Analog Digital Converter (ADC)

Modules
	ADC_Registers

Data Structures
struct	mxc_adc_monitor_req_t
struct	mxc_adc_conversion_req_t

Typedefs
typedef void(*	mxc_adc_complete_cb_t) (void *req, int error)
typedef void(*	mxc_adc_monitor_cb_t) (void *req, int error)

Enumerations
enum	mxc_adc_chsel_t
enum	mxc_adc_monitor_t
enum	mxc_adc_scale_t

Functions
int	MXC_ADC_Init (void)
int	MXC_ADC_Shutdown (void)
int	MXC_ADC_Busy (void)
void	MXC_ADC_EnableInt (uint32_t flags)
void	MXC_ADC_DisableInt (uint32_t flags)
uint32_t	MXC_ADC_GetFlags (void)
void	MXC_ADC_ClearFlags (uint32_t flags)
int	MXC_ADC_SetConversionSpeed (uint32_t hz)
int	MXC_ADC_GetConversionSpeed (void)
void	MXC_ADC_SetDataAlignment (int msbJustify)
void	MXC_ADC_SetExtScale (mxc_adc_scale_t scale)
void	MXC_ADC_EnableMonitor (mxc_adc_monitor_t monitor)
void	MXC_ADC_DisableMonitor (mxc_adc_monitor_t monitor)
void	MXC_ADC_SetMonitorHighThreshold (mxc_adc_monitor_t monitor, uint32_t threshold)
int	MXC_ADC_GetMonitorHighThreshold (mxc_adc_monitor_t monitor)
void	MXC_ADC_SetMonitorLowThreshold (mxc_adc_monitor_t monitor, uint32_t threshold)
int	MXC_ADC_GetMonitorLowThreshold (mxc_adc_monitor_t monitor)
void	MXC_ADC_SetMonitorChannel (mxc_adc_monitor_t monitor, mxc_adc_chsel_t channel)
int	MXC_ADC_GetMonitorChannel (mxc_adc_monitor_t monitor)
void	MXC_ADC_EnableMonitorAsync (mxc_adc_monitor_t monitor, mxc_adc_monitor_cb_t callback)
void	MXC_ADC_DisableMonitorAsync (mxc_adc_monitor_t monitor)
int	MXC_ADC_StartConversion (mxc_adc_chsel_t channel)
int	MXC_ADC_StartConversionAsync (mxc_adc_chsel_t channel, mxc_adc_complete_cb_t callback)
int	MXC_ADC_StartConversionDMA (mxc_adc_chsel_t channel, uint16_t *data, void(*callback)(int, int))
int	MXC_ADC_Handler (void)
int	MXC_ADC_Convert (mxc_adc_conversion_req_t *req)
int	MXC_ADC_ConvertAsync (mxc_adc_conversion_req_t *req)
void	MXC_ADC_Monitor (mxc_adc_monitor_req_t req)
void	MXC_ADC_MonitorAsync (mxc_adc_monitor_req_t req)
int	MXC_ADC_GetData (uint16_t *outdata)

Detailed Description

---

Data Structure Documentation

mxc_adc_monitor_req_t

struct mxc_adc_monitor_req_t

Used to set up a monitor to watch a channel.

Data Fields
mxc_adc_monitor_t	monitor
mxc_adc_scale_t	scale
mxc_adc_chsel_t	channel
int	lowThreshold
int	highThreshold
mxc_adc_monitor_cb_t	callback

mxc_adc_conversion_req_t

struct mxc_adc_conversion_req_t

Used to set up channel for conversion.

Data Fields
mxc_adc_chsel_t	channel
mxc_adc_scale_t	scale
int	rawADCValue
mxc_adc_complete_cb_t	callback

Enumeration Type Documentation

mxc_adc_chsel_t

enum mxc_adc_chsel_t

Enumeration type for the ADC Input Channels

mxc_adc_scale_t

enum mxc_adc_scale_t

Enumeration type for ADC Scale values Internal ADC channels automatically use the most appropriate scale.

Enumerator
MXC_ADC_SCALE_2X	ADC Scale by 2x.
MXC_ADC_SCALE_1	ADC Scale by 1x (no scaling)
MXC_ADC_SCALE_2	ADC Scale by 1/2.

Function Documentation

MXC_ADC_Busy()

int MXC_ADC_Busy

(

void

)

Checks if the ADC is busy (performing a conversion)

Returns

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

MXC_ADC_ClearFlags()

void MXC_ADC_ClearFlags

(

uint32_t

flags

)

Clear interrupt flag(s) using the mask parameter. All bits set in the parameter will be cleared.

Parameters

flags

Interrupt flags to clear. See the ADC_INTR Register for the interrupt flag masks

MXC_ADC_Convert()

int MXC_ADC_Convert

(

mxc_adc_conversion_req_t *

req

)

Perform a conversion on a specific channel.

Note

The result will be placed back in the request structure

Parameters

req	The structure containing all information for the conversion

Returns

Error Codes for error.

MXC_ADC_ConvertAsync()

int MXC_ADC_ConvertAsync

(

mxc_adc_conversion_req_t *

req

)

Perform a conversion on a specific channel.

Note

The result will be placed back in the request structure The ADC interrupt must be enabled and MXC_ADC_Handler() called in the ISR

Parameters

req	The structure containing all information for the conversion

Returns

return E_NO_ERROR OR E_BUSY

MXC_ADC_DisableInt()

void MXC_ADC_DisableInt

(

uint32_t

flags

)

Disable ADC interrupts based on mask.

Parameters

flags

ADC interrupts to disable. See ADC_INTR Register for the interrupt enable bit masks.

MXC_ADC_DisableMonitor()

void MXC_ADC_DisableMonitor

(

mxc_adc_monitor_t

monitor

)

Disable channel high/low monitor.

Note

This function only disables an already configured monitor

Parameters

monitor

The monitor to disable or mxc_adc_monitor_t

MXC_ADC_DisableMonitorAsync()

void MXC_ADC_DisableMonitorAsync

(

mxc_adc_monitor_t

monitor

)

Disable a callback for a monitor.

Parameters

monitor

the monitor to unregister callback for or mxc_adc_monitor_t

MXC_ADC_EnableInt()

void MXC_ADC_EnableInt

(

uint32_t

flags

)

Enables the ADC interrupts specified by the mask parameter.

Parameters

flags

ADC interrupts to enable. See ADC_INTR Register for the interrupt enable bit masks.

MXC_ADC_EnableMonitor()

void MXC_ADC_EnableMonitor

(

mxc_adc_monitor_t

monitor

)

Enable channel high/low monitor.

Note

This function only enables an already configured monitor

Parameters

monitor

The monitor to enable or mxc_adc_monitor_t

MXC_ADC_EnableMonitorAsync()

void MXC_ADC_EnableMonitorAsync	(	mxc_adc_monitor_t	monitor,
		mxc_adc_monitor_cb_t	callback
	)

Set a callback to be called when a monitor goes out of range.

Note

The ADC interrupt must be enabled and MXC_ADC_Handler() called in the ISR

Parameters

monitor	the monitor to register callback for or mxc_adc_monitor_t
callback	the function called when the limit is hit or mxc_adc_monitor_cb_t

MXC_ADC_GetConversionSpeed()

int MXC_ADC_GetConversionSpeed

(

void

)

Gets the current ADC conversion speed.

Returns

Actual conversion speed, or Error Codes for Error.

MXC_ADC_GetData()

int MXC_ADC_GetData

(

uint16_t *

outdata

)

Gets the result from the previous ADC conversion.

Parameters

outdata

Pointer to store the ADC data conversion result

Returns

E_OVERFLOW ADC overflow error

E_NO_ERROR Data returned in outdata parameter

MXC_ADC_GetFlags()

uint32_t MXC_ADC_GetFlags

(

void

)

Get interrupt flags.

Returns

ADC Interrupt flags bit mask. See the ADC_INTR Register for the interrupt flag masks.

MXC_ADC_GetMonitorChannel()

int MXC_ADC_GetMonitorChannel

(

mxc_adc_monitor_t

monitor

)

Get the channel used by a monitor.

Parameters

monitor

the monitor to set the limit on or mxc_adc_monitor_t

Returns

the channel being monitored

MXC_ADC_GetMonitorHighThreshold()

int MXC_ADC_GetMonitorHighThreshold

(

mxc_adc_monitor_t

monitor

)

Set the high limit for a specific monitor.

Parameters

monitor

the monitor to set the limit on or mxc_adc_monitor_t

Returns

the monitor's high threshold

MXC_ADC_GetMonitorLowThreshold()

int MXC_ADC_GetMonitorLowThreshold

(

mxc_adc_monitor_t

monitor

)

Set the low limit for a specific monitor.

Parameters

monitor

the monitor to set the limit on or mxc_adc_monitor_t

Returns

the monitor's low threshold

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

(

void

)

Initialize the ADC hardware.

Returns

E_NO_ERROR if successful

MXC_ADC_Monitor()

void MXC_ADC_Monitor

(

mxc_adc_monitor_req_t

req

)

Monitor a specific channel for an out of range event.

Note

synchronously waits for an out of range event to occur on the monitor

Parameters

req	The structure containing all information for monitoring

MXC_ADC_MonitorAsync()

void MXC_ADC_MonitorAsync

(

mxc_adc_monitor_req_t

req

)

Monitor a specific channel for an out of range event.

Note

If a callback is included, the ADC interrupt must be enabled and MXC_ADC_Handler() called in the ISR

Parameters

req	The structure containing all information for monitoring

MXC_ADC_SetConversionSpeed()

int MXC_ADC_SetConversionSpeed

(

uint32_t

hz

)

Sets the ADC conversion speed.

Parameters

hz	conversion frequency

Returns

Actual conversion speed, or Error Codes for Error.

MXC_ADC_SetDataAlignment()

void MXC_ADC_SetDataAlignment

(

int

msbJustify

)

Set the data alignment.

Parameters

msbJustify

Setting this to a non-zero number will fill the 12 most significant bits of the data registers. Otherwise, the 12 Least significant bits will be filled.

MXC_ADC_SetExtScale()

void MXC_ADC_SetExtScale

(

mxc_adc_scale_t

scale

)

Sets the scaling used for conversions on external channels.

Note

Internal channels are approx. known and have fixed scaling Externals channels can be scaled with standard scaling (1-4x) Or by using a separate 1/2 input scale, or a 1/2 ref scale (total range 0.5-8x)

Parameters

scale

requested scale or mxc_adc_scale_t

MXC_ADC_SetMonitorChannel()

void MXC_ADC_SetMonitorChannel	(	mxc_adc_monitor_t	monitor,
		mxc_adc_chsel_t	channel
	)

Set a monitor to use a specific channel.

Note

The monitor must be enabled separately

Parameters

monitor	the monitor to set the limit on or mxc_adc_monitor_t
channel	the channel to monitor or mxc_adc_chsel_t

MXC_ADC_SetMonitorHighThreshold()

void MXC_ADC_SetMonitorHighThreshold	(	mxc_adc_monitor_t	monitor,
		uint32_t	threshold
	)

Set the high limit for a specific monitor.

Note

setting a value of 0 disables this limit

Parameters

monitor	the monitor to set the limit on or mxc_adc_monitor_t
threshold	the limit to set

MXC_ADC_SetMonitorLowThreshold()

void MXC_ADC_SetMonitorLowThreshold	(	mxc_adc_monitor_t	monitor,
		uint32_t	threshold
	)

Set the low limit for a specific monitor.

Note

setting a value of 0 disables this limit

Parameters

monitor	the monitor to set the limit on or mxc_adc_monitor_t
threshold	the limit to set

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_StartConversion()

int MXC_ADC_StartConversion

(

mxc_adc_chsel_t

channel

)

Start ADC conversion on the selected channel.

Parameters

channel

Channel select from mxc_adc_chsel_t

Returns

Data read in the conversion if successful, an error code otherwise

MXC_ADC_StartConversionAsync()

int MXC_ADC_StartConversionAsync	(	mxc_adc_chsel_t	channel,
		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

channel	the channel to perform the conversion on or mxc_adc_chsel_t
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_chsel_t	channel,
		uint16_t *	data,
		void(*)(int, int)	callback
	)

Perform a conversion on a specific channel.

Note

The channel must be configured separately

Parameters

channel	the channel to perform the conversion on or mxc_adc_chsel_t
data	return rax adc data
callback	DMA complete callback

Returns

Raw conversion value, or Error Codes for error.