Initialization and de-initialization functions

Functions
ErrorStatus	LL_ADC_CommonDeInit (ADC_Common_TypeDef *ADCxy_COMMON)
	De-initialize registers of all ADC instances belonging to the same ADC common instance to their default reset values.
ErrorStatus	LL_ADC_CommonInit (ADC_Common_TypeDef *ADCxy_COMMON, LL_ADC_CommonInitTypeDef *ADC_CommonInitStruct)
	Initialize some features of ADC common parameters (all ADC instances belonging to the same ADC common instance) and multimode (for devices with several ADC instances available).
void	LL_ADC_CommonStructInit (LL_ADC_CommonInitTypeDef *ADC_CommonInitStruct)
	Set each LL_ADC_CommonInitTypeDef field to default value.
ErrorStatus	LL_ADC_DeInit (ADC_TypeDef *ADCx)
	De-initialize registers of the selected ADC instance to their default reset values.
ErrorStatus	LL_ADC_Init (ADC_TypeDef *ADCx, LL_ADC_InitTypeDef *ADC_InitStruct)
	Initialize some features of ADC instance.
void	LL_ADC_StructInit (LL_ADC_InitTypeDef *ADC_InitStruct)
	Set each LL_ADC_InitTypeDef field to default value.
ErrorStatus	LL_ADC_REG_Init (ADC_TypeDef *ADCx, LL_ADC_REG_InitTypeDef *ADC_REG_InitStruct)
	Initialize some features of ADC group regular.
void	LL_ADC_REG_StructInit (LL_ADC_REG_InitTypeDef *ADC_REG_InitStruct)
	Set each LL_ADC_REG_InitTypeDef field to default value.
ErrorStatus	LL_ADC_INJ_Init (ADC_TypeDef *ADCx, LL_ADC_INJ_InitTypeDef *ADC_INJ_InitStruct)
	Initialize some features of ADC group injected.
void	LL_ADC_INJ_StructInit (LL_ADC_INJ_InitTypeDef *ADC_INJ_InitStruct)
	Set each LL_ADC_INJ_InitTypeDef field to default value.

---

Function Documentation

ErrorStatus LL_ADC_CommonDeInit

(

ADC_Common_TypeDef *

ADCxy_COMMON

)

De-initialize registers of all ADC instances belonging to the same ADC common instance to their default reset values.

Note:

This function is performing a hard reset, using high level clock source RCC ADC reset. Caution: On this STM32 series, if several ADC instances are available on the selected device, RCC ADC reset will reset all ADC instances belonging to the common ADC instance. To de-initialize only 1 ADC instance, use function LL_ADC_DeInit().

Parameters:

ADCxy_COMMON

ADC common instance (can be set directly from CMSIS definition or by using helper macro __LL_ADC_COMMON_INSTANCE() )

Return values:

An	ErrorStatus enumeration value: SUCCESS: ADC common registers are de-initialized ERROR: not applicable

Definition at line 330 of file stm32h7xx_ll_adc.c.

References assert_param, LL_AHB1_GRP1_ForceReset(), LL_AHB1_GRP1_PERIPH_ADC12, LL_AHB1_GRP1_ReleaseReset(), LL_AHB4_GRP1_ForceReset(), LL_AHB4_GRP1_PERIPH_ADC3, and LL_AHB4_GRP1_ReleaseReset().

ErrorStatus LL_ADC_CommonInit	(	ADC_Common_TypeDef *	ADCxy_COMMON,
		LL_ADC_CommonInitTypeDef *	ADC_CommonInitStruct
	)

Initialize some features of ADC common parameters (all ADC instances belonging to the same ADC common instance) and multimode (for devices with several ADC instances available).

Note:

The setting of ADC common parameters is conditioned to ADC instances state: All ADC instances belonging to the same ADC common instance must be disabled.

Parameters:

ADCxy_COMMON	ADC common instance (can be set directly from CMSIS definition or by using helper macro __LL_ADC_COMMON_INSTANCE() )
ADC_CommonInitStruct	Pointer to a LL_ADC_CommonInitTypeDef structure

Return values:

An	ErrorStatus enumeration value: SUCCESS: ADC common registers are initialized ERROR: ADC common registers are not initialized

Definition at line 372 of file stm32h7xx_ll_adc.c.

References __LL_ADC_IS_ENABLED_ALL_COMMON_INSTANCE, assert_param, LL_ADC_CommonInitTypeDef::CommonClock, IS_LL_ADC_COMMON_CLOCK, IS_LL_ADC_MULTI_DMA_TRANSFER, IS_LL_ADC_MULTI_MODE, IS_LL_ADC_MULTI_TWOSMP_DELAY, LL_ADC_MULTI_INDEPENDENT, LL_ADC_CommonInitTypeDef::MultiDMATransfer, LL_ADC_CommonInitTypeDef::Multimode, and LL_ADC_CommonInitTypeDef::MultiTwoSamplingDelay.

void LL_ADC_CommonStructInit

(

LL_ADC_CommonInitTypeDef *

ADC_CommonInitStruct

)

Set each LL_ADC_CommonInitTypeDef field to default value.

Parameters:

ADC_CommonInitStruct

Pointer to a LL_ADC_CommonInitTypeDef structure whose fields will be set to default values.

Return values:

None

Definition at line 448 of file stm32h7xx_ll_adc.c.

References LL_ADC_CommonInitTypeDef::CommonClock, LL_ADC_CLOCK_SYNC_PCLK_DIV2, LL_ADC_MULTI_INDEPENDENT, LL_ADC_MULTI_REG_DMA_EACH_ADC, LL_ADC_MULTI_TWOSMP_DELAY_1CYCLE_5, LL_ADC_CommonInitTypeDef::MultiDMATransfer, LL_ADC_CommonInitTypeDef::Multimode, and LL_ADC_CommonInitTypeDef::MultiTwoSamplingDelay.

ErrorStatus LL_ADC_DeInit

(

ADC_TypeDef *

ADCx

)

De-initialize registers of the selected ADC instance to their default reset values.

Note:

To reset all ADC instances quickly (perform a hard reset), use function LL_ADC_CommonDeInit().

If this functions returns error status, it means that ADC instance is in an unknown state. In this case, perform a hard reset using high level clock source RCC ADC reset. Caution: On this STM32 series, if several ADC instances are available on the selected device, RCC ADC reset will reset all ADC instances belonging to the common ADC instance. Refer to function LL_ADC_CommonDeInit().

Parameters:

ADCx	ADC instance

Return values:

An	ErrorStatus enumeration value: SUCCESS: ADC registers are de-initialized ERROR: ADC registers are not de-initialized

Definition at line 479 of file stm32h7xx_ll_adc.c.

References ADC_TIMEOUT_DISABLE_CPU_CYCLES, ADC_TIMEOUT_STOP_CONVERSION_CPU_CYCLES, assert_param, LL_ADC_Disable(), LL_ADC_FLAG_ADRDY, LL_ADC_FLAG_AWD1, LL_ADC_FLAG_AWD2, LL_ADC_FLAG_AWD3, LL_ADC_FLAG_EOC, LL_ADC_FLAG_EOS, LL_ADC_FLAG_EOSMP, LL_ADC_FLAG_JEOC, LL_ADC_FLAG_JEOS, LL_ADC_FLAG_JQOVF, LL_ADC_FLAG_OVR, LL_ADC_INJ_IsConversionOngoing(), LL_ADC_INJ_IsStopConversionOngoing(), LL_ADC_INJ_QUEUE_2CONTEXTS_END_EMPTY, LL_ADC_INJ_SetQueueMode(), LL_ADC_INJ_SetTriggerSource(), LL_ADC_INJ_StopConversion(), LL_ADC_INJ_TRIG_SOFTWARE, LL_ADC_IsDisableOngoing(), LL_ADC_IsEnabled(), LL_ADC_IT_ADRDY, LL_ADC_IT_AWD1, LL_ADC_IT_AWD2, LL_ADC_IT_AWD3, LL_ADC_IT_EOC, LL_ADC_IT_EOS, LL_ADC_IT_EOSMP, LL_ADC_IT_JEOC, LL_ADC_IT_JEOS, LL_ADC_IT_JQOVF, LL_ADC_IT_OVR, LL_ADC_REG_IsConversionOngoing(), LL_ADC_REG_IsStopConversionOngoing(), LL_ADC_REG_SetTriggerSource(), LL_ADC_REG_StopConversion(), and LL_ADC_REG_TRIG_SOFTWARE.

ErrorStatus LL_ADC_Init	(	ADC_TypeDef *	ADCx,
		LL_ADC_InitTypeDef *	ADC_InitStruct
	)

Initialize some features of ADC instance.

Note:

These parameters have an impact on ADC scope: ADC instance. Affects both group regular and group injected (availability of ADC group injected depends on STM32 families). Refer to corresponding unitary functions into Configuration of ADC hierarchical scope: ADC instance .

The setting of these parameters by function LL_ADC_Init() is conditioned to ADC state: ADC instance must be disabled. This condition is applied to all ADC features, for efficiency and compatibility over all STM32 families. However, the different features can be set under different ADC state conditions (setting possible with ADC enabled without conversion on going, ADC enabled with conversion on going, ...) Each feature can be updated afterwards with a unitary function and potentially with ADC in a different state than disabled, refer to description of each function for setting conditioned to ADC state.

After using this function, some other features must be configured using LL unitary functions. The minimum configuration remaining to be done is:

• Set ADC group regular or group injected sequencer: map channel on the selected sequencer rank. Refer to function LL_ADC_REG_SetSequencerRanks().
• Set ADC channel sampling time Refer to function LL_ADC_SetChannelSamplingTime();

Parameters:

ADCx	ADC instance
ADC_InitStruct	Pointer to a LL_ADC_REG_InitTypeDef structure

Return values:

An	ErrorStatus enumeration value: SUCCESS: ADC registers are initialized ERROR: ADC registers are not initialized

Definition at line 805 of file stm32h7xx_ll_adc.c.

References __LL_ADC12_RESOLUTION_TO_ADC3, assert_param, IS_LL_ADC_LEFT_BIT_SHIFT, IS_LL_ADC_LOW_POWER, IS_LL_ADC_RESOLUTION, LL_ADC_InitTypeDef::LeftBitShift, LL_ADC_IsEnabled(), LL_ADC_InitTypeDef::LowPowerMode, and LL_ADC_InitTypeDef::Resolution.

ErrorStatus LL_ADC_INJ_Init	(	ADC_TypeDef *	ADCx,
		LL_ADC_INJ_InitTypeDef *	ADC_INJ_InitStruct
	)

Initialize some features of ADC group injected.

Note:

These parameters have an impact on ADC scope: ADC group injected. Refer to corresponding unitary functions into Configuration of ADC hierarchical scope: group regular (functions with prefix "INJ").

The setting of these parameters by function LL_ADC_Init() is conditioned to ADC state: ADC instance must be disabled. This condition is applied to all ADC features, for efficiency and compatibility over all STM32 families. However, the different features can be set under different ADC state conditions (setting possible with ADC enabled without conversion on going, ADC enabled with conversion on going, ...) Each feature can be updated afterwards with a unitary function and potentially with ADC in a different state than disabled, refer to description of each function for setting conditioned to ADC state.

After using this function, other features must be configured using LL unitary functions. The minimum configuration remaining to be done is:

• Set ADC group injected sequencer: map channel on the selected sequencer rank. Refer to function LL_ADC_INJ_SetSequencerRanks().
• Set ADC channel sampling time Refer to function LL_ADC_SetChannelSamplingTime();

Parameters:

ADCx	ADC instance
ADC_INJ_InitStruct	Pointer to a LL_ADC_INJ_InitTypeDef structure

Return values:

An	ErrorStatus enumeration value: SUCCESS: ADC registers are initialized ERROR: ADC registers are not initialized

Definition at line 1050 of file stm32h7xx_ll_adc.c.

References assert_param, IS_LL_ADC_INJ_SEQ_SCAN_DISCONT_MODE, IS_LL_ADC_INJ_SEQ_SCAN_LENGTH, IS_LL_ADC_INJ_TRIG_AUTO, IS_LL_ADC_INJ_TRIG_SOURCE, LL_ADC_INJ_SEQ_SCAN_DISABLE, LL_ADC_IsEnabled(), LL_ADC_REG_SEQ_DISCONT_DISABLE, LL_ADC_REG_SEQ_SCAN_DISABLE, LL_ADC_INJ_InitTypeDef::SequencerDiscont, LL_ADC_INJ_InitTypeDef::SequencerLength, LL_ADC_INJ_InitTypeDef::TrigAuto, and LL_ADC_INJ_InitTypeDef::TriggerSource.

void LL_ADC_INJ_StructInit

(

LL_ADC_INJ_InitTypeDef *

ADC_INJ_InitStruct

)

Set each LL_ADC_INJ_InitTypeDef field to default value.

Parameters:

ADC_INJ_InitStruct

Pointer to a LL_ADC_INJ_InitTypeDef structure whose fields will be set to default values.

Return values:

None

Definition at line 1121 of file stm32h7xx_ll_adc.c.

References LL_ADC_INJ_SEQ_DISCONT_DISABLE, LL_ADC_INJ_SEQ_SCAN_DISABLE, LL_ADC_INJ_TRIG_INDEPENDENT, LL_ADC_INJ_TRIG_SOFTWARE, LL_ADC_INJ_InitTypeDef::SequencerDiscont, LL_ADC_INJ_InitTypeDef::SequencerLength, LL_ADC_INJ_InitTypeDef::TrigAuto, and LL_ADC_INJ_InitTypeDef::TriggerSource.

ErrorStatus LL_ADC_REG_Init	(	ADC_TypeDef *	ADCx,
		LL_ADC_REG_InitTypeDef *	ADC_REG_InitStruct
	)

Initialize some features of ADC group regular.

Note:

These parameters have an impact on ADC scope: ADC group regular. Refer to corresponding unitary functions into Configuration of ADC hierarchical scope: group regular (functions with prefix "REG").

The setting of these parameters by function LL_ADC_Init() is conditioned to ADC state: ADC instance must be disabled. This condition is applied to all ADC features, for efficiency and compatibility over all STM32 families. However, the different features can be set under different ADC state conditions (setting possible with ADC enabled without conversion on going, ADC enabled with conversion on going, ...) Each feature can be updated afterwards with a unitary function and potentially with ADC in a different state than disabled, refer to description of each function for setting conditioned to ADC state.

After using this function, other features must be configured using LL unitary functions. The minimum configuration remaining to be done is:

• Set ADC group regular or group injected sequencer: map channel on the selected sequencer rank. Refer to function LL_ADC_REG_SetSequencerRanks().
• Set ADC channel sampling time Refer to function LL_ADC_SetChannelSamplingTime();

Parameters:

ADCx	ADC instance
ADC_REG_InitStruct	Pointer to a LL_ADC_REG_InitTypeDef structure

Return values:

An	ErrorStatus enumeration value: SUCCESS: ADC registers are initialized ERROR: ADC registers are not initialized

Definition at line 914 of file stm32h7xx_ll_adc.c.

References assert_param, LL_ADC_REG_InitTypeDef::ContinuousMode, LL_ADC_REG_InitTypeDef::DataTransferMode, IS_LL_ADC_REG_CONTINUOUS_MODE, IS_LL_ADC_REG_DATA_TRANSFER_MODE, IS_LL_ADC_REG_OVR_DATA_BEHAVIOR, IS_LL_ADC_REG_SEQ_SCAN_DISCONT_MODE, IS_LL_ADC_REG_SEQ_SCAN_LENGTH, IS_LL_ADC_REG_TRIG_SOURCE, LL_ADC_IsEnabled(), LL_ADC_REG_CONV_SINGLE, LL_ADC_REG_SEQ_DISCONT_DISABLE, LL_ADC_REG_SEQ_SCAN_DISABLE, LL_ADC_REG_SetSequencerLength(), LL_ADC_REG_InitTypeDef::Overrun, LL_ADC_REG_InitTypeDef::SequencerDiscont, LL_ADC_REG_InitTypeDef::SequencerLength, and LL_ADC_REG_InitTypeDef::TriggerSource.

void LL_ADC_REG_StructInit

(

LL_ADC_REG_InitTypeDef *

ADC_REG_InitStruct

)

Set each LL_ADC_REG_InitTypeDef field to default value.

Parameters:

ADC_REG_InitStruct

Pointer to a LL_ADC_REG_InitTypeDef structure whose fields will be set to default values.

Return values:

None

Definition at line 1004 of file stm32h7xx_ll_adc.c.

References LL_ADC_REG_InitTypeDef::ContinuousMode, LL_ADC_REG_InitTypeDef::DataTransferMode, LL_ADC_REG_CONV_SINGLE, LL_ADC_REG_DR_TRANSFER, LL_ADC_REG_OVR_DATA_OVERWRITTEN, LL_ADC_REG_SEQ_DISCONT_DISABLE, LL_ADC_REG_SEQ_SCAN_DISABLE, LL_ADC_REG_TRIG_SOFTWARE, LL_ADC_REG_InitTypeDef::Overrun, LL_ADC_REG_InitTypeDef::SequencerDiscont, LL_ADC_REG_InitTypeDef::SequencerLength, and LL_ADC_REG_InitTypeDef::TriggerSource.

void LL_ADC_StructInit

(

LL_ADC_InitTypeDef *

ADC_InitStruct

)

Set each LL_ADC_InitTypeDef field to default value.

Parameters:

ADC_InitStruct

Pointer to a LL_ADC_InitTypeDef structure whose fields will be set to default values.

Return values:

None

Definition at line 872 of file stm32h7xx_ll_adc.c.

References LL_ADC_InitTypeDef::LeftBitShift, LL_ADC_LEFT_BIT_SHIFT_NONE, LL_ADC_LP_MODE_NONE, LL_ADC_RESOLUTION_16B, LL_ADC_InitTypeDef::LowPowerMode, and LL_ADC_InitTypeDef::Resolution.