| commit | a07d2fad5bd7bcc6b8d02ddcda14d38beba13bfe | [log] [tgz] |
|---|---|---|
| author | Brian Swetland <swetland@google.com> | Sat Jan 24 22:36:36 2009 -0800 |
| committer | Brian Swetland <swetland@google.com> | Sun Jan 25 17:37:44 2009 -0800 |
| tree | 65d33bca6a6e90b51ae0dbaddffd1b61a8143d91 | |
| parent | f1e5afdb3c8a4809bf2dc3f50a2c375e6b426c14 [diff] [blame] |
[docs] provide rules for correct usage of events, mutexes, and timers
diff --git a/include/kernel/mutex.h b/include/kernel/mutex.h index 2bdf8f4..40fe72f 100644 --- a/include/kernel/mutex.h +++ b/include/kernel/mutex.h
@@ -34,6 +34,11 @@ wait_queue_t wait; } mutex_t; +/* Rules for Mutexes: + * - Mutexes are only safe to use from thread context. + * - Mutexes are non-recursive. +*/ + void mutex_init(mutex_t *); void mutex_destroy(mutex_t *); status_t mutex_acquire(mutex_t *);