ETH Handle Structure definition. More...

#include <stm32f4xx_hal_eth.h>

Collaboration diagram for ETH_HandleTypeDef:

Data Fields
ETH_TypeDef *	Instance

ETH_InitTypeDef	Init

ETH_TxDescListTypeDef	TxDescList

ETH_RxDescListTypeDef	RxDescList

__IO HAL_ETH_StateTypeDef	gState

__IO uint32_t	ErrorCode

__IO uint32_t	DMAErrorCode

__IO uint32_t	MACErrorCode

__IO uint32_t	MACWakeUpEvent

__IO uint32_t	MACLPIEvent

__IO uint32_t	IsPtpConfigured

pETH_rxAllocateCallbackTypeDef	rxAllocateCallback

pETH_rxLinkCallbackTypeDef	rxLinkCallback

pETH_txFreeCallbackTypeDef	txFreeCallback

pETH_txPtpCallbackTypeDef	txPtpCallback

Detailed Description

ETH Handle Structure definition.

Definition at line 525 of file stm32f4xx_hal_eth.h.

Field Documentation

◆ Instance

ETH_TypeDef* ETH_HandleTypeDef::Instance

◆ Init

ETH_InitTypeDef ETH_HandleTypeDef::Init

Ethernet Init Configuration

Definition at line 530 of file stm32f4xx_hal_eth.h.

Referenced by ETH_DMARxDescListInit(), ETH_DMATxDescListInit(), ETH_UpdateDescriptor(), HAL_ETH_Init(), and HAL_ETH_ReleaseTxPacket().

◆ TxDescList

ETH_TxDescListTypeDef ETH_HandleTypeDef::TxDescList

Tx descriptor wrapper: holds all Tx descriptors list addresses and current descriptor index

Definition at line 532 of file stm32f4xx_hal_eth.h.

Referenced by ETH_DMATxDescListInit(), ETH_Prepare_Tx_Descriptors(), HAL_ETH_ReleaseTxPacket(), HAL_ETH_Transmit(), and HAL_ETH_Transmit_IT().

◆ RxDescList

ETH_RxDescListTypeDef ETH_HandleTypeDef::RxDescList

Rx descriptor wrapper: holds all Rx descriptors list addresses and current descriptor index

Definition at line 535 of file stm32f4xx_hal_eth.h.

Referenced by ETH_DMARxDescListInit(), ETH_UpdateDescriptor(), HAL_ETH_GetRxDataErrorCode(), HAL_ETH_ReadData(), HAL_ETH_Start(), HAL_ETH_Start_IT(), and HAL_ETH_Stop_IT().

◆ gState

__IO HAL_ETH_StateTypeDef ETH_HandleTypeDef::gState

ETH state information related to global Handle management and also related to Tx operations. This parameter can be a value of ETH States

Definition at line 542 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_DeInit(), HAL_ETH_GetState(), HAL_ETH_Init(), HAL_ETH_IRQHandler(), HAL_ETH_ReadData(), HAL_ETH_SetDMAConfig(), HAL_ETH_SetMACConfig(), HAL_ETH_Start(), HAL_ETH_Start_IT(), HAL_ETH_Stop(), HAL_ETH_Stop_IT(), HAL_ETH_Transmit(), and HAL_ETH_Transmit_IT().

◆ ErrorCode

__IO uint32_t ETH_HandleTypeDef::ErrorCode

Holds the global Error code of the ETH HAL status machine This parameter can be a value of ETH Error Code.

Definition at line 546 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_GetError(), HAL_ETH_Init(), HAL_ETH_IRQHandler(), HAL_ETH_ReadData(), HAL_ETH_Transmit(), and HAL_ETH_Transmit_IT().

◆ DMAErrorCode

__IO uint32_t ETH_HandleTypeDef::DMAErrorCode

Holds the DMA Rx Tx Error code when a DMA AIS interrupt occurs This parameter can be a combination of ETH DMA Status Flags

Definition at line 550 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_GetDMAError(), HAL_ETH_IRQHandler(), and HAL_ETH_Transmit().

◆ MACErrorCode

__IO uint32_t ETH_HandleTypeDef::MACErrorCode

Holds the MAC Rx Tx Error code when a MAC Rx or Tx status interrupt occurs This parameter can be a combination of ETH_MAC_Rx_Tx_Status

Definition at line 555 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_GetMACError().

◆ MACWakeUpEvent

__IO uint32_t ETH_HandleTypeDef::MACWakeUpEvent

Holds the Wake Up event when the MAC exit the power down mode This parameter can be a value of ETH MAC Wake Up Event

Definition at line 559 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_GetMACWakeUpSource(), and HAL_ETH_IRQHandler().

◆ MACLPIEvent

__IO uint32_t ETH_HandleTypeDef::MACLPIEvent

Holds the LPI event when the an LPI status interrupt occurs. This parameter can be a value of ETHEx_LPI_Event

Definition at line 563 of file stm32f4xx_hal_eth.h.

◆ IsPtpConfigured

__IO uint32_t ETH_HandleTypeDef::IsPtpConfigured

Holds the PTP configuration status. This parameter can be a value of ETH PTP Config Status

Definition at line 566 of file stm32f4xx_hal_eth.h.

◆ rxAllocateCallback

pETH_rxAllocateCallbackTypeDef ETH_HandleTypeDef::rxAllocateCallback

ETH Rx Get Buffer Function

Definition at line 583 of file stm32f4xx_hal_eth.h.

Referenced by ETH_UpdateDescriptor(), HAL_ETH_RegisterRxAllocateCallback(), and HAL_ETH_UnRegisterRxAllocateCallback().

◆ rxLinkCallback

pETH_rxLinkCallbackTypeDef ETH_HandleTypeDef::rxLinkCallback

ETH Rx Set App Data Function

Definition at line 584 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_ReadData(), HAL_ETH_RegisterRxLinkCallback(), and HAL_ETH_UnRegisterRxLinkCallback().

◆ txFreeCallback

pETH_txFreeCallbackTypeDef ETH_HandleTypeDef::txFreeCallback

ETH Tx Free Function

Definition at line 585 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_RegisterTxFreeCallback(), HAL_ETH_ReleaseTxPacket(), and HAL_ETH_UnRegisterTxFreeCallback().

◆ txPtpCallback

pETH_txPtpCallbackTypeDef ETH_HandleTypeDef::txPtpCallback

ETH Tx Handle Ptp Function

Definition at line 586 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_ReleaseTxPacket().

The documentation for this struct was generated from the following file:

stm32f4xx_hal_eth.h

Data Fields