enet_dma.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2020-23
 *
 *  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_DMA_H_
#define ENET_DMA_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <include/core/enet_types.h>
#include <include/core/enet_queue.h>
#include <include/core/enet_dma_pktutils.h>
 
#if defined(SOC_AM64X) || defined(SOC_AM243X) || defined(SOC_AM62AX) || defined(SOC_AM62PX) || defined(SOC_AM62DX)
#include <drivers/udma.h>
#include <include/dma/udma/enet_udma_types.h>
#include <include/dma/udma/enet_udma.h>
#include <include/dma/udma/enet_udma_psi.h>
#elif defined (SOC_AM273X) || defined(SOC_AWR294X) || defined(SOC_AWR2544) || defined(SOC_AM263X) || defined(SOC_AM263PX) || defined(SOC_AM261X)
#include <include/dma/cpdma/enet_cpdma.h>
#else
#error "SOC not supported"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
 
 
#if defined(SOC_AM273X) || defined(SOC_AWR294X) || defined(SOC_AWR2544) || defined(SOC_AM263X) || defined(SOC_AM263PX) || defined(SOC_AM261X)
 
#define Enet_isCacheCoherent()                  (false)
#elif defined(SOC_AM64X) || defined(SOC_AM243X) || defined(SOC_AM62AX) || defined(SOC_AM62PX) || defined(SOC_AM62DX)
 
#define Enet_isCacheCoherent()                  (Udma_isCacheCoherent())
#else
#error "SOC not supported"
#endif
 
#define ENETDMA_RXCSUMINFO_CHKSUM_ADD_SHIFT        (0U)
 
#define ENETDMA_RXCSUMINFO_CHKSUM_ADD_MASK         (((uint32_t) 0xFFFF) << ENETDMA_RXCSUMINFO_CHKSUM_ADD_SHIFT)
 
#define ENETDMA_RXCSUMINFO_CHKSUM_ERR_SHIFT        (16U)
 
#define ENETDMA_RXCSUMINFO_CHKSUM_ERR_MASK         (((uint32_t) 0x1U) << ENETDMA_RXCSUMINFO_CHKSUM_ERR_SHIFT)
 
#define ENETDMA_RXCSUMINFO_FRAGMENT_SHIFT          (17U)
 
#define ENETDMA_RXCSUMINFO_FRAGMENT_MASK           (((uint32_t) 0x1U) << ENETDMA_RXCSUMINFO_FRAGMENT_SHIFT)
 
#define ENETDMA_RXCSUMINFO_TCP_UDP_N_SHIFT         (18U)
 
#define ENETDMA_RXCSUMINFO_TCP_UDP_N_MASK          (((uint32_t) 0x1U) << ENETDMA_RXCSUMINFO_TCP_UDP_N_SHIFT)
 
#define ENETDMA_RXCSUMINFO_IPV6_VALID_SHIFT        (19U)
 
#define ENETDMA_RXCSUMINFO_IPV6_VALID_MASK         (((uint32_t) 0x1U) << ENETDMA_RXCSUMINFO_IPV6_VALID_SHIFT)
 
#define ENETDMA_RXCSUMINFO_IPV4_VALID_SHIFT        (20U)
 
#define ENETDMA_RXCSUMINFO_IPV4_VALID_MASK         (((uint32_t) 0x1U) << ENETDMA_RXCSUMINFO_IPV4_VALID_SHIFT)
 
#define ENETDMA_TXCSUMINFO_CHKSUM_BYTECNT_SHIFT      (0U)
 
#define ENETDMA_TXCSUMINFO_CHKSUM_BYTECNT_MASK       (((uint32_t) 0x3FFFU) << ENETDMA_TXCSUMINFO_CHKSUM_BYTECNT_SHIFT)
 
#define ENETDMA_TXCSUMINFO_CHKSUM_INV_SHIFT          (15U)
 
#define ENETDMA_TXCSUMINFO_CHKSUM_INV_MASK           (((uint32_t) 0x1U) << ENETDMA_TXCSUMINFO_CHKSUM_INV_SHIFT)
 
#define ENETDMA_TXCSUMINFO_CHKSUM_STARTBYTE_SHIFT    (16U)
 
#define ENETDMA_TXCSUMINFO_CHKSUM_STARTBYTE_MASK     (((uint32_t) 0xFFU) << ENETDMA_TXCSUMINFO_CHKSUM_STARTBYTE_SHIFT)
 
#define ENETDMA_TXCSUMINFO_CHKSUM_RESULT_SHIFT       (24U)
 
#define ENETDMA_TXCSUMINFO_CHKSUM_RESULT_MASK        (((uint32_t) 0xFFU) << ENETDMA_TXCSUMINFO_CHKSUM_RESULT_SHIFT)
 
 
/* --- Utilities macros to extract fields from THOST Checksum Encapsulation word --- */
 
#define ENETDMA_RXCSUMINFO_GET_IPV4_FLAG(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETDMA_RXCSUMINFO_IPV4_VALID)
 
#define ENETDMA_RXCSUMINFO_GET_IPV6_FLAG(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETDMA_RXCSUMINFO_IPV6_VALID)
 
#define ENETDMA_RXCSUMINFO_GET_TCPUDP_N_FLAG(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETDMA_RXCSUMINFO_TCP_UDP_N)
 
#define ENETDMA_RXCSUMINFO_GET_FRAGMENT_FLAG(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETDMA_RXCSUMINFO_FRAGMENT)
 
#define ENETDMA_RXCSUMINFO_GET_CHKSUM_ERR_FLAG(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETDMA_RXCSUMINFO_CHKSUM_ERR)
 
#define ENETDMA_RXCSUMINFO_GET_CHKSUM_RESULT(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENETDMA_RXCSUMINFO_CHKSUM_ADD)
 
/* --- Utilities macros to insert fields in FHOST Checksum Encapsulation word --- */
 
#define ENETDMA_TXCSUMINFO_SET_CHKSUM_RESBYTE(chkSumInfo, val) \
                ENET_FINS(chkSumInfo, ENETDMA_TXCSUMINFO_CHKSUM_RESULT, val)
 
#define ENETDMA_TXCSUMINFO_SET_CHKSUM_STARTBYTE(chkSumInfo, val) \
                ENET_FINS(chkSumInfo, ENETDMA_TXCSUMINFO_CHKSUM_STARTBYTE, val)
 
#define ENETDMA_TXCSUMINFO_SET_CHKSUM_INV_FLAG(chkSumInfo, val) \
                ENET_FINS(chkSumInfo, ENETDMA_TXCSUMINFO_CHKSUM_INV, val)
 
#define ENETDMA_TXCSUMINFO_SET_CHKSUM_BYTECNT(chkSumInfo, val) \
                ENET_FINS(chkSumInfo, ENETDMA_TXCSUMINFO_CHKSUM_BYTECNT, val)
 
#define ENET_DMA_STATS_HISTORY_CNT                  ((uint32_t)2U)
 
typedef EnetDma_Pkt *(*EnetDma_AllocEthPktFxn)(uint32_t pktSize,
                                               uint32_t alignSize,
                                               void *appPriv);
 
typedef void (*EnetDma_FreeEthPktFxn)(EnetDma_Pkt *pPktInfo);
 
typedef EnetQ EnetDma_PktQ;
 
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct EnetDma_CbStats_s
{
    uint64_t dataNotifyCnt;
 
    uint64_t zeroNotifyCnt;
    uint64_t totalPktCnt;
    uint64_t totalCycleCnt;
 
    uint64_t pktsPerNotifyMax;
 
    uint64_t pktsPerNotify[ENET_DMA_STATS_HISTORY_CNT];
    uint64_t cycleCntPerNotifyMax;
 
    uint64_t cycleCntPerNotify[ENET_DMA_STATS_HISTORY_CNT];
    uint64_t cycleCntPerPktMax;
 
    uint64_t cycleCntPerPkt[ENET_DMA_STATS_HISTORY_CNT];
 
    uint64_t readyDmaDescQCnt[ENET_DMA_STATS_HISTORY_CNT];
} EnetDma_CbStats;
 
typedef struct EnetDma_DmaDescStats_s
{
    uint64_t readyDmaDescEnq;
    uint64_t freeDmaDescDeq;
    uint64_t underFlowCnt;
} EnetDma_DmaDescStats;
 
typedef struct EnetDma_RxChStats_s
{
    EnetDma_CbStats submitPktStats;
    EnetDma_CbStats retrievePktStats;
    EnetDma_DmaDescStats dmaDescStats;
    uint64_t rxSubmitPktEnq;
    uint64_t rxRetrievePktDeq;
    uint64_t rxSubmitPktUnderFlowCnt;
}EnetDma_RxChStats;
 
typedef struct EnetDma_TxChStats_s
{
    EnetDma_CbStats submitPktStats;
    EnetDma_CbStats retrievePktStats;
    EnetDma_DmaDescStats dmaDescStats;
    uint64_t txSubmitPktEnq;
    uint64_t txRetrievePktDeq;
    uint64_t txSubmitPktOverFlowCnt;
} EnetDma_TxChStats;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
EnetDma_Handle EnetDma_initDmaCfg(Enet_Type enetType,
                                  uint32_t instId,
                                  const EnetDma_initCfg *pDmaCfg);
 
int32_t EnetDma_deinitDmaCfg(EnetDma_Handle hEnetUdma);
 
void EnetDma_initRxChParams(void *pRxChCfg);
 
EnetDma_RxChHandle EnetDma_openRxCh(EnetDma_Handle hDma,
                                    const void *pRxChCfg);
 
int32_t EnetDma_closeRxCh(EnetDma_RxChHandle hRxCh,
                          EnetDma_PktQ *fq,
                          EnetDma_PktQ *cq);
 
int32_t EnetDma_enableRxEvent(EnetDma_RxChHandle hRxCh);
 
int32_t EnetDma_registerRxEventCb(EnetDma_RxChHandle hRxCh, EnetDma_PktNotifyCb notifyCb, void *cbArg);
 
int32_t EnetDma_disableRxEvent(EnetDma_RxChHandle hRxCh);
 
void EnetDma_initTxChParams(void *pTxChCfg);
 
EnetDma_TxChHandle EnetDma_openTxCh(EnetDma_Handle hDma,
                                    const void *pTxChCfg);
 
int32_t EnetDma_closeTxCh(EnetDma_TxChHandle hTxCh,
                          EnetDma_PktQ *fq,
                          EnetDma_PktQ *cq);
 
int32_t EnetDma_enableTxEvent(EnetDma_TxChHandle hTxCh);
 
int32_t EnetDma_registerTxEventCb(EnetDma_TxChHandle hTxCh, EnetDma_PktNotifyCb notifyCb, void *cbArg);
 
int32_t EnetDma_disableTxEvent(EnetDma_TxChHandle hTxCh);
 
int32_t EnetDma_retrieveRxPktQ(EnetDma_RxChHandle hRxCh,
                               EnetDma_PktQ *pRetrieveQ);
 
int32_t EnetDma_retrieveRxPkt(EnetDma_RxChHandle hRxCh,
                              EnetDma_Pkt **pPkt);
 
int32_t EnetDma_submitRxPktQ(EnetDma_RxChHandle hRxCh,
                             EnetDma_PktQ *pSubmitQ);
 
int32_t EnetDma_submitRxPkt(EnetDma_RxChHandle hRxCh,
                            EnetDma_Pkt *pPkt);
 
int32_t EnetDma_retrieveTxPktQ(EnetDma_TxChHandle hTxCh,
                               EnetDma_PktQ *pRetrieveQ);
 
int32_t EnetDma_retrieveTxPkt(EnetDma_TxChHandle hTxCh,
                              EnetDma_Pkt **pPkt);
 
int32_t EnetDma_submitTxPktQ(EnetDma_TxChHandle hTxCh,
                             EnetDma_PktQ *pSubmitQ);
 
int32_t EnetDma_submitTxPkt(EnetDma_TxChHandle hTxCh,
                            EnetDma_Pkt *pPkt);
 
void EnetDma_initPktInfo(EnetDma_Pkt *pktInfo);
 
int32_t EnetDma_getRxChStats(EnetDma_RxChHandle hRxCh,
                             EnetDma_RxChStats *pStats);
 
int32_t EnetDma_getTxChStats(EnetDma_TxChHandle hTxCh,
                             EnetDma_TxChStats *pStats);
 
int32_t EnetDma_resetRxChStats(EnetDma_RxChHandle hRxCh);
 
int32_t EnetDma_resetTxChStats(EnetDma_TxChHandle hTxCh);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_DMA_H_ */