summaryrefslogtreecommitdiffstats
path: root/cpukit/sapi/include/rtems/fatal.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/sapi/include/rtems/fatal.h')
-rw-r--r--cpukit/sapi/include/rtems/fatal.h35
1 files changed, 19 insertions, 16 deletions
diff --git a/cpukit/sapi/include/rtems/fatal.h b/cpukit/sapi/include/rtems/fatal.h
index 64344b36b8..66236462d8 100644
--- a/cpukit/sapi/include/rtems/fatal.h
+++ b/cpukit/sapi/include/rtems/fatal.h
@@ -1,8 +1,6 @@
/**
* @file
*
- * @ingroup ClassicFatal
- *
* @brief Fatal API.
*/
@@ -32,9 +30,8 @@ extern "C" {
*
* @brief The Fatal Manager provides functions for fatal system states and or
* irrecoverable errors.
- *
- * @{
*/
+/**@{**/
/**
* @brief Exception frame.
@@ -42,9 +39,9 @@ extern "C" {
typedef CPU_Exception_frame rtems_exception_frame;
/**
- * @brief Prints the exception frame via printk().
+ * @brief Prints the exception frame via printk().
*
- * @see rtems_fatal() and RTEMS_FATAL_SOURCE_EXCEPTION.
+ * @see rtems_fatal() and RTEMS_FATAL_SOURCE_EXCEPTION.
*/
static inline void rtems_exception_frame_print(
const rtems_exception_frame *frame
@@ -57,9 +54,7 @@ static inline void rtems_exception_frame_print(
* @brief Invokes the internal error handler with a source of
* INTERNAL_ERROR_RTEMS_API and is internal set to false.
*
- * @param[in] the_error A 32-bit fatal error code.
- *
- * @return This function will not return.
+ * @param[in] the_error is a 32-bit fatal error code.
*
* @see _Internal_error_Occurred().
*/
@@ -70,10 +65,8 @@ void rtems_fatal_error_occurred(
/**
* @brief Invokes the internal error handler with is internal set to false.
*
- * @param[in] source The fatal source.
- * @param[in] error The fatal code.
- *
- * @return This function will not return.
+ * @param[in] source is the fatal source.
+ * @param[in] error is the fatal code.
*
* @see _Internal_error_Occurred().
*/
@@ -83,12 +76,22 @@ void rtems_fatal(
) RTEMS_COMPILER_NO_RETURN_ATTRIBUTE;
/**
+ * @brief Returns a description for a fatal source.
+ *
+ * @param[in] source is the fatal source.
+ *
+ * @retval description The fatal source description.
+ * @retval ? The passed fatal source is invalid.
+ */
+const char *rtems_fatal_source_description( rtems_fatal_source source );
+
+/**
* @brief Returns a description for an internal error code.
*
- * @param[in] error The error code.
+ * @param[in] error is the error code.
*
- * @return The error code description or "?" in case the passed error code is
- * invalid.
+ * @retval description The error code description.
+ * @retval ? The passed error code is invalid.
*/
const char *rtems_internal_error_description( rtems_fatal_code error );