udma_ring.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_RING_H_
#define UDMA_RING_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define UDMA_RING_INVALID               ((uint16_t) (0xFFFFu))
 
#define UDMA_RING_ANY                   ((uint16_t) 0xFFFEU)
 
#define UDMA_RING_VIRTID_INVALID        ((uint16_t) 0xFFFFU)
 
#define UDMA_RING_SIZE_CHECK_SKIP       (0xABDCABCDU)
 
#define UDMA_RING_ORDERID_MAX           (0x0FU)
 
#define UDMA_RING_MODE_CREDENTIALS (0x2u)
 
#define UDMA_RING_MODE_QM        (0x3u)
 
#define UDMA_RING_ES_4BYTES             ((uint8_t) 0x00U)
 
#define UDMA_RING_ES_8BYTES             ((uint8_t) 0x01U)
 
#define UDMA_RING_ES_16BYTES            ((uint8_t) 0x02U)
 
#define UDMA_RING_ES_32BYTES            ((uint8_t) 0x03U)
 
#define UDMA_RING_ES_64BYTES            ((uint8_t) 0x04U)
 
#define UDMA_RING_ES_128BYTES           ((uint8_t) 0x05U)
 
#define UDMA_RING_ES_256BYTES           ((uint8_t) 0x06U)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    void                   *ringMem;
    uint32_t                ringMemSize;
    uint8_t                 mode;
    uint16_t                virtId;
    uint32_t                elemCnt;
    uint8_t                 elemSize;
    uint8_t                 orderId;
    uint8_t                 asel;
    uint32_t                mappedRingGrp;
    uint32_t                mappedChNum;
    uint64_t                currWrLoc;
    uint64_t                currRdLoc;
} Udma_RingPrms;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t Udma_ringAlloc(Udma_DrvHandle drvHandle,
                       Udma_RingHandle ringHandle,
                       uint16_t ringNum,
                       const Udma_RingPrms *ringPrms);
 
int32_t Udma_ringFree(Udma_RingHandle ringHandle);
 
int32_t Udma_ringAttach(Udma_DrvHandle drvHandle,
                        Udma_RingHandle ringHandle,
                        uint16_t ringNum);
 
int32_t Udma_ringDetach(Udma_RingHandle ringHandle);
 
int32_t Udma_ringQueueRaw(Udma_RingHandle ringHandle, uint64_t phyDescMem);
 
int32_t Udma_ringDequeueRaw(Udma_RingHandle ringHandle, uint64_t *phyDescMem);
 
int32_t Udma_ringFlushRaw(Udma_RingHandle ringHandle, uint64_t *phyDescMem);
 
void Udma_ringPrime(Udma_RingHandle ringHandle, uint64_t phyDescMem);
 
void Udma_ringPrimeRead(Udma_RingHandle ringHandle, uint64_t *phyDescMem);
 
void Udma_ringSetDoorBell(Udma_RingHandle ringHandle, int32_t count);
 
uint16_t Udma_ringGetNum(Udma_RingHandle ringHandle);
 
void *Udma_ringGetMemPtr(Udma_RingHandle ringHandle);
 
uint32_t Udma_ringGetMode(Udma_RingHandle ringHandle);
 
uint32_t Udma_ringGetElementCnt(Udma_RingHandle ringHandle);
 
uint32_t Udma_ringGetForwardRingOcc(Udma_RingHandle ringHandle);
 
uint32_t Udma_ringGetReverseRingOcc(Udma_RingHandle ringHandle);
 
uint32_t Udma_ringGetWrIdx(Udma_RingHandle ringHandle);
 
uint32_t Udma_ringGetRdIdx(Udma_RingHandle ringHandle);
 
/*
 * Structure Init functions
 */
void UdmaRingPrms_init(Udma_RingPrms *ringPrms);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
typedef struct Udma_RingObject_t
{
    uintptr_t rsv[30U];
} Udma_RingObject;
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef UDMA_RING_H_ */