Table Of ContentMediaTek ConfidentialB
Y
L
N
L
O
A
I
E
T
S
N
U
E
m
D
I o
Rev 2.0 January 17, 2011
F c
.
N
e
YuSu NvRam Customer Document
l
O
i
b
The Improvement in Android 2.2 or later
C
o
m
K
o
E
n
T
n
A
i
t
I
@
D
E i
l
.
M
u
y
©2010-2011MediaTek Inc.
This document contains information that is proprietary to MediaTek Inc.
R
Unauthorized reproduction or disclosure of this information in whole or in part is strictly prohibited.
O
Specifications are subject to change without notice.
F
Revision 2.0 Page 1 4/20/2011
MediaTek ConfidentialB
Y
L
Table of Contents
N
L
Rev 1.0 January 17, 2011.......................................................................................................1
O
Table of Contents..........................................................................................A.........................................2
1. Introduction...................................................................................................................................4
I
E
1.1 Software/Hardware Environment.................................................................................................4
T
1.1.1 Software Environment.................................................................................................4
S
1.1.2 Hardware Environment................................................................................................4
N
1.2 Improvement in Android 2.2................................................................U........................................4
1.3 Related Patch..............................................................................................................................4
E
2. Improvement in Android 2.2............................................................ ...............................................5
m
2.1 NvRam Backup to Bin Region.............................D.......................................................................5
2.1.1 The customization of Bin Region.................................................................................5
2.1.2 The customization of tool for Bin RIegion............o.........................................................6
2.2NvRam Data Table....................................F....................c..............................................................7
2.3NvRam Data Compatibility..........................................................................................................7
.
N
3 Update to W1048mpV2 or later......................................e..................................................................10
l
O
i
b
C
o
m
K
o
E
n
T
n
A
i
t
I
@
D
E i
l
.
M
u
y
R
O
F
Revision 2.0 Page 2 4/20/2011
MediaTek ConfidentialB
Y
Revision History
L
Revision Author Date Description
N
1.0 Jason Zhang 2011/ 01/ 17 Initial draft L
2.0 Jason Zhang 2011/ 03 / 31 Add the content of bin region O
A
I
E
T
S
N
U
E
m
D
I o
F c
.
N
e
l
O
i
b
C
o
m
K
o
E
n
T
n
A
i
t
I
@
D
E i
l
.
M
u
y
R
O
F
Revision 2.0 Page 3 4/20/2011
MediaTek ConfidentialB
Y
L
1. Introduction
N
L
1.1 Software/Hardware Environment
O
A
1.1.1 Software Environment
I
E
NvRam Driver discussed in this document is designed based on Android 2.2or later ,which is
T
improved on the nvram driver of Android 2.1.The NvRam driver is based on the NAND flash driver,
S
and Linux YAFFS2 file system. With these two functionalities supNports, NvRAM mechanism can
provide Linux device driver or user space services to access the data in NvRUam storage. If you want
to get the detailed info aboutnvram module, please refer to tEhe YuSu NvRam Driver Document.
1.1.2 Hardware Environment D m
Driver discussed in this document canberun on the devicewith MT6516and MT6573 chip only.
I o
1.2 Improvement in Android 2.2 F c
.
N
In order to meet the need of protecting nvram data and eenhancing the compatibility of nvram data
between loads with different version, the improvement has been provided based on Android 2.2
l
O
(MT6516: W1048mpV2). i
(1) NvRam backup to bin region b
C
NvRam has added a bin region to backup and restore nvram data.
o
(2) NvRam data table
In order to support some new feature, mnvram has changed the data structure.
K
(3) NvRam data compatibility
It will help customer to update looad from old version to new version , and the old nvram data
E
can be used in the new load after converting if need.
n
T
n
1.3 Related Patch
A
i
t
MT6516:ALPS00138674, ALPS00029539
I
(48MP V2or earlier)
@
D
MT6573: The feature has been supported.
E i
l
.
M
u
y
R
O
F
Revision 2.0 Page 4 4/20/2011
MediaTek ConfidentialB
Y
L
2. Improvement in Android 2.2
N
L
2.1 NvRam Backup to Bin Region
O
A
Since W1048mpV2(MT6516), NvRam has added a bin region to backup and restore nvram data,
in order to re-construct nvram when clean boot. So there are two spaces for nvra m to store date:
I
E
NvRam region (with YAFFS), and Bin region(without YAFFS). NvRam region is placed in Data
T
partition ,and the bin region is NvRam partition of 48MPV2 or earlier.
S
N
U
NvRam Partition
E
m
D
I o
F c
Read/Write in this region
.
N
e
l
When module reads or writes data, theOdata is stored in nvram region. However, this region will be
i
cleared when clean boot, or will be broken becauseb of some File System error. So some important
data, such as IMEI, WIFI Mac addCress and so on, should be backed up to bin region after
o
calibration in product line,or when system updates from oneversion to another version.
There are two occasions to re store data fromm bin region: factory reset, or the clean boot flag has
been checked to be true when Ksystem boots. This clean boot flag is used to notify target that this is
the first time for system to boot. And the user data partition will be cleared during the procedure of
o
factor reset ,so the contenEt of nvram will be lost. The nvram module is able to check this situation
happened or not . and then restore danta from bin region to nvram. If you find the RF calibration data
is lost after factory reseTt even the procedure of restoring has been finished , please contact with MTK
n
to get the Modem patch of MAUI_02866518.
A
i
2.1.1 The customizationt of Bin Region
I
In order to support the@ customization of backup to bin region, a kind of data structure has been
D
defined in /mtk/src/custom/common/cgen/CFG_file_info.c:
FileName aBackupToBinRegion[]=
E i
{
l
{“FILE_VER”.,},
M
u
{“BT_Addr”,},
{“WIFI”,},
y
{“AUXADC”,},
{“FACTORY”,},
R
{“BWCS”,},
{“HWMON_ACC”,},
O
{“WIFI_CUSTOM”,},
{“GPS”,},
F
}
Revision 2.0 Page 5 4/20/2011
MediaTek ConfidentialB
Y
If a kind of new data needs to be backed up to bin region, the file name should be added in this
L
table.
N
2.1.2 The customization of tool for Bin Region L
The procedure of backing up to bin region should be called by tool with meta.dll of Omediatek. In
A
this DLL, the interface function of backing up to bin region has been provided for customization of
tool , and then custom can back up data to bin region.
I
E
The interface function provided by meta.dll is as below:
T
S
Definition:
N
META_RESULT __stdcall SP_META_Clean_Boot(unsigned int ms_tiUmeout);
META_RESULT __stdcall SP_META_Clean_Boot_r(int meta_handle,unsigned int ms_timeout);
E
Description:
This function will backup Nvram data to Bin region, and then semt clean boot flag as true.
D
Return Value:
Return Value Description I o
META_SUCCESS Success
F c
Other error code Other error messages please use META_GetErrorString to translate the
meaning. .
N
e
Parameter:
Parameter Description l
O
i
meta_handle IN Handle of META_DLL that return from
b
META_GetAvailableHandle().
C
ms_timeout IN Timeout valueo, unit = minisecond
m
SN writer of mediatek ,which is used to write IMEI into phone ,has been added the function of
K
backing up data.
o
E
n
T
n
A
i
t
I
@
D
E i
l
.
M
u
y
R
O
F
Revision 2.0 Page 6 4/20/2011
MediaTek ConfidentialB
Y
2.2 NvRam Data Table
L
In Android 2.1,a kind of data table, which is of the type TCFG_FILE, is used to manage the files in
N
the NvRam storage. It provides the file path name, file version number, record size, record numbers,
L
and it’s default values.
O
A
typedef struct
{ I
E
char cFileName[FILENAMELENGTH]; //file name
T
char cFileVer[FILEVERLENGTH]; //nvram file version information
S
int i4RecSize; //record size N
int i4RecNum; //record total U
FILE_DEFAULT_TYPE stDefualType; //the typEe of default value
char *pDefualtVaule; //the defualt value.
m
} TCFG_FILE; D
Since W1048mpV2, the data table has been Ichanged in oorder to support the new feature:
compatibility between loads of different version . Two Items have been added in the definition of
F c
TCFG_FILE: bDataProcessingType and NVM_DataConvertFunc. And the new definition is as below:
.
typedef struct N
e
{
l
char cFileName[FILENAMELENGOTH]; //file name
i
char cFileVer[FILEVERLENGTH]; //nbvram file version information
int i4RecSize; C//record size
int i4RecNum; //recorod total
FILE_DEFAULT_TYPE stD efualTypem; //the type of default value
char *pDefualtVaule;K //the defualt value.
Int bDataProcessingType; //type of processing when version not match
o
pfConvertFunc; E //Data-convert function
} TCFG_FILE; n
T
n
The value of bDataProcessingType is DataReset/DataConvert. The meaning of “DataReset” is to
reset data using deAfault value wihen version info of the data doesn’t match, and “DataConvert” is to
convert nvram old data basetd on the data-convert function provided by module when version not
match. The datIa-convert fun ction is described in the next section.
@
D
2.3 NvERam Daita Compatibility
l
When update l.oad from one version to another , the feature of nvram data compatibility can keep
M
u
nvram compatible with different load. The most important part of data compatibility is the data-convert
function.
y
Data-convert function is of the format as below:
R
Int XXXX_ConverFunction(int CurrentVerID,int NewVerID,char*pSrcMem,char*pDstMem)
O
If the data-convert function works successfully (data has been converted based on the old and new
nvram data structure), this function returns “1”, else returns “0”. The parameter of CurrentVerID is the
F
data version info of current load, and the parameter of NewVerID is the data version of target load,
Revision 2.0 Page 7 4/20/2011
MediaTek ConfidentialB
Y
which is the load updated to. The parameters of pSrcMem and pDstMem are the memory buffer which
L
nvram module allocates for data-convertion. The size of the buffer is enough for data-convert function
to use. pSrcMem is used to store the data need to be processed, and the pDstMem is the buffer
N
where the data that has been processed is stored. L
O
We take a data for example: A
This data is of the original data structure and original default value as below:
I
E
typedef struct{ T
Unsigned int added; S
} ap_nvram_added_config_struct; N
U
ap_nvram_added_config_struct stAddedDefaultE=
{
m
0x1111, D
};
I o
And then we modify the data value in order to simFulate the caclibration procedure.
.
N
e
l
O
i
b
C
o
m
K
o
E
n
T
n
A
i
t
I
@
D
The data version is assumed to be updated. the data structure and the default value are as the
below: E i
l
tyMpedef stru.ct{
u
unsigned int added;
uynsigned int added1;
} ap_nvram_added_config_struct;
ap_nvrRam_added_config_struct stAddedDefault=
{
O 0x1111,
0x3333,
};
F
Revision 2.0 Page 8 4/20/2011
MediaTek ConfidentialB
Y
Of course, the modified data should be saved when data converts, and the new item should use the
L
default value. So the result of data-convert is as below:
N
L
O
A
I
E
T
S
N
U
E
m
D
I o
F c
.
N
e
l
O
i
b
C
o
m
K
o
E
n
T
n
A
i
t
I
@
D
E i
l
.
M
u
y
R
O
F
Revision 2.0 Page 9 4/20/2011
MediaTek ConfidentialB
Y
L
3 Update to W1048mpV2 or later
N
L
Because bin region has been added, nvram data should be backup when update. In order to keep the
O
procedure of updating easy ,there are two ways for custom to update systeAm: Flash Tool Update and
SD Update. The detailed information about these update tools can be gotten from Flash Tool Update
SOP and SD update SOP documents. I
E
Note: This part is used on MT6516 platform, and may be changed onT MT6573.
S
N
U
E
m
D
I o
F c
.
N
e
l
O
i
b
C
o
m
K
o
E
n
T
n
A
i
t
I
@
D
E i
l
.
M
u
y
R
O
F
Revision 2.0 Page 10 4/20/2011
