Channel operation functions. More...

Collaboration diagram for Channel operation functions:

Functions
HAL_StatusTypeDef	HAL_DFSDM_ChannelCkabStart (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to start clock absence detection in polling mode. More...

HAL_StatusTypeDef	HAL_DFSDM_ChannelCkabStart_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to start clock absence detection in interrupt mode. More...

HAL_StatusTypeDef	HAL_DFSDM_ChannelCkabStop (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to stop clock absence detection in polling mode. More...

HAL_StatusTypeDef	HAL_DFSDM_ChannelCkabStop_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to stop clock absence detection in interrupt mode. More...

HAL_StatusTypeDef	HAL_DFSDM_ChannelScdStart (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Threshold, uint32_t BreakSignal)
	This function allows to start short circuit detection in polling mode. More...

HAL_StatusTypeDef	HAL_DFSDM_ChannelScdStart_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Threshold, uint32_t BreakSignal)
	This function allows to start short circuit detection in interrupt mode. More...

HAL_StatusTypeDef	HAL_DFSDM_ChannelScdStop (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to stop short circuit detection in polling mode. More...

HAL_StatusTypeDef	HAL_DFSDM_ChannelScdStop_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to stop short circuit detection in interrupt mode. More...

int16_t	HAL_DFSDM_ChannelGetAwdValue (const DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to get channel analog watchdog value. More...

HAL_StatusTypeDef	HAL_DFSDM_ChannelModifyOffset (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, int32_t Offset)
	This function allows to modify channel offset value. More...

HAL_StatusTypeDef	HAL_DFSDM_ChannelPollForCkab (const DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Timeout)
	This function allows to poll for the clock absence detection. More...

HAL_StatusTypeDef	HAL_DFSDM_ChannelPollForScd (const DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Timeout)
	This function allows to poll for the short circuit detection. More...

void	HAL_DFSDM_ChannelCkabCallback (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	Clock absence detection callback. More...

void	HAL_DFSDM_ChannelScdCallback (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	Short circuit detection callback. More...

Detailed Description

Channel operation functions.

  ==============================================================================
                   ##### Channel operation functions #####
  ==============================================================================
    [..]  This section provides functions allowing to:
      (+) Manage clock absence detector feature.
      (+) Manage short circuit detector feature.
      (+) Get analog watchdog value.
      (+) Modify offset value.

Function Documentation

◆ HAL_DFSDM_ChannelCkabCallback()

__weak void HAL_DFSDM_ChannelCkabCallback ( DFSDM_Channel_HandleTypeDef * hdfsdm_channel )

Clock absence detection callback.

Parameters

hdfsdm_channel DFSDM channel handle.

Return values

None

Definition at line 1212 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelCkabStart()

HAL_StatusTypeDef HAL_DFSDM_ChannelCkabStart ( DFSDM_Channel_HandleTypeDef * hdfsdm_channel )

This function allows to start clock absence detection in polling mode.

Note: Same mode has to be used for all channels.; If clock is not available on this channel during 5 seconds, clock absence detection will not be activated and function will return HAL_TIMEOUT error.

Parameters

hdfsdm_channel DFSDM channel handle.

Return values

HAL status

Definition at line 875 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelCkabStart_IT()

HAL_StatusTypeDef HAL_DFSDM_ChannelCkabStart_IT ( DFSDM_Channel_HandleTypeDef * hdfsdm_channel )

This function allows to start clock absence detection in interrupt mode.

Note: Same mode has to be used for all channels.; If clock is not available on this channel during 5 seconds, clock absence detection will not be activated and function will return HAL_TIMEOUT error.

Parameters

hdfsdm_channel DFSDM channel handle.

Return values

HAL status

Definition at line 1111 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelCkabStop()

HAL_StatusTypeDef HAL_DFSDM_ChannelCkabStop ( DFSDM_Channel_HandleTypeDef * hdfsdm_channel )

This function allows to stop clock absence detection in polling mode.

Parameters

hdfsdm_channel DFSDM channel handle.

Return values

HAL status

Definition at line 1051 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelCkabStop_IT()

HAL_StatusTypeDef HAL_DFSDM_ChannelCkabStop_IT ( DFSDM_Channel_HandleTypeDef * hdfsdm_channel )

This function allows to stop clock absence detection in interrupt mode.

Note: Interrupt will be disabled for all channels

Parameters

hdfsdm_channel DFSDM channel handle.

Return values

HAL status

Definition at line 1227 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelGetAwdValue()

int16_t HAL_DFSDM_ChannelGetAwdValue ( const DFSDM_Channel_HandleTypeDef * hdfsdm_channel )

This function allows to get channel analog watchdog value.

Parameters

hdfsdm_channel DFSDM channel handle.

Return values

Channel analog watchdog value.

Definition at line 1599 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelModifyOffset()

HAL_StatusTypeDef HAL_DFSDM_ChannelModifyOffset	(	DFSDM_Channel_HandleTypeDef *	hdfsdm_channel,
		int32_t	Offset
	)

This function allows to modify channel offset value.

Parameters

hdfsdm_channel	DFSDM channel handle.
Offset	DFSDM channel offset. This parameter must be a number between Min_Data = -8388608 and Max_Data = 8388607.

Return values

HAL status.

Definition at line 1611 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelPollForCkab()

HAL_StatusTypeDef HAL_DFSDM_ChannelPollForCkab	(	const DFSDM_Channel_HandleTypeDef *	hdfsdm_channel,
		uint32_t	Timeout
	)

This function allows to poll for the clock absence detection.

Parameters

hdfsdm_channel	DFSDM channel handle.
Timeout	Timeout value in milliseconds.

Return values

HAL status

Definition at line 963 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelPollForScd()

HAL_StatusTypeDef HAL_DFSDM_ChannelPollForScd	(	const DFSDM_Channel_HandleTypeDef *	hdfsdm_channel,
		uint32_t	Timeout
	)

This function allows to poll for the short circuit detection.

Parameters

hdfsdm_channel	DFSDM channel handle.
Timeout	Timeout value in milliseconds.

Return values

HAL status

Definition at line 1332 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelScdCallback()

__weak void HAL_DFSDM_ChannelScdCallback ( DFSDM_Channel_HandleTypeDef * hdfsdm_channel )

Short circuit detection callback.

Parameters

hdfsdm_channel DFSDM channel handle.

Return values

None

Definition at line 1529 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelScdStart()

HAL_StatusTypeDef HAL_DFSDM_ChannelScdStart	(	DFSDM_Channel_HandleTypeDef *	hdfsdm_channel,
		uint32_t	Threshold,
		uint32_t	BreakSignal
	)

This function allows to start short circuit detection in polling mode.

Note: Same mode has to be used for all channels

Parameters

hdfsdm_channel	DFSDM channel handle.
Threshold	Short circuit detector threshold. This parameter must be a number between Min_Data = 0 and Max_Data = 255.
BreakSignal	Break signals assigned to short circuit event. This parameter can be a values combination of DFSDM break signals.

Return values

HAL status

Definition at line 1295 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelScdStart_IT()

HAL_StatusTypeDef HAL_DFSDM_ChannelScdStart_IT	(	DFSDM_Channel_HandleTypeDef *	hdfsdm_channel,
		uint32_t	Threshold,
		uint32_t	BreakSignal
	)

This function allows to start short circuit detection in interrupt mode.

Note: Same mode has to be used for all channels

Parameters

hdfsdm_channel	DFSDM channel handle.
Threshold	Short circuit detector threshold. This parameter must be a number between Min_Data = 0 and Max_Data = 255.
BreakSignal	Break signals assigned to short circuit event. This parameter can be a values combination of DFSDM break signals.

Return values

HAL status

Definition at line 1473 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelScdStop()

HAL_StatusTypeDef HAL_DFSDM_ChannelScdStop ( DFSDM_Channel_HandleTypeDef * hdfsdm_channel )

This function allows to stop short circuit detection in polling mode.

Parameters

hdfsdm_channel DFSDM channel handle.

Return values

HAL status

Definition at line 1418 of file stm32f4xx_hal_dfsdm.c.

◆ HAL_DFSDM_ChannelScdStop_IT()

HAL_StatusTypeDef HAL_DFSDM_ChannelScdStop_IT ( DFSDM_Channel_HandleTypeDef * hdfsdm_channel )

This function allows to stop short circuit detection in interrupt mode.

Note: Interrupt will be disabled for all channels

Parameters

hdfsdm_channel DFSDM channel handle.

Return values

HAL status

Definition at line 1544 of file stm32f4xx_hal_dfsdm.c.

Functions

Detailed Description

Function Documentation

◆ HAL_DFSDM_ChannelCkabCallback()

◆ HAL_DFSDM_ChannelCkabStart()

◆ HAL_DFSDM_ChannelCkabStart_IT()

◆ HAL_DFSDM_ChannelCkabStop()

◆ HAL_DFSDM_ChannelCkabStop_IT()

◆ HAL_DFSDM_ChannelGetAwdValue()

◆ HAL_DFSDM_ChannelModifyOffset()

◆ HAL_DFSDM_ChannelPollForCkab()

◆ HAL_DFSDM_ChannelPollForScd()

◆ HAL_DFSDM_ChannelScdCallback()

◆ HAL_DFSDM_ChannelScdStart()

◆ HAL_DFSDM_ChannelScdStart_IT()

◆ HAL_DFSDM_ChannelScdStop()

◆ HAL_DFSDM_ChannelScdStop_IT()