MAX32680 Peripheral Driver API
Peripheral Driver API for the MAX32680
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Modules
Modules | Enumerations | Functions
Analog to Digital Converter (ADC)

Modules

 ADC_Registers
 

Enumerations

enum  mxc_adc_chsel_t
 
enum  mxc_adc_monitor_t
 
enum  mxc_adc_scale_t
 
enum  mxc_adc_ref_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)
 
int 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_RefSelect (mxc_adc_ref_t ref)
 
void MXC_ADC_EnableMonitor (mxc_adc_monitor_t monitors)
 
void MXC_ADC_DisableMonitor (mxc_adc_monitor_t monitors)
 
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_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)
 
void MXC_ADC_EnableComparators (uint32_t mask)
 
void MXC_ADC_DisableComparators (uint32_t mask)
 
int MXC_ADC_GetData (uint16_t *outdata)
 

Detailed Description

Enumeration Type Documentation

◆ mxc_adc_chsel_t

enum mxc_adc_chsel_t

Enumeration type for the ADC Input Channels

◆ mxc_adc_monitor_t

enum mxc_adc_monitor_t

Enumeration type for the ADC Monitors 4 Monitors exist and can be mapped to any ADC channels

◆ mxc_adc_ref_t

enum mxc_adc_ref_t

Enumeration type for ADC reference sources

◆ mxc_adc_scale_t

enum mxc_adc_scale_t

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

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)

Performs the ADC startup procedure.

Parameters
flagsmask of flags to clear

◆ 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
reqThe 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
reqThe structure containing all information for the conversion
Returns
return E_NO_ERROR OR E_BUSY

◆ MXC_ADC_DisableComparators()

void MXC_ADC_DisableComparators ( uint32_t  mask)

Disable the Comparators.

Parameters
maskusing mxc_adc_comp_t enum to create the mask of comparators to enable

◆ MXC_ADC_DisableInt()

void MXC_ADC_DisableInt ( uint32_t  flags)

Disable specific ADC interrupts.

Parameters
flagsmask of interrupt flags to enables

◆ MXC_ADC_DisableMonitor()

void MXC_ADC_DisableMonitor ( mxc_adc_monitor_t  monitors)

Disable channel high/low monitor.

Note
This function only disables an already configured monitor
Parameters
monitorsThe monitor(s) to disable

◆ MXC_ADC_DisableMonitorAsync()

void MXC_ADC_DisableMonitorAsync ( mxc_adc_monitor_t  monitor)

Disable a callback for a monitor.

Parameters
monitorthe monitor to unregister callback for

◆ MXC_ADC_EnableComparators()

void MXC_ADC_EnableComparators ( uint32_t  mask)

Enable the Comparators.

Parameters
maskusing mxc_adc_comp_t enum to create the mask of comparators to enable

◆ MXC_ADC_EnableInt()

void MXC_ADC_EnableInt ( uint32_t  flags)

Enable specific ADC interrupts.

Parameters
flagsmask of interrupt flags to enables

◆ MXC_ADC_EnableMonitor()

void MXC_ADC_EnableMonitor ( mxc_adc_monitor_t  monitors)

Enable channel high/low monitor.

Note
This function only enables an already configured monitor
Parameters
monitorsThe monitor(s) to enable

◆ 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
monitorthe monitor to register callback for
callbackthe function called when the limit is hit

◆ 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
outdataPointer to store the ADC data conversion result
Returns
E_OVERFLOW ADC overflow error
E_NO_ERROR Data returned in outdata parameter

◆ MXC_ADC_GetFlags()

int MXC_ADC_GetFlags ( void  )

Performs the ADC startup procedure.

Returns
active flags

◆ MXC_ADC_GetMonitorChannel()

int MXC_ADC_GetMonitorChannel ( mxc_adc_monitor_t  monitor)

Get the channel used by a monitor.

Parameters
monitorthe monitor to set the limit on
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
monitorthe monitor to set the limit on
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
monitorthe monitor to set the limit on
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  )

Performs the ADC startup procedure.

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

◆ 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
reqThe 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
reqThe structure containing all information for monitoring

◆ MXC_ADC_RefSelect()

void MXC_ADC_RefSelect ( mxc_adc_ref_t  ref)

Select the ADC reference source.

Parameters
refThe ADC reference to use

◆ MXC_ADC_SetConversionSpeed()

int MXC_ADC_SetConversionSpeed ( uint32_t  hz)

Sets the ADC conversion speed.

Parameters
hzDesired clock freuquency for ADC conversion.
Returns
Actual conversion speed, or Error Codes for Error.

◆ MXC_ADC_SetDataAlignment()

void MXC_ADC_SetDataAlignment ( int  msbJustify)

Gets the current ADC conversion speed.

Parameters
msbJustifyset this bit to fill the 12 most significant bits of the data registers

◆ MXC_ADC_SetExtScale()

void MXC_ADC_SetExtScale ( mxc_adc_scale_t  scale)

Sets the scaling used for conversions on external channels.

Parameters
scalerequested scale

◆ 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
monitorthe monitor to set the limit on
channelthe channel to monitor

◆ 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
monitorthe monitor to set the limit on
thresholdthe 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
monitorthe monitor to set the limit on
thresholdthe 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)

Perform a conversion on a specific channel.

Note
The channel must be configured separately
Parameters
channelthe channel to perform the conversion on
Returns
Raw conversion value, or Error Codes for error.

◆ 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
channelthe channel to perform the conversion on
callbackthe function to call when the conversion is complete
Returns
Success/Fail, see Error Codes for a list of return codes.