gainamp.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef GAINAMP_H
#define GAINAMP_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
#include "drv_analog_in.h"    
 
#define GAINAMP_CHANNEL_A_x0         0x00
#define GAINAMP_CHANNEL_A_x1         0x01
#define GAINAMP_CHANNEL_A_x2         0x02
#define GAINAMP_CHANNEL_A_x5         0x03
#define GAINAMP_CHANNEL_A_x10        0x04
#define GAINAMP_CHANNEL_A_x20        0x05
#define GAINAMP_CHANNEL_A_x50        0x06
#define GAINAMP_CHANNEL_A_x100       0x07
#define GAINAMP_CHANNEL_A_SHUTDOWN   0x08
 
#define GAINAMP_CHANNEL_B_x0         0x00
#define GAINAMP_CHANNEL_B_x1         0x10
#define GAINAMP_CHANNEL_B_x2         0x20
#define GAINAMP_CHANNEL_B_x5         0x30
#define GAINAMP_CHANNEL_B_x10        0x40
#define GAINAMP_CHANNEL_B_x20        0x50
#define GAINAMP_CHANNEL_B_x50        0x60
#define GAINAMP_CHANNEL_B_x100       0x70
#define GAINAMP_CHANNEL_B_SHUTDOWN   0x80
 
#define GAINAMP_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define GAINAMP_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // gainamp_set
 
#define GAINAMP_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
 
 // gainamp_map
 // gainamp
 
typedef struct
{
    // Output pins
    digital_out_t  rst;     
    // Modules
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
    analog_in_t  adc;       
} gainamp_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;                                    
    pin_name_t  mosi;                                    
    pin_name_t  sck;                                     
    pin_name_t  cs;                                      
    // Additional gpio pins
    pin_name_t  rst;        
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
    pin_name_t  an;     
    analog_in_resolution_t  resolution;     
    float                   vref;           
} gainamp_cfg_t;
 
typedef enum
{
   GAINAMP_OK = 0,
   GAINAMP_ERROR = -1
 
} gainamp_return_value_t;
 
void gainamp_cfg_setup ( gainamp_cfg_t *cfg );
 
err_t gainamp_init ( gainamp_t *ctx, gainamp_cfg_t *cfg );
 
err_t gainamp_generic_write ( gainamp_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t gainamp_generic_read ( gainamp_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t gainamp_read_an_pin_value ( gainamp_t *ctx, uint16_t *data_out );
 
err_t gainamp_read_an_pin_voltage ( gainamp_t *ctx, float *data_out );
 
void gainamp_reset ( gainamp_t *ctx );
 
void gainamp_set_gain ( gainamp_t *ctx, uint8_t gain );
 
#ifdef __cplusplus
}
#endif
#endif // GAINAMP_H
 
 // gainamp
 
// ------------------------------------------------------------------------ END