cmsis_os2_stk.cpp File Reference

#include "stk.h"
#include "sync/stk_sync.h"
#include "time/stk_time.h"
#include "memory/stk_memory.h"
#include "cmsis_os2.h"

Include dependency graph for cmsis_os2_stk.cpp:

Go to the source code of this file.

Classes
class	StkThread
struct	StkMutex
struct	StkSemaphore
struct	StkEventFlags
class	StkTimer
class	StkMemPool
class	StkMessageQueue

Macros
#define	STK_WRAPPER_API_VERSION   20030000UL
#define	STK_WRAPPER_KERNEL_VERSION   20030000UL
#define	STK_WRAPPER_KERNEL_ID   "STK RTOS2 Wrapper v1.0"
#define	CMSIS_STK_MAX_THREADS   (16U)
#define	CMSIS_STK_DEFAULT_STACK_WORDS   (256U)
#define	CMSIS_STK_MIN_STACK_WORDS   (STK_STACK_SIZE_MIN)

Typedefs
using	StkKernel

Functions
template<typename T>
static constexpr size_t	StkGetWordCountForType ()
static size_t	CmsisStrlen (const char str[])
void *	malloc (size_t size)
void	free (void *ptr)
static __stk_forceinline int32_t	CmsisPrioToStk (osPriority_t p)
static __stk_forceinline osPriority_t	StkPrioToCmsis (int32_t p)
static __stk_forceinline stk::Timeout	CmsisTimeoutToStk (uint32_t ticks)
static __stk_forceinline bool	IsIrqContext ()
template<typename T, typename... Args>
static T *	PlacementNewOrHeap (void *mem, size_t size, const Args &... args)
template<typename T>
static void	ObjDestroy (T *obj)
static __stk_forceinline uint32_t	CmsisFlagsOptionsToStk (uint32_t options)
static __stk_forceinline uint32_t	StkFlagsResultToCmsis (uint32_t result)
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)
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)
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)
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, 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)

Variables
static StkKernel	g_StkKernel
static uint32_t	g_StkKernelLocked = 0U
static stk::time::TimerHost *	g_TimerHost = nullptr
static stk::Word	g_TimerHostBuf [StkGetWordCountForType< stk::time::TimerHost >()]

Macro Definition Documentation

CMSIS_STK_DEFAULT_STACK_WORDS

#define CMSIS_STK_DEFAULT_STACK_WORDS   (256U)

Definition at line 39 of file cmsis_os2_stk.cpp.

Referenced by osThreadNew().

CMSIS_STK_MAX_THREADS

#define CMSIS_STK_MAX_THREADS   (16U)

Definition at line 34 of file cmsis_os2_stk.cpp.

CMSIS_STK_MIN_STACK_WORDS

#define CMSIS_STK_MIN_STACK_WORDS   (STK_STACK_SIZE_MIN)

Definition at line 43 of file cmsis_os2_stk.cpp.

Referenced by osThreadNew().

STK_WRAPPER_API_VERSION

#define STK_WRAPPER_API_VERSION   20030000UL

Definition at line 23 of file cmsis_os2_stk.cpp.

Referenced by osKernelGetInfo().

STK_WRAPPER_KERNEL_ID

#define STK_WRAPPER_KERNEL_ID   "STK RTOS2 Wrapper v1.0"

Definition at line 25 of file cmsis_os2_stk.cpp.

Referenced by osKernelGetInfo().

STK_WRAPPER_KERNEL_VERSION

#define STK_WRAPPER_KERNEL_VERSION   20030000UL

Definition at line 24 of file cmsis_os2_stk.cpp.

Referenced by osKernelGetInfo().

Typedef Documentation

StkKernel

using StkKernel

Initial value:

stk::Kernel<stk::KERNEL_DYNAMIC | stk::KERNEL_SYNC
 
   | stk::KERNEL_TICKLESS
 
   , (16U) , stk::SwitchStrategyFP32, stk::PlatformDefault>

Definition at line 152 of file cmsis_os2_stk.cpp.

Function Documentation

CmsisFlagsOptionsToStk()

__stk_forceinline uint32_t CmsisFlagsOptionsToStk ( uint32_t options )

static

Definition at line 492 of file cmsis_os2_stk.cpp.

{
    uint32_t stk_opts = stk::sync::EventFlags::OPT_WAIT_ANY; // default
 
    if ((options & osFlagsWaitAll) != 0U)
    {
        stk_opts |= stk::sync::EventFlags::OPT_WAIT_ALL;
    }
 
    if ((options & osFlagsNoClear) != 0U)
    {
        stk_opts |= stk::sync::EventFlags::OPT_NO_CLEAR;
    }
 
    return stk_opts;
}

References __stk_forceinline, stk::sync::EventFlags::OPT_NO_CLEAR, stk::sync::EventFlags::OPT_WAIT_ALL, stk::sync::EventFlags::OPT_WAIT_ANY, osFlagsNoClear, and osFlagsWaitAll.

Referenced by osEventFlagsWait(), and osThreadFlagsWait().

Here is the caller graph for this function:

CmsisPrioToStk()

__stk_forceinline int32_t CmsisPrioToStk ( osPriority_t p )

static

Definition at line 77 of file cmsis_os2_stk.cpp.

{
    int32_t result;
 
    if (p <= osPriorityIdle)
    {
        result = 0;
    }
    else if (p >= osPriorityISR)
    {
        result = 31;
    }
    else
    {
        result = ((static_cast<int32_t>(p) * 31) / 56);
    }
 
    return result;
}

References __stk_forceinline, osPriorityIdle, and osPriorityISR.

Referenced by osThreadNew(), osThreadSetPriority(), and StkThread::StkThread().

Here is the caller graph for this function:

CmsisStrlen()

size_t CmsisStrlen ( const char str[] )

static

Definition at line 52 of file cmsis_os2_stk.cpp.

{
    size_t total_len = 0U;
    
    while (str[total_len] != '\0')
    {
        total_len++;
    }
    
    return total_len;
}

Referenced by osKernelGetInfo().

Here is the caller graph for this function:

CmsisTimeoutToStk()

__stk_forceinline stk::Timeout CmsisTimeoutToStk ( uint32_t ticks )

static

Definition at line 120 of file cmsis_os2_stk.cpp.

{
    stk::Timeout result;
 
    if (ticks > static_cast<uint32_t>(stk::WAIT_INFINITE))
    {
        result = stk::WAIT_INFINITE;
    }
    else if (ticks == 0U)
    {
        result = stk::NO_WAIT;
    }
    else
    {
        // CMSIS ticks are kernel ticks – pass through directly as STK ticks
        result = static_cast<stk::Timeout>(ticks);
    }
 
    return result;
}

References __stk_forceinline, stk::NO_WAIT, and stk::WAIT_INFINITE.

Referenced by osDelay(), osEventFlagsWait(), osMemoryPoolAlloc(), osMessageQueueGet(), osMessageQueuePut(), osMutexAcquire(), osSemaphoreAcquire(), and osThreadFlagsWait().

Here is the caller graph for this function:

free()

void free

(

void *

ptr

)

IsIrqContext()

__stk_forceinline bool IsIrqContext ( )

static

Definition at line 144 of file cmsis_os2_stk.cpp.

{
    return stk::hw::IsInsideISR();
}

References __stk_forceinline, and stk::hw::IsInsideISR().

Referenced by osDelay(), osDelayUntil(), osEventFlagsDelete(), osEventFlagsNew(), osKernelInitialize(), osKernelLock(), osKernelRestoreLock(), osKernelStart(), osKernelUnlock(), osMemoryPoolAlloc(), osMemoryPoolDelete(), osMemoryPoolNew(), osMessageQueueDelete(), osMessageQueueGet(), osMessageQueueNew(), osMessageQueuePut(), osMessageQueueReset(), osMutexAcquire(), osMutexDelete(), osMutexNew(), osMutexRelease(), osSemaphoreAcquire(), osSemaphoreDelete(), osSemaphoreNew(), osThreadDetach(), osThreadFlagsWait(), osThreadGetId(), osThreadGetPriority(), osThreadGetState(), osThreadJoin(), osThreadNew(), osThreadResume(), osThreadSetPriority(), osThreadSuspend(), osThreadYield(), osTimerDelete(), osTimerNew(), osTimerStart(), osTimerStop(), ulTaskNotifyTakeIndexed(), vTaskDelay(), xEventGroupCreate(), xEventGroupCreateStatic(), xEventGroupSync(), xEventGroupWaitBits(), xMessageBufferReceive(), xQueueCreate(), xQueueCreateSet(), xQueueCreateStatic(), xQueuePeek(), xQueueReceive(), xQueueSelectFromSet(), xQueueSend(), xQueueSendToFront(), xSemaphoreTake(), xStreamBufferReceive(), xTaskDelayUntil(), xTaskGetCurrentTaskHandle(), xTaskNotifyWaitIndexed(), xTimerCreate(), xTimerCreateStatic(), xTimerPendFunctionCall(), xTimerStart(), and xTimerStop().

Here is the call graph for this function:

Here is the caller graph for this function:

malloc()

void * malloc

(

size_t

size

)

ObjDestroy()

template<typename T>

void ObjDestroy ( T * obj )

static

Definition at line 479 of file cmsis_os2_stk.cpp.

{
    if (obj->m_cb_owned)
    {
        delete obj;
    }
    else
    {
        obj->~T();
    }
}

Referenced by osEventFlagsDelete(), osMemoryPoolDelete(), osMemoryPoolNew(), osMessageQueueDelete(), osMessageQueueNew(), osMutexDelete(), osSemaphoreDelete(), osThreadDetach(), osThreadJoin(), osThreadNew(), osThreadTerminate(), and osTimerDelete().

Here is the caller graph for this function:

PlacementNewOrHeap()

template<typename T, typename... Args>

T * PlacementNewOrHeap ( void * mem, size_t size, const Args &... args )

static

Definition at line 456 of file cmsis_os2_stk.cpp.

{
    T *obj;
 
    if ((mem != nullptr) && (size >= sizeof(T)))
    {
        obj = new (mem) T(args...);
        obj->m_cb_owned = false;
    }
    else
    {
        obj = new (std::nothrow) T(args...);
        // m_cb_owned is already true from the constructor default
        STK_ASSERT(obj != nullptr);
    }
 
    return obj;
}

References STK_ASSERT.

Referenced by osEventFlagsNew(), osMemoryPoolNew(), osMessageQueueNew(), osMutexNew(), osSemaphoreNew(), osThreadNew(), and osTimerNew().

Here is the caller graph for this function:

StkFlagsResultToCmsis()

__stk_forceinline uint32_t StkFlagsResultToCmsis ( uint32_t result )

static

Definition at line 510 of file cmsis_os2_stk.cpp.

{
    uint32_t cmsis_result;
 
    if (!stk::sync::EventFlags::IsError(result))
    {
        cmsis_result = result;
    }
    else if (result == stk::sync::EventFlags::ERROR_TIMEOUT)
    {
        cmsis_result = osFlagsErrorTimeout;
    }
    else if (result == stk::sync::EventFlags::ERROR_PARAMETER)
    {
        cmsis_result = osFlagsErrorParameter;
    }
    else if (result == stk::sync::EventFlags::ERROR_ISR)
    {
        cmsis_result = osFlagsErrorISR;
    }
    else
    {
        cmsis_result = osFlagsErrorUnknown;
    }
 
    return cmsis_result;
}

References __stk_forceinline, stk::sync::EventFlags::ERROR_ISR, stk::sync::EventFlags::ERROR_PARAMETER, stk::sync::EventFlags::ERROR_TIMEOUT, stk::sync::EventFlags::IsError(), osFlagsErrorISR, osFlagsErrorParameter, osFlagsErrorTimeout, and osFlagsErrorUnknown.

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

Here is the call graph for this function:

Here is the caller graph for this function:

StkGetWordCountForType()

template<typename T>

constexpr size_t StkGetWordCountForType ( )

staticconstexpr

Definition at line 46 of file cmsis_os2_stk.cpp.

{
    return ((sizeof(T) + sizeof(stk::Word) - 1U) / sizeof(stk::Word));
}

StkPrioToCmsis()

__stk_forceinline osPriority_t StkPrioToCmsis ( int32_t p )

static

Definition at line 96 of file cmsis_os2_stk.cpp.

{
    // Inverse: cmsis_prio = (stk_prio * 56) / 31
    int32_t r = (p * 56) / 31;
    if (r < static_cast<int32_t>(osPriorityIdle))
    {
        r = static_cast<int32_t>(osPriorityIdle);
    }
 
    if (r > static_cast<int32_t>(osPriorityISR))
    {
        r = static_cast<int32_t>(osPriorityISR);
    }
 
    return static_cast<osPriority_t>(r);
}

References __stk_forceinline, osPriorityIdle, and osPriorityISR.

Referenced by osThreadGetPriority().

Here is the caller graph for this function:

Variable Documentation

g_StkKernel

StkKernel g_StkKernel

static

Definition at line 158 of file cmsis_os2_stk.cpp.

Referenced by EnsureKernelInitialized(), StkTimer::EnsureTimerHostCreated(), osKernelGetState(), osKernelInitialize(), osKernelStart(), osThreadEnumerate(), osThreadExit(), osThreadGetCount(), osThreadNew(), osThreadResume(), osThreadSuspend(), osThreadTerminate(), uxTaskGetNumberOfTasks(), uxTaskGetSystemState(), vTaskDelete(), vTaskEndScheduler(), vTaskGetRunTimeStats(), vTaskList(), vTaskResume(), vTaskStartScheduler(), vTaskSuspend(), xTaskCreate(), xTaskCreateStatic(), xTaskGetHandle(), xTaskGetSchedulerState(), and xTaskResumeFromISR().

g_StkKernelLocked

uint32_t g_StkKernelLocked = 0U

static

Definition at line 159 of file cmsis_os2_stk.cpp.

Referenced by osKernelGetState(), osKernelLock(), osKernelRestoreLock(), and osKernelUnlock().

g_TimerHost

stk::time::TimerHost* g_TimerHost = nullptr

static

Definition at line 312 of file cmsis_os2_stk.cpp.

Referenced by EnsurePendDrainer(), StkTimer::EnsureTimerHostCreated(), KickPendDrainerFromISR(), osTimerDelete(), osTimerStart(), osTimerStop(), xTimerChangePeriodFromISR(), xTimerDelete(), xTimerGetExpiryTime(), xTimerPendFunctionCallFromISR(), xTimerStart(), xTimerStartFromISR(), xTimerStop(), and xTimerStopFromISR().

g_TimerHostBuf

stk::Word g_TimerHostBuf[StkGetWordCountForType< stk::time::TimerHost >()]

static

Definition at line 313 of file cmsis_os2_stk.cpp.

Referenced by StkTimer::EnsureTimerHostCreated().