adc15.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 ADC15_H
#define ADC15_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 ADC15_CMD_NULL              0x0000
#define ADC15_CMD_RESET             0x0011
#define ADC15_CMD_STANDBY           0x0022
#define ADC15_CMD_WAKEUP            0x0033
#define ADC15_CMD_LOCK              0x0555
#define ADC15_CMD_UNLOCK            0x0655
#define ADC15_CMD_RREG              0xA000
#define ADC15_CMD_WREG              0x6000
 
#define ADC15_REG_ID                0x00
#define ADC15_REG_STATUS            0x01
#define ADC15_REG_MODE              0x02
#define ADC15_REG_CLOCK             0x03
#define ADC15_REG_GAIN              0x04
#define ADC15_REG_CFG               0x06
#define ADC15_REG_THRSHLD_MSB       0x07
#define ADC15_REG_THRSHLD_LSB       0x08
#define ADC15_REG_CH0_CFG           0x09
#define ADC15_REG_CH0_OCAL_MSB      0x0A
#define ADC15_REG_CH0_OCAL_LSB      0x0B
#define ADC15_REG_CH0_GCAL_MSB      0x0C
#define ADC15_REG_CH0_GCAL_LSB      0x0D
#define ADC15_REG_CH1_CFG           0x0E
#define ADC15_REG_CH1_OCAL_MSB      0x0F
#define ADC15_REG_CH1_OCAL_LSB      0x10
#define ADC15_REG_CH1_GCAL_MSB      0x11
#define ADC15_REG_CH1_GCAL_LSB      0x12
#define ADC15_REG_REGMAP_CRC        0x3E
 
 // adc15_reg
 
#define ADC15_FREQ_MODE_HIGH_RESOLUTION 8192000
#define ADC15_FREQ_MODE_LOW_POWER       4096000
#define ADC15_FREQ_MODE_VERY_LOW_POWER  2048000
 
#define ADC15_LDC_CFG_POWER_ON      2
#define ADC15_LDC_CFG_POWER_DOWN    3
 
#define ADC15_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define ADC15_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // adc15_set
 
#define ADC15_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.cs2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.drdy = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // adc15_map
 // adc15
 
typedef struct
{
    // Output pins
    digital_out_t  rst;         
    digital_out_t  cs2;         
    // Input pins
    digital_in_t  drdy;         
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
    uint8_t gain1;              
    uint8_t gain2;              
    uint8_t word_len;           
    uint32_t resolution;        
} adc15_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  cs2;    
    pin_name_t  drdy;   
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} adc15_cfg_t;
 
typedef enum
{
   ADC15_OK = 0,
   ADC15_ERROR = -1
 
} adc15_return_value_t;
 
typedef enum
{
   ADC15_CHANNEL1 = 0,
   ADC15_CHANNEL2 = 4
 
} adc15_channel_t;
 
typedef enum
{
   ADC15_GAIN1 = 0, 
   ADC15_GAIN2,     
   ADC15_GAIN4,     
   ADC15_GAIN8,     
   ADC15_GAIN16,    
   ADC15_GAIN32,    
   ADC15_GAIN64,    
   ADC15_GAIN128    
} adc15_gain_t;
 
typedef enum
{
   ADC15_16bit = 0,
   ADC15_24bit,
   ADC15_32bit
 
} adc15_word_t;
 
void adc15_cfg_setup ( adc15_cfg_t *cfg );
 
err_t adc15_init ( adc15_t *ctx, adc15_cfg_t *cfg );
 
err_t adc15_default_cfg ( adc15_t *ctx );
 
err_t adc15_adc_write ( adc15_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t adc15_reg_write ( adc15_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t adc15_multiple_reg_write ( adc15_t *ctx, uint8_t reg, uint16_t *data_in, uint8_t data_size );
 
err_t adc15_adc_read ( adc15_t *ctx, uint8_t *data_out, uint8_t len );
 
err_t adc15_reg_read ( adc15_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t adc15_multiple_reg_read ( adc15_t *ctx, uint8_t reg, uint16_t *data_out, uint8_t data_size );
 
err_t adc15_adc_transfer ( adc15_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len );
 
err_t adc15_ltc_write ( adc15_t *ctx, uint8_t oct, uint16_t dac, uint8_t cfg );
 
err_t adc15_set_frequency ( adc15_t *ctx, uint32_t frequency );
 
err_t adc15_read_adc_value ( adc15_t *ctx, uint16_t *status, int32_t *ch1_out, int32_t *ch2_out );
 
err_t adc15_read_voltage ( adc15_t *ctx, uint16_t *status, float *ch1_out, float *ch2_out );
 
uint8_t adc15_data_ready ( adc15_t *ctx );
 
err_t adc15_set_gain ( adc15_t *ctx, adc15_channel_t channel, adc15_gain_t gain );
 
err_t adc15_set_word_len ( adc15_t *ctx, adc15_word_t word_len );
 
#ifdef __cplusplus
}
#endif
#endif // ADC15_H
 
 // adc15
 
// ------------------------------------------------------------------------ END