doxygen/latest/spinlock_8h_source.html

/*

 * SPDX-License-Identifier: GPL-3.0-only

 * This file is part of Lazuli.

 */


#ifndef LAZULI_SPINLOCK_H

#define LAZULI_SPINLOCK_H


#include <stdint.h>


#include <Lazuli/common.h>


_EXTERN_C_DECL_BEGIN


typedef volatile uint8_t Lz_Spinlock;


#define LZ_SPINLOCK_INIT ((uint8_t)0)


void

Lz_Spinlock_Lock(Lz_Spinlock * const spinlock);


void

Lz_Spinlock_Unlock(Lz_Spinlock * const spinlock);


_EXTERN_C_DECL_END


#endif /* LAZULI_SPINLOCK_H */

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

common.h
Basic type definitions and useful macros.

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

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

Lz_Spinlock
volatile uint8_t Lz_Spinlock
Type used to represent a spinlock.
Definition spinlock.h:26

Lz_Spinlock_Lock
void Lz_Spinlock_Lock(Lz_Spinlock *const spinlock)
Set the lock and enter region, or active wait if the lock is already set.

Lz_Spinlock_Unlock
void Lz_Spinlock_Unlock(Lz_Spinlock *const spinlock)
Unset the lock and leave region.
Definition spinlock.c:21