axiethernet
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Typedefs Macros Groups Pages
XAxiEthernet_Config Struct Reference

This typedef contains configuration information for a Axi Ethernet device. More...

#include <xaxiethernet.h>

Data Fields

char * Name
 Unique name of the device. More...
 
UINTPTR BaseAddress
 
BaseAddress is the physical base address of the

device's registers More...

 
u8 TxCsum
 TxCsum indicates that the device has checksum offload on the Tx channel or not. More...
 
u8 RxCsum
 RxCsum indicates that the device has checksum offload on the Rx channel or not. More...
 
char * PhyType
 PhyType indicates which type of PHY interface is used (MII, GMII, RGMII, etc. More...
 
u8 TxVlanTran
 TX VLAN Translation indication. More...
 
u8 RxVlanTran
 RX VLAN Translation indication. More...
 
u8 TxVlanTag
 TX VLAN tagging indication. More...
 
u8 RxVlanTag
 RX VLAN tagging indication. More...
 
u8 TxVlanStrp
 TX VLAN stripping indication. More...
 
u8 RxVlanStrp
 RX VLAN stripping indication. More...
 
u8 ExtMcast
 Extend multicast indication. More...
 
u8 Stats
 Statistics gathering option. More...
 
u8 Avb
 Avb option. More...
 
u8 EnableSgmiiOverLvds
 Enable LVDS option. More...
 
u8 Enable_1588
 Enable 1588 option. More...
 
u32 Speed
 Tells whether MAC is 1G or 2p5G. More...
 
u8 NumTableEntries
 Number of table entries. More...
 
u32 PhyAddr
 PHY address for MDIO register access. More...
 
u16 IntrId
 Bits[11:0] Interrupt-id Bits[15:12] trigger type and level flags. More...
 
UINTPTR IntrParent
 Bit[0] Interrupt parent type Bit[64/32:1] Parent base address. More...
 
UINTPTR AxiDevBaseAddress
 
 Bit[3:0] AxiDevType is the type of device attached to the

Axi Ethernet's AXI4-Stream interface Bit[64/32:4] AxiDevBaseAddress is the base address of the device attached to the Axi Ethernet's AXI4-Stream interface. More...

 

Detailed Description

This typedef contains configuration information for a Axi Ethernet device.

Field Documentation

u8 XAxiEthernet_Config::Avb

Avb option.

UINTPTR XAxiEthernet_Config::AxiDevBaseAddress

 Bit[3:0] AxiDevType is the type of device attached to the

Axi Ethernet's AXI4-Stream interface Bit[64/32:4] AxiDevBaseAddress is the base address of the device attached to the Axi Ethernet's AXI4-Stream interface.

Referenced by AxiEthernetExtVlanExample(), AxiEthernetFifoIntrExample(), AxiEthernetMcastExample(), AxiEthernetPingReqExample(), AxiEthernetPolledExample(), AxiEthernetSgDmaIntrExample(), AxiEthernetSgDmaPollExample(), XAxiEthernet_CfgInitialize(), and XAxiEthernet_Initialize().

UINTPTR XAxiEthernet_Config::BaseAddress

BaseAddress is the physical base address of the

device's registers

Referenced by AxiEthernetExtVlanExample(), AxiEthernetFifoIntrExample(), AxiEthernetMcastExample(), AxiEthernetPingReqExample(), AxiEthernetPolledExample(), AxiEthernetSgDmaIntrExample(), AxiEthernetSgDmaPollExample(), main(), XAxiEthernet_AddExtMulticastGroup(), XAxiEthernet_CfgInitialize(), XAxiEthernet_ClearBadFrmRcvOption(), XAxiEthernet_ClearExtMulticastGroup(), XAxiEthernet_ClearOptions(), XAxiEthernet_ClearTpid(), XAxiEthernet_DisableControlFrameLenCheck(), XAxiEthernet_DumpExtMulticastGroup(), XAxiEthernet_EnableControlFrameLenCheck(), XAxiEthernet_GetExtMulticastGroup(), XAxiEthernet_GetMacAddress(), XAxiEthernet_GetMacPauseAddress(), XAxiEthernet_GetOperatingSpeed(), XAxiEthernet_GetRgmiiStatus(), XAxiEthernet_GetSgmiiStatus(), XAxiEthernet_GetTpid(), XAxiEthernet_GetVidTable(), XAxiEthernet_GetVStripMode(), XAxiEthernet_GetVTagMode(), XAxiEthernet_GetVTagValue(), XAxiEthernet_Initialize(), XAxiEthernet_MulticastAdd(), XAxiEthernet_MulticastClear(), XAxiEthernet_MulticastGet(), XAxiEthernet_PhySetMdioDivisor(), XAxiEthernet_Reset(), XAxiEthernet_SendPausePacket(), XAxiEthernet_SetBadFrmRcvOption(), XAxiEthernet_SetMacAddress(), XAxiEthernet_SetMacPauseAddress(), XAxiEthernet_SetOperatingSpeed(), XAxiEthernet_SetOptions(), XAxiEthernet_SetTpid(), XAxiEthernet_SetVidTable(), XAxiEthernet_SetVStripMode(), XAxiEthernet_SetVTagMode(), XAxiEthernet_SetVTagValue(), XAxiEthernet_Start(), and XAxiEthernet_Stop().

u8 XAxiEthernet_Config::Enable_1588
u8 XAxiEthernet_Config::EnableSgmiiOverLvds

Enable LVDS option.

u8 XAxiEthernet_Config::ExtMcast

Extend multicast indication.

u16 XAxiEthernet_Config::IntrId
UINTPTR XAxiEthernet_Config::IntrParent
char* XAxiEthernet_Config::Name

Unique name of the device.

Referenced by XAxiEthernet_LookupConfig().

u8 XAxiEthernet_Config::NumTableEntries

Number of table entries.

u32 XAxiEthernet_Config::PhyAddr

PHY address for MDIO register access.

Referenced by AxiEthernetPingReqExample(), AxiEthernetUtilConfigureInternalPhy(), and AxiEthernetUtilEnterLoopback().

char* XAxiEthernet_Config::PhyType

PhyType indicates which type of PHY interface is used (MII, GMII, RGMII, etc.

Referenced by XAxiEthernet_CfgInitialize(), and XAxiEthernet_Get_Phy_Interface().

u8 XAxiEthernet_Config::RxCsum

RxCsum indicates that the device has checksum offload on the Rx channel or not.

u8 XAxiEthernet_Config::RxVlanStrp

RX VLAN stripping indication.

u8 XAxiEthernet_Config::RxVlanTag

RX VLAN tagging indication.

u8 XAxiEthernet_Config::RxVlanTran

RX VLAN Translation indication.

u32 XAxiEthernet_Config::Speed

Tells whether MAC is 1G or 2p5G.

Referenced by AxiEthernetSgDmaIntrExample(), and AxiEthernetSgDmaPollExample().

u8 XAxiEthernet_Config::Stats

Statistics gathering option.

u8 XAxiEthernet_Config::TxCsum

TxCsum indicates that the device has checksum offload on the Tx channel or not.

u8 XAxiEthernet_Config::TxVlanStrp

TX VLAN stripping indication.

u8 XAxiEthernet_Config::TxVlanTag

TX VLAN tagging indication.

u8 XAxiEthernet_Config::TxVlanTran

TX VLAN Translation indication.