sysstatemgmt/systemstatemgr/inc/ssmpatchableconstants.h
changeset 0 4e1aa6a622a0
equal deleted inserted replaced
-1:000000000000 0:4e1aa6a622a0
       
     1 // Copyright (c) 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: Patchable constants defined in SSM
       
    14 //
       
    15 
       
    16 #ifndef __SSMPATCHABLECONSTANTS_H__
       
    17 #define __SSMPATCHABLECONSTANTS_H__
       
    18 #include <e32def.h>
       
    19 
       
    20 #ifdef SYMBIAN_SSM_GRACEFUL_SHUTDOWN
       
    21 /**
       
    22  * Patchable constant to determine if System State Manager(SSM) staged shutdown or existing shutdown server 
       
    23  * mechanism is to be used for device shutdown.
       
    24  *
       
    25  * This value determines if System State Manager/Shutdown server is used for device shutdown.
       
    26  * The default value for KSsmGracefulShutdown is 0x0, i.e., Shutdown server is used for device shutdown.
       
    27  *
       
    28  * If device shutdown is to be done through SSM staged shutdown this value must be set to '0xFFFFFFFF'.
       
    29  *
       
    30  * To patch these values, add a line to an iby or oby file that is included in the rom being built using the following format:
       
    31  * 
       
    32  * "patchdata <dll> @ <symbol> <newvalue>"
       
    33  *
       
    34  * e.g. to enable System State Manager for device shutdown, use the following line:
       
    35  * "patchdata ssmcmn.dll @ KSsmGracefulShutdown 0xFFFFFFFF"
       
    36  *
       
    37  * @SYMPatchable
       
    38  * @publishedPartner
       
    39  * @released
       
    40  *
       
    41  */
       
    42 IMPORT_C extern const TUint32 KSsmGracefulShutdown;
       
    43 
       
    44 IMPORT_C TUint32 IsSsmGracefulShutdown();
       
    45 #endif // SYMBIAN_SSM_GRACEFUL_SHUTDOWN
       
    46 
       
    47 /**
       
    48  * 
       
    49  * This patchable constant enables the feature of graceful offline notification.
       
    50  * The default value for KSsmGracefulOffline is 0x0. 
       
    51  * 
       
    52  * To patch these values, add a line to an iby or oby file that is included in the rom being built using the following format:
       
    53  * 
       
    54  * "patchdata <dll> @ <symbol> <newvalue>"
       
    55  * By default this feature will not be enabled.
       
    56  * e.g. to enable graceful offline notification 
       
    57  * "patchdata ssmcmn.dll @ KSsmGracefulOffline 0xFFFFFFFF" 
       
    58  * 
       
    59  * @SYMPatchable
       
    60  * @publishedPartner
       
    61  * @released
       
    62  * 
       
    63  */
       
    64 IMPORT_C extern const TUint32 KSsmGracefulOffline;
       
    65 
       
    66 IMPORT_C TUint32 IsSsmGracefulOffline();
       
    67 
       
    68 
       
    69 /**
       
    70  * 
       
    71  * This patchable constant enables the feature for checking of Invalid Sim
       
    72  * The default value for KSsmInvalidSim is 0x0. 
       
    73  * 
       
    74  * To patch these values, add a line to an iby or oby file that is included in the rom being built using the following format:
       
    75  * 
       
    76  * "patchdata <dll> @ <symbol> <newvalue>"
       
    77  * By default this feature will not be enabled.
       
    78  * e.g. to enable feature to check whether sim is invalid
       
    79  * "patchdata ssmcmn.dll @ KSsmInvalidSim 0xFFFFFFFF" 
       
    80  * 
       
    81  * @SYMPatchable
       
    82  * @publishedPartner
       
    83  * @released
       
    84  * 
       
    85  */
       
    86 IMPORT_C extern const TUint32 KSsmInvalidSim;
       
    87 
       
    88 #endif	// __SSMPATCHABLECONSTANTS_H__