adc22.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 ADC22_H
#define ADC22_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 ADC22_CMD_NOP                   0x00
#define ADC22_CMD_CLEAR_HWORD           0xC0
#define ADC22_CMD_READ_HWORD            0xC8
#define ADC22_CMD_READ                  0x48
#define ADC22_CMD_WRITE                 0xD0
#define ADC22_CMD_WRITE_MS              0xD2
#define ADC22_CMD_WRITE_LS              0xD4
#define ADC22_CMD_SET_HWORD             0xD8
 
 // adc22_cmd
 
#define ADC22_REG_DEVICE_ID             0x02
#define ADC22_REG_RST_PWRCTL_LSB        0x04
#define ADC22_REG_RST_PWRCTL_MSB        0x05
#define ADC22_REG_SDI_CTL               0x08
#define ADC22_REG_SDO_CTL_LSB           0x0C
#define ADC22_REG_SDO_CTL_MSB           0x0D
#define ADC22_REG_DATAOUT_CTL_LSB       0x10
#define ADC22_REG_DATAOUT_CTL_MSB       0x11
#define ADC22_REG_RANGE_SEL             0x14
#define ADC22_REG_ALARM_LSB             0x20
#define ADC22_REG_ALARM_MSB             0x21
#define ADC22_REG_ALARM_H_TH_LSB        0x24
#define ADC22_REG_ALARM_H_TH_MSB        0x25
#define ADC22_REG_ALARM_L_TH_LSB        0x28
#define ADC22_REG_ALARM_L_TH_MSB        0x29
 
 // adc22_reg
 
#define ADC22_DEVICE_ADDR_MAX           16
 
#define ADC22_SDO_MODE_SAME_SDI         1
#define ADC22_SDO_MODE_INV              2
#define ADC22_SDO_MODE_ADC_M_CLK        3
 
#define ADC22_DATAOUT_CTL_VAL_CONV      0x00
#define ADC22_DATAOUT_CTL_VAL_0_S       0x04
#define ADC22_DATAOUT_CTL_VAL_1_S       0x05
#define ADC22_DATAOUT_CTL_VAL_A_01_S    0x06
#define ADC22_DATAOUT_CTL_VAL_A_0011_S  0x07
#define ADC22_DATAOUT_CTL_PAR_DIS       0x00
#define ADC22_DATAOUT_CTL_PAR_EN        0x08
 
#define ADC22_ADC_ZERO_SCALE            2045u
#define ADC22_ADC_MIDDLE_SCALE          2048.0f
#define ADC22_ADC_FULL_SCALE            4096.0f
 
#define ADC22_ADC_RANGE_12V28           12.28f
#define ADC22_ADC_RANGE_10V24           10.24f
#define ADC22_ADC_RANGE_6V14            6.14f
#define ADC22_ADC_RANGE_5V12            5.12f
#define ADC22_ADC_RANGE_2V56            2.56f
#define ADC22_SET_RANGE_BIT_MASK        0x0F
 
#define ADC22_PIN_STATE_LOW             0x00
#define ADC22_PIN_STATE_HIGH            0x01
 
#define ADC22_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define ADC22_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // adc22_set
 
#define ADC22_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.rvs = MIKROBUS( mikrobus, MIKROBUS_AN );    \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );   \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // adc22_map
 // adc22
 
typedef struct
{
    // Output pins
    digital_out_t rst;     
    // Input pins
    digital_in_t rvs;      
    digital_in_t int_pin;  
    // Modules
    spi_master_t spi;      
    pin_name_t   chip_select;  
} adc22_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 rvs;      
    pin_name_t rst;      
    pin_name_t int_pin;  
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} adc22_cfg_t;
 
typedef enum
{
    ADC22_OK = 0,
    ADC22_ERROR = -1
 
} adc22_return_value_t;
 
typedef enum
{
    ADC22_RANGE_BI_12V28 = 0x00,    
    ADC22_RANGE_BI_10V24 = 0x01,    
    ADC22_RANGE_BI_6V14 = 0x02,     
    ADC22_RANGE_BI_5V12 = 0x03,     
    ADC22_RANGE_BI_2V56 = 0x04,     
    ADC22_RANGE_12V28 = 0x08,       
    ADC22_RANGE_10V24 = 0x09,       
    ADC22_RANGE_6V14 = 0x0A,        
    ADC22_RANGE_5V12 = 0x0B         
} adc22_range_sel_t;
 
void adc22_cfg_setup ( adc22_cfg_t *cfg );
 
err_t adc22_init ( adc22_t *ctx, adc22_cfg_t *cfg );
 
err_t adc22_default_cfg ( adc22_t *ctx );
 
void adc22_hw_reset ( adc22_t *ctx );
 
uint8_t adc22_get_interrupt ( adc22_t *ctx );
 
uint8_t adc22_get_rvs ( adc22_t *ctx );
 
 
err_t adc22_write_reg ( adc22_t *ctx, uint8_t w_cmd, uint8_t reg, uint8_t data_in );
 
err_t adc22_read_reg ( adc22_t *ctx, uint8_t r_cmd, uint8_t reg, uint8_t *data_out );
 
err_t adc22_get_adc_raw_data ( adc22_t *ctx, uint16_t *raw_adc );
 
err_t adc22_get_voltage ( adc22_t *ctx, float *voltage );
 
err_t adc22_set_device_addr ( adc22_t *ctx, uint8_t device_addr );
 
err_t adc22_get_device_id ( adc22_t *ctx, uint8_t *device_id );
 
err_t adc22_set_sdo_mode ( adc22_t *ctx, uint8_t sdo_mode );
 
err_t adc22_en_out_data_parity ( adc22_t *ctx );
 
err_t adc22_set_range ( adc22_t *ctx, adc22_range_sel_t range );
 
err_t adc22_get_range ( adc22_t *ctx, uint8_t *range );
 
#ifdef __cplusplus
}
#endif
#endif // ADC22_H
 
 // adc22
 
// ------------------------------------------------------------------------ END