ADC Extended Peripheral Control functions. More...

Functions
HAL_StatusTypeDef	HAL_ADCEx_InjectedConfigChannel (ADC_HandleTypeDef hadc, ADC_InjectionConfTypeDef sConfigInjected)
	Configure a channel to be assigned to ADC group injected.
HAL_StatusTypeDef	HAL_ADCEx_EnableInjectedQueue (ADC_HandleTypeDef *hadc)
	Enable Injected Queue.
HAL_StatusTypeDef	HAL_ADCEx_DisableInjectedQueue (ADC_HandleTypeDef *hadc)
	Disable Injected Queue.
HAL_StatusTypeDef	HAL_ADCEx_DisableVoltageRegulator (ADC_HandleTypeDef *hadc)
	Disable ADC voltage regulator.
HAL_StatusTypeDef	HAL_ADCEx_EnterADCDeepPowerDownMode (ADC_HandleTypeDef *hadc)
	Enter ADC deep-power-down mode.

Detailed Description

ADC Extended Peripheral Control functions.

 ===============================================================================
             ##### Peripheral Control functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Configure channels on injected group
      (+) Configure multimode when multimode feature is available
      (+) Enable or Disable Injected Queue
      (+) Disable ADC voltage regulator
      (+) Enter ADC deep-power-down mode

Function Documentation

HAL_StatusTypeDef HAL_ADCEx_DisableInjectedQueue ( ADC_HandleTypeDef * hadc )

Disable Injected Queue.

Note:: This function sets CFGR register JQDIS bit in order to disable the Injected Queue. JQDIS can be written only when ADSTART and JDSTART are both equal to 0 to ensure that no regular nor injected conversion is ongoing.

Parameters:

hadc	ADC handle

Return values:

HAL status

Definition at line 2254 of file stm32l4xx_hal_adc_ex.c.

References assert_param, __ADC_HandleTypeDef::Instance, LL_ADC_INJ_IsConversionOngoing(), LL_ADC_INJ_QUEUE_DISABLE, LL_ADC_INJ_SetQueueMode(), and LL_ADC_REG_IsConversionOngoing().

HAL_StatusTypeDef HAL_ADCEx_DisableVoltageRegulator ( ADC_HandleTypeDef * hadc )

Disable ADC voltage regulator.

Note:: Disabling voltage regulator allows to save power. This operation can be carried out only when ADC is disabled.; To enable again the voltage regulator, the user is expected to resort to HAL_ADC_Init() API.

Parameters:

hadc	ADC handle

Return values:

HAL status

Definition at line 2291 of file stm32l4xx_hal_adc_ex.c.

References assert_param, __ADC_HandleTypeDef::Instance, LL_ADC_DisableInternalRegulator(), and LL_ADC_IsEnabled().

HAL_StatusTypeDef HAL_ADCEx_EnableInjectedQueue ( ADC_HandleTypeDef * hadc )

Enable Injected Queue.

Note:: This function resets CFGR register JQDIS bit in order to enable the Injected Queue. JQDIS can be written only when ADSTART and JDSTART are both equal to 0 to ensure that no regular nor injected conversion is ongoing.

Parameters:

hadc	ADC handle

Return values:

HAL status

Definition at line 2213 of file stm32l4xx_hal_adc_ex.c.

References assert_param, HAL_ADC_STATE_INJ_JQOVF, __ADC_HandleTypeDef::Instance, LL_ADC_INJ_IsConversionOngoing(), LL_ADC_REG_IsConversionOngoing(), and __ADC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_ADCEx_EnterADCDeepPowerDownMode ( ADC_HandleTypeDef * hadc )

Enter ADC deep-power-down mode.

Note:: This mode is achieved in setting DEEPPWD bit and allows to save power in reducing leakage currents. It is particularly interesting before entering stop modes.; Setting DEEPPWD automatically clears ADVREGEN bit and disables the ADC voltage regulator. This means that this API encompasses HAL_ADCEx_DisableVoltageRegulator(). Additionally, the internal calibration is lost.; To exit the ADC deep-power-down mode, the user is expected to resort to HAL_ADC_Init() API as well as to relaunch a calibration with HAL_ADCEx_Calibration_Start() API or to re-apply a previously saved calibration factor.

Parameters:

hadc	ADC handle

Return values:

HAL status

Definition at line 2328 of file stm32l4xx_hal_adc_ex.c.

References assert_param, __ADC_HandleTypeDef::Instance, LL_ADC_EnableDeepPowerDown(), and LL_ADC_IsEnabled().

HAL_StatusTypeDef HAL_ADCEx_InjectedConfigChannel	(	ADC_HandleTypeDef *	hadc,
		ADC_InjectionConfTypeDef *	sConfigInjected
	)

Configure a channel to be assigned to ADC group injected.

Note:

Possibility to update parameters on the fly: This function initializes injected group, following calls to this function can be used to reconfigure some parameters of structure "ADC_InjectionConfTypeDef" on the fly, without resetting the ADC. The setting of these parameters is conditioned to ADC state: Refer to comments of structure "ADC_InjectionConfTypeDef".

In case of usage of internal measurement channels: Vbat/VrefInt/TempSensor. These internal paths can be disabled using function HAL_ADC_DeInit().

Caution: For Injected Context Queue use, a context must be fully defined before start of injected conversion. All channels are configured consecutively for the same ADC instance. Therefore, the number of calls to HAL_ADCEx_InjectedConfigChannel() must be equal to the value of parameter InjectedNbrOfConversion for each context.

Example 1: If 1 context is intended to be used (or if there is no use of the Injected Queue Context feature) and if the context contains 3 injected ranks (InjectedNbrOfConversion = 3), HAL_ADCEx_InjectedConfigChannel() must be called once for each channel (i.e. 3 times) before starting a conversion. This function must not be called to configure a 4th injected channel: it would start a new context into context queue.
Example 2: If 2 contexts are intended to be used and each of them contains 3 injected ranks (InjectedNbrOfConversion = 3), HAL_ADCEx_InjectedConfigChannel() must be called once for each channel and for each context (3 channels x 2 contexts = 6 calls). Conversion can start once the 1st context is set, that is after the first three HAL_ADCEx_InjectedConfigChannel() calls. The 2nd context can be set on the fly.

Parameters:

hadc	ADC handle
sConfigInjected	Structure of ADC injected group and ADC channel for injected group.

Return values:

HAL status

Definition at line 1651 of file stm32l4xx_hal_adc_ex.c.

Functions

Detailed Description

Function Documentation