Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Channel operation functions
[DFSDM Exported Functions]
Channel operation functions. More...
Functions | |
| HAL_StatusTypeDef | HAL_DFSDM_ChannelCkabStart (DFSDM_Channel_HandleTypeDef *hdfsdm_channel) |
| This function allows to start clock absence detection in polling mode. | |
| HAL_StatusTypeDef | HAL_DFSDM_ChannelPollForCkab (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Timeout) |
| This function allows to poll for the clock absence detection. | |
| HAL_StatusTypeDef | HAL_DFSDM_ChannelCkabStop (DFSDM_Channel_HandleTypeDef *hdfsdm_channel) |
| This function allows to stop clock absence detection in polling mode. | |
| HAL_StatusTypeDef | HAL_DFSDM_ChannelCkabStart_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel) |
| This function allows to start clock absence detection in interrupt mode. | |
| __weak void | HAL_DFSDM_ChannelCkabCallback (DFSDM_Channel_HandleTypeDef *hdfsdm_channel) |
| Clock absence detection callback. | |
| HAL_StatusTypeDef | HAL_DFSDM_ChannelCkabStop_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel) |
| This function allows to stop clock absence detection in interrupt mode. | |
| 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. | |
| HAL_StatusTypeDef | HAL_DFSDM_ChannelPollForScd (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Timeout) |
| This function allows to poll for the short circuit detection. | |
| HAL_StatusTypeDef | HAL_DFSDM_ChannelScdStop (DFSDM_Channel_HandleTypeDef *hdfsdm_channel) |
| This function allows to stop short circuit detection in polling mode. | |
| 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. | |
| __weak void | HAL_DFSDM_ChannelScdCallback (DFSDM_Channel_HandleTypeDef *hdfsdm_channel) |
| Short circuit detection callback. | |
| HAL_StatusTypeDef | HAL_DFSDM_ChannelScdStop_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel) |
| This function allows to stop short circuit detection in interrupt mode. | |
| int16_t | HAL_DFSDM_ChannelGetAwdValue (DFSDM_Channel_HandleTypeDef *hdfsdm_channel) |
| This function allows to get channel analog watchdog value. | |
| HAL_StatusTypeDef | HAL_DFSDM_ChannelModifyOffset (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, int32_t Offset) |
| This function allows to modify channel offset value. | |
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
| __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 681 of file stm32l4xx_hal_dfsdm.c.
| 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 487 of file stm32l4xx_hal_dfsdm.c.
| 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 626 of file stm32l4xx_hal_dfsdm.c.
| 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 590 of file stm32l4xx_hal_dfsdm.c.
| 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 697 of file stm32l4xx_hal_dfsdm.c.
| int16_t HAL_DFSDM_ChannelGetAwdValue | ( | 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 951 of file stm32l4xx_hal_dfsdm.c.
| 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 963 of file stm32l4xx_hal_dfsdm.c.
| HAL_StatusTypeDef HAL_DFSDM_ChannelPollForCkab | ( | 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 540 of file stm32l4xx_hal_dfsdm.c.
| HAL_StatusTypeDef HAL_DFSDM_ChannelPollForScd | ( | 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 774 of file stm32l4xx_hal_dfsdm.c.
| __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 900 of file stm32l4xx_hal_dfsdm.c.
| 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_BreakSignals.
- Return values:
-
HAL status
Definition at line 737 of file stm32l4xx_hal_dfsdm.c.
| 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_BreakSignals.
- Return values:
-
HAL status
Definition at line 861 of file stm32l4xx_hal_dfsdm.c.
| 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 824 of file stm32l4xx_hal_dfsdm.c.
| 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 916 of file stm32l4xx_hal_dfsdm.c.
Generated on Tue Jul 12 2022 11:00:04 by
1.7.2