udma_ch.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2024 Texas Instruments Incorporated
 *
 *  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 UDMA_CH_H_
#define UDMA_CH_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define UDMA_DMA_CH_INVALID             ((uint32_t) 0xFFFF0000U)
 
#define UDMA_DMA_CH_ANY                 ((uint32_t) 0xFFFF0001U)
 
#define UDMA_DMA_CH_NA                  ((uint32_t) 0xFFFF0002U)
 
#define UDMA_UTC_ID_INVALID             ((uint32_t) 0xFFFF0003U)
 
#define UDMA_MAPPED_GROUP_INVALID       ((uint32_t) 0xFFFF0004U)
 
 
#define UDMA_CH_FLAG_TX                 ((uint32_t) 0x0001U)
 
#define UDMA_CH_FLAG_RX                 ((uint32_t) 0x0002U)
 
#define UDMA_CH_FLAG_BLK_COPY           ((uint32_t) 0x0004U)
 
#define UDMA_CH_FLAG_PDMA               ((uint32_t) 0x0008U)
 
#define UDMA_CH_FLAG_PSIL               ((uint32_t) 0x0010U)
 
#define UDMA_CH_FLAG_UTC                ((uint32_t) 0x0020U)
 
#define UDMA_CH_FLAG_HC                 ((uint32_t) 0x0040U)
 
#define UDMA_CH_FLAG_UHC                ((uint32_t) 0x0080U)
 
#define UDMA_CH_FLAG_MAPPED             ((uint32_t) 0x0100U)
 
#define UDMA_CH_TYPE_TR_BLK_COPY        (UDMA_CH_FLAG_BLK_COPY |        \
                                         UDMA_CH_FLAG_TX |              \
                                         UDMA_CH_FLAG_RX)
 
#define UDMA_CH_TYPE_TR_BLK_COPY_HC     (UDMA_CH_FLAG_BLK_COPY |        \
                                         UDMA_CH_FLAG_TX |              \
                                         UDMA_CH_FLAG_RX |              \
                                         UDMA_CH_FLAG_HC)
 
#define UDMA_CH_TYPE_TR_BLK_COPY_UHC    (UDMA_CH_FLAG_BLK_COPY |        \
                                         UDMA_CH_FLAG_TX |              \
                                         UDMA_CH_FLAG_RX |              \
                                         UDMA_CH_FLAG_UHC)
 
#define UDMA_CH_TYPE_TX                 (UDMA_CH_FLAG_TX | UDMA_CH_FLAG_PSIL)
 
#define UDMA_CH_TYPE_TX_HC              (UDMA_CH_FLAG_TX | UDMA_CH_FLAG_PSIL | UDMA_CH_FLAG_HC)
 
#define UDMA_CH_TYPE_TX_UHC             (UDMA_CH_FLAG_TX | UDMA_CH_FLAG_PSIL | UDMA_CH_FLAG_UHC)
 
#define UDMA_CH_TYPE_RX                 (UDMA_CH_FLAG_RX | UDMA_CH_FLAG_PSIL)
 
#define UDMA_CH_TYPE_RX_HC              (UDMA_CH_FLAG_RX | UDMA_CH_FLAG_PSIL | UDMA_CH_FLAG_HC)
 
#define UDMA_CH_TYPE_RX_UHC             (UDMA_CH_FLAG_RX | UDMA_CH_FLAG_PSIL | UDMA_CH_FLAG_UHC)
 
#define UDMA_CH_TYPE_PDMA_TX            (UDMA_CH_FLAG_TX | UDMA_CH_FLAG_PDMA)
 
#define UDMA_CH_TYPE_PDMA_TX_HC         (UDMA_CH_FLAG_TX | UDMA_CH_FLAG_PDMA | UDMA_CH_FLAG_HC)
 
#define UDMA_CH_TYPE_PDMA_TX_UHC        (UDMA_CH_FLAG_TX | UDMA_CH_FLAG_PDMA | UDMA_CH_FLAG_UHC)
 
#define UDMA_CH_TYPE_PDMA_RX            (UDMA_CH_FLAG_RX | UDMA_CH_FLAG_PDMA)
 
#define UDMA_CH_TYPE_PDMA_RX_HC         (UDMA_CH_FLAG_RX | UDMA_CH_FLAG_PDMA | UDMA_CH_FLAG_HC)
 
#define UDMA_CH_TYPE_PDMA_RX_UHC        (UDMA_CH_FLAG_RX | UDMA_CH_FLAG_PDMA | UDMA_CH_FLAG_UHC)
 
#define UDMA_CH_TYPE_TX_MAPPED          (UDMA_CH_FLAG_TX | UDMA_CH_FLAG_PSIL | UDMA_CH_FLAG_MAPPED)
 
#define UDMA_CH_TYPE_RX_MAPPED          (UDMA_CH_FLAG_RX | UDMA_CH_FLAG_PSIL | UDMA_CH_FLAG_MAPPED)
 
#define UDMA_PDMA_ES_8BITS              ((uint32_t) 0x00U)
#define UDMA_PDMA_ES_16BITS             ((uint32_t) 0x01U)
#define UDMA_PDMA_ES_24BITS             ((uint32_t) 0x02U)
#define UDMA_PDMA_ES_32BITS             ((uint32_t) 0x03U)
#define UDMA_PDMA_ES_64BITS             ((uint32_t) 0x04U)
 
#define UDMA_PDMA_ES_DONTCARE           ((uint32_t) 0x00U)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint32_t                chNum;
    uint32_t                peerChNum;
    uint32_t                mappedChGrp;
    void                   *appData;
    Udma_RingPrms           fqRingPrms;
    Udma_RingPrms           cqRingPrms;
    Udma_RingPrms           tdCqRingPrms;
} Udma_ChPrms;
 
typedef struct
{
    uint8_t                 pauseOnError;
    uint8_t                 filterEinfo;
    uint8_t                 filterPsWords;
    uint8_t                 addrType;
    uint8_t                 chanType;
    uint16_t                fetchWordSize;
    uint8_t                 busPriority;
    uint8_t                 busQos;
    uint8_t                 busOrderId;
    uint8_t                 dmaPriority;
    uint8_t                 txCredit;
    uint16_t                fifoDepth;
    uint8_t                 burstSize;
    uint8_t                 supressTdCqPkt;
    uint8_t                  tdType;
} Udma_ChTxPrms;
 
typedef struct
{
    uint8_t                 pauseOnError;
    uint8_t                 addrType;
    uint8_t                 chanType;
    uint16_t                fetchWordSize;
    uint8_t                 busPriority;
    uint8_t                 busQos;
    uint8_t                 busOrderId;
    uint8_t                 dmaPriority;
    uint16_t                flowIdFwRangeStart;
    uint16_t                flowIdFwRangeCnt;
    uint8_t                flowEInfoPresent;
    uint8_t                flowPsInfoPresent;
    uint8_t                flowErrorHandling;
    uint8_t                flowSopOffset;
    uint8_t                 ignoreLongPkts;
    uint32_t                configDefaultFlow;
    uint8_t                 burstSize;
} Udma_ChRxPrms;
 
 
typedef struct
{
    uint32_t                elemSize;
    uint32_t                elemCnt;
    uint32_t                fifoCnt;
    uint8_t burst;
    uint8_t acc32;
    uint8_t eol;
} Udma_ChPdmaPrms;
 
typedef struct
{
    uint32_t                packetCnt;
    uint32_t                completedByteCnt;
    uint32_t                startedByteCnt;
} Udma_ChStats;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t Udma_chOpen(Udma_DrvHandle drvHandle,
                    Udma_ChHandle chHandle,
                    uint32_t chType,
                    const Udma_ChPrms *chPrms);
 
int32_t Udma_chClose(Udma_ChHandle chHandle);
 
int32_t Udma_chConfigTx(Udma_ChHandle chHandle, const Udma_ChTxPrms *txPrms);
 
int32_t Udma_chConfigRx(Udma_ChHandle chHandle, const Udma_ChRxPrms *rxPrms);
 
int32_t Udma_chConfigPdma(Udma_ChHandle chHandle,
                          const Udma_ChPdmaPrms *pdmaPrms);
 
int32_t Udma_chEnable(Udma_ChHandle chHandle);
 
int32_t Udma_chDisable(Udma_ChHandle chHandle, uint32_t timeout);
 
int32_t Udma_chPause(Udma_ChHandle chHandle);
 
int32_t Udma_chResume(Udma_ChHandle chHandle);
 
uint32_t Udma_chGetNum(Udma_ChHandle chHandle);
 
Udma_RingHandle Udma_chGetFqRingHandle(Udma_ChHandle chHandle);
 
Udma_RingHandle Udma_chGetCqRingHandle(Udma_ChHandle chHandle);
 
Udma_RingHandle Udma_chGetTdCqRingHandle(Udma_ChHandle chHandle);
 
uint16_t Udma_chGetFqRingNum(Udma_ChHandle chHandle);
 
uint16_t Udma_chGetCqRingNum(Udma_ChHandle chHandle);
 
Udma_FlowHandle Udma_chGetDefaultFlowHandle(Udma_ChHandle chHandle);
 
void *Udma_chGetSwTriggerRegister(Udma_ChHandle chHandle);
 
int32_t Udma_chSetSwTrigger(Udma_ChHandle chHandle, uint32_t trigger);
 
int32_t Udma_chSetChaining(Udma_ChHandle triggerChHandle,
                           Udma_ChHandle chainedChHandle,
                           uint32_t trigger);
 
int32_t Udma_chBreakChaining(Udma_ChHandle triggerChHandle,
                             Udma_ChHandle chainedChHandle);
 
/*
 * Structure Init functions
 */
void UdmaChPrms_init(Udma_ChPrms *chPrms, uint32_t chType);
 
void UdmaChTxPrms_init(Udma_ChTxPrms *txPrms, uint32_t chType);
 
void UdmaChRxPrms_init(Udma_ChRxPrms *rxPrms, uint32_t chType);
 
int32_t Udma_chRingQueueRaw(Udma_ChHandle chHandle, uint8_t *phyDescMem,
                            uint64_t noEleCnt);
 
int32_t Udma_chRingRingDbRaw(Udma_ChHandle chHandle, uint64_t noOfEntries);
 
int32_t Udma_chRingDeQueueRaw(Udma_ChHandle chHandle, uint64_t noElem,
                                uint64_t *eleInRing);
 
int32_t Udma_chRingRingRvrDbRaw(Udma_ChHandle chHandle, uint64_t noOfEntries);
 
void UdmaChPdmaPrms_init(Udma_ChPdmaPrms *pdmaPrms);
 
int32_t Udma_chGetStats(Udma_ChHandle chHandle, Udma_ChStats *chStats);
 
int32_t Udma_getPeerData(Udma_ChHandle chHandle, uint32_t *peerData);
 
int32_t Udma_clearPeerData(Udma_ChHandle chHandle, uint32_t peerData);
 
int32_t Udma_chReset(Udma_ChHandle chHandle);
 
int32_t Udma_TeardownChan(Udma_ChHandle chHandle);
 
int32_t Udma_chGetChanEnStatus(Udma_ChHandle chHandle, uint8_t *chEnableStat);
 
int32_t Udma_chDecStats(Udma_ChHandle chHandle, Udma_ChStats *chStats);
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
typedef struct Udma_ChObject_t
{
    uintptr_t rsv[178U];
} Udma_ChObject;
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef UDMA_CH_H_ */