stk_helper.h File Reference

Contains helper implementations which simplify user-side code. More...

#include "stk_common.h"
#include "stk_arch.h"

Include dependency graph for stk_helper.h:

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

Go to the source code of this file.

Classes
class	stk::Task< _StackSize, _AccessMode >
	Partial implementation of the user task. More...
class	stk::TaskW< _Weight, _StackSize, _AccessMode >
	Partial implementation of the user task with a compile-time scheduling weight. Use when the kernel is configured with SwitchStrategySmoothWeightedRoundRobin. More...
class	stk::StackMemoryWrapper< _StackSize >
	Adapts an externally-owned stack memory array to the IStackMemory interface. More...

Namespaces
namespace	stk
	Namespace of STK package.

Functions
template<bool TicklessMode>
Timeout	stk::GetInitialSleepTicks ()
template<>
Timeout	stk::GetInitialSleepTicks< true > ()
template<>
Timeout	stk::GetInitialSleepTicks< false > ()
static TId	stk::GetTid ()
	Get task/thread Id of the calling task.
static uint32_t	stk::GetTickResolution ()
	Get number of microseconds in one tick.
static Time	stk::GetMsFromTicks (Ticks tick_count, uint32_t resolution)
	Convert ticks to milliseconds.
static Ticks	stk::GetTicksFromMs (Time ms, uint32_t resolution)
	Convert milliseconds to ticks.
static Ticks	stk::GetTicksFromMs (Time ms)
	Convert milliseconds to ticks using the current kernel tick resolution.
static Timeout	stk::GetTicksFromMsClampedToTimeout (Timeout ms)
	Convert milliseconds to ticks and clamp the result to a Timeout type.
static Ticks	stk::GetTicks ()
	Get number of ticks elapsed since kernel start.
static Time	stk::GetTimeNowMs ()
	Get current time in milliseconds since kernel start.
static Cycles	stk::GetSysTimerCount ()
	Get system timer count value.
static uint32_t	stk::GetSysTimerFrequency ()
	Get system timer frequency.
static void	stk::Sleep (Timeout tick_count)
	Put calling process into a sleep state.
static void	stk::SleepMs (Timeout ms)
	Put calling process into a sleep state.
static bool	stk::SleepUntil (Ticks timestamp)
	Put calling process into a sleep state until the specified timestamp.
static void	stk::SleepCancel (TId task_id)
	Cancel sleep of the task.
static void	stk::Yield ()
	Notify scheduler to switch to the next runnable task.
static void	stk::Delay (Timeout tick_count)
	Delay calling process by busy-waiting until the deadline expires.
static void	stk::DelayMs (Timeout ms)
	Delay calling process by busy-waiting until the deadline expires.

Detailed Description

Contains helper implementations which simplify user-side code.

Definition in file stk_helper.h.