summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2010-11-01 15:58:22 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2010-11-01 15:58:22 +0000
commit22d226c01b133cceb9593bdadc0634a364e82860 (patch)
treeaaf1506fb16f06bbd872f647edbe00b6cc364f18
parentab52da4049b0bb354b450e323d74e80dab477bc4 (diff)
2010-11-01 Joel Sherrill <joel.sherrilL@OARcorp.com>
PR 1714/doc * user/datatypes.t, user/intr.t: Add missing description of rtems_status_codes.
-rw-r--r--doc/ChangeLog6
-rw-r--r--doc/user/datatypes.t6
-rw-r--r--doc/user/intr.t17
3 files changed, 27 insertions, 2 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 3097be52a8..d7f5609bf0 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,9 @@
+2010-11-01 Joel Sherrill <joel.sherrilL@OARcorp.com>
+
+ PR 1714/doc
+ * user/datatypes.t, user/intr.t: Add missing description of
+ rtems_status_codes.
+
2010-08-09 Sebastian Huber <sebastian.huber@embedded-brains.de>
PR 1513/doc
diff --git a/doc/user/datatypes.t b/doc/user/datatypes.t
index ec0fe5b3db..d856cc2332 100644
--- a/doc/user/datatypes.t
+++ b/doc/user/datatypes.t
@@ -226,7 +226,11 @@ on the target hardware.
This type is deprecated. Use "float" instead.
@findex rtems_status_codes
-@item @code{@value{DIRPREFIX}status_codes} is the
+@item @code{@value{DIRPREFIX}status_codes} is the return type for most
+RTEMS services. This is an enumerated type of approximately twenty-five
+values. In general, when a service returns a particular status code, it
+indicates that a very specific error condition has occurred.
+
@findex rtems_task
@item @code{@value{DIRPREFIX}task} is the return type for an
RTEMS Task.
diff --git a/doc/user/intr.t b/doc/user/intr.t
index 89218dd1ac..113e61cc4f 100644
--- a/doc/user/intr.t
+++ b/doc/user/intr.t
@@ -194,13 +194,28 @@ implementation error to use RTEMS_SELF from an ISR.
@item Interrupt Management
@itemize -
-@item rtems_interrupt_enable
+@item rtems_interrupt_enable
@item rtems_interrupt_disable
@item rtems_interrupt_flash
@item rtems_interrupt_is_in_progress
@item rtems_interrupt_catch
@end itemize
+@item Clock Management
+
+@itemize
+@item rtems_clock_set
+@item rtems_clock_get
+@item rtems_clock_get_tod
+@item rtems_clock_get_tod_timeval
+@item rtems_clock_get_seconds_since_epoch
+@item rtems_clock_get_ticks_per_second
+@item rtems_clock_get_ticks_since_boot
+@item rtems_clock_get_uptime
+@item rtems_clock_set_nanoseconds_extension
+@item rtems_clock_tick
+@end itemize
+
@item Message, Event, and Signal Management
@itemize -