rtems: Add rtems_clock_get_uptime_timeval()

1 files changed, 35 insertions, 0 deletions

diff --git a/doc/user/clock.t b/doc/user/clock.t
index 6fde5afd9f..15cfc8dcd8 100644
--- a/doc/user/clock.t
+++ b/doc/user/clock.t
@@ -22,6 +22,7 @@ the clock manager are:
 @item @code{@value{DIRPREFIX}clock_get_ticks_per_second} - Get ticks per second
 @item @code{@value{DIRPREFIX}clock_get_ticks_since_boot} - Get ticks since boot
 @item @code{@value{DIRPREFIX}clock_get_uptime} - Get time since boot
+@item @code{@value{DIRPREFIX}clock_get_uptime_timeval} - Get time since boot in timeval format
 @item @code{@value{DIRPREFIX}clock_set_nanoseconds_extension} - Install the nanoseconds since last tick handler
 @item @code{@value{DIRPREFIX}clock_tick} - Announce a clock tick
 @end itemize
@@ -665,6 +666,40 @@ call.
 
 This directive may be called from an ISR.
 
+@c
+@c
+@c
+@page
+@subsection CLOCK_GET_UPTIME_TIMEVAL - Get the time since boot in timeval format
+
+@cindex clock get uptime
+@cindex uptime
+
+@subheading CALLING SEQUENCE:
+
+@ifset is-C
+@findex rtems_clock_get_uptime_timeval
+@example
+void rtems_clock_get_uptime_timeval(
+  struct timeval *uptime
+);
+@end example
+@end ifset
+
+@subheading DIRECTIVE STATUS CODES:
+
+NONE
+
+@subheading DESCRIPTION:
+
+This directive returns the seconds and microseconds since the
+system was booted.  If the BSP supports nanosecond clock
+accuracy, the time reported will probably be different on every
+call.
+
+@subheading NOTES:
+
+This directive may be called from an ISR.
 
 @c
 @c