summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2007-04-02 18:22:56 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2007-04-02 18:22:56 +0000
commitbf4d01665003316c49a048d8697e5f9478f0a2f6 (patch)
treea42d32e72ea0399e3582a006da8e819d3303cd1a /doc
parent2007-04-02 Joel Sherrill <joel@OARcorp.com> (diff)
downloadrtems-bf4d01665003316c49a048d8697e5f9478f0a2f6.tar.bz2
2007-04-02 Joel Sherrill <joel@OARcorp.com>
* user/clock.t: Add clock_get_uptime().
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog4
-rw-r--r--doc/user/clock.t42
2 files changed, 46 insertions, 0 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 347fbabbe8..82cb83cb7b 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,7 @@
+2007-04-02 Joel Sherrill <joel@OARcorp.com>
+
+ * user/clock.t: Add clock_get_uptime().
+
2007-03-28 Chris Johns <chrisj@rtems.org>
* user/Makefile.am, user/clock.t: Add support for a handler to obtain
diff --git a/doc/user/clock.t b/doc/user/clock.t
index c452152837..4e6a1fef27 100644
--- a/doc/user/clock.t
+++ b/doc/user/clock.t
@@ -19,6 +19,7 @@ the clock manager are:
@itemize @bullet
@item @code{@value{DIRPREFIX}clock_set} - Set system date and time
@item @code{@value{DIRPREFIX}clock_get} - Get system date and time information
+@item @code{@value{DIRPREFIX}clock_get_uptime} - Get time since boot
@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
@@ -446,6 +447,47 @@ current date and time as well as timestamps.
@c
@c
@page
+@subsection CLOCK_GET_UPTIME - Get the time since booy
+
+@cindex clock get uptime
+@cindex uptime
+
+@subheading CALLING SEQUENCE:
+
+@ifset is-C
+@findex rtems_clock_get_uptime
+@example
+rtems_status_code rtems_clock_get_uptime(
+ struct timespec *uptime
+);
+@end example
+@end ifset
+
+@ifset is-Ada
+@example
+NOT SUPPORTED FROM Ada BINDING
+@end example
+@end ifset
+
+@subheading DIRECTIVE STATUS CODES:
+@code{@value{RPREFIX}SUCCESSFUL} - clock tick processed successfully@*
+@code{@value{RPREFIX}INVALID_ADDRESS} - @code{time_buffer} is NULL
+
+@subheading DESCRIPTION:
+
+This directive returns the seconds and nanoseconds 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
+@c
+@page
@subsection CLOCK_TICK - Announce a clock tick
@cindex clock tick