sdl_osal.h

Go to the documentation of this file.

/* Copyright (C) 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 SDL_OSAL_H_
#define SDL_OSAL_H_

#include <stdint.h>
#include "sdl_types.h"

// Data Structures and Types

typedef void (*pSDL_OSAL_interruptCallbackFunction)(uintptr_t arg);

typedef struct SDL_OSAL_hwipParams_s
{
    int32_t intNum;
    pSDL_OSAL_interruptCallbackFunction callback;
    uintptr_t callbackArg;
} SDL_OSAL_hwipParams;

typedef void* pSDL_OSAL_hwipHandle;

typedef int32_t (*pSDL_OSAL_interruptFunction)(int32_t intNum);

typedef pSDL_OSAL_hwipHandle (*pSDL_OSAL_registerFunction)(SDL_OSAL_hwipParams *pParams);

typedef int32_t (*pSDL_OSAL_deregisterFunction)(pSDL_OSAL_hwipHandle handle);

typedef int32_t (*pSDL_OSAL_globalDisableInterruptsFunction)(uintptr_t *key);

typedef int32_t (*pSDL_OSAL_globalRestoreInterruptsFunction)(uintptr_t key);

typedef void (*pSDL_OSAL_printFunction)(const char *traceBuf);

typedef int32_t (*pSDL_OSAL_delayFunction)(int32_t ndelay);

typedef void* (*pSDL_OSAL_addrTranslateFunction)(uint64_t addr, uint32_t size);

typedef struct SDL_OSAL_Interface_s
{
    pSDL_OSAL_interruptFunction enableInterrupt;
    pSDL_OSAL_interruptFunction disableInterrupt;
    pSDL_OSAL_registerFunction registerInterrupt;
    pSDL_OSAL_deregisterFunction deregisterInterrupt;
    pSDL_OSAL_globalDisableInterruptsFunction globalDisableInterrupts;
    pSDL_OSAL_globalRestoreInterruptsFunction globalRestoreInterrupts;
    pSDL_OSAL_printFunction printFxn;
    pSDL_OSAL_delayFunction delay;
    pSDL_OSAL_addrTranslateFunction addrTranslate;
} SDL_OSAL_Interface;

// Functions

int32_t SDL_OSAL_init(SDL_OSAL_Interface *osalInterface);

int32_t SDL_OSAL_enableInterrupt(int32_t intNum);

int32_t SDL_OSAL_disableInterrupt(int32_t intNum);

int32_t SDL_OSAL_registerInterrupt(SDL_OSAL_hwipParams *pParams, pSDL_OSAL_hwipHandle *handle);

int32_t SDL_OSAL_deregisterInterrupt(pSDL_OSAL_hwipHandle handle);

int32_t SDL_OSAL_globalDisableInterrupts(uintptr_t *key);

int32_t SDL_OSAL_globalRestoreInterrupts(uintptr_t key);

void SDL_OSAL_printf(const char *traceBuf);

int32_t SDL_OSAL_delay(int32_t ndelay);

void *SDL_OSAL_addrTranslate(uint64_t addr, uint32_t size);

#endif /* SDL_OSAL_H_ */