Add the Lua scripting language plugin to the manual.
[kugel-rb/myfork.git] / rbutil / mkamsboot / README
blob53f1fba9b9e3f58c06b85dbc3220cde70e410de7
1 mkamsboot
2 ---------
4 A tool to inject a bootloader into a Sansa V2 (AMS) firmware file.
7 Usage
8 -----
10 mkamsboot <firmware file> <boot file> <output file>
12 <firmware file> is an original Sansa firmware file obtained from the Sansa
13     forums for example : http://forums.sandisk.com/sansa/?category.id=devices
15 <boot file> is the code you want to execute (a rockbox bootloader), previously
16     scrambled with tools/scramble utility.
18 <output file> is the resulting firmware file which you'll have to copy on your
19     Sansa player. See "Firmware filenames".
22 Supported models
23 ----------------
25 Sansa Clip  :   firmware version starting with "01."
26 Sansa Clipv2:   firmware version starting with "02."
27 Sansa Fuze  :   firmware version starting with "01."
28 Sansa E200v2:   firmware version starting with "03."
29 Sansa C200v2:   firmware version starting with "03."
30 Sansa M200v4:   firmware version starting with "4."
33 Firmware filenames
34 ------------------
36 For the firmware upgrade to happen, the firmware has to be named specially:
38 clip v2 :   m30pa.bin
39 clip    :   m300a.bin
40 fuze    :   fuzea.bin
41 e200v2  :   e200pa.bin
42 c200v2  :   c200pa.bin
43 m200v4  :   m200a.bin
46 Dual-Boot
47 ---------
49   The purpose of this program is to provide dual-boot between the original
50 firmware and the new (rockbox) firmware.
52   By default the player will boot into the new firmware.
54   To boot into the Original Firmware, you need to press the Left key.
55   ***Note : on the c200v2 you need to press the Right key.
57   The player will boot into the Original Firmware as well if it is powered up by
58 inserting an usb cable.
59   ***Note : on the m200v4 powering up by usb will cause booting into the new
60 firmware
62 Hacking
63 -------
65 See comments in mkamsboot.c and dualboot/dualboot.S for more information.