yu.dong | c33b307 | 2024-08-21 23:14:49 -0700 | [diff] [blame^] | 1 | /***************************************************************************** |
| 2 | * Copyright Statement: |
| 3 | * -------------------- |
| 4 | * This software is protected by Copyright and the information contained |
| 5 | * herein is confidential. The software may not be copied and the information |
| 6 | * contained herein may not be used or disclosed except with the written |
| 7 | * permission of MediaTek Inc. (C) 2005 |
| 8 | * |
| 9 | * BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES |
| 10 | * THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE") |
| 11 | * RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON |
| 12 | * AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES, |
| 13 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF |
| 14 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. |
| 15 | * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE |
| 16 | * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR |
| 17 | * SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH |
| 18 | * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO |
| 19 | * NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S |
| 20 | * SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM. |
| 21 | * |
| 22 | * BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE |
| 23 | * LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE, |
| 24 | * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE, |
| 25 | * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO |
| 26 | * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. |
| 27 | * |
| 28 | * THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE |
| 29 | * WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF |
| 30 | * LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND |
| 31 | * RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER |
| 32 | * THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC). |
| 33 | * |
| 34 | *****************************************************************************/ |
| 35 | |
| 36 | /******************************************************************************* |
| 37 | * Filename: |
| 38 | * --------- |
| 39 | * nvram_struct.h |
| 40 | * |
| 41 | * Project: |
| 42 | * -------- |
| 43 | * MAUI |
| 44 | * |
| 45 | * Description: |
| 46 | * ------------ |
| 47 | * This file is for customers to config/customize their parameters to NVRAM Layer and |
| 48 | * Driver Layer. |
| 49 | * |
| 50 | * Author: |
| 51 | * ------- |
| 52 | * ------- |
| 53 | * |
| 54 | *============================================================================== |
| 55 | * HISTORY |
| 56 | * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!! |
| 57 | *------------------------------------------------------------------------------ |
| 58 | * removed! |
| 59 | * |
| 60 | * removed! |
| 61 | * removed! |
| 62 | * |
| 63 | * removed! |
| 64 | * removed! |
| 65 | * |
| 66 | * removed! |
| 67 | * removed! |
| 68 | * |
| 69 | * removed! |
| 70 | * removed! |
| 71 | * removed! |
| 72 | * |
| 73 | * removed! |
| 74 | * removed! |
| 75 | * removed! |
| 76 | * |
| 77 | * removed! |
| 78 | * removed! |
| 79 | * removed! |
| 80 | * |
| 81 | * removed! |
| 82 | * removed! |
| 83 | * removed! |
| 84 | * |
| 85 | * removed! |
| 86 | * removed! |
| 87 | * |
| 88 | * removed! |
| 89 | * removed! |
| 90 | * removed! |
| 91 | * |
| 92 | * removed! |
| 93 | * removed! |
| 94 | * removed! |
| 95 | * |
| 96 | * removed! |
| 97 | * removed! |
| 98 | * removed! |
| 99 | * |
| 100 | * removed! |
| 101 | * removed! |
| 102 | * removed! |
| 103 | * |
| 104 | * removed! |
| 105 | * removed! |
| 106 | * removed! |
| 107 | * |
| 108 | *------------------------------------------------------------------------------ |
| 109 | * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!! |
| 110 | *============================================================================== |
| 111 | *******************************************************************************/ |
| 112 | |
| 113 | #ifndef NVRAM_STRUCT_H |
| 114 | #define NVRAM_STRUCT_H |
| 115 | |
| 116 | #include "kal_general_types.h" |
| 117 | #include "nvram_enums.h" |
| 118 | |
| 119 | #include "nvram_defs.h" |
| 120 | |
| 121 | /************************************************************* |
| 122 | * <GROUP Local_Parameter_Structure> |
| 123 | * Related Message: MSG_ID_NVRAM_STARTUP_REQ |
| 124 | *************************************************************/ |
| 125 | typedef struct |
| 126 | { |
| 127 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 128 | LOCAL_PARA_HDR |
| 129 | /* DOM-NOT_FOR_SDK-END */ |
| 130 | kal_uint8 access_id; |
| 131 | kal_uint8 poweron_mode; |
| 132 | } nvram_startup_req_struct; |
| 133 | |
| 134 | /************************************************************* |
| 135 | * <GROUP Local_Parameter_Structure> |
| 136 | * Related Message: MSG_ID_NVRAM_STARTUP_CNF |
| 137 | *************************************************************/ |
| 138 | typedef struct |
| 139 | { |
| 140 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 141 | LOCAL_PARA_HDR |
| 142 | /* DOM-NOT_FOR_SDK-END */ |
| 143 | kal_uint8 access_id; |
| 144 | kal_uint8 result; |
| 145 | kal_uint8 data[8]; |
| 146 | } nvram_startup_cnf_struct; |
| 147 | |
| 148 | /************************************************************* |
| 149 | * <GROUP Local_Parameter_Structure> |
| 150 | * Related Message: MSG_ID_NVRAM_RESET_REQ |
| 151 | *************************************************************/ |
| 152 | typedef struct |
| 153 | { |
| 154 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 155 | LOCAL_PARA_HDR |
| 156 | /* DOM-NOT_FOR_SDK-END */ |
| 157 | kal_uint8 access_id; |
| 158 | nvram_reset_category_enum reset_category; |
| 159 | nvram_app_id_enum app_id; |
| 160 | nvram_lid_enum LID; |
| 161 | kal_uint16 rec_index; |
| 162 | kal_uint16 rec_amount; |
| 163 | } nvram_reset_req_struct; |
| 164 | |
| 165 | /************************************************************* |
| 166 | * <GROUP Local_Parameter_Structure> |
| 167 | * Related Message: MSG_ID_NVRAM_RESET_CNF |
| 168 | *************************************************************/ |
| 169 | typedef struct |
| 170 | { |
| 171 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 172 | LOCAL_PARA_HDR |
| 173 | /* DOM-NOT_FOR_SDK-END */ |
| 174 | kal_uint8 access_id; |
| 175 | kal_uint8 result; |
| 176 | } nvram_reset_cnf_struct; |
| 177 | |
| 178 | /************************************************************* |
| 179 | * <GROUP Local_Parameter_Structure> |
| 180 | * Related Message: MSG_ID_NVRAM_READ_REQ |
| 181 | *************************************************************/ |
| 182 | typedef struct |
| 183 | { |
| 184 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 185 | LOCAL_PARA_HDR |
| 186 | /* DOM-NOT_FOR_SDK-END */ |
| 187 | kal_uint8 access_id; |
| 188 | nvram_lid_enum file_idx; |
| 189 | kal_uint16 para; |
| 190 | kal_uint16 rec_amount; |
| 191 | } nvram_read_req_struct; |
| 192 | |
| 193 | /************************************************************* |
| 194 | * <GROUP Local_Parameter_Structure> |
| 195 | * Related Message: MSG_ID_NVRAM_READ_CNF |
| 196 | *************************************************************/ |
| 197 | typedef struct |
| 198 | { |
| 199 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 200 | LOCAL_PARA_HDR |
| 201 | /* DOM-NOT_FOR_SDK-END */ |
| 202 | kal_uint8 access_id; |
| 203 | nvram_lid_enum file_idx; |
| 204 | kal_uint16 para; |
| 205 | kal_uint16 length; |
| 206 | kal_uint8 result; |
| 207 | } nvram_read_cnf_struct; |
| 208 | |
| 209 | /************************************************************* |
| 210 | * <GROUP Local_Parameter_Structure> |
| 211 | * Related Message: MSG_ID_NVRAM_READ_DEFAULT_REQ |
| 212 | *************************************************************/ |
| 213 | typedef struct |
| 214 | { |
| 215 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 216 | LOCAL_PARA_HDR |
| 217 | /* DOM-NOT_FOR_SDK-END */ |
| 218 | kal_uint8 access_id; |
| 219 | nvram_lid_enum file_idx; |
| 220 | kal_uint16 para; |
| 221 | kal_uint16 rec_amount; |
| 222 | } nvram_read_default_req_struct; |
| 223 | |
| 224 | /************************************************************* |
| 225 | * <GROUP Local_Parameter_Structure> |
| 226 | * Related Message: MSG_ID_NVRAM_READ_DEFAULT_CNF |
| 227 | *************************************************************/ |
| 228 | typedef struct |
| 229 | { |
| 230 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 231 | LOCAL_PARA_HDR |
| 232 | /* DOM-NOT_FOR_SDK-END */ |
| 233 | kal_uint8 access_id; |
| 234 | nvram_lid_enum file_idx; |
| 235 | kal_uint16 para; |
| 236 | kal_uint16 length; |
| 237 | kal_uint8 result; |
| 238 | } nvram_read_default_cnf_struct; |
| 239 | |
| 240 | /************************************************************* |
| 241 | * <GROUP Local_Parameter_Structure> |
| 242 | * Related Message: MSG_ID_NVRAM_WRITE_REQ |
| 243 | *************************************************************/ |
| 244 | typedef struct |
| 245 | { |
| 246 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 247 | LOCAL_PARA_HDR |
| 248 | /* DOM-NOT_FOR_SDK-END */ |
| 249 | kal_uint8 access_id; |
| 250 | nvram_lid_enum file_idx; |
| 251 | kal_uint16 para; |
| 252 | } nvram_write_req_struct; |
| 253 | |
| 254 | /************************************************************* |
| 255 | * <GROUP Local_Parameter_Structure> |
| 256 | * Related Message: MSG_ID_NVRAM_WRITE_CNF |
| 257 | *************************************************************/ |
| 258 | typedef struct |
| 259 | { |
| 260 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 261 | LOCAL_PARA_HDR |
| 262 | /* DOM-NOT_FOR_SDK-END */ |
| 263 | kal_uint8 access_id; |
| 264 | nvram_lid_enum file_idx; |
| 265 | kal_uint16 para; |
| 266 | kal_uint8 result; |
| 267 | } nvram_write_cnf_struct; |
| 268 | |
| 269 | /************************************************************* |
| 270 | * <GROUP Local_Parameter_Structure> |
| 271 | * Related Message: MSG_ID_NVRAM_WRITE_IMEI_REQ |
| 272 | *************************************************************/ |
| 273 | typedef struct |
| 274 | { |
| 275 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 276 | LOCAL_PARA_HDR |
| 277 | /* DOM-NOT_FOR_SDK-END */ |
| 278 | kal_uint8 access_id; /* assign by sender */ |
| 279 | kal_uint16 record_index; /* first IMEI or second IMEI, starts from 1 */ |
| 280 | kal_uint8 imei[8]; /* IMEI 8 bytes */ |
| 281 | kal_uint8 svn; /* svn 1 bytes */ |
| 282 | } nvram_write_imei_req_struct; |
| 283 | |
| 284 | /************************************************************* |
| 285 | * <GROUP Local_Parameter_Structure> |
| 286 | * Related Message: MSG_ID_NVRAM_WRITE_IMEI_CNF |
| 287 | *************************************************************/ |
| 288 | typedef struct |
| 289 | { |
| 290 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 291 | LOCAL_PARA_HDR |
| 292 | /* DOM-NOT_FOR_SDK-END */ |
| 293 | kal_uint8 access_id; /* same as nvram_write_imei_req_struct */ |
| 294 | kal_uint16 record_index; /* 1 ~ 2 */ |
| 295 | kal_uint8 result; /* nvram_errno_enum */ |
| 296 | } nvram_write_imei_cnf_struct; |
| 297 | |
| 298 | |
| 299 | /************************************************************* |
| 300 | * <GROUP Local_Parameter_Structure> |
| 301 | * Related Message: MSG_ID_NVRAM_SET_LOCK_REQ |
| 302 | *************************************************************/ |
| 303 | typedef struct |
| 304 | { |
| 305 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 306 | LOCAL_PARA_HDR |
| 307 | /* DOM-NOT_FOR_SDK-END */ |
| 308 | kal_uint8 lock_en; |
| 309 | kal_uint32 reserved; |
| 310 | } nvram_set_lock_req_struct; |
| 311 | |
| 312 | /************************************************************* |
| 313 | * <GROUP Local_Parameter_Structure> |
| 314 | * Related Message: MSG_ID_NVRAM_SET_LOCK_CNF |
| 315 | *************************************************************/ |
| 316 | typedef struct |
| 317 | { |
| 318 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 319 | LOCAL_PARA_HDR |
| 320 | /* DOM-NOT_FOR_SDK-END */ |
| 321 | kal_uint8 result; |
| 322 | } nvram_set_lock_cnf_struct; |
| 323 | |
| 324 | /************************************************************* |
| 325 | * <GROUP Local_Parameter_Structure> |
| 326 | * Related Message: MSG_ID_NVRAM_READ_SM_REQ |
| 327 | *************************************************************/ |
| 328 | typedef struct |
| 329 | { |
| 330 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 331 | LOCAL_PARA_HDR |
| 332 | /* DOM-NOT_FOR_SDK-END */ |
| 333 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 334 | nvram_lid_enum file_idx; /* NVRAM lid index */ |
| 335 | kal_uint16 para; /* record index */ |
| 336 | kal_uint16 rec_amount; /* total record to read */ |
| 337 | kal_uint8 *buffer; /* buffer to fill in data */ |
| 338 | kal_uint32 buf_size; /* buffer size */ |
| 339 | } nvram_read_sm_req_struct; |
| 340 | |
| 341 | /************************************************************* |
| 342 | * <GROUP Local_Parameter_Structure> |
| 343 | * Related Message: MSG_ID_NVRAM_READ_SM_CNF |
| 344 | *************************************************************/ |
| 345 | typedef struct |
| 346 | { |
| 347 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 348 | LOCAL_PARA_HDR |
| 349 | /* DOM-NOT_FOR_SDK-END */ |
| 350 | kal_uint8 access_id; /* app use, no use to NVRAM, same value in requeset primitive*/ |
| 351 | nvram_lid_enum file_idx; /* NVRAM lid index */ |
| 352 | kal_uint16 para; /* record index */ |
| 353 | kal_uint32 length; /* length of data in buffer */ |
| 354 | kal_uint8 result; /* error code */ |
| 355 | } nvram_read_sm_cnf_struct; |
| 356 | |
| 357 | /************************************************************* |
| 358 | * <GROUP Local_Parameter_Structure> |
| 359 | * Related Message: MSG_ID_NVRAM_WRITE_SM_REQ |
| 360 | *************************************************************/ |
| 361 | typedef struct |
| 362 | { |
| 363 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 364 | LOCAL_PARA_HDR |
| 365 | /* DOM-NOT_FOR_SDK-END */ |
| 366 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 367 | nvram_lid_enum file_idx; /* NVRAM lid index */ |
| 368 | kal_uint16 para; /* record index */ |
| 369 | kal_uint8 *buffer; /* buffer to fill in data */ |
| 370 | kal_uint32 buf_size; /* buffer size */ |
| 371 | } nvram_write_sm_req_struct; |
| 372 | |
| 373 | /************************************************************* |
| 374 | * <GROUP Local_Parameter_Structure> |
| 375 | * Related Message: MSG_ID_NVRAM_WRITE_SM_CNF |
| 376 | *************************************************************/ |
| 377 | typedef struct |
| 378 | { |
| 379 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 380 | LOCAL_PARA_HDR |
| 381 | /* DOM-NOT_FOR_SDK-END */ |
| 382 | kal_uint8 access_id; /* app use, no use to NVRAM, same value in requeset primitive*/ |
| 383 | nvram_lid_enum file_idx; /* NVRAM lid index */ |
| 384 | kal_uint16 para; /* record index */ |
| 385 | kal_uint8 result; /* result */ |
| 386 | } nvram_write_sm_cnf_struct; |
| 387 | |
| 388 | /************************************************************* |
| 389 | * <GROUP Local_Parameter_Structure> |
| 390 | * Related Message: MSG_ID_NVRAM_IMAGE_CREATE_REQ |
| 391 | *************************************************************/ |
| 392 | typedef struct |
| 393 | { |
| 394 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 395 | LOCAL_PARA_HDR |
| 396 | /* DOM-NOT_FOR_SDK-END */ |
| 397 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 398 | nvram_image_type_enum image_type; /* Which kind of data need to put into backup partition. |
| 399 | The value is a bitwise exclusive value. |
| 400 | ex: NVRAM_IMAGE_TYPE_CALIBRAT | NVRAM_IMAGE_TYPE_IMEI |
| 401 | ex: NVRAM_IMAGE_TYPE_DEFAULT |
| 402 | if the value is NVRAM_IMAGE_TYPE_EMPTY, the backup partition |
| 403 | would be initialized. */ |
| 404 | } nvram_create_image_req_struct; |
| 405 | |
| 406 | |
| 407 | /************************************************************* |
| 408 | * <GROUP Local_Parameter_Structure> |
| 409 | * Related Message: MSG_ID_NVRAM_IMAGE_CREATE_CNF |
| 410 | *************************************************************/ |
| 411 | typedef struct |
| 412 | { |
| 413 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 414 | LOCAL_PARA_HDR |
| 415 | /* DOM-NOT_FOR_SDK-END */ |
| 416 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 417 | nvram_errno_enum result; /* the result of the requirement */ |
| 418 | } nvram_create_image_cnf_struct; |
| 419 | |
| 420 | /************************************************************* |
| 421 | * <GROUP Local_Parameter_Structure> |
| 422 | * Related Message: MSG_ID_NVRAM_IMAGE_RECOVER_REQ |
| 423 | *************************************************************/ |
| 424 | |
| 425 | typedef struct |
| 426 | { |
| 427 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 428 | LOCAL_PARA_HDR |
| 429 | /* DOM-NOT_FOR_SDK-END */ |
| 430 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 431 | nvram_image_type_enum image_type; /* Which kind of data need to recover |
| 432 | The value is a bitwise exclusive value. |
| 433 | ex: NVRAM_IMAGE_TYPE_CALIBRAT | NVRAM_IMAGE_TYPE_IMEI |
| 434 | ex: NVRAM_IMAGE_TYPE_DEFAULT |
| 435 | The value -- NVRAM_IMAGE_TYPE_EMPTY is no use*/ |
| 436 | |
| 437 | } nvram_recover_image_req_struct; |
| 438 | |
| 439 | |
| 440 | /************************************************************* |
| 441 | * <GROUP Local_Parameter_Structure> |
| 442 | * Related Message: MSG_ID_NVRAM_IMAGE_RECOVER_CNF |
| 443 | *************************************************************/ |
| 444 | |
| 445 | typedef struct |
| 446 | { |
| 447 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 448 | LOCAL_PARA_HDR |
| 449 | /* DOM-NOT_FOR_SDK-END */ |
| 450 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 451 | nvram_errno_enum result; /* the result of the requirement */ |
| 452 | } nvram_recover_image_cnf_struct; |
| 453 | |
| 454 | /************************************************************* |
| 455 | * <GROUP Local_Parameter_Structure> |
| 456 | * Related Message: MSG_ID_NVRAM_IMAGE_VERIFY_REQ |
| 457 | *************************************************************/ |
| 458 | |
| 459 | typedef struct |
| 460 | { |
| 461 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 462 | LOCAL_PARA_HDR |
| 463 | /* DOM-NOT_FOR_SDK-END */ |
| 464 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 465 | nvram_image_type_enum image_type; /* Which kind of data need to verify |
| 466 | The value is a bitwise exclusive value. |
| 467 | ex: NVRAM_IMAGE_TYPE_CALIBRAT | NVRAM_IMAGE_TYPE_IMEI |
| 468 | ex: NVRAM_IMAGE_TYPE_DEFAULT |
| 469 | The value -- NVRAM_IMAGE_TYPE_EMPTY is no use*/ |
| 470 | |
| 471 | kal_bool fast_verify; /* if the parameter is true, only the status of backup |
| 472 | partition would be checked. */ |
| 473 | } nvram_verify_image_req_struct; |
| 474 | |
| 475 | /************************************************************* |
| 476 | * <GROUP Local_Parameter_Structure> |
| 477 | * Related Message: MSG_ID_NVRAM_IMAGE_VERIFY_CNF |
| 478 | *************************************************************/ |
| 479 | |
| 480 | typedef struct |
| 481 | { |
| 482 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 483 | LOCAL_PARA_HDR |
| 484 | /* DOM-NOT_FOR_SDK-END */ |
| 485 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 486 | nvram_errno_enum result; /* the result of the requirement |
| 487 | NVRAM_ERRNO_IMAGE_EMPTY : the image is empty |
| 488 | NVRAM_ERRNO_IMAGE_BROKEN : the image is broken, may power lost during image backup |
| 489 | NVRAM_ERRNO_IMAGE_DATA_NOT_SYNC : the data doesn't synchoronous with NVRAM's*/ |
| 490 | } nvram_verify_image_cnf_struct; |
| 491 | |
| 492 | |
| 493 | /************************************************************* |
| 494 | * <GROUP Local_Parameter_Structure> |
| 495 | * Related Message: MSG_ID_NVRAM_SUSPEND_REQ |
| 496 | *************************************************************/ |
| 497 | typedef struct |
| 498 | { |
| 499 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 500 | LOCAL_PARA_HDR |
| 501 | /* DOM-NOT_FOR_SDK-END */ |
| 502 | kal_uint32 suspend_time; /* 0: suspend forever*/ |
| 503 | } nvram_suspend_req_struct; |
| 504 | |
| 505 | /************************************************************* |
| 506 | * <GROUP Local_Parameter_Structure> |
| 507 | * Related Message: MSG_ID_NVRAM_SUSPEND_CNF |
| 508 | *************************************************************/ |
| 509 | typedef struct |
| 510 | { |
| 511 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 512 | LOCAL_PARA_HDR |
| 513 | /* DOM-NOT_FOR_SDK-END */ |
| 514 | nvram_errno_enum result; |
| 515 | } nvram_suspend_cnf_struct; |
| 516 | |
| 517 | /************************************************************* |
| 518 | * <GROUP Local_Parameter_Structure> |
| 519 | * Related Message: MSG_ID_NVRAM_SDS_REQ |
| 520 | *************************************************************/ |
| 521 | typedef struct |
| 522 | { |
| 523 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 524 | LOCAL_PARA_HDR |
| 525 | /* DOM-NOT_FOR_SDK-END */ |
| 526 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 527 | nvram_sds_access_enum access_mode; /* SDS access mode */ |
| 528 | } nvram_sds_req_struct; |
| 529 | |
| 530 | |
| 531 | /************************************************************* |
| 532 | * <GROUP Local_Parameter_Structure> |
| 533 | * Related Message: |
| 534 | * Related Message: MSG_ID_NVRAM_SDS_CNF |
| 535 | *************************************************************/ |
| 536 | typedef struct |
| 537 | { |
| 538 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 539 | LOCAL_PARA_HDR |
| 540 | /* DOM-NOT_FOR_SDK-END */ |
| 541 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 542 | nvram_errno_enum result; /* the result of the requirement |
| 543 | NVRAM_ERRNO_SUCCESS : access success */ |
| 544 | } nvram_sds_cnf_struct; |
| 545 | |
| 546 | |
| 547 | /************************************************************* |
| 548 | * <GROUP Local_Parameter_Structure> |
| 549 | * Related Message: MSG_ID_NVRAM_BIN_REGION_REQ |
| 550 | *************************************************************/ |
| 551 | typedef struct |
| 552 | { |
| 553 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 554 | LOCAL_PARA_HDR |
| 555 | /* DOM-NOT_FOR_SDK-END */ |
| 556 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 557 | nvram_bin_region_access_enum access_mode; /* SDS access mode */ |
| 558 | } nvram_bin_region_req_struct; |
| 559 | |
| 560 | |
| 561 | /************************************************************* |
| 562 | * <GROUP Local_Parameter_Structure> |
| 563 | * Related Message: MSG_ID_NVRAM_BIN_REGION_CNF |
| 564 | *************************************************************/ |
| 565 | typedef struct |
| 566 | { |
| 567 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 568 | LOCAL_PARA_HDR |
| 569 | /* DOM-NOT_FOR_SDK-END */ |
| 570 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 571 | nvram_errno_enum result; /* the result of the requirement */ |
| 572 | } nvram_bin_region_cnf_struct; |
| 573 | |
| 574 | |
| 575 | /************************************************************* |
| 576 | * <GROUP Local_Parameter_Structure> |
| 577 | * Related Message: MSG_ID_NVRAM_CALLBACK_REQ |
| 578 | *************************************************************/ |
| 579 | typedef struct |
| 580 | { |
| 581 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 582 | LOCAL_PARA_HDR |
| 583 | /* DOM-NOT_FOR_SDK-END */ |
| 584 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 585 | void *cfun_addr; |
| 586 | } nvram_callback_req_struct; |
| 587 | |
| 588 | /* For ELT to Parsing Local Parameter */ |
| 589 | typedef nvram_read_req_struct nvram_reg_notify_req_struct; |
| 590 | typedef nvram_read_req_struct nvram_dereg_notify_req_struct; |
| 591 | |
| 592 | #if defined (__NVRAM_UT_TEST__) |
| 593 | |
| 594 | /************************************************************* |
| 595 | * <GROUP Local_Parameter_Structure> |
| 596 | * Related Message: MSG_ID_NVRAM_TEST_REQ |
| 597 | *************************************************************/ |
| 598 | typedef struct |
| 599 | { |
| 600 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 601 | LOCAL_PARA_HDR |
| 602 | /* DOM-NOT_FOR_SDK-END */ |
| 603 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 604 | kal_uint8 test_case[20]; |
| 605 | kal_uint8 start_test; /*0:do not start test; 1: start test*/ |
| 606 | } nvram_test_req_struct; |
| 607 | |
| 608 | /************************************************************* |
| 609 | * <GROUP Local_Parameter_Structure> |
| 610 | * Related Message: MSG_ID_NVRAM_STRESS_TEST1_REQ |
| 611 | *************************************************************/ |
| 612 | typedef struct |
| 613 | { |
| 614 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 615 | LOCAL_PARA_HDR |
| 616 | /* DOM-NOT_FOR_SDK-END */ |
| 617 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 618 | kal_uint8 start_stress_test1; /*0:do not start test; 1: start test*/ |
| 619 | } nvram_stress_test1_req_struct; |
| 620 | |
| 621 | /************************************************************* |
| 622 | * <GROUP Local_Parameter_Structure> |
| 623 | * Related Message: MSG_ID_NVRAM_STRESS_TEST1_CNF |
| 624 | *************************************************************/ |
| 625 | typedef struct |
| 626 | { |
| 627 | /* DOM-NOT_FOR_SDK-BEGIN */ |
| 628 | LOCAL_PARA_HDR |
| 629 | /* DOM-NOT_FOR_SDK-END */ |
| 630 | kal_uint8 access_id; /* app use, no use to NVRAM, will return in confirm primitive*/ |
| 631 | kal_uint8 stress_test1_result; /*0:fail; 1:success*/ |
| 632 | kal_uint32 total_operation_num; /*if stress_test1_result is 1, this is should be ignore*/ |
| 633 | kal_uint32 fail_operation_num; /*if stress_test1_result is 1, this is should be ignore*/ |
| 634 | } nvram_stress_test1_cnf_struct; |
| 635 | |
| 636 | #endif |
| 637 | |
| 638 | #endif /* NVRAM_STRUCT_H */ |
| 639 | |