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