STM32H735xx HAL User Manual
Functions
Peripheral Control functions
ETH Exported Functions

ETH control functions. More...

Functions

HAL_StatusTypeDef HAL_ETH_GetMACConfig (ETH_HandleTypeDef *heth, ETH_MACConfigTypeDef *macconf)
 Get the configuration of the MAC and MTL subsystems.
HAL_StatusTypeDef HAL_ETH_GetDMAConfig (ETH_HandleTypeDef *heth, ETH_DMAConfigTypeDef *dmaconf)
 Get the configuration of the DMA.
HAL_StatusTypeDef HAL_ETH_SetMACConfig (ETH_HandleTypeDef *heth, ETH_MACConfigTypeDef *macconf)
 Set the MAC configuration.
HAL_StatusTypeDef HAL_ETH_SetDMAConfig (ETH_HandleTypeDef *heth, ETH_DMAConfigTypeDef *dmaconf)
 Set the ETH DMA configuration.
void HAL_ETH_SetMDIOClockRange (ETH_HandleTypeDef *heth)
 Configures the Clock range of ETH MDIO interface.
HAL_StatusTypeDef HAL_ETH_SetMACFilterConfig (ETH_HandleTypeDef *heth, ETH_MACFilterConfigTypeDef *pFilterConfig)
 Set the ETH MAC (L2) Filters configuration.
HAL_StatusTypeDef HAL_ETH_GetMACFilterConfig (ETH_HandleTypeDef *heth, ETH_MACFilterConfigTypeDef *pFilterConfig)
 Get the ETH MAC (L2) Filters configuration.
HAL_StatusTypeDef HAL_ETH_SetSourceMACAddrMatch (ETH_HandleTypeDef *heth, uint32_t AddrNbr, uint8_t *pMACAddr)
 Set the source MAC Address to be matched.
HAL_StatusTypeDef HAL_ETH_SetHashTable (ETH_HandleTypeDef *heth, uint32_t *pHashTable)
 Set the ETH Hash Table Value.
void HAL_ETH_SetRxVLANIdentifier (ETH_HandleTypeDef *heth, uint32_t ComparisonBits, uint32_t VLANIdentifier)
 Set the VLAN Identifier for Rx packets.
void HAL_ETH_EnterPowerDownMode (ETH_HandleTypeDef *heth, ETH_PowerDownConfigTypeDef *pPowerDownConfig)
 Enters the Power down mode.
void HAL_ETH_ExitPowerDownMode (ETH_HandleTypeDef *heth)
 Exits from the Power down mode.
HAL_StatusTypeDef HAL_ETH_SetWakeUpFilter (ETH_HandleTypeDef *heth, uint32_t *pFilter, uint32_t Count)
 Set the WakeUp filter.

Detailed Description

ETH control functions.

  ==============================================================================
                      ##### Peripheral Control functions #####
  ==============================================================================
  [..]
    This subsection provides a set of functions allowing to control the ETH
    peripheral.


Function Documentation

void HAL_ETH_EnterPowerDownMode ( ETH_HandleTypeDef heth,
ETH_PowerDownConfigTypeDef pPowerDownConfig 
)

Enters the Power down mode.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
pPowerDownConfig,:a pointer to ETH_PowerDownConfigTypeDef structure that contains the Power Down configuration
Return values:
None.

Definition at line 2247 of file stm32h7xx_hal_eth.c.

References __HAL_ETH_MAC_ENABLE_IT, ETH_MACPCSR_MASK, ETH_PowerDownConfigTypeDef::GlobalUnicast, __ETH_HandleTypeDef::Instance, ETH_PowerDownConfigTypeDef::MagicPacket, ETH_PowerDownConfigTypeDef::WakeUpForward, and ETH_PowerDownConfigTypeDef::WakeUpPacket.

Exits from the Power down mode.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
Return values:
None.

Definition at line 2269 of file stm32h7xx_hal_eth.c.

References __HAL_ETH_MAC_DISABLE_IT, and __ETH_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_ETH_GetDMAConfig ( ETH_HandleTypeDef heth,
ETH_DMAConfigTypeDef dmaconf 
)

Get the configuration of the DMA.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
dmaconf,:pointer to a ETH_DMAConfigTypeDef structure that will hold the configuration of the ETH DMA.
Return values:
HALStatus

Definition at line 1963 of file stm32h7xx_hal_eth.c.

References ETH_DMAConfigTypeDef::AddressAlignedBeats, ETH_DMAConfigTypeDef::BurstMode, ETH_DMAConfigTypeDef::DMAArbitration, ETH_DMAConfigTypeDef::FlushRxPacket, __ETH_HandleTypeDef::Instance, ETH_DMAConfigTypeDef::MaximumSegmentSize, ETH_DMAConfigTypeDef::PBLx8Mode, ETH_DMAConfigTypeDef::RebuildINCRxBurst, ETH_DMAConfigTypeDef::RxDMABurstLength, ETH_DMAConfigTypeDef::SecondPacketOperate, ETH_DMAConfigTypeDef::TCPSegmentation, and ETH_DMAConfigTypeDef::TxDMABurstLength.

HAL_StatusTypeDef HAL_ETH_GetMACConfig ( ETH_HandleTypeDef heth,
ETH_MACConfigTypeDef macconf 
)

Get the configuration of the MAC and MTL subsystems.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
macconf,:pointer to a ETH_MACConfigTypeDef structure that will hold the configuration of the MAC.
Return values:
HALStatus

Definition at line 1896 of file stm32h7xx_hal_eth.c.

References ETH_MACConfigTypeDef::AutomaticPadCRCStrip, ETH_MACConfigTypeDef::BackOffLimit, ETH_MACConfigTypeDef::CarrierSenseBeforeTransmit, ETH_MACConfigTypeDef::CarrierSenseDuringTransmit, ETH_MACConfigTypeDef::ChecksumOffload, ETH_MACConfigTypeDef::CRCCheckingRxPackets, ETH_MACConfigTypeDef::CRCStripTypePacket, ETH_MACConfigTypeDef::DeferralCheck, ETH_MACConfigTypeDef::DropTCPIPChecksumErrorPacket, ETH_MACConfigTypeDef::DuplexMode, ETH_MACConfigTypeDef::ExtendedInterPacketGap, ETH_MACConfigTypeDef::ExtendedInterPacketGapVal, ETH_MACConfigTypeDef::ForwardRxErrorPacket, ETH_MACConfigTypeDef::ForwardRxUndersizedGoodPacket, ETH_MACConfigTypeDef::GiantPacketSizeLimit, ETH_MACConfigTypeDef::GiantPacketSizeLimitControl, __ETH_HandleTypeDef::Instance, ETH_MACConfigTypeDef::InterPacketGapVal, ETH_MACConfigTypeDef::Jabber, ETH_MACConfigTypeDef::JumboPacket, ETH_MACConfigTypeDef::LoopbackMode, ETH_MACConfigTypeDef::PauseLowThreshold, ETH_MACConfigTypeDef::PauseTime, ETH_MACConfigTypeDef::PreambleLength, ETH_MACConfigTypeDef::ProgrammableWatchdog, ETH_MACConfigTypeDef::ReceiveFlowControl, ETH_MACConfigTypeDef::ReceiveOwn, ETH_MACConfigTypeDef::ReceiveQueueMode, ETH_MACConfigTypeDef::RetryTransmission, ETH_MACConfigTypeDef::SlowProtocolDetect, ETH_MACConfigTypeDef::SourceAddrControl, ETH_MACConfigTypeDef::Speed, ETH_MACConfigTypeDef::Support2KPacket, ETH_MACConfigTypeDef::TransmitFlowControl, ETH_MACConfigTypeDef::TransmitQueueMode, ETH_MACConfigTypeDef::UnicastPausePacketDetect, ETH_MACConfigTypeDef::UnicastSlowProtocolPacketDetect, ETH_MACConfigTypeDef::Watchdog, ETH_MACConfigTypeDef::WatchdogTimeout, and ETH_MACConfigTypeDef::ZeroQuantaPause.

HAL_StatusTypeDef HAL_ETH_GetMACFilterConfig ( ETH_HandleTypeDef heth,
ETH_MACFilterConfigTypeDef pFilterConfig 
)
HAL_StatusTypeDef HAL_ETH_SetDMAConfig ( ETH_HandleTypeDef heth,
ETH_DMAConfigTypeDef dmaconf 
)

Set the ETH DMA configuration.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
dmaconf,:pointer to a ETH_DMAConfigTypeDef structure that will hold the configuration of the ETH DMA.
Return values:
HALstatus

Definition at line 2024 of file stm32h7xx_hal_eth.c.

References ETH_SetDMAConfig(), HAL_ETH_STATE_READY, and __ETH_HandleTypeDef::RxState.

HAL_StatusTypeDef HAL_ETH_SetHashTable ( ETH_HandleTypeDef heth,
uint32_t *  pHashTable 
)

Set the ETH Hash Table Value.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
pHashTable,:pointer to a table of two 32 bit values, that contains the 64 bits of the hash table.
Return values:
HALstatus

Definition at line 2203 of file stm32h7xx_hal_eth.c.

References __ETH_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_ETH_SetMACConfig ( ETH_HandleTypeDef heth,
ETH_MACConfigTypeDef macconf 
)

Set the MAC configuration.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
macconf,:pointer to a ETH_MACConfigTypeDef structure that contains the configuration of the MAC.
Return values:
HALstatus

Definition at line 1997 of file stm32h7xx_hal_eth.c.

References ETH_SetMACConfig(), HAL_ETH_STATE_READY, and __ETH_HandleTypeDef::RxState.

HAL_StatusTypeDef HAL_ETH_SetMACFilterConfig ( ETH_HandleTypeDef heth,
ETH_MACFilterConfigTypeDef pFilterConfig 
)

Configures the Clock range of ETH MDIO interface.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
Return values:
None

Definition at line 2049 of file stm32h7xx_hal_eth.c.

References HAL_RCC_GetHCLKFreq(), and __ETH_HandleTypeDef::Instance.

void HAL_ETH_SetRxVLANIdentifier ( ETH_HandleTypeDef heth,
uint32_t  ComparisonBits,
uint32_t  VLANIdentifier 
)

Set the VLAN Identifier for Rx packets.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
ComparisonBits,:12 or 16 bit comparison mode must be a value of ETH VLAN Tag Comparison
VLANIdentifier,:VLAN Identifier value
Return values:
None

Definition at line 2225 of file stm32h7xx_hal_eth.c.

References ETH_VLANTAGCOMPARISON_16BIT, and __ETH_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_ETH_SetSourceMACAddrMatch ( ETH_HandleTypeDef heth,
uint32_t  AddrNbr,
uint8_t *  pMACAddr 
)

Set the source MAC Address to be matched.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
AddrNbr,:The MAC address to configure This parameter must be a value of the following: ETH_MAC_ADDRESS1 ETH_MAC_ADDRESS2 ETH_MAC_ADDRESS3
pMACAddr,:Pointer to MAC address buffer data (6 bytes)
Return values:
HALstatus

Definition at line 2169 of file stm32h7xx_hal_eth.c.

References __ETH_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_ETH_SetWakeUpFilter ( ETH_HandleTypeDef heth,
uint32_t *  pFilter,
uint32_t  Count 
)

Set the WakeUp filter.

Parameters:
heth,:pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
pFilter,:pointer to filter registers values
Count,:number of filter registers, must be from 1 to 8.
Return values:
None.

Definition at line 2292 of file stm32h7xx_hal_eth.c.

References __ETH_HandleTypeDef::Instance.