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

#include <stk_arch_common.h>

Collaboration diagram for stk::PlatformContext:

Public Member Functions
	PlatformContext ()
	~PlatformContext ()
	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 *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::PlatformContext::~PlatformContext ( )

inline

Destructor.

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

Definition at line 34 of file stk_arch_common.h.

35 {}

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]	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 * 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: Pointer to initialized stack memory.

Definition at line 57 of file stk_arch_common.h.

    {
        size_t stack_size = memory->GetStackSize();
        Word *itr = memory->GetStack();
        Word *stack_top = itr + stack_size;
 
        STK_ASSERT(stack_size >= STACK_SIZE_MIN);
 
        // initialization of the stack memory satisfies stack integrity check in Kernel::StateSwitch
        while (itr < stack_top)
            *itr++ = STK_STACK_MEMORY_FILLER;
 
        // expecting STK_STACK_MEMORY_ALIGN-byte aligned memory for a stack
        STK_ASSERT((hw::PtrToWord(stack_top) & (STK_STACK_MEMORY_ALIGN - 1)) == 0U);
 
        return stack_top;
    }