ptxOsal.h

Go to the documentation of this file.

 
#ifndef PTX_OSAL_H
#define PTX_OSAL_H
 
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptx_Status.h"
#include <stdlib.h>
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
 
struct ptxOsal;
 
struct ptxTimer;
 
struct ptxThread;
/* polyspace:begin<MISRA-C3:5.7 : Not a defect : No action planned > Forward declaration. */
/* polyspace:begin<MISRA-C3:1.3 : Not a defect : No action planned > Don't spread other defs via this header file. */
typedef struct ptxMutex* ptxMutex_t;
 
typedef struct ptxSemaphore* ptxSemaphore_t;
/* polyspace:end<MISRA-C3:1.3:Not a defect:No action planned> Don't spread other defs via this header file. */
/* polyspace:end<MISRA-C3:5.7:Not a defect:No action planned> Forward declaration. */
 
typedef uint64_t ptxTimeDiff_t;
 
typedef void (*pptxOsal_ThreadProc_t)(void *threadParam);
 
typedef void (*pptxOsal_TimerProc_t)(void *timerParam);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / ADMINISTRATIVE
 * ####################################################################################################################
 */
 
ptxStatus_t ptxOsal_AllocInit(struct ptxOsal **osalCtx, void *sysCtx);
 
void ptxOsal_DeInit(struct ptxOsal *osalCtx);
 
void ptxOsal_DeAlloc(struct ptxOsal **osalCtx);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / MEMORY HANDLING
 * ####################################################################################################################
 */
 
void *ptxOsal_Allocate(struct ptxOsal *osalCtx, size_t allocSize);
 
void *ptxOsal_JustAllocate(size_t allocSize);
 
void ptxOsal_Free(struct ptxOsal *osalCtx, void *memToFree);
 
void ptxOsal_FreeNull(struct ptxOsal *osalCtx, void **memToFree);
 
void *ptxOsal_Allocate_NoTrack(struct ptxOsal *osalCtx, size_t allocSize);
 
void ptxOsal_Free_NoTrack(struct ptxOsal *osalCtx, void *memToFree);
 
void ptxOsal_JustFree(void *memToFree, uint32_t *sentryViolationCount);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / SEMAPHORES
 * ####################################################################################################################
 */
 
ptxStatus_t ptxOsal_SemInit(struct ptxOsal *osalCtx, ptxSemaphore_t *hSem, uint32_t initialCount, uint32_t maxCount);
 
ptxStatus_t ptxOsal_SemClose(struct ptxOsal *osalCtx, ptxSemaphore_t *hSem);
 
ptxStatus_t ptxOsal_SemPost(struct ptxOsal *osalCtx, ptxSemaphore_t *hSem);
 
ptxStatus_t ptxOsal_SemWait(struct ptxOsal *osalCtx, ptxSemaphore_t *hSem);
 
ptxStatus_t ptxOsal_SemTimedWait(struct ptxOsal *osalCtx, ptxSemaphore_t *hSem, uint32_t msTimeout);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / MUTEXES
 * ####################################################################################################################
 */
 
ptxStatus_t ptxOsal_MutexInit(struct ptxOsal *osalCtx, ptxMutex_t *hMutex);
 
ptxStatus_t ptxOsal_MutexDestroy(struct ptxOsal *osalCtx, ptxMutex_t *hMutex);
 
ptxStatus_t ptxOsal_MutexLock(struct ptxOsal *osalCtx, ptxMutex_t *hMutex);
 
ptxStatus_t ptxOsal_MutexUnlock(struct ptxOsal *osalCtx, ptxMutex_t *hMutex);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / THREADS
 * ####################################################################################################################
 */
 
struct ptxThread *ptxOsal_ThreadAllocate(struct ptxOsal *osalCtx);
 
ptxStatus_t ptxOsal_ThreadCreate(struct ptxOsal *osalCtx, struct ptxThread *hThd, pptxOsal_ThreadProc_t thdFn, void *thdParam);
 
ptxStatus_t ptxOsal_ThreadJoin(struct ptxOsal *osalCtx, struct ptxThread *hThd);
 
ptxStatus_t ptxOsal_ThreadClose(struct ptxOsal *osalCtx, struct ptxThread *hThd);
 
void ptxOsal_ThreadSleep(struct ptxOsal *osalCtx, uint32_t msSleep);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / TIMERS
 * ####################################################################################################################
 */
 
struct ptxTimer *ptxOsal_TimerAllocate(struct ptxOsal *osalCtx);
 
ptxStatus_t ptxOsal_TimerCreate(struct ptxOsal *osalCtx, struct ptxTimer *hTimer, pptxOsal_TimerProc_t timerProc, void *timerParam);
 
ptxStatus_t ptxOsal_TimerStart(struct ptxOsal *osalCtx, struct ptxTimer *hTimer, uint32_t msInterval);
 
ptxStatus_t ptxOsal_TimerCancel(struct ptxOsal *osalCtx, struct ptxTimer *hTimer);
 
ptxStatus_t ptxOsal_TimerClose(struct ptxOsal *osalCtx, struct ptxTimer *hTimer);
 
ptxStatus_t ptxOsal_StopwatchStart(struct ptxOsal *osalCtx, ptxTimeDiff_t *startVal);
 
ptxStatus_t ptxOsal_StopwatchStop(struct ptxOsal *osalCtx, ptxTimeDiff_t *startStopVal);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / SYSTEM CONTEXT
 * ####################################################################################################################
 */
 
void *ptxOsal_GetSysCtx(struct ptxOsal *osalCtx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */