epoc32/include/ssm/ssmsubstates.hrh
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
//
williamr@4
    15
williamr@4
    16
#ifndef __SSMSUBSTATES_HRH__
williamr@4
    17
#define __SSMSUBSTATES_HRH__
williamr@4
    18
williamr@4
    19
williamr@4
    20
/**
williamr@4
    21
 This enum contains sub-states for Startup System State.
williamr@4
    22
 It matches TStartupStateIdentifier in sysstart (startup.hrh) for backwards compatibility.
williamr@4
    23
williamr@4
    24
 @publishedPartner
williamr@4
    25
 @released
williamr@4
    26
 */
williamr@4
    27
enum TSsmStartupSubStates
williamr@4
    28
	{
williamr@4
    29
	/** Undefined state */
williamr@4
    30
	ESsmStartupSubStateUndefined = 0x00,
williamr@4
    31
williamr@4
    32
	/** Reserved for future use
williamr@4
    33
	@internalComponent */
williamr@4
    34
	ESsmStartupSubStateReserved1 = 0x08,
williamr@4
    35
williamr@4
    36
	/** Within this state all ROM based(static) components or resources
williamr@4
    37
	that are critical to the operation of the phone function are started. */
williamr@4
    38
	ESsmStartupSubStateCriticalStatic = 0x10,
williamr@4
    39
williamr@4
    40
	/** Reserved for future use
williamr@4
    41
	@internalComponent */
williamr@4
    42
	ESsmStartupSubStateReserved2 = 0x18,
williamr@4
    43
williamr@4
    44
	/** Within this state all non-ROM based(dynamic) components or resources
williamr@4
    45
	that are critical to the operation of the phone function are started. */
williamr@4
    46
	ESsmStartupSubStateCriticalDynamic = 0x20,
williamr@4
    47
williamr@4
    48
	/** Networking state */
williamr@4
    49
	ESsmStartupSubStateNetworkingCritical = 0x28,
williamr@4
    50
williamr@4
    51
	/** Within this state all ROM based(static) or non-ROM based(dynamic) components or 
williamr@4
    52
	resources that are non-critical to the operation of the phone function are started. */
williamr@4
    53
	ESsmStartupSubStateNonCritical = 0x30,
williamr@4
    54
williamr@4
    55
	/** Reserved for future use. 
williamr@4
    56
	@internalComponent */
williamr@4
    57
	ESsmStartupSubStateReserved3 = 0x38,
williamr@4
    58
williamr@4
    59
	/** Reserved for future use.
williamr@4
    60
	@internalComponent */
williamr@4
    61
	ESsmStartupSubStateReserved4 = 0x40
williamr@4
    62
williamr@4
    63
	/**
williamr@4
    64
	Additional states for use 0x48 - 0xFF
williamr@4
    65
	*/
williamr@4
    66
	};
williamr@4
    67
williamr@4
    68
williamr@4
    69
williamr@4
    70
williamr@4
    71
/**
williamr@4
    72
This enum contains sub-states for Normal System State.
williamr@4
    73
williamr@4
    74
 @publishedPartner
williamr@4
    75
 @released
williamr@4
    76
 */
williamr@4
    77
enum TSsmNormalSubStates
williamr@4
    78
	{
williamr@4
    79
	/** Undefined state */
williamr@4
    80
	ESsmNormalSubStateUndefined = 0x00,
williamr@4
    81
williamr@4
    82
	/** Reserved for future use
williamr@4
    83
	@internalComponent */
williamr@4
    84
	ESsmNormalSubStateReserved1 = 0x08,
williamr@4
    85
	
williamr@4
    86
	/** Publishes the state. */
williamr@4
    87
	ESsmNormalSubState = 0x10,
williamr@4
    88
williamr@4
    89
	/** Reserved for future use.
williamr@4
    90
	@internalComponent*/
williamr@4
    91
	ESsmNormalSubStateReserved2 = 0x18,
williamr@4
    92
williamr@4
    93
	/** Reserved for future use.
williamr@4
    94
	@internalComponent*/
williamr@4
    95
	ESsmNormalSubStateReserved3 = 0x20,
williamr@4
    96
	
williamr@4
    97
	/** This state is valid only when patchable constant KSsmGracefulOffline is enabled*/
williamr@4
    98
	ESsmNormalRfOnSubState = 0x28,
williamr@4
    99
	
williamr@4
   100
	/** This state is valid only when patchable constant KSsmGracefulOffline is enabled*/
williamr@4
   101
	ESsmNormalRfOffSubState = 0x30
williamr@4
   102
williamr@4
   103
	/**
williamr@4
   104
	Additional states for use 0x38 - 0xFF
williamr@4
   105
	*/
williamr@4
   106
	};
williamr@4
   107
williamr@4
   108
/**
williamr@4
   109
This enum contains sub-states for Fail System State.
williamr@4
   110
williamr@4
   111
 @publishedPartner
williamr@4
   112
 @released
williamr@4
   113
 */
williamr@4
   114
enum TSsmFailSubStates
williamr@4
   115
	{
williamr@4
   116
	/** Undefined state */
williamr@4
   117
	ESsmFailSubStateUndefined = 0x00,
williamr@4
   118
williamr@4
   119
	/** Reserved for future use
williamr@4
   120
	@internalComponent */
williamr@4
   121
	ESsmFailSubStateReserved1 = 0x08,
williamr@4
   122
williamr@4
   123
	/** Publishes the state and issues a device poweroff. */
williamr@4
   124
	ESsmFailSubStatePowerOff = 0x10,
williamr@4
   125
williamr@4
   126
	/** Reserved for future use.
williamr@4
   127
	@internalComponent */
williamr@4
   128
	ESsmFailSubStateReserved2 = 0x18,
williamr@4
   129
williamr@4
   130
	/** Publishes the state and issues a device restart. */
williamr@4
   131
	ESsmFailSubStateRestart = 0x20,
williamr@4
   132
williamr@4
   133
	/** Reserved for future use.
williamr@4
   134
	@internalComponent */
williamr@4
   135
	ESsmFailSubStateReserved3 = 0x28
williamr@4
   136
williamr@4
   137
	/**
williamr@4
   138
	Additional states for use 0x30 - 0xFF
williamr@4
   139
	*/
williamr@4
   140
	};
williamr@4
   141
williamr@4
   142
/**
williamr@4
   143
This enum contains sub-states for Shutdown System State.
williamr@4
   144
williamr@4
   145
 @publishedPartner
williamr@4
   146
 @released
williamr@4
   147
 */
williamr@4
   148
enum TSsmShutdownSubStates
williamr@4
   149
	{
williamr@4
   150
	/** Undefined state */
williamr@4
   151
	ESsmShutdownSubStateUndefined = 0x00,
williamr@4
   152
williamr@4
   153
	/** Reserved for future use
williamr@4
   154
	@internalComponent */
williamr@4
   155
	ESsmShutdownSubStateReserved1 = 0x08,
williamr@4
   156
williamr@4
   157
	/** Within this state all components or resources that are critical and have registered for the shutdown notification
williamr@4
   158
	are given notification to carryout shutdown activities. */
williamr@4
   159
	ESsmShutdownSubStateCritical = 0x10,
williamr@4
   160
williamr@4
   161
	/** Reserved for future use. 
williamr@4
   162
	@internalComponent */
williamr@4
   163
	ESsmShutdownSubStateReserved2 = 0x18,
williamr@4
   164
williamr@4
   165
	/** Within this state all components or resources that are non-critical and have registered for the shutdown notification
williamr@4
   166
	are given notification to carryout shutdown activities. */
williamr@4
   167
	ESsmShutdownSubStateNonCritical = 0x20,
williamr@4
   168
williamr@4
   169
	/** Reserved for future use.
williamr@4
   170
	@internalComponent */
williamr@4
   171
	ESsmShutdownSubStateReserved3 = 0x28,
williamr@4
   172
williamr@4
   173
	/** Power Off state. */
williamr@4
   174
	ESsmShutdownSubStatePowerOff = 0x30,
williamr@4
   175
williamr@4
   176
	/** Restart the device.  */
williamr@4
   177
	ESsmShutdownSubStateReStart = 0x38,
williamr@4
   178
williamr@4
   179
	/** Reserved for future use.
williamr@4
   180
	@internalComponent */
williamr@4
   181
	ESsmShutdownSubStateReserved4 = 0x40	
williamr@4
   182
williamr@4
   183
	/**
williamr@4
   184
	Additional states for use 0x48 - 0xFF
williamr@4
   185
	*/
williamr@4
   186
	};
williamr@4
   187
williamr@4
   188
williamr@4
   189
/**
williamr@4
   190
This enum contains sub-states for Emergency Calls System State.
williamr@4
   191
williamr@4
   192
 @publishedPartner
williamr@4
   193
 @released
williamr@4
   194
 */
williamr@4
   195
enum TSsmEmergencyCallSubStates
williamr@4
   196
	{
williamr@4
   197
	/** Undefined state */
williamr@4
   198
	ESsmEmergencyCallSubStateUndefined = 0x00,
williamr@4
   199
williamr@4
   200
	/** Reserved for future use
williamr@4
   201
	@internalComponent */
williamr@4
   202
	ESsmEmergencyCallSubStateReserved1 = 0x08,
williamr@4
   203
williamr@4
   204
	/**
williamr@4
   205
	@internalComponent
williamr@4
   206
	Reserved for future use.
williamr@4
   207
	*/
williamr@4
   208
	ESsmEmergencyCallsEnabledSubState = 0x10,
williamr@4
   209
williamr@4
   210
	/**
williamr@4
   211
	@internalComponent
williamr@4
   212
	Reserved for future use.
williamr@4
   213
	*/
williamr@4
   214
	ESsmEmergencyCallsDisabledSubState = 0x18,
williamr@4
   215
williamr@4
   216
	/**
williamr@4
   217
	@internalComponent
williamr@4
   218
	Reserved for future use.
williamr@4
   219
	*/
williamr@4
   220
	ESsmEmergencyCallsEnabledSubStateReserved2 = 0x20
williamr@4
   221
williamr@4
   222
	/**
williamr@4
   223
	Additional states for use 0x28 - 0xFF
williamr@4
   224
	*/
williamr@4
   225
	};
williamr@4
   226
williamr@4
   227
/**
williamr@4
   228
This enum contains sub-states for Back-up System State.
williamr@4
   229
williamr@4
   230
 @publishedPartner
williamr@4
   231
 @released
williamr@4
   232
 */
williamr@4
   233
enum TSsmBackupSubStates
williamr@4
   234
	{
williamr@4
   235
	/** Undefined state */
williamr@4
   236
	ESsmBackupSubStateUndefined = 0x00,
williamr@4
   237
williamr@4
   238
	/** Reserved for future use
williamr@4
   239
	@internalComponent */
williamr@4
   240
	ESsmBackupSubStateReserved1 = 0x08,
williamr@4
   241
williamr@4
   242
	/**
williamr@4
   243
	@internalComponent
williamr@4
   244
	Reserved for future use.
williamr@4
   245
	*/
williamr@4
   246
	ESsmBackupSubState = 0x10,
williamr@4
   247
williamr@4
   248
	/**
williamr@4
   249
	@internalComponent
williamr@4
   250
	Reserved for future use.
williamr@4
   251
	*/
williamr@4
   252
	ESsmBackupSubStateReserved2 = 0x18
williamr@4
   253
williamr@4
   254
	/**
williamr@4
   255
	Additional states for use 0x20 - 0xFF
williamr@4
   256
	*/
williamr@4
   257
	};
williamr@4
   258
williamr@4
   259
/**
williamr@4
   260
This enum contains sub-states for Restore System State.
williamr@4
   261
williamr@4
   262
 @publishedPartner
williamr@4
   263
 @released
williamr@4
   264
 */
williamr@4
   265
enum TSsmRestoreSubStates
williamr@4
   266
	{
williamr@4
   267
	/** Undefined state */
williamr@4
   268
	ESsmRestoreSubStateUndefined = 0x00,
williamr@4
   269
williamr@4
   270
	/** Reserved for future use
williamr@4
   271
	@internalComponent */
williamr@4
   272
	ESsmRestoreSubStateReserved1 = 0x08,
williamr@4
   273
williamr@4
   274
	/**
williamr@4
   275
	@internalComponent
williamr@4
   276
	Reserved for future use.
williamr@4
   277
	*/
williamr@4
   278
	ESsmRestoreSubState = 0x10,
williamr@4
   279
williamr@4
   280
	/**
williamr@4
   281
	@internalComponent
williamr@4
   282
	Reserved for future use.
williamr@4
   283
	*/
williamr@4
   284
	ESsmRestoreSubStateReserved2 = 0x18
williamr@4
   285
williamr@4
   286
	/**
williamr@4
   287
	Additional states for use 0x20 - 0xFF
williamr@4
   288
	*/
williamr@4
   289
	};
williamr@4
   290
williamr@4
   291
#endif	//__SSMSUBSTATES_HRH__