CMSIS RTOS2 interface for C++ API of SuperTinyKernel RTOS. More...

Classes
struct	osVersion_t
	Version information. More...
struct	osThreadAttr_t
	Attributes structure for thread. More...
struct	osTimerAttr_t
	Attributes structure for timer. More...
struct	osEventFlagsAttr_t
	Attributes structure for event flags. More...
struct	osMutexAttr_t
	Attributes structure for mutex. More...
struct	osSemaphoreAttr_t
	Attributes structure for semaphore. More...
struct	osMemoryPoolAttr_t
	Attributes structure for memory pool. More...
struct	osMessageQueueAttr_t
	Attributes structure for message queue. More...

Macros
#define	osWaitForever 0xFFFFFFFFU
	Wait forever timeout value.
#define	osFlagsWaitAny 0x00000000U
	Wait for any flag (default).
#define	osFlagsWaitAll 0x00000001U
	Wait for all flags.
#define	osFlagsNoClear 0x00000002U
	Do not clear flags which have been specified to wait for.
#define	osFlagsError 0x80000000U
	Error indicator.
#define	osFlagsErrorUnknown 0xFFFFFFFFU
	osError (-1).
#define	osFlagsErrorTimeout 0xFFFFFFFEU
	osErrorTimeout (-2).
#define	osFlagsErrorResource 0xFFFFFFFDU
	osErrorResource (-3).
#define	osFlagsErrorParameter 0xFFFFFFFCU
	osErrorParameter (-4).
#define	osFlagsErrorISR 0xFFFFFFFAU
	osErrorISR (-6).
#define	osFlagsErrorSafetyClass 0xFFFFFFF9U
	osErrorSafetyClass (-7).
#define	osThreadDetached 0x00000000U
	Thread created in detached mode (default).
#define	osThreadJoinable 0x00000001U
	Thread created in joinable mode.
#define	osThreadUnprivileged 0x00000002U
	Thread runs in unprivileged mode.
#define	osThreadPrivileged 0x00000004U
	Thread runs in privileged mode.
#define	osThreadZone_Pos 8U
	MPU protected zone position.
#define	osThreadZone_Msk (0x3FUL << osThreadZone_Pos)
	MPU protected zone mask.
#define	osThreadZone_Valid (0x80UL << osThreadZone_Pos)
	MPU protected zone valid flag.
#define	osThreadZone(n)
	MPU zone value in attribute bit field format.
#define	osThreadProcessor(n)
	Thread processor number for SMP systems.
#define	osMutexRecursive 0x00000001U
	Recursive mutex.
#define	osMutexPrioInherit 0x00000002U
	Priority inherit protocol.
#define	osMutexRobust 0x00000008U
	Robust mutex.
#define	osSafetyClass_Pos 16U
	Safety class position.
#define	osSafetyClass_Msk (0x0FUL << osSafetyClass_Pos)
	Safety class mask.
#define	osSafetyClass_Valid (0x10UL << osSafetyClass_Pos)
	Safety class valid flag.
#define	osSafetyClass(n)
	Safety class.
#define	osSafetyWithSameClass 0x00000001U
	Objects with same safety class.
#define	osSafetyWithLowerClass 0x00000002U
	Objects with lower safety class.
#define	osErrorId 0xFFFFFFFFU
	osError (-1).
#define	TZ_MODULEID_T

Typedefs
typedef void(*	osThreadFunc_t) (void *argument)
	Entry point of a thread.
typedef void(*	osTimerFunc_t) (void *argument)
	Timer callback function.
typedef void *	osThreadId_t
typedef void *	osTimerId_t
typedef void *	osEventFlagsId_t
typedef void *	osMutexId_t
typedef void *	osSemaphoreId_t
typedef void *	osMemoryPoolId_t
typedef void *	osMessageQueueId_t
typedef uint32_t	TZ_ModuleId_t

Enumerations
enum	osKernelState_t { osKernelInactive = 0 , osKernelReady = 1 , osKernelRunning = 2 , osKernelLocked = 3 , osKernelSuspended = 4 , osKernelError = -1 , osKernelReserved = 0x7FFFFFFF }
	Kernel state. More...
enum	osThreadState_t { osThreadInactive = 0 , osThreadReady = 1 , osThreadRunning = 2 , osThreadBlocked = 3 , osThreadTerminated = 4 , osThreadError = -1 , osThreadReserved = 0x7FFFFFFF }
	Thread state. More...
enum	osPriority_t { osPriorityNone = 0 , osPriorityIdle = 1 , osPriorityLow = 8 , osPriorityLow1 = 8+1 , osPriorityLow2 = 8+2 , osPriorityLow3 = 8+3 , osPriorityLow4 = 8+4 , osPriorityLow5 = 8+5 , osPriorityLow6 = 8+6 , osPriorityLow7 = 8+7 , osPriorityBelowNormal = 16 , osPriorityBelowNormal1 = 16+1 , osPriorityBelowNormal2 = 16+2 , osPriorityBelowNormal3 = 16+3 , osPriorityBelowNormal4 = 16+4 , osPriorityBelowNormal5 = 16+5 , osPriorityBelowNormal6 = 16+6 , osPriorityBelowNormal7 = 16+7 , osPriorityNormal = 24 , osPriorityNormal1 = 24+1 , osPriorityNormal2 = 24+2 , osPriorityNormal3 = 24+3 , osPriorityNormal4 = 24+4 , osPriorityNormal5 = 24+5 , osPriorityNormal6 = 24+6 , osPriorityNormal7 = 24+7 , osPriorityAboveNormal = 32 , osPriorityAboveNormal1 = 32+1 , osPriorityAboveNormal2 = 32+2 , osPriorityAboveNormal3 = 32+3 , osPriorityAboveNormal4 = 32+4 , osPriorityAboveNormal5 = 32+5 , osPriorityAboveNormal6 = 32+6 , osPriorityAboveNormal7 = 32+7 , osPriorityHigh = 40 , osPriorityHigh1 = 40+1 , osPriorityHigh2 = 40+2 , osPriorityHigh3 = 40+3 , osPriorityHigh4 = 40+4 , osPriorityHigh5 = 40+5 , osPriorityHigh6 = 40+6 , osPriorityHigh7 = 40+7 , osPriorityRealtime = 48 , osPriorityRealtime1 = 48+1 , osPriorityRealtime2 = 48+2 , osPriorityRealtime3 = 48+3 , osPriorityRealtime4 = 48+4 , osPriorityRealtime5 = 48+5 , osPriorityRealtime6 = 48+6 , osPriorityRealtime7 = 48+7 , osPriorityISR = 56 , osPriorityError = -1 , osPriorityReserved = 0x7FFFFFFF }
	Priority values. More...
enum	osTimerType_t { osTimerOnce = 0 , osTimerPeriodic = 1 }
	Timer type. More...
enum	osStatus_t { osOK = 0 , osError = -1 , osErrorTimeout = -2 , osErrorResource = -3 , osErrorParameter = -4 , osErrorNoMemory = -5 , osErrorISR = -6 , osErrorSafetyClass = -7 , osStatusReserved = 0x7FFFFFFF }
	Status code values returned by CMSIS-RTOS functions. More...

Functions
osStatus_t	osKernelInitialize (void)
osStatus_t	osKernelGetInfo (osVersion_t version, char id_buf, uint32_t id_size)
osKernelState_t	osKernelGetState (void)
osStatus_t	osKernelStart (void)
int32_t	osKernelLock (void)
int32_t	osKernelUnlock (void)
int32_t	osKernelRestoreLock (int32_t lock)
uint32_t	osKernelSuspend (void)
void	osKernelResume (uint32_t sleep_ticks)
osStatus_t	osKernelProtect (uint32_t safety_class)
osStatus_t	osKernelDestroyClass (uint32_t safety_class, uint32_t mode)
uint32_t	osKernelGetTickCount (void)
uint32_t	osKernelGetTickFreq (void)
uint32_t	osKernelGetSysTimerCount (void)
uint64_t	osKernelGetSysTimerCount64 (void)
uint32_t	osKernelGetSysTimerFreq (void)
osThreadId_t	osThreadNew (osThreadFunc_t func, void argument, const osThreadAttr_t attr)
const char *	osThreadGetName (osThreadId_t thread_id)
uint32_t	osThreadGetClass (osThreadId_t thread_id)
uint32_t	osThreadGetZone (osThreadId_t thread_id)
osThreadId_t	osThreadGetId (void)
osThreadState_t	osThreadGetState (osThreadId_t thread_id)
uint32_t	osThreadGetStackSize (osThreadId_t thread_id)
uint32_t	osThreadGetStackSpace (osThreadId_t thread_id)
osStatus_t	osThreadSetPriority (osThreadId_t thread_id, osPriority_t priority)
osPriority_t	osThreadGetPriority (osThreadId_t thread_id)
osStatus_t	osThreadYield (void)
osStatus_t	osThreadSuspend (osThreadId_t thread_id)
osStatus_t	osThreadResume (osThreadId_t thread_id)
osStatus_t	osThreadDetach (osThreadId_t thread_id)
osStatus_t	osThreadJoin (osThreadId_t thread_id)
void	osThreadExit (void)
	Terminate execution of current running thread.
osStatus_t	osThreadTerminate (osThreadId_t thread_id)
osStatus_t	osThreadFeedWatchdog (uint32_t ticks)
osStatus_t	osThreadProtectPrivileged (void)
osStatus_t	osThreadSuspendClass (uint32_t safety_class, uint32_t mode)
osStatus_t	osThreadResumeClass (uint32_t safety_class, uint32_t mode)
osStatus_t	osThreadTerminateZone (uint32_t zone)
osStatus_t	osThreadSetAffinityMask (osThreadId_t thread_id, uint32_t affinity_mask)
uint32_t	osThreadGetAffinityMask (osThreadId_t thread_id)
uint32_t	osThreadGetCount (void)
uint32_t	osThreadEnumerate (osThreadId_t *thread_array, uint32_t array_items)
uint32_t	osThreadFlagsSet (osThreadId_t thread_id, uint32_t flags)
uint32_t	osThreadFlagsClear (uint32_t flags)
uint32_t	osThreadFlagsGet (void)
uint32_t	osThreadFlagsWait (uint32_t flags, uint32_t options, uint32_t timeout)
osStatus_t	osDelay (uint32_t ticks)
osStatus_t	osDelayUntil (uint32_t ticks)
osTimerId_t	osTimerNew (osTimerFunc_t func, osTimerType_t type, void argument, const osTimerAttr_t attr)
const char *	osTimerGetName (osTimerId_t timer_id)
osStatus_t	osTimerStart (osTimerId_t timer_id, uint32_t ticks)
osStatus_t	osTimerStop (osTimerId_t timer_id)
uint32_t	osTimerIsRunning (osTimerId_t timer_id)
osStatus_t	osTimerDelete (osTimerId_t timer_id)
osEventFlagsId_t	osEventFlagsNew (const osEventFlagsAttr_t *attr)
const char *	osEventFlagsGetName (osEventFlagsId_t ef_id)
uint32_t	osEventFlagsSet (osEventFlagsId_t ef_id, uint32_t flags)
uint32_t	osEventFlagsClear (osEventFlagsId_t ef_id, uint32_t flags)
uint32_t	osEventFlagsGet (osEventFlagsId_t ef_id)
uint32_t	osEventFlagsWait (osEventFlagsId_t ef_id, uint32_t flags, uint32_t options, uint32_t timeout)
osStatus_t	osEventFlagsDelete (osEventFlagsId_t ef_id)
osMutexId_t	osMutexNew (const osMutexAttr_t *attr)
const char *	osMutexGetName (osMutexId_t mutex_id)
osStatus_t	osMutexAcquire (osMutexId_t mutex_id, uint32_t timeout)
osStatus_t	osMutexRelease (osMutexId_t mutex_id)
osThreadId_t	osMutexGetOwner (osMutexId_t mutex_id)
osStatus_t	osMutexDelete (osMutexId_t mutex_id)
osSemaphoreId_t	osSemaphoreNew (uint32_t max_count, uint32_t initial_count, const osSemaphoreAttr_t *attr)
const char *	osSemaphoreGetName (osSemaphoreId_t semaphore_id)
osStatus_t	osSemaphoreAcquire (osSemaphoreId_t semaphore_id, uint32_t timeout)
osStatus_t	osSemaphoreRelease (osSemaphoreId_t semaphore_id)
uint32_t	osSemaphoreGetCount (osSemaphoreId_t semaphore_id)
osStatus_t	osSemaphoreDelete (osSemaphoreId_t semaphore_id)
osMemoryPoolId_t	osMemoryPoolNew (uint32_t block_count, uint32_t block_size, const osMemoryPoolAttr_t *attr)
const char *	osMemoryPoolGetName (osMemoryPoolId_t mp_id)
void *	osMemoryPoolAlloc (osMemoryPoolId_t mp_id, uint32_t timeout)
osStatus_t	osMemoryPoolFree (osMemoryPoolId_t mp_id, void *block)
uint32_t	osMemoryPoolGetCapacity (osMemoryPoolId_t mp_id)
uint32_t	osMemoryPoolGetBlockSize (osMemoryPoolId_t mp_id)
uint32_t	osMemoryPoolGetCount (osMemoryPoolId_t mp_id)
uint32_t	osMemoryPoolGetSpace (osMemoryPoolId_t mp_id)
osStatus_t	osMemoryPoolDelete (osMemoryPoolId_t mp_id)
osMessageQueueId_t	osMessageQueueNew (uint32_t msg_count, uint32_t msg_size, const osMessageQueueAttr_t *attr)
const char *	osMessageQueueGetName (osMessageQueueId_t mq_id)
osStatus_t	osMessageQueuePut (osMessageQueueId_t mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t timeout)
osStatus_t	osMessageQueueGet (osMessageQueueId_t mq_id, void msg_ptr, uint8_t msg_prio, uint32_t timeout)
uint32_t	osMessageQueueGetCapacity (osMessageQueueId_t mq_id)
uint32_t	osMessageQueueGetMsgSize (osMessageQueueId_t mq_id)
uint32_t	osMessageQueueGetCount (osMessageQueueId_t mq_id)
uint32_t	osMessageQueueGetSpace (osMessageQueueId_t mq_id)
osStatus_t	osMessageQueueReset (osMessageQueueId_t mq_id)
osStatus_t	osMessageQueueDelete (osMessageQueueId_t mq_id)
uint32_t	osWatchdogAlarm_Handler (osThreadId_t thread_id)
void	osZoneSetup_Callback (uint32_t zone)
void	osFaultResume (void)
	Resume normal operation when exiting exception faults.

Detailed Description

CMSIS RTOS2 interface for C++ API of SuperTinyKernel RTOS.

Maps the CMSIS RTOS2 C API (cmsis_os2.h) onto the STK C++ API.

Supported:

Kernel management (osKernelInitialize / Start / GetState / GetInfo / GetTickCount / GetTickFreq / GetSysTimerCount / GetSysTimerFreq / Lock / Unlock / RestoreLock)
Thread management (osThreadNew / Delete / Yield / Delay / osDelay / GetId / GetName / GetState / GetPriority / SetPriority / GetStackSize / GetStackSpace / GetCount / Terminate / Suspend / Resume, Join, Detach)
Thread flags (osThreadFlagsSet / Clear / Get / Wait)
Event flags (osEventFlagsNew / Delete / Set / Clear / Get / Wait)
Mutex (osMutexNew / Delete / Acquire / Release / GetOwner)
Semaphore (osSemaphoreNew / Delete / Acquire / Release / GetCount)
Timer (osTimerNew / Delete / Start / Stop / IsRunning)
Message Queue (osMessageQueueNew / Delete / Put / Get / GetCapacity / GetMsgSize / GetCount / GetSpace / Reset)
Memory Pool (osMemoryPoolNew / Delete / Alloc / Free / GetCapacity / GetBlockSize / GetCount / GetSpace / GetName)

Design notes:

All objects are heap-allocated with operator new/delete. For a fully static deployment, replace with a static object-pool allocator.
The wrapper owns one global Kernel instance (g_StkKernel). Call osKernelInitialize() before any other API, then osKernelStart().
The kernel is configured with KERNEL_DYNAMIC | KERNEL_SYNC and SwitchStrategyFP32 (32 fixed-priority levels). osThread priority values (osPriorityIdle=1 .. osPriorityISR=56) are linearly mapped to STK priority levels 0..31.
CMSIS osWaitForever (0xFFFFFFFF) is translated to STK WAIT_INFINITE.
Timeout values in CMSIS are in ticks; STK Sleep/Delay also take ticks, so no conversion is required.
Thread flags and event flags are backed by stk::sync::EventFlags, STK's native 32-bit multi-flag synchronization primitive.
Message queues are backed by stk::sync::MessageQueue, STK's native fixed-capacity, fixed-message-size ring-buffer with integrated blocking semantics (Put/Get with configurable timeouts, ISR-safe TryPut/TryGet).

Limitations / deviations from the specification:

Priority inheritance (osMutexPrioInherit): ignored, always supported.
Robust mutex (osMutexRobust): will assert as unsafe code.
Recursive mutex (osMutexRecursive): ignored, always recursive by default.

Macro Definition Documentation

◆ osErrorId

#define osErrorId 0xFFFFFFFFU

osError (-1).

Definition at line 294 of file cmsis_os2.h.

◆ osFlagsError

#define osFlagsError 0x80000000U

Error indicator.

Definition at line 254 of file cmsis_os2.h.

Referenced by osEventFlagsClear(), osEventFlagsSet(), osEventFlagsWait(), and osThreadFlagsSet().

◆ osFlagsErrorISR

#define osFlagsErrorISR 0xFFFFFFFAU

osErrorISR (-6).

Definition at line 259 of file cmsis_os2.h.

Referenced by osThreadFlagsWait(), and StkFlagsResultToCmsis().

◆ osFlagsErrorParameter

#define osFlagsErrorParameter 0xFFFFFFFCU

osErrorParameter (-4).

Definition at line 258 of file cmsis_os2.h.

Referenced by osEventFlagsClear(), osEventFlagsSet(), osEventFlagsWait(), osThreadFlagsSet(), and StkFlagsResultToCmsis().

◆ osFlagsErrorResource

#define osFlagsErrorResource 0xFFFFFFFDU

osErrorResource (-3).

Definition at line 257 of file cmsis_os2.h.

◆ osFlagsErrorSafetyClass

#define osFlagsErrorSafetyClass 0xFFFFFFF9U

osErrorSafetyClass (-7).

Definition at line 260 of file cmsis_os2.h.

◆ osFlagsErrorTimeout

#define osFlagsErrorTimeout 0xFFFFFFFEU

osErrorTimeout (-2).

Definition at line 256 of file cmsis_os2.h.

Referenced by StkFlagsResultToCmsis().

◆ osFlagsErrorUnknown

#define osFlagsErrorUnknown 0xFFFFFFFFU

osError (-1).

Definition at line 255 of file cmsis_os2.h.

Referenced by osThreadFlagsClear(), osThreadFlagsWait(), and StkFlagsResultToCmsis().

◆ osFlagsNoClear

#define osFlagsNoClear 0x00000002U

Do not clear flags which have been specified to wait for.

Definition at line 251 of file cmsis_os2.h.

Referenced by CmsisFlagsOptionsToStk().

◆ osFlagsWaitAll

#define osFlagsWaitAll 0x00000001U

Wait for all flags.

Definition at line 250 of file cmsis_os2.h.

Referenced by CmsisFlagsOptionsToStk().

◆ osFlagsWaitAny

#define osFlagsWaitAny 0x00000000U

Wait for any flag (default).

Definition at line 249 of file cmsis_os2.h.

◆ osMutexPrioInherit

#define osMutexPrioInherit 0x00000002U

Priority inherit protocol.

Definition at line 279 of file cmsis_os2.h.

◆ osMutexRecursive

#define osMutexRecursive 0x00000001U

Recursive mutex.

Definition at line 278 of file cmsis_os2.h.

◆ osMutexRobust

#define osMutexRobust 0x00000008U

Robust mutex.

Definition at line 280 of file cmsis_os2.h.

Referenced by osMutexNew().

◆ osSafetyClass

#define osSafetyClass ( n )

Value:

((((n) << osSafetyClass_Pos) & osSafetyClass_Msk) | \

osSafetyClass_Valid)

osSafetyClass_Pos

#define osSafetyClass_Pos

Safety class position.

Definition cmsis_os2.h:283

osSafetyClass_Msk

#define osSafetyClass_Msk

Safety class mask.

Definition cmsis_os2.h:284

osSafetyClass_Valid

#define osSafetyClass_Valid

Safety class valid flag.

Definition cmsis_os2.h:285

Safety class.

Definition at line 286 of file cmsis_os2.h.

286#define osSafetyClass(n) ((((n) << osSafetyClass_Pos) & osSafetyClass_Msk) | \

287 osSafetyClass_Valid)

◆ osSafetyClass_Msk

#define osSafetyClass_Msk (0x0FUL << osSafetyClass_Pos)

Safety class mask.

Definition at line 284 of file cmsis_os2.h.

◆ osSafetyClass_Pos

#define osSafetyClass_Pos 16U

Safety class position.

Definition at line 283 of file cmsis_os2.h.

◆ osSafetyClass_Valid

#define osSafetyClass_Valid (0x10UL << osSafetyClass_Pos)

Safety class valid flag.

Definition at line 285 of file cmsis_os2.h.

◆ osSafetyWithLowerClass

#define osSafetyWithLowerClass 0x00000002U

Objects with lower safety class.

Definition at line 291 of file cmsis_os2.h.

◆ osSafetyWithSameClass

#define osSafetyWithSameClass 0x00000001U

Objects with same safety class.

Definition at line 290 of file cmsis_os2.h.

◆ osThreadDetached

#define osThreadDetached 0x00000000U

Thread created in detached mode (default).

Definition at line 263 of file cmsis_os2.h.

◆ osThreadJoinable

#define osThreadJoinable 0x00000001U

Thread created in joinable mode.

Definition at line 264 of file cmsis_os2.h.

Referenced by osThreadNew().

◆ osThreadPrivileged

#define osThreadPrivileged 0x00000004U

Thread runs in privileged mode.

Definition at line 266 of file cmsis_os2.h.

◆ osThreadProcessor

#define osThreadProcessor ( n )

Value:

(1UL << (n))

Thread processor number for SMP systems.

Definition at line 275 of file cmsis_os2.h.

◆ osThreadUnprivileged

#define osThreadUnprivileged 0x00000002U

Thread runs in unprivileged mode.

Definition at line 265 of file cmsis_os2.h.

◆ osThreadZone

#define osThreadZone ( n )

Value:

((((n) << osThreadZone_Pos) & osThreadZone_Msk) | \

osThreadZone_Valid)

osThreadZone_Msk

#define osThreadZone_Msk

MPU protected zone mask.

Definition cmsis_os2.h:269

osThreadZone_Pos

#define osThreadZone_Pos

MPU protected zone position.

Definition cmsis_os2.h:268

osThreadZone_Valid

#define osThreadZone_Valid

MPU protected zone valid flag.

Definition cmsis_os2.h:270

MPU zone value in attribute bit field format.

Definition at line 271 of file cmsis_os2.h.

271#define osThreadZone(n) ((((n) << osThreadZone_Pos) & osThreadZone_Msk) | \

272 osThreadZone_Valid)

◆ osThreadZone_Msk

#define osThreadZone_Msk (0x3FUL << osThreadZone_Pos)

MPU protected zone mask.

Definition at line 269 of file cmsis_os2.h.

◆ osThreadZone_Pos

#define osThreadZone_Pos 8U

MPU protected zone position.

Definition at line 268 of file cmsis_os2.h.

◆ osThreadZone_Valid

#define osThreadZone_Valid (0x80UL << osThreadZone_Pos)

MPU protected zone valid flag.

Definition at line 270 of file cmsis_os2.h.

◆ osWaitForever

#define osWaitForever 0xFFFFFFFFU

Wait forever timeout value.

Definition at line 246 of file cmsis_os2.h.

◆ TZ_MODULEID_T

#define TZ_MODULEID_T

Definition at line 333 of file cmsis_os2.h.

Typedef Documentation

◆ osEventFlagsId_t

typedef void* osEventFlagsId_t

Event Flags ID identifies the event flags.

Definition at line 317 of file cmsis_os2.h.

◆ osMemoryPoolId_t

typedef void* osMemoryPoolId_t

Memory Pool ID identifies the memory pool.

Definition at line 326 of file cmsis_os2.h.

◆ osMessageQueueId_t

typedef void* osMessageQueueId_t

Message Queue ID identifies the message queue.

Definition at line 329 of file cmsis_os2.h.

◆ osMutexId_t

typedef void* osMutexId_t

Mutex ID identifies the mutex.

Definition at line 320 of file cmsis_os2.h.

◆ osSemaphoreId_t

typedef void* osSemaphoreId_t

Semaphore ID identifies the semaphore.

Definition at line 323 of file cmsis_os2.h.

◆ osThreadFunc_t

typedef void(* osThreadFunc_t) (void *argument)

Entry point of a thread.

Definition at line 234 of file cmsis_os2.h.

◆ osThreadId_t

typedef void* osThreadId_t

Thread ID identifies the thread.

Definition at line 311 of file cmsis_os2.h.

◆ osTimerFunc_t

typedef void(* osTimerFunc_t) (void *argument)

Timer callback function.

Definition at line 237 of file cmsis_os2.h.

◆ osTimerId_t

typedef void* osTimerId_t

Timer ID identifies the timer.

Definition at line 314 of file cmsis_os2.h.

◆ TZ_ModuleId_t

typedef uint32_t TZ_ModuleId_t

Data type that identifies secure software modules called by a process.

Definition at line 335 of file cmsis_os2.h.

Enumeration Type Documentation

◆ osKernelState_t

enum osKernelState_t

Kernel state.

Enumerator
osKernelInactive	Inactive.
osKernelReady	Ready.
osKernelRunning	Running.
osKernelLocked	Locked.
osKernelSuspended	Suspended.
osKernelError	Error.
osKernelReserved	Prevents enum down-size compiler optimization.

Definition at line 155 of file cmsis_os2.h.

             {
  osKernelInactive        =  0,         
  osKernelReady           =  1,         
  osKernelRunning         =  2,         
  osKernelLocked          =  3,         
  osKernelSuspended       =  4,         
  osKernelError           = -1,         
  osKernelReserved        = 0x7FFFFFFF  
} osKernelState_t;

◆ osPriority_t

enum osPriority_t

Priority values.

Enumerator
osPriorityNone	No priority (not initialized).
osPriorityIdle	Reserved for Idle thread.
osPriorityLow	Priority: low.
osPriorityLow1	Priority: low + 1.
osPriorityLow2	Priority: low + 2.
osPriorityLow3	Priority: low + 3.
osPriorityLow4	Priority: low + 4.
osPriorityLow5	Priority: low + 5.
osPriorityLow6	Priority: low + 6.
osPriorityLow7	Priority: low + 7.
osPriorityBelowNormal	Priority: below normal.
osPriorityBelowNormal1	Priority: below normal + 1.
osPriorityBelowNormal2	Priority: below normal + 2.
osPriorityBelowNormal3	Priority: below normal + 3.
osPriorityBelowNormal4	Priority: below normal + 4.
osPriorityBelowNormal5	Priority: below normal + 5.
osPriorityBelowNormal6	Priority: below normal + 6.
osPriorityBelowNormal7	Priority: below normal + 7.
osPriorityNormal	Priority: normal.
osPriorityNormal1	Priority: normal + 1.
osPriorityNormal2	Priority: normal + 2.
osPriorityNormal3	Priority: normal + 3.
osPriorityNormal4	Priority: normal + 4.
osPriorityNormal5	Priority: normal + 5.
osPriorityNormal6	Priority: normal + 6.
osPriorityNormal7	Priority: normal + 7.
osPriorityAboveNormal	Priority: above normal.
osPriorityAboveNormal1	Priority: above normal + 1.
osPriorityAboveNormal2	Priority: above normal + 2.
osPriorityAboveNormal3	Priority: above normal + 3.
osPriorityAboveNormal4	Priority: above normal + 4.
osPriorityAboveNormal5	Priority: above normal + 5.
osPriorityAboveNormal6	Priority: above normal + 6.
osPriorityAboveNormal7	Priority: above normal + 7.
osPriorityHigh	Priority: high.
osPriorityHigh1	Priority: high + 1.
osPriorityHigh2	Priority: high + 2.
osPriorityHigh3	Priority: high + 3.
osPriorityHigh4	Priority: high + 4.
osPriorityHigh5	Priority: high + 5.
osPriorityHigh6	Priority: high + 6.
osPriorityHigh7	Priority: high + 7.
osPriorityRealtime	Priority: realtime.
osPriorityRealtime1	Priority: realtime + 1.
osPriorityRealtime2	Priority: realtime + 2.
osPriorityRealtime3	Priority: realtime + 3.
osPriorityRealtime4	Priority: realtime + 4.
osPriorityRealtime5	Priority: realtime + 5.
osPriorityRealtime6	Priority: realtime + 6.
osPriorityRealtime7	Priority: realtime + 7.
osPriorityISR	Reserved for ISR deferred thread.
osPriorityError	System cannot determine priority or illegal priority.
osPriorityReserved	Prevents enum down-size compiler optimization.

Definition at line 177 of file cmsis_os2.h.

             {
  osPriorityNone          =  0,         
  osPriorityIdle          =  1,         
  osPriorityLow           =  8,         
  osPriorityLow1          =  8+1,       
  osPriorityLow2          =  8+2,       
  osPriorityLow3          =  8+3,       
  osPriorityLow4          =  8+4,       
  osPriorityLow5          =  8+5,       
  osPriorityLow6          =  8+6,       
  osPriorityLow7          =  8+7,       
  osPriorityBelowNormal   = 16,         
  osPriorityBelowNormal1  = 16+1,       
  osPriorityBelowNormal2  = 16+2,       
  osPriorityBelowNormal3  = 16+3,       
  osPriorityBelowNormal4  = 16+4,       
  osPriorityBelowNormal5  = 16+5,       
  osPriorityBelowNormal6  = 16+6,       
  osPriorityBelowNormal7  = 16+7,       
  osPriorityNormal        = 24,         
  osPriorityNormal1       = 24+1,       
  osPriorityNormal2       = 24+2,       
  osPriorityNormal3       = 24+3,       
  osPriorityNormal4       = 24+4,       
  osPriorityNormal5       = 24+5,       
  osPriorityNormal6       = 24+6,       
  osPriorityNormal7       = 24+7,       
  osPriorityAboveNormal   = 32,         
  osPriorityAboveNormal1  = 32+1,       
  osPriorityAboveNormal2  = 32+2,       
  osPriorityAboveNormal3  = 32+3,       
  osPriorityAboveNormal4  = 32+4,       
  osPriorityAboveNormal5  = 32+5,       
  osPriorityAboveNormal6  = 32+6,       
  osPriorityAboveNormal7  = 32+7,       
  osPriorityHigh          = 40,         
  osPriorityHigh1         = 40+1,       
  osPriorityHigh2         = 40+2,       
  osPriorityHigh3         = 40+3,       
  osPriorityHigh4         = 40+4,       
  osPriorityHigh5         = 40+5,       
  osPriorityHigh6         = 40+6,       
  osPriorityHigh7         = 40+7,       
  osPriorityRealtime      = 48,         
  osPriorityRealtime1     = 48+1,       
  osPriorityRealtime2     = 48+2,       
  osPriorityRealtime3     = 48+3,       
  osPriorityRealtime4     = 48+4,       
  osPriorityRealtime5     = 48+5,       
  osPriorityRealtime6     = 48+6,       
  osPriorityRealtime7     = 48+7,       
  osPriorityISR           = 56,         
  osPriorityError         = -1,         
  osPriorityReserved      = 0x7FFFFFFF  
} osPriority_t;

◆ osStatus_t

enum osStatus_t

Status code values returned by CMSIS-RTOS functions.

Enumerator
osOK	Operation completed successfully.
osError	Unspecified RTOS error: run-time error but no other error message fits.
osErrorTimeout	Operation not completed within the timeout period.
osErrorResource	Resource not available.
osErrorParameter	Parameter error.
osErrorNoMemory	System is out of memory: it was impossible to allocate or reserve memory for the operation.
osErrorISR	Not allowed in ISR context: the function cannot be called from interrupt service routines.
osErrorSafetyClass	Operation denied because of safety class violation.
osStatusReserved	Prevents enum down-size compiler optimization.

Definition at line 297 of file cmsis_os2.h.

             {
  osOK                    =  0,         
  osError                 = -1,         
  osErrorTimeout          = -2,         
  osErrorResource         = -3,         
  osErrorParameter        = -4,         
  osErrorNoMemory         = -5,         
  osErrorISR              = -6,         
  osErrorSafetyClass      = -7,         
  osStatusReserved        = 0x7FFFFFFF  
} osStatus_t;

◆ osThreadState_t

enum osThreadState_t

Thread state.

Enumerator
osThreadInactive	Inactive.
osThreadReady	Ready.
osThreadRunning	Running.
osThreadBlocked	Blocked.
osThreadTerminated	Terminated.
osThreadError	Error.
osThreadReserved	Prevents enum down-size compiler optimization.

Definition at line 166 of file cmsis_os2.h.

             {
  osThreadInactive        =  0,         
  osThreadReady           =  1,         
  osThreadRunning         =  2,         
  osThreadBlocked         =  3,         
  osThreadTerminated      =  4,         
  osThreadError           = -1,         
  osThreadReserved        = 0x7FFFFFFF  
} osThreadState_t;

◆ osTimerType_t

enum osTimerType_t

Timer type.

Enumerator
osTimerOnce	One-shot timer.
osTimerPeriodic	Repeating timer.

Definition at line 240 of file cmsis_os2.h.

             {
  osTimerOnce             = 0,          
  osTimerPeriodic         = 1           
} osTimerType_t;

Function Documentation

◆ osDelay()

osStatus_t osDelay ( uint32_t ticks )

Wait for Timeout (Time Delay).

Parameters

[in] ticks time ticks value

Returns: status code that indicates the execution status of the function.

Definition at line 1039 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return osErrorISR;
    if (osKernelGetState() == osKernelInactive)
        return osError;
 
    stk::Timeout timeout = CmsisTimeoutToStk(ticks);
 
    stk::Sleep(timeout);
    return osOK;
}

References CmsisTimeoutToStk(), IsIrqContext(), osError, osErrorISR, osKernelGetState(), osKernelInactive, osOK, and stk::Sleep().

Here is the call graph for this function:

◆ osDelayUntil()

osStatus_t osDelayUntil ( uint32_t ticks )

Wait until specified time.

Parameters

[in] ticks absolute time in ticks

Returns: status code that indicates the execution status of the function.

Definition at line 1052 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return osErrorISR;
    if (osKernelGetState() == osKernelInactive)
        return osError;
 
    stk::SleepUntil(static_cast<stk::Ticks>(ticks));
    return osOK;
}

References IsIrqContext(), osError, osErrorISR, osKernelGetState(), osKernelInactive, osOK, and stk::SleepUntil().

Here is the call graph for this function:

◆ osEventFlagsClear()

uint32_t osEventFlagsClear	(	osEventFlagsId_t	ef_id,
		uint32_t	flags )

Clear the specified Event Flags.

Parameters

[in]	ef_id	event flags ID obtained by osEventFlagsNew.
[in]	flags	specifies the flags that shall be cleared.

Returns: event flags before clearing or error code if highest bit set.

Definition at line 1178 of file cmsis_os2_stk.cpp.

{
    if ((ef_id == nullptr) || ((flags & osFlagsError) != 0U))
        return osFlagsErrorParameter;
 
    uint32_t result = static_cast<StkEventFlags *>(ef_id)->m_ef.Clear(flags);
    return StkFlagsResultToCmsis(result);
}

References osFlagsError, osFlagsErrorParameter, and StkFlagsResultToCmsis().

Here is the call graph for this function:

◆ osEventFlagsDelete()

osStatus_t osEventFlagsDelete ( osEventFlagsId_t ef_id )

Delete an Event Flags object.

Parameters

[in] ef_id event flags ID obtained by osEventFlagsNew.

Returns: status code that indicates the execution status of the function.

Definition at line 1207 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (ef_id == nullptr))
        return IsIrqContext() ? osErrorISR : osErrorParameter;
 
    ObjDestroy(static_cast<StkEventFlags *>(ef_id));
    return osOK;
}

References IsIrqContext(), ObjDestroy(), osErrorISR, osErrorParameter, and osOK.

Here is the call graph for this function:

◆ osEventFlagsGet()

uint32_t osEventFlagsGet ( osEventFlagsId_t ef_id )

Get the current Event Flags.

Parameters

[in] ef_id event flags ID obtained by osEventFlagsNew.

Returns: current event flags.

Definition at line 1187 of file cmsis_os2_stk.cpp.

{
    if (ef_id == nullptr)
        return 0U;
 
    return static_cast<StkEventFlags *>(ef_id)->m_ef.Get();
}

◆ osEventFlagsGetName()

const char * osEventFlagsGetName ( osEventFlagsId_t ef_id )

Get name of an Event Flags object.

Parameters

[in] ef_id event flags ID obtained by osEventFlagsNew.

Returns: name as null-terminated string.

Definition at line 1161 of file cmsis_os2_stk.cpp.

{
    if (ef_id == nullptr)
        return nullptr;
 
    return static_cast<StkEventFlags *>(ef_id)->m_ef.GetTraceName();
}

◆ osEventFlagsNew()

osEventFlagsId_t osEventFlagsNew ( const osEventFlagsAttr_t * attr )

Create and Initialize an Event Flags object.

Parameters

[in] attr event flags attributes; NULL: default values.

Returns: event flags ID for reference by other functions or NULL in case of error.

Definition at line 1148 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return nullptr;
 
    const char *name   = (attr != nullptr ? attr->name    : nullptr);
    void       *cb_mem = (attr != nullptr ? attr->cb_mem  : nullptr);
    uint32_t    cb_sz  = (attr != nullptr ? attr->cb_size : 0U);
 
    StkEventFlags *ef = PlacementNewOrHeap<StkEventFlags>(cb_mem, cb_sz, name);
    return static_cast<osEventFlagsId_t>(ef);
}

References osEventFlagsAttr_t::cb_mem, osEventFlagsAttr_t::cb_size, IsIrqContext(), osEventFlagsAttr_t::name, and PlacementNewOrHeap().

Here is the call graph for this function:

◆ osEventFlagsSet()

uint32_t osEventFlagsSet	(	osEventFlagsId_t	ef_id,
		uint32_t	flags )

Set the specified Event Flags.

Parameters

[in]	ef_id	event flags ID obtained by osEventFlagsNew.
[in]	flags	specifies the flags that shall be set.

Returns: event flags after setting or error code if highest bit set.

Definition at line 1169 of file cmsis_os2_stk.cpp.

{
    if ((ef_id == nullptr) || ((flags & osFlagsError) != 0U))
        return osFlagsErrorParameter;
 
    uint32_t result = static_cast<StkEventFlags *>(ef_id)->m_ef.Set(flags);
    return StkFlagsResultToCmsis(result);
}

References osFlagsError, osFlagsErrorParameter, and StkFlagsResultToCmsis().

Here is the call graph for this function:

◆ osEventFlagsWait()

uint32_t osEventFlagsWait	(	osEventFlagsId_t	ef_id,
		uint32_t	flags,
		uint32_t	options,
		uint32_t	timeout )

Wait for one or more Event Flags to become signaled.

Parameters

[in]	ef_id	event flags ID obtained by osEventFlagsNew.
[in]	flags	specifies the flags to wait for.
[in]	options	specifies flags options (osFlagsXxxx).
[in]	timeout	CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.

Returns: event flags before clearing or error code if highest bit set.

Definition at line 1195 of file cmsis_os2_stk.cpp.

{
    if ((ef_id == nullptr) || ((flags & osFlagsError) != 0U))
        return osFlagsErrorParameter;
 
    uint32_t result = static_cast<StkEventFlags *>(ef_id)->m_ef.Wait(flags,
        CmsisFlagsOptionsToStk(options), CmsisTimeoutToStk(timeout));
 
    return StkFlagsResultToCmsis(result);
}

References CmsisFlagsOptionsToStk(), CmsisTimeoutToStk(), osFlagsError, osFlagsErrorParameter, and StkFlagsResultToCmsis().

Here is the call graph for this function:

◆ osFaultResume()

void osFaultResume ( void )

Resume normal operation when exiting exception faults.

◆ osKernelDestroyClass()

osStatus_t osKernelDestroyClass	(	uint32_t	safety_class,
		uint32_t	mode )

Destroy objects for specified safety classes.

Parameters

[in]	safety_class	safety class.
[in]	mode	safety mode.

Returns: status code that indicates the execution status of the function.

◆ osKernelGetInfo()

osStatus_t osKernelGetInfo	(	osVersion_t *	version,
		char *	id_buf,
		uint32_t	id_size )

Get RTOS Kernel Information.

Parameters

[out]	version	pointer to buffer for retrieving version information.
[out]	id_buf	pointer to buffer for retrieving kernel identification string.
[in]	id_size	size of buffer for kernel identification string.

Returns: status code that indicates the execution status of the function.

Definition at line 483 of file cmsis_os2_stk.cpp.

{
    if (version != nullptr)
    {
        version->api    = STK_WRAPPER_API_VERSION;
        version->kernel = STK_WRAPPER_KERNEL_VERSION;
    }
 
    if ((id_buf != nullptr) && (id_size > 0U))
    {
        const char *id = STK_WRAPPER_KERNEL_ID;
        size_t copy_len = id_size - 1U;
        size_t id_len   = __builtin_strlen(id);
        if (copy_len > id_len)
            copy_len = id_len;
 
        memcpy(id_buf, id, copy_len);
        id_buf[copy_len] = '\0';
    }
 
    return osOK;
}

References osVersion_t::api, osVersion_t::kernel, osOK, STK_WRAPPER_API_VERSION, STK_WRAPPER_KERNEL_ID, and STK_WRAPPER_KERNEL_VERSION.

◆ osKernelGetState()

osKernelState_t osKernelGetState ( void )

Get the current RTOS Kernel state.

Returns: current RTOS Kernel state.

Definition at line 506 of file cmsis_os2_stk.cpp.

{
    if (g_StkKernelLocked != 0U)
        return osKernelLocked;
 
    switch (g_StkKernel.GetState())
    {
    case stk::IKernel::KSTATE_INACTIVE:  return osKernelInactive;
    case stk::IKernel::KSTATE_READY:     return osKernelReady;
    case stk::IKernel::KSTATE_RUNNING:   return osKernelRunning;
    case stk::IKernel::KSTATE_SUSPENDED: return osKernelSuspended;
    default:                             return osKernelError;
    }
}

References g_StkKernel, g_StkKernelLocked, stk::IKernel::KSTATE_INACTIVE, stk::IKernel::KSTATE_READY, stk::IKernel::KSTATE_RUNNING, stk::IKernel::KSTATE_SUSPENDED, osKernelError, osKernelInactive, osKernelLocked, osKernelReady, osKernelRunning, and osKernelSuspended.

Referenced by osDelay(), osDelayUntil(), osKernelGetTickCount(), osKernelGetTickFreq(), osKernelInitialize(), osKernelResume(), osKernelStart(), osKernelSuspend(), osThreadEnumerate(), osThreadGetCount(), osThreadGetId(), osThreadNew(), osThreadResume(), osThreadSuspend(), osThreadTerminate(), osThreadYield(), and osTimerNew().

Here is the caller graph for this function:

◆ osKernelGetSysTimerCount()

uint32_t osKernelGetSysTimerCount ( void )

Get the RTOS kernel system timer count.

Returns: RTOS kernel current system timer count as 32-bit value.

Definition at line 623 of file cmsis_os2_stk.cpp.

{
    return static_cast<uint32_t>(stk::GetSysTimerCount());
}

References stk::GetSysTimerCount().

Here is the call graph for this function:

◆ osKernelGetSysTimerCount64()

uint64_t osKernelGetSysTimerCount64 ( void )

Get the RTOS kernel system timer count.

Returns: RTOS kernel current system timer count as 64-bit value.

Definition at line 628 of file cmsis_os2_stk.cpp.

{
    return stk::GetSysTimerCount();
}

References stk::GetSysTimerCount().

Here is the call graph for this function:

◆ osKernelGetSysTimerFreq()

uint32_t osKernelGetSysTimerFreq ( void )

Get the RTOS kernel system timer frequency.

Returns: frequency of the system timer in hertz, i.e. timer ticks per second.

Definition at line 633 of file cmsis_os2_stk.cpp.

{
    return stk::GetSysTimerFrequency();
}

References stk::GetSysTimerFrequency().

Here is the call graph for this function:

◆ osKernelGetTickCount()

uint32_t osKernelGetTickCount ( void )

Get the RTOS kernel tick count.

Returns: RTOS kernel current tick count.

Definition at line 603 of file cmsis_os2_stk.cpp.

{
    if (osKernelGetState() == osKernelInactive)
        return 0U;
 
    return static_cast<uint32_t>(stk::GetTicks());
}

References stk::GetTicks(), osKernelGetState(), and osKernelInactive.

Here is the call graph for this function:

◆ osKernelGetTickFreq()

uint32_t osKernelGetTickFreq ( void )

Get the RTOS kernel tick frequency.

Returns: frequency of the kernel tick in hertz, i.e. kernel ticks per second.

Definition at line 611 of file cmsis_os2_stk.cpp.

{
    if (osKernelGetState() == osKernelInactive)
        return 1000U; // default 1 kHz
 
    int32_t res_us = stk::GetTickResolution(); // us per tick
    if (res_us <= 0)
        return 1000U;
 
    return (1000000U / static_cast<uint32_t>(res_us));
}

References stk::GetTickResolution(), osKernelGetState(), and osKernelInactive.

Here is the call graph for this function:

◆ osKernelInitialize()

osStatus_t osKernelInitialize ( void )

Initialize the RTOS Kernel.

Returns: status code that indicates the execution status of the function.

Definition at line 471 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return osErrorISR;
 
    if (osKernelGetState() != osKernelInactive)
        return osError;
 
    g_StkKernel.Initialize(); // default 1 ms tick resolution
    return osOK;
}

References g_StkKernel, IsIrqContext(), osError, osErrorISR, osKernelGetState(), osKernelInactive, and osOK.

Here is the call graph for this function:

◆ osKernelLock()

int32_t osKernelLock ( void )

Lock the RTOS Kernel scheduler.

Returns: previous lock state (1 - locked, 0 - not locked, error code if negative).

Definition at line 535 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return static_cast<int32_t>(osErrorISR);
 
    stk::hw::CriticalSection::Enter();
    ++g_StkKernelLocked;
    return 0;
}

References stk::hw::CriticalSection::Enter(), g_StkKernelLocked, IsIrqContext(), and osErrorISR.

Here is the call graph for this function:

◆ osKernelProtect()

osStatus_t osKernelProtect ( uint32_t safety_class )

Protect the RTOS Kernel scheduler access.

Parameters

[in] safety_class safety class.

Returns: status code that indicates the execution status of the function.

◆ osKernelRestoreLock()

int32_t osKernelRestoreLock ( int32_t lock )

Restore the RTOS Kernel scheduler lock state.

Parameters

[in] lock lock state obtained by osKernelLock or osKernelUnlock.

Returns: new lock state (1 - locked, 0 - not locked, error code if negative).

Definition at line 557 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return static_cast<int32_t>(osErrorISR);
 
    if (lock == 1)
    {
        stk::hw::CriticalSection::Enter();
        ++g_StkKernelLocked;
    }
    else
    {
        if (g_StkKernelLocked == 0U)
            return osErrorResource;
 
        --g_StkKernelLocked;
        stk::hw::CriticalSection::Exit();
    }
 
    return lock;
}

References stk::hw::CriticalSection::Enter(), stk::hw::CriticalSection::Exit(), g_StkKernelLocked, IsIrqContext(), osErrorISR, and osErrorResource.

Here is the call graph for this function:

◆ osKernelResume()

void osKernelResume ( uint32_t sleep_ticks )

Resume the RTOS Kernel scheduler.

Parameters

[in] sleep_ticks time in ticks for how long the system was in sleep or power-down mode.

Definition at line 592 of file cmsis_os2_stk.cpp.

{
#if STK_TICKLESS_IDLE
    if (osKernelGetState() != osKernelInactive)
        return stk::IKernelService::GetInstance()->Resume(sleep_ticks);
#else
    // Not supported in non-tickless kernel.
    STK_UNUSED(sleep_ticks);
#endif
}

References stk::IKernelService::GetInstance(), osKernelGetState(), osKernelInactive, stk::IKernelService::Resume(), and STK_UNUSED.

Here is the call graph for this function:

◆ osKernelStart()

osStatus_t osKernelStart ( void )

Start the RTOS Kernel scheduler.

Returns: status code that indicates the execution status of the function.

Definition at line 521 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return osErrorISR;
 
    if (osKernelGetState() != osKernelReady)
        return osError;
 
    // Start() does not return for KERNEL_STATIC;
    // for KERNEL_DYNAMIC it returns when all tasks exit.
    g_StkKernel.Start();
    return osOK;
}

References g_StkKernel, IsIrqContext(), osError, osErrorISR, osKernelGetState(), osKernelReady, and osOK.

Here is the call graph for this function:

◆ osKernelSuspend()

uint32_t osKernelSuspend ( void )

Suspend the RTOS Kernel scheduler.

Returns: time in ticks, for how long the system can sleep or power-down.

Definition at line 579 of file cmsis_os2_stk.cpp.

{
#if STK_TICKLESS_IDLE
    if (osKernelGetState() == osKernelInactive)
        return 0U;
 
    return stk::IKernelService::GetInstance()->Suspend();
#else
    // Not supported in non-tickless kernel.
    return 0U;
#endif
}

References stk::IKernelService::GetInstance(), osKernelGetState(), osKernelInactive, and stk::IKernelService::Suspend().

Here is the call graph for this function:

◆ osKernelUnlock()

int32_t osKernelUnlock ( void )

Unlock the RTOS Kernel scheduler.

Returns: previous lock state (1 - locked, 0 - not locked, error code if negative).

Definition at line 545 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return static_cast<int32_t>(osErrorISR);
    if (g_StkKernelLocked == 0U)
        return osErrorResource;
 
    --g_StkKernelLocked;
    stk::hw::CriticalSection::Exit();
    return 0;
}

References stk::hw::CriticalSection::Exit(), g_StkKernelLocked, IsIrqContext(), osErrorISR, and osErrorResource.

Here is the call graph for this function:

◆ osMemoryPoolAlloc()

void * osMemoryPoolAlloc	(	osMemoryPoolId_t	mp_id,
		uint32_t	timeout )

Allocate a memory block from a Memory Pool.

Parameters

[in]	mp_id	memory pool ID obtained by osMemoryPoolNew.
[in]	timeout	CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.

Returns: address of the allocated memory block or NULL in case of no memory is available.

Definition at line 1436 of file cmsis_os2_stk.cpp.

{
    if (mp_id == nullptr)
        return nullptr;
 
    // ISR context is only valid with timeout == 0 (NO_WAIT / TryAlloc).
    if (IsIrqContext() && (timeout != 0U))
        return nullptr;
 
    return static_cast<StkMemPool *>(mp_id)->m_mpool.TimedAlloc(CmsisTimeoutToStk(timeout));
}

References CmsisTimeoutToStk(), and IsIrqContext().

Here is the call graph for this function:

◆ osMemoryPoolDelete()

osStatus_t osMemoryPoolDelete ( osMemoryPoolId_t mp_id )

Delete a Memory Pool object.

Parameters

[in] mp_id memory pool ID obtained by osMemoryPoolNew.

Returns: status code that indicates the execution status of the function.

Definition at line 1491 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (mp_id == nullptr))
        return (IsIrqContext() ? osErrorISR : osErrorParameter);
 
    ObjDestroy(static_cast<StkMemPool *>(mp_id));
 
    return osOK;
}

References IsIrqContext(), ObjDestroy(), osErrorISR, osErrorParameter, and osOK.

Here is the call graph for this function:

◆ osMemoryPoolFree()

osStatus_t osMemoryPoolFree	(	osMemoryPoolId_t	mp_id,
		void *	block )

Return an allocated memory block back to a Memory Pool.

Parameters

[in]	mp_id	memory pool ID obtained by osMemoryPoolNew.
[in]	block	address of the allocated memory block to be returned to the memory pool.

Returns: status code that indicates the execution status of the function.

Definition at line 1448 of file cmsis_os2_stk.cpp.

{
    if ((mp_id == nullptr) || (block == nullptr))
        return osErrorParameter;
 
    if (!static_cast<StkMemPool *>(mp_id)->m_mpool.Free(block))
        return osErrorParameter; // ptr not from this pool
 
    return osOK;
}

References osErrorParameter, and osOK.

◆ osMemoryPoolGetBlockSize()

uint32_t osMemoryPoolGetBlockSize ( osMemoryPoolId_t mp_id )

Get memory block size in a Memory Pool.

Parameters

[in] mp_id memory pool ID obtained by osMemoryPoolNew.

Returns: memory block size in bytes.

Definition at line 1467 of file cmsis_os2_stk.cpp.

{
    if (mp_id == nullptr)
        return 0U;
 
    return static_cast<uint32_t>(static_cast<StkMemPool *>(mp_id)->m_mpool.GetBlockSize());
}

References stk::memory::BlockMemoryPool::GetBlockSize(), and StkMemPool::m_mpool.

Here is the call graph for this function:

◆ osMemoryPoolGetCapacity()

uint32_t osMemoryPoolGetCapacity ( osMemoryPoolId_t mp_id )

Get maximum number of memory blocks in a Memory Pool.

Parameters

[in] mp_id memory pool ID obtained by osMemoryPoolNew.

Returns: maximum number of memory blocks.

Definition at line 1459 of file cmsis_os2_stk.cpp.

{
    if (mp_id == nullptr)
        return 0U;
 
    return static_cast<StkMemPool *>(mp_id)->m_mpool.GetCapacity();
}

◆ osMemoryPoolGetCount()

uint32_t osMemoryPoolGetCount ( osMemoryPoolId_t mp_id )

Get number of memory blocks used in a Memory Pool.

Parameters

[in] mp_id memory pool ID obtained by osMemoryPoolNew.

Returns: number of memory blocks used.

Definition at line 1475 of file cmsis_os2_stk.cpp.

{
    if (mp_id == nullptr)
        return 0U;
 
    return static_cast<StkMemPool *>(mp_id)->m_mpool.GetUsedCount();
}

◆ osMemoryPoolGetName()

const char * osMemoryPoolGetName ( osMemoryPoolId_t mp_id )

Get name of a Memory Pool object.

Parameters

[in] mp_id memory pool ID obtained by osMemoryPoolNew.

Returns: name as null-terminated string.

Definition at line 1428 of file cmsis_os2_stk.cpp.

{
    if (mp_id == nullptr)
        return nullptr;
 
    return static_cast<StkMemPool *>(mp_id)->m_mpool.GetTraceName();
}

◆ osMemoryPoolGetSpace()

uint32_t osMemoryPoolGetSpace ( osMemoryPoolId_t mp_id )

Get number of memory blocks available in a Memory Pool.

Parameters

[in] mp_id memory pool ID obtained by osMemoryPoolNew.

Returns: number of memory blocks available.

Definition at line 1483 of file cmsis_os2_stk.cpp.

{
    if (mp_id == nullptr)
        return 0U;
 
    return static_cast<StkMemPool *>(mp_id)->m_mpool.GetFreeCount();
}

◆ osMemoryPoolNew()

osMemoryPoolId_t osMemoryPoolNew	(	uint32_t	block_count,
		uint32_t	block_size,
		const osMemoryPoolAttr_t *	attr )

Create and Initialize a Memory Pool object.

Parameters

[in]	block_count	maximum number of memory blocks in memory pool.
[in]	block_size	memory block size in bytes.
[in]	attr	memory pool attributes; NULL: default values.

Returns: memory pool ID for reference by other functions or NULL in case of error.

Definition at line 1382 of file cmsis_os2_stk.cpp.

{
    // ISR context: forbidden per CMSIS spec.
    if (IsIrqContext())
        return nullptr;
 
    // Zero capacity or zero block size are meaningless.
    if ((block_count == 0U) || (block_size == 0U))
        return nullptr;
 
    const char *name    = (attr != nullptr ? attr->name    : nullptr);
    void       *cb_mem  = (attr != nullptr ? attr->cb_mem  : nullptr);
    uint32_t    cb_sz   = (attr != nullptr ? attr->cb_size : 0U);
    void       *mp_mem  = (attr != nullptr ? attr->mp_mem  : nullptr);
    uint32_t    mp_sz   = (attr != nullptr ? attr->mp_size : 0U);
 
    // Compute the aligned block size and required storage byte count.
    const uint32_t aligned_blk       = stk::memory::BlockMemoryPool::AlignBlockSize(block_size);
    const uint32_t storage_required  = (block_count * aligned_blk);
 
    StkMemPool *pool = nullptr;
 
    if ((mp_mem != nullptr) && (mp_sz >= storage_required))
    {
        // Caller-supplied pool storage - BlockMemoryPool external-storage ctor.
        pool = PlacementNewOrHeap<StkMemPool>(cb_mem, cb_sz,
            block_count, block_size, name, static_cast<uint8_t *>(mp_mem));
    }
    else
    {
        // Heap-allocated pool storage - BlockMemoryPool heap ctor.
        pool = PlacementNewOrHeap<StkMemPool>(cb_mem, cb_sz,
            block_count, block_size, name);
 
        // If the heap ctor failed to allocate storage, clean up and bail.
        if ((pool != nullptr) && !pool->m_mpool.IsStorageValid())
        {
            ObjDestroy(pool);
            return nullptr;
        }
    }
 
    return static_cast<osMemoryPoolId_t>(pool);
}

References stk::memory::BlockMemoryPool::AlignBlockSize(), osMemoryPoolAttr_t::cb_mem, osMemoryPoolAttr_t::cb_size, IsIrqContext(), stk::memory::BlockMemoryPool::IsStorageValid(), StkMemPool::m_mpool, osMemoryPoolAttr_t::mp_mem, osMemoryPoolAttr_t::mp_size, osMemoryPoolAttr_t::name, ObjDestroy(), and PlacementNewOrHeap().

Here is the call graph for this function:

◆ osMessageQueueDelete()

osStatus_t osMessageQueueDelete ( osMessageQueueId_t mq_id )

Delete a Message Queue object.

Parameters

[in] mq_id message queue ID obtained by osMessageQueueNew.

Returns: status code that indicates the execution status of the function.

Definition at line 1632 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (mq_id == nullptr))
        return (IsIrqContext() ? osErrorISR : osErrorParameter);
 
    ObjDestroy(static_cast<StkMessageQueue *>(mq_id));
 
    return osOK;
}

References IsIrqContext(), ObjDestroy(), osErrorISR, osErrorParameter, and osOK.

Here is the call graph for this function:

◆ osMessageQueueGet()

osStatus_t osMessageQueueGet	(	osMessageQueueId_t	mq_id,
		void *	msg_ptr,
		uint8_t *	msg_prio,
		uint32_t	timeout )

Get a Message from a Queue or timeout if Queue is empty.

Parameters

[in]	mq_id	message queue ID obtained by osMessageQueueNew.
[out]	msg_ptr	pointer to buffer for message to get from a queue.
[out]	msg_prio	pointer to buffer for message priority or NULL.
[in]	timeout	CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.

Returns: status code that indicates the execution status of the function.

Definition at line 1571 of file cmsis_os2_stk.cpp.

{
    if (!mq_id || !msg_ptr)
        return osErrorParameter;
    if (IsIrqContext() && (timeout != 0U))
        return osErrorISR;
 
    stk::Timeout stk_timeout = CmsisTimeoutToStk(timeout);
 
    if (!static_cast<StkMessageQueue *>(mq_id)->m_mq.Get(msg_ptr, stk_timeout))
        return ((stk_timeout == stk::NO_WAIT) ? osErrorResource : osErrorTimeout);
 
    if (msg_prio)
        *msg_prio = 0U; // STK queues have no priority lanes.
 
    return osOK;
}

References CmsisTimeoutToStk(), IsIrqContext(), stk::NO_WAIT, osErrorISR, osErrorParameter, osErrorResource, osErrorTimeout, and osOK.

Here is the call graph for this function:

◆ osMessageQueueGetCapacity()

uint32_t osMessageQueueGetCapacity ( osMessageQueueId_t mq_id )

Get maximum number of messages in a Message Queue.

Parameters

[in] mq_id message queue ID obtained by osMessageQueueNew.

Returns: maximum number of messages.

Definition at line 1590 of file cmsis_os2_stk.cpp.

{
    if (mq_id == nullptr)
        return 0U;
 
    return static_cast<uint32_t>(static_cast<StkMessageQueue *>(mq_id)->m_mq.GetCapacity());
}

References stk::sync::MessageQueue::GetCapacity(), and StkMessageQueue::m_mq.

Here is the call graph for this function:

◆ osMessageQueueGetCount()

uint32_t osMessageQueueGetCount ( osMessageQueueId_t mq_id )

Get number of queued messages in a Message Queue.

Parameters

[in] mq_id message queue ID obtained by osMessageQueueNew.

Returns: number of queued messages.

Definition at line 1606 of file cmsis_os2_stk.cpp.

{
    if (mq_id == nullptr)
        return 0U;
 
    return static_cast<uint32_t>(static_cast<StkMessageQueue *>(mq_id)->m_mq.GetCount());
}

References stk::sync::MessageQueue::GetCount(), and StkMessageQueue::m_mq.

Here is the call graph for this function:

◆ osMessageQueueGetMsgSize()

uint32_t osMessageQueueGetMsgSize ( osMessageQueueId_t mq_id )

Get maximum message size in a Message Queue.

Parameters

[in] mq_id message queue ID obtained by osMessageQueueNew.

Returns: maximum message size in bytes.

Definition at line 1598 of file cmsis_os2_stk.cpp.

{
    if (mq_id == nullptr)
        return 0U;
 
    return static_cast<uint32_t>(static_cast<StkMessageQueue *>(mq_id)->m_mq.GetMsgSize());
}

References stk::sync::MessageQueue::GetMsgSize(), and StkMessageQueue::m_mq.

Here is the call graph for this function:

◆ osMessageQueueGetName()

const char * osMessageQueueGetName ( osMessageQueueId_t mq_id )

Get name of a Message Queue object.

Parameters

[in] mq_id message queue ID obtained by osMessageQueueNew.

Returns: name as null-terminated string.

Definition at line 1547 of file cmsis_os2_stk.cpp.

{
    if (mq_id == nullptr)
        return nullptr;
 
    return static_cast<StkMessageQueue *>(mq_id)->m_mq.GetTraceName();
}

◆ osMessageQueueGetSpace()

uint32_t osMessageQueueGetSpace ( osMessageQueueId_t mq_id )

Get number of available slots for messages in a Message Queue.

Parameters

[in] mq_id message queue ID obtained by osMessageQueueNew.

Returns: number of available slots for messages.

Definition at line 1614 of file cmsis_os2_stk.cpp.

{
    if (mq_id == nullptr)
        return 0U;
 
    return static_cast<uint32_t>(static_cast<StkMessageQueue *>(mq_id)->m_mq.GetSpace());
}

References stk::sync::MessageQueue::GetSpace(), and StkMessageQueue::m_mq.

Here is the call graph for this function:

◆ osMessageQueueNew()

osMessageQueueId_t osMessageQueueNew	(	uint32_t	msg_count,
		uint32_t	msg_size,
		const osMessageQueueAttr_t *	attr )

Create and Initialize a Message Queue object.

Parameters

[in]	msg_count	maximum number of messages in queue.
[in]	msg_size	maximum message size in bytes.
[in]	attr	message queue attributes; NULL: default values.

Returns: message queue ID for reference by other functions or NULL in case of error.

Definition at line 1506 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (msg_count == 0U) || (msg_size == 0U))
        return nullptr;
 
    if (msg_count > stk::sync::MessageQueue::CAPACITY_MAX)
        return nullptr;
 
    const char *name         = (attr != nullptr ? attr->name    : nullptr);
    void       *cb_mem       = (attr != nullptr ? attr->cb_mem  : nullptr);
    uint32_t    cb_sz        = (attr != nullptr ? attr->cb_size : 0U);
    void       *ext_buf      = (attr != nullptr ? attr->mq_mem  : nullptr);
    uint32_t    ext_buf_size = (attr != nullptr ? attr->mq_size : 0U);
 
    const uint32_t buf_required = msg_count * msg_size;
 
    StkMessageQueue *mq = nullptr;
 
    if ((ext_buf != nullptr) && (ext_buf_size >= buf_required))
    {
        // Data buffer: use caller-supplied memory.
        mq = PlacementNewOrHeap<StkMessageQueue>(cb_mem, cb_sz,
            msg_count, msg_size, name, static_cast<uint8_t *>(ext_buf));
    }
    else
    {
        // Data buffer: heap-allocated inside StkMessageQueue constructor.
        mq = PlacementNewOrHeap<StkMessageQueue>(cb_mem, cb_sz,
            msg_count, msg_size, name);
 
        if ((mq != nullptr) && (mq->m_mq.GetBuffer() == nullptr))
        {
            ObjDestroy(mq);
            return nullptr;
        }
    }
 
    return static_cast<osMessageQueueId_t>(mq);
}

References stk::sync::MessageQueue::CAPACITY_MAX, osMessageQueueAttr_t::cb_mem, osMessageQueueAttr_t::cb_size, stk::sync::MessageQueue::GetBuffer(), IsIrqContext(), StkMessageQueue::m_mq, osMessageQueueAttr_t::mq_mem, osMessageQueueAttr_t::mq_size, osMessageQueueAttr_t::name, ObjDestroy(), and PlacementNewOrHeap().

Here is the call graph for this function:

◆ osMessageQueuePut()

osStatus_t osMessageQueuePut	(	osMessageQueueId_t	mq_id,
		const void *	msg_ptr,
		uint8_t	msg_prio,
		uint32_t	timeout )

Put a Message into a Queue or timeout if Queue is full.

Parameters

[in]	mq_id	message queue ID obtained by osMessageQueueNew.
[in]	msg_ptr	pointer to buffer with message to put into a queue.
[in]	msg_prio	message priority.
[in]	timeout	CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.

Returns: status code that indicates the execution status of the function.

Definition at line 1555 of file cmsis_os2_stk.cpp.

{
    if (!mq_id || !msg_ptr)
        return osErrorParameter;
    if (IsIrqContext() && (timeout != 0U))
        return osErrorISR;
 
    stk::Timeout stk_timeout = CmsisTimeoutToStk(timeout);
 
    if (!static_cast<StkMessageQueue *>(mq_id)->m_mq.Put(msg_ptr, stk_timeout))
        return ((stk_timeout == stk::NO_WAIT) ? osErrorResource : osErrorTimeout);
 
    return osOK;
}

References CmsisTimeoutToStk(), IsIrqContext(), stk::NO_WAIT, osErrorISR, osErrorParameter, osErrorResource, osErrorTimeout, and osOK.

Here is the call graph for this function:

◆ osMessageQueueReset()

osStatus_t osMessageQueueReset ( osMessageQueueId_t mq_id )

Reset a Message Queue to initial empty state.

Parameters

[in] mq_id message queue ID obtained by osMessageQueueNew.

Returns: status code that indicates the execution status of the function.

Definition at line 1622 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (mq_id == nullptr))
        return (IsIrqContext() ? osErrorISR : osErrorParameter);
 
    static_cast<StkMessageQueue *>(mq_id)->m_mq.Reset();
 
    return osOK;
}

References IsIrqContext(), osErrorISR, osErrorParameter, and osOK.

Here is the call graph for this function:

◆ osMutexAcquire()

osStatus_t osMutexAcquire	(	osMutexId_t	mutex_id,
		uint32_t	timeout )

Acquire a Mutex or timeout if it is locked.

Parameters

[in]	mutex_id	mutex ID obtained by osMutexNew.
[in]	timeout	CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.

Returns: status code that indicates the execution status of the function.

Definition at line 1251 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return osErrorISR;
    if (mutex_id == nullptr)
        return osErrorParameter;
 
    StkMutex *m = static_cast<StkMutex *>(mutex_id);
    stk::Timeout stk_timeout = CmsisTimeoutToStk(timeout);
 
    bool acquired = m->m_mutex.TimedLock(stk_timeout);
    if (!acquired)
        return ((stk_timeout == stk::NO_WAIT) ? osErrorResource : osErrorTimeout);
 
    return osOK;
}

References CmsisTimeoutToStk(), IsIrqContext(), StkMutex::m_mutex, stk::NO_WAIT, osErrorISR, osErrorParameter, osErrorResource, osErrorTimeout, osOK, and stk::sync::Mutex::TimedLock().

Here is the call graph for this function:

◆ osMutexDelete()

osStatus_t osMutexDelete ( osMutexId_t mutex_id )

Delete a Mutex object.

Parameters

[in] mutex_id mutex ID obtained by osMutexNew.

Returns: status code that indicates the execution status of the function.

Definition at line 1291 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (mutex_id == nullptr))
        return IsIrqContext() ? osErrorISR : osErrorParameter;
 
    ObjDestroy(static_cast<StkMutex *>(mutex_id));
    return osOK;
}

References IsIrqContext(), ObjDestroy(), osErrorISR, osErrorParameter, and osOK.

Here is the call graph for this function:

◆ osMutexGetName()

const char * osMutexGetName ( osMutexId_t mutex_id )

Get name of a Mutex object.

Parameters

[in] mutex_id mutex ID obtained by osMutexNew.

Returns: name as null-terminated string.

Definition at line 1243 of file cmsis_os2_stk.cpp.

{
    if (mutex_id == nullptr)
        return nullptr;
 
    return static_cast<StkMutex *>(mutex_id)->m_mutex.GetTraceName();
}

◆ osMutexGetOwner()

osThreadId_t osMutexGetOwner ( osMutexId_t mutex_id )

Get Thread which owns a Mutex object.

Parameters

[in] mutex_id mutex ID obtained by osMutexNew.

Returns: thread ID of owner thread or NULL when mutex was not acquired.

Definition at line 1279 of file cmsis_os2_stk.cpp.

{
    if (mutex_id == nullptr)
        return nullptr;
 
    stk::TId tid = static_cast<StkMutex *>(mutex_id)->m_mutex.GetOwner();
 
    // tid is hw::PtrToWord(this) where 'this' is the StkThread* - cast it back.
    return reinterpret_cast<osThreadId_t>(static_cast<void *>(
        reinterpret_cast<StkThread *>(static_cast<uintptr_t>(tid))));
}

◆ osMutexNew()

osMutexId_t osMutexNew ( const osMutexAttr_t * attr )

Create and Initialize a Mutex object.

Parameters

[in] attr mutex attributes; NULL: default values.

Returns: mutex ID for reference by other functions or NULL in case of error.

Definition at line 1221 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return nullptr;
 
    // osMutexPrioInherit: ignored, supported by default.
    // osMutexRecursive: ignored, sync::Mutex is always recursive.
    // osMutexRobust: will assert as unsafe code.
    const char *name   = (attr != nullptr ? attr->name    : nullptr);
    void       *cb_mem = (attr != nullptr ? attr->cb_mem  : nullptr);
    uint32_t    cb_sz  = (attr != nullptr ? attr->cb_size : 0U);
    bool        robust = (attr != nullptr) && (attr->attr_bits & osMutexRobust);
 
    // disallow osMutexRobust
    STK_ASSERT(!robust);
    if (robust)
        return nullptr;
 
    StkMutex *m = PlacementNewOrHeap<StkMutex>(cb_mem, cb_sz, name);
    return static_cast<osMutexId_t>(m);
}

References osMutexAttr_t::attr_bits, osMutexAttr_t::cb_mem, osMutexAttr_t::cb_size, IsIrqContext(), osMutexAttr_t::name, osMutexRobust, PlacementNewOrHeap(), and STK_ASSERT.

Here is the call graph for this function:

◆ osMutexRelease()

osStatus_t osMutexRelease ( osMutexId_t mutex_id )

Release a Mutex that was acquired by osMutexAcquire.

Parameters

[in] mutex_id mutex ID obtained by osMutexNew.

Returns: status code that indicates the execution status of the function.

Definition at line 1268 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return osErrorISR;
    if (mutex_id == nullptr)
        return osErrorParameter;
 
    static_cast<StkMutex *>(mutex_id)->m_mutex.Unlock();
    return osOK;
}

References IsIrqContext(), osErrorISR, osErrorParameter, and osOK.

Here is the call graph for this function:

◆ osSemaphoreAcquire()

osStatus_t osSemaphoreAcquire	(	osSemaphoreId_t	semaphore_id,
		uint32_t	timeout )

Acquire a Semaphore token or timeout if no tokens are available.

Parameters

[in]	semaphore_id	semaphore ID obtained by osSemaphoreNew.
[in]	timeout	CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.

Returns: status code that indicates the execution status of the function.

Definition at line 1334 of file cmsis_os2_stk.cpp.

{
    if (semaphore_id == nullptr)
        return osErrorParameter;
    if (IsIrqContext() && (timeout != 0U))
        return osErrorISR;
 
    StkSemaphore *s = static_cast<StkSemaphore *>(semaphore_id);
    stk::Timeout stk_timeout = CmsisTimeoutToStk(timeout);
 
    bool acquired = s->m_semaphore.Wait(stk_timeout);
    if (!acquired)
        return (stk_timeout == stk::NO_WAIT) ? osErrorResource : osErrorTimeout;
 
    return osOK;
}

References CmsisTimeoutToStk(), IsIrqContext(), StkSemaphore::m_semaphore, stk::NO_WAIT, osErrorISR, osErrorParameter, osErrorResource, osErrorTimeout, osOK, and stk::sync::Semaphore::Wait().

Here is the call graph for this function:

◆ osSemaphoreDelete()

osStatus_t osSemaphoreDelete ( osSemaphoreId_t semaphore_id )

Delete a Semaphore object.

Parameters

[in] semaphore_id semaphore ID obtained by osSemaphoreNew.

Returns: status code that indicates the execution status of the function.

Definition at line 1368 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (semaphore_id == nullptr))
        return (IsIrqContext() ? osErrorISR : osErrorParameter);
 
    ObjDestroy(static_cast<StkSemaphore *>(semaphore_id));
    return osOK;
}

References IsIrqContext(), ObjDestroy(), osErrorISR, osErrorParameter, and osOK.

Here is the call graph for this function:

◆ osSemaphoreGetCount()

uint32_t osSemaphoreGetCount ( osSemaphoreId_t semaphore_id )

Get current Semaphore token count.

Parameters

[in] semaphore_id semaphore ID obtained by osSemaphoreNew.

Returns: number of tokens available.

Definition at line 1360 of file cmsis_os2_stk.cpp.

{
    if (semaphore_id == nullptr)
        return 0U;
 
    return static_cast<uint32_t>(static_cast<StkSemaphore *>(semaphore_id)->m_semaphore.GetCount());
}

References stk::sync::Semaphore::GetCount(), and StkSemaphore::m_semaphore.

Here is the call graph for this function:

◆ osSemaphoreGetName()

const char * osSemaphoreGetName ( osSemaphoreId_t semaphore_id )

Get name of a Semaphore object.

Parameters

[in] semaphore_id semaphore ID obtained by osSemaphoreNew.

Returns: name as null-terminated string.

Definition at line 1326 of file cmsis_os2_stk.cpp.

{
    if (semaphore_id == nullptr)
        return nullptr;
 
    return static_cast<StkSemaphore *>(semaphore_id)->m_semaphore.GetTraceName();
}

◆ osSemaphoreNew()

osSemaphoreId_t osSemaphoreNew	(	uint32_t	max_count,
		uint32_t	initial_count,
		const osSemaphoreAttr_t *	attr )

Create and Initialize a Semaphore object.

Parameters

[in]	max_count	maximum number of available tokens.
[in]	initial_count	initial number of available tokens.
[in]	attr	semaphore attributes; NULL: default values.

Returns: semaphore ID for reference by other functions or NULL in case of error.

Definition at line 1305 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return nullptr;
 
    if ((max_count == 0U) || (initial_count > max_count))
        return nullptr;
 
    // STK Semaphore uses uint16_t counters, clamp to stk::sync::Semaphore::COUNT_MAX.
    uint16_t mc = stk::Min(max_count, static_cast<uint32_t>(stk::sync::Semaphore::COUNT_MAX));
    uint16_t ic = stk::Min(initial_count, static_cast<uint32_t>(stk::sync::Semaphore::COUNT_MAX));
 
    const char *name   = (attr != nullptr ? attr->name    : nullptr);
    void       *cb_mem = (attr != nullptr ? attr->cb_mem  : nullptr);
    uint32_t    cb_sz  = (attr != nullptr ? attr->cb_size : 0U);
 
    StkSemaphore *s = PlacementNewOrHeap<StkSemaphore>(cb_mem, cb_sz, ic, mc, name);
    return static_cast<osSemaphoreId_t>(s);
}

References osSemaphoreAttr_t::cb_mem, osSemaphoreAttr_t::cb_size, stk::sync::Semaphore::COUNT_MAX, IsIrqContext(), stk::Min(), osSemaphoreAttr_t::name, and PlacementNewOrHeap().

Here is the call graph for this function:

◆ osSemaphoreRelease()

osStatus_t osSemaphoreRelease ( osSemaphoreId_t semaphore_id )

Release a Semaphore token up to the initial maximum count.

Parameters

[in] semaphore_id semaphore ID obtained by osSemaphoreNew.

Returns: status code that indicates the execution status of the function.

Definition at line 1351 of file cmsis_os2_stk.cpp.

{
    if (semaphore_id == nullptr)
        return osErrorParameter;
 
    static_cast<StkSemaphore *>(semaphore_id)->m_semaphore.Signal();
    return osOK;
}

References osErrorParameter, and osOK.

◆ osThreadDetach()

osStatus_t osThreadDetach ( osThreadId_t thread_id )

Detach a thread (thread storage can be reclaimed when thread terminates).

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: status code that indicates the execution status of the function.

Definition at line 836 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (thread_id == nullptr))
        return IsIrqContext() ? osErrorISR : osErrorParameter;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
 
    stk::sync::ScopedCriticalSection cs_;
 
    switch (t->m_join_state)
    {
    case StkThread::JoinState::Detached:
        // already detached - CMSIS spec says this is an error
        return osError;
 
    case StkThread::JoinState::Joined:
        // already joined - cannot detach
        return osError;
 
    case StkThread::JoinState::Exited:
        // thread finished but nobody joined yet, transition to Detached
        // and free the control block now, since no joiner will ever do it
        t->m_join_state = StkThread::JoinState::Detached;
        ObjDestroy(t); // safe: task slot already freed by the kernel
        return osOK;
 
    case StkThread::JoinState::Joinable:
        // normal case: thread is still running or just hasn't been joined
        t->m_join_state = StkThread::JoinState::Detached;
        return osOK;
    }
 
    return osError;
}

References StkThread::Detached, StkThread::Exited, IsIrqContext(), StkThread::Joinable, StkThread::Joined, StkThread::m_join_state, ObjDestroy(), osError, osErrorISR, osErrorParameter, and osOK.

Here is the call graph for this function:

◆ osThreadEnumerate()

uint32_t osThreadEnumerate	(	osThreadId_t *	thread_array,
		uint32_t	array_items )

Enumerate active threads.

Parameters

[out]	thread_array	pointer to array for retrieving thread IDs.
[in]	array_items	maximum number of items in array for retrieving thread IDs.

Returns: number of enumerated threads.

Definition at line 960 of file cmsis_os2_stk.cpp.

{
    uint32_t result_count = 0U;
    const osKernelState_t kstate = osKernelGetState();
 
    // kernel must be active and buffer must be valid
    if ((kstate != osKernelInactive) && (thread_array != nullptr) && (array_items != 0U))
    {
        // cast the raw pointer array to the expected ITask* destination type
        stk::ITask **tasks_destination = reinterpret_cast<stk::ITask **>(thread_array);
 
        // bind raw destination buffer into a temporary ArrayView object
        const size_t count = g_StkKernel.EnumerateTasks(
            stk::ArrayView<stk::ITask *>(tasks_destination, static_cast<size_t>(array_items)));
 
        result_count = static_cast<uint32_t>(count);
    }
 
    return result_count;
}

References g_StkKernel, osKernelGetState(), and osKernelInactive.

Here is the call graph for this function:

◆ osThreadExit()

void osThreadExit ( void )

Terminate execution of current running thread.

Definition at line 913 of file cmsis_os2_stk.cpp.

{
    StkThread *t = static_cast<StkThread *>(osThreadGetId());
 
    g_StkKernel.ScheduleTaskRemoval(t);
 
    // Wait for removal.
    for (;;)
        stk::Yield();
}

References __NO_RETURN, g_StkKernel, osThreadGetId(), and stk::Yield().

Here is the call graph for this function:

◆ osThreadFeedWatchdog()

osStatus_t osThreadFeedWatchdog ( uint32_t ticks )

Feed watchdog of the current running thread.

Parameters

[in] ticks interval in kernel ticks until the thread watchdog expires, or 0 to stop the watchdog

Returns: status code that indicates the execution status of the function.

◆ osThreadFlagsClear()

uint32_t osThreadFlagsClear ( uint32_t flags )

Clear the specified Thread Flags of current running thread.

Parameters

[in] flags specifies the flags of the thread that shall be cleared.

Returns: thread flags before clearing or error code if highest bit set.

Definition at line 996 of file cmsis_os2_stk.cpp.

{
    osThreadId_t self = osThreadGetId();
    if (self == nullptr)
        return osFlagsErrorUnknown;
 
    StkThread *t = static_cast<StkThread *>(self);
 
    uint32_t result = t->m_thread_flags.Clear(flags);
    return StkFlagsResultToCmsis(result);
}

References stk::sync::EventFlags::Clear(), StkThread::m_thread_flags, osFlagsErrorUnknown, osThreadGetId(), and StkFlagsResultToCmsis().

Here is the call graph for this function:

◆ osThreadFlagsGet()

uint32_t osThreadFlagsGet ( void )

Get the current Thread Flags of current running thread.

Returns: current thread flags.

Definition at line 1008 of file cmsis_os2_stk.cpp.

{
    osThreadId_t self = osThreadGetId();
    if (self == nullptr)
        return 0U;
 
    return static_cast<StkThread *>(self)->m_thread_flags.Get();
}

References osThreadGetId().

Here is the call graph for this function:

◆ osThreadFlagsSet()

uint32_t osThreadFlagsSet	(	osThreadId_t	thread_id,
		uint32_t	flags )

Set the specified Thread Flags of a thread.

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	flags	specifies the flags of the thread that shall be set.

Returns: thread flags after setting or error code if highest bit set.

Definition at line 985 of file cmsis_os2_stk.cpp.

{
    if ((thread_id == nullptr) || ((flags & osFlagsError) != 0))
        return osFlagsErrorParameter;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
 
    uint32_t result = t->m_thread_flags.Set(flags);
    return StkFlagsResultToCmsis(result);
}

References StkThread::m_thread_flags, osFlagsError, osFlagsErrorParameter, stk::sync::EventFlags::Set(), and StkFlagsResultToCmsis().

Here is the call graph for this function:

◆ osThreadFlagsWait()

uint32_t osThreadFlagsWait	(	uint32_t	flags,
		uint32_t	options,
		uint32_t	timeout )

Wait for one or more Thread Flags of the current running thread to become signaled.

Parameters

[in]	flags	specifies the flags to wait for.
[in]	options	specifies flags options (osFlagsXxxx).
[in]	timeout	CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.

Returns: thread flags before clearing or error code if highest bit set.

Definition at line 1017 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return osFlagsErrorISR;
 
    osThreadId_t self = osThreadGetId();
    if (self == nullptr)
        return osFlagsErrorUnknown;
 
    StkThread *t = static_cast<StkThread *>(self);
 
    uint32_t result = t->m_thread_flags.Wait(flags, CmsisFlagsOptionsToStk(options),
        CmsisTimeoutToStk(timeout));
 
    return StkFlagsResultToCmsis(result);
}

References CmsisFlagsOptionsToStk(), CmsisTimeoutToStk(), IsIrqContext(), StkThread::m_thread_flags, osFlagsErrorISR, osFlagsErrorUnknown, osThreadGetId(), StkFlagsResultToCmsis(), and stk::sync::EventFlags::Wait().

Here is the call graph for this function:

◆ osThreadGetAffinityMask()

uint32_t osThreadGetAffinityMask ( osThreadId_t thread_id )

Get current processor affinity mask of a thread.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: current processor affinity mask of the specified thread.

◆ osThreadGetClass()

uint32_t osThreadGetClass ( osThreadId_t thread_id )

Get safety class of a thread.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: safety class of the specified thread.

◆ osThreadGetCount()

uint32_t osThreadGetCount ( void )

Get number of active threads.

Returns: number of active threads.

Definition at line 949 of file cmsis_os2_stk.cpp.

{
    if (osKernelGetState() == osKernelInactive)
        return 0U;
 
    // avoid race with OnTick
    stk::sync::ScopedCriticalSection cs_;
 
    return static_cast<uint32_t>(g_StkKernel.GetSwitchStrategy()->GetSize());
}

References g_StkKernel, osKernelGetState(), and osKernelInactive.

Here is the call graph for this function:

◆ osThreadGetId()

osThreadId_t osThreadGetId ( void )

Return the thread ID of the current running thread.

Returns: thread ID for reference by other functions or NULL in case of error.

Definition at line 725 of file cmsis_os2_stk.cpp.

{
    if ((osKernelGetState() == osKernelInactive) || IsIrqContext())
        return nullptr;
 
    // STK's GetTid() returns the ITask pointer cast to Word.
    stk::TId tid = stk::GetTid();
 
    // tid is hw::PtrToWord(this) where 'this' is the StkThread* - cast it back.
    return reinterpret_cast<osThreadId_t>(static_cast<void *>(
        reinterpret_cast<StkThread *>(static_cast<uintptr_t>(tid))));
}

References stk::GetTid(), IsIrqContext(), osKernelGetState(), and osKernelInactive.

Referenced by osThreadExit(), osThreadFlagsClear(), osThreadFlagsGet(), osThreadFlagsWait(), osThreadGetState(), and osThreadJoin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ osThreadGetName()

const char * osThreadGetName ( osThreadId_t thread_id )

Get name of a thread.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: name as null-terminated string.

Definition at line 717 of file cmsis_os2_stk.cpp.

{
    if (thread_id == nullptr)
        return nullptr;
 
    return static_cast<StkThread *>(thread_id)->m_name;
}

◆ osThreadGetPriority()

osPriority_t osThreadGetPriority ( osThreadId_t thread_id )

Get current priority of a thread.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: current priority value of the specified thread.

Definition at line 786 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (thread_id == nullptr))
        return osPriorityError;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
    return StkPrioToCmsis(t->m_stk_priority);
}

References IsIrqContext(), StkThread::m_stk_priority, osPriorityError, and StkPrioToCmsis().

Here is the call graph for this function:

◆ osThreadGetStackSize()

uint32_t osThreadGetStackSize ( osThreadId_t thread_id )

Get stack size of a thread.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: stack size in bytes.

Definition at line 754 of file cmsis_os2_stk.cpp.

{
    if (thread_id == nullptr)
        return 0U;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
    return static_cast<uint32_t>(t->GetStackSizeBytes());
}

References StkThread::GetStackSizeBytes().

Here is the call graph for this function:

◆ osThreadGetStackSpace()

uint32_t osThreadGetStackSpace ( osThreadId_t thread_id )

Get available stack space of a thread based on stack watermark recording during execution.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: remaining stack space in bytes.

Definition at line 763 of file cmsis_os2_stk.cpp.

{
    if (thread_id == nullptr)
        return 0U;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
    return static_cast<uint32_t>(t->GetStackSpace() * sizeof(stk::Word));
}

References stk::IStackMemory::GetStackSpace().

Here is the call graph for this function:

◆ osThreadGetState()

osThreadState_t osThreadGetState ( osThreadId_t thread_id )

Get current thread state of a thread.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: current thread state of the specified thread.

Definition at line 738 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (thread_id == nullptr))
        return osThreadError;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
 
    if (t->m_suspended)
        return osThreadBlocked;
 
    if (thread_id == osThreadGetId())
        return osThreadRunning;
 
    return osThreadReady;
}

References IsIrqContext(), StkThread::m_suspended, osThreadBlocked, osThreadError, osThreadGetId(), osThreadReady, and osThreadRunning.

Here is the call graph for this function:

◆ osThreadGetZone()

uint32_t osThreadGetZone ( osThreadId_t thread_id )

Get MPU protected zone of a thread.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: MPU protected zone of the specified thread.

References __NO_RETURN.

◆ osThreadJoin()

osStatus_t osThreadJoin ( osThreadId_t thread_id )

Wait for specified thread to terminate.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: status code that indicates the execution status of the function.

Definition at line 871 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (thread_id == nullptr))
        return IsIrqContext() ? osErrorISR : osErrorParameter;
 
    // Self-join is undefined behavior per POSIX / CMSIS spec.
    if (thread_id == osThreadGetId())
        return osErrorParameter;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
 
    stk::sync::ScopedCriticalSection cs_;
 
    // Only joinable threads can be joined.
    if (t->m_join_state == StkThread::JoinState::Detached)
        return osError;
 
    // Double-join: second caller always gets an error.
    if (t->m_join_state == StkThread::JoinState::Joined)
        return osError;
 
    t->m_join_state = StkThread::JoinState::Joined;
 
    // Block until OnExit() fires (transitions state to Exited).
    // m_join_cv.Wait() atomically releases m_join_mutex and suspends.
    while (t->m_join_state == StkThread::JoinState::Joined)
    {
        // WAIT_INFINITE - CMSIS osThreadJoin has no timeout parameter.
        t->m_join_cv.Wait(cs_, stk::WAIT_INFINITE);
    }
 
    // At this point m_join_state == Exited (or Detached if someone
    // raced osThreadDetach - treat that as an error).
    if (t->m_join_state != StkThread::JoinState::Exited)
        return osError;
 
    // Free the control block - the kernel has already freed the slot.
    ObjDestroy(t);
 
    return osOK;
}

References StkThread::Detached, StkThread::Exited, IsIrqContext(), StkThread::Joined, StkThread::m_join_cv, StkThread::m_join_state, ObjDestroy(), osError, osErrorISR, osErrorParameter, osOK, osThreadGetId(), stk::sync::ConditionVariable::Wait(), and stk::WAIT_INFINITE.

Here is the call graph for this function:

◆ osThreadNew()

osThreadId_t osThreadNew	(	osThreadFunc_t	func,
		void *	argument,
		const osThreadAttr_t *	attr )

Create a thread and add it to Active Threads.

Parameters

[in]	func	thread function.
[in]	argument	pointer that is passed to the thread function as start argument.
[in]	attr	thread attributes; NULL: default values.

Returns: thread ID for reference by other functions or NULL in case of error.

Definition at line 643 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (func == nullptr) || (osKernelGetState() == osKernelInactive))
        return nullptr;
 
    bool     joinable = (attr != nullptr) && (attr->attr_bits & osThreadJoinable);
    void    *cb_mem   = (attr != nullptr ? attr->cb_mem  : nullptr);
    uint32_t cb_size  = (attr != nullptr ? attr->cb_size : 0U);
 
    StkThread *t = PlacementNewOrHeap<StkThread>(cb_mem, cb_size);
    if (t == nullptr)
        return nullptr;
 
    t->m_func       = func;
    t->m_argument   = argument;
    t->m_name       = nullptr;
    t->m_join_state = (joinable ? StkThread::JoinState::Joinable : StkThread::JoinState::Detached);
 
    osPriority_t cmsis_prio = osPriorityNormal;
    size_t stack_words      = CMSIS_STK_DEFAULT_STACK_WORDS;
 
    if (attr != nullptr)
    {
        t->m_name = attr->name;
 
        if (attr->priority != osPriorityNone)
            cmsis_prio = attr->priority;
 
        if ((cmsis_prio < osPriorityIdle) || (cmsis_prio > osPriorityISR))
        {
            ObjDestroy(t);
            return nullptr;
        }
 
        // Stack: prefer caller-provided memory.
        if ((attr->stack_mem != nullptr) && (attr->stack_size > 0U))
        {
            size_t words = attr->stack_size / sizeof(stk::Word);
            if (words < CMSIS_STK_MIN_STACK_WORDS)
                words = CMSIS_STK_MIN_STACK_WORDS;
 
            t->m_stack       = static_cast<stk::Word *>(attr->stack_mem);
            t->m_stack_size  = words;
            t->m_stack_owned = false;
        }
        else
        if (attr->stack_size > 0U)
        {
            stack_words = attr->stack_size / sizeof(stk::Word);
            if (stack_words < CMSIS_STK_MIN_STACK_WORDS)
                stack_words = CMSIS_STK_MIN_STACK_WORDS;
        }
    }
 
    // Allocate stack if not caller-provided.
    if (t->m_stack == nullptr)
    {
        t->m_stack = new (std::nothrow) stk::Word[stack_words];
        if (t->m_stack == nullptr)
        {
            ObjDestroy(t);
            return nullptr;
        }
        t->m_stack_size  = stack_words;
        t->m_stack_owned = true;
    }
 
    t->m_stk_priority = CmsisPrioToStk(cmsis_prio);
 
    g_StkKernel.AddTask(t);
 
    return static_cast<osThreadId_t>(t);
}

References osThreadAttr_t::attr_bits, osThreadAttr_t::cb_mem, osThreadAttr_t::cb_size, CMSIS_STK_DEFAULT_STACK_WORDS, CMSIS_STK_MIN_STACK_WORDS, CmsisPrioToStk(), StkThread::Detached, g_StkKernel, IsIrqContext(), StkThread::Joinable, StkThread::m_argument, StkThread::m_func, StkThread::m_join_state, StkThread::m_name, StkThread::m_stack, StkThread::m_stack_owned, StkThread::m_stack_size, StkThread::m_stk_priority, osThreadAttr_t::name, ObjDestroy(), osKernelGetState(), osKernelInactive, osPriorityIdle, osPriorityISR, osPriorityNone, osPriorityNormal, osThreadJoinable, PlacementNewOrHeap(), osThreadAttr_t::priority, osThreadAttr_t::stack_mem, and osThreadAttr_t::stack_size.

Here is the call graph for this function:

◆ osThreadProtectPrivileged()

osStatus_t osThreadProtectPrivileged ( void )

Protect creation of privileged threads.

Returns: status code that indicates the execution status of the function.

◆ osThreadResume()

osStatus_t osThreadResume ( osThreadId_t thread_id )

Resume execution of a thread.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: status code that indicates the execution status of the function.

Definition at line 818 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (thread_id == nullptr) || (osKernelGetState() == osKernelInactive))
        return IsIrqContext() ? osErrorISR : osErrorParameter;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
 
    stk::sync::ScopedCriticalSection cs_;
 
    if (!t->m_suspended)
        return osOK; // not suspended, nothing to do
 
    g_StkKernel.ResumeTask(t);
    t->m_suspended = false;
 
    return osOK;
}

References g_StkKernel, IsIrqContext(), StkThread::m_suspended, osErrorISR, osErrorParameter, osKernelGetState(), osKernelInactive, and osOK.

Here is the call graph for this function:

◆ osThreadResumeClass()

osStatus_t osThreadResumeClass	(	uint32_t	safety_class,
		uint32_t	mode )

Resume execution of threads for specified safety classes.

Parameters

[in]	safety_class	safety class.
[in]	mode	safety mode.

Returns: status code that indicates the execution status of the function.

◆ osThreadSetAffinityMask()

osStatus_t osThreadSetAffinityMask	(	osThreadId_t	thread_id,
		uint32_t	affinity_mask )

Set processor affinity mask of a thread.

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	affinity_mask	processor affinity mask for the thread.

Returns: status code that indicates the execution status of the function.

◆ osThreadSetPriority()

osStatus_t osThreadSetPriority	(	osThreadId_t	thread_id,
		osPriority_t	priority )

Change priority of a thread.

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	priority	new priority value for the thread function.

Returns: status code that indicates the execution status of the function.

Definition at line 772 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (thread_id == nullptr))
        return IsIrqContext() ? osErrorISR : osErrorParameter;
 
    if ((priority < osPriorityIdle) || (priority > osPriorityISR))
        return osErrorParameter;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
    t->m_stk_priority = CmsisPrioToStk(priority);
 
    return osOK;
}

References CmsisPrioToStk(), IsIrqContext(), StkThread::m_stk_priority, osErrorISR, osErrorParameter, osOK, osPriorityIdle, and osPriorityISR.

Here is the call graph for this function:

◆ osThreadSuspend()

osStatus_t osThreadSuspend ( osThreadId_t thread_id )

Suspend execution of a thread.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: status code that indicates the execution status of the function.

Definition at line 806 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (thread_id == nullptr) || (osKernelGetState() == osKernelInactive))
        return IsIrqContext() ? osErrorISR : osErrorParameter;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
 
    g_StkKernel.SuspendTask(t, t->m_suspended);
 
    return osOK;
}

References g_StkKernel, IsIrqContext(), StkThread::m_suspended, osErrorISR, osErrorParameter, osKernelGetState(), osKernelInactive, and osOK.

Here is the call graph for this function:

◆ osThreadSuspendClass()

osStatus_t osThreadSuspendClass	(	uint32_t	safety_class,
		uint32_t	mode )

Suspend execution of threads for specified safety classes.

Parameters

[in]	safety_class	safety class.
[in]	mode	safety mode.

Returns: status code that indicates the execution status of the function.

◆ osThreadTerminate()

osStatus_t osThreadTerminate ( osThreadId_t thread_id )

Terminate execution of a thread.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: status code that indicates the execution status of the function.

Definition at line 924 of file cmsis_os2_stk.cpp.

{
    if ((thread_id == nullptr) || (osKernelGetState() == osKernelInactive))
        return osErrorParameter;
 
    StkThread *t = static_cast<StkThread *>(thread_id);
 
    stk::sync::ScopedCriticalSection cs_;
 
    // RemoveTask triggers the STATE_REMOVE_PENDING path in the kernel,
    // which will call OnExit() before freeing the slot.
    g_StkKernel.ScheduleTaskRemoval(t);
 
    // For detached threads, free immediately (no joiner expected).
    // For joinable threads, OnExit() will wake the joiner; the joiner
    // calls ObjDestroy(). Do NOT free here.
    {
        if (t->m_join_state == StkThread::JoinState::Detached)
            ObjDestroy(t);
        // else: joiner owns the lifetime
    }
 
    return osOK;
}

References StkThread::Detached, g_StkKernel, StkThread::m_join_state, ObjDestroy(), osErrorParameter, osKernelGetState(), osKernelInactive, and osOK.

Here is the call graph for this function:

◆ osThreadTerminateZone()

osStatus_t osThreadTerminateZone ( uint32_t zone )

Terminate execution of threads assigned to a specified MPU protected zone.

Parameters

[in] zone MPU protected zone.

Returns: status code that indicates the execution status of the function.

◆ osThreadYield()

osStatus_t osThreadYield ( void )

Pass control to next thread that is in state READY.

Returns: status code that indicates the execution status of the function.

Definition at line 795 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext())
        return osErrorISR;
    if (osKernelGetState() == osKernelInactive)
        return osError;
 
    stk::Yield();
    return osOK;
}

References IsIrqContext(), osError, osErrorISR, osKernelGetState(), osKernelInactive, osOK, and stk::Yield().

Here is the call graph for this function:

◆ osTimerDelete()

osStatus_t osTimerDelete ( osTimerId_t timer_id )

Delete a timer.

Parameters

[in] timer_id timer ID obtained by osTimerNew.

Returns: status code that indicates the execution status of the function.

Definition at line 1129 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (timer_id == nullptr))
        return IsIrqContext() ? osErrorISR : osErrorParameter;
 
    StkTimer *timer = static_cast<StkTimer *>(timer_id);
 
    if ((g_TimerHost != nullptr) && timer->IsActive())
        g_TimerHost->Stop(*timer);
 
    ObjDestroy(timer);
    return osOK;
}

References g_TimerHost, stk::time::TimerHost::Timer::IsActive(), IsIrqContext(), ObjDestroy(), osErrorISR, osErrorParameter, and osOK.

Here is the call graph for this function:

◆ osTimerGetName()

const char * osTimerGetName ( osTimerId_t timer_id )

Get name of a timer.

Parameters

[in] timer_id timer ID obtained by osTimerNew.

Returns: name as null-terminated string.

Definition at line 1085 of file cmsis_os2_stk.cpp.

{
    if (timer_id == nullptr)
        return nullptr;
 
    return static_cast<StkTimer *>(timer_id)->m_name;
}

◆ osTimerIsRunning()

uint32_t osTimerIsRunning ( osTimerId_t timer_id )

Check if a timer is running.

Parameters

[in] timer_id timer ID obtained by osTimerNew.

Returns: 0 not running, 1 running.

Definition at line 1121 of file cmsis_os2_stk.cpp.

{
    if (timer_id == nullptr)
        return 0U;
 
    return (static_cast<StkTimer *>(timer_id)->IsActive() ? 1U : 0U);
}

◆ osTimerNew()

osTimerId_t osTimerNew	(	osTimerFunc_t	func,
		osTimerType_t	type,
		void *	argument,
		const osTimerAttr_t *	attr )

Create and Initialize a timer.

Parameters

[in]	func	function pointer to callback function.
[in]	type	osTimerOnce for one-shot or osTimerPeriodic for periodic behavior.
[in]	argument	argument to the timer callback function.
[in]	attr	timer attributes; NULL: default values.

Returns: timer ID for reference by other functions or NULL in case of error.

Definition at line 1068 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (func == nullptr) || (osKernelGetState() == osKernelInactive))
        return nullptr;
 
    if (!StkTimer::EnsureTimerHostCreated())
        return nullptr;
 
    const char *name   = (attr != nullptr ? attr->name    : nullptr);
    void       *cb_mem = (attr != nullptr ? attr->cb_mem  : nullptr);
    uint32_t    cb_sz  = (attr != nullptr ? attr->cb_size : 0U);
 
    StkTimer *timer = PlacementNewOrHeap<StkTimer>(cb_mem, cb_sz, func, type, argument, name);
    return static_cast<osTimerId_t>(timer);
}

References osTimerAttr_t::cb_mem, osTimerAttr_t::cb_size, StkTimer::EnsureTimerHostCreated(), IsIrqContext(), osTimerAttr_t::name, osKernelGetState(), osKernelInactive, and PlacementNewOrHeap().

Here is the call graph for this function:

◆ osTimerStart()

osStatus_t osTimerStart	(	osTimerId_t	timer_id,
		uint32_t	ticks )

Start or restart a timer.

Parameters

[in]	timer_id	timer ID obtained by osTimerNew.
[in]	ticks	time ticks value of the timer.

Returns: status code that indicates the execution status of the function.

Definition at line 1093 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (timer_id == nullptr) || (g_TimerHost == nullptr))
        return IsIrqContext() ? osErrorISR : osErrorParameter;
 
    StkTimer *timer = static_cast<StkTimer *>(timer_id);
 
    uint32_t period = (timer->m_type == osTimerPeriodic) ? ticks : 0U;
    timer->m_period_ticks = period;
 
    bool ok = g_TimerHost->Restart(*timer, ticks, period);
    return (ok ? osOK : osError);
}

References g_TimerHost, IsIrqContext(), StkTimer::m_period_ticks, StkTimer::m_type, osError, osErrorISR, osErrorParameter, osOK, and osTimerPeriodic.

Here is the call graph for this function:

◆ osTimerStop()

osStatus_t osTimerStop ( osTimerId_t timer_id )

Stop a timer.

Parameters

[in] timer_id timer ID obtained by osTimerNew.

Returns: status code that indicates the execution status of the function.

Definition at line 1107 of file cmsis_os2_stk.cpp.

{
    if (IsIrqContext() || (timer_id == nullptr) || (g_TimerHost == nullptr))
        return IsIrqContext() ? osErrorISR : osErrorParameter;
 
    StkTimer *timer = static_cast<StkTimer *>(timer_id);
 
    if (!timer->IsActive())
        return osErrorResource;
 
    bool ok = g_TimerHost->Stop(*timer);
    return (ok ? osOK : osError);
}

References g_TimerHost, stk::time::TimerHost::Timer::IsActive(), IsIrqContext(), osError, osErrorISR, osErrorParameter, osErrorResource, and osOK.

Here is the call graph for this function:

◆ osWatchdogAlarm_Handler()

uint32_t osWatchdogAlarm_Handler ( osThreadId_t thread_id )

Handler for expired thread watchdogs.

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

Returns: new watchdog reload value or 0 to stop the watchdog.

◆ osZoneSetup_Callback()

void osZoneSetup_Callback ( uint32_t zone )

Setup MPU protected zone (called when zone changes).

Parameters

[in] zone zone number.

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ osErrorId

◆ osFlagsError

◆ osFlagsErrorISR

◆ osFlagsErrorParameter

◆ osFlagsErrorResource

◆ osFlagsErrorSafetyClass

◆ osFlagsErrorTimeout

◆ osFlagsErrorUnknown

◆ osFlagsNoClear

◆ osFlagsWaitAll

◆ osFlagsWaitAny

◆ osMutexPrioInherit

◆ osMutexRecursive

◆ osMutexRobust

◆ osSafetyClass

◆ osSafetyClass_Msk

◆ osSafetyClass_Pos

◆ osSafetyClass_Valid

◆ osSafetyWithLowerClass

◆ osSafetyWithSameClass

◆ osThreadDetached

◆ osThreadJoinable

◆ osThreadPrivileged

◆ osThreadProcessor

◆ osThreadUnprivileged

◆ osThreadZone

◆ osThreadZone_Msk

◆ osThreadZone_Pos

◆ osThreadZone_Valid

◆ osWaitForever

◆ TZ_MODULEID_T

Typedef Documentation

◆ osEventFlagsId_t

◆ osMemoryPoolId_t

◆ osMessageQueueId_t

◆ osMutexId_t

◆ osSemaphoreId_t

◆ osThreadFunc_t

◆ osThreadId_t

◆ osTimerFunc_t

◆ osTimerId_t

◆ TZ_ModuleId_t

Enumeration Type Documentation

◆ osKernelState_t

◆ osPriority_t

◆ osStatus_t

◆ osThreadState_t

◆ osTimerType_t

Function Documentation

◆ osDelay()

◆ osDelayUntil()

◆ osEventFlagsClear()

◆ osEventFlagsDelete()

◆ osEventFlagsGet()

◆ osEventFlagsGetName()

◆ osEventFlagsNew()

◆ osEventFlagsSet()

◆ osEventFlagsWait()

◆ osFaultResume()

◆ osKernelDestroyClass()

◆ osKernelGetInfo()

◆ osKernelGetState()

◆ osKernelGetSysTimerCount()

◆ osKernelGetSysTimerCount64()

◆ osKernelGetSysTimerFreq()

◆ osKernelGetTickCount()

◆ osKernelGetTickFreq()

◆ osKernelInitialize()

◆ osKernelLock()

◆ osKernelProtect()

◆ osKernelRestoreLock()

◆ osKernelResume()

◆ osKernelStart()