enet_udma_psi.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2020
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef ENET_UDMA_PSI_H_
#define ENET_UDMA_PSI_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
/* -------------------- CPPI TX Info Word 0 definitions --------------------- */
 
#define ENETUDMA_CPPI_TXINFO_WORD0_FLOWID_SHIFT              (0U)
 
#define ENETUDMA_CPPI_TXINFO_WORD0_FLOWID_MASK               (((uint32_t) 0xFFU) << ENETUDMA_CPPI_TXINFO_WORD0_FLOWID_SHIFT)
 
#define ENETUDMA_CPPI_TXINFO_WORD0_CRCTYPE_SHIFT             (22U)
 
#define ENETUDMA_CPPI_TXINFO_WORD0_CRCTYPE_MASK              (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXINFO_WORD0_CRCTYPE_SHIFT)
 
#define ENETUDMA_CPPI_TXINFO_WORD0_PASSCRC_SHIFT             (23U)
 
#define ENETUDMA_CPPI_TXINFO_WORD0_PASSCRC_MASK              (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXINFO_WORD0_PASSCRC_SHIFT)
 
#define ENETUDMA_CPPI_TXINFO_WORD0_PKTTYPE_SHIFT             (27U)
 
#define ENETUDMA_CPPI_TXINFO_WORD0_PKTTYPE_MASK              (((uint32_t) 0x1FU) << ENETUDMA_CPPI_TXINFO_WORD0_PKTTYPE_SHIFT)
 
 
/* -------------------- CPPI TX Info Word 1 definitions --------------------- */
 
#define ENETUDMA_CPPI_TXINFO_WORD1_PKTLEN_SHIFT              (0U)
 
#define ENETUDMA_CPPI_TXINFO_WORD1_PKTLEN_MASK               (((uint32_t) 0x3FFF) << ENETUDMA_CPPI_TXINFO_WORD1_PKTLEN_SHIFT)
 
 
/* -------------------- CPPI TX Info Word 3 definitions --------------------- */
 
#define ENETUDMA_CPPI_TXINFO_WORD3_SRCID_SHIFT               (16U)
 
#define ENETUDMA_CPPI_TXINFO_WORD3_SRCID_MASK                (((uint32_t) 0xFF) << ENETUDMA_CPPI_TXINFO_WORD3_SRCID_SHIFT)
 
 
/* -------------------- CPPI TX Status Word 2 definitions --------------------- */
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ADD_SHIFT        (0U)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ADD_MASK         (((uint32_t) 0xFFFF) << ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ADD_SHIFT)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ERR_SHIFT        (16U)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ERR_MASK         (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ERR_SHIFT)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_FRAGMENT_SHIFT          (17U)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_FRAGMENT_MASK           (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXSTATUS_WORD2_FRAGMENT_SHIFT)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_TCP_UDP_N_SHIFT         (18U)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_TCP_UDP_N_MASK          (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXSTATUS_WORD2_TCP_UDP_N_SHIFT)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_IPV6_VALID_SHIFT        (19U)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_IPV6_VALID_MASK         (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXSTATUS_WORD2_IPV6_VALID_SHIFT)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_IPV4_VALID_SHIFT        (20U)
 
#define ENETUDMA_CPPI_TXSTATUS_WORD2_IPV4_VALID_MASK         (((uint32_t) 0x1U) << ENETUDMA_CPPI_TXSTATUS_WORD2_IPV4_VALID_SHIFT)
 
 
/* -------------------- CPPI RX Info Word 0 definitions --------------------- */
 
#define ENETUDMA_CPPI_RXINFO_WORD0_CRCTYPE_SHIFT             (22U)
 
#define ENETUDMA_CPPI_RXINFO_WORD0_CRCTYPE_MASK              (((uint32_t) 0x1U) << ENETUDMA_CPPI_RXINFO_WORD0_CRCTYPE_SHIFT)
 
#define ENETUDMA_CPPI_RXINFO_WORD0_PASSCRC_SHIFT             (23U)
 
#define ENETUDMA_CPPI_RXINFO_WORD0_PASSCRC_MASK              (((uint32_t) 0x1U) << ENETUDMA_CPPI_RXINFO_WORD0_PASSCRC_SHIFT)
 
 
/* -------------------- CPPI RX Info Word 2 definitions --------------------- */
 
#define ENETUDMA_CPPI_RXINFO_WORD2_TOPORT_SHIFT              (16U)
 
#define ENETUDMA_CPPI_RXINFO_WORD2_TOPORT_MASK               (((uint32_t) 0x1FU) << ENETUDMA_CPPI_RXINFO_WORD2_TOPORT_SHIFT)
 
 
/* -------------------- CPPI RX Control Word 1 definitions --------------------- */
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_SEQID_SHIFT               (0U)
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_SEQID_MASK                (((uint32_t) 0xFFFFU) << ENETUDMA_CPPI_RXCTRL_WORD1_SEQID_SHIFT)
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_MSGTYPE_SHIFT             (16U)
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_MSGTYPE_MASK              (((uint32_t) 0xFU) << ENETUDMA_CPPI_RXCTRL_WORD1_MSGTYPE_SHIFT)
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_DOMAIN_SHIFT              (20U)
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_DOMAIN_MASK               (((uint32_t) 0xFFU) << ENETUDMA_CPPI_RXCTRL_WORD1_DOMAIN_SHIFT)
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_TSEN_SHIFT                (31U)
 
#define ENETUDMA_CPPI_RXCTRL_WORD1_TSEN_MASK                 (((uint32_t) 0x1U) << ENETUDMA_CPPI_RXCTRL_WORD1_TSEN_SHIFT)
 
 
/* -------------------- CPPI RX Control Word 2 definitions --------------------- */
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_BYTECNT_SHIFT      (0U)
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_BYTECNT_MASK       (((uint32_t) 0x3FFFU) << ENETUDMA_CPPI_RXCTRL_WORD1_SEQID_SHIFT)
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_INV_SHIFT          (15U)
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_INV_MASK           (((uint32_t) 0x1U) << ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_INV_SHIFT)
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_STARTBYTE_SHIFT    (16U)
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_STARTBYTE_MASK     (((uint32_t) 0xFFU) << ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_STARTBYTE_SHIFT)
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_RESULT_SHIFT       (24U)
 
#define ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_RESULT_MASK        (((uint32_t) 0xFFU) << ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_RESULT_SHIFT)
 
 
/* -- Utilities macros to extract fields from the CPPI TX (host RX) PSI words -- */
 
#define ENETUDMA_CPPIPSI_GET_IPV4_FLAG(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_IPV4_VALID)
 
#define ENETUDMA_CPPIPSI_GET_IPV6_FLAG(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_IPV6_VALID)
 
#define ENETUDMA_CPPIPSI_GET_TCPUDP_N_FLAG(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_TCP_UDP_N)
 
#define ENETUDMA_CPPIPSI_GET_FRAGMENT_FLAG(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_FRAGMENT)
 
#define ENETUDMA_CPPIPSI_GET_CHKSUM_ERR_FLAG(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ERR)
 
#define ENETUDMA_CPPIPSI_GET_CHKSUM_RESULT(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETUDMA_CPPI_TXSTATUS_WORD2_CHKSUM_ADD)
 
 
/* --- Utilities macros to insert fields into the CPPI RX (host TX) PSI words --- */
 
#define ENETUDMA_CPPIPSI_SET_CHKSUM_RES(chkSumInfo, val) \
                ENET_FINS(chkSumInfo, ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_RESULT, val)
 
#define ENETUDMA_CPPIPSI_SET_CHKSUM_STARTBYTE(chkSumInfo, val) \
                ENET_FINS(chkSumInfo, ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_STARTBYTE, val)
 
#define ENETUDMA_CPPIPSI_SET_CHKSUM_INV_FLAG(chkSumInfo, val) \
                ENET_FINS(chkSumInfo, ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_INV, val)
 
#define ENETUDMA_CPPIPSI_SET_CHKSUM_BYTECNT(chkSumInfo, val) \
                ENET_FINS(chkSumInfo, ENETUDMA_CPPI_RXCTRL_WORD2_CHKSUM_BYTECNT, val)
 
#define ENETUDMA_CPPIPSI_SET_TSEN(tsInfo, val) \
                ENET_FINS(tsInfo, ENETUDMA_CPPI_RXCTRL_WORD1_TSEN, val)
 
#define ENETUDMA_CPPIPSI_SET_DOMAIN(tsInfo, val) \
                ENET_FINS(tsInfo, ENETUDMA_CPPI_RXCTRL_WORD1_DOMAIN, val)
 
#define ENETUDMA_CPPIPSI_SET_MSGTYPE(tsInfo, val) \
                ENET_FINS(tsInfo, ENETUDMA_CPPI_RXCTRL_WORD1_MSGTYPE, val)
 
#define ENETUDMA_CPPIPSI_SET_SEQID(tsInfo, val) \
                ENET_FINS(tsInfo, ENETUDMA_CPPI_RXCTRL_WORD1_SEQID, val)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct EnetUdma_RxProtoInfo_s
{
    bool ipv6Valid;
 
    bool ipv4Valid;
 
    bool tcpudpIndicator;
 
    bool fragment;
 
    bool chkSumErr;
 
    uint16_t chkSum;
} EnetUdma_RxProtoInfo;
 
typedef struct EnetUdma_TxProtoInfo_s
{
    uint16_t chkSumResOffset;
 
    uint16_t chkSumStartByte;
 
    bool chkSumInv;
 
    uint16_t chkSumByteCnt;
} EnetUdma_TxProtoInfo;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_UDMA_PSI_H_ */