HAL ADC macro to manage HAL ADC handle, IT and flags.

Collaboration diagram for HAL ADC macro to manage HAL ADC handle, IT and flags.:

Macros
#define	__HAL_ADC_RESET_HANDLE_STATE(__HANDLE__)
	Reset ADC handle state.
#define	__HAL_ADC_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable ADC interrupt.
#define	__HAL_ADC_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable ADC interrupt.
#define	__HAL_ADC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Checks if the specified ADC interrupt source is enabled or disabled.
#define	__HAL_ADC_GET_FLAG(__HANDLE__, __FLAG__)
	Check whether the specified ADC flag is set or not.
#define	__HAL_ADC_CLEAR_FLAG(__HANDLE__, __FLAG__)
	Clear the specified ADC flag.

Detailed Description

Macro Definition Documentation

__HAL_ADC_CLEAR_FLAG

#define __HAL_ADC_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__ )

Value:

  (((__HANDLE__)->Instance->ISR) = (__FLAG__))

Clear the specified ADC flag.

Parameters

__HANDLE__

ADC handle

__FLAG__

ADC flag This parameter can be one of the following values: ADC_FLAG_RDY ADC Ready flag ADC_FLAG_EOSMP ADC End of Sampling flag ADC_FLAG_EOC ADC End of Regular Conversion flag ADC_FLAG_EOS ADC End of Regular sequence of Conversions flag ADC_FLAG_OVR ADC overrun flag ADC_FLAG_JEOC ADC End of Injected Conversion flag ADC_FLAG_JEOS ADC End of Injected sequence of Conversions flag ADC_FLAG_AWD1 ADC Analog watchdog 1 flag (main analog watchdog) ADC_FLAG_AWD2 ADC Analog watchdog 2 flag (additional analog watchdog) ADC_FLAG_AWD3 ADC Analog watchdog 3 flag (additional analog watchdog) ADC_FLAG_JQOVF ADC Injected Context Queue Overflow flag.

Return values

None

Definition at line 1401 of file stm32h7xx_hal_adc.h.

__HAL_ADC_DISABLE_IT

#define __HAL_ADC_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

Value:

  (((__HANDLE__)->Instance->IER) &= ~(__INTERRUPT__))

Disable ADC interrupt.

Parameters

__HANDLE__

ADC handle

__INTERRUPT__

ADC Interrupt This parameter can be one of the following values: ADC_IT_RDY ADC Ready interrupt source ADC_IT_EOSMP ADC End of Sampling interrupt source ADC_IT_EOC ADC End of Regular Conversion interrupt source ADC_IT_EOS ADC End of Regular sequence of Conversions interrupt source ADC_IT_OVR ADC overrun interrupt source ADC_IT_JEOC ADC End of Injected Conversion interrupt source ADC_IT_JEOS ADC End of Injected sequence of Conversions interrupt source ADC_IT_AWD1 ADC Analog watchdog 1 interrupt source (main analog watchdog) ADC_IT_AWD2 ADC Analog watchdog 2 interrupt source (additional analog watchdog) ADC_IT_AWD3 ADC Analog watchdog 3 interrupt source (additional analog watchdog) ADC_IT_JQOVF ADC Injected Context Queue Overflow interrupt source.

Return values

None

Definition at line 1337 of file stm32h7xx_hal_adc.h.

__HAL_ADC_ENABLE_IT

#define __HAL_ADC_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

Value:

  (((__HANDLE__)->Instance->IER) |= (__INTERRUPT__))

Enable ADC interrupt.

Parameters

__HANDLE__

ADC handle

__INTERRUPT__

ADC Interrupt This parameter can be one of the following values: ADC_IT_RDY ADC Ready interrupt source ADC_IT_EOSMP ADC End of Sampling interrupt source ADC_IT_EOC ADC End of Regular Conversion interrupt source ADC_IT_EOS ADC End of Regular sequence of Conversions interrupt source ADC_IT_OVR ADC overrun interrupt source ADC_IT_JEOC ADC End of Injected Conversion interrupt source ADC_IT_JEOS ADC End of Injected sequence of Conversions interrupt source ADC_IT_AWD1 ADC Analog watchdog 1 interrupt source (main analog watchdog) ADC_IT_AWD2 ADC Analog watchdog 2 interrupt source (additional analog watchdog) ADC_IT_AWD3 ADC Analog watchdog 3 interrupt source (additional analog watchdog) ADC_IT_JQOVF ADC Injected Context Queue Overflow interrupt source.

Return values

None

Definition at line 1316 of file stm32h7xx_hal_adc.h.

__HAL_ADC_GET_FLAG

#define __HAL_ADC_GET_FLAG	(		__HANDLE__,
			__FLAG__ )

Value:

  ((((__HANDLE__)->Instance->ISR) & (__FLAG__)) == (__FLAG__))

Check whether the specified ADC flag is set or not.

Parameters

__HANDLE__

ADC handle

__FLAG__

ADC flag This parameter can be one of the following values: ADC_FLAG_RDY ADC Ready flag ADC_FLAG_EOSMP ADC End of Sampling flag ADC_FLAG_EOC ADC End of Regular Conversion flag ADC_FLAG_EOS ADC End of Regular sequence of Conversions flag ADC_FLAG_OVR ADC overrun flag ADC_FLAG_JEOC ADC End of Injected Conversion flag ADC_FLAG_JEOS ADC End of Injected sequence of Conversions flag ADC_FLAG_AWD1 ADC Analog watchdog 1 flag (main analog watchdog) ADC_FLAG_AWD2 ADC Analog watchdog 2 flag (additional analog watchdog) ADC_FLAG_AWD3 ADC Analog watchdog 3 flag (additional analog watchdog) ADC_FLAG_JQOVF ADC Injected Context Queue Overflow flag ADC_FLAG_LDORDY ADC LDO output voltage ready bit.

Return values

State

of flag (TRUE or FALSE).

Definition at line 1379 of file stm32h7xx_hal_adc.h.

__HAL_ADC_GET_IT_SOURCE

#define __HAL_ADC_GET_IT_SOURCE	(		__HANDLE__,
			__INTERRUPT__ )

Value:

  (((__HANDLE__)->Instance->IER & (__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 one of the following values: ADC_IT_RDY ADC Ready interrupt source ADC_IT_EOSMP ADC End of Sampling interrupt source ADC_IT_EOC ADC End of Regular Conversion interrupt source ADC_IT_EOS ADC End of Regular sequence of Conversions interrupt source ADC_IT_OVR ADC overrun interrupt source ADC_IT_JEOC ADC End of Injected Conversion interrupt source ADC_IT_JEOS ADC End of Injected sequence of Conversions interrupt source ADC_IT_AWD1 ADC Analog watchdog 1 interrupt source (main analog watchdog) ADC_IT_AWD2 ADC Analog watchdog 2 interrupt source (additional analog watchdog) ADC_IT_AWD3 ADC Analog watchdog 3 interrupt source (additional analog watchdog) ADC_IT_JQOVF ADC Injected Context Queue Overflow interrupt source.

Return values

State

of interruption (SET or RESET)

Definition at line 1357 of file stm32h7xx_hal_adc.h.

__HAL_ADC_RESET_HANDLE_STATE

#define __HAL_ADC_RESET_HANDLE_STATE

(

__HANDLE__

)

Value:

  ((__HANDLE__)->State = HAL_ADC_STATE_RESET)

Reset ADC handle state.

Parameters

__HANDLE__

ADC handle

Return values

None

Definition at line 1294 of file stm32h7xx_hal_adc.h.