diff options
Diffstat (limited to 'rbutil/jztool/README.md')
-rw-r--r-- | rbutil/jztool/README.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/rbutil/jztool/README.md b/rbutil/jztool/README.md new file mode 100644 index 0000000000..6a9b78f8d7 --- /dev/null +++ b/rbutil/jztool/README.md | |||
@@ -0,0 +1,60 @@ | |||
1 | # jztool -- Ingenic device utility & bootloader installer | ||
2 | |||
3 | The `jztool` utility can install, backup, and restore the bootloader on | ||
4 | Rockbox players based on a supported Ingenic SoC. | ||
5 | |||
6 | ## FiiO M3K | ||
7 | |||
8 | To use `jztool` on the FiiO M3K you have to connect the player to your | ||
9 | computer in USB boot mode. | ||
10 | |||
11 | The easiest way to do this is by plugging in the microUSB cable to the M3K | ||
12 | and holding the volume down button while plugging the USB into your computer. | ||
13 | If you entered USB boot mode, the button light will turn on but the LCD will | ||
14 | turn off. | ||
15 | |||
16 | To install or update the Rockbox bootloader on the M3K, use the command | ||
17 | `jztool fiiom3k install`. It is recommended that you take a backup of your | ||
18 | current bootloader so you can restore it in case of any problems. | ||
19 | |||
20 | After any operation finishes, you will have to force a power off of the M3K | ||
21 | by holding down the power button for at least 10 seconds. This must be done | ||
22 | whether the operation succeeds or fails. Just don't power off or unplug the | ||
23 | device in the middle of an operation -- that might make bad things happen. | ||
24 | |||
25 | See `jztool --help` for info. | ||
26 | |||
27 | ## TODO list | ||
28 | |||
29 | ### Add better documentation and logging | ||
30 | |||
31 | There's only a bare minimum of documentation, and logging is sparse, not | ||
32 | really enough to debug problems. | ||
33 | |||
34 | Some of the error messages could be friendlier too. | ||
35 | |||
36 | ### Integration with the Rockbox utility | ||
37 | |||
38 | Adding support to the Rockbox utility should be mostly boilerplate since the | ||
39 | jztool library wraps all the troublesome details. | ||
40 | |||
41 | Getting appropriate privileges to access the USB device is the main issue. | ||
42 | Preferably, the Rockbox utility should not run as root/admin/etc. | ||
43 | |||
44 | - Windows: not sure | ||
45 | - Linux: needs udev rules or root privileges | ||
46 | - Mac: apparently does not need privileges | ||
47 | |||
48 | ### Porting to Windows | ||
49 | |||
50 | Windows wants to see a driver installed before we can access the USB device, | ||
51 | the easiest way to do this is by having the user run Zadig, a 3rd party app | ||
52 | which can install the WinUSB driver. WinUSB itself is from Microsoft and | ||
53 | bundled with Windows. | ||
54 | |||
55 | Zadig's homepage: https://zadig.akeo.ie/ | ||
56 | |||
57 | ### Porting to Mac | ||
58 | |||
59 | According to the libusb wiki, libusb works on Mac without any special setup or | ||
60 | privileges, presumably porting there is easy. | ||