1 /*

     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 * Name        : startupdomainpskeys.h

    16 * Part of     : System Startup / Starter

    17 * Interface   : Domain, System State API

    18 * This file contains Domain Publish & Subscribe definitions of Startup subsystem.

    19 * Version     : %version: ou1s60rt#12 %

    20 * This material, including documentation and any related computer

    21 * programs, is protected by copyright controlled by Nokia.  All

    22 * rights are reserved.  Copying, including reproducing, storing,

    23 * adapting or translating, any or all of this material requires the

    24 * prior written consent of Nokia.  This material also contains

    25 * confidential information which may not be disclosed to others

    26 * without the prior written consent of Nokia.

    27 * Template version: 4.0

    28 * Nokia Core OS *

    29 *

    30 */

    31 

    32 #ifndef __STARTUPDOMAINPSKEYS_H__

    33 #define __STARTUPDOMAINPSKEYS_H__

    34 

    35 #include <e32property.h>

    36 #include <ssm/startupreason.h>

    37 #include <ssm/simutils.h>

    38 

    39 /*

    40 * @file

    41 * @publishedPartner

    42 * @released

    43 */

    44 

    45 const TInt KStartupEnumerationFirstValue = 100;

    46 

    47 static const TUid KPSUidStartup = { 0x101F8766 };

    48 

    49 // =============================================================================

    50 // System State API

    51 // =============================================================================

    52 

    53 // Use TUid KPSUidStartup = { 0x101F8766 };

    54 

    55 /**

    56 * The system state shared by Symbian OS and Domestic OS.

    57 */

    58 const TUint32 KPSGlobalSystemState = 0x00000041;

    59 enum TPSGlobalSystemState

    60     {

    61     ESwStateStartingUiServices  = KStartupEnumerationFirstValue,

    62     ESwStateStartingCriticalApps,

    63     ESwStateSelfTestOK,

    64 

    65     // States for the security check phase.

    66     ESwStateSecurityCheck,

    67     ESwStateCriticalPhaseOK,

    68     ESwStateEmergencyCallsOnly,

    69 

    70     // Terminal states defined by the boot mode (and some other variables such as offline mode).

    71     ESwStateTest,

    72     ESwStateCharging,

    73     ESwStateAlarm,

    74     ESwStateNormalRfOn,

    75     ESwStateNormalRfOff,

    76     ESwStateNormalBTSap,

    77 

    78     // States for notifying adaptation about a terminal state change.

    79     ESwStateAlarmToCharging,

    80     ESwStateChargingToAlarm,

    81     ESwStateChargingToNormal,

    82     ESwStateAlarmToNormal,

    83 

    84     // Error states.

    85     ESwStateFatalStartupError,

    86 

    87     // A state for shutdown

    88     ESwStateShuttingDown

    89     };

    90 

    91 /**

    92 * The startup mode shared by Symbian OS and Domestic OS.

    93 */

    94 const TUint32 KPSGlobalStartupMode = 0x00000042;

    95 enum TPSGlobalStartupMode

    96     {

    97     EStartupModeNormal = KStartupEnumerationFirstValue,

    98     EStartupModeAlarm,

    99     EStartupModeCharging,

   100     EStartupModeTest

   101     };

   102 

   103 /**

   104 * Idle screen is ready to be transferred into foreground. Startup animation can be shown.

   105 */

   106 const TUint32 KPSIdlePhase1Ok = 0x00000043;

   107 enum TPSIdlePhase1Ok

   108     {

   109     EIdlePhase1NOK = KStartupEnumerationFirstValue,

   110     EIdlePhase1Ok

   111     };

   112 

   113 /**

   114 * Phone application is ready for MO/MT calls. RF can be switched on.

   115 */

   116 const TUint32 KPSPhonePhase1Ok = 0x00000044;

   117 enum TPSPhonePhase1Ok

   118     {

   119     EPhonePhase1NOK = KStartupEnumerationFirstValue,

   120     EPhonePhase1Ok

   121     };

   122 

   123 /**

   124 * Used by Starter to publish the additional startup reason (language switch,

   125 * RFS, etc.) for other components to use.

   126 * The correct startup reason is updated to this key early in start-up, and the

   127 * value stays the same until system is shut down.

   128 *

   129 * Contains one of the values of TStartupReason enumeration defined in

   130 * startupreason.h.

   131 */

   132 const TUint32 KPSStartupReason = 0x000000045;

   133 

   134 /**

   135 * Informs completion of a startup UI sequence phase (animation, graphic, text).

   136 *

   137 * After the key is notified with value EStartupUiPhaseAllDone, clients can begin 

   138 * to use UI services without interfering with startup queries or animation(s).

   139 * 

   140 * Clients must not rely on notification of any other value but EStartupUiPhaseAllDone,

   141 * because if an animation or graphic is not shown its completion is not notified either.

   142 */

   143 const TUint32 KPSStartupUiPhase = 0x00000046;

   144 

   145 enum TPSStartupUiPhase

   146     {

   147     EStartupUiPhaseUninitialized = KStartupEnumerationFirstValue, // default value after key definition

   148     EStartupUiPhaseSystemWelcomeDone, // startup animation has been displayed

   149     EStartupUiPhaseOperatorWelcomeDone, // operator animation / graphic has been displayed

   150     EStartupUiPhaseUserWelcomeDone, // user welcome text / graphic has been displayed

   151     EStartupUiPhaseAllDone // all the startup related queries and graphics has been displayed

   152     };

   153 

   154 // =============================================================================

   155 // Startup Security Status API

   156 // =============================================================================

   157 

   158 // Use TUid KPSUidStartup = { 0x101F8766 };

   159 

   160 /**

   161 * Indicates the SIM security status

   162 */

   163 const TUint32 KStartupSimSecurityStatus = 0x00000001;

   164 enum TPSSimSecurityStatus

   165     {

   166     ESimSecurityStatusUninitialized = KStartupEnumerationFirstValue,

   167     ESimRejected,   // The PUK code has been entered incorrectly, so the card is rejected.

   168     ESimUnaccepted,  // The SIM lock is on, so the card is unaccepted.

   169     ESimInvalid     //The Sim inserted is not same as the one provided by the operator, so card is invalid.

   170     };

   171 

   172 

   173 /**

   174 * Indicates the SIM lock status

   175 */

   176 const TUint32 KStartupSimLockStatus = 0x00000002;

   177 enum TPSSimLockStatus

   178     {

   179     ESimLockStatusUninitialized = KStartupEnumerationFirstValue,

   180     ESimLockActive,

   181     ESimLockRestrictionPending,

   182     ESimLockRestrictionOn,

   183     ESimLockOk

   184     };

   185 

   186 /**

   187 * Indicates the Security code status, i.e. is the code required or not.

   188 */

   189 const TUint32 KStartupSecurityCodeStatus = 0x00000003;

   190 enum TPSSecurityCodeStatus

   191     {

   192     ESecurityCodeStatusUninitialized = KStartupEnumerationFirstValue,

   193     ESecurityCodeNotRequired,

   194     ESecurityCodeRequired,

   195     ESecurityCodeInitWait

   196     };

   197 

   198 /**

   199 * Used by Security Notifier to notify Startup Application whether the security

   200 * code query is active.

   201 * Old Shared Data constant name: KSysCodeQueryStatus.

   202 */

   203 const TUint32 KStartupSecurityCodeQueryStatus = 0x00000004;

   204 enum TStartupCodeQueryStatus

   205     {

   206     ESecurityQueryUninitialized = KStartupEnumerationFirstValue,

   207     ESecurityQueryNotActive,

   208     ESecurityQueryActive

   209     };

   210 

   211 // =============================================================================

   212 // System Startup Control API

   213 // =============================================================================

   214 

   215 // Use TUid KPSUidStartup = { 0x101F8766 };

   216 

   217 /**

   218 * "Boot into Offline Mode" query reply. Startup App shows the query

   219 * and notifies Starter about the user's choice.

   220 * Old Shared Data constant name: KSysApBootIntoOffline

   221 **/

   222 const TUint32 KStartupBootIntoOffline = 0x00000011;

   223 enum TStartupBootIntoOffline

   224     {

   225     EBootIntoOnlineModeUninitialized = KStartupEnumerationFirstValue,

   226     EBootIntoOnlineMode,

   227     EBootIntoOfflineMode

   228     };

   229 

   230 /**

   231 * To be used by Startup App for notifying Starter

   232 * of the ongoing clean boot.

   233 * Old Shared Data constant name: KSysApCleanBoot

   234 */

   235 const TUint32 KStartupCleanBoot = 0x00000012;

   236 enum TStartupCleanBoot

   237     {

   238     EStartupCleanBootUninitialized = KStartupEnumerationFirstValue,

   239     EStartupNormalBoot,

   240     EStartupCleanBoot

   241     };

   242 

   243 /**  

   244 * To be used by Starter to check whether this is the first boot. This Key will 

   245 * hold the cenrep value same as KStartupFirstBoot , which is persistant across the boots.

   246 */

   247 const TUint32 KPSStartupFirstBoot = 0x00000013;

   248 enum TPSStartupFirstBoot

   249     {

   250     EPSStartupFirstBootUninitialized = KStartupEnumerationFirstValue,

   251     EPSStartupFirstBoot,

   252     EPSStartupNotFirstBoot

   253     };

   254 

   255 // =============================================================================

   256 // Splash Screen Shutdown API

   257 // =============================================================================

   258 

   259 // Use TUid KPSUidStartup = { 0x101F8766 };

   260 const TInt KSplashScreenShutdownAPIBase = 0x00000301;

   261 

   262 /**

   263 * To be used by Startup App for notifying SplashScreen that it should shut down.

   264 * Changing the value of this key has no effect unless SplashScreen is running.

   265 */

   266 const TUint32 KPSSplashShutdown = KSplashScreenShutdownAPIBase;

   267 enum TPSSplashShutdown

   268     {

   269     ESplashRunning = KStartupEnumerationFirstValue,

   270     ESplashShutdown

   271     };

   272 

   273 // =============================================================================

   274 // Wakeup Alarm API

   275 // =============================================================================

   276 

   277 // Use TUid KPSUidStartup = { 0x101F8766 };

   278 const TInt KWakeupAlarmAPIBase = 0x00000401;

   279 

   280 /**

   281 * Starter server sets this value to EWakeupAlarmSet when there are active

   282 * wakeup alarm(s), and ENoWakeupAlarmsSet when there are no active wakeup

   283 * alarms.

   284 * A wakeup alarm is an alarm which wakes up the terminal is it is powered off

   285 * when the alarm occurs.

   286 * An active wakeup alarm is a wakeup alarm which has been set and has not

   287 * started to alert yet.

   288 */

   289 const TUint32 KPSWakeupAlarmStatus = KWakeupAlarmAPIBase;

   290 enum TPSWakeupAlarmStatus

   291     {

   292     EWakeupAlarmUninitialized = KStartupEnumerationFirstValue,

   293     EWakeupAlarmSet,

   294     ENoWakeupAlarmsSet

   295     };

   296 

   297 #endif // __STARTUPDOMAINPSKEYS_H__