1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/ssm/ssmsubstates.hrh Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -0,0 +1,291 @@
1.4 +// Copyright (c) 2007-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 +//
1.18 +
1.19 +#ifndef __SSMSUBSTATES_HRH__
1.20 +#define __SSMSUBSTATES_HRH__
1.21 +
1.22 +
1.23 +/**
1.24 + This enum contains sub-states for Startup System State.
1.25 + It matches TStartupStateIdentifier in sysstart (startup.hrh) for backwards compatibility.
1.26 +
1.27 + @publishedPartner
1.28 + @released
1.29 + */
1.30 +enum TSsmStartupSubStates
1.31 + {
1.32 + /** Undefined state */
1.33 + ESsmStartupSubStateUndefined = 0x00,
1.34 +
1.35 + /** Reserved for future use
1.36 + @internalComponent */
1.37 + ESsmStartupSubStateReserved1 = 0x08,
1.38 +
1.39 + /** Within this state all ROM based(static) components or resources
1.40 + that are critical to the operation of the phone function are started. */
1.41 + ESsmStartupSubStateCriticalStatic = 0x10,
1.42 +
1.43 + /** Reserved for future use
1.44 + @internalComponent */
1.45 + ESsmStartupSubStateReserved2 = 0x18,
1.46 +
1.47 + /** Within this state all non-ROM based(dynamic) components or resources
1.48 + that are critical to the operation of the phone function are started. */
1.49 + ESsmStartupSubStateCriticalDynamic = 0x20,
1.50 +
1.51 + /** Networking state */
1.52 + ESsmStartupSubStateNetworkingCritical = 0x28,
1.53 +
1.54 + /** Within this state all ROM based(static) or non-ROM based(dynamic) components or
1.55 + resources that are non-critical to the operation of the phone function are started. */
1.56 + ESsmStartupSubStateNonCritical = 0x30,
1.57 +
1.58 + /** Reserved for future use.
1.59 + @internalComponent */
1.60 + ESsmStartupSubStateReserved3 = 0x38,
1.61 +
1.62 + /** Reserved for future use.
1.63 + @internalComponent */
1.64 + ESsmStartupSubStateReserved4 = 0x40
1.65 +
1.66 + /**
1.67 + Additional states for use 0x48 - 0xFF
1.68 + */
1.69 + };
1.70 +
1.71 +
1.72 +
1.73 +
1.74 +/**
1.75 +This enum contains sub-states for Normal System State.
1.76 +
1.77 + @publishedPartner
1.78 + @released
1.79 + */
1.80 +enum TSsmNormalSubStates
1.81 + {
1.82 + /** Undefined state */
1.83 + ESsmNormalSubStateUndefined = 0x00,
1.84 +
1.85 + /** Reserved for future use
1.86 + @internalComponent */
1.87 + ESsmNormalSubStateReserved1 = 0x08,
1.88 +
1.89 + /** Publishes the state. */
1.90 + ESsmNormalSubState = 0x10,
1.91 +
1.92 + /** Reserved for future use.
1.93 + @internalComponent*/
1.94 + ESsmNormalSubStateReserved2 = 0x18,
1.95 +
1.96 + /** Reserved for future use.
1.97 + @internalComponent*/
1.98 + ESsmNormalSubStateReserved3 = 0x20,
1.99 +
1.100 + /** This state is valid only when patchable constant KSsmGracefulOffline is enabled*/
1.101 + ESsmNormalRfOnSubState = 0x28,
1.102 +
1.103 + /** This state is valid only when patchable constant KSsmGracefulOffline is enabled*/
1.104 + ESsmNormalRfOffSubState = 0x30
1.105 +
1.106 + /**
1.107 + Additional states for use 0x38 - 0xFF
1.108 + */
1.109 + };
1.110 +
1.111 +/**
1.112 +This enum contains sub-states for Fail System State.
1.113 +
1.114 + @publishedPartner
1.115 + @released
1.116 + */
1.117 +enum TSsmFailSubStates
1.118 + {
1.119 + /** Undefined state */
1.120 + ESsmFailSubStateUndefined = 0x00,
1.121 +
1.122 + /** Reserved for future use
1.123 + @internalComponent */
1.124 + ESsmFailSubStateReserved1 = 0x08,
1.125 +
1.126 + /** Publishes the state and issues a device poweroff. */
1.127 + ESsmFailSubStatePowerOff = 0x10,
1.128 +
1.129 + /** Reserved for future use.
1.130 + @internalComponent */
1.131 + ESsmFailSubStateReserved2 = 0x18,
1.132 +
1.133 + /** Publishes the state and issues a device restart. */
1.134 + ESsmFailSubStateRestart = 0x20,
1.135 +
1.136 + /** Reserved for future use.
1.137 + @internalComponent */
1.138 + ESsmFailSubStateReserved3 = 0x28
1.139 +
1.140 + /**
1.141 + Additional states for use 0x30 - 0xFF
1.142 + */
1.143 + };
1.144 +
1.145 +/**
1.146 +This enum contains sub-states for Shutdown System State.
1.147 +
1.148 + @publishedPartner
1.149 + @released
1.150 + */
1.151 +enum TSsmShutdownSubStates
1.152 + {
1.153 + /** Undefined state */
1.154 + ESsmShutdownSubStateUndefined = 0x00,
1.155 +
1.156 + /** Reserved for future use
1.157 + @internalComponent */
1.158 + ESsmShutdownSubStateReserved1 = 0x08,
1.159 +
1.160 + /** Within this state all components or resources that are critical and have registered for the shutdown notification
1.161 + are given notification to carryout shutdown activities. */
1.162 + ESsmShutdownSubStateCritical = 0x10,
1.163 +
1.164 + /** Reserved for future use.
1.165 + @internalComponent */
1.166 + ESsmShutdownSubStateReserved2 = 0x18,
1.167 +
1.168 + /** Within this state all components or resources that are non-critical and have registered for the shutdown notification
1.169 + are given notification to carryout shutdown activities. */
1.170 + ESsmShutdownSubStateNonCritical = 0x20,
1.171 +
1.172 + /** Reserved for future use.
1.173 + @internalComponent */
1.174 + ESsmShutdownSubStateReserved3 = 0x28,
1.175 +
1.176 + /** Power Off state. */
1.177 + ESsmShutdownSubStatePowerOff = 0x30,
1.178 +
1.179 + /** Restart the device. */
1.180 + ESsmShutdownSubStateReStart = 0x38,
1.181 +
1.182 + /** Reserved for future use.
1.183 + @internalComponent */
1.184 + ESsmShutdownSubStateReserved4 = 0x40
1.185 +
1.186 + /**
1.187 + Additional states for use 0x48 - 0xFF
1.188 + */
1.189 + };
1.190 +
1.191 +
1.192 +/**
1.193 +This enum contains sub-states for Emergency Calls System State.
1.194 +
1.195 + @publishedPartner
1.196 + @released
1.197 + */
1.198 +enum TSsmEmergencyCallSubStates
1.199 + {
1.200 + /** Undefined state */
1.201 + ESsmEmergencyCallSubStateUndefined = 0x00,
1.202 +
1.203 + /** Reserved for future use
1.204 + @internalComponent */
1.205 + ESsmEmergencyCallSubStateReserved1 = 0x08,
1.206 +
1.207 + /**
1.208 + @internalComponent
1.209 + Reserved for future use.
1.210 + */
1.211 + ESsmEmergencyCallsEnabledSubState = 0x10,
1.212 +
1.213 + /**
1.214 + @internalComponent
1.215 + Reserved for future use.
1.216 + */
1.217 + ESsmEmergencyCallsDisabledSubState = 0x18,
1.218 +
1.219 + /**
1.220 + @internalComponent
1.221 + Reserved for future use.
1.222 + */
1.223 + ESsmEmergencyCallsEnabledSubStateReserved2 = 0x20
1.224 +
1.225 + /**
1.226 + Additional states for use 0x28 - 0xFF
1.227 + */
1.228 + };
1.229 +
1.230 +/**
1.231 +This enum contains sub-states for Back-up System State.
1.232 +
1.233 + @publishedPartner
1.234 + @released
1.235 + */
1.236 +enum TSsmBackupSubStates
1.237 + {
1.238 + /** Undefined state */
1.239 + ESsmBackupSubStateUndefined = 0x00,
1.240 +
1.241 + /** Reserved for future use
1.242 + @internalComponent */
1.243 + ESsmBackupSubStateReserved1 = 0x08,
1.244 +
1.245 + /**
1.246 + @internalComponent
1.247 + Reserved for future use.
1.248 + */
1.249 + ESsmBackupSubState = 0x10,
1.250 +
1.251 + /**
1.252 + @internalComponent
1.253 + Reserved for future use.
1.254 + */
1.255 + ESsmBackupSubStateReserved2 = 0x18
1.256 +
1.257 + /**
1.258 + Additional states for use 0x20 - 0xFF
1.259 + */
1.260 + };
1.261 +
1.262 +/**
1.263 +This enum contains sub-states for Restore System State.
1.264 +
1.265 + @publishedPartner
1.266 + @released
1.267 + */
1.268 +enum TSsmRestoreSubStates
1.269 + {
1.270 + /** Undefined state */
1.271 + ESsmRestoreSubStateUndefined = 0x00,
1.272 +
1.273 + /** Reserved for future use
1.274 + @internalComponent */
1.275 + ESsmRestoreSubStateReserved1 = 0x08,
1.276 +
1.277 + /**
1.278 + @internalComponent
1.279 + Reserved for future use.
1.280 + */
1.281 + ESsmRestoreSubState = 0x10,
1.282 +
1.283 + /**
1.284 + @internalComponent
1.285 + Reserved for future use.
1.286 + */
1.287 + ESsmRestoreSubStateReserved2 = 0x18
1.288 +
1.289 + /**
1.290 + Additional states for use 0x20 - 0xFF
1.291 + */
1.292 + };
1.293 +
1.294 +#endif //__SSMSUBSTATES_HRH__