source: rtems/cpukit/score/include/rtems/score/sysstate.h @ 11874561

4.104.114.84.95
Last change on this file since 11874561 was 11874561, checked in by Ralf Corsepius <ralf.corsepius@…>, on 11/21/04 at 07:17:38

Adjust doxygen @file.

  • Property mode set to 100644
File size: 1.7 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-2004.
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_SYSTEM_STATE_h
19#define __RTEMS_SYSTEM_STATE_h
20
21/**
22 *  @defgroup ScoreSysState System State Handler
23 *
24 *  This group contains functionality which XXX
25 */
26/**@{*/
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32/* types */
33
34/* enumerated constants */
35
36/*
37 *  The following type defines the possible system states.
38 */
39
40typedef enum {
41  SYSTEM_STATE_BEFORE_INITIALIZATION,   /* start -> end of 1st init part */
42  SYSTEM_STATE_BEFORE_MULTITASKING,     /* end of 1st -> beginning of 2nd */
43  SYSTEM_STATE_BEGIN_MULTITASKING,      /* just before multitasking starts */
44  SYSTEM_STATE_UP,                      /* normal operation */
45  SYSTEM_STATE_SHUTDOWN,                /* shutdown */
46  SYSTEM_STATE_FAILED                   /* fatal error occurred */
47} System_state_Codes;
48
49#define SYSTEM_STATE_CODES_FIRST SYSTEM_STATE_BEFORE_INITIALIZATION
50#define SYSTEM_STATE_CODES_LAST  SYSTEM_STATE_FAILED
51
52/*
53 *  The following variable indicates whether or not this is
54 *  an multiprocessing system.
55 */
56
57SCORE_EXTERN boolean _System_state_Is_multiprocessing;
58
59/*
60 *  The following variable contains the current system state.
61 */
62
63SCORE_EXTERN System_state_Codes _System_state_Current;
64
65/*
66 *  Make it possible for the application to get the system state information.
67 */
68
69#include <rtems/score/sysstate.inl>
70
71#ifdef __cplusplus
72}
73#endif
74
75/**@}*/
76
77#endif
78/* end of include file */
Note: See TracBrowser for help on using the repository browser.