mutex.h File Reference

#include "pico/lock_core.h"

Include dependency graph for mutex.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	recursive_mutex_t
	recursive mutex instance More...
struct	mutex
	regular (non recursive) mutex instance More...

Macros
#define	auto_init_mutex(name)
	Helper macro for static definition of mutexes.
#define	auto_init_recursive_mutex(name)
	Helper macro for static definition of recursive mutexes.

Typedefs
typedef struct mutex	mutex_t
	regular (non recursive) mutex instance

Functions
void	mutex_init (mutex_t *mtx)
	Initialise a mutex structure.
void	recursive_mutex_init (recursive_mutex_t *mtx)
	Initialise a recursive mutex structure.
void	mutex_enter_blocking (mutex_t *mtx)
	Take ownership of a mutex.
void	recursive_mutex_enter_blocking (recursive_mutex_t *mtx)
	Take ownership of a recursive mutex.
bool	mutex_try_enter (mutex_t *mtx, uint32_t *owner_out)
	Attempt to take ownership of a mutex.
bool	mutex_try_enter_block_until (mutex_t *mtx, absolute_time_t until)
	Attempt to take ownership of a mutex until the specified time.
bool	recursive_mutex_try_enter (recursive_mutex_t *mtx, uint32_t *owner_out)
	Attempt to take ownership of a recursive mutex.
bool	mutex_enter_timeout_ms (mutex_t *mtx, uint32_t timeout_ms)
	Wait for mutex with timeout.
bool	recursive_mutex_enter_timeout_ms (recursive_mutex_t *mtx, uint32_t timeout_ms)
	Wait for recursive mutex with timeout.
bool	mutex_enter_timeout_us (mutex_t *mtx, uint32_t timeout_us)
	Wait for mutex with timeout.
bool	recursive_mutex_enter_timeout_us (recursive_mutex_t *mtx, uint32_t timeout_us)
	Wait for recursive mutex with timeout.
bool	mutex_enter_block_until (mutex_t *mtx, absolute_time_t until)
	Wait for mutex until a specific time.
bool	recursive_mutex_enter_block_until (recursive_mutex_t *mtx, absolute_time_t until)
	Wait for mutex until a specific time.
void	mutex_exit (mutex_t *mtx)
	Release ownership of a mutex.
void	recursive_mutex_exit (recursive_mutex_t *mtx)
	Release ownership of a recursive mutex.
static bool	mutex_is_initialized (mutex_t *mtx)
	Test for mutex initialized state.
static bool	recursive_mutex_is_initialized (recursive_mutex_t *mtx)
	Test for recursive mutex initialized state.
void	runtime_init_mutex (void)