SDADC Private Macros

Macros
#define	SDADC_IS_ENABLE(__HANDLE__)
	Verification of SDADC state: enabled or disabled. More...
#define	SDADC_STATE_CLR_SET   MODIFY_REG
	Simultaneously clears and sets specific bits of the handle State. More...
#define	SDADC_CLEAR_ERRORCODE(__HANDLE__)   ((__HANDLE__)->ErrorCode = HAL_SDADC_ERROR_NONE)
	Clear SDADC error code (set it to error code: "no error") More...
#define	SDADC_CHSELR_CHANNEL(_CHANNEL_)   ( 1U << (_CHANNEL_))
	Configure the channel number into channel selection register. More...
#define	SDADC_CFGR_CONTINUOUS(__HANDLE__, _CONTINUOUS_MODE_)   (((__HANDLE__)->Instance->CFG0) |= (_CONTINUOUS_MODE_) << SDADC_CFG0_CONTIN_LV_Pos)
	Enable SDADC continuous conversion mode. More...
#define	SDADC_Enable(__HANDLE__)   (( __HANDLE__)->Instance->CFG0 |= SDADC_CFG0_PU_LV)
	Enable the selected ADC. More...
#define	SDADC_Disable(__HANDLE__)   ((__HANDLE__)->Instance->CFG0 &= ~SDADC_CFG0_PU_LV)
	Disable the selected ADC. More...
#define	SDADC_DMA_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->DMA_CFG |= SDADC_DMA_CFG_RX_DMA_MSK)
	Enable SDADC DMA mode. More...
#define	SDADC_DMA_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->DMA_CFG &= (~SDADC_DMA_CFG_RX_DMA_MSK))
	Disable SDADC DMA mode. More...
#define	IS_SDADC_SRC_TIMER(__HANDLE__)   ((__HANDLE__)->Instance->TRIG & SDADC_TRIG_TIMER_TRIG_EN)
	Check if timer triger enable. More...
#define	SDADC_ENABLE_TIMER_TRIGER(__HANDLE__)   ((__HANDLE__)->Instance->TRIG |= SDADC_TRIG_TIMER_TRIG_EN)
	Enable timer triger. More...
#define	SDADC_DISABLE_TIMER_TRIGER(__HANDLE__)   ((__HANDLE__)->Instance->TRIG &= (~SDADC_TRIG_TIMER_TRIG_EN))
	Enable timer triger. More...
#define	SDADC_ENABLE_GPIO_TRIGER(__HANDLE__)   ((__HANDLE__)->Instance->TRIG |= SDADC_TRIG_GPIO_TRIG_EN)
	Enable GPIO triger. More...
#define	SDADC_DISABLE_GPIO_TRIGER(__HANDLE__)   ((__HANDLE__)->Instance->TRIG &= (~SDADC_TRIG_GPIO_TRIG_EN))
	Enable GPIO triger. More...

Detailed Description

Macro Definition Documentation

IS_SDADC_SRC_TIMER

#define IS_SDADC_SRC_TIMER

(

__HANDLE__

)

((__HANDLE__)->Instance->TRIG & SDADC_TRIG_TIMER_TRIG_EN)

Check if timer triger enable.

Parameters

__HANDLE__

SDADC handle.

Return values

Not	0 if timer triger enable

SDADC_CFGR_CONTINUOUS

#define SDADC_CFGR_CONTINUOUS	(		__HANDLE__,
			_CONTINUOUS_MODE_
	)		(((__HANDLE__)->Instance->CFG0) |= (_CONTINUOUS_MODE_) << SDADC_CFG0_CONTIN_LV_Pos)

Enable SDADC continuous conversion mode.

Parameters

__HANDLE__	SDADC handle.
_CONTINUOUS_MODE_	Continuous mode.

Return values

None

SDADC_CHSELR_CHANNEL

#define SDADC_CHSELR_CHANNEL

(

_CHANNEL_

)

( 1U << (_CHANNEL_))

Configure the channel number into channel selection register.

Parameters

_CHANNEL_

SDADC Channel

Return values

None

SDADC_CLEAR_ERRORCODE

#define SDADC_CLEAR_ERRORCODE

(

__HANDLE__

)

((__HANDLE__)->ErrorCode = HAL_SDADC_ERROR_NONE)

Clear SDADC error code (set it to error code: "no error")

Parameters

__HANDLE__

SDADC handle

Return values

None

SDADC_Disable

#define SDADC_Disable

(

__HANDLE__

)

((__HANDLE__)->Instance->CFG0 &= ~SDADC_CFG0_PU_LV)

Disable the selected ADC.

Note

Prerequisite condition to use this function: ADC conversions must be stopped.

Parameters

__HANDLE__

ADC handle

Return values

None.

SDADC_DISABLE_GPIO_TRIGER

#define SDADC_DISABLE_GPIO_TRIGER

(

__HANDLE__

)

((__HANDLE__)->Instance->TRIG &= (~SDADC_TRIG_GPIO_TRIG_EN))

Enable GPIO triger.

Parameters

__HANDLE__

SDADC handle.

Return values

None

SDADC_DISABLE_TIMER_TRIGER

#define SDADC_DISABLE_TIMER_TRIGER

(

__HANDLE__

)

((__HANDLE__)->Instance->TRIG &= (~SDADC_TRIG_TIMER_TRIG_EN))

Enable timer triger.

Parameters

__HANDLE__

SDADC handle.

Return values

None

SDADC_DMA_DISABLE

#define SDADC_DMA_DISABLE

(

__HANDLE__

)

((__HANDLE__)->Instance->DMA_CFG &= (~SDADC_DMA_CFG_RX_DMA_MSK))

Disable SDADC DMA mode.

Parameters

__HANDLE__

SDADC handle.

Return values

None

SDADC_DMA_ENABLE

#define SDADC_DMA_ENABLE

(

__HANDLE__

)

((__HANDLE__)->Instance->DMA_CFG |= SDADC_DMA_CFG_RX_DMA_MSK)

Enable SDADC DMA mode.

Parameters

__HANDLE__

SDADC handle.

Return values

None

SDADC_Enable

#define SDADC_Enable

(

__HANDLE__

)

(( __HANDLE__)->Instance->CFG0 |= SDADC_CFG0_PU_LV)

Enable the selected ADC.

Note

Prerequisite condition to use this function: ADC must be disabled and voltage regulator must be enabled (done into HAL_ADC_Init()).

If low power mode AutoPowerOff is enabled, power-on/off phases are performed automatically by hardware. In this mode, this function is useless and must not be called because flag ADC_FLAG_RDY is not usable. Therefore, this function must be called under condition of "if (hadc->Init.LowPowerAutoPowerOff != ENABLE)".

Parameters

__HANDLE__

ADC handle

Return values

None.

SDADC_ENABLE_GPIO_TRIGER

#define SDADC_ENABLE_GPIO_TRIGER

(

__HANDLE__

)

((__HANDLE__)->Instance->TRIG |= SDADC_TRIG_GPIO_TRIG_EN)

Enable GPIO triger.

Parameters

__HANDLE__

SDADC handle.

Return values

None

SDADC_ENABLE_TIMER_TRIGER

#define SDADC_ENABLE_TIMER_TRIGER

(

__HANDLE__

)

((__HANDLE__)->Instance->TRIG |= SDADC_TRIG_TIMER_TRIG_EN)

Enable timer triger.

Parameters

__HANDLE__

SDADC handle.

Return values

None

SDADC_IS_ENABLE

#define SDADC_IS_ENABLE

(

__HANDLE__

)

Value:

  (( (((__HANDLE__)->Instance->CH0_CFG) & SDADC_CH0_CFG_EN) |  \
  (((__HANDLE__)->Instance->CH1_CFG) & SDADC_CH1_CFG_EN) |  \
  (((__HANDLE__)->Instance->CH2_CFG) & SDADC_CH2_CFG_EN) |  \
  (((__HANDLE__)->Instance->CH3_CFG) & SDADC_CH3_CFG_EN) |  \
  (((__HANDLE__)->Instance->CH4_CFG) & SDADC_CH4_CFG_EN) |  \
   ) ? SET : RESET)

Verification of SDADC state: enabled or disabled.

Parameters

__HANDLE__

SDADC handle

Return values

SET	(SDADC enabled) or RESET (SDADC disabled)

SDADC_STATE_CLR_SET

#define SDADC_STATE_CLR_SET   MODIFY_REG

Simultaneously clears and sets specific bits of the handle State.

Note

: SDADC_STATE_CLR_SET() macro is merely aliased to generic macro MODIFY_REG(), the first parameter is the ADC handle State, the second parameter is the bit field to clear, the third and last parameter is the bit field to set.

Return values

None