sdl_dpl.h

Go to the documentation of this file.

/* Copyright (C) 2022 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 SDL_DPL_H_
#define SDL_DPL_H_
 
#include <stdint.h>
#include <sdl/include/sdl_types.h>
 
/* Data Structures and Types */
 
typedef void (*pSDL_DPL_InterruptCallbackFunction)(void *arg);
 
typedef struct SDL_DPL_HwipParams_s
{
    int32_t intNum;
    pSDL_DPL_InterruptCallbackFunction callback;
    uintptr_t callbackArg;
} SDL_DPL_HwipParams;
 
typedef void* pSDL_DPL_HwipHandle;
 
typedef int32_t (*pSDL_DPL_InterruptFunction)(int32_t intNum);
 
typedef pSDL_DPL_HwipHandle (*pSDL_DPL_RegisterFunction)(SDL_DPL_HwipParams *pParams);
 
typedef int32_t (*pSDL_DPL_DeregisterFunction)(pSDL_DPL_HwipHandle handle);
 
typedef int32_t (*pSDL_DPL_DelayFunction)(int32_t ndelay);
 
typedef void* (*pSDL_DPL_AddrTranslateFunction)(uint64_t addr, uint32_t size);
 
typedef int32_t (*pSDL_DPL_globalDisableInterruptsFunction)(uintptr_t *key);
 
typedef int32_t (*pSDL_DPL_globalRestoreInterruptsFunction)(uintptr_t key);
 
typedef struct SDL_DPL_Interface_s
{
    pSDL_DPL_InterruptFunction enableInterrupt;
    pSDL_DPL_InterruptFunction disableInterrupt;
    pSDL_DPL_RegisterFunction registerInterrupt;
    pSDL_DPL_DeregisterFunction deregisterInterrupt;
    pSDL_DPL_DelayFunction delay;
    pSDL_DPL_globalDisableInterruptsFunction globalDisableInterrupts;
    pSDL_DPL_globalRestoreInterruptsFunction globalRestoreInterrupts;
    pSDL_DPL_AddrTranslateFunction addrTranslate;
} SDL_DPL_Interface;
 
/* Functions */
 
int32_t SDL_DPL_init(SDL_DPL_Interface *dplInterface);
 
int32_t SDL_DPL_enableInterrupt(int32_t intNum);
 
int32_t SDL_DPL_disableInterrupt(int32_t intNum);
 
int32_t SDL_DPL_registerInterrupt(SDL_DPL_HwipParams *pParams, pSDL_DPL_HwipHandle *handle);
 
int32_t SDL_DPL_deregisterInterrupt(pSDL_DPL_HwipHandle handle);
 
int32_t SDL_DPL_delay(int32_t ndelay);
 
void *SDL_DPL_addrTranslate(uint64_t addr, uint32_t size);
 
int32_t SDL_DPL_globalDisableInterrupts(uintptr_t *key);
 
int32_t SDL_DPL_globalRestoreInterrupts(uintptr_t key);
 
#endif /* SDL_DPL_H_ */