Detailed Description

ADC driver implementation for the ADC peripheral on Low Power F3 devices.

This ADC driver implementation is designed to operate on a ADC peripheral for Low Power 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 ADCLPF3.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

struct	ADCLPF3_Object
	ADCLPF3 Object. More...

Enumerations
enum	ADCLPF3_Resolution_Bits { ADCLPF3_RESOLUTION_12_BIT = ADC_RESOLUTION_12_BIT, ADCLPF3_RESOLUTION_10_BIT = ADC_RESOLUTION_10_BIT, ADCLPF3_RESOLUTION_8_BIT = ADC_RESOLUTION_8_BIT }
	Resolution of ADC-conversion. More...

enum	ADCLPF3_Reference_Source { ADCLPF3_FIXED_REFERENCE_1V4 = ADC_FIXED_REFERENCE_1V4, ADCLPF3_FIXED_REFERENCE_2V5 = ADC_FIXED_REFERENCE_2V5, ADCLPF3_VDDS_REFERENCE = ADC_VDDS_REFERENCE, ADCLPF3_EXTERNAL_REFERENCE = ADC_EXTERNAL_REFERENCE }
	Specifies the source of the ADC reference voltage. More...

enum	ADCLPF3_Clock_Divider { ADCLPF3_CLKDIV_1 = ADC_CLOCK_DIVIDER_1, ADCLPF3_CLKDIV_2 = ADC_CLOCK_DIVIDER_2, ADCLPF3_CLKDIV_4 = ADC_CLOCK_DIVIDER_4, ADCLPF3_CLKDIV_8 = ADC_CLOCK_DIVIDER_8, ADCLPF3_CLKDIV_16 = ADC_CLOCK_DIVIDER_16, ADCLPF3_CLKDIV_24 = ADC_CLOCK_DIVIDER_24, ADCLPF3_CLKDIV_32 = ADC_CLOCK_DIVIDER_32, ADCLPF3_CLKDIV_48 = ADC_CLOCK_DIVIDER_48 }
	ADC clock-divider. More...

Variables
const ADC_FxnTable	ADCLPF3_fxnTable

Enumeration Type Documentation

§ ADCLPF3_Resolution_Bits

enum ADCLPF3_Resolution_Bits

Resolution of ADC-conversion.

This sets the resolution of the ADC conversion, and will affect how long a conversion takes.

Enumerator
ADCLPF3_RESOLUTION_12_BIT
ADCLPF3_RESOLUTION_10_BIT
ADCLPF3_RESOLUTION_8_BIT

§ ADCLPF3_Reference_Source

enum ADCLPF3_Reference_Source

Specifies the source of the ADC reference voltage.

The ADC reference voltage will determine the upper limit of the input 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 FCFG. 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 specifies limits.

Enumerator
ADCLPF3_FIXED_REFERENCE_1V4
ADCLPF3_FIXED_REFERENCE_2V5
ADCLPF3_VDDS_REFERENCE
ADCLPF3_EXTERNAL_REFERENCE

§ ADCLPF3_Clock_Divider

enum ADCLPF3_Clock_Divider

ADC clock-divider.

This sets the clock divider value for the ADC clock, derived from the SYSCLK

Enumerator
ADCLPF3_CLKDIV_1
ADCLPF3_CLKDIV_2
ADCLPF3_CLKDIV_4
ADCLPF3_CLKDIV_8
ADCLPF3_CLKDIV_16
ADCLPF3_CLKDIV_24
ADCLPF3_CLKDIV_32
ADCLPF3_CLKDIV_48

Variable Documentation

§ ADCLPF3_fxnTable

const ADC_FxnTable ADCLPF3_fxnTable