adc23.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 ADC23_H
#define ADC23_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"
 
#define ADC_REG_DEV_ID                       0x00
#define ADC_REG_REV_ID                       0x01
#define ADC_REG_STATUS                       0x02
#define ADC_REG_CONTROL                      0x03
#define ADC_REG_MUX                          0x04
#define ADC_REG_CONFIG1                      0x05
#define ADC_REG_CONFIG2                      0x06
#define ADC_REG_CONFIG3                      0x07
#define ADC_REG_CONFIG4                      0x08
#define ADC_REG_OFFSET2                      0x09
#define ADC_REG_OFFSET1                      0x0A
#define ADC_REG_OFFSET0                      0x0B
#define ADC_REG_GAIN2                        0x0C
#define ADC_REG_GAIN1                        0x0D
#define ADC_REG_GAIN0                        0x0E
#define ADC_REG_CRC                          0x0F
 
 // adc23_reg
 
#define ADC_CMD_NO_OPERATION                 0x00
#define ADC_CMD_READ_REG                     0x40
#define ADC_CMD_WRITE_REG                    0x80
 
 // adc23_cmd
 
#define ADC23_INT_VREF_2_5V                  2.5f
 
#define ADC23_SET_CTRL_STOP                  0x01
#define ADC23_SET_CTRL_START                 0x02
#define ADC23_SET_CTRL_SW_RESET              0x58
#define ADC23_MAX_REG_ADDR                   0x0F
 
#define ADC23_CONV_V_TO_MV                    1000.0f
 
#define ADC23_FULL_SCALE_OUT_DATA_RANGE      0x7FFFFFul
 
#define ADC23_SET_DATA_SAMPLE_EDGE           SET_SPI_DATA_SAMPLE_EDGE
#define ADC23_SET_DATA_SAMPLE_MIDDLE         SET_SPI_DATA_SAMPLE_MIDDLE
 
 // adc23_set
 
#define ADC23_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.rst = MIKROBUS( mikrobus, MIKROBUS_RST );   \
    cfg.str = MIKROBUS( mikrobus, MIKROBUS_PWM );   \
    cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // adc23_map
 // adc23
 
typedef struct
{
    // Output pins
    digital_out_t rst;   
    digital_out_t str;   
    // Input pins
    digital_in_t rdy;    
    // Modules
    spi_master_t spi;          
    pin_name_t   chip_select;  
    float vref;
 
} adc23_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;     
    pin_name_t str;     
    pin_name_t rdy;     
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
    float vref;
 
} adc23_cfg_t;
 
typedef enum
{
    ADC23_OK = 0,
    ADC23_ERROR = -1
 
} adc23_return_value_t;
 
void adc23_cfg_setup ( adc23_cfg_t *cfg );
 
err_t adc23_init ( adc23_t *ctx, adc23_cfg_t *cfg );
 
err_t adc23_default_cfg ( adc23_t *ctx );
 
err_t adc23_generic_write ( adc23_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t adc23_generic_read ( adc23_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t adc23_generic_transfer ( adc23_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len );
 
err_t adc23_read_reg_cmd ( adc23_t *ctx, uint8_t reg, uint16_t *data_out, uint8_t *reg_data_out );
 
err_t adc23_read_reg_data ( adc23_t *ctx, uint8_t reg, uint32_t *data_out, uint8_t *reg_data_out );
 
err_t adc23_write_reg_cmd ( adc23_t *ctx, uint8_t reg, uint8_t data_in, uint16_t *data_out );
 
err_t adc23_write_reg_data ( adc23_t *ctx, uint8_t reg, uint8_t data_in, uint32_t *data_out );
 
err_t adc23_sw_reset ( adc23_t *ctx );
 
err_t adc23_start_conversion ( adc23_t *ctx );
 
err_t adc23_stop_conversion ( adc23_t *ctx );
 
err_t adc23_read_conversion_data ( adc23_t *ctx, int32_t *adc_data );
 
err_t adc23_get_voltage ( adc23_t *ctx, float *voltage );
 
void adc23_set_start ( adc23_t *ctx );
 
void adc23_set_stop ( adc23_t *ctx );
 
void adc23_hw_reset ( adc23_t *ctx );
 
uint8_t adc23_get_data_ready ( adc23_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ADC23_H
 
 // adc23
 
// ------------------------------------------------------------------------ END