EnetUdma_PktInfo Struct Reference

Data Fields
EnetQ_Node	node
void *	appPriv
uint32_t	pktState
uint32_t	chkSumInfo
EnetUdma_PktTsInfo	tsInfo
Enet_MacPort	txPortNum
Enet_MacPort	rxPortNum
uint32_t	txPktTc
uint32_t	txTsId
uint32_t	perDmaFlags
EnetUdma_SGList	sgList

Field Documentation

node

EnetQ_Node EnetUdma_PktInfo::node

Pointer to next buffer. Note: Keep EnetQ_Node as first member always as driver uses generic queue functions and dereferences to this member

appPriv

void* EnetUdma_PktInfo::appPriv

Pointer to application layer specific data blob

pktState

uint32_t EnetUdma_PktInfo::pktState

Packet state info. Refer to EnetDma_PktStateModuleType, EnetDma_PktStateMemMgr, EnetDma_PktStateDma and EnetDma_PktStateApp.

This is only for runtime check and debug, not to be used by application

chkSumInfo

uint32_t EnetUdma_PktInfo::chkSumInfo

Protocol information word. Currently used for checksum offload related information.

For RX it contains HW computed checksum. App should call appropriate CPPI helper macros to extract required fields.

For TX it contains information passed to HW for checksum computation. App should call appropriate CPPI helper macros to insert required fields

tsInfo

EnetUdma_PktTsInfo EnetUdma_PktInfo::tsInfo

Packet time stamp information.

For TX, if tsInfo.enableHostTxTs flag is set to true, packet will be timestamped on egress and will trigger host transmit event in CPTS. The timestamp value is then stored in CPTS FIFO with given sequence Id, message type and domain value. This can be used to timestamp any packet (even non-PTP) sent from host.

For RX, the received packet's ingress timestamp is captured and is stored in tsInfo.rxPktTs. All ingress packets are timestamped.

txPortNum

Enet_MacPort EnetUdma_PktInfo::txPortNum

Directed port number.

The port number to which the packet is to be directed bypassing ALE lookup. This value is written to Dst Tag – Low bits of packet descriptor. If ALE lookup based switching is to be performed, this value should be set to ENET_MAC_PORT_INV.

Note: Directed packets go to the directed port, but an ALE lookup is performed to determine untagged egress in VLAN aware mode.

rxPortNum

Enet_MacPort EnetUdma_PktInfo::rxPortNum

Packet's received port number This variable contains the port number from which the packet was received. This value is obtained from the Source Tag – Low bits of packet descriptor.

txPktTc

uint32_t EnetUdma_PktInfo::txPktTc

TX packet traffic class indicates which TX port queue the ICSSG FW should use to transmit the packet to the PHY. QoS for transmission (TX) is achieved with help of two parameters:

1. PSI DMA channel number (Supports upto 4 Qos) - Per RTU (Max 2x RTU per ICSSG instance) has 4 x priority threads connected to PSI DMA used for fetching packet from host to send over the port. Threads can be selected using the channel number. Order for threads serviced by RTU core is '3' - highest and '0' - lowest. Maximum TX channels supported is '8', if channel number is >= '4', then the packet is serviced by the RTU1 core else RTU0 core. To modify the PSI DMA channel number, refer: EnetDma_submitTxPktQ(), pass the TX Channel handle[channel_num]
2. TX priority port queues - txPktTc(Supports upto 8 Qos as per 802.1Q bridging standard) This priority port queues are mapped one-to-one with traffic class, means allowing seperate queues for each traffic class. Highest priority is '7' and lowest is '0'. Order of servicing the packet by the transmit port is based on this parameter.

txTsId

uint32_t EnetUdma_PktInfo::txTsId

Transmit timestamp id. Used to correlate request with response

perDmaFlags

uint32_t EnetUdma_PktInfo::perDmaFlags

Additional DMA metadata flags used to communicate with ICSSG based protocols

sgList

EnetUdma_SGList EnetUdma_PktInfo::sgList

Scatter Gather list information for packets to be transmitted. A single tx packet can be fragmented across multiple chunks, the bufPtrs and filled len of each segment are contained here. sgList.numScatterSegments = 1 by default.