1 /*

     2 * Copyright (c) 2005 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: Constants for scheduled backup state IDs

    15 *     

    16 *

    17 */

    18 

    19 #ifndef __MMCSCBKUPSTATEIDS_H__

    20 #define __MMCSCBKUPSTATEIDS_H__

    21 

    22 // System includes

    23 #include <e32std.h>

    24 

    25 // Type definitions

    26 typedef TUid TMMCScBkupStateId;

    27 

    28 // Constants

    29 

    30 

    31 /**

    32 * Archive Header

    33 * ===========================

    34 *

    35 * BACKUP:  Step 1 - first archive write operation: store archive header

    36 * RESTORE: Step 1 - first archive read operation: restore archive header

    37 */

    38 const TInt32 KMMCScBkupStateIdValueArchiveOpArchiveHeader = 0x0BAC001;

    39 const TMMCScBkupStateId KMMCScBkupStateArchiveOpArchiveHeader = { KMMCScBkupStateIdValueArchiveOpArchiveHeader };

    40 

    41 /**

    42 * Obtain List of Data Owners 

    43 * ==========================

    44 *

    45 * BACKUP:  Step 2 - Get list of data owners from SBE

    46 */

    47 const TInt32 KMMCScBkupStateIdValueGetDataOwners = 0x0BAC0002;

    48 const TMMCScBkupStateId KMMCScBkupStateIdGetDataOwners = { KMMCScBkupStateIdValueGetDataOwners };

    49 

    50 /**

    51 * Set Smartphone into Backup Mode

    52 * ===============================

    53 *

    54 * BACKUP:  Step 3

    55 * RESTORE: 

    56 */

    57 const TInt32 KMMCScBkupStateIdValueSetPhoneMode = 0x0BAC0003;

    58 const TMMCScBkupStateId KMMCScBkupStateIdSetPhoneMode = { KMMCScBkupStateIdValueSetPhoneMode };

    59 

    60 /**

    61 * Supply Data Snapshots (Not Currently Supported)

    62 * ===============================================

    63 *

    64 * BACKUP: Step 4

    65 */

    66 const TInt32 KMMCScBkupStateIdValueSupplyDataSnapshots = 0x0BAC0004; // Not supported

    67 const TMMCScBkupStateId KMMCScBkupStateIdSupplyDataSnapshots = { KMMCScBkupStateIdValueSupplyDataSnapshots };

    68 

    69 /**

    70 * Inform the Device that All Snapshots Have Been Supplied

    71 * =======================================================

    72 *

    73 * BACKUP: Step 5

    74 */

    75 const TInt32 KMMCScBkupStateIdValueNotifyAllSnapshotsSupplied = 0x0BAC0005;

    76 const TMMCScBkupStateId KMMCScBkupStateIdNotifyAllSnapshotsSupplied = { KMMCScBkupStateIdValueNotifyAllSnapshotsSupplied };

    77 

    78 /**

    79 * Request Size of Backup Data

    80 * ===========================

    81 *

    82 * BACKUP: Step 6

    83 */

    84 const TInt32 KMMCScBkupStateIdValueRequestSizeOfBackupData = 0x0BAC0006;

    85 const TMMCScBkupStateId KMMCScBkupStateIdRequestSizeOfBackupData = { KMMCScBkupStateIdValueRequestSizeOfBackupData };

    86 

    87 /**

    88 * Archive Operation: data owners

    89 * ==============================

    90 *

    91 * BACKUP: Step 7 - second archive write operation: store data owners

    92 */

    93 const TInt32 KMMCScBkupStateIdValueArchiveOpDataOwners = 0x0BAC0007;

    94 const TMMCScBkupStateId KMMCScBkupStateIdArchiveOpDataOwners = { KMMCScBkupStateIdValueArchiveOpDataOwners };

    95 

    96 /**

    97 * Request List of Public Files

    98 * ============================

    99 *

   100 * BACKUP: Step 8

   101 */

   102 const TInt32 KMMCScBkupStateIdValueRequestListOfPublicFiles = 0x0BAC0008;

   103 const TMMCScBkupStateId KMMCScBkupStateIdRequestListOfPublicFiles = { KMMCScBkupStateIdValueRequestListOfPublicFiles };

   104 

   105 /**

   106 * Calculate disk space required for backup or restore

   107 * ============================

   108 *

   109 * BACKUP: Step 8

   110 */

   111 const TInt32 KMMCScBkupStateIdValueValidateDiskSpace = 0x0BAC0009;

   112 const TMMCScBkupStateId KMMCScBkupStateIdValidateDiskSpace = { KMMCScBkupStateIdValueValidateDiskSpace };

   113 

   114 

   115 /**

   116 * Archive Operation: public data files

   117 * ====================================

   118 *

   119 * BACKUP: Step 10 - forth archive write operation: store public data files

   120 */

   121 const TInt32 KMMCScBkupStateIdValueArchiveOpPublicDataFiles = 0x0BAC000A;

   122 const TMMCScBkupStateId KMMCScBkupStateIdArchiveOpPublicDataFiles = { KMMCScBkupStateIdValueArchiveOpPublicDataFiles };

   123 

   124 /**

   125 * Request System Data

   126 * ===================

   127 *

   128 * BACKUP: Step 11 - fifth archive write operation: store system data

   129 */

   130 const TInt32 KMMCScBkupStateIdValueArchiveOpSystemData = 0x0BAC000B;

   131 const TMMCScBkupStateId KMMCScBkupStateIdArchiveOpSystemData = { KMMCScBkupStateIdValueArchiveOpSystemData };

   132 

   133 /**

   134 * Request Java Data

   135 * ===================

   136 *

   137 * BACKUP: Step 12 - sixth archive write operation: store system data

   138 */

   139 const TInt32 KMMCScBkupStateIdValueArchiveOpJavaData = 0x0BAC000C;

   140 const TMMCScBkupStateId KMMCScBkupStateIdArchiveOpJavaData = { KMMCScBkupStateIdValueArchiveOpJavaData };

   141 

   142 /**

   143 * Request Request State of Active Data Owners

   144 * ===========================================

   145 *

   146 * BACKUP: Step 13

   147 */

   148 const TInt32 KMMCScBkupStateIdValueGetDataOwnerStatuses = 0x0BAC000D;

   149 const TMMCScBkupStateId KMMCScBkupStateIdGetDataOwnerStatuses = { KMMCScBkupStateIdValueGetDataOwnerStatuses };

   150 

   151 /**

   152 * Request Active Private Data

   153 * ===========================

   154 *

   155 * BACKUP: Step 14 - seventh archive write operation: store active data

   156 */

   157 const TInt32 KMMCScBkupStateIdValueArchiveOpActiveData = 0x0BAC000E;

   158 const TMMCScBkupStateId KMMCScBkupStateIdArchiveOpActiveData = { KMMCScBkupStateIdValueArchiveOpActiveData };

   159 

   160 /**

   161 * Request Passive Private Data

   162 * ===========================

   163 *

   164 * BACKUP: Step 15 - eighth archive write operation: store passive data

   165 */

   166 const TInt32 KMMCScBkupStateIdValueArchiveOpPassiveData = 0x0BAC000F;

   167 const TMMCScBkupStateId KMMCScBkupStateIdArchiveOpPassiveData = { KMMCScBkupStateIdValueArchiveOpPassiveData };

   168 

   169 /**

   170 * Archive Footer

   171 * ===========================

   172 *

   173 * BACKUP: Step 16 - nineth archive write operation: store footer

   174 */

   175 const TInt32 KMMCScBkupStateIdValueArchiveOpArchiveFooter = 0x0BAC0010;

   176 const TMMCScBkupStateId KMMCScBkupStateIdArchiveOpArchiveFooter = { KMMCScBkupStateIdValueArchiveOpArchiveFooter };

   177 

   178 /**

   179 * Archive Header

   180 * ===========================

   181 *

   182 * COMMON: Special step to indicate no more steps required

   183 */

   184 const TInt32 KMMCScBkupStateIdValueOperationComplete = 0x0BAC0011;

   185 const TMMCScBkupStateId KMMCScBkupStateIdOperationComplete = { KMMCScBkupStateIdValueOperationComplete };

   186 

   187 

   188 

   189 /**

   190 * Archive Operation: read data owners

   191 * ===================================

   192 *

   193 * RESTORE: Step 2 - read from archive, inform to secure backup engine

   194 */

   195 const TInt32 KMMCScBkupStateIdValueArchiveOpReadDataOwners = 0x0BAC0012;

   196 const TMMCScBkupStateId KMMCScBkupStateIdArchiveOpReadDataOwners = { KMMCScBkupStateIdValueArchiveOpReadDataOwners };

   197 

   198 

   199 

   200 

   201 /**

   202 * BACKUP STATE FLOW

   203 * =================

   204 *

   205 *  1) KMMCScBkupStateIdArchiveOpArchiveHeader

   206 *  2) KMMCScBkupStateIdGetDataOwners

   207 *  3) KMMCScBkupStateIdSetPhoneMode

   208 *  4) KMMCScBkupStateIdNotifyAllSnapshotsSupplied

   209 *  5) KMMCScBkupStateIdRequestSizeOfBackupData

   210 *  6) KMMCScBkupStateIdRequestListOfPublicFiles

   211 *  7) KMMCScBkupStateIdValidateDiskSpace

   212 *  8) KMMCScBkupStateIdArchiveOpPublicDataFiles

   213 *  9) KMMCScBkupStateIdArchiveOpSystemData

   214 * 10) KMMCScBkupStateIdArchiveOpJavaData

   215 * 11) KMMCScBkupStateIdGetDataOwnerStatuses

   216 * 12) KMMCScBkupStateIdArchiveOpActiveData

   217 * 13) KMMCScBkupStateIdArchiveOpPassiveData

   218 * 14) KMMCScBkupStateIdArchiveOpDataOwners

   219 * 15) KMMCScBkupStateIdArchiveOpArchiveFooter

   220 * 16) KMMCScBkupStateIdOperationComplete

   221 * 

   222 */

   223 

   224 

   225 

   226 /**

   227 * RESTORE STATE FLOW

   228 * =================

   229 *

   230 *  1) KMMCScBkupStateIdArchiveOpArchiveHeader

   231 *  2) KMMCScBkupStateIdArchiveOpArchiveFooter

   232 *  3) KMMCScBkupStateIdArchiveOpDataOwners

   233 *  4) KMMCScBkupStateIdValidateDiskSpace

   234 *  5) KMMCScBkupStateIdSetPhoneMode

   235 *  6) KMMCScBkupStateIdArchiveOpSystemData

   236 *  7) KMMCScBkupStateIdArchiveOpJavaData

   237 *  8) KMMCScBkupStateIdArchiveOpPassiveData

   238 *  9) KMMCScBkupStateIdGetDataOwnerStatuses

   239 * 10) KMMCScBkupStateIdArchiveOpActiveData

   240 * 11) KMMCScBkupStateIdArchiveOpPublicDataFiles

   241 * 12) KMMCScBkupStateIdOperationComplete

   242 *

   243 */

   244 

   245 #endif // __MMCSCBKUPSTATEIDS_H__

   246 

   247 //End of File