RTEMS  5.1
Files | Macros | Enumerations | Functions | Variables
System State Handler

Management of the internal system state of RTEMS. More...

Files

file  sysstate.h
 System State Handler API.
 

Macros

#define SYSTEM_STATE_CODES_FIRST   SYSTEM_STATE_BEFORE_INITIALIZATION
 
#define SYSTEM_STATE_CODES_LAST   SYSTEM_STATE_TERMINATED
 

Enumerations

enum  System_state_Codes { SYSTEM_STATE_BEFORE_INITIALIZATION, SYSTEM_STATE_BEFORE_MULTITASKING, SYSTEM_STATE_UP, SYSTEM_STATE_TERMINATED }
 System states. More...
 

Functions

RTEMS_INLINE_ROUTINE void _System_state_Set (System_state_Codes state)
 Sets the current system state to the given state. More...
 
RTEMS_INLINE_ROUTINE System_state_Codes _System_state_Get (void)
 Gets the current system state. More...
 
RTEMS_INLINE_ROUTINE bool _System_state_Is_before_initialization (System_state_Codes state)
 Checks if the state is before initialization. More...
 
RTEMS_INLINE_ROUTINE bool _System_state_Is_before_multitasking (System_state_Codes state)
 Checks if the state is before multitasking. More...
 
RTEMS_INLINE_ROUTINE bool _System_state_Is_up (System_state_Codes state)
 Checks if the state is up. More...
 
RTEMS_INLINE_ROUTINE bool _System_state_Is_terminated (System_state_Codes state)
 Checks if the state is terminated. More...
 

Variables

System_state_Codes _System_state_Current
 

Detailed Description

Management of the internal system state of RTEMS.

Enumeration Type Documentation

◆ System_state_Codes

System states.

Enumerator
SYSTEM_STATE_BEFORE_INITIALIZATION 

The system is before the end of the first phase of initialization.

SYSTEM_STATE_BEFORE_MULTITASKING 

The system is between end of the first phase of initialization but before multitasking is started.

SYSTEM_STATE_UP 

The system is up and operating normally.

SYSTEM_STATE_TERMINATED 

The system reached its terminal state.

Function Documentation

◆ _System_state_Get()

RTEMS_INLINE_ROUTINE System_state_Codes _System_state_Get ( void  )

Gets the current system state.

Returns
The current system state.

◆ _System_state_Is_before_initialization()

RTEMS_INLINE_ROUTINE bool _System_state_Is_before_initialization ( System_state_Codes  state)

Checks if the state is before initialization.

Parameters
stateThe state to check.
Return values
truestate is before initialization.
falsestate is not before initialization.

◆ _System_state_Is_before_multitasking()

RTEMS_INLINE_ROUTINE bool _System_state_Is_before_multitasking ( System_state_Codes  state)

Checks if the state is before multitasking.

Parameters
stateThe state to check.
Return values
truestate is before multitasking.
falsestate is not before multitasking.

◆ _System_state_Is_terminated()

RTEMS_INLINE_ROUTINE bool _System_state_Is_terminated ( System_state_Codes  state)

Checks if the state is terminated.

Parameters
stateThe state to check.
Return values
truestate is terminated.
falsestate is not terminated.

◆ _System_state_Is_up()

RTEMS_INLINE_ROUTINE bool _System_state_Is_up ( System_state_Codes  state)

Checks if the state is up.

Parameters
stateThe state to check.
Return values
truestate is up.
falsestate is not up.

◆ _System_state_Set()

RTEMS_INLINE_ROUTINE void _System_state_Set ( System_state_Codes  state)

Sets the current system state to the given state.

Parameters
stateThe state to set.