libopencm3
A free/libre/open-source firmware library for various ARM Cortex-M3 microcontrollers.
Functions
ADC peripheral API
Peripheral APIs
Collaboration diagram for ADC peripheral API:

Functions

void adc_set_sample_time (uint32_t adc, uint8_t channel, uint8_t time)
 ADC Set the Sample Time for a Single Channel. More...
 
void adc_set_sample_time_on_all_channels (uint32_t adc, uint8_t time)
 ADC Set the Sample Time for All Channels. More...
 
void adc_set_multi_mode (uint32_t mode)
 ADC Set Dual/Triple Mode. More...
 
void adc_enable_vbat_sensor (void)
 Enable The VBat Sensor. More...
 
void adc_disable_vbat_sensor (void)
 Disable The VBat Sensor. More...
 
void adc_power_off (uint32_t adc)
 ADC Off. More...
 
void adc_enable_analog_watchdog_regular (uint32_t adc)
 ADC Enable Analog Watchdog for Regular Conversions. More...
 
void adc_disable_analog_watchdog_regular (uint32_t adc)
 ADC Disable Analog Watchdog for Regular Conversions. More...
 
void adc_enable_analog_watchdog_injected (uint32_t adc)
 ADC Enable Analog Watchdog for Injected Conversions. More...
 
void adc_disable_analog_watchdog_injected (uint32_t adc)
 ADC Disable Analog Watchdog for Injected Conversions. More...
 
void adc_enable_discontinuous_mode_regular (uint32_t adc, uint8_t length)
 ADC Enable Discontinuous Mode for Regular Conversions. More...
 
void adc_disable_discontinuous_mode_regular (uint32_t adc)
 ADC Disable Discontinuous Mode for Regular Conversions. More...
 
void adc_enable_discontinuous_mode_injected (uint32_t adc)
 ADC Enable Discontinuous Mode for Injected Conversions. More...
 
void adc_disable_discontinuous_mode_injected (uint32_t adc)
 ADC Disable Discontinuous Mode for Injected Conversions. More...
 
void adc_enable_automatic_injected_group_conversion (uint32_t adc)
 ADC Enable Automatic Injected Conversions. More...
 
void adc_disable_automatic_injected_group_conversion (uint32_t adc)
 ADC Disable Automatic Injected Conversions. More...
 
void adc_enable_analog_watchdog_on_all_channels (uint32_t adc)
 ADC Enable Analog Watchdog for All Regular and/or Injected Channels. More...
 
void adc_enable_analog_watchdog_on_selected_channel (uint32_t adc, uint8_t channel)
 ADC Enable Analog Watchdog for a Selected Channel. More...
 
void adc_enable_scan_mode (uint32_t adc)
 ADC Set Scan Mode. More...
 
void adc_disable_scan_mode (uint32_t adc)
 ADC Disable Scan Mode. More...
 
void adc_enable_eoc_interrupt_injected (uint32_t adc)
 ADC Enable Injected End-Of-Conversion Interrupt. More...
 
void adc_disable_eoc_interrupt_injected (uint32_t adc)
 ADC Disable Injected End-Of-Conversion Interrupt. More...
 
void adc_enable_awd_interrupt (uint32_t adc)
 ADC Enable Analog Watchdog Interrupt. More...
 
void adc_disable_awd_interrupt (uint32_t adc)
 ADC Disable Analog Watchdog Interrupt. More...
 
void adc_enable_eoc_interrupt (uint32_t adc)
 ADC Enable Regular End-Of-Conversion Interrupt. More...
 
void adc_disable_eoc_interrupt (uint32_t adc)
 ADC Disable Regular End-Of-Conversion Interrupt. More...
 
void adc_set_left_aligned (uint32_t adc)
 ADC Set the Data as Left Aligned. More...
 
void adc_set_right_aligned (uint32_t adc)
 ADC Set the Data as Right Aligned. More...
 
bool adc_eoc (uint32_t adc)
 ADC Read the End-of-Conversion Flag. More...
 
bool adc_eoc_injected (uint32_t adc)
 ADC Read the End-of-Conversion Flag for Injected Conversion. More...
 
uint32_t adc_read_regular (uint32_t adc)
 ADC Read from the Regular Conversion Result Register. More...
 
uint32_t adc_read_injected (uint32_t adc, uint8_t reg)
 ADC Read from an Injected Conversion Result Register. More...
 
void adc_set_continuous_conversion_mode (uint32_t adc)
 ADC Enable Continuous Conversion Mode. More...
 
void adc_set_single_conversion_mode (uint32_t adc)
 ADC Enable Single Conversion Mode. More...
 
void adc_set_watchdog_high_threshold (uint32_t adc, uint16_t threshold)
 ADC Set Analog Watchdog Upper Threshold. More...
 
void adc_set_watchdog_low_threshold (uint32_t adc, uint16_t threshold)
 ADC Set Analog Watchdog Lower Threshold. More...
 
void adc_set_regular_sequence (uint32_t adc, uint8_t length, uint8_t channel[])
 ADC Set a Regular Channel Conversion Sequence. More...
 
void adc_set_injected_sequence (uint32_t adc, uint8_t length, uint8_t channel[])
 ADC Set an Injected Channel Conversion Sequence. More...
 
void adc_set_injected_offset (uint32_t adc, uint8_t reg, uint32_t offset)
 ADC Set the Injected Channel Data Offset. More...
 
void adc_start_conversion_regular (uint32_t adc)
 ADC Software Triggered Conversion on Regular Channels. More...
 
void adc_start_conversion_injected (uint32_t adc)
 ADC Software Triggered Conversion on Injected Channels. More...
 
void adc_enable_dma (uint32_t adc)
 ADC Enable DMA Transfers. More...
 
void adc_disable_dma (uint32_t adc)
 ADC Disable DMA Transfers. More...
 
bool adc_get_flag (uint32_t adc, uint32_t flag)
 Read a Status Flag. More...
 
void adc_clear_flag (uint32_t adc, uint32_t flag)
 Clear a Status Flag. More...
 
void adc_power_on (uint32_t adc)
 ADC Power On. More...
 
void adc_set_clk_prescale (uint32_t prescale)
 ADC Set Clock Prescale The ADC clock can be prescaled. More...
 
void adc_enable_external_trigger_regular (uint32_t adc, uint32_t trigger, uint32_t polarity)
 ADC Enable an External Trigger for Regular Channels. More...
 
void adc_disable_external_trigger_regular (uint32_t adc)
 ADC Disable an External Trigger for Regular Channels. More...
 
void adc_enable_external_trigger_injected (uint32_t adc, uint32_t trigger, uint32_t polarity)
 ADC Enable an External Trigger for Injected Channels. More...
 
void adc_disable_external_trigger_injected (uint32_t adc)
 ADC Disable an External Trigger for Injected Channels. More...
 
void adc_set_resolution (uint32_t adc, uint32_t resolution)
 ADC Set Resolution. More...
 
void adc_enable_overrun_interrupt (uint32_t adc)
 ADC Enable the Overrun Interrupt. More...
 
void adc_disable_overrun_interrupt (uint32_t adc)
 ADC Disable the Overrun Interrupt. More...
 
bool adc_get_overrun_flag (uint32_t adc)
 ADC Read the Overrun Flag. More...
 
void adc_clear_overrun_flag (uint32_t adc)
 ADC Clear Overrun Flags. More...
 
void adc_eoc_after_each (uint32_t adc)
 ADC Enable an EOC for Each Conversion. More...
 
void adc_eoc_after_group (uint32_t adc)
 ADC Disable the EOC for Each Conversion. More...
 
void adc_set_dma_continue (uint32_t adc)
 ADC Set DMA to Continue. More...
 
void adc_set_dma_terminate (uint32_t adc)
 ADC Set DMA to Terminate. More...
 
bool adc_awd (uint32_t adc)
 ADC Read the Analog Watchdog Flag. More...
 
void adc_enable_temperature_sensor (void)
 ADC Enable The Temperature Sensor. More...
 
void adc_disable_temperature_sensor (void)
 ADC Disable The Temperature Sensor. More...
 

Detailed Description

Author
© 2012 Ken Sarkies ksark.nosp@m.ies@.nosp@m.inter.nosp@m.node.nosp@m..on.n.nosp@m.et
Date
30 August 2012

LGPL License Terms libopencm3 License

Author
© 2009 Edward Cheeseman evbui.nosp@m.lder.nosp@m.@user.nosp@m.s.so.nosp@m.urcef.nosp@m.orge.nosp@m..net
© 2012 Ken Sarkies ksark.nosp@m.ies@.nosp@m.inter.nosp@m.node.nosp@m..on.n.nosp@m.et
© 2014 Karl Palsson karlp.nosp@m.@twe.nosp@m.ak.ne.nosp@m.t.au

This library supports one style of the Analog to Digital Conversion System in the STM32 series of ARM Cortex Microcontrollers by ST Microelectronics.

The style of ADC Peripheral supported by this code is found in the F1, F2, F37x, F38x, F4, and L1 series devices (at the time of writing) but is quite different to the style found on the F0 and F30x and F31x. Devices can have up to three A/D converters each with their own set of registers. However all the A/D converters share a common clock. On most devices, this is prescaled from the APB2 clock by default by a minimum factor of 2 to a maximum of 8, though on the L1 this is always a divider from the HSI. (And therefore HSI must be enabled before attempting to enable the ADC)

Each A/D converter has up to ADC_MAX_CHANNELS channels:

The conversions can occur as a one-off conversion whereby the process stops once conversion is complete. The conversions can also be continuous wherein a new conversion starts immediately the previous conversion has ended.

Conversion can occur as a single channel conversion or a scan of a group of channels in either continuous or one-off mode. If more than one channel is converted in a scan group, DMA must be used to transfer the data as there is only one result register available. An interrupt can be set to occur at the end of conversion, which occurs after all channels have been scanned.

A discontinuous mode allows a subgroup of group of a channels to be converted in bursts of a given length.

Injected conversions allow a second group of channels to be converted separately from the regular group. An interrupt can be set to occur at the end of conversion, which occurs after all channels have been scanned.

Basic ADC Handling API.

Example 1: Simple single channel conversion polled. Enable the peripheral clock and ADC, reset ADC and set the prescaler divider. Set dual mode to independent (default). Enable triggering for a software trigger.

rcc_periph_clock_enable(RCC_ADC1);
adc_power_off(ADC1);
rcc_periph_reset_pulse(RST_ADC1);
rcc_set_adcpre(RCC_CFGR_ADCPRE_PCLK2_DIV2);
adc_set_dual_mode(ADC_CR1_DUALMOD_IND);
adc_disable_scan_mode(ADC1);
adc_set_single_conversion_mode(ADC1);
adc_set_sample_time(ADC1, ADC_CHANNEL0, ADC_SMPR1_SMP_1DOT5CYC);
adc_enable_trigger(ADC1, ADC_CR2_EXTSEL_SWSTART);
adc_power_on(ADC1);
adc_reset_calibration(ADC1);
adc_calibration(ADC1);
adc_start_conversion_regular(ADC1);
while (! adc_eoc(ADC1));
reg16 = adc_read_regular(ADC1);
ADC_CHANNEL0
#define ADC_CHANNEL0
Definition: adc_common_v1.h:164
adc_set_sample_time
void adc_set_sample_time(uint32_t adc, uint8_t channel, uint8_t time)
ADC Set the Sample Time for a Single Channel.
Definition: adc_common_f47.c:45
adc_start_conversion_regular
void adc_start_conversion_regular(uint32_t adc)
ADC Software Triggered Conversion on Regular Channels.
Definition: adc_common_v1.c:695
adc_power_off
void adc_power_off(uint32_t adc)
ADC Off.
Definition: adc_common_v1.c:108
adc_set_single_conversion_mode
void adc_set_single_conversion_mode(uint32_t adc)
ADC Enable Single Conversion Mode.
Definition: adc_common_v1.c:523
adc_power_on
void adc_power_on(uint32_t adc)
ADC Power On.
Definition: adc_common_v1_multi.c:102
adc_read_regular
uint32_t adc_read_regular(uint32_t adc)
ADC Read from the Regular Conversion Result Register.
Definition: adc_common_v1.c:465
adc_disable_scan_mode
void adc_disable_scan_mode(uint32_t adc)
ADC Disable Scan Mode.
Definition: adc_common_v1.c:328
adc_eoc
bool adc_eoc(uint32_t adc)
ADC Read the End-of-Conversion Flag.
Definition: adc_common_v1.c:435
ADC1
#define ADC1
Definition: adc_common_v1.h:46
rcc_periph_clock_enable
void rcc_periph_clock_enable(enum rcc_periph_clken clken)
Enable Peripheral Clock in running mode.
Definition: rcc_common_all.c:127
rcc_periph_reset_pulse
void rcc_periph_reset_pulse(enum rcc_periph_rst rst)
Reset Peripheral, pulsed.
Definition: rcc_common_all.c:152
RCC_ADC1
@ RCC_ADC1
Definition: f4/rcc.h:910

LGPL License Terms libopencm3 License

Author
© 2012 Ken Sarkies ksark.nosp@m.ies@.nosp@m.inter.nosp@m.node.nosp@m..on.n.nosp@m.et
Date
30 August 2012

This library supports the A/D Converter Control System in the STM32 series of ARM Cortex Microcontrollers by ST Microelectronics.

Devices can have up to three A/D converters each with their own set of registers. However all the A/D converters share a common clock which is prescaled from the APB2 clock by default by a minimum factor of 2 to a maximum of 8. The ADC resolution can be set to 12, 10, 8 or 6 bits.

Each A/D converter has multiple channels, not all of which might be available externally. Internal channels can be used for the the temperature sensor, VBat monitoring, and the internal reference voltage VREFINT. Consult the Reference manual for the specifics of your part.

See also
ADC_MAX_CHANNELS
ADC_CHANNEL_TEMP
ADC_CHANNEL_VREF
ADC_CHANNEL_VBAT

The conversions can occur as a one-off conversion whereby the process stops once conversion is complete. The conversions can also be continuous wherein a new conversion starts immediately the previous conversion has ended.

Conversion can occur as a single channel conversion or a scan of a group of channels in either continuous or one-off mode. If more than one channel is converted in a scan group, DMA must be used to transfer the data as there is only one result register available. An interrupt can be set to occur at the end of conversion, which occurs after all channels have been scanned.

A discontinuous mode allows a subgroup of group of a channels to be converted in bursts of a given length.

Injected conversions allow a second group of channels to be converted separately from the regular group. An interrupt can be set to occur at the end of conversion, which occurs after all channels have been scanned.

Basic ADC Handling API.

Example 1: Simple single channel conversion polled. Enable the peripheral clock and ADC, reset ADC and set the prescaler divider. Set the sample time to a minimum of 3 cycles. Set multiple mode to independent.

gpio_mode_setup(GPIOA, GPIO_MODE_ANALOG, GPIO_PUPD_NONE, GPIO1);
rcc_periph_clock_enable(RCC_ADC1);
adc_set_clk_prescale(ADC_CCR_ADCPRE_BY2);
adc_disable_scan_mode(ADC1);
adc_set_single_conversion_mode(ADC1);
adc_set_sample_time(ADC1, ADC_CHANNEL0, ADC_SMPR_SMP_3CYC);
uint8_t channels[] = ADC_CHANNEL0;
adc_set_regular_sequence(ADC1, 1, channels);
adc_set_multi_mode(ADC_CCR_MULTI_INDEPENDENT);
adc_power_on(ADC1);
adc_start_conversion_regular(ADC1);
while (!adc_eoc(ADC1));
reg16 = adc_read_regular(ADC1);
ADC_CCR_ADCPRE_BY2
#define ADC_CCR_ADCPRE_BY2
Definition: f4/adc.h:183
adc_set_regular_sequence
void adc_set_regular_sequence(uint32_t adc, uint8_t length, uint8_t channel[])
ADC Set a Regular Channel Conversion Sequence.
Definition: adc_common_v1.c:574
adc_set_clk_prescale
void adc_set_clk_prescale(uint32_t prescaler)
ADC Set Clock Prescale The ADC clock can be prescaled.
Definition: adc_common_v1_multi.c:114
adc_set_multi_mode
void adc_set_multi_mode(uint32_t mode)
ADC Set Dual/Triple Mode.
Definition: adc_common_f47.c:99
ADC_CCR_MULTI_INDEPENDENT
#define ADC_CCR_MULTI_INDEPENDENT
All ADCs independent.
Definition: adc_common_v1_multi.h:299
ADC_SMPR_SMP_3CYC
#define ADC_SMPR_SMP_3CYC
Definition: f4/adc.h:162
gpio_mode_setup
void gpio_mode_setup(uint32_t gpioport, uint8_t mode, uint8_t pull_up_down, uint16_t gpios)
Set GPIO Pin Mode.
Definition: gpio_common_f0234.c:89
GPIO_MODE_ANALOG
#define GPIO_MODE_ANALOG
Definition: gpio_common_f234.h:181
GPIO1
#define GPIO1
Definition: gpio_common_all.h:54
GPIOA
#define GPIOA
Definition: gpio_common_f234.h:48
GPIO_PUPD_NONE
#define GPIO_PUPD_NONE
Definition: gpio_common_f234.h:215

LGPL License Terms libopencm3 License

Function Documentation

◆ adc_awd()

bool adc_awd ( uint32_t  adc)

ADC Read the Analog Watchdog Flag.

This flag is set when the converted voltage crosses the high or low thresholds.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
Returns
bool. AWD flag.

Definition at line 329 of file adc_common_v1_multi.c.

References ADC_SR, and ADC_SR_AWD.

◆ adc_clear_flag()

void adc_clear_flag ( uint32_t  adc,
uint32_t  flag 
)

Clear a Status Flag.

Parameters
[in]adcUnsigned int32. ADC register address base ADC register base addresses
[in]flagUnsigned int32. Status register flag ADC Status Register Flags.

Definition at line 771 of file adc_common_v1.c.

References ADC_SR.

◆ adc_clear_overrun_flag()

void adc_clear_overrun_flag ( uint32_t  adc)

ADC Clear Overrun Flags.

The overrun flag is cleared. Note that if an overrun occurs, DMA is terminated. The flag must be cleared and the DMA stream and ADC reinitialised to resume conversions (see the reference manual).

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
Returns
Unsigned int32 conversion result.

Definition at line 259 of file adc_common_v1_multi.c.

References ADC_SR.

◆ adc_disable_analog_watchdog_injected()

void adc_disable_analog_watchdog_injected ( uint32_t  adc)

ADC Disable Analog Watchdog for Injected Conversions.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 161 of file adc_common_v1.c.

References ADC_CR1.

◆ adc_disable_analog_watchdog_regular()

void adc_disable_analog_watchdog_regular ( uint32_t  adc)

ADC Disable Analog Watchdog for Regular Conversions.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses.

Definition at line 135 of file adc_common_v1.c.

References ADC_CR1.

◆ adc_disable_automatic_injected_group_conversion()

void adc_disable_automatic_injected_group_conversion ( uint32_t  adc)

ADC Disable Automatic Injected Conversions.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 251 of file adc_common_v1.c.

References ADC_CR1.

◆ adc_disable_awd_interrupt()

void adc_disable_awd_interrupt ( uint32_t  adc)

ADC Disable Analog Watchdog Interrupt.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 372 of file adc_common_v1.c.

References ADC_CR1.

◆ adc_disable_discontinuous_mode_injected()

void adc_disable_discontinuous_mode_injected ( uint32_t  adc)

ADC Disable Discontinuous Mode for Injected Conversions.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 223 of file adc_common_v1.c.

References ADC_CR1.

◆ adc_disable_discontinuous_mode_regular()

void adc_disable_discontinuous_mode_regular ( uint32_t  adc)

ADC Disable Discontinuous Mode for Regular Conversions.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 197 of file adc_common_v1.c.

References ADC_CR1.

◆ adc_disable_dma()

void adc_disable_dma ( uint32_t  adc)

ADC Disable DMA Transfers.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 746 of file adc_common_v1.c.

References ADC_CR2.

◆ adc_disable_eoc_interrupt()

void adc_disable_eoc_interrupt ( uint32_t  adc)

ADC Disable Regular End-Of-Conversion Interrupt.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 395 of file adc_common_v1.c.

References ADC_CR1.

◆ adc_disable_eoc_interrupt_injected()

void adc_disable_eoc_interrupt_injected ( uint32_t  adc)

ADC Disable Injected End-Of-Conversion Interrupt.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 350 of file adc_common_v1.c.

References ADC_CR1.

◆ adc_disable_external_trigger_injected()

void adc_disable_external_trigger_injected ( uint32_t  adc)

ADC Disable an External Trigger for Injected Channels.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 182 of file adc_common_v1_multi.c.

References ADC_CR2.

Referenced by adc_enable_automatic_injected_group_conversion().

Here is the caller graph for this function:

◆ adc_disable_external_trigger_regular()

void adc_disable_external_trigger_regular ( uint32_t  adc)

ADC Disable an External Trigger for Regular Channels.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 149 of file adc_common_v1_multi.c.

References ADC_CR2.

◆ adc_disable_overrun_interrupt()

void adc_disable_overrun_interrupt ( uint32_t  adc)

ADC Disable the Overrun Interrupt.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 227 of file adc_common_v1_multi.c.

References ADC_CR1.

◆ adc_disable_scan_mode()

void adc_disable_scan_mode ( uint32_t  adc)

ADC Disable Scan Mode.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 328 of file adc_common_v1.c.

References ADC_CR1.

◆ adc_disable_temperature_sensor()

void adc_disable_temperature_sensor ( void  )

ADC Disable The Temperature Sensor.

Disabling this will reduce power consumption from the sensor and the reference voltage measurements.

Definition at line 355 of file adc_common_v1_multi.c.

References ADC_CCR.

◆ adc_disable_vbat_sensor()

void adc_disable_vbat_sensor ( void  )

Disable The VBat Sensor.

Disabling this will reduce power consumption from the battery voltage measurement.

Definition at line 119 of file adc_common_f47.c.

References ADC_CCR.

◆ adc_enable_analog_watchdog_injected()

void adc_enable_analog_watchdog_injected ( uint32_t  adc)

ADC Enable Analog Watchdog for Injected Conversions.

The analog watchdog allows the monitoring of an analog signal between two threshold levels. The thresholds must be preset. Comparison is done before data alignment takes place, so the thresholds are left-aligned.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 150 of file adc_common_v1.c.

References ADC_CR1, and ADC_CR1_JAWDEN.

◆ adc_enable_analog_watchdog_on_all_channels()

void adc_enable_analog_watchdog_on_all_channels ( uint32_t  adc)

ADC Enable Analog Watchdog for All Regular and/or Injected Channels.

The analog watchdog allows the monitoring of an analog signal between two threshold levels. The thresholds must be preset. Comparison is done before data alignment takes place, so the thresholds are left-aligned.

Note
The analog watchdog must be enabled for either or both of the regular or injected channels. If neither are enabled, the analog watchdog feature will be disabled. adc_enable_analog_watchdog_injected, adc_enable_analog_watchdog_regular.
Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 272 of file adc_common_v1.c.

References ADC_CR1.

◆ adc_enable_analog_watchdog_on_selected_channel()

void adc_enable_analog_watchdog_on_selected_channel ( uint32_t  adc,
uint8_t  channel 
)

ADC Enable Analog Watchdog for a Selected Channel.

The analog watchdog allows the monitoring of an analog signal between two threshold levels. The thresholds must be preset. Comparison is done before data alignment takes place, so the thresholds are left-aligned.

Note
The analog watchdog must be enabled for either or both of the regular or injected channels. If neither are enabled, the analog watchdog feature will be disabled. If both are enabled, the same channel number is monitored. adc_enable_analog_watchdog_injected, adc_enable_analog_watchdog_regular.
Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]channelUnsigned int8. ADC channel number ADC watchdog channel

Definition at line 294 of file adc_common_v1.c.

References ADC_CR1, ADC_CR1_AWDCH_MAX, and ADC_CR1_AWDSGL.

◆ adc_enable_analog_watchdog_regular()

void adc_enable_analog_watchdog_regular ( uint32_t  adc)

ADC Enable Analog Watchdog for Regular Conversions.

The analog watchdog allows the monitoring of an analog signal between two threshold levels. The thresholds must be preset.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses.

Definition at line 123 of file adc_common_v1.c.

References ADC_CR1, and ADC_CR1_AWDEN.

◆ adc_enable_automatic_injected_group_conversion()

void adc_enable_automatic_injected_group_conversion ( uint32_t  adc)

ADC Enable Automatic Injected Conversions.

The ADC converts a defined injected group of channels immediately after the regular channels have been converted. The external trigger on the injected channels is disabled as required.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 239 of file adc_common_v1.c.

References ADC_CR1, ADC_CR1_JAUTO, and adc_disable_external_trigger_injected().

Here is the call graph for this function:

◆ adc_enable_awd_interrupt()

void adc_enable_awd_interrupt ( uint32_t  adc)

ADC Enable Analog Watchdog Interrupt.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 361 of file adc_common_v1.c.

References ADC_CR1, and ADC_CR1_AWDIE.

◆ adc_enable_discontinuous_mode_injected()

void adc_enable_discontinuous_mode_injected ( uint32_t  adc)

ADC Enable Discontinuous Mode for Injected Conversions.

In this mode the ADC converts sequentially one channel of the defined group of injected channels, cycling back to the first channel in the group once the entire group has been converted.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 212 of file adc_common_v1.c.

References ADC_CR1, and ADC_CR1_JDISCEN.

◆ adc_enable_discontinuous_mode_regular()

void adc_enable_discontinuous_mode_regular ( uint32_t  adc,
uint8_t  length 
)

ADC Enable Discontinuous Mode for Regular Conversions.

In this mode the ADC converts, on each trigger, a subgroup of up to 8 of the defined regular channel group. The subgroup is defined by the number of consecutive channels to be converted. After a subgroup has been converted the next trigger will start conversion of the immediately following subgroup of the same length or until the whole group has all been converted. When the the whole group has been converted, the next trigger will restart conversion of the subgroup at the beginning of the whole group.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]lengthUnsigned int8. Number of channels in the group ADC Number of channels in discontinuous mode.

Definition at line 182 of file adc_common_v1.c.

References ADC_CR1, ADC_CR1_DISCEN, and ADC_CR1_DISCNUM_SHIFT.

◆ adc_enable_dma()

void adc_enable_dma ( uint32_t  adc)

ADC Enable DMA Transfers.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 735 of file adc_common_v1.c.

References ADC_CR2, and ADC_CR2_DMA.

◆ adc_enable_eoc_interrupt()

void adc_enable_eoc_interrupt ( uint32_t  adc)

ADC Enable Regular End-Of-Conversion Interrupt.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 384 of file adc_common_v1.c.

References ADC_CR1, and ADC_CR1_EOCIE.

◆ adc_enable_eoc_interrupt_injected()

void adc_enable_eoc_interrupt_injected ( uint32_t  adc)

ADC Enable Injected End-Of-Conversion Interrupt.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 339 of file adc_common_v1.c.

References ADC_CR1, and ADC_CR1_JEOCIE.

◆ adc_enable_external_trigger_injected()

void adc_enable_external_trigger_injected ( uint32_t  adc,
uint32_t  trigger,
uint32_t  polarity 
)

ADC Enable an External Trigger for Injected Channels.

This enables an external trigger for set of defined injected channels, and sets the polarity of the trigger event: rising or falling edge or both.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]triggerUnsigned int8. Trigger identifier ADC Trigger Identifier for Injected group
[in]polarityUnsigned int32. Trigger polarity ADC Injected Trigger Polarity

Definition at line 166 of file adc_common_v1_multi.c.

References ADC_CR2, ADC_CR2_JEXTEN_MASK, and ADC_CR2_JEXTSEL_MASK.

◆ adc_enable_external_trigger_regular()

void adc_enable_external_trigger_regular ( uint32_t  adc,
uint32_t  trigger,
uint32_t  polarity 
)

ADC Enable an External Trigger for Regular Channels.

This enables an external trigger for set of defined regular channels, and sets the polarity of the trigger event: rising or falling edge or both. Note that if the trigger polarity is zero, triggering is disabled.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]triggerUnsigned int32. Trigger identifier ADC Trigger Identifier for Regular group
[in]polarityUnsigned int32. Trigger polarity ADC Trigger Polarity

Definition at line 133 of file adc_common_v1_multi.c.

References ADC_CR2, ADC_CR2_EXTEN_MASK, and ADC_CR2_EXTSEL_MASK.

◆ adc_enable_overrun_interrupt()

void adc_enable_overrun_interrupt ( uint32_t  adc)

ADC Enable the Overrun Interrupt.

The overrun interrupt is generated when data is not read from a result register before the next conversion is written. If DMA is enabled, all transfers are terminated and any conversion sequence is aborted.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 216 of file adc_common_v1_multi.c.

References ADC_CR1, and ADC_CR1_OVRIE.

◆ adc_enable_scan_mode()

void adc_enable_scan_mode ( uint32_t  adc)

ADC Set Scan Mode.

In this mode a conversion consists of a scan of the predefined set of channels, regular and injected, each channel conversion immediately following the previous one. It can use single, continuous or discontinuous mode.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 317 of file adc_common_v1.c.

References ADC_CR1, and ADC_CR1_SCAN.

◆ adc_enable_temperature_sensor()

void adc_enable_temperature_sensor ( void  )

ADC Enable The Temperature Sensor.

This enables both the sensor and the reference voltage measurements on ADC1. On STM32F42x and STM32F43x, the temperature sensor is connected to ADC1 channel 18, the same as VBat. If both are enabled, only the VBat conversion is performed.

Definition at line 343 of file adc_common_v1_multi.c.

References ADC_CCR, and ADC_CCR_TSVREFE.

◆ adc_enable_vbat_sensor()

void adc_enable_vbat_sensor ( void  )

Enable The VBat Sensor.

This enables the battery voltage measurements on ADC1 channel 18. On STM32F42x and STM32F43x, this must be disabled when the temperature sensor is enabled. If both are enabled, only the VBat conversion is performed.

Definition at line 110 of file adc_common_f47.c.

References ADC_CCR, and ADC_CCR_VBATE.

◆ adc_eoc()

bool adc_eoc ( uint32_t  adc)

ADC Read the End-of-Conversion Flag.

This flag is set after all channels of a regular or injected group have been converted.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
Returns
bool. End of conversion flag.

Definition at line 435 of file adc_common_v1.c.

References ADC_SR, and ADC_SR_EOC.

◆ adc_eoc_after_each()

void adc_eoc_after_each ( uint32_t  adc)

ADC Enable an EOC for Each Conversion.

The EOC is set after each conversion in a sequence rather than at the end of the sequence. Overrun detection is enabled only if DMA is enabled.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 274 of file adc_common_v1_multi.c.

References ADC_CR2, and ADC_CR2_EOCS.

◆ adc_eoc_after_group()

void adc_eoc_after_group ( uint32_t  adc)

ADC Disable the EOC for Each Conversion.

The EOC is set at the end of each sequence rather than after each conversion in the sequence. Overrun detection is enabled always.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 288 of file adc_common_v1_multi.c.

References ADC_CR2.

◆ adc_eoc_injected()

bool adc_eoc_injected ( uint32_t  adc)

ADC Read the End-of-Conversion Flag for Injected Conversion.

This flag is set after all channels of an injected group have been converted.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
Returns
bool. End of conversion flag.

Definition at line 449 of file adc_common_v1.c.

References ADC_SR, and ADC_SR_JEOC.

◆ adc_get_flag()

bool adc_get_flag ( uint32_t  adc,
uint32_t  flag 
)

Read a Status Flag.

Parameters
[in]adcUnsigned int32. ADC register address base ADC register base addresses
[in]flagUnsigned int32. Status register flag ADC Status Register Flags.
Returns
boolean: flag set.

Definition at line 759 of file adc_common_v1.c.

References ADC_SR.

◆ adc_get_overrun_flag()

bool adc_get_overrun_flag ( uint32_t  adc)

ADC Read the Overrun Flag.

The overrun flag is set when data is not read from a result register before the next conversion is written. If DMA is enabled, all transfers are terminated and any conversion sequence is aborted.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
Returns
Unsigned int32 conversion result.

Definition at line 243 of file adc_common_v1_multi.c.

References ADC_SR, and ADC_SR_OVR.

◆ adc_power_off()

void adc_power_off ( uint32_t  adc)

ADC Off.

Turn off the ADC to reduce power consumption to a few microamps.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses.

Definition at line 108 of file adc_common_v1.c.

References ADC_CR2.

◆ adc_power_on()

void adc_power_on ( uint32_t  adc)

ADC Power On.

If the ADC is in power-down mode then it is powered up. The application needs to wait a time of about 3 microseconds for stabilization before using the ADC. If the ADC is already on this function call will have no effect. NOTE Common with L1 and F2

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 102 of file adc_common_v1_multi.c.

References ADC_CR2, and ADC_CR2_ADON.

◆ adc_read_injected()

uint32_t adc_read_injected ( uint32_t  adc,
uint8_t  reg 
)

ADC Read from an Injected Conversion Result Register.

The result read back from the selected injected result register (one of four) is 12 bits, right or left aligned within the first 16 bits. The result can have a negative value if the injected channel offset has been set

See also
adc_set_injected_offset.
Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]regUnsigned int8. Register number (1 ... 4).
Returns
Unsigned int32 conversion result.

Definition at line 483 of file adc_common_v1.c.

References ADC_JDR1, ADC_JDR2, ADC_JDR3, and ADC_JDR4.

◆ adc_read_regular()

uint32_t adc_read_regular ( uint32_t  adc)

ADC Read from the Regular Conversion Result Register.

The result read back is 12 bits, right or left aligned within the first 16 bits. For ADC1 only, the higher 16 bits will hold the result from ADC2 if an appropriate dual mode has been set

See also
adc_set_dual_mode.
Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
Returns
Unsigned int32 conversion result.

Definition at line 465 of file adc_common_v1.c.

References ADC_DR.

◆ adc_set_clk_prescale()

void adc_set_clk_prescale ( uint32_t  prescale)

ADC Set Clock Prescale The ADC clock can be prescaled.

The Clock sources and scaler values are part specific.

Parameters
[in]prescalePrescale value for ADC Clock ADC Prescale

Definition at line 114 of file adc_common_v1_multi.c.

References ADC_CCR.

◆ adc_set_continuous_conversion_mode()

void adc_set_continuous_conversion_mode ( uint32_t  adc)

ADC Enable Continuous Conversion Mode.

In this mode the ADC starts a new conversion of a single channel or a channel group immediately following completion of the previous channel group conversion.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 507 of file adc_common_v1.c.

References ADC_CR2, and ADC_CR2_CONT.

◆ adc_set_dma_continue()

void adc_set_dma_continue ( uint32_t  adc)

ADC Set DMA to Continue.

This must be set to allow DMA to continue to operate after the last conversion in the DMA sequence. This allows DMA to be used in continuous circular mode.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 302 of file adc_common_v1_multi.c.

References ADC_CR2, and ADC_CR2_DDS.

◆ adc_set_dma_terminate()

void adc_set_dma_terminate ( uint32_t  adc)

ADC Set DMA to Terminate.

This must be set to allow DMA to terminate after the last conversion in the DMA sequence. This can avoid overrun errors.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses

Definition at line 316 of file adc_common_v1_multi.c.

References ADC_CR2.

◆ adc_set_injected_offset()

void adc_set_injected_offset ( uint32_t  adc,
uint8_t  reg,
uint32_t  offset 
)

ADC Set the Injected Channel Data Offset.

This value is subtracted from the injected channel results after conversion is complete, and can result in negative results. A separate value can be specified for each injected data register.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]regUnsigned int8. Register number (1 ... 4).
[in]offsetUnsigned int32.

Definition at line 662 of file adc_common_v1.c.

References ADC_JOFR1, ADC_JOFR2, ADC_JOFR3, and ADC_JOFR4.

◆ adc_set_injected_sequence()

void adc_set_injected_sequence ( uint32_t  adc,
uint8_t  length,
uint8_t  channel[] 
)

ADC Set an Injected Channel Conversion Sequence.

Defines a sequence of channels to be converted as an injected group with a length from 1 to 4 channels. If this is called during conversion, the current conversion is reset and conversion begins again with the newly defined group.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]lengthUnsigned int8. Number of channels in the group.
[in]channelUnsigned int8[]. Set of channels in sequence, integers 0..18

Definition at line 630 of file adc_common_v1.c.

References ADC_JSQR, ADC_JSQR_JL_VAL, and ADC_JSQR_JSQ_VAL.

◆ adc_set_left_aligned()

void adc_set_left_aligned ( uint32_t  adc)

ADC Set the Data as Left Aligned.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses.

Definition at line 408 of file adc_common_v1.c.

References ADC_CR2, and ADC_CR2_ALIGN.

◆ adc_set_multi_mode()

void adc_set_multi_mode ( uint32_t  mode)

ADC Set Dual/Triple Mode.

The multiple mode uses ADC1 as master, ADC2 and optionally ADC3 in a slave arrangement. This setting is applied to ADC1 only.

The various modes possible are described in the reference manual.

Parameters
[in]modeUnsigned int32. Multiple mode selection from ADC Multi mode selection

Definition at line 99 of file adc_common_f47.c.

References ADC_CCR.

◆ adc_set_regular_sequence()

void adc_set_regular_sequence ( uint32_t  adc,
uint8_t  length,
uint8_t  channel[] 
)

ADC Set a Regular Channel Conversion Sequence.

Define a sequence of channels to be converted as a regular group with a length from 1 to ADC_REGULAR_SEQUENCE_MAX channels. If this is called during conversion, the current conversion is reset and conversion begins again with the newly defined group.

Parameters
[in]adcUnsigned int32. ADC block base address ADC register base addresses.
[in]lengthUnsigned int8. Number of channels in the group.
[in]channelUnsigned int8[]. Set of channels in sequence, integers 0..31.

Definition at line 574 of file adc_common_v1.c.

References ADC_SQR1, ADC_SQR1_L_LSB, ADC_SQR2, ADC_SQR3, and ADC_SQR_MAX_CHANNELS_REGULAR.

◆ adc_set_resolution()

void adc_set_resolution ( uint32_t  adc,
uint32_t  resolution 
)

ADC Set Resolution.

ADC Resolution can be reduced from 12 bits to 10, 8 or 6 bits for a corresponding reduction in conversion time (resolution + 3 ADC clock cycles).

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]resolutionUnsigned int32. Resolution value ADC Resolution.

Definition at line 197 of file adc_common_v1_multi.c.

References ADC_CR1.

◆ adc_set_right_aligned()

void adc_set_right_aligned ( uint32_t  adc)

ADC Set the Data as Right Aligned.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses.

Definition at line 420 of file adc_common_v1.c.

References ADC_CR2.

◆ adc_set_sample_time()

void adc_set_sample_time ( uint32_t  adc,
uint8_t  channel,
uint8_t  time 
)

ADC Set the Sample Time for a Single Channel.

The sampling time can be selected in ADC clock cycles from 1.5 to 239.5.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]channelUnsigned int8. ADC Channel integer 0..18 or from ADC Channel Numbers
[in]timeUnsigned int8. Sampling time selection from ADC Sample Time Selection for All Channels NOTE Common with f1, f2 and f37x

Definition at line 45 of file adc_common_f47.c.

References ADC_SMPR1, and ADC_SMPR2.

◆ adc_set_sample_time_on_all_channels()

void adc_set_sample_time_on_all_channels ( uint32_t  adc,
uint8_t  time 
)

ADC Set the Sample Time for All Channels.

The sampling time can be selected in ADC clock cycles from 1.5 to 239.5, same for all channels.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]timeUnsigned int8. Sampling time selection from ADC Sample Time Selection for All Channels NOTE Common with f1, f2 and f37x

Definition at line 72 of file adc_common_f47.c.

References ADC_SMPR1, and ADC_SMPR2.

◆ adc_set_single_conversion_mode()

void adc_set_single_conversion_mode ( uint32_t  adc)

ADC Enable Single Conversion Mode.

In this mode the ADC performs a conversion of one channel or a channel group and stops.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses.

Definition at line 523 of file adc_common_v1.c.

References ADC_CR2.

◆ adc_set_watchdog_high_threshold()

void adc_set_watchdog_high_threshold ( uint32_t  adc,
uint16_t  threshold 
)

ADC Set Analog Watchdog Upper Threshold.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]thresholdUpper threshold value, 12bit right aligned.

Definition at line 535 of file adc_common_v1.c.

References ADC_HT_MSK, and ADC_HTR.

◆ adc_set_watchdog_low_threshold()

void adc_set_watchdog_low_threshold ( uint32_t  adc,
uint16_t  threshold 
)

ADC Set Analog Watchdog Lower Threshold.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses
[in]thresholdLower threshold value, 12bit right aligned.

Definition at line 551 of file adc_common_v1.c.

References ADC_LT_MSK, and ADC_LTR.

◆ adc_start_conversion_injected()

void adc_start_conversion_injected ( uint32_t  adc)

ADC Software Triggered Conversion on Injected Channels.

This starts conversion on a set of defined injected channels if the ADC trigger is set to be a software trigger. It is cleared by hardware once conversion starts.

Special F1 Note this is a software trigger and requires triggering to be enabled and the trigger source to be set appropriately otherwise conversion will not start. This is not the same as the ADC start conversion operation.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses.

Definition at line 719 of file adc_common_v1.c.

References ADC_CR2, and ADC_CR2_JSWSTART.

◆ adc_start_conversion_regular()

void adc_start_conversion_regular ( uint32_t  adc)

ADC Software Triggered Conversion on Regular Channels.

This starts conversion on a set of defined regular channels if the ADC trigger is set to be a software trigger. It is cleared by hardware once conversion starts.

Special F1 Note this is a software trigger and requires triggering to be enabled and the trigger source to be set appropriately otherwise conversion will not start. This is not the same as the ADC start conversion operation.

Parameters
[in]adcUnsigned int32. ADC block register address base ADC register base addresses.

Definition at line 695 of file adc_common_v1.c.

References ADC_CR2, and ADC_CR2_SWSTART.