summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/interr.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2012-11-14 15:56:04 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2012-11-15 15:33:11 +0100
commit891d0d96249e21c72aba77e568c71f25f02a3016 (patch)
treeaa9393f8c86e02d9487424f04430eb135595ad18 /cpukit/score/include/rtems/score/interr.h
parentsptests/spfatal24: Fix NULL pointer access (diff)
downloadrtems-891d0d96249e21c72aba77e568c71f25f02a3016.tar.bz2
score: Documentation
Diffstat (limited to 'cpukit/score/include/rtems/score/interr.h')
-rw-r--r--cpukit/score/include/rtems/score/interr.h13
1 files changed, 10 insertions, 3 deletions
diff --git a/cpukit/score/include/rtems/score/interr.h b/cpukit/score/include/rtems/score/interr.h
index 0ba0750c6f..c81d493659 100644
--- a/cpukit/score/include/rtems/score/interr.h
+++ b/cpukit/score/include/rtems/score/interr.h
@@ -96,10 +96,17 @@ typedef struct {
extern Internal_errors_Information _Internal_errors_What_happened;
/**
- * @brief Internal error Occurred
+ * @brief An internal or fatal error occurred.
*
- * This routine is invoked when the application or the executive itself
- * determines that a fatal error has occurred.
+ * This routine is invoked when the application or the executive itself
+ * determines that a fatal error has occurred.
+ *
+ * This function can be called in every system state provided the following
+ * conditions are true
+ * - the stack pointer is valid,
+ * - the code memory is valid,
+ * - the read-only data is valid, and
+ * - the read-write data is accessible.
*/
void _Internal_error_Occurred(
Internal_errors_Source the_source,