ADC Extended Peripheral Control functions

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_MultiModeConfigChannel (ADC_HandleTypeDef *hadc, ADC_MultiModeTypeDef *multimode)
	Enable ADC multimode and configure multimode parameters.
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 2152 of file stm32l4xx_hal_adc_ex.c.

References ADC_IS_CONVERSION_ONGOING_REGULAR_INJECTED, and __ADC_HandleTypeDef::Instance.

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 2175 of file stm32l4xx_hal_adc_ex.c.

References ADC_IS_ENABLE, and __ADC_HandleTypeDef::Instance.

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 2125 of file stm32l4xx_hal_adc_ex.c.

References ADC_IS_CONVERSION_ONGOING_REGULAR_INJECTED, HAL_ADC_STATE_INJ_JQOVF, __ADC_HandleTypeDef::Instance, 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 2205 of file stm32l4xx_hal_adc_ex.c.

References ADC_IS_ENABLE, and __ADC_HandleTypeDef::Instance.

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 1593 of file stm32l4xx_hal_adc_ex.c.

References __LL_ADC_CHANNEL_TO_DECIMAL_NB, __LL_ADC_COMMON_INSTANCE, __LL_ADC_DECIMAL_NB_TO_CHANNEL, ADC_BATTERY_VOLTAGE_INSTANCE, ADC_CFGR_INJECT_CONTEXT_QUEUE, ADC_CFGR_INJECT_DISCCONTINUOUS, ADC_CHANNEL_TEMPSENSOR, ADC_CHANNEL_VBAT, ADC_CHANNEL_VREFINT, ADC_DIFFERENTIAL_ENDED, ADC_EXTERNALTRIGINJECCONV_EDGE_NONE, ADC_GET_RESOLUTION, ADC_INJECTED_RANK_1, ADC_INJECTED_SOFTWARE_START, ADC_IS_CONVERSION_ONGOING_INJECTED, ADC_IS_CONVERSION_ONGOING_REGULAR_INJECTED, ADC_IS_ENABLE, ADC_JSQR_FIELDS, ADC_JSQR_RK, ADC_OFFSET_NONE, ADC_OFFSET_SHIFT_RESOLUTION, ADC_SCAN_DISABLE, ADC_TEMPERATURE_SENSOR_INSTANCE, ADC_VREFINT_INSTANCE, assert_param, ADC_InjectionConfTypeDef::AutoInjectedConv, ADC_InjectionConfigTypeDef::ChannelCount, ADC_InjectionConfigTypeDef::ContextQueue, ADC_InitTypeDef::DiscontinuousConvMode, ADC_InjectionConfTypeDef::ExternalTrigInjecConv, ADC_InjectionConfTypeDef::ExternalTrigInjecConvEdge, HAL_ADC_STATE_ERROR_CONFIG, __ADC_HandleTypeDef::Init, ADC_InjectionConfTypeDef::InjecOversampling, ADC_InjectionConfTypeDef::InjecOversamplingMode, ADC_InjectionConfTypeDef::InjectedChannel, ADC_InjectionConfTypeDef::InjectedDiscontinuousConvMode, ADC_InjectionConfTypeDef::InjectedNbrOfConversion, ADC_InjectionConfTypeDef::InjectedOffset, ADC_InjectionConfTypeDef::InjectedOffsetNumber, ADC_InjectionConfTypeDef::InjectedRank, ADC_InjectionConfTypeDef::InjectedSamplingTime, ADC_InjectionConfTypeDef::InjectedSingleDiff, __ADC_HandleTypeDef::InjectionConfig, __ADC_HandleTypeDef::Instance, IS_ADC_CHANNEL, IS_ADC_DIFF_CHANNEL, IS_ADC_EXTTRIGINJEC, IS_ADC_EXTTRIGINJEC_EDGE, IS_ADC_INJECTED_NB_CONV, IS_ADC_INJECTED_RANK, IS_ADC_OFFSET_NUMBER, IS_ADC_OVERSAMPLING_RATIO, IS_ADC_RANGE, IS_ADC_RIGHT_BIT_SHIFT, IS_ADC_SAMPLE_TIME, IS_ADC_SINGLE_DIFFERENTIAL, LL_ADC_DELAY_TEMPSENSOR_STAB_US, LL_ADC_GetCommonPathInternalCh(), LL_ADC_GetOffsetChannel(), LL_ADC_OFFSET_1, LL_ADC_OFFSET_2, LL_ADC_OFFSET_3, LL_ADC_OFFSET_4, LL_ADC_OFFSET_DISABLE, LL_ADC_PATH_INTERNAL_TEMPSENSOR, LL_ADC_PATH_INTERNAL_VBAT, LL_ADC_PATH_INTERNAL_VREFINT, LL_ADC_SAMPLINGTIME_2CYCLES_5, LL_ADC_SetChannelSamplingTime(), LL_ADC_SetChannelSingleDiff(), LL_ADC_SetCommonPathInternalCh(), LL_ADC_SetOffset(), LL_ADC_SetOffsetState(), ADC_InjectionConfTypeDef::QueueInjectedContext, ADC_InjOversamplingTypeDef::Ratio, ADC_InjOversamplingTypeDef::RightBitShift, ADC_InitTypeDef::ScanConvMode, and __ADC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_ADCEx_MultiModeConfigChannel	(	ADC_HandleTypeDef *	hadc,
		ADC_MultiModeTypeDef *	multimode
	)

Enable ADC multimode and configure multimode parameters.

Note:

Possibility to update parameters on the fly: This function initializes multimode parameters, following calls to this function can be used to reconfigure some parameters of structure "ADC_MultiModeTypeDef" on the fly, without resetting the ADCs. The setting of these parameters is conditioned to ADC state. For parameters constraints, see comments of structure "ADC_MultiModeTypeDef".

To move back configuration from multimode to single mode, ADC must be reset (using function HAL_ADC_Init() ).

Parameters:

hadc	Master ADC handle
multimode	Structure of ADC multimode configuration

Return values:

HAL

status

Definition at line 2012 of file stm32l4xx_hal_adc_ex.c.

References __LL_ADC_COMMON_INSTANCE, ADC_CCR_MULTI_DMACONTREQ, ADC_IS_CONVERSION_ONGOING_REGULAR, ADC_IS_ENABLE, ADC_MODE_INDEPENDENT, ADC_MULTI_SLAVE, assert_param, ADC_MultiModeTypeDef::DMAAccessMode, ADC_InitTypeDef::DMAContinuousRequests, HAL_ADC_STATE_ERROR_CONFIG, __ADC_HandleTypeDef::Init, __ADC_HandleTypeDef::Instance, IS_ADC_DMA_ACCESS_MULTIMODE, IS_ADC_MULTIMODE, IS_ADC_SAMPLING_DELAY, ADC_MultiModeTypeDef::Mode, __ADC_HandleTypeDef::State, and ADC_MultiModeTypeDef::TwoSamplingDelay.