diff options
Diffstat (limited to 'c-user/fatal_error.rst')
| -rw-r--r-- | c-user/fatal_error.rst | 36 |
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 |