source: rtems/cpukit/score/include/rtems/score/sysstate.h @ 6a07436

4.104.114.84.9
Last change on this file since 6a07436 was 6a07436, checked in by Joel Sherrill <joel.sherrill@…>, on Jan 16, 2006 at 3:13:58 PM

2006-01-16 Joel Sherrill <joel@…>

Large patch to improve Doxygen output. As a side-effect, grammar and
spelling errors were corrected, spacing errors were address, and some
variable names were improved.

  • libmisc/monitor/mon-object.c, libmisc/monitor/monitor.h: Account for changing OBJECTS_NO_CLASS to OBJECTS_CLASSIC_NO_CLASS.
  • score/Doxyfile: Set output directory. Predefine some macro values. Turn on graphical output.
  • score/include/rtems/debug.h, score/include/rtems/seterr.h, score/include/rtems/system.h, score/include/rtems/score/address.h, score/include/rtems/score/apiext.h, score/include/rtems/score/apimutex.h, score/include/rtems/score/bitfield.h, score/include/rtems/score/chain.h, score/include/rtems/score/context.h, score/include/rtems/score/coremsg.h, score/include/rtems/score/coremutex.h, score/include/rtems/score/coresem.h, score/include/rtems/score/heap.h, score/include/rtems/score/interr.h, score/include/rtems/score/isr.h, score/include/rtems/score/mpci.h, score/include/rtems/score/mppkt.h, score/include/rtems/score/object.h, score/include/rtems/score/objectmp.h, score/include/rtems/score/priority.h, score/include/rtems/score/stack.h, score/include/rtems/score/states.h, score/include/rtems/score/sysstate.h, score/include/rtems/score/thread.h, score/include/rtems/score/threadmp.h, score/include/rtems/score/threadq.h, score/include/rtems/score/tod.h, score/include/rtems/score/tqdata.h, score/include/rtems/score/userext.h, score/include/rtems/score/watchdog.h, score/include/rtems/score/wkspace.h, score/inline/rtems/score/address.inl, score/inline/rtems/score/chain.inl, score/inline/rtems/score/coremutex.inl, score/inline/rtems/score/coresem.inl, score/inline/rtems/score/heap.inl, score/inline/rtems/score/object.inl, score/inline/rtems/score/stack.inl, score/inline/rtems/score/thread.inl, score/inline/rtems/score/tqdata.inl, score/macros/README, score/src/heap.c, score/src/threadmp.c, score/src/threadready.c, score/src/threadstartmultitasking.c: Improve generated Doxygen output. Fix spelling and grammar errors in comments. Correct names of some variables and propagate changes.
  • Property mode set to 100644
File size: 2.2 KB
Line 
1/**
2 *  @file  rtems/score/sysstate.h
3 *
4 *  This include file contains information regarding the system state.
5 */
6
7/*
8 *  COPYRIGHT (c) 1989-2006.
9 *  On-Line Applications Research Corporation (OAR).
10 *
11 *  The license and distribution terms for this file may be
12 *  found in the file LICENSE in this distribution or at
13 *  http://www.rtems.com/license/LICENSE.
14 *
15 *  $Id$
16 */
17
18#ifndef _RTEMS_SCORE_SYSSTATE_H
19#define _RTEMS_SCORE_SYSSTATE_H
20
21/**
22 *  @defgroup ScoreSysState System State Handler
23 *
24 *  This handler encapsulates functionality related to the management of the
25 *  internal system state of RTEMS.
26 */
27/**@{*/
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33/* types */
34
35/* enumerated constants */
36
37/**
38 *  The following type defines the possible system states.
39 */
40typedef enum {
41  /** This indicates that the system state is between the start
42   *  of rtems_initialize_executive_early and the end of the first
43   *  phase of initialization.
44   */
45  SYSTEM_STATE_BEFORE_INITIALIZATION,
46  /** This indicates that the system state is between end of the first
47   *  phase of initializatin but before  multitasking is started.
48   */
49  SYSTEM_STATE_BEFORE_MULTITASKING,
50  /** This indicates that the system state is attempting to initiate
51   *  multitasking.
52   */
53  SYSTEM_STATE_BEGIN_MULTITASKING,
54  /** This indicates that the system is up and operating normally. */
55  SYSTEM_STATE_UP,
56  /** This indicates that the system is in the midst of a shutdown. */
57  SYSTEM_STATE_SHUTDOWN,
58  /** This indicates that a fatal error has occurred. */
59  SYSTEM_STATE_FAILED
60} System_state_Codes;
61
62/** This defines the first system state. */
63#define SYSTEM_STATE_CODES_FIRST SYSTEM_STATE_BEFORE_INITIALIZATION
64/** This defines the highest value system state. */
65#define SYSTEM_STATE_CODES_LAST  SYSTEM_STATE_FAILED
66
67/**
68 *  The following variable indicates whether or not this is
69 *  an multiprocessing system.
70 */
71SCORE_EXTERN boolean _System_state_Is_multiprocessing;
72
73/**
74 *  The following variable contains the current system state.
75 */
76SCORE_EXTERN System_state_Codes _System_state_Current;
77
78/*
79 *  Make it possible for the application to get the system state information.
80 */
81
82#include <rtems/score/sysstate.inl>
83
84#ifdef __cplusplus
85}
86#endif
87
88/**@}*/
89
90#endif
91/* end of include file */
Note: See TracBrowser for help on using the repository browser.