Defines a driver to facilitate interfacing with the Analog-to-Digital Converter (ADC) driver.
More...
Defines a driver to facilitate interfacing with the Analog-to-Digital Converter (ADC) driver.
Use this driver to measure a DC voltage via a GPIO pin. Voltage measurement values are reported in millivolts (mV).
Note that the ADC channels do not correspond directly to the GPIO pin numbering convention (e.g. ADC channel 15 is tied to GPIO P18, etc). Please reference the Kit Guide for more information regarding your specific platform.
The following parameters are used to configure the driver or define return status. They are not modifiable.
Supported ADC input channel selection.
typedef enum ADC_INPUT_CHANNEL_SEL {
ADC_INPUT_P17 = 0x0, //GPIO 16
ADC_INPUT_P16 = 0x1, //GPIO 17
ADC_INPUT_P15 = 0x2, //GPIO 18
ADC_INPUT_P14 = 0x3, //GPIO 19
ADC_INPUT_P13 = 0x4, //GPIO 20
ADC_INPUT_P12 = 0x5, //GPIO 21
ADC_INPUT_P11 = 0x6, //GPIO 22
ADC_INPUT_P10 = 0x7, //GPIO 23
ADC_INPUT_P9 = 0x8, //GPIO 24
ADC_INPUT_P8 = 0x9, //GPIO 25
ADC_INPUT_P1 = 0xA, //GPIO 26
ADC_INPUT_P0 = 0xB, //GPIO 27
ADC_INPUT_VDDIO = 0xC, //ADC_INPUT_VBAT_VDDIO
ADC_INPUT_VDD_CORE = 0xD, //ADC_INPUT_VDDC
ADC_INPUT_ADC_BGREF = 0xE,
ADC_INPUT_ADC_REFGND = 0xF,
ADC_INPUT_P38 = 0x10, //GPIO 0
ADC_INPUT_P37 = 0x11, //GPIO 1
ADC_INPUT_P36 = 0x12, //GPIO 2
ADC_INPUT_P35 = 0x13, //GPIO 3
ADC_INPUT_P34 = 0x14, //GPIO 4
ADC_INPUT_P33 = 0x15, //GPIO 5
ADC_INPUT_P32 = 0x16, //GPIO 6
ADC_INPUT_P31 = 0x17, //GPIO 7
ADC_INPUT_P30 = 0x18, //GPIO 8
ADC_INPUT_P29 = 0x19, //GPIO 9
ADC_INPUT_P28 = 0x1A, //GPIO 10
ADC_INPUT_P23 = 0x1B, //GPIO 11
ADC_INPUT_P22 = 0x1C, //GPIO 12
ADC_INPUT_P21 = 0x1D, //GPIO 13
ADC_INPUT_P19 = 0x1E, //GPIO 14
ADC_INPUT_P18 = 0x1F, //GPIO 15
ADC_INPUT_CHANNEL_MASK = 0x1f,
}ADC_INPUT_CHANNEL_SEL;
ADC power type
typedef enum ADC_POWER_TYPE
{
ADC_POWER_DOWN = 1,
ADC_POWER_UP = 0,
}ADC_POWER_TYPE;
input voltage range selection
typedef enum ADC_INPUT_RANGE_SEL
{
ADC_RANGE_0_3P6V = 0,
ADC_RANGE_0_1P8V = 1,
}ADC_INPUT_RANGE_SEL;
| static INLINE void wiced_hal_adc_init |
( |
void |
| ) |
|
|
static |
Initialize the ADC hardware to its default state.
- Parameters
-
- Returns
- none
| static INLINE INT16 wiced_hal_adc_read_raw_sample |
( |
ADC_INPUT_CHANNEL_SEL |
channel | ) |
|
|
static |
Read the raw ADC register value for the given channel.
The value returned here is direct from the register.
- Parameters
-
| channel | - The input channel that corresponds to a GPIO pin. |
- Returns
- Raw digital value read from the hardware register.
| static INLINE UINT32 wiced_hal_adc_read_voltage |
( |
ADC_INPUT_CHANNEL_SEL |
channel | ) |
|
|
static |
Read the ADC voltage value for the given channel.
The value returned here is converted to a voltage value from the register.
- Parameters
-
| channel | - The input channel that corresponds to a GPIO pin. |
- Returns
- Converted digital voltage value.
| static INLINE void wiced_hal_adc_set_input_range |
( |
ADC_INPUT_RANGE_SEL |
rangeIdx | ) |
|
|
static |
Calibrate and set the input voltage range expected for the ADC hardware.
- Parameters
-
| range_idx | - 0 to 3.6v(0) or 0 to 1.8v(1). |
- Returns
- none
| static INLINE ADC_POWER_TYPE wiced_hal_adc_set_power |
( |
ADC_POWER_TYPE |
pwr | ) |
|
|
static |
Power up or power down the ADC hardware.
- Parameters
-
| pwr | - ADC_POWER_UP(0) or ADC_POWER_DOWN(1). |
- Returns
- The previous power state.
