mutex.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _PICO_MUTEX_H
#define _PICO_MUTEX_H
 
#include "pico/lock_core.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct __packed_aligned  {
    lock_core_t core;
    lock_owner_id_t owner;      
    uint8_t enter_count;        
#if PICO_MUTEX_ENABLE_SDK120_COMPATIBILITY
    bool recursive;
#endif
} recursive_mutex_t;
 
#if !PICO_MUTEX_ENABLE_SDK120_COMPATIBILITY
typedef struct __packed_aligned mutex {
    lock_core_t core;
    lock_owner_id_t owner;      
} mutex_t;
#else
typedef recursive_mutex_t mutex_t; // they are one and the same when backwards compatible with SDK1.2.0
#endif
 
void mutex_init(mutex_t *mtx);
 
void recursive_mutex_init(recursive_mutex_t *mtx);
 
void mutex_enter_blocking(mutex_t *mtx);
 
void recursive_mutex_enter_blocking(recursive_mutex_t *mtx);
 
bool mutex_try_enter(mutex_t *mtx, uint32_t *owner_out);
 
bool mutex_try_enter_block_until(mutex_t *mtx, absolute_time_t until);
 
bool recursive_mutex_try_enter(recursive_mutex_t *mtx, uint32_t *owner_out);
 
bool mutex_enter_timeout_ms(mutex_t *mtx, uint32_t timeout_ms);
 
bool recursive_mutex_enter_timeout_ms(recursive_mutex_t *mtx, uint32_t timeout_ms);
 
bool mutex_enter_timeout_us(mutex_t *mtx, uint32_t timeout_us);
 
bool recursive_mutex_enter_timeout_us(recursive_mutex_t *mtx, uint32_t timeout_us);
 
bool mutex_enter_block_until(mutex_t *mtx, absolute_time_t until);
 
bool recursive_mutex_enter_block_until(recursive_mutex_t *mtx, absolute_time_t until);
 
void mutex_exit(mutex_t *mtx);
 
void recursive_mutex_exit(recursive_mutex_t *mtx);
 
static inline bool mutex_is_initialized(mutex_t *mtx) {
    return mtx->core.spin_lock != 0;
}
 
static inline bool recursive_mutex_is_initialized(recursive_mutex_t *mtx) {
    return mtx->core.spin_lock != 0;
}
 
#define auto_init_mutex(name) static __attribute__((section(".mutex_array"))) mutex_t name
 
#define auto_init_recursive_mutex(name) static __attribute__((section(".mutex_array"))) recursive_mutex_t name = { .core = { .spin_lock = (spin_lock_t *)1 /* marker for runtime_init */ }, .owner = 0, .enter_count = 0 }
 
#ifdef __cplusplus
}
#endif
#endif