ADC

Modules
	ADC_Registers

Data Structures
struct	mxc_adc_req_t
struct	mxc_adc_slot_req_t
struct	mxc_adc_conversion_req_t

Enumerations
enum	mxc_adc_chsel_t
enum	mxc_adc_avg_t
enum	mxc_adc_comp_t
enum	mxc_adc_clkdiv_t
enum	mxc_adc_clock_t
enum	mxc_adc_calibration_t
enum	mxc_adc_trig_mode_t
enum	mxc_adc_trig_sel_t
enum	mxc_adc_conversion_mode_t
enum	mxc_adc_divsel_t
enum	mxc_adc_refsel_t
enum	mxc_adc_div_lpmode_t
enum	mxc_adc_fifodataformat_t
enum	mxc_adc_dynamic_pullup_t

Functions
int	MXC_ADC_Init (mxc_adc_req_t *req)
int	MXC_ADC_Shutdown (void)
void	MXC_ADC_EnableInt (uint32_t flags)
void	MXC_ADC_DisableInt (uint32_t flags)
int	MXC_ADC_GetFlags (void)
void	MXC_ADC_ClearFlags (uint32_t flags)
int	MXC_ADC_StartConversion (void)
int	MXC_ADC_StartConversionAsync (mxc_adc_complete_cb_t callback)
int	MXC_ADC_StartConversionDMA (mxc_adc_conversion_req_t *req, int *data, void(*callback)(int, int))
int	MXC_ADC_Handler (void)
int	MXC_ADC_EnableComparator (mxc_adc_comp_t comp, mxc_adc_chsel_t negCh, mxc_adc_chsel_t posCh)
int	MXC_ADC_DisableComparator (mxc_adc_comp_t comp)
int	MXC_ADC_ComparatorHysteresisEn (mxc_adc_comp_t comp)
int	MXC_ADC_ComparatorHysteresisDis (mxc_adc_comp_t comp)
int	MXC_ADC_InputDividerSelect (mxc_adc_chsel_t ch, mxc_adc_divsel_t div, mxc_adc_dynamic_pullup_t lpEn)
int	MXC_ADC_ReferenceSelect (mxc_adc_refsel_t ref)
int	MXC_ADC_DynamicModeEn (mxc_adc_chsel_t ch)
int	MXC_ADC_DynamicModeDis (mxc_adc_chsel_t ch)
int	MXC_ADC_GetData (int *outdata)
int	MXC_ADC_Configuration (mxc_adc_conversion_req_t *req)
int	MXC_ADC_SlotConfiguration (mxc_adc_slot_req_t *req, uint32_t slot_length)
void	MXC_ADC_TS_SelectEnable (void)
void	MXC_ADC_TS_SelectDisable (void)
void	MXC_ADC_EnableConversion (void)
void	MXC_ADC_DisableConversion (void)
uint16_t	MXC_ADC_FIFO_Level (void)
void	MAX_ADC_Flush_FIFO (void)
int	MXC_ADC_FIFO_Threshold_Config (uint32_t fifo_threshold)
int	MXC_ADC_AverageConfig (mxc_adc_avg_t avg_number)
void	MXC_ADC_Clear_ChannelSelect (void)
void	MXC_ADC_TriggerConfig (mxc_adc_conversion_req_t *req)
void	MXC_ADC_ConversionModeConfig (mxc_adc_conversion_req_t *req)
void	MXC_ADC_SetConversionDelay (int delay)
int	MXC_ADC_SlotsConfig (mxc_adc_conversion_req_t *req)
int	MXC_ConvertTemperature_ToK (uint16_t tempSensor_Readout, mxc_adc_refsel_t ref, float ext_ref, float *temp_k)
int	MXC_ConvertTemperature_ToC (uint16_t tempSensor_Readout, mxc_adc_refsel_t ref, float ext_ref, float *temp)
int	MXC_ConvertTemperature_ToF (uint16_t tempSensor_Readout, mxc_adc_refsel_t ref, float ext_ref, float *temp)
int	MXC_ADC_LowPowerModeDividerSelect (mxc_adc_div_lpmode_t div_lpmode)

Detailed Description

API for Analog to Digital Converter (ADC).

---

Data Structure Documentation

mxc_adc_req_t

struct mxc_adc_req_t

ADC Settings.

Data Fields
mxc_adc_clock_t	clock
mxc_adc_clkdiv_t	clkdiv
mxc_adc_calibration_t	cal
mxc_adc_refsel_t	ref
uint32_t	trackCount
uint32_t	idleCount

mxc_adc_slot_req_t

struct mxc_adc_slot_req_t

ADC Slot Settings.

Data Fields
mxc_adc_chsel_t	channel
mxc_adc_divsel_t	div
mxc_adc_dynamic_pullup_t	pullup_dyn

mxc_adc_conversion_req_t

struct mxc_adc_conversion_req_t

ADC Conversion Settings.

Data Fields
mxc_adc_conversion_mode_t	mode
mxc_adc_trig_mode_t	trig
mxc_adc_trig_sel_t	hwTrig
mxc_adc_fifodataformat_t	fifo_format
uint8_t	fifo_threshold
mxc_adc_avg_t	avg_number
mxc_adc_div_lpmode_t	lpmode_divder
uint8_t	num_slots
int8_t	dma_channel

Enumeration Type Documentation

mxc_adc_avg_t

enum mxc_adc_avg_t

Enumeration type for the number of samples to average.

Enumerator
MXC_ADC_AVG_1	Select Channel 0.
MXC_ADC_AVG_2	Select Channel 1.
MXC_ADC_AVG_4	Select Channel 2.
MXC_ADC_AVG_8	Select Channel 3.
MXC_ADC_AVG_16	Select Channel 4.
MXC_ADC_AVG_32	Select Channel 5.

mxc_adc_calibration_t

enum mxc_adc_calibration_t

Calibration settings.

Enumerator
MXC_ADC_SKIP_CAL	Skip calibration on power-up.
MXC_ADC_EN_CAL	Calibrate on power-up.

mxc_adc_chsel_t

enum mxc_adc_chsel_t

Enumeration type for the ADC Input Channels.

Enumerator
MXC_ADC_CH_0	Select Channel 0.
MXC_ADC_CH_1	Select Channel 1.
MXC_ADC_CH_2	Select Channel 2.
MXC_ADC_CH_3	Select Channel 3.
MXC_ADC_CH_4	Select Channel 4.
MXC_ADC_CH_5	Select Channel 5.
MXC_ADC_CH_6	Select Channel 6.
MXC_ADC_CH_7	Select Channel 7.
MXC_ADC_CH_8	Select Channel 8.
MXC_ADC_CH_9	Select Channel 9.
MXC_ADC_CH_10	Select Channel 10.
MXC_ADC_CH_11	Select Channel 11.
MXC_ADC_CH_12	Select Channel 12.
MXC_ADC_CH_13	Select Channel 13.
MXC_ADC_CH_14	Select Channel 14.
MXC_ADC_CH_15	Select Channel 15.

mxc_adc_clkdiv_t

enum mxc_adc_clkdiv_t

Enumeration type for ADC clock divider.

Enumerator
MXC_ADC_CLKDIV_2	ADC Scale by 1/2.
MXC_ADC_CLKDIV_4	ADC Scale by 1/4.
MXC_ADC_CLKDIV_8	ADC Scale by 1/8.
MXC_ADC_CLKDIV_16	ADC Scale by 1/16.
MXC_ADC_CLKDIV_1	ADC Scale by 1x (no scaling)

mxc_adc_clock_t

enum mxc_adc_clock_t

Clock settings.

Enumerator
MXC_ADC_CLK_HCLK	HCLK CLock.
MXC_ADC_CLK_EXT	External Clock.
MXC_ADC_CLK_IBRO	IBRO Clock.
MXC_ADC_CLK_ERFO	ERFO Clock.

mxc_adc_comp_t

enum mxc_adc_comp_t

Enumeration type for the ADC Compartors

mxc_adc_conversion_mode_t

enum mxc_adc_conversion_mode_t

trigger mode settings

Enumerator
MXC_ADC_ATOMIC_CONV	Software Trigger.
MXC_ADC_CONTINUOUS_CONV	Hardware Trigger.

mxc_adc_div_lpmode_t

enum mxc_adc_div_lpmode_t

Divide by 2 control in low power mode.

Enumerator
MXC_ADC_DIV_2_5K_50K_ENABLE	2.5K and 50K divide by 2 enable in lpmode
MXC_ADC_DIV_2_5K_DISABLE	2.5K disable and 50K divide by 2 enable in lpmode
MXC_ADC_DIV_50K_DISABLE	2.5K enable and 50K divide by 2 disable in lpmode
MXC_ADC_DIV_2_5K_50K_DISABLE	2.5K and 50K divide by 2 disable in lpmode

mxc_adc_divsel_t

enum mxc_adc_divsel_t

Analog input divider select.

Enumerator
MXC_ADC_DIV1	No input divider.
MXC_ADC_DIV2_5K	Divide analog input by two with 5K resistor.
MXC_ADC_DIV2_50K	Divide analog input by two with 50K resistor.

mxc_adc_dynamic_pullup_t

enum mxc_adc_dynamic_pullup_t

Dynamic Divider pullup control.

TODO

Enumerator
MXC_ADC_PY_DN_DISABLE	Disable Dynamic Divider Pullup.
MXC_ADC_PY_DN_ENABLE	Enable Dynamic Divider Pullup.

mxc_adc_fifodataformat_t

enum mxc_adc_fifodataformat_t

Data FIFO data format.

TODO

Enumerator
MXC_ADC_DATA_STATUS	Data(12-bit) plus Status.
MXC_ADC_DATA	Data(12-bit) only.
MXC_ADC_RAW_DATA	18-bit raw data

mxc_adc_refsel_t

enum mxc_adc_refsel_t

Reference voltage select type.

Enumerator
MXC_ADC_REF_EXT	Use external reference voltage source.
MXC_ADC_REF_INT_1V25	Use internal 1.25V source.
MXC_ADC_REF_INT_2V048	Use internal 2.048V souce.

mxc_adc_trig_mode_t

enum mxc_adc_trig_mode_t

trigger mode settings

Enumerator
MXC_ADC_TRIG_SOFTWARE	Software Trigger.
MXC_ADC_TRIG_HARDWARE	Hardware Trigger.

mxc_adc_trig_sel_t

enum mxc_adc_trig_sel_t

Hardware trigger select options.

Enumerator
MXC_ADC_TRIG_SEL_TMR0	Timer 0 Out Rising edge.
MXC_ADC_TRIG_SEL_TMR1	Timer 1 Out Rising Edge.
MXC_ADC_TRIG_SEL_TMR2	Timer 2 Out Rising Edge.
MXC_ADC_TRIG_SEL_TMR3	Timer 3 Out Rising Edge.
MXC_ADC_TRIG_SEL_P0_29	GPIO Port 0, Pin 29.
MXC_ADC_TRIG_SEL_P0_22	GPIO Port 0, Pin 22.
MXC_ADC_TRIG_SEL_P1_4	GPIO Port 1, Pin 4.
MXC_ADC_TRIG_SEL_TEMP_SENS	Temperature Sensor Ready.

Function Documentation

MAX_ADC_Flush_FIFO()

void MAX_ADC_Flush_FIFO

(

void

)

Flushes the ADC FIFO.

Parameters

None

MXC_ADC_AverageConfig()

int MXC_ADC_AverageConfig

(

mxc_adc_avg_t

avg_number

)

Configures number of sample average in the sequence for each channel.

Parameters

Average

number

Returns

see Error Codes for a list of return codes.

MXC_ADC_Clear_ChannelSelect()

void MXC_ADC_Clear_ChannelSelect

(

void

)

Clear all channel select registers.

Returns

None.

MXC_ADC_ClearFlags()

void MXC_ADC_ClearFlags

(

uint32_t

flags

)

Clear adc interrupt flags.

Parameters

flags

mask of flags to clear

MXC_ADC_ComparatorHysteresisDis()

int MXC_ADC_ComparatorHysteresisDis

(

mxc_adc_comp_t

comp

)

Disable comparator hysteresis.

Parameters

comp	Selects the comparator to disable hysteresis for.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_ComparatorHysteresisEn()

int MXC_ADC_ComparatorHysteresisEn

(

mxc_adc_comp_t

comp

)

Enable comparator hysteresis.

Parameters

comp	Selects the comparator to enable hysteresis for.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_Configuration()

int MXC_ADC_Configuration

(

mxc_adc_conversion_req_t *

req

)

Configures the ADC.

Parameters

pointer

to the variable having ADC configuration.

Returns

see Error Codes for a list of return codes.

MXC_ADC_ConversionModeConfig()

void MXC_ADC_ConversionModeConfig

(

mxc_adc_conversion_req_t *

req

)

Configures ADC Conversion Mode: Single vs Continuous Conversion.

Parameters

pointer

to ADC configure data structure.

Returns

None.

MXC_ADC_DisableComparator()

int MXC_ADC_DisableComparator

(

mxc_adc_comp_t

comp

)

Disable the Comparators.

Parameters

comp	Selects the comparator to disable

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_DisableConversion()

void MXC_ADC_DisableConversion

(

void

)

Disables the ADC converter.

Parameters

None

MXC_ADC_DisableInt()

void MXC_ADC_DisableInt

(

uint32_t

flags

)

Disable specific ADC interrupts.

Parameters

flags

mask of interrupt flags to enables

MXC_ADC_DynamicModeDis()

int MXC_ADC_DynamicModeDis

(

mxc_adc_chsel_t

ch

)

Disables the ADC Dynamic Power-Up Mode.

Parameters

Channel

to disable dynamic mode for.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_DynamicModeEn()

int MXC_ADC_DynamicModeEn

(

mxc_adc_chsel_t

ch

)

Enables the ADC Dynamic Power-Up Mode.

Parameters

Channel

to enable dynamic mode for.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_EnableComparator()

int MXC_ADC_EnableComparator	(	mxc_adc_comp_t	comp,
		mxc_adc_chsel_t	negCh,
		mxc_adc_chsel_t	posCh
	)

Enable the Comparator.

Parameters

comp	Selects the comparator to enable
negCh	Channel to use for the negative input of the comparator, valid channels AIN0-AIN3
posCh	Channel to use for the positive input of the comparator, valid channels AIN4-AIN7

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_EnableConversion()

void MXC_ADC_EnableConversion

(

void

)

Enables the ADC converter.

Parameters

None

MXC_ADC_EnableInt()

void MXC_ADC_EnableInt

(

uint32_t

flags

)

Enable specific ADC interrupts.

Parameters

flags

mask of interrupt flags to enables

MXC_ADC_FIFO_Level()

uint16_t MXC_ADC_FIFO_Level

(

void

)

Provides the ADC FIFO level.

Returns

return the ADC FIFO level counts.

MXC_ADC_FIFO_Threshold_Config()

int MXC_ADC_FIFO_Threshold_Config

(

uint32_t

fifo_threshold

)

Configures the ADC FIFO threshold register.

Parameters

FIFO	threshold.

Returns

see Error Codes for a list of return codes.

MXC_ADC_GetData()

int MXC_ADC_GetData

(

int *

outdata

)

Gets the ADC readout after the ADC conversion.

Parameters

Pointer

to store the ADC data conversion result

Returns

see Error Codes for a list of return codes.

MXC_ADC_GetFlags()

int MXC_ADC_GetFlags

(

void

)

Get adc interrupt flags.

Returns

active flags

MXC_ADC_Handler()

int MXC_ADC_Handler

(

void

)

Call this function from the ADC ISR when using Async API functions.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_Init()

int MXC_ADC_Init

(

mxc_adc_req_t *

req

)

Performs the ADC startup procedure.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_InputDividerSelect()

int MXC_ADC_InputDividerSelect	(	mxc_adc_chsel_t	ch,
		mxc_adc_divsel_t	div,
		mxc_adc_dynamic_pullup_t	lpEn
	)

Selects the analog input divider.

Parameters

ch	Channel to set divider for
div	The analog input divider to select
lpEn	If Divide by 2, non-zero values will enable divide by 2 in low-power modes.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_LowPowerModeDividerSelect()

int MXC_ADC_LowPowerModeDividerSelect

(

mxc_adc_div_lpmode_t

div_lpmode

)

Configures Divider (0-12 channel) in the low power mode.

Parameters

Channel

specific low power divider control in the lp mode.

Returns

see Error Codes for a list of return codes.

MXC_ADC_ReferenceSelect()

int MXC_ADC_ReferenceSelect

(

mxc_adc_refsel_t

ref

)

Selects the desired reference voltage for the ADC.

Parameters

ref	Desired reference voltage source.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_SetConversionDelay()

void MXC_ADC_SetConversionDelay

(

int

delay

)

Set Sample Delay before Continuous Mode Conversion Restart.

Parameters

number

of sample clock periods to delay in between conversions.

Returns

None.

MXC_ADC_Shutdown()

int MXC_ADC_Shutdown

(

void

)

Shuts down the ADC.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_SlotConfiguration()

int MXC_ADC_SlotConfiguration	(	mxc_adc_slot_req_t *	req,
		uint32_t	slot_length
	)

Configures ADC slot and channel registers.

Parameters

Pointer	of a variable having channel parameter configuration.
Number	of slots for ADC sequence.

Returns

see Error Codes for a list of return codes.

MXC_ADC_SlotsConfig()

int MXC_ADC_SlotsConfig

(

mxc_adc_conversion_req_t *

req

)

Configures number of slots for ADC sequence.

Parameters

pointer

to ADC configure data structure.

Returns

see Error Codes for a list of return codes.

MXC_ADC_StartConversion()

int MXC_ADC_StartConversion

(

void

)

Initiate configured ADC conversion.

Note

The channel must be configured separately

Returns

Raw conversion value, or Error Codes for error.

MXC_ADC_StartConversionAsync()

int MXC_ADC_StartConversionAsync

(

mxc_adc_complete_cb_t

callback

)

Perform a conversion on a specific channel.

Note

The channel must be configured separately The ADC interrupt must be enabled and MXC_ADC_Handler() called in the ISR places data in the error parameter of the callback function

Parameters

callback

the function to call when the conversion is complete

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_StartConversionDMA()

int MXC_ADC_StartConversionDMA	(	mxc_adc_conversion_req_t *	req,
		int *	data,
		void(*)(int, int)	callback
	)

Perform a conversion on a specific channel using a DMA transfer. DMA channel must be acquired using MXC_DMA_AcquireChannel and should be passed to this function via "dma_channel" member of "req" input struct. DMA IRQ corresponding to that channel must be enabled using MXC_NVIC_SetVector, and the MXC_DMA_Handler should be called from the respective ISR.

Parameters

req	mxc_adc_conversion_req_t
pointer	to the variable to hold the conversion result
callback	the function to call when the conversion is complete

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_ADC_TriggerConfig()

void MXC_ADC_TriggerConfig

(

mxc_adc_conversion_req_t *

req

)

Configures ADC Trigger to initiate ADC conversion.

Parameters

pointer

to ADC configure data structure.

Returns

None.

MXC_ADC_TS_SelectDisable()

void MXC_ADC_TS_SelectDisable

(

void

)

Disables the temperature sensor.

Parameters

None

MXC_ADC_TS_SelectEnable()

void MXC_ADC_TS_SelectEnable

(

void

)

Enables the temperature sensor.

Parameters

None

MXC_ConvertTemperature_ToC()

int MXC_ConvertTemperature_ToC	(	uint16_t	tempSensor_Readout,
		mxc_adc_refsel_t	ref,
		float	ext_ref,
		float *	temp
	)

Calculates temperature (in C) from ADC readout.

Parameters

Temperature	readout from ADC.
ADC	refereence (internal 1.25V, 2.048V and external reference).
external	reference value for ADC if used.
pointer	to temperature value.

Returns

see Error Codes for a list of return codes.

MXC_ConvertTemperature_ToF()

int MXC_ConvertTemperature_ToF	(	uint16_t	tempSensor_Readout,
		mxc_adc_refsel_t	ref,
		float	ext_ref,
		float *	temp
	)

Calculates temperature (in F) from ADC readout.

Parameters

Temperature	readout from ADC.
ADC	refereence (internal 1.25V, 2.048V and external reference).
external	reference value for ADC if used.
pointer	to temperature value.

Returns

see Error Codes for a list of return codes.

MXC_ConvertTemperature_ToK()

int MXC_ConvertTemperature_ToK	(	uint16_t	tempSensor_Readout,
		mxc_adc_refsel_t	ref,
		float	ext_ref,
		float *	temp_k
	)

Calculates temperature (in K) from ADC readout.

Parameters

Temperature	readout from ADC.
ADC	refereence (internal 1.25V, 2.048V and external reference).
external	reference value for ADC if used.
pointer	to temperature value.

Returns

see Error Codes for a list of return codes.