Analog-to-Digital Converter (ADC/ADC12B) driver for SAM. More...

#include "compiler.h"

Macros
#define	ADC_FREQ_MAX 20000000
#define	ADC_FREQ_MIN 1000000
#define	ADC_STARTUP_FAST 12
#define	ADC_STARTUP_NORM 40

Enumerations
enum	adc_channel_num_t { ADC_CHANNEL_0 = 0 , ADC_CHANNEL_1 = 1 , ADC_CHANNEL_2 = 2 , ADC_CHANNEL_3 = 3 , ADC_CHANNEL_4 = 4 , ADC_CHANNEL_5 = 5 , ADC_CHANNEL_6 = 6 , ADC_CHANNEL_7 = 7 , ADC_CHANNEL_8 = 8 , ADC_CHANNEL_9 = 9 , ADC_CHANNEL_10 = 10 , ADC_CHANNEL_11 = 11 , ADC_CHANNEL_12 = 12 , ADC_CHANNEL_13 = 13 , ADC_CHANNEL_14 = 14 , ADC_TEMPERATURE_SENSOR = 15 }
enum	adc_gainvalue_t { ADC_GAINVALUE_0 = 0 , ADC_GAINVALUE_1 = 1 , ADC_GAINVALUE_2 = 2 , ADC_GAINVALUE_3 = 3 }
enum	adc_resolution_t { ADC_10_BITS = ADC_MR_LOWRES_BITS_10 , ADC_12_BITS = ADC_MR_LOWRES_BITS_12 }
enum	adc_settling_time_t { ADC_SETTLING_TIME_0 = ADC_MR_SETTLING_AST3 , ADC_SETTLING_TIME_1 = ADC_MR_SETTLING_AST5 , ADC_SETTLING_TIME_2 = ADC_MR_SETTLING_AST9 , ADC_SETTLING_TIME_3 = ADC_MR_SETTLING_AST17 }
enum	adc_startup_time { ADC_STARTUP_TIME_0 = ADC_MR_STARTUP_SUT0 , ADC_STARTUP_TIME_1 = ADC_MR_STARTUP_SUT8 , ADC_STARTUP_TIME_2 = ADC_MR_STARTUP_SUT16 , ADC_STARTUP_TIME_3 = ADC_MR_STARTUP_SUT24 , ADC_STARTUP_TIME_4 = ADC_MR_STARTUP_SUT64 , ADC_STARTUP_TIME_5 = ADC_MR_STARTUP_SUT80 , ADC_STARTUP_TIME_6 = ADC_MR_STARTUP_SUT96 , ADC_STARTUP_TIME_7 = ADC_MR_STARTUP_SUT112 , ADC_STARTUP_TIME_8 = ADC_MR_STARTUP_SUT512 , ADC_STARTUP_TIME_9 = ADC_MR_STARTUP_SUT576 , ADC_STARTUP_TIME_10 = ADC_MR_STARTUP_SUT640 , ADC_STARTUP_TIME_11 = ADC_MR_STARTUP_SUT704 , ADC_STARTUP_TIME_12 = ADC_MR_STARTUP_SUT768 , ADC_STARTUP_TIME_13 = ADC_MR_STARTUP_SUT832 , ADC_STARTUP_TIME_14 = ADC_MR_STARTUP_SUT896 , ADC_STARTUP_TIME_15 = ADC_MR_STARTUP_SUT960 }
	Definitions for ADC Start Up Time. More...
enum	adc_trigger_t { ADC_TRIG_SW = ADC_MR_TRGEN_DIS , ADC_TRIG_EXT = ADC_MR_TRGSEL_ADC_TRIG0 \| ADC_MR_TRGEN , ADC_TRIG_TIO_CH_0 = ADC_MR_TRGSEL_ADC_TRIG1 \| ADC_MR_TRGEN , ADC_TRIG_TIO_CH_1 = ADC_MR_TRGSEL_ADC_TRIG2 \| ADC_MR_TRGEN , ADC_TRIG_TIO_CH_2 = ADC_MR_TRGSEL_ADC_TRIG3 \| ADC_MR_TRGEN , ADC_TRIG_PWM_EVENT_LINE_0 = ADC_MR_TRGSEL_ADC_TRIG4 \| ADC_MR_TRGEN , ADC_TRIG_PWM_EVENT_LINE_1 = ADC_MR_TRGSEL_ADC_TRIG5 \| ADC_MR_TRGEN }

Functions
void	adc_check (Adc *p_adc, const uint32_t ul_mck)
	Check ADC configurations.
void	adc_configure_power_save (Adc *p_adc, const uint8_t uc_sleep, const uint8_t uc_fwup)
	Configures ADC power saving mode.
void	adc_configure_sequence (Adc *p_adc, const enum adc_channel_num_t ch_list[], const uint8_t uc_num)
	Configure conversion sequence.
void	adc_configure_timing (Adc *p_adc, const uint8_t uc_tracking, const enum adc_settling_time_t settling, const uint8_t uc_transfer)
	Configure ADC timing.
void	adc_configure_trigger (Adc *p_adc, const enum adc_trigger_t trigger, const uint8_t uc_freerun)
	Configure conversion trigger and free run mode.
void	adc_disable_all_channel (Adc *p_adc)
	Disable all ADC channel.
void	adc_disable_anch (Adc *p_adc)
	Disable analog change.
void	adc_disable_channel (Adc *p_adc, const enum adc_channel_num_t adc_ch)
	Disable the specified ADC channel.
void	adc_disable_channel_differential_input (Adc *p_adc, const enum adc_channel_num_t channel)
	Disable differential input for the specified channel.
void	adc_disable_channel_input_offset (Adc *p_adc, const enum adc_channel_num_t channel)
	Disable analog signal offset for the specified channel.
void	adc_disable_interrupt (Adc *p_adc, const uint32_t ul_source)
	Disable ADC interrupts.
void	adc_disable_tag (Adc *p_adc)
	Disable TAG option.
void	adc_disable_ts (Adc *p_adc)
	Turn off temperature sensor.
void	adc_enable_all_channel (Adc *p_adc)
	Enable all ADC channels.
void	adc_enable_anch (Adc *p_adc)
	Enable analog change.
void	adc_enable_channel (Adc *p_adc, const enum adc_channel_num_t adc_ch)
	Enable the specified ADC channel.
void	adc_enable_channel_differential_input (Adc *p_adc, const enum adc_channel_num_t channel)
	Enable differential input for the specified channel.
void	adc_enable_channel_input_offset (Adc *p_adc, const enum adc_channel_num_t channel)
	Enable analog signal offset for the specified channel.
void	adc_enable_interrupt (Adc *p_adc, const uint32_t ul_source)
	Enable ADC interrupts.
void	adc_enable_tag (Adc *p_adc)
	Enable TAG option so that the number of the last converted channel can be indicated.
void	adc_enable_ts (Adc *p_adc)
	Turn on temperature sensor.
uint32_t	adc_get_actual_adc_clock (const Adc *p_adc, const uint32_t ul_mck)
	Return the actual ADC clock.
uint32_t	adc_get_channel_status (const Adc *p_adc, const enum adc_channel_num_t adc_ch)
	Read the ADC channel status.
uint32_t	adc_get_channel_value (const Adc *p_adc, const enum adc_channel_num_t adc_ch)
	Read the ADC result data of the specified channel.
uint32_t	adc_get_comparison_mode (const Adc *p_adc)
	Get comparison mode.
uint32_t	adc_get_interrupt_mask (const Adc *p_adc)
	Read ADC interrupt mask.
uint32_t	adc_get_latest_value (const Adc *p_adc)
	Read the last ADC result data.
uint32_t	adc_get_overrun_status (const Adc *p_adc)
	Get ADC interrupt and overrun error status.
Pdc *	adc_get_pdc_base (const Adc *p_adc)
	Get PDC registers base address.
uint32_t	adc_get_status (const Adc *p_adc)
	Get ADC interrupt and overrun error status.
enum adc_channel_num_t	adc_get_tag (const Adc *p_adc)
	Indicate the last converted channel.
uint32_t	adc_get_writeprotect_status (const Adc *p_adc)
	Indicate write protect status.
uint32_t	adc_init (Adc *p_adc, const uint32_t ul_mck, const uint32_t ul_adc_clock, const enum adc_startup_time startup)
	Initialize the given ADC with the specified ADC clock and startup time.
void	adc_reset (Adc *p_adc)
	Reset ADC.
void	adc_set_bias_current (Adc *p_adc, const uint8_t uc_ibctl)
	Adapt performance versus power consumption.
void	adc_set_calibmode (Adc *p_adc)
	Set ADC auto calibration mode.
void	adc_set_channel_input_gain (Adc *p_adc, const enum adc_channel_num_t channel, const enum adc_gainvalue_t uc_gain)
	Configure input gain for the specified channel.
void	adc_set_comparison_channel (Adc *p_adc, const enum adc_channel_num_t channel)
	Configure comparison selected channel.
void	adc_set_comparison_mode (Adc *p_adc, const uint8_t uc_mode)
	Configure comparison mode.
void	adc_set_comparison_window (Adc *p_adc, const uint16_t us_low_threshold, const uint16_t us_high_threshold)
	Configure ADC compare window.
void	adc_set_resolution (Adc *p_adc, const enum adc_resolution_t resolution)
	Configure the conversion resolution.
void	adc_set_writeprotect (Adc *p_adc, const uint32_t ul_enable)
	Enable or disable write protection of ADC registers.
void	adc_start (Adc *p_adc)
	Start analog-to-digital conversion.
void	adc_start_sequencer (Adc *p_adc)
	Enable conversion sequencer.
void	adc_stop_sequencer (Adc *p_adc)
	Disable conversion sequencer.

Detailed Description

Analog-to-Digital Converter (ADC/ADC12B) driver for SAM.

\cond ASF_LICENSE

Definition in file adc.h.

Macro Definition Documentation

◆ ADC_FREQ_MAX

#define ADC_FREQ_MAX 20000000

Definition at line 52 of file adc.h.

Referenced by adc_check().

◆ ADC_FREQ_MIN

#define ADC_FREQ_MIN 1000000

Definition at line 57 of file adc.h.

Referenced by adc_check().

◆ ADC_STARTUP_FAST

#define ADC_STARTUP_FAST 12

Definition at line 61 of file adc.h.

Referenced by adc_check().

◆ ADC_STARTUP_NORM

#define ADC_STARTUP_NORM 40

Definition at line 59 of file adc.h.

Referenced by adc_check().

Enumeration Type Documentation

◆ adc_channel_num_t

enum adc_channel_num_t

Enumerator
ADC_CHANNEL_0
ADC_CHANNEL_1
ADC_CHANNEL_2
ADC_CHANNEL_3
ADC_CHANNEL_4
ADC_CHANNEL_5
ADC_CHANNEL_6
ADC_CHANNEL_7
ADC_CHANNEL_8
ADC_CHANNEL_9
ADC_CHANNEL_10
ADC_CHANNEL_11
ADC_CHANNEL_12
ADC_CHANNEL_13
ADC_CHANNEL_14
ADC_TEMPERATURE_SENSOR

Definition at line 141 of file adc.h.

                       {
    ADC_CHANNEL_0  = 0,
    ADC_CHANNEL_1  = 1,
    ADC_CHANNEL_2  = 2,
    ADC_CHANNEL_3  = 3,
    ADC_CHANNEL_4  = 4,
    ADC_CHANNEL_5  = 5,
    ADC_CHANNEL_6  = 6,
#if SAM4C || SAM4CP || SAM4CM
    ADC_TEMPERATURE_SENSOR = 7,
#else
    ADC_CHANNEL_7  = 7,
    ADC_CHANNEL_8  = 8,
    ADC_CHANNEL_9  = 9,
    ADC_CHANNEL_10 = 10,
    ADC_CHANNEL_11 = 11,
    ADC_CHANNEL_12 = 12,
    ADC_CHANNEL_13 = 13,
    ADC_CHANNEL_14 = 14,
    ADC_TEMPERATURE_SENSOR = 15,
#endif
};

◆ adc_gainvalue_t

enum adc_gainvalue_t

Enumerator
ADC_GAINVALUE_0
ADC_GAINVALUE_1
ADC_GAINVALUE_2
ADC_GAINVALUE_3

Definition at line 178 of file adc.h.

                     {
    ADC_GAINVALUE_0 = 0,
    ADC_GAINVALUE_1 = 1,
    ADC_GAINVALUE_2 = 2,
    ADC_GAINVALUE_3 = 3
};

◆ adc_resolution_t

enum adc_resolution_t

Enumerator
ADC_10_BITS
ADC_12_BITS

Definition at line 65 of file adc.h.

                      {
    ADC_10_BITS = ADC_MR_LOWRES_BITS_10,    /* ADC 10-bit resolution */
    ADC_12_BITS = ADC_MR_LOWRES_BITS_12     /* ADC 12-bit resolution */
};

◆ adc_settling_time_t

enum adc_settling_time_t

Enumerator
ADC_SETTLING_TIME_0
ADC_SETTLING_TIME_1
ADC_SETTLING_TIME_2
ADC_SETTLING_TIME_3

Definition at line 187 of file adc.h.

                         {
    ADC_SETTLING_TIME_0 = ADC_MR_SETTLING_AST3,
    ADC_SETTLING_TIME_1 = ADC_MR_SETTLING_AST5,
    ADC_SETTLING_TIME_2 = ADC_MR_SETTLING_AST9,
    ADC_SETTLING_TIME_3 = ADC_MR_SETTLING_AST17
};

◆ adc_startup_time

enum adc_startup_time

Definitions for ADC Start Up Time.

Enumerator
ADC_STARTUP_TIME_0
ADC_STARTUP_TIME_1
ADC_STARTUP_TIME_2
ADC_STARTUP_TIME_3
ADC_STARTUP_TIME_4
ADC_STARTUP_TIME_5
ADC_STARTUP_TIME_6
ADC_STARTUP_TIME_7
ADC_STARTUP_TIME_8
ADC_STARTUP_TIME_9
ADC_STARTUP_TIME_10
ADC_STARTUP_TIME_11
ADC_STARTUP_TIME_12
ADC_STARTUP_TIME_13
ADC_STARTUP_TIME_14
ADC_STARTUP_TIME_15

Definition at line 197 of file adc.h.

                      {
    ADC_STARTUP_TIME_0 = ADC_MR_STARTUP_SUT0,
    ADC_STARTUP_TIME_1 = ADC_MR_STARTUP_SUT8,
    ADC_STARTUP_TIME_2 = ADC_MR_STARTUP_SUT16,
    ADC_STARTUP_TIME_3 = ADC_MR_STARTUP_SUT24,
    ADC_STARTUP_TIME_4 = ADC_MR_STARTUP_SUT64,
    ADC_STARTUP_TIME_5 = ADC_MR_STARTUP_SUT80,
    ADC_STARTUP_TIME_6 = ADC_MR_STARTUP_SUT96,
    ADC_STARTUP_TIME_7 = ADC_MR_STARTUP_SUT112,
    ADC_STARTUP_TIME_8 = ADC_MR_STARTUP_SUT512,
    ADC_STARTUP_TIME_9 = ADC_MR_STARTUP_SUT576,
    ADC_STARTUP_TIME_10 = ADC_MR_STARTUP_SUT640,
    ADC_STARTUP_TIME_11 = ADC_MR_STARTUP_SUT704,
    ADC_STARTUP_TIME_12 = ADC_MR_STARTUP_SUT768,
    ADC_STARTUP_TIME_13 = ADC_MR_STARTUP_SUT832,
    ADC_STARTUP_TIME_14 = ADC_MR_STARTUP_SUT896,
    ADC_STARTUP_TIME_15 = ADC_MR_STARTUP_SUT960
};

◆ adc_trigger_t

enum adc_trigger_t

Enumerator
ADC_TRIG_SW
ADC_TRIG_EXT
ADC_TRIG_TIO_CH_0
ADC_TRIG_TIO_CH_1
ADC_TRIG_TIO_CH_2
ADC_TRIG_PWM_EVENT_LINE_0
ADC_TRIG_PWM_EVENT_LINE_1

Definition at line 90 of file adc.h.

                   {
    /* Starting a conversion is only possible by software. */
    ADC_TRIG_SW = ADC_MR_TRGEN_DIS,
    /* External trigger */
    ADC_TRIG_EXT = ADC_MR_TRGSEL_ADC_TRIG0 | ADC_MR_TRGEN,
    /* TIO Output of the Timer Counter Channel 0 */
    ADC_TRIG_TIO_CH_0 = ADC_MR_TRGSEL_ADC_TRIG1 | ADC_MR_TRGEN,
    /* TIO Output of the Timer Counter Channel 1 */
    ADC_TRIG_TIO_CH_1 = ADC_MR_TRGSEL_ADC_TRIG2 | ADC_MR_TRGEN,
    /* TIO Output of the Timer Counter Channel 2 */
    ADC_TRIG_TIO_CH_2 = ADC_MR_TRGSEL_ADC_TRIG3 | ADC_MR_TRGEN,
#if SAM4C || SAM4CP || SAM4CM
    /* TIO Output of the Timer Counter Channel 3 */
    ADC_TRIG_TIO_CH_3 = ADC_MR_TRGSEL_ADC_TRIG3 | ADC_MR_TRGEN,
    /* TIO Output of the Timer Counter Channel 4 */
    ADC_TRIG_TIO_CH_4 = ADC_MR_TRGSEL_ADC_TRIG4 | ADC_MR_TRGEN,
    /* TIO Output of the Timer Counter Channel 5 */
    ADC_TRIG_TIO_CH_5 = ADC_MR_TRGSEL_ADC_TRIG5 | ADC_MR_TRGEN,
    /* TIO Output of the Timer Counter Channel 6 */
    ADC_TRIG_TIO_CH_6 = ADC_MR_TRGSEL_ADC_TRIG6 | ADC_MR_TRGEN,
#endif
#if SAM3S || SAM4S || SAM3XA || SAM3U
    /* PWM Event Line 0 */
    ADC_TRIG_PWM_EVENT_LINE_0 = ADC_MR_TRGSEL_ADC_TRIG4 | ADC_MR_TRGEN,
    /* PWM Event Line 1 */
    ADC_TRIG_PWM_EVENT_LINE_1 = ADC_MR_TRGSEL_ADC_TRIG5 | ADC_MR_TRGEN
#endif
};

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ ADC_FREQ_MAX

◆ ADC_FREQ_MIN

◆ ADC_STARTUP_FAST

◆ ADC_STARTUP_NORM

Enumeration Type Documentation

◆ adc_channel_num_t

◆ adc_gainvalue_t

◆ adc_resolution_t

◆ adc_settling_time_t

◆ adc_startup_time

◆ adc_trigger_t