AVR1631 - Energy Meter Reference Design with ATxmega32A4  Rev 1.0
 All Data Structures Files Functions Variables Typedefs Macros
adc_driver.h File Reference

XMEGA ADC driver header file. More...

#include "avr_compiler.h"

Go to the source code of this file.

Macros

#define COMMON_MODE_CYCLES   16
#define ADC_Enable(_adc)   ((_adc)->CTRLA |= ADC_ENABLE_bm)
 This macro enables the selected adc.
#define ADC_Disable(_adc)   ((_adc)->CTRLA = (_adc)->CTRLA & (~ADC_ENABLE_bm))
 This macro disables the selected adc.
#define ADC_Pipeline_Flush(_adc)   ((_adc)->CTRLA |= ADC_FLUSH_bm)
 This macro flushes the pipline in the selected adc.
#define ADC_ConvMode_and_Resolution_Config(_adc, _signedMode, _resolution)
 This macro set the conversion mode and resolution in the selected adc.
#define ADC_ConvMode_Signed   true
 Helper macro for increased readability with ADC_ConvMode_and_Resolution_Config.
#define ADC_ConvMode_Unsigned   false
 Helper macro for increased readability with ADC_ConvMode_and_Resolution_Config.
#define ADC_Prescaler_Config(_adc, _div)   ((_adc)->PRESCALER = ((_adc)->PRESCALER & (~ADC_PRESCALER_gm)) | _div)
 This macro set the prescaler factor in the selected adc.
#define ADC_Reference_Config(_adc, _convRef)   ((_adc)->REFCTRL = ((_adc)->REFCTRL & ~(ADC_REFSEL_gm)) | _convRef)
 This macro set the conversion reference in the selected adc.
#define ADC_SweepChannels_Config(_adc, _sweepChannels)   ((_adc)->EVCTRL = ((_adc)->EVCTRL & (~ADC_SWEEP_gm)) | _sweepChannels)
 This macro sets the sweep channel settings.
#define ADC_Events_Config(_adc, _eventChannels, _eventMode)
 This macro configures the event channels used and the event mode.
#define ADC_Ch_Interrupts_Config(_adc_ch, _interruptMode, _interruptLevel)
 This macro configures the interrupt mode and level for one channel.
#define ADC_Ch_InputMode_and_Gain_Config(_adc_ch, _inputMode, _gain)
 This macro configures the input mode and gain to a specific virtual channel.
#define ADC_DRIVER_CH_GAIN_NONE   ADC_CH_GAIN_1X_gc
 Helper macro for increased readability with ADC_Ch_InputMode_and_Gain_Config.
#define ADC_Ch_InputMux_Config(_adc_ch, _posInput, _negInput)   ((_adc_ch)->MUXCTRL = (uint8_t) _posInput | _negInput)
 This macro configures the Positiv and negativ inputs.
#define ADC_Ch_Conversion_Complete(_adc_ch)   (((_adc_ch)->INTFLAGS & ADC_CH_CHIF_bm) != 0x00)
 This macro returns the channel conversion complete flag..
#define ADC_CompareValue_Set(_adc, _value)   ((_adc)->CMP = _value)
 This macro sets the value in the ADC compare register.
#define ADC_FreeRunning_Enable(_adc)   ((_adc)->CTRLB |= ADC_FREERUN_bm)
 This macro enables the Free Running mode in the selected adc.
#define ADC_FreeRunning_Disable(_adc)   ((_adc)->CTRLB = (_adc)->CTRLB & (~ADC_FREERUN_bm))
 This macro disables the Free Running mode in the selected adc.
#define ADC_Low_Impedance_Mode(_adc)   ((_adc)->CTRLB |= ADC_IMPMODE_bm)
#define ADC_High_Impedence_Mode(_adc)   ((_adc)->CTRLB = (_adc)->CTRLB & (~ADC_IMPMODE_bm))
#define ADC_Ch_Conversion_Start(_adc_ch)   ((_adc_ch)->CTRL |= ADC_CH_START_bm)
 This macro starts one channel conversion.
#define ADC_Conversions_Start(_adc, _channelMask)
 This macro starts multiple channel conversions.
#define ADC_BandgapReference_Enable(_adc)   ((_adc)->REFCTRL |= ADC_BANDGAP_bm)
 This macro pre enables the Bandgap Reference.
#define ADC_BandgapReference_Disable(_adc)   ((_adc)->REFCTRL &= ~ADC_BANDGAP_bm)
 This macro disables the pre enabled the Bandgap Reference.
#define ADC_TempReference_Enable(_adc)   ((_adc)->REFCTRL |= ADC_TEMPREF_bm)
 This macro makes sure that the temperature reference circuitry is enabled.
#define ADC_TempReference_Disable(_adc)   ((_adc)->REFCTRL = (_adc)->REFCTRL & (~ADC_TEMPREF_bm))
 This macro disables the temperature reference.
Deprecated functions

Deprecated functions: Compatibility with previous application note version. These functions will be removed in later releases of the driver

#define ADC_Referance_Config(_adc, _convRef)   ADC_Reference_Config(_adc, _convRef)
#define ADC_CalibrationValues_Set(_adc)   ADC_CalibrationValues_Load(_adc)
GCC compatibility macros

Offset addresses for production signature row on which is not in current GCC header files

#define ADCACAL0_offset   0x20
#define ADCACAL1_offset   0x21
#define ADCBCAL0_offset   0x24
#define ADCBCAL1_offset   0x25

Functions

uint8_t SP_ReadCalibrationByte (uint8_t index)
void ADC_CalibrationValues_Load (ADC_t *adc)
 This function get the calibration data from the production calibration.
uint16_t ADC_ResultCh_GetWord_Unsigned (ADC_CH_t *adc_ch, uint16_t offset)
 This function clears the interrupt flag and returns the unsigned coversion result.
int16_t ADC_ResultCh_GetWord_Signed (ADC_CH_t *adc_ch, int16_t offset)
 This function clears the interrupt flag and returns the signed coversion result.
uint16_t ADC_Offset_Get_Unsigned (ADC_t *adc, ADC_CH_t *ch, bool oversampling)
 This function gets the offset of the ADC when it is configured in unsigned mode.
int16_t ADC_Offset_Get_Signed (ADC_t *adc, ADC_CH_t *ch, bool oversampling)
 This function gets the offset of the ADC when it is configured in signed mode.
uint16_t ADC_ResultCh_GetWord (ADC_CH_t *adc_ch)
 This function clears the interrupt flag and returns the coversion result without compensating for offset.
uint8_t ADC_ResultCh_GetLowByte (ADC_CH_t *adc_ch)
 This function clears the interrupt flag and returns the low byte of the coversion result.
uint8_t ADC_ResultCh_GetHighByte (ADC_CH_t *adc_ch)
 This function clears the interrupt flag and returns the high byte of the coversion result.
void ADC_Wait_8MHz (ADC_t *adc)
 This function waits until the adc common mode is settled.
void ADC_Wait_32MHz (ADC_t *adc)
 This function waits until the adc common mode is settled.

Detailed Description

XMEGA ADC driver header file.

 This file contains the function prototypes and enumerator definitions
 for various configuration parameters for the XMEGA ADC driver that is
 implemented in C.

 The driver is not intended for size and/or speed critical code, since
 most functions are just a few lines of code, and the function call
 overhead would decrease code performance. The driver is intended for
 rapid prototyping and documentation purposes for getting started with
 the XMEGA ADC module.

 For size and/or speed critical code, it is recommended to copy the
 function contents directly into your application instead of making
 a function call.
Application note:
AVR1300: Using the XMEGA ADC
Documentation
For comprehensive code documentation, supported compilers, compiler settings and supported devices see readme.html
Author
Atmel Corporation: http://www.atmel.com
Support email: avr@a.nosp@m.tmel.nosp@m..com
Revision:
2644
Date:
2009-08-04 12:37:51 +0200 (ti, 04 aug 2009)


Copyright (c) 2008, Atmel Corporation All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  1. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  1. The name of ATMEL may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file adc_driver.h.

Macro Definition Documentation

#define ADC_BandgapReference_Disable (   _adc)    ((_adc)->REFCTRL &= ~ADC_BANDGAP_bm)

This macro disables the pre enabled the Bandgap Reference.

Parameters
_adcPointer to ADC module register section.

Definition at line 328 of file adc_driver.h.

#define ADC_BandgapReference_Enable (   _adc)    ((_adc)->REFCTRL |= ADC_BANDGAP_bm)

This macro pre enables the Bandgap Reference.

Note
If the ADC is enabled the Bandgap Reference is automaticly enabled.
Parameters
_adcPointer to ADC module register section.

Definition at line 321 of file adc_driver.h.

#define ADC_Ch_Conversion_Complete (   _adc_ch)    (((_adc_ch)->INTFLAGS & ADC_CH_CHIF_bm) != 0x00)

This macro returns the channel conversion complete flag..

Parameters
_adc_chPointer to ADC Channel register section.
Returns
value of channels conversion complete flag.

Definition at line 243 of file adc_driver.h.

#define ADC_Ch_Conversion_Start (   _adc_ch)    ((_adc_ch)->CTRL |= ADC_CH_START_bm)

This macro starts one channel conversion.

Use the ADC_GetWordResultCh or ADC_GetByteResultCh functions to retrieve the conversion result. This macro is not to be used when the ADC is running in free-running mode.

Parameters
_adc_chPointer to ADC Channel module register section.

Definition at line 295 of file adc_driver.h.

#define ADC_Ch_InputMode_and_Gain_Config (   _adc_ch,
  _inputMode,
  _gain 
)
Value:
(_adc_ch)->CTRL = ((_adc_ch)->CTRL & \
(~(ADC_CH_INPUTMODE_gm|ADC_CH_GAIN_gm))) | \
((uint8_t) _inputMode|_gain)

This macro configures the input mode and gain to a specific virtual channel.

Parameters
_adc_chPointer to ADC channel register section.
_inputModeInput mode for this channel, differential, single-ended, gain etc. Use ADC_CH_INPUTMODE_t type.
_gainThe preamplifiers gain value. Use ADC_CH_GAINFAC_t type.

Definition at line 210 of file adc_driver.h.

#define ADC_Ch_InputMux_Config (   _adc_ch,
  _posInput,
  _negInput 
)    ((_adc_ch)->MUXCTRL = (uint8_t) _posInput | _negInput)

This macro configures the Positiv and negativ inputs.

Parameters
_adc_chWhich ADC channel to configure.
_posInputWhich pin (or internal signal) to connect to positive ADC input. Use ADC_CH_MUXPOS_enum type.
_negInputWhich pin to connect to negative ADC input. Use ADC_CH_MUXNEG_t type.
Note
The negative input is connected to GND for single-ended and internal input modes.

Definition at line 233 of file adc_driver.h.

#define ADC_Ch_Interrupts_Config (   _adc_ch,
  _interruptMode,
  _interruptLevel 
)
Value:
(_adc_ch)->INTCTRL = (((_adc_ch)->INTCTRL & \
(~(ADC_CH_INTMODE_gm | ADC_CH_INTLVL_gm))) | \
((uint8_t) _interruptMode | _interruptLevel))

This macro configures the interrupt mode and level for one channel.

The interrupt mode affects the interrupt flag for the virtual channel, and thus also affects code that polls this flag instead of using interrupts.

Note
When using the result comparator function, the compare value must be set using the ADC_SetCompareValue function.
Parameters
_adc_chPointer to ADC channel register section.
_interruptModeInterrupt mode, flag on complete or above/below compare value. Use ADC_CH_INTMODE_t type.
_interruptLevelDisable or set low/med/high priority for this virtual channel. Use ADC_CH_INTLVL_t type.

Definition at line 195 of file adc_driver.h.

#define ADC_CompareValue_Set (   _adc,
  _value 
)    ((_adc)->CMP = _value)

This macro sets the value in the ADC compare register.

The value in the ADC compare register is used by the result comparator for channels that are configured to notify when result is above or below this value. Even if the ADC compare value register is always left adjusted, the input to this function is adjusted according to the result presentation setup for the ADC. This means that the value will be right adjusted unless the "12-bit left adjust" result mode is selected with ADC_ConvMode_and_Resolution_Config.

Parameters
_adcPointer to ADC module register section.
_value12-bit value used by the result comparator. Use uint16_t type.

Definition at line 260 of file adc_driver.h.

#define ADC_Conversions_Start (   _adc,
  _channelMask 
)
Value:
(_adc)->CTRLA |= _channelMask & \
(ADC_CH0START_bm | ADC_CH1START_bm | \
ADC_CH2START_bm | ADC_CH3START_bm)

This macro starts multiple channel conversions.

This macro starts a conversion for the channels selected by the channel mask parameter. Use the bit mask defines for each channel and combine them into one byte using bitwise OR. The available masks are ADC_CH0START_bm, ADC_CH1START_bm, ADC_CH2START_bm and ADC_CH3START_bm.

Parameters
_adcPointer to ADC module register section.
_channelMaskA bitmask selecting which channels to check.

Definition at line 309 of file adc_driver.h.

#define ADC_ConvMode_and_Resolution_Config (   _adc,
  _signedMode,
  _resolution 
)
Value:
((_adc)->CTRLB = ((_adc)->CTRLB & (~(ADC_RESOLUTION_gm|ADC_CONMODE_bm)))| \
(_resolution| ( _signedMode? ADC_CONMODE_bm : 0)))

This macro set the conversion mode and resolution in the selected adc.

This macro configures the conversion mode to signed or unsigned and set the resolution in and the way the results are put in the result registers.

Parameters
_adcPointer to ADC module register section
_signedModeSelects conversion mode: signed (true) or unsigned (false). USE bool type.
_resolutionResolution and presentation selection. Use ADC_RESOLUTION_t type.

Definition at line 111 of file adc_driver.h.

#define ADC_ConvMode_Signed   true

Helper macro for increased readability with ADC_ConvMode_and_Resolution_Config.

See Also
ADC_ConvMode_and_Resolution_Config

Definition at line 119 of file adc_driver.h.

#define ADC_ConvMode_Unsigned   false

Helper macro for increased readability with ADC_ConvMode_and_Resolution_Config.

See Also
ADC_ConvMode_and_Resolution_Config

Definition at line 125 of file adc_driver.h.

#define ADC_Disable (   _adc)    ((_adc)->CTRLA = (_adc)->CTRLA & (~ADC_ENABLE_bm))

This macro disables the selected adc.

Parameters
_adcPointer to ADC module register section

Definition at line 89 of file adc_driver.h.

#define ADC_DRIVER_CH_GAIN_NONE   ADC_CH_GAIN_1X_gc

Helper macro for increased readability with ADC_Ch_InputMode_and_Gain_Config.

See Also
ADC_Ch_InputMode_and_Gain_Config

Definition at line 220 of file adc_driver.h.

#define ADC_Enable (   _adc)    ((_adc)->CTRLA |= ADC_ENABLE_bm)

This macro enables the selected adc.

Before the ADC is enabled the first time the function ADC_CalibrationValues_Set should be used to reduce the gain error in the ADC.

Note
After the ADC is enabled the commen mode voltage in the ADC is ready after 12 ADC clock cycels. Do one dummy conversion or wait the required number of clock cycles to reasure correct conversion.
Parameters
_adcPointer to ADC module register section.

Definition at line 83 of file adc_driver.h.

#define ADC_Events_Config (   _adc,
  _eventChannels,
  _eventMode 
)
Value:
\ \
(_adc)->EVCTRL = ((_adc)->EVCTRL & (~(ADC_EVSEL_gm | ADC_EVACT_gm))) | \
((uint8_t) _eventChannels | _eventMode)

This macro configures the event channels used and the event mode.

This macro configures the way events are used to trigger conversions for the virtual channels. Use the eventChannels parameter to select which event channel to associate with virtual channel 0 or to trigger a conversion sweep, depending on the selected eventMode parameter.

Parameters
_adcPointer to ADC module register section.
_eventChannelsThe first event channel to be used for triggering. Use ADC_EVSEL_t type.
_eventModeSelect event trigger mode. Use ADC_EVACT_t type.

Definition at line 176 of file adc_driver.h.

#define ADC_FreeRunning_Disable (   _adc)    ((_adc)->CTRLB = (_adc)->CTRLB & (~ADC_FREERUN_bm))

This macro disables the Free Running mode in the selected adc.

Parameters
_adcPointer to ADC module register section.

Definition at line 274 of file adc_driver.h.

#define ADC_FreeRunning_Enable (   _adc)    ((_adc)->CTRLB |= ADC_FREERUN_bm)

This macro enables the Free Running mode in the selected adc.

Parameters
_adcPointer to ADC module register section.

Definition at line 267 of file adc_driver.h.

#define ADC_Pipeline_Flush (   _adc)    ((_adc)->CTRLA |= ADC_FLUSH_bm)

This macro flushes the pipline in the selected adc.

Parameters
_adcPointer to ADC module register section

Definition at line 95 of file adc_driver.h.

#define ADC_Prescaler_Config (   _adc,
  _div 
)    ((_adc)->PRESCALER = ((_adc)->PRESCALER & (~ADC_PRESCALER_gm)) | _div)

This macro set the prescaler factor in the selected adc.

This macro configures the division factor between the XMEGA IO-clock and the ADC clock. Given a certain IO-clock, the prescaler must be configured so the the ADC clock is within recommended limits. A faster IO-clock required higher division factors.

Note
The maximum ADC sample rate is always one fourth of the IO clock.
Parameters
_adcPointer to ADC module register section.
_divADC prescaler division factor setting. Use ADC_PRESCALER_t type

Definition at line 140 of file adc_driver.h.

#define ADC_Reference_Config (   _adc,
  _convRef 
)    ((_adc)->REFCTRL = ((_adc)->REFCTRL & ~(ADC_REFSEL_gm)) | _convRef)

This macro set the conversion reference in the selected adc.

Parameters
_adcPointer to ADC module register section.
_convRefSelects reference voltage for all conversions. Use ADC_REFSEL_t type.

Definition at line 150 of file adc_driver.h.

#define ADC_SweepChannels_Config (   _adc,
  _sweepChannels 
)    ((_adc)->EVCTRL = ((_adc)->EVCTRL & (~ADC_SWEEP_gm)) | _sweepChannels)

This macro sets the sweep channel settings.

Parameters
_adcPointer to ADC module register section.
_sweepChannelsSweep channel selection. Use ADC_SWEEP_t type

Definition at line 159 of file adc_driver.h.

#define ADC_TempReference_Disable (   _adc)    ((_adc)->REFCTRL = (_adc)->REFCTRL & (~ADC_TEMPREF_bm))

This macro disables the temperature reference.

Parameters
_adcPointer to ADC module register section.

Definition at line 344 of file adc_driver.h.

#define ADC_TempReference_Enable (   _adc)    ((_adc)->REFCTRL |= ADC_TEMPREF_bm)

This macro makes sure that the temperature reference circuitry is enabled.

Note
Enabling the temperature reference automatically enables the bandgap reference.
Parameters
_adcPointer to ADC module register section.

Definition at line 337 of file adc_driver.h.

Function Documentation

void ADC_CalibrationValues_Load ( ADC_t *  adc)

This function get the calibration data from the production calibration.

The calibration data is loaded from flash and stored in the calibration register. The calibration data reduces the non-linearity error in the adc.

Parameters
adcPointer to ADC module register section.

Definition at line 77 of file adc_driver.c.

int16_t ADC_Offset_Get_Signed ( ADC_t *  adc,
ADC_CH_t *  ch,
bool  oversampling 
)

This function gets the offset of the ADC when it is configured in signed mode.

This function does one or several measurements to determine the offset of the ADC.

Note
The ADC must be configured and enabled before this function is run.
This function only return the low byte of the 12-bit convertion, because the offset should never be more than +-8 LSB off.
Parameters
adcPointer to the ADC to calculate offset from.
chPointer to the ADC channel to measure on.
oversamplingfalse for one measurement. true for averaging several measurements.
Returns
Offset on the selected ADC

Definition at line 320 of file adc_driver.c.

uint16_t ADC_Offset_Get_Unsigned ( ADC_t *  adc,
ADC_CH_t *  ch,
bool  oversampling 
)

This function gets the offset of the ADC when it is configured in unsigned mode.

This function does one or several measurements to determine the offset of the ADC.

Note
The ADC must be configured and enabled before this function is run.
This function only return the low byte of the 12-bit convertion, because the offset should never be more than +-8 LSB off.
Parameters
adcPointer to the ADC to calculate offset from.
chPointer to the ADC channel to measure on.
oversamplingfalse for one measurement. true for averaging several measurements.
Returns
Offset on the selected ADC

Definition at line 273 of file adc_driver.c.

uint8_t ADC_ResultCh_GetHighByte ( ADC_CH_t *  adc_ch)

This function clears the interrupt flag and returns the high byte of the coversion result.

 This funtion should be used together with the ADC_ResultCh_ConversionComplete.
When the conversion result is ready this function reads out the result.
Note
If this function is used with 12-bit right adjusted results, it returns the 8 LSB only. Offset is not compensated.
Parameters
adc_chPointer to ADC channel register section.
Returns
High byte of conversion result.

Definition at line 188 of file adc_driver.c.

uint8_t ADC_ResultCh_GetLowByte ( ADC_CH_t *  adc_ch)

This function clears the interrupt flag and returns the low byte of the coversion result.

 This funtion should be used together with the ADC_Ch_Conversion_Complete.
When the conversion result is ready this funciton reads out the result.
Note
If this function is used with 12-bit right adjusted results, it returns the 8 LSB only. Offset is not compensated.
Parameters
adc_chPointer to ADC channel register section.
Returns
Low byte of conversion result.

Definition at line 168 of file adc_driver.c.

uint16_t ADC_ResultCh_GetWord ( ADC_CH_t *  adc_ch)

This function clears the interrupt flag and returns the coversion result without compensating for offset.

 This function should be used together with the ADC_Ch_Conversion_Complete.
When the conversion result is ready this funciton reads out the result.
Parameters
adc_chPointer to ADC channel register section.
Returns
Signed conversion result.

Definition at line 146 of file adc_driver.c.

int16_t ADC_ResultCh_GetWord_Signed ( ADC_CH_t *  adc_ch,
int16_t  signedOffset 
)

This function clears the interrupt flag and returns the signed coversion result.

 This function should be used together with the ADC_Ch_Conversion_Complete.
When the conversion result is ready this funciton reads out the result.
Parameters
adc_chPointer to ADC channel register section.
signedOffsetOffset value to subtract.
Returns
The signed Conversion result with the offset substracted.

Definition at line 125 of file adc_driver.c.

uint16_t ADC_ResultCh_GetWord_Unsigned ( ADC_CH_t *  adc_ch,
uint16_t  offset 
)

This function clears the interrupt flag and returns the unsigned coversion result.

 This function should be used together with the ADC_Ch_Conversion_Complete.
When the conversion result is ready this funciton reads out the result.
Parameters
adc_chPointer to ADC channel register section.
offsetUnsigned offset value to subtract.
Returns
The unsigned Conversion result with the offset substracted.

Definition at line 102 of file adc_driver.c.

void ADC_Wait_32MHz ( ADC_t *  adc)

This function waits until the adc common mode is settled.

After the ADC clock has been turned on, the common mode voltage in the ADC need some time to settle. The time it takes equals one dummy conversion. Instead of doing a dummy conversion this function waits until the common mode is settled.

Note
The function sets the prescaler to the minimum value possible when the clock speed is larger than 8 MHz to minimize the time it takes the common mode to settle.
The ADC clock is turned off every time the ADC i disabled or the device goes into sleep (not Idle sleep mode).
Parameters
adcPointer to ADC module register section.

Definition at line 242 of file adc_driver.c.

void ADC_Wait_8MHz ( ADC_t *  adc)

This function waits until the adc common mode is settled.

After the ADC clock has been turned on, the common mode voltage in the ADC need some time to settle. The time it takes equals one dummy conversion. Instead of doing a dummy conversion this function waits until the common mode is settled.

Note
The function sets the prescaler to the minimum value to minimize the time it takes the common mode to settle. If the clock speed is higher than 8 MHz use the ADC_wait_32MHz function.
Parameters
adcPointer to ADC module register section.

Definition at line 210 of file adc_driver.c.