Initialization and de-initialization functions

Initialization and Configuration functions. More...

Functions
HAL_StatusTypeDef	HAL_FMAC_Init (FMAC_HandleTypeDef *hfmac)
	Initialize the FMAC peripheral and the associated handle.
HAL_StatusTypeDef	HAL_FMAC_DeInit (FMAC_HandleTypeDef *hfmac)
	De-initialize the FMAC peripheral.
__weak void	HAL_FMAC_MspInit (FMAC_HandleTypeDef *hfmac)
	Initialize the FMAC MSP.
__weak void	HAL_FMAC_MspDeInit (FMAC_HandleTypeDef *hfmac)
	De-initialize the FMAC MSP.
HAL_StatusTypeDef	HAL_FMAC_RegisterCallback (FMAC_HandleTypeDef *hfmac, HAL_FMAC_CallbackIDTypeDef CallbackID, pFMAC_CallbackTypeDef pCallback)
	Register a User FMAC Callback.
HAL_StatusTypeDef	HAL_FMAC_UnRegisterCallback (FMAC_HandleTypeDef *hfmac, HAL_FMAC_CallbackIDTypeDef CallbackID)
	Unregister a FMAC CallBack.

---

Detailed Description

Initialization and Configuration functions.

 ===============================================================================
     #####       Initialization and de-initialization functions       #####
 ===============================================================================
    [..] This section provides functions allowing to:
      (+) Initialize the FMAC peripheral and the associated handle
      (+) DeInitialize the FMAC peripheral
      (+) Initialize the FMAC MSP (MCU Specific Package)
      (+) De-Initialize the FMAC MSP
      (+) Register a User FMAC Callback
      (+) Unregister a FMAC CallBack

    [..]

---

Function Documentation

HAL_StatusTypeDef HAL_FMAC_DeInit

(

FMAC_HandleTypeDef *

hfmac

)

De-initialize the FMAC peripheral.

Parameters:

hfmac

pointer to a FMAC structure.

Return values:

HAL_StatusTypeDef

HAL status

Definition at line 455 of file stm32h7xx_hal_fmac.c.

References assert_param, __FMAC_HandleTypeDef::ErrorCode, __FMAC_HandleTypeDef::FilterParam, FMAC_ResetDataPointers(), HAL_FMAC_ERROR_NONE, HAL_FMAC_MspDeInit(), HAL_FMAC_STATE_BUSY, HAL_FMAC_STATE_RESET, __FMAC_HandleTypeDef::Instance, __FMAC_HandleTypeDef::MspDeInitCallback, and __FMAC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_FMAC_Init

(

FMAC_HandleTypeDef *

hfmac

)

Initialize the FMAC peripheral and the associated handle.

Parameters:

hfmac

pointer to a FMAC_HandleTypeDef structure.

Return values:

HAL_StatusTypeDef

HAL status

Definition at line 382 of file stm32h7xx_hal_fmac.c.

References assert_param, __FMAC_HandleTypeDef::ErrorCallback, __FMAC_HandleTypeDef::ErrorCode, __FMAC_HandleTypeDef::FilterConfigCallback, __FMAC_HandleTypeDef::FilterParam, __FMAC_HandleTypeDef::FilterPreloadCallback, FMAC_Reset(), FMAC_ResetDataPointers(), __FMAC_HandleTypeDef::GetDataCallback, HAL_FMAC_ERROR_NONE, HAL_FMAC_ERROR_RESET, HAL_FMAC_ErrorCallback(), HAL_FMAC_FilterConfigCallback(), HAL_FMAC_FilterPreloadCallback(), HAL_FMAC_GetDataCallback(), HAL_FMAC_HalfGetDataCallback(), HAL_FMAC_HalfOutputDataReadyCallback(), HAL_FMAC_MspInit(), HAL_FMAC_OutputDataReadyCallback(), HAL_FMAC_STATE_READY, HAL_FMAC_STATE_RESET, HAL_FMAC_STATE_TIMEOUT, __FMAC_HandleTypeDef::HalfGetDataCallback, __FMAC_HandleTypeDef::HalfOutputDataReadyCallback, __FMAC_HandleTypeDef::Instance, __FMAC_HandleTypeDef::Lock, __FMAC_HandleTypeDef::MspInitCallback, __FMAC_HandleTypeDef::OutputDataReadyCallback, and __FMAC_HandleTypeDef::State.

void HAL_FMAC_MspDeInit

(

FMAC_HandleTypeDef *

hfmac

)

De-initialize the FMAC MSP.

Parameters:

hfmac

FMAC handle.

Return values:

None

Definition at line 517 of file stm32h7xx_hal_fmac.c.

Referenced by HAL_FMAC_DeInit(), and HAL_FMAC_UnRegisterCallback().

void HAL_FMAC_MspInit

(

FMAC_HandleTypeDef *

hfmac

)

Initialize the FMAC MSP.

Parameters:

hfmac

FMAC handle.

Return values:

None

Definition at line 502 of file stm32h7xx_hal_fmac.c.

Referenced by HAL_FMAC_Init(), and HAL_FMAC_UnRegisterCallback().

HAL_StatusTypeDef HAL_FMAC_RegisterCallback	(	FMAC_HandleTypeDef *	hfmac,
		HAL_FMAC_CallbackIDTypeDef	CallbackID,
		pFMAC_CallbackTypeDef	pCallback
	)

Register a User FMAC Callback.

Note:

The User FMAC Callback is to be used instead of the weak predefined callback.

Parameters:

hfmac	pointer to a FMAC_HandleTypeDef structure that contains the configuration information for FMAC module.
CallbackID	ID of the callback to be registered. This parameter can be one of the following values: HAL_FMAC_ERROR_CB_ID Error Callback ID HAL_FMAC_HALF_GET_DATA_CB_ID Get Half Data Callback ID HAL_FMAC_GET_DATA_CB_ID Get Data Callback ID HAL_FMAC_HALF_OUTPUT_DATA_READY_CB_ID Half Output Data Ready Callback ID HAL_FMAC_OUTPUT_DATA_READY_CB_ID Output Data Ready Callback ID HAL_FMAC_FILTER_CONFIG_CB_ID Filter Configuration Callback ID HAL_FMAC_FILTER_PRELOAD_CB_ID Filter Preload Callback ID HAL_FMAC_MSPINIT_CB_ID FMAC MspInit ID HAL_FMAC_MSPDEINIT_CB_ID FMAC MspDeInit ID
pCallback	pointer to the Callback function.

Return values:

HAL_StatusTypeDef

HAL status

Definition at line 547 of file stm32h7xx_hal_fmac.c.

References __FMAC_HandleTypeDef::ErrorCallback, __FMAC_HandleTypeDef::ErrorCode, __FMAC_HandleTypeDef::FilterConfigCallback, __FMAC_HandleTypeDef::FilterPreloadCallback, __FMAC_HandleTypeDef::GetDataCallback, HAL_FMAC_ERROR_CB_ID, HAL_FMAC_ERROR_INVALID_CALLBACK, HAL_FMAC_FILTER_CONFIG_CB_ID, HAL_FMAC_FILTER_PRELOAD_CB_ID, HAL_FMAC_GET_DATA_CB_ID, HAL_FMAC_HALF_GET_DATA_CB_ID, HAL_FMAC_HALF_OUTPUT_DATA_READY_CB_ID, HAL_FMAC_MSPDEINIT_CB_ID, HAL_FMAC_MSPINIT_CB_ID, HAL_FMAC_OUTPUT_DATA_READY_CB_ID, HAL_FMAC_STATE_READY, HAL_FMAC_STATE_RESET, __FMAC_HandleTypeDef::HalfGetDataCallback, __FMAC_HandleTypeDef::HalfOutputDataReadyCallback, __FMAC_HandleTypeDef::MspDeInitCallback, __FMAC_HandleTypeDef::MspInitCallback, __FMAC_HandleTypeDef::OutputDataReadyCallback, and __FMAC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_FMAC_UnRegisterCallback	(	FMAC_HandleTypeDef *	hfmac,
		HAL_FMAC_CallbackIDTypeDef	CallbackID
	)

Unregister a FMAC CallBack.

Note:

The FMAC callback is redirected to the weak predefined callback.

Parameters:

hfmac

pointer to a FMAC_HandleTypeDef structure that contains the configuration information for FMAC module

CallbackID

ID of the callback to be unregistered. This parameter can be one of the following values: HAL_FMAC_ERROR_CB_ID Error Callback ID HAL_FMAC_HALF_GET_DATA_CB_ID Get Half Data Callback ID HAL_FMAC_GET_DATA_CB_ID Get Data Callback ID HAL_FMAC_HALF_OUTPUT_DATA_READY_CB_ID Half Output Data Ready Callback ID HAL_FMAC_OUTPUT_DATA_READY_CB_ID Output Data Ready Callback ID HAL_FMAC_FILTER_CONFIG_CB_ID Filter Configuration Callback ID HAL_FMAC_FILTER_PRELOAD_CB_ID Filter Preload Callback ID HAL_FMAC_MSPINIT_CB_ID FMAC MspInit ID HAL_FMAC_MSPDEINIT_CB_ID FMAC MspDeInit ID

Return values:

HAL_StatusTypeDef

HAL status

Definition at line 669 of file stm32h7xx_hal_fmac.c.

References __FMAC_HandleTypeDef::ErrorCallback, __FMAC_HandleTypeDef::ErrorCode, __FMAC_HandleTypeDef::FilterConfigCallback, __FMAC_HandleTypeDef::FilterPreloadCallback, __FMAC_HandleTypeDef::GetDataCallback, HAL_FMAC_ERROR_CB_ID, HAL_FMAC_ERROR_INVALID_CALLBACK, HAL_FMAC_ErrorCallback(), HAL_FMAC_FILTER_CONFIG_CB_ID, HAL_FMAC_FILTER_PRELOAD_CB_ID, HAL_FMAC_FilterConfigCallback(), HAL_FMAC_FilterPreloadCallback(), HAL_FMAC_GET_DATA_CB_ID, HAL_FMAC_GetDataCallback(), HAL_FMAC_HALF_GET_DATA_CB_ID, HAL_FMAC_HALF_OUTPUT_DATA_READY_CB_ID, HAL_FMAC_HalfGetDataCallback(), HAL_FMAC_HalfOutputDataReadyCallback(), HAL_FMAC_MspDeInit(), HAL_FMAC_MSPDEINIT_CB_ID, HAL_FMAC_MspInit(), HAL_FMAC_MSPINIT_CB_ID, HAL_FMAC_OUTPUT_DATA_READY_CB_ID, HAL_FMAC_OutputDataReadyCallback(), HAL_FMAC_STATE_READY, HAL_FMAC_STATE_RESET, __FMAC_HandleTypeDef::HalfGetDataCallback, __FMAC_HandleTypeDef::HalfOutputDataReadyCallback, __FMAC_HandleTypeDef::MspDeInitCallback, __FMAC_HandleTypeDef::MspInitCallback, __FMAC_HandleTypeDef::OutputDataReadyCallback, and __FMAC_HandleTypeDef::State.