stk::time::TimerHost::TimerWorkerTask Class Reference

Internal kernel task used by TimerHost for both the tick task and handler tasks. More...

Inheritance diagram for stk::time::TimerHost::TimerWorkerTask:

Collaboration diagram for stk::time::TimerHost::TimerWorkerTask:

Public Member Functions
	TimerWorkerTask ()
	Default constructor. All members are zero/null-initialized.
EAccessMode	GetAccessMode () const override
	Get hardware access mode of the user task.
void	OnDeadlineMissed (uint32_t) override
	Called by the scheduler if deadline of the task is missed when Kernel is operating in Hard Real-Time mode (see stk::KERNEL_HRT).
void	OnExit () override
	Called by the kernel before removal from the scheduling (see stk::KERNEL_DYNAMIC).
int32_t	GetWeight () const override
	Get static base weight of the task.
const char *	GetTraceName () const override
	Get task trace name set by application.
const Word *	GetStack () const override
	Get pointer to the stack memory.
size_t	GetStackSize () const override
	Get number of elements of the stack memory array.
size_t	GetStackSizeBytes () const override
	Get size of the memory in bytes.
void	Initialize (TimerHost *host, Word *stack, size_t stack_size, EAccessMode mode, TimerFuncType const func)
	Bind this task to a host, stack buffer, access mode, and entry function.
void	SetWeight (int32_t weight)
	Override the scheduling weight assigned by Initialize().
TId	GetId () const
	Get task Id set by application.
virtual size_t	GetStackSpace () const
	Get available stack space.

Private Member Functions
void	Run () override
	Timer task entry point.

Private Attributes
TimerFuncType	m_func
	entry function (tick loop or handler loop)
TimerHost *	m_host
	owning TimerHost instance
Word *	m_stack
	pointer to stack buffer
size_t	m_stack_size
	stack size in words
EAccessMode	m_mode
	kernel access mode
int32_t	m_weight
	scheduling weight

Detailed Description

Internal kernel task used by TimerHost for both the tick task and handler tasks.

Wraps a free function pointer (TimerFuncType) so that the same ITask-derived class can serve either role (tick or handler) with different stack buffers, access modes, and entry points supplied at Initialize() time.

Note

This class is an implementation detail of TimerHost and is not part of the public API. Do not instantiate or inherit from it directly.

Definition at line 330 of file stk_time_timer.h.

Constructor & Destructor Documentation

TimerWorkerTask()

stk::time::TimerHost::TimerWorkerTask::TimerWorkerTask ( )

inlineexplicit

Default constructor. All members are zero/null-initialized.

Definition at line 334 of file stk_time_timer.h.

            : m_func(nullptr), m_host(nullptr), m_stack(nullptr), m_stack_size(0U), 
              m_mode(ACCESS_USER), m_weight(DEFAULT_WEIGHT)
        {}

References stk::ACCESS_USER, stk::DEFAULT_WEIGHT, m_func, m_host, m_mode, m_stack, m_stack_size, and m_weight.

Member Function Documentation

GetAccessMode()

EAccessMode stk::time::TimerHost::TimerWorkerTask::GetAccessMode ( ) const

inlineoverridevirtual

Get hardware access mode of the user task.

Implements stk::ITask.

Definition at line 340 of file stk_time_timer.h.

{ return m_mode; }

References m_mode.

GetId()

TId stk::ITask::GetId ( ) const

inlineinherited

Get task Id set by application.

Implementation of ITask::GetId, see ITask. Placed here as it depends on GetTidFromUserTask.

Returns

Application-defined task identifier. Return 0 if unused.

Note

Used for debugging and tracing only. The kernel does not interpret this value.

Definition at line 234 of file stk_helper.h.

{
    return GetTidFromUserTask(this);
}

References stk::GetTidFromUserTask().

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

Here is the call graph for this function:

Here is the caller graph for this function:

GetStack()

const Word * stk::time::TimerHost::TimerWorkerTask::GetStack ( ) const

inlineoverridevirtual

Get pointer to the stack memory.

Implements stk::IStackMemory.

Definition at line 347 of file stk_time_timer.h.

{ return m_stack; }

References m_stack.

GetStackSize()

size_t stk::time::TimerHost::TimerWorkerTask::GetStackSize ( ) const

inlineoverridevirtual

Get number of elements of the stack memory array.

Implements stk::IStackMemory.

Definition at line 348 of file stk_time_timer.h.

{ return m_stack_size; }

References m_stack_size.

GetStackSizeBytes()

size_t stk::time::TimerHost::TimerWorkerTask::GetStackSizeBytes ( ) const

inlineoverridevirtual

Get size of the memory in bytes.

Implements stk::IStackMemory.

Definition at line 349 of file stk_time_timer.h.

{ return (m_stack_size * sizeof(Word)); }

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 319 of file stk_common.h.

    {
        const ArrayView<const Word> stack(GetStack(), GetStackSize());
        const size_t total_size = stack.GetSize();
        size_t space = 0U;
 
        for (size_t i = 0U; i < total_size; ++i)
        {
            if (stack[i] == STK_STACK_MEMORY_FILLER)
            {
                space = i + 1U;
            }
            else
            {
                break; // terminate loop as soon as watermark ends
            }
        }
 
        return space;
    }

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

Referenced by FrtosTask::GetStackHighWaterMark(), and osThreadGetStackSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTraceName()

const char * stk::time::TimerHost::TimerWorkerTask::GetTraceName ( ) const

inlineoverridevirtual

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 from stk::ITask.

Definition at line 344 of file stk_time_timer.h.

{ return nullptr; }

GetWeight()

int32_t stk::time::TimerHost::TimerWorkerTask::GetWeight ( ) const

inlineoverridevirtual

Get static base weight of the task.

Returns

Static weight value of the task (must be non-zero, positive 24-bit number).

See also

SwitchStrategyFixedPriority, SwitchStrategySmoothWeightedRoundRobin, IKernelTask::GetWeight, IKernelService::InheritWeight, IKernelService::RestoreWeight

Reimplemented from stk::ITask.

Definition at line 343 of file stk_time_timer.h.

{ return m_weight; }

References m_weight.

Initialize()

void stk::time::TimerHost::TimerWorkerTask::Initialize ( TimerHost * host, Word * stack, size_t stack_size, EAccessMode mode, TimerFuncType const func )

inline

Bind this task to a host, stack buffer, access mode, and entry function.

Parameters

[in]	host	TimerHost instance this task belongs to.
[in]	stack	Pointer to the pre-allocated stack memory.
[in]	stack_size	Stack size in words.
[in]	mode	Kernel access mode (user or privileged).
[in]	func	Entry function called in the task's context.

Note

Must be called before the task is added to the kernel.

Definition at line 359 of file stk_time_timer.h.

        {
            m_host       = host;
            m_func       = func;
            m_stack      = stack;
            m_stack_size = stack_size;
            m_mode       = mode;
            m_weight     = DEFAULT_WEIGHT;
        }

References stk::DEFAULT_WEIGHT, m_func, m_host, m_mode, m_stack, m_stack_size, m_weight, and stk::time::TimerHost::TimerHost().

Here is the call graph for this function:

OnDeadlineMissed()

void stk::time::TimerHost::TimerWorkerTask::OnDeadlineMissed ( uint32_t duration )

inlineoverridevirtual

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]

duration

Elapsed 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 from stk::ITask.

Definition at line 341 of file stk_time_timer.h.

{}

OnExit()

void stk::time::TimerHost::TimerWorkerTask::OnExit ( )

inlineoverridevirtual

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.

Reimplemented from stk::ITask.

Definition at line 342 of file stk_time_timer.h.

{}

Run()

void stk::time::TimerHost::TimerWorkerTask::Run ( )

inlineoverrideprivatevirtual

Timer task entry point.

Implements stk::ITask.

Definition at line 377 of file stk_time_timer.h.

{ m_func(m_host); }

References m_func, and m_host.

SetWeight()

void stk::time::TimerHost::TimerWorkerTask::SetWeight ( int32_t weight )

inline

Override the scheduling weight assigned by Initialize().

Parameters

[in]

weight

New scheduling weight value.

Definition at line 373 of file stk_time_timer.h.

{ m_weight = weight; }

References m_weight.

Member Data Documentation

m_func

TimerFuncType stk::time::TimerHost::TimerWorkerTask::m_func

private

entry function (tick loop or handler loop)

Definition at line 379 of file stk_time_timer.h.

Referenced by Initialize(), Run(), and TimerWorkerTask().

m_host

TimerHost* stk::time::TimerHost::TimerWorkerTask::m_host

private

owning TimerHost instance

Definition at line 380 of file stk_time_timer.h.

Referenced by Initialize(), Run(), and TimerWorkerTask().

m_mode

EAccessMode stk::time::TimerHost::TimerWorkerTask::m_mode

private

kernel access mode

Definition at line 383 of file stk_time_timer.h.

Referenced by GetAccessMode(), Initialize(), and TimerWorkerTask().

m_stack

Word* stk::time::TimerHost::TimerWorkerTask::m_stack

private

pointer to stack buffer

Definition at line 381 of file stk_time_timer.h.

Referenced by GetStack(), Initialize(), and TimerWorkerTask().

m_stack_size

size_t stk::time::TimerHost::TimerWorkerTask::m_stack_size

private

stack size in words

Definition at line 382 of file stk_time_timer.h.

Referenced by GetStackSize(), GetStackSizeBytes(), Initialize(), and TimerWorkerTask().

m_weight

int32_t stk::time::TimerHost::TimerWorkerTask::m_weight

private

scheduling weight

Definition at line 384 of file stk_time_timer.h.

Referenced by GetWeight(), Initialize(), SetWeight(), and TimerWorkerTask().

---

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

• stk_time_timer.h