enet_osal.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2020
 *
 *  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 ENET_OSAL_H_
#define ENET_OSAL_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

#include <stdint.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */

typedef uintptr_t (*EnetOsal_DisableAllIntr)(void);

typedef void (*EnetOsal_RestoreAllIntr)(uintptr_t cookie);

typedef void (*EnetOsal_RestoreIntr)(uint32_t coreIntrNum);

typedef void (*EnetOsal_DisableIntr)(uint32_t coreIntrNum);

typedef void (*EnetOsal_Isr)(uintptr_t arg);

typedef void *(*EnetOsal_RegisterIntr)(EnetOsal_Isr isrFxn,
                                       uint32_t coreIntrNum,
                                       uint32_t intrPriority,
                                       uint32_t triggerType,
                                       void *arg);

typedef void (*EnetOsal_UnregisterIntr)(void *hHwi);

typedef void *(*EnetOsal_CreateMutex)(void);

typedef void (*EnetOsal_DeleteMutex)(void *hMutex);

typedef void (*EnetOsal_LockMutex)(void *hMutex);

typedef void (*EnetOsal_UnlockMutex)(void *hMutex);

typedef bool (*EnetOsal_IsCacheCoherent)(void);

typedef void (*EnetOsal_CacheInv)(const void *addr,
                                  int32_t size);

typedef void (*EnetOsal_CacheWb)(const void *addr,
                                 int32_t size);

typedef void (*EnetOsal_CacheWbInv)(const void *addr,
                                    int32_t size);

typedef uint32_t (*EnetOsal_TimerRead)(void);

typedef struct EnetOsal_Cfg_s
{
    EnetOsal_DisableAllIntr disableAllIntr;

    EnetOsal_RestoreAllIntr restoreAllIntr;

    EnetOsal_DisableIntr disableIntr;

    EnetOsal_RestoreIntr restoreIntr;

    EnetOsal_RegisterIntr registerIntr;

    EnetOsal_UnregisterIntr unregisterIntr;

    EnetOsal_CreateMutex createMutex;

    EnetOsal_DeleteMutex deleteMutex;

    EnetOsal_LockMutex lockMutex;

    EnetOsal_UnlockMutex unlockMutex;

    EnetOsal_IsCacheCoherent isCacheCoherent;

    EnetOsal_CacheInv cacheInv;

    EnetOsal_CacheWb cacheWb;

    EnetOsal_CacheWbInv cacheWbInv;

    EnetOsal_TimerRead timerRead;
} EnetOsal_Cfg;

/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

void EnetOsal_init(const EnetOsal_Cfg *cfg);

void EnetOsal_deinit(void);

uintptr_t EnetOsal_disableAllIntr(void);

void EnetOsal_restoreAllIntr(uintptr_t cookie);

void *EnetOsal_registerIntr(EnetOsal_Isr isrFxn,
                            uint32_t coreIntrNum,
                            uint32_t intrPriority,
                            uint32_t intrTrigType,
                            void *arg);

void EnetOsal_unregisterIntr(void *hHwi);

void EnetOsal_enableIntr(uint32_t coreIntrNum);

void EnetOsal_disableIntr(uint32_t coreIntrNum);

void *EnetOsal_createMutex(void);

void EnetOsal_deleteMutex(void *hMutex);

void EnetOsal_lockMutex(void *hMutex);

void EnetOsal_unlockMutex(void *hMutex);

void EnetOsal_cacheInv(const void *addr,
                           int32_t size);

void EnetOsal_cacheWb(const void *addr,
                          int32_t size);

void EnetOsal_cacheWbInv(const void *addr,
                             int32_t size);

uint32_t EnetOsal_timerGetDiff(uint32_t startTime);

uint32_t EnetOsal_timerRead(void);

/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */

/* None */

#ifdef __cplusplus
}
#endif

#endif /* ENET_OSAL_H_ */