AM243x MCU+ SDK  09.02.00
enet_udma_psi.h File Reference

Introduction

This file contains the type definitions and helper macros for the Enet UDMA CPPI protocol specific info.

Go to the source code of this file.

Data Structures

struct  EnetUdma_RxProtoInfo
 Enet UDMA RX Protocol Info structure. More...
 
struct  EnetUdma_TxProtoInfo
 Enet UDMA TX Protocol Info structure. More...
 

Macros

#define ENETUDMA_CPPI_TXINFO_WORD0_FLOWID_SHIFT   (0U)
 CPPI TX Info Word 0 - Flow Id bit shift. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD0_FLOWID_MASK   (((uint32_t) 0xFFU) << ENETUDMA_CPPI_TXINFO_WORD0_FLOWID_SHIFT)
 CPPI TX Info Word 0 - Flow ID bit mask. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD0_CRCTYPE_SHIFT   (22U)
 CPPI TX Info Word 0 - CRC Type bit shift. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD0_CRCTYPE_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXINFO_WORD0_CRCTYPE_SHIFT)
 CPPI TX Info Word 0 - CRC Type bit mask. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD0_PASSCRC_SHIFT   (23U)
 CPPI TX Info Word 0 - Pass CRC bit shift. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD0_PASSCRC_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXINFO_WORD0_PASSCRC_SHIFT)
 CPPI TX Info Word 0 - Pass CRC bit mask. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD0_PKTTYPE_SHIFT   (27U)
 CPPI TX Info Word 0 - Packet Type bit shift. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD0_PKTTYPE_MASK   (((uint32_t) 0x1FU) << ENETUDMA_CPPI_TXINFO_WORD0_PKTTYPE_SHIFT)
 CPPI TX Info Word 0 - Packet Type bit mask. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD1_PKTLEN_SHIFT   (0U)
 CPPI TX Info Word 1 - Packet Length bit shift. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD1_PKTLEN_MASK   (((uint32_t) 0x3FFF) << ENETUDMA_CPPI_TXINFO_WORD1_PKTLEN_SHIFT)
 CPPI TX Info Word 1 - Packet Length bit mask. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD3_SRCID_SHIFT   (16U)
 CPPI TX Info Word 3 - Source Id bit shift. More...
 
#define ENETUDMA_CPPI_TXINFO_WORD3_SRCID_MASK   (((uint32_t) 0xFF) << ENETUDMA_CPPI_TXINFO_WORD3_SRCID_SHIFT)
 CPPI TX Info Word 3 - Source Id bit mask. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ADD_SHIFT   (0U)
 CPPI TX Status Word 2- Checksum Add bit shift. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ADD_MASK   (((uint32_t) 0xFFFF) << ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ADD_SHIFT)
 CPPI TX Status Word 2 - Checksum Add bit mask. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ERR_SHIFT   (16U)
 CPPI TX Status Word 2 - Checksum Error bit shift. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ERR_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ERR_SHIFT)
 CPPI TX Status Word 2 - Checksum Error bit mask. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_FRAGMENT_SHIFT   (17U)
 CPPI TX Status Word 2 - IP Fragment bit shift. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_FRAGMENT_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXSTATUS_WORD2_FRAGMENT_SHIFT)
 CPPI TX Status Word 2 - IP Fragment bit mask. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_TCP_UDP_N_SHIFT   (18U)
 CPPI TX Status Word 2 - TCP or UDP bit shift. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_TCP_UDP_N_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXSTATUS_WORD2_TCP_UDP_N_SHIFT)
 CPPI TX Status Word 2 - TCP or UDP bit mask. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_IPV6_VALID_SHIFT   (19U)
 CPPI TX Status Word 2 - IPv6 Valid bit shift. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_IPV6_VALID_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXSTATUS_WORD2_IPV6_VALID_SHIFT)
 CPPI TX Status Word 2 - IPv6 Valid bit mask. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_IPV4_VALID_SHIFT   (20U)
 CPPI TX Status Word 2 - IPv4 Valid bit shift. More...
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_IPV4_VALID_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXSTATUS_WORD2_IPV4_VALID_SHIFT)
 CPPI TX Status Word 2 - IPv4 Valid bit mask. More...
 
#define ENETUDMA_CPPI_RXINFO_WORD0_CRCTYPE_SHIFT   (22U)
 CPPI RX Info Word 0 - CRC Type bit shift. More...
 
#define ENETUDMA_CPPI_RXINFO_WORD0_CRCTYPE_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_RXINFO_WORD0_CRCTYPE_SHIFT)
 CPPI RX Info Word 0 - CRC Type bit mask. More...
 
#define ENETUDMA_CPPI_RXINFO_WORD0_PASSCRC_SHIFT   (23U)
 CPPI RX Info Word 0 - Pass CRC bit shift. More...
 
#define ENETUDMA_CPPI_RXINFO_WORD0_PASSCRC_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_RXINFO_WORD0_PASSCRC_SHIFT)
 CPPI RX Info Word 0 - Pass CRC bit mask. More...
 
#define ENETUDMA_CPPI_RXINFO_WORD2_TOPORT_SHIFT   (16U)
 CPPI RX Info Word 2 - Port To Send bit shift. More...
 
#define ENETUDMA_CPPI_RXINFO_WORD2_TOPORT_MASK   (((uint32_t) 0x1FU) << ENETUDMA_CPPI_RXINFO_WORD2_TOPORT_SHIFT)
 CPPI RX Info Word 2 - Port To Send bit mask. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_SEQID_SHIFT   (0U)
 CPPI RX Control Word 1 - Timesync Sequence Id bit shift. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_SEQID_MASK   (((uint32_t) 0xFFFFU) << ENETUDMA_CPPI_RXCTRL_WORD1_SEQID_SHIFT)
 CPPI RX Control Word 1 - Timesync Sequence Id bit mask. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_MSGTYPE_SHIFT   (16U)
 CPPI RX Control Word 1 - Timesync Message Type bit shift. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_MSGTYPE_MASK   (((uint32_t) 0xFU) << ENETUDMA_CPPI_RXCTRL_WORD1_MSGTYPE_SHIFT)
 CPPI RX Control Word 1 - Timesync Message Type bit mask. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_DOMAIN_SHIFT   (20U)
 CPPI RX Control Word 1 - Timesync Domain bit shift. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_DOMAIN_MASK   (((uint32_t) 0xFFU) << ENETUDMA_CPPI_RXCTRL_WORD1_DOMAIN_SHIFT)
 CPPI RX Control Word 1 - Timesync Domain bit mask. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_TSEN_SHIFT   (31U)
 CPPI RX Control Word 1 - Timestamp Enabled bit shift. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_TSEN_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_RXCTRL_WORD1_TSEN_SHIFT)
 CPPI RX Control Word 1 - Timestamp Enabled bit mask. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_BYTECNT_SHIFT   (0U)
 CPPI RX Control Word 2 - Checksum Byte Count bit shift. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_BYTECNT_MASK   (((uint32_t) 0x3FFFU) << ENETUDMA_CPPI_RXCTRL_WORD1_SEQID_SHIFT)
 CPPI RX Control Word 2 - Checksum Byte Count bit mask. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_INV_SHIFT   (15U)
 CPPI RX Control Word 2 - Inverted Checksum bit shift. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_INV_MASK   (((uint32_t) 0x1U) << ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_INV_SHIFT)
 CPPI RX Control Word 2 - Inverted Checksum bit mask. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_STARTBYTE_SHIFT   (16U)
 CPPI RX Control Word 2 - Checksum Start Byte bit shift. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_STARTBYTE_MASK   (((uint32_t) 0xFFU) << ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_STARTBYTE_SHIFT)
 CPPI RX Control Word 2 - Checksum Start Byte bit mask. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_RESULT_SHIFT   (24U)
 CPPI RX Control Word 2 - Checksum Result bit shift. More...
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_RESULT_MASK   (((uint32_t) 0xFFU) << ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_RESULT_SHIFT)
 CPPI RX Control Word 2 - Checksum Result bit mask. More...
 
#define ENETUDMA_CPPIPSI_GET_IPV4_FLAG(chkSumInfo)    ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_IPV4_VALID)
 Get IPv4 flag from CPPI TX Status Word 2. More...
 
#define ENETUDMA_CPPIPSI_GET_IPV6_FLAG(chkSumInfo)    ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_IPV6_VALID)
 Get IPv6 flag from CPPI TX Status Word 2. More...
 
#define ENETUDMA_CPPIPSI_GET_TCPUDP_N_FLAG(chkSumInfo)    ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_TCP_UDP_N)
 Get TCP or UDP flag from CPPI TX Status Word 2. More...
 
#define ENETUDMA_CPPIPSI_GET_FRAGMENT_FLAG(chkSumInfo)    ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_FRAGMENT)
 Get IP Fragment flag from CPPI TX Status Word 2. More...
 
#define ENETUDMA_CPPIPSI_GET_CHKSUM_ERR_FLAG(chkSumInfo)    ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ERR)
 Get Checksum Error flag from CPPI TX Status Word 2. More...
 
#define ENETUDMA_CPPIPSI_GET_CHKSUM_RESULT(chkSumInfo)    ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ADD)
 Get Checksum Result from CPPI TX Status Word 2. More...
 
#define ENETUDMA_CPPIPSI_SET_CHKSUM_RES(chkSumInfo, val)    ENET_FINS(chkSumInfo, ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_RESULT, val)
 Set Checksum Result into CPPI RX Control Word 2. More...
 
#define ENETUDMA_CPPIPSI_SET_CHKSUM_STARTBYTE(chkSumInfo, val)    ENET_FINS(chkSumInfo, ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_STARTBYTE, val)
 Set Checksum Start Byte into CPPI RX Control Word 2. More...
 
#define ENETUDMA_CPPIPSI_SET_CHKSUM_INV_FLAG(chkSumInfo, val)    ENET_FINS(chkSumInfo, ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_INV, val)
 Set Invert Checksum flag into CPPI RX Control Word 2. More...
 
#define ENETUDMA_CPPIPSI_SET_CHKSUM_BYTECNT(chkSumInfo, val)    ENET_FINS(chkSumInfo, ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_BYTECNT, val)
 Set Checksum Byte Count into CPPI RX Control Word 2. More...
 
#define ENETUDMA_CPPIPSI_SET_TSEN(tsInfo, val)    ENET_FINS(tsInfo, ENETUDMA_CPPI_RXCTRL_WORD1_TSEN, val)
 Set Timestamp enable bit into CPPI RX Control Word. 1. More...
 
#define ENETUDMA_CPPIPSI_SET_DOMAIN(tsInfo, val)    ENET_FINS(tsInfo, ENETUDMA_CPPI_RXCTRL_WORD1_DOMAIN, val)
 Set domain value into CPPI RX Control Word 1. More...
 
#define ENETUDMA_CPPIPSI_SET_MSGTYPE(tsInfo, val)    ENET_FINS(tsInfo, ENETUDMA_CPPI_RXCTRL_WORD1_MSGTYPE, val)
 Set message type value into CPPI RX Control Word 1. More...
 
#define ENETUDMA_CPPIPSI_SET_SEQID(tsInfo, val)    ENET_FINS(tsInfo, ENETUDMA_CPPI_RXCTRL_WORD1_SEQID, val)
 Set sequence Id value into CPPI RX Control Word 1. More...