udma_rm.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2021 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_RM_H_
#define UDMA_RM_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define UDMA_RM_RES_ID_INVALID          ((uint32_t) 0xFFFF0005U)
 
#define UDMA_RM_SHARED_RES_CNT_MIN      ((uint32_t) 0xFFFF0006U)
 
#define UDMA_RM_SHARED_RES_CNT_REST     ((uint32_t) 0xFFFF0007U)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint32_t                startBlkCopyUhcCh;
    uint32_t                numBlkCopyUhcCh;
    uint32_t                startBlkCopyHcCh;
    uint32_t                numBlkCopyHcCh;
    uint32_t                startBlkCopyCh;
    uint32_t                numBlkCopyCh;
    uint32_t                startTxUhcCh;
    uint32_t                numTxUhcCh;
    uint32_t                startTxHcCh;
    uint32_t                numTxHcCh;
    uint32_t                startTxCh;
    uint32_t                numTxCh;
    uint32_t                startRxUhcCh;
    uint32_t                numRxUhcCh;
    uint32_t                startRxHcCh;
    uint32_t                numRxHcCh;
    uint32_t                startRxCh;
    uint32_t                numRxCh;
#if (UDMA_NUM_MAPPED_TX_GROUP > 0)
    uint32_t                startMappedTxCh[UDMA_NUM_MAPPED_TX_GROUP];
    uint32_t                numMappedTxCh[UDMA_NUM_MAPPED_TX_GROUP];
#endif
 
#if (UDMA_NUM_MAPPED_RX_GROUP > 0)
    uint32_t                startMappedRxCh[UDMA_NUM_MAPPED_RX_GROUP];
    uint32_t                numMappedRxCh[UDMA_NUM_MAPPED_RX_GROUP];
#endif
 
#if ((UDMA_NUM_MAPPED_TX_GROUP + UDMA_NUM_MAPPED_RX_GROUP) > 0)
    uint32_t                startMappedRing[UDMA_NUM_MAPPED_TX_GROUP + UDMA_NUM_MAPPED_RX_GROUP];
    uint32_t                numMappedRing[UDMA_NUM_MAPPED_TX_GROUP + UDMA_NUM_MAPPED_RX_GROUP];
#endif
 
    uint32_t                startFreeFlow;
    uint32_t                numFreeFlow;
    uint32_t                startFreeRing;
    uint32_t                numFreeRing;
    uint32_t                startGlobalEvent;
    uint32_t                numGlobalEvent;
    uint32_t                startVintr;
    uint32_t                numVintr;
    uint32_t                startIrIntr;
    uint32_t                numIrIntr;
    uint32_t                proxyThreadNum;
    uint32_t                startProxy;
    uint32_t                numProxy;
    uint32_t                startRingMon;
    uint32_t                numRingMon;
} Udma_RmInitPrms;
 
typedef struct
{
    uint32_t                resId;
    uint32_t                startResrvCnt;
    uint32_t                endResrvCnt;
    uint32_t                numInst;
    uint32_t                minReq;
    uint32_t                instShare[UDMA_RM_SHARED_RES_MAX_INST];
} Udma_RmSharedResPrms;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
Udma_RmSharedResPrms *Udma_rmGetSharedResPrms(uint32_t resId);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef UDMA_RM_H_ */