hw_gpadc_v2.h

Go to the documentation of this file.

 
#ifndef HW_GPADC_V2_H
#define HW_GPADC_V2_H
 
 
#if dg_configUSE_HW_GPADC
 
#include <stdbool.h>
#include <stdint.h>
#include "sdk_defs.h"
 
/***************************************************************************
 *********    Macro, type and data-structure definitions     ***************
 ***************************************************************************/
 
#define HW_GPADC_DIE_TEMP_SMPL_TIME             0x04
 
#define HW_GPADC_DIE_TEMP_INIT_DELAY            0x68  /* 26 usec with a clock speed of (DivN_clk / 2) */
 
typedef enum {
        HW_GPADC_INPUT_VOLTAGE_UP_TO_0V9 = 0,   
        HW_GPADC_INPUT_VOLTAGE_UP_TO_1V8 = 1,   
        HW_GPADC_INPUT_VOLTAGE_UP_TO_2V7 = 2,   
        HW_GPADC_INPUT_VOLTAGE_UP_TO_3V6 = 3,   
} HW_GPADC_MAX_INPUT_VOLTAGE;
 
#define HW_GPADC_VREF_MILLIVOLT                 (900)
 
typedef enum {
        HW_GPADC_STORE_DEL_0         = 0x0,     
        HW_GPADC_STORE_DEL_2_CYCLES = 0x1,      
        HW_GPADC_STORE_DEL_3_CYCLES = 0x2,      
        HW_GPADC_STORE_DEL_4_CYCLES = 0x3,      
        HW_GPADC_STORE_DEL_5_CYCLES = 0x4,     
        HW_GPADC_STORE_DEL_6_CYCLES = 0x5,     
        HW_GPADC_STORE_DEL_7_CYCLES = 0x6,     
        HW_GPADC_STORE_DEL_8_CYCLES = 0x7,     
} HW_GPADC_STORE_DELAY;
 
/*
 *  ADC input to GPIO pin mapping
 */
typedef enum {
        HW_GPADC_INPUT_ADC0 = 0,
        HW_GPADC_INPUT_ADC1,
        HW_GPADC_INPUT_ADC2,
        HW_GPADC_INPUT_ADC3,
        HW_GPADC_INPUT_ADC4 = 0x0A,
        HW_GPADC_INPUT_ADC5 = 0x0B,
        HW_GPADC_INPUT_ADC6 = 0x0C,
        HW_GPADC_INPUT_ADC7 = 0x0D,
        HW_GPADC_INPUT_RES1 = 0x0E,
        HW_GPADC_INPUT_RES2 = 0x0F,
} HW_GPADC_GPIO_INPUT;
 
typedef enum {
        HW_GPADC_INP_P1_0  = HW_GPADC_INPUT_ADC0,       
        HW_GPADC_INP_P1_1  = HW_GPADC_INPUT_ADC1,       
        HW_GPADC_INP_P1_2  = HW_GPADC_INPUT_ADC2,       
        HW_GPADC_INP_P0_10 = HW_GPADC_INPUT_ADC3,       
        HW_GPADC_INP_DIE_TEMP = 4,                      
        HW_GPADC_INP_VDCDC = 5,                         
        HW_GPADC_INP_VBAT = 6,                          
        HW_GPADC_INP_VDDD = 7,                          
        HW_GPADC_INP_VSSA = 8,                          
        HW_GPADC_INP_VDDIO = 9,                         
        HW_GPADC_INP_P1_5  = HW_GPADC_INPUT_ADC4,       
        HW_GPADC_INP_P1_6  = HW_GPADC_INPUT_ADC5,       
        HW_GPADC_INP_P1_9  = HW_GPADC_INPUT_ADC6,       
        HW_GPADC_INP_P1_11 = HW_GPADC_INPUT_ADC7,       
} HW_GPADC_INPUT_POSITIVE;
 
typedef enum {
        HW_GPADC_INN_P1_0  = HW_GPADC_INPUT_ADC0,       
        HW_GPADC_INN_P1_1  = HW_GPADC_INPUT_ADC1,       
        HW_GPADC_INN_P1_2  = HW_GPADC_INPUT_ADC2,       
        HW_GPADC_INN_P0_10 = HW_GPADC_INPUT_ADC3,       
        HW_GPADC_INN_P1_5  = HW_GPADC_INPUT_ADC4,       
        HW_GPADC_INN_P1_6  = HW_GPADC_INPUT_ADC5,       
        HW_GPADC_INN_P1_9  = HW_GPADC_INPUT_ADC6,       
        HW_GPADC_INN_P1_11 = HW_GPADC_INPUT_ADC7,       
} HW_GPADC_INPUT_NEGATIVE;
 
typedef struct {
        HW_GPADC_INPUT_MODE        input_mode;          
        HW_GPADC_INPUT_POSITIVE    positive;            
        HW_GPADC_INPUT_NEGATIVE    negative;            
        uint8_t                    sample_time;         
        bool                       continuous;          
        uint8_t                    interval;            
        HW_GPADC_MAX_INPUT_VOLTAGE input_attenuator;    
        bool                       chopping;            
        HW_GPADC_OVERSAMPLING      oversampling;        
#if HW_GPADC_DMA_SUPPORT
        gpadc_dma_cfg              *dma_setup;          
#endif
} hw_gpadc_config_t;
 
/***************************************************************************
 ****************      GP_ADC configuration functions    *******************
 ***************************************************************************/
 
__STATIC_INLINE void hw_gpadc_set_ldo_delay(uint32_t delay)
{
        /* Zero delay is not allowed by the h/w specification */
        ASSERT_ERROR(delay != 0);
        REG_SETF(GPADC, GP_ADC_CTRL3_REG, GP_ADC_EN_DEL, delay);
}
 
 __STATIC_INLINE void hw_gpadc_set_store_delay(HW_GPADC_STORE_DELAY delay)
 {
         REG_SETF(GPADC, GP_ADC_CTRL2_REG, GP_ADC_STORE_DEL, delay);
 }
 
__STATIC_INLINE void hw_gpadc_set_positive(HW_GPADC_INPUT_POSITIVE channel)
{
        REG_SETF(GPADC, GP_ADC_SEL_REG, GP_ADC_SEL_P, channel);
}
 
__STATIC_INLINE HW_GPADC_INPUT_POSITIVE hw_gpadc_get_positive(void)
{
        return REG_GETF(GPADC, GP_ADC_SEL_REG, GP_ADC_SEL_P);
}
 
__STATIC_INLINE void hw_gpadc_set_negative(HW_GPADC_INPUT_NEGATIVE channel)
{
        REG_SETF(GPADC, GP_ADC_SEL_REG, GP_ADC_SEL_N, channel);
}
 
__STATIC_INLINE HW_GPADC_INPUT_NEGATIVE hw_gpadc_get_negative(void)
{
        return REG_GETF(GPADC, GP_ADC_SEL_REG, GP_ADC_SEL_N);
}
 
__STATIC_INLINE void hw_gpadc_set_input_attenuator_state(HW_GPADC_MAX_INPUT_VOLTAGE vmax)
{
        REG_SETF(GPADC, GP_ADC_CTRL2_REG, GP_ADC_ATTN, vmax);
}
 
__STATIC_INLINE HW_GPADC_MAX_INPUT_VOLTAGE hw_gpadc_get_input_attenuator_state(void)
{
        return REG_GETF(GPADC, GP_ADC_CTRL2_REG, GP_ADC_ATTN);
}
 
__STATIC_INLINE void hw_gpadc_set_sample_time(uint8_t mult)
{
        REG_SETF(GPADC, GP_ADC_CTRL2_REG, GP_ADC_SMPL_TIME, mult);
}
 
__STATIC_INLINE uint8_t hw_gpadc_get_sample_time(void)
{
        return REG_GETF(GPADC, GP_ADC_CTRL2_REG, GP_ADC_SMPL_TIME);
}
 
__STATIC_INLINE void hw_gpadc_set_die_temp(bool enabled)
{
        REG_SETF(GPADC, GP_ADC_CTRL_REG, DIE_TEMP_EN, !!enabled);
}
 
__STATIC_INLINE bool hw_gpadc_get_die_temp(void)
{
        return REG_GETF(GPADC, GP_ADC_CTRL_REG, DIE_TEMP_EN);
}
 
__STATIC_INLINE void hw_gpadc_set_ldo_hold(bool enabled)
{
        REG_SETF(GPADC, GP_ADC_CTRL_REG, GP_ADC_LDO_HOLD, !!enabled);
}
 
__STATIC_INLINE bool hw_gpadc_get_ldo_hold(void)
{
        return (bool) REG_GETF(GPADC, GP_ADC_CTRL_REG, GP_ADC_LDO_HOLD);
}
 
/***************************************************************************
 ****************    Basic functionality of the GPADC    *******************
 ***************************************************************************/
 
int16_t hw_gpadc_get_voltage(void);
 
/***************************************************************************
 ******************      TEMPERATURE SENSOR functions  *********************
 ***************************************************************************/
 
int16_t hw_gpadc_convert_to_celsius_x100_util(const hw_gpadc_config_t *cfg, uint16_t raw_val);
 
uint16_t hw_gpadc_convert_celsius_x100_to_raw_val_util(const hw_gpadc_config_t *cfg, int16_t temperature);
 
void hw_gpadc_store_ambient_calibration_point(uint16_t raw_val, int16_t temp);
 
#endif /* dg_configUSE_HW_GPADC */
#endif /* HW_GPADC_V2_H */