Initialization and Configuration functions. More...

Functions
HAL_StatusTypeDef	HAL_ETH_Init (ETH_HandleTypeDef *heth)
	Initializes the Ethernet MAC and DMA according to default parameters.
HAL_StatusTypeDef	HAL_ETH_DeInit (ETH_HandleTypeDef *heth)
	De-Initializes the ETH peripheral.
HAL_StatusTypeDef	HAL_ETH_DMATxDescListInit (ETH_HandleTypeDef heth, ETH_DMADescTypeDef DMATxDescTab, uint8_t *TxBuff, uint32_t TxBuffCount)
	Initializes the DMA Tx descriptors in chain mode.
HAL_StatusTypeDef	HAL_ETH_DMARxDescListInit (ETH_HandleTypeDef heth, ETH_DMADescTypeDef DMARxDescTab, uint8_t *RxBuff, uint32_t RxBuffCount)
	Initializes the DMA Rx descriptors in chain mode.
__weak void	HAL_ETH_MspInit (ETH_HandleTypeDef *heth)
	Initializes the ETH MSP.
__weak void	HAL_ETH_MspDeInit (ETH_HandleTypeDef *heth)
	DeInitializes ETH MSP.
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.
HAL_StatusTypeDef	HAL_ETH_UnRegisterCallback (ETH_HandleTypeDef *heth, HAL_ETH_CallbackIDTypeDef CallbackID)
	Unregister an ETH Callback ETH callabck is redirected to the weak predefined callback.

Detailed Description

Initialization and Configuration functions.

  ===============================================================================
            ##### Initialization and de-initialization functions #####
  ===============================================================================
  [..]  This section provides functions allowing to:
      (+) Initialize and configure the Ethernet peripheral
      (+) De-initialize the Ethernet peripheral

Function Documentation

HAL_StatusTypeDef HAL_ETH_DeInit ( ETH_HandleTypeDef * heth )

De-Initializes 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 497 of file stm32f4xx_hal_eth.c.

References HAL_ETH_MspDeInit(), HAL_ETH_STATE_BUSY, HAL_ETH_STATE_RESET, __ETH_HandleTypeDef::MspDeInitCallback, and __ETH_HandleTypeDef::State.

HAL_StatusTypeDef HAL_ETH_DMARxDescListInit	(	ETH_HandleTypeDef *	heth,
		ETH_DMADescTypeDef *	DMARxDescTab,
		uint8_t *	RxBuff,
		uint32_t	RxBuffCount
	)

Initializes the DMA Rx descriptors in chain mode.

Parameters:

heth	pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
DMARxDescTab	Pointer to the first Rx desc list
RxBuff	Pointer to the first RxBuffer list
RxBuffCount	Number of the used Rx desc in the list

Return values:

HAL status

Definition at line 600 of file stm32f4xx_hal_eth.c.

References ETH_DMADescTypeDef::Buffer1Addr, ETH_DMADescTypeDef::Buffer2NextDescAddr, ETH_DMADescTypeDef::ControlBufferSize, ETH_DMARXDESC_DIC, ETH_DMARXDESC_OWN, ETH_DMARXDESC_RCH, ETH_RX_BUF_SIZE, ETH_RXINTERRUPT_MODE, HAL_ETH_STATE_BUSY, HAL_ETH_STATE_READY, __ETH_HandleTypeDef::Init, __ETH_HandleTypeDef::Instance, __ETH_HandleTypeDef::RxDesc, __ETH_HandleTypeDef::State, and ETH_DMADescTypeDef::Status.

HAL_StatusTypeDef HAL_ETH_DMATxDescListInit	(	ETH_HandleTypeDef *	heth,
		ETH_DMADescTypeDef *	DMATxDescTab,
		uint8_t *	TxBuff,
		uint32_t	TxBuffCount
	)

Initializes the DMA Tx descriptors in chain mode.

Parameters:

heth	pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
DMATxDescTab	Pointer to the first Tx desc list
TxBuff	Pointer to the first TxBuffer list
TxBuffCount	Number of the used Tx desc in the list

Return values:

HAL status

Definition at line 533 of file stm32f4xx_hal_eth.c.

References ETH_DMADescTypeDef::Buffer1Addr, ETH_DMADescTypeDef::Buffer2NextDescAddr, ETH_CHECKSUM_BY_HARDWARE, ETH_DMATXDESC_CHECKSUMTCPUDPICMPFULL, ETH_DMATXDESC_TCH, ETH_TX_BUF_SIZE, HAL_ETH_STATE_BUSY, HAL_ETH_STATE_READY, __ETH_HandleTypeDef::Init, __ETH_HandleTypeDef::Instance, __ETH_HandleTypeDef::State, ETH_DMADescTypeDef::Status, and __ETH_HandleTypeDef::TxDesc.

HAL_StatusTypeDef HAL_ETH_Init ( ETH_HandleTypeDef * heth )

Initializes the Ethernet MAC and DMA according to default parameters.

Parameters:

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

Return values:

HAL status

Definition at line 213 of file stm32f4xx_hal_eth.c.

References __HAL_RCC_SYSCFG_CLK_ENABLE, assert_param, ETH_InitTypeDef::AutoNegotiation, ETH_InitTypeDef::ChecksumMode, ETH_InitTypeDef::DuplexMode, ETH_AUTONEGOTIATION_DISABLE, ETH_ERROR, ETH_InitCallbacksToDefault(), ETH_MACDMAConfig(), ETH_MACMIIAR_CR_MASK, ETH_MODE_FULLDUPLEX, ETH_MODE_HALFDUPLEX, ETH_SPEED_100M, ETH_SPEED_10M, ETH_SUCCESS, ETH_TIMEOUT_AUTONEGO_COMPLETED, ETH_TIMEOUT_LINKED_STATE, ETH_TIMEOUT_SWRESET, HAL_Delay(), HAL_ETH_MspInit(), HAL_ETH_ReadPHYRegister(), HAL_ETH_STATE_READY, HAL_ETH_STATE_RESET, HAL_ETH_STATE_TIMEOUT, HAL_ETH_WritePHYRegister(), HAL_GetTick(), HAL_RCC_GetHCLKFreq(), __ETH_HandleTypeDef::Init, __ETH_HandleTypeDef::Instance, IS_ETH_AUTONEGOTIATION, IS_ETH_CHECKSUM_MODE, IS_ETH_DUPLEX_MODE, IS_ETH_MEDIA_INTERFACE, IS_ETH_RX_MODE, IS_ETH_SPEED, __ETH_HandleTypeDef::Lock, ETH_InitTypeDef::MediaInterface, __ETH_HandleTypeDef::MspInitCallback, PHY_AUTONEGO_COMPLETE, PHY_AUTONEGOTIATION, PHY_BCR, PHY_BSR, PHY_CONFIG_DELAY, PHY_DUPLEX_STATUS, PHY_LINKED_STATUS, PHY_RESET, PHY_RESET_DELAY, PHY_SPEED_STATUS, PHY_SR, ETH_InitTypeDef::RxMode, ETH_InitTypeDef::Speed, and __ETH_HandleTypeDef::State.

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 682 of file stm32f4xx_hal_eth.c.

Referenced by HAL_ETH_DeInit(), and HAL_ETH_UnRegisterCallback().

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 667 of file stm32f4xx_hal_eth.c.

Referenced by HAL_ETH_Init(), and HAL_ETH_UnRegisterCallback().

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_DMA_ERROR_CB_ID DMA Error 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 706 of file stm32f4xx_hal_eth.c.

References __ETH_HandleTypeDef::DMAErrorCallback, HAL_ETH_DMA_ERROR_CB_ID, HAL_ETH_MSPDEINIT_CB_ID, HAL_ETH_MSPINIT_CB_ID, HAL_ETH_RX_COMPLETE_CB_ID, HAL_ETH_STATE_READY, HAL_ETH_STATE_RESET, HAL_ETH_TX_COMPLETE_CB_ID, __ETH_HandleTypeDef::MspDeInitCallback, __ETH_HandleTypeDef::MspInitCallback, __ETH_HandleTypeDef::RxCpltCallback, __ETH_HandleTypeDef::State, and __ETH_HandleTypeDef::TxCpltCallback.

HAL_StatusTypeDef HAL_ETH_UnRegisterCallback	(	ETH_HandleTypeDef *	heth,
		HAL_ETH_CallbackIDTypeDef	CallbackID
	)

Unregister an ETH Callback ETH callabck 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_DMA_ERROR_CB_ID DMA Error Callback ID HAL_ETH_MSPINIT_CB_ID MspInit callback ID HAL_ETH_MSPDEINIT_CB_ID MspDeInit callback ID

Return values:

status

Definition at line 790 of file stm32f4xx_hal_eth.c.

References __ETH_HandleTypeDef::DMAErrorCallback, HAL_ETH_DMA_ERROR_CB_ID, HAL_ETH_ErrorCallback(), HAL_ETH_MspDeInit(), HAL_ETH_MSPDEINIT_CB_ID, HAL_ETH_MspInit(), HAL_ETH_MSPINIT_CB_ID, HAL_ETH_RX_COMPLETE_CB_ID, HAL_ETH_RxCpltCallback(), HAL_ETH_STATE_READY, HAL_ETH_STATE_RESET, HAL_ETH_TX_COMPLETE_CB_ID, HAL_ETH_TxCpltCallback(), __ETH_HandleTypeDef::MspDeInitCallback, __ETH_HandleTypeDef::MspInitCallback, __ETH_HandleTypeDef::RxCpltCallback, __ETH_HandleTypeDef::State, and __ETH_HandleTypeDef::TxCpltCallback.

Functions

Detailed Description

Function Documentation