Peripheral Control functions

ETH control functions. More...

Collaboration diagram for Peripheral Control functions:

Functions
HAL_StatusTypeDef	HAL_ETH_GetMACConfig (const ETH_HandleTypeDef *heth, ETH_MACConfigTypeDef *macconf)
	Get the configuration of the MAC and MTL subsystems.
HAL_StatusTypeDef	HAL_ETH_GetDMAConfig (const 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.
void	HAL_ETH_SetRxVLANIdentifier (ETH_HandleTypeDef *heth, uint32_t ComparisonBits, uint32_t VLANIdentifier)
	Set the VLAN Identifier for Rx packets.
HAL_StatusTypeDef	HAL_ETH_GetMACFilterConfig (const ETH_HandleTypeDef *heth, ETH_MACFilterConfigTypeDef *pFilterConfig)
	Get the ETH MAC (L2) Filters configuration.
HAL_StatusTypeDef	HAL_ETH_SetMACFilterConfig (ETH_HandleTypeDef *heth, const ETH_MACFilterConfigTypeDef *pFilterConfig)
	Set the ETH MAC (L2) Filters configuration.
HAL_StatusTypeDef	HAL_ETH_SetHashTable (ETH_HandleTypeDef *heth, uint32_t *pHashTable)
	Set the ETH Hash Table Value.
HAL_StatusTypeDef	HAL_ETH_SetSourceMACAddrMatch (const ETH_HandleTypeDef *heth, uint32_t AddrNbr, const uint8_t *pMACAddr)
	Set the source MAC Address to be matched.
void	HAL_ETH_EnterPowerDownMode (ETH_HandleTypeDef *heth, const 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

HAL_ETH_GetMACConfig()

HAL_StatusTypeDef HAL_ETH_GetMACConfig	(	const ETH_HandleTypeDef *	heth,
		ETH_MACConfigTypeDef *	macconf )

#include <stm32f4xx_hal_eth.h>

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

HAL

Status

Definition at line 2200 of file stm32f4xx_hal_eth.c.

References ETH_MACConfigTypeDef::AutomaticPadCRCStrip, ETH_MACConfigTypeDef::BackOffLimit, ETH_MACConfigTypeDef::CarrierSenseDuringTransmit, ETH_MACConfigTypeDef::ChecksumOffload, ETH_MACConfigTypeDef::CRCStripTypePacket, ETH_MACConfigTypeDef::DeferralCheck, ETH_MACConfigTypeDef::DuplexMode, HAL_ERROR, HAL_OK, ETH_HandleTypeDef::Instance, ETH_MACConfigTypeDef::InterPacketGapVal, ETH_MACConfigTypeDef::Jabber, ETH_MACConfigTypeDef::LoopbackMode, ETH_MACConfigTypeDef::PauseLowThreshold, ETH_MACConfigTypeDef::PauseTime, ETH_MACConfigTypeDef::ReceiveFlowControl, ETH_MACConfigTypeDef::ReceiveOwn, ETH_MACConfigTypeDef::RetryTransmission, ETH_MACConfigTypeDef::Speed, ETH_MACConfigTypeDef::TransmitFlowControl, ETH_MACConfigTypeDef::UnicastPausePacketDetect, ETH_MACConfigTypeDef::Watchdog, and ETH_MACConfigTypeDef::ZeroQuantaPause.

HAL_ETH_GetDMAConfig()

HAL_StatusTypeDef HAL_ETH_GetDMAConfig	(	const ETH_HandleTypeDef *	heth,
		ETH_DMAConfigTypeDef *	dmaconf )

#include <stm32f4xx_hal_eth.h>

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

HAL

Status

Definition at line 2243 of file stm32f4xx_hal_eth.c.

References ETH_DMAConfigTypeDef::AddressAlignedBeats, ETH_DMAConfigTypeDef::BurstMode, ETH_DMAConfigTypeDef::DescriptorSkipLength, ETH_DMAConfigTypeDef::DMAArbitration, ETH_DMAConfigTypeDef::DropTCPIPChecksumErrorFrame, ETH_DMAConfigTypeDef::EnhancedDescriptorFormat, ETH_DMAARBITRATION_ROUNDROBIN_RXTX_4_1, ETH_DMAARBITRATION_RXPRIORTX, ETH_DMAConfigTypeDef::FlushRxPacket, ETH_DMAConfigTypeDef::ForwardErrorFrames, ETH_DMAConfigTypeDef::ForwardUndersizedGoodFrames, HAL_ERROR, HAL_OK, ETH_HandleTypeDef::Instance, ETH_DMAConfigTypeDef::ReceiveStoreForward, ETH_DMAConfigTypeDef::ReceiveThresholdControl, ETH_DMAConfigTypeDef::RxDMABurstLength, ETH_DMAConfigTypeDef::SecondFrameOperate, ETH_DMAConfigTypeDef::TransmitStoreForward, ETH_DMAConfigTypeDef::TransmitThresholdControl, and ETH_DMAConfigTypeDef::TxDMABurstLength.

HAL_ETH_SetMACConfig()

HAL_StatusTypeDef HAL_ETH_SetMACConfig	(	ETH_HandleTypeDef *	heth,
		ETH_MACConfigTypeDef *	macconf )

#include <stm32f4xx_hal_eth.h>

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

HAL

status

Definition at line 2282 of file stm32f4xx_hal_eth.c.

References ETH_SetMACConfig(), ETH_HandleTypeDef::gState, HAL_ERROR, HAL_ETH_STATE_READY, and HAL_OK.

HAL_ETH_SetDMAConfig()

HAL_StatusTypeDef HAL_ETH_SetDMAConfig	(	ETH_HandleTypeDef *	heth,
		ETH_DMAConfigTypeDef *	dmaconf )

#include <stm32f4xx_hal_eth.h>

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

HAL

status

Definition at line 2309 of file stm32f4xx_hal_eth.c.

References ETH_SetDMAConfig(), ETH_HandleTypeDef::gState, HAL_ERROR, HAL_ETH_STATE_READY, and HAL_OK.

HAL_ETH_SetMDIOClockRange()

void HAL_ETH_SetMDIOClockRange

(

ETH_HandleTypeDef *

heth

)

#include <stm32f4xx_hal_eth.h>

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

References ETH_MACMIIAR_CR_MASK, HAL_RCC_GetHCLKFreq(), and ETH_HandleTypeDef::Instance.

HAL_ETH_SetRxVLANIdentifier()

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

#include <stm32f4xx_hal_eth.h>

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

References ETH_REG_WRITE_DELAY, ETH_VLANTAGCOMPARISON_16BIT, HAL_Delay(), and ETH_HandleTypeDef::Instance.

HAL_ETH_GetMACFilterConfig()

HAL_StatusTypeDef HAL_ETH_GetMACFilterConfig	(	const ETH_HandleTypeDef *	heth,
		ETH_MACFilterConfigTypeDef *	pFilterConfig )

#include <stm32f4xx_hal_eth.h>

Get the ETH MAC (L2) Filters configuration.

Parameters

heth	pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
pFilterConfig	pointer to a ETH_MACFilterConfigTypeDef structure that will hold the configuration of the ETH MAC filters.

Return values

HAL

status

Definition at line 2427 of file stm32f4xx_hal_eth.c.

References ETH_MACFilterConfigTypeDef::BroadcastFilter, ETH_MACFilterConfigTypeDef::ControlPacketsFilter, ETH_MACFilterConfigTypeDef::DestAddrInverseFiltering, ETH_MACFilterConfigTypeDef::HachOrPerfectFilter, HAL_ERROR, HAL_OK, ETH_MACFilterConfigTypeDef::HashMulticast, ETH_MACFilterConfigTypeDef::HashUnicast, ETH_HandleTypeDef::Instance, ETH_MACFilterConfigTypeDef::PassAllMulticast, ETH_MACFilterConfigTypeDef::PromiscuousMode, ETH_MACFilterConfigTypeDef::ReceiveAllMode, ETH_MACFilterConfigTypeDef::SrcAddrFiltering, and ETH_MACFilterConfigTypeDef::SrcAddrInverseFiltering.

HAL_ETH_SetMACFilterConfig()

HAL_StatusTypeDef HAL_ETH_SetMACFilterConfig	(	ETH_HandleTypeDef *	heth,
		const ETH_MACFilterConfigTypeDef *	pFilterConfig )

#include <stm32f4xx_hal_eth.h>

Set the ETH MAC (L2) Filters configuration.

Parameters

heth	pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module
pFilterConfig	pointer to a ETH_MACFilterConfigTypeDef structure that contains the configuration of the ETH MAC filters.

Return values

HAL

status

Definition at line 2386 of file stm32f4xx_hal_eth.c.

References ETH_MACFilterConfigTypeDef::BroadcastFilter, ETH_MACFilterConfigTypeDef::ControlPacketsFilter, ETH_MACFilterConfigTypeDef::DestAddrInverseFiltering, ETH_MACFFR_MASK, ETH_REG_WRITE_DELAY, ETH_MACFilterConfigTypeDef::HachOrPerfectFilter, HAL_Delay(), HAL_ERROR, HAL_OK, ETH_MACFilterConfigTypeDef::HashMulticast, ETH_MACFilterConfigTypeDef::HashUnicast, ETH_HandleTypeDef::Instance, ETH_MACFilterConfigTypeDef::PassAllMulticast, ETH_MACFilterConfigTypeDef::PromiscuousMode, ETH_MACFilterConfigTypeDef::ReceiveAllMode, ETH_MACFilterConfigTypeDef::SrcAddrFiltering, and ETH_MACFilterConfigTypeDef::SrcAddrInverseFiltering.

HAL_ETH_SetHashTable()

HAL_StatusTypeDef HAL_ETH_SetHashTable	(	ETH_HandleTypeDef *	heth,
		uint32_t *	pHashTable )

#include <stm32f4xx_hal_eth.h>

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

HAL

status

Definition at line 2500 of file stm32f4xx_hal_eth.c.

References ETH_REG_WRITE_DELAY, HAL_Delay(), HAL_ERROR, HAL_OK, and ETH_HandleTypeDef::Instance.

HAL_ETH_SetSourceMACAddrMatch()

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

#include <stm32f4xx_hal_eth.h>

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

HAL

status

Definition at line 2464 of file stm32f4xx_hal_eth.c.

References HAL_ERROR, HAL_OK, and ETH_HandleTypeDef::Instance.

HAL_ETH_EnterPowerDownMode()

void HAL_ETH_EnterPowerDownMode	(	ETH_HandleTypeDef *	heth,
		const ETH_PowerDownConfigTypeDef *	pPowerDownConfig )

#include <stm32f4xx_hal_eth.h>

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

References ETH_MACPMTCSR_MASK, ETH_PowerDownConfigTypeDef::GlobalUnicast, ETH_HandleTypeDef::Instance, ETH_PowerDownConfigTypeDef::MagicPacket, and ETH_PowerDownConfigTypeDef::WakeUpPacket.

HAL_ETH_ExitPowerDownMode()

void HAL_ETH_ExitPowerDownMode

(

ETH_HandleTypeDef *

heth

)

#include <stm32f4xx_hal_eth.h>

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

References ETH_REG_WRITE_DELAY, HAL_Delay(), and ETH_HandleTypeDef::Instance.

HAL_ETH_SetWakeUpFilter()

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

#include <stm32f4xx_hal_eth.h>

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

References HAL_ERROR, HAL_OK, and ETH_HandleTypeDef::Instance.