epoc32/include/ssm/ssmstates.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 __SSMSTATES_HRH__
    17 #define __SSMSTATES_HRH__
    18 
    19 #include <e32def.h>
    20 
    21 /**
    22  Enumeration of the main system states for the System State Manager
    23  
    24  @see TSsmState
    25  
    26  @publishedPartner
    27  @released
    28  
    29  The total value of the state can occupy a maximum of the lower 24 bits of a TUint32.  
    30  This has been divided into 8 bits (0-0xff for TSsmMainSystemStates, 16 bits (0-0xffff) for KSsmAnyMinorState
    31 */
    32 enum TSsmMainSystemStates
    33 	{
    34 	ESsmStartup = 0, // This must be 0 for compatibility with existing GSA components
    35 	ESsmNormal,
    36 	ESsmShutdown,
    37 	ESsmFail,
    38 	ESsmBackup,
    39 	ESsmRestore,
    40 	ESsmEmergencyCallsOnly,
    41 	/** Main states are 16 bits, but 8 bits are reserved for internal use, so allowed values range is until 0xFF */
    42 	ESsmMainSystemStateMax = 0xFF
    43 	};
    44 
    45 /**
    46  Represents any sub state, used for transitioning to policies where you don't know (or care)
    47  about the sub state.
    48  @publishedPartner
    49 @released
    50  */
    51 const TUint16 KSsmAnySubState = 0xFFFF;
    52 
    53 #endif	//__SSMSTATES_HRH__