lazuli.h

Go to the documentation of this file.

/*
 * 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;
 
typedef uint8_t lz_scheduling_policy_t;
 
/*
 * TODO: See if we should rename the policies macro constants as LZ_POLICY_XXX
 *       or LZ_SCHEDULING_POLICY_XXX.
 */
 
#define CYCLIC_RT ((lz_scheduling_policy_t)0U)
 
#define PRIORITY_RT ((lz_scheduling_policy_t)1U)
 
#define LZ_SCHEDULING_POLICY_MAX PRIORITY_RT
 
typedef struct {
  char const *name;
 
  size_t stackSize;
 
  lz_scheduling_policy_t 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 */