From 891d0d96249e21c72aba77e568c71f25f02a3016 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 14 Nov 2012 15:56:04 +0100 Subject: score: Documentation --- cpukit/score/include/rtems/score/interr.h | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'cpukit/score/include/rtems/score/interr.h') 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, -- cgit v1.2.3