Changeset 70527f1 in mainline for src/time/delay.c

Timestamp:

2005-06-03T14:51:05Z (20 years ago)

Author:

Martin Decky <martin@…>

Branches:

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

Children:

673104e

Parents:

ac5d02b

Message:

doxygen-style comments
cleanups

File:

• src/time/delay.c (modified) (1 diff)

src/time/delay.c

@@ -33 +33 @@
 #include <arch.h>
 
-/*
- * Note that the delay loop is calibrated for each and every CPU in the system.
- * Therefore it is necessary to cpu_priority_high() before calling the asm_delay_loop().
+/** Active delay
+ *
+ * Delay the execution for the given number
+ * of microseconds (or slightly more). The delay
+ * is implemented as CPU calibrated active loop.
+ *
+ * @param microseconds Number of usec to sleep.
+ *
  */
 void delay(__u32 microseconds)
 {
         pri_t pri;
-
+        
+        /* The delay loop is calibrated for each and every
+           CPU in the system. Therefore it is necessary to
+           cpu_priority_high() before calling the asm_delay_loop(). */
         pri = cpu_priority_high();
         asm_delay_loop(microseconds * CPU->delay_loop_const);