Introduction

OS Abstraction Layer header.

============================================================================

Data Structures
struct	Osal_StaticMemStatus
	This structure holds static memory status parameters of OSAL library. More...

struct	Osal_memRange
	Osal memory address range. More...

struct	Osal_HwAttrs
	Osal hw attributes structure. More...

Macros
#define	osal_WAIT_FOREVER (~((uint32_t)0U))

#define	osal_NO_WAIT ((uint32_t)0U)

#define	OSAL_NONOS_SEMAPHOREP_SIZE_BYTES ((uint32_t) 48U)

#define	OSAL_NONOS_HWIP_SIZE_BYTES ((uint32_t) 48U)

#define	OSAL_FREERTOS_HWIP_C7X_SIZE_BYTES ((uint32_t) 56U)

#define	OSAL_TIRTOS_SEMAPHOREP_SIZE_BYTES ((uint32_t) 96U)

#define	OSAL_TIRTOS_HWIP_SIZE_BYTES (96U)

#define	OSAL_FREERTOS_SEMAPHOREP_SIZE_BYTES ((uint32_t) 96U)

#define	OSAL_FREERTOS_TASKP_SIZE_BYTES ((uint32_t) 128U)

#define	OSAL_SAFERTOS_SEMAPHOREP_SIZE_BYTES ((uint32_t) 136U)

#define	OSAL_SAFERTOS_TASKP_SIZE_BYTES ((uint32_t) 248U)

#define	OSAL_Assert(expression)
	Assert checking function. More...

#define	OSAL_COMPILE_TIME_SIZE_CHECK(x, y)

Osal Error return Codes
Return error codes for Osal generic APIs
#define	osal_OK (0)

#define	osal_FAILURE (-(int32_t)(1))

#define	osal_UNSUPPORTED (-(int32_t)(2))

#define	osal_NOMEM (-(int32_t)(3))

Osal HwAttrs ValidBit definitions

#define	OSAL_HWATTR_SET_EXT_CLK (0x00000001U)

#define	OSAL_HWATTR_SET_ECM_INT (0x00000002U)

#define	OSAL_HWATTR_SET_HWACCESS_TYPE (0x00000004U)

#define	OSAL_HWATTR_SET_OSALDELAY_TIMER_BASE (0x00000008U)

#define	OSAL_HWATTR_SET_SEMP_EXT_BASE (0x00000010U)

#define	OSAL_HWATTR_SET_HWIP_EXT_BASE (0x00000020U)

#define	OSAL_HWATTR_SET_CPU_FREQ (0x00000040U)

#define	OSAL_HWATTR_SET_TARG_PROC_LIST (0x00000080)

Enumerations
enum	Osal_ThreadType { Osal_ThreadType_Hwi, Osal_ThreadType_Swi, Osal_ThreadType_Task, Osal_ThreadType_Main }
	This enum defines the multiple thread types used under OSAL library. More...

enum	Osal_HwAccessType { OSAL_HWACCESS_UNRESTRICTED, OSAL_HWACCESS_RESTRICTED }
	Osal hw access type. More...

Functions
void	Osal_DebugP_assert (int32_t expression, const char *file, int32_t line)

Osal_ThreadType	Osal_getThreadType (void)
	Function to get the current thread type. More...

int32_t	Osal_delay (uint32_t nTicks)
	Function to delay/sleep the specified number of ticks. More...

int32_t	Osal_setHwAttrs (uint32_t ctrlBitMap, const Osal_HwAttrs *hwAttrs)
	Function to set the Hw Attributes. More...

int32_t	Osal_getHwAttrs (Osal_HwAttrs *hwAttrs)
	Function to get the Hw Attributes. More...

int32_t	Osal_getStaticMemStatus (Osal_StaticMemStatus *pMemStat)
	Function to get the static memory usage of OSAL library. More...

int32_t	Osal_getCoreId (void)
	Function to get the core ID of the running Core. More...

void	OS_init (void)
	Function for initializing the OS / scheduler. More...

void	OS_start (void)
	Function to strat OS / scheduler. More...

void	OS_stop (void)
	Function to stop OS / scheduler. More...

Variables
Osal_HwAttrs	gOsal_HwAttrs
	external references for Osal Hw Attribute structure More...

Data Structures