[PATCH] asm-i386/timer.h docu cleanup

From: Adam Lackorzynski <adam@os.inf.tu-dresden.de>

This patch fixes a typo (intruupt), a possible confusion (ms should be
microseconds here, not milli), and adds descriptions for the missing
functions.

Signed-off-by: Adam Lackorzynski <adam@os.inf.tu-dresden.de>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

diff --git a/include/asm-i386/timer.h b/include/asm-i386/timer.h
index 41adcaeaa5480ada3c77716347eecf1906f5a195..585d947ca1d07f0add2d98e15fd243b32517f682 100644 (file)
--- a/include/asm-i386/timer.h
+++ b/include/asm-i386/timer.h
@@ -4,11 +4,16 @@
 /**
  * struct timer_ops - used to define a timer source
  *
+ * @name: name of the timer.
  * @init: Probes and initializes the timer. Takes clock= override 
- *  string as an argument. Returns 0 on success, anything else on failure.
- * @mark_offset: called by the timer interrupt
- * @get_offset: called by gettimeofday().  Returns the number of ms since the
- *     last timer intruupt.
+ *        string as an argument. Returns 0 on success, anything else
+ *        on failure.
+ * @mark_offset: called by the timer interrupt.
+ * @get_offset:  called by gettimeofday(). Returns the number of microseconds
+ *               since the last timer interupt.
+ * @monotonic_clock: returns the number of nanoseconds since the init of the
+ *                   timer.
+ * @delay: delays this many clock cycles.
  */
 struct timer_opts{
        char* name;