summaryrefslogtreecommitdiffstats
path: root/c-user/fatal_error.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2016-12-09 13:01:57 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2016-12-12 08:07:35 +0100
commit6fa32c01ee112d63a9d1ec04087f84d75bbc69d8 (patch)
tree29c80b48898800ddff7e55eb4e03b96ef84691ec /c-user/fatal_error.rst
parent00ffe1fa6ba775628014b68b93e42722b36a742a (diff)
downloadrtems-docs-6fa32c01ee112d63a9d1ec04087f84d75bbc69d8.tar.bz2
Update Initialization Manager chapter
Update #2408.
Diffstat (limited to 'c-user/fatal_error.rst')
-rw-r--r--c-user/fatal_error.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/c-user/fatal_error.rst b/c-user/fatal_error.rst
index df8294b..8deb3db 100644
--- a/c-user/fatal_error.rst
+++ b/c-user/fatal_error.rst
@@ -4,6 +4,8 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
+.. _fatal_error_manager:
+
Fatal Error Manager
*******************
@@ -19,6 +21,8 @@ provided by the fatal error manager are:
- rtems_fatal_ - Invoke the fatal error handler
+- rtems_shutdown_executive_ - Shutdown RTEMS
+
- rtems_exception_frame_print_ - Print the CPU exception frame
- rtems_fatal_source_text_ - Return the fatal source text
@@ -468,6 +472,38 @@ NOTE:
\clearpage
+.. _rtems_shutdown_executive:
+
+SHUTDOWN_EXECUTIVE - Shutdown RTEMS
+-----------------------------------
+.. index:: shutdown RTEMS
+
+.. index:: rtems_shutdown_executive
+CALLING SEQUENCE:
+ .. code-block:: c
+
+ void rtems_shutdown_executive(
+ uint32_t result
+ );
+
+DIRECTIVE STATUS CODES:
+ NONE - This function will not return to the caller.
+
+DESCRIPTION:
+ This directive is called when the application wishes to shutdown RTEMS.
+ The system is terminated with a fatal source of ``RTEMS_FATAL_SOURCE_EXIT``
+ and the specified ``result`` code.
+
+NOTES:
+ This directive *must* be the last RTEMS directive invoked by an application
+ and it *does not return* to the caller.
+
+ This directive may be called any time.
+
+.. raw:: latex
+
+ \clearpage
+
.. _rtems_exception_frame_print:
EXCEPTION_FRAME_PRINT - Prints the exception frame