diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/annotated.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/annotated.html old mode 100644 new mode 100755 index 6b09c1e0..69863e11 --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/annotated.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/annotated.html @@ -2,38 +2,27 @@ - Xilinx Driver axiethernet v4_2: Class List + Class List - +

Xilinx Processor IP Library

Software Drivers
- - - -
+ +
+
+
+

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
XAxiEthernet
XAxiEthernet_Config
-
-

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - +Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/classes.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/classes.html deleted file mode 100644 index d1b67097..00000000 --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/classes.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - - Xilinx Driver axiethernet v4_2: Alphabetical List - - - -

Xilinx Processor IP Library

-Software Drivers -
- - - -
-

Class Index

X
- -
  X  
-		XAxiEthernet   XAxiEthernet_Config   
X
-
-

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/files.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/files.html old mode 100644 new mode 100755 index 1728ed81..92201955 --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/files.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/files.html @@ -2,31 +2,25 @@ - Xilinx Driver axiethernet v4_2: File Index + File Index - +

Xilinx Processor IP Library

Software Drivers
- - - -
+ +
+
+
+

File List

Here is a list of all files with brief descriptions: @@ -37,9 +31,4 @@
xaxiethernet.c
xaxiethernet.h
xaxiethernet_sinit.c
xdebug.h
-
-

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - +Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/functions.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/functions.html old mode 100644 new mode 100755 index e61719d3..5e662697 --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/functions.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/functions.html @@ -2,123 +2,60 @@ - Xilinx Driver axiethernet v4_2: Class Members + Class Members - +

Xilinx Processor IP Library

Software Drivers
- - - -

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - + 4.3 adk 29/10/14 - Added support for generating parameters for SGMII/1000BaseX + modes When IP is configured with the PCS/PMA core. + Changes are made in the driver tcl file (CR 828796). + Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet-members.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet-members.html old mode 100644 new mode 100755 index 37ae8aa0..67976ebc --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet-members.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet-members.html @@ -2,40 +2,29 @@ - Xilinx Driver axiethernet v4_2: Member List + Member List - +

Xilinx Processor IP Library

Software Drivers
- - - -
-

XAxiEthernet Member List

This is the complete list of members for XAxiEthernet, including all inherited members. - - - - - -
ConfigXAxiEthernet
FlagsXAxiEthernet
IsReadyXAxiEthernet
IsStartedXAxiEthernet
OptionsXAxiEthernet
-

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - + +
+
+
+
+

XAxiEthernet Member List

This is the complete list of members for XAxiEthernet, including all inherited members.

+ + + + + +
ConfigXAxiEthernet
FlagsXAxiEthernet
IsReadyXAxiEthernet
IsStartedXAxiEthernet
OptionsXAxiEthernet
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet.html old mode 100644 new mode 100755 index 7844ea79..954b48be --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet.html @@ -2,123 +2,120 @@ - Xilinx Driver axiethernet v4_2: XAxiEthernet Struct Reference + XAxiEthernet Struct Reference - +

Xilinx Processor IP Library

Software Drivers
- - - -
-

XAxiEthernet Struct Reference

-

#include <xaxiethernet.h>

- -

List of all members.

+ +
+
+
+
+

XAxiEthernet Struct Reference

#include <xaxiethernet.h> +

+List of all members.

Detailed Description

+struct XAxiEthernet is the type for Axi Ethernet driver instance data. The calling code is required to use a unique instance of this structure for every Axi Ethernet device used in the system. A reference to a structure of this type is then passed to the driver API functions. +

- - - - - - + + + + + + + + + + + +

Public Attributes

XAxiEthernet_Config Config
u32 IsStarted
u32 IsReady
u32 Options
u32 Flags

Public Attributes

XAxiEthernet_Config Config
u32 IsStarted
u32 IsReady
u32 Options
u32 Flags
-

Detailed Description

-

struct XAxiEthernet is the type for Axi Ethernet driver instance data. The calling code is required to use a unique instance of this structure for every Axi Ethernet device used in the system. A reference to a structure of this type is then passed to the driver API functions.

-

Member Data Documentation

- +

Member Data Documentation

+
- +
XAxiEthernet_Config XAxiEthernet::ConfigXAxiEthernet_Config XAxiEthernet::Config
-

Hardware configuration

+

+Hardware configuration

-
- +

+

- +
u32 XAxiEthernet::Flagsu32 XAxiEthernet::Flags
-

Internal driver flags

+

+Internal driver flags

-
- +

+

- +
u32 XAxiEthernet::IsReadyu32 XAxiEthernet::IsReady
-

Device is initialized and ready

+

+Device is initialized and ready

-
- +

+

- +
u32 XAxiEthernet::IsStartedu32 XAxiEthernet::IsStarted
-

Device is currently started

+

+Device is currently started

-
- +

+

- +
u32 XAxiEthernet::Optionsu32 XAxiEthernet::Options
-

Current options word

+

+Current options word

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

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - - +

+

The documentation for this struct was generated from the following file: +Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet___config-members.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet___config-members.html old mode 100644 new mode 100755 index 5223bf63..d9678937 --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet___config-members.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet___config-members.html @@ -2,57 +2,46 @@ - Xilinx Driver axiethernet v4_2: Member List + Member List - +

Xilinx Processor IP Library

Software Drivers
- - - -
-

XAxiEthernet_Config Member List

This is the complete list of members for XAxiEthernet_Config, including all inherited members. - - - - - - - - - - - - - - - - - - - - - - -
AvbXAxiEthernet_Config
AxiDevBaseAddressXAxiEthernet_Config
AxiDevTypeXAxiEthernet_Config
AxiDmaRxIntrXAxiEthernet_Config
AxiDmaTxIntrXAxiEthernet_Config
AxiFifoIntrXAxiEthernet_Config
BaseAddressXAxiEthernet_Config
DeviceIdXAxiEthernet_Config
EnableSgmiiOverLvdsXAxiEthernet_Config
ExtMcastXAxiEthernet_Config
PhyTypeXAxiEthernet_Config
RxCsumXAxiEthernet_Config
RxVlanStrpXAxiEthernet_Config
RxVlanTagXAxiEthernet_Config
RxVlanTranXAxiEthernet_Config
StatsXAxiEthernet_Config
TemacIntrXAxiEthernet_Config
TemacTypeXAxiEthernet_Config
TxCsumXAxiEthernet_Config
TxVlanStrpXAxiEthernet_Config
TxVlanTagXAxiEthernet_Config
TxVlanTranXAxiEthernet_Config
-

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - + +
+
+
+
+

XAxiEthernet_Config Member List

This is the complete list of members for XAxiEthernet_Config, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + +
AvbXAxiEthernet_Config
AxiDevBaseAddressXAxiEthernet_Config
AxiDevTypeXAxiEthernet_Config
AxiDmaRxIntrXAxiEthernet_Config
AxiDmaTxIntrXAxiEthernet_Config
AxiFifoIntrXAxiEthernet_Config
BaseAddressXAxiEthernet_Config
DeviceIdXAxiEthernet_Config
EnableSgmiiOverLvdsXAxiEthernet_Config
ExtMcastXAxiEthernet_Config
PhyTypeXAxiEthernet_Config
RxCsumXAxiEthernet_Config
RxVlanStrpXAxiEthernet_Config
RxVlanTagXAxiEthernet_Config
RxVlanTranXAxiEthernet_Config
StatsXAxiEthernet_Config
TemacIntrXAxiEthernet_Config
TemacTypeXAxiEthernet_Config
TxCsumXAxiEthernet_Config
TxVlanStrpXAxiEthernet_Config
TxVlanTagXAxiEthernet_Config
TxVlanTranXAxiEthernet_Config
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet___config.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet___config.html old mode 100644 new mode 100755 index c4e27510..b3f9277c --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet___config.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/struct_x_axi_ethernet___config.html @@ -2,378 +2,409 @@ - Xilinx Driver axiethernet v4_2: XAxiEthernet_Config Struct Reference + XAxiEthernet_Config Struct Reference - +

Xilinx Processor IP Library

Software Drivers
- - - -
-

XAxiEthernet_Config Struct Reference

-

#include <xaxiethernet.h>

- -

List of all members.

+ +
+
+
+
+

XAxiEthernet_Config Struct Reference

#include <xaxiethernet.h> +

+List of all members.

Detailed Description

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

- - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Attributes

u16 DeviceId
u32 BaseAddress
u8 TemacType
u8 TxCsum
u8 RxCsum
u8 PhyType
u8 TxVlanTran
u8 RxVlanTran
u8 TxVlanTag
u8 RxVlanTag
u8 TxVlanStrp
u8 RxVlanStrp
u8 ExtMcast
u8 Stats
u8 Avb
u8 EnableSgmiiOverLvds
u8 TemacIntr
int AxiDevType
u32 AxiDevBaseAddress
u8 AxiFifoIntr
u8 AxiDmaRxIntr
u8 AxiDmaTxIntr

Public Attributes

u16 DeviceId
u32 BaseAddress
u8 TemacType
u8 TxCsum
u8 RxCsum
u8 PhyType
u8 TxVlanTran
u8 RxVlanTran
u8 TxVlanTag
u8 RxVlanTag
u8 TxVlanStrp
u8 RxVlanStrp
u8 ExtMcast
u8 Stats
u8 Avb
u8 EnableSgmiiOverLvds
u8 TemacIntr
int AxiDevType
u32 AxiDevBaseAddress
u8 AxiFifoIntr
u8 AxiDmaRxIntr
u8 AxiDmaTxIntr
-

Detailed Description

-

This typedef contains configuration information for a Axi Ethernet device.

-

Member Data Documentation

- +

Member Data Documentation

+
- +
u8 XAxiEthernet_Config::Avbu8 XAxiEthernet_Config::Avb
-

Avb option

+

+Avb option

-
- +

+

- +
u32 XAxiEthernet_Config::AxiDevBaseAddressu32 XAxiEthernet_Config::AxiDevBaseAddress
-

AxiDevBaseAddress is the base address of the device attached to the Axi Ethernet's AXI4-Stream interface.

+

+AxiDevBaseAddress is the base address of the device attached to the Axi Ethernet's AXI4-Stream interface.

-
- +

+

- +
int XAxiEthernet_Config::AxiDevTypeint XAxiEthernet_Config::AxiDevType
-

AxiDevType is the type of device attached to the Axi Ethernet's AXI4-Stream interface.

+

+AxiDevType is the type of device attached to the Axi Ethernet's AXI4-Stream interface.

-
- +

+

- +
u8 XAxiEthernet_Config::AxiDmaRxIntru8 XAxiEthernet_Config::AxiDmaRxIntr
-

Axi DMA RX interrupt ID (unused if FIFO)

+

+Axi DMA RX interrupt ID (unused if FIFO)

-
- +

+

- +
u8 XAxiEthernet_Config::AxiDmaTxIntru8 XAxiEthernet_Config::AxiDmaTxIntr
-

Axi DMA TX interrupt ID (unused if FIFO)

+

+Axi DMA TX interrupt ID (unused if FIFO)

-
- +

+

- +
u8 XAxiEthernet_Config::AxiFifoIntru8 XAxiEthernet_Config::AxiFifoIntr
-

AxiFifoIntr interrupt ID (unused if DMA)

+

+AxiFifoIntr interrupt ID (unused if DMA)

-
- +

+

- +
u32 XAxiEthernet_Config::BaseAddressu32 XAxiEthernet_Config::BaseAddress
-

BaseAddress is the physical base address of the device's registers

+

+BaseAddress is the physical base address of the device's registers

-
- +

+

- +
u16 XAxiEthernet_Config::DeviceIdu16 XAxiEthernet_Config::DeviceId
-

DeviceId is the unique ID of the device

+

+DeviceId is the unique ID of the device

-
- +

+

- +
u8 XAxiEthernet_Config::EnableSgmiiOverLvdsu8 XAxiEthernet_Config::EnableSgmiiOverLvds
-

Enable LVDS option

+

+Enable LVDS option

-
- +

+

- +
u8 XAxiEthernet_Config::ExtMcastu8 XAxiEthernet_Config::ExtMcast
-

Extend multicast indication

+

+Extend multicast indication

-
- +

+

- +
u8 XAxiEthernet_Config::PhyTypeu8 XAxiEthernet_Config::PhyType
-

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

+

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

-
- +

+

- +
u8 XAxiEthernet_Config::RxCsumu8 XAxiEthernet_Config::RxCsum
-

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

+

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

-
- +

+

- +
u8 XAxiEthernet_Config::RxVlanStrpu8 XAxiEthernet_Config::RxVlanStrp
-

RX VLAN stripping indication

+

+RX VLAN stripping indication

-
- +

+

- +
u8 XAxiEthernet_Config::RxVlanTagu8 XAxiEthernet_Config::RxVlanTag
-

RX VLAN tagging indication

+

+RX VLAN tagging indication

-
- +

+

- +
u8 XAxiEthernet_Config::RxVlanTranu8 XAxiEthernet_Config::RxVlanTran
-

RX VLAN Translation indication

+

+RX VLAN Translation indication

-
- +

+

- +
u8 XAxiEthernet_Config::Statsu8 XAxiEthernet_Config::Stats
-

Statistics gathering option

+

+Statistics gathering option

-
- +

+

- +
u8 XAxiEthernet_Config::TemacIntru8 XAxiEthernet_Config::TemacIntr
-

Axi Ethernet interrupt ID

+

+Axi Ethernet interrupt ID

-
- +

+

- +
u8 XAxiEthernet_Config::TemacTypeu8 XAxiEthernet_Config::TemacType
-

Temac Type can have 3 possible values. They are 0 for SoftTemac at 10/100 Mbps, 1 for SoftTemac at 10/100/1000 Mbps and 2 for Vitex6 Hard Temac

+

+Temac Type can have 3 possible values. They are 0 for SoftTemac at 10/100 Mbps, 1 for SoftTemac at 10/100/1000 Mbps and 2 for Vitex6 Hard Temac

-
- +

+

- +
u8 XAxiEthernet_Config::TxCsumu8 XAxiEthernet_Config::TxCsum
-

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

+

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

-
- +

+

- +
u8 XAxiEthernet_Config::TxVlanStrpu8 XAxiEthernet_Config::TxVlanStrp
-

TX VLAN stripping indication

+

+TX VLAN stripping indication

-
- +

+

- +
u8 XAxiEthernet_Config::TxVlanTagu8 XAxiEthernet_Config::TxVlanTag
-

TX VLAN tagging indication

+

+TX VLAN tagging indication

-
- +

+

- +
u8 XAxiEthernet_Config::TxVlanTranu8 XAxiEthernet_Config::TxVlanTran
-

TX VLAN Translation indication

+

+TX VLAN Translation indication

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

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - - +

+

The documentation for this struct was generated from the following file: +Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/tab_b.gif b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/tab_b.gif old mode 100644 new mode 100755 diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/tab_l.gif b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/tab_l.gif old mode 100644 new mode 100755 diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/tab_r.gif b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/tab_r.gif old mode 100644 new mode 100755 diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/tabs.css b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/tabs.css old mode 100644 new mode 100755 index a4441634..a61552a6 --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/tabs.css +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/tabs.css @@ -32,7 +32,7 @@ DIV.tabs A float : left; background : url("tab_r.gif") no-repeat right top; border-bottom : 1px solid #84B0C7; - font-size : 80%; + font-size : x-small; font-weight : bold; text-decoration : none; } @@ -57,7 +57,7 @@ DIV.tabs SPAN white-space : nowrap; } -DIV.tabs #MSearchBox +DIV.tabs INPUT { float : right; display : inline; @@ -66,7 +66,7 @@ DIV.tabs #MSearchBox DIV.tabs TD { - font-size : 80%; + font-size : x-small; font-weight : bold; text-decoration : none; } @@ -82,24 +82,21 @@ DIV.tabs A:hover SPAN background-position: 0% -150px; } -DIV.tabs LI.current A +DIV.tabs LI#current A { background-position: 100% -150px; border-width : 0px; } -DIV.tabs LI.current SPAN +DIV.tabs LI#current SPAN { background-position: 0% -150px; padding-bottom : 6px; } -DIV.navpath +DIV.nav { background : none; border : none; border-bottom : 1px solid #84B0C7; - text-align : center; - margin : 2px; - padding : 2px; } diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet_8c.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet_8c.html old mode 100644 new mode 100755 index 9540a8ef..f16941ff --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet_8c.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet_8c.html @@ -2,75 +2,87 @@ - Xilinx Driver axiethernet v4_2: xaxiethernet.c File Reference + xaxiethernet.c File Reference - +

Xilinx Processor IP Library

Software Drivers
- - - -
-

xaxiethernet.c File Reference

#include "xaxiethernet.h"
- - - - - - - - - - - - - - - - - - - - - -

Functions

 xdbg_stmnt (int indent_on=0;) xdbg_stmnt(u32 _xaxiethernet_rir_value
int XAxiEthernet_CfgInitialize (XAxiEthernet *InstancePtr, XAxiEthernet_Config *CfgPtr, u32 EffectiveAddress)
void XAxiEthernet_Start (XAxiEthernet *InstancePtr)
void XAxiEthernet_Stop (XAxiEthernet *InstancePtr)
void XAxiEthernet_Reset (XAxiEthernet *InstancePtr)
int XAxiEthernet_SetMacAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_GetMacAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_SetOptions (XAxiEthernet *InstancePtr, u32 Options)
int XAxiEthernet_ClearOptions (XAxiEthernet *InstancePtr, u32 Options)
u32 XAxiEthernet_GetOptions (XAxiEthernet *InstancePtr)
u16 XAxiEthernet_GetOperatingSpeed (XAxiEthernet *InstancePtr)
int XAxiEthernet_SetOperatingSpeed (XAxiEthernet *InstancePtr, u16 Speed)
void XAxiEthernet_SetBadFrmRcvOption (XAxiEthernet *InstancePtr)
void XAxiEthernet_ClearBadFrmRcvOption (XAxiEthernet *InstancePtr)
void XAxiEthernet_DisableControlFrameLenCheck (XAxiEthernet *InstancePtr)
void XAxiEthernet_EnableControlFrameLenCheck (XAxiEthernet *InstancePtr)
void XAxiEthernet_PhySetMdioDivisor (XAxiEthernet *InstancePtr, u8 Divisor)
void XAxiEthernet_PhyRead (XAxiEthernet *InstancePtr, u32 PhyAddress, u32 RegisterNum, u16 *PhyDataPtr)
void XAxiEthernet_PhyWrite (XAxiEthernet *InstancePtr, u32 PhyAddress, u32 RegisterNum, u16 PhyData)
-

Detailed Description

-

The APIs in this file takes care of the primary functionalities of the driver. The APIs in this driver take care of the following:

- + +
+
+
+
+

xaxiethernet.c File Reference

Detailed Description

+The APIs in this file takes care of the primary functionalities of the driver. The APIs in this driver take care of the following: +

 Ver   Who  Date     Changes
  ----- ---- -------- -------------------------------------------------------
  1.00a asa  6/30/10 First release based on the ll temac driver
  1.02a asa  2/16/11 Made changes in XAxiEthernet_Reset to insert delays.
- 3.02a srt  4/13/13 Removed Warnings (CR 704998).

Function Documentation

- + 3.02a srt 4/13/13 Removed Warnings (CR 704998).

+
+

+#include "xaxiethernet.h"
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

 xdbg_stmnt (int indent_on=0;) xdbg_stmnt(u32 _xaxiethernet_rir_value
int XAxiEthernet_CfgInitialize (XAxiEthernet *InstancePtr, XAxiEthernet_Config *CfgPtr, u32 EffectiveAddress)
void XAxiEthernet_Start (XAxiEthernet *InstancePtr)
void XAxiEthernet_Stop (XAxiEthernet *InstancePtr)
void XAxiEthernet_Reset (XAxiEthernet *InstancePtr)
int XAxiEthernet_SetMacAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_GetMacAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_SetOptions (XAxiEthernet *InstancePtr, u32 Options)
int XAxiEthernet_ClearOptions (XAxiEthernet *InstancePtr, u32 Options)
u32 XAxiEthernet_GetOptions (XAxiEthernet *InstancePtr)
u16 XAxiEthernet_GetOperatingSpeed (XAxiEthernet *InstancePtr)
int XAxiEthernet_SetOperatingSpeed (XAxiEthernet *InstancePtr, u16 Speed)
void XAxiEthernet_SetBadFrmRcvOption (XAxiEthernet *InstancePtr)
void XAxiEthernet_ClearBadFrmRcvOption (XAxiEthernet *InstancePtr)
void XAxiEthernet_DisableControlFrameLenCheck (XAxiEthernet *InstancePtr)
void XAxiEthernet_EnableControlFrameLenCheck (XAxiEthernet *InstancePtr)
void XAxiEthernet_PhySetMdioDivisor (XAxiEthernet *InstancePtr, u8 Divisor)
void XAxiEthernet_PhyRead (XAxiEthernet *InstancePtr, u32 PhyAddress, u32 RegisterNum, u16 *PhyDataPtr)
void XAxiEthernet_PhyWrite (XAxiEthernet *InstancePtr, u32 PhyAddress, u32 RegisterNum, u16 PhyData)
+

Function Documentation

+
- + @@ -90,59 +102,61 @@ - +
int XAxiEthernet_CfgInitialize int XAxiEthernet_CfgInitialize ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_CfgInitialize initializes an AXI Ethernet device along with the InstancePtr that references it.

-

The PHY is setup independently from the Ethernet core. Use the MII or whatever other interface may be present for setup.

-
Parameters:
+ +

+XAxiEthernet_CfgInitialize initializes an AXI Ethernet device along with the InstancePtr that references it.

+The PHY is setup independently from the Ethernet core. Use the MII or whatever other interface may be present for setup.

+

Parameters:
InstancePtr references the memory instance to be associated with the AXI Ethernet core instance upon initialization.
CfgPtr references the structure holding the hardware configuration for the Axi Ethernet core to initialize.
EffectiveAddress is the processor address used to access the base address of the AXI Ethernet instance. In systems with an MMU and virtual memory, EffectiveAddress is the virtual address mapped to the physical in ConfigPtr->Config.BaseAddress. In systems without an active MMU, EffectiveAddress should be set to the same value as ConfigPtr->Config.BaseAddress.
-
-
Returns:
XST_SUCCESS.
-
Note:
None.
+
Returns:
XST_SUCCESS.
+
Note:
None.
-
- +

+

- + - + - +
void XAxiEthernet_ClearBadFrmRcvOption void XAxiEthernet_ClearBadFrmRcvOption ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_ClearBadFrmRcvOption is used to disable the bad frame receive option.

-
Parameters:
+ +

+XAxiEthernet_ClearBadFrmRcvOption is used to disable the bad frame receive option.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + @@ -156,88 +170,89 @@ - +
int XAxiEthernet_ClearOptions int XAxiEthernet_ClearOptions ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_ClearOptions clears the options, Options for the Axi Ethernet, specified by InstancePtr. Axi Ethernet should be stopped with XAxiEthernet_Stop() before changing options.

-
Parameters:
+ +

+XAxiEthernet_ClearOptions clears the options, Options for the Axi Ethernet, specified by InstancePtr. Axi Ethernet should be stopped with XAxiEthernet_Stop() before changing options.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Options is a bitmask of OR'd XAE_*_OPTION values for options to clear. Options not specified are not affected.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the device has not been stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the device has not been stopped.
-
Note:
See xaxiethernet.h for a description of the available options.
+
Note:
See xaxiethernet.h for a description of the available options.
-
- +

+

- + - + - +
void XAxiEthernet_DisableControlFrameLenCheck void XAxiEthernet_DisableControlFrameLenCheck ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_DisableControlFrameLenCheck is used to disable the length check for control frames (pause frames). This means once the API is called, control frames larger than the minimum frame length are accepted.

-
Parameters:
+ +

+XAxiEthernet_DisableControlFrameLenCheck is used to disable the length check for control frames (pause frames). This means once the API is called, control frames larger than the minimum frame length are accepted.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + - + - +
void XAxiEthernet_EnableControlFrameLenCheck void XAxiEthernet_EnableControlFrameLenCheck ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_EnableControlFrameLenCheck is used to enable the length check for control frames (pause frames). After calling the API, all control frames received will be checked for proper length (less than minimum frame length). By default, upon normal start up, control frame length check is enabled. Hence this API needs to be called only if previously the control frame length check has been disabled by calling the API XAxiEthernet_DisableControlFrameLenCheck.

-
Parameters:
+ +

+XAxiEthernet_EnableControlFrameLenCheck is used to enable the length check for control frames (pause frames). After calling the API, all control frames received will be checked for proper length (less than minimum frame length). By default, upon normal start up, control frame length check is enabled. Hence this API needs to be called only if previously the control frame length check has been disabled by calling the API XAxiEthernet_DisableControlFrameLenCheck.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + @@ -251,85 +266,87 @@ - +
void XAxiEthernet_GetMacAddress void XAxiEthernet_GetMacAddress ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetMacAddress gets the MAC address for the Axi Ethernet, specified by InstancePtr into the memory buffer specified by AddressPtr.

-
Parameters:
+ +

+XAxiEthernet_GetMacAddress gets the MAC address for the Axi Ethernet, specified by InstancePtr into the memory buffer specified by AddressPtr.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr references the memory buffer to store the retrieved MAC address. This memory buffer must be at least 6 bytes in length.
-
-
Returns:
None.
-
Note:
-

This routine also supports the extended/new VLAN and multicast mode. The XAE_RAF_NEWFNCENBL_MASK bit dictates which offset will be configured.

- +
Returns:
None.
+
Note:
+This routine also supports the extended/new VLAN and multicast mode. The XAE_RAF_NEWFNCENBL_MASK bit dictates which offset will be configured.
-
- +

+

- + - + - +
u16 XAxiEthernet_GetOperatingSpeed u16 XAxiEthernet_GetOperatingSpeed ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_GetOperatingSpeed gets the current operating link speed. This may be the value set by XAxiEthernet_SetOperatingSpeed() or a hardware default.

-
Parameters:
+ +

+XAxiEthernet_GetOperatingSpeed gets the current operating link speed. This may be the value set by XAxiEthernet_SetOperatingSpeed() or a hardware default.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
Returns the link speed in units of megabits per second (10 / 100 / 1000). Can return a value of 0, in case it does not get a valid speed from EMMC.
-
Note:
None.
+
Returns:
Returns the link speed in units of megabits per second (10 / 100 / 1000). Can return a value of 0, in case it does not get a valid speed from EMMC.
+
Note:
None.
-
- +

+

- + - + - +
u32 XAxiEthernet_GetOptions u32 XAxiEthernet_GetOptions ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_GetOptions returns the current option settings.

-
Parameters:
+ +

+XAxiEthernet_GetOptions returns the current option settings.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
Returns a bitmask of XAE_*_OPTION constants, each bit specifying an option that is currently active.
-
Note:
See xaxiethernet.h for a description of the available options.
+
Returns:
Returns a bitmask of XAE_*_OPTION constants, each bit specifying an option that is currently active.
+
Note:
See xaxiethernet.h for a description of the available options.
-
- +

+

- + @@ -355,20 +372,22 @@ - +
void XAxiEthernet_PhyRead void XAxiEthernet_PhyRead ( XAxiEthernet *  InstancePtr,
)
+

+

-
- +

+

- + @@ -382,35 +401,37 @@ - +
void XAxiEthernet_PhySetMdioDivisor void XAxiEthernet_PhySetMdioDivisor ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_PhySetMdioDivisor sets the MDIO clock divisor in the Axi Ethernet,specified by InstancePtr to the value, Divisor. This function must be called once after each reset prior to accessing MII PHY registers.

-

From the Virtex-6(TM) and Spartan-6 (TM) Embedded Tri-Mode Ethernet MAC User's Guide, the following equation governs the MDIO clock to the PHY:

+ +

+XAxiEthernet_PhySetMdioDivisor sets the MDIO clock divisor in the Axi Ethernet,specified by InstancePtr to the value, Divisor. This function must be called once after each reset prior to accessing MII PHY registers.

+From the Virtex-6(TM) and Spartan-6 (TM) Embedded Tri-Mode Ethernet MAC User's Guide, the following equation governs the MDIO clock to the PHY:

  			f[HOSTCLK]
 	f[MDC] = -----------------------
 			(1 + Divisor) * 2
-

where f[HOSTCLK] is the bus clock frequency in MHz, and f[MDC] is the MDIO clock frequency in MHz to the PHY. Typically, f[MDC] should not exceed 2.5 MHz. Some PHYs can tolerate faster speeds which means faster access.

-
Parameters:
+

+where f[HOSTCLK] is the bus clock frequency in MHz, and f[MDC] is the MDIO clock frequency in MHz to the PHY. Typically, f[MDC] should not exceed 2.5 MHz. Some PHYs can tolerate faster speeds which means faster access.

+

Parameters:
InstancePtr references the Axi Ethernet instance on which to operate.
Divisor is the divisor value to set within the range of 0 to XAE_MDIO_MC_CLK_DVD_MAX.
-
-
Note:
None.
+
Note:
None.
-
- +

+

- + @@ -436,73 +457,77 @@ - +
void XAxiEthernet_PhyWrite void XAxiEthernet_PhyWrite ( XAxiEthernet *  InstancePtr,
)
+

+

-
- +

+

- + - + - +
void XAxiEthernet_Reset void XAxiEthernet_Reset ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_Reset does not perform a soft reset of the AxiEthernet core. AxiEthernet hardware is reset by the device connected to the AXI4-Stream interface. This function inserts some delay before proceeding to check for MgtRdy bit. The delay is necessary to be at a safe side. It takes a while for the reset process to complete and for any of the AxiEthernet registers to be accessed. It then checks for MgtRdy bit in IS register to know if AxiEthernet reset is completed or not. Subsequently it calls one more driver function to complete the AxiEthernet hardware initialization.

-
Parameters:
+ +

+XAxiEthernet_Reset does not perform a soft reset of the AxiEthernet core. AxiEthernet hardware is reset by the device connected to the AXI4-Stream interface. This function inserts some delay before proceeding to check for MgtRdy bit. The delay is necessary to be at a safe side. It takes a while for the reset process to complete and for any of the AxiEthernet registers to be accessed. It then checks for MgtRdy bit in IS register to know if AxiEthernet reset is completed or not. Subsequently it calls one more driver function to complete the AxiEthernet hardware initialization.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Note:
It is the responsibility of the user to reset the AxiEthernet hardware before using it. AxiEthernet hardware should be reset through the device connected to the AXI4-Stream interface of AxiEthernet.
+
Note:
It is the responsibility of the user to reset the AxiEthernet hardware before using it. AxiEthernet hardware should be reset through the device connected to the AXI4-Stream interface of AxiEthernet.
-
- +

+

- + - + - +
void XAxiEthernet_SetBadFrmRcvOption void XAxiEthernet_SetBadFrmRcvOption ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_SetBadFrmRcvOption is used to enable the bad frame receive option. If enabled, this option ensures that bad receive frames are allowed and passed to the AXI4-Stream interface as if they are good frames.

-
Parameters:
+ +

+XAxiEthernet_SetBadFrmRcvOption is used to enable the bad frame receive option. If enabled, this option ensures that bad receive frames are allowed and passed to the AXI4-Stream interface as if they are good frames.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
None
+
Returns:
None.
+
Note:
None
-
- +

+

- + @@ -516,34 +541,33 @@ - +
int XAxiEthernet_SetMacAddress int XAxiEthernet_SetMacAddress ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetMacAddress sets the MAC address for the Axi Ethernet device, specified by InstancePtr to the MAC address specified by AddressPtr. The Axi Ethernet device must be stopped before calling this function.

-
Parameters:
+ +

+XAxiEthernet_SetMacAddress sets the MAC address for the Axi Ethernet device, specified by InstancePtr to the MAC address specified by AddressPtr. The Axi Ethernet device must be stopped before calling this function.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a reference to the 6-byte MAC address to set.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device has not stopped,
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device has not stopped,
-
Note:
This routine also supports the extended/new VLAN and multicast mode. The XAE_RAF_NEWFNCENBL_MASK bit dictates which offset will be configured.
+
Note:
This routine also supports the extended/new VLAN and multicast mode. The XAE_RAF_NEWFNCENBL_MASK bit dictates which offset will be configured.
-
- +

+

- + @@ -557,33 +581,33 @@ - +
int XAxiEthernet_SetOperatingSpeed int XAxiEthernet_SetOperatingSpeed ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetOperatingSpeed sets the current operating link speed. For any traffic to be passed, this speed must match the current MII/GMII/SGMII/RGMII link speed.

-
Parameters:
+ +

+XAxiEthernet_SetOperatingSpeed sets the current operating link speed. For any traffic to be passed, this speed must match the current MII/GMII/SGMII/RGMII link speed.

+

Parameters:
InstancePtr references the Axi Ethernet on which to operate.
Speed is the speed to set in units of Mbps. Valid values are 10, 100, or 1000.
-
-
Returns:
- XST_SUCCESS on successful setting of speed.
    -
  • XST_FAILURE, if the speed cannot be set for the present harwdare configuration.
    • -
+
Returns:
- XST_SUCCESS on successful setting of speed.
    +
  • XST_FAILURE, if the speed cannot be set for the present harwdare configuration.
-
Note:
None.
+
Note:
None.
-
- +

+

- + @@ -597,113 +621,107 @@ - +
int XAxiEthernet_SetOptions int XAxiEthernet_SetOptions ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetOptions enables the options, Options for the Axi Ethernet, specified by InstancePtr. Axi Ethernet should be stopped with XAxiEthernet_Stop() before changing options.

-
Parameters:
+ +

+XAxiEthernet_SetOptions enables the options, Options for the Axi Ethernet, specified by InstancePtr. Axi Ethernet should be stopped with XAxiEthernet_Stop() before changing options.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Options is a bitmask of OR'd XAE_*_OPTION values for options to set. Options not specified are not affected.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the device has not been stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the device has not been stopped.
-
Note:
See xaxiethernet.h for a description of the available options.
+
Note:
See xaxiethernet.h for a description of the available options.
-
- +

+

- + - + - +
void XAxiEthernet_Start void XAxiEthernet_Start ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_Start starts the Axi Ethernet device as follows:

- -
Parameters:
+ +

+XAxiEthernet_Start starts the Axi Ethernet device as follows:

    +
  • Enable transmitter if XAE_TRANSMIT_ENABLE_OPTION is set
  • Enable receiver if XAE_RECEIVER_ENABLE_OPTION is set
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + - + - +
void XAxiEthernet_Stop void XAxiEthernet_Stop ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_Stop gracefully stops the Axi Ethernet device as follows:

- -

XAxiEthernet_Stop does not modify any of the current device options.

-

Since the transmitter is not disabled, frames currently in internal buffers or in process by a DMA engine are allowed to be transmitted.

-
Parameters:
+ +

+XAxiEthernet_Stop gracefully stops the Axi Ethernet device as follows:

    +
  • Disable all interrupts from this device
  • Disable the receiver
+

+XAxiEthernet_Stop does not modify any of the current device options.

+Since the transmitter is not disabled, frames currently in internal buffers or in process by a DMA engine are allowed to be transmitted.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None
-
Note:
None.
+
Returns:
None
+
Note:
None.
-
- +

+

- + - + - +
xdbg_stmnt xdbg_stmnt ( int  indent_on = 0; indent_on = 0;  ) 
+

+

-
- -

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - +

+Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet_8h.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet_8h.html old mode 100644 new mode 100755 index 39d98bf2..d463e0b8 --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet_8h.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet_8h.html @@ -2,1786 +2,1972 @@ - Xilinx Driver axiethernet v4_2: xaxiethernet.h File Reference + xaxiethernet.h File Reference - +

Xilinx Processor IP Library

Software Drivers
- - - -
-

xaxiethernet.h File Reference

#include "xenv.h"
-#include "xstatus.h"
-#include "xil_assert.h"
-#include "xaxiethernet_hw.h"
+ +
+
+
+
+

xaxiethernet.h File Reference

+

+#include "xenv.h"
+#include "xstatus.h"
+#include "xil_assert.h"
+#include "xaxiethernet_hw.h"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes

struct  XAxiEthernet_Config
struct  XAxiEthernet

Defines

#define XAXIETHERNET_H
#define XAE_MULTI_MAT_ENTRIES   4
#define XAE_MDIO_DIV_DFT   29
#define XAE_MAC_ADDR_SIZE   6
#define XAE_MTU   1500
#define XAE_JUMBO_MTU   8982
#define XAE_HDR_SIZE   14
#define XAE_HDR_VLAN_SIZE   18
#define XAE_TRL_SIZE   4
#define XAE_MAX_FRAME_SIZE   (XAE_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE)
#define XAE_MAX_VLAN_FRAME_SIZE   (XAE_MTU + XAE_HDR_VLAN_SIZE + XAE_TRL_SIZE)
#define XAE_MAX_JUMBO_FRAME_SIZE   (XAE_JUMBO_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE)
#define XAE_PHY_TYPE_MII   0
#define XAE_PHY_TYPE_GMII   1
#define XAE_PHY_TYPE_RGMII_1_3   2
#define XAE_PHY_TYPE_RGMII_2_0   3
#define XAE_PHY_TYPE_SGMII   4
#define XAE_PHY_TYPE_1000BASE_X   5
#define XAE_TPID_MAX_ENTRIES   4
#define XAE_VTAG_NONE   0
#define XAE_VTAG_ALL   1
#define XAE_VTAG_EXISTED   2
#define XAE_VTAG_SELECT   3
#define XAE_DEFAULT_TXVTAG_MODE   XAE_VTAG_ALL
#define XAE_DEFAULT_RXVTAG_MODE   XAE_VTAG_ALL
#define XAE_VSTRP_NONE   0
#define XAE_VSTRP_ALL   1
#define XAE_VSTRP_SELECT   3
#define XAE_DEFAULT_TXVSTRP_MODE   XAE_VSTRP_ALL
#define XAE_DEFAULT_RXVSTRP_MODE   XAE_VSTRP_ALL
#define XAE_RX   1
#define XAE_TX   2
#define XAE_SOFT_TEMAC_10_100_MBPS   0
#define XAE_SOFT_TEMAC_10_100_1000_MBPS   1
#define XAE_HARD_TEMC   2
#define XAxiEthernet_IsStarted(InstancePtr)   (((InstancePtr)->IsStarted == XIL_COMPONENT_IS_STARTED) ? TRUE : FALSE)
#define XAxiEthernet_IsDma(InstancePtr)   (((InstancePtr)->Config.AxiDevType == XPAR_AXI_DMA) ? TRUE: FALSE)
#define XAxiEthernet_IsFifo(InstancePtr)   (((InstancePtr)->Config.AxiDevType == XPAR_AXI_FIFO) ? TRUE: FALSE)
#define XAxiEthernet_AxiDevBaseAddress(InstancePtr)   ((InstancePtr)->Config.AxiDevBaseAddress)
#define XAxiEthernet_IsRecvFrameDropped(InstancePtr)
#define XAxiEthernet_IsRxPartialCsum(InstancePtr)   ((((InstancePtr)->Config.RxCsum) == 0x01) ? TRUE : FALSE)
#define XAxiEthernet_IsTxPartialCsum(InstancePtr)   ((((InstancePtr)->Config.TxCsum) == 0x01) ? TRUE : FALSE)
#define XAxiEthernet_IsRxFullCsum(InstancePtr)   ((((InstancePtr)->Config.RxCsum) == 0x02) ? TRUE : FALSE)
#define XAxiEthernet_IsTxFullCsum(InstancePtr)   ((((InstancePtr)->Config.TxCsum) == 0x02) ? TRUE : FALSE)
#define XAxiEthernet_GetPhysicalInterface(InstancePtr)   ((InstancePtr)->Config.PhyType)
#define XAxiEthernet_GetIntStatus(InstancePtr)   XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, XAE_IS_OFFSET)
#define XAxiEthernet_IntEnable(InstancePtr, Mask)
#define XAxiEthernet_IntDisable(InstancePtr, Mask)
#define XAxiEthernet_IntPending(InstancePtr)   XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, XAE_IP_OFFSET)
#define XAxiEthernet_IntClear(InstancePtr, Mask)
#define XAxiEthernet_IsExtFuncCap(InstancePtr)
#define XAxiEthernet_IsExtMcastEnable(InstancePtr)
#define XAxiEthernet_IsExtMcast(InstancePtr)   (((InstancePtr)->Config.ExtMcast) ? TRUE : FALSE)
#define XAxiEthernet_IsTxVlanStrp(InstancePtr)   (((InstancePtr)->Config.TxVlanStrp) ? TRUE : FALSE)
#define XAxiEthernet_IsRxVlanStrp(InstancePtr)   (((InstancePtr)->Config.RxVlanStrp) ? TRUE : FALSE)
#define XAxiEthernet_IsTxVlanTran(InstancePtr)   (((InstancePtr)->Config.TxVlanTran) ? TRUE : FALSE)
#define XAxiEthernet_IsRxVlanTran(InstancePtr)   (((InstancePtr)->Config.RxVlanTran) ? TRUE : FALSE)
#define XAxiEthernet_IsTxVlanTag(InstancePtr)   (((InstancePtr)->Config.TxVlanTag) ? TRUE : FALSE)
#define XAxiEthernet_IsRxVlanTag(InstancePtr)   (((InstancePtr)->Config.RxVlanTag) ? TRUE : FALSE)
#define XAxiEthernet_GetTemacType(InstancePtr)   ((InstancePtr)->Config.TemacType)
#define XAxiEthernet_IsAvbConfigured(InstancePtr)   (((InstancePtr)->Config.Avb) ? TRUE : FALSE)
#define XAxiEthernet_IsSgmiiOverLvdsEnabled(InstancePtr)   (((InstancePtr)->Config.EnableSgmiiOverLvds) ? TRUE : FALSE)
#define XAxiEthernet_IsStatsConfigured(InstancePtr)   (((InstancePtr)->Config.Stats) ? TRUE : FALSE)
Configuration options

The following are device configuration options. See the XAxiEthernet_SetOptions, XAxiEthernet_ClearOptions and XAxiEthernet_GetOptions routines for information on how to use options.

-

The default state of the options are also noted below.

-

#define XAE_PROMISC_OPTION   0x00000001
#define XAE_JUMBO_OPTION   0x00000002
#define XAE_VLAN_OPTION   0x00000004
#define XAE_FLOW_CONTROL_OPTION   0x00000008
#define XAE_FCS_STRIP_OPTION   0x00000010
#define XAE_FCS_INSERT_OPTION   0x00000020
#define XAE_LENTYPE_ERR_OPTION   0x00000040
#define XAE_TRANSMITTER_ENABLE_OPTION   0x00000080
#define XAE_RECEIVER_ENABLE_OPTION   0x00000100
#define XAE_BROADCAST_OPTION   0x00000200
#define XAE_MULTICAST_OPTION   0x00000400
#define XAE_EXT_MULTICAST_OPTION   0x00000800
#define XAE_EXT_TXVLAN_TRAN_OPTION   0x00001000
#define XAE_EXT_RXVLAN_TRAN_OPTION   0x00002000
#define XAE_EXT_TXVLAN_TAG_OPTION   0x00004000
#define XAE_EXT_RXVLAN_TAG_OPTION   0x00008000
#define XAE_EXT_TXVLAN_STRP_OPTION   0x00010000
#define XAE_EXT_RXVLAN_STRP_OPTION   0x00020000
#define XAE_DEFAULT_OPTIONS

Functions

int XAxiEthernet_CfgInitialize (XAxiEthernet *InstancePtr, XAxiEthernet_Config *CfgPtr, u32 VirtualAddress)
void XAxiEthernet_Start (XAxiEthernet *InstancePtr)
void XAxiEthernet_Stop (XAxiEthernet *InstancePtr)
void XAxiEthernet_Reset (XAxiEthernet *InstancePtr)
XAxiEthernet_Config * XAxiEthernet_LookupConfig (u16 DeviceId)
int XAxiEthernet_SetOptions (XAxiEthernet *InstancePtr, u32 Options)
int XAxiEthernet_ClearOptions (XAxiEthernet *InstancePtr, u32 Options)
u32 XAxiEthernet_GetOptions (XAxiEthernet *InstancePtr)
int XAxiEthernet_SetMacAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_GetMacAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_SetMacPauseAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_GetMacPauseAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_SendPausePacket (XAxiEthernet *InstancePtr, u16 PauseValue)
int XAxiEthernet_GetSgmiiStatus (XAxiEthernet *InstancePtr, u16 *SpeedPtr)
int XAxiEthernet_GetRgmiiStatus (XAxiEthernet *InstancePtr, u16 *SpeedPtr, int *IsFullDuplexPtr, int *IsLinkUpPtr)
u16 XAxiEthernet_GetOperatingSpeed (XAxiEthernet *InstancePtr)
int XAxiEthernet_SetOperatingSpeed (XAxiEthernet *InstancePtr, u16 Speed)
void XAxiEthernet_SetBadFrmRcvOption (XAxiEthernet *InstancePtr)
void XAxiEthernet_ClearBadFrmRcvOption (XAxiEthernet *InstancePtr)
void XAxiEthernet_DisableControlFrameLenCheck (XAxiEthernet *InstancePtr)
void XAxiEthernet_EnableControlFrameLenCheck (XAxiEthernet *InstancePtr)
void XAxiEthernet_PhySetMdioDivisor (XAxiEthernet *InstancePtr, u8 Divisor)
void XAxiEthernet_PhyRead (XAxiEthernet *InstancePtr, u32 PhyAddress, u32 RegisterNum, u16 *PhyDataPtr)
void XAxiEthernet_PhyWrite (XAxiEthernet *InstancePtr, u32 PhyAddress, u32 RegisterNum, u16 PhyData)
int XAxiEthernet_MulticastAdd (XAxiEthernet *InstancePtr, void *AddressPtr, int Entry)
void XAxiEthernet_MulticastGet (XAxiEthernet *InstancePtr, void *AddressPtr, int Entry)
int XAxiEthernet_MulticastClear (XAxiEthernet *InstancePtr, int Entry)
int XAxiEthernet_SetTpid (XAxiEthernet *InstancePtr, u16 Tpid, u8 Entry)
int XAxiEthernet_ClearTpid (XAxiEthernet *InstancePtr, u8 Entry)
void XAxiEthernet_GetTpid (XAxiEthernet *InstancePtr, u16 *TpidPtr, u8 Entry)
int XAxiEthernet_SetVTagMode (XAxiEthernet *InstancePtr, u32 Mode, int Dir)
void XAxiEthernet_GetVTagMode (XAxiEthernet *InstancePtr, u8 *ModePtr, int Dir)
int XAxiEthernet_SetVStripMode (XAxiEthernet *InstancePtr, u32 Mode, int Dir)
void XAxiEthernet_GetVStripMode (XAxiEthernet *InstancePtr, u8 *ModePtr, int Dir)
int XAxiEthernet_SetVTagValue (XAxiEthernet *InstancePtr, u32 VTagValue, int Dir)
void XAxiEthernet_GetVTagValue (XAxiEthernet *InstancePtr, u32 *VTagValuePtr, int Dir)
int XAxiEthernet_SetVidTable (XAxiEthernet *InstancePtr, u32 Entry, u32 Vid, u8 Strip, u8 Tag, int Dir)
void XAxiEthernet_GetVidTable (XAxiEthernet *InstancePtr, u32 Entry, u32 *VidPtr, u8 *StripPtr, u8 *TagPtr, int Dir)
int XAxiEthernet_AddExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_ClearExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_GetExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_DumpExtMulticastGroup (XAxiEthernet *InstancePtr)

Classes

struct  XAxiEthernet_Config
struct  XAxiEthernet

Configuration options

The following are device configuration options. See the XAxiEthernet_SetOptions, XAxiEthernet_ClearOptions and XAxiEthernet_GetOptions routines for information on how to use options.

+The default state of the options are also noted below.

#define XAE_PROMISC_OPTION   0x00000001
#define XAE_JUMBO_OPTION   0x00000002
#define XAE_VLAN_OPTION   0x00000004
#define XAE_FLOW_CONTROL_OPTION   0x00000008
#define XAE_FCS_STRIP_OPTION   0x00000010
#define XAE_FCS_INSERT_OPTION   0x00000020
#define XAE_LENTYPE_ERR_OPTION   0x00000040
#define XAE_TRANSMITTER_ENABLE_OPTION   0x00000080
#define XAE_RECEIVER_ENABLE_OPTION   0x00000100
#define XAE_BROADCAST_OPTION   0x00000200
#define XAE_MULTICAST_OPTION   0x00000400
#define XAE_EXT_MULTICAST_OPTION   0x00000800
#define XAE_EXT_TXVLAN_TRAN_OPTION   0x00001000
#define XAE_EXT_RXVLAN_TRAN_OPTION   0x00002000
#define XAE_EXT_TXVLAN_TAG_OPTION   0x00004000
#define XAE_EXT_RXVLAN_TAG_OPTION   0x00008000
#define XAE_EXT_TXVLAN_STRP_OPTION   0x00010000
#define XAE_EXT_RXVLAN_STRP_OPTION   0x00020000
#define XAE_DEFAULT_OPTIONS

Defines

#define XAXIETHERNET_H
#define XAE_MULTI_MAT_ENTRIES   4
#define XAE_MDIO_DIV_DFT   29
#define XAE_MAC_ADDR_SIZE   6
#define XAE_MTU   1500
#define XAE_JUMBO_MTU   8982
#define XAE_HDR_SIZE   14
#define XAE_HDR_VLAN_SIZE   18
#define XAE_TRL_SIZE   4
#define XAE_MAX_FRAME_SIZE   (XAE_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE)
#define XAE_MAX_VLAN_FRAME_SIZE   (XAE_MTU + XAE_HDR_VLAN_SIZE + XAE_TRL_SIZE)
#define XAE_MAX_JUMBO_FRAME_SIZE   (XAE_JUMBO_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE)
#define XAE_PHY_TYPE_MII   0
#define XAE_PHY_TYPE_GMII   1
#define XAE_PHY_TYPE_RGMII_1_3   2
#define XAE_PHY_TYPE_RGMII_2_0   3
#define XAE_PHY_TYPE_SGMII   4
#define XAE_PHY_TYPE_1000BASE_X   5
#define XAE_TPID_MAX_ENTRIES   4
#define XAE_VTAG_NONE   0
#define XAE_VTAG_ALL   1
#define XAE_VTAG_EXISTED   2
#define XAE_VTAG_SELECT   3
#define XAE_DEFAULT_TXVTAG_MODE   XAE_VTAG_ALL
#define XAE_DEFAULT_RXVTAG_MODE   XAE_VTAG_ALL
#define XAE_VSTRP_NONE   0
#define XAE_VSTRP_ALL   1
#define XAE_VSTRP_SELECT   3
#define XAE_DEFAULT_TXVSTRP_MODE   XAE_VSTRP_ALL
#define XAE_DEFAULT_RXVSTRP_MODE   XAE_VSTRP_ALL
#define XAE_RX   1
#define XAE_TX   2
#define XAE_SOFT_TEMAC_10_100_MBPS   0
#define XAE_SOFT_TEMAC_10_100_1000_MBPS   1
#define XAE_HARD_TEMC   2
#define XAxiEthernet_IsStarted(InstancePtr)   (((InstancePtr)->IsStarted == XIL_COMPONENT_IS_STARTED) ? TRUE : FALSE)
#define XAxiEthernet_IsDma(InstancePtr)   (((InstancePtr)->Config.AxiDevType == XPAR_AXI_DMA) ? TRUE: FALSE)
#define XAxiEthernet_IsFifo(InstancePtr)   (((InstancePtr)->Config.AxiDevType == XPAR_AXI_FIFO) ? TRUE: FALSE)
#define XAxiEthernet_AxiDevBaseAddress(InstancePtr)   ((InstancePtr)->Config.AxiDevBaseAddress)
#define XAxiEthernet_IsRecvFrameDropped(InstancePtr)
#define XAxiEthernet_IsRxPartialCsum(InstancePtr)   ((((InstancePtr)->Config.RxCsum) == 0x01) ? TRUE : FALSE)
#define XAxiEthernet_IsTxPartialCsum(InstancePtr)   ((((InstancePtr)->Config.TxCsum) == 0x01) ? TRUE : FALSE)
#define XAxiEthernet_IsRxFullCsum(InstancePtr)   ((((InstancePtr)->Config.RxCsum) == 0x02) ? TRUE : FALSE)
#define XAxiEthernet_IsTxFullCsum(InstancePtr)   ((((InstancePtr)->Config.TxCsum) == 0x02) ? TRUE : FALSE)
#define XAxiEthernet_GetPhysicalInterface(InstancePtr)   ((InstancePtr)->Config.PhyType)
#define XAxiEthernet_GetIntStatus(InstancePtr)   XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, XAE_IS_OFFSET)
#define XAxiEthernet_IntEnable(InstancePtr, Mask)
#define XAxiEthernet_IntDisable(InstancePtr, Mask)
#define XAxiEthernet_IntPending(InstancePtr)   XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, XAE_IP_OFFSET)
#define XAxiEthernet_IntClear(InstancePtr, Mask)
#define XAxiEthernet_IsExtFuncCap(InstancePtr)
#define XAxiEthernet_IsExtMcastEnable(InstancePtr)
#define XAxiEthernet_IsExtMcast(InstancePtr)   (((InstancePtr)->Config.ExtMcast) ? TRUE : FALSE)
#define XAxiEthernet_IsTxVlanStrp(InstancePtr)   (((InstancePtr)->Config.TxVlanStrp) ? TRUE : FALSE)
#define XAxiEthernet_IsRxVlanStrp(InstancePtr)   (((InstancePtr)->Config.RxVlanStrp) ? TRUE : FALSE)
#define XAxiEthernet_IsTxVlanTran(InstancePtr)   (((InstancePtr)->Config.TxVlanTran) ? TRUE : FALSE)
#define XAxiEthernet_IsRxVlanTran(InstancePtr)   (((InstancePtr)->Config.RxVlanTran) ? TRUE : FALSE)
#define XAxiEthernet_IsTxVlanTag(InstancePtr)   (((InstancePtr)->Config.TxVlanTag) ? TRUE : FALSE)
#define XAxiEthernet_IsRxVlanTag(InstancePtr)   (((InstancePtr)->Config.RxVlanTag) ? TRUE : FALSE)
#define XAxiEthernet_GetTemacType(InstancePtr)   ((InstancePtr)->Config.TemacType)
#define XAxiEthernet_IsAvbConfigured(InstancePtr)   (((InstancePtr)->Config.Avb) ? TRUE : FALSE)
#define XAxiEthernet_IsSgmiiOverLvdsEnabled(InstancePtr)   (((InstancePtr)->Config.EnableSgmiiOverLvds) ? TRUE : FALSE)
#define XAxiEthernet_IsStatsConfigured(InstancePtr)   (((InstancePtr)->Config.Stats) ? TRUE : FALSE)

Functions

int XAxiEthernet_CfgInitialize (XAxiEthernet *InstancePtr, XAxiEthernet_Config *CfgPtr, u32 VirtualAddress)
void XAxiEthernet_Start (XAxiEthernet *InstancePtr)
void XAxiEthernet_Stop (XAxiEthernet *InstancePtr)
void XAxiEthernet_Reset (XAxiEthernet *InstancePtr)
XAxiEthernet_Config * XAxiEthernet_LookupConfig (u16 DeviceId)
int XAxiEthernet_SetOptions (XAxiEthernet *InstancePtr, u32 Options)
int XAxiEthernet_ClearOptions (XAxiEthernet *InstancePtr, u32 Options)
u32 XAxiEthernet_GetOptions (XAxiEthernet *InstancePtr)
int XAxiEthernet_SetMacAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_GetMacAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_SetMacPauseAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_GetMacPauseAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_SendPausePacket (XAxiEthernet *InstancePtr, u16 PauseValue)
int XAxiEthernet_GetSgmiiStatus (XAxiEthernet *InstancePtr, u16 *SpeedPtr)
int XAxiEthernet_GetRgmiiStatus (XAxiEthernet *InstancePtr, u16 *SpeedPtr, int *IsFullDuplexPtr, int *IsLinkUpPtr)
u16 XAxiEthernet_GetOperatingSpeed (XAxiEthernet *InstancePtr)
int XAxiEthernet_SetOperatingSpeed (XAxiEthernet *InstancePtr, u16 Speed)
void XAxiEthernet_SetBadFrmRcvOption (XAxiEthernet *InstancePtr)
void XAxiEthernet_ClearBadFrmRcvOption (XAxiEthernet *InstancePtr)
void XAxiEthernet_DisableControlFrameLenCheck (XAxiEthernet *InstancePtr)
void XAxiEthernet_EnableControlFrameLenCheck (XAxiEthernet *InstancePtr)
void XAxiEthernet_PhySetMdioDivisor (XAxiEthernet *InstancePtr, u8 Divisor)
void XAxiEthernet_PhyRead (XAxiEthernet *InstancePtr, u32 PhyAddress, u32 RegisterNum, u16 *PhyDataPtr)
void XAxiEthernet_PhyWrite (XAxiEthernet *InstancePtr, u32 PhyAddress, u32 RegisterNum, u16 PhyData)
int XAxiEthernet_MulticastAdd (XAxiEthernet *InstancePtr, void *AddressPtr, int Entry)
void XAxiEthernet_MulticastGet (XAxiEthernet *InstancePtr, void *AddressPtr, int Entry)
int XAxiEthernet_MulticastClear (XAxiEthernet *InstancePtr, int Entry)
int XAxiEthernet_SetTpid (XAxiEthernet *InstancePtr, u16 Tpid, u8 Entry)
int XAxiEthernet_ClearTpid (XAxiEthernet *InstancePtr, u8 Entry)
void XAxiEthernet_GetTpid (XAxiEthernet *InstancePtr, u16 *TpidPtr, u8 Entry)
int XAxiEthernet_SetVTagMode (XAxiEthernet *InstancePtr, u32 Mode, int Dir)
void XAxiEthernet_GetVTagMode (XAxiEthernet *InstancePtr, u8 *ModePtr, int Dir)
int XAxiEthernet_SetVStripMode (XAxiEthernet *InstancePtr, u32 Mode, int Dir)
void XAxiEthernet_GetVStripMode (XAxiEthernet *InstancePtr, u8 *ModePtr, int Dir)
int XAxiEthernet_SetVTagValue (XAxiEthernet *InstancePtr, u32 VTagValue, int Dir)
void XAxiEthernet_GetVTagValue (XAxiEthernet *InstancePtr, u32 *VTagValuePtr, int Dir)
int XAxiEthernet_SetVidTable (XAxiEthernet *InstancePtr, u32 Entry, u32 Vid, u8 Strip, u8 Tag, int Dir)
void XAxiEthernet_GetVidTable (XAxiEthernet *InstancePtr, u32 Entry, u32 *VidPtr, u8 *StripPtr, u8 *TagPtr, int Dir)
int XAxiEthernet_AddExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_ClearExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_GetExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_DumpExtMulticastGroup (XAxiEthernet *InstancePtr)
-

Detailed Description

-

Define Documentation

- +

Define Documentation

+
- - -
#define XAE_BROADCAST_OPTION   0x00000200
-
-
-

XAE_MULTICAST_OPTION specifies the Axi Ethernet device to receive frames sent to Ethernet addresses that are programmed into the Multicast Address Table (MAT). This driver sets this option to disabled (cleared) by default.

- -
-
- -
-
- - - - -
#define XAE_DEFAULT_OPTIONS
-
-
-Value:
(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)
-

XAE_DEFAULT_OPTIONS specify the options set in XAxiEthernet_Reset() and XAxiEthernet_CfgInitialize()

- -
-
- -
-
- - - +
#define XAE_DEFAULT_RXVSTRP_MODE   XAE_VSTRP_ALL#define XAE_BROADCAST_OPTION   0x00000200
+

+XAE_MULTICAST_OPTION specifies the Axi Ethernet device to receive frames sent to Ethernet addresses that are programmed into the Multicast Address Table (MAT). This driver sets this option to disabled (cleared) by default.

-
- +

+

- +
#define XAE_DEFAULT_RXVTAG_MODE   XAE_VTAG_ALL#define XAE_DEFAULT_OPTIONS
+

+Value:

(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)
+
XAE_DEFAULT_OPTIONS specify the options set in XAxiEthernet_Reset() and XAxiEthernet_CfgInitialize()
-
- +

+

- +
#define XAE_DEFAULT_TXVSTRP_MODE   XAE_VSTRP_ALL#define XAE_DEFAULT_RXVSTRP_MODE   XAE_VSTRP_ALL
+

+

-
- +

+

- +
#define XAE_DEFAULT_TXVTAG_MODE   XAE_VTAG_ALL#define XAE_DEFAULT_RXVTAG_MODE   XAE_VTAG_ALL
-
-
- -
-
- - - - -
#define XAE_EXT_MULTICAST_OPTION   0x00000800
-
-
-

XAE_EXT_TXVLAN_TRAN_OPTION specifies the Axi Ethernet device to enable transmit VLAN translation. This driver sets this option to be dependent on HW configuration by default.

+

-
- +

+

- +
#define XAE_EXT_RXVLAN_STRP_OPTION   0x00020000#define XAE_DEFAULT_TXVSTRP_MODE   XAE_VSTRP_ALL
-
-
- -
-
- - - - -
#define XAE_EXT_RXVLAN_TAG_OPTION   0x00008000
-
-
-

XAE_EXT_TXVLAN_STRP_OPTION specifies the Axi Ethernet device to enable transmit VLAN stripping. This driver sets this option to be dependent during HW build time by default.

+

-
- +

+

- - -
#define XAE_EXT_RXVLAN_TRAN_OPTION   0x00002000
-
-
-

XAE_EXT_TXVLAN_TAG_OPTION specifies the Axi Ethernet device to enable transmit VLAN tagging. This driver sets this option to be dependent during HW build time by default.

- -
-
- -
-
- - - - -
#define XAE_EXT_TXVLAN_STRP_OPTION   0x00010000
-
-
-

XAE_EXT_RXVLAN_STRP_OPTION specifies the Axi Ethernet device to enable receive VLAN stripping. This driver sets this option to be dependent during HW build time by default.

- -
-
- -
-
- - - - -
#define XAE_EXT_TXVLAN_TAG_OPTION   0x00004000
-
-
-

XAE_EXT_RXVLAN_TAG_OPTION specifies the Axi Ethernet device to enable receive VLAN tagging. This driver sets this option to be dependent during HW build time by default.

- -
-
- -
-
- - - - -
#define XAE_EXT_TXVLAN_TRAN_OPTION   0x00001000
-
-
-

XAE_EXT_RXVLAN_TRAN_OPTION specifies the Axi Ethernet device to enable receive VLAN translation. This driver sets this option to be dependent on HW configuration by default.

- -
-
- -
-
- - - - -
#define XAE_FCS_INSERT_OPTION   0x00000020
-
-
-

XAE_LENTYPE_ERR_OPTION specifies the Axi Ethernet device to enable Length/Type error checking (mismatched type/length field) for received frames. This driver sets this option to enabled (set) by default.

- -
-
- -
-
- - - - -
#define XAE_FCS_STRIP_OPTION   0x00000010
-
-
-

XAE_FCS_INSERT_OPTION specifies the Axi Ethernet device to generate the FCS field and add PAD automatically for outgoing frames. This driver sets this option to enabled (set) by default.

- -
-
- -
-
- - - - -
#define XAE_FLOW_CONTROL_OPTION   0x00000008
-
-
-

XAE_FCS_STRIP_OPTION specifies the Axi Ethernet device to strip FCS and PAD from received frames. Note that PAD from VLAN frames is not stripped. This driver sets this option to enabled (set) by default.

- -
-
- -
-
- - - +
#define XAE_HARD_TEMC   2#define XAE_DEFAULT_TXVTAG_MODE   XAE_VTAG_ALL
+

+

-
- +

+

- +
#define XAE_HDR_SIZE   14#define XAE_EXT_MULTICAST_OPTION   0x00000800
+

+XAE_EXT_TXVLAN_TRAN_OPTION specifies the Axi Ethernet device to enable transmit VLAN translation. This driver sets this option to be dependent on HW configuration by default.

-
- +

+

- +
#define XAE_HDR_VLAN_SIZE   18#define XAE_EXT_RXVLAN_STRP_OPTION   0x00020000
+

+

-
- +

+

- +
#define XAE_JUMBO_MTU   8982#define XAE_EXT_RXVLAN_TAG_OPTION   0x00008000
+

+XAE_EXT_TXVLAN_STRP_OPTION specifies the Axi Ethernet device to enable transmit VLAN stripping. This driver sets this option to be dependent during HW build time by default.

-
- +

+

- - -
#define XAE_JUMBO_OPTION   0x00000002
-
-
-

XAE_VLAN_OPTION specifies the Axi Ethernet device to enable VLAN support for transmit and receive. This driver sets this option to disabled (cleared) by default.

- -
-
- -
-
- - - - -
#define XAE_LENTYPE_ERR_OPTION   0x00000040
-
-
-

XAE_TRANSMITTER_ENABLE_OPTION specifies the Axi Ethernet device transmitter to be enabled. This driver sets this option to enabled (set) by default.

- -
-
- -
-
- - - +
#define XAE_MAC_ADDR_SIZE   6#define XAE_EXT_RXVLAN_TRAN_OPTION   0x00002000
+

+XAE_EXT_TXVLAN_TAG_OPTION specifies the Axi Ethernet device to enable transmit VLAN tagging. This driver sets this option to be dependent during HW build time by default.

-
- +

+

- +
#define XAE_MAX_FRAME_SIZE   (XAE_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE)#define XAE_EXT_TXVLAN_STRP_OPTION   0x00010000
+

+XAE_EXT_RXVLAN_STRP_OPTION specifies the Axi Ethernet device to enable receive VLAN stripping. This driver sets this option to be dependent during HW build time by default.

-
- +

+

- +
#define XAE_MAX_JUMBO_FRAME_SIZE   (XAE_JUMBO_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE)#define XAE_EXT_TXVLAN_TAG_OPTION   0x00004000
+

+XAE_EXT_RXVLAN_TAG_OPTION specifies the Axi Ethernet device to enable receive VLAN tagging. This driver sets this option to be dependent during HW build time by default.

-
- +

+

- +
#define XAE_MAX_VLAN_FRAME_SIZE   (XAE_MTU + XAE_HDR_VLAN_SIZE + XAE_TRL_SIZE)#define XAE_EXT_TXVLAN_TRAN_OPTION   0x00001000
+

+XAE_EXT_RXVLAN_TRAN_OPTION specifies the Axi Ethernet device to enable receive VLAN translation. This driver sets this option to be dependent on HW configuration by default.

-
- +

+

- - -
#define XAE_MDIO_DIV_DFT   29
-
-
-

Default MDIO clock divisor

- -
-
- -
-
- - - +
#define XAE_MTU   1500#define XAE_FCS_INSERT_OPTION   0x00000020
+

+XAE_LENTYPE_ERR_OPTION specifies the Axi Ethernet device to enable Length/Type error checking (mismatched type/length field) for received frames. This driver sets this option to enabled (set) by default.

-
- +

+

- - -
#define XAE_MULTI_MAT_ENTRIES   4
-
-
-

Number of storable addresses in the Multicast Address Table

- -
-
- -
-
- - - - -
#define XAE_MULTICAST_OPTION   0x00000400
-
-
-

XAE_EXT_MULTICAST_OPTION specifies the Axi Ethernet device to receive frames sent to Ethernet addresses that are programmed into the Multicast Address Table. This driver sets this option to be dependent on HW configuration by default.

- -
-
- -
-
- - - +
#define XAE_PHY_TYPE_1000BASE_X   5#define XAE_FCS_STRIP_OPTION   0x00000010
+

+XAE_FCS_INSERT_OPTION specifies the Axi Ethernet device to generate the FCS field and add PAD automatically for outgoing frames. This driver sets this option to enabled (set) by default.

-
- +

+

- +
#define XAE_PHY_TYPE_GMII   1#define XAE_FLOW_CONTROL_OPTION   0x00000008
+

+XAE_FCS_STRIP_OPTION specifies the Axi Ethernet device to strip FCS and PAD from received frames. Note that PAD from VLAN frames is not stripped. This driver sets this option to enabled (set) by default.

-
- +

+

- +
#define XAE_PHY_TYPE_MII   0#define XAE_HARD_TEMC   2
+

+

-
- +

+

- +
#define XAE_PHY_TYPE_RGMII_1_3   2#define XAE_HDR_SIZE   14
+

+

-
- +

+

- +
#define XAE_PHY_TYPE_RGMII_2_0   3#define XAE_HDR_VLAN_SIZE   18
+

+

-
- +

+

- +
#define XAE_PHY_TYPE_SGMII   4#define XAE_JUMBO_MTU   8982
-
-
- -
-
- - - - -
#define XAE_PROMISC_OPTION   0x00000001
-
-
-

< XAE_PROMISC_OPTION specifies the Axi Ethernet device to accept all incoming packets. This driver sets this option to disabled (cleared) by default. XAE_JUMBO_OPTION specifies the Axi Ethernet device to accept jumbo frames for transmit and receive. This driver sets this option to disabled (cleared) by default.

+

-
- +

+

- - -
#define XAE_RECEIVER_ENABLE_OPTION   0x00000100
-
-
-

XAE_BROADCAST_OPTION specifies the Axi Ethernet device to receive frames sent to the broadcast Ethernet address. This driver sets this option to enabled (set) by default.

- -
-
- -
-
- - - +
#define XAE_RX   1#define XAE_JUMBO_OPTION   0x00000002
+

+XAE_VLAN_OPTION specifies the Axi Ethernet device to enable VLAN support for transmit and receive. This driver sets this option to disabled (cleared) by default.

-
- +

+

- +
#define XAE_SOFT_TEMAC_10_100_1000_MBPS   1#define XAE_LENTYPE_ERR_OPTION   0x00000040
+

+XAE_TRANSMITTER_ENABLE_OPTION specifies the Axi Ethernet device transmitter to be enabled. This driver sets this option to enabled (set) by default.

-
- +

+

- +
#define XAE_SOFT_TEMAC_10_100_MBPS   0#define XAE_MAC_ADDR_SIZE   6
+

+

-
- +

+

- +
#define XAE_TPID_MAX_ENTRIES   4#define XAE_MAX_FRAME_SIZE   (XAE_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE)
-
-
- -
-
- - - - -
#define XAE_TRANSMITTER_ENABLE_OPTION   0x00000080
-
-
-

XAE_RECEIVER_ENABLE_OPTION specifies the Axi Ethernet device receiver to be enabled. This driver sets this option to enabled (set) by default.

+

-
- +

+

- +
#define XAE_TRL_SIZE   4#define XAE_MAX_JUMBO_FRAME_SIZE   (XAE_JUMBO_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE)
+

+

-
- +

+

- +
#define XAE_TX   2#define XAE_MAX_VLAN_FRAME_SIZE   (XAE_MTU + XAE_HDR_VLAN_SIZE + XAE_TRL_SIZE)
-
-
- -
-
- - - - -
#define XAE_VLAN_OPTION   0x00000004
-
-
-

XAE_FLOW_CONTROL_OPTION specifies the Axi Ethernet device to recognize received flow control frames. This driver sets this option to enabled (set) by default.

+

-
- +

+

- +
#define XAE_VSTRP_ALL   1#define XAE_MDIO_DIV_DFT   29
+

+Default MDIO clock divisor

-
- +

+

- +
#define XAE_VSTRP_NONE   0#define XAE_MTU   1500
+

+

-
- +

+

- +
#define XAE_VSTRP_SELECT   3#define XAE_MULTI_MAT_ENTRIES   4
+

+Number of storable addresses in the Multicast Address Table

-
- +

+

- +
#define XAE_VTAG_ALL   1#define XAE_MULTICAST_OPTION   0x00000400
+

+XAE_EXT_MULTICAST_OPTION specifies the Axi Ethernet device to receive frames sent to Ethernet addresses that are programmed into the Multicast Address Table. This driver sets this option to be dependent on HW configuration by default.

-
- +

+

- +
#define XAE_VTAG_EXISTED   2#define XAE_PHY_TYPE_1000BASE_X   5
+

+

-
- +

+

- +
#define XAE_VTAG_NONE   0#define XAE_PHY_TYPE_GMII   1
+

+

-
- +

+

- +
#define XAE_VTAG_SELECT   3#define XAE_PHY_TYPE_MII   0
+

+

-
- +

+

- + + +
#define XAxiEthernet_AxiDevBaseAddress#define XAE_PHY_TYPE_RGMII_1_3   2
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_PHY_TYPE_RGMII_2_0   3
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_PHY_TYPE_SGMII   4
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_PROMISC_OPTION   0x00000001
+
+
+ +

+< XAE_PROMISC_OPTION specifies the Axi Ethernet device to accept all incoming packets. This driver sets this option to disabled (cleared) by default. XAE_JUMBO_OPTION specifies the Axi Ethernet device to accept jumbo frames for transmit and receive. This driver sets this option to disabled (cleared) by default. +

+

+ +

+
+ + + + +
#define XAE_RECEIVER_ENABLE_OPTION   0x00000100
+
+
+ +

+XAE_BROADCAST_OPTION specifies the Axi Ethernet device to receive frames sent to the broadcast Ethernet address. This driver sets this option to enabled (set) by default. +

+

+ +

+
+ + + + +
#define XAE_RX   1
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_SOFT_TEMAC_10_100_1000_MBPS   1
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_SOFT_TEMAC_10_100_MBPS   0
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_TPID_MAX_ENTRIES   4
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_TRANSMITTER_ENABLE_OPTION   0x00000080
+
+
+ +

+XAE_RECEIVER_ENABLE_OPTION specifies the Axi Ethernet device receiver to be enabled. This driver sets this option to enabled (set) by default. +

+

+ +

+
+ + + + +
#define XAE_TRL_SIZE   4
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_TX   2
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_VLAN_OPTION   0x00000004
+
+
+ +

+XAE_FLOW_CONTROL_OPTION specifies the Axi Ethernet device to recognize received flow control frames. This driver sets this option to enabled (set) by default. +

+

+ +

+
+ + + + +
#define XAE_VSTRP_ALL   1
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_VSTRP_NONE   0
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_VSTRP_SELECT   3
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_VTAG_ALL   1
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_VTAG_EXISTED   2
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_VTAG_NONE   0
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define XAE_VTAG_SELECT   3
+
+
+ +

+ +

+

+ +

+
+ + + - + - +
#define XAxiEthernet_AxiDevBaseAddress ( InstancePtr   )    ((InstancePtr)->Config.AxiDevBaseAddress)   ((InstancePtr)->Config.AxiDevBaseAddress)
-

XAxiEthernet_AxiDevBaseAddress reports the base address of the core connected to the Axi Ethernet's Axi4 Stream interface.

-
Parameters:
+ +

+XAxiEthernet_AxiDevBaseAddress reports the base address of the core connected to the Axi Ethernet's Axi4 Stream interface.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
The base address of the core connected to the Axi Ethernet's streaming interface.
-
Note:
C-style signature: u32 XAxiEthernet_AxiDevBaseAddress(XAxiEthernet *InstancePtr)
+
Returns:
The base address of the core connected to the Axi Ethernet's streaming interface.
+
Note:
C-style signature: u32 XAxiEthernet_AxiDevBaseAddress(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_GetIntStatus#define XAxiEthernet_GetIntStatus ( InstancePtr   )    XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, XAE_IS_OFFSET)   XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, XAE_IS_OFFSET)
-

XAxiEthernet_GetIntStatus returns a bit mask of the interrupt status register (ISR). XAxiEthernet_GetIntStatus can be used to query the status without having to have interrupts enabled.

-
Parameters:
+ +

+XAxiEthernet_GetIntStatus returns a bit mask of the interrupt status register (ISR). XAxiEthernet_GetIntStatus can be used to query the status without having to have interrupts enabled.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
Returns a bit mask of the interrupt status conditions. The mask will be a set of bit wise or'd values from the XAE_INT_*_MASK definitions in xaxitemac_hw.h file.
-
Note:
C-style signature: u32 XAxiEthernet_GetIntStatus(XAxiEthernet *InstancePtr)
+
Returns:
Returns a bit mask of the interrupt status conditions. The mask will be a set of bit wise or'd values from the XAE_INT_*_MASK definitions in xaxitemac_hw.h file.
+
Note:
C-style signature: u32 XAxiEthernet_GetIntStatus(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_GetPhysicalInterface#define XAxiEthernet_GetPhysicalInterface ( InstancePtr   )    ((InstancePtr)->Config.PhyType)   ((InstancePtr)->Config.PhyType)
-

XAxiEthernet_GetPhysicalInterface returns the type of PHY interface being used by the given instance, specified by InstancePtr.

-
Parameters:
+ +

+XAxiEthernet_GetPhysicalInterface returns the type of PHY interface being used by the given instance, specified by InstancePtr.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
The Physical Interface type which is one of XAE_PHY_TYPE_x where x is MII, GMII, RGMII_1_3, RGMII_2_0, SGMII, or 1000BASE_X (defined in xaxiethernet.h).
-
Note:
C-style signature: int XAxiEthernet_GetPhysicalInterface(XAxiEthernet *InstancePtr)
+
Returns:
The Physical Interface type which is one of XAE_PHY_TYPE_x where x is MII, GMII, RGMII_1_3, RGMII_2_0, SGMII, or 1000BASE_X (defined in xaxiethernet.h).
+
Note:
C-style signature: int XAxiEthernet_GetPhysicalInterface(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_GetTemacType#define XAxiEthernet_GetTemacType ( InstancePtr   )    ((InstancePtr)->Config.TemacType)   ((InstancePtr)->Config.TemacType)
-

XAxiEthernet_GetTemacType returns the Axi Ethernet type of the core.

-
Parameters:
+ +

+XAxiEthernet_GetTemacType returns the Axi Ethernet type of the core.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • Returns the values of TemacType, which can be XAE_SOFT_TEMAC_10_100_MBPS (0) for Soft Temac Core with speed 10/100 Mbps. XAE_SOFT_TEMAC_10_100_1000_MBPS (1) for Soft Temac core with speed 10/100/1000 Mbps XAE_HARD_TEMC (2) for Hard Temac Core for Virtex-6
    • -
+
Returns:
    +
  • Returns the values of TemacType, which can be XAE_SOFT_TEMAC_10_100_MBPS (0) for Soft Temac Core with speed 10/100 Mbps. XAE_SOFT_TEMAC_10_100_1000_MBPS (1) for Soft Temac core with speed 10/100/1000 Mbps XAE_HARD_TEMC (2) for Hard Temac Core for Virtex-6
-
Note:
C-style signature: u32 XAxiEthernet_GetTemacType(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_GetTemacType(XAxiEthernet *InstancePtr)
-
- +

+

- +
#define XAXIETHERNET_H#define XAXIETHERNET_H
+

+

-
- +

+

- + - - - + - + - +
#define XAxiEthernet_IntClear#define XAxiEthernet_IntClear (InstancePtr,
InstancePtr,
Mask   ) 
-Value:
XAxiEthernet_WriteReg((InstancePtr)->Config.BaseAddress, \
-                        XAE_IS_OFFSET, ((Mask) & XAE_INT_ALL_MASK))
-

XAxiEthernet_IntClear clears pending interrupts specified in Mask. The corresponding pending interrupt for each bit set to 1 in Mask, will be cleared. In other words, XAxiEthernet_IntClear uses the "set a bit to - clear it" scheme.

-
Parameters:
+ +

+Value:

XAxiEthernet_WriteReg((InstancePtr)->Config.BaseAddress, \
+                        XAE_IS_OFFSET, ((Mask) & XAE_INT_ALL_MASK))
+
XAxiEthernet_IntClear clears pending interrupts specified in Mask. The corresponding pending interrupt for each bit set to 1 in Mask, will be cleared. In other words, XAxiEthernet_IntClear uses the "set a bit to clear it" scheme.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Mask contains a bit mask of the pending interrupts to clear. The mask can be formed using a set of bit wise or'd values from the XAE_INT_*_MASK definitions in xaxitemac_hw.h file.
-
-
Note:
C-style signature: void XAxiEthernet_IntClear(XAxiEthernet *InstancePtr, u32 Mask)
+
Note:
C-style signature: void XAxiEthernet_IntClear(XAxiEthernet *InstancePtr, u32 Mask)
-
- +

+

- + - - - + - + - +
#define XAxiEthernet_IntDisable#define XAxiEthernet_IntDisable (InstancePtr,
InstancePtr,
Mask   ) 
-Value:
XAxiEthernet_WriteReg((InstancePtr)->Config.BaseAddress,         \
-                XAE_IE_OFFSET,                                           \
-                XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, \
-                                XAE_IE_OFFSET) & ~((Mask) & XAE_INT_ALL_MASK));
-

XAxiEthernet_IntDisable disables the interrupts specified in Mask. The corresponding interrupt for each bit set to 1 in Mask, will be disabled. In other words, XAxiEthernet_IntDisable uses the "set a bit to - clear it" scheme.

-
Parameters:
+ +

+Value:

XAxiEthernet_WriteReg((InstancePtr)->Config.BaseAddress,         \
+                XAE_IE_OFFSET,                                           \
+                XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, \
+                                XAE_IE_OFFSET) & ~((Mask) & XAE_INT_ALL_MASK));
+
XAxiEthernet_IntDisable disables the interrupts specified in Mask. The corresponding interrupt for each bit set to 1 in Mask, will be disabled. In other words, XAxiEthernet_IntDisable uses the "set a bit to clear it" scheme.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Mask contains a bit mask of the interrupts to disable. The mask can be formed using a set of bit wise or'd values from the XAE_INT_*_MASK definitions in xaxitemac_hw.h file
-
-
Returns:
None.
-
Note:
C-style signature: void XAxiEthernet_IntDisable(XAxiEthernet *InstancePtr, u32 Mask)
+
Returns:
None.
+
Note:
C-style signature: void XAxiEthernet_IntDisable(XAxiEthernet *InstancePtr, u32 Mask)
-
- +

+

- + - - - + - + - +
#define XAxiEthernet_IntEnable#define XAxiEthernet_IntEnable (InstancePtr,
InstancePtr,
Mask   ) 
-Value:
XAxiEthernet_WriteReg((InstancePtr)->Config.BaseAddress,        \
-                XAE_IE_OFFSET,                                          \
-                XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, \
-                                XAE_IE_OFFSET) | ((Mask) & XAE_INT_ALL_MASK));
-

XAxiEthernet_IntEnable enables the interrupts specified in Mask. The corresponding interrupt for each bit set to 1 in Mask, will be enabled.

-
Parameters:
+ +

+Value:

XAxiEthernet_WriteReg((InstancePtr)->Config.BaseAddress,        \
+                XAE_IE_OFFSET,                                          \
+                XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, \
+                                XAE_IE_OFFSET) | ((Mask) & XAE_INT_ALL_MASK));
+
XAxiEthernet_IntEnable enables the interrupts specified in Mask. The corresponding interrupt for each bit set to 1 in Mask, will be enabled.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Mask contains a bit mask of the interrupts to enable. The mask can be formed using a set of bit wise or'd values from the XAE_INT_*_MASK definitions in xaxitemac_hw.h file.
-
-
Returns:
None.
-
Note:
C-style signature: void XAxiEthernet_IntEnable(XAxiEthernet *InstancePtr, u32 Mask)
+
Returns:
None.
+
Note:
C-style signature: void XAxiEthernet_IntEnable(XAxiEthernet *InstancePtr, u32 Mask)
-
- +

+

- + - + - +
#define XAxiEthernet_IntPending#define XAxiEthernet_IntPending ( InstancePtr   )    XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, XAE_IP_OFFSET)   XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, XAE_IP_OFFSET)
-

XAxiEthernet_IntPending returns a bit mask of the pending interrupts. Each bit set to 1 in the return value represents a pending interrupt.

-
Parameters:
+ +

+XAxiEthernet_IntPending returns a bit mask of the pending interrupts. Each bit set to 1 in the return value represents a pending interrupt.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
Returns a bit mask of the interrupts that are pending. The mask will be a set of bit wise or'd values from the XAE_INT_*_MASK definitions in xaxitemac_hw.h file.
-
Note:
C-style signature: u32 XAxiEthernet_IntPending(XAxiEthernet *InstancePtr)
+
Returns:
Returns a bit mask of the interrupts that are pending. The mask will be a set of bit wise or'd values from the XAE_INT_*_MASK definitions in xaxitemac_hw.h file.
+
Note:
C-style signature: u32 XAxiEthernet_IntPending(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsAvbConfigured#define XAxiEthernet_IsAvbConfigured ( InstancePtr   )    (((InstancePtr)->Config.Avb) ? TRUE : FALSE)   (((InstancePtr)->Config.Avb) ? TRUE : FALSE)
-

XAxiEthernet_IsAvbConfigured returns determines if Ethernet AVB.is configured in the harwdare or not.

-
Parameters:
+ +

+XAxiEthernet_IsAvbConfigured returns determines if Ethernet AVB.is configured in the harwdare or not.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with Ethernet AVB.
    • -
  • FALSE if the device is NOT configured with Ethernet AVB.
    • -
+
Returns:
    +
  • TRUE if the device is configured with Ethernet AVB.
  • FALSE if the device is NOT configured with Ethernet AVB.
-
Note:
C-style signature: u32 XAxiEthernet_IsAvbConfigured(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsAvbConfigured(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsDma#define XAxiEthernet_IsDma ( InstancePtr   )    (((InstancePtr)->Config.AxiDevType == XPAR_AXI_DMA) ? TRUE: FALSE)   (((InstancePtr)->Config.AxiDevType == XPAR_AXI_DMA) ? TRUE: FALSE)
-

XAxiEthernet_IsDma reports if the device is currently connected to DMA.

-
Parameters:
+ +

+XAxiEthernet_IsDma reports if the device is currently connected to DMA.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the Axi Ethernet device is connected DMA.
    • -
  • FALSE.if the Axi Ethernet device is NOT connected to DMA
    • -
+
Returns:
    +
  • TRUE if the Axi Ethernet device is connected DMA.
  • FALSE.if the Axi Ethernet device is NOT connected to DMA
-
Note:
C-style signature: u32 XAxiEthernet_IsDma(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsDma(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsExtFuncCap#define XAxiEthernet_IsExtFuncCap ( InstancePtr   ) 
-Value:
((XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, \
-                        XAE_RAF_OFFSET) & XAE_RAF_NEWFNCENBL_MASK) ?  \
+
+

+Value:
((XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, \
+                        XAE_RAF_OFFSET) & XAE_RAF_NEWFNCENBL_MASK) ?  \
                                 TRUE : FALSE)
-
XAxiEthernet_IsExtFuncCap determines if the device is capable of the new/extend VLAN and multicast features.

-
Parameters:

+
XAxiEthernet_IsExtFuncCap determines if the device is capable of the new/extend VLAN and multicast features.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is capable and configured with extended Multicast and VLAN Tagging/Stripping and Translation.
    • -
  • TRUE if the device is NOT capable and NOT configured with extended Multicast and VLAN Tagging/Stripping and Translation.
    • -
+
Returns:
    +
  • TRUE if the device is capable and configured with extended Multicast and VLAN Tagging/Stripping and Translation.
  • TRUE if the device is NOT capable and NOT configured with extended Multicast and VLAN Tagging/Stripping and Translation.
-
Note:
C-style signature: u32 XAxiEthernet_IsExtFuncCap(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsExtFuncCap(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsExtMcast#define XAxiEthernet_IsExtMcast ( InstancePtr   )    (((InstancePtr)->Config.ExtMcast) ? TRUE : FALSE)   (((InstancePtr)->Config.ExtMcast) ? TRUE : FALSE)
-

XAxiEthernet_IsExtMcast determines if the device is built with new/extended multicast features.

-
Parameters:
+ +

+XAxiEthernet_IsExtMcast determines if the device is built with new/extended multicast features.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is built with extended multicast features.
    • -
  • FALSE if the device is not built with the extended multicast features.
    • -
+
Returns:
    +
  • TRUE if the device is built with extended multicast features.
  • FALSE if the device is not built with the extended multicast features.
-
Note:
This function indicates when hardware is built with extended Multicast feature.
-

C-style signature: u32 XAxiEthernet_IsExtMcast(XAxiEthernet *InstancePtr)

- +
Note:
This function indicates when hardware is built with extended Multicast feature.
+C-style signature: u32 XAxiEthernet_IsExtMcast(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsExtMcastEnable#define XAxiEthernet_IsExtMcastEnable ( InstancePtr   ) 
-Value:
((XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, \
-                        XAE_RAF_OFFSET) & XAE_RAF_EMULTIFLTRENBL_MASK) ? \
+
+

+Value:
((XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress, \
+                        XAE_RAF_OFFSET) & XAE_RAF_EMULTIFLTRENBL_MASK) ? \
                                 TRUE : FALSE)
-
XAxiEthernet_IsExtMcastEnable determines if the extended multicast features is enabled.

-
Parameters:

+
XAxiEthernet_IsExtMcastEnable determines if the extended multicast features is enabled.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the extended multicast features are enabled.
    • -
  • FALSE if the extended multicast features are NOT enabled
    • -
+
Returns:
    +
  • TRUE if the extended multicast features are enabled.
  • FALSE if the extended multicast features are NOT enabled
-
Note:
: This function indicates when extended Multicast is enabled in HW, extended multicast mode in wrapper can be tested.
-

C-style signature: u32 XAxiEthernet_IsExtMcastEnable(XAxiEthernet *InstancePtr)

- +
Note:
: This function indicates when extended Multicast is enabled in HW, extended multicast mode in wrapper can be tested.
+C-style signature: u32 XAxiEthernet_IsExtMcastEnable(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsFifo#define XAxiEthernet_IsFifo ( InstancePtr   )    (((InstancePtr)->Config.AxiDevType == XPAR_AXI_FIFO) ? TRUE: FALSE)   (((InstancePtr)->Config.AxiDevType == XPAR_AXI_FIFO) ? TRUE: FALSE)
-

XAxiEthernet_IsFifo reports if the device is currently connected to a fifo core.

-
Parameters:
+ +

+XAxiEthernet_IsFifo reports if the device is currently connected to a fifo core.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the Axi Ethernet device is connected to a fifo
    • -
  • FALSE if the Axi Ethernet device is NOT connected to a fifo.
    • -
+
Returns:
    +
  • TRUE if the Axi Ethernet device is connected to a fifo
  • FALSE if the Axi Ethernet device is NOT connected to a fifo.
-
Note:
C-style signature: u32 XAxiEthernet_IsFifo(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsFifo(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsRecvFrameDropped#define XAxiEthernet_IsRecvFrameDropped ( InstancePtr   ) 
-Value:
((XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress,  \
-        XAE_IS_OFFSET) & XAE_INT_RXRJECT_MASK) ? TRUE : FALSE)
-

XAxiEthernet_IsRecvFrameDropped determines if the device thinks it has dropped a receive frame. The device interrupt status register is read to determine this.

-
Parameters:
+ +

+Value:

((XAxiEthernet_ReadReg((InstancePtr)->Config.BaseAddress,  \
+        XAE_IS_OFFSET) & XAE_INT_RXRJECT_MASK) ? TRUE : FALSE)
+
XAxiEthernet_IsRecvFrameDropped determines if the device thinks it has dropped a receive frame. The device interrupt status register is read to determine this.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if a frame has been dropped
    • -
  • FALSE if a frame has NOT been dropped.
    • -
+
Returns:
    +
  • TRUE if a frame has been dropped
  • FALSE if a frame has NOT been dropped.
-
Note:
C-style signature: u32 XAxiEthernet_IsRecvFrameDropped(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsRecvFrameDropped(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsRxFullCsum#define XAxiEthernet_IsRxFullCsum ( InstancePtr   )    ((((InstancePtr)->Config.RxCsum) == 0x02) ? TRUE : FALSE)   ((((InstancePtr)->Config.RxCsum) == 0x02) ? TRUE : FALSE)
-

XAxiEthernet_IsRxFullCsum determines if the device is configured with full checksum offloading on the receive channel.

-
Parameters:
+ +

+XAxiEthernet_IsRxFullCsum determines if the device is configured with full checksum offloading on the receive channel.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with full checksum offloading on the receive channel.
    • -
  • FALSE.if the device is not configured with full checksum offloading on the receive side.
    • -
+
Returns:
    +
  • TRUE if the device is configured with full checksum offloading on the receive channel.
  • FALSE.if the device is not configured with full checksum offloading on the receive side.
-
Note:
C-style signature: u32 XAxiEthernet_IsRxFullCsum(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsRxFullCsum(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsRxPartialCsum#define XAxiEthernet_IsRxPartialCsum ( InstancePtr   )    ((((InstancePtr)->Config.RxCsum) == 0x01) ? TRUE : FALSE)   ((((InstancePtr)->Config.RxCsum) == 0x01) ? TRUE : FALSE)
-

XAxiEthernet_IsRxPartialCsum determines if the device is configured with partial checksum offloading on the receive channel.

-
Parameters:
+ +

+XAxiEthernet_IsRxPartialCsum determines if the device is configured with partial checksum offloading on the receive channel.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with partial checksum offloading on the receive channel.
    • -
  • FALSE.if the device is not configured with partial checksum offloading on the receive side.
    • -
+
Returns:
    +
  • TRUE if the device is configured with partial checksum offloading on the receive channel.
  • FALSE.if the device is not configured with partial checksum offloading on the receive side.
-
Note:
C-style signature: u32 XAxiEthernet_IsRxPartialCsum(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsRxPartialCsum(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsRxVlanStrp#define XAxiEthernet_IsRxVlanStrp ( InstancePtr   )    (((InstancePtr)->Config.RxVlanStrp) ? TRUE : FALSE)   (((InstancePtr)->Config.RxVlanStrp) ? TRUE : FALSE)
-

XAxiEthernet_IsRxVlanStrp determines if the device is configured with receive VLAN stripping on the receive channel.

-
Parameters:
+ +

+XAxiEthernet_IsRxVlanStrp determines if the device is configured with receive VLAN stripping on the receive channel.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with VLAN stripping on the Receive channel.
    • -
  • FALSE if the device is NOT configured with VLAN stripping on the Receive channel.
    • -
+
Returns:
    +
  • TRUE if the device is configured with VLAN stripping on the Receive channel.
  • FALSE if the device is NOT configured with VLAN stripping on the Receive channel.
-
Note:
C-style signature: u32 XAxiEthernet_IsRxVlanTran(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsRxVlanTran(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsRxVlanTag#define XAxiEthernet_IsRxVlanTag ( InstancePtr   )    (((InstancePtr)->Config.RxVlanTag) ? TRUE : FALSE)   (((InstancePtr)->Config.RxVlanTag) ? TRUE : FALSE)
-

XAxiEthernet_IsRxVlanTag determines if the device is configured with receive VLAN tagging on the receive channel.

-
Parameters:
+ +

+XAxiEthernet_IsRxVlanTag determines if the device is configured with receive VLAN tagging on the receive channel.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with VLAN tagging on the Receive channel.
    • -
  • FALSE if the device is NOT configured with VLAN tagging on the Receive channel.
    • -
+
Returns:
    +
  • TRUE if the device is configured with VLAN tagging on the Receive channel.
  • FALSE if the device is NOT configured with VLAN tagging on the Receive channel.
-
Note:
C-style signature: u32 XAxiEthernet_IsRxVlanTag(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsRxVlanTag(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsRxVlanTran#define XAxiEthernet_IsRxVlanTran ( InstancePtr   )    (((InstancePtr)->Config.RxVlanTran) ? TRUE : FALSE)   (((InstancePtr)->Config.RxVlanTran) ? TRUE : FALSE)
-

XAxiEthernet_IsRxVlanTran determines if the device is configured with receive VLAN translation on the receive channel.

-
Parameters:
+ +

+XAxiEthernet_IsRxVlanTran determines if the device is configured with receive VLAN translation on the receive channel.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with VLAN translation on the Receive channel.
    • -
  • FALSE if the device is NOT configured with VLAN translation on the Receive channel.
    • -
+
Returns:
    +
  • TRUE if the device is configured with VLAN translation on the Receive channel.
  • FALSE if the device is NOT configured with VLAN translation on the Receive channel.
-
Note:
C-style signature: u32 XAxiEthernet_IsRxVlanTran(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsRxVlanTran(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsSgmiiOverLvdsEnabled#define XAxiEthernet_IsSgmiiOverLvdsEnabled ( InstancePtr   )    (((InstancePtr)->Config.EnableSgmiiOverLvds) ? TRUE : FALSE)   (((InstancePtr)->Config.EnableSgmiiOverLvds) ? TRUE : FALSE)
-

XAxiEthernet_IsSgmiiOverLvdsEnabled determines if SGMII over LVDS is enabled in the harwdare or not.

-
Parameters:
+ +

+XAxiEthernet_IsSgmiiOverLvdsEnabled determines if SGMII over LVDS is enabled in the harwdare or not.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with SGMII over LVDS.
    • -
  • FALSE if the device is NOT configured with SGMII over LVDS.
    • -
+
Returns:
    +
  • TRUE if the device is configured with SGMII over LVDS.
  • FALSE if the device is NOT configured with SGMII over LVDS.
-
Note:
C-style signature: u32 XAxiEthernet_IsSgmiiOverLvdsEnabled(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsSgmiiOverLvdsEnabled(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsStarted#define XAxiEthernet_IsStarted ( InstancePtr   )    (((InstancePtr)->IsStarted == XIL_COMPONENT_IS_STARTED) ? TRUE : FALSE)   (((InstancePtr)->IsStarted == XIL_COMPONENT_IS_STARTED) ? TRUE : FALSE)
-

XAxiEthernet_IsStarted reports if the device is in the started or stopped state. To be in the started state, the calling code must have made a successful call to XAxiEthernet_Start. To be in the stopped state, XAxiEthernet_Stop or XAxiEthernet_CfgInitialize function must have been called.

-
Parameters:
+ +

+XAxiEthernet_IsStarted reports if the device is in the started or stopped state. To be in the started state, the calling code must have made a successful call to XAxiEthernet_Start. To be in the stopped state, XAxiEthernet_Stop or XAxiEthernet_CfgInitialize function must have been called.

+

Parameters:
InstancePtr is a pointer to the of Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device has been started.
    • -
  • FALSE.if the device has not been started
    • -
+
Returns:
    +
  • TRUE if the device has been started.
  • FALSE.if the device has not been started
-
Note:
C-style signature: u32 XAxiEthernet_IsStarted(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsStarted(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsStatsConfigured#define XAxiEthernet_IsStatsConfigured ( InstancePtr   )    (((InstancePtr)->Config.Stats) ? TRUE : FALSE)   (((InstancePtr)->Config.Stats) ? TRUE : FALSE)
-

XAxiEthernet_IsStatsConfigured returns determines if Statistics gathering. is configured in the harwdare or not.

-
Parameters:
+ +

+XAxiEthernet_IsStatsConfigured returns determines if Statistics gathering. is configured in the harwdare or not.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with statistics gathering.
    • -
  • FALSE if the device is NOT configured with statistics gathering.
    • -
+
Returns:
    +
  • TRUE if the device is configured with statistics gathering.
  • FALSE if the device is NOT configured with statistics gathering.
-
Note:
C-style signature: u32 XAxiEthernet_IsStatsConfigured(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsStatsConfigured(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsTxFullCsum#define XAxiEthernet_IsTxFullCsum ( InstancePtr   )    ((((InstancePtr)->Config.TxCsum) == 0x02) ? TRUE : FALSE)   ((((InstancePtr)->Config.TxCsum) == 0x02) ? TRUE : FALSE)
-

XAxiEthernet_IsTxFullCsum determines if the device is configured with full checksum offloading on the transmit channel.

-
Parameters:
+ +

+XAxiEthernet_IsTxFullCsum determines if the device is configured with full checksum offloading on the transmit channel.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with full checksum offloading on the transmit side.
    • -
  • FALSE.if the device is not configured with full checksum offloading on the transmit side.
    • -
+
Returns:
    +
  • TRUE if the device is configured with full checksum offloading on the transmit side.
  • FALSE.if the device is not configured with full checksum offloading on the transmit side.
-
Note:
C-style signature: u32 XAxiEthernet_IsTxFullCsum(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsTxFullCsum(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsTxPartialCsum#define XAxiEthernet_IsTxPartialCsum ( InstancePtr   )    ((((InstancePtr)->Config.TxCsum) == 0x01) ? TRUE : FALSE)   ((((InstancePtr)->Config.TxCsum) == 0x01) ? TRUE : FALSE)
-

XAxiEthernet_IsTxPartialCsum determines if the device is configured with partial checksum offloading on the transmit channel.

-
Parameters:
+ +

+XAxiEthernet_IsTxPartialCsum determines if the device is configured with partial checksum offloading on the transmit channel.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with partial checksum offloading on the transmit side.
    • -
  • FALSE.if the device is not configured with partial checksum offloading on the transmit side.
    • -
+
Returns:
    +
  • TRUE if the device is configured with partial checksum offloading on the transmit side.
  • FALSE.if the device is not configured with partial checksum offloading on the transmit side.
-
Note:
C-style signature: u32 XAxiEthernet_IsTxPartialCsum(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsTxPartialCsum(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsTxVlanStrp#define XAxiEthernet_IsTxVlanStrp ( InstancePtr   )    (((InstancePtr)->Config.TxVlanStrp) ? TRUE : FALSE)   (((InstancePtr)->Config.TxVlanStrp) ? TRUE : FALSE)
-

XAxiEthernet_IsTxVlanStrp determines if the device is configured with transmit VLAN stripping on the transmit channel.

-
Parameters:
+ +

+XAxiEthernet_IsTxVlanStrp determines if the device is configured with transmit VLAN stripping on the transmit channel.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with VLAN stripping on the Transmit channel.
    • -
  • FALSE if the device is NOT configured with VLAN stripping on the Transmit channel.
    • -
+
Returns:
    +
  • TRUE if the device is configured with VLAN stripping on the Transmit channel.
  • FALSE if the device is NOT configured with VLAN stripping on the Transmit channel.
-
Note:
C-style signature: u32 XAxiEthernet_IsTxVlanStrp(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsTxVlanStrp(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsTxVlanTag#define XAxiEthernet_IsTxVlanTag ( InstancePtr   )    (((InstancePtr)->Config.TxVlanTag) ? TRUE : FALSE)   (((InstancePtr)->Config.TxVlanTag) ? TRUE : FALSE)
-

XAxiEthernet_IsTxVlanTag determines if the device is configured with transmit VLAN tagging on the transmit channel.

-
Parameters:
+ +

+XAxiEthernet_IsTxVlanTag determines if the device is configured with transmit VLAN tagging on the transmit channel.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with VLAN tagging on the Transmit channel.
    • -
  • FALSE if the device is NOT configured with VLAN tagging on the Transmit channel.
    • -
+
Returns:
    +
  • TRUE if the device is configured with VLAN tagging on the Transmit channel.
  • FALSE if the device is NOT configured with VLAN tagging on the Transmit channel.
-
Note:
C-style signature: u32 XAxiEthernet_IsTxVlanTag(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsTxVlanTag(XAxiEthernet *InstancePtr)
-
- +

+

- + - + - +
#define XAxiEthernet_IsTxVlanTran#define XAxiEthernet_IsTxVlanTran ( InstancePtr   )    (((InstancePtr)->Config.TxVlanTran) ? TRUE : FALSE)   (((InstancePtr)->Config.TxVlanTran) ? TRUE : FALSE)
-

XAxiEthernet_IsTxVlanTran determines if the device is configured with transmit VLAN translation on the transmit channel.

-
Parameters:
+ +

+XAxiEthernet_IsTxVlanTran determines if the device is configured with transmit VLAN translation on the transmit channel.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
    -
  • TRUE if the device is configured with VLAN translation on the Transmit channel.
    • -
  • FALSE if the device is NOT configured with VLAN translation on the Transmit channel.
    • -
+
Returns:
    +
  • TRUE if the device is configured with VLAN translation on the Transmit channel.
  • FALSE if the device is NOT configured with VLAN translation on the Transmit channel.
-
Note:
C-style signature: u32 XAxiEthernet_IsTxVlanTran(XAxiEthernet *InstancePtr)
+
Note:
C-style signature: u32 XAxiEthernet_IsTxVlanTran(XAxiEthernet *InstancePtr)
-
-

Function Documentation

- +

+

Function Documentation

+
- + @@ -1795,42 +1981,39 @@ - +
int XAxiEthernet_AddExtMulticastGroup int XAxiEthernet_AddExtMulticastGroup ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_AddExtMulticastGroup adds an entry to the multicast Ethernet address table. The new entry, represents a group of MAC addresses based on the contents of AddressPtr. AddressPtr is one member of the MAC address set in the newly added entry.

-

The device must be stopped to use this function.
-
-

-

Once an Ethernet address is programmed, the Axi Ethernet device will begin receiving data sent from that address. The Axi Ethernet hardware does not have a control bit to disable multicast filtering. The only way to prevent the Axi Ethernet device from receiving messages from an Ethernet address in the multicast table is to clear it with XAxiEthernet_ClearExtMulticastGroup().

-
Parameters:
+ +

+XAxiEthernet_AddExtMulticastGroup adds an entry to the multicast Ethernet address table. The new entry, represents a group of MAC addresses based on the contents of AddressPtr. AddressPtr is one member of the MAC address set in the newly added entry.

+The device must be stopped to use this function.
+
+

+Once an Ethernet address is programmed, the Axi Ethernet device will begin receiving data sent from that address. The Axi Ethernet hardware does not have a control bit to disable multicast filtering. The only way to prevent the Axi Ethernet device from receiving messages from an Ethernet address in the multicast table is to clear it with XAxiEthernet_ClearExtMulticastGroup().

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a pointer to the 6-byte Ethernet address to add.
-
-
Returns:
    -
  • XST_SUCCESS.on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_INVALID_PARAM if the input MAC address is not between 01:00:5E:00:00:00 and 01:00:5E:7F:FF:FF per RFC1112.
    • -
+
Returns:
    +
  • XST_SUCCESS.on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_INVALID_PARAM if the input MAC address is not between 01:00:5E:00:00:00 and 01:00:5E:7F:FF:FF per RFC1112.
-
Note:
-

This routine consider all 2**23 possible multicast Ethernet addresses to be 8Mx1 bit or 1M bytes memory area. All defined multicast addresses are from 01.00.5E.00.00.00 to 01.00.5E.7F.FF.FF The most significant 25 bit out of 48 bit are static, so they will not be part of calculation.

-

The hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group.

-

This API operates at a group (256 MAC addresses) for hardware to do the first layer address filtering. It is user's responsibility to provision this table appropriately.

- +
Note:
+This routine consider all 2**23 possible multicast Ethernet addresses to be 8Mx1 bit or 1M bytes memory area. All defined multicast addresses are from 01.00.5E.00.00.00 to 01.00.5E.7F.FF.FF The most significant 25 bit out of 48 bit are static, so they will not be part of calculation.

+The hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group.

+This API operates at a group (256 MAC addresses) for hardware to do the first layer address filtering. It is user's responsibility to provision this table appropriately.

-
- +

+

- + @@ -1850,59 +2033,61 @@ - +
int XAxiEthernet_CfgInitialize int XAxiEthernet_CfgInitialize ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_CfgInitialize initializes an AXI Ethernet device along with the InstancePtr that references it.

-

The PHY is setup independently from the Ethernet core. Use the MII or whatever other interface may be present for setup.

-
Parameters:
+ +

+XAxiEthernet_CfgInitialize initializes an AXI Ethernet device along with the InstancePtr that references it.

+The PHY is setup independently from the Ethernet core. Use the MII or whatever other interface may be present for setup.

+

Parameters:
InstancePtr references the memory instance to be associated with the AXI Ethernet core instance upon initialization.
CfgPtr references the structure holding the hardware configuration for the Axi Ethernet core to initialize.
EffectiveAddress is the processor address used to access the base address of the AXI Ethernet instance. In systems with an MMU and virtual memory, EffectiveAddress is the virtual address mapped to the physical in ConfigPtr->Config.BaseAddress. In systems without an active MMU, EffectiveAddress should be set to the same value as ConfigPtr->Config.BaseAddress.
-
-
Returns:
XST_SUCCESS.
-
Note:
None.
+
Returns:
XST_SUCCESS.
+
Note:
None.
-
- +

+

- + - + - +
void XAxiEthernet_ClearBadFrmRcvOption void XAxiEthernet_ClearBadFrmRcvOption ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_ClearBadFrmRcvOption is used to disable the bad frame receive option.

-
Parameters:
+ +

+XAxiEthernet_ClearBadFrmRcvOption is used to disable the bad frame receive option.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + @@ -1916,42 +2101,39 @@ - +
int XAxiEthernet_ClearExtMulticastGroup int XAxiEthernet_ClearExtMulticastGroup ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_ClearExtMulticastGroup clears input multicast Ethernet address group from table.

-
Parameters:
+ +

+XAxiEthernet_ClearExtMulticastGroup clears input multicast Ethernet address group from table.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a pointer to the 6-byte Ethernet address to clear.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion, returns XST_SUCCESS.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped
    • -
  • XST_INVALID_PARAM if input MAC address is not between 01:00:5E:00:00:00 and 01:00:5E:7F:FF:FF per RFC1112.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion, returns XST_SUCCESS.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped
  • XST_INVALID_PARAM if input MAC address is not between 01:00:5E:00:00:00 and 01:00:5E:7F:FF:FF per RFC1112.
-
Note:
-

Please reference XAxiEthernet_AddExtMulticastGroup for multicast address index and bit value calculation.

-

In table, hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group.

-

There is a scenario that might introduce issues: When multicast tables are programmed initially to accept 01:00:5E:12:34:56 and 01:00:5E:12:34:78 but later decided to clear 01:00:5E:12:34:78. Without validating all possible combinations at the indexed entry, multicast table might be misconfigured and drop frames.

-

When clearing a multicast address table entry, note that a whole group of mac addresses will no longer be accepted - this because an entry in the table represents multiple(256) mac addresses.

-

The device must be stopped to use this function.
-
- This API operates at a group (256 MAC addresses) level for hardware to perform the first layer address filtering. It is user's responsibility to provision this table appropriately.

- +
Note:
+Please reference XAxiEthernet_AddExtMulticastGroup for multicast address index and bit value calculation.

+In table, hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group.

+There is a scenario that might introduce issues: When multicast tables are programmed initially to accept 01:00:5E:12:34:56 and 01:00:5E:12:34:78 but later decided to clear 01:00:5E:12:34:78. Without validating all possible combinations at the indexed entry, multicast table might be misconfigured and drop frames.

+When clearing a multicast address table entry, note that a whole group of mac addresses will no longer be accepted - this because an entry in the table represents multiple(256) mac addresses.

+The device must be stopped to use this function.
+
+ This API operates at a group (256 MAC addresses) level for hardware to perform the first layer address filtering. It is user's responsibility to provision this table appropriately.

-
- +

+

- + @@ -1965,34 +2147,33 @@ - +
int XAxiEthernet_ClearOptions int XAxiEthernet_ClearOptions ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_ClearOptions clears the options, Options for the Axi Ethernet, specified by InstancePtr. Axi Ethernet should be stopped with XAxiEthernet_Stop() before changing options.

-
Parameters:
+ +

+XAxiEthernet_ClearOptions clears the options, Options for the Axi Ethernet, specified by InstancePtr. Axi Ethernet should be stopped with XAxiEthernet_Stop() before changing options.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Options is a bitmask of OR'd XAE_*_OPTION values for options to clear. Options not specified are not affected.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the device has not been stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the device has not been stopped.
-
Note:
See xaxiethernet.h for a description of the available options.
+
Note:
See xaxiethernet.h for a description of the available options.
-
- +

+

- + @@ -2006,118 +2187,118 @@ - +
int XAxiEthernet_ClearTpid int XAxiEthernet_ClearTpid ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_ClearTpid clears the VLAN Tag Protocol Identifier(TPID).

-
Parameters:
+ +

+XAxiEthernet_ClearTpid clears the VLAN Tag Protocol Identifier(TPID).

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Entry is the hardware storage location to program this address and must be between 0..XAE_TPID_MAX_ENTRIES.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the VLAN tag capability.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the VLAN tag capability.
-
Note:
The device must be stopped to use this function.
+
Note:
The device must be stopped to use this function.
-
- +

+

- + - + - +
void XAxiEthernet_DisableControlFrameLenCheck void XAxiEthernet_DisableControlFrameLenCheck ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_DisableControlFrameLenCheck is used to disable the length check for control frames (pause frames). This means once the API is called, control frames larger than the minimum frame length are accepted.

-
Parameters:
+ +

+XAxiEthernet_DisableControlFrameLenCheck is used to disable the length check for control frames (pause frames). This means once the API is called, control frames larger than the minimum frame length are accepted.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + - + - +
void XAxiEthernet_DumpExtMulticastGroup void XAxiEthernet_DumpExtMulticastGroup ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_DumpExtMulticastGroup dumps ALL provisioned acceptable multicast MAC in the Axi Ethernet device's multicast table.

-
Parameters:
+ +

+XAxiEthernet_DumpExtMulticastGroup dumps ALL provisioned acceptable multicast MAC in the Axi Ethernet device's multicast table.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
-

Hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a set.

-

This API operates at a set (256 MAC addresses) level.

- +
Returns:
None.
+
Note:
+Hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a set.

+This API operates at a set (256 MAC addresses) level.

-
- +

+

- + - + - +
void XAxiEthernet_EnableControlFrameLenCheck void XAxiEthernet_EnableControlFrameLenCheck ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_EnableControlFrameLenCheck is used to enable the length check for control frames (pause frames). After calling the API, all control frames received will be checked for proper length (less than minimum frame length). By default, upon normal start up, control frame length check is enabled. Hence this API needs to be called only if previously the control frame length check has been disabled by calling the API XAxiEthernet_DisableControlFrameLenCheck.

-
Parameters:
+ +

+XAxiEthernet_EnableControlFrameLenCheck is used to enable the length check for control frames (pause frames). After calling the API, all control frames received will be checked for proper length (less than minimum frame length). By default, upon normal start up, control frame length check is enabled. Hence this API needs to be called only if previously the control frame length check has been disabled by calling the API XAxiEthernet_DisableControlFrameLenCheck.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + @@ -2131,35 +2312,33 @@ - +
int XAxiEthernet_GetExtMulticastGroup int XAxiEthernet_GetExtMulticastGroup ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetExtMulticastGroup returns whether the given Ethernet address group is stored in the table.

-
Parameters:
+ +

+XAxiEthernet_GetExtMulticastGroup returns whether the given Ethernet address group is stored in the table.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a pointer to the 6-byte Ethernet address.
-
-
Returns:
    -
  • TRUE if it is an acceptable multicast MAC address and the group is present in the table.
    • -
  • FALSE if it is not a valid multicast MAC address or the group was not found in the table.
    • -
+
Returns:
    +
  • TRUE if it is an acceptable multicast MAC address and the group is present in the table.
  • FALSE if it is not a valid multicast MAC address or the group was not found in the table.
-
Note:
-

In the table, hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group. This API operates at a group (256 MAC addresses) level.

- +
Note:
+In the table, hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group. This API operates at a group (256 MAC addresses) level.
-
- +

+

- + @@ -2173,31 +2352,31 @@ - +
void XAxiEthernet_GetMacAddress void XAxiEthernet_GetMacAddress ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetMacAddress gets the MAC address for the Axi Ethernet, specified by InstancePtr into the memory buffer specified by AddressPtr.

-
Parameters:
+ +

+XAxiEthernet_GetMacAddress gets the MAC address for the Axi Ethernet, specified by InstancePtr into the memory buffer specified by AddressPtr.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr references the memory buffer to store the retrieved MAC address. This memory buffer must be at least 6 bytes in length.
-
-
Returns:
None.
-
Note:
-

This routine also supports the extended/new VLAN and multicast mode. The XAE_RAF_NEWFNCENBL_MASK bit dictates which offset will be configured.

- +
Returns:
None.
+
Note:
+This routine also supports the extended/new VLAN and multicast mode. The XAE_RAF_NEWFNCENBL_MASK bit dictates which offset will be configured.
-
- +

+

- + @@ -2211,84 +2390,87 @@ - +
void XAxiEthernet_GetMacPauseAddress void XAxiEthernet_GetMacPauseAddress ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetMacPauseAddress gets the MAC address used for pause frames for the Axi Ethernet device specified by InstancePtr.

-
Parameters:
+ +

+XAxiEthernet_GetMacPauseAddress gets the MAC address used for pause frames for the Axi Ethernet device specified by InstancePtr.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr references the memory buffer to store the retrieved MAC address. This memory buffer must be at least 6 bytes in length.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + - + - +
u16 XAxiEthernet_GetOperatingSpeed u16 XAxiEthernet_GetOperatingSpeed ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_GetOperatingSpeed gets the current operating link speed. This may be the value set by XAxiEthernet_SetOperatingSpeed() or a hardware default.

-
Parameters:
+ +

+XAxiEthernet_GetOperatingSpeed gets the current operating link speed. This may be the value set by XAxiEthernet_SetOperatingSpeed() or a hardware default.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
Returns the link speed in units of megabits per second (10 / 100 / 1000). Can return a value of 0, in case it does not get a valid speed from EMMC.
-
Note:
None.
+
Returns:
Returns the link speed in units of megabits per second (10 / 100 / 1000). Can return a value of 0, in case it does not get a valid speed from EMMC.
+
Note:
None.
-
- +

+

- + - + - +
u32 XAxiEthernet_GetOptions u32 XAxiEthernet_GetOptions ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_GetOptions returns the current option settings.

-
Parameters:
+ +

+XAxiEthernet_GetOptions returns the current option settings.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
Returns a bitmask of XAE_*_OPTION constants, each bit specifying an option that is currently active.
-
Note:
See xaxiethernet.h for a description of the available options.
+
Returns:
Returns a bitmask of XAE_*_OPTION constants, each bit specifying an option that is currently active.
+
Note:
See xaxiethernet.h for a description of the available options.
-
- +

+

- + @@ -2314,36 +2496,35 @@ - +
int XAxiEthernet_GetRgmiiStatus int XAxiEthernet_GetRgmiiStatus ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetRgmiiStatus get the state of the link when using the RGMII media interface.

-
Parameters:
+ +

+XAxiEthernet_GetRgmiiStatus get the state of the link when using the RGMII media interface.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
SpeedPtr references the location to store the result, which is the auto negotiated link speed in units of Mbits/sec, either 0, 10, 100, or 1000.
IsFullDuplexPtr references the value that is set by this function to indicate full duplex operation. IsFullDuplexPtr is set to TRUE when the RGMII link is operating in full duplex mode, otherwise it is set to FALSE.
IsLinkUpPtr references the value that is set by this function to indicate the link status.IsLinkUpPtr is set to TRUE when the RGMII link up, otherwise it is set to FALSE.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_NO_FEATURE if the Axi Ethernet device is not using an RGMII interface,
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_NO_FEATURE if the Axi Ethernet device is not using an RGMII interface,
-
Note:
None.
+
Note:
None.
-
- +

+

- + @@ -2357,34 +2538,33 @@ - +
int XAxiEthernet_GetSgmiiStatus int XAxiEthernet_GetSgmiiStatus ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetSgmiiStatus get the state of the link when using the SGMII media interface.

-
Parameters:
+ +

+XAxiEthernet_GetSgmiiStatus get the state of the link when using the SGMII media interface.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
SpeedPtr references the location to store the result, which is the auto negotiated link speed in units of Mbits/sec, either 0, 10, 100, or 1000.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_NO_FEATURE if the Axi Ethernet device is not using an SGMII interface,
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_NO_FEATURE if the Axi Ethernet device is not using an SGMII interface,
-
Note:
Currently SGMII PHY does not support half duplex mode.
+
Note:
Currently SGMII PHY does not support half duplex mode.
-
- +

+

- + @@ -2404,31 +2584,32 @@ - +
void XAxiEthernet_GetTpid void XAxiEthernet_GetTpid ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetTpid gets the VLAN Tag Protocol Identifier value (TPID).

-
Parameters:
+ +

+XAxiEthernet_GetTpid gets the VLAN Tag Protocol Identifier value (TPID).

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
TpidPtr references the location to store the result.
Entry is the hardware storage location to program this address and must be between 0..XAE_TPID_MAX_ENTRIES.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + @@ -2466,16 +2647,18 @@ - +
void XAxiEthernet_GetVidTable void XAxiEthernet_GetVidTable ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetVidTable gets VID table content includes new VLAN ID, strip and tag enable bits.

-

The device must be stopped to use this function.
-
-

-
Parameters:
+ +

+XAxiEthernet_GetVidTable gets VID table content includes new VLAN ID, strip and tag enable bits.

+The device must be stopped to use this function.
+
+

+

Parameters:
@@ -2484,21 +2667,19 @@
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Entry is the hardware storage location/index to program updated VID value, strip, or tag value. The value must be between 0..0xFFF.
TagPtr references the location to store the result. This function stores the tag enable bit value indexed by Entry into this location.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
None.
-
Note:
-

The hardware requires the table to be 'indexed' with Entry and must be 0x000..0xFFF.

-

Bits layout is bbbb bbbb bbbb b b VLAN ID (12b), | | | VLAN double tag enable bit VLAN strip enable bit

- +
Returns:
None.
+
Note:
+The hardware requires the table to be 'indexed' with Entry and must be 0x000..0xFFF.

+Bits layout is bbbb bbbb bbbb b b VLAN ID (12b), | | | VLAN double tag enable bit VLAN strip enable bit

-
- +

+

- + @@ -2518,32 +2699,32 @@ - +
void XAxiEthernet_GetVStripMode void XAxiEthernet_GetVStripMode ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetVStripMode gets the VLAN stripping mode.

-
Parameters:
+ +

+XAxiEthernet_GetVStripMode gets the VLAN stripping mode.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
ModePtr references the location to store the VLAN strip mode returned by this function. Value is b'00, b'01 or b'11. Refer XAE_VTSRAP_* in xaxiethernet.h file for the details.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
None.
-
Note:
-

Mode value shifting is handled in this function. No shifting is required to call this function.

- +
Returns:
None.
+
Note:
+Mode value shifting is handled in this function. No shifting is required to call this function.
-
- +

+

- + @@ -2563,34 +2744,34 @@ - +
void XAxiEthernet_GetVTagMode void XAxiEthernet_GetVTagMode ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetVTagMode gets VLAN tagging mode.

-
Parameters:
+ +

+XAxiEthernet_GetVTagMode gets VLAN tagging mode.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
ModePtr references the location to store the VLAN tag mode. Value is between b'00-b'11.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
None.
-
Note:
-

The device must be stopped to use this function.
-
- Mode value shifting is handled in this function. No shifting is required to call this function.

- +
Returns:
None.
+
Note:
+The device must be stopped to use this function.
+
+ Mode value shifting is handled in this function. No shifting is required to call this function.
-
- +

+

- + @@ -2610,62 +2791,61 @@ - +
void XAxiEthernet_GetVTagValue void XAxiEthernet_GetVTagValue ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetVTagValue gets the configured VLAN tagging value.

-
Parameters:
+ +

+XAxiEthernet_GetVTagValue gets the configured VLAN tagging value.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
VTagValuePtr references the location to store the result. Format is TPID, one of the following 16 bit values, 0x8100, 0x88a8, 0x9100, 0x9200. Priority, 3 bits CFI, 1 bit VID, 12 bits
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
None.
-
Note:
-

Ethernet VLAN frames' VLAN type/length(2B) and tag control information(2B). Bit layout : bbbb bbbb bbbb bbbb bbb b bbbb bbbb bbbb \ / | | \ VID (12b) / \ / | CFI bit (1b) TPID (16b) priority bit (3b)

- +
Returns:
None.
+
Note:
+Ethernet VLAN frames' VLAN type/length(2B) and tag control information(2B). Bit layout : bbbb bbbb bbbb bbbb bbb b bbbb bbbb bbbb \ / | | \ VID (12b) / \ / | CFI bit (1b) TPID (16b) priority bit (3b)
-
- +

+

- + - + - +
XAxiEthernet_Config* XAxiEthernet_LookupConfig XAxiEthernet_Config* XAxiEthernet_LookupConfig ( u16  DeviceId DeviceId  ) 
-

XAxiEthernet_LookupConfig returns a reference to an XAxiEthernet_Config structure based on an unique device id, DeviceId. The return value will refer to an entry in the device configuration table defined in the xaxiethernet_g.c file.

-
Parameters:
+ +

+XAxiEthernet_LookupConfig returns a reference to an XAxiEthernet_Config structure based on an unique device id, DeviceId. The return value will refer to an entry in the device configuration table defined in the xaxiethernet_g.c file.

+

Parameters:
DeviceId is the unique device ID of the device for the lookup operation.
-
-
Returns:
    -
  • Returns a reference to a config record in the configuration table (in xaxiethernet_g.c) corresponding to DeviceId, or NULL
    • -
  • NULL if no match is found.
    • -
+
Returns:
    +
  • Returns a reference to a config record in the configuration table (in xaxiethernet_g.c) corresponding to DeviceId, or NULL
  • NULL if no match is found.
-
- +

+

- + @@ -2685,43 +2865,41 @@ - +
int XAxiEthernet_MulticastAdd int XAxiEthernet_MulticastAdd ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_MulticastAdd adds the Ethernet address, AddressPtr to the Axi Ethernet device's multicast filter list, at list index Entry. The address referenced by AddressPtr may be of any unicast, multicast, or broadcast address form. The hardware for the Axi Ethernet device can hold up to XAE_MULTI_MAT_ENTRIES addresses in this filter list.
-
-

-

The device must be stopped to use this function.
-
-

-

Once an Ethernet address is programmed, the Axi Ethernet device will begin receiving data sent from that address. The Axi Ethernet hardware does not have a control bit to disable multicast filtering. The only way to prevent the Axi Ethernet device from receiving messages from an Ethernet address in the Multicast Address Table (MAT) is to clear it with XAxiEthernet_MulticastClear().

-
Parameters:
+ +

+XAxiEthernet_MulticastAdd adds the Ethernet address, AddressPtr to the Axi Ethernet device's multicast filter list, at list index Entry. The address referenced by AddressPtr may be of any unicast, multicast, or broadcast address form. The hardware for the Axi Ethernet device can hold up to XAE_MULTI_MAT_ENTRIES addresses in this filter list.
+
+

+The device must be stopped to use this function.
+
+

+Once an Ethernet address is programmed, the Axi Ethernet device will begin receiving data sent from that address. The Axi Ethernet hardware does not have a control bit to disable multicast filtering. The only way to prevent the Axi Ethernet device from receiving messages from an Ethernet address in the Multicast Address Table (MAT) is to clear it with XAxiEthernet_MulticastClear().

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a pointer to the 6-byte Ethernet address to set. The previous address at the location Entry (if any) is overwritten with the value at AddressPtr.
Entry is the hardware storage location to program this address and must be between 0 to (XAE_MULTI_MAT_ENTRIES - 1).
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED.if the Axi Ethernet device is not stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED.if the Axi Ethernet device is not stopped.
-
Note:
-

This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

-

To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

- +
Note:
+This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

+To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

-
- +

+

- + @@ -2735,41 +2913,39 @@ - +
int XAxiEthernet_MulticastClear int XAxiEthernet_MulticastClear ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_MulticastClear clears the Ethernet address stored at index Entry in the Axi Ethernet device's multicast filter list.
-
-

-

The device must be stopped to use this function.
-
-

-
Parameters:
+ +

+XAxiEthernet_MulticastClear clears the Ethernet address stored at index Entry in the Axi Ethernet device's multicast filter list.
+
+

+The device must be stopped to use this function.
+
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Entry is the HW storage location used when this address was added. It must be between 0 to (XAE_MULTI_MAT_ENTRIES - 1).
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED.if the Axi Ethernet device is not stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED.if the Axi Ethernet device is not stopped.
-
Note:
-

This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

-

To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

- +
Note:
+This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

+To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

-
- +

+

- + @@ -2789,35 +2965,35 @@ - +
void XAxiEthernet_MulticastGet void XAxiEthernet_MulticastGet ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_MulticastGet gets the Ethernet address stored at index Entry in the Axi Ethernet device's multicast filter list.
-
-

-
Parameters:
+ +

+XAxiEthernet_MulticastGet gets the Ethernet address stored at index Entry in the Axi Ethernet device's multicast filter list.
+
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr references the memory buffer to store the retrieved Ethernet address. This memory buffer must be at least 6 bytes in length.
Entry is the hardware storage location from which to retrieve the address and must be between 0 to (XAE_MULTI_MAT_ENTRIES - 1)
-
-
Returns:
None.
-
Note:
-

This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

-

To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

- +
Returns:
None.
+
Note:
+This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

+To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

-
- +

+

- + @@ -2843,20 +3019,22 @@ - +
void XAxiEthernet_PhyRead void XAxiEthernet_PhyRead ( XAxiEthernet *  InstancePtr,
)
+

+

-
- +

+

- + @@ -2870,35 +3048,37 @@ - +
void XAxiEthernet_PhySetMdioDivisor void XAxiEthernet_PhySetMdioDivisor ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_PhySetMdioDivisor sets the MDIO clock divisor in the Axi Ethernet,specified by InstancePtr to the value, Divisor. This function must be called once after each reset prior to accessing MII PHY registers.

-

From the Virtex-6(TM) and Spartan-6 (TM) Embedded Tri-Mode Ethernet MAC User's Guide, the following equation governs the MDIO clock to the PHY:

+ +

+XAxiEthernet_PhySetMdioDivisor sets the MDIO clock divisor in the Axi Ethernet,specified by InstancePtr to the value, Divisor. This function must be called once after each reset prior to accessing MII PHY registers.

+From the Virtex-6(TM) and Spartan-6 (TM) Embedded Tri-Mode Ethernet MAC User's Guide, the following equation governs the MDIO clock to the PHY:

 			f[HOSTCLK]
 	f[MDC] = -----------------------
 			(1 + Divisor) * 2
-

where f[HOSTCLK] is the bus clock frequency in MHz, and f[MDC] is the MDIO clock frequency in MHz to the PHY. Typically, f[MDC] should not exceed 2.5 MHz. Some PHYs can tolerate faster speeds which means faster access.

-
Parameters:
+

+where f[HOSTCLK] is the bus clock frequency in MHz, and f[MDC] is the MDIO clock frequency in MHz to the PHY. Typically, f[MDC] should not exceed 2.5 MHz. Some PHYs can tolerate faster speeds which means faster access.

+

Parameters:
InstancePtr references the Axi Ethernet instance on which to operate.
Divisor is the divisor value to set within the range of 0 to XAE_MDIO_MC_CLK_DVD_MAX.
-
-
Note:
None.
+
Note:
None.
-
- +

+

- + @@ -2924,46 +3104,49 @@ - +
void XAxiEthernet_PhyWrite void XAxiEthernet_PhyWrite ( XAxiEthernet *  InstancePtr,
)
+

+

-
- +

+

- + - + - +
void XAxiEthernet_Reset void XAxiEthernet_Reset ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_Reset does not perform a soft reset of the AxiEthernet core. AxiEthernet hardware is reset by the device connected to the AXI4-Stream interface. This function inserts some delay before proceeding to check for MgtRdy bit. The delay is necessary to be at a safe side. It takes a while for the reset process to complete and for any of the AxiEthernet registers to be accessed. It then checks for MgtRdy bit in IS register to know if AxiEthernet reset is completed or not. Subsequently it calls one more driver function to complete the AxiEthernet hardware initialization.

-
Parameters:
+ +

+XAxiEthernet_Reset does not perform a soft reset of the AxiEthernet core. AxiEthernet hardware is reset by the device connected to the AXI4-Stream interface. This function inserts some delay before proceeding to check for MgtRdy bit. The delay is necessary to be at a safe side. It takes a while for the reset process to complete and for any of the AxiEthernet registers to be accessed. It then checks for MgtRdy bit in IS register to know if AxiEthernet reset is completed or not. Subsequently it calls one more driver function to complete the AxiEthernet hardware initialization.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Note:
It is the responsibility of the user to reset the AxiEthernet hardware before using it. AxiEthernet hardware should be reset through the device connected to the AXI4-Stream interface of AxiEthernet.
+
Note:
It is the responsibility of the user to reset the AxiEthernet hardware before using it. AxiEthernet hardware should be reset through the device connected to the AXI4-Stream interface of AxiEthernet.
-
- +

+

- + @@ -2977,61 +3160,61 @@ - +
int XAxiEthernet_SendPausePacket int XAxiEthernet_SendPausePacket ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SendPausePacket sends a pause packet with the value of PauseValue.

-
Parameters:
+ +

+XAxiEthernet_SendPausePacket sends a pause packet with the value of PauseValue.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
PauseValue is the pause value in units of 512 bit times.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
-
Note:
None.
+
Note:
None.
-
- +

+

- + - + - +
void XAxiEthernet_SetBadFrmRcvOption void XAxiEthernet_SetBadFrmRcvOption ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_SetBadFrmRcvOption is used to enable the bad frame receive option. If enabled, this option ensures that bad receive frames are allowed and passed to the AXI4-Stream interface as if they are good frames.

-
Parameters:
+ +

+XAxiEthernet_SetBadFrmRcvOption is used to enable the bad frame receive option. If enabled, this option ensures that bad receive frames are allowed and passed to the AXI4-Stream interface as if they are good frames.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
None
+
Returns:
None.
+
Note:
None
-
- +

+

- + @@ -3045,34 +3228,33 @@ - +
int XAxiEthernet_SetMacAddress int XAxiEthernet_SetMacAddress ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetMacAddress sets the MAC address for the Axi Ethernet device, specified by InstancePtr to the MAC address specified by AddressPtr. The Axi Ethernet device must be stopped before calling this function.

-
Parameters:
+ +

+XAxiEthernet_SetMacAddress sets the MAC address for the Axi Ethernet device, specified by InstancePtr to the MAC address specified by AddressPtr. The Axi Ethernet device must be stopped before calling this function.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a reference to the 6-byte MAC address to set.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device has not stopped,
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device has not stopped,
-
Note:
This routine also supports the extended/new VLAN and multicast mode. The XAE_RAF_NEWFNCENBL_MASK bit dictates which offset will be configured.
+
Note:
This routine also supports the extended/new VLAN and multicast mode. The XAE_RAF_NEWFNCENBL_MASK bit dictates which offset will be configured.
-
- +

+

- + @@ -3086,34 +3268,33 @@ - +
int XAxiEthernet_SetMacPauseAddress int XAxiEthernet_SetMacPauseAddress ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetMacPauseAddress sets the MAC address used for pause frames to AddressPtr. AddressPtr will be the address the Axi Ethernet device will recognize as being for pause frames. Pause frames transmitted with XAxiEthernet_SendPausePacket() will also use this address.

-
Parameters:
+ +

+XAxiEthernet_SetMacPauseAddress sets the MAC address used for pause frames to AddressPtr. AddressPtr will be the address the Axi Ethernet device will recognize as being for pause frames. Pause frames transmitted with XAxiEthernet_SendPausePacket() will also use this address.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a pointer to the 6-byte Ethernet address to set.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
-
Note:
None.
+
Note:
None.
-
- +

+

- + @@ -3127,33 +3308,33 @@ - +
int XAxiEthernet_SetOperatingSpeed int XAxiEthernet_SetOperatingSpeed ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetOperatingSpeed sets the current operating link speed. For any traffic to be passed, this speed must match the current MII/GMII/SGMII/RGMII link speed.

-
Parameters:
+ +

+XAxiEthernet_SetOperatingSpeed sets the current operating link speed. For any traffic to be passed, this speed must match the current MII/GMII/SGMII/RGMII link speed.

+

Parameters:
InstancePtr references the Axi Ethernet on which to operate.
Speed is the speed to set in units of Mbps. Valid values are 10, 100, or 1000.
-
-
Returns:
- XST_SUCCESS on successful setting of speed.
    -
  • XST_FAILURE, if the speed cannot be set for the present harwdare configuration.
    • -
+
Returns:
- XST_SUCCESS on successful setting of speed.
    +
  • XST_FAILURE, if the speed cannot be set for the present harwdare configuration.
-
Note:
None.
+
Note:
None.
-
- +

+

- + @@ -3167,34 +3348,33 @@ - +
int XAxiEthernet_SetOptions int XAxiEthernet_SetOptions ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetOptions enables the options, Options for the Axi Ethernet, specified by InstancePtr. Axi Ethernet should be stopped with XAxiEthernet_Stop() before changing options.

-
Parameters:
+ +

+XAxiEthernet_SetOptions enables the options, Options for the Axi Ethernet, specified by InstancePtr. Axi Ethernet should be stopped with XAxiEthernet_Stop() before changing options.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Options is a bitmask of OR'd XAE_*_OPTION values for options to set. Options not specified are not affected.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the device has not been stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the device has not been stopped.
-
Note:
See xaxiethernet.h for a description of the available options.
+
Note:
See xaxiethernet.h for a description of the available options.
-
- +

+

- + @@ -3214,38 +3394,35 @@ - +
int XAxiEthernet_SetTpid int XAxiEthernet_SetTpid ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetTpid sets the VLAN Tag Protocol Identifier(TPID).

-

Four values can be configured - 0x8100, 0x9100, 0x9200, 0x88A8.

-
Parameters:
+ +

+XAxiEthernet_SetTpid sets the VLAN Tag Protocol Identifier(TPID).

+Four values can be configured - 0x8100, 0x9100, 0x9200, 0x88A8.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Tpid is a hex value to be added to the TPID table. The four values that can be added are 0x8100, 0x9100, 0x9200, 0x88A8.
Entry is the hardware storage location to program this address and must be between 0..XAE_TPID_MAX_ENTRIES.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED, if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the VLAN tag capability.
    • -
  • XST_INVALID_PARAM if Tpid is not one of supported values.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED, if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the VLAN tag capability.
  • XST_INVALID_PARAM if Tpid is not one of supported values.
-
Note:
The device must be stopped to use this function.
+
Note:
The device must be stopped to use this function.
-
- +

+

- + @@ -3283,16 +3460,18 @@ - +
int XAxiEthernet_SetVidTable int XAxiEthernet_SetVidTable ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetVidTable sets VID table includes new VLAN ID, strip and tag enable bits.

-

The device must be stopped to use this function.
-
-

-
Parameters:
+ +

+XAxiEthernet_SetVidTable sets VID table includes new VLAN ID, strip and tag enable bits.

+The device must be stopped to use this function.
+
+

+

Parameters:
@@ -3301,27 +3480,22 @@
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Entry is the hardware storage location/index to program updated VID value, strip, or tag value. The value must be between 0..0xFFF.
Tag is tag enable indication for Vid.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable/have extended functionalities.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable/have extended functionalities.
-
Note:
-

The hardware requires the table to be 'indexed' with Entry and must be 0x000..0xFFF.

-

Bits layout is bbbb bbbb bbbb b b VLAN ID (12b), | | | VLAN double tag enable bit VLAN strip enable bit

-

To disable translation indexed by Entry, Set Vid = Entry.

- +
Note:
+The hardware requires the table to be 'indexed' with Entry and must be 0x000..0xFFF.

+Bits layout is bbbb bbbb bbbb b b VLAN ID (12b), | | | VLAN double tag enable bit VLAN strip enable bit

+To disable translation indexed by Entry, Set Vid = Entry.

-
- +

+

- + @@ -3341,47 +3515,40 @@ - +
int XAxiEthernet_SetVStripMode int XAxiEthernet_SetVStripMode ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetVStripMode configures the VLAN strip mode.

-

Three modes can be configured :

- -
Parameters:
+ +

+XAxiEthernet_SetVStripMode configures the VLAN strip mode.

+Three modes can be configured :

    +
  • XAE_VSTRP_NONE for no stripping.
  • XAE_VSTRP_ALL to strip one tag from all frames.
  • XAE_VSTRP_SELECT to strip one tag from already selected tagged frames based on VID value.
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Mode is the VLAN strip mode. Value must be b'00, b'01, or b'11.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion., returns XST_SUCCESS.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the TX VLAN strip capability.
    • -
  • XST_INVALID_PARAM if Mode is not one of supported modes.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion., returns XST_SUCCESS.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the TX VLAN strip capability.
  • XST_INVALID_PARAM if Mode is not one of supported modes.
-
Note:
-

The device must be stopped to use this function.
-
- The third mode (specified by XAE_VSTRP_SELECT) requires a method for specifying which tagged frames should be stripped. The VLAN translation table 'stripped enabled' is referenced. That configuration is handled in XAxiEthernet_SetVidTable().

-

Mode value shifting is handled in this function. No shifting is required to call this function.

- +
Note:
+The device must be stopped to use this function.
+
+ The third mode (specified by XAE_VSTRP_SELECT) requires a method for specifying which tagged frames should be stripped. The VLAN translation table 'stripped enabled' is referenced. That configuration is handled in XAxiEthernet_SetVidTable().

+Mode value shifting is handled in this function. No shifting is required to call this function.

-
- +

+

- + @@ -3401,49 +3568,41 @@ - +
int XAxiEthernet_SetVTagMode int XAxiEthernet_SetVTagMode ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetVTagMode configures the VLAN tagging mode.

-

Four modes can be configured,

- -
Parameters:
+ +

+XAxiEthernet_SetVTagMode configures the VLAN tagging mode.

+Four modes can be configured,

    +
  • XAE_VTAG_NONE for no tagging.
  • XAE_VTAG_ALL to tag all frames.
  • XAE_VTAG_EXISTED to tag already tagged frames.
  • XAE_VTAG_SELECT to tag selected already tagged frames based on VID value.
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Mode is the VLAN tag mode. Value must be between b'00-b'11.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
    -
  • XST_SUCCESS. on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the TX VLAN tag capability.
    • -
  • XST_INVALID_PARAM if Mode is not one of supported modes.
    • -
+
Returns:
    +
  • XST_SUCCESS. on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the TX VLAN tag capability.
  • XST_INVALID_PARAM if Mode is not one of supported modes.
-
Note:
-

The device must be stopped to use this function.
-
-

-

The fourth mode (specified by XAE_VTAG_SELECT) requires a method for specifying which tagged frames should receive an additional VLAN tag. The VLAN translation table 'tag enabled' is referenced. That configuration is handled in XAxiEthernet_SetVidTable().

-

Mode value shifting is handled in this function. No shifting is required to call this function.

- +
Note:
+The device must be stopped to use this function.
+
+

+The fourth mode (specified by XAE_VTAG_SELECT) requires a method for specifying which tagged frames should receive an additional VLAN tag. The VLAN translation table 'tag enabled' is referenced. That configuration is handled in XAxiEthernet_SetVidTable().

+Mode value shifting is handled in this function. No shifting is required to call this function.

-
- +

+

- + @@ -3463,103 +3622,92 @@ - +
int XAxiEthernet_SetVTagValue int XAxiEthernet_SetVTagValue ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetVTagValue configures the VLAN tagging value.

-

The device must be stopped to use this function.
-
-

-
Parameters:
+ +

+XAxiEthernet_SetVTagValue configures the VLAN tagging value.

+The device must be stopped to use this function.
+
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
VTagValue is the VLAN tag value to be configured. A 32bit value. TPID, one of the following 16 bit values, 0x8100, 0x88a8, 0x9100, 0x9200. Priority, 3 bits CFI, 1 bit VID, 12 bits
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion, returns .
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable/have TX VLAN tag capability.
    • -
  • XST_INVALID_PARAM, if the TPID is not one the four supported values.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion, returns .
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable/have TX VLAN tag capability.
  • XST_INVALID_PARAM, if the TPID is not one the four supported values.
-
Note:
-

The four supported TPID values are 0x8100, 0x88a8, 0x9100, 0x9200. XAxiEthernet_SetVTagValue performs verification on TPID only.

-

Ethernet VLAN frames' VLAN type/length(2B) and tag control information(2B). Bit layout : bbbb bbbb bbbb bbbb bbb b bbbb bbbb bbbb \ / | | \ VID (12b) / \ / | CFI bit (1b) TPID (16b) priority bit (3b)

- +
Note:
+The four supported TPID values are 0x8100, 0x88a8, 0x9100, 0x9200. XAxiEthernet_SetVTagValue performs verification on TPID only.

+Ethernet VLAN frames' VLAN type/length(2B) and tag control information(2B). Bit layout : bbbb bbbb bbbb bbbb bbb b bbbb bbbb bbbb \ / | | \ VID (12b) / \ / | CFI bit (1b) TPID (16b) priority bit (3b)

-
- +

+

- + - + - +
void XAxiEthernet_Start void XAxiEthernet_Start ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_Start starts the Axi Ethernet device as follows:

- -
Parameters:
+ +

+XAxiEthernet_Start starts the Axi Ethernet device as follows:

    +
  • Enable transmitter if XAE_TRANSMIT_ENABLE_OPTION is set
  • Enable receiver if XAE_RECEIVER_ENABLE_OPTION is set
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + - + - +
void XAxiEthernet_Stop void XAxiEthernet_Stop ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_Stop gracefully stops the Axi Ethernet device as follows:

- -

XAxiEthernet_Stop does not modify any of the current device options.

-

Since the transmitter is not disabled, frames currently in internal buffers or in process by a DMA engine are allowed to be transmitted.

-
Parameters:
+ +

+XAxiEthernet_Stop gracefully stops the Axi Ethernet device as follows:

    +
  • Disable all interrupts from this device
  • Disable the receiver
+

+XAxiEthernet_Stop does not modify any of the current device options.

+Since the transmitter is not disabled, frames currently in internal buffers or in process by a DMA engine are allowed to be transmitted.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None
-
Note:
None.
+
Returns:
None
+
Note:
None.
-
- -

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - +

+Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__control_8c.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__control_8c.html old mode 100644 new mode 100755 index d6c706a5..b5ae8625 --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__control_8c.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__control_8c.html @@ -2,77 +2,95 @@ - Xilinx Driver axiethernet v4_2: xaxiethernet_control.c File Reference + xaxiethernet_control.c File Reference - +

Xilinx Processor IP Library

Software Drivers
- - - -
-

xaxiethernet_control.c File Reference

#include "xaxiethernet.h"
- - - - - - - - - - - - - - - - - - - - - - - - - -

Functions

int XAxiEthernet_MulticastAdd (XAxiEthernet *InstancePtr, void *AddressPtr, int Entry)
void XAxiEthernet_MulticastGet (XAxiEthernet *InstancePtr, void *AddressPtr, int Entry)
int XAxiEthernet_MulticastClear (XAxiEthernet *InstancePtr, int Entry)
int XAxiEthernet_SetMacPauseAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_GetMacPauseAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_SendPausePacket (XAxiEthernet *InstancePtr, u16 PauseValue)
int XAxiEthernet_GetSgmiiStatus (XAxiEthernet *InstancePtr, u16 *SpeedPtr)
int XAxiEthernet_GetRgmiiStatus (XAxiEthernet *InstancePtr, u16 *SpeedPtr, int *IsFullDuplexPtr, int *IsLinkUpPtr)
int XAxiEthernet_SetTpid (XAxiEthernet *InstancePtr, u16 Tpid, u8 Entry)
int XAxiEthernet_ClearTpid (XAxiEthernet *InstancePtr, u8 Entry)
void XAxiEthernet_GetTpid (XAxiEthernet *InstancePtr, u16 *TpidPtr, u8 Entry)
int XAxiEthernet_SetVTagMode (XAxiEthernet *InstancePtr, u32 Mode, int Dir)
void XAxiEthernet_GetVTagMode (XAxiEthernet *InstancePtr, u8 *ModePtr, int Dir)
int XAxiEthernet_SetVStripMode (XAxiEthernet *InstancePtr, u32 Mode, int Dir)
void XAxiEthernet_GetVStripMode (XAxiEthernet *InstancePtr, u8 *ModePtr, int Dir)
int XAxiEthernet_SetVTagValue (XAxiEthernet *InstancePtr, u32 VTagValue, int Dir)
void XAxiEthernet_GetVTagValue (XAxiEthernet *InstancePtr, u32 *VTagValuePtr, int Dir)
int XAxiEthernet_SetVidTable (XAxiEthernet *InstancePtr, u32 Entry, u32 Vid, u8 Strip, u8 Tag, int Dir)
void XAxiEthernet_GetVidTable (XAxiEthernet *InstancePtr, u32 Entry, u32 *VidPtr, u8 *StripPtr, u8 *TagPtr, int Dir)
int XAxiEthernet_AddExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_ClearExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_GetExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_DumpExtMulticastGroup (XAxiEthernet *InstancePtr)
-

Detailed Description

-

This file has driver APIs related to the controlling of the extended features of the AXI Ethernet device. Please note that APIs for turning on/off any of the driver features are present in axiethernet.c. This file takes care of controlling these features.

- -

See xaxiethernet.h for a detailed description of the driver.

+ +
+
+
+
+

xaxiethernet_control.c File Reference

Detailed Description

+This file has driver APIs related to the controlling of the extended features of the AXI Ethernet device. Please note that APIs for turning on/off any of the driver features are present in axiethernet.c. This file takes care of controlling these features. +

+See xaxiethernet.h for a detailed description of the driver.

- MODIFICATION HISTORY:
 Ver   Who  Date     Changes
+ MODIFICATION HISTORY:

+

 Ver   Who  Date     Changes
  ----- ---- -------- -------------------------------------------------------
  1.00a asa  6/30/10 First release based on the ll temac driver
-

Function Documentation

- + +

+#include "xaxiethernet.h"
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

int XAxiEthernet_MulticastAdd (XAxiEthernet *InstancePtr, void *AddressPtr, int Entry)
void XAxiEthernet_MulticastGet (XAxiEthernet *InstancePtr, void *AddressPtr, int Entry)
int XAxiEthernet_MulticastClear (XAxiEthernet *InstancePtr, int Entry)
int XAxiEthernet_SetMacPauseAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_GetMacPauseAddress (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_SendPausePacket (XAxiEthernet *InstancePtr, u16 PauseValue)
int XAxiEthernet_GetSgmiiStatus (XAxiEthernet *InstancePtr, u16 *SpeedPtr)
int XAxiEthernet_GetRgmiiStatus (XAxiEthernet *InstancePtr, u16 *SpeedPtr, int *IsFullDuplexPtr, int *IsLinkUpPtr)
int XAxiEthernet_SetTpid (XAxiEthernet *InstancePtr, u16 Tpid, u8 Entry)
int XAxiEthernet_ClearTpid (XAxiEthernet *InstancePtr, u8 Entry)
void XAxiEthernet_GetTpid (XAxiEthernet *InstancePtr, u16 *TpidPtr, u8 Entry)
int XAxiEthernet_SetVTagMode (XAxiEthernet *InstancePtr, u32 Mode, int Dir)
void XAxiEthernet_GetVTagMode (XAxiEthernet *InstancePtr, u8 *ModePtr, int Dir)
int XAxiEthernet_SetVStripMode (XAxiEthernet *InstancePtr, u32 Mode, int Dir)
void XAxiEthernet_GetVStripMode (XAxiEthernet *InstancePtr, u8 *ModePtr, int Dir)
int XAxiEthernet_SetVTagValue (XAxiEthernet *InstancePtr, u32 VTagValue, int Dir)
void XAxiEthernet_GetVTagValue (XAxiEthernet *InstancePtr, u32 *VTagValuePtr, int Dir)
int XAxiEthernet_SetVidTable (XAxiEthernet *InstancePtr, u32 Entry, u32 Vid, u8 Strip, u8 Tag, int Dir)
void XAxiEthernet_GetVidTable (XAxiEthernet *InstancePtr, u32 Entry, u32 *VidPtr, u8 *StripPtr, u8 *TagPtr, int Dir)
int XAxiEthernet_AddExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_ClearExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
int XAxiEthernet_GetExtMulticastGroup (XAxiEthernet *InstancePtr, void *AddressPtr)
void XAxiEthernet_DumpExtMulticastGroup (XAxiEthernet *InstancePtr)
+

Function Documentation

+
- + @@ -86,42 +104,39 @@ - +
int XAxiEthernet_AddExtMulticastGroup int XAxiEthernet_AddExtMulticastGroup ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_AddExtMulticastGroup adds an entry to the multicast Ethernet address table. The new entry, represents a group of MAC addresses based on the contents of AddressPtr. AddressPtr is one member of the MAC address set in the newly added entry.

-

The device must be stopped to use this function.
-
-

-

Once an Ethernet address is programmed, the Axi Ethernet device will begin receiving data sent from that address. The Axi Ethernet hardware does not have a control bit to disable multicast filtering. The only way to prevent the Axi Ethernet device from receiving messages from an Ethernet address in the multicast table is to clear it with XAxiEthernet_ClearExtMulticastGroup().

-
Parameters:
+ +

+XAxiEthernet_AddExtMulticastGroup adds an entry to the multicast Ethernet address table. The new entry, represents a group of MAC addresses based on the contents of AddressPtr. AddressPtr is one member of the MAC address set in the newly added entry.

+The device must be stopped to use this function.
+
+

+Once an Ethernet address is programmed, the Axi Ethernet device will begin receiving data sent from that address. The Axi Ethernet hardware does not have a control bit to disable multicast filtering. The only way to prevent the Axi Ethernet device from receiving messages from an Ethernet address in the multicast table is to clear it with XAxiEthernet_ClearExtMulticastGroup().

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a pointer to the 6-byte Ethernet address to add.
-
-
Returns:
    -
  • XST_SUCCESS.on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_INVALID_PARAM if the input MAC address is not between 01:00:5E:00:00:00 and 01:00:5E:7F:FF:FF per RFC1112.
    • -
+
Returns:
    +
  • XST_SUCCESS.on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_INVALID_PARAM if the input MAC address is not between 01:00:5E:00:00:00 and 01:00:5E:7F:FF:FF per RFC1112.
-
Note:
-

This routine consider all 2**23 possible multicast Ethernet addresses to be 8Mx1 bit or 1M bytes memory area. All defined multicast addresses are from 01.00.5E.00.00.00 to 01.00.5E.7F.FF.FF The most significant 25 bit out of 48 bit are static, so they will not be part of calculation.

-

The hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group.

-

This API operates at a group (256 MAC addresses) for hardware to do the first layer address filtering. It is user's responsibility to provision this table appropriately.

- +
Note:
+This routine consider all 2**23 possible multicast Ethernet addresses to be 8Mx1 bit or 1M bytes memory area. All defined multicast addresses are from 01.00.5E.00.00.00 to 01.00.5E.7F.FF.FF The most significant 25 bit out of 48 bit are static, so they will not be part of calculation.

+The hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group.

+This API operates at a group (256 MAC addresses) for hardware to do the first layer address filtering. It is user's responsibility to provision this table appropriately.

-
- +

+

- + @@ -135,42 +150,39 @@ - +
int XAxiEthernet_ClearExtMulticastGroup int XAxiEthernet_ClearExtMulticastGroup ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_ClearExtMulticastGroup clears input multicast Ethernet address group from table.

-
Parameters:
+ +

+XAxiEthernet_ClearExtMulticastGroup clears input multicast Ethernet address group from table.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a pointer to the 6-byte Ethernet address to clear.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion, returns XST_SUCCESS.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped
    • -
  • XST_INVALID_PARAM if input MAC address is not between 01:00:5E:00:00:00 and 01:00:5E:7F:FF:FF per RFC1112.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion, returns XST_SUCCESS.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped
  • XST_INVALID_PARAM if input MAC address is not between 01:00:5E:00:00:00 and 01:00:5E:7F:FF:FF per RFC1112.
-
Note:
-

Please reference XAxiEthernet_AddExtMulticastGroup for multicast address index and bit value calculation.

-

In table, hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group.

-

There is a scenario that might introduce issues: When multicast tables are programmed initially to accept 01:00:5E:12:34:56 and 01:00:5E:12:34:78 but later decided to clear 01:00:5E:12:34:78. Without validating all possible combinations at the indexed entry, multicast table might be misconfigured and drop frames.

-

When clearing a multicast address table entry, note that a whole group of mac addresses will no longer be accepted - this because an entry in the table represents multiple(256) mac addresses.

-

The device must be stopped to use this function.
-
- This API operates at a group (256 MAC addresses) level for hardware to perform the first layer address filtering. It is user's responsibility to provision this table appropriately.

- +
Note:
+Please reference XAxiEthernet_AddExtMulticastGroup for multicast address index and bit value calculation.

+In table, hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group.

+There is a scenario that might introduce issues: When multicast tables are programmed initially to accept 01:00:5E:12:34:56 and 01:00:5E:12:34:78 but later decided to clear 01:00:5E:12:34:78. Without validating all possible combinations at the indexed entry, multicast table might be misconfigured and drop frames.

+When clearing a multicast address table entry, note that a whole group of mac addresses will no longer be accepted - this because an entry in the table represents multiple(256) mac addresses.

+The device must be stopped to use this function.
+
+ This API operates at a group (256 MAC addresses) level for hardware to perform the first layer address filtering. It is user's responsibility to provision this table appropriately.

-
- +

+

- + @@ -184,64 +196,62 @@ - +
int XAxiEthernet_ClearTpid int XAxiEthernet_ClearTpid ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_ClearTpid clears the VLAN Tag Protocol Identifier(TPID).

-
Parameters:
+ +

+XAxiEthernet_ClearTpid clears the VLAN Tag Protocol Identifier(TPID).

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Entry is the hardware storage location to program this address and must be between 0..XAE_TPID_MAX_ENTRIES.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the VLAN tag capability.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the VLAN tag capability.
-
Note:
The device must be stopped to use this function.
+
Note:
The device must be stopped to use this function.
-
- +

+

- + - + - +
void XAxiEthernet_DumpExtMulticastGroup void XAxiEthernet_DumpExtMulticastGroup ( XAxiEthernet *  InstancePtr InstancePtr  ) 
-

XAxiEthernet_DumpExtMulticastGroup dumps ALL provisioned acceptable multicast MAC in the Axi Ethernet device's multicast table.

-
Parameters:
+ +

+XAxiEthernet_DumpExtMulticastGroup dumps ALL provisioned acceptable multicast MAC in the Axi Ethernet device's multicast table.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
-
-
Returns:
None.
-
Note:
-

Hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a set.

-

This API operates at a set (256 MAC addresses) level.

- +
Returns:
None.
+
Note:
+Hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a set.

+This API operates at a set (256 MAC addresses) level.

-
- +

+

- + @@ -255,35 +265,33 @@ - +
int XAxiEthernet_GetExtMulticastGroup int XAxiEthernet_GetExtMulticastGroup ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetExtMulticastGroup returns whether the given Ethernet address group is stored in the table.

-
Parameters:
+ +

+XAxiEthernet_GetExtMulticastGroup returns whether the given Ethernet address group is stored in the table.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a pointer to the 6-byte Ethernet address.
-
-
Returns:
    -
  • TRUE if it is an acceptable multicast MAC address and the group is present in the table.
    • -
  • FALSE if it is not a valid multicast MAC address or the group was not found in the table.
    • -
+
Returns:
    +
  • TRUE if it is an acceptable multicast MAC address and the group is present in the table.
  • FALSE if it is not a valid multicast MAC address or the group was not found in the table.
-
Note:
-

In the table, hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group. This API operates at a group (256 MAC addresses) level.

- +
Note:
+In the table, hardware requires to 'index' with bit 22-8, 15 bits in total. The least significant byte/8 bits are considered a group. This API operates at a group (256 MAC addresses) level.
-
- +

+

- + @@ -297,30 +305,31 @@ - +
void XAxiEthernet_GetMacPauseAddress void XAxiEthernet_GetMacPauseAddress ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetMacPauseAddress gets the MAC address used for pause frames for the Axi Ethernet device specified by InstancePtr.

-
Parameters:
+ +

+XAxiEthernet_GetMacPauseAddress gets the MAC address used for pause frames for the Axi Ethernet device specified by InstancePtr.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr references the memory buffer to store the retrieved MAC address. This memory buffer must be at least 6 bytes in length.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + @@ -346,36 +355,35 @@ - +
int XAxiEthernet_GetRgmiiStatus int XAxiEthernet_GetRgmiiStatus ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetRgmiiStatus get the state of the link when using the RGMII media interface.

-
Parameters:
+ +

+XAxiEthernet_GetRgmiiStatus get the state of the link when using the RGMII media interface.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
SpeedPtr references the location to store the result, which is the auto negotiated link speed in units of Mbits/sec, either 0, 10, 100, or 1000.
IsFullDuplexPtr references the value that is set by this function to indicate full duplex operation. IsFullDuplexPtr is set to TRUE when the RGMII link is operating in full duplex mode, otherwise it is set to FALSE.
IsLinkUpPtr references the value that is set by this function to indicate the link status.IsLinkUpPtr is set to TRUE when the RGMII link up, otherwise it is set to FALSE.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_NO_FEATURE if the Axi Ethernet device is not using an RGMII interface,
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_NO_FEATURE if the Axi Ethernet device is not using an RGMII interface,
-
Note:
None.
+
Note:
None.
-
- +

+

- + @@ -389,34 +397,33 @@ - +
int XAxiEthernet_GetSgmiiStatus int XAxiEthernet_GetSgmiiStatus ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetSgmiiStatus get the state of the link when using the SGMII media interface.

-
Parameters:
+ +

+XAxiEthernet_GetSgmiiStatus get the state of the link when using the SGMII media interface.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
SpeedPtr references the location to store the result, which is the auto negotiated link speed in units of Mbits/sec, either 0, 10, 100, or 1000.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_NO_FEATURE if the Axi Ethernet device is not using an SGMII interface,
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_NO_FEATURE if the Axi Ethernet device is not using an SGMII interface,
-
Note:
Currently SGMII PHY does not support half duplex mode.
+
Note:
Currently SGMII PHY does not support half duplex mode.
-
- +

+

- + @@ -436,31 +443,32 @@ - +
void XAxiEthernet_GetTpid void XAxiEthernet_GetTpid ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetTpid gets the VLAN Tag Protocol Identifier value (TPID).

-
Parameters:
+ +

+XAxiEthernet_GetTpid gets the VLAN Tag Protocol Identifier value (TPID).

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
TpidPtr references the location to store the result.
Entry is the hardware storage location to program this address and must be between 0..XAE_TPID_MAX_ENTRIES.
-
-
Returns:
None.
-
Note:
None.
+
Returns:
None.
+
Note:
None.
-
- +

+

- + @@ -498,16 +506,18 @@ - +
void XAxiEthernet_GetVidTable void XAxiEthernet_GetVidTable ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetVidTable gets VID table content includes new VLAN ID, strip and tag enable bits.

-

The device must be stopped to use this function.
-
-

-
Parameters:
+ +

+XAxiEthernet_GetVidTable gets VID table content includes new VLAN ID, strip and tag enable bits.

+The device must be stopped to use this function.
+
+

+

Parameters:
@@ -516,21 +526,19 @@
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Entry is the hardware storage location/index to program updated VID value, strip, or tag value. The value must be between 0..0xFFF.
TagPtr references the location to store the result. This function stores the tag enable bit value indexed by Entry into this location.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
None.
-
Note:
-

The hardware requires the table to be 'indexed' with Entry and must be 0x000..0xFFF.

-

Bits layout is bbbb bbbb bbbb b b VLAN ID (12b), | | | VLAN double tag enable bit VLAN strip enable bit

- +
Returns:
None.
+
Note:
+The hardware requires the table to be 'indexed' with Entry and must be 0x000..0xFFF.

+Bits layout is bbbb bbbb bbbb b b VLAN ID (12b), | | | VLAN double tag enable bit VLAN strip enable bit

-
- +

+

- + @@ -550,32 +558,32 @@ - +
void XAxiEthernet_GetVStripMode void XAxiEthernet_GetVStripMode ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetVStripMode gets the VLAN stripping mode.

-
Parameters:
+ +

+XAxiEthernet_GetVStripMode gets the VLAN stripping mode.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
ModePtr references the location to store the VLAN strip mode returned by this function. Value is b'00, b'01 or b'11. Refer XAE_VTSRAP_* in xaxiethernet.h file for the details.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
None.
-
Note:
-

Mode value shifting is handled in this function. No shifting is required to call this function.

- +
Returns:
None.
+
Note:
+Mode value shifting is handled in this function. No shifting is required to call this function.
-
- +

+

- + @@ -595,34 +603,34 @@ - +
void XAxiEthernet_GetVTagMode void XAxiEthernet_GetVTagMode ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetVTagMode gets VLAN tagging mode.

-
Parameters:
+ +

+XAxiEthernet_GetVTagMode gets VLAN tagging mode.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
ModePtr references the location to store the VLAN tag mode. Value is between b'00-b'11.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
None.
-
Note:
-

The device must be stopped to use this function.
-
- Mode value shifting is handled in this function. No shifting is required to call this function.

- +
Returns:
None.
+
Note:
+The device must be stopped to use this function.
+
+ Mode value shifting is handled in this function. No shifting is required to call this function.
-
- +

+

- + @@ -642,32 +650,32 @@ - +
void XAxiEthernet_GetVTagValue void XAxiEthernet_GetVTagValue ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_GetVTagValue gets the configured VLAN tagging value.

-
Parameters:
+ +

+XAxiEthernet_GetVTagValue gets the configured VLAN tagging value.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
VTagValuePtr references the location to store the result. Format is TPID, one of the following 16 bit values, 0x8100, 0x88a8, 0x9100, 0x9200. Priority, 3 bits CFI, 1 bit VID, 12 bits
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
None.
-
Note:
-

Ethernet VLAN frames' VLAN type/length(2B) and tag control information(2B). Bit layout : bbbb bbbb bbbb bbbb bbb b bbbb bbbb bbbb \ / | | \ VID (12b) / \ / | CFI bit (1b) TPID (16b) priority bit (3b)

- +
Returns:
None.
+
Note:
+Ethernet VLAN frames' VLAN type/length(2B) and tag control information(2B). Bit layout : bbbb bbbb bbbb bbbb bbb b bbbb bbbb bbbb \ / | | \ VID (12b) / \ / | CFI bit (1b) TPID (16b) priority bit (3b)
-
- +

+

- + @@ -687,43 +695,41 @@ - +
int XAxiEthernet_MulticastAdd int XAxiEthernet_MulticastAdd ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_MulticastAdd adds the Ethernet address, AddressPtr to the Axi Ethernet device's multicast filter list, at list index Entry. The address referenced by AddressPtr may be of any unicast, multicast, or broadcast address form. The hardware for the Axi Ethernet device can hold up to XAE_MULTI_MAT_ENTRIES addresses in this filter list.
-
-

-

The device must be stopped to use this function.
-
-

-

Once an Ethernet address is programmed, the Axi Ethernet device will begin receiving data sent from that address. The Axi Ethernet hardware does not have a control bit to disable multicast filtering. The only way to prevent the Axi Ethernet device from receiving messages from an Ethernet address in the Multicast Address Table (MAT) is to clear it with XAxiEthernet_MulticastClear().

-
Parameters:
+ +

+XAxiEthernet_MulticastAdd adds the Ethernet address, AddressPtr to the Axi Ethernet device's multicast filter list, at list index Entry. The address referenced by AddressPtr may be of any unicast, multicast, or broadcast address form. The hardware for the Axi Ethernet device can hold up to XAE_MULTI_MAT_ENTRIES addresses in this filter list.
+
+

+The device must be stopped to use this function.
+
+

+Once an Ethernet address is programmed, the Axi Ethernet device will begin receiving data sent from that address. The Axi Ethernet hardware does not have a control bit to disable multicast filtering. The only way to prevent the Axi Ethernet device from receiving messages from an Ethernet address in the Multicast Address Table (MAT) is to clear it with XAxiEthernet_MulticastClear().

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a pointer to the 6-byte Ethernet address to set. The previous address at the location Entry (if any) is overwritten with the value at AddressPtr.
Entry is the hardware storage location to program this address and must be between 0 to (XAE_MULTI_MAT_ENTRIES - 1).
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED.if the Axi Ethernet device is not stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED.if the Axi Ethernet device is not stopped.
-
Note:
-

This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

-

To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

- +
Note:
+This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

+To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

-
- +

+

- + @@ -737,41 +743,39 @@ - +
int XAxiEthernet_MulticastClear int XAxiEthernet_MulticastClear ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_MulticastClear clears the Ethernet address stored at index Entry in the Axi Ethernet device's multicast filter list.
-
-

-

The device must be stopped to use this function.
-
-

-
Parameters:
+ +

+XAxiEthernet_MulticastClear clears the Ethernet address stored at index Entry in the Axi Ethernet device's multicast filter list.
+
+

+The device must be stopped to use this function.
+
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Entry is the HW storage location used when this address was added. It must be between 0 to (XAE_MULTI_MAT_ENTRIES - 1).
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED.if the Axi Ethernet device is not stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED.if the Axi Ethernet device is not stopped.
-
Note:
-

This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

-

To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

- +
Note:
+This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

+To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

-
- +

+

- + @@ -791,35 +795,35 @@ - +
void XAxiEthernet_MulticastGet void XAxiEthernet_MulticastGet ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_MulticastGet gets the Ethernet address stored at index Entry in the Axi Ethernet device's multicast filter list.
-
-

-
Parameters:
+ +

+XAxiEthernet_MulticastGet gets the Ethernet address stored at index Entry in the Axi Ethernet device's multicast filter list.
+
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr references the memory buffer to store the retrieved Ethernet address. This memory buffer must be at least 6 bytes in length.
Entry is the hardware storage location from which to retrieve the address and must be between 0 to (XAE_MULTI_MAT_ENTRIES - 1)
-
-
Returns:
None.
-
Note:
-

This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

-

To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

- +
Returns:
None.
+
Note:
+This routine works only with normal multicast filtering feature. A maximum of 4 multicast addresses can be stored in the HW provided multicast table.

+To use the extended multicast feature, extended multicast filtering must be enabled by using driver API XAxiEthernet_SetOptions with proper option fields set. Once extended multicast filtering is enabled, the APIs XAxiEthernet_[Add|Clear|Get]ExtMulticastGroup() must be used to manage multicast address groups.

-
- +

+

- + @@ -833,34 +837,33 @@ - +
int XAxiEthernet_SendPausePacket int XAxiEthernet_SendPausePacket ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SendPausePacket sends a pause packet with the value of PauseValue.

-
Parameters:
+ +

+XAxiEthernet_SendPausePacket sends a pause packet with the value of PauseValue.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
PauseValue is the pause value in units of 512 bit times.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
-
Note:
None.
+
Note:
None.
-
- +

+

- + @@ -874,34 +877,33 @@ - +
int XAxiEthernet_SetMacPauseAddress int XAxiEthernet_SetMacPauseAddress ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetMacPauseAddress sets the MAC address used for pause frames to AddressPtr. AddressPtr will be the address the Axi Ethernet device will recognize as being for pause frames. Pause frames transmitted with XAxiEthernet_SendPausePacket() will also use this address.

-
Parameters:
+ +

+XAxiEthernet_SetMacPauseAddress sets the MAC address used for pause frames to AddressPtr. AddressPtr will be the address the Axi Ethernet device will recognize as being for pause frames. Pause frames transmitted with XAxiEthernet_SendPausePacket() will also use this address.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
AddressPtr is a pointer to the 6-byte Ethernet address to set.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
-
Note:
None.
+
Note:
None.
-
- +

+

- + @@ -921,38 +923,35 @@ - +
int XAxiEthernet_SetTpid int XAxiEthernet_SetTpid ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetTpid sets the VLAN Tag Protocol Identifier(TPID).

-

Four values can be configured - 0x8100, 0x9100, 0x9200, 0x88A8.

-
Parameters:
+ +

+XAxiEthernet_SetTpid sets the VLAN Tag Protocol Identifier(TPID).

+Four values can be configured - 0x8100, 0x9100, 0x9200, 0x88A8.

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Tpid is a hex value to be added to the TPID table. The four values that can be added are 0x8100, 0x9100, 0x9200, 0x88A8.
Entry is the hardware storage location to program this address and must be between 0..XAE_TPID_MAX_ENTRIES.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED, if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the VLAN tag capability.
    • -
  • XST_INVALID_PARAM if Tpid is not one of supported values.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED, if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the VLAN tag capability.
  • XST_INVALID_PARAM if Tpid is not one of supported values.
-
Note:
The device must be stopped to use this function.
+
Note:
The device must be stopped to use this function.
-
- +

+

- + @@ -990,16 +989,18 @@ - +
int XAxiEthernet_SetVidTable int XAxiEthernet_SetVidTable ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetVidTable sets VID table includes new VLAN ID, strip and tag enable bits.

-

The device must be stopped to use this function.
-
-

-
Parameters:
+ +

+XAxiEthernet_SetVidTable sets VID table includes new VLAN ID, strip and tag enable bits.

+The device must be stopped to use this function.
+
+

+

Parameters:
@@ -1008,27 +1009,22 @@
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Entry is the hardware storage location/index to program updated VID value, strip, or tag value. The value must be between 0..0xFFF.
Tag is tag enable indication for Vid.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable/have extended functionalities.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable/have extended functionalities.
-
Note:
-

The hardware requires the table to be 'indexed' with Entry and must be 0x000..0xFFF.

-

Bits layout is bbbb bbbb bbbb b b VLAN ID (12b), | | | VLAN double tag enable bit VLAN strip enable bit

-

To disable translation indexed by Entry, Set Vid = Entry.

- +
Note:
+The hardware requires the table to be 'indexed' with Entry and must be 0x000..0xFFF.

+Bits layout is bbbb bbbb bbbb b b VLAN ID (12b), | | | VLAN double tag enable bit VLAN strip enable bit

+To disable translation indexed by Entry, Set Vid = Entry.

-
- +

+

- + @@ -1048,47 +1044,40 @@ - +
int XAxiEthernet_SetVStripMode int XAxiEthernet_SetVStripMode ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetVStripMode configures the VLAN strip mode.

-

Three modes can be configured :

- -
Parameters:
+ +

+XAxiEthernet_SetVStripMode configures the VLAN strip mode.

+Three modes can be configured :

    +
  • XAE_VSTRP_NONE for no stripping.
  • XAE_VSTRP_ALL to strip one tag from all frames.
  • XAE_VSTRP_SELECT to strip one tag from already selected tagged frames based on VID value.
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Mode is the VLAN strip mode. Value must be b'00, b'01, or b'11.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion., returns XST_SUCCESS.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the TX VLAN strip capability.
    • -
  • XST_INVALID_PARAM if Mode is not one of supported modes.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion., returns XST_SUCCESS.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the TX VLAN strip capability.
  • XST_INVALID_PARAM if Mode is not one of supported modes.
-
Note:
-

The device must be stopped to use this function.
-
- The third mode (specified by XAE_VSTRP_SELECT) requires a method for specifying which tagged frames should be stripped. The VLAN translation table 'stripped enabled' is referenced. That configuration is handled in XAxiEthernet_SetVidTable().

-

Mode value shifting is handled in this function. No shifting is required to call this function.

- +
Note:
+The device must be stopped to use this function.
+
+ The third mode (specified by XAE_VSTRP_SELECT) requires a method for specifying which tagged frames should be stripped. The VLAN translation table 'stripped enabled' is referenced. That configuration is handled in XAxiEthernet_SetVidTable().

+Mode value shifting is handled in this function. No shifting is required to call this function.

-
- +

+

- + @@ -1108,49 +1097,41 @@ - +
int XAxiEthernet_SetVTagMode int XAxiEthernet_SetVTagMode ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetVTagMode configures the VLAN tagging mode.

-

Four modes can be configured,

- -
Parameters:
+ +

+XAxiEthernet_SetVTagMode configures the VLAN tagging mode.

+Four modes can be configured,

    +
  • XAE_VTAG_NONE for no tagging.
  • XAE_VTAG_ALL to tag all frames.
  • XAE_VTAG_EXISTED to tag already tagged frames.
  • XAE_VTAG_SELECT to tag selected already tagged frames based on VID value.
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
Mode is the VLAN tag mode. Value must be between b'00-b'11.
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
    -
  • XST_SUCCESS. on successful completion.
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the TX VLAN tag capability.
    • -
  • XST_INVALID_PARAM if Mode is not one of supported modes.
    • -
+
Returns:
    +
  • XST_SUCCESS. on successful completion.
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable or have the TX VLAN tag capability.
  • XST_INVALID_PARAM if Mode is not one of supported modes.
-
Note:
-

The device must be stopped to use this function.
-
-

-

The fourth mode (specified by XAE_VTAG_SELECT) requires a method for specifying which tagged frames should receive an additional VLAN tag. The VLAN translation table 'tag enabled' is referenced. That configuration is handled in XAxiEthernet_SetVidTable().

-

Mode value shifting is handled in this function. No shifting is required to call this function.

- +
Note:
+The device must be stopped to use this function.
+
+

+The fourth mode (specified by XAE_VTAG_SELECT) requires a method for specifying which tagged frames should receive an additional VLAN tag. The VLAN translation table 'tag enabled' is referenced. That configuration is handled in XAxiEthernet_SetVidTable().

+Mode value shifting is handled in this function. No shifting is required to call this function.

-
- +

+

- + @@ -1170,39 +1151,30 @@ - +
int XAxiEthernet_SetVTagValue int XAxiEthernet_SetVTagValue ( XAxiEthernet *  InstancePtr,
)
-

XAxiEthernet_SetVTagValue configures the VLAN tagging value.

-

The device must be stopped to use this function.
-
-

-
Parameters:
+ +

+XAxiEthernet_SetVTagValue configures the VLAN tagging value.

+The device must be stopped to use this function.
+
+

+

Parameters:
InstancePtr is a pointer to the Axi Ethernet instance to be worked on.
VTagValue is the VLAN tag value to be configured. A 32bit value. TPID, one of the following 16 bit values, 0x8100, 0x88a8, 0x9100, 0x9200. Priority, 3 bits CFI, 1 bit VID, 12 bits
Dir must be either XAE_TX or XAE_RX.
-
-
Returns:
    -
  • XST_SUCCESS on successful completion, returns .
    • -
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
    • -
  • XST_NO_FEATURE if the Axi Ethernet does not enable/have TX VLAN tag capability.
    • -
  • XST_INVALID_PARAM, if the TPID is not one the four supported values.
    • -
+
Returns:
    +
  • XST_SUCCESS on successful completion, returns .
  • XST_DEVICE_IS_STARTED if the Axi Ethernet device is not stopped.
  • XST_NO_FEATURE if the Axi Ethernet does not enable/have TX VLAN tag capability.
  • XST_INVALID_PARAM, if the TPID is not one the four supported values.
-
Note:
-

The four supported TPID values are 0x8100, 0x88a8, 0x9100, 0x9200. XAxiEthernet_SetVTagValue performs verification on TPID only.

-

Ethernet VLAN frames' VLAN type/length(2B) and tag control information(2B). Bit layout : bbbb bbbb bbbb bbbb bbb b bbbb bbbb bbbb \ / | | \ VID (12b) / \ / | CFI bit (1b) TPID (16b) priority bit (3b)

- +
Note:
+The four supported TPID values are 0x8100, 0x88a8, 0x9100, 0x9200. XAxiEthernet_SetVTagValue performs verification on TPID only.

+Ethernet VLAN frames' VLAN type/length(2B) and tag control information(2B). Bit layout : bbbb bbbb bbbb bbbb bbb b bbbb bbbb bbbb \ / | | \ VID (12b) / \ / | CFI bit (1b) TPID (16b) priority bit (3b)

-
- -

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - +

+Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__g_8c.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__g_8c.html old mode 100644 new mode 100755 index 033942f6..0bf1b3e7 --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__g_8c.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__g_8c.html @@ -2,48 +2,48 @@ - Xilinx Driver axiethernet v4_2: xaxiethernet_g.c File Reference + xaxiethernet_g.c File Reference - +

Xilinx Processor IP Library

Software Drivers
- - - -
-

xaxiethernet_g.c File Reference

#include "xparameters.h"
-#include "xaxiethernet.h"
+ +
+
+
+
+

xaxiethernet_g.c File Reference

+

+#include "xparameters.h"
+#include "xaxiethernet.h"
- - + + + +

Variables

XAxiEthernet_Config XAxiEthernet_ConfigTable []

Variables

XAxiEthernet_Config XAxiEthernet_ConfigTable []
-

Variable Documentation

- +

Variable Documentation

+
- +
XAxiEthernet_Config XAxiEthernet_ConfigTable[]XAxiEthernet_Config XAxiEthernet_ConfigTable[]
+ +

Initial value:

 {
         {
          XPAR_AXIETHERNET_0_DEVICE_ID,
@@ -72,10 +72,5 @@
 }
-
-
-

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - +

+Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__hw_8h.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__hw_8h.html old mode 100644 new mode 100755 index 1abc0ed8..ab3f787d --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__hw_8h.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__hw_8h.html @@ -2,336 +2,31 @@ - Xilinx Driver axiethernet v4_2: xaxiethernet_hw.h File Reference + xaxiethernet_hw.h File Reference - +

Xilinx Processor IP Library

Software Drivers
- - - -
-

xaxiethernet_hw.h File Reference

#include "xdebug.h"
-#include "xil_io.h"
-#include "xil_types.h"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Defines

#define XAXIETHERNET_HW_H
#define XAxiEthernet_indent(RegOffset)
#define XAxiEthernet_reg_name(RegOffset)
#define XAxiEthernet_print_reg_o(BaseAddress, RegOffset, Value)
#define XAxiEthernet_print_reg_i(BaseAddress, RegOffset, Value)
#define XAxiEthernet_ReadReg(BaseAddress, RegOffset)   (Xil_In32(((BaseAddress) + (RegOffset))))
#define XAxiEthernet_WriteReg(BaseAddress, RegOffset, Data)   Xil_Out32(((BaseAddress) + (RegOffset)), (Data))
Axi Ethernet registers offset

-

#define XAE_RAF_OFFSET   0x00000000
#define XAE_TPF_OFFSET   0x00000004
#define XAE_IFGP_OFFSET   0x00000008
#define XAE_IS_OFFSET   0x0000000C
#define XAE_IP_OFFSET   0x00000010
#define XAE_IE_OFFSET   0x00000014
#define XAE_TTAG_OFFSET   0x00000018
#define XAE_RTAG_OFFSET   0x0000001C
#define XAE_UAWL_OFFSET   0x00000020
#define XAE_UAWU_OFFSET   0x00000024
#define XAE_TPID0_OFFSET   0x00000028
#define XAE_TPID1_OFFSET   0x0000002C
#define XAE_RXBL_OFFSET   0x00000200
#define XAE_RXBU_OFFSET   0x00000204
#define XAE_TXBL_OFFSET   0x00000208
#define XAE_TXBU_OFFSET   0x0000020C
#define XAE_RXUNDRL_OFFSET   0x00000210
#define XAE_RXUNDRU_OFFSET   0x00000214
#define XAE_RXFRAGL_OFFSET   0x00000218
#define XAE_RXFRAGU_OFFSET   0x0000021C
#define XAE_RX64BL_OFFSET   0x00000220
#define XAE_RX64BU_OFFSET   0x00000224
#define XAE_RX65B127L_OFFSET   0x00000228
#define XAE_RX65B127U_OFFSET   0x0000022C
#define XAE_RX128B255L_OFFSET   0x00000230
#define XAE_RX128B255U_OFFSET   0x00000234
#define XAE_RX256B511L_OFFSET   0x00000238
#define XAE_RX256B511U_OFFSET   0x0000023C
#define XAE_RX512B1023L_OFFSET   0x00000240
#define XAE_RX512B1023U_OFFSET   0x00000244
#define XAE_RX1024BL_OFFSET   0x00000248
#define XAE_RX1024BU_OFFSET   0x0000024C
#define XAE_RXOVRL_OFFSET   0x00000250
#define XAE_RXOVRU_OFFSET   0x00000254
#define XAE_TX64BL_OFFSET   0x00000258
#define XAE_TX64BU_OFFSET   0x0000025C
#define XAE_TX65B127L_OFFSET   0x00000260
#define XAE_TX65B127U_OFFSET   0x00000264
#define XAE_TX128B255L_OFFSET   0x00000268
#define XAE_TX128B255U_OFFSET   0x0000026C
#define XAE_TX256B511L_OFFSET   0x00000270
#define XAE_TX256B511U_OFFSET   0x00000274
#define XAE_TX512B1023L_OFFSET   0x00000278
#define XAE_TX512B1023U_OFFSET   0x0000027C
#define XAE_TX1024L_OFFSET   0x00000280
#define XAE_TX1024U_OFFSET   0x00000284
#define XAE_TXOVRL_OFFSET   0x00000288
#define XAE_TXOVRU_OFFSET   0x0000028C
#define XAE_RXFL_OFFSET   0x00000290
#define XAE_RXFU_OFFSET   0x00000294
#define XAE_RXFCSERL_OFFSET   0x00000298
#define XAE_RXFCSERU_OFFSET   0x0000029C
#define XAE_RXBCSTFL_OFFSET   0x000002A0
#define XAE_RXBCSTFU_OFFSET   0x000002A4
#define XAE_RXMCSTFL_OFFSET   0x000002A8
#define XAE_RXMCSTFU_OFFSET   0x000002AC
#define XAE_RXCTRFL_OFFSET   0x000002B0
#define XAE_RXCTRFU_OFFSET   0x000002B4
#define XAE_RXLTERL_OFFSET   0x000002B8
#define XAE_RXLTERU_OFFSET   0x000002BC
#define XAE_RXVLANFL_OFFSET   0x000002C0
#define XAE_RXVLANFU_OFFSET   0x000002C4
#define XAE_RXPFL_OFFSET   0x000002C8
#define XAE_RXPFU_OFFSET   0x000002CC
#define XAE_RXUOPFL_OFFSET   0x000002D0
#define XAE_RXUOPFU_OFFSET   0x000002D4
#define XAE_TXFL_OFFSET   0x000002D8
#define XAE_TXFU_OFFSET   0x000002DC
#define XAE_TXBCSTFL_OFFSET   0x000002E0
#define XAE_TXBCSTFU_OFFSET   0x000002E4
#define XAE_TXMCSTFL_OFFSET   0x000002E8
#define XAE_TXMCSTFU_OFFSET   0x000002EC
#define XAE_TXUNDRERL_OFFSET   0x000002F0
#define XAE_TXUNDRERU_OFFSET   0x000002F4
#define XAE_TXCTRFL_OFFSET   0x000002F8
#define XAE_TXCTRFU_OFFSET   0x000002FC
#define XAE_TXVLANFL_OFFSET   0x00000300
#define XAE_TXVLANFU_OFFSET   0x00000304
#define XAE_TXPFL_OFFSET   0x00000308
#define XAE_TXPFU_OFFSET   0x0000030C
#define XAE_TXSCL_OFFSET   0x00000310
#define XAE_TXSCU_OFFSET   0x00000314
#define XAE_TXMCL_OFFSET   0x00000318
#define XAE_TXMCU_OFFSET   0x0000031C
#define XAE_TXDEFL_OFFSET   0x00000320
#define XAE_TXDEFU_OFFSET   0x00000324
#define XAE_TXLTCL_OFFSET   0x00000328
#define XAE_TXLTCU_OFFSET   0x0000032C
#define XAE_TXAECL_OFFSET   0x00000330
#define XAE_TXAECU_OFFSET   0x00000334
#define XAE_TXEDEFL_OFFSET   0x00000338
#define XAE_TXEDEFU_OFFSET   0x0000033C
#define XAE_RXAERL_OFFSET   0x00000340
#define XAE_RXAERU_OFFSET   0x0000034C
#define XAE_RCW0_OFFSET   0x00000400
#define XAE_RCW1_OFFSET   0x00000404
#define XAE_TC_OFFSET   0x00000408
#define XAE_FCC_OFFSET   0x0000040C
#define XAE_EMMC_OFFSET   0x00000410
#define XAE_RXFC_OFFSET   0x00000414
#define XAE_TXFC_OFFSET   0x00000418
#define XAE_TX_TIMESTAMP_ADJ_OFFSET   0x0000041C
#define XAE_PHYC_OFFSET   0x00000420
#define XAE_IDREG_OFFSET   0x000004F8
#define XAE_ARREG_OFFSET   0x000004FC
#define XAE_MDIO_MC_OFFSET   0x00000500
#define XAE_MDIO_MCR_OFFSET   0x00000504
#define XAE_MDIO_MWD_OFFSET   0x00000508
#define XAE_MDIO_MRD_OFFSET   0x0000050C
#define XAE_MDIO_MIS_OFFSET   0x00000600
#define XAE_MDIO_MIP_OFFSET   0x00000620
#define XAE_MDIO_MIE_OFFSET   0x00000640
#define XAE_MDIO_MIC_OFFSET   0x00000660
#define XAE_UAW0_OFFSET   0x00000700
#define XAE_UAW1_OFFSET   0x00000704
#define XAE_FMI_OFFSET   0x00000708
#define XAE_AF0_OFFSET   0x00000710
#define XAE_AF1_OFFSET   0x00000714
#define XAE_TX_VLAN_DATA_OFFSET   0x00004000
#define XAE_RX_VLAN_DATA_OFFSET   0x00008000
#define XAE_MCAST_TABLE_OFFSET   0x00020000
Reset and Address Filter (RAF) Register bit definitions.

These bits are associated with the XAE_RAF_OFFSET register.

-

#define XAE_RAF_MCSTREJ_MASK   0x00000002
#define XAE_RAF_BCSTREJ_MASK   0x00000004
#define XAE_RAF_TXVTAGMODE_MASK   0x00000018
#define XAE_RAF_RXVTAGMODE_MASK   0x00000060
#define XAE_RAF_TXVSTRPMODE_MASK   0x00000180
#define XAE_RAF_RXVSTRPMODE_MASK   0x00000600
#define XAE_RAF_NEWFNCENBL_MASK   0x00000800
#define XAE_RAF_EMULTIFLTRENBL_MASK   0x00001000
#define XAE_RAF_STATSRST_MASK   0x00002000
#define XAE_RAF_RXBADFRMEN_MASK   0x00004000
#define XAE_RAF_TXVTAGMODE_SHIFT   3
#define XAE_RAF_RXVTAGMODE_SHIFT   5
#define XAE_RAF_TXVSTRPMODE_SHIFT   7
#define XAE_RAF_RXVSTRPMODE_SHIFT   9
Transmit Pause Frame Register (TPF) bit definitions

-

#define XAE_TPF_TPFV_MASK   0x0000FFFF
Transmit Inter-Frame Gap Adjustement Register (TFGP) bit definitions

-

#define XAE_TFGP_IFGP_MASK   0x0000007F
Interrupt Status/Enable/Mask Registers bit definitions

The bit definition of these three interrupt registers are the same. These bits are associated with the XAE_IS_OFFSET, XAE_IP_OFFSET, and XAE_IE_OFFSET registers.

-

#define XAE_INT_HARDACSCMPLT_MASK   0x00000001
#define XAE_INT_AUTONEG_MASK   0x00000002
#define XAE_INT_RXCMPIT_MASK   0x00000004
#define XAE_INT_RXRJECT_MASK   0x00000008
#define XAE_INT_RXFIFOOVR_MASK   0x00000010
#define XAE_INT_TXCMPIT_MASK   0x00000020
#define XAE_INT_RXDCMLOCK_MASK   0x00000040
#define XAE_INT_MGTRDY_MASK   0x00000080
#define XAE_INT_PHYRSTCMPLT_MASK   0x00000100
#define XAE_INT_ALL_MASK   0x0000003F
#define XAE_INT_RECV_ERROR_MASK   (XAE_INT_RXRJECT_MASK | XAE_INT_RXFIFOOVR_MASK)
TPID Register (TPID) bit definitions

-

#define XAE_TPID_0_MASK   0x0000FFFF
#define XAE_TPID_1_MASK   0xFFFF0000
Receive Configuration Word 1 (RCW1) Register bit definitions

-

#define XAE_RCW1_RST_MASK   0x80000000
#define XAE_RCW1_JUM_MASK   0x40000000
#define XAE_RCW1_FCS_MASK   0x20000000
#define XAE_RCW1_RX_MASK   0x10000000
#define XAE_RCW1_VLAN_MASK   0x08000000
#define XAE_RCW1_LT_DIS_MASK   0x02000000
#define XAE_RCW1_CL_DIS_MASK   0x01000000
#define XAE_RCW1_1588_TIMESTAMP_EN_MASK   0x00400000
#define XAE_RCW1_PAUSEADDR_MASK   0x0000FFFF
Transmitter Configuration (TC) Register bit definitions

-

#define XAE_TC_RST_MASK   0x80000000
#define XAE_TC_JUM_MASK   0x40000000
#define XAE_TC_FCS_MASK   0x20000000
#define XAE_TC_TX_MASK   0x10000000
#define XAE_TC_VLAN_MASK   0x08000000
#define XAE_TC_IFG_MASK   0x02000000
#define XAE_TC_1588_CMD_EN_MASK   0x00400000
Flow Control Configuration (FCC) Register Bit definitions

-

#define XAE_FCC_FCRX_MASK   0x20000000
#define XAE_FCC_FCTX_MASK   0x40000000
Ethernet MAC Mode Configuration (EMMC) Register bit definitions

-

#define XAE_EMMC_LINKSPEED_MASK   0xC0000000
#define XAE_EMMC_RGMII_MASK   0x20000000
#define XAE_EMMC_SGMII_MASK   0x10000000
#define XAE_EMMC_GPCS_MASK   0x08000000
#define XAE_EMMC_HOST_MASK   0x04000000
#define XAE_EMMC_TX16BIT   0x02000000
#define XAE_EMMC_RX16BIT   0x01000000
#define XAE_EMMC_LINKSPD_10   0x00000000
#define XAE_EMMC_LINKSPD_100   0x40000000
#define XAE_EMMC_LINKSPD_1000   0x80000000
RGMII/SGMII Configuration (PHYC) Register bit definitions

-

#define XAE_PHYC_SGMIILINKSPEED_MASK   0xC0000000
#define XAE_PHYC_RGMIILINKSPEED_MASK   0x0000000C
#define XAE_PHYC_RGMIIHD_MASK   0x00000002
#define XAE_PHYC_RGMIILINK_MASK   0x00000001
#define XAE_PHYC_RGLINKSPD_10   0x00000000
#define XAE_PHYC_RGLINKSPD_100   0x00000004
#define XAE_PHYC_RGLINKSPD_1000   0x00000008
#define XAE_PHYC_SGLINKSPD_10   0x00000000
#define XAE_PHYC_SGLINKSPD_100   0x40000000
#define XAE_PHYC_SGLINKSPD_1000   0x80000000
MDIO Management Configuration (MC) Register bit definitions

-

#define XAE_MDIO_MC_MDIOEN_MASK   0x00000040
#define XAE_MDIO_MC_CLOCK_DIVIDE_MAX   0x3F
MDIO Management Control Register (MCR) Register bit definitions

-

#define XAE_MDIO_MCR_PHYAD_MASK   0x1F000000
#define XAE_MDIO_MCR_PHYAD_SHIFT   24
#define XAE_MDIO_MCR_REGAD_MASK   0x001F0000
#define XAE_MDIO_MCR_REGAD_SHIFT   16
#define XAE_MDIO_MCR_OP_MASK   0x0000C000
#define XAE_MDIO_MCR_OP_SHIFT   13
#define XAE_MDIO_MCR_OP_READ_MASK   0x00008000
#define XAE_MDIO_MCR_OP_WRITE_MASK   0x00004000
#define XAE_MDIO_MCR_INITIATE_MASK   0x00000800
#define XAE_MDIO_MCR_READY_MASK   0x00000080
MDIO Interrupt Enable/Mask/Status Registers bit definitions

The bit definition of these three interrupt registers are the same. These bits are associated with the XAE_IS_OFFSET, XAE_IP_OFFSET, and XAE_IE_OFFSET registers.

-

#define XAE_MDIO_INT_MIIM_RDY_MASK   0x00000001
Axi Ethernet Unicast Address Register Word 1 (UAW1) Register Bit

definitions

-

#define XAE_UAW1_UNICASTADDR_MASK   0x0000FFFF
Filter Mask Index (FMI) Register bit definitions

-

#define XAE_FMI_PM_MASK   0x80000000
#define XAE_FMI_IND_MASK   0x00000003
Extended multicast buffer descriptor bit mask

-

#define XAE_BD_RX_USR2_BCAST_MASK   0x00000004
#define XAE_BD_RX_USR2_IP_MCAST_MASK   0x00000002
#define XAE_BD_RX_USR2_MCAST_MASK   0x00000001
Axi Ethernet Multicast Address Register Word 1 (MAW1)

-

#define XAE_MAW1_RNW_MASK   0x00800000
#define XAE_MAW1_ADDR_MASK   0x00030000
#define XAE_MAW1_MULTICADDR_MASK   0x0000FFFF
#define XAE_MAW1_MATADDR_SHIFT_MASK   16
Other Constant definitions used in the driver

-

#define XAE_SPEED_10_MBPS   10
#define XAE_SPEED_100_MBPS   100
#define XAE_SPEED_1000_MBPS   1000
#define XAE_SOFT_TEMAC_LOW_SPEED   0
#define XAE_SOFT_TEMAC_HIGH_SPEED   1
#define XAE_HARD_TEMAC_TYPE   2
#define XAE_PHY_ADDR_LIMIT   31
#define XAE_PHY_REG_NUM_LIMIT   31
#define XAE_LOOPS_TO_COME_OUT_OF_RST   10000
#define XAE_RST_DELAY_LOOPCNT_VAL   200
#define XAE_VLAN_TABL_STRP_FLD_LEN   1
#define XAE_VLAN_TABL_TAG_FLD_LEN   1
#define XAE_MAX_VLAN_TABL_ENTRY   0xFFF
#define XAE_VLAN_TABL_VID_START_OFFSET   2
#define XAE_VLAN_TABL_STRP_STRT_OFFSET   1
#define XAE_VLAN_TABL_STRP_ENTRY_MASK   0x01
#define XAE_VLAN_TABL_TAG_ENTRY_MASK   0x01

Functions

 xdbg_stmnt (extern int indent_on)
-

Detailed Description

-

This header file contains identifiers and macros that can be used to access the Axi Ethernet device. The driver APIs/functions are defined in xaxiethernet.h.

-
Note:
+ +
+
+
+
+

xaxiethernet_hw.h File Reference

Detailed Description

+This header file contains identifiers and macros that can be used to access the Axi Ethernet device. The driver APIs/functions are defined in xaxiethernet.h.

+

Note:
- MODIFICATION HISTORY:
 Ver   Who  Date     Changes
+ MODIFICATION HISTORY:

+

 Ver   Who  Date     Changes
  ----- ---- -------- ---------------------------------------------------------
  1.00a asa  6/30/10 First release for Axi Ethernet driver
  1.02a asa  2/16/11 Changes the value of XAE_LOOPS_TO_COME_OUT_OF_RST to
@@ -339,3403 +34,4134 @@
  2.00a asa  8/29/11 Added defines for Ability Reg, Identification Reg, Rx max
 		     Frame and Tx Max Frame registers.
 		     Changed define for TEMAC RGMII/SGMII Config (PHYC) Reg.
-

Define Documentation

- + +

+#include "xdebug.h"
+#include "xil_io.h"
+#include "xil_types.h"
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Axi Ethernet registers offset

#define XAE_RAF_OFFSET   0x00000000
#define XAE_TPF_OFFSET   0x00000004
#define XAE_IFGP_OFFSET   0x00000008
#define XAE_IS_OFFSET   0x0000000C
#define XAE_IP_OFFSET   0x00000010
#define XAE_IE_OFFSET   0x00000014
#define XAE_TTAG_OFFSET   0x00000018
#define XAE_RTAG_OFFSET   0x0000001C
#define XAE_UAWL_OFFSET   0x00000020
#define XAE_UAWU_OFFSET   0x00000024
#define XAE_TPID0_OFFSET   0x00000028
#define XAE_TPID1_OFFSET   0x0000002C
#define XAE_RXBL_OFFSET   0x00000200
#define XAE_RXBU_OFFSET   0x00000204
#define XAE_TXBL_OFFSET   0x00000208
#define XAE_TXBU_OFFSET   0x0000020C
#define XAE_RXUNDRL_OFFSET   0x00000210
#define XAE_RXUNDRU_OFFSET   0x00000214
#define XAE_RXFRAGL_OFFSET   0x00000218
#define XAE_RXFRAGU_OFFSET   0x0000021C
#define XAE_RX64BL_OFFSET   0x00000220
#define XAE_RX64BU_OFFSET   0x00000224
#define XAE_RX65B127L_OFFSET   0x00000228
#define XAE_RX65B127U_OFFSET   0x0000022C
#define XAE_RX128B255L_OFFSET   0x00000230
#define XAE_RX128B255U_OFFSET   0x00000234
#define XAE_RX256B511L_OFFSET   0x00000238
#define XAE_RX256B511U_OFFSET   0x0000023C
#define XAE_RX512B1023L_OFFSET   0x00000240
#define XAE_RX512B1023U_OFFSET   0x00000244
#define XAE_RX1024BL_OFFSET   0x00000248
#define XAE_RX1024BU_OFFSET   0x0000024C
#define XAE_RXOVRL_OFFSET   0x00000250
#define XAE_RXOVRU_OFFSET   0x00000254
#define XAE_TX64BL_OFFSET   0x00000258
#define XAE_TX64BU_OFFSET   0x0000025C
#define XAE_TX65B127L_OFFSET   0x00000260
#define XAE_TX65B127U_OFFSET   0x00000264
#define XAE_TX128B255L_OFFSET   0x00000268
#define XAE_TX128B255U_OFFSET   0x0000026C
#define XAE_TX256B511L_OFFSET   0x00000270
#define XAE_TX256B511U_OFFSET   0x00000274
#define XAE_TX512B1023L_OFFSET   0x00000278
#define XAE_TX512B1023U_OFFSET   0x0000027C
#define XAE_TX1024L_OFFSET   0x00000280
#define XAE_TX1024U_OFFSET   0x00000284
#define XAE_TXOVRL_OFFSET   0x00000288
#define XAE_TXOVRU_OFFSET   0x0000028C
#define XAE_RXFL_OFFSET   0x00000290
#define XAE_RXFU_OFFSET   0x00000294
#define XAE_RXFCSERL_OFFSET   0x00000298
#define XAE_RXFCSERU_OFFSET   0x0000029C
#define XAE_RXBCSTFL_OFFSET   0x000002A0
#define XAE_RXBCSTFU_OFFSET   0x000002A4
#define XAE_RXMCSTFL_OFFSET   0x000002A8
#define XAE_RXMCSTFU_OFFSET   0x000002AC
#define XAE_RXCTRFL_OFFSET   0x000002B0
#define XAE_RXCTRFU_OFFSET   0x000002B4
#define XAE_RXLTERL_OFFSET   0x000002B8
#define XAE_RXLTERU_OFFSET   0x000002BC
#define XAE_RXVLANFL_OFFSET   0x000002C0
#define XAE_RXVLANFU_OFFSET   0x000002C4
#define XAE_RXPFL_OFFSET   0x000002C8
#define XAE_RXPFU_OFFSET   0x000002CC
#define XAE_RXUOPFL_OFFSET   0x000002D0
#define XAE_RXUOPFU_OFFSET   0x000002D4
#define XAE_TXFL_OFFSET   0x000002D8
#define XAE_TXFU_OFFSET   0x000002DC
#define XAE_TXBCSTFL_OFFSET   0x000002E0
#define XAE_TXBCSTFU_OFFSET   0x000002E4
#define XAE_TXMCSTFL_OFFSET   0x000002E8
#define XAE_TXMCSTFU_OFFSET   0x000002EC
#define XAE_TXUNDRERL_OFFSET   0x000002F0
#define XAE_TXUNDRERU_OFFSET   0x000002F4
#define XAE_TXCTRFL_OFFSET   0x000002F8
#define XAE_TXCTRFU_OFFSET   0x000002FC
#define XAE_TXVLANFL_OFFSET   0x00000300
#define XAE_TXVLANFU_OFFSET   0x00000304
#define XAE_TXPFL_OFFSET   0x00000308
#define XAE_TXPFU_OFFSET   0x0000030C
#define XAE_TXSCL_OFFSET   0x00000310
#define XAE_TXSCU_OFFSET   0x00000314
#define XAE_TXMCL_OFFSET   0x00000318
#define XAE_TXMCU_OFFSET   0x0000031C
#define XAE_TXDEFL_OFFSET   0x00000320
#define XAE_TXDEFU_OFFSET   0x00000324
#define XAE_TXLTCL_OFFSET   0x00000328
#define XAE_TXLTCU_OFFSET   0x0000032C
#define XAE_TXAECL_OFFSET   0x00000330
#define XAE_TXAECU_OFFSET   0x00000334
#define XAE_TXEDEFL_OFFSET   0x00000338
#define XAE_TXEDEFU_OFFSET   0x0000033C
#define XAE_RXAERL_OFFSET   0x00000340
#define XAE_RXAERU_OFFSET   0x0000034C
#define XAE_RCW0_OFFSET   0x00000400
#define XAE_RCW1_OFFSET   0x00000404
#define XAE_TC_OFFSET   0x00000408
#define XAE_FCC_OFFSET   0x0000040C
#define XAE_EMMC_OFFSET   0x00000410
#define XAE_RXFC_OFFSET   0x00000414
#define XAE_TXFC_OFFSET   0x00000418
#define XAE_TX_TIMESTAMP_ADJ_OFFSET   0x0000041C
#define XAE_PHYC_OFFSET   0x00000420
#define XAE_IDREG_OFFSET   0x000004F8
#define XAE_ARREG_OFFSET   0x000004FC
#define XAE_MDIO_MC_OFFSET   0x00000500
#define XAE_MDIO_MCR_OFFSET   0x00000504
#define XAE_MDIO_MWD_OFFSET   0x00000508
#define XAE_MDIO_MRD_OFFSET   0x0000050C
#define XAE_MDIO_MIS_OFFSET   0x00000600
#define XAE_MDIO_MIP_OFFSET   0x00000620
#define XAE_MDIO_MIE_OFFSET   0x00000640
#define XAE_MDIO_MIC_OFFSET   0x00000660
#define XAE_UAW0_OFFSET   0x00000700
#define XAE_UAW1_OFFSET   0x00000704
#define XAE_FMI_OFFSET   0x00000708
#define XAE_AF0_OFFSET   0x00000710
#define XAE_AF1_OFFSET   0x00000714
#define XAE_TX_VLAN_DATA_OFFSET   0x00004000
#define XAE_RX_VLAN_DATA_OFFSET   0x00008000
#define XAE_MCAST_TABLE_OFFSET   0x00020000

Reset and Address Filter (RAF) Register bit definitions.

These bits are associated with the XAE_RAF_OFFSET register.

#define XAE_RAF_MCSTREJ_MASK   0x00000002
#define XAE_RAF_BCSTREJ_MASK   0x00000004
#define XAE_RAF_TXVTAGMODE_MASK   0x00000018
#define XAE_RAF_RXVTAGMODE_MASK   0x00000060
#define XAE_RAF_TXVSTRPMODE_MASK   0x00000180
#define XAE_RAF_RXVSTRPMODE_MASK   0x00000600
#define XAE_RAF_NEWFNCENBL_MASK   0x00000800
#define XAE_RAF_EMULTIFLTRENBL_MASK   0x00001000
#define XAE_RAF_STATSRST_MASK   0x00002000
#define XAE_RAF_RXBADFRMEN_MASK   0x00004000
#define XAE_RAF_TXVTAGMODE_SHIFT   3
#define XAE_RAF_RXVTAGMODE_SHIFT   5
#define XAE_RAF_TXVSTRPMODE_SHIFT   7
#define XAE_RAF_RXVSTRPMODE_SHIFT   9

Transmit Pause Frame Register (TPF) bit definitions

#define XAE_TPF_TPFV_MASK   0x0000FFFF

Transmit Inter-Frame Gap Adjustement Register (TFGP) bit definitions

#define XAE_TFGP_IFGP_MASK   0x0000007F

Interrupt Status/Enable/Mask Registers bit definitions

The bit definition of these three interrupt registers are the same. These bits are associated with the XAE_IS_OFFSET, XAE_IP_OFFSET, and XAE_IE_OFFSET registers.

#define XAE_INT_HARDACSCMPLT_MASK   0x00000001
#define XAE_INT_AUTONEG_MASK   0x00000002
#define XAE_INT_RXCMPIT_MASK   0x00000004
#define XAE_INT_RXRJECT_MASK   0x00000008
#define XAE_INT_RXFIFOOVR_MASK   0x00000010
#define XAE_INT_TXCMPIT_MASK   0x00000020
#define XAE_INT_RXDCMLOCK_MASK   0x00000040
#define XAE_INT_MGTRDY_MASK   0x00000080
#define XAE_INT_PHYRSTCMPLT_MASK   0x00000100
#define XAE_INT_ALL_MASK   0x0000003F
#define XAE_INT_RECV_ERROR_MASK   (XAE_INT_RXRJECT_MASK | XAE_INT_RXFIFOOVR_MASK)

TPID Register (TPID) bit definitions

#define XAE_TPID_0_MASK   0x0000FFFF
#define XAE_TPID_1_MASK   0xFFFF0000

Receive Configuration Word 1 (RCW1) Register bit definitions

#define XAE_RCW1_RST_MASK   0x80000000
#define XAE_RCW1_JUM_MASK   0x40000000
#define XAE_RCW1_FCS_MASK   0x20000000
#define XAE_RCW1_RX_MASK   0x10000000
#define XAE_RCW1_VLAN_MASK   0x08000000
#define XAE_RCW1_LT_DIS_MASK   0x02000000
#define XAE_RCW1_CL_DIS_MASK   0x01000000
#define XAE_RCW1_1588_TIMESTAMP_EN_MASK   0x00400000
#define XAE_RCW1_PAUSEADDR_MASK   0x0000FFFF

Transmitter Configuration (TC) Register bit definitions

#define XAE_TC_RST_MASK   0x80000000
#define XAE_TC_JUM_MASK   0x40000000
#define XAE_TC_FCS_MASK   0x20000000
#define XAE_TC_TX_MASK   0x10000000
#define XAE_TC_VLAN_MASK   0x08000000
#define XAE_TC_IFG_MASK   0x02000000
#define XAE_TC_1588_CMD_EN_MASK   0x00400000

Flow Control Configuration (FCC) Register Bit definitions

#define XAE_FCC_FCRX_MASK   0x20000000
#define XAE_FCC_FCTX_MASK   0x40000000

Ethernet MAC Mode Configuration (EMMC) Register bit definitions

#define XAE_EMMC_LINKSPEED_MASK   0xC0000000
#define XAE_EMMC_RGMII_MASK   0x20000000
#define XAE_EMMC_SGMII_MASK   0x10000000
#define XAE_EMMC_GPCS_MASK   0x08000000
#define XAE_EMMC_HOST_MASK   0x04000000
#define XAE_EMMC_TX16BIT   0x02000000
#define XAE_EMMC_RX16BIT   0x01000000
#define XAE_EMMC_LINKSPD_10   0x00000000
#define XAE_EMMC_LINKSPD_100   0x40000000
#define XAE_EMMC_LINKSPD_1000   0x80000000

RGMII/SGMII Configuration (PHYC) Register bit definitions

#define XAE_PHYC_SGMIILINKSPEED_MASK   0xC0000000
#define XAE_PHYC_RGMIILINKSPEED_MASK   0x0000000C
#define XAE_PHYC_RGMIIHD_MASK   0x00000002
#define XAE_PHYC_RGMIILINK_MASK   0x00000001
#define XAE_PHYC_RGLINKSPD_10   0x00000000
#define XAE_PHYC_RGLINKSPD_100   0x00000004
#define XAE_PHYC_RGLINKSPD_1000   0x00000008
#define XAE_PHYC_SGLINKSPD_10   0x00000000
#define XAE_PHYC_SGLINKSPD_100   0x40000000
#define XAE_PHYC_SGLINKSPD_1000   0x80000000

MDIO Management Configuration (MC) Register bit definitions

#define XAE_MDIO_MC_MDIOEN_MASK   0x00000040
#define XAE_MDIO_MC_CLOCK_DIVIDE_MAX   0x3F

MDIO Management Control Register (MCR) Register bit definitions

#define XAE_MDIO_MCR_PHYAD_MASK   0x1F000000
#define XAE_MDIO_MCR_PHYAD_SHIFT   24
#define XAE_MDIO_MCR_REGAD_MASK   0x001F0000
#define XAE_MDIO_MCR_REGAD_SHIFT   16
#define XAE_MDIO_MCR_OP_MASK   0x0000C000
#define XAE_MDIO_MCR_OP_SHIFT   13
#define XAE_MDIO_MCR_OP_READ_MASK   0x00008000
#define XAE_MDIO_MCR_OP_WRITE_MASK   0x00004000
#define XAE_MDIO_MCR_INITIATE_MASK   0x00000800
#define XAE_MDIO_MCR_READY_MASK   0x00000080

MDIO Interrupt Enable/Mask/Status Registers bit definitions

The bit definition of these three interrupt registers are the same. These bits are associated with the XAE_IS_OFFSET, XAE_IP_OFFSET, and XAE_IE_OFFSET registers.

#define XAE_MDIO_INT_MIIM_RDY_MASK   0x00000001

Axi Ethernet Unicast Address Register Word 1 (UAW1) Register Bit

definitions

#define XAE_UAW1_UNICASTADDR_MASK   0x0000FFFF

Filter Mask Index (FMI) Register bit definitions

#define XAE_FMI_PM_MASK   0x80000000
#define XAE_FMI_IND_MASK   0x00000003

Extended multicast buffer descriptor bit mask

#define XAE_BD_RX_USR2_BCAST_MASK   0x00000004
#define XAE_BD_RX_USR2_IP_MCAST_MASK   0x00000002
#define XAE_BD_RX_USR2_MCAST_MASK   0x00000001

Axi Ethernet Multicast Address Register Word 1 (MAW1)

#define XAE_MAW1_RNW_MASK   0x00800000
#define XAE_MAW1_ADDR_MASK   0x00030000
#define XAE_MAW1_MULTICADDR_MASK   0x0000FFFF
#define XAE_MAW1_MATADDR_SHIFT_MASK   16

Other Constant definitions used in the driver

#define XAE_SPEED_10_MBPS   10
#define XAE_SPEED_100_MBPS   100
#define XAE_SPEED_1000_MBPS   1000
#define XAE_SOFT_TEMAC_LOW_SPEED   0
#define XAE_SOFT_TEMAC_HIGH_SPEED   1
#define XAE_HARD_TEMAC_TYPE   2
#define XAE_PHY_ADDR_LIMIT   31
#define XAE_PHY_REG_NUM_LIMIT   31
#define XAE_LOOPS_TO_COME_OUT_OF_RST   10000
#define XAE_RST_DELAY_LOOPCNT_VAL   200
#define XAE_VLAN_TABL_STRP_FLD_LEN   1
#define XAE_VLAN_TABL_TAG_FLD_LEN   1
#define XAE_MAX_VLAN_TABL_ENTRY   0xFFF
#define XAE_VLAN_TABL_VID_START_OFFSET   2
#define XAE_VLAN_TABL_STRP_STRT_OFFSET   1
#define XAE_VLAN_TABL_STRP_ENTRY_MASK   0x01
#define XAE_VLAN_TABL_TAG_ENTRY_MASK   0x01

Defines

#define XAXIETHERNET_HW_H
#define XAxiEthernet_indent(RegOffset)
#define XAxiEthernet_reg_name(RegOffset)
#define XAxiEthernet_print_reg_o(BaseAddress, RegOffset, Value)
#define XAxiEthernet_print_reg_i(BaseAddress, RegOffset, Value)
#define XAxiEthernet_ReadReg(BaseAddress, RegOffset)   (Xil_In32(((BaseAddress) + (RegOffset))))
#define XAxiEthernet_WriteReg(BaseAddress, RegOffset, Data)   Xil_Out32(((BaseAddress) + (RegOffset)), (Data))

Functions

 xdbg_stmnt (extern int indent_on)
+

Define Documentation

+
- +
#define XAE_AF0_OFFSET   0x00000710#define XAE_AF0_OFFSET   0x00000710
-

Address Filter 0

+

+Address Filter 0

-
- +

+

- +
#define XAE_AF1_OFFSET   0x00000714#define XAE_AF1_OFFSET   0x00000714
-

Address Filter 1

+

+Address Filter 1

-
- +

+

- +
#define XAE_ARREG_OFFSET   0x000004FC#define XAE_ARREG_OFFSET   0x000004FC
-

Ability Register

+

+Ability Register

-
- +

+

- +
#define XAE_BD_RX_USR2_BCAST_MASK   0x00000004#define XAE_BD_RX_USR2_BCAST_MASK   0x00000004
+

+

-
- +

+

- +
#define XAE_BD_RX_USR2_IP_MCAST_MASK   0x00000002#define XAE_BD_RX_USR2_IP_MCAST_MASK   0x00000002
+

+

-
- +

+

- +
#define XAE_BD_RX_USR2_MCAST_MASK   0x00000001#define XAE_BD_RX_USR2_MCAST_MASK   0x00000001
+

+

-
- +

+

- +
#define XAE_EMMC_GPCS_MASK   0x08000000#define XAE_EMMC_GPCS_MASK   0x08000000
-

1000BaseX mode enable

+

+1000BaseX mode enable

-
- +

+

- +
#define XAE_EMMC_HOST_MASK   0x04000000#define XAE_EMMC_HOST_MASK   0x04000000
-

Host interface enable

+

+Host interface enable

-
- +

+

- +
#define XAE_EMMC_LINKSPD_10   0x00000000#define XAE_EMMC_LINKSPD_10   0x00000000
-

Link Speed mask for 10 Mbit

+

+Link Speed mask for 10 Mbit

-
- +

+

- +
#define XAE_EMMC_LINKSPD_100   0x40000000#define XAE_EMMC_LINKSPD_100   0x40000000
-

Link Speed mask for 100 Mbit

+

+Link Speed mask for 100 Mbit

-
- +

+

- +
#define XAE_EMMC_LINKSPD_1000   0x80000000#define XAE_EMMC_LINKSPD_1000   0x80000000
-

Link Speed mask for 1000 Mbit

+

+Link Speed mask for 1000 Mbit

-
- +

+

- +
#define XAE_EMMC_LINKSPEED_MASK   0xC0000000#define XAE_EMMC_LINKSPEED_MASK   0xC0000000
-

Link speed

+

+Link speed

-
- +

+

- +
#define XAE_EMMC_OFFSET   0x00000410#define XAE_EMMC_OFFSET   0x00000410
-

EMAC mode configuration

+

+EMAC mode configuration

-
- +

+

- +
#define XAE_EMMC_RGMII_MASK   0x20000000#define XAE_EMMC_RGMII_MASK   0x20000000
-

RGMII mode enable

+

+RGMII mode enable

-
- +

+

- +
#define XAE_EMMC_RX16BIT   0x01000000#define XAE_EMMC_RX16BIT   0x01000000
-

16 bit Rx client enable

+

+16 bit Rx client enable

-
- +

+

- +
#define XAE_EMMC_SGMII_MASK   0x10000000#define XAE_EMMC_SGMII_MASK   0x10000000
-

SGMII mode enable

+

+SGMII mode enable

-
- +

+

- +
#define XAE_EMMC_TX16BIT   0x02000000#define XAE_EMMC_TX16BIT   0x02000000
-

16 bit Tx client enable

+

+16 bit Tx client enable

-
- +

+

- +
#define XAE_FCC_FCRX_MASK   0x20000000#define XAE_FCC_FCRX_MASK   0x20000000
-

Rx flow control enable

+

+Rx flow control enable

-
- +

+

- +
#define XAE_FCC_FCTX_MASK   0x40000000#define XAE_FCC_FCTX_MASK   0x40000000
-

Tx flow control enable

+

+Tx flow control enable

-
- +

+

- +
#define XAE_FCC_OFFSET   0x0000040C#define XAE_FCC_OFFSET   0x0000040C
-

Flow Control Configuration

+

+Flow Control Configuration

-
- +

+

- +
#define XAE_FMI_IND_MASK   0x00000003#define XAE_FMI_IND_MASK   0x00000003
-

Index Mask

+

+Index Mask

-
- +

+

- +
#define XAE_FMI_OFFSET   0x00000708#define XAE_FMI_OFFSET   0x00000708
-

Filter Mask Index

+

+Filter Mask Index

-
- +

+

- +
#define XAE_FMI_PM_MASK   0x80000000#define XAE_FMI_PM_MASK   0x80000000
-

Promiscuous mode enable

+

+Promiscuous mode enable

-
- +

+

- +
#define XAE_HARD_TEMAC_TYPE   2#define XAE_HARD_TEMAC_TYPE   2
-

For hard TEMAC cores used virtex-6.

+

+For hard TEMAC cores used virtex-6.

-
- +

+

- +
#define XAE_IDREG_OFFSET   0x000004F8#define XAE_IDREG_OFFSET   0x000004F8
-

Identification Register

+

+Identification Register

-
- +

+

- +
#define XAE_IE_OFFSET   0x00000014#define XAE_IE_OFFSET   0x00000014
-

Interrupt enable

+

+Interrupt enable

-
- +

+

- +
#define XAE_IFGP_OFFSET   0x00000008#define XAE_IFGP_OFFSET   0x00000008
-

Tx Inter-frame gap adjustment

+

+Tx Inter-frame gap adjustment

-
- +

+

- +
#define XAE_INT_ALL_MASK   0x0000003F#define XAE_INT_ALL_MASK   0x0000003F
-

All the ints

+

+All the ints

-
- +

+

- +
#define XAE_INT_AUTONEG_MASK   0x00000002#define XAE_INT_AUTONEG_MASK   0x00000002
-

Auto negotiation complete

+

+Auto negotiation complete

-
- +

+

- +
#define XAE_INT_HARDACSCMPLT_MASK   0x00000001#define XAE_INT_HARDACSCMPLT_MASK   0x00000001
-

Hard register access complete

+

+Hard register access complete

-
- +

+

- +
#define XAE_INT_MGTRDY_MASK   0x00000080#define XAE_INT_MGTRDY_MASK   0x00000080
-

MGT clock Lock

+

+MGT clock Lock

-
- +

+

- +
#define XAE_INT_PHYRSTCMPLT_MASK   0x00000100#define XAE_INT_PHYRSTCMPLT_MASK   0x00000100
-

Phy Reset complete

+

+Phy Reset complete

-
- +

+

- +
#define XAE_INT_RECV_ERROR_MASK   (XAE_INT_RXRJECT_MASK | XAE_INT_RXFIFOOVR_MASK)#define XAE_INT_RECV_ERROR_MASK   (XAE_INT_RXRJECT_MASK | XAE_INT_RXFIFOOVR_MASK)
-

INT bits that indicate receive errors

+

+INT bits that indicate receive errors

-
- +

+

- +
#define XAE_INT_RXCMPIT_MASK   0x00000004#define XAE_INT_RXCMPIT_MASK   0x00000004
-

Rx complete

+

+Rx complete

-
- +

+

- +
#define XAE_INT_RXDCMLOCK_MASK   0x00000040#define XAE_INT_RXDCMLOCK_MASK   0x00000040
-

Rx Dcm Lock

+

+Rx Dcm Lock

-
- +

+

- +
#define XAE_INT_RXFIFOOVR_MASK   0x00000010#define XAE_INT_RXFIFOOVR_MASK   0x00000010
-

Rx fifo overrun

+

+Rx fifo overrun

-
- +

+

- +
#define XAE_INT_RXRJECT_MASK   0x00000008#define XAE_INT_RXRJECT_MASK   0x00000008
-

Rx frame rejected

+

+Rx frame rejected

-
- +

+

- +
#define XAE_INT_TXCMPIT_MASK   0x00000020#define XAE_INT_TXCMPIT_MASK   0x00000020
-

Tx complete

+

+Tx complete

-
- +

+

- +
#define XAE_IP_OFFSET   0x00000010#define XAE_IP_OFFSET   0x00000010
-

Interrupt pending

+

+Interrupt pending

-
- +

+

- +
#define XAE_IS_OFFSET   0x0000000C#define XAE_IS_OFFSET   0x0000000C
-

Interrupt status

+

+Interrupt status

-
- +

+

- +
#define XAE_LOOPS_TO_COME_OUT_OF_RST   10000#define XAE_LOOPS_TO_COME_OUT_OF_RST   10000
-

Number of loops in the driver API to wait for before returning a failure case.

+

+Number of loops in the driver API to wait for before returning a failure case.

-
- +

+

- +
#define XAE_MAW1_ADDR_MASK   0x00030000#define XAE_MAW1_ADDR_MASK   0x00030000
-

Multicast address table register address

+

+Multicast address table register address

-
- +

+

- +
#define XAE_MAW1_MATADDR_SHIFT_MASK   16#define XAE_MAW1_MATADDR_SHIFT_MASK   16
-

Number of bits to shift right to align with XAE_MAW1_CAMADDR_MASK

+

+Number of bits to shift right to align with XAE_MAW1_CAMADDR_MASK

-
- +

+

- +
#define XAE_MAW1_MULTICADDR_MASK   0x0000FFFF#define XAE_MAW1_MULTICADDR_MASK   0x0000FFFF
-

Multicast address bits [47:32] Multicast address bits [31:0] are stored in register MAW0

+

+Multicast address bits [47:32] Multicast address bits [31:0] are stored in register MAW0

-
- +

+

- +
#define XAE_MAW1_RNW_MASK   0x00800000#define XAE_MAW1_RNW_MASK   0x00800000
-

Multicast address table register read enable

+

+Multicast address table register read enable

-
- +

+

- +
#define XAE_MAX_VLAN_TABL_ENTRY   0xFFF#define XAE_MAX_VLAN_TABL_ENTRY   0xFFF
-

Max possible number of entries in vlan table used for extended vlan features.

+

+Max possible number of entries in vlan table used for extended vlan features.

-
- +

+

- +
#define XAE_MCAST_TABLE_OFFSET   0x00020000#define XAE_MCAST_TABLE_OFFSET   0x00020000
-

Multicast table address

+

+Multicast table address

-
- +

+

- +
#define XAE_MDIO_INT_MIIM_RDY_MASK   0x00000001#define XAE_MDIO_INT_MIIM_RDY_MASK   0x00000001
-

MIIM Interrupt

+

+MIIM Interrupt

-
- +

+

- +
#define XAE_MDIO_MC_CLOCK_DIVIDE_MAX   0x3F#define XAE_MDIO_MC_CLOCK_DIVIDE_MAX   0x3F
-

Maximum MDIO divisor

+

+Maximum MDIO divisor

-
- +

+

- +
#define XAE_MDIO_MC_MDIOEN_MASK   0x00000040#define XAE_MDIO_MC_MDIOEN_MASK   0x00000040
-

MII management enable

+

+MII management enable

-
- +

+

- +
#define XAE_MDIO_MC_OFFSET   0x00000500#define XAE_MDIO_MC_OFFSET   0x00000500
-

MII Management Config

+

+MII Management Config

-
- +

+

- +
#define XAE_MDIO_MCR_INITIATE_MASK   0x00000800#define XAE_MDIO_MCR_INITIATE_MASK   0x00000800
-

Ready Mask

+

+Ready Mask

-
- +

+

- +
#define XAE_MDIO_MCR_OFFSET   0x00000504#define XAE_MDIO_MCR_OFFSET   0x00000504
-

MII Management Control

+

+MII Management Control

-
- +

+

- +
#define XAE_MDIO_MCR_OP_MASK   0x0000C000#define XAE_MDIO_MCR_OP_MASK   0x0000C000
-

Operation Code Mask

+

+Operation Code Mask

-
- +

+

- +
#define XAE_MDIO_MCR_OP_READ_MASK   0x00008000#define XAE_MDIO_MCR_OP_READ_MASK   0x00008000
-

Op Code Read Mask

+

+Op Code Read Mask

-
- +

+

- +
#define XAE_MDIO_MCR_OP_SHIFT   13#define XAE_MDIO_MCR_OP_SHIFT   13
-

Operation Code Shift

+

+Operation Code Shift

-
- +

+

- +
#define XAE_MDIO_MCR_OP_WRITE_MASK   0x00004000#define XAE_MDIO_MCR_OP_WRITE_MASK   0x00004000
-

Op Code Write Mask

+

+Op Code Write Mask

-
- +

+

- +
#define XAE_MDIO_MCR_PHYAD_MASK   0x1F000000#define XAE_MDIO_MCR_PHYAD_MASK   0x1F000000
-

Phy Address Mask

+

+Phy Address Mask

-
- +

+

- +
#define XAE_MDIO_MCR_PHYAD_SHIFT   24#define XAE_MDIO_MCR_PHYAD_SHIFT   24
-

Phy Address Shift

+

+Phy Address Shift

-
- +

+

- +
#define XAE_MDIO_MCR_READY_MASK   0x00000080#define XAE_MDIO_MCR_READY_MASK   0x00000080
-

Ready Mask

+

+Ready Mask

-
- +

+

- +
#define XAE_MDIO_MCR_REGAD_MASK   0x001F0000#define XAE_MDIO_MCR_REGAD_MASK   0x001F0000
-

Reg Address Mask

+

+Reg Address Mask

-
- +

+

- +
#define XAE_MDIO_MCR_REGAD_SHIFT   16#define XAE_MDIO_MCR_REGAD_SHIFT   16
-

Reg Address Shift

+

+Reg Address Shift

-
- +

+

- +
#define XAE_MDIO_MIC_OFFSET   0x00000660#define XAE_MDIO_MIC_OFFSET   0x00000660
-

MII Management Interrupt Clear register offset.

+

+MII Management Interrupt Clear register offset.

-
- +

+

- +
#define XAE_MDIO_MIE_OFFSET   0x00000640#define XAE_MDIO_MIE_OFFSET   0x00000640
-

MII Management Interrupt Enable register offset

+

+MII Management Interrupt Enable register offset

-
- +

+

- +
#define XAE_MDIO_MIP_OFFSET   0x00000620#define XAE_MDIO_MIP_OFFSET   0x00000620
-

MII Management Interrupt Pending register offse

+

+MII Management Interrupt Pending register offse

-
- +

+

- +
#define XAE_MDIO_MIS_OFFSET   0x00000600#define XAE_MDIO_MIS_OFFSET   0x00000600
-

MII Management Interrupt Status

+

+MII Management Interrupt Status

-
- +

+

- +
#define XAE_MDIO_MRD_OFFSET   0x0000050C#define XAE_MDIO_MRD_OFFSET   0x0000050C
-

MII Management Read Data

+

+MII Management Read Data

-
- +

+

- +
#define XAE_MDIO_MWD_OFFSET   0x00000508#define XAE_MDIO_MWD_OFFSET   0x00000508
-

MII Management Write Data

+

+MII Management Write Data

-
- +

+

- +
#define XAE_PHY_ADDR_LIMIT   31#define XAE_PHY_ADDR_LIMIT   31
-

Max limit while accessing and searching for available PHYs.

+

+Max limit while accessing and searching for available PHYs.

-
- +

+

- +
#define XAE_PHY_REG_NUM_LIMIT   31#define XAE_PHY_REG_NUM_LIMIT   31
-

Max register limit in PHY as mandated by the spec.

+

+Max register limit in PHY as mandated by the spec.

-
- +

+

- +
#define XAE_PHYC_OFFSET   0x00000420#define XAE_PHYC_OFFSET   0x00000420
-

RGMII/SGMII configuration

+

+RGMII/SGMII configuration

-
- +

+

- +
#define XAE_PHYC_RGLINKSPD_10   0x00000000#define XAE_PHYC_RGLINKSPD_10   0x00000000
-

RGMII link 10 Mbit

+

+RGMII link 10 Mbit

-
- +

+

- +
#define XAE_PHYC_RGLINKSPD_100   0x00000004#define XAE_PHYC_RGLINKSPD_100   0x00000004
-

RGMII link 100 Mbit

+

+RGMII link 100 Mbit

-
- +

+

- +
#define XAE_PHYC_RGLINKSPD_1000   0x00000008#define XAE_PHYC_RGLINKSPD_1000   0x00000008
-

RGMII link 1000 Mbit

+

+RGMII link 1000 Mbit

-
- +

+

- +
#define XAE_PHYC_RGMIIHD_MASK   0x00000002#define XAE_PHYC_RGMIIHD_MASK   0x00000002
-

RGMII Half-duplex

+

+RGMII Half-duplex

-
- +

+

- +
#define XAE_PHYC_RGMIILINK_MASK   0x00000001#define XAE_PHYC_RGMIILINK_MASK   0x00000001
-

RGMII link status

+

+RGMII link status

-
- +

+

- +
#define XAE_PHYC_RGMIILINKSPEED_MASK   0x0000000C#define XAE_PHYC_RGMIILINKSPEED_MASK   0x0000000C
-

RGMII link speed

+

+RGMII link speed

-
- +

+

- +
#define XAE_PHYC_SGLINKSPD_10   0x00000000#define XAE_PHYC_SGLINKSPD_10   0x00000000
-

SGMII link 10 Mbit

+

+SGMII link 10 Mbit

-
- +

+

- +
#define XAE_PHYC_SGLINKSPD_100   0x40000000#define XAE_PHYC_SGLINKSPD_100   0x40000000
-

SGMII link 100 Mbit

+

+SGMII link 100 Mbit

-
- +

+

- +
#define XAE_PHYC_SGLINKSPD_1000   0x80000000#define XAE_PHYC_SGLINKSPD_1000   0x80000000
-

SGMII link 1000 Mbit

+

+SGMII link 1000 Mbit

-
- +

+

- +
#define XAE_PHYC_SGMIILINKSPEED_MASK   0xC0000000#define XAE_PHYC_SGMIILINKSPEED_MASK   0xC0000000
-

SGMII link speed mask

+

+SGMII link speed mask

-
- +

+

- +
#define XAE_RAF_BCSTREJ_MASK   0x00000004#define XAE_RAF_BCSTREJ_MASK   0x00000004
-

Reject receive broadcast destination address

+

+Reject receive broadcast destination address

-
- +

+

- +
#define XAE_RAF_EMULTIFLTRENBL_MASK   0x00001000#define XAE_RAF_EMULTIFLTRENBL_MASK   0x00001000
-

Exteneded Multicast Filtering mode

+

+Exteneded Multicast Filtering mode

-
- +

+

- +
#define XAE_RAF_MCSTREJ_MASK   0x00000002#define XAE_RAF_MCSTREJ_MASK   0x00000002
-

Reject receive multicast destination address

+

+Reject receive multicast destination address

-
- +

+

- +
#define XAE_RAF_NEWFNCENBL_MASK   0x00000800#define XAE_RAF_NEWFNCENBL_MASK   0x00000800
-

New function mode

+

+New function mode

-
- +

+

- +
#define XAE_RAF_OFFSET   0x00000000#define XAE_RAF_OFFSET   0x00000000
-

Reset and Address filter

+

+Reset and Address filter

-
- +

+

- +
#define XAE_RAF_RXBADFRMEN_MASK   0x00004000#define XAE_RAF_RXBADFRMEN_MASK   0x00004000
-

Receive Bad Frame Enable

+

+Receive Bad Frame Enable

-
- +

+

- +
#define XAE_RAF_RXVSTRPMODE_MASK   0x00000600#define XAE_RAF_RXVSTRPMODE_MASK   0x00000600
-

Rx VLAN STRIP mode

+

+Rx VLAN STRIP mode

-
- +

+

- +
#define XAE_RAF_RXVSTRPMODE_SHIFT   9#define XAE_RAF_RXVSTRPMODE_SHIFT   9
-

Rx Strip mode shift bits

+

+Rx Strip mode shift bits

-
- +

+

- +
#define XAE_RAF_RXVTAGMODE_MASK   0x00000060#define XAE_RAF_RXVTAGMODE_MASK   0x00000060
-

Rx VLAN TAG mode

+

+Rx VLAN TAG mode

-
- +

+

- +
#define XAE_RAF_RXVTAGMODE_SHIFT   5#define XAE_RAF_RXVTAGMODE_SHIFT   5
-

Rx Tag mode shift bits

+

+Rx Tag mode shift bits

-
- +

+

- +
#define XAE_RAF_STATSRST_MASK   0x00002000#define XAE_RAF_STATSRST_MASK   0x00002000
-

Statistics Counter Reset

+

+Statistics Counter Reset

-
- +

+

- +
#define XAE_RAF_TXVSTRPMODE_MASK   0x00000180#define XAE_RAF_TXVSTRPMODE_MASK   0x00000180
-

Tx VLAN STRIP mode

+

+Tx VLAN STRIP mode

-
- +

+

- +
#define XAE_RAF_TXVSTRPMODE_SHIFT   7#define XAE_RAF_TXVSTRPMODE_SHIFT   7
-

Tx strip mode shift bits

+

+Tx strip mode shift bits

-
- +

+

- +
#define XAE_RAF_TXVTAGMODE_MASK   0x00000018#define XAE_RAF_TXVTAGMODE_MASK   0x00000018
-

Tx VLAN TAG mode

+

+Tx VLAN TAG mode

-
- +

+

- +
#define XAE_RAF_TXVTAGMODE_SHIFT   3#define XAE_RAF_TXVTAGMODE_SHIFT   3
-

Tx Tag mode shift bits

+

+Tx Tag mode shift bits

-
- +

+

- +
#define XAE_RCW0_OFFSET   0x00000400#define XAE_RCW0_OFFSET   0x00000400
-

Rx Configuration Word 0

+

+Rx Configuration Word 0

-
- +

+

- +
#define XAE_RCW1_1588_TIMESTAMP_EN_MASK   0x00400000#define XAE_RCW1_1588_TIMESTAMP_EN_MASK   0x00400000
-

Inband 1588 time stamp enable

+

+Inband 1588 time stamp enable

-
- +

+

- +
#define XAE_RCW1_CL_DIS_MASK   0x01000000#define XAE_RCW1_CL_DIS_MASK   0x01000000
-

Control frame Length check disable

+

+Control frame Length check disable

-
- +

+

- +
#define XAE_RCW1_FCS_MASK   0x20000000#define XAE_RCW1_FCS_MASK   0x20000000
-

In-Band FCS enable (FCS not stripped)

+

+In-Band FCS enable (FCS not stripped)

-
- +

+

- +
#define XAE_RCW1_JUM_MASK   0x40000000#define XAE_RCW1_JUM_MASK   0x40000000
-

Jumbo frame enable

+

+Jumbo frame enable

-
- +

+

- +
#define XAE_RCW1_LT_DIS_MASK   0x02000000#define XAE_RCW1_LT_DIS_MASK   0x02000000
-

Length/type field valid check disable

+

+Length/type field valid check disable

-
- +

+

- +
#define XAE_RCW1_OFFSET   0x00000404#define XAE_RCW1_OFFSET   0x00000404
-

Rx Configuration Word 1

+

+Rx Configuration Word 1

-
- +

+

- +
#define XAE_RCW1_PAUSEADDR_MASK   0x0000FFFF#define XAE_RCW1_PAUSEADDR_MASK   0x0000FFFF
-

Pause frame source address bits [47:32].Bits [31:0] are stored in register RCW0

+

+Pause frame source address bits [47:32].Bits [31:0] are stored in register RCW0

-
- +

+

- +
#define XAE_RCW1_RST_MASK   0x80000000#define XAE_RCW1_RST_MASK   0x80000000
-

Reset

+

+Reset

-
- +

+

- +
#define XAE_RCW1_RX_MASK   0x10000000#define XAE_RCW1_RX_MASK   0x10000000
-

Receiver enable

+

+Receiver enable

-
- +

+

- +
#define XAE_RCW1_VLAN_MASK   0x08000000#define XAE_RCW1_VLAN_MASK   0x08000000
-

VLAN frame enable

+

+VLAN frame enable

-
- +

+

- +
#define XAE_RST_DELAY_LOOPCNT_VAL   200#define XAE_RST_DELAY_LOOPCNT_VAL   200
-

Timeout in ticks used while checking if the core had come out of reset. The exact tick time is defined in each case/loop where it will be used

+

+Timeout in ticks used while checking if the core had come out of reset. The exact tick time is defined in each case/loop where it will be used

-
- +

+

- +
#define XAE_RTAG_OFFSET   0x0000001C#define XAE_RTAG_OFFSET   0x0000001C
-

Rx VLAN TAG

+

+Rx VLAN TAG

-
- +

+

- +
#define XAE_RX1024BL_OFFSET   0x00000248#define XAE_RX1024BL_OFFSET   0x00000248
-

Count of 1024-MAX bytes frames received, LSW

+

+Count of 1024-MAX bytes frames received, LSW

-
- +

+

- +
#define XAE_RX1024BU_OFFSET   0x0000024C#define XAE_RX1024BU_OFFSET   0x0000024C
-

Count of 1024-MAX bytes frames received, MSW

+

+Count of 1024-MAX bytes frames received, MSW

-
- +

+

- +
#define XAE_RX128B255L_OFFSET   0x00000230#define XAE_RX128B255L_OFFSET   0x00000230
-

Count of 128-255 bytes Frames received, LSW

+

+Count of 128-255 bytes Frames received, LSW

-
- +

+

- +
#define XAE_RX128B255U_OFFSET   0x00000234#define XAE_RX128B255U_OFFSET   0x00000234
-

Count of 128-255 bytes frames received, MSW

+

+Count of 128-255 bytes frames received, MSW

-
- +

+

- +
#define XAE_RX256B511L_OFFSET   0x00000238#define XAE_RX256B511L_OFFSET   0x00000238
-

Count of 256-511 bytes Frames received, LSW

+

+Count of 256-511 bytes Frames received, LSW

-
- +

+

- +
#define XAE_RX256B511U_OFFSET   0x0000023C#define XAE_RX256B511U_OFFSET   0x0000023C
-

Count of 256-511 bytes frames received, MSW

+

+Count of 256-511 bytes frames received, MSW

-
- +

+

- +
#define XAE_RX512B1023L_OFFSET   0x00000240#define XAE_RX512B1023L_OFFSET   0x00000240
-

Count of 512-1023 bytes frames received, LSW

+

+Count of 512-1023 bytes frames received, LSW

-
- +

+

- +
#define XAE_RX512B1023U_OFFSET   0x00000244#define XAE_RX512B1023U_OFFSET   0x00000244
-

Count of 512-1023 bytes frames received, MSW

+

+Count of 512-1023 bytes frames received, MSW

-
- +

+

- +
#define XAE_RX64BL_OFFSET   0x00000220#define XAE_RX64BL_OFFSET   0x00000220
-

Count of 64 bytes frames received, LSW

+

+Count of 64 bytes frames received, LSW

-
- +

+

- +
#define XAE_RX64BU_OFFSET   0x00000224#define XAE_RX64BU_OFFSET   0x00000224
-

Count of 64 bytes frames received, MSW

+

+Count of 64 bytes frames received, MSW

-
- +

+

- +
#define XAE_RX65B127L_OFFSET   0x00000228#define XAE_RX65B127L_OFFSET   0x00000228
-

Count of 65-127 bytes Frames received, LSW

+

+Count of 65-127 bytes Frames received, LSW

-
- +

+

- +
#define XAE_RX65B127U_OFFSET   0x0000022C#define XAE_RX65B127U_OFFSET   0x0000022C
-

Count of 65-127 bytes Frames received, MSW

+

+Count of 65-127 bytes Frames received, MSW

-
- +

+

- +
#define XAE_RX_VLAN_DATA_OFFSET   0x00008000#define XAE_RX_VLAN_DATA_OFFSET   0x00008000
-

RX VLAN data table address

+

+RX VLAN data table address

-
- +

+

- +
#define XAE_RXAERL_OFFSET   0x00000340#define XAE_RXAERL_OFFSET   0x00000340
-

Frames received with alignment errors, LSW

+

+Frames received with alignment errors, LSW

-
- +

+

- +
#define XAE_RXAERU_OFFSET   0x0000034C#define XAE_RXAERU_OFFSET   0x0000034C
-

Frames received with alignment errors, MSW

+

+Frames received with alignment errors, MSW

-
- +

+

- +
#define XAE_RXBCSTFL_OFFSET   0x000002A0#define XAE_RXBCSTFL_OFFSET   0x000002A0
-

Count of broadcast frames received, LSW

+

+Count of broadcast frames received, LSW

-
- +

+

- +
#define XAE_RXBCSTFU_OFFSET   0x000002A4#define XAE_RXBCSTFU_OFFSET   0x000002A4
-

Count of broadcast frames received, MSW

+

+Count of broadcast frames received, MSW

-
- +

+

- +
#define XAE_RXBL_OFFSET   0x00000200#define XAE_RXBL_OFFSET   0x00000200
-

Received Bytes, LSW

+

+Received Bytes, LSW

-
- +

+

- +
#define XAE_RXBU_OFFSET   0x00000204#define XAE_RXBU_OFFSET   0x00000204
-

Received Bytes, MSW

+

+Received Bytes, MSW

-
- +

+

- +
#define XAE_RXCTRFL_OFFSET   0x000002B0#define XAE_RXCTRFL_OFFSET   0x000002B0
-

Count of control frames received, LSW

+

+Count of control frames received, LSW

-
- +

+

- +
#define XAE_RXCTRFU_OFFSET   0x000002B4#define XAE_RXCTRFU_OFFSET   0x000002B4
-

Count of control frames received, MSW

+

+Count of control frames received, MSW

-
- +

+

- +
#define XAE_RXFC_OFFSET   0x00000414#define XAE_RXFC_OFFSET   0x00000414
-

Rx Max Frm Config Register

+

+Rx Max Frm Config Register

-
- +

+

- +
#define XAE_RXFCSERL_OFFSET   0x00000298#define XAE_RXFCSERL_OFFSET   0x00000298
-

Count of frames received with FCS error and at least 64 bytes, LSW

+

+Count of frames received with FCS error and at least 64 bytes, LSW

-
- +

+

- +
#define XAE_RXFCSERU_OFFSET   0x0000029C#define XAE_RXFCSERU_OFFSET   0x0000029C
-

Count of frames received with FCS error and at least 64 bytes,MSW

+

+Count of frames received with FCS error and at least 64 bytes,MSW

-
- +

+

- +
#define XAE_RXFL_OFFSET   0x00000290#define XAE_RXFL_OFFSET   0x00000290
-

Count of frames received OK, LSW

+

+Count of frames received OK, LSW

-
- +

+

- +
#define XAE_RXFRAGL_OFFSET   0x00000218#define XAE_RXFRAGL_OFFSET   0x00000218
-

Count of undersized(less than 64 bytes) and bad FCS frames received, LSW

+

+Count of undersized(less than 64 bytes) and bad FCS frames received, LSW

-
- +

+

- +
#define XAE_RXFRAGU_OFFSET   0x0000021C#define XAE_RXFRAGU_OFFSET   0x0000021C
-

Count of undersized(less than 64 bytes) and bad FCS frames received, MSW

+

+Count of undersized(less than 64 bytes) and bad FCS frames received, MSW

-
- +

+

- +
#define XAE_RXFU_OFFSET   0x00000294#define XAE_RXFU_OFFSET   0x00000294
-

Count of frames received OK, MSW

+

+Count of frames received OK, MSW

-
- +

+

- +
#define XAE_RXLTERL_OFFSET   0x000002B8#define XAE_RXLTERL_OFFSET   0x000002B8
-

Count of frames received with length error, LSW

+

+Count of frames received with length error, LSW

-
- +

+

- +
#define XAE_RXLTERU_OFFSET   0x000002BC#define XAE_RXLTERU_OFFSET   0x000002BC
-

Count of frames received with length error, MSW

+

+Count of frames received with length error, MSW

-
- +

+

- +
#define XAE_RXMCSTFL_OFFSET   0x000002A8#define XAE_RXMCSTFL_OFFSET   0x000002A8
-

Count of multicast frames received, LSW

+

+Count of multicast frames received, LSW

-
- +

+

- +
#define XAE_RXMCSTFU_OFFSET   0x000002AC#define XAE_RXMCSTFU_OFFSET   0x000002AC
-

Count of multicast frames received, MSW

+

+Count of multicast frames received, MSW

-
- +

+

- +
#define XAE_RXOVRL_OFFSET   0x00000250#define XAE_RXOVRL_OFFSET   0x00000250
-

Count of oversize frames received, LSW

+

+Count of oversize frames received, LSW

-
- +

+

- +
#define XAE_RXOVRU_OFFSET   0x00000254#define XAE_RXOVRU_OFFSET   0x00000254
-

Count of oversize frames received, MSW

+

+Count of oversize frames received, MSW

-
- +

+

- +
#define XAE_RXPFL_OFFSET   0x000002C8#define XAE_RXPFL_OFFSET   0x000002C8
-

Count of pause frames received, LSW

+

+Count of pause frames received, LSW

-
- +

+

- +
#define XAE_RXPFU_OFFSET   0x000002CC#define XAE_RXPFU_OFFSET   0x000002CC
-

Count of pause frames received, MSW

+

+Count of pause frames received, MSW

-
- +

+

- +
#define XAE_RXUNDRL_OFFSET   0x00000210#define XAE_RXUNDRL_OFFSET   0x00000210
-

Count of undersize(less than 64 bytes) frames received, LSW

+

+Count of undersize(less than 64 bytes) frames received, LSW

-
- +

+

- +
#define XAE_RXUNDRU_OFFSET   0x00000214#define XAE_RXUNDRU_OFFSET   0x00000214
-

Count of undersize(less than 64 bytes) frames received, MSW

+

+Count of undersize(less than 64 bytes) frames received, MSW

-
- +

+

- +
#define XAE_RXUOPFL_OFFSET   0x000002D0#define XAE_RXUOPFL_OFFSET   0x000002D0
-

Count of control frames received with unsupported opcode, LSW

+

+Count of control frames received with unsupported opcode, LSW

-
- +

+

- +
#define XAE_RXUOPFU_OFFSET   0x000002D4#define XAE_RXUOPFU_OFFSET   0x000002D4
-

Count of control frames received with unsupported opcode, MSW

+

+Count of control frames received with unsupported opcode, MSW

-
- +

+

- +
#define XAE_RXVLANFL_OFFSET   0x000002C0#define XAE_RXVLANFL_OFFSET   0x000002C0
-

Count of VLAN tagged frames received, LSW

+

+Count of VLAN tagged frames received, LSW

-
- +

+

- +
#define XAE_RXVLANFU_OFFSET   0x000002C4#define XAE_RXVLANFU_OFFSET   0x000002C4
-

Count of VLAN tagged frames received, MSW

+

+Count of VLAN tagged frames received, MSW

-
- +

+

- +
#define XAE_SOFT_TEMAC_HIGH_SPEED   1#define XAE_SOFT_TEMAC_HIGH_SPEED   1
-

For soft cores with 10/100/1000 Mbps speed.

+

+For soft cores with 10/100/1000 Mbps speed.

-
- +

+

- +
#define XAE_SOFT_TEMAC_LOW_SPEED   0#define XAE_SOFT_TEMAC_LOW_SPEED   0
-

For soft cores with 10/100 Mbps speed.

+

+For soft cores with 10/100 Mbps speed.

-
- +

+

- +
#define XAE_SPEED_1000_MBPS   1000#define XAE_SPEED_1000_MBPS   1000
-

Speed of 1000 Mbps

+

+Speed of 1000 Mbps

-
- +

+

- +
#define XAE_SPEED_100_MBPS   100#define XAE_SPEED_100_MBPS   100
-

Speed of 100 Mbps

+

+Speed of 100 Mbps

-
- +

+

- +
#define XAE_SPEED_10_MBPS   10#define XAE_SPEED_10_MBPS   10
-

Speed of 10 Mbps

+

+Speed of 10 Mbps

-
- +

+

- +
#define XAE_TC_1588_CMD_EN_MASK   0x00400000#define XAE_TC_1588_CMD_EN_MASK   0x00400000
-

1588 Cmd field enable

+

+1588 Cmd field enable

-
- +

+

- +
#define XAE_TC_FCS_MASK   0x20000000#define XAE_TC_FCS_MASK   0x20000000
-

In-Band FCS enable (FCS not generated)

+

+In-Band FCS enable (FCS not generated)

-
- +

+

- +
#define XAE_TC_IFG_MASK   0x02000000#define XAE_TC_IFG_MASK   0x02000000
-

Inter-frame gap adjustment enable

+

+Inter-frame gap adjustment enable

-
- +

+

- +
#define XAE_TC_JUM_MASK   0x40000000#define XAE_TC_JUM_MASK   0x40000000
-

Jumbo frame enable

+

+Jumbo frame enable

-
- +

+

- +
#define XAE_TC_OFFSET   0x00000408#define XAE_TC_OFFSET   0x00000408
-

Tx Configuration

+

+Tx Configuration

-
- +

+

- +
#define XAE_TC_RST_MASK   0x80000000#define XAE_TC_RST_MASK   0x80000000
-

Reset

+

+Reset

-
- +

+

- +
#define XAE_TC_TX_MASK   0x10000000#define XAE_TC_TX_MASK   0x10000000
-

Transmitter enable

+

+Transmitter enable

-
- +

+

- +
#define XAE_TC_VLAN_MASK   0x08000000#define XAE_TC_VLAN_MASK   0x08000000
-

VLAN frame enable

+

+VLAN frame enable

-
- +

+

- +
#define XAE_TFGP_IFGP_MASK   0x0000007F#define XAE_TFGP_IFGP_MASK   0x0000007F
-

Transmit inter-frame gap adjustment value

+

+Transmit inter-frame gap adjustment value

-
- +

+

- +
#define XAE_TPF_OFFSET   0x00000004#define XAE_TPF_OFFSET   0x00000004
-

Tx Pause Frame

+

+Tx Pause Frame

-
- +

+

- +
#define XAE_TPF_TPFV_MASK   0x0000FFFF#define XAE_TPF_TPFV_MASK   0x0000FFFF
-

Tx pause frame value

+

+Tx pause frame value

-
- +

+

- +
#define XAE_TPID0_OFFSET   0x00000028#define XAE_TPID0_OFFSET   0x00000028
-

VLAN TPID0 register

+

+VLAN TPID0 register

-
- +

+

- +
#define XAE_TPID1_OFFSET   0x0000002C#define XAE_TPID1_OFFSET   0x0000002C
-

VLAN TPID1 register

+

+VLAN TPID1 register

-
- +

+

- +
#define XAE_TPID_0_MASK   0x0000FFFF#define XAE_TPID_0_MASK   0x0000FFFF
-

TPID 0

+

+TPID 0

-
- +

+

- +
#define XAE_TPID_1_MASK   0xFFFF0000#define XAE_TPID_1_MASK   0xFFFF0000
-

TPID 1

+

+TPID 1

-
- +

+

- +
#define XAE_TTAG_OFFSET   0x00000018#define XAE_TTAG_OFFSET   0x00000018
-

Tx VLAN TAG

+

+Tx VLAN TAG

-
- +

+

- +
#define XAE_TX1024L_OFFSET   0x00000280#define XAE_TX1024L_OFFSET   0x00000280
-

Count of 1024-MAX bytes frames transmitted, LSW

+

+Count of 1024-MAX bytes frames transmitted, LSW

-
- +

+

- +
#define XAE_TX1024U_OFFSET   0x00000284#define XAE_TX1024U_OFFSET   0x00000284
-

Count of 1024-MAX bytes frames transmitted, MSW

+

+Count of 1024-MAX bytes frames transmitted, MSW

-
- +

+

- +
#define XAE_TX128B255L_OFFSET   0x00000268#define XAE_TX128B255L_OFFSET   0x00000268
-

Count of 128-255 bytes frames transmitted, LSW

+

+Count of 128-255 bytes frames transmitted, LSW

-
- +

+

- +
#define XAE_TX128B255U_OFFSET   0x0000026C#define XAE_TX128B255U_OFFSET   0x0000026C
-

Count of 128-255 bytes frames transmitted, MSW

+

+Count of 128-255 bytes frames transmitted, MSW

-
- +

+

- +
#define XAE_TX256B511L_OFFSET   0x00000270#define XAE_TX256B511L_OFFSET   0x00000270
-

Count of 256-511 bytes frames transmitted, LSW

+

+Count of 256-511 bytes frames transmitted, LSW

-
- +

+

- +
#define XAE_TX256B511U_OFFSET   0x00000274#define XAE_TX256B511U_OFFSET   0x00000274
-

Count of 256-511 bytes frames transmitted, MSW

+

+Count of 256-511 bytes frames transmitted, MSW

-
- +

+

- +
#define XAE_TX512B1023L_OFFSET   0x00000278#define XAE_TX512B1023L_OFFSET   0x00000278
-

Count of 512-1023 bytes frames transmitted, LSW

+

+Count of 512-1023 bytes frames transmitted, LSW

-
- +

+

- +
#define XAE_TX512B1023U_OFFSET   0x0000027C#define XAE_TX512B1023U_OFFSET   0x0000027C
-

Count of 512-1023 bytes frames transmitted, MSW

+

+Count of 512-1023 bytes frames transmitted, MSW

-
- +

+

- +
#define XAE_TX64BL_OFFSET   0x00000258#define XAE_TX64BL_OFFSET   0x00000258
-

Count of 64 bytes frames transmitted, LSW

+

+Count of 64 bytes frames transmitted, LSW

-
- +

+

- +
#define XAE_TX64BU_OFFSET   0x0000025C#define XAE_TX64BU_OFFSET   0x0000025C
-

Count of 64 bytes frames transmitted, MSW

+

+Count of 64 bytes frames transmitted, MSW

-
- +

+

- +
#define XAE_TX65B127L_OFFSET   0x00000260#define XAE_TX65B127L_OFFSET   0x00000260
-

Count of 65-127 bytes frames transmitted, LSW

+

+Count of 65-127 bytes frames transmitted, LSW

-
- +

+

- +
#define XAE_TX65B127U_OFFSET   0x00000264#define XAE_TX65B127U_OFFSET   0x00000264
-

Count of 65-127 bytes frames transmitted, MSW

+

+Count of 65-127 bytes frames transmitted, MSW

-
- +

+

- +
#define XAE_TX_TIMESTAMP_ADJ_OFFSET   0x0000041C#define XAE_TX_TIMESTAMP_ADJ_OFFSET   0x0000041C
-

Transmitter time stamp adjust control Register

+

+Transmitter time stamp adjust control Register

-
- +

+

- +
#define XAE_TX_VLAN_DATA_OFFSET   0x00004000#define XAE_TX_VLAN_DATA_OFFSET   0x00004000
-

TX VLAN data table address

+

+TX VLAN data table address

-
- +

+

- +
#define XAE_TXAECL_OFFSET   0x00000330#define XAE_TXAECL_OFFSET   0x00000330
-

Frames aborted with excessive Collisions, LSW

+

+Frames aborted with excessive Collisions, LSW

-
- +

+

- +
#define XAE_TXAECU_OFFSET   0x00000334#define XAE_TXAECU_OFFSET   0x00000334
-

Frames aborted with excessive Collisions, MSW

+

+Frames aborted with excessive Collisions, MSW

-
- +

+

- +
#define XAE_TXBCSTFL_OFFSET   0x000002E0#define XAE_TXBCSTFL_OFFSET   0x000002E0
-

Count of broadcast frames transmitted OK, LSW

+

+Count of broadcast frames transmitted OK, LSW

-
- +

+

- +
#define XAE_TXBCSTFU_OFFSET   0x000002E4#define XAE_TXBCSTFU_OFFSET   0x000002E4
-

Count of broadcast frames transmitted, MSW

+

+Count of broadcast frames transmitted, MSW

-
- +

+

- +
#define XAE_TXBL_OFFSET   0x00000208#define XAE_TXBL_OFFSET   0x00000208
-

Transmitted Bytes, LSW

+

+Transmitted Bytes, LSW

-
- +

+

- +
#define XAE_TXBU_OFFSET   0x0000020C#define XAE_TXBU_OFFSET   0x0000020C
-

Transmitted Bytes, MSW

+

+Transmitted Bytes, MSW

-
- +

+

- +
#define XAE_TXCTRFL_OFFSET   0x000002F8#define XAE_TXCTRFL_OFFSET   0x000002F8
-

Count of control frames transmitted, LSW

+

+Count of control frames transmitted, LSW

-
- +

+

- +
#define XAE_TXCTRFU_OFFSET   0x000002FC#define XAE_TXCTRFU_OFFSET   0x000002FC
-

Count of control frames, transmitted, MSW

+

+Count of control frames, transmitted, MSW

-
- +

+

- +
#define XAE_TXDEFL_OFFSET   0x00000320#define XAE_TXDEFL_OFFSET   0x00000320
-

Deferred Tx Frames, LSW

+

+Deferred Tx Frames, LSW

-
- +

+

- +
#define XAE_TXDEFU_OFFSET   0x00000324#define XAE_TXDEFU_OFFSET   0x00000324
-

Deferred Tx Frames, MSW

+

+Deferred Tx Frames, MSW

-
- +

+

- +
#define XAE_TXEDEFL_OFFSET   0x00000338#define XAE_TXEDEFL_OFFSET   0x00000338
-

Transmit Frames with excessive Defferal, LSW

+

+Transmit Frames with excessive Defferal, LSW

-
- +

+

- +
#define XAE_TXEDEFU_OFFSET   0x0000033C#define XAE_TXEDEFU_OFFSET   0x0000033C
-

Transmit Frames with excessive Defferal, MSW

+

+Transmit Frames with excessive Defferal, MSW

-
- +

+

- +
#define XAE_TXFC_OFFSET   0x00000418#define XAE_TXFC_OFFSET   0x00000418
-

Tx Max Frm Config Register

+

+Tx Max Frm Config Register

-
- +

+

- +
#define XAE_TXFL_OFFSET   0x000002D8#define XAE_TXFL_OFFSET   0x000002D8
-

Count of frames transmitted OK, LSW

+

+Count of frames transmitted OK, LSW

-
- +

+

- +
#define XAE_TXFU_OFFSET   0x000002DC#define XAE_TXFU_OFFSET   0x000002DC
-

Count of frames transmitted OK, MSW

+

+Count of frames transmitted OK, MSW

-
- +

+

- +
#define XAE_TXLTCL_OFFSET   0x00000328#define XAE_TXLTCL_OFFSET   0x00000328
-

Frames transmitted with late Collisions, LSW

+

+Frames transmitted with late Collisions, LSW

-
- +

+

- +
#define XAE_TXLTCU_OFFSET   0x0000032C#define XAE_TXLTCU_OFFSET   0x0000032C
-

Frames transmitted with late Collisions, MSW

+

+Frames transmitted with late Collisions, MSW

-
- +

+

- +
#define XAE_TXMCL_OFFSET   0x00000318#define XAE_TXMCL_OFFSET   0x00000318
-

Multiple Collision Frames Transmitted OK, LSW

+

+Multiple Collision Frames Transmitted OK, LSW

-
- +

+

- +
#define XAE_TXMCSTFL_OFFSET   0x000002E8#define XAE_TXMCSTFL_OFFSET   0x000002E8
-

Count of multicast frames transmitted, LSW

+

+Count of multicast frames transmitted, LSW

-
- +

+

- +
#define XAE_TXMCSTFU_OFFSET   0x000002EC#define XAE_TXMCSTFU_OFFSET   0x000002EC
-

Count of multicast frames transmitted, MSW

+

+Count of multicast frames transmitted, MSW

-
- +

+

- +
#define XAE_TXMCU_OFFSET   0x0000031C#define XAE_TXMCU_OFFSET   0x0000031C
-

Multiple Collision Frames Transmitted OK, MSW

+

+Multiple Collision Frames Transmitted OK, MSW

-
- +

+

- +
#define XAE_TXOVRL_OFFSET   0x00000288#define XAE_TXOVRL_OFFSET   0x00000288
-

Count of oversize frames transmitted, LSW

+

+Count of oversize frames transmitted, LSW

-
- +

+

- +
#define XAE_TXOVRU_OFFSET   0x0000028C#define XAE_TXOVRU_OFFSET   0x0000028C
-

Count of oversize frames transmitted, MSW

+

+Count of oversize frames transmitted, MSW

-
- +

+

- +
#define XAE_TXPFL_OFFSET   0x00000308#define XAE_TXPFL_OFFSET   0x00000308
-

Count of pause frames transmitted, LSW

+

+Count of pause frames transmitted, LSW

-
- +

+

- +
#define XAE_TXPFU_OFFSET   0x0000030C#define XAE_TXPFU_OFFSET   0x0000030C
-

Count of pause frames transmitted, MSW

+

+Count of pause frames transmitted, MSW

-
- +

+

- +
#define XAE_TXSCL_OFFSET   0x00000310#define XAE_TXSCL_OFFSET   0x00000310
-

Single Collision Frames Transmitted OK, LSW

+

+Single Collision Frames Transmitted OK, LSW

-
- +

+

- +
#define XAE_TXSCU_OFFSET   0x00000314#define XAE_TXSCU_OFFSET   0x00000314
-

Single Collision Frames Transmitted OK, MSW

+

+Single Collision Frames Transmitted OK, MSW

-
- +

+

- +
#define XAE_TXUNDRERL_OFFSET   0x000002F0#define XAE_TXUNDRERL_OFFSET   0x000002F0
-

Count of frames transmitted underrun error, LSW

+

+Count of frames transmitted underrun error, LSW

-
- +

+

- +
#define XAE_TXUNDRERU_OFFSET   0x000002F4#define XAE_TXUNDRERU_OFFSET   0x000002F4
-

Count of frames transmitted underrun error, MSW

+

+Count of frames transmitted underrun error, MSW

-
- +

+

- +
#define XAE_TXVLANFL_OFFSET   0x00000300#define XAE_TXVLANFL_OFFSET   0x00000300
-

Count of VLAN tagged frames transmitted, LSW

+

+Count of VLAN tagged frames transmitted, LSW

-
- +

+

- +
#define XAE_TXVLANFU_OFFSET   0x00000304#define XAE_TXVLANFU_OFFSET   0x00000304
-

Count of VLAN tagged frames transmitted, MSW

+

+Count of VLAN tagged frames transmitted, MSW

-
- +

+

- +
#define XAE_UAW0_OFFSET   0x00000700#define XAE_UAW0_OFFSET   0x00000700
-

Unicast address word 0

+

+Unicast address word 0

-
- +

+

- +
#define XAE_UAW1_OFFSET   0x00000704#define XAE_UAW1_OFFSET   0x00000704
-

Unicast address word 1

+

+Unicast address word 1

-
- +

+

- +
#define XAE_UAW1_UNICASTADDR_MASK   0x0000FFFF#define XAE_UAW1_UNICASTADDR_MASK   0x0000FFFF
-

Station address bits [47:32] Station address bits [31:0] are stored in register UAW0

+

+Station address bits [47:32] Station address bits [31:0] are stored in register UAW0

-
- +

+

- +
#define XAE_UAWL_OFFSET   0x00000020#define XAE_UAWL_OFFSET   0x00000020
-

Unicast address word lower

+

+Unicast address word lower

-
- +

+

- +
#define XAE_UAWU_OFFSET   0x00000024#define XAE_UAWU_OFFSET   0x00000024
-

Unicast address word upper

+

+Unicast address word upper

-
- +

+

- +
#define XAE_VLAN_TABL_STRP_ENTRY_MASK   0x01#define XAE_VLAN_TABL_STRP_ENTRY_MASK   0x01
-

Mask used to extract the the strip field from an entry in VLAN table.

+

+Mask used to extract the the strip field from an entry in VLAN table.

-
- +

+

- +
#define XAE_VLAN_TABL_STRP_FLD_LEN   1#define XAE_VLAN_TABL_STRP_FLD_LEN   1
-

Strip field length in vlan table used for extended vlan features.

+

+Strip field length in vlan table used for extended vlan features.

-
- +

+

- +
#define XAE_VLAN_TABL_STRP_STRT_OFFSET   1#define XAE_VLAN_TABL_STRP_STRT_OFFSET   1
-

Strip field start offset in each entry in the VLAN table.

+

+Strip field start offset in each entry in the VLAN table.

-
- +

+

- +
#define XAE_VLAN_TABL_TAG_ENTRY_MASK   0x01#define XAE_VLAN_TABL_TAG_ENTRY_MASK   0x01
-

Mask used to extract the the tag field from an entry in VLAN table.

+

+Mask used to extract the the tag field from an entry in VLAN table.

-
- +

+

- +
#define XAE_VLAN_TABL_TAG_FLD_LEN   1#define XAE_VLAN_TABL_TAG_FLD_LEN   1
-

Tag field length in vlan table used for extended vlan features.

+

+Tag field length in vlan table used for extended vlan features.

-
- +

+

- +
#define XAE_VLAN_TABL_VID_START_OFFSET   2#define XAE_VLAN_TABL_VID_START_OFFSET   2
-

VID field start offset in each entry in the VLAN table.

+

+VID field start offset in each entry in the VLAN table.

-
- +

+

- +
#define XAXIETHERNET_HW_H#define XAXIETHERNET_HW_H
+

+

-
- +

+

- + - + - +
#define XAxiEthernet_indent#define XAxiEthernet_indent ( RegOffset   ) 
-Value:
((indent_on && ((RegOffset) >= XAE_RAF_OFFSET) && ((RegOffset) <=       \
- XAE_AF1_OFFSET)) ? "\t" : "")
+
+

+Value:
((indent_on && ((RegOffset) >= XAE_RAF_OFFSET) && ((RegOffset) <=       \
+ XAE_AF1_OFFSET)) ? "\t" : "")
-
- +

+

- + - - - + - - - + - + - +
#define XAxiEthernet_print_reg_i#define XAxiEthernet_print_reg_i (BaseAddress,
BaseAddress,
RegOffset,
RegOffset,
Value   ) 
-Value:
xdbg_printf(XDBG_DEBUG_TEMAC_REG, "%s%s(0x%0x) -> 0x%0x\n", \
-                XAxiEthernet_indent(RegOffset),  \
-                XAxiEthernet_reg_name(RegOffset),(RegOffset), (Value)) \
+
+

+Value:
xdbg_printf(XDBG_DEBUG_TEMAC_REG, "%s%s(0x%0x) -> 0x%0x\n", \
+                XAxiEthernet_indent(RegOffset),  \
+                XAxiEthernet_reg_name(RegOffset),(RegOffset), (Value)) \
-
- +

+

- + - - - + - - - + - + - +
#define XAxiEthernet_print_reg_o#define XAxiEthernet_print_reg_o (BaseAddress,
BaseAddress,
RegOffset,
RegOffset,
Value   ) 
-Value:
xdbg_printf(XDBG_DEBUG_TEMAC_REG, "%s0x%0x -> %s(0x%0x)\n",     \
-                        XAxiEthernet_indent(RegOffset), (Value),        \
-                        XAxiEthernet_reg_name(RegOffset), (RegOffset))  \
+
+

+Value:
xdbg_printf(XDBG_DEBUG_TEMAC_REG, "%s0x%0x -> %s(0x%0x)\n",     \
+                        XAxiEthernet_indent(RegOffset), (Value),        \
+                        XAxiEthernet_reg_name(RegOffset), (RegOffset))  \
-
- +

+

- + - - - + - + - +
#define XAxiEthernet_ReadReg#define XAxiEthernet_ReadReg (BaseAddress,
BaseAddress,
RegOffset   )    (Xil_In32(((BaseAddress) + (RegOffset))))   (Xil_In32(((BaseAddress) + (RegOffset))))
-

XAxiEthernet_ReadReg returns the value read from the register specified by RegOffset.

-
Parameters:
+ +

+XAxiEthernet_ReadReg returns the value read from the register specified by RegOffset.

+

Parameters:
BaseAddress is the base address of the Axi Ethernet device.
RegOffset is the offset of the register to be read.
-
-
Returns:
Returns the 32-bit value of the register.
-
Note:
C-style signature: u32 XAxiEthernet_ReadReg(u32 BaseAddress, u32 RegOffset)
+
Returns:
Returns the 32-bit value of the register.
+
Note:
C-style signature: u32 XAxiEthernet_ReadReg(u32 BaseAddress, u32 RegOffset)
-
- +

+

- + - + - +
#define XAxiEthernet_reg_name#define XAxiEthernet_reg_name ( RegOffset   ) 
+

+

-
- +

+

- + - - - + - - - + - + - +
#define XAxiEthernet_WriteReg#define XAxiEthernet_WriteReg (BaseAddress,
BaseAddress,
RegOffset,
RegOffset,
Data   )    Xil_Out32(((BaseAddress) + (RegOffset)), (Data))   Xil_Out32(((BaseAddress) + (RegOffset)), (Data))
-

XAxiEthernet_WriteReg, writes Data to the register specified by RegOffset.

-
Parameters:
+ +

+XAxiEthernet_WriteReg, writes Data to the register specified by RegOffset.

+

Parameters:
BaseAddress is the base address of the Axi Ethernet device.
RegOffset is the offset of the register to be written.
Data is the 32-bit value to write to the register.
-
-
Returns:
None.
-
Note:
C-style signature: void XAxiEthernet_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)
+
Returns:
None.
+
Note:
C-style signature: void XAxiEthernet_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)
-
-

Function Documentation

- +

+

Function Documentation

+
- + - + - +
xdbg_stmnt xdbg_stmnt ( extern int  indent_on indent_on  ) 
+

+

-
- -

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved. -

- - +

+Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__porting__guide_8h.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__porting__guide_8h.html old mode 100644 new mode 100755 index 2557e4bf..e3c4c2c0 --- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__porting__guide_8h.html +++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__porting__guide_8h.html @@ -2,63 +2,50 @@ - Xilinx Driver axiethernet v4_2: xaxiethernet_porting_guide.h File Reference + xaxiethernet_porting_guide.h File Reference - +

Xilinx Processor IP Library

Software Drivers
- - - -
-

xaxiethernet_porting_guide.h File Reference

-
-

Detailed Description

-

This is a guide on how to move from using the ll temac driver to use the xaxiethernet driver.

-

The AXI Ethernet IP is based on the XPS_LL TEMAC IP. There are few changes in the IP and some of them are listed below

- -

Please read the HW Device specification of the AXI Ethernet IP for further information.

-

The AXI Ethernet can be used in a DMA mode using the AXI DMA or used in a FIFO mode using the AXI Streaming FIFO.

-

There is a new driver for AXI DMA which is used by the AXi Ethernet. Please refer the xaxidma_porting_guide.h provided as a part of the AXI DMA driver to see the differences from the LL DMA driver.

-

The LL FIFO driver is a common driver for the LL FIFO and the AXI Streaming FIFO.

+ +
+
+
+
+

xaxiethernet_porting_guide.h File Reference

Detailed Description

+This is a guide on how to move from using the ll temac driver to use the xaxiethernet driver.

+The AXI Ethernet IP is based on the XPS_LL TEMAC IP. There are few changes in the IP and some of them are listed below

+

+Please read the HW Device specification of the AXI Ethernet IP for further information.

+The AXI Ethernet can be used in a DMA mode using the AXI DMA or used in a FIFO mode using the AXI Streaming FIFO.

+There is a new driver for AXI DMA which is used by the AXi Ethernet. Please refer the xaxidma_porting_guide.h provided as a part of the AXI DMA driver to see the differences from the LL DMA driver.

+The LL FIFO driver is a common driver for the LL FIFO and the AXI Streaming FIFO.

- MODIFICATION HISTORY:
 Ver   Who  Date     Changes
+ MODIFICATION HISTORY:

+

 Ver   Who  Date     Changes
  ----- ---- -------- -------------------------------------------------------
- 1.00a ASA   07/18/10 First release

Overview

-

The API for xaxiethernet driver are similar to xlltemac driver. The prefix for the API functions and structures is XAxiEthernet_ for the xaxiethernet driver.

-

The prefix for all hash-defines (option masks or generic hash-defined constants) start with XAE_.

-

The Axi Ethernet API "XAxiEthernet_Reset" is different from the corresponding LLTEMAC API "XLlTemac_Reset". The AxiEthernet version does not do a soft reset of the AxiEthernet hardware. Since AxiEthernet hardware could only be reset through the device connected to the AxiEthernet AXI4-Stream interface, the user must ensure that AxiEthernet hardware initialization happens after the initialization of the other device.

-

These are the classification of the APIs

- -

Note that data structures have different prefix of XAxiEthernet_. Those API functions, that have data structures with prefix change, are considered as prefix change.

-

API Functions That Only Have Prefix Changes

-

Most of the functions have the prefix change and are given below

-
+ 1.00a ASA   07/18/10 First release

+

+Overview

+The API for xaxiethernet driver are similar to xlltemac driver. The prefix for the API functions and structures is XAxiEthernet_ for the xaxiethernet driver.

+The prefix for all hash-defines (option masks or generic hash-defined constants) start with XAE_.

+The Axi Ethernet API "XAxiEthernet_Reset" is different from the corresponding LLTEMAC API "XLlTemac_Reset". The AxiEthernet version does not do a soft reset of the AxiEthernet hardware. Since AxiEthernet hardware could only be reset through the device connected to the AxiEthernet AXI4-Stream interface, the user must ensure that AxiEthernet hardware initialization happens after the initialization of the other device.

+These are the classification of the APIs

+

+Note that data structures have different prefix of XAxiEthernet_. Those API functions, that have data structures with prefix change, are considered as prefix change.

+API Functions That Only Have Prefix Changes

+Most of the functions have the prefix change and are given below 

          xlltemac driver		|	xaxiethernet driver
  ---------------------------------------------------------------------------------
     XLlTemac_IsStarted(...)		|	XAxiEthernet_IsStarted(...)
@@ -112,27 +99,22 @@
     XLlTemac_AddExtMulticastGroup(...)	|	XAxiEthernet_AddExtMulticastGroup(...)
     XLlTemac_ClearExtMulticastGroup(..)|	XAxiEthernet_ClearExtMulticastGroup(...)
     XLlTemac_GetExtMulticastGroup(...)	|	XAxiEthernet_GetExtMulticastGroup(...)
-    XLlTemac_DumpExtMulticastGroup(..)	|	XAxiEthernet_DumpExtMulticastGroup(...)
API Function names that have changed 

+    XLlTemac_DumpExtMulticastGroup(..)	|	XAxiEthernet_DumpExtMulticastGroup(...)

+

+API Function names that have changed 

 
          xlltemac driver		|	xaaxiethernet driver
  -----------------------------------------------------------------------
  XLlTemac_IsRxCsum(...)		|	XAxiEthernet_IsRxPartialCsum(...)
  XLlTemac_IsTxCsum(...)		|	XAxiEthernet_IsTxPartialCsum(...)
  XLlTemac_Status(...)			|	XAxiEthernet_GetIntStatus
- 
API Functions That Are New API Functions

+ 

+API Functions That Are New API Functions

 

-

-

-Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
-

-
-
+
  • XAxiEthernet_GetTemacType(...)
  • XAxiEthernet_IsAvbConfigured(...)
  • XAxiEthernet_IsStatsConfigured(...)
  • XAxiEthernet_SetBadFrmRcvOption((...);
  • XAxiEthernet_ClearBadFrmRcvOption(...);
  • XAxiEthernet_DisableControlFrameLenCheck(...)
  • XAxiEthernet_EnableControlFrameLenCheck(...) 
    • 
 
+
    
+
+
+
    
+Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__sinit_8c.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__sinit_8c.html
old mode 100644
new mode 100755
index ae7dd2c2..0bbab5de
--- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__sinit_8c.html
+++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__sinit_8c.html
@@ -2,77 +2,70 @@
 
    
 
-   Xilinx Driver axiethernet v4_2: xaxiethernet_sinit.c File Reference
+   xaxiethernet_sinit.c File Reference
 
-
+
 
 
    Xilinx Processor IP Library
    
 Software Drivers
 
    
-
-
-
-
    
-
    xaxiethernet_sinit.c File Reference
    #include "xparameters.h"
    
-#include "xaxiethernet.h"
    
-
-
-
-
    Functions
    XAxiEthernet_Config * XAxiEthernet_LookupConfig (u16 DeviceId)
    
-
    Detailed Description
    
-
    This file contains static initialzation functionality for Axi Ethernet driver.
    
+
+
    
+  
    
+
    
+  
    
+
    xaxiethernet_sinit.c File Reference
    Detailed Description
    
+This file contains static initialzation functionality for Axi Ethernet driver.
    
 
    - MODIFICATION HISTORY:
     Ver   Who  Date     Changes
+ MODIFICATION HISTORY:
    
+
     Ver   Who  Date     Changes
  ----- ---- -------- -------------------------------------------------------
  1.00a asa  6/30/10 First release
- 
     
    Function Documentation
    
-
+ 
+
    
+#include "xparameters.h"
    
+#include "xaxiethernet.h"
    
+
+
+
+
+
+

    Functions
    XAxiEthernet_Config * XAxiEthernet_LookupConfig (u16 DeviceId)
    
+
    Function Documentation
    
+
 
    
 
    
       
-          
+          
-          
+          
-          
+          
    
         
    XAxiEthernet_Config* XAxiEthernet_LookupConfig XAxiEthernet_Config* XAxiEthernet_LookupConfig           
           (
           u16  DeviceId DeviceId          
            ) 
         
    
       
    
 
    
 
    
-
    XAxiEthernet_LookupConfig returns a reference to an XAxiEthernet_Config structure based on an unique device id, DeviceId. The return value will refer to an entry in the device configuration table defined in the xaxiethernet_g.c file.
    
-
    Parameters:
    
+
+
    
+XAxiEthernet_LookupConfig returns a reference to an XAxiEthernet_Config structure based on an unique device id, DeviceId. The return value will refer to an entry in the device configuration table defined in the xaxiethernet_g.c file.
    
+
    Parameters:
    
   
    
     
    DeviceId is the unique device ID of the device for the lookup operation.
    
   
    
-  
    
 
    
-
    Returns:
      
-
    • Returns a reference to a config record in the configuration table (in xaxiethernet_g.c) corresponding to DeviceId, or NULL
      • 
-
    • NULL if no match is found. 
      • 
-
    
+
    Returns:
      
+
    • Returns a reference to a config record in the configuration table (in xaxiethernet_g.c) corresponding to DeviceId, or NULL
    • NULL if no match is found. 
    
 
    
 
 
    
-
    
-
    
-
    
-Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
-
    
-
-
+
    
+Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
diff --git a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xdebug_8h.html b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xdebug_8h.html
old mode 100644
new mode 100755
index 8d39b4a0..856baa3f
--- a/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xdebug_8h.html
+++ b/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xdebug_8h.html
@@ -2,76 +2,74 @@
 
    
 
-   Xilinx Driver axiethernet v4_2: xdebug.h File Reference
+   xdebug.h File Reference
 
-
+
 
 
    Xilinx Processor IP Library
    
 Software Drivers
 
    
+
+
    
+  
    
+
    
+  
    
+
    xdebug.h File Reference
    
+
    
+
+
+
+
+
+
 
-
-
-
    
-
    xdebug.h File Reference

    Defines
    #define xdbg_stmnt(x)
    #define xdbg_printf()
    
-
-
-
    Defines
    #define xdbg_stmnt(x)
    #define xdbg_printf(...)
    
 
    
-
    Define Documentation
    
-
+
    Define Documentation
    
+
 
    
 
    
       
-          
+          
-          
-          
+ 
+          
-          
+          
    
         
    #define xdbg_printf#define xdbg_printf          
           ( ...           
            ) 
         
    
       
    
 
    
 
    
 
+
    
+
 
    
-
    
-
+
    
+
 
    
 
    
       
-          
+          
-          
+          
-          
+          
    
         
    #define xdbg_stmnt#define xdbg_stmnt          
           (
           x           
            ) 
         
    
       
    
 
    
 
    
 
+
    
+
 
    
-
    
-
-
    
-Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
-
    
-
-
+
    
+Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.