1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/startup.hrh Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -0,0 +1,259 @@
1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// This file has been deprecated and use ssmcmd.hrh instead
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __STARTUP_HRH__
1.22 +#define __STARTUP_HRH__
1.23 +
1.24 +/** Identifiers for different command types.
1.25 +
1.26 +Note: To add a new command type, extend this enum and add a
1.27 +new struct to startup.rh. The struct should start with a WORD
1.28 +member initialised to the newly-added value.
1.29 +
1.30 +@publishedPartner
1.31 +@deprecated Instead of this use TSsmCommandType
1.32 +*/
1.33 +enum TStartupCommandType
1.34 + {
1.35 + /**
1.36 + This command is used for starting processes.
1.37 + */
1.38 + EStartupProcess = 1,
1.39 + /**
1.40 + This command is used for starting apps.
1.41 + */
1.42 + EStartupApp,
1.43 + /**
1.44 + This command is used for starting or killing the splash screen.
1.45 + */
1.46 + EStartupSplashScreen,
1.47 + /**
1.48 + This command is used to force the apparc server to initialise.
1.49 + */
1.50 + EInitAppArcServer,
1.51 + /**
1.52 + This command is used to call a function within a DLL using
1.53 + the ordinal number.
1.54 + */
1.55 + EStartupDLL,
1.56 + /**
1.57 + This command is used to check that all previous processes and
1.58 + apps with start_method EDeferredWaitForStart have rendezvoused.
1.59 + */
1.60 + EMultipleWait,
1.61 + /**
1.62 + This command is used for starting processes with extended sysstart V2 functionality.
1.63 + */
1.64 + EStartupProcess2,
1.65 + /**
1.66 + This command is used for starting applications with extended sysstart V2 functionality.
1.67 + */
1.68 + EStartupApp2,
1.69 + /**
1.70 + This command is used for starting AMAStarter with a particular DSC
1.71 + */
1.72 + EStartupAMAStarter
1.73 + };
1.74 +
1.75 +/** Identifiers for starting up an application. Presently there are
1.76 +two methods of startup.
1.77 +
1.78 +@publishedPartner
1.79 +@deprecated Instead of this use TSsmCommandType
1.80 +*/
1.81 +enum TStartupType
1.82 + {
1.83 + /**
1.84 + For starting exes.
1.85 + */
1.86 + EStartProcess = 1,
1.87 + /**
1.88 + For starting apps.
1.89 + */
1.90 + EStartApp
1.91 + };
1.92 +
1.93 +/** Identifiers for each startup state. Used to inform state-aware
1.94 +applications of a change of state.
1.95 +
1.96 +@publishedPartner
1.97 +@deprecated Instead of this use TSsmStartupSubStates
1.98 +*/
1.99 +enum TStartupStateIdentifier
1.100 + {
1.101 + /**
1.102 + Undefined state.
1.103 + */
1.104 + EStartupStateUndefined = 0x00,
1.105 + /**
1.106 + @internalComponent
1.107 + Reserved for future use.
1.108 + */
1.109 + EReservedStartUpState1 = 0x08,
1.110 + /**
1.111 + Within this state all ROM based(static) components or resources
1.112 + that are critical to the operation of the phone function are started.
1.113 + */
1.114 + EStartupStateCriticalStatic = 0x10,
1.115 + /**
1.116 + @internalComponent
1.117 + Reserved for future use.
1.118 + */
1.119 + EReservedStartUpState2 = 0x18,
1.120 + /**
1.121 + Within this state all non-ROM based(dynamic) components or resources
1.122 + that are critical to the operation of the phone function are started.
1.123 + */
1.124 + EStartupStateCriticalDynamic = 0x20,
1.125 + /**
1.126 + Networking state.
1.127 + */
1.128 + EStartupStateNetworkingCritical = 0x28,
1.129 + /**
1.130 + Within this state all ROM based(static) or non-ROM based(dynamic) components
1.131 + or resources that are non-critical to the operation of the phone function
1.132 + are started.
1.133 + */
1.134 + EStartupStateNonCritical = 0x30,
1.135 + /**
1.136 + @internalComponent
1.137 + Reserved for future use.
1.138 + */
1.139 + EReservedStartUpState4 = 0x38,
1.140 + /**
1.141 + @internalComponent
1.142 + Reserved for future use.
1.143 + */
1.144 + EReservedStartUpState5 = 0x40
1.145 + };
1.146 +
1.147 +/** Identifiers for each start-up method.
1.148 +
1.149 +@publishedPartner
1.150 +@deprecated Instead of this use TSsmExecutionBehaviour
1.151 +*/
1.152 +enum TStartMethod
1.153 + {
1.154 + /**
1.155 + By using this type the starter can continue immediately
1.156 + with executing its next command.
1.157 + */
1.158 + EFireAndForget = 1,
1.159 + /**
1.160 + By using this type the starter cannot continue with the
1.161 + next command until a rendezvous has been made with the started process.
1.162 + */
1.163 + EWaitForStart,
1.164 + /**
1.165 + By using this type the starter will continue with the next command
1.166 + before a rendezvous has been made with the current command.
1.167 + However the rendezvous will be checked later when a MULTIPLE_WAIT command
1.168 + is encountered.
1.169 + */
1.170 + EDeferredWaitForStart
1.171 + };
1.172 +
1.173 +
1.174 +
1.175 +/** Identifier for the no of retries on state transition failure.
1.176 +
1.177 +@publishedPartner
1.178 +@deprecated
1.179 +*/
1.180 +enum TNoOfRetries
1.181 + {
1.182 + /**
1.183 + On state transition failure do not re-attempt the transition.
1.184 + */
1.185 + ERetry0,
1.186 + /**
1.187 + On state transition failure re-attempt the transition once.
1.188 + */
1.189 + ERetry1
1.190 + };
1.191 +
1.192 +
1.193 +/** Identifier for the action to be taken on state transition
1.194 +failure (after a re-attempt has already been made if required).
1.195 +
1.196 +@publishedPartner
1.197 +@deprecated Instead of this use TSsmRecoveryMethod
1.198 +*/
1.199 +enum TActionOnStateTransitionFailure
1.200 + {
1.201 + /**
1.202 + Ignore the state transition failure. Carry on with actions
1.203 + corresponding to the next state.
1.204 + */
1.205 + EIgnoreFailure,
1.206 +
1.207 + /**
1.208 + Panic the system starter if state transition failed. This
1.209 + will cause the device to re-boot.
1.210 + */
1.211 + EPanicOnFailure
1.212 + };
1.213 +
1.214 +/** Identifier for the action to be taken on command failure.
1.215 +This is used with the fail_on_error fields within START_PROCESS_INFO, START_APP_INFO, START_DLL_INFO, and MULTIPLE_WAIT structures.
1.216 +These structures rely on this enum being a boolean value so it must not hold more than 2 values: EIgnoreCommandFailure=0 and EPanicOnCommandFailure=1.
1.217 +
1.218 +@publishedPartner
1.219 +@deprecated Instead of this use TSsmRecoveryMethod
1.220 +*/
1.221 +enum TActionOnCommandFailure
1.222 + {
1.223 + /**
1.224 + Ignore the command failure.
1.225 + */
1.226 + EIgnoreCommandFailure,
1.227 +
1.228 + /**
1.229 + Panic the system starter if command fails. This
1.230 + will cause the device to re-boot.
1.231 + */
1.232 + EPanicOnCommandFailure
1.233 + };
1.234 +
1.235 +/** Identifier for the action to be taken on command failure.
1.236 +This should be used to set the retry_failure_recovery_method when using START_PROCESS_INFO2 or START_APP_INFO2 structures
1.237 +
1.238 +@publishedPartner
1.239 +@deprecated Instead of this use TSsmRecoveryMethod
1.240 +*/
1.241 +enum TRecoveryMethod
1.242 + {
1.243 + /**
1.244 + Ignore the command failure
1.245 + */
1.246 + EIgnoreOnFailure,
1.247 + /**
1.248 + Reboot the OS
1.249 + */
1.250 + ERestartOS,
1.251 + /**
1.252 + Reboot the OS in a particular mode
1.253 + */
1.254 + ERestartOSWithMode,
1.255 + /**
1.256 + Reboot the OS (with no attempts to restart the component being attempted)
1.257 + */
1.258 + ECriticalNoRetries
1.259 + };
1.260 +
1.261 +#endif // __STARTUP_HRH__
1.262 +