PSDK QNX API Guide
osal.h File Reference

OS Abstraction Layer header. More...

#include <ti/csl/tistdtypes.h>
#include <ti/osal/TaskP.h>
#include <ti/osal/HwiP.h>
#include <ti/osal/MuxIntcP.h>
#include <ti/osal/SemaphoreP.h>
#include <ti/osal/CacheP.h>
#include <ti/osal/TimerP.h>
#include <ti/osal/RegisterIntr.h>
#include <ti/osal/QueueP.h>
#include <ti/osal/CycleprofilerP.h>
#include <ti/osal/MailboxP.h>
#include <ti/osal/MutexP.h>
#include <ti/osal/ClockP.h>
#include <ti/osal/DebugP.h>
#include <ti/osal/HeapP.h>
#include <ti/osal/MemoryP.h>
#include <ti/osal/EventP.h>
#include <ti/osal/StartuphooksP.h>

Go to the source code of this file.

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...
 

Osal Error return Codes

Return error codes for Osal generic APIs

#define osal_OK   ((int32_t)(0))
 
#define osal_FAILURE   (-(int32_t)(1))
 
#define osal_UNSUPPORTED   (-(int32_t)(2))
 
#define osal_NOMEM   (-(int32_t)(3))
 
#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_SAFERTOS_HWIP_C7X_SIZE_BYTES   ((uint32_t) 56U)
 
#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) 248U)
 
#define OSAL_SAFERTOS_TASKP_SIZE_BYTES   ((uint32_t) 248U)
 
#define OSAL_Assert(expression)
 Assert checking function. More...
 
enum  Osal_ThreadType {
  Osal_ThreadType_Hwi ,
  Osal_ThreadType_Swi ,
  Osal_ThreadType_Task ,
  Osal_ThreadType_Main ,
  Osal_ThreadType_Abort
}
 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...
 
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...
 

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   (0x00000080U)
 
#define OSAL_COMPILE_TIME_SIZE_CHECK(x, y)
 
Osal_HwAttrs gOsal_HwAttrs
 external references for Osal Hw Attribute structure 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...
 
uint32_t Osal_getCoreId (void)
 Function to get the core ID of the running Core. More...
 
int32_t Osal_isInPrivilegeMode (void)
 Function to check if the calling task is in privileged mode. 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...
 

Detailed Description

OS Abstraction Layer header.

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