Detailed Description

ADC driver implementation for the ADC peripheral on Wi-Fi F3 devices.

This ADC driver implementation is designed to operate on a ADC peripheral for Wi-Fi F3 devices.

Refer to ADC.h for a complete description of APIs & example of use.

Limitations

ADC_Params Attributes Limitations

Some attributes in the ADC_Params structure have a limited set of supported values. These limitations are described below:

ADC_Params.isProtected
- Must be true. If this is false, ADC_open() will fail and return NULL.

#include <stdint.h>
#include <stdbool.h>
#include <ti/drivers/ADC.h>
#include <ti/drivers/Power.h>
#include <ti/devices/DeviceFamily.h>
#include <DeviceFamily_constructPath(driverlib/adc.h)>

Include dependency graph for ADCWFF3.h:

Go to the source code of this file.

Data Structures
struct	ADCWFF3_HWAttrs
	ADCWFF3 Hardware attributes These fields are used by driverlib APIs and therefore must be populated by driverlib macro definitions. More...

struct	ADCWFF3_Object
	ADCWFF3 Object. More...

Enumerations
enum	ADCWFF3_ReferenceSource { ADCWFF3_INTERNAL_REFERENCE = ADC_INTERNAL_REFERENCE, ADCWFF3_VDDA_REFERENCE = ADC_VDDA_REFERENCE, ADCWFF3_EXTERNAL_REFERENCE = ADC_EXTERNAL_REFERENCE }
	Specifies the source of the ADC reference voltage. More...

enum	ADCWFF3_SampleClockSource { ADCWFF3_SAMPLE_CLK_SOC_CLK = ADC_SAMPLE_CLK_SOC_CLK, ADCWFF3_SAMPLE_CLK_HFXT = ADC_SAMPLE_CLK_HFXT, ADCWFF3_SAMPLE_CLK_SOC_PLL_CLK_DIV = ADC_SAMPLE_CLK_SOC_PLL_CLK_DIV }
	ADC sample clock source. More...

enum	ADCWFF3_ClockDivider { ADCWFF3_CLKDIV_1 = ADC_CLOCK_DIVIDER_1, ADCWFF3_CLKDIV_2 = ADC_CLOCK_DIVIDER_2, ADCWFF3_CLKDIV_4 = ADC_CLOCK_DIVIDER_4, ADCWFF3_CLKDIV_8 = ADC_CLOCK_DIVIDER_8, ADCWFF3_CLKDIV_16 = ADC_CLOCK_DIVIDER_16, ADCWFF3_CLKDIV_24 = ADC_CLOCK_DIVIDER_24, ADCWFF3_CLKDIV_32 = ADC_CLOCK_DIVIDER_32, ADCWFF3_CLKDIV_48 = ADC_CLOCK_DIVIDER_48 }
	ADC clock-divider. More...

enum	ADCWFF3_FullScaleRange { ADCWFF3_FULL_SCALE_RANGE_0V0_3V3 = ADC_FULL_SCALE_RANGE_0V0_3V3, ADCWFF3_FULL_SCALE_RANGE_0V1_3V3 = ADC_FULL_SCALE_RANGE_0V1_3V3, ADCWFF3_FULL_SCALE_RANGE_0V0_3V2 = ADC_FULL_SCALE_RANGE_0V0_3V2, ADCWFF3_FULL_SCALE_RANGE_0V0_1V8 = ADC_FULL_SCALE_RANGE_0V0_1V8 }
	ADC full scale range. More...

Variables
const ADC_FxnTable	ADCWFF3_fxnTable

Enumeration Type Documentation

§ ADCWFF3_ReferenceSource

enum ADCWFF3_ReferenceSource

Specifies the source of the ADC reference voltage.

Note: The actual reference values are slightly different for each device and are higher than the values specified above. This gain is saved in the eFuse. The function ADC_convertToMicroVolts() must be used to derive actual voltage values. Do not attempt to compare raw values between devices or derive a voltage from them yourself. The results of doing so will only be approximately correct.

Warning: Refer to the datasheet to make sure the input voltage to the ADC never exceeds the specified limits.

Enumerator
ADCWFF3_INTERNAL_REFERENCE
ADCWFF3_VDDA_REFERENCE
ADCWFF3_EXTERNAL_REFERENCE

§ ADCWFF3_SampleClockSource

enum ADCWFF3_SampleClockSource

ADC sample clock source.

This sets the sampling clock source.

Enumerator
ADCWFF3_SAMPLE_CLK_SOC_CLK	System-on-Chip clock, 80 Mhz.
ADCWFF3_SAMPLE_CLK_HFXT	High-Frequency Crystal clock, 40 Mhz.
ADCWFF3_SAMPLE_CLK_SOC_PLL_CLK_DIV	Divided Phase-Locked Loop clock, 80 Mhz.

§ ADCWFF3_ClockDivider

enum ADCWFF3_ClockDivider

ADC clock-divider.

This sets the sample clock divider value.

Enumerator
ADCWFF3_CLKDIV_1
ADCWFF3_CLKDIV_2
ADCWFF3_CLKDIV_4
ADCWFF3_CLKDIV_8
ADCWFF3_CLKDIV_16
ADCWFF3_CLKDIV_24
ADCWFF3_CLKDIV_32
ADCWFF3_CLKDIV_48

§ ADCWFF3_FullScaleRange

enum ADCWFF3_FullScaleRange

ADC full scale range.

This sets the voltage range the ADC can measure

Enumerator
ADCWFF3_FULL_SCALE_RANGE_0V0_3V3
ADCWFF3_FULL_SCALE_RANGE_0V1_3V3
ADCWFF3_FULL_SCALE_RANGE_0V0_3V2
ADCWFF3_FULL_SCALE_RANGE_0V0_1V8

Variable Documentation

§ ADCWFF3_fxnTable

const ADC_FxnTable ADCWFF3_fxnTable