Changeset ac4177ca in mainline

Timestamp:

2005-10-02T16:04:43Z (19 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

f02436c8

Parents:

5e04b48d

Message:

Doxygen-style comments for semaphore.c.

File:

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

src/synch/semaphore.c

@@ -27 +27 @@
  */
 
-#include <synch/synch.h>
 #include <synch/semaphore.h>
 #include <synch/waitq.h>
 #include <synch/spinlock.h>
+#include <synch/synch.h>
 #include <arch/asm.h>
 #include <arch.h>
 
+/** Initialize semaphore
+ *
+ * Initialize semaphore.
+ *
+ * @param s Semaphore.
+ * @param val Maximal number of threads allowed to enter critical section.
+ */
 void semaphore_initialize(semaphore_t *s, int val)
 {
@@ -49 +56 @@
 }
 
+/** Semaphore down
+ *
+ * Semaphore down.
+ * Conditional mode and mode with timeout can be requested.
+ *
+ * @param s Semaphore.
+ * @param usec Timeout in microseconds.
+ * @param trydown Switches between blocking and non-blocking mode.
+ *
+ * For exact description of possible combinations of
+ * 'usec' and 'trydown', see comment for waitq_sleep_timeout().
+ *
+ * @return See comment for waitq_sleep_timeout().
+ */
 int _semaphore_down_timeout(semaphore_t *s, __u32 usec, int trydown)
 {
@@ -54 +75 @@
 }
 
+/** Semaphore up
+ *
+ * Semaphore up.
+ *
+ * @param s Semaphore.
+ */
 void semaphore_up(semaphore_t *s)
 {