![]() |
axiethernet
Vitis Drivers API Documentation
|
Data Structures | |
| struct | XAxiEthernet_Config |
| Holds configuration information for an AXI Ethernet device. More... | |
| struct | XAxiEthernet |
| struct XAxiEthernet is the type for Axi Ethernet driver instance data. More... | |
Macros | |
| #define | XAXIETHERNET_H /* by using protection macros */ |
| Include guard for the AXI Ethernet driver header. More... | |
| #define | XAE_MDIO_DIV_DFT 29 |
| Default MDIO clock divisor. More... | |
| #define | XAE_TPID_MAX_ENTRIES 4 |
| Number of storable TPIDs in the VLAN table. More... | |
| #define | XAE_RX 1 |
| Receive direction. More... | |
| #define | XAE_TX 2 |
| Transmit direction. More... | |
Configuration options | |
Device configuration options used with XAxiEthernet_SetOptions(), XAxiEthernet_ClearOptions(), and XAxiEthernet_GetOptions(). The default state of each option is noted below. XAE_DEFAULT_OPTIONS is the bitmask applied by XAxiEthernet_Reset() and XAxiEthernet_CfgInitialize(). | |
| #define | XAE_PROMISC_OPTION 0x00000001 |
| Accepts all incoming packets. More... | |
| #define | XAE_JUMBO_OPTION 0x00000002 |
| Accepts jumbo frames for TX and RX. More... | |
| #define | XAE_VLAN_OPTION 0x00000004 |
| Enables VLAN support for TX and RX. More... | |
| #define | XAE_FLOW_CONTROL_OPTION 0x00000008 |
| Recognizes received flow control frames. More... | |
| #define | XAE_FCS_STRIP_OPTION 0x00000010 |
| Strips FCS and PAD from RX frames. More... | |
| #define | XAE_FCS_INSERT_OPTION 0x00000020 |
| Inserts FCS and PAD on TX frames. More... | |
| #define | XAE_LENTYPE_ERR_OPTION 0x00000040 |
| Enables Length/Type error checking on RX. More... | |
| #define | XAE_TRANSMITTER_ENABLE_OPTION 0x00000080 |
| Enables the transmitter. More... | |
| #define | XAE_RECEIVER_ENABLE_OPTION 0x00000100 |
| Enables the receiver. More... | |
| #define | XAE_BROADCAST_OPTION 0x00000200 |
| Receives broadcast frames. More... | |
| #define | XAE_MULTICAST_OPTION 0x00000400 |
| Receives programmed multicast frames. More... | |
| #define | XAE_EXT_MULTICAST_OPTION 0x00000800 |
| Enables the extended multicast address table. More... | |
| #define | XAE_EXT_TXVLAN_TRAN_OPTION 0x00001000 |
| Enables TX VLAN translation. More... | |
| #define | XAE_EXT_RXVLAN_TRAN_OPTION 0x00002000 |
| Enables RX VLAN translation. More... | |
| #define | XAE_EXT_TXVLAN_TAG_OPTION 0x00004000 |
| Enables TX VLAN tagging. More... | |
| #define | XAE_EXT_RXVLAN_TAG_OPTION 0x00008000 |
| Enables RX VLAN tagging. More... | |
| #define | XAE_EXT_TXVLAN_STRP_OPTION 0x00010000 |
| Enables TX VLAN stripping. More... | |
| #define | XAE_EXT_RXVLAN_STRP_OPTION 0x00020000 |
| Enables RX VLAN stripping. More... | |
| #define | XAE_DEFAULT_OPTIONS (XAE_FLOW_CONTROL_OPTION | XAE_BROADCAST_OPTION | XAE_FCS_INSERT_OPTION | XAE_FCS_STRIP_OPTION | XAE_LENTYPE_ERR_OPTION | XAE_TRANSMITTER_ENABLE_OPTION | XAE_RECEIVER_ENABLE_OPTION) |
| Default options applied by XAxiEthernet_Reset() and XAxiEthernet_CfgInitialize(). More... | |
Ethernet buffer size constants | |
Constants that help upper layers size memory pools for Ethernet buffers and descriptor lists. | |
| #define | XAE_MAC_ADDR_SIZE 6 |
| Size of a MAC address in bytes. More... | |
| #define | XAE_MTU 1500 |
| Maximum MTU size of an Ethernet frame. More... | |
| #define | XAE_JUMBO_MTU 8982 |
| Maximum MTU size of a jumbo Ethernet frame. More... | |
| #define | XAE_HDR_SIZE 14 |
| Size of an Ethernet header in bytes. More... | |
| #define | XAE_HDR_VLAN_SIZE 18 |
| Size of an Ethernet header with VLAN in bytes. More... | |
| #define | XAE_TRL_SIZE 4 |
| Size of an Ethernet trailer (FCS) in bytes. More... | |
| #define | XAE_MAX_FRAME_SIZE (XAE_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE) |
| Maximum Ethernet frame size including header and trailer. More... | |
| #define | XAE_MAX_VLAN_FRAME_SIZE (XAE_MTU + XAE_HDR_VLAN_SIZE + XAE_TRL_SIZE) |
| Maximum VLAN Ethernet frame size including header and trailer. More... | |
| #define | XAE_MAX_JUMBO_FRAME_SIZE (XAE_JUMBO_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE) |
| Maximum jumbo Ethernet frame size including header and trailer. More... | |
PHY interface type constants | |
Values returned by XAxiEthernet_GetPhysicalInterface(). These match design parameters from the AXI Ethernet specification. | |
| #define | XAE_PHY_TYPE_RGMII 9 |
| RGMII PHY interface type. More... | |
| #define | XAE_PHY_TYPE_RGMII_ID 10 |
| RGMII with internal delay PHY interface type. More... | |
| #define | XAE_PHY_TYPE_RGMII_RXID 11 |
| RGMII with RX internal delay PHY interface type. More... | |
| #define | XAE_PHY_TYPE_RGMII_TXID 12 |
| RGMII with TX internal delay PHY interface type. More... | |
| #define | XAE_PHY_INTERFACE_MODE_NA 0 |
| PHY interface mode is not applicable. More... | |
| #define | XAE_PHY_TYPE_MII 2 |
| MII PHY interface type. More... | |
| #define | XAE_PHY_TYPE_GMII 3 |
| GMII PHY interface type. More... | |
| #define | XAE_PHY_TYPE_SGMII 4 |
| SGMII PHY interface type. More... | |
| #define | XAE_PHY_TYPE_RGMII_1_3 XAE_PHY_TYPE_RGMII |
| RGMII 1.3 PHY interface type. More... | |
| #define | XAE_PHY_TYPE_RGMII_2_0 XAE_PHY_TYPE_RGMII_RXID |
| RGMII 2.0 PHY interface type. More... | |
| #define | XAE_PHY_TYPE_1000BASE_X 21 |
| 1000BASE-X PHY interface type. More... | |
VLAN tag and strip mode constants | |
Values passed into XAxiEthernet_SetVTagMode() and XAxiEthernet_SetVStripMode() and returned by XAxiEthernet_GetVTagMode() and XAxiEthernet_GetVStripMode(). | |
| #define | XAE_VTAG_NONE 0 |
| No VLAN tagging. More... | |
| #define | XAE_VTAG_ALL 1 |
| Tag all frames. More... | |
| #define | XAE_VTAG_EXISTED 2 |
| Tag already tagged frames. More... | |
| #define | XAE_VTAG_SELECT 3 |
| Tag selected already tagged frames. More... | |
| #define | XAE_DEFAULT_TXVTAG_MODE XAE_VTAG_ALL |
| Default TX VLAN tag mode. More... | |
| #define | XAE_DEFAULT_RXVTAG_MODE XAE_VTAG_ALL |
| Default RX VLAN tag mode. More... | |
| #define | XAE_VSTRP_NONE 0 |
| No VLAN stripping. More... | |
| #define | XAE_VSTRP_ALL 1 |
| Strip one tag from all frames. More... | |
| #define | XAE_VSTRP_SELECT 3 |
| Strip one tag from selected frames. More... | |
| #define | XAE_DEFAULT_TXVSTRP_MODE XAE_VSTRP_ALL |
| Default TX VLAN strip mode. More... | |
| #define | XAE_DEFAULT_RXVSTRP_MODE XAE_VSTRP_ALL |
| Default RX VLAN strip mode. More... | |
TEMAC type constants | |
| #define | XAE_SOFT_TEMAC_10_100_MBPS 0 |
| Soft TEMAC at 10/100 Mbps. More... | |
| #define | XAE_SOFT_TEMAC_10_100_1000_MBPS 1 |
| Soft TEMAC at 10/100/1000 Mbps. More... | |
| #define | XAE_HARD_TEMC 2 |
| Hard TEMAC type. More... | |
AXI Ethernet DMA device type constants | |
| #define | XPAR_AXI_FIFO 1U |
| AXI FIFO device type. More... | |
| #define | XPAR_AXI_DMA 2U |
| AXI DMA device type. More... | |
| #define | XPAR_AXI_MCDMA 3U |
| AXI MCDMA device type. More... | |
AXI Ethernet device type masks | |
| #define | XAE_AXIDEVTYPE_MASK 0xF |
| Mask for the AXI device type field. More... | |
| #define | XAE_AXIBASEADDR_MASK 0xFFFFFFFFFFFFFFF0 |
| Mask for the AXI device base address field. More... | |
Typedefs | |
| typedef struct XAxiEthernet_Config | XAxiEthernet_Config |
| Holds configuration information for an AXI Ethernet device. More... | |
| typedef struct XAxiEthernet | XAxiEthernet |
| struct XAxiEthernet is the type for Axi Ethernet driver instance data. More... | |
Functions | |
| int | XAxiEthernet_CfgInitialize (XAxiEthernet *InstancePtr, XAxiEthernet_Config *CfgPtr, UINTPTR EffectiveAddress) |
| XAxiEthernet_CfgInitialize initializes an AXI Ethernet device along with the. More... | |
| int | XAxiEthernet_Initialize (XAxiEthernet *InstancePtr, XAxiEthernet_Config *CfgPtr, UINTPTR EffectiveAddress) |
| XAxiEthernet_Initialize initializes an AXI Ethernet device along with the. More... | |
| void | XAxiEthernet_Start (XAxiEthernet *InstancePtr) |
| XAxiEthernet_Start starts the Axi Ethernet device as follows:. More... | |
| void | XAxiEthernet_Stop (XAxiEthernet *InstancePtr) |
| XAxiEthernet_Stop gracefully stops the Axi Ethernet device as follows:. More... | |
| void | XAxiEthernet_Reset (XAxiEthernet *InstancePtr) |
| XAxiEthernet_Reset does not perform a soft reset of the AxiEthernet core. More... | |
| XAxiEthernet_Config * | XAxiEthernet_LookupConfig (UINTPTR BaseAddress) |
| Looks up device configuration by base address. More... | |
| int | XAxiEthernet_SetOptions (XAxiEthernet *InstancePtr, u32 Options) |
| XAxiEthernet_SetOptions enables the options, Options for the. More... | |
| int | XAxiEthernet_ClearOptions (XAxiEthernet *InstancePtr, u32 Options) |
| XAxiEthernet_ClearOptions clears the options, Options for the. More... | |
| u32 | XAxiEthernet_GetOptions (XAxiEthernet *InstancePtr) |
| XAxiEthernet_GetOptions returns the current option settings. More... | |
| int | XAxiEthernet_SetMacAddress (XAxiEthernet *InstancePtr, void *AddressPtr) |
| Sets the MAC address for the AXI Ethernet device. More... | |
| void | XAxiEthernet_GetMacAddress (XAxiEthernet *InstancePtr, void *AddressPtr) |
| Reads the MAC address for the AXI Ethernet device. More... | |
| int | XAxiEthernet_SetMacPauseAddress (XAxiEthernet *InstancePtr, void *AddressPtr) |
| XAxiEthernet_SetMacPauseAddress sets the MAC address used for pause frames. More... | |
| void | XAxiEthernet_GetMacPauseAddress (XAxiEthernet *InstancePtr, void *AddressPtr) |
| XAxiEthernet_GetMacPauseAddress gets the MAC address used for pause frames. More... | |
| int | XAxiEthernet_SendPausePacket (XAxiEthernet *InstancePtr, u16 PauseValue) |
| XAxiEthernet_SendPausePacket sends a pause packet with the value of. More... | |
| int | XAxiEthernet_GetSgmiiStatus (XAxiEthernet *InstancePtr, u16 *SpeedPtr) |
| XAxiEthernet_GetSgmiiStatus get the state of the link when using the SGMII. More... | |
| int | XAxiEthernet_GetRgmiiStatus (XAxiEthernet *InstancePtr, u16 *SpeedPtr, int *IsFullDuplexPtr, int *IsLinkUpPtr) |
| XAxiEthernet_GetRgmiiStatus get the state of the link when using the RGMII. More... | |
| u16 | XAxiEthernet_GetOperatingSpeed (XAxiEthernet *InstancePtr) |
| Reads the current operating link speed. More... | |
| int | XAxiEthernet_SetOperatingSpeed (XAxiEthernet *InstancePtr, u16 Speed) |
| Sets the current operating link speed. More... | |
| void | XAxiEthernet_SetBadFrmRcvOption (XAxiEthernet *InstancePtr) |
| Enables the bad frame receive option. More... | |
| void | XAxiEthernet_ClearBadFrmRcvOption (XAxiEthernet *InstancePtr) |
| Disables the bad frame receive option. More... | |
| void | XAxiEthernet_DisableControlFrameLenCheck (XAxiEthernet *InstancePtr) |
| Disables the length check for control frames. More... | |
| void | XAxiEthernet_EnableControlFrameLenCheck (XAxiEthernet *InstancePtr) |
| Enables the length check for control frames. More... | |
| void | XAxiEthernet_PhySetMdioDivisor (XAxiEthernet *InstancePtr, u8 Divisor) |
| XAxiEthernet_PhySetMdioDivisor sets the MDIO clock divisor in the. More... | |
| void | XAxiEthernet_PhyRead (XAxiEthernet *InstancePtr, u32 PhyAddress, u32 RegisterNum, u16 *PhyDataPtr) |
| XAxiEthernet_PhyRead reads the specified PHY register, RegiseterNum. More... | |
| void | XAxiEthernet_PhyWrite (XAxiEthernet *InstancePtr, u32 PhyAddress, u32 RegisterNum, u16 PhyData) |
| XAxiEthernet_PhyWrite writes PhyData to the specified PHY register, RegiseterNum on the PHY specified by PhyAddress. More... | |
| int | XAxiEthernet_MulticastAdd (XAxiEthernet *InstancePtr, void *AddressPtr, int Entry) |
| XAxiEthernet_MulticastAdd adds the Ethernet address, AddressPtr to the. More... | |
| void | XAxiEthernet_MulticastGet (XAxiEthernet *InstancePtr, void *AddressPtr, int Entry) |
| XAxiEthernet_MulticastGet gets the Ethernet address stored at. More... | |
| int | XAxiEthernet_MulticastClear (XAxiEthernet *InstancePtr, int Entry) |
| XAxiEthernet_MulticastClear clears the Ethernet address stored at index. More... | |
| int | XAxiEthernet_SetTpid (XAxiEthernet *InstancePtr, u16 Tpid, u8 Entry) |
| XAxiEthernet_SetTpid sets the VLAN Tag Protocol Identifier(TPID). More... | |
| int | XAxiEthernet_ClearTpid (XAxiEthernet *InstancePtr, u8 Entry) |
| XAxiEthernet_ClearTpid clears the VLAN Tag Protocol Identifier(TPID). More... | |
| void | XAxiEthernet_GetTpid (XAxiEthernet *InstancePtr, u16 *TpidPtr, u8 Entry) |
| XAxiEthernet_GetTpid gets the VLAN Tag Protocol Identifier value (TPID). More... | |
| int | XAxiEthernet_SetVTagMode (XAxiEthernet *InstancePtr, u32 Mode, int Dir) |
| XAxiEthernet_SetVTagMode configures the VLAN tagging mode. More... | |
| void | XAxiEthernet_GetVTagMode (XAxiEthernet *InstancePtr, u8 *ModePtr, int Dir) |
| XAxiEthernet_GetVTagMode gets VLAN tagging mode. More... | |
| int | XAxiEthernet_SetVStripMode (XAxiEthernet *InstancePtr, u32 Mode, int Dir) |
| XAxiEthernet_SetVStripMode configures the VLAN strip mode. More... | |
| void | XAxiEthernet_GetVStripMode (XAxiEthernet *InstancePtr, u8 *ModePtr, int Dir) |
| XAxiEthernet_GetVStripMode gets the VLAN stripping mode. More... | |
| int | XAxiEthernet_SetVTagValue (XAxiEthernet *InstancePtr, u32 VTagValue, int Dir) |
| XAxiEthernet_SetVTagValue configures the VLAN tagging value. More... | |
| void | XAxiEthernet_GetVTagValue (XAxiEthernet *InstancePtr, u32 *VTagValuePtr, int Dir) |
| XAxiEthernet_GetVTagValue gets the configured VLAN tagging value. More... | |
| int | XAxiEthernet_SetVidTable (XAxiEthernet *InstancePtr, u32 Entry, u32 Vid, u8 Strip, u8 Tag, int Dir) |
| XAxiEthernet_SetVidTable sets VID table includes new VLAN ID, strip. More... | |
| void | XAxiEthernet_GetVidTable (XAxiEthernet *InstancePtr, u32 Entry, u32 *VidPtr, u8 *StripPtr, u8 *TagPtr, int Dir) |
| XAxiEthernet_GetVidTable gets VID table content includes new VLAN ID, strip. More... | |
| int | XAxiEthernet_AddExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr) |
| XAxiEthernet_AddExtMulticastGroup adds an entry to the multicast Ethernet. More... | |
| int | XAxiEthernet_ClearExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr) |
| XAxiEthernet_ClearExtMulticastGroup clears input multicast Ethernet address. More... | |
| int | XAxiEthernet_GetExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr) |
| XAxiEthernet_GetExtMulticastGroup returns whether the given Ethernet address. More... | |
| void | XAxiEthernet_DumpExtMulticastGroup (XAxiEthernet *InstancePtr) |
| XAxiEthernet_DumpExtMulticastGroup dumps ALL provisioned acceptable multicast. More... | |
| #define XAXIETHERNET_H /* by using protection macros */ |
Include guard for the AXI Ethernet driver header.