Changeset 7f0837c in mainline for generic/src/synch

Timestamp:

2006-04-24T12:59:11Z (20 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

fd8af4b

Parents:

24f3874

Message:

Remove the outdated TODO file.
Improve doxygen comments here and there.

Location:

generic/src/synch

Files:

• condvar.c (modified) (1 diff)
• futex.c (modified) (2 diffs)
• mutex.c (modified) (1 diff)
• rwlock.c (modified) (2 diffs)
• semaphore.c (modified) (1 diff)
• waitq.c (modified) (1 diff)

generic/src/synch/condvar.c

@@ -77 +77 @@
  *
  * For exact description of possible combinations of
- * 'usec' and 'trywait', see comment for waitq_sleep_timeout().
+ * @usec and @trywait, see comment for waitq_sleep_timeout().
  *
  * @return See comment for waitq_sleep_timeout().

generic/src/synch/futex.c

@@ -94 +94 @@
  * @param uaddr Userspace address of the futex counter.
  * @param usec If non-zero, number of microseconds this thread is willing to sleep.
- * @param trydown If usec is zero and trydown is non-zero, conditional operation will be attempted.
+ * @param trydown If @usec is zero and trydown is non-zero, conditional operation will be attempted.
  *
  * @return One of ESYNCH_TIMEOUT, ESYNCH_OK_ATOMIC and ESYNCH_OK_BLOCKED. See synch.h.
@@ -219 +219 @@
 /** Compute hash index into futex hash table.
  *
+ * @param key Address where the @key (i.e. physical address of futex counter) is stored.
+ *
+ * @return Index into futex hash table.
+ */
+index_t futex_ht_hash(__native *key)
+{
+        return *key & (FUTEX_HT_SIZE-1);
+}
+
+/** Compare futex hash table item with a key.
+ *
  * @param key Address where the key (i.e. physical address of futex counter) is stored.
  *
- * @return Index into futex hash table.
- */
-index_t futex_ht_hash(__native *key)
-{
-        return *key & (FUTEX_HT_SIZE-1);
-}
-
-/** Compare futex hash table item with a key.
- *
- * @param key Address where the key (i.e. physical address of futex counter) is stored.
- *
- * @return True if the item matches the key. False otherwise.
+ * @return True if the item matches the @key. False otherwise.
  */
 bool futex_ht_compare(__native *key, count_t keys, link_t *item)

generic/src/synch/mutex.c

@@ -52 +52 @@
  *
  * For exact description of possible combinations of
- * 'usec' and 'trylock', see comment for waitq_sleep_timeout().
+ * @usec and @trylock, see comment for waitq_sleep_timeout().
  *
  * @return See comment for waitq_sleep_timeout().

generic/src/synch/rwlock.c

@@ -92 +92 @@
  *
  * For exact description of possible combinations of
- * 'usec' and 'trylock', see comment for waitq_sleep_timeout().
+ * @usec and @trylock, see comment for waitq_sleep_timeout().
  *
  * @return See comment for waitq_sleep_timeout().
@@ -146 +146 @@
  *
  * For exact description of possible combinations of
- * 'usec' and 'trylock', see comment for waitq_sleep_timeout().
+ * @usec and @trylock, see comment for waitq_sleep_timeout().
  *
  * @return See comment for waitq_sleep_timeout().

generic/src/synch/semaphore.c

@@ -66 +66 @@
  *
  * For exact description of possible combinations of
- * 'usec' and 'trydown', see comment for waitq_sleep_timeout().
+ * @usec and @trydown, see comment for waitq_sleep_timeout().
  *
  * @return See comment for waitq_sleep_timeout().

generic/src/synch/waitq.c

@@ -161 +161 @@
  * @param nonblocking Blocking vs. non-blocking operation mode switch.
  *
- * If usec is greater than zero, regardless of the value of nonblocking,
+ * If @usec is greater than zero, regardless of the value of @nonblocking,
  * the call will not return until either timeout or wakeup comes.
  *
- * If usec is zero and nonblocking is zero (false), the call
+ * If @usec is zero and @nonblocking is zero (false), the call
  * will not return until wakeup comes.
  *
- * If usec is zero and nonblocking is non-zero (true), the call will
+ * If @usec is zero and @nonblocking is non-zero (true), the call will
  * immediately return, reporting either success or failure.
  *