freertos_stk.cpp File Reference

#include <stdio.h>
#include "stk.h"
#include "sync/stk_sync.h"
#include "time/stk_time.h"
#include "memory/stk_memory.h"
#include "FreeRTOS.h"

Include dependency graph for freertos_stk.cpp:

Go to the source code of this file.

Classes
struct	FrtosTask
struct	FrtosTask::NotifySlot
struct	FrtosQueue
struct	FrtosMutexBase
struct	FrtosRecursiveMutex
struct	FrtosFastMutex
struct	FrtosSemaphore
struct	FrtosQueueSet
struct	FrtosTimer
struct	PendCall
struct	FrtosPendDrainer
struct	FrtosEventGroup
struct	FrtosStreamBuffer
struct	FrtosMessageBuffer
struct	FrtosMessageBuffer::MsgEnvelope

Macros
#define	FREERTOS_STK_WRAPPER_VERSION   "FreeRTOS-STK Wrapper v1.1"
#define	FREERTOS_STK_MIN_STACK_WORDS   STK_STACK_SIZE_MIN

Typedefs
using	FrtosKernel

Enumerations
enum class	SemKind : uint8_t {   None = 0x00U ,   Counting = 0x80U ,   Mutex = 0x81U }

Functions
template<typename T>
static constexpr size_t	StkGetWordCountForType ()
static int32_t	FreertosStrcmp (const char str1[], const char str2[])
void *	malloc (size_t size)
void	free (void *ptr)
template<typename T, typename... Args>
static T *	ObjAlloc (Args &&...args)
template<typename T>
static void	ObjFree (T *obj)
template<typename T>
static T *	ObjAllocArray (size_t count)
static void	ObjFreeArray (void *ptr)
template<typename T>
static void	ObjFreeRaw (T *obj)
__stk_weak void *	pvPortMalloc (size_t xWantedSize)
__stk_weak void	vPortFree (void *pv)
size_t	xPortGetFreeHeapSize (void)
size_t	xPortGetMinimumEverFreeHeapSize (void)
void	vPortGetHeapStats (HeapStats_t *pxHeapStats)
static int32_t	FrtosPrioToStkWeight (UBaseType_t p)
static UBaseType_t	StkWeightToFrtosPrio (int32_t w)
static stk::Timeout	FrtosTimeoutToStk (TickType_t t)
static bool	IsIrqContext ()
void	vPortEnterCritical (void)
void	vPortExitCritical (void)
void	taskYIELD_impl (void)
static SemKind	GetSemKindFromHandle (const void *obj)
template<typename THost>
static void	QueueSetNotify (void *member_handle, THost *host)
static bool	EnsurePendDrainer ()
static void	KickPendDrainerFromISR ()
static void	EnsureKernelInitialized ()
void	vTaskStartScheduler (void)
void	vTaskEndScheduler (void)
	End scheduling (KERNEL_DYNAMIC only). Included for API completeness.
void	vTaskSuspendAll (void)
	Suspend the scheduler (disables preemption; interrupts remain enabled).
BaseType_t	xTaskResumeAll (void)
TickType_t	xTaskGetTickCount (void)
	Return the tick count since the scheduler started.
TickType_t	xTaskGetTickCountFromISR (void)
	Return the tick count from ISR context (ISR-safe).
UBaseType_t	uxTaskGetNumberOfTasks (void)
	Return the number of tasks currently under kernel management.
BaseType_t	xTaskGetSchedulerState (void)
BaseType_t	xTaskCreate (TaskFunction_t pvTaskCode, const char *pcName, uint32_t usStackDepth, void *pvParameters, UBaseType_t uxPriority, TaskHandle_t *pxCreatedTask)
TaskHandle_t	xTaskCreateStatic (TaskFunction_t pvTaskCode, const char *pcName, uint32_t ulStackDepth, void *pvParameters, UBaseType_t uxPriority, StackType_t *puxStackBuffer, StaticTask_t *pxTaskBuffer)
void	vTaskDelete (TaskHandle_t xTaskToDelete)
void	vTaskSuspend (TaskHandle_t xTaskToSuspend)
void	vTaskResume (TaskHandle_t xTaskToResume)
BaseType_t	xTaskResumeFromISR (TaskHandle_t xTaskToResume)
BaseType_t	xTaskAbortDelay (TaskHandle_t xTask)
void	vTaskDelay (TickType_t xTicksToDelay)
void	vTaskDelayUntil (TickType_t *pxPreviousWakeTime, TickType_t xTimeIncrement)
BaseType_t	xTaskDelayUntil (TickType_t *pxPreviousWakeTime, TickType_t xTimeIncrement)
void	vTaskPrioritySet (TaskHandle_t xTask, UBaseType_t uxNewPriority)
UBaseType_t	uxTaskPriorityGet (TaskHandle_t xTask)
UBaseType_t	uxTaskPriorityGetFromISR (TaskHandle_t xTask)
eTaskState	eTaskGetState (TaskHandle_t xTask)
TaskHandle_t	xTaskGetCurrentTaskHandle (void)
TaskHandle_t	xTaskGetHandle (const char *pcNameToQuery)
const char *	pcTaskGetName (TaskHandle_t xTaskToQuery)
UBaseType_t	uxTaskGetStackHighWaterMark (TaskHandle_t xTask)
StackType_t	uxTaskGetStackHighWaterMark2 (TaskHandle_t xTask)
UBaseType_t	uxTaskGetSystemState (TaskStatus_t *pxTaskStatusArray, UBaseType_t uxArraySize, uint32_t *pulTotalRunTime)
BaseType_t	xTaskCreateRestrictedStatic (const TaskParameters_restricted_t *pxTaskDefinition, TaskHandle_t *pxCreatedTask)
BaseType_t	xTaskCreateRestricted (const TaskParameters_restricted_t *pxTaskDefinition, TaskHandle_t *pxCreatedTask)
void	vTaskList (char *pcWriteBuffer)
void	vTaskGetRunTimeStats (char *pcWriteBuffer)
QueueHandle_t	xQueueCreate (UBaseType_t uxQueueLength, UBaseType_t uxItemSize)
QueueHandle_t	xQueueCreateStatic (UBaseType_t uxQueueLength, UBaseType_t uxItemSize, uint8_t *pucQueueStorage, StaticQueue_t *pxStaticQueue)
void	vQueueDelete (QueueHandle_t xQueue)
BaseType_t	xQueueSend (QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait)
BaseType_t	xQueueSendToBack (QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait)
BaseType_t	xQueueSendToFront (QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait)
BaseType_t	xQueueReceive (QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait)
BaseType_t	xQueuePeek (QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait)
BaseType_t	xQueuePeekFromISR (QueueHandle_t xQueue, void *pvBuffer)
UBaseType_t	uxQueueMessagesWaiting (QueueHandle_t xQueue)
UBaseType_t	uxQueueMessagesWaitingFromISR (QueueHandle_t xQueue)
UBaseType_t	uxQueueSpacesAvailable (QueueHandle_t xQueue)
BaseType_t	xQueueReset (QueueHandle_t xQueue)
BaseType_t	xQueueOverwrite (QueueHandle_t xQueue, const void *pvItemToQueue)
BaseType_t	xQueueOverwriteFromISR (QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xQueueSendFromISR (QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xQueueReceiveFromISR (QueueHandle_t xQueue, void *pvBuffer, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xQueueSendToBackFromISR (QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xQueueSendToFrontFromISR (QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xQueueIsQueueEmptyFromISR (const QueueHandle_t xQueue)
BaseType_t	xQueueIsQueueFullFromISR (const QueueHandle_t xQueue)
static FrtosSemaphore *	QueueHandleAsMutex (QueueHandle_t xQueue)
TaskHandle_t	xQueueGetMutexHolder (QueueHandle_t xQueue)
TaskHandle_t	xQueueGetMutexHolderFromISR (QueueHandle_t xQueue)
QueueSetHandle_t	xQueueCreateSet (UBaseType_t uxEventQueueLength)
BaseType_t	xQueueAddToSet (QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet)
BaseType_t	xQueueRemoveFromSet (QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet)
QueueSetMemberHandle_t	xQueueSelectFromSet (QueueSetHandle_t xQueueSet, TickType_t xTicksToWait)
QueueSetMemberHandle_t	xQueueSelectFromSetFromISR (QueueSetHandle_t xQueueSet)
SemaphoreHandle_t	xSemaphoreCreateBinary (void)
SemaphoreHandle_t	xSemaphoreCreateBinaryStatic (StaticSemaphore_t *pxSemaphoreBuffer)
SemaphoreHandle_t	xSemaphoreCreateCounting (UBaseType_t uxMaxCount, UBaseType_t uxInitialCount)
SemaphoreHandle_t	xSemaphoreCreateCountingStatic (UBaseType_t uxMaxCount, UBaseType_t uxInitialCount, StaticSemaphore_t *pxSemaphoreBuffer)
static SemaphoreHandle_t	CreateMutexInternal (bool recursive)
static SemaphoreHandle_t	CreateMutexStaticInternal (StaticSemaphore_t *pxMutexBuffer, bool recursive)
SemaphoreHandle_t	xSemaphoreCreateMutex (void)
SemaphoreHandle_t	xSemaphoreCreateMutexStatic (StaticSemaphore_t *pxMutexBuffer)
SemaphoreHandle_t	xSemaphoreCreateRecursiveMutex (void)
	Create a recursive mutex (same implementation as xSemaphoreCreateMutex).
SemaphoreHandle_t	xSemaphoreCreateRecursiveMutexStatic (StaticSemaphore_t *pxMutexBuffer)
void	vSemaphoreDelete (SemaphoreHandle_t xSemaphore)
BaseType_t	xSemaphoreTake (SemaphoreHandle_t xSemaphore, TickType_t xTicksToWait)
BaseType_t	xSemaphoreTakeFromISR (SemaphoreHandle_t xSemaphore, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xSemaphoreTakeRecursive (SemaphoreHandle_t xMutex, TickType_t xTicksToWait)
BaseType_t	xSemaphoreGive (SemaphoreHandle_t xSemaphore)
BaseType_t	xSemaphoreGiveRecursive (SemaphoreHandle_t xMutex)
BaseType_t	xSemaphoreGiveFromISR (SemaphoreHandle_t xSemaphore, BaseType_t *pxHigherPriorityTaskWoken)
UBaseType_t	uxSemaphoreGetCount (SemaphoreHandle_t xSemaphore)
TaskHandle_t	xSemaphoreGetMutexHolder (SemaphoreHandle_t xMutex)
TaskHandle_t	xSemaphoreGetMutexHolderFromISR (SemaphoreHandle_t xMutex)
TimerHandle_t	xTimerCreate (const char *pcTimerName, TickType_t xTimerPeriodInTicks, UBaseType_t uxAutoReload, void *pvTimerID, TimerCallbackFunction_t pxCallbackFunction)
TimerHandle_t	xTimerCreateStatic (const char *pcTimerName, TickType_t xTimerPeriodInTicks, UBaseType_t uxAutoReload, void *pvTimerID, TimerCallbackFunction_t pxCallbackFunction, StaticTimer_t *pxTimerBuffer)
BaseType_t	xTimerDelete (TimerHandle_t xTimer, TickType_t)
BaseType_t	xTimerStart (TimerHandle_t xTimer, TickType_t)
BaseType_t	xTimerStop (TimerHandle_t xTimer, TickType_t)
BaseType_t	xTimerReset (TimerHandle_t xTimer, TickType_t xTicksToWait)
BaseType_t	xTimerChangePeriod (TimerHandle_t xTimer, TickType_t xNewPeriod, TickType_t xTicksToWait)
BaseType_t	xTimerStartFromISR (TimerHandle_t xTimer, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTimerStopFromISR (TimerHandle_t xTimer, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTimerResetFromISR (TimerHandle_t xTimer, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTimerChangePeriodFromISR (TimerHandle_t xTimer, TickType_t xNewPeriod, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTimerPendFunctionCall (PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait)
BaseType_t	xTimerPendFunctionCallFromISR (PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTimerIsTimerActive (TimerHandle_t xTimer)
void *	pvTimerGetTimerID (TimerHandle_t xTimer)
void	vTimerSetTimerID (TimerHandle_t xTimer, void *pvNewID)
const char *	pcTimerGetName (TimerHandle_t xTimer)
TickType_t	xTimerGetPeriod (TimerHandle_t xTimer)
TickType_t	xTimerGetExpiryTime (TimerHandle_t xTimer)
static EventBits_t	StkFlagsToFrtos (uint32_t result, EventBits_t snapshot=0U)
static uint32_t	BuildStkFlagsOpts (BaseType_t xClearOnExit, BaseType_t xWaitForAllBits)
EventGroupHandle_t	xEventGroupCreate (void)
EventGroupHandle_t	xEventGroupCreateStatic (StaticEventGroup_t *pxEventGroupBuffer)
void	vEventGroupDelete (EventGroupHandle_t xEventGroup)
EventBits_t	xEventGroupSetBits (EventGroupHandle_t xEventGroup, EventBits_t uxBitsToSet)
EventBits_t	xEventGroupClearBits (EventGroupHandle_t xEventGroup, EventBits_t uxBitsToClear)
EventBits_t	xEventGroupGetBits (EventGroupHandle_t xEventGroup)
EventBits_t	xEventGroupWaitBits (EventGroupHandle_t xEventGroup, EventBits_t uxBitsToWaitFor, BaseType_t xClearOnExit, BaseType_t xWaitForAllBits, TickType_t xTicksToWait)
BaseType_t	xEventGroupSetBitsFromISR (EventGroupHandle_t xEventGroup, EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken)
EventBits_t	xEventGroupClearBitsFromISR (EventGroupHandle_t xEventGroup, EventBits_t uxBitsToClear)
EventBits_t	xEventGroupSync (EventGroupHandle_t xEventGroup, EventBits_t uxBitsToSet, EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait)
static FrtosTask *	ResolveNotifyTarget (TaskHandle_t xTask, UBaseType_t uxIndex)
static BaseType_t	NotifyApplyAction (FrtosTask::NotifySlot &slot, uint32_t ulValue, eNotifyAction eAction)
BaseType_t	xTaskNotifyGiveIndexed (TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify)
uint32_t	ulTaskNotifyTakeIndexed (UBaseType_t uxIndexToWait, BaseType_t ulClearCountOnExit, TickType_t xTicksToWait)
BaseType_t	xTaskNotifyIndexed (TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify, uint32_t ulValue, eNotifyAction eAction)
BaseType_t	xTaskNotifyWaitIndexed (UBaseType_t uxIndexToWait, uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait)
BaseType_t	xTaskNotifyFromISRIndexed (TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify, uint32_t ulValue, eNotifyAction eAction, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTaskNotifyGive (TaskHandle_t xTaskToNotify)
uint32_t	ulTaskNotifyTake (BaseType_t ulClearCountOnExit, TickType_t xTicksToWait)
BaseType_t	xTaskNotify (TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction)
BaseType_t	xTaskNotifyWait (uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait)
BaseType_t	xTaskNotifyFromISR (TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTaskNotifyAndQueryIndexed (TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotifyValue)
BaseType_t	xTaskNotifyAndQuery (TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotifyValue)
BaseType_t	xTaskNotifyAndQueryFromISRIndexed (TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotifyValue, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTaskNotifyAndQueryFromISR (TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotifyValue, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTaskNotifyStateClearIndexed (TaskHandle_t xTask, UBaseType_t uxIndexToClear)
BaseType_t	xTaskNotifyStateClear (TaskHandle_t xTask)
uint32_t	ulTaskNotifyValueClearIndexed (TaskHandle_t xTask, UBaseType_t uxIndexToClear, uint32_t ulBitsToClear)
uint32_t	ulTaskNotifyValueClear (TaskHandle_t xTask, uint32_t ulBitsToClear)
void	vTaskSetThreadLocalStoragePointer (TaskHandle_t xTaskToSet, BaseType_t xIndex, void *pvValue)
void *	pvTaskGetThreadLocalStoragePointer (TaskHandle_t xTaskToQuery, BaseType_t xIndex)
StreamBufferHandle_t	xStreamBufferCreate (size_t xBufferSizeBytes, size_t xTriggerLevelBytes)
StreamBufferHandle_t	xStreamBufferCreateStatic (size_t xBufferSizeBytes, size_t xTriggerLevelBytes, uint8_t *pucStreamBufferStorageArea, StaticStreamBuffer_t *pxStaticStreamBuffer)
void	vStreamBufferDelete (StreamBufferHandle_t xStreamBuffer)
size_t	xStreamBufferSend (StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, TickType_t xTicksToWait)
size_t	xStreamBufferSendFromISR (StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, BaseType_t *pxHigherPriorityTaskWoken)
size_t	xStreamBufferReceive (StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, TickType_t xTicksToWait)
size_t	xStreamBufferReceiveFromISR (StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, BaseType_t *pxHigherPriorityTaskWoken)
size_t	xStreamBufferBytesAvailable (StreamBufferHandle_t xStreamBuffer)
size_t	xStreamBufferSpacesAvailable (StreamBufferHandle_t xStreamBuffer)
BaseType_t	xStreamBufferIsEmpty (StreamBufferHandle_t xStreamBuffer)
BaseType_t	xStreamBufferIsFull (StreamBufferHandle_t xStreamBuffer)
BaseType_t	xStreamBufferReset (StreamBufferHandle_t xStreamBuffer)
BaseType_t	xStreamBufferSetTriggerLevel (StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevelBytes)
BaseType_t	xStreamBufferResetFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken)
size_t	xStreamBufferGetTriggerLevel (StreamBufferHandle_t xStreamBuffer)
size_t	xStreamBufferNextMessageLengthBytes (StreamBufferHandle_t xStreamBuffer)
StreamBufferHandle_t	xStreamBufferCreateWithCallback (size_t xBufferSizeBytes, size_t xTriggerLevelBytes, StreamBufferCallbackFunction_t pxSendCompletedCallback, StreamBufferCallbackFunction_t pxReceiveCompletedCallback)
StreamBufferHandle_t	xStreamBufferCreateStaticWithCallback (size_t xBufferSizeBytes, size_t xTriggerLevelBytes, uint8_t *pucStreamBufferStorageArea, StaticStreamBuffer_t *pxStaticStreamBuffer, StreamBufferCallbackFunction_t pxSendCompletedCallback, StreamBufferCallbackFunction_t pxReceiveCompletedCallback)
static size_t	MsgBufSlotCount (size_t budget_bytes, size_t max_msg_size)
MessageBufferHandle_t	xMessageBufferCreate (size_t xBufferSizeBytes, size_t xMaxMessageSize)
MessageBufferHandle_t	xMessageBufferCreateStatic (size_t xMaxMessageSize, size_t xMessageCount, uint8_t *pucMessageBufferStorageArea, StaticMessageBuffer_t *pxStaticMessageBuffer)
MessageBufferHandle_t	xMessageBufferCreateWithCallback (size_t xBufferSizeBytes, size_t xMaxMessageSize, StreamBufferCallbackFunction_t pxSendCompletedCallback, StreamBufferCallbackFunction_t pxReceiveCompletedCallback)
MessageBufferHandle_t	xMessageBufferCreateStaticWithCallback (size_t xMaxMessageSize, size_t xMessageCount, uint8_t *pucMessageBufferStorageArea, StaticMessageBuffer_t *pxStaticMessageBuffer, StreamBufferCallbackFunction_t pxSendCompletedCallback, StreamBufferCallbackFunction_t pxReceiveCompletedCallback)
void	vMessageBufferDelete (MessageBufferHandle_t xMessageBuffer)
size_t	xMessageBufferSend (MessageBufferHandle_t xMessageBuffer, const void *pvTxData, size_t xDataLengthBytes, TickType_t xTicksToWait)
size_t	xMessageBufferReceive (MessageBufferHandle_t xMessageBuffer, void *pvRxData, size_t xBufferLengthBytes, TickType_t xTicksToWait)
BaseType_t	xMessageBufferIsEmpty (MessageBufferHandle_t xMessageBuffer)
BaseType_t	xMessageBufferIsFull (MessageBufferHandle_t xMessageBuffer)
size_t	xMessageBufferSpacesAvailable (MessageBufferHandle_t xMessageBuffer)
BaseType_t	xMessageBufferReset (MessageBufferHandle_t xMessageBuffer)
size_t	xMessageBufferSendFromISR (MessageBufferHandle_t xMessageBuffer, const void *pvTxData, size_t xDataLengthBytes, BaseType_t *pxHigherPriorityTaskWoken)
size_t	xMessageBufferReceiveFromISR (MessageBufferHandle_t xMessageBuffer, void *pvRxData, size_t xBufferLengthBytes, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xMessageBufferResetFromISR (MessageBufferHandle_t xMessageBuffer, BaseType_t *pxHigherPriorityTaskWoken)
size_t	xMessageBufferNextLengthBytes (MessageBufferHandle_t xMessageBuffer)

Variables
static stk::memory::MemoryAllocator::Stats	s_MemStats (10240U)
static FrtosKernel	g_StkKernel
static stk::time::TimerHost *	g_TimerHost = nullptr
static stk::Word	g_TimerHostBuf [StkGetWordCountForType< stk::time::TimerHost >()]
static stk::sync::PipeT< PendCall, 8U >	g_PendCallPipe
static stk::Word	g_PendDrainerBuf [StkGetWordCountForType< stk::time::TimerHost::Timer >()]
static stk::time::TimerHost::Timer *	g_PendDrainer = nullptr

Macro Definition Documentation

FREERTOS_STK_MIN_STACK_WORDS

#define FREERTOS_STK_MIN_STACK_WORDS   STK_STACK_SIZE_MIN

Definition at line 41 of file freertos_stk.cpp.

Referenced by xTaskCreate(), and xTaskCreateStatic().

FREERTOS_STK_WRAPPER_VERSION

#define FREERTOS_STK_WRAPPER_VERSION   "FreeRTOS-STK Wrapper v1.1"

Definition at line 25 of file freertos_stk.cpp.

Typedef Documentation

FrtosKernel

using FrtosKernel

Initial value:

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

Definition at line 357 of file freertos_stk.cpp.

Enumeration Type Documentation

SemKind

enum class SemKind : uint8_t

strong

Enumerator
None	Sentinel: not a FrtosSemaphore (e.g. plain FrtosQueue).
Counting	Binary or counting semaphore (backed by stk::sync::Semaphore).
Mutex	Mutex or recursive mutex (backed by stk::sync::FastMutex or stk::sync::Mutex).

Definition at line 591 of file freertos_stk.cpp.

{
    None     = 0x00U, 
    Counting = 0x80U, 
    Mutex    = 0x81U, 
};

Function Documentation

BuildStkFlagsOpts()

uint32_t BuildStkFlagsOpts ( BaseType_t xClearOnExit, BaseType_t xWaitForAllBits )

inlinestatic

Definition at line 3088 of file freertos_stk.cpp.

{
    uint32_t opts = stk::sync::EventFlags::OPT_WAIT_ANY;
 
    if (xWaitForAllBits == pdTRUE)
        opts |= stk::sync::EventFlags::OPT_WAIT_ALL;
 
    if (xClearOnExit == pdFALSE)
        opts |= stk::sync::EventFlags::OPT_NO_CLEAR;
 
    return opts;
}

References stk::sync::EventFlags::OPT_NO_CLEAR, stk::sync::EventFlags::OPT_WAIT_ALL, stk::sync::EventFlags::OPT_WAIT_ANY, pdFALSE, and pdTRUE.

Referenced by xEventGroupWaitBits().

Here is the caller graph for this function:

CreateMutexInternal()

SemaphoreHandle_t CreateMutexInternal ( bool recursive )

static

Definition at line 2416 of file freertos_stk.cpp.

{
    FrtosSemaphore *s = ObjAlloc<FrtosSemaphore>(
        SemKind::Mutex,
        static_cast<uint16_t>(0U),
        static_cast<uint16_t>(1U),
        recursive);
 
    if ((s == nullptr) || (s->m_mtx == nullptr))
    {
        ObjFree(s);
        return nullptr;
    }
 
    return static_cast<SemaphoreHandle_t>(s);
}

References FrtosSemaphore::m_mtx, Mutex, ObjAlloc(), and ObjFree().

Referenced by xSemaphoreCreateMutex(), and xSemaphoreCreateRecursiveMutex().

Here is the call graph for this function:

Here is the caller graph for this function:

CreateMutexStaticInternal()

SemaphoreHandle_t CreateMutexStaticInternal ( StaticSemaphore_t * pxMutexBuffer, bool recursive )

static

Definition at line 2434 of file freertos_stk.cpp.

{
    if (pxMutexBuffer == nullptr)
        return nullptr;
 
    static_assert(sizeof(StaticSemaphore_t) >= sizeof(FrtosSemaphore),
        "StaticSemaphore_t is too small to hold FrtosSemaphore. "
        "Increase STATIC_SEMAPHORE_TCB_SIZE_WORDS in freertos_stk.h.");
 
    FrtosSemaphore *s = new (pxMutexBuffer) FrtosSemaphore(
        SemKind::Mutex,
        static_cast<uint16_t>(0U),
        static_cast<uint16_t>(1U),
        recursive);
 
    if (s->m_mtx == nullptr)
    {
        s->~FrtosSemaphore();
        return nullptr;
    }
 
    s->m_cb_owned = false;
    return static_cast<SemaphoreHandle_t>(s);
}

References FrtosSemaphore::m_cb_owned, FrtosSemaphore::m_mtx, Mutex, and FrtosSemaphore::~FrtosSemaphore().

Referenced by xSemaphoreCreateMutexStatic(), and xSemaphoreCreateRecursiveMutexStatic().

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureKernelInitialized()

void EnsureKernelInitialized ( )

static

Definition at line 1111 of file freertos_stk.cpp.

{
    if (g_StkKernel.GetState() == stk::IKernel::KSTATE_INACTIVE)
    {
        g_StkKernel.Initialize(); // default 1 ms tick resolution
    }
}

References g_StkKernel, and stk::IKernel::KSTATE_INACTIVE.

Referenced by vTaskStartScheduler(), xTaskCreate(), and xTaskCreateStatic().

Here is the caller graph for this function:

EnsurePendDrainer()

bool EnsurePendDrainer ( )

static

Definition at line 931 of file freertos_stk.cpp.

{
    if (g_PendDrainer == nullptr)
        g_PendDrainer = new (g_PendDrainerBuf) FrtosPendDrainer();
 
    // Re-start as a 1-tick auto-reload timer each time we have new work.
    // Restart() is idempotent if already active.
    return g_TimerHost->Restart(*g_PendDrainer, 1U, 1U);
}

References g_PendDrainer, g_PendDrainerBuf, and g_TimerHost.

Referenced by xTimerPendFunctionCall().

Here is the caller graph for this function:

free()

void free

(

void *

ptr

)

FreertosStrcmp()

int32_t FreertosStrcmp ( const char str1[], const char str2[] )

static

Definition at line 50 of file freertos_stk.cpp.

{
    size_t index = 0U;
    int32_t result = 0;
 
    // Loop until the end of either string or until a mismatch is found
    while ((str1[index] != '\0') && (str2[index] != '\0') && (str1[index] == str2[index]))
    {
        index++;
    }
 
    // Calculate the difference between the characters where the loop stopped
    // Cast to int to match standard strcmp return type
    result = static_cast<int32_t>(str1[index]) - static_cast<int32_t>(str2[index]);
 
    return result;
}

Referenced by xTaskGetHandle().

Here is the caller graph for this function:

FrtosPrioToStkWeight()

int32_t FrtosPrioToStkWeight ( UBaseType_t p )

inlinestatic

Definition at line 301 of file freertos_stk.cpp.

{
    // Clamp to [0 .. configMAX_PRIORITIES-1] then pass through directly:
    // STK FP32 level == FreeRTOS priority (both 0 = lowest).
    if (p >= (UBaseType_t)configMAX_PRIORITIES)
        p = (UBaseType_t)configMAX_PRIORITIES - 1U;
 
    return static_cast<int32_t>(p);
}

References configMAX_PRIORITIES.

Referenced by FrtosTask::FrtosTask(), vTaskPrioritySet(), xTaskCreate(), and xTaskCreateStatic().

Here is the caller graph for this function:

FrtosTimeoutToStk()

stk::Timeout FrtosTimeoutToStk ( TickType_t t )

inlinestatic

< Block indefinitely.

Definition at line 330 of file freertos_stk.cpp.

{
    if (t == portMAX_DELAY)
        return stk::WAIT_INFINITE;
 
    if (t == 0U)
        return stk::NO_WAIT;
 
    return static_cast<stk::Timeout>(t);
}

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

Referenced by ulTaskNotifyTakeIndexed(), vTaskDelay(), xEventGroupSync(), xEventGroupWaitBits(), xMessageBufferReceive(), xMessageBufferSend(), xQueuePeek(), xQueueReceive(), xQueueSelectFromSet(), xQueueSend(), xQueueSendToFront(), xSemaphoreTake(), xStreamBufferReceive(), xStreamBufferSend(), xTaskNotifyWaitIndexed(), and xTimerPendFunctionCall().

Here is the caller graph for this function:

GetSemKindFromHandle()

SemKind GetSemKindFromHandle ( const void * obj )

static

Definition at line 605 of file freertos_stk.cpp.

{
    const uint8_t first_byte = *static_cast<const uint8_t *>(obj);
 
    switch (first_byte)
    {
    case static_cast<uint8_t>(SemKind::Counting): return SemKind::Counting;
    case static_cast<uint8_t>(SemKind::Mutex):    return SemKind::Mutex;
    default:                                      return SemKind::None;
    }
}

References Counting, Mutex, and None.

Referenced by QueueHandleAsMutex(), xQueueAddToSet(), and xQueueRemoveFromSet().

Here is the caller graph for this function:

IsIrqContext()

bool IsIrqContext ( )

inlinestatic

Definition at line 344 of file freertos_stk.cpp.

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

References stk::hw::IsInsideISR().

Here is the call graph for this function:

KickPendDrainerFromISR()

void KickPendDrainerFromISR ( )

static

Definition at line 945 of file freertos_stk.cpp.

{
    if ((g_PendDrainer != nullptr) && (g_TimerHost != nullptr))
        g_TimerHost->Restart(*g_PendDrainer, 1U, 1U);
}

References g_PendDrainer, and g_TimerHost.

Referenced by xTimerPendFunctionCallFromISR().

Here is the caller graph for this function:

malloc()

void * malloc

(

size_t

size

)

MsgBufSlotCount()

size_t MsgBufSlotCount ( size_t budget_bytes, size_t max_msg_size )

static

Definition at line 4212 of file freertos_stk.cpp.

{
    const size_t block_size = stk::memory::BlockMemoryPool::AlignBlockSize(max_msg_size);
    const size_t slot_cost  = block_size + FrtosMessageBuffer::ENVELOPE_SIZE;
 
    if (slot_cost == 0U)
        return 0U;
 
    return budget_bytes / slot_cost;
}

References stk::memory::BlockMemoryPool::AlignBlockSize(), and FrtosMessageBuffer::ENVELOPE_SIZE.

Referenced by xMessageBufferCreate().

Here is the call graph for this function:

Here is the caller graph for this function:

NotifyApplyAction()

BaseType_t NotifyApplyAction ( FrtosTask::NotifySlot & slot, uint32_t ulValue, eNotifyAction eAction )

static

Definition at line 3351 of file freertos_stk.cpp.

{
    switch (eAction)
    {
    case eNoAction:
        break;
 
    case eSetBits:
        slot.value |= ulValue;
        break;
 
    case eIncrement:
        slot.value++;
        break;
 
    case eSetValueWithOverwrite:
        slot.value = ulValue;
        break;
 
    case eSetValueWithoutOverwrite:
        if (slot.pending)
            return pdFAIL; // value not consumed yet
        slot.value   = ulValue;
        slot.pending = true;
        break;
 
    default:
        return pdFAIL;
    }
 
    return pdPASS;
}

References eIncrement, eNoAction, eSetBits, eSetValueWithoutOverwrite, eSetValueWithOverwrite, pdFAIL, pdPASS, FrtosTask::NotifySlot::pending, and FrtosTask::NotifySlot::value.

Referenced by xTaskNotifyAndQueryIndexed(), and xTaskNotifyIndexed().

Here is the caller graph for this function:

ObjAlloc()

template<typename T, typename... Args>

T * ObjAlloc ( Args &&... args )

static

Definition at line 137 of file freertos_stk.cpp.

{
    T *obj = nullptr;
 
    void *ptr = pvPortMalloc(sizeof(T));
    if (ptr != nullptr)
        obj = new (ptr) T(static_cast<Args &&>(args)...);
 
    return obj;
}

References pvPortMalloc().

Referenced by CreateMutexInternal(), FrtosQueueSet::FrtosQueueSet(), FrtosSemaphore::FrtosSemaphore(), xEventGroupCreate(), xMessageBufferCreate(), xMessageBufferCreateWithCallback(), xQueueCreate(), xQueueCreateSet(), xSemaphoreCreateBinary(), xSemaphoreCreateCounting(), xStreamBufferCreate(), xStreamBufferCreateWithCallback(), xTaskCreate(), and xTimerCreate().

Here is the call graph for this function:

Here is the caller graph for this function:

ObjAllocArray()

template<typename T>

T * ObjAllocArray ( size_t count )

static

Definition at line 164 of file freertos_stk.cpp.

{
    if (count == 0U)
        return nullptr;
 
    void *ptr = pvPortMalloc(sizeof(T) * count);
    return static_cast<T *>(ptr);
}

References pvPortMalloc().

Referenced by FrtosQueue::AllocBuffer(), FrtosMessageBuffer::FrtosMessageBuffer(), FrtosQueueSet::FrtosQueueSet(), xStreamBufferCreate(), xStreamBufferCreateWithCallback(), and xTaskCreate().

Here is the call graph for this function:

Here is the caller graph for this function:

ObjFree()

template<typename T>

void ObjFree ( T * obj )

static

Definition at line 150 of file freertos_stk.cpp.

{
    if (obj != nullptr)
    {
        obj->~T();
 
        if (obj->m_cb_owned)
            vPortFree(obj);
    }
}

References vPortFree().

Referenced by CreateMutexInternal(), vEventGroupDelete(), vMessageBufferDelete(), vQueueDelete(), vSemaphoreDelete(), vStreamBufferDelete(), vTaskDelete(), xQueueCreate(), xQueueCreateSet(), xSemaphoreCreateBinary(), xSemaphoreCreateCounting(), xTaskCreate(), and xTimerDelete().

Here is the call graph for this function:

Here is the caller graph for this function:

ObjFreeArray()

void ObjFreeArray ( void * ptr )

inlinestatic

Definition at line 175 of file freertos_stk.cpp.

{
    vPortFree(ptr);
}

References vPortFree().

Referenced by xStreamBufferCreate(), xStreamBufferCreateWithCallback(), FrtosMessageBuffer::~FrtosMessageBuffer(), FrtosQueue::~FrtosQueue(), FrtosQueueSet::~FrtosQueueSet(), FrtosStreamBuffer::~FrtosStreamBuffer(), and FrtosTask::~FrtosTask().

Here is the call graph for this function:

Here is the caller graph for this function:

ObjFreeRaw()

template<typename T>

void ObjFreeRaw ( T * obj )

static

Definition at line 184 of file freertos_stk.cpp.

{
    if (obj != nullptr)
    {
        obj->~T();
        vPortFree(obj);
    }
}

References vPortFree().

Referenced by xMessageBufferCreate(), xMessageBufferCreateWithCallback(), FrtosQueueSet::~FrtosQueueSet(), and FrtosSemaphore::~FrtosSemaphore().

Here is the call graph for this function:

Here is the caller graph for this function:

QueueHandleAsMutex()

FrtosSemaphore * QueueHandleAsMutex ( QueueHandle_t xQueue )

inlinestatic

Definition at line 2081 of file freertos_stk.cpp.

{
    if (xQueue == nullptr)
        return nullptr;
 
    // GetSemKindFromHandle() returns SemKind::None for FrtosQueue handles
    // (and any unrecognised object), SemKind::Counting or SemKind::Mutex for
    // FrtosSemaphore handles.  Only SemKind::Mutex carries an owner field.
    if (GetSemKindFromHandle(xQueue) != SemKind::Mutex)
        return nullptr;
 
    return static_cast<FrtosSemaphore *>(xQueue);
}

References GetSemKindFromHandle(), and Mutex.

Referenced by xQueueGetMutexHolder(), and xQueueGetMutexHolderFromISR().

Here is the call graph for this function:

Here is the caller graph for this function:

QueueSetNotify()

template<typename THost>

void QueueSetNotify ( void * member_handle, THost * host )

inlinestatic

Definition at line 796 of file freertos_stk.cpp.

{
#if configUSE_QUEUE_SETS
    // m_set is non-null only when the member was registered with xQueueAddToSet.
    // Post the member handle as a pointer-sized token. TryPut is ISR-safe.
    if (host->m_set != nullptr)
        host->m_set->m_token_mq->TryPut(&member_handle);
#else
    STK_UNUSED(member_handle);
    STK_UNUSED(host);
#endif
}

References STK_UNUSED.

Referenced by xQueueOverwrite(), xQueueOverwriteFromISR(), xQueueSend(), xQueueSendFromISR(), xQueueSendToFront(), xQueueSendToFrontFromISR(), xSemaphoreGive(), and xSemaphoreGiveFromISR().

Here is the caller graph for this function:

ResolveNotifyTarget()

FrtosTask * ResolveNotifyTarget ( TaskHandle_t xTask, UBaseType_t uxIndex )

static

< Number of per-task notification slots (indexed API).

< Number of per-task notification slots (indexed API).

Definition at line 3334 of file freertos_stk.cpp.

{
    STK_ASSERT(uxIndex < (UBaseType_t)configTASK_NOTIFICATION_ARRAY_ENTRIES);
 
    if (uxIndex >= (UBaseType_t)configTASK_NOTIFICATION_ARRAY_ENTRIES)
        return nullptr;
 
    if (xTask == nullptr)
        xTask = xTaskGetCurrentTaskHandle();
 
    return static_cast<FrtosTask *>(xTask);
}

References configTASK_NOTIFICATION_ARRAY_ENTRIES, STK_ASSERT, and xTaskGetCurrentTaskHandle().

Referenced by ulTaskNotifyTakeIndexed(), ulTaskNotifyValueClearIndexed(), xTaskNotifyAndQueryIndexed(), xTaskNotifyGiveIndexed(), xTaskNotifyIndexed(), xTaskNotifyStateClearIndexed(), and xTaskNotifyWaitIndexed().

Here is the call graph for this function:

Here is the caller graph for this function:

StkFlagsToFrtos()

EventBits_t StkFlagsToFrtos ( uint32_t result, EventBits_t snapshot = 0U )

inlinestatic

Definition at line 3079 of file freertos_stk.cpp.

{
    if (stk::sync::EventFlags::IsError(result))
        return snapshot; // timeout, aborted wait (ERROR_CANCELED) or error — return flags snapshot
 
    return static_cast<EventBits_t>(result);
}

References stk::sync::EventFlags::IsError().

Referenced by xEventGroupClearBits(), xEventGroupClearBitsFromISR(), xEventGroupSetBits(), xEventGroupSync(), and xEventGroupWaitBits().

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 44 of file freertos_stk.cpp.

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

StkWeightToFrtosPrio()

UBaseType_t StkWeightToFrtosPrio ( int32_t w )

inlinestatic

Definition at line 311 of file freertos_stk.cpp.

{
    if (w < 0)
        return 0U;
 
    UBaseType_t p = static_cast<UBaseType_t>(w);
 
    if (p >= (UBaseType_t)configMAX_PRIORITIES)
        p = (UBaseType_t)configMAX_PRIORITIES - 1U;
 
    return p;
}

References configMAX_PRIORITIES.

Referenced by uxTaskGetSystemState(), uxTaskPriorityGet(), and vTaskList().

Here is the caller graph for this function:

Variable Documentation

g_PendCallPipe

stk::sync::PipeT<PendCall, 8U > g_PendCallPipe

static

Definition at line 905 of file freertos_stk.cpp.

Referenced by FrtosPendDrainer::OnExpired(), xTimerPendFunctionCall(), and xTimerPendFunctionCallFromISR().

g_PendDrainer

stk::time::TimerHost::Timer* g_PendDrainer = nullptr

static

Definition at line 909 of file freertos_stk.cpp.

Referenced by EnsurePendDrainer(), and KickPendDrainerFromISR().

g_PendDrainerBuf

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

static

Definition at line 908 of file freertos_stk.cpp.

Referenced by EnsurePendDrainer().

g_StkKernel

FrtosKernel g_StkKernel

static

Definition at line 365 of file freertos_stk.cpp.

Referenced by FrtosTimer::EnsureTimerHost().

g_TimerHost

stk::time::TimerHost* g_TimerHost = nullptr

static

Definition at line 818 of file freertos_stk.cpp.

Referenced by FrtosTimer::EnsureTimerHost().

g_TimerHostBuf

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

static

Definition at line 821 of file freertos_stk.cpp.

Referenced by FrtosTimer::EnsureTimerHost().

s_MemStats

stk::memory::MemoryAllocator::Stats s_MemStats(10240U) ( 10240U )

static

Referenced by stk::memory::MemoryAllocator::GetStats(), vPortGetHeapStats(), xPortGetFreeHeapSize(), and xPortGetMinimumEverFreeHeapSize().