RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

score: Documentation

Browse Source
This commit is contained in:
Sebastian Huber
2012-11-29 15:07:12 +01:00
parent bf54252a05
commit f8ac52f21c
1 changed files with 7 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
cpukit/score/include/rtems/score/interr.h
View File

@@ -172,19 +172,13 @@ extern Internal_errors_Information _Internal_errors_What_happened;
* determines that a fatal error has occurred or a final system state is * determines that a fatal error has occurred or a final system state is
* reached (for example after exit()). * reached (for example after exit()).
* *
* This routine will invoke the fatal error handler supplied by the user
* followed by the the default one provided by the executive. The default
* error handler assumes no hardware is present to help inform the user
* of the problem. Halt stores the error code in a known register,
* disables interrupts, and halts the CPU. If the CPU does not have a
* halt instruction, it will loop to itself.
*
* The first action of this function is to call the fatal handler of the user * The first action of this function is to call the fatal handler of the user
* extensions. For the initial extensions the following conditions are * extensions. For the initial extensions the following conditions are
* required * required
* - a valid stack pointer and enough stack space, * - a valid stack pointer and enough stack space,
* - a valid code memory, and * - a valid code memory, and
* - valid read-only data. * - valid read-only data.
*
* For the initial extensions the read-write data (including BSS segment) is * For the initial extensions the read-write data (including BSS segment) is
* not required. * not required.
* *
@@ -198,11 +192,12 @@ extern Internal_errors_Information _Internal_errors_What_happened;
* *
* The final step is to call the CPU specific _CPU_Fatal_halt(). * The final step is to call the CPU specific _CPU_Fatal_halt().
* *
* @param[in] the_source is what subsystem the error originated in * @param[in] the_source The fatal source indicating the subsystem the fatal
* @param[in] is_internal is if the error was internally generated * condition originated in.
* @param[in] the_error is the fatal error status code * @param[in] is_internal Indicates if the fatal condition was generated
* * internally to the executive.
* @note The the_error is not necessarily a directive status code. * @param[in] the_error The fatal error code. This value must be interpreted
* with respect to the source.
* *
* @see rtems_fatal_error_occurred() and rtems_fatal(). * @see rtems_fatal_error_occurred() and rtems_fatal().
*/ */