nvram_defs.h
15.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
/*****************************************************************************
* Copyright Statement:
* --------------------
* This software is protected by Copyright and the information contained
* herein is confidential. The software may not be copied and the information
* contained herein may not be used or disclosed except with the written
* permission of MediaTek Inc. (C) 2005
*
* BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
* AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
* NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
* SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
* SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
* THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
* NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
* SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
* BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
* LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
* AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
* OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
* MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
* THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
* WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
* LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
* RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
* THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/
/*******************************************************************************
* Filename:
* ---------
* nvram_defs.h
*
* Project:
* --------
* MT6208
*
* Description:
* ------------
* This file contains definitions used by NVRAM task.
*
* Author:
* -------
* -------
*
*==============================================================================
* HISTORY
* Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
*------------------------------------------------------------------------------
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
*------------------------------------------------------------------------------
* Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
*==============================================================================
*******************************************************************************/
#ifndef NVRAM_DEFS_H
#define NVRAM_DEFS_H
#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */
#include "kal_general_types.h"
/***************************************************************
* Macro and Definition used for lid table
**********************************************************************/
/*****************************************************************************
* Include
****************************************************************************/
#include "nvram_lid_statistics.h"
#include "nvram_enums.h"
//***************************************************************************
// -- Custpack configuration --
//***************************************************************************
#ifdef __MULTIPLE_BINARY_FILES__
#if !defined(__L1_STANDALONE__)
#define __NVRAM_SUPPORT_CUSTPACK__
#endif
#endif
/*****************************************************************************
* Define
****************************************************************************/
#define FILE_PREFIX_LEN 4
#define FILE_VERNO_LEN 3
#define NVRAM_FILE_LEN (FILE_PREFIX_LEN + 1 + FILE_VERNO_LEN)
#define NVRAM_MAX_DESC_LEN 20
#define NVRAM_EF_RESERVED_LID 0xFFFE
#define VER_LID(lid) lid##_VERNO lid
#ifndef NVRAM_AUTO_GEN
#define VER(lid) lid##_VERNO
#else
#define VER(lid) lid##_VERNO,#lid
#endif
#define NVRAM_EF_ZERO_DEFAULT_ZIP NVRAM_EF_ZERO_DEFAULT
#define NVRAM_EF_FF_DEFAULT_ZIP NVRAM_EF_FF_DEFAULT
#ifndef NVRAM_AUTO_GEN
#define NVRAM_NORMAL(X) (kal_uint8 const *)X
#define NVRAM_NORMAL_NOT_GEN(X) (kal_uint8 const *)X
#if !defined(__NVRAM_SUPPORT_CUSTPACK__) && !defined(__L1_STANDALONE__)
#define NVRAM_CUSTPACK(X) NVRAM_NORMAL(X)
#else
#define NVRAM_CUSTPACK(X) NVRAM_EF_ZERO_DEFAULT
#endif /* __MMI_FMI__ */
#define NVRAM_SECUPACK(X) NVRAM_EF_ZERO_DEFAULT
#define NVRAM_DEFAULT_FUNC(X) (kal_uint8 const*)X
#else
#define NVRAM_NORMAL(X) #X, (kal_uint8 const *)X
#define NVRAM_NORMAL_NOT_GEN(X) #X,NVRAM_EF_ZERO_DEFAULT
#define NVRAM_CUSTPACK(X) #X,NVRAM_EF_ZERO_DEFAULT
#define NVRAM_SECUPACK(X) #X,(kal_uint8 const *)X
#define NVRAM_DEFAULT_FUNC(X) #X,NVRAM_EF_ZERO_DEFAULT
#endif
#define NVRAM_LOCK_PATTERN_LOCKED "_NVRAM__YES_"
#define NVRAM_LOCK_PATTERN_UNLOCKED " _NVRAM__NO_"
#define NVRAM_CHKSUM_SIZE sizeof(kal_uint16)
/* AES 16 byte alignment, must be power of 2*/
#define NVRAM_MSP_ALIGNMENT 16
#define NVRAM_MSP_ALIGNMENT_REMAINDER(x) ((~(x) + 1) & (NVRAM_MSP_ALIGNMENT - 1))
#define NVRAM_MSP_ALIGNMENT_FLOOR(x) ((x) & (~(NVRAM_MSP_ALIGNMENT-1)))
#define NVRAM_MSP_ALIGNMENT_CEILING(x) (((x) + NVRAM_MSP_ALIGNMENT - 1) & ~(NVRAM_MSP_ALIGNMENT-1))
#define NVRAM_MSP_DECRYPT 0
#define NVRAM_MSP_ENCRYPT 1
#define NVRAM_APP_RESERVED 0
/* Attributes of a Logical Data Item, predefined. */
typedef kal_uint16 nvram_attr_enum;
#define NVRAM_ATTR_AVERAGE 0x0000
#define NVRAM_ATTR_MULTI_DEFAULT 0x0001
#define NVRAM_ATTR_WRITEPROTECT 0x0002
#define NVRAM_ATTR_MULTIPLE 0x0004
#define NVRAM_ATTR_CONFIDENTIAL 0x0008
#define NVRAM_ATTR_MULTIREC_READ 0x0010
#define NVRAM_ATTR_MSP 0x0020 /* Protected by MTK Secure Platform */
#define NVRAM_ATTR_SW_VERNO_RESET 0x0040
#define NVRAM_ATTR_FACTORY_RESET 0x0080
#define NVRAM_ATTR_RING 0x0100
#define NVRAM_ATTR_PACKAGE 0x0200 /* NVRAM Reserved.LID will package in file */
#define NVRAM_ATTR_BACKUP_FAT 0x0400 /* Put a copy into backup partition, and the format is FAT */
#define NVRAM_ATTR_BACKUP_RAW 0x0800 /* Put a copy into backup partition, and the format is Raw data */
#define NVRAM_ATTR_ZIP_DEFAULT 0x1000 /* Nvram default value will be compressed,
the original default value must be wrapped by NVRAM_AUTO_GEN */
#define NVRAM_ATTR_NOT_ZIP_DEFAULT 0x2000
#define NVRAM_ATTR_COMMITTED 0x4000 /* Add for SP, add FS_COMMITTED while opening file */
#define NVRAM_ATTR_AUTO_RECOVER 0x8000 /* Add for SP, auto-recover while there is error in the file */
#define NVRAM_ATTR_ALL 0xFFFF
typedef kal_uint32 nvram_category_enum;
/*
* byte 0: NVRAM internal or Not
*/
#define NVRAM_CATEGORY_USER 0x0000
#define NVRAM_CATEGORY_INTERNAL 0x0001
/*
* byte 1: storage information
*/
#define NVRAM_CATEGORY_BACKUP_SDS 0x0010
#define NVRAM_CATEGORY_OTP 0x0020
#define NVRAM_CATEGORY_CUSTOM_DISK 0x0040 /* Used by custom, it means the data is put into another partition */
/* Used by custom, NVRAM will put custom's sensitive data into another folder
if multiple folder feature turn on. Attribute of the data item in this category
must with NVRAM_ATTR_CONFIDENTIAL | NVRAM_ATTR_MULTIPLE */
#define NVRAM_CATEGORY_CUSTOM_SENSITIVE 0x0080
/*
* byte 2: default value information
*/
#define NVRAM_CATEGORY_CUSTPACK 0x0100
#define NVRAM_CATEGORY_SECUPACK 0x0200
#define NVRAM_CATEGORY_FUNC_DEFAULT 0x0400
/*
* byte 3: factory tool/Smartphone Nvram related information
*/
#if (defined(CURR_MODULE) && (CURR_MODULE == MOD_NVRAM)) || defined(NVRAM_AUTO_GEN) || defined(NVRAM_LID_SPLIT)
#define NVRAM_CATEGORY_CALIBRAT 0x1000
#define NVRAM_CATEGORY_IMPORTANT 0x2000
#define NVRAM_CATEGORY_IMPORTANT_L4 0x4000
#else
#define NVRAM_CATEGORY_CALIBRAT "NVRAM_CATEGORY_CALIBRAT is not able to use here! Please contact META tool owner for help."
#define NVRAM_CATEGORY_IMPORTANT "NVRAM_CATEGORY_IMPORTANT is not able to use here! Please contact META tool owner for help."
#define NVRAM_CATEGORY_IMPORTANT_L4 "NVRAM_CATEGORY_IMPORTANT_L4 is not able to use here! Please contact META tool owner for help."
#endif
#define NVRAM_CATEGORY_ALL 0xFFFF
typedef enum
{
NVRAM_CLEAN_FOLDER_NONE = 0x00,
NVRAM_CLEAN_FOLDER_SYSTEM = 0x01, //custom_nvram_config.c
NVRAM_CLEAN_FOLDER_FACTORY = 0x02,
NVRAM_CLEAN_FOLDER_BRANCH = 0x04,
NVRAM_CLEAN_FOLDER_ALL = 0xFF
} nvram_clean_folder_enum;
/*****************************************************************************
* Typedef
****************************************************************************/
typedef void (*nvram_query_deault_func)(nvram_lid_enum file_id, kal_uint8 *buffer, kal_uint16 buffer_size);
#ifndef NVRAM_AUTO_GEN
#ifdef __MTK_TARGET__
typedef struct
#else
typedef struct __declspec(align(32))
#endif
{
nvram_lid_enum LID; /* Logical Data Item ID, U16 */
kal_uint16 total_records; /* Number of records */
kal_uint32 size; /* Size of one record. < sizeof(control buffer) */
kal_uint8 const* default_value; /* Hardcoded default */
nvram_category_enum category; /* U32 */
nvram_attr_enum attr; /* U16 */
kal_char fileprefix[FILE_PREFIX_LEN + 1];
kal_char fileverno[FILE_VERNO_LEN + 1];
kal_char* description;
} nvram_ltable_entry_struct;
#else
typedef struct
{
nvram_lid_enum LID;
kal_uint16 total_records;
kal_uint32 size;
kal_char* str_default_value;
kal_uint8 const* default_value;
nvram_category_enum category;
nvram_attr_enum attr;
kal_char fileprefix[FILE_PREFIX_LEN + 1];
kal_char fileverno[FILE_VERNO_LEN + 1];
kal_char* str_LID;
kal_char* description;
} nvram_ltable_entry_struct;
#endif
typedef struct
{
nvram_ltable_entry_struct *ltable;
kal_uint32 size;
}nvram_ltable_tbl_struct;
#ifdef NVRAM_AUTO_GEN
#define SYS_CACHE_ENTRY(ENUM_ID, APP_ID, RESTORE, DESCRIPTION, VALUE1, VALUE2, VALUE3, VALUE4, VALUE5, VALUE6, VALUE7, VALUE8) \
{ \
ENUM_ID, \
APP_ID, \
RESTORE, \
VALUE1, \
VALUE2, \
VALUE3, \
VALUE4, \
VALUE5, \
VALUE6, \
VALUE7, \
VALUE8, \
#ENUM_ID, \
#APP_ID, \
#VALUE1, \
#VALUE2, \
#VALUE3, \
#VALUE4, \
#VALUE5, \
#VALUE6, \
#VALUE7, \
#VALUE8, \
DESCRIPTION \
}
typedef struct
{
kal_uint16 id; /* nvram_sys_cache_enum */
nvram_app_id_enum app_id; /* nvram_restore_app_id_enum */
kal_bool restore;
kal_uint8 value1;
kal_uint8 value2;
kal_uint8 value3;
kal_uint8 value4;
kal_uint8 value5;
kal_uint8 value6;
kal_uint8 value7;
kal_uint8 value8;
kal_char *id_str;
kal_char *app_id_str;
kal_char *value1_str;
kal_char *value2_str;
kal_char *value3_str;
kal_char *value4_str;
kal_char *value5_str;
kal_char *value6_str;
kal_char *value7_str;
kal_char *value8_str;
kal_char *description;
} nvram_sys_cache_entry;
#endif
#if defined(NVRAM_AUTO_GEN)
#define ltable_entry_struct nvram_ltable_entry_struct __attribute__((aligned(4))) __attribute__((__section__("_nvram_ltable")))
#define NVRAM_LIG_GRP_INIT(X)
#elif defined(__MTK_TARGET__)
#define ltable_entry_struct nvram_ltable_entry_struct __attribute__((section("_nvram_ltable")))
#define NVRAM_LIG_GRP_INIT(X) {\
extern nvram_ltable_entry_struct X##[];\
void *X##_p = (void *)&X;\
}
#else
#define ltable_entry_struct __pragma(section("_nvram_ltable_content")) \
nvram_ltable_entry_struct __declspec(allocate("_nvram_ltable_content"))
#define NVRAM_LIG_GRP_INIT(X) extern nvram_ltable_entry_struct X##[];\
static void *X##_p = (void *)&X;
#endif
#ifndef NVRAM_CUSTPACK_TOTAL
#define NVRAM_CUSTPACK_TOTAL 1
#endif
typedef struct
{
kal_uint8 const* version;
void const* custpack_default[NVRAM_CUSTPACK_TOTAL];
}custpack_nvram_header;
typedef struct
{
nvram_clean_folder_enum category;
kal_wchar *folder_path;
} nvram_clean_folder_entry;
typedef struct
{
nvram_lid_enum LID;
kal_bool (*get_data)(kal_uint8 *buffer, kal_uint16 buf_size);
}nvram_shutdown_cb_struct;
typedef struct
{
nvram_lid_enum LID;
kal_uint32 size; /* Size of one record. < sizeof(control buffer) */
kal_uint16 total_records; /* Number of records */
kal_uint8 const *default_value;
kal_bool is_multi_default;
} nvram_cat_replace_setting;
/*****************************************************************************
* Global Function
****************************************************************************/
extern const kal_uint8 NVRAM_EF_ZERO_DEFAULT[];
extern const kal_uint8 NVRAM_EF_FF_DEFAULT[];
#ifdef __cplusplus
}
#endif
#endif /* NVRAM_DEFS_H */