diff options
Diffstat (limited to 'utils/nwztools/scripts/README')
-rw-r--r-- | utils/nwztools/scripts/README | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/utils/nwztools/scripts/README b/utils/nwztools/scripts/README new file mode 100644 index 0000000000..e103647bd6 --- /dev/null +++ b/utils/nwztools/scripts/README | |||
@@ -0,0 +1,59 @@ | |||
1 | This directory contains various scripts that can be used to help development | ||
2 | process on the Sony NWZ players. The proper way to use it is to use the Makefile. | ||
3 | |||
4 | In case of doubt, run | ||
5 | make | ||
6 | to get the up-to-date documentation. | ||
7 | |||
8 | ***************************** | ||
9 | Performing a firmware upgrade | ||
10 | ***************************** | ||
11 | |||
12 | To perform a firmware upgrade, first copy the firmware upgrade file to the root of | ||
13 | the device, and make sure its named | ||
14 | NW_WM_FW.UPG | ||
15 | Another other name WILL NOT WORK. You've been warned. | ||
16 | |||
17 | DO NOT FORGET TO UNMOUNT YOUR DEVICE PROPERLY BEFORE DOING WHAT FOLLOWS | ||
18 | |||
19 | Once once, you need to tell the device to reboot in firmware upgrade mode. | ||
20 | At the moment, we only support this operation in UMS/MSC (Mass Storage) mode. So if | ||
21 | your device appears as a MTP device, go to the preference settings of your device | ||
22 | and make sure your device is set to UMS/MSC or Auto. | ||
23 | You need to identify the linux device associated with your device. There are | ||
24 | plenty of tutorials on the net on how to do that, you can use mount or dmesg. | ||
25 | Assuming the linux device corresponding to your player is | ||
26 | /dev/sdx | ||
27 | run AS ROOT OR USING SUDO | ||
28 | make do_fw_upgrade NWZ_DEV=/dev/sdx | ||
29 | |||
30 | If everything goes well, the device should reboot and perform the firmware upgrade. | ||
31 | |||
32 | ******************************** | ||
33 | Building a firmware upgrade that | ||
34 | dumps important stuff | ||
35 | ******************************** | ||
36 | |||
37 | In early development stage, the most useful thing you can do is to dump important | ||
38 | stuff from your device: | ||
39 | - dmesg and mount output | ||
40 | - FU (firmware upgrade) initrd | ||
41 | - root FS (file system) | ||
42 | We carefully wrote a script that does the following. First make sure that your device | ||
43 | has enough free space (at least 300MB to be safe). You need to know the model of | ||
44 | your device to build this firmware upgrade. Once you known it, run | ||
45 | make list_targets | ||
46 | to list all available targets. For example if your targets is one of the | ||
47 | NWZ-E460 series, the corresponding target is nwz-e46x. | ||
48 | Once you have identified the target. Run | ||
49 | make dump_rootfs NWZ_TARGET=nwz-exyz | ||
50 | (replace nwz-exyz with your target) | ||
51 | This command will produce a firmware upgrade file called | ||
52 | dump_rootfs.upg | ||
53 | |||
54 | In order to run this firmware upgrade, you need to follows the instruction | ||
55 | on how to perform a firmware upgrade. | ||
56 | |||
57 | When performing the firmware upgrade, the script will perform various operation | ||
58 | and create several files. Once the "upgrade" is finish and the device has rebooted, | ||
59 | you should find the files in the dump_rootfs/ directory at the root of your device. | ||