ADC Exported Macros

Collaboration diagram for ADC Exported Macros:

Macros
#define	__HAL_ADC_RESET_HANDLE_STATE(__HANDLE__)
	Reset ADC handle state.
#define	__HAL_ADC_ENABLE(__HANDLE__)
	Enable the ADC peripheral.
#define	__HAL_ADC_DISABLE(__HANDLE__)
	Disable the ADC peripheral.
#define	__HAL_ADC_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the ADC end of conversion interrupt.
#define	__HAL_ADC_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable the ADC end of conversion interrupt.
#define	__HAL_ADC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check if the specified ADC interrupt source is enabled or disabled.
#define	__HAL_ADC_CLEAR_FLAG(__HANDLE__, __FLAG__)
	Clear the ADC's pending flags.
#define	__HAL_ADC_GET_FLAG(__HANDLE__, __FLAG__)
	Get the selected ADC's flag status.

Detailed Description

Macro Definition Documentation

__HAL_ADC_RESET_HANDLE_STATE

#define __HAL_ADC_RESET_HANDLE_STATE

(

__HANDLE__

)

#include <stm32f4xx_hal_adc.h>

Value:

  ((__HANDLE__)->State = HAL_ADC_STATE_RESET)

Reset ADC handle state.

Parameters

__HANDLE__

ADC handle

Return values

None

Definition at line 492 of file stm32f4xx_hal_adc.h.

__HAL_ADC_ENABLE

#define __HAL_ADC_ENABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_adc.h>

Value:

((__HANDLE__)->Instance->CR2 |=  ADC_CR2_ADON)

Enable the ADC peripheral.

Parameters

__HANDLE__

ADC handle

Return values

None

Definition at line 501 of file stm32f4xx_hal_adc.h.

Referenced by HAL_ADC_Start(), HAL_ADC_Start_DMA(), HAL_ADC_Start_IT(), HAL_ADCEx_InjectedStart(), HAL_ADCEx_InjectedStart_IT(), and HAL_ADCEx_MultiModeStart_DMA().

__HAL_ADC_DISABLE

#define __HAL_ADC_DISABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_adc.h>

Value:

((__HANDLE__)->Instance->CR2 &=  ~ADC_CR2_ADON)

Disable the ADC peripheral.

Parameters

__HANDLE__

ADC handle

Return values

None

Definition at line 508 of file stm32f4xx_hal_adc.h.

Referenced by HAL_ADC_DeInit(), HAL_ADC_Stop(), HAL_ADC_Stop_DMA(), HAL_ADC_Stop_IT(), HAL_ADCEx_InjectedStop(), HAL_ADCEx_InjectedStop_IT(), and HAL_ADCEx_MultiModeStop_DMA().

__HAL_ADC_ENABLE_IT

#define __HAL_ADC_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_adc.h>

Value:

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

Enable the ADC end of conversion interrupt.

Parameters

__HANDLE__	specifies the ADC Handle.
__INTERRUPT__	ADC Interrupt.

Return values

None

Definition at line 516 of file stm32f4xx_hal_adc.h.

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

__HAL_ADC_DISABLE_IT

#define __HAL_ADC_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_adc.h>

Value:

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

Disable the ADC end of conversion interrupt.

Parameters

__HANDLE__	specifies the ADC Handle.
__INTERRUPT__	ADC interrupt.

Return values

None

Definition at line 524 of file stm32f4xx_hal_adc.h.

Referenced by ADC_DMAConvCplt(), ADC_MultiModeDMAConvCplt(), HAL_ADC_AnalogWDGConfig(), HAL_ADC_IRQHandler(), HAL_ADC_Stop_DMA(), HAL_ADC_Stop_IT(), HAL_ADCEx_InjectedStop_IT(), and HAL_ADCEx_MultiModeStop_DMA().

__HAL_ADC_GET_IT_SOURCE

#define __HAL_ADC_GET_IT_SOURCE	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_adc.h>

Value:

(((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__))

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

Parameters

__HANDLE__	specifies the ADC Handle.
__INTERRUPT__	specifies the ADC interrupt source to check.

Return values

The	new state of IT (TRUE or FALSE).

Definition at line 531 of file stm32f4xx_hal_adc.h.

__HAL_ADC_CLEAR_FLAG

#define __HAL_ADC_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_adc.h>

Value:

(((__HANDLE__)->Instance->SR) = ~(__FLAG__))

Clear the ADC's pending flags.

Parameters

__HANDLE__	specifies the ADC Handle.
__FLAG__	ADC flag.

Return values

None

Definition at line 539 of file stm32f4xx_hal_adc.h.

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

__HAL_ADC_GET_FLAG

#define __HAL_ADC_GET_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_adc.h>

Value:

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

Get the selected ADC's flag status.

Parameters

__HANDLE__	specifies the ADC Handle.
__FLAG__	ADC flag.

Return values

None

Definition at line 547 of file stm32f4xx_hal_adc.h.

Referenced by HAL_ADC_IRQHandler(), HAL_ADC_PollForConversion(), HAL_ADC_PollForEvent(), and HAL_ADCEx_InjectedPollForConversion().