Mark3 Realtime Kernel
kernel.cpp
Go to the documentation of this file.
1 /*===========================================================================
2  _____ _____ _____ _____
3  ___| _|__ __|_ |__ __|__ |__ __| __ |__ ______
4 | \ / | || \ || | || |/ / ||___ |
5 | \/ | || \ || \ || \ ||___ |
6 |__/\__/|__|_||__|\__\ __||__|\__\ __||__|\__\ __||______|
7  |_____| |_____| |_____| |_____|
8 
9 --[Mark3 Realtime Platform]--------------------------------------------------
10 
11 Copyright (c) 2012 - 2019 m0slevin, all rights reserved.
12 See license.txt for more information
13 ===========================================================================*/
21 #include "mark3.h"
22 namespace Mark3
23 {
24 bool Kernel::m_bIsStarted;
25 bool Kernel::m_bIsPanic;
26 PanicFunc Kernel::m_pfPanic;
27 
28 #if KERNEL_THREAD_CREATE_CALLOUT
29 ThreadCreateCallout Kernel::m_pfThreadCreateCallout;
30 #endif // #if KERNEL_THREAD_CREATE_CALLOUT
31 #if KERNEL_THREAD_EXIT_CALLOUT
32 ThreadExitCallout Kernel::m_pfThreadExitCallout;
33 #endif // #if KERNEL_THREAD_EXIT_CALLOUT
34 #if KERNEL_CONTEXT_SWITCH_CALLOUT
35 ThreadContextCallout Kernel::m_pfThreadContextCallout;
36 #endif // #if KERNEL_CONTEXT_SWITCH_CALLOUT
37 DebugPrintFunction Kernel::m_pfDebugPrintFunction;
38 #if KERNEL_STACK_CHECK
39 uint16_t Kernel::m_u16GuardThreshold;
40 #endif // #if KERNEL_STACK_CHECK
41 uint32_t Kernel::m_u32Ticks;
42 
43 //---------------------------------------------------------------------------
44 void Kernel::Init()
45 {
46  // Call port-specific early init function
47  ThreadPort::Init();
48  AutoAlloc::Init();
49  // Initialize the global kernel data - thread-scheduler, and timer-scheduler.
50  Scheduler::Init();
51  TimerScheduler::Init();
52 #if KERNEL_STACK_CHECK
53  m_u16GuardThreshold = KERNEL_STACK_GUARD_DEFAULT;
54 #endif // #if KERNEL_STACK_CHECK
55 }
56 
57 //---------------------------------------------------------------------------
58 void Kernel::Start()
59 {
60  ThreadPort::StartThreads();
61 }
62 
63 //---------------------------------------------------------------------------
64 void Kernel::CompleteStart()
65 {
66  m_bIsStarted = true;
67 }
68 
69 //---------------------------------------------------------------------------
70 void Kernel::Panic(uint16_t u16Cause_)
71 {
72  m_bIsPanic = true;
73  if (nullptr != m_pfPanic) {
74  m_pfPanic(u16Cause_);
75  } else {
76  while (true) {}
77  }
78 }
79 
80 //---------------------------------------------------------------------------
81 void Kernel::DebugPrint(const char* szString_)
82 {
83  KERNEL_ASSERT(nullptr != szString_);
84  if (nullptr != m_pfDebugPrintFunction) {
85  m_pfDebugPrintFunction(szString_);
86  }
87 }
88 
89 //---------------------------------------------------------------------------
90 uint32_t Kernel::GetTicks()
91 {
92  auto cs = CriticalGuard{};
93  return m_u32Ticks;
94 }
95 
96 } // namespace Mark3
Mark3::ThreadPort::StartThreads
static void StartThreads()
StartThreads Function to start the scheduler, initial threads, etc.
Definition: threadport.cpp:100
Mark3::ThreadExitCallout
void(*)(Thread *pclThread_) ThreadExitCallout
Definition: thread.h:53
DebugPrintFunction
void(*)(const char *szString_) DebugPrintFunction
Definition: kernel.h:39
Mark3::ThreadCreateCallout
void(*)(Thread *pclThread_) ThreadCreateCallout
Definition: thread.h:52
Mark3::ThreadPort::Init
static void Init()
Init Function to perform early init of the target environment prior to using OS primatives.
Definition: ithreadport.h:43
KERNEL_STACK_GUARD_DEFAULT
#define KERNEL_STACK_GUARD_DEFAULT
Definition: portcfg.h:41
Mark3::TimerScheduler::Init
static void Init()
Init Initialize the timer scheduler. Must be called before any timer, or timer-derived functions are ...
Definition: timerscheduler.h:46
KERNEL_ASSERT
#define KERNEL_ASSERT(x)
Definition: kerneldebug.h:36
Mark3::Kernel::m_pfThreadExitCallout
static ThreadExitCallout m_pfThreadExitCallout
Function to call on thread exit.
Definition: kernel.h:217
Mark3::AutoAlloc::Init
static void Init(void)
Init Initialize the AutoAllocator before use. Called by Kernel::Init().
Definition: autoalloc.cpp:83
Mark3::Kernel::DebugPrint
static void DebugPrint(const char *szString_)
DebugPrint Print a string to the configured output interface. Has no effect if Kernel::SetDebugPrintF...
Definition: kernel.cpp:81
Mark3
Definition: atomic.cpp:23
mark3.h
Single include file given to users of the Mark3 Kernel API.
Mark3::Kernel::m_pfPanic
static PanicFunc m_pfPanic
set panic function
Definition: kernel.h:211
Mark3::Kernel::GetTicks
static uint32_t GetTicks()
Definition: kernel.cpp:90
Mark3::Kernel::CompleteStart
static void CompleteStart()
CompleteStart Call this from the thread initialization code at the point that the scheduler is to be ...
Definition: kernel.cpp:64
Mark3::Kernel::Start
static void Start()
Start the operating system kernel - the current execution context is cancelled, all kernel services a...
Definition: kernel.cpp:58
Mark3::Kernel::m_bIsStarted
static bool m_bIsStarted
true if kernel is running, false otherwise
Definition: kernel.h:209
Mark3::CriticalGuard
The CriticalGuard class. This class provides an implemention of RAII for critical sections...
Definition: criticalguard.h:38
Mark3::Kernel::m_pfThreadCreateCallout
static ThreadCreateCallout m_pfThreadCreateCallout
Function to call on thread creation.
Definition: kernel.h:214
Mark3::ThreadContextCallout
void(*)(Thread *pclThread_) ThreadContextCallout
Definition: thread.h:54
Mark3::Kernel::m_pfDebugPrintFunction
static DebugPrintFunction m_pfDebugPrintFunction
Function to call to print debug info.
Definition: kernel.h:222
Mark3::Kernel::m_u16GuardThreshold
static uint16_t m_u16GuardThreshold
Definition: kernel.h:224
Mark3::Kernel::m_bIsPanic
static bool m_bIsPanic
true if kernel is in panic state, false otherwise
Definition: kernel.h:210
Mark3::Scheduler::Init
static void Init()
Init Intiailize the scheduler, must be called before use.
Definition: scheduler.cpp:36
Mark3::Kernel::m_u32Ticks
static uint32_t m_u32Ticks
Definition: kernel.h:226
Mark3::PanicFunc
void(*)(uint16_t u16PanicCode_) PanicFunc
Definition: kerneltypes.h:30
Mark3::Kernel::m_pfThreadContextCallout
static ThreadContextCallout m_pfThreadContextCallout
Function to call on context switch.
Definition: kernel.h:220
Mark3::Kernel::Init
static void Init()
Kernel Initialization Function, call before any other OS function.
Definition: kernel.cpp:44
Mark3::Kernel::Panic
static void Panic(uint16_t u16Cause_)
Panic Cause the kernel to enter its panic state.
Definition: kernel.cpp:70