|
1 // Copyright (c) 2005-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 __STARTUP_HRH__ |
|
17 #define __STARTUP_HRH__ |
|
18 |
|
19 /** Identifiers for different command types. |
|
20 |
|
21 Note: To add a new command type, extend this enum and add a |
|
22 new struct to startup.rh. The struct should start with a WORD |
|
23 member initialised to the newly-added value. |
|
24 |
|
25 @publishedPartner |
|
26 @deprecated Instead of this use TSsmCommandType |
|
27 */ |
|
28 enum TStartupCommandType |
|
29 { |
|
30 /** |
|
31 This command is used for starting processes. |
|
32 */ |
|
33 EStartupProcess = 1, |
|
34 /** |
|
35 This command is used for starting apps. |
|
36 */ |
|
37 EStartupApp, |
|
38 /** |
|
39 This command is used for starting or killing the splash screen. |
|
40 */ |
|
41 EStartupSplashScreen, |
|
42 /** |
|
43 This command is used to force the apparc server to initialise. |
|
44 */ |
|
45 EInitAppArcServer, |
|
46 /** |
|
47 This command is used to call a function within a DLL using |
|
48 the ordinal number. |
|
49 */ |
|
50 EStartupDLL, |
|
51 /** |
|
52 This command is used to check that all previous processes and |
|
53 apps with start_method EDeferredWaitForStart have rendezvoused. |
|
54 */ |
|
55 EMultipleWait |
|
56 #ifdef SYMBIAN_PROCESS_MONITORING_AND_STARTUP |
|
57 , |
|
58 /** |
|
59 This command is used for starting processes with extended sysstart V2 functionality. |
|
60 */ |
|
61 EStartupProcess2, |
|
62 /** |
|
63 This command is used for starting applications with extended sysstart V2 functionality. |
|
64 */ |
|
65 EStartupApp2, |
|
66 /** |
|
67 This command is used for starting AMAStarter with a particular DSC |
|
68 */ |
|
69 EStartupAMAStarter |
|
70 #endif // SYMBIAN_PROCESS_MONITORING_AND_STARTUP |
|
71 }; |
|
72 |
|
73 /** Identifiers for starting up an application. Presently there are |
|
74 two methods of startup. |
|
75 |
|
76 @publishedPartner |
|
77 @deprecated Instead of this use TSsmCommandType |
|
78 */ |
|
79 enum TStartupType |
|
80 { |
|
81 /** |
|
82 For starting exes. |
|
83 */ |
|
84 EStartProcess = 1, |
|
85 /** |
|
86 For starting apps. |
|
87 */ |
|
88 EStartApp |
|
89 }; |
|
90 |
|
91 /** Identifiers for each startup state. Used to inform state-aware |
|
92 applications of a change of state. |
|
93 |
|
94 @publishedPartner |
|
95 @deprecated Instead of this use TSsmStartupSubStates |
|
96 */ |
|
97 enum TStartupStateIdentifier |
|
98 { |
|
99 /** |
|
100 Undefined state. |
|
101 */ |
|
102 EStartupStateUndefined = 0x00, |
|
103 /** |
|
104 @internalComponent |
|
105 Reserved for future use. |
|
106 */ |
|
107 EReservedStartUpState1 = 0x08, |
|
108 /** |
|
109 Within this state all ROM based(static) components or resources |
|
110 that are critical to the operation of the phone function are started. |
|
111 */ |
|
112 EStartupStateCriticalStatic = 0x10, |
|
113 /** |
|
114 @internalComponent |
|
115 Reserved for future use. |
|
116 */ |
|
117 EReservedStartUpState2 = 0x18, |
|
118 /** |
|
119 Within this state all non-ROM based(dynamic) components or resources |
|
120 that are critical to the operation of the phone function are started. |
|
121 */ |
|
122 EStartupStateCriticalDynamic = 0x20, |
|
123 /** |
|
124 Networking state. |
|
125 */ |
|
126 EStartupStateNetworkingCritical = 0x28, |
|
127 /** |
|
128 Within this state all ROM based(static) or non-ROM based(dynamic) components |
|
129 or resources that are non-critical to the operation of the phone function |
|
130 are started. |
|
131 */ |
|
132 EStartupStateNonCritical = 0x30, |
|
133 /** |
|
134 @internalComponent |
|
135 Reserved for future use. |
|
136 */ |
|
137 EReservedStartUpState4 = 0x38, |
|
138 /** |
|
139 @internalComponent |
|
140 Reserved for future use. |
|
141 */ |
|
142 EReservedStartUpState5 = 0x40 |
|
143 }; |
|
144 |
|
145 /** Identifiers for each start-up method. |
|
146 |
|
147 @publishedPartner |
|
148 @deprecated Instead of this use TSsmExecutionBehaviour |
|
149 */ |
|
150 enum TStartMethod |
|
151 { |
|
152 /** |
|
153 By using this type the starter can continue immediately |
|
154 with executing its next command. |
|
155 */ |
|
156 EFireAndForget = 1, |
|
157 /** |
|
158 By using this type the starter cannot continue with the |
|
159 next command until a rendezvous has been made with the started process. |
|
160 */ |
|
161 EWaitForStart, |
|
162 /** |
|
163 By using this type the starter will continue with the next command |
|
164 before a rendezvous has been made with the current command. |
|
165 However the rendezvous will be checked later when a MULTIPLE_WAIT command |
|
166 is encountered. |
|
167 */ |
|
168 EDeferredWaitForStart |
|
169 }; |
|
170 |
|
171 |
|
172 |
|
173 /** Identifier for the no of retries on state transition failure. |
|
174 |
|
175 @publishedPartner |
|
176 @deprecated |
|
177 */ |
|
178 enum TNoOfRetries |
|
179 { |
|
180 /** |
|
181 On state transition failure do not re-attempt the transition. |
|
182 */ |
|
183 ERetry0, |
|
184 /** |
|
185 On state transition failure re-attempt the transition once. |
|
186 */ |
|
187 ERetry1 |
|
188 }; |
|
189 |
|
190 |
|
191 /** Identifier for the action to be taken on state transition |
|
192 failure (after a re-attempt has already been made if required). |
|
193 |
|
194 @publishedPartner |
|
195 @deprecated Instead of this use TSsmRecoveryMethod |
|
196 */ |
|
197 enum TActionOnStateTransitionFailure |
|
198 { |
|
199 /** |
|
200 Ignore the state transition failure. Carry on with actions |
|
201 corresponding to the next state. |
|
202 */ |
|
203 EIgnoreFailure, |
|
204 |
|
205 /** |
|
206 Panic the system starter if state transition failed. This |
|
207 will cause the device to re-boot. |
|
208 */ |
|
209 EPanicOnFailure |
|
210 }; |
|
211 |
|
212 /** Identifier for the action to be taken on command failure. |
|
213 This is used with the fail_on_error fields within START_PROCESS_INFO, START_APP_INFO, START_DLL_INFO, and MULTIPLE_WAIT structures. |
|
214 These structures rely on this enum being a boolean value so it must not hold more than 2 values: EIgnoreCommandFailure=0 and EPanicOnCommandFailure=1. |
|
215 |
|
216 @publishedPartner |
|
217 @deprecated Instead of this use TSsmRecoveryMethod |
|
218 */ |
|
219 enum TActionOnCommandFailure |
|
220 { |
|
221 /** |
|
222 Ignore the command failure. |
|
223 */ |
|
224 EIgnoreCommandFailure, |
|
225 |
|
226 /** |
|
227 Panic the system starter if command fails. This |
|
228 will cause the device to re-boot. |
|
229 */ |
|
230 EPanicOnCommandFailure |
|
231 }; |
|
232 |
|
233 #ifdef SYMBIAN_PROCESS_MONITORING_AND_STARTUP |
|
234 /** Identifier for the action to be taken on command failure. |
|
235 This should be used to set the retry_failure_recovery_method when using START_PROCESS_INFO2 or START_APP_INFO2 structures |
|
236 |
|
237 @publishedPartner |
|
238 @deprecated Instead of this use TSsmRecoveryMethod |
|
239 */ |
|
240 enum TRecoveryMethod |
|
241 { |
|
242 /** |
|
243 Ignore the command failure |
|
244 */ |
|
245 EIgnoreOnFailure, |
|
246 /** |
|
247 Reboot the OS |
|
248 */ |
|
249 ERestartOS, |
|
250 /** |
|
251 Reboot the OS in a particular mode |
|
252 */ |
|
253 ERestartOSWithMode |
|
254 }; |
|
255 #endif // SYMBIAN_PROCESS_MONITORING_AND_STARTUP |
|
256 |
|
257 #endif // __STARTUP_HRH__ |
|
258 |