Filter initialization and de-initialization functions

Filter initialization and de-initialization functions. More...

Functions
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.
HAL_StatusTypeDef	HAL_DFSDM_FilterDeInit (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
	De-initializes the DFSDM filter.
__weak void	HAL_DFSDM_FilterMspInit (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
	Initializes the DFSDM filter MSP.
__weak void	HAL_DFSDM_FilterMspDeInit (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
	De-initializes the DFSDM filter MSP.
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.
HAL_StatusTypeDef	HAL_DFSDM_Filter_UnRegisterCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, HAL_DFSDM_Filter_CallbackIDTypeDef CallbackID)
	Unregister a user DFSDM filter callback.
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.
HAL_StatusTypeDef	HAL_DFSDM_Filter_UnRegisterAwdCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
	Unregister a user DFSDM filter analog watchdog callback.

---

Detailed Description

Filter initialization and de-initialization functions.

  ==============================================================================
        ##### Filter initialization and de-initialization functions #####
  ==============================================================================
    [..]  This section provides functions allowing to:
      (+) Initialize the DFSDM filter.
      (+) De-initialize the DFSDM filter.

---

Function Documentation

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.

Parameters:

hdfsdm_filter	DFSDM filter handle.
pCallback	pointer to the DFSDM filter analog watchdog callback function.

Return values:

HAL

status.

Definition at line 1636 of file stm32l4xx_hal_dfsdm.c.

References __DFSDM_Filter_HandleTypeDef::AwdCallback, DFSDM_FILTER_ERROR_INVALID_CALLBACK, __DFSDM_Filter_HandleTypeDef::ErrorCode, HAL_DFSDM_FILTER_STATE_READY, and __DFSDM_Filter_HandleTypeDef::State.

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.

Parameters:

hdfsdm_filter	DFSDM filter handle.
CallbackID	ID of the callback to be registered. This parameter can be one of the following values: HAL_DFSDM_FILTER_REGCONV_COMPLETE_CB_ID regular conversion complete callback ID. HAL_DFSDM_FILTER_REGCONV_HALFCOMPLETE_CB_ID half regular conversion complete callback ID. HAL_DFSDM_FILTER_INJCONV_COMPLETE_CB_ID injected conversion complete callback ID. HAL_DFSDM_FILTER_INJCONV_HALFCOMPLETE_CB_ID half injected conversion complete callback ID. HAL_DFSDM_FILTER_ERROR_CB_ID error callback ID. HAL_DFSDM_FILTER_MSPINIT_CB_ID MSP init callback ID. HAL_DFSDM_FILTER_MSPDEINIT_CB_ID MSP de-init callback ID.
pCallback	pointer to the callback function.

Return values:

HAL

status.

Definition at line 1471 of file stm32l4xx_hal_dfsdm.c.

References DFSDM_FILTER_ERROR_INVALID_CALLBACK, __DFSDM_Filter_HandleTypeDef::ErrorCallback, __DFSDM_Filter_HandleTypeDef::ErrorCode, HAL_DFSDM_FILTER_ERROR_CB_ID, HAL_DFSDM_FILTER_INJCONV_COMPLETE_CB_ID, HAL_DFSDM_FILTER_INJCONV_HALFCOMPLETE_CB_ID, HAL_DFSDM_FILTER_MSPDEINIT_CB_ID, HAL_DFSDM_FILTER_MSPINIT_CB_ID, HAL_DFSDM_FILTER_REGCONV_COMPLETE_CB_ID, HAL_DFSDM_FILTER_REGCONV_HALFCOMPLETE_CB_ID, HAL_DFSDM_FILTER_STATE_READY, HAL_DFSDM_FILTER_STATE_RESET, __DFSDM_Filter_HandleTypeDef::InjConvCpltCallback, __DFSDM_Filter_HandleTypeDef::InjConvHalfCpltCallback, __DFSDM_Filter_HandleTypeDef::MspDeInitCallback, __DFSDM_Filter_HandleTypeDef::MspInitCallback, __DFSDM_Filter_HandleTypeDef::RegConvCpltCallback, __DFSDM_Filter_HandleTypeDef::RegConvHalfCpltCallback, and __DFSDM_Filter_HandleTypeDef::State.

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.

Parameters:

hdfsdm_filter

DFSDM filter handle.

Return values:

HAL

status.

Definition at line 1671 of file stm32l4xx_hal_dfsdm.c.

References __DFSDM_Filter_HandleTypeDef::AwdCallback, DFSDM_FILTER_ERROR_INVALID_CALLBACK, __DFSDM_Filter_HandleTypeDef::ErrorCode, HAL_DFSDM_FILTER_STATE_READY, HAL_DFSDM_FilterAwdCallback(), and __DFSDM_Filter_HandleTypeDef::State.

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.

Parameters:

hdfsdm_filter

DFSDM filter handle.

CallbackID

ID of the callback to be unregistered. This parameter can be one of the following values: HAL_DFSDM_FILTER_REGCONV_COMPLETE_CB_ID regular conversion complete callback ID. HAL_DFSDM_FILTER_REGCONV_HALFCOMPLETE_CB_ID half regular conversion complete callback ID. HAL_DFSDM_FILTER_INJCONV_COMPLETE_CB_ID injected conversion complete callback ID. HAL_DFSDM_FILTER_INJCONV_HALFCOMPLETE_CB_ID half injected conversion complete callback ID. HAL_DFSDM_FILTER_ERROR_CB_ID error callback ID. HAL_DFSDM_FILTER_MSPINIT_CB_ID MSP init callback ID. HAL_DFSDM_FILTER_MSPDEINIT_CB_ID MSP de-init callback ID.

Return values:

HAL

status.

Definition at line 1563 of file stm32l4xx_hal_dfsdm.c.

References DFSDM_FILTER_ERROR_INVALID_CALLBACK, __DFSDM_Filter_HandleTypeDef::ErrorCallback, __DFSDM_Filter_HandleTypeDef::ErrorCode, HAL_DFSDM_FILTER_ERROR_CB_ID, HAL_DFSDM_FILTER_INJCONV_COMPLETE_CB_ID, HAL_DFSDM_FILTER_INJCONV_HALFCOMPLETE_CB_ID, HAL_DFSDM_FILTER_MSPDEINIT_CB_ID, HAL_DFSDM_FILTER_MSPINIT_CB_ID, HAL_DFSDM_FILTER_REGCONV_COMPLETE_CB_ID, HAL_DFSDM_FILTER_REGCONV_HALFCOMPLETE_CB_ID, HAL_DFSDM_FILTER_STATE_READY, HAL_DFSDM_FILTER_STATE_RESET, HAL_DFSDM_FilterErrorCallback(), HAL_DFSDM_FilterInjConvCpltCallback(), HAL_DFSDM_FilterInjConvHalfCpltCallback(), HAL_DFSDM_FilterMspDeInit(), HAL_DFSDM_FilterMspInit(), HAL_DFSDM_FilterRegConvCpltCallback(), HAL_DFSDM_FilterRegConvHalfCpltCallback(), __DFSDM_Filter_HandleTypeDef::InjConvCpltCallback, __DFSDM_Filter_HandleTypeDef::InjConvHalfCpltCallback, __DFSDM_Filter_HandleTypeDef::MspDeInitCallback, __DFSDM_Filter_HandleTypeDef::MspInitCallback, __DFSDM_Filter_HandleTypeDef::RegConvCpltCallback, __DFSDM_Filter_HandleTypeDef::RegConvHalfCpltCallback, and __DFSDM_Filter_HandleTypeDef::State.

HAL_StatusTypeDef HAL_DFSDM_FilterDeInit

(

DFSDM_Filter_HandleTypeDef *

hdfsdm_filter

)

De-initializes the DFSDM filter.

Parameters:

hdfsdm_filter

DFSDM filter handle.

Return values:

HAL

status.

Definition at line 1393 of file stm32l4xx_hal_dfsdm.c.

References assert_param, HAL_DFSDM_FILTER_STATE_RESET, HAL_DFSDM_FilterMspDeInit(), __DFSDM_Filter_HandleTypeDef::Instance, __DFSDM_Filter_HandleTypeDef::MspDeInitCallback, and __DFSDM_Filter_HandleTypeDef::State.

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.

Parameters:

hdfsdm_filter

DFSDM filter handle.

Return values:

HAL

status.

Definition at line 1266 of file stm32l4xx_hal_dfsdm.c.

References assert_param, __DFSDM_Filter_HandleTypeDef::AwdCallback, DFSDM_CONTINUOUS_CONV_OFF, DFSDM_FILTER_ERROR_NONE, DFSDM_FILTER_EXT_TRIGGER, DFSDM_FILTER_SYNC_TRIGGER, DFSDM_Filter_RegularParamTypeDef::DmaMode, DFSDM_Filter_InjectedParamTypeDef::DmaMode, __DFSDM_Filter_HandleTypeDef::ErrorCallback, __DFSDM_Filter_HandleTypeDef::ErrorCode, DFSDM_Filter_InjectedParamTypeDef::ExtTrigger, DFSDM_Filter_InjectedParamTypeDef::ExtTriggerEdge, __DFSDM_Filter_HandleTypeDef::ExtTriggerEdge, DFSDM_Filter_RegularParamTypeDef::FastMode, DFSDM_Filter_InitTypeDef::FilterParam, HAL_DFSDM_FILTER_STATE_READY, HAL_DFSDM_FilterAwdCallback(), HAL_DFSDM_FilterErrorCallback(), HAL_DFSDM_FilterInjConvCpltCallback(), HAL_DFSDM_FilterInjConvHalfCpltCallback(), HAL_DFSDM_FilterMspInit(), HAL_DFSDM_FilterRegConvCpltCallback(), HAL_DFSDM_FilterRegConvHalfCpltCallback(), __DFSDM_Filter_HandleTypeDef::Init, __DFSDM_Filter_HandleTypeDef::InjConvCpltCallback, __DFSDM_Filter_HandleTypeDef::InjConvHalfCpltCallback, __DFSDM_Filter_HandleTypeDef::InjConvRemaining, __DFSDM_Filter_HandleTypeDef::InjectedChannelsNbr, DFSDM_Filter_InitTypeDef::InjectedParam, __DFSDM_Filter_HandleTypeDef::InjectedScanMode, __DFSDM_Filter_HandleTypeDef::InjectedTrigger, __DFSDM_Filter_HandleTypeDef::Instance, DFSDM_Filter_FilterParamTypeDef::IntOversampling, IS_DFSDM_FILTER_EXT_TRIG, IS_DFSDM_FILTER_EXT_TRIG_EDGE, IS_DFSDM_FILTER_INJ_TRIGGER, IS_DFSDM_FILTER_INTEGRATOR_OVS_RATIO, IS_DFSDM_FILTER_OVS_RATIO, IS_DFSDM_FILTER_REG_TRIGGER, IS_DFSDM_FILTER_SINC_ORDER, __DFSDM_Filter_HandleTypeDef::MspInitCallback, DFSDM_Filter_FilterParamTypeDef::Oversampling, __DFSDM_Filter_HandleTypeDef::RegConvCpltCallback, __DFSDM_Filter_HandleTypeDef::RegConvHalfCpltCallback, __DFSDM_Filter_HandleTypeDef::RegularContMode, DFSDM_Filter_InitTypeDef::RegularParam, __DFSDM_Filter_HandleTypeDef::RegularTrigger, DFSDM_Filter_InjectedParamTypeDef::ScanMode, DFSDM_Filter_FilterParamTypeDef::SincOrder, __DFSDM_Filter_HandleTypeDef::State, DFSDM_Filter_RegularParamTypeDef::Trigger, and DFSDM_Filter_InjectedParamTypeDef::Trigger.

void HAL_DFSDM_FilterMspDeInit

(

DFSDM_Filter_HandleTypeDef *

hdfsdm_filter

)

De-initializes the DFSDM filter MSP.

Parameters:

hdfsdm_filter

DFSDM filter handle.

Return values:

None

Definition at line 1444 of file stm32l4xx_hal_dfsdm.c.

Referenced by HAL_DFSDM_Filter_UnRegisterCallback(), and HAL_DFSDM_FilterDeInit().

void HAL_DFSDM_FilterMspInit

(

DFSDM_Filter_HandleTypeDef *

hdfsdm_filter

)

Initializes the DFSDM filter MSP.

Parameters:

hdfsdm_filter

DFSDM filter handle.

Return values:

None

Definition at line 1429 of file stm32l4xx_hal_dfsdm.c.

Referenced by HAL_DFSDM_Filter_UnRegisterCallback(), and HAL_DFSDM_FilterInit().