enet_cpdma.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2020-25
 *
 *  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_CPDMA_H_
#define ENET_CPDMA_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <include/core/enet_types.h>
#include <include/core/enet_base.h>
#include <include/core/enet_queue.h>
#include <include/dma/cpdma/enet_cpdma_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define ENET_CPDMA_CPSW_MAX_TX_CH                                (8U)
 
#define ENET_CPDMA_CPSW_MAX_RX_CH                                (8U)
 
#define ENET_CPDMA_CPSW_MAX_SG_LIST         (4U)
 
#if ((__ARM_ARCH == 7) && (__ARM_ARCH_PROFILE == 'R'))
 
#define ENETDMA_CACHELINE_ALIGNMENT            (32U)
#else
#error "Enet library compilation not supported on non cortex R cores. Update correct cache line size"
#endif
 
#define ENET_CPDMA_CSUM_START_BYTE_SHIFT                         (16U)
 
#define ENET_CPDMA_CSUM_START_BYTE_MASK                          (((uint32_t) 0xFFU) << ENET_CPDMA_CSUM_START_BYTE_SHIFT)
 
#define ENET_CPDMA_CSUM_RESULT_BYTE_SHIFT                        (24U)
 
#define ENET_CPDMA_CSUM_RESULT_BYTE_MASK                         (((uint32_t) 0xFFU) << ENET_CPDMA_CSUM_RESULT_BYTE_SHIFT)
 
#define ENET_CPDMA_CSUM_BYTE_COUNT_SHIFT                         (0U)
 
#define ENET_CPDMA_CSUM_BYTE_COUNT_MASK                          (((uint32_t) 0x3FFU) << ENET_CPDMA_CSUM_BYTE_COUNT_SHIFT)
 
#define ENET_CPDMA_GET_CSUM_RESULT_BYTE(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENET_CPDMA_CSUM_RESULT_BYTE)
 
#define ENET_CPDMA_GET_CSUM_START_BYTE(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENET_CPDMA_CSUM_START_BYTE)
 
#define ENET_CPDMA_GET_CSUM_BYTE_COUNT(chkSumInfo) \
                ENET_FEXT(chkSumInfo, ENET_CPDMA_CSUM_BYTE_COUNT)
 
/* TODO: may be deleted */
typedef void (*EnetDma_PktNotifyCb)(void *cbArg);
 
typedef EnetQ EnetDma_PktQ;
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
/*
 * TODO: CPDMA does not support timestamp within packet
 *       Stub to share the application code?
 */
 
typedef struct EnetCpdma_PktTsInfo_s
{
    bool enableHostTxTs;
 
    uint32_t txPktSeqId;
 
    uint8_t txPktMsgType;
 
    uint8_t txPktDomain;
 
    uint64_t rxPktTs;
} EnetCpdma_PktTsInfo;
 
typedef struct EnetCpdma_SGListEntry_s
{
    uint8_t *bufPtr;
 
    uint8_t *origBufPtr;
 
    uint32_t segmentFilledLen;
 
    uint32_t segmentAllocLen;
 
    bool disableCacheOps;
} EnetCpdma_SGListEntry;
 
typedef struct EnetCpdma_SGList_s
{
    uint32_t numScatterSegments;
    EnetCpdma_SGListEntry list[ENET_CPDMA_CPSW_MAX_SG_LIST];
} EnetCpdma_SGList;
 
typedef EnetCpdma_SGListEntry EnetDma_SGListEntry;
 
typedef struct EnetCpdma_PktInfo_s
{
    EnetQ_Node node;
 
    void *appPriv;
 
    uint32_t pktState;
 
    uint32_t chkSumInfo;
 
    EnetCpdma_PktTsInfo tsInfo;
 
    Enet_MacPort txPortNum;
 
    Enet_MacPort rxPortNum;
 
    uint32_t txPktTc;
 
    uint32_t txTsId;
 
    EnetCpdma_SGList sgList;
} EnetCpdma_PktInfo;
 
typedef struct EnetCpdma_OpenTxChPrms_s
{
    Enet_Handle hEnet;
 
    uint32_t chNum;
 
    EnetDma_PktNotifyCb notifyCb;
 
    uint32_t numTxPkts;
 
    void *cbArg;
 
} EnetCpdma_OpenTxChPrms;
 
typedef struct EnetCpdma_OpenRxChPrms_s
{
    Enet_Handle hEnet;
 
    uint32_t chNum;
 
    EnetDma_PktNotifyCb notifyCb;
 
    uint32_t numRxPkts;
 
    void *cbArg;
 
} EnetCpdma_OpenRxChPrms;
 
typedef EnetCpdma_OpenRxChPrms EnetDma_OpenRxChPrms;
 
typedef struct EnetCpdma_RxChInitPrms_s
{
    uint32_t rxBufferOffset;
} EnetCpdma_RxChInitPrms;
 
typedef struct EnetCpdma_Cfg_s
{
    uint32_t txInterruptPerMSec;
 
    uint32_t rxInterruptPerMSec;
 
    bool     enChOverrideFlag;
 
    bool enHostRxTsFlag;
 
    EnetCpdma_RxChInitPrms rxChInitPrms;
 
    uint32_t maxTxChannels;
 
    uint32_t maxRxChannels;
 
} EnetDma_Cfg;
 
typedef struct EnetDma_initCfg_s
{
}
EnetDma_initCfg;
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void EnetCpdma_initRxChParams(EnetCpdma_OpenRxChPrms *pRxChPrms);
 
EnetDma_RxChHandle EnetCpdma_openRxCh(EnetDma_Handle hDma,
                                      const EnetCpdma_OpenRxChPrms *pRxChPrms);
 
int32_t EnetCpdma_closeRxCh(EnetDma_RxChHandle hRxCh,
                            EnetDma_PktQ *fq,
                            EnetDma_PktQ *cq);
 
void EnetCpdma_initTxChParams(EnetCpdma_OpenTxChPrms *pTxChPrms);
 
EnetDma_TxChHandle EnetCpdma_openTxCh(EnetDma_Handle hDma,
                                      const EnetCpdma_OpenTxChPrms *pTxChPrms);
 
int32_t EnetCpdma_closeTxCh(EnetDma_TxChHandle hTxCh,
                            EnetDma_PktQ *fq,
                            EnetDma_PktQ *cq);
 
EnetDma_Handle EnetCpdma_open(Enet_Type enetType,
                              uint32_t instId,
                              const EnetDma_Cfg *dmaCfg,
                              uint32_t appCoreId);
 
EnetDma_Handle EnetCpdma_restoreCtxt(Enet_Type enetType,
                                     uint32_t instId,
                                     uint32_t appCoreId);
 
int32_t EnetCpdma_close(EnetDma_Handle hEnetDma);
 
int32_t EnetCpdma_saveCtxt(EnetDma_Handle hEnetDma);
 
int32_t EnetCpdma_rxThreshIsr(EnetDma_Handle hEnetDma);
 
int32_t EnetCpdma_rxIsr(EnetDma_Handle hEnetDma);
 
int32_t EnetCpdma_txIsr(EnetDma_Handle hEnetDma);
 
int32_t EnetCpdma_miscIsrGetStatus(EnetDma_Handle hEnetDma, uint32_t *pStatusMask);
 
int32_t EnetCpdma_ackMiscIsr(EnetDma_Handle hEnetDma);
 
void EnetCpdma_initParams(EnetDma_Cfg *pDmaConfig);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_CPDMA_H_ */