XMEGA ADC driver header file. More...

#include "avr_compiler.h"

Include dependency graph for adc_driver.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	ADC_BandgapReference_Disable(_adc) ((_adc)->REFCTRL &= ~ADC_BANDGAP_bm)
	This macro disables the pre enabled the Bandgap Reference. More...

#define	ADC_BandgapReference_Enable(_adc) ((_adc)->REFCTRL \|= ADC_BANDGAP_bm)
	This macro pre enables the Bandgap Reference. More...

#define	ADC_Ch_Conversion_Complete(_adc_ch) (((_adc_ch)->INTFLAGS & ADC_CH_CHIF_bm) != 0x00)
	This macro returns the channel conversion complete flag.. More...

#define	ADC_Ch_Conversion_Start(_adc_ch) ((_adc_ch)->CTRL \|= ADC_CH_START_bm)
	This macro start one channel conversion. More...

#define	ADC_Ch_InputMode_and_Gain_Config(_adc_ch, _inputMode, _gain)
	This macro configures the input mode and gain to a specific virtual channel. More...

#define	ADC_Ch_InputMux_Config(_adc_ch, _posInput, _negInput) ((_adc_ch)->MUXCTRL = (uint8_t) _posInput \| _negInput)
	This macro configures the Positiv and negativ inputs. More...

#define	ADC_Ch_Interrupts_Config(_adc_ch, _interruptMode, _interruptLevel)
	This macro configures the interrupt mode and level for one channel. More...

#define	ADC_CompareValue_Set(_adc, _value) ((_adc)->CMP = _value)
	This macro sets the value in the ADC compare register. More...

#define	ADC_Conversions_Start(_adc, _channelMask)
	This macro start multiple channel conversions. More...

#define	ADC_ConvMode_and_Resolution_Config(_adc, _signedMode, _resolution)
	This macro set the conversion mode and resolution in the selected adc. More...

#define	ADC_Disable(_adc) ((_adc)->CTRLA = (_adc)->CTRLA & (~ADC_ENABLE_bm))
	This macro disables the selected adc. More...

#define	ADC_Enable(_adc) ((_adc)->CTRLA \|= ADC_ENABLE_bm)
	This macro enables the selected adc. More...

#define	ADC_Events_Config(_adc, _eventChannels, _eventMode)
	This macro configures the event channels used and the event mode. More...

#define	ADC_FreeRunning_Disable(_adc) ((_adc)->CTRLB = (_adc)->CTRLB & (~ADC_FREERUN_bm))
	This macro disables the Free Running mode in the selected adc. More...

#define	ADC_FreeRunning_Enable(_adc) ((_adc)->CTRLB \|= ADC_FREERUN_bm)
	This macro enables the Free Running mode in the selected adc. More...

#define	ADC_Pipeline_Flush(_adc) ((_adc)->CTRLA \|= ADC_FLUSH_bm)
	This macro flushes the pipline in the selected adc. More...

#define	ADC_Prescaler_Config(_adc, _div) ((_adc)->PRESCALER = ((_adc)->PRESCALER & (~ADC_PRESCALER_gm)) \| _div)
	This macro set the prescaler factor in the selected adc. More...

#define	ADC_Referance_Config(_adc, _convRef) ((_adc)->REFCTRL = ((_adc)->REFCTRL & ~(ADC_REFSEL_gm)) \| _convRef)
	This macro set the conversion referance in the selected adc. More...

#define	ADC_SweepChannels_Config(_adc, _sweepChannels) ((_adc)->EVCTRL = ((_adc)->EVCTRL & (~ADC_SWEEP_gm)) \| _sweepChannels)
	This macro sets the sweep channel settings. More...

#define	ADC_TempReference_Disable(_adc) ((_adc)->REFCTRL = (_adc)->REFCTRL & (~ADC_TEMPREF_bm))
	This macro disables the temperature reference. More...

#define	ADC_TempReference_Enable(_adc) ((_adc)->REFCTRL \|= ADC_TEMPREF_bm)
	This macro makes sure that the temperature reference circuitry is enabled. More...

#define	COMMEN_MODE_CYCLES 16

Functions
void	ADC_CalibrationValues_Set (ADC_t *adc)
	This function get the calibration data from the production calibration. More...

uint8_t	ADC_Offset_Get (ADC_t *adc)
	This function get the offset of the ADC. More...

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. More...

uint8_t	ADC_ResultCh_GetLowByte (ADC_CH_t *adc_ch, uint8_t offset)
	This function clears the interrupt flag and returns the low byte of the coversion result. More...

uint16_t	ADC_ResultCh_GetWord (ADC_CH_t *adc_ch, uint8_t offset)
	This function clears the interrupt flag and returns the coversion result. More...

void	ADC_Wait_32MHz (ADC_t *adc)
	This function waits until the adc common mode is settled. More...

void	ADC_Wait_8MHz (ADC_t *adc)
	This function waits until the adc common mode is settled. More...

uint8_t	SP_ReadCalibrationByte (uint8_t index)

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: 1569

Date: 2008-04-22 13:03:43 +0200 (ti, 22 apr 2008)

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

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
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

◆ ADC_BandgapReference_Disable

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

This macro disables the pre enabled the Bandgap Reference.

Parameters

_adc	Pointer to ADC module register section.

Definition at line 298 of file adc_driver.h.

◆ ADC_BandgapReference_Enable

#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

_adc	Pointer to ADC module register section.

Definition at line 291 of file adc_driver.h.

◆ ADC_Ch_Conversion_Complete

#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_ch Pointer to ADC Channel register section.

Returns: value of channels conversion complete flag.

Definition at line 222 of file adc_driver.h.

Referenced by ADC_Offset_Get(), and mc_ADC_Scheduler().

◆ ADC_Ch_Conversion_Start

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

This macro start 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_ch Pointer to ADC Channel module register section.

Definition at line 265 of file adc_driver.h.

Referenced by ADC_Offset_Get().

◆ ADC_Ch_InputMode_and_Gain_Config

#define ADC_Ch_InputMode_and_Gain_Config	(	_adc_ch,
		_inputMode,
		_gain
	)

Value:

(_adc_ch)->CTRL = ((_adc_ch)->CTRL &                                   \
                      (~(ADC_CH_INPUTMODE_gm|ADC_CH_GAINFAC_gm))) |        \
                      ((uint8_t) _inputMode|_gain)

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

Parameters

_adc_ch	Pointer to ADC channel register section.
_inputMode	Input mode for this channel, differential, single-ended, gain etc. Use ADC_CH_INPUTMODE_t type.
_gain	The preamplifiers gain value. Use ADC_CH_GAINFAC_t type.

Definition at line 197 of file adc_driver.h.

Referenced by ADC_Init(), and ADC_Offset_Get().

◆ ADC_Ch_InputMux_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.

Parameters

_adc_ch	Which ADC channel to configure.
_posInput	Which pin (or internal signal) to connect to positive ADC input. Use ADC_CH_MUXPOS_enum type.
_negInput	Which 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 212 of file adc_driver.h.

Referenced by ADC_Init(), and ADC_Offset_Get().

◆ ADC_Ch_Interrupts_Config

#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_ch	Pointer to ADC channel register section.
_interruptMode	Interrupt mode, flag on complete or above/below compare value. Use ADC_CH_INTMODE_t type.
_interruptLevel	Disable or set low/med/high priority for this virtual channel. Use ADC_CH_INTLVL_t type.

Definition at line 182 of file adc_driver.h.

◆ ADC_CompareValue_Set

#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

_adc	Pointer to ADC module register section.
_value	12-bit value used by the result comparator. Use uint16_t type.

Definition at line 239 of file adc_driver.h.

◆ ADC_Conversions_Start

#define ADC_Conversions_Start	(	_adc,
		_channelMask
	)

Value:

(_adc)->CTRLA |= _channelMask &                                   \
                  (ADC_CH0START_bm | ADC_CH1START_bm |                \
                   ADC_CH2START_bm | ADC_CH3START_bm)

This macro start 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

_adc	Pointer to ADC module register section.
_channelMask	A bitmask selecting which channels to check.

Definition at line 279 of file adc_driver.h.

◆ ADC_ConvMode_and_Resolution_Config

#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

_adc	Pointer to ADC module register section
_signedMode	Selects conversion mode: signed (true) or unsigned (false). USE bool type.
_resolution	Resolution and presentation selection. Use ADC_RESOLUTION_t type.

Definition at line 110 of file adc_driver.h.

Referenced by ADC_Init(), and ADC_Offset_Get().

◆ ADC_Disable

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

This macro disables the selected adc.

Parameters

_adc	Pointer to ADC module register section

Definition at line 89 of file adc_driver.h.

Referenced by ADC_Offset_Get().

◆ ADC_Enable

#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

_adc	Pointer to ADC module register section.

Definition at line 83 of file adc_driver.h.

Referenced by ADC_Init(), and ADC_Offset_Get().

◆ ADC_Events_Config

#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

_adc	Pointer to ADC module register section.
_eventChannels	The first event channel to be used for triggering. Use ADC_EVSEL_t type.
_eventMode	Select event trigger mode. Use ADC_EVACT_t type.

Definition at line 163 of file adc_driver.h.

◆ ADC_FreeRunning_Disable

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

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

Parameters

_adc	Pointer to ADC module register section.

Definition at line 253 of file adc_driver.h.

◆ ADC_FreeRunning_Enable

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

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

Parameters

_adc	Pointer to ADC module register section.

Definition at line 246 of file adc_driver.h.

Referenced by ADC_Init().

◆ ADC_Pipeline_Flush

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

This macro flushes the pipline in the selected adc.

Parameters

_adc	Pointer to ADC module register section

Definition at line 95 of file adc_driver.h.

◆ ADC_Prescaler_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.

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

_adc	Pointer to ADC module register section.
_div	ADC prescaler division factor setting. Use ADC_PRESCALER_t type

Definition at line 127 of file adc_driver.h.

Referenced by ADC_Init(), and ADC_Offset_Get().

◆ ADC_Referance_Config

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

This macro set the conversion referance in the selected adc.

Parameters

_adc	Pointer to ADC module register section.
_convRef	Selects reference voltage for all conversions. Use ADC_REFSEL_t type.

Definition at line 137 of file adc_driver.h.

Referenced by ADC_Init(), and ADC_Offset_Get().

◆ ADC_SweepChannels_Config

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

This macro sets the sweep channel settings.

Parameters

_adc	Pointer to ADC module register section.
_sweepChannels	Sweep channel selection. Use uint8_t type

Definition at line 146 of file adc_driver.h.

◆ ADC_TempReference_Disable

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

This macro disables the temperature reference.

Parameters

_adc	Pointer to ADC module register section.

Definition at line 314 of file adc_driver.h.

◆ ADC_TempReference_Enable

#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

_adc	Pointer to ADC module register section.

Definition at line 307 of file adc_driver.h.

◆ COMMEN_MODE_CYCLES

#define COMMEN_MODE_CYCLES 16

Definition at line 66 of file adc_driver.h.

Referenced by ADC_Wait_32MHz(), and ADC_Wait_8MHz().

Function Documentation

◆ ADC_CalibrationValues_Set()

void ADC_CalibrationValues_Set ( 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 gain error in the adc.

Parameters

adc	Pointer to ADC module register section.

Definition at line 77 of file adc_driver.c.

References SP_ReadCalibrationByte().

Referenced by ADC_Init().

 {
     if(&ADCA == adc){
          /* Get ADCCAL0 from byte address 0x20 (Word address 0x10. */
         adc->CAL = SP_ReadCalibrationByte(0x20);
     }else {
         /* Get ADCCAL0 from byte address 0x24 (Word address 0x12. */
         adc->CAL = SP_ReadCalibrationByte(0x24);
     }
 }

Here is the call graph for this function:

◆ ADC_Offset_Get()

uint8_t ADC_Offset_Get ( ADC_t * adc )

This function get the offset of the ADC.

This function make an internal coupling to the same pin and calculate the internal offset in the ADC.

Note: This function only return the low byte of the 12-bit convertion, because the offset should never be more than +-8 LSB off.

Parameters

adc	Pointer to the ADC to calculate offset from.

Returns: Offset on the selected ADC

Definition at line 241 of file adc_driver.c.

References ADC_Ch_Conversion_Complete, ADC_Ch_Conversion_Start, ADC_Ch_InputMode_and_Gain_Config, ADC_Ch_InputMux_Config, ADC_ConvMode_and_Resolution_Config, ADC_Disable, ADC_Enable, ADC_Prescaler_Config, ADC_Referance_Config, ADC_ResultCh_GetLowByte(), ADC_Wait_32MHz(), offset, and SP_ReadCalibrationByte().

Referenced by ADC_Init().

 {
     uint8_t offset;
 
     /* Set up ADC to get offset. */
     ADC_ConvMode_and_Resolution_Config(adc, true, ADC_RESOLUTION_12BIT_gc);
 
     ADC_Prescaler_Config(adc , ADC_PRESCALER_DIV8_gc);
 
     ADC_Referance_Config(adc , ADC_REFSEL_INTVCC_gc);
 
     ADC_Ch_InputMode_and_Gain_Config(&(adc->CH0),
                                      ADC_CH_INPUTMODE_DIFF_gc,
                                      ADC_CH_GAIN_1X_gc);
 
     ADC_Ch_InputMux_Config(&(adc->CH0), ADC_CH_MUXPOS_PIN0_gc, ADC_CH_MUXNEG_PIN0_gc);
 
     /* Enable ADC. */
     ADC_Enable(adc);
 
     /* Wait until ADC is ready. */
     ADC_Wait_32MHz(adc);
 
     /* Do one conversion to find offset. */
     ADC_Ch_Conversion_Start(&(adc->CH0));
 
     do{
     }while(!ADC_Ch_Conversion_Complete(&(adc->CH0)));
     offset = ADC_ResultCh_GetLowByte(&(adc->CH0), 0x00);
 
     /* Disable ADC. */
     ADC_Disable(adc);
 
     return offset;
 }

Here is the call graph for this function:

◆ ADC_ResultCh_GetHighByte()

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 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.; If ADC interrupts are enabled, the interrupt handler will clear the interrupt flag before the polling loop can detect it, and this function will hang forever. Therefore, do not use interrupts with this function. Instead, read the result registers directly.

Parameters

adc_ch Pointer to ADC channel register section.

Returns: High byte of conversion result.

Definition at line 160 of file adc_driver.c.

 {
     /* Clear interrupt flag.*/
     adc_ch->INTFLAGS = ADC_CH_CHIF_bm;
 
     /* Return low byte result register contents.*/
     return adc_ch->RESH;
 }

◆ ADC_ResultCh_GetLowByte()

uint8_t ADC_ResultCh_GetLowByte	(	ADC_CH_t *	adc_ch,
		uint8_t	offset
	)

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.

Parameters

adc_ch	Pointer to ADC channel register section.
offset	Compansation offset value.

Returns: Low byte of conversion result.

Definition at line 131 of file adc_driver.c.

References offset.

Referenced by ADC_Offset_Get().

 {
     uint8_t answer;
 
     /* Clear interrupt flag.*/
     adc_ch->INTFLAGS = ADC_CH_CHIF_bm;
     /* Return result register contents*/
     answer = adc_ch->RESL - offset;
 
     return answer;
 }

◆ ADC_ResultCh_GetWord()

uint16_t ADC_ResultCh_GetWord	(	ADC_CH_t *	adc_ch,
		uint8_t	offset
	)

This function clears the interrupt flag and returns the 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_ch	Pointer to ADC channel register section.
offset	Offset value that is compansated for.

Returns: Conversion result.

Definition at line 98 of file adc_driver.c.

Referenced by mc_ADC_Scheduler().

 {
     uint16_t answer;
     uint16_t signedOffset = (uint16_t) offset;
 
     /* Append 16-bit signed value if offset (signed) is negative. */
     if (offset >= 128){
         signedOffset |= 0xFF00;
     }
 
     /* Clear interrupt flag.*/
     adc_ch->INTFLAGS = ADC_CH_CHIF_bm;
 
     /* Return result register contents*/
     answer = adc_ch->RES - signedOffset;
 
     return answer;
 }

◆ ADC_Wait_32MHz()

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

adc	Pointer to ADC module register section.

Definition at line 214 of file adc_driver.c.

References COMMEN_MODE_CYCLES.

Referenced by ADC_Offset_Get().

 {
     /* Store old prescaler value. */
     uint8_t prescaler_val = adc->PRESCALER;
 
     /* Set prescaler value to minimum value. */
     adc->PRESCALER = ADC_PRESCALER_DIV8_gc;
 
     /* wait 8*COMMEN_MODE_CYCLES for common mode to settle*/
     delay_us(8*COMMEN_MODE_CYCLES);
 
     /* Set prescaler to old value*/
     adc->PRESCALER = prescaler_val;
 }

◆ ADC_Wait_8MHz()

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

adc	Pointer to ADC module register section.

Definition at line 182 of file adc_driver.c.

References COMMEN_MODE_CYCLES.

Referenced by ADC_Init().

 {
     /* Store old prescaler value. */
     uint8_t prescaler_val = adc->PRESCALER;
 
     /* Set prescaler value to minimum value. */
     adc->PRESCALER = ADC_PRESCALER_DIV4_gc;
 
     /* Wait 4*COMMEN_MODE_CYCLES for common mode to settle. */
     delay_us(4*COMMEN_MODE_CYCLES);
 
     /* Set prescaler to old value*/
     adc->PRESCALER = prescaler_val;
 }

◆ SP_ReadCalibrationByte()

uint8_t SP_ReadCalibrationByte ( uint8_t index )

Referenced by ADC_CalibrationValues_Set(), and ADC_Offset_Get().

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ ADC_BandgapReference_Disable

◆ ADC_BandgapReference_Enable

◆ ADC_Ch_Conversion_Complete

◆ ADC_Ch_Conversion_Start

◆ ADC_Ch_InputMode_and_Gain_Config

◆ ADC_Ch_InputMux_Config

◆ ADC_Ch_Interrupts_Config

◆ ADC_CompareValue_Set

◆ ADC_Conversions_Start

◆ ADC_ConvMode_and_Resolution_Config

◆ ADC_Disable

◆ ADC_Enable

◆ ADC_Events_Config

◆ ADC_FreeRunning_Disable

◆ ADC_FreeRunning_Enable

◆ ADC_Pipeline_Flush

◆ ADC_Prescaler_Config

◆ ADC_Referance_Config

◆ ADC_SweepChannels_Config

◆ ADC_TempReference_Disable

◆ ADC_TempReference_Enable

◆ COMMEN_MODE_CYCLES

Function Documentation

◆ ADC_CalibrationValues_Set()

◆ ADC_Offset_Get()

◆ ADC_ResultCh_GetHighByte()

◆ ADC_ResultCh_GetLowByte()

◆ ADC_ResultCh_GetWord()

◆ ADC_Wait_32MHz()

◆ ADC_Wait_8MHz()

◆ SP_ReadCalibrationByte()