Contiki-NG
Loading...
Searching...
No Matches
process-mutex.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2024, Siemens AG.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the copyright holder nor the names of its
14 * contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31/**
32 * \addtogroup process
33 * @{
34 *
35 * \file
36 * Header file for Process mutexes.
37 * \author
38 * Konrad Krentz <konrad.krentz@gmail.com>
39 */
40
41#ifndef PROCESS_MUTEX_H_
42#define PROCESS_MUTEX_H_
43
44#include "contiki.h"
45#include <stdbool.h>
46
47/**
48 * Structure of a process mutex.
49 */
50typedef struct process_mutex_t {
51 struct process *waiting_process;
52 bool has_more_waiting_processes;
53 bool is_locked;
54} process_mutex_t;
55
56/**
57 * \brief Initializes a process mutex.
58 * \param mutex The process mutex.
59 */
60void process_mutex_init(process_mutex_t *mutex);
61
62/**
63 * \brief Tries to acquire a process mutex.
64 * \param mutex The process mutex.
65 * \return True if the process mutex was locked.
66 */
67bool process_mutex_try_lock(process_mutex_t *mutex);
68
69/**
70 * \brief Unlocks a process mutex.
71 * \param mutex The process mutex.
72 */
73void process_mutex_unlock(process_mutex_t *mutex);
74
75#endif /* PROCESS_MUTEX_H_ */
76
77/** @} */
process_mutex_t
struct process_mutex_t process_mutex_t
Structure of a process mutex.
process_mutex_init
void process_mutex_init(process_mutex_t *mutex)
Initializes a process mutex.
Definition process-mutex.c:46
process_mutex_try_lock
bool process_mutex_try_lock(process_mutex_t *mutex)
Tries to acquire a process mutex.
Definition process-mutex.c:52
process_mutex_unlock
void process_mutex_unlock(process_mutex_t *mutex)
Unlocks a process mutex.
Definition process-mutex.c:69
process_mutex_t
Structure of a process mutex.
Definition process-mutex.h:50