ChibiOS
21.6.0
|
System related APIs and services:
Macros | |
#define | CH_SYS_CORE0_MEMORY PORT_CORE0_BSS_SECTION |
Core zero memory affinity macro. More... | |
#define | CH_SYS_CORE1_MEMORY PORT_CORE1_BSS_SECTION |
Core one memory affinity macro. More... | |
#define | currcore ch_system.instances[port_get_core_id()] |
Access to current core's instance structure. More... | |
#define | chSysGetRealtimeCounterX() (rtcnt_t)port_rt_get_counter_value() |
Returns the current value of the system real time counter. More... | |
#define | chSysSwitch(ntp, otp) |
Performs a context switch. More... | |
Masks of executable integrity checks. | |
#define | CH_INTEGRITY_RLIST 1U |
#define | CH_INTEGRITY_VTLIST 2U |
#define | CH_INTEGRITY_REGISTRY 4U |
#define | CH_INTEGRITY_PORT 8U |
ISRs abstraction macros | |
#define | CH_IRQ_IS_VALID_PRIORITY(prio) PORT_IRQ_IS_VALID_PRIORITY(prio) |
Priority level validation macro. More... | |
#define | CH_IRQ_IS_VALID_KERNEL_PRIORITY(prio) PORT_IRQ_IS_VALID_KERNEL_PRIORITY(prio) |
Priority level validation macro. More... | |
#define | CH_IRQ_PROLOGUE() |
IRQ handler enter code. More... | |
#define | CH_IRQ_EPILOGUE() |
IRQ handler exit code. More... | |
#define | CH_IRQ_HANDLER(id) PORT_IRQ_HANDLER(id) |
Standard normal IRQ handler declaration. More... | |
Fast ISRs abstraction macros | |
#define | CH_FAST_IRQ_HANDLER(id) PORT_FAST_IRQ_HANDLER(id) |
Standard fast IRQ handler declaration. More... | |
Time conversion utilities for the realtime counter | |
#define | S2RTC(freq, sec) ((freq) * (sec)) |
Seconds to realtime counter. More... | |
#define | MS2RTC(freq, msec) (rtcnt_t)((((freq) + 999UL) / 1000UL) * (msec)) |
Milliseconds to realtime counter. More... | |
#define | US2RTC(freq, usec) (rtcnt_t)((((freq) + 999999UL) / 1000000UL) * (usec)) |
Microseconds to realtime counter. More... | |
#define | RTC2S(freq, n) ((((n) - 1UL) / (freq)) + 1UL) |
Realtime counter cycles to seconds. More... | |
#define | RTC2MS(freq, n) ((((n) - 1UL) / ((freq) / 1000UL)) + 1UL) |
Realtime counter cycles to milliseconds. More... | |
#define | RTC2US(freq, n) ((((n) - 1UL) / ((freq) / 1000000UL)) + 1UL) |
Realtime counter cycles to microseconds. More... | |
Functions | |
static CH_SYS_CORE0_MEMORY | THD_WORKING_AREA (ch_c0_idle_thread_wa, PORT_IDLE_THREAD_STACK_SIZE) |
Working area for core 0 idle thread. More... | |
static CH_SYS_CORE1_MEMORY | THD_WORKING_AREA (ch_c1_idle_thread_wa, PORT_IDLE_THREAD_STACK_SIZE) |
Working area for core 1 idle thread. More... | |
void | chSysWaitSystemState (system_state_t state) |
Waits for the system state to be equal to the specified one. More... | |
void | chSysInit (void) |
System initialization. More... | |
void | chSysHalt (const char *reason) |
Halts the system. More... | |
bool | chSysIntegrityCheckI (unsigned testmask) |
System integrity check. More... | |
void | chSysTimerHandlerI (void) |
Handles time ticks for round robin preemption and timer increments. More... | |
syssts_t | chSysGetStatusAndLockX (void) |
Returns the execution status and enters a critical zone. More... | |
void | chSysRestoreStatusX (syssts_t sts) |
Restores the specified execution status and leaves a critical zone. More... | |
bool | chSysIsCounterWithinX (rtcnt_t cnt, rtcnt_t start, rtcnt_t end) |
Realtime window test. More... | |
void | chSysPolledDelayX (rtcnt_t cycles) |
Polled delay. More... | |
static void | chSysDisable (void) |
Raises the system interrupt priority mask to the maximum level. More... | |
static void | chSysSuspend (void) |
Raises the system interrupt priority mask to system level. More... | |
static void | chSysEnable (void) |
Lowers the system interrupt priority mask to user level. More... | |
static void | chSysLock (void) |
Enters the kernel lock state. More... | |
static void | chSysUnlock (void) |
Leaves the kernel lock state. More... | |
static void | chSysLockFromISR (void) |
Enters the kernel lock state from within an interrupt handler. More... | |
static void | chSysUnlockFromISR (void) |
Leaves the kernel lock state from within an interrupt handler. More... | |
static void | chSysUnconditionalLock (void) |
Unconditionally enters the kernel lock state. More... | |
static void | chSysUnconditionalUnlock (void) |
Unconditionally leaves the kernel lock state. More... | |
static void | chSysNotifyInstance (os_instance_t *oip) |
Notifies an OS instance to check for reschedule. More... | |
static thread_t * | chSysGetIdleThreadX (void) |
Returns a pointer to the idle thread. More... | |
Variables | |
ch_system_t | ch_system |
System root object. More... | |
CH_SYS_CORE0_MEMORY os_instance_t | ch0 |
Core 0 OS instance. More... | |
const os_instance_config_t | ch_core0_cfg |
Core 0 OS instance configuration. More... | |
CH_SYS_CORE1_MEMORY os_instance_t | ch1 |
Core 1 OS instance. More... | |
const os_instance_config_t | ch_core1_cfg |
Core 1 OS instance configuration. More... | |
#define CH_SYS_CORE0_MEMORY PORT_CORE0_BSS_SECTION |
#define CH_SYS_CORE1_MEMORY PORT_CORE1_BSS_SECTION |
#define currcore ch_system.instances[port_get_core_id()] |
#define CH_IRQ_IS_VALID_PRIORITY | ( | prio | ) | PORT_IRQ_IS_VALID_PRIORITY(prio) |
Priority level validation macro.
This macro determines if the passed value is a valid priority level for the underlying architecture.
[in] | prio | the priority level |
false | if the priority is invalid or if the architecture does not support priorities. |
true | if the priority is valid. |
#define CH_IRQ_IS_VALID_KERNEL_PRIORITY | ( | prio | ) | PORT_IRQ_IS_VALID_KERNEL_PRIORITY(prio) |
Priority level validation macro.
This macro determines if the passed value is a valid priority level that cannot preempt the kernel critical zone.
[in] | prio | the priority level |
false | if the priority is invalid or if the architecture does not support priorities. |
true | if the priority is valid. |
#define CH_IRQ_PROLOGUE | ( | ) |
IRQ handler enter code.
#define CH_IRQ_EPILOGUE | ( | ) |
IRQ handler exit code.
chSchIsPreemptionRequired()
and chSchDoReschedule()
.#define CH_IRQ_HANDLER | ( | id | ) | PORT_IRQ_HANDLER(id) |
#define CH_FAST_IRQ_HANDLER | ( | id | ) | PORT_FAST_IRQ_HANDLER(id) |
#define S2RTC | ( | freq, | |
sec | |||
) | ((freq) * (sec)) |
Seconds to realtime counter.
Converts from seconds to realtime counter cycles.
freq
>= 1
.[in] | freq | clock frequency, in Hz, of the realtime counter |
[in] | sec | number of seconds |
#define MS2RTC | ( | freq, | |
msec | |||
) | (rtcnt_t)((((freq) + 999UL) / 1000UL) * (msec)) |
Milliseconds to realtime counter.
Converts from milliseconds to realtime counter cycles.
freq
>= 1000
.[in] | freq | clock frequency, in Hz, of the realtime counter |
[in] | msec | number of milliseconds |
#define US2RTC | ( | freq, | |
usec | |||
) | (rtcnt_t)((((freq) + 999999UL) / 1000000UL) * (usec)) |
Microseconds to realtime counter.
Converts from microseconds to realtime counter cycles.
freq
>= 1000000
.[in] | freq | clock frequency, in Hz, of the realtime counter |
[in] | usec | number of microseconds |
#define RTC2S | ( | freq, | |
n | |||
) | ((((n) - 1UL) / (freq)) + 1UL) |
Realtime counter cycles to seconds.
Converts from realtime counter cycles number to seconds.
freq
>= 1
.[in] | freq | clock frequency, in Hz, of the realtime counter |
[in] | n | number of cycles |
#define RTC2MS | ( | freq, | |
n | |||
) | ((((n) - 1UL) / ((freq) / 1000UL)) + 1UL) |
Realtime counter cycles to milliseconds.
Converts from realtime counter cycles number to milliseconds.
freq
>= 1000
.[in] | freq | clock frequency, in Hz, of the realtime counter |
[in] | n | number of cycles |
#define RTC2US | ( | freq, | |
n | |||
) | ((((n) - 1UL) / ((freq) / 1000000UL)) + 1UL) |
Realtime counter cycles to microseconds.
Converts from realtime counter cycles number to microseconds.
freq
>= 1000000
.[in] | freq | clock frequency, in Hz, of the realtime counter |
[in] | n | number of cycles |
#define chSysGetRealtimeCounterX | ( | ) | (rtcnt_t)port_rt_get_counter_value() |
Returns the current value of the system real time counter.
PORT_SUPPORTS_RT
.#define chSysSwitch | ( | ntp, | |
otp | |||
) |
Performs a context switch.
[in] | ntp | the thread to be switched in |
[in] | otp | the thread to be switched out |
|
static |
Working area for core 0 idle thread.
|
static |
Working area for core 1 idle thread.
void chSysWaitSystemState | ( | system_state_t | state | ) |
Waits for the system state to be equal to the specified one.
chSchObjectInit()
in order to wait for system initialization by another core.Definition at line 142 of file chsys.c.
References ch_system::state.
void chSysInit | ( | void | ) |
System initialization.
After executing this function the current instructions stream becomes the main thread.
NORMALPRIO
and interrupts are enabled. ch_sys_running
state.Definition at line 159 of file chsys.c.
References ch_system::state.
void chSysHalt | ( | const char * | reason | ) |
Halts the system.
This function is invoked by the operating system when an unrecoverable error is detected, for example because a programming error in the application code that triggers an assertion while in debug mode.
[in] | reason | pointer to an error string |
Definition at line 209 of file chsys.c.
Referenced by __dbg_check_disable(), __dbg_check_enable(), __dbg_check_enter_isr(), __dbg_check_leave_isr(), __dbg_check_lock(), __dbg_check_lock_from_isr(), __dbg_check_suspend(), __dbg_check_unlock(), __dbg_check_unlock_from_isr(), chDbgCheckClassI(), and chDbgCheckClassS().
bool chSysIntegrityCheckI | ( | unsigned | testmask | ) |
System integrity check.
Performs an integrity check of the important ChibiOS/RT data structures.
NULL
or corrupted pointers in list elements. Exception vectors must be monitored as well. [in] | testmask | Each bit in this mask is associated to a test to be performed. |
false | The test succeeded. |
true | Test failed. |
Definition at line 260 of file chsys.c.
References currcore.
void chSysTimerHandlerI | ( | void | ) |
Handles time ticks for round robin preemption and timer increments.
Decrements the remaining time quantum of the running thread and preempts it when the quantum is used up. Increments system time and manages the timers.
CH_CFG_TIME_QUANTUM
macro, the round robin interval.Definition at line 366 of file chsys.c.
References chThdGetSelfX.
syssts_t chSysGetStatusAndLockX | ( | void | ) |
Returns the execution status and enters a critical zone.
This functions enters into a critical zone and can be called from any context. Because its flexibility it is less efficient than chSysLock()
which is preferable when the calling context is known.
Definition at line 400 of file chsys.c.
References chSysLock, chSysLockFromISR, port_get_irq_status(), port_irq_enabled(), and port_is_isr_context().
void chSysRestoreStatusX | ( | syssts_t | sts | ) |
Restores the specified execution status and leaves a critical zone.
chSchRescheduleS()
is automatically performed if exiting the critical zone and if not in ISR context.[in] | sts | the system status to be restored. |
Definition at line 423 of file chsys.c.
References chSchRescheduleS(), chSysUnlock, chSysUnlockFromISR, port_irq_enabled(), and port_is_isr_context().
Realtime window test.
This function verifies if the current realtime counter value lies within the specified range or not. The test takes care of the realtime counter wrapping to zero on overflow.
PORT_SUPPORTS_RT
.[in] | cnt | the counter value to be tested |
[in] | start | the start of the time window (inclusive) |
[in] | end | the end of the time window (non inclusive) |
true | current time within the specified time window. |
false | current time not within the specified time window. |
Definition at line 455 of file chsys.c.
Referenced by chSysPolledDelayX().
void chSysPolledDelayX | ( | rtcnt_t | cycles | ) |
Polled delay.
PORT_SUPPORTS_RT
.[in] | cycles | number of cycles |
Definition at line 472 of file chsys.c.
References chSysGetRealtimeCounterX, and chSysIsCounterWithinX().
|
inlinestatic |
Raises the system interrupt priority mask to the maximum level.
All the maskable interrupt sources are disabled regardless their hardware priority.
chSysLock()and
chSysUnock()
which could do more than just disable interrupts.Definition at line 361 of file chsys.h.
References port_disable().
|
inlinestatic |
Raises the system interrupt priority mask to system level.
The interrupt sources that should not be able to preempt the kernel are disabled, interrupt sources with higher priority are still enabled.
chSysLock()
which could do more than just disable interrupts.Definition at line 378 of file chsys.h.
References port_suspend().
|
inlinestatic |
Lowers the system interrupt priority mask to user level.
All the interrupt sources are enabled.
chSysUnlock()
which could do more than just enable interrupts.
|
inlinestatic |
Enters the kernel lock state.
Definition at line 406 of file chsys.h.
References __stats_start_measure_crit_thd(), and port_lock().
Referenced by chSysUnconditionalLock().
|
inlinestatic |
Leaves the kernel lock state.
Definition at line 420 of file chsys.h.
Referenced by chSysUnconditionalUnlock().
|
inlinestatic |
Enters the kernel lock state from within an interrupt handler.
Definition at line 450 of file chsys.h.
References __stats_start_measure_crit_isr(), and port_lock_from_isr().
|
inlinestatic |
Leaves the kernel lock state from within an interrupt handler.
|
inlinestatic |
Unconditionally enters the kernel lock state.
Definition at line 486 of file chsys.h.
References chSysLock(), port_get_irq_status(), and port_irq_enabled().
|
inlinestatic |
Unconditionally leaves the kernel lock state.
Definition at line 500 of file chsys.h.
References chSysUnlock(), port_get_irq_status(), and port_irq_enabled().
|
inlinestatic |
|
inlinestatic |
Returns a pointer to the idle thread.
CH_CFG_NO_IDLE_THREAD
must be disabled. Definition at line 534 of file chsys.h.
References currcore.
const os_instance_config_t ch_core0_cfg |
Core 0 OS instance configuration.
const os_instance_config_t ch_core1_cfg |
Core 1 OS instance configuration.