udma_event.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_EVENT_H_
#define UDMA_EVENT_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define UDMA_EVENT_INVALID              ((uint32_t) 0xFFFFU)
 
#define UDMA_INTR_INVALID               ((uint32_t) 0xFFFF0000U)
 
#define UDMA_CORE_INTR_ANY              ((uint32_t) 0xFFFF0001U)
 
#define UDMA_MAX_EVENTS_PER_VINTR       (64U)
 
#define UDMA_EVENT_TYPE_DMA_COMPLETION          ((uint32_t) 0x0001U)
 
#define UDMA_EVENT_TYPE_TEARDOWN_PACKET         ((uint32_t) 0x0002U)
 
#define UDMA_EVENT_TYPE_TR                      ((uint32_t) 0x0003U)
 
#define UDMA_EVENT_TYPE_RING                    ((uint32_t) 0x0004U)
 
#define UDMA_EVENT_TYPE_MASTER                  ((uint32_t) 0x0005U)
 
#define UDMA_EVENT_TYPE_TEARDOWN_COMPLETION         ((uint32_t) 0x0006U)
 
#define UDMA_EVENT_TYPE_ERR_OUT_OF_RANGE_FLOW   ((uint32_t) 0x0006U)
 
#define UDMA_EVENT_TYPE_RING_MON                ((uint32_t) 0x0007U)
 
#define UDMA_EVENT_MODE_EXCLUSIVE       ((uint32_t) 0x0001U)
 
#define UDMA_EVENT_MODE_SHARED          ((uint32_t) 0x0002U)
 
typedef void (*Udma_EventCallback)(Udma_EventHandle eventHandle,
                                   uint32_t eventType,
                                   void *appData);
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint32_t                eventType;
    uint32_t                eventMode;
    Udma_ChHandle           chHandle;
    Udma_RingHandle         ringHandle;
    Udma_EventHandle        controllerEventHandle;
    Udma_EventCallback      eventCb;
    uint32_t                intrPriority;
    void                   *appData;
    uint32_t                preferredCoreIntrNum;
    #if (UDMA_SOC_CFG_RING_MON_PRESENT == 1)
    Udma_RingMonHandle      monHandle;
    #endif
    /*
     * Output parameters
     */
    volatile uint64_t      *intrStatusReg;
    volatile uint64_t      *intrClearReg;
    uint64_t                intrMask;
    uint32_t                vintrNum;
    uint32_t                coreIntrNum;
} Udma_EventPrms;
 
typedef struct
{
    uint32_t    isException;
    uint32_t    flowId;
    uint32_t    chNum;
} Udma_EventRxFlowIdFwStatus;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t Udma_eventRegister(Udma_DrvHandle drvHandle,
                           Udma_EventHandle eventHandle,
                           Udma_EventPrms *eventPrms);
 
int32_t Udma_eventUnRegister(Udma_EventHandle eventHandle);
 
uint32_t Udma_eventGetId(Udma_EventHandle eventHandle);
 
int32_t Udma_eventDisable(Udma_EventHandle eventHandle);
 
int32_t Udma_eventEnable(Udma_EventHandle eventHandle);
 
Udma_EventHandle Udma_eventGetGlobalHandle(Udma_DrvHandle drvHandle);
 
/*
 * Structure Init functions
 */
void UdmaEventPrms_init(Udma_EventPrms *eventPrms);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
typedef struct Udma_EventObject_t
{
    uintptr_t rsv[40U];
} Udma_EventObject;
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef UDMA_EVENT_H_ */