#include "ptx_Status.h"
#include <stdlib.h>

Include dependency graph for ptxOsal.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef struct ptxMutex *	ptxMutex_t
	Mutex Wrapper Structure - Forward Declaration.

typedef struct ptxSemaphore *	ptxSemaphore_t
	Semaphore Wrapper Structure - Forward Declaration.

typedef uint64_t	ptxTimeDiff_t
	Time difference type.

typedef void(*	pptxOsal_ThreadProc_t) (void *threadParam)
	Thread procedure function pointer declaration.

typedef void(*	pptxOsal_TimerProc_t) (void *timerParam)
	Timer procedure function pointer declaration.

Functions
ptxStatus_t	ptxOsal_AllocInit (struct ptxOsal *osalCtx, void sysCtx)
	Initialize the OSAL.

void	ptxOsal_DeInit (struct ptxOsal *osalCtx)
	Un-Initialize the OSAL.

void	ptxOsal_DeAlloc (struct ptxOsal **osalCtx)
	De-Allocate the OSAL.

void *	ptxOsal_Allocate (struct ptxOsal *osalCtx, size_t allocSize)
	Allocate memory. Track memory usage.

void *	ptxOsal_JustAllocate (size_t allocSize)
	Allocate memory. Do not track memory usage. Does not need an instance of OSAL.

void	ptxOsal_Free (struct ptxOsal osalCtx, void memToFree)
	Free memory, allocated by ptxOsal_Allocate.

void	ptxOsal_FreeNull (struct ptxOsal osalCtx, void *memToFree)
	Free memory, allocated by ptxOsal_Allocate and set the pointer to NULL.

void *	ptxOsal_Allocate_NoTrack (struct ptxOsal *osalCtx, size_t allocSize)
	Allocate memory. Do not track memory usage.

void	ptxOsal_Free_NoTrack (struct ptxOsal osalCtx, void memToFree)
	Free memory, allocated by ptxOsal_Allocate_NoTrack.

void	ptxOsal_JustFree (void memToFree, uint32_t sentryViolationCount)
	Free memory, allocated by ptxOsal_JustAllocate.

ptxStatus_t	ptxOsal_SemInit (struct ptxOsal osalCtx, ptxSemaphore_t hSem, uint32_t initialCount, uint32_t maxCount)
	Initialize an already allocated but non-initialized object.

ptxStatus_t	ptxOsal_SemClose (struct ptxOsal osalCtx, ptxSemaphore_t hSem)
	Close an initialized semaphore object.

ptxStatus_t	ptxOsal_SemPost (struct ptxOsal osalCtx, ptxSemaphore_t hSem)
	Signal a semaphore, unblock a waiting thread.

ptxStatus_t	ptxOsal_SemWait (struct ptxOsal osalCtx, ptxSemaphore_t hSem)
	Wait on the semaphore.

ptxStatus_t	ptxOsal_SemTimedWait (struct ptxOsal osalCtx, ptxSemaphore_t hSem, uint32_t msTimeout)
	Wait on the semaphore, with timeout.

ptxStatus_t	ptxOsal_MutexInit (struct ptxOsal osalCtx, ptxMutex_t hMutex)
	Initialize a Mutex.

ptxStatus_t	ptxOsal_MutexDestroy (struct ptxOsal osalCtx, ptxMutex_t hMutex)
	Remove a Mutex.

ptxStatus_t	ptxOsal_MutexLock (struct ptxOsal osalCtx, ptxMutex_t hMutex)
	Lock/acquire a Mutex.

ptxStatus_t	ptxOsal_MutexUnlock (struct ptxOsal osalCtx, ptxMutex_t hMutex)
	Unlock/release a Mutex.

struct ptxThread *	ptxOsal_ThreadAllocate (struct ptxOsal *osalCtx)
	Allocate a thread structure.

ptxStatus_t	ptxOsal_ThreadCreate (struct ptxOsal osalCtx, struct ptxThread hThd, pptxOsal_ThreadProc_t thdFn, void *thdParam)
	Create a thread.

ptxStatus_t	ptxOsal_ThreadJoin (struct ptxOsal osalCtx, struct ptxThread hThd)
	Join on a thread, wait until it has exited.

ptxStatus_t	ptxOsal_ThreadClose (struct ptxOsal osalCtx, struct ptxThread hThd)
	Close a thread, once it has exited.

void	ptxOsal_ThreadSleep (struct ptxOsal *osalCtx, uint32_t msSleep)
	Sleep for a number of ms.

struct ptxTimer *	ptxOsal_TimerAllocate (struct ptxOsal *osalCtx)
	Allocate a timer structure.

ptxStatus_t	ptxOsal_TimerCreate (struct ptxOsal osalCtx, struct ptxTimer hTimer, pptxOsal_TimerProc_t timerProc, void *timerParam)
	Create a timer.

ptxStatus_t	ptxOsal_TimerStart (struct ptxOsal osalCtx, struct ptxTimer hTimer, uint32_t msInterval)
	Start or restart the timer.

ptxStatus_t	ptxOsal_TimerCancel (struct ptxOsal osalCtx, struct ptxTimer hTimer)
	Cancel a timer, if active.

ptxStatus_t	ptxOsal_TimerClose (struct ptxOsal osalCtx, struct ptxTimer hTimer)
	Close a timer, once it has expired.

ptxStatus_t	ptxOsal_StopwatchStart (struct ptxOsal osalCtx, ptxTimeDiff_t startVal)
	Start a time measurement or get a time value.

ptxStatus_t	ptxOsal_StopwatchStop (struct ptxOsal osalCtx, ptxTimeDiff_t startStopVal)
	End a time measurement.

void *	ptxOsal_GetSysCtx (struct ptxOsal *osalCtx)
	Get the System Context.

Detailed Description

SPDX-License-Identifier: BSD-3-Clause

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 Renesas 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 Renesas "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RENESAS 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.

Project : PTX1K Module : OSAL (Operating System Abstraction Layer) File : ptxOsal.h

Description : Header file gathering forward declarations and function prototypes for anything meant to be OS-Independent

Typedefs

Functions

Detailed Description

OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.