kernel.h

Go to the documentation of this file.

/*===========================================================================
     _____        _____        _____        _____
 ___|    _|__  __|_    |__  __|__   |__  __| __  |__  ______
|    \  /  | ||    \      ||     |     ||  |/ /     ||___   |
|     \/   | ||     \     ||     \     ||     \     ||___   |
|__/\__/|__|_||__|\__\  __||__|\__\  __||__|\__\  __||______|
    |_____|      |_____|      |_____|      |_____|

--[Mark3 Realtime Platform]--------------------------------------------------

Copyright (c) 2012 - 2019 m0slevin, all rights reserved.
See license.txt for more information
===========================================================================*/
#pragma once

#include "mark3cfg.h"
#include "kerneltypes.h"
#include "paniccodes.h"
#include "thread.h"

using DebugPrintFunction = void (*)(const char* szString_);

namespace Mark3
{
//---------------------------------------------------------------------------
class Kernel
{
public:
    static void Init();

    static void Start();

    static void CompleteStart();

    static bool IsStarted() { return m_bIsStarted; }
    static void SetPanic(PanicFunc pfPanic_) { m_pfPanic = pfPanic_; }
    static bool IsPanic() { return m_bIsPanic; }
    static void Panic(uint16_t u16Cause_);

#if KERNEL_THREAD_CREATE_CALLOUT

    static void SetThreadCreateCallout(ThreadCreateCallout pfCreate_) { m_pfThreadCreateCallout = pfCreate_; }
#endif // #if KERNEL_THREAD_CREATE_HOOK

#if KERNEL_THREAD_EXIT_CALLOUT

    static void SetThreadExitCallout(ThreadExitCallout pfExit_) { m_pfThreadExitCallout = pfExit_; }
#endif // #if KERNEL_THREAD_EXIT_CALLOUT

#if KERNEL_CONTEXT_SWITCH_CALLOUT

    static void SetThreadContextSwitchCallout(ThreadContextCallout pfContext_)
    {
        m_pfThreadContextCallout = pfContext_;
    }
#endif // KERNEL_CONTEXT_SWITCH_CALLOUT

    static void SetDebugPrintFunction(DebugPrintFunction pfPrintFunction_)
    {
        m_pfDebugPrintFunction = pfPrintFunction_;
    }

    static void DebugPrint(const char* szString_);

#if KERNEL_THREAD_CREATE_CALLOUT

    static ThreadCreateCallout GetThreadCreateCallout() { return m_pfThreadCreateCallout; }
#endif // #if KERNEL_THREAD_CREATE_HOOK
#if KERNEL_THREAD_EXIT_CALLOUT

    static ThreadExitCallout GetThreadExitCallout() { return m_pfThreadExitCallout; }
#endif // #if KERNEL_THREAD_EXIT_HOOK
#if KERNEL_CONTEXT_SWITCH_CALLOUT

    static ThreadContextCallout GetThreadContextSwitchCallout() { return m_pfThreadContextCallout; }
#endif // #if KERNEL_CONTEXT_SWITCH_CALLOUT
#if KERNEL_STACK_CHECK
    static void     SetStackGuardThreshold(uint16_t u16Threshold_) { m_u16GuardThreshold = u16Threshold_; }
    static uint16_t GetStackGuardThreshold() { return m_u16GuardThreshold; }
#endif // #if KERNEL_STACK_CHECK

    static void     Tick() { m_u32Ticks++; }
    static uint32_t GetTicks();

private:
    static bool      m_bIsStarted; 
    static bool      m_bIsPanic;   
    static PanicFunc m_pfPanic;    

#if KERNEL_THREAD_CREATE_CALLOUT
    static ThreadCreateCallout m_pfThreadCreateCallout; 
#endif                                                  // #if KERNEL_THREAD_CREATE_HOOK
#if KERNEL_THREAD_EXIT_CALLOUT
    static ThreadExitCallout m_pfThreadExitCallout; 
#endif                                              // #if KERNEL_THREAD_EXIT_HOOK
#if KERNEL_CONTEXT_SWITCH_CALLOUT
    static ThreadContextCallout m_pfThreadContextCallout; 
#endif                                                    // #if KERNEL_CONTEXT_SWITCH_CALLOUT
    static DebugPrintFunction m_pfDebugPrintFunction;     
#if KERNEL_STACK_CHECK
    static uint16_t m_u16GuardThreshold;
#endif // #if KERNEL_STACK_CHECK
    static uint32_t m_u32Ticks;
};

} // namespace Mark3