diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2012-11-13 17:40:33 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2012-11-15 15:33:11 +0100 |
| commit | dc6e830c108996c43e9267f05a51b7299dd3e6f9 (patch) | |
| tree | fb18e0a10ef689e15aaa6054a25ab6bc3ee3eb00 /doc | |
| parent | sapi: Add rtems_fatal_source and rtems_fatal_code (diff) | |
| download | rtems-dc6e830c108996c43e9267f05a51b7299dd3e6f9.tar.bz2 | |
sapi: Add and use rtems_internal_error_description
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/user/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/user/fatal.t | 29 |
2 files changed, 29 insertions, 2 deletions
diff --git a/doc/user/Makefile.am b/doc/user/Makefile.am index ddf2f07db8..07735ffbba 100644 --- a/doc/user/Makefile.am +++ b/doc/user/Makefile.am @@ -144,7 +144,7 @@ fatal.texi: fatal.t -n "Board Support Packages" < $< > $@ bsp.texi: bsp.t - $(BMENU2) -p "Fatal Error Manager FATAL_ERROR_OCCURRED - Invoke the fatal error handler" \ + $(BMENU2) -p "Fatal Error Manager INTERNAL_ERROR_DESCRIPTION - Returns a description for an internal error code" \ -u "Top" \ -n "User Extensions Manager" < $< > $@ diff --git a/doc/user/fatal.t b/doc/user/fatal.t index 4fc4c99d33..fd5a7ea0c0 100644 --- a/doc/user/fatal.t +++ b/doc/user/fatal.t @@ -129,7 +129,7 @@ constants, usage, and status codes. @ifset is-C @findex rtems_fatal_error_occurred @example -void volatile rtems_fatal_error_occurred( +void rtems_fatal_error_occurred( uint32_t the_error ); @end example @@ -167,3 +167,30 @@ NOT RETURN to the caller. The user-defined extension for this directive may wish to initiate a global shutdown. + +@c +@c +@c +@page +@subsection INTERNAL_ERROR_DESCRIPTION - Returns a description for an internal error code + +@cindex fatal error + +@subheading CALLING SEQUENCE: + +@ifset is-C +@findex rtems_internal_error_description +@example +const char *rtems_internal_error_description( + rtems_fatal_code error +); +@end example +@end ifset + +@subheading DIRECTIVE STATUS CODES + +The error code description or "?" in case the passed error code is invalid. + +@subheading DESCRIPTION: + +Returns a description for an internal error code. |