doxygen/latest/lazuli_8h_source.html

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

 #ifndef LAZULI_LAZULI_H
 #define LAZULI_LAZULI_H

 #include <stdint.h>

 #include <Lazuli/common.h>
 #include <Lazuli/config.h>

 _EXTERN_C_DECL_BEGIN

 typedef int8_t lz_task_priority_t;

 typedef uint16_t lz_u_resolution_unit_t;

 enum Lz_SchedulingPolicy {
    __LZ_SCHEDULING_POLICY_ENUM_BEGIN = -1,

    CYCLIC_RT = 0,

    PRIORITY_RT,

    /*
     * PRIORITY_RR,
     */

    __LZ_SCHEDULING_POLICY_ENUM_END

 };

 typedef struct {
   char const *name;

   size_t stackSize;

   enum Lz_SchedulingPolicy schedulingPolicy;

   lz_task_priority_t priority;

   lz_u_resolution_unit_t period;

   lz_u_resolution_unit_t completion;
 }Lz_TaskConfiguration;

 bool
 Lz_RegisterTask(void (* const taskEntryPoint)(void),
                 Lz_TaskConfiguration * taskConfiguration);

 void
 Lz_TaskConfiguration_Init(Lz_TaskConfiguration * const taskConfiguration);

 void
 Lz_Run(void);

 void
 Lz_Task_WaitInterrupt(uint8_t interruptCode);

 char const *
 Lz_Task_GetName(void);

 void
 Lz_Task_Terminate(void);

 void
 Lz_Task_WaitActivation(void);

 void
 Lz_WaitTimer(lz_u_resolution_unit_t units);

 _EXTERN_C_DECL_END

 #endif /* LAZULI_LAZULI_H */
Lz_RegisterTask
bool Lz_RegisterTask(void(*const taskEntryPoint)(void), Lz_TaskConfiguration *taskConfiguration)
Register a new task.
Definition: scheduler.c:758

int8_t
char int8_t
Represents a signed integer type with width of exactly 8 bits.
Definition: stdint.h:27

Lz_TaskConfiguration::name
char const  * name
A pointer to an allocated const string containing the name to give to the task.
Definition: lazuli.h:94

CYCLIC_RT
Cyclic real-time scheduling.
Definition: lazuli.h:58

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

Lz_SchedulingPolicy
Lz_SchedulingPolicy
Defines the possible scheduling policies for a Lazuli user task.
Definition: lazuli.h:44

Lz_TaskConfiguration::period
lz_u_resolution_unit_t period
The period (T) of the task.
Definition: lazuli.h:117

config.h
Include appropriate config file.

Lz_TaskConfiguration::completion
lz_u_resolution_unit_t completion
The completion time (C) of the task (worst case execution time).
Definition: lazuli.h:125

Lz_TaskConfiguration::stackSize
size_t stackSize
The size of the stack needed by the task.
Definition: lazuli.h:99

Lz_TaskConfiguration_Init
void Lz_TaskConfiguration_Init(Lz_TaskConfiguration *const taskConfiguration)
Initialize an Lz_TaskConfiguration with default values for all parameters.
Definition: scheduler.c:746

lz_u_resolution_unit_t
uint16_t lz_u_resolution_unit_t
Represents the type used for the system clock resolution unit, as an unsigned integer.
Definition: lazuli.h:36

uint16_t
unsigned int uint16_t
Represents a unsigned integer type with width of exactly 16 bits.
Definition: stdint.h:94

Lz_Task_WaitInterrupt
void Lz_Task_WaitInterrupt(uint8_t interruptCode)
Wait for a specific interrupt to occur.
Definition: scheduler.c:793

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

Lz_TaskConfiguration
Represents the configuration of a task.
Definition: lazuli.h:88

Lz_WaitTimer
void Lz_WaitTimer(lz_u_resolution_unit_t units)
Set the calling task to wait for the specified number of time resolution units (time slices)...
Definition: scheduler.c:804

Lz_Task_Terminate
void Lz_Task_Terminate(void)
Terminate the calling task.
Definition: scheduler.c:815

PRIORITY_RT
Priority time sliced real-time scheduling.
Definition: lazuli.h:65

Lz_TaskConfiguration::priority
lz_task_priority_t priority
The priority of task.
Definition: lazuli.h:110

common.h
Basic type definitions and useful macros.

Lz_Task_WaitActivation
void Lz_Task_WaitActivation(void)
Set the calling task to wait for its next activation.
Definition: scheduler.c:785

Lz_Task_GetName
char const  * Lz_Task_GetName(void)
Get the name of the calling task.
Definition: scheduler.c:779

lz_task_priority_t
int8_t lz_task_priority_t
Represents the priority of a task, as a signed integer.
Definition: lazuli.h:30

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

Lz_Run
void Lz_Run(void)
Run the scheduler.
Definition: scheduler.c:765