ADC Exported Macros

Macros
#define	__HAL_ADC_GET_FLAG(__HANDLE__, __FLAG__)   ((((__HANDLE__)->Instance->GPADC_IRQ) & (__FLAG__)) == (__FLAG__))
	Get the selected ADC's flag status. More...
#define	__HAL_ADC_CLEAR_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->GPADC_IRQ) |= (__FLAG__))
	Clear the ADC's pending flags. More...
#define	__HAL_ADC_ENABLE_IRQ(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->GPADC_IRQ |= (__FLAG__))
	Enable ADC irq. More...
#define	__HAL_ADC_DISABLE_IRQ(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->GPADC_IRQ &= ~(__FLAG__))
	Disable ADC irq. More...
#define	__HAL_ADC_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_ADC_STATE_RESET)
	Reset ADC handle state. More...
#define	__HAL_ADC_SET_SAMPLE_WIDTH(__HANDLE__, width)
	Set ADC Sample width. More...
#define	__HAL_ADC_SET_CONV_WIDTH(__HANDLE__, width)
	Set ADC Conversion width. More...
#define	__HAL_ADC_SET_DATA_DELAY(__HANDLE__, delay)
	Set ADC Data sample delay. More...
#define	__HAL_ADC_START_CONV(__HANDLE__)   ((__HANDLE__)->Instance->ADC_CTRL_REG |= GPADC_ADC_CTRL_REG_ADC_START)
	Start ADC convert. More...
#define	__HAL_ADC_STOP_CONV(__HANDLE__)   ((__HANDLE__)->Instance->ADC_CTRL_REG |= GPADC_ADC_CTRL_REG_ADC_STOP)
	Stop ADC convert, only work for infinite mode. More...

Detailed Description

Macro Definition Documentation

__HAL_ADC_CLEAR_FLAG

#define __HAL_ADC_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__
	)		(((__HANDLE__)->Instance->GPADC_IRQ) |= (__FLAG__))

Clear the ADC's pending flags.

Parameters

__HANDLE__	ADC handle
__FLAG__	ADC flag

Return values

None

__HAL_ADC_DISABLE_IRQ

#define __HAL_ADC_DISABLE_IRQ	(		__HANDLE__,
			__FLAG__
	)		((__HANDLE__)->Instance->GPADC_IRQ &= ~(__FLAG__))

Disable ADC irq.

Parameters

__HANDLE__	ADC handle
__FLAG__	ADC irq flag

Return values

None

__HAL_ADC_ENABLE_IRQ

#define __HAL_ADC_ENABLE_IRQ	(		__HANDLE__,
			__FLAG__
	)		((__HANDLE__)->Instance->GPADC_IRQ |= (__FLAG__))

Enable ADC irq.

Parameters

__HANDLE__	ADC handle
__FLAG__	ADC irq flag

Return values

None

__HAL_ADC_GET_FLAG

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

Get the selected ADC's flag status.

Parameters

__HANDLE__	ADC handle
__FLAG__	ADC flag

Return values

None

__HAL_ADC_RESET_HANDLE_STATE

#define __HAL_ADC_RESET_HANDLE_STATE

(

__HANDLE__

)

((__HANDLE__)->State = HAL_ADC_STATE_RESET)

Reset ADC handle state.

Parameters

__HANDLE__

ADC handle

Return values

None

__HAL_ADC_SET_CONV_WIDTH

#define __HAL_ADC_SET_CONV_WIDTH	(		__HANDLE__,
			width
	)

Value:

    do { \
        (__HANDLE__)->Instance->ADC_CTRL_REG2 &= (~GPADC_ADC_CTRL_REG2_CONV_WIDTH_Msk);    \
        (__HANDLE__)->Instance->ADC_CTRL_REG2 |= (((width)-1)<<GPADC_ADC_CTRL_REG2_CONV_WIDTH_Pos);  \
    }while(0)\

Set ADC Conversion width.

Parameters

__HANDLE__	ADC handle
width	Conversion width in unit of PCLK cycles.

Return values

None

__HAL_ADC_SET_DATA_DELAY

#define __HAL_ADC_SET_DATA_DELAY	(		__HANDLE__,
			delay
	)

Value:

    do { \
        (__HANDLE__)->Instance->ADC_CTRL_REG &= (~GPADC_ADC_CTRL_REG_DATA_SAMP_DLY);    \
        (__HANDLE__)->Instance->ADC_CTRL_REG |= ((delay)<<GPADC_ADC_CTRL_REG_DATA_SAMP_DLY_Pos);  \
    }while(0)\

Set ADC Data sample delay.

Parameters

__HANDLE__	ADC handle
delay	Delay for data in unit of PCLK cycles.

Return values

None

__HAL_ADC_SET_SAMPLE_WIDTH

#define __HAL_ADC_SET_SAMPLE_WIDTH	(		__HANDLE__,
			width
	)

Value:

    do { \
        (__HANDLE__)->Instance->ADC_CTRL_REG2 &= (~GPADC_ADC_CTRL_REG2_SAMP_WIDTH_Msk);    \
        (__HANDLE__)->Instance->ADC_CTRL_REG2 |= (((width)-1)<<GPADC_ADC_CTRL_REG2_SAMP_WIDTH_Pos);  \
    }while(0)\

Set ADC Sample width.

Parameters

__HANDLE__	ADC handle
width	Sample width in unit of PCLK cycles.

Return values

None

__HAL_ADC_START_CONV

#define __HAL_ADC_START_CONV

(

__HANDLE__

)

((__HANDLE__)->Instance->ADC_CTRL_REG |= GPADC_ADC_CTRL_REG_ADC_START)

Start ADC convert.

Parameters

__HANDLE__

ADC handle

Return values

None

__HAL_ADC_STOP_CONV

#define __HAL_ADC_STOP_CONV

(

__HANDLE__

)

((__HANDLE__)->Instance->ADC_CTRL_REG |= GPADC_ADC_CTRL_REG_ADC_STOP)

Stop ADC convert, only work for infinite mode.

Parameters

__HANDLE__

ADC handle

Return values

None