Modules | Data Structures | Macros | Typedefs | Enumerations
Enet MAC Port

Modules

 ICSSG MAC Port
 
 CPSW MAC Port
 

Data Structures

struct  EnetMacPort_Interface_s
 MAC port interface. More...
 
struct  EnetMacPort_LinkCfg_s
 Link speed and duplexity configuration. More...
 
struct  EnetMacPort_SetIngressDscpPriorityMapInArgs_s
 Input args for ENET_MACPORT_IOCTL_SET_INGRESS_DSCP_PRIORITY_MAP command. More...
 
struct  EnetMacPort_SetPriorityRegenMapInArgs_s
 Input args for ENET_MACPORT_IOCTL_SET_PRIORITY_REGEN_MAP command. More...
 
struct  EnetMacPort_SetEgressPriorityMapInArgs_s
 Input args for ENET_MACPORT_IOCTL_SET_EGRESS_QOS_PRIORITY_MAP command. More...
 
struct  EnetMacPort_EnableEgressTrafficShapingInArgs_s
 Input args for ENET_MACPORT_IOCTL_ENABLE_EGRESS_TRAFFIC_SHAPING command. More...
 

Macros

#define ENET_MACPORT_PUBLIC_IOCTL(x)   (ENET_IOCTL_MACPORT_BASE | ENET_IOCTL_MIN(x))
 Helper macro to create IOCTL commands for MAC port module.
 

Typedefs

typedef enum EnetMacPort_Ioctl_e EnetMacPort_Ioctl
 MAC port IOCTL commands.
 
typedef enum EnetMac_LayerType_e EnetMac_LayerType
 MAC interface layer type.
 
typedef enum EnetMac_SublayerType_e EnetMac_SublayerType
 MAC interface sublayer type.
 
typedef enum EnetMac_VariantType_e EnetMac_VariantType
 MAC interface variant (only for specific interface types).
 
typedef enum EnetMac_SgmiiMode_e EnetMac_SgmiiMode
 SGMII mode.
 
typedef struct
EnetMacPort_Interface_s 
EnetMacPort_Interface
 MAC port interface.
 
typedef struct
EnetMacPort_LinkCfg_s 
EnetMacPort_LinkCfg
 Link speed and duplexity configuration.
 
typedef enum EnetMacPort_VlanType_e EnetMacPort_VlanType
 VLAN usage type.
 
typedef struct
EnetMacPort_SetIngressDscpPriorityMapInArgs_s 
EnetMacPort_SetIngressDscpPriorityMapInArgs
 Input args for ENET_MACPORT_IOCTL_SET_INGRESS_DSCP_PRIORITY_MAP command.
 
typedef struct
EnetMacPort_SetPriorityRegenMapInArgs_s 
EnetMacPort_SetPriorityRegenMapInArgs
 Input args for ENET_MACPORT_IOCTL_SET_PRIORITY_REGEN_MAP command.
 
typedef struct
EnetMacPort_SetEgressPriorityMapInArgs_s 
EnetMacPort_SetEgressPriorityMapInArgs
 Input args for ENET_MACPORT_IOCTL_SET_EGRESS_QOS_PRIORITY_MAP command.
 
typedef struct
EnetMacPort_EnableEgressTrafficShapingInArgs_s 
EnetMacPort_EnableEgressTrafficShapingInArgs
 Input args for ENET_MACPORT_IOCTL_ENABLE_EGRESS_TRAFFIC_SHAPING command.
 

Enumerations

enum  EnetMacPort_Ioctl_e {
  ENET_MACPORT_IOCTL_GET_VERSION = ENET_MACPORT_PUBLIC_IOCTL(0U), ENET_MACPORT_IOCTL_PRINT_REGS = ENET_MACPORT_PUBLIC_IOCTL(1U), ENET_MACPORT_IOCTL_SET_INGRESS_DSCP_PRIORITY_MAP = ENET_MACPORT_PUBLIC_IOCTL(2U), ENET_MACPORT_IOCTL_GET_INGRESS_DSCP_PRIORITY_MAP = ENET_MACPORT_PUBLIC_IOCTL(3U),
  ENET_MACPORT_IOCTL_SET_PRIORITY_REGEN_MAP = ENET_MACPORT_PUBLIC_IOCTL(4U), ENET_MACPORT_IOCTL_GET_PRIORITY_REGEN_MAP = ENET_MACPORT_PUBLIC_IOCTL(5U), ENET_MACPORT_IOCTL_SET_EGRESS_QOS_PRIORITY_MAP = ENET_MACPORT_PUBLIC_IOCTL(6U), ENET_MACPORT_IOCTL_GET_EGRESS_QOS_PRIORITY_MAP = ENET_MACPORT_PUBLIC_IOCTL(7U),
  ENET_MACPORT_IOCTL_ENABLE_EGRESS_TRAFFIC_SHAPING = ENET_MACPORT_PUBLIC_IOCTL(8U), ENET_MACPORT_IOCTL_DISABLE_EGRESS_TRAFFIC_SHAPING = ENET_MACPORT_PUBLIC_IOCTL(9U), ENET_MACPORT_IOCTL_GET_EGRESS_TRAFFIC_SHAPING = ENET_MACPORT_PUBLIC_IOCTL(10U), ENET_MACPORT_IOCTL_GET_MAXLEN = ENET_MACPORT_PUBLIC_IOCTL(11U)
}
 MAC port IOCTL commands. More...
 
enum  EnetMac_LayerType_e { ENET_MAC_LAYER_MII = 1U, ENET_MAC_LAYER_GMII = 0U, ENET_MAC_LAYER_XGMII = 2U }
 MAC interface layer type. More...
 
enum  EnetMac_SublayerType_e {
  ENET_MAC_SUBLAYER_STANDARD = 0U, ENET_MAC_SUBLAYER_REDUCED, ENET_MAC_SUBLAYER_SERIAL, ENET_MAC_SUBLAYER_QUAD_SERIAL_MAIN,
  ENET_MAC_SUBLAYER_QUAD_SERIAL_SUB
}
 MAC interface sublayer type. More...
 
enum  EnetMac_VariantType_e { ENET_MAC_VARIANT_NONE = 0U, ENET_MAC_VARIANT_FORCED }
 MAC interface variant (only for specific interface types). More...
 
enum  EnetMac_SgmiiMode_e {
  ENET_MAC_SGMIIMODE_INVALID = 0U, ENET_MAC_SGMIIMODE_FIBER_WITH_PHY, ENET_MAC_SGMIIMODE_SGMII_WITH_PHY, ENET_MAC_SGMIIMODE_SGMII_AUTONEG_MASTER,
  ENET_MAC_SGMIIMODE_SGMII_AUTONEG_SLAVE, ENET_MAC_SGMIIMODE_SGMII_FORCEDLINK
}
 SGMII mode. More...
 
enum  EnetMacPort_VlanType_e { ENET_MACPORT_VLAN_TYPE_NONE = 0x00U, ENET_MACPORT_VLAN_TYPE_SINGLE_TAG = 0x01U, ENET_MACPORT_VLAN_TYPE_STACKED_TAGS = 0x02U }
 VLAN usage type. More...
 

Detailed Description

Enumeration Type Documentation

MAC interface layer type.

Enumerator
ENET_MAC_LAYER_MII 

Media-Independent Interface (MII) layer

ENET_MAC_LAYER_GMII 

Gigabit Media-Independent Interface (GMII) layer

ENET_MAC_LAYER_XGMII 

10-Gigabit Media-Independent Interface (XGMII) layer

SGMII mode.

Enumerator
ENET_MAC_SGMIIMODE_INVALID 

Invalid mode. Set to when port is used in non Q/SGMII mode

ENET_MAC_SGMIIMODE_FIBER_WITH_PHY 

SGMII in fiber mode with PHY connection

ENET_MAC_SGMIIMODE_SGMII_WITH_PHY 

SGMII in SGMII mode with PHY connection

ENET_MAC_SGMIIMODE_SGMII_AUTONEG_MASTER 

SGMII in MAC to MAC with auto-neg master mode

ENET_MAC_SGMIIMODE_SGMII_AUTONEG_SLAVE 

SGMII in MAC to MAC with auto-neg slave mode

ENET_MAC_SGMIIMODE_SGMII_FORCEDLINK 

SGMII in MAC to MAC with forced master mode

MAC interface sublayer type.

Enumerator
ENET_MAC_SUBLAYER_STANDARD 

Standard interface sublayer

ENET_MAC_SUBLAYER_REDUCED 

Reduced interface sublayer

ENET_MAC_SUBLAYER_SERIAL 

Serial interface sublayer

ENET_MAC_SUBLAYER_QUAD_SERIAL_MAIN 

Quad-serial interface sublayer (main port)

ENET_MAC_SUBLAYER_QUAD_SERIAL_SUB 

Quad-serial interface sublayer (sub port)

MAC interface variant (only for specific interface types).

Enumerator
ENET_MAC_VARIANT_NONE 

No variant

ENET_MAC_VARIANT_FORCED 

Forced mode (out of band)

MAC port IOCTL commands.

Enumerator
ENET_MACPORT_IOCTL_GET_VERSION 

Get the hardware version of the MAC port module.

IOCTL parameters:

ENET_MACPORT_IOCTL_PRINT_REGS 

Print MAC port registers.

IOCTL parameters:

  • inArgs: None
  • outArgs: None
ENET_MACPORT_IOCTL_SET_INGRESS_DSCP_PRIORITY_MAP 

Set ingress DSCP priority (TOS) map.

IOCTL parameters:

ENET_MACPORT_IOCTL_GET_INGRESS_DSCP_PRIORITY_MAP 

Get ingress DSCP priority (TOS) map.

IOCTL parameters:

ENET_MACPORT_IOCTL_SET_PRIORITY_REGEN_MAP 

Set VLAN priority regeneration map.

IOCTL parameters:

ENET_MACPORT_IOCTL_GET_PRIORITY_REGEN_MAP 

Get VLAN priority regeneration map.

IOCTL parameters:

ENET_MACPORT_IOCTL_SET_EGRESS_QOS_PRIORITY_MAP 

Set QoS egress priority map.

IOCTL parameters:

ENET_MACPORT_IOCTL_GET_EGRESS_QOS_PRIORITY_MAP 

Get QoS egress priority map.

IOCTL parameters:

ENET_MACPORT_IOCTL_ENABLE_EGRESS_TRAFFIC_SHAPING 

Enable egress traffic shaping configuration.

IOCTL parameters:

ENET_MACPORT_IOCTL_DISABLE_EGRESS_TRAFFIC_SHAPING 

Disable egress traffic shaping configuration.

IOCTL parameters:

ENET_MACPORT_IOCTL_GET_EGRESS_TRAFFIC_SHAPING 

Get egress traffic shaping configuration.

IOCTL parameters:

ENET_MACPORT_IOCTL_GET_MAXLEN 

Get MRU and MTU.

IOCTL parameters:

VLAN usage type.

Enumerator
ENET_MACPORT_VLAN_TYPE_NONE 

No VLAN tag

ENET_MACPORT_VLAN_TYPE_SINGLE_TAG 

Single VLAN tag

ENET_MACPORT_VLAN_TYPE_STACKED_TAGS 

Stacked VLAN tag


Copyright 2020, Texas Instruments Incorporated