SuperTinyKernel™ RTOS 1.08.x
Lightweight, high-performance, deterministic, bare-metal C++ RTOS for resource-constrained embedded systems. MIT Open Source License.
Loading...
Searching...
No Matches
SecureHwCommandQueueTask< _AccessMode > Class Template Reference
Inheritance diagram for SecureHwCommandQueueTask< _AccessMode >:
Collaboration diagram for SecureHwCommandQueueTask< _AccessMode >:

Public Types

enum  

Public Member Functions

 SecureHwCommandQueueTask (stk::Word *stack, size_t stack_size)
TId GetTid () const
virtual void OnDeadlineMissed (uint32_t duration)
 Called by the scheduler if deadline of the task is missed when Kernel is operating in Hard Real-Time mode (see stk::KERNEL_HRT).
virtual void OnExit ()
 Called by the kernel before removal from the scheduling (see stk::KERNEL_DYNAMIC).
virtual Weight GetWeight () const
 Get static base weight of the task.
virtual Timeout GetTimeSlice () const
 Get time-slice quantum of the task (ticks). KERNEL_TIMESLICE only.
virtual const char * GetTraceName () const
 Get task trace name set by application.
virtual size_t GetStackSpace () const
 Get available stack space.

Private Member Functions

void Run () override
 Entry point of the user task.
void Run () override
 Entry point of the user task.
stk::EAccessMode GetAccessMode () const override
 Get pointer to the stack memory.
const stk::MpuRegionList * GetMpuRegions () const override
const stk::Word * GetStack () const override
 Get pointer to the stack memory.
size_t GetStackSize () const override
 Get number of elements of the stack memory array.
void Run () override
 Entry point of the user task.
void Run () override
 Entry point of the user task.
void Run () override
 Entry point of the user task.

Private Attributes

const stk::MpuRegionConfig m_mpu_regions [2]
const stk::MpuRegionList m_mpu_regions_list
stk::Word * m_stack
 pointer to stack buffer
size_t m_stack_size
 stack size in words

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Definition at line 100 of file stk_helper.h.

Partial implementation of the user task.
Definition stk_helper.h:98

Constructor & Destructor Documentation

◆ SecureHwCommandQueueTask()

template<stk::EAccessMode _AccessMode>
SecureHwCommandQueueTask< _AccessMode >::SecureHwCommandQueueTask ( stk::Word * stack,
size_t stack_size )
inline
Examples
blinky_mpu-hard/example.cpp.

Definition at line 366 of file blinky_mpu-hard/example.cpp.

368 {
369 { // Memory region of this class instance
370 .addr = stk::hw::PtrToWord(this),
371 .size = PRIV_TASK_MEMORY_SIZE * sizeof(stk::Word),
376 },
377 { // Peripherals (AIPS 1-4: GPIO, LPUART, CCM, IOMUXC)
378 .addr = PERIPHERAL_AIPS_BASE,
379 .size = PERIPHERAL_AIPS_SIZE,
381 .mem_type = stk::hw::mpu::TYPE_DEVICE,
384 },
385 },
387 m_stack(stack),
389 {}
#define STK_STATIC_ARRAY_SIZE(ARRAY)
Get size of the static array.
Definition stk_defs.h:742
static Word PtrToWord(T *const ptr) noexcept
Cast a pointer to a CPU register-width integer.
Definition stk_arch.h:215
stk::Word * m_stack
pointer to stack buffer
size_t m_stack_size
stack size in words
const stk::MpuRegionConfig m_mpu_regions[2]
const stk::MpuRegionList m_mpu_regions_list

References m_mpu_regions, PERIPHERAL_AIPS_BASE, PERIPHERAL_AIPS_SIZE, PRIV_TASK_MEMORY_SIZE, and stk::hw::PtrToWord().

Here is the call graph for this function:

Member Function Documentation

◆ GetAccessMode()

template<stk::EAccessMode _AccessMode>
stk::EAccessMode SecureHwCommandQueueTask< _AccessMode >::GetAccessMode ( ) const
inlineoverrideprivatevirtual

Get pointer to the stack memory.

Note
Optional. ARM TrustZone only.
Returns
Pointer to the Secure stack memory.

Get up to (STK_MPU_TASK_REGIONS - 1) application-defined MPU regions for this task.

When STK_MPU_STACK_GUARD is enabled, each task owns STK_MPU_TASK_REGIONS (2, 4, 6, 8, 12 or 16, see STK_MPU_TASK_REGIONS) hardware MPU region slots. Slot 0 is always the automatic stack guard, computed by the driver from the task's own stack memory (see IStackMemory::GetStack/GetStackSize). This hook supplies the remaining STK_MPU_TASK_REGIONS-1 slots, letting an application additionally sandbox a task to e.g. a private data buffer, a specific peripheral block, or a shared IPC region - on top of its stack guard.

Returns
Pointer to a constant MpuRegionList containing up to (STK_MPU_TASK_REGIONS - 1) region descriptors, or nullptr if no extra task regions are configured. Array element i is applied at task-relative region index i +1 (i.e. the slots following the stack guard).
Note
Optional. Only consulted when STK_MPU_STACK_GUARD is enabled; a no-op on platforms/builds without MPU stack-guard support.
Read once, when the task is bound via Kernel::AddTask() (through IPlatform::InitStack()), not re-evaluated on every context switch. The underlying MpuRegionList instance referenced by the returned pointer must remain valid (e.g. a static const instance); a stack-local temporary is invalid once this function returns.
Warning
An element count greater than (STK_MPU_TASK_REGIONS - 1) is clamped by the driver (STK_ASSERT fires in debug builds); only the first STK_MPU_TASK_REGIONS-1 entries are ever applied.
class MyTask : public stk::Task<256, stk::ACCESS_USER>
{
static constexpr stk::MpuRegionConfig s_extra_regions[] =
{
{ .addr = MY_BUFFER_ADDR, .size = MY_BUFFER_SIZE,
.access_perm = stk::hw::mpu::ACCESS_FULL,
.mem_type = stk::hw::mpu::TYPE_NORMAL_CACHEABLE,
.exec = stk::hw::mpu::EXEC_NEVER },
};
const stk::MpuRegionList *GetMpuRegions() const override
{
static const stk::MpuRegionList mpu_regions(s_extra_regions, 1U);
return &mpu_regions;
}
void Run() override { ... }
};
See also
TaskMpu::Configure, IPlatform::InitStack, MpuRegionList

Get hardware access mode of the user task.

Implements stk::ITask.

Examples
blinky_mpu-hard/example.cpp.

Definition at line 358 of file blinky_mpu-hard/example.cpp.

358{ return stk::ACCESS_PRIVILEGED; }

References stk::ACCESS_PRIVILEGED.

◆ GetMpuRegions()

template<stk::EAccessMode _AccessMode>
const stk::MpuRegionList * SecureHwCommandQueueTask< _AccessMode >::GetMpuRegions ( ) const
inlineoverrideprivate
Examples
blinky_mpu-hard/example.cpp.

Definition at line 359 of file blinky_mpu-hard/example.cpp.

359{ return &m_mpu_regions_list; }

References m_mpu_regions_list.

◆ GetStack()

template<stk::EAccessMode _AccessMode>
const stk::Word * SecureHwCommandQueueTask< _AccessMode >::GetStack ( ) const
inlineoverrideprivatevirtual

Get pointer to the stack memory.

Implements stk::IStackMemory.

Examples
blinky_mpu-hard/example.cpp.

Definition at line 362 of file blinky_mpu-hard/example.cpp.

362{ return m_stack; }

References m_stack.

◆ GetStackSize()

template<stk::EAccessMode _AccessMode>
size_t SecureHwCommandQueueTask< _AccessMode >::GetStackSize ( ) const
inlineoverrideprivatevirtual

Get number of elements of the stack memory array.

Implements stk::IStackMemory.

Examples
blinky_mpu-hard/example.cpp.

Definition at line 363 of file blinky_mpu-hard/example.cpp.

363{ return m_stack_size; }

References m_stack_size.

◆ GetStackSpace()

virtual size_t stk::IStackMemory::GetStackSpace ( ) const
inlinevirtualinherited

Get available stack space.

Returns
Number of elements of the stack memory array remaining on the stack (computed via the watermark pattern). Returns 0 if the stack has been fully used or the watermark STK_STACK_MEMORY_FILLER was overwritten.
Warning
Stack type: Bottom to Top (index[0]).

Definition at line 511 of file stk_common.h.

512 {
513 const ArrayView<const Word> stack(GetStack(), GetStackSize());
514 const size_t total_size = stack.GetSize();
515 size_t space = 0U;
516
517 for (size_t i = 0U; i < total_size; ++i)
518 {
519 if (stack[i] == STK_STACK_MEMORY_FILLER)
520 {
521 space = i + 1U;
522 }
523 else
524 {
525 break; // terminate loop as soon as watermark ends
526 }
527 }
528
529 return space;
530 }
#define STK_STACK_MEMORY_FILLER
Sentinel value written to the entire stack region at initialization (stack watermark pattern).
Definition stk_defs.h:570
virtual size_t GetStackSize() const =0
Get number of elements of the stack memory array.
virtual const Word * GetStack() const =0
Get pointer to the stack memory.

References stk::ArrayView< T >::GetSize(), GetStack(), GetStackSize(), and STK_STACK_MEMORY_FILLER.

Here is the call graph for this function:

◆ GetTid()

TId stk::Task< _StackSize, _AccessMode >::GetTid ( ) const
inlineinherited

Definition at line 106 of file stk_helper.h.

106{ return GetTidFromUserTask(this); }
TId GetTidFromUserTask(const ITask *task) noexcept
Get task identifier from ITask instance.
Definition stk_arch.h:775

◆ GetTimeSlice()

virtual Timeout stk::ITask::GetTimeSlice ( ) const
inlinevirtualinherited

Get time-slice quantum of the task (ticks). KERNEL_TIMESLICE only.

Returns
Number of ticks the task may run before being rotated behind its same-priority peers, or NO_TIME_SLICE (default) to run until it blocks, yields or is preempted.
Note
Read once when the task is bound by Kernel::AddTask(). Use IKernelService::SetTimeSlice() to change it at run-time.
See also
stk::KERNEL_TIMESLICE, IKernelService::SetTimeSlice

Reimplemented in LedTaskT< _AccessMode >, and LedTaskT< stk::ACCESS_PRIVILEGED >.

Definition at line 1006 of file stk_common.h.

1006{ return NO_TIME_SLICE; }
static constexpr Timeout NO_TIME_SLICE
Time-slice quantum value: no time-slicing for the task (it runs until it blocks, yields or is preempt...
Definition stk_common.h:296

References stk::NO_TIME_SLICE.

Referenced by stk::Kernel< TMode, TSize, TStrategy, TPlatform >::KernelTask::Bind().

Here is the caller graph for this function:

◆ GetTraceName()

virtual const char * stk::ITask::GetTraceName ( ) const
inlinevirtualinherited

Get task trace name set by application.

Returns
Null-terminated name string, or NULL if unused.
Note
Used for debugging and tracing only (e.g. SEGGER SystemView). Kernel does not interpret this value.

Reimplemented in AudioIsrTask, BlinkyTask, cy_stk_thread, LedTask< _Priority, _AccessMode >, LogTask< _AccessMode >, stk::pthread::PthreadTask, stk::pthread::ReaperTask, stk::time::TimerHost::TimerWorkerTask, and UsbDeviceTask.

Definition at line 1013 of file stk_common.h.

1013{ return nullptr; }

◆ GetWeight()

virtual Weight stk::ITask::GetWeight ( ) const
inlinevirtualinherited

Get static base weight of the task.

Returns
Static weight value of the task (must be positive, the valid range is defined by the strategy).
See also
sched::SwitchStrategyFixedPriority, sched::SwitchStrategySmoothWeightedRoundRobin, IKernelTask::GetWeight, IKernelService::InheritWeight, IKernelService::RestoreWeight

Reimplemented in AudioIsrTask, BlinkyTask, cy_stk_thread, LedTaskT< _AccessMode >, LedTaskT< stk::ACCESS_PRIVILEGED >, stk::pthread::PthreadTask, stk::pthread::ReaperTask, stk::TaskW< _Weight, _StackSize, _AccessMode >, stk::TaskW< _Priority, TASK_STACK_SIZE, _AccessMode >, stk::TaskW< _Weight, TASK_STACK_SIZE, _AccessMode >, stk::time::TimerHost::TimerWorkerTask, and UsbDeviceTask.

Definition at line 997 of file stk_common.h.

997{ return DEFAULT_WEIGHT; }
static constexpr Weight DEFAULT_WEIGHT
Weight value: default weight of value (1) (see SwitchStrategySmoothWeightedRoundRobin).
Definition stk_common.h:290

References stk::DEFAULT_WEIGHT.

Referenced by stk::ISyncObject::FindWeightHigherThan().

Here is the caller graph for this function:

◆ OnDeadlineMissed()

virtual void stk::ITask::OnDeadlineMissed ( uint32_t duration)
inlinevirtualinherited

Called by the scheduler if deadline of the task is missed when Kernel is operating in Hard Real-Time mode (see stk::KERNEL_HRT).

Parameters
[in]durationElapsed active time in ticks at the point the deadline was detected. Always greater than the task's configured deadline (ticks).
Note
Optional handler. Use it for fault logging.
After this call returns, IPlatform::ProcessHardFault() is invoked and the system enters a safe state. This function should not attempt to recover scheduling.

Reimplemented in CtrlTask< _AccessMode >, HwLedTask< _AccessMode >, and stk::time::TimerHost::TimerWorkerTask.

Definition at line 973 of file stk_common.h.

973{ STK_UNUSED(duration); }
#define STK_UNUSED(X)
Explicitly marks a variable as unused to suppress compiler warnings.
Definition stk_defs.h:715

References STK_UNUSED.

◆ OnExit()

virtual void stk::ITask::OnExit ( )
inlinevirtualinherited

Called by the kernel before removal from the scheduling (see stk::KERNEL_DYNAMIC).

Note
The task's stack is no longer in use but the ITask object itself is still valid.
The default no-op implementation is sufficient for detached tasks. Override to implement join semantics (signal a waiting joiner).
Called in kernel/tick context - keep it short. ISR-safe primitives only (e.g. stk::sync::Semaphore::Signal(), stk::sync::EventFlags::Set()).
KERNEL_DYNAMIC only. Never called in KERNEL_STATIC mode.
This is the completion notification of a task removal (returning from Run(), IKernelService::ExitTask() or IKernel::ScheduleTaskRemoval()): after it has been observed by another task the kernel no longer references the ITask object, its stack and its slot, so they can be released or reused, and the same ITask can be added again with IKernel::AddTask() (a restart, e.g. tx_thread_reset()). The removal is an atomic step of the kernel tick: the slot is freed right after this call, before any other task can run (single-core kernel). Until then IKernel::AddTask() of the same task fails with ADD_FAIL_DUPLICATE.

Reimplemented in cy_stk_thread, stk::pthread::PthreadTask, and stk::time::TimerHost::TimerWorkerTask.

Definition at line 990 of file stk_common.h.

990{}

Referenced by stk::Kernel< TMode, TSize, TStrategy, TPlatform >::RemoveTask().

Here is the caller graph for this function:

◆ Run() [1/5]

template<stk::EAccessMode _AccessMode>
void SecureHwCommandQueueTask< _AccessMode >::Run ( )
inlineoverrideprivatevirtual

Entry point of the user task.

Note
Called by the Kernel when the task is scheduled for execution. Implement this method with the task's main logic.
Warning
If Kernel is configured as KERNEL_STATIC, the body must contain an infinite loop.
void Run() override
{
while (true)
{
// task logic here
}
}
void Run() override
Entry point of the user task.

Implements stk::ITask.

Examples
blinky-trustzone-sc/example.cpp, blinky_mpu-hard/example.cpp, blinky_mpu-trustzone-sc/example.cpp, blinky_mpu/example.cpp, and blinky_mpu_armv8/example.cpp.

Definition at line 248 of file blinky-trustzone-sc/example.cpp.

249 {
250 while (true)
251 {
253 if (s_HwCmdQueue.Read(cmd))
254 {
255 switch (cmd.id)
256 {
258 Led::SwitchOnExclusive(static_cast<bsp::Led::Id>(cmd.param_0));
259 break;
260 default:
261 STK_ASSERT(false);
262 break;
263 }
264 }
265 }
266 }
#define STK_ASSERT(e)
Runtime assertion. Halts execution if the expression e evaluates to false.
Definition stk_defs.h:532
static void SwitchOnExclusive(Id led)
Definition led.h:48

References HwCommand::CMD_LED_ON, HwCommand::id, HwCommand::param_0, s_HwCmdQueue, STK_ASSERT, and bsp::Led::SwitchOnExclusive().

Here is the call graph for this function:

◆ Run() [2/5]

template<stk::EAccessMode _AccessMode>
void SecureHwCommandQueueTask< _AccessMode >::Run ( )
inlineoverrideprivatevirtual

Entry point of the user task.

Note
Called by the Kernel when the task is scheduled for execution. Implement this method with the task's main logic.
Warning
If Kernel is configured as KERNEL_STATIC, the body must contain an infinite loop.
void Run() override
{
while (true)
{
// task logic here
}
}

Implements stk::ITask.

Definition at line 334 of file blinky_mpu-hard/example.cpp.

335 {
336 while (true)
337 {
339 if (s_HwCmdQueue.Read(cmd))
340 {
341 switch (cmd.id)
342 {
344 Led::SwitchOnExclusive(static_cast<bsp::Led::Id>(cmd.param_0));
345
346 // counter is accessed by a Safe task, no MemManage exception in this case
348 break; }
349 default: {
350 STK_ASSERT(false);
351 break; }
352 }
353 }
354 }
355 }

References HwCommand::CMD_LED_ON, g_SecureCounter, HwCommand::id, HwCommand::param_0, s_HwCmdQueue, STK_ASSERT, and bsp::Led::SwitchOnExclusive().

Here is the call graph for this function:

◆ Run() [3/5]

template<stk::EAccessMode _AccessMode>
void SecureHwCommandQueueTask< _AccessMode >::Run ( )
inlineoverrideprivatevirtual

Entry point of the user task.

Note
Called by the Kernel when the task is scheduled for execution. Implement this method with the task's main logic.
Warning
If Kernel is configured as KERNEL_STATIC, the body must contain an infinite loop.
void Run() override
{
while (true)
{
// task logic here
}
}

Implements stk::ITask.

Definition at line 330 of file blinky_mpu-trustzone-sc/example.cpp.

331 {
332 while (true)
333 {
335 if (s_HwCmdQueue.Read(cmd))
336 {
337 switch (cmd.id)
338 {
340 Led::SwitchOnExclusive(static_cast<bsp::Led::Id>(cmd.param_0));
341 ++s_Counter;
342 break; }
343 default:
344 STK_ASSERT(false);
345 break;
346 }
347 }
348 }
349 }

References HwCommand::CMD_LED_ON, HwCommand::id, HwCommand::param_0, s_HwCmdQueue, STK_ASSERT, and bsp::Led::SwitchOnExclusive().

Here is the call graph for this function:

◆ Run() [4/5]

template<stk::EAccessMode _AccessMode>
void SecureHwCommandQueueTask< _AccessMode >::Run ( )
inlineoverrideprivatevirtual

Entry point of the user task.

Note
Called by the Kernel when the task is scheduled for execution. Implement this method with the task's main logic.
Warning
If Kernel is configured as KERNEL_STATIC, the body must contain an infinite loop.
void Run() override
{
while (true)
{
// task logic here
}
}

Implements stk::ITask.

Definition at line 326 of file blinky_mpu/example.cpp.

327 {
328 while (true)
329 {
331 if (s_HwCmdQueue.Read(cmd))
332 {
333 switch (cmd.id)
334 {
336 Led::SwitchOnExclusive(static_cast<bsp::Led::Id>(cmd.param_0));
337
338 // counter is accessed by a Safe task, no MemManage exception in this case
340 break; }
341 default: {
342 STK_ASSERT(false);
343 break; }
344 }
345 }
346 }
347 }

References HwCommand::CMD_LED_ON, g_SecureCounter, HwCommand::id, HwCommand::param_0, s_HwCmdQueue, STK_ASSERT, and bsp::Led::SwitchOnExclusive().

Here is the call graph for this function:

◆ Run() [5/5]

template<stk::EAccessMode _AccessMode>
void SecureHwCommandQueueTask< _AccessMode >::Run ( )
inlineoverrideprivatevirtual

Entry point of the user task.

Note
Called by the Kernel when the task is scheduled for execution. Implement this method with the task's main logic.
Warning
If Kernel is configured as KERNEL_STATIC, the body must contain an infinite loop.
void Run() override
{
while (true)
{
// task logic here
}
}

Implements stk::ITask.

Definition at line 268 of file blinky_mpu_armv8/example.cpp.

269 {
270 while (true)
271 {
273 if (s_HwCmdQueue.Read(cmd))
274 {
275 switch (cmd.id)
276 {
278 Led::SwitchOnExclusive(static_cast<bsp::Led::Id>(cmd.param_0));
279
280 // counter is accessed by a Safe task, no MemManage exception in this case
282 break; }
283 default: {
284 STK_ASSERT(false);
285 break; }
286 }
287 }
288 }
289 }

References HwCommand::CMD_LED_ON, g_SecureCounter, HwCommand::id, HwCommand::param_0, s_HwCmdQueue, STK_ASSERT, and bsp::Led::SwitchOnExclusive().

Here is the call graph for this function:

Member Data Documentation

◆ m_mpu_regions

template<stk::EAccessMode _AccessMode>
const stk::MpuRegionConfig SecureHwCommandQueueTask< _AccessMode >::m_mpu_regions[2]
private
Examples
blinky_mpu-hard/example.cpp.

Definition at line 327 of file blinky_mpu-hard/example.cpp.

Referenced by SecureHwCommandQueueTask().

◆ m_mpu_regions_list

template<stk::EAccessMode _AccessMode>
const stk::MpuRegionList SecureHwCommandQueueTask< _AccessMode >::m_mpu_regions_list
private
Examples
blinky_mpu-hard/example.cpp.

Definition at line 328 of file blinky_mpu-hard/example.cpp.

Referenced by GetMpuRegions().

◆ m_stack

template<stk::EAccessMode _AccessMode>
stk::Word* SecureHwCommandQueueTask< _AccessMode >::m_stack
private

pointer to stack buffer

Examples
blinky_mpu-hard/example.cpp.

Definition at line 331 of file blinky_mpu-hard/example.cpp.

Referenced by GetStack().

◆ m_stack_size

template<stk::EAccessMode _AccessMode>
size_t SecureHwCommandQueueTask< _AccessMode >::m_stack_size
private

stack size in words

Examples
blinky_mpu-hard/example.cpp.

Definition at line 332 of file blinky_mpu-hard/example.cpp.

Referenced by GetStackSize().


The documentation for this class was generated from the following files: