ruuvi_interface_adc_mcu.h

Go to the documentation of this file.

#ifndef RUUVI_INTERFACE_ADC_MCU_H
#define RUUVI_INTERFACE_ADC_MCU_H
#include "ruuvi_driver_error.h"
#include "ruuvi_driver_sensor.h"
#include "ruuvi_interface_gpio.h"
#if RI_ADC_ENABLED
#  define RUUVI_NRF5_SDK15_ADC_ENABLED RUUVI_NRF5_SDK15_ENABLED
#endif
 
/* Analog input channels of device */
typedef enum
{
    RI_ADC_GND,           
    RI_ADC_AIN0,          
    RI_ADC_AIN1,          
    RI_ADC_AIN2,          
    RI_ADC_AIN3,          
    RI_ADC_AIN4,          
    RI_ADC_AIN5,          
    RI_ADC_AIN6,          
    RI_ADC_AIN7,          
    RI_ADC_AINVDD,        
    RI_ADC_CH_NUM         
} ri_adc_channel_t;
 
/* ADC reference voltage. */
typedef enum
{
    RI_ADC_VREF_INTERNAL, 
    RI_ADC_VREF_EXTERNAL  
} ri_adc_vref_t;
 
/* ADC mode */
typedef enum
{
    RI_ADC_MODE_SINGLE,       
#ifdef RI_ADC_ADV_MODE_CONFIG
    RI_ADC_MODE_DIFFERENTIAL  
#endif
} ri_adc_mode_t;
 
/* ADC oversampling mode. */
typedef enum
{
    RI_ADC_OVERSAMPLE_DISABLED,
    RI_ADC_OVERSAMPLE_2X,
    RI_ADC_OVERSAMPLE_4X,
    RI_ADC_OVERSAMPLE_8X,
    RI_ADC_OVERSAMPLE_16X,
    RI_ADC_OVERSAMPLE_32X,
    RI_ADC_OVERSAMPLE_64X,
    RI_ADC_OVERSAMPLE_128X,
    RI_ADC_OVERSAMPLE_256X,
} ri_adc_oversample_t;
 
/* ADC resolutions. */
typedef enum
{
    RI_ADC_RESOLUTION_8BIT,
    RI_ADC_RESOLUTION_10BIT,
    RI_ADC_RESOLUTION_12BIT,
    RI_ADC_RESOLUTION_14BIT,
} ri_adc_resolution_t;
 
#ifdef RI_ADC_ADV_CONFIG
/* ADC pin resistor. */
typedef enum
{
    RI_ADC_RESISTOR_DISABLED,
    RI_ADC_RESISTOR_PULLDOWN,
    RI_ADC_RESISTOR_PULLUP,
    RI_ADC_RESISTOR_VDD1_2,
} nri_adc_resistor_t;
 
/* ADC acq_time. */
typedef enum
{
    RI_ADC_ACQTIME_3US,
    RI_ADC_ACQTIME_5US,
    RI_ADC_ACQTIME_10US,
    RI_ADC_ACQTIME_15US,
    RI_ADC_ACQTIME_20US,
    RI_ADC_ACQTIME_40US,
} ri_adc_acqtime_t;
#endif
 
/* ADC gain. */
typedef enum
{
    RI_ADC_GAIN1_6,
    RI_ADC_GAIN1_5,
    RI_ADC_GAIN1_4,
    RI_ADC_GAIN1_3,
    RI_ADC_GAIN1_2,
    RI_ADC_GAIN1,
    RI_ADC_GAIN2,
    RI_ADC_GAIN4,
} ri_adc_gain_t;
 
/* ADC pin config struct. */
typedef struct
{
    ri_adc_channel_t channel;
#ifdef RI_ADC_ADV_CONFIG
    nri_adc_resistor_t resistor;
#endif
} ri_adc_pin_config_t;
 
/* ADC x2 pins config struct. */
typedef struct
{
    ri_adc_pin_config_t p_pin;
#ifdef RI_ADC_ADV_MODE_CONFIG
    ri_adc_pin_config_t n_pin;
#endif
} ri_adc_pins_config_t;
 
/* ADC channel config struct. */
typedef struct
{
    ri_adc_mode_t mode;
    ri_adc_vref_t vref;
    ri_adc_gain_t gain;
#ifdef RI_ADC_ADV_CONFIG
    ri_adc_acqtime_t acqtime;
#endif
} ri_adc_channel_config_t;
 
/* ADC config struct. */
typedef struct
{
    ri_adc_oversample_t oversample;
    ri_adc_resolution_t resolution;
} ri_adc_config_t;
 
/* ADC result config struct. */
typedef struct
{
    float vdd;
    float divider;
} ri_adc_get_data_t;
 
bool ri_adc_is_init (void);
rd_status_t ri_adc_init (ri_adc_config_t * p_config);
 
rd_status_t ri_adc_uninit (bool config_default);
 
rd_status_t ri_adc_configure (uint8_t channel_num,
                              ri_adc_pins_config_t * p_pins,
                              ri_adc_channel_config_t * p_config);
 
rd_status_t ri_adc_stop (uint8_t channel_num);
 
rd_status_t ri_adc_get_raw_data (uint8_t channel_num,
                                 int16_t * p_data);
 
rd_status_t ri_adc_get_data_absolute (uint8_t channel_num,
                                      ri_adc_get_data_t * p_config,
                                      float * p_data);
 
rd_status_t ri_adc_get_data_ratio (uint8_t channel_num,
                                   ri_adc_get_data_t * p_config,
                                   float * p_data);
 
bool ri_adc_mcu_is_valid_ch (const uint8_t ch);
#endif