diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2009-09-04 13:09:48 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2009-09-04 13:09:48 +0000 |
commit | 56e171066de897e3e8196b5e7479913b12ce2af6 (patch) | |
tree | 94887d97a946d9e4b6f86ccbd0f283bd05893aea /cpukit/score/include/rtems/score/sysstate.h | |
parent | Fix expat. (diff) | |
download | rtems-56e171066de897e3e8196b5e7479913b12ce2af6.tar.bz2 |
2009-09-04 Sebastian Huber <Sebastian.Huber@embedded-brains.de>
* rtems/src/taskmode.c, sapi/src/exshutdown.c,
score/include/rtems/score/sysstate.h,
score/inline/rtems/score/sysstate.inl: Added
_System_state_Is_shutdown(). Removed direct uses of
_System_state_Current. Documentation.
Diffstat (limited to 'cpukit/score/include/rtems/score/sysstate.h')
-rw-r--r-- | cpukit/score/include/rtems/score/sysstate.h | 75 |
1 files changed, 39 insertions, 36 deletions
diff --git a/cpukit/score/include/rtems/score/sysstate.h b/cpukit/score/include/rtems/score/sysstate.h index 8d4a8e313e..52fa1c0b89 100644 --- a/cpukit/score/include/rtems/score/sysstate.h +++ b/cpukit/score/include/rtems/score/sysstate.h @@ -1,7 +1,9 @@ /** - * @file rtems/score/sysstate.h + * @file * - * This include file contains information regarding the system state. + * @ingroup ScoreSysState + * + * @brief System State Handler API. */ /* @@ -18,63 +20,64 @@ #ifndef _RTEMS_SCORE_SYSSTATE_H #define _RTEMS_SCORE_SYSSTATE_H -/** - * @defgroup ScoreSysState System State Handler - * - * This handler encapsulates functionality related to the management of the - * internal system state of RTEMS. - */ -/**@{*/ - #ifdef __cplusplus extern "C" { #endif -/* types */ - -/* enumerated constants */ +/** + * @defgroup ScoreSysState System State Handler + * + * @ingroup Score + * + * @brief Management of the internal system state of RTEMS. + * + * @{ + */ /** - * The following type defines the possible system states. + * @brief System states. */ typedef enum { - /** This indicates that the system state is between the start - * of rtems_initialize_executive_early and the end of the first - * phase of initialization. + /** + * @brief The system is before the end of the first phase of initialization. */ SYSTEM_STATE_BEFORE_INITIALIZATION, - /** This indicates that the system state is between end of the first - * phase of initializatin but before multitasking is started. + + /** + * @brief The system is between end of the first phase of initializatin but + * before multitasking is started. */ SYSTEM_STATE_BEFORE_MULTITASKING, - /** This indicates that the system state is attempting to initiate - * multitasking. + + /** + * @brief The system is attempting to initiate multitasking. */ SYSTEM_STATE_BEGIN_MULTITASKING, - /** This indicates that the system is up and operating normally. */ + + /** + * @brief The system is up and operating normally. + */ SYSTEM_STATE_UP, - /** This indicates that the system is in the midst of a shutdown. */ + + /** + * @brief The system is in the midst of a shutdown. + */ SYSTEM_STATE_SHUTDOWN, - /** This indicates that a fatal error has occurred. */ + + /** + * @brief A fatal error has occurred. + */ SYSTEM_STATE_FAILED } System_state_Codes; -/** This defines the first system state. */ #define SYSTEM_STATE_CODES_FIRST SYSTEM_STATE_BEFORE_INITIALIZATION -/** This defines the highest value system state. */ -#define SYSTEM_STATE_CODES_LAST SYSTEM_STATE_FAILED + +#define SYSTEM_STATE_CODES_LAST SYSTEM_STATE_FAILED #if defined(RTEMS_MULTIPROCESSING) -/** - * The following variable indicates whether or not this is - * an multiprocessing system. - */ SCORE_EXTERN bool _System_state_Is_multiprocessing; #endif -/** - * The following variable contains the current system state. - */ SCORE_EXTERN System_state_Codes _System_state_Current; /* @@ -83,11 +86,11 @@ SCORE_EXTERN System_state_Codes _System_state_Current; #include <rtems/score/sysstate.inl> +/** @} */ + #ifdef __cplusplus } #endif -/**@}*/ - #endif /* end of include file */ |