CPSW Host Port API

Introduction

Data Structures
struct	CpswHostPort_FifoStats
	FIFO related statistics of the host port. More...
struct	CpswHostPort_Config
	Host port submodule configuration. More...

Typedefs
typedef struct CpswHostPort_Obj_s *	CpswHostPort_Handle
	Host port submodule handle. More...

Enumerations
enum	CpswHostPort_Ioctl_e {   CPSW_HOSTPORT_IOCTL_ENABLE = CPSW_HOSTPORT_PUBLIC_IOCTL(0U), CPSW_HOSTPORT_IOCTL_DISABLE = CPSW_HOSTPORT_PUBLIC_IOCTL(1U), CPSW_HOSTPORT_IOCTL_GET_FIFO_STATS = CPSW_HOSTPORT_PUBLIC_IOCTL(2U), CPSW_HOSTPORT_IOCTL_SET_TX_PRIORITY = CPSW_HOSTPORT_PUBLIC_IOCTL(3U),   CPSW_HOSTPORT_IOCTL_GET_TX_PRIORITY = CPSW_HOSTPORT_PUBLIC_IOCTL(4U), CPSW_HOSTPORT_IOCTL_SET_RX_PRIORITY = CPSW_HOSTPORT_PUBLIC_IOCTL(5U), CPSW_HOSTPORT_IOCTL_GET_RX_PRIORITY = CPSW_HOSTPORT_PUBLIC_IOCTL(6U), CPSW_HOSTPORT_IOCTL_SET_RX_DSCP_PRIORITY = CPSW_HOSTPORT_PUBLIC_IOCTL(7U),   CPSW_HOSTPORT_IOCTL_GET_RX_DSCP_PRIORITY = CPSW_HOSTPORT_PUBLIC_IOCTL(8U), CPSW_HOSTPORT_IOCTL_SET_TRAFFIC_SHAPING = CPSW_HOSTPORT_PUBLIC_IOCTL(9U), CPSW_HOSTPORT_IOCTL_GET_TRAFFIC_SHAPING = CPSW_HOSTPORT_PUBLIC_IOCTL(10U), CPSW_HOSTPORT_IOCTL_PRINT_REGS = CPSW_HOSTPORT_PUBLIC_IOCTL(11U),   CPSW_HOSTPORT_IOCTL_GET_RX_MTU = CPSW_HOSTPORT_PUBLIC_IOCTL(12U), CPSW_HOSTPORT_GET_FLOW_ID_OFFSET = CPSW_HOSTPORT_PUBLIC_IOCTL(13U), CPSW_HOSTPORT_IS_CSUM_OFFLOAD_ENABLE = CPSW_HOSTPORT_PUBLIC_IOCTL(14U) }
	Host port IOCTL commands. More...
enum	CpswHostPort_RxPriorityType { CPSW_RX_PRIORITY_TYPE_FIXED = 0U, CPSW_RX_PRIORITY_TYPE_RR = 1U }
	Port priority type. More...

Macros
#define	CPSW_HOSTPORT_PUBLIC_IOCTL(x)   (CPSW_IOCTL_HOSTPORT_BASE | CPSW_IOCTL_MIN(x))
	Helper macro to create IOCTL commands for host port submodule. More...
#define	CPSW_HOSTPORT_RX_MTU_DEFAULT   (1518U)
	Default value used for Host port RX MTU. More...

Macro Definition Documentation

#define CPSW_HOSTPORT_PUBLIC_IOCTL

(

x

)

(CPSW_IOCTL_HOSTPORT_BASE | CPSW_IOCTL_MIN(x))

Helper macro to create IOCTL commands for host port submodule.

#define CPSW_HOSTPORT_RX_MTU_DEFAULT   (1518U)

Default value used for Host port RX MTU.

Typedef Documentation

typedef struct CpswHostPort_Obj_s* CpswHostPort_Handle

Host port submodule handle.

Host port submodule opaque handle used to call any host port related APIs.

Enumeration Type Documentation

enum CpswHostPort_Ioctl_e

Host port IOCTL commands.

Enumerator
CPSW_HOSTPORT_IOCTL_ENABLE	Enable host port. IOCTL parameters: inArgs: None outArgs: None
CPSW_HOSTPORT_IOCTL_DISABLE	Disable host port. IOCTL parameters: inArgs: None outArgs: None
CPSW_HOSTPORT_IOCTL_GET_FIFO_STATS	Get host port's FIFO statistics. IOCTL parameters: inArgs: None outArgs: CpswHostPort_FifoStats
CPSW_HOSTPORT_IOCTL_SET_TX_PRIORITY	Set TX priority map (Header Packet Priority to Switch Priority) IOCTL parameters: inArgs: CpswPort_TxPriority outArgs: None
CPSW_HOSTPORT_IOCTL_GET_TX_PRIORITY	Get TX priority map (Header Packet Priority to Switch Priority) IOCTL parameters: inArgs: None outArgs: CpswPort_TxPriority
CPSW_HOSTPORT_IOCTL_SET_RX_PRIORITY	Set RX priority map (Packet Priority to Header Packet Priority) IOCTL parameters: inArgs: CpswPort_RxPriority outArgs: None
CPSW_HOSTPORT_IOCTL_GET_RX_PRIORITY	Get RX priority map (Packet Priority to Header Packet Priority) IOCTL parameters: inArgs: None outArgs: CpswPort_RxPriority
CPSW_HOSTPORT_IOCTL_SET_RX_DSCP_PRIORITY	Set RX DSCP priority (TOS) map. IOCTL parameters: inArgs: CpswPort_DscpPriority outArgs: None
CPSW_HOSTPORT_IOCTL_GET_RX_DSCP_PRIORITY	Get RX DSCP priority (TOS) map. IOCTL parameters: inArgs: uint32_t outArgs: CpswPort_DscpPriority
CPSW_HOSTPORT_IOCTL_SET_TRAFFIC_SHAPING	Set traffic shapping configuration. IOCTL parameters: inArgs: CpswPort_TrafficShapingConfig outArgs: None
CPSW_HOSTPORT_IOCTL_GET_TRAFFIC_SHAPING	Get traffic shapping configuration. IOCTL parameters: inArgs: None outArgs: CpswPort_TrafficShapingConfig
CPSW_HOSTPORT_IOCTL_PRINT_REGS	Print host port registers. IOCTL parameters: inArgs: None outArgs: None
CPSW_HOSTPORT_IOCTL_GET_RX_MTU	Get host port Rx MTU. IOCTL parameters: inArgs: None outArgs: uint32_t
CPSW_HOSTPORT_GET_FLOW_ID_OFFSET	Get host port Flow Id offset. IOCTL parameters: inArgs: None outArgs: uint32_t
CPSW_HOSTPORT_IS_CSUM_OFFLOAD_ENABLE	Returns true if checksum offload is enabled else false. IOCTL parameters: inArgs: None outArgs: bool

enum CpswHostPort_RxPriorityType

Port priority type.

Enumerator
CPSW_RX_PRIORITY_TYPE_FIXED	Fixed priority
CPSW_RX_PRIORITY_TYPE_RR	Round-robin priority