SuperTinyKernel™ RTOS 1.08.x
Lightweight, high-performance, deterministic, bare-metal C++ RTOS for resource-constrained embedded systems. MIT Open Source License.
Loading...
Searching...
No Matches
stk_arch_risc-v.h
Go to the documentation of this file.
1/*
2 * SuperTinyKernel(TM) RTOS: Lightweight High-Performance Deterministic C++ RTOS for Embedded Systems.
3 *
4 * Source: https://github.com/SuperTinyKernel-RTOS
5 *
6 * Copyright (c) 2022-2026 Neutron Code Limited <stk@neutroncode.com>. All Rights Reserved.
7 * License: MIT License, see LICENSE for a full text.
8 */
9
10#ifndef STK_ARCH_RISC_V_H_
11#define STK_ARCH_RISC_V_H_
12
13#include "stk_common.h"
14
18
19namespace stk {
20
25{
26public:
31
36 {
37 public:
42 virtual bool OnException(Word cause) = 0;
43 };
44
45 void Initialize(IEventHandler *event_handler, IKernelService *service, uint32_t resolution_us, Stack *exit_trap) override;
46 void Start() override;
47 void Stop() override;
48 void InitStack(EStackType stack_type, Stack *stack, IStackMemory *stack_memory, ITask *user_task) override;
49 uint32_t GetTickResolution() const override;
50 Cycles GetSysTimerCount() const override;
51 uint32_t GetSysTimerFrequency() const override;
52 void ForceContextSwitch(TId id) override;
53 void ProcessTick() override;
54 void ProcessHardFault() override;
55 void SetEventOverrider(IEventOverrider *overrider, bool non_secure) override;
56 Word GetCallerSP() const override;
57 TId GetTid() const override;
58 Timeout Suspend() override;
59 void Resume(Timeout elapsed_ticks) override;
60 void SetCpuFrequency(uint8_t core_id, uint32_t frequency) override;
61
63};
64
69
70// Inline TLS via x4/tp. Active when both STK_TLS and STK_TLS_PREFER_REGISTER are enabled.
71#if STK_TLS && STK_TLS_PREFER_REGISTER
72
77static __stk_forceinline Word GetTls()
78{
79 Word tp;
80 __asm volatile("mv %0, tp" : "=r"(tp) : /* input: none */ : /* clobbers: none */);
81 return tp;
82}
83
88static __stk_forceinline void SetTls(Word tp)
89{
90 __asm volatile("mv tp, %0" : /* output: none */ : "r"(tp) : /* clobbers: none */);
91}
92
93// Notify stk_arch.h that we defined inline versions of GetTls/SetTls.
94#define STK_INLINE_TLS (1)
95
96#endif // STK_TLS && STK_TLS_PREFER_REGISTER
97
98} // namespace stk
99
102static __stk_forceinline void __stk_dmb() { __asm volatile("fence rw, rw" ::: "memory"); }
103
108#ifndef STK_SUBMICORSECOND_PRECISION_TIMER
109 #define STK_SUBMICORSECOND_PRECISION_TIMER 0
110#endif
111
115#ifndef STK_SYSTEM_CORE_CLOCK_FREQUENCY
116 #define STK_SYSTEM_CORE_CLOCK_FREQUENCY 150000000U
117#endif
118
122extern "C" volatile uint32_t STK_SYSTEM_CORE_CLOCK_VAR;
123
124#endif /* STK_ARCH_RISC_V_H_ */
static __stk_forceinline void __stk_dmb()
Data memory barrier.
volatile uint32_t STK_SYSTEM_CORE_CLOCK_VAR
System clock frequency in Hz.
Contains interface definitions of the library.
#define __stk_forceinline
Forces compiler to always inline the decorated function, regardless of optimisation level.
Definition stk_defs.h:270
#define STK_VIRT_DTOR
Expands to nothing if STK_STRICT_COMPLIANCY=0 (non-virtual destructors, smaller objects),...
Definition stk_defs.h:254
Namespace of STK package.
uintptr_t Word
Native processor word type.
Definition stk_common.h:206
int32_t Timeout
Timeout time (ticks).
Definition stk_common.h:216
PlatformArmCortexM PlatformDefault
Default platform implementation.
EStackType
Stack type.
Definition stk_common.h:96
uint64_t Cycles
Cycles value.
Definition stk_common.h:231
Word TId
Task (thread) id.
Definition stk_common.h:211
Concrete implementation of IPlatform driver for RISC-V processors.
Cycles GetSysTimerCount() const override
Get system timer count value.
Word GetCallerSP() const override
Get caller's Stack Pointer (SP).
void Resume(Timeout elapsed_ticks) override
Resume scheduling after a prior Suspend() call.
void Start() override
Start scheduling.
uint32_t GetTickResolution() const override
Get resolution of the system tick timer in microseconds. Resolution means a number of microseconds be...
uint32_t GetSysTimerFrequency() const override
Get system timer frequency.
void ProcessHardFault() override
Cause a hard fault of the system.
void InitStack(EStackType stack_type, Stack *stack, IStackMemory *stack_memory, ITask *user_task) override
Initialize stack memory of the user task.
void ProcessTick() override
Process one tick.
TId GetTid() const override
Get thread Id.
void ForceContextSwitch(TId id) override
Force context switch.
void SetSpecificEventHandler(ISpecificEventHandler *handler)
void SetCpuFrequency(uint8_t core_id, uint32_t frequency) override
Notify the scheduler of a CPU core's operating frequency.
void SetEventOverrider(IEventOverrider *overrider, bool non_secure) override
Set platform event overrider.
void Stop() override
Stop scheduling.
STK_VIRT_DTOR ~PlatformRiscV()=default
Destructor.
Timeout Suspend() override
Suspend scheduling.
void Initialize(IEventHandler *event_handler, IKernelService *service, uint32_t resolution_us, Stack *exit_trap) override
Initialize scheduler's context.
RISC-V specific event handler, see SetSpecificEventHandler().
virtual bool OnException(Word cause)=0
Called by the trap handler for a RISC-V exception/interrupt cause (IRQ_XXX, see encoding....
Stack descriptor.
Definition stk_common.h:473
Interface for a stack memory region.
Definition stk_common.h:494
Interface for a user task.
Definition stk_common.h:886
Interface for a platform driver.
Interface for a back-end event handler.
Interface for a platform event overrider.
Interface for the kernel services exposed to the user processes during run-time when Kernel started s...