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