osal.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2021 T2 Software, Inc. All rights reserved.
 *
 * SPDX-License-Identifier: LicenseRef-T2-LC3
 */
 
#ifndef __OSAL_H__
#define __OSAL_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "stddef.h"
#include "osal_types.h"
 
#define OSAL_STATUS_SUCCESS               ( 0)
#define OSAL_STATUS_INVALID_PARAMETER     (-1)
#define OSAL_STATUS_OUT_OF_MEMORY         (-2)
#define OSAL_STATUS_INTERNAL_ERROR        (-3)
 
#define OSAL_TIMEOUT_INFINITE                (0xFFFFFFFF)
 
typedef void *OSAL_Mutex_t;
 
typedef void *OSAL_Timer_t;
 
typedef void *OSAL_Thread_t;
 
typedef void *OSAL_Event_t;
 
typedef enum
{
   OSAL_TIMER_PERIODIC,
   OSAL_TIMER_ONE_SHOT
} OSAL_Timer_Type_t;
 
typedef void(*OSAL_Timer_Function_t)(OSAL_Timer_t TimerHandle, void *CallbackData);
 
typedef void(*OSAL_Thread_Function_t)(OSAL_Thread_t ThreadHandle, void *Data);
 
void *OSAL_Malloc(size_t Size);
 
void OSAL_Free(void *Ptr);
 
void *OSAL_Memset(void *Ptr, int Value, size_t Num);
 
void *OSAL_Memcpy(void *Dst, const void *Src, size_t Num);
 
int OSAL_Memcmp(const void *Ptr1, const void *Ptr2, size_t Num);
 
OSAL_Mutex_t OSAL_Create_Mutex(bool_t Owned);
 
void OSAL_Close_Mutex(OSAL_Mutex_t Mutex);
 
bool_t OSAL_Wait_Mutex(OSAL_Mutex_t Mutex, unsigned long Timeout);
 
void OSAL_Release_Mutex(OSAL_Mutex_t Mutex);
 
OSAL_Timer_t OSAL_Create_Timer(uint32_t Delay, bool_t Start, OSAL_Timer_Type_t Type, OSAL_Timer_Function_t TimerFunction, void *Data);
 
int OSAL_Start_Timer(OSAL_Timer_t Timer);
 
void OSAL_Close_Timer(OSAL_Timer_t Timer);
 
OSAL_Thread_t OSAL_Create_Thread(uint32_t StackSize, OSAL_Thread_Function_t ThreadFunction, void *Data);
 
OSAL_Event_t OSAL_Create_Event(void);
 
int OSAL_Wait_Event(OSAL_Event_t Event, uint32_t Flags, uint32_t *FlagsSet, bool_t Reset, int Timeout);
 
int OSAL_Set_Event(OSAL_Event_t Event, uint32_t Flags);
 
int OSAL_Reset_Event(OSAL_Event_t Event, uint32_t Flags);
 
void OSAL_Close_Event(OSAL_Event_t Event);
 
void OSAL_OutputMessage(const char *DebugString, ...);
 
void OSAL_OutputMessageInit(char *bufPtr, uint16_t size);
 
void OSAL_OutputMessageFlush(void);
 
int OSAL_DumpData(unsigned int dataLength, const unsigned char *dataPtr, int size);
 
#if defined LC3_CYCLES_PER_BLOCK && __arc__
void OSAL_CycleCountStart(uint8_t blockNumber);
 
void OSAL_CycleCountEnd(uint8_t blockNumber);
#endif
 
 
#ifdef __cplusplus
};
#endif
 
#endif // __OSAL_H__