STM32F103xB HAL User Manual
Defines
ADC Exported Macros
ADC

Defines

#define __HAL_ADC_ENABLE(__HANDLE__)   (SET_BIT((__HANDLE__)->Instance->CR2, (ADC_CR2_ADON)))
 Enable the ADC peripheral.
#define __HAL_ADC_DISABLE(__HANDLE__)   (CLEAR_BIT((__HANDLE__)->Instance->CR2, (ADC_CR2_ADON)))
 Disable the ADC peripheral.
#define __HAL_ADC_ENABLE_IT(__HANDLE__, __INTERRUPT__)   (SET_BIT((__HANDLE__)->Instance->CR1, (__INTERRUPT__)))
 Enable the ADC end of conversion interrupt.
#define __HAL_ADC_DISABLE_IT(__HANDLE__, __INTERRUPT__)   (CLEAR_BIT((__HANDLE__)->Instance->CR1, (__INTERRUPT__)))
 Disable the ADC end of conversion interrupt.
#define __HAL_ADC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__))
 Checks if the specified ADC interrupt source is enabled or disabled.
#define __HAL_ADC_GET_FLAG(__HANDLE__, __FLAG__)   ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
 Get the selected ADC's flag status.
#define __HAL_ADC_CLEAR_FLAG(__HANDLE__, __FLAG__)   (WRITE_REG((__HANDLE__)->Instance->SR, ~(__FLAG__)))
 Clear the ADC's pending flags.
#define __HAL_ADC_RESET_HANDLE_STATE(__HANDLE__)
 Reset ADC handle state.

Define Documentation

#define __HAL_ADC_CLEAR_FLAG (   __HANDLE__,
  __FLAG__ 
)    (WRITE_REG((__HANDLE__)->Instance->SR, ~(__FLAG__)))

Clear the ADC's pending flags.

Parameters:
__HANDLE__,:ADC handle
__FLAG__,:ADC flag This parameter can be any combination of the following values:
  • ADC_FLAG_STRT: ADC Regular group start flag
  • ADC_FLAG_JSTRT: ADC Injected group start flag
  • ADC_FLAG_EOC: ADC End of Regular conversion flag
  • ADC_FLAG_JEOC: ADC End of Injected conversion flag
  • ADC_FLAG_AWD: ADC Analog watchdog flag
Return values:
None

Definition at line 584 of file stm32f1xx_hal_adc.h.

Referenced by HAL_ADC_DeInit(), HAL_ADC_IRQHandler(), HAL_ADC_PollForConversion(), HAL_ADC_PollForEvent(), HAL_ADC_Start(), HAL_ADC_Start_DMA(), HAL_ADC_Start_IT(), HAL_ADCEx_InjectedPollForConversion(), HAL_ADCEx_InjectedStart(), HAL_ADCEx_InjectedStart_IT(), and HAL_ADCEx_MultiModeStart_DMA().

#define __HAL_ADC_DISABLE (   __HANDLE__)    (CLEAR_BIT((__HANDLE__)->Instance->CR2, (ADC_CR2_ADON)))

Disable the ADC peripheral.

Parameters:
__HANDLE__,:ADC handle
Return values:
None

Definition at line 520 of file stm32f1xx_hal_adc.h.

Referenced by ADC_ConversionStop_Disable().

#define __HAL_ADC_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    (CLEAR_BIT((__HANDLE__)->Instance->CR1, (__INTERRUPT__)))

Disable the ADC end of conversion interrupt.

Parameters:
__HANDLE__,:ADC handle
__INTERRUPT__,:ADC Interrupt This parameter can be any combination of the following values:
  • ADC_IT_EOC: ADC End of Regular Conversion interrupt source
  • ADC_IT_JEOC: ADC End of Injected Conversion interrupt source
  • ADC_IT_AWD: ADC Analog watchdog interrupt source
Return values:
None

Definition at line 544 of file stm32f1xx_hal_adc.h.

Referenced by HAL_ADC_AnalogWDGConfig(), HAL_ADC_IRQHandler(), HAL_ADC_Stop_IT(), and HAL_ADCEx_InjectedStop_IT().

#define __HAL_ADC_ENABLE (   __HANDLE__)    (SET_BIT((__HANDLE__)->Instance->CR2, (ADC_CR2_ADON)))

Enable the ADC peripheral.

Note:
ADC enable requires a delay for ADC stabilization time (refer to device datasheet, parameter tSTAB)
On STM32F1, if ADC is already enabled this macro trigs a conversion SW start on regular group.
Parameters:
__HANDLE__,:ADC handle
Return values:
None

Definition at line 512 of file stm32f1xx_hal_adc.h.

Referenced by ADC_Enable().

#define __HAL_ADC_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    (SET_BIT((__HANDLE__)->Instance->CR1, (__INTERRUPT__)))

Enable the ADC end of conversion interrupt.

Parameters:
__HANDLE__,:ADC handle
__INTERRUPT__,:ADC Interrupt This parameter can be any combination of the following values:
  • ADC_IT_EOC: ADC End of Regular Conversion interrupt source
  • ADC_IT_JEOC: ADC End of Injected Conversion interrupt source
  • ADC_IT_AWD: ADC Analog watchdog interrupt source
Return values:
None

Definition at line 532 of file stm32f1xx_hal_adc.h.

Referenced by HAL_ADC_AnalogWDGConfig(), HAL_ADC_Start_IT(), and HAL_ADCEx_InjectedStart_IT().

#define __HAL_ADC_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)    ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))

Get the selected ADC's flag status.

Parameters:
__HANDLE__,:ADC handle
__FLAG__,:ADC flag This parameter can be any combination of the following values:
  • ADC_FLAG_STRT: ADC Regular group start flag
  • ADC_FLAG_JSTRT: ADC Injected group start flag
  • ADC_FLAG_EOC: ADC End of Regular conversion flag
  • ADC_FLAG_JEOC: ADC End of Injected conversion flag
  • ADC_FLAG_AWD: ADC Analog watchdog flag
Return values:
None

Definition at line 570 of file stm32f1xx_hal_adc.h.

Referenced by HAL_ADC_IRQHandler(), and HAL_ADC_PollForEvent().

#define __HAL_ADC_GET_IT_SOURCE (   __HANDLE__,
  __INTERRUPT__ 
)    (((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__))

Checks if the specified ADC interrupt source is enabled or disabled.

Parameters:
__HANDLE__,:ADC handle
__INTERRUPT__,:ADC interrupt source to check This parameter can be any combination of the following values:
  • ADC_IT_EOC: ADC End of Regular Conversion interrupt source
  • ADC_IT_JEOC: ADC End of Injected Conversion interrupt source
  • ADC_IT_AWD: ADC Analog watchdog interrupt source
Return values:
None

Definition at line 556 of file stm32f1xx_hal_adc.h.

Referenced by HAL_ADC_IRQHandler().

#define __HAL_ADC_RESET_HANDLE_STATE (   __HANDLE__)
Value:
do{                                                                          \
     (__HANDLE__)->State = HAL_ADC_STATE_RESET;                                \
     (__HANDLE__)->MspInitCallback = NULL;                                     \
     (__HANDLE__)->MspDeInitCallback = NULL;                                   \
    } while(0)

Reset ADC handle state.

Parameters:
__HANDLE__,:ADC handle
Return values:
None

Definition at line 592 of file stm32f1xx_hal_adc.h.