summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2012-11-14 09:51:41 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2012-11-15 15:33:12 +0100
commite2e5b49215cabd82f99bdc0c6e1b6f69ff233d19 (patch)
tree9817613ec2f5d5c474c00ef363d3b42c3b94daa7 /doc
parentscore: Add INTERNAL_ERROR_CPU_ISR_INSTALL_VECTOR (diff)
downloadrtems-e2e5b49215cabd82f99bdc0c6e1b6f69ff233d19.tar.bz2
score: Add rtems_fatal()
Diffstat (limited to 'doc')
-rw-r--r--doc/user/fatal.t31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/user/fatal.t b/doc/user/fatal.t
index fd5a7ea0c0..aa9c2bf0a6 100644
--- a/doc/user/fatal.t
+++ b/doc/user/fatal.t
@@ -15,6 +15,7 @@ manager is:
@itemize @bullet
@item @code{@value{DIRPREFIX}fatal_error_occurred} - Invoke the fatal error handler
+@item @code{@value{DIRPREFIX}fatal} - Invoke the fatal error handler with error source
@end itemize
@section Background
@@ -172,6 +173,36 @@ wish to initiate a global shutdown.
@c
@c
@page
+@subsection FATAL - Invoke the fatal error handler with error source
+
+@cindex announce fatal error
+@cindex fatal error, announce
+
+@subheading CALLING SEQUENCE:
+
+@ifset is-C
+@findex rtems_fatal
+@example
+void rtems_fatal(
+ rtems_fatal_source source,
+ rtems_fatal_code error
+);
+@end example
+@end ifset
+
+@subheading DIRECTIVE STATUS CODES
+
+NONE
+
+@subheading DESCRIPTION:
+
+This directive invokes the internal error handler with is internal set to
+false. See also @code{@value{DIRPREFIX}fatal_error_occurred}.
+
+@c
+@c
+@c
+@page
@subsection INTERNAL_ERROR_DESCRIPTION - Returns a description for an internal error code
@cindex fatal error