stk_arch_common.h

Go to the documentation of this file.

/*
 * SuperTinyKernel(TM) RTOS: Lightweight High-Performance Deterministic C++ RTOS for Embedded Systems.
 *
 * Source: https://github.com/SuperTinyKernel-RTOS
 *
 * Copyright (c) 2022-2026 Neutron Code Limited <stk@neutroncode.com>. All Rights Reserved.
 * License: MIT License, see LICENSE for a full text.
 */
 
#ifndef STK_ARCH_COMMON_H_
#define STK_ARCH_COMMON_H_

 
#include "stk_common.h"
 
namespace stk {

class PlatformContext
{
public:
    explicit PlatformContext() : m_handler(nullptr), m_service(nullptr), m_stack_idle(nullptr),
        m_stack_active(nullptr), m_tick_resolution(0U)
    {}

    ~PlatformContext()
    {}

    virtual void Initialize(IPlatform::IEventHandler *handler, IKernelService *service, Stack *exit_trap,
        uint32_t resolution_us)
    {
        m_handler         = handler;
        m_service         = service;
        m_stack_idle      = exit_trap;
        m_stack_active    = nullptr;
        m_tick_resolution = resolution_us;
    }

    static inline Word *InitStackMemory(IStackMemory *memory)
    {
        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;
    }
 
    IPlatform::IEventHandler *m_handler;         
    IKernelService           *m_service;         
    Stack                    *m_stack_idle;      
    Stack                    *m_stack_active;    
    uint32_t                  m_tick_resolution; 
 
protected:
    STK_NONCOPYABLE_CLASS(PlatformContext);
};

#ifndef STK_ARCH_GET_CPU_ID
    #define STK_ARCH_GET_CPU_ID() (0)
#endif

#ifndef _STK_UNDER_TEST
    #define GetContext() s_StkPlatformContext[STK_ARCH_GET_CPU_ID()]
#endif

static __stk_forceinline Cycles ConvertTimeUsToClockCycles(Cycles clock_freq, Ticks time_us)
{
    return ((clock_freq * static_cast<Cycles>(time_us)) / 1000000ULL);
}
 
} // namespace stk
 
#endif /* STK_ARCH_COMMON_H_ */