Changeset 63975c6 in mainline for src/synch/mutex.c

Timestamp:

2005-10-02T17:19:34Z (19 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

df364582

Parents:

f02436c8

Message:

Doxygen-style comments for mutex.c.

File:

• src/synch/mutex.c (modified) (3 diffs)

src/synch/mutex.c

@@ -27 +27 @@
  */
 
-#include <synch/synch.h>
 #include <synch/mutex.h>
 #include <synch/semaphore.h>
+#include <synch/synch.h>
 
+/** Initialize mutex
+ *
+ * Initialize mutex.
+ *
+ * @param mtx Mutex.
+ */
 void mutex_initialize(mutex_t *mtx)
 {
@@ -36 +42 @@
 }
 
+/** Acquire mutex
+ *
+ * Acquire mutex.
+ * Timeout mode and non-blocking mode can be requested.
+ *
+ * @param mxt Mutex.
+ * @param usec Timeout in microseconds.
+ * @param trylock Switches between blocking and non-blocking mode.
+ *
+ * For exact description of possible combinations of
+ * 'usec' and 'trylock', see comment for waitq_sleep_timeout().
+ *
+ * @return See comment for waitq_sleep_timeout().
+ */
 int _mutex_lock_timeout(mutex_t *mtx, __u32 usec, int trylock)
 {
@@ -41 +61 @@
 }
 
+/** Release mutex
+ *
+ * Release mutex.
+ *
+ * @param mtx Mutex.
+ */
 void mutex_unlock(mutex_t *mtx)
 {