STM32L443xx HAL User Manual
Defines
ADC Extended Private Macros
ADCEx

Defines

#define ADC_IS_SOFTWARE_START_INJECTED(__HANDLE__)   (((__HANDLE__)->Instance->JSQR & ADC_JSQR_JEXTEN) == 0UL)
 Test if conversion trigger of injected group is software start or external trigger.
#define ADC_IS_CONVERSION_ONGOING_REGULAR_INJECTED(__HANDLE__)
 Check if conversion is on going on regular or injected groups.
#define ADC_IS_CONVERSION_ONGOING_INJECTED(__HANDLE__)   (LL_ADC_INJ_IsConversionOngoing((__HANDLE__)->Instance))
 Check if conversion is on going on injected group.
#define ADC_IS_INDEPENDENT(__HANDLE__)   (SET)
 Check whether or not ADC is independent.
#define ADC_JSQR_RK(__CHANNELNB__, __RANKNB__)
 Set the selected injected Channel rank.
#define ADC_CFGR_INJECT_CONTEXT_QUEUE(__INJECT_CONTEXT_QUEUE_MODE__)   ((__INJECT_CONTEXT_QUEUE_MODE__) << ADC_CFGR_JQM_Pos)
 Configure ADC injected context queue.
#define ADC_CFGR_INJECT_DISCCONTINUOUS(__INJECT_DISCONTINUOUS_MODE__)   ((__INJECT_DISCONTINUOUS_MODE__) << ADC_CFGR_JDISCEN_Pos)
 Configure ADC discontinuous conversion mode for injected group.
#define ADC_CFGR_REG_DISCONTINUOUS(__REG_DISCONTINUOUS_MODE__)   ((__REG_DISCONTINUOUS_MODE__) << ADC_CFGR_DISCEN_Pos)
 Configure ADC discontinuous conversion mode for regular group.
#define ADC_CFGR_DISCONTINUOUS_NUM(__NBR_DISCONTINUOUS_CONV__)   (((__NBR_DISCONTINUOUS_CONV__) - 1UL) << ADC_CFGR_DISCNUM_Pos)
 Configure the number of discontinuous conversions for regular group.
#define ADC_CFGR_AUTOWAIT(__AUTOWAIT__)   ((__AUTOWAIT__) << ADC_CFGR_AUTDLY_Pos)
 Configure the ADC auto delay mode.
#define ADC_CFGR_CONTINUOUS(__CONTINUOUS_MODE__)   ((__CONTINUOUS_MODE__) << ADC_CFGR_CONT_Pos)
 Configure ADC continuous conversion mode.
#define ADC_CFGR_DMACONTREQ(__DMACONTREQ_MODE__)   ((__DMACONTREQ_MODE__) << ADC_CFGR_DMACFG_Pos)
 Configure the ADC DMA continuous request.
#define ADC_OFR_CHANNEL(__CHANNEL__)   ((__CHANNEL__) << ADC_OFR1_OFFSET1_CH_Pos)
 Configure the channel number into offset OFRx register.
#define ADC_DIFSEL_CHANNEL(__CHANNEL__)   (1UL << (__CHANNEL__))
 Configure the channel number into differential mode selection register.
#define ADC_CALFACT_DIFF_SET(__CALIBRATION_FACTOR__)
 Configure calibration factor in differential mode to be set into calibration register.
#define ADC_CALFACT_DIFF_GET(__CALIBRATION_FACTOR__)   ((__CALIBRATION_FACTOR__) >> ADC_CALFACT_CALFACT_D_Pos)
 Calibration factor in differential mode to be retrieved from calibration register.
#define ADC_TRX_HIGHTHRESHOLD(__THRESHOLD__)   ((__THRESHOLD__) << 16UL)
 Configure the analog watchdog high threshold into registers TR1, TR2 or TR3.
#define ADC_OFFSET_SHIFT_RESOLUTION(__HANDLE__, __OFFSET__)   ((__OFFSET__) << ((((__HANDLE__)->Instance->CFGR & ADC_CFGR_RES) >> 3UL) * 2UL))
 Shift the offset with respect to the selected ADC resolution.
#define ADC_AWD1THRESHOLD_SHIFT_RESOLUTION(__HANDLE__, __THRESHOLD__)   ((__THRESHOLD__) << ((((__HANDLE__)->Instance->CFGR & ADC_CFGR_RES) >> 3UL) * 2UL))
 Shift the AWD1 threshold with respect to the selected ADC resolution.
#define ADC_AWD23THRESHOLD_SHIFT_RESOLUTION(__HANDLE__, __THRESHOLD__)
 Shift the AWD2 and AWD3 threshold with respect to the selected ADC resolution.
#define ADC_CLEAR_COMMON_CONTROL_REGISTER(__HANDLE__)
 Clear Common Control Register.
#define ADC_TEMPERATURE_SENSOR_INSTANCE(__HANDLE__)   (((__HANDLE__)->Instance) == ADC1)
 Verify the ADC instance connected to the temperature sensor.
#define ADC_BATTERY_VOLTAGE_INSTANCE(__HANDLE__)   (((__HANDLE__)->Instance) == ADC1)
 Verify the ADC instance connected to the battery voltage VBAT.
#define ADC_VREFINT_INSTANCE(__HANDLE__)   (((__HANDLE__)->Instance) == ADC1)
 Verify the ADC instance connected to the internal voltage reference VREFINT.
#define IS_ADC_INJECTED_NB_CONV(__LENGTH__)   (((__LENGTH__) >= (1U)) && ((__LENGTH__) <= (4U)))
 Verify the length of scheduled injected conversions group.
#define IS_ADC_CALFACT(__CALIBRATION_FACTOR__)   ((__CALIBRATION_FACTOR__) <= (0x7FU))
 Calibration factor size verification (7 bits maximum).
#define IS_ADC_CHANNEL(__HANDLE__, __CHANNEL__)
 Verify the ADC channel setting.
#define IS_ADC_DIFF_CHANNEL(__HANDLE__, __CHANNEL__)
 Verify the ADC channel setting in differential mode.
#define IS_ADC_SINGLE_DIFFERENTIAL(__SING_DIFF__)
 Verify the ADC single-ended input or differential mode setting.
#define IS_ADC_OFFSET_NUMBER(__OFFSET_NUMBER__)
 Verify the ADC offset management setting.
#define IS_ADC_INJECTED_RANK(__CHANNEL__)
 Verify the ADC injected channel setting.
#define IS_ADC_EXTTRIGINJEC(__HANDLE__, __INJTRIG__)
 Verify the ADC injected conversions external trigger.
#define IS_ADC_EXTTRIGINJEC_EDGE(__EDGE__)
 Verify the ADC edge trigger setting for injected group.
#define IS_ADC_ANALOG_WATCHDOG_NUMBER(__WATCHDOG__)
 Verify the ADC analog watchdog setting.
#define IS_ADC_ANALOG_WATCHDOG_MODE(__WATCHDOG_MODE__)
 Verify the ADC analog watchdog mode setting.
#define IS_ADC_CONVERSION_GROUP(__CONVERSION__)
 Verify the ADC conversion (regular or injected or both).
#define IS_ADC_EVENT_TYPE(__EVENT__)
 Verify the ADC event type.
#define IS_ADC_OVERSAMPLING_RATIO(__RATIO__)
 Verify the ADC oversampling ratio.
#define IS_ADC_RIGHT_BIT_SHIFT(__SHIFT__)
 Verify the ADC oversampling shift.
#define IS_ADC_TRIGGERED_OVERSAMPLING_MODE(__MODE__)
 Verify the ADC oversampling triggered mode.
#define IS_ADC_REGOVERSAMPLING_MODE(__MODE__)
 Verify the ADC oversampling regular conversion resumed or continued mode.
#define IS_ADC_DFSDMCFG_MODE(__HANDLE__)   (SET)
 Verify the DFSDM mode configuration.
#define ADC_CFGR_DFSDM(__HANDLE__)   (0x0UL)
 Return the DFSDM configuration mode.

Define Documentation

#define ADC_AWD1THRESHOLD_SHIFT_RESOLUTION (   __HANDLE__,
  __THRESHOLD__ 
)    ((__THRESHOLD__) << ((((__HANDLE__)->Instance->CFGR & ADC_CFGR_RES) >> 3UL) * 2UL))

Shift the AWD1 threshold with respect to the selected ADC resolution.

Note:
Thresholds have to be left-aligned on bit 11, the LSB (right bits) are set to 0. If resolution 12 bits, no shift. If resolution 10 bits, shift of 2 ranks on the left. If resolution 8 bits, shift of 4 ranks on the left. If resolution 6 bits, shift of 6 ranks on the left. Therefore, shift = (12 - resolution) = 12 - (12- (((RES[1:0]) >> 3)*2)).
Parameters:
__HANDLE__ADC handle
__THRESHOLD__Value to be shifted
Return values:
None

Definition at line 613 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_AnalogWDGConfig().

#define ADC_AWD23THRESHOLD_SHIFT_RESOLUTION (   __HANDLE__,
  __THRESHOLD__ 
)
Value:
((((__HANDLE__)->Instance->CFGR & ADC_CFGR_RES) != (ADC_CFGR_RES_1 | ADC_CFGR_RES_0))                    ? \
   ((__THRESHOLD__) >> ((4UL - ((((__HANDLE__)->Instance->CFGR & ADC_CFGR_RES) >> 3UL) * 2UL)) & 0x1FUL)) : \
   ((__THRESHOLD__) << 2UL)                                                                                 \
  )

Shift the AWD2 and AWD3 threshold with respect to the selected ADC resolution.

Note:
Thresholds have to be left-aligned on bit 7. If resolution 12 bits, shift of 4 ranks on the right (the 4 LSB are discarded). If resolution 10 bits, shift of 2 ranks on the right (the 2 LSB are discarded). If resolution 8 bits, no shift. If resolution 6 bits, shift of 2 ranks on the left (the 2 LSB are set to 0).
Parameters:
__HANDLE__ADC handle
__THRESHOLD__Value to be shifted
Return values:
None

Definition at line 627 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_AnalogWDGConfig().

#define ADC_BATTERY_VOLTAGE_INSTANCE (   __HANDLE__)    (((__HANDLE__)->Instance) == ADC1)

Verify the ADC instance connected to the battery voltage VBAT.

Parameters:
__HANDLE__ADC handle.
Return values:
SET(ADC instance is valid) or RESET (ADC instance is invalid)

Definition at line 693 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_ConfigChannel(), and HAL_ADCEx_InjectedConfigChannel().

#define ADC_CALFACT_DIFF_GET (   __CALIBRATION_FACTOR__)    ((__CALIBRATION_FACTOR__) >> ADC_CALFACT_CALFACT_D_Pos)

Calibration factor in differential mode to be retrieved from calibration register.

Parameters:
__CALIBRATION_FACTOR__Calibration factor value.
Return values:
None

Definition at line 568 of file stm32l4xx_hal_adc_ex.h.

#define ADC_CALFACT_DIFF_SET (   __CALIBRATION_FACTOR__)
Value:
(((__CALIBRATION_FACTOR__)\
                                                       & (ADC_CALFACT_CALFACT_D_Pos >> ADC_CALFACT_CALFACT_D_Pos) ) << ADC_CALFACT_CALFACT_D_Pos)

Configure calibration factor in differential mode to be set into calibration register.

Parameters:
__CALIBRATION_FACTOR__Calibration factor value.
Return values:
None

Definition at line 560 of file stm32l4xx_hal_adc_ex.h.

#define ADC_CFGR_AUTOWAIT (   __AUTOWAIT__)    ((__AUTOWAIT__) << ADC_CFGR_AUTDLY_Pos)

Configure the ADC auto delay mode.

Parameters:
__AUTOWAIT__Auto delay bit enable or disable.
Return values:
None

Definition at line 525 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init().

#define ADC_CFGR_CONTINUOUS (   __CONTINUOUS_MODE__)    ((__CONTINUOUS_MODE__) << ADC_CFGR_CONT_Pos)

Configure ADC continuous conversion mode.

Parameters:
__CONTINUOUS_MODE__Continuous mode.
Return values:
None

Definition at line 532 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init().

#define ADC_CFGR_DFSDM (   __HANDLE__)    (0x0UL)

Return the DFSDM configuration mode.

Parameters:
__HANDLE__ADC handle.
Note:
When DMSDFM configuration is not supported, the macro systematically reports 0x0 (i.e disabled). For this reason, the input parameter is the ADC handle and not the configuration parameter directly.
Return values:
DFSDMconfiguration mode

Definition at line 1174 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init().

#define ADC_CFGR_DISCONTINUOUS_NUM (   __NBR_DISCONTINUOUS_CONV__)    (((__NBR_DISCONTINUOUS_CONV__) - 1UL) << ADC_CFGR_DISCNUM_Pos)

Configure the number of discontinuous conversions for regular group.

Parameters:
__NBR_DISCONTINUOUS_CONV__Number of discontinuous conversions.
Return values:
None

Definition at line 518 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init().

#define ADC_CFGR_DMACONTREQ (   __DMACONTREQ_MODE__)    ((__DMACONTREQ_MODE__) << ADC_CFGR_DMACFG_Pos)

Configure the ADC DMA continuous request.

Parameters:
__DMACONTREQ_MODE__DMA continuous request mode.
Return values:
None

Definition at line 539 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init().

#define ADC_CFGR_INJECT_CONTEXT_QUEUE (   __INJECT_CONTEXT_QUEUE_MODE__)    ((__INJECT_CONTEXT_QUEUE_MODE__) << ADC_CFGR_JQM_Pos)

Configure ADC injected context queue.

Parameters:
__INJECT_CONTEXT_QUEUE_MODE__Injected context queue mode.
Return values:
None

Definition at line 497 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADCEx_InjectedConfigChannel().

#define ADC_CFGR_INJECT_DISCCONTINUOUS (   __INJECT_DISCONTINUOUS_MODE__)    ((__INJECT_DISCONTINUOUS_MODE__) << ADC_CFGR_JDISCEN_Pos)

Configure ADC discontinuous conversion mode for injected group.

Parameters:
__INJECT_DISCONTINUOUS_MODE__Injected discontinuous mode.
Return values:
None

Definition at line 504 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADCEx_InjectedConfigChannel().

#define ADC_CFGR_REG_DISCONTINUOUS (   __REG_DISCONTINUOUS_MODE__)    ((__REG_DISCONTINUOUS_MODE__) << ADC_CFGR_DISCEN_Pos)

Configure ADC discontinuous conversion mode for regular group.

Parameters:
__REG_DISCONTINUOUS_MODE__Regular discontinuous mode.
Return values:
None

Definition at line 511 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init().

#define ADC_CLEAR_COMMON_CONTROL_REGISTER (   __HANDLE__)
Value:
CLEAR_BIT(__LL_ADC_COMMON_INSTANCE((__HANDLE__)->Instance)->CCR, \
                                                                ADC_CCR_CKMODE | \
                                                                ADC_CCR_PRESC  | \
                                                                ADC_CCR_VBATEN | \
                                                                ADC_CCR_TSEN   | \
                                                                ADC_CCR_VREFEN)

Clear Common Control Register.

Parameters:
__HANDLE__ADC handle.
Return values:
None

Definition at line 650 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_DeInit().

#define ADC_DIFSEL_CHANNEL (   __CHANNEL__)    (1UL << (__CHANNEL__))

Configure the channel number into differential mode selection register.

Parameters:
__CHANNEL__ADC Channel.
Return values:
None

Definition at line 553 of file stm32l4xx_hal_adc_ex.h.

#define ADC_IS_CONVERSION_ONGOING_INJECTED (   __HANDLE__)    (LL_ADC_INJ_IsConversionOngoing((__HANDLE__)->Instance))

Check if conversion is on going on injected group.

Parameters:
__HANDLE__ADC handle.
Return values:
Value"0" (no conversion is on going) or value "1" (conversion is on going)

Definition at line 460 of file stm32l4xx_hal_adc_ex.h.

#define ADC_IS_CONVERSION_ONGOING_REGULAR_INJECTED (   __HANDLE__)
Value:
(( (((__HANDLE__)->Instance->CR) & (ADC_CR_ADSTART | ADC_CR_JADSTART)) == 0UL \
   ) ? RESET : SET)

Check if conversion is on going on regular or injected groups.

Parameters:
__HANDLE__ADC handle.
Return values:
SET(conversion is on going) or RESET (no conversion is on going).

Definition at line 451 of file stm32l4xx_hal_adc_ex.h.

#define ADC_IS_INDEPENDENT (   __HANDLE__)    (SET)

Check whether or not ADC is independent.

Parameters:
__HANDLE__ADC handle.
Note:
When multimode feature is not available, the macro always returns SET.
Return values:
SET(ADC is independent) or RESET (ADC is not).

Definition at line 478 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Start_DMA().

#define ADC_IS_SOFTWARE_START_INJECTED (   __HANDLE__)    (((__HANDLE__)->Instance->JSQR & ADC_JSQR_JEXTEN) == 0UL)

Test if conversion trigger of injected group is software start or external trigger.

Parameters:
__HANDLE__ADC handle.
Return values:
SET(software start) or RESET (external trigger).

Definition at line 443 of file stm32l4xx_hal_adc_ex.h.

#define ADC_JSQR_RK (   __CHANNELNB__,
  __RANKNB__ 
)
Value:
((((__CHANNELNB__)\
                                                  & ADC_CHANNEL_ID_NUMBER_MASK) >> ADC_CHANNEL_ID_NUMBER_BITOFFSET_POS) << ((__RANKNB__) & ADC_INJ_RANK_ID_JSQR_MASK))

Set the selected injected Channel rank.

Parameters:
__CHANNELNB__Channel number.
__RANKNB__Rank number.
Return values:
None

Definition at line 489 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADCEx_InjectedConfigChannel().

#define ADC_OFFSET_SHIFT_RESOLUTION (   __HANDLE__,
  __OFFSET__ 
)    ((__OFFSET__) << ((((__HANDLE__)->Instance->CFGR & ADC_CFGR_RES) >> 3UL) * 2UL))

Shift the offset with respect to the selected ADC resolution.

Note:
Offset has to be left-aligned on bit 11, the LSB (right bits) are set to 0. If resolution 12 bits, no shift. If resolution 10 bits, shift of 2 ranks on the left. If resolution 8 bits, shift of 4 ranks on the left. If resolution 6 bits, shift of 6 ranks on the left. Therefore, shift = (12 - resolution) = 12 - (12- (((RES[1:0]) >> 3)*2)).
Parameters:
__HANDLE__ADC handle
__OFFSET__Value to be shifted
Return values:
None

Definition at line 598 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_ConfigChannel(), and HAL_ADCEx_InjectedConfigChannel().

#define ADC_OFR_CHANNEL (   __CHANNEL__)    ((__CHANNEL__) << ADC_OFR1_OFFSET1_CH_Pos)

Configure the channel number into offset OFRx register.

Parameters:
__CHANNEL__ADC Channel.
Return values:
None

Definition at line 546 of file stm32l4xx_hal_adc_ex.h.

#define ADC_TEMPERATURE_SENSOR_INSTANCE (   __HANDLE__)    (((__HANDLE__)->Instance) == ADC1)

Verify the ADC instance connected to the temperature sensor.

Parameters:
__HANDLE__ADC handle.
Return values:
SET(ADC instance is valid) or RESET (ADC instance is invalid)

Definition at line 679 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_ConfigChannel(), and HAL_ADCEx_InjectedConfigChannel().

#define ADC_TRX_HIGHTHRESHOLD (   __THRESHOLD__)    ((__THRESHOLD__) << 16UL)

Configure the analog watchdog high threshold into registers TR1, TR2 or TR3.

Parameters:
__THRESHOLD__Threshold value.
Return values:
None

Definition at line 575 of file stm32l4xx_hal_adc_ex.h.

#define ADC_VREFINT_INSTANCE (   __HANDLE__)    (((__HANDLE__)->Instance) == ADC1)

Verify the ADC instance connected to the internal voltage reference VREFINT.

Parameters:
__HANDLE__ADC handle.
Return values:
SET(ADC instance is valid) or RESET (ADC instance is invalid)

Definition at line 706 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_ConfigChannel(), and HAL_ADCEx_InjectedConfigChannel().

#define IS_ADC_ANALOG_WATCHDOG_MODE (   __WATCHDOG_MODE__)
Value:
(((__WATCHDOG_MODE__) == ADC_ANALOGWATCHDOG_NONE)             || \
                                                        ((__WATCHDOG_MODE__) == ADC_ANALOGWATCHDOG_SINGLE_REG)       || \
                                                        ((__WATCHDOG_MODE__) == ADC_ANALOGWATCHDOG_SINGLE_INJEC)     || \
                                                        ((__WATCHDOG_MODE__) == ADC_ANALOGWATCHDOG_SINGLE_REGINJEC)  || \
                                                        ((__WATCHDOG_MODE__) == ADC_ANALOGWATCHDOG_ALL_REG)          || \
                                                        ((__WATCHDOG_MODE__) == ADC_ANALOGWATCHDOG_ALL_INJEC)        || \
                                                        ((__WATCHDOG_MODE__) == ADC_ANALOGWATCHDOG_ALL_REGINJEC)       )

Verify the ADC analog watchdog mode setting.

Parameters:
__WATCHDOG_MODE__programmed ADC analog watchdog mode setting.
Return values:
SET(__WATCHDOG_MODE__ is valid) or RESET (__WATCHDOG_MODE__ is invalid)

Definition at line 1074 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_AnalogWDGConfig().

#define IS_ADC_ANALOG_WATCHDOG_NUMBER (   __WATCHDOG__)
Value:
(((__WATCHDOG__) == ADC_ANALOGWATCHDOG_1) || \
                                                     ((__WATCHDOG__) == ADC_ANALOGWATCHDOG_2) || \
                                                     ((__WATCHDOG__) == ADC_ANALOGWATCHDOG_3)   )

Verify the ADC analog watchdog setting.

Parameters:
__WATCHDOG__programmed ADC analog watchdog setting.
Return values:
SET(__WATCHDOG__ is valid) or RESET (__WATCHDOG__ is invalid)

Definition at line 1065 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_AnalogWDGConfig().

#define IS_ADC_CALFACT (   __CALIBRATION_FACTOR__)    ((__CALIBRATION_FACTOR__) <= (0x7FU))

Calibration factor size verification (7 bits maximum).

Parameters:
__CALIBRATION_FACTOR__Calibration factor value.
Return values:
SET(__CALIBRATION_FACTOR__ is within the authorized size) or RESET (__CALIBRATION_FACTOR__ is too large)

Definition at line 720 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADCEx_Calibration_SetValue().

#define IS_ADC_CHANNEL (   __HANDLE__,
  __CHANNEL__ 
)
Value:
((((__HANDLE__)->Instance) == ADC1)  && \
                                                 (((__CHANNEL__) == ADC_CHANNEL_1)           || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_2)           || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_3)           || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_4)           || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_5)           || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_6)           || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_7)           || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_8)           || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_9)           || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_10)          || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_11)          || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_12)          || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_13)          || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_14)          || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_15)          || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_16)          || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_17)          || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_18)          || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_VREFINT)     || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_TEMPSENSOR)  || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_VBAT)        || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_DAC1CH1)     || \
                                                  ((__CHANNEL__) == ADC_CHANNEL_DAC1CH2)))

Verify the ADC channel setting.

Parameters:
__HANDLE__ADC handle.
__CHANNEL__programmed ADC channel.
Return values:
SET(__CHANNEL__ is valid) or RESET (__CHANNEL__ is invalid)

Definition at line 730 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_AnalogWDGConfig(), HAL_ADC_ConfigChannel(), and HAL_ADCEx_InjectedConfigChannel().

#define IS_ADC_CONVERSION_GROUP (   __CONVERSION__)
Value:
(((__CONVERSION__) == ADC_REGULAR_GROUP)         || \
                                                 ((__CONVERSION__) == ADC_INJECTED_GROUP)        || \
                                                 ((__CONVERSION__) == ADC_REGULAR_INJECTED_GROUP)  )

Verify the ADC conversion (regular or injected or both).

Parameters:
__CONVERSION__ADC conversion group.
Return values:
SET(__CONVERSION__ is valid) or RESET (__CONVERSION__ is invalid)

Definition at line 1087 of file stm32l4xx_hal_adc_ex.h.

Referenced by ADC_ConversionStop().

#define IS_ADC_DFSDMCFG_MODE (   __HANDLE__)    (SET)

Verify the DFSDM mode configuration.

Parameters:
__HANDLE__ADC handle.
Note:
When DMSDFM configuration is not supported, the macro systematically reports SET. For this reason, the input parameter is the ADC handle and not the configuration parameter directly.
Return values:
SET(DFSDM mode configuration is valid) or RESET (DFSDM mode configuration is invalid)

Definition at line 1160 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init().

#define IS_ADC_DIFF_CHANNEL (   __HANDLE__,
  __CHANNEL__ 
)
Value:
(((__CHANNEL__) == ADC_CHANNEL_1)      || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_2)      || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_3)      || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_4)      || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_5)      || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_6)      || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_7)      || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_8)      || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_9)      || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_10)     || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_11)     || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_12)     || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_13)     || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_14)     || \
                                                      ((__CHANNEL__) == ADC_CHANNEL_15)       )

Verify the ADC channel setting in differential mode.

Parameters:
__HANDLE__ADC handle.
__CHANNEL__programmed ADC channel.
Return values:
SET(__CHANNEL__ is valid) or RESET (__CHANNEL__ is invalid)

Definition at line 904 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_ConfigChannel(), and HAL_ADCEx_InjectedConfigChannel().

#define IS_ADC_EVENT_TYPE (   __EVENT__)
Value:
(((__EVENT__) == ADC_EOSMP_EVENT)  || \
                                      ((__EVENT__) == ADC_AWD_EVENT)    || \
                                      ((__EVENT__) == ADC_AWD2_EVENT)   || \
                                      ((__EVENT__) == ADC_AWD3_EVENT)   || \
                                      ((__EVENT__) == ADC_OVR_EVENT)    || \
                                      ((__EVENT__) == ADC_JQOVF_EVENT)  )

Verify the ADC event type.

Parameters:
__EVENT__ADC event.
Return values:
SET(__EVENT__ is valid) or RESET (__EVENT__ is invalid)

Definition at line 1096 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_PollForEvent().

#define IS_ADC_EXTTRIGINJEC (   __HANDLE__,
  __INJTRIG__ 
)
Value:
(((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T1_TRGO)     || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T1_CC4)      || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T2_TRGO)     || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T2_CC1)      || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T3_CC4)      || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T4_TRGO)     || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_EXT_IT15)    || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T8_CC4)      || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T1_TRGO2)    || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T8_TRGO)     || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T8_TRGO2)    || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T3_CC3)      || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T3_TRGO)     || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T3_CC1)      || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T6_TRGO)     || \
                                                      ((__INJTRIG__) == ADC_EXTERNALTRIGINJEC_T15_TRGO)    || \
                                                      ((__INJTRIG__) == ADC_INJECTED_SOFTWARE_START)       )

Verify the ADC injected conversions external trigger.

Parameters:
__HANDLE__ADC handle.
__INJTRIG__programmed ADC injected conversions external trigger.
Return values:
SET(__INJTRIG__ is a valid value) or RESET (__INJTRIG__ is invalid)

Definition at line 989 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADCEx_InjectedConfigChannel().

#define IS_ADC_EXTTRIGINJEC_EDGE (   __EDGE__)
Value:
(((__EDGE__) == ADC_EXTERNALTRIGINJECCONV_EDGE_NONE)         || \
                                            ((__EDGE__) == ADC_EXTERNALTRIGINJECCONV_EDGE_RISING)       || \
                                            ((__EDGE__) == ADC_EXTERNALTRIGINJECCONV_EDGE_FALLING)      || \
                                            ((__EDGE__) == ADC_EXTERNALTRIGINJECCONV_EDGE_RISINGFALLING) )

Verify the ADC edge trigger setting for injected group.

Parameters:
__EDGE__programmed ADC edge trigger setting.
Return values:
SET(__EDGE__ is a valid value) or RESET (__EDGE__ is invalid)

Definition at line 1012 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADCEx_InjectedConfigChannel().

#define IS_ADC_INJECTED_NB_CONV (   __LENGTH__)    (((__LENGTH__) >= (1U)) && ((__LENGTH__) <= (4U)))

Verify the length of scheduled injected conversions group.

Parameters:
__LENGTH__number of programmed conversions.
Return values:
SET(__LENGTH__ is within the maximum number of possible programmable injected conversions) or RESET (__LENGTH__ is null or too large)

Definition at line 713 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADCEx_InjectedConfigChannel().

#define IS_ADC_INJECTED_RANK (   __CHANNEL__)
Value:
(((__CHANNEL__) == ADC_INJECTED_RANK_1) || \
                                           ((__CHANNEL__) == ADC_INJECTED_RANK_2) || \
                                           ((__CHANNEL__) == ADC_INJECTED_RANK_3) || \
                                           ((__CHANNEL__) == ADC_INJECTED_RANK_4)   )

Verify the ADC injected channel setting.

Parameters:
__CHANNEL__programmed ADC injected channel.
Return values:
SET(__CHANNEL__ is valid) or RESET (__CHANNEL__ is invalid)

Definition at line 978 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADCEx_InjectedConfigChannel(), and HAL_ADCEx_InjectedGetValue().

#define IS_ADC_OFFSET_NUMBER (   __OFFSET_NUMBER__)
Value:
(((__OFFSET_NUMBER__) == ADC_OFFSET_NONE) || \
                                                 ((__OFFSET_NUMBER__) == ADC_OFFSET_1)    || \
                                                 ((__OFFSET_NUMBER__) == ADC_OFFSET_2)    || \
                                                 ((__OFFSET_NUMBER__) == ADC_OFFSET_3)    || \
                                                 ((__OFFSET_NUMBER__) == ADC_OFFSET_4)      )

Verify the ADC offset management setting.

Parameters:
__OFFSET_NUMBER__ADC offset management.
Return values:
SET(__OFFSET_NUMBER__ is valid) or RESET (__OFFSET_NUMBER__ is invalid)

Definition at line 967 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_ConfigChannel(), and HAL_ADCEx_InjectedConfigChannel().

#define IS_ADC_OVERSAMPLING_RATIO (   __RATIO__)
Value:
(((__RATIO__) == ADC_OVERSAMPLING_RATIO_2   ) || \
                                                   ((__RATIO__) == ADC_OVERSAMPLING_RATIO_4   ) || \
                                                   ((__RATIO__) == ADC_OVERSAMPLING_RATIO_8   ) || \
                                                   ((__RATIO__) == ADC_OVERSAMPLING_RATIO_16  ) || \
                                                   ((__RATIO__) == ADC_OVERSAMPLING_RATIO_32  ) || \
                                                   ((__RATIO__) == ADC_OVERSAMPLING_RATIO_64  ) || \
                                                   ((__RATIO__) == ADC_OVERSAMPLING_RATIO_128 ) || \
                                                   ((__RATIO__) == ADC_OVERSAMPLING_RATIO_256 ))

Verify the ADC oversampling ratio.

Parameters:
__RATIO__programmed ADC oversampling ratio.
Return values:
SET(__RATIO__ is a valid value) or RESET (__RATIO__ is invalid)

Definition at line 1108 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init(), and HAL_ADCEx_InjectedConfigChannel().

#define IS_ADC_REGOVERSAMPLING_MODE (   __MODE__)
Value:
(((__MODE__) == ADC_REGOVERSAMPLING_CONTINUED_MODE) || \
                                               ((__MODE__) == ADC_REGOVERSAMPLING_RESUMED_MODE) )

Verify the ADC oversampling regular conversion resumed or continued mode.

Parameters:
__MODE__programmed ADC oversampling regular conversion resumed or continued mode.
Return values:
SET(__MODE__ is valid) or RESET (__MODE__ is invalid)

Definition at line 1145 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init().

#define IS_ADC_RIGHT_BIT_SHIFT (   __SHIFT__)
Value:
(((__SHIFT__) == ADC_RIGHTBITSHIFT_NONE) || \
                                                  ((__SHIFT__) == ADC_RIGHTBITSHIFT_1   ) || \
                                                  ((__SHIFT__) == ADC_RIGHTBITSHIFT_2   ) || \
                                                  ((__SHIFT__) == ADC_RIGHTBITSHIFT_3   ) || \
                                                  ((__SHIFT__) == ADC_RIGHTBITSHIFT_4   ) || \
                                                  ((__SHIFT__) == ADC_RIGHTBITSHIFT_5   ) || \
                                                  ((__SHIFT__) == ADC_RIGHTBITSHIFT_6   ) || \
                                                  ((__SHIFT__) == ADC_RIGHTBITSHIFT_7   ) || \
                                                  ((__SHIFT__) == ADC_RIGHTBITSHIFT_8   ))

Verify the ADC oversampling shift.

Parameters:
__SHIFT__programmed ADC oversampling shift.
Return values:
SET(__SHIFT__ is a valid value) or RESET (__SHIFT__ is invalid)

Definition at line 1122 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init(), and HAL_ADCEx_InjectedConfigChannel().

#define IS_ADC_SINGLE_DIFFERENTIAL (   __SING_DIFF__)
Value:
(((__SING_DIFF__) == ADC_SINGLE_ENDED)      || \
                                                   ((__SING_DIFF__) == ADC_DIFFERENTIAL_ENDED)  )

Verify the ADC single-ended input or differential mode setting.

Parameters:
__SING_DIFF__programmed channel setting.
Return values:
SET(__SING_DIFF__ is valid) or RESET (__SING_DIFF__ is invalid)

Definition at line 959 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_ConfigChannel(), HAL_ADCEx_Calibration_GetValue(), HAL_ADCEx_Calibration_SetValue(), HAL_ADCEx_Calibration_Start(), and HAL_ADCEx_InjectedConfigChannel().

#define IS_ADC_TRIGGERED_OVERSAMPLING_MODE (   __MODE__)
Value:
(((__MODE__) == ADC_TRIGGEREDMODE_SINGLE_TRIGGER) || \
                                                      ((__MODE__) == ADC_TRIGGEREDMODE_MULTI_TRIGGER) )

Verify the ADC oversampling triggered mode.

Parameters:
__MODE__programmed ADC oversampling triggered mode.
Return values:
SET(__MODE__ is valid) or RESET (__MODE__ is invalid)

Definition at line 1137 of file stm32l4xx_hal_adc_ex.h.

Referenced by HAL_ADC_Init().

Generated on Fri Nov 26 2021 00:45:54 for STM32L443xx HAL User Manual by   doxygen 1.7.6.1