Base platform context for all platform implementations. More...

#include <stk_arch_common.h>

Collaboration diagram for stk::PlatformContext:

Public Member Functions
	PlatformContext ()
STK_VIRT_DTOR	~PlatformContext ()=default
	Destructor.
virtual void	Initialize (IPlatform::IEventHandler handler, IKernelService service, Stack *exit_trap, uint32_t resolution_us)
	Initialize context.

Static Public Member Functions
static Word	InitStackMemory (IStackMemory *const memory)
	Initialize stack memory by filling it with STK_STACK_MEMORY_FILLER.

Public Attributes
IPlatform::IEventHandler *	m_handler
	kernel event handler
IKernelService *	m_service
	kernel service
Stack *	m_stack_idle
	idle task stack
Stack *	m_stack_active
	active task stack
uint32_t	m_tick_resolution
	system tick resolution (microseconds)

Protected Member Functions
	STK_NONCOPYABLE_CLASS (PlatformContext)

Detailed Description

Base platform context for all platform implementations.

Definition at line 24 of file stk_arch_common.h.

Constructor & Destructor Documentation

◆ PlatformContext()

stk::PlatformContext::PlatformContext ( )

inlineexplicit

Definition at line 27 of file stk_arch_common.h.

                               : m_handler(nullptr), m_service(nullptr), m_stack_idle(nullptr),
        m_stack_active(nullptr), m_tick_resolution(0U)
    {}

References m_handler, m_service, m_stack_active, m_stack_idle, and m_tick_resolution.

Referenced by STK_NONCOPYABLE_CLASS().

Here is the caller graph for this function:

◆ ~PlatformContext()

STK_VIRT_DTOR stk::PlatformContext::~PlatformContext ( )

default

Destructor.

Note: MISRA deviation: [STK-DEV-005] Rule 10-3-2.

References STK_VIRT_DTOR.

Member Function Documentation

◆ Initialize()

virtual void stk::PlatformContext::Initialize	(	IPlatform::IEventHandler *	handler,
		IKernelService *	service,
		Stack *	exit_trap,
		uint32_t	resolution_us )

inlinevirtual

Initialize context.

Parameters

[in]	handler	Event handler.
[in]	service	Kernel service.
[in]	exit_trap	Exit trap's stack.
[in]	resolution_us	Tick resolution in microseconds (for example 1000 equals to 1 millisecond resolution).

Definition at line 42 of file stk_arch_common.h.

    {
        m_handler         = handler;
        m_service         = service;
        m_stack_idle      = exit_trap;
        m_stack_active    = nullptr;
        m_tick_resolution = resolution_us;
    }

References m_handler, m_service, m_stack_active, m_stack_idle, and m_tick_resolution.

◆ InitStackMemory()

Word stk::PlatformContext::InitStackMemory ( IStackMemory *const memory )

inlinestatic

Initialize stack memory by filling it with STK_STACK_MEMORY_FILLER.

Note: Returned pointer is for a stack growing from top to down.

Parameters

[in] memory Stack memory to initialize.

Returns: Top of the stack memory (valid memory region is (stack_top - sizeof(Word))).

Definition at line 57 of file stk_arch_common.h.

    {
        STK_ASSERT(memory != nullptr);
              
        ArrayView<Word> stack(const_cast<Word *>(memory->GetStack()), memory->GetStackSize());
        STK_ASSERT(stack.GetSize() >= STACK_SIZE_MIN);
        
        // initialize stack memory to satisfy stack integrity check in Kernel::StateSwitch
        for (size_t i = 0U; i < stack.GetSize(); ++i)
        {
            stack[i] = STK_STACK_MEMORY_FILLER;
        }
        
        // get address of the last valid item and step forward by 1 Word size to point to the top
        const Word stack_top = hw::PtrToWord(memory->GetStack()) + (stack.GetSize() * sizeof(Word));
 
        // expecting STK_STACK_MEMORY_ALIGN-byte aligned memory for a stack
        STK_ASSERT((stack_top & (STK_STACK_MEMORY_ALIGN - 1U)) == 0U);
 
        return stack_top;
    }