CMSIS RTOS2 interface for SuperTinyKernel (STK). More...

#include <stdint.h>
#include <stddef.h>

Include dependency graph for cmsis_os2.h:

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

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	__NO_RETURN
#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 SuperTinyKernel (STK).

Definition in file cmsis_os2.h.

Macro Definition Documentation

◆ __NO_RETURN

#define __NO_RETURN

Definition at line 80 of file cmsis_os2.h.

Referenced by osThreadExit(), and osThreadGetZone().

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ __NO_RETURN