doxygen/latest/scheduler_8h_source.html

 /*
  * SPDX-License-Identifier: GPL-3.0-only
  * This file is part of Lazuli.
  */

 #ifndef LAZULI_SYS_SCHEDULER_H
 #define LAZULI_SYS_SCHEDULER_H

 #include <stdint.h>

 #include <Lazuli/common.h>
 #include <Lazuli/lazuli.h>
 #include <Lazuli/mutex.h>

 #include <Lazuli/sys/task.h>

 _EXTERN_C_DECL_BEGIN

 void
 (*ReverseBytesOfFunctionPointer(void (* const pointer)(void)))(void);

 void
 Scheduler_Init(void);

 void
 Scheduler_AbortTask(void * const sp);

 /*
  * TODO: Maybe rename interruptCode and eventCode to xxxxxId or something like
  * that...
  */
 void
 Scheduler_HandleInterrupt(const uint8_t interruptCode);

 void
 Scheduler_HandleClockTick(void * const sp);

 void
 Scheduler_WaitEvent(void * const sp, const uint8_t eventCode);

 void
 Scheduler_WakeupTasksWaitingMutex(Lz_Mutex * const mutex);

 Task*
 Scheduler_GetCurrentTask(void);

 void
 Scheduler_SleepUntilEndOfTimeSlice(void);

 _EXTERN_C_DECL_END

 #endif /* LAZULI_SYS_SCHEDULER_H */
Scheduler_HandleClockTick
void Scheduler_HandleClockTick(void *const sp)
This function is called when a clock tick occured, catch by the interrupt handler.
Definition: scheduler.c:680

_EXTERN_C_DECL_BEGIN
#define _EXTERN_C_DECL_BEGIN
Open C++ header file declarations.
Definition: common.h:37

Scheduler_GetCurrentTask
Task * Scheduler_GetCurrentTask(void)
Get a pointer to the current running task.
Definition: scheduler.c:720

Scheduler_WaitEvent
void Scheduler_WaitEvent(void *const sp, const uint8_t eventCode)
This function is called from arch-specific Wait routine in order to get the current running task wait...

Scheduler_WakeupTasksWaitingMutex
void Scheduler_WakeupTasksWaitingMutex(Lz_Mutex *const mutex)
Wake up all tasks waiting for a mutex.
Definition: scheduler.c:694

Scheduler_AbortTask
void Scheduler_AbortTask(void *const sp)
Call the appropriate scheduler to abort the curent running task.
Definition: scheduler.c:632

lazuli.h
The public API of the Lazuli kernel.

uint8_t
unsigned char uint8_t
Represents a unsigned integer type with width of exactly 8 bits.
Definition: stdint.h:89

mutex.h
Mutexes interface.

task.h
Base task definition and context description.

Scheduler_HandleInterrupt
void Scheduler_HandleInterrupt(const uint8_t interruptCode)
This function is called by arch-specific interrupt handling routine.
Definition: scheduler.c:657

Scheduler_SleepUntilEndOfTimeSlice
void Scheduler_SleepUntilEndOfTimeSlice(void)
Put the current task to sleep until the end of its time slice.
Definition: scheduler.c:726

common.h
Basic type definitions and useful macros.

Lz_Mutex
Represents a mutex.
Definition: mutex.h:28

_EXTERN_C_DECL_END
#define _EXTERN_C_DECL_END
Close C++ header file declarations.
Definition: common.h:42

Task
Represents a task.
Definition: task.h:76

Scheduler_Init
void Scheduler_Init(void)
Initialize the scheduler prior to running it.
Definition: scheduler.c:613

ReverseBytesOfFunctionPointer
void(*)(void) ReverseBytesOfFunctionPointer(void(*const pointer)(void))
Reverse the bytes of a function pointer.
Definition: scheduler.h:35