STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_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  DFSDM_Filter_AwdParamTypeDef
 DFSDM filter analog watchdog parameters structure definition. More...
 
struct  DFSDM_MultiChannelConfigTypeDef
 Synchronization parameters structure definition for STM32F413xx/STM32F423xx devices. More...
 

Typedefs

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

Enumerations

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 (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...
 
HAL_DFSDM_Channel_StateTypeDef HAL_DFSDM_ChannelGetState (const 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, const 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 (const DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t *Channel)
 This function allows to get regular conversion value. More...
 
int32_t HAL_DFSDM_FilterGetInjectedValue (const DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t *Channel)
 This function allows to get injected conversion value. More...
 
int32_t HAL_DFSDM_FilterGetExdMaxValue (const DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t *Channel)
 This function allows to get extreme detector maximum value. More...
 
int32_t HAL_DFSDM_FilterGetExdMinValue (const DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t *Channel)
 This function allows to get extreme detector minimum value. More...
 
uint32_t HAL_DFSDM_FilterGetConvTimeValue (const 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 (const DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to get the current DFSDM filter handle state. More...
 
uint32_t HAL_DFSDM_FilterGetError (const DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 This function allows to get the current DFSDM filter error. More...
 
void HAL_DFSDM_ConfigMultiChannelDelay (DFSDM_MultiChannelConfigTypeDef *mchdlystruct)
 Configure multi channel delay block: Use DFSDM2 audio clock source as input clock for DFSDM1 and DFSDM2 filters to Synchronize DFSDMx filters. Set the path of the DFSDM2 clock output (dfsdm2_ckout) to the DFSDM1/2 CkInx and data inputs channels by configuring following MCHDLY muxes or demuxes: M1, M2, M3, M4, M5, M6, M7, M8, DM1, DM2, DM3, DM4, DM5, DM6, M9, M10, M11, M12, M13, M14, M15, M16, M17, M18, M19, M20 based on the contains of the DFSDM_MultiChannelConfigTypeDef structure. More...
 
void HAL_DFSDM_BitstreamClock_Start (void)
 Select the DFSDM2 as clock source for the bitstream clock. More...
 
void HAL_DFSDM_BitstreamClock_Stop (void)
 Stop the DFSDM2 as clock source for the bitstream clock. More...
 
void HAL_DFSDM_DisableDelayClock (uint32_t MCHDLY)
 Disable Delay Clock for DFSDM1/2. More...
 
void HAL_DFSDM_EnableDelayClock (uint32_t MCHDLY)
 Enable Delay Clock for DFSDM1/2. More...
 
void HAL_DFSDM_ClockIn_SourceSelection (uint32_t source)
 Select the source for CKin signals for DFSDM1/2. More...
 
void HAL_DFSDM_ClockOut_SourceSelection (uint32_t source)
 Select the source for CKOut signals for DFSDM1/2. More...
 
void HAL_DFSDM_DataIn0_SourceSelection (uint32_t source)
 Select the source for DataIn0 signals for DFSDM1/2. More...
 
void HAL_DFSDM_DataIn2_SourceSelection (uint32_t source)
 Select the source for DataIn2 signals for DFSDM1/2. More...
 
void HAL_DFSDM_DataIn4_SourceSelection (uint32_t source)
 Select the source for DataIn4 signals for DFSDM2. More...
 
void HAL_DFSDM_DataIn6_SourceSelection (uint32_t source)
 Select the source for DataIn6 signals for DFSDM2. More...
 
void HAL_DFSDM_BitStreamClkDistribution_Config (uint32_t source)
 Configure the distribution of the bitstream clock gated from TIM4_OC for DFSDM1 or TIM3_OC for DFSDM2. More...
 

Variables

 C
 

Detailed Description

Header file of DFSDM HAL module.

Author
MCD Application Team
Attention

Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_dfsdm.h.


Data Structure Documentation

◆ DFSDM_Channel_OutputClockTypeDef

struct DFSDM_Channel_OutputClockTypeDef

DFSDM channel output clock structure definition.

Definition at line 57 of file stm32f4xx_hal_dfsdm.h.

Data Fields
FunctionalState Activation

Output clock enable/disable

uint32_t Divider

Output clock divider. This parameter must be a number between Min_Data = 2 and Max_Data = 256

uint32_t Selection

Output clock is system clock or audio clock. This parameter can be a value of DFSDM channel output clock selection

◆ DFSDM_Channel_InputTypeDef

struct DFSDM_Channel_InputTypeDef

DFSDM channel input structure definition.

Definition at line 69 of file stm32f4xx_hal_dfsdm.h.

Data Fields
uint32_t DataPacking

Standard, interleaved or dual mode for internal register. This parameter can be a value of DFSDM channel input data packing

uint32_t Multiplexer

Input is external serial inputs or internal register. This parameter can be a value of DFSDM channel input multiplexer

uint32_t Pins

Input pins are taken from same or following channel. This parameter can be a value of DFSDM channel input pins

◆ DFSDM_Channel_SerialInterfaceTypeDef

struct DFSDM_Channel_SerialInterfaceTypeDef

DFSDM channel serial interface structure definition.

Definition at line 82 of file stm32f4xx_hal_dfsdm.h.

Data Fields
uint32_t SpiClock

SPI clock select (external or internal with different sampling point). This parameter can be a value of DFSDM channel SPI clock selection

uint32_t Type

SPI or Manchester modes. This parameter can be a value of DFSDM channel serial interface type

◆ DFSDM_Channel_AwdTypeDef

struct DFSDM_Channel_AwdTypeDef

DFSDM channel analog watchdog structure definition.

Definition at line 93 of file stm32f4xx_hal_dfsdm.h.

Data Fields
uint32_t FilterOrder

Analog watchdog Sinc filter order. This parameter can be a value of DFSDM channel analog watchdog filter order

uint32_t Oversampling

Analog watchdog filter oversampling ratio. This parameter must be a number between Min_Data = 1 and Max_Data = 32

◆ DFSDM_Channel_InitTypeDef

struct DFSDM_Channel_InitTypeDef

DFSDM channel init structure definition.

Definition at line 104 of file stm32f4xx_hal_dfsdm.h.

+ Collaboration diagram for DFSDM_Channel_InitTypeDef:
Data Fields
DFSDM_Channel_AwdTypeDef Awd

DFSDM channel analog watchdog parameters

DFSDM_Channel_InputTypeDef Input

DFSDM channel input parameters

int32_t Offset

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

DFSDM_Channel_OutputClockTypeDef OutputClock

DFSDM channel output clock parameters

uint32_t RightBitShift

DFSDM channel right bit shift. This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x1F

DFSDM_Channel_SerialInterfaceTypeDef SerialInterface

DFSDM channel serial interface parameters

◆ DFSDM_Filter_RegularParamTypeDef

struct DFSDM_Filter_RegularParamTypeDef

DFSDM filter regular conversion parameters structure definition.

Definition at line 169 of file stm32f4xx_hal_dfsdm.h.

Data Fields
FunctionalState DmaMode

Enable/disable DMA for regular conversion

FunctionalState FastMode

Enable/disable fast mode for regular conversion

uint32_t Trigger

Trigger used to start regular conversion: software or synchronous. This parameter can be a value of DFSDM filter conversion trigger

◆ DFSDM_Filter_InjectedParamTypeDef

struct DFSDM_Filter_InjectedParamTypeDef

DFSDM filter injected conversion parameters structure definition.

Definition at line 180 of file stm32f4xx_hal_dfsdm.h.

Data Fields
FunctionalState DmaMode

Enable/disable DMA for injected conversion

uint32_t ExtTrigger

External trigger. This parameter can be a value of DFSDM filter external trigger

uint32_t ExtTriggerEdge

External trigger edge: rising, falling or both. This parameter can be a value of DFSDM filter external trigger edge

FunctionalState ScanMode

Enable/disable scanning mode for injected conversion

uint32_t Trigger

Trigger used to start injected conversion: software, external or synchronous. This parameter can be a value of DFSDM filter conversion trigger

◆ DFSDM_Filter_FilterParamTypeDef

struct DFSDM_Filter_FilterParamTypeDef

DFSDM filter parameters structure definition.

Definition at line 195 of file stm32f4xx_hal_dfsdm.h.

Data Fields
uint32_t IntOversampling

Integrator oversampling ratio. This parameter must be a number between Min_Data = 1 and Max_Data = 256

uint32_t Oversampling

Filter oversampling ratio. This parameter must be a number between Min_Data = 1 and Max_Data = 1024

uint32_t SincOrder

Sinc filter order. This parameter can be a value of DFSDM filter sinc order

◆ DFSDM_Filter_InitTypeDef

struct DFSDM_Filter_InitTypeDef

DFSDM filter init structure definition.

Definition at line 208 of file stm32f4xx_hal_dfsdm.h.

+ Collaboration diagram for DFSDM_Filter_InitTypeDef:
Data Fields
DFSDM_Filter_FilterParamTypeDef FilterParam

DFSDM filter parameters

DFSDM_Filter_InjectedParamTypeDef InjectedParam

DFSDM injected conversion parameters

DFSDM_Filter_RegularParamTypeDef RegularParam

DFSDM regular conversion parameters

◆ DFSDM_Filter_AwdParamTypeDef

struct DFSDM_Filter_AwdParamTypeDef

DFSDM filter analog watchdog parameters structure definition.

Definition at line 253 of file stm32f4xx_hal_dfsdm.h.

Data Fields
uint32_t Channel

Analog watchdog channel selection. This parameter can be a values combination of DFSDM Channel Selection

uint32_t DataSource

Values from digital filter or from channel watchdog filter. This parameter can be a value of DFSDM filter analog watchdog data source

uint32_t HighBreakSignal

Break signal assigned to analog watchdog high threshold event. This parameter can be a values combination of DFSDM break signals

int32_t HighThreshold

High threshold for the analog watchdog. This parameter must be a number between Min_Data = -8388608 and Max_Data = 8388607

uint32_t LowBreakSignal

Break signal assigned to analog watchdog low threshold event. This parameter can be a values combination of DFSDM break signals

int32_t LowThreshold

Low threshold for the analog watchdog. This parameter must be a number between Min_Data = -8388608 and Max_Data = 8388607

◆ DFSDM_MultiChannelConfigTypeDef

struct DFSDM_MultiChannelConfigTypeDef

Synchronization parameters structure definition for STM32F413xx/STM32F423xx devices.

Definition at line 298 of file stm32f4xx_hal_dfsdm.h.

Data Fields
uint32_t DFSDM1BitClkDistribution

Distribution of the DFSDM1 bitstream clock gated by TIM4 OC1 or TIM4 OC2. This parameter can be a value of DFSDM1 Bit Stream Distribution

Note
The DFSDM2 audio gated by TIM4 OC2 can be injected on CKIN0 or CKIN2
The DFSDM2 audio gated by TIM4 OC1 can be injected on CKIN1 or CKIN3
uint32_t DFSDM1ClockIn

Source selection for DFSDM1_Ckin. This parameter can be a value of DFSDM1 ClockIn Selection

uint32_t DFSDM1ClockOut

Source selection for DFSDM1_Ckout. This parameter can be a value of DFSDM1 ClockOut Selection

uint32_t DFSDM1DataDistribution

Source selection for DatIn0 and DatIn2 of DFSDM1. This parameter can be a value of DFSDM1 Data Distribution

uint32_t DFSDM2BitClkDistribution

Distribution of the DFSDM2 bitstream clock gated by TIM3 OC1 or TIM3 OC2 or TIM3 OC3 or TIM3 OC4. This parameter can be a value of DFSDM12 Bit Stream Distribution

Note
The DFSDM2 audio gated by TIM3 OC4 can be injected on CKIN0 or CKIN4
The DFSDM2 audio gated by TIM3 OC3 can be injected on CKIN1 or CKIN5
The DFSDM2 audio gated by TIM3 OC2 can be injected on CKIN2 or CKIN6
The DFSDM2 audio gated by TIM3 OC1 can be injected on CKIN3 or CKIN7
uint32_t DFSDM2ClockIn

Source selection for DFSDM2_Ckin. This parameter can be a value of DFSDM2 ClockIn Selection

uint32_t DFSDM2ClockOut

Source selection for DFSDM2_Ckout. This parameter can be a value of DFSDM2 ClockOut Selection

uint32_t DFSDM2DataDistribution

Source selection for DatIn0, DatIn2, DatIn4 and DatIn6 of DFSDM2. This parameter can be a value of DFSDM2 Data Distribution

Enumeration Type Documentation

◆ HAL_DFSDM_Channel_CallbackIDTypeDef

DFSDM channel callback ID enumeration definition.

Enumerator
HAL_DFSDM_CHANNEL_CKAB_CB_ID 

DFSDM channel clock absence detection callback ID

HAL_DFSDM_CHANNEL_SCD_CB_ID 

DFSDM channel short circuit detection callback ID

HAL_DFSDM_CHANNEL_MSPINIT_CB_ID 

DFSDM channel MSP init callback ID

HAL_DFSDM_CHANNEL_MSPDEINIT_CB_ID 

DFSDM channel MSP de-init callback ID

Definition at line 140 of file stm32f4xx_hal_dfsdm.h.

◆ HAL_DFSDM_Filter_CallbackIDTypeDef

DFSDM filter callback ID enumeration definition.

Enumerator
HAL_DFSDM_FILTER_REGCONV_COMPLETE_CB_ID 

DFSDM filter regular conversion complete callback ID

HAL_DFSDM_FILTER_REGCONV_HALFCOMPLETE_CB_ID 

DFSDM filter half regular conversion complete callback ID

HAL_DFSDM_FILTER_INJCONV_COMPLETE_CB_ID 

DFSDM filter injected conversion complete callback ID

HAL_DFSDM_FILTER_INJCONV_HALFCOMPLETE_CB_ID 

DFSDM filter half injected conversion complete callback ID

HAL_DFSDM_FILTER_ERROR_CB_ID 

DFSDM filter error callback ID

HAL_DFSDM_FILTER_MSPINIT_CB_ID 

DFSDM filter MSP init callback ID

HAL_DFSDM_FILTER_MSPDEINIT_CB_ID 

DFSDM filter MSP de-init callback ID

Definition at line 273 of file stm32f4xx_hal_dfsdm.h.

◆ HAL_DFSDM_Filter_StateTypeDef

HAL DFSDM Filter states definition.

Enumerator
HAL_DFSDM_FILTER_STATE_RESET 

DFSDM filter not initialized

HAL_DFSDM_FILTER_STATE_READY 

DFSDM filter initialized and ready for use

HAL_DFSDM_FILTER_STATE_REG 

DFSDM filter regular conversion in progress

HAL_DFSDM_FILTER_STATE_INJ 

DFSDM filter injected conversion in progress

HAL_DFSDM_FILTER_STATE_REG_INJ 

DFSDM filter regular and injected conversions in progress

HAL_DFSDM_FILTER_STATE_ERROR 

DFSDM filter state error

Definition at line 156 of file stm32f4xx_hal_dfsdm.h.

Variable Documentation

◆ C

C
extern
Initial value:
{
#endif
#if defined(STM32F412Zx) || defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx)
typedef enum
{
HAL_DFSDM_CHANNEL_STATE_RESET = 0x00U,
HAL_DFSDM_CHANNEL_STATE_READY = 0x01U,
HAL_DFSDM_CHANNEL_STATE_ERROR = 0xFFU
}HAL_DFSDM_Channel_StateTypeDef
This file contains HAL common defines, enumeration, macros and structures definitions.