pal_rtos.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// Copyright 2016-2019 ARM Ltd.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------------------------------------------------------

#ifndef _PAL_RTOS_H
#define _PAL_RTOS_H

#ifndef _PAL_H
    #error "Please do not include this file directly, use pal.h instead"
#endif

#include <stdint.h>
#include <string.h> //memcpy


#ifdef __cplusplus
extern "C" {
#endif

#include "pal.h" //added for PAL_INITIAL_RANDOM_SIZE value

#define PAL_TICK_TO_MILLI_FACTOR 1000

typedef uintptr_t palThreadID_t;
typedef uintptr_t palTimerID_t;
typedef uintptr_t palMutexID_t;
typedef uintptr_t palSemaphoreID_t;
typedef uintptr_t palMemoryPoolID_t;
typedef uintptr_t palMessageQID_t;

typedef enum  palTimerType {
    palOsTimerOnce = 0, 
    palOsTimerPeriodic = 1 
} palTimerType_t;


typedef void(*palTimerFuncPtr)(void const *funcArgument);

typedef void(*palThreadFuncPtr)(void const *funcArgument);

typedef enum pal_osPriority {
    PAL_osPriorityFirst = 0,
    PAL_osPriorityIdle = PAL_osPriorityFirst,
    PAL_osPriorityLow = 1,
    PAL_osPriorityReservedTRNG = 2,
    PAL_osPriorityBelowNormal = 3,
    PAL_osPriorityNormal = 4,
    PAL_osPriorityAboveNormal = 5,
    PAL_osPriorityReservedDNS = 6, 
    PAL_osPriorityReservedSockets = 7, 
    PAL_osPriorityHigh = 8,
    PAL_osPriorityReservedHighResTimer = 9, 
    PAL_osPriorityRealtime = 10,
    PAL_osPrioritylast = PAL_osPriorityRealtime,
    PAL_osPriorityError = 0x84
} palThreadPriority_t; 
typedef struct pal_threadLocalStore{
    void* storeData;
} palThreadLocalStore_t;

typedef struct pal_timeVal{
    int32_t    pal_tv_sec;      
    int32_t    pal_tv_usec;     
} pal_timeVal_t;


//------- system general functions
void pal_osReboot(void);

//------- system tick functions
uint64_t pal_osKernelSysTick(void);


uint64_t pal_osKernelSysTickMicroSec(uint64_t microseconds);

uint64_t pal_osKernelSysMilliSecTick(uint64_t sysTicks);

uint64_t pal_osKernelSysTickFrequency(void);

palStatus_t pal_osThreadCreateWithAlloc(palThreadFuncPtr function, void* funcArgument, palThreadPriority_t priority, uint32_t stackSize, palThreadLocalStore_t* store, palThreadID_t* threadID);

palStatus_t pal_osThreadTerminate(palThreadID_t* threadID);

palThreadID_t pal_osThreadGetId(void);

palStatus_t pal_osDelay(uint32_t milliseconds);

palStatus_t pal_osTimerCreate(palTimerFuncPtr function, void* funcArgument, palTimerType_t timerType, palTimerID_t* timerID);

palStatus_t pal_osTimerStart(palTimerID_t timerID, uint32_t millisec);

palStatus_t pal_osTimerStop(palTimerID_t timerID);

palStatus_t pal_osTimerDelete(palTimerID_t* timerID);

palStatus_t pal_osMutexCreate(palMutexID_t* mutexID);

palStatus_t pal_osMutexWait(palMutexID_t mutexID, uint32_t millisec);

palStatus_t pal_osMutexRelease(palMutexID_t mutexID);

palStatus_t pal_osMutexDelete(palMutexID_t* mutexID);

palStatus_t pal_osSemaphoreCreate(uint32_t count, palSemaphoreID_t* semaphoreID);

palStatus_t pal_osSemaphoreWait(palSemaphoreID_t semaphoreID, uint32_t millisec, int32_t* countersAvailable);

palStatus_t pal_osSemaphoreRelease(palSemaphoreID_t semaphoreID);

palStatus_t pal_osSemaphoreDelete(palSemaphoreID_t* semaphoreID);

int32_t pal_osAtomicIncrement(int32_t* valuePtr, int32_t increment);

palStatus_t pal_RTOSInitialize(void* opaqueContext);


palStatus_t pal_RTOSDestroy(void);



#ifdef __cplusplus
}
#endif
#endif //_PAL_RTOS_H