doxygen/latest/mutex_8h_source.html

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

 #ifndef LAZULI_MUTEX_H
 #define LAZULI_MUTEX_H

 #include <stdint.h>

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

 _EXTERN_C_DECL_BEGIN

 typedef struct {
   volatile uint8_t lock;
   Lz_LinkedList waitingTasks;
 }Lz_Mutex;

 #define LZ_MUTEX_INIT { 0, LINKED_LIST_INIT }

 #define LZ_MUTEX_INIT_LOCKED { 1, LINKED_LIST_INIT }

 void
 Lz_Mutex_Init(Lz_Mutex * const mutex);

 void
 Lz_Mutex_InitLocked(Lz_Mutex * const mutex);

 void
 Lz_Mutex_Lock(Lz_Mutex * const mutex);

 void
 Lz_Mutex_Unlock(Lz_Mutex * const mutex);

 _EXTERN_C_DECL_END

 #endif /* LAZULI_MUTEX_H */
_EXTERN_C_DECL_BEGIN
#define _EXTERN_C_DECL_BEGIN
Open C++ header file declarations.
Definition: common.h:37

Lz_Mutex::waitingTasks
Lz_LinkedList waitingTasks
The list of tasks waiting for that mutex.
Definition: mutex.h:30

Lz_Mutex_Init
void Lz_Mutex_Init(Lz_Mutex *const mutex)
Initialize an already allocated Lz_Mutex.
Definition: mutex.c:61

Lz_Mutex::lock
volatile uint8_t lock
The mutex lock.
Definition: mutex.h:29

list.h
Doubly linked lists interface.

Lz_LinkedList
Represents the main container for doubly linked elements.
Definition: list.h:36

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

Lz_Mutex_InitLocked
void Lz_Mutex_InitLocked(Lz_Mutex *const mutex)
Initialize an already allocated Lz_Mutex.
Definition: mutex.c:69

Lz_Mutex_Lock
void Lz_Mutex_Lock(Lz_Mutex *const mutex)
Lock the mutex and enter critical section.
Definition: mutex.c:77

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

Lz_Mutex_Unlock
void Lz_Mutex_Unlock(Lz_Mutex *const mutex)
Unlock the mutex and leave critical section.
Definition: mutex.c:91