ADC

ADC library. More...

Macros
#define	NUM_ADC_CHANNELS   19U
	Total Number of ADC channels (16 external, 3 internal)
#define	ADC_TIMEOUT_MS   100U
	Maximum time permitted for an ADC transaction.

Enumerations
enum	AdcMode { ADC_MODE_SINGLE = 0 , ADC_MODE_CONTINUOUS , NUM_ADC_MODES }
	Available ADC modes. More...

Functions
StatusCode	adc_init (void)
	Initialize the ADC instance. More...
StatusCode	adc_add_channel (GpioAddress *address)
	Adds an ADC channel for a given Gpio. More...
StatusCode	adc_run (void)
	Runs ADC conversions for all added channels. More...
StatusCode	adc_read_raw (GpioAddress *address, uint16_t *reading)
	Read the most recent raw value for a Gpio address. More...
StatusCode	adc_read_converted (GpioAddress *address, uint16_t *reading)
	Read the most recent converted value for a Gpio address in mV. More...
void	adc_deinit (void)
	Clears the ADC state.

Detailed Description

ADC library.

Enumeration Type Documentation

AdcMode

enum AdcMode

Available ADC modes.

Enumerator
ADC_MODE_SINGLE	Single mode
ADC_MODE_CONTINUOUS	Continuous mode
NUM_ADC_MODES	Number of ADC Ports

Function Documentation

adc_add_channel()

StatusCode adc_add_channel

(

GpioAddress *

address

)

Adds an ADC channel for a given Gpio.

Configures a Gpio to be used as an ADC channel Must be called for all pins in use before adc_init

Parameters

address

Specifies which Gpio to set as an ADC channel

Returns

STATUS_CODE_OK if adding a channel succeeded STATUS_CODE_INVALID_ARGS if one of the parameters are incorrect STATUS_CODE_INTERNAL_ERROR if HAL initialization fails STATUS_CODE_RESOURCE_EXHAUSTED if already added

adc_init()

StatusCode adc_init

(

void

)

Initialize the ADC instance.

This shall configure the ADC for DMA transactions, increasing throughput ADC channels must be already added prior to calling this function

Returns

STATUS_CODE_OK if initialization succeeded STATUS_CODE_INTERNAL_ERROR if HAL initialization fails STATUS_CODE_RESOURCE_EXHAUSTED if already initialized

adc_read_converted()

StatusCode adc_read_converted	(	GpioAddress *	address,
		uint16_t *	reading
	)

Read the most recent converted value for a Gpio address in mV.

Parameters

address	Specifies which Gpio to read from
reading	Pointer to a 16-bit value that will be updated with the reading

Returns

STATUS_CODE_OK if reading succeeded STATUS_CODE_INVALID_ARGS if one of the parameters are incorrect STATUS_CODE_INTERNAL_ERROR if reading fails

adc_read_raw()

StatusCode adc_read_raw	(	GpioAddress *	address,
		uint16_t *	reading
	)

Read the most recent raw value for a Gpio address.

Parameters

address	Specifies which Gpio to read from
reading	Pointer to a 16-bit value that will be updated with the reading

Returns

STATUS_CODE_OK if reading succeeded STATUS_CODE_INVALID_ARGS if one of the parameters are incorrect STATUS_CODE_INTERNAL_ERROR if reading fails

adc_run()

StatusCode adc_run

(

void

)

Runs ADC conversions for all added channels.

Uses DMA to perform the transaction

Returns

STATUS_CODE_OK if conversions succeeded STATUS_CODE_INTERNAL_ERROR if HAL transaction fails STATUS_CODE_TIMEOUT if ADC conversions exceed ADC_TIMEOUT_MS