First version
[3rdparty/ote_partner/tlk.git] / include / kernel / mutex.h
1 /*
2  * Copyright (c) 2008 Travis Geiselbrecht
3  * Copyright (c) 2012 Shantanu Gupta
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files
7  * (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 #ifndef __KERNEL_MUTEX_H
25 #define __KERNEL_MUTEX_H
26
27 #include <kernel/thread.h>
28
29 #if DEBUGLEVEL > 1
30 #define MUTEX_CHECK 1
31 #define MUTEX_MAGIC 'mutx'
32 #else
33 #define MUTEX_CHECK 0
34 #endif
35
36 typedef struct mutex {
37 #if MUTEX_CHECK
38         int magic;
39         thread_t *holder;
40 #endif
41         int count;
42         wait_queue_t wait;
43 } mutex_t;
44
45 /* Rules for Mutexes:
46  * - Mutexes are only safe to use from thread context.
47  * - Mutexes are non-recursive.
48 */
49
50 void mutex_init(mutex_t *);
51 void mutex_destroy(mutex_t *);
52 status_t mutex_acquire(mutex_t *);
53 status_t mutex_acquire_timeout(mutex_t *, lk_time_t); /* try to acquire the mutex with a timeout value */
54 status_t mutex_release(mutex_t *);
55
56 #endif
57