diff options
Diffstat (limited to 'doc/user/fatal.t')
| -rw-r--r-- | doc/user/fatal.t | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/user/fatal.t b/doc/user/fatal.t index f51549a6b7..0c07a184ba 100644 --- a/doc/user/fatal.t +++ b/doc/user/fatal.t @@ -88,10 +88,11 @@ a specific target processor. @end ifinfo @subsection Announcing a Fatal Error -The fatal_error_occurred directive is invoked when a +The @code{@value{DIRPREFIX}fatal_error_occurred} directive is invoked when a fatal error is detected. Before invoking any user-supplied fatal error handlers or the RTEMS fatal error handler, the -fatal_error_occurred directive stores useful information in the +@code{@value{DIRPREFIX}fatal_error_occurred} +directive stores useful information in the variable @code{_Internal_errors_What_happened}. This @value{STRUCTURE} contains three pieces of information: @@ -106,9 +107,13 @@ executive, and a The error type indicator is dependent on the source of the error and whether or not the error was internally -generated by the executive. +generated by the executive. If the error was generated +from an API, then the error code will be of that API's +error or status codes. The status codes for the RTEMS +API are in c/src/exec/rtems/headers/status.h. Those +for the POSIX API can be found in <errno.h>. -The fatal_error_directive directive is responsible +The @code{@value{DIRPREFIX}fatal_error_occurred} directive is responsible for invoking an optional user-supplied fatal error handler and/or the RTEMS fatal error handler. All fatal error handlers are passed an error code to describe the error detected. @@ -118,7 +123,8 @@ sophisticated fatal error processing such as passing control to a debugger. For these cases, a user-supplied fatal error handler can be specified in the RTEMS configuration table. The User Extension Table field fatal contains the address of the -fatal error handler to be executed when the fatal_error_occurred +fatal error handler to be executed when the +@code{@value{DIRPREFIX}fatal_error_occurred} directive is called. If the field is set to NULL or if the configured fatal error handler returns to the executive, then the default handler provided by RTEMS is executed. This default |