STM32L4xx_HAL_Driver  1.14.0
stm32l4xx_hal_dfsdm.h File Reference

Header file of DFSDM HAL module. More...

Go to the source code of this file.

Data Structures

struct  DFSDM_Channel_OutputClockTypeDef
 DFSDM channel output clock structure definition. More...
 
struct  DFSDM_Channel_InputTypeDef
 DFSDM channel input structure definition. More...
 
struct  DFSDM_Channel_SerialInterfaceTypeDef
 DFSDM channel serial interface structure definition. More...
 
struct  DFSDM_Channel_AwdTypeDef
 DFSDM channel analog watchdog structure definition. More...
 
struct  DFSDM_Channel_InitTypeDef
 DFSDM channel init structure definition. More...
 
struct  endif
 ADC handle Structure definition. More...
 
struct  DFSDM_Filter_RegularParamTypeDef
 DFSDM filter regular conversion parameters structure definition. More...
 
struct  DFSDM_Filter_InjectedParamTypeDef
 DFSDM filter injected conversion parameters structure definition. More...
 
struct  DFSDM_Filter_FilterParamTypeDef
 DFSDM filter parameters structure definition. More...
 
struct  DFSDM_Filter_InitTypeDef
 DFSDM filter init structure definition. More...
 
struct  endif
 ADC handle Structure definition. More...
 
struct  DFSDM_Filter_AwdParamTypeDef
 DFSDM filter analog watchdog parameters structure definition. More...
 

Typedefs

typedef struct __DFSDM_Channel_HandleTypeDef else typedef struct endif DFSDM_Channel_HandleTypeDef
 DFSDM channel handle structure definition. More...
 
typedef void(* pDFSDM_Channel_CallbackTypeDef) (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
 DFSDM channel callback pointer definition. More...
 
typedef struct __DFSDM_Filter_HandleTypeDef else typedef struct endif DFSDM_Filter_HandleTypeDef
 DFSDM filter handle structure definition. More...
 
typedef void(* pDFSDM_Filter_CallbackTypeDef) (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 DFSDM filter callback pointer definition. More...
 
typedef void(* pDFSDM_Filter_AwdCallbackTypeDef) (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t Channel, uint32_t Threshold)
 

Enumerations

enum  HAL_DFSDM_Channel_StateTypeDef { HAL_DFSDM_CHANNEL_STATE_RESET = 0x00U, HAL_DFSDM_CHANNEL_STATE_READY = 0x01U, HAL_DFSDM_CHANNEL_STATE_ERROR = 0xFFU }
 HAL DFSDM Channel states definition. More...
 
enum  HAL_DFSDM_Channel_CallbackIDTypeDef { HAL_DFSDM_CHANNEL_CKAB_CB_ID = 0x00U, HAL_DFSDM_CHANNEL_SCD_CB_ID = 0x01U, HAL_DFSDM_CHANNEL_MSPINIT_CB_ID = 0x02U, HAL_DFSDM_CHANNEL_MSPDEINIT_CB_ID = 0x03U }
 DFSDM channel callback ID enumeration definition. More...
 
enum  HAL_DFSDM_Filter_StateTypeDef {
  HAL_DFSDM_FILTER_STATE_RESET = 0x00U, HAL_DFSDM_FILTER_STATE_READY = 0x01U, HAL_DFSDM_FILTER_STATE_REG = 0x02U, HAL_DFSDM_FILTER_STATE_INJ = 0x03U,
  HAL_DFSDM_FILTER_STATE_REG_INJ = 0x04U, HAL_DFSDM_FILTER_STATE_ERROR = 0xFFU
}
 HAL DFSDM Filter states definition. More...
 
enum  HAL_DFSDM_Filter_CallbackIDTypeDef {
  HAL_DFSDM_FILTER_REGCONV_COMPLETE_CB_ID = 0x00U, HAL_DFSDM_FILTER_REGCONV_HALFCOMPLETE_CB_ID = 0x01U, HAL_DFSDM_FILTER_INJCONV_COMPLETE_CB_ID = 0x02U, HAL_DFSDM_FILTER_INJCONV_HALFCOMPLETE_CB_ID = 0x03U,
  HAL_DFSDM_FILTER_ERROR_CB_ID = 0x04U, HAL_DFSDM_FILTER_MSPINIT_CB_ID = 0x05U, HAL_DFSDM_FILTER_MSPDEINIT_CB_ID = 0x06U
}
 DFSDM filter callback ID enumeration definition. More...
 

Functions

HAL_StatusTypeDef HAL_DFSDM_ChannelInit (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
 Initialize the DFSDM channel according to the specified parameters in the DFSDM_ChannelInitTypeDef structure and initialize the associated handle. More...
 
HAL_StatusTypeDef HAL_DFSDM_ChannelDeInit (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
 De-initialize the DFSDM channel. More...
 
void HAL_DFSDM_ChannelMspInit (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
 Initialize the DFSDM channel MSP. More...
 
void HAL_DFSDM_ChannelMspDeInit (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
 De-initialize the DFSDM channel MSP. More...
 
HAL_StatusTypeDef HAL_DFSDM_Channel_RegisterCallback (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, HAL_DFSDM_Channel_CallbackIDTypeDef CallbackID, pDFSDM_Channel_CallbackTypeDef pCallback)
 Register a user DFSDM channel callback to be used instead of the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_DFSDM_Channel_UnRegisterCallback (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, HAL_DFSDM_Channel_CallbackIDTypeDef CallbackID)
 Unregister a user DFSDM channel callback. DFSDM channel callback is redirected to the weak predefined callback. More...
 
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 (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 (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Timeout)
 This function allows to poll for the clock absence detection. More...
 
HAL_StatusTypeDef HAL_DFSDM_ChannelPollForScd (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...
 
HAL_DFSDM_Channel_StateTypeDef HAL_DFSDM_ChannelGetState (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
 This function allows to get the current DFSDM channel handle state. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterInit (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 Initialize the DFSDM filter according to the specified parameters in the DFSDM_FilterInitTypeDef structure and initialize the associated handle. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterDeInit (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 De-initializes the DFSDM filter. More...
 
void HAL_DFSDM_FilterMspInit (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 Initializes the DFSDM filter MSP. More...
 
void HAL_DFSDM_FilterMspDeInit (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 De-initializes the DFSDM filter MSP. More...
 
HAL_StatusTypeDef HAL_DFSDM_Filter_RegisterCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, HAL_DFSDM_Filter_CallbackIDTypeDef CallbackID, pDFSDM_Filter_CallbackTypeDef pCallback)
 Register a user DFSDM filter callback to be used instead of the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_DFSDM_Filter_UnRegisterCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, HAL_DFSDM_Filter_CallbackIDTypeDef CallbackID)
 Unregister a user DFSDM filter callback. DFSDM filter callback is redirected to the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_DFSDM_Filter_RegisterAwdCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, pDFSDM_Filter_AwdCallbackTypeDef pCallback)
 Register a user DFSDM filter analog watchdog callback to be used instead of the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_DFSDM_Filter_UnRegisterAwdCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 Unregister a user DFSDM filter analog watchdog callback. DFSDM filter AWD callback is redirected to the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterConfigRegChannel (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t Channel, uint32_t ContinuousMode)
 This function allows to select channel and to enable/disable continuous mode for regular conversion. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterConfigInjChannel (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t Channel)
 This function allows to select channels for injected conversion. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterRegularStart (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to start regular conversion in polling mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterRegularStart_IT (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to start regular conversion in interrupt mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterRegularStart_DMA (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, int32_t *pData, uint32_t Length)
 This function allows to start regular conversion in DMA mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterRegularMsbStart_DMA (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, int16_t *pData, uint32_t Length)
 This function allows to start regular conversion in DMA mode and to get only the 16 most significant bits of conversion. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterRegularStop (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to stop regular conversion in polling mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterRegularStop_IT (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to stop regular conversion in interrupt mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterRegularStop_DMA (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to stop regular conversion in DMA mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterInjectedStart (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to start injected conversion in polling mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterInjectedStart_IT (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to start injected conversion in interrupt mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterInjectedStart_DMA (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, int32_t *pData, uint32_t Length)
 This function allows to start injected conversion in DMA mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterInjectedMsbStart_DMA (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, int16_t *pData, uint32_t Length)
 This function allows to start injected conversion in DMA mode and to get only the 16 most significant bits of conversion. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterInjectedStop (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to stop injected conversion in polling mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterInjectedStop_IT (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to stop injected conversion in interrupt mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterInjectedStop_DMA (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to stop injected conversion in DMA mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterAwdStart_IT (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, DFSDM_Filter_AwdParamTypeDef *awdParam)
 This function allows to start filter analog watchdog in interrupt mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterAwdStop_IT (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to stop filter analog watchdog in interrupt mode. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterExdStart (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t Channel)
 This function allows to start extreme detector feature. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterExdStop (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to stop extreme detector feature. More...
 
int32_t HAL_DFSDM_FilterGetRegularValue (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t *Channel)
 This function allows to get regular conversion value. More...
 
int32_t HAL_DFSDM_FilterGetInjectedValue (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t *Channel)
 This function allows to get injected conversion value. More...
 
int32_t HAL_DFSDM_FilterGetExdMaxValue (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t *Channel)
 This function allows to get extreme detector maximum value. More...
 
int32_t HAL_DFSDM_FilterGetExdMinValue (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t *Channel)
 This function allows to get extreme detector minimum value. More...
 
uint32_t HAL_DFSDM_FilterGetConvTimeValue (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to get conversion time value. More...
 
void HAL_DFSDM_IRQHandler (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function handles the DFSDM interrupts. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterPollForRegConversion (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t Timeout)
 This function allows to poll for the end of regular conversion. More...
 
HAL_StatusTypeDef HAL_DFSDM_FilterPollForInjConversion (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t Timeout)
 This function allows to poll for the end of injected conversion. More...
 
void HAL_DFSDM_FilterRegConvCpltCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 Regular conversion complete callback. More...
 
void HAL_DFSDM_FilterRegConvHalfCpltCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 Half regular conversion complete callback. More...
 
void HAL_DFSDM_FilterInjConvCpltCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 Injected conversion complete callback. More...
 
void HAL_DFSDM_FilterInjConvHalfCpltCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 Half injected conversion complete callback. More...
 
void HAL_DFSDM_FilterAwdCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t Channel, uint32_t Threshold)
 Filter analog watchdog callback. More...
 
void HAL_DFSDM_FilterErrorCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 Error callback. More...
 
HAL_DFSDM_Filter_StateTypeDef HAL_DFSDM_FilterGetState (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to get the current DFSDM filter handle state. More...
 
uint32_t HAL_DFSDM_FilterGetError (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to get the current DFSDM filter error. More...
 

Detailed Description

Header file of DFSDM HAL module.

Author
MCD Application Team
Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_dfsdm.h.