Initialization and deinitialization functions

Initialization and Configuration functions. More...

Collaboration diagram for Initialization and deinitialization functions:

Functions
HAL_StatusTypeDef	HAL_ETH_Init (ETH_HandleTypeDef *heth)
	Initialize the Ethernet peripheral registers. More...
HAL_StatusTypeDef	HAL_ETH_DeInit (ETH_HandleTypeDef *heth)
	DeInitializes the ETH peripheral. More...
void	HAL_ETH_MspInit (ETH_HandleTypeDef *heth)
	Initializes the ETH MSP. More...
void	HAL_ETH_MspDeInit (ETH_HandleTypeDef *heth)
	DeInitializes ETH MSP. More...
HAL_StatusTypeDef	HAL_ETH_RegisterCallback (ETH_HandleTypeDef *heth, HAL_ETH_CallbackIDTypeDef CallbackID, pETH_CallbackTypeDef pCallback)
	Register a User ETH Callback To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_ETH_UnRegisterCallback (ETH_HandleTypeDef *heth, HAL_ETH_CallbackIDTypeDef CallbackID)
	Unregister an ETH Callback ETH callback is redirected to the weak predefined callback. More...

Detailed Description

Initialization and Configuration functions.

===============================================================================
            ##### Initialization and Configuration functions #####
 ===============================================================================
    [..]  This subsection provides a set of functions allowing to initialize and
          deinitialize the ETH peripheral:

      (+) User must Implement HAL_ETH_MspInit() function in which he configures
          all related peripherals resources (CLOCK, GPIO and NVIC ).

      (+) Call the function HAL_ETH_Init() to configure the selected device with
          the selected configuration:
        (++) MAC address
        (++) Media interface (MII or RMII)
        (++) Rx DMA Descriptors Tab
        (++) Tx DMA Descriptors Tab
        (++) Length of Rx Buffers

      (+) Call the function HAL_ETH_DeInit() to restore the default configuration
          of the selected ETH peripheral.

Function Documentation

HAL_ETH_DeInit()

HAL_StatusTypeDef HAL_ETH_DeInit

(

ETH_HandleTypeDef *

heth

)

DeInitializes the ETH peripheral.

Parameters

heth	pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module

Return values

HAL

status

Definition at line 433 of file stm32f4xx_hal_eth.c.

HAL_ETH_Init()

HAL_StatusTypeDef HAL_ETH_Init

(

ETH_HandleTypeDef *

heth

)

Initialize the Ethernet peripheral registers.

Parameters

heth	pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module

Return values

HAL

status

Definition at line 336 of file stm32f4xx_hal_eth.c.

HAL_ETH_MspDeInit()

__weak void HAL_ETH_MspDeInit

(

ETH_HandleTypeDef *

heth

)

DeInitializes ETH MSP.

Parameters

heth	pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module

Return values

None

Definition at line 481 of file stm32f4xx_hal_eth.c.

HAL_ETH_MspInit()

__weak void HAL_ETH_MspInit

(

ETH_HandleTypeDef *

heth

)

Initializes the ETH MSP.

Parameters

heth	pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module

Return values

None

Definition at line 466 of file stm32f4xx_hal_eth.c.

HAL_ETH_RegisterCallback()

HAL_StatusTypeDef HAL_ETH_RegisterCallback	(	ETH_HandleTypeDef *	heth,
		HAL_ETH_CallbackIDTypeDef	CallbackID,
		pETH_CallbackTypeDef	pCallback
	)

Register a User ETH Callback To be used instead of the weak predefined callback.

Parameters

heth	eth handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_ETH_TX_COMPLETE_CB_ID Tx Complete Callback ID HAL_ETH_RX_COMPLETE_CB_ID Rx Complete Callback ID HAL_ETH_ERROR_CB_ID Error Callback ID HAL_ETH_PMT_CB_ID Power Management Callback ID HAL_ETH_WAKEUP_CB_ID Wake UP Callback ID HAL_ETH_MSPINIT_CB_ID MspInit callback ID HAL_ETH_MSPDEINIT_CB_ID MspDeInit callback ID
pCallback	pointer to the Callback function

Return values

status

Definition at line 507 of file stm32f4xx_hal_eth.c.

HAL_ETH_UnRegisterCallback()

HAL_StatusTypeDef HAL_ETH_UnRegisterCallback	(	ETH_HandleTypeDef *	heth,
		HAL_ETH_CallbackIDTypeDef	CallbackID
	)

Unregister an ETH Callback ETH callback is redirected to the weak predefined callback.

Parameters

heth

eth handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_ETH_TX_COMPLETE_CB_ID Tx Complete Callback ID HAL_ETH_RX_COMPLETE_CB_ID Rx Complete Callback ID HAL_ETH_ERROR_CB_ID Error Callback ID HAL_ETH_PMT_CB_ID Power Management Callback ID HAL_ETH_WAKEUP_CB_ID Wake UP Callback ID HAL_ETH_MSPINIT_CB_ID MspInit callback ID HAL_ETH_MSPDEINIT_CB_ID MspDeInit callback ID

Return values

status

Definition at line 606 of file stm32f4xx_hal_eth.c.