adc16.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 ADC16_H
#define ADC16_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_i2c_master.h"
 
#define ADC16_OPCODE_SINGLE_READ                    0x10
#define ADC16_OPCODE_SINGLE_WRITE                   0x08
#define ADC16_OPCODE_SET_BIT                        0x18
#define ADC16_OPCODE_CLEAR_BIT                      0x20
#define ADC16_OPCODE_CONTINUOUS_READ                0x30
#define ADC16_OPCODE_CONTINUOUS_WRITE               0x28
 
#define ADC16_REG_OPMODE_I2CMODE_STATUS             0x00
#define ADC16_REG_DATA_BUFFER_STATUS                0x01
#define ADC16_REG_ACCUMULATOR_STATUS                0x02
#define ADC16_REG_ALERT_TRIG_CHID                   0x03
#define ADC16_REG_SEQUENCE_STATUS                   0x04
#define ADC16_REG_ACC_CH0_LSB                       0x08
#define ADC16_REG_ACC_CH0_MSB                       0x09
#define ADC16_REG_ACC_CH1_LSB                       0x0A
#define ADC16_REG_ACC_CH1_MSB                       0x0B
#define ADC16_REG_ALERT_LOW_FLAGS                   0x0C
#define ADC16_REG_ALERT_HIGH_FLAGS                  0x0E
#define ADC16_REG_DEVICE_RESET                      0x14
#define ADC16_REG_OFFSET_CAL                        0x15
#define ADC16_REG_WKEY                              0x17
#define ADC16_REG_OSC_SEL                           0x18
#define ADC16_REG_NCLK_SEL                          0x19
#define ADC16_REG_OPMODE_SEL                        0x1C
#define ADC16_REG_START_SEQUENCE                    0x1E
#define ADC16_REG_ABORT_SEQUENCE                    0x1F
#define ADC16_REG_AUTO_SEQ_CHEN                     0x20
#define ADC16_REG_CH_INPUT_CFG                      0x24
#define ADC16_REG_DOUT_FORMAT_CFG                   0x28
#define ADC16_REG_DATA_BUFFER_OPMODE                0x2C
#define ADC16_REG_ACC_EN                            0x30
#define ADC16_REG_ALERT_CHEN                        0x34
#define ADC16_REG_PRE_ALT_MAX_EVENT_COUNT           0x36
#define ADC16_REG_ALERT_DWC_EN                      0x37
#define ADC16_REG_DWC_HTH_CH0_LSB                   0x38
#define ADC16_REG_DWC_HTH_CH0_MSB                   0x39
#define ADC16_REG_DWC_LTH_CH0_LSB                   0x3A
#define ADC16_REG_DWC_LTH_CH0_MSB                   0x3B
#define ADC16_REG_DWC_HTH_CH1_LSB                   0x3C
#define ADC16_REG_DWC_HTH_CH1_MSB                   0x3D
#define ADC16_REG_DWC_LTH_CH1_LSB                   0x3E
#define ADC16_REG_DWC_LTH_CH1_MSB                   0x3F
#define ADC16_REG_DWC_HYS_CH0                       0x40
#define ADC16_REG_DWC_HYS_CH1                       0x41
 
 // adc16_reg
 
#define ADC16_WKEY_UNLOCK                           0x0A
#define ADC16_WKEY_LOCK                             0x00
 
#define ADC16_DEVICE_RESET                          0x01
 
#define ADC16_START_CALIBRATION                     0x01
 
#define ADC16_CH_CFG_TWO_CH_SINGLE_END              0x00
#define ADC16_CH_CFG_SIN_CH_SINGLE_END_RMT_GND      0x01
#define ADC16_CH_CFG_SIN_CH_SINGLE_END_PSEUDO_DIFF  0x02
 
#define ADC16_OPMODE_SEL_MAN_WITH_CH0               0x00
#define ADC16_OPMODE_SEL_MAN_WITH_AUTO_SEQ          0x04
#define ADC16_OPMODE_SEL_AUTO_WITH_AUTO_SEQ         0x06
#define ADC16_OPMODE_SEL_HIGH_PREC_WITH_AUTO_SEQ    0x07
 
#define ADC16_AUTOSEQ_EN_CH0                        0x01
#define ADC16_AUTOSEQ_EN_CH1                        0x02
#define ADC16_AUTOSEQ_EN_BOTH_CH                    0x03
 
#define ADC16_START_SEQUENCE                        0x01
#define ADC16_ABORT_SEQUENCE                        0x01
 
#define ADC16_RESOLUTION                            0x0FFF
#define ADC16_VREF                                  3.3
 
#define ADC16_DEV_ADDR_R1_0_R2_DNP                  0x1F
#define ADC16_DEV_ADDR_R1_11K_R2_DNP                0x1E
#define ADC16_DEV_ADDR_R1_33K_R2_DNP                0x1D
#define ADC16_DEV_ADDR_R1_100K_R2_DNP               0x1C
#define ADC16_DEV_ADDR_R1_DNP_R2_DNP                0x18
#define ADC16_DEV_ADDR_R1_DNP_R2_11K                0x19
#define ADC16_DEV_ADDR_R1_DNP_R2_33K                0x1A
#define ADC16_DEV_ADDR_R1_DNP_R2_100K               0x1B
 
 // adc16_set
 
#define ADC16_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.alr = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // adc16_map
 // adc16
 
typedef struct
{
    // Input pins
    digital_in_t  rdy;          
    digital_in_t  alr;          
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} adc16_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  rdy;            
    pin_name_t  alr;            
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} adc16_cfg_t;
 
typedef enum
{
    ADC16_OK = 0,
    ADC16_ERROR = -1
 
} adc16_return_value_t;
 
void adc16_cfg_setup ( adc16_cfg_t *cfg );
 
err_t adc16_init ( adc16_t *ctx, adc16_cfg_t *cfg );
 
err_t adc16_default_cfg ( adc16_t *ctx );
 
err_t adc16_single_register_write ( adc16_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t adc16_single_register_read ( adc16_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t adc16_set_register_bits ( adc16_t *ctx, uint8_t reg, uint8_t bit_mask );
 
err_t adc16_clear_register_bits ( adc16_t *ctx, uint8_t reg, uint8_t bit_mask );
 
err_t adc16_continuous_register_write ( adc16_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t adc16_continuous_register_read ( adc16_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
uint8_t adc16_get_rdy_pin ( adc16_t *ctx );
 
uint8_t adc16_get_alr_pin ( adc16_t *ctx );
 
err_t adc16_get_voltage ( adc16_t *ctx, float *ain0_voltage, float *ain1_voltage );
 
#ifdef __cplusplus
}
#endif
#endif // ADC16_H
 
 // adc16
 
// ------------------------------------------------------------------------ END