Colour targets: Revert an optimisation from almost 18 months ago that actually turned...
[Rockbox.git] / manual / getting_started / iriver_install.tex
blob97b43db7765a7be87404f6567acc233128f894ce
1 % $Id$ %
3 Installing the bootloader is the trickiest part of the installation.
4 The Rockbox bootloader allows users to boot into either the Rockbox
5 firmware or the \playerman{} firmware. For legal reasons, we cannot distribute
6 the bootloader. Instead, we have developed a program that will patch the
7 Iriver firmware with the Rockbox bootloader. These instructions will explain
8 how to download and patch the Iriver firmware with the Rockbox bootloader
9 and install it on your jukebox.
12 \begin{enumerate}
13 \item Download a supported version of the Iriver firmware for your
14 \playername{} from the Iriver website, links can be found on
15 \wikilink{IriverBoot}.
16 Supported Iriver firmware versions currently include
17 \opt{IRIVER_H100_PAD}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US,
18 1.66EU and 1.66K. Note that the H140 uses the same firmware as the H120;
19 H120 and H140 owners should use the firmware called \fname{ihp\_120.hex}.
20 Likewise, the iHP110 and iHP115 use the same firmware, called
21 \fname{ihp\_100.hex}. Be sure to use the correct firmware file for
22 your player.}
23 \opt{IRIVER_H300_PAD}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.
24 \note{The US \playername{} firmware is not supported and cannot be
25 patched to be used with the bootloader. If you wish to install Rockbox
26 on a US \playername, you must first install a non-US version of the
27 original firmware and then install one of the supported versions patched
28 with the Rockbox bootloader.
29 \warn{Installing non-US firmware on a US \playername{} will
30 permanently remove DRM support from the player.}}
32 If the file that you downloaded is a \fname{.zip} file, use an unzip
33 utility like mentioned in the prerequisites section to extract
34 the \fname{.hex} from the \fname{.zip} file
35 to your desktop. Likewise, if the file that you downloaded is an
36 \fname{.exe} file, double-click on the \fname{.exe} file to extract
37 the \fname{.hex} file to your desktop.
38 When running Linux you should be able extracting \fname{.exe}
39 files using \fname{unzip}.
41 \item Download the firmware patcher \fname{fwpatcher.exe} from
42 \url{http://download.rockbox.org/bootloader/iriver/} and save it to your desktop.
43 \warn{The firmware patcher contains Unicode support, which is not supported by
44 all versions of Windows. If you have difficulty with the firmware patcher, try
45 downloading the alternate firmware patcher \fname{fwpatchernu.exe}, which is
46 built without Unicode support.}
48 \item Go to your desktop and double-click on whichever version of the firmware
49 patcher you downloaded in the prior step.
51 \item In the firmware patcher dialog box, click on the \setting{Browse}
52 button and navigate
53 to the \fname{.hex} file that you previously downloaded to your desktop.
55 \item Click \setting{Patch}. The firmware patcher will patch the
56 original firmware to include the Rockbox bootloader. The \fname{.hex}
57 file on your desktop is now a modified version of the original
58 \fname{.hex} file.
60 \item Turn on your \playerman{} and connect it to your computer via USB.
62 \item Copy or move the modified \fname{.hex} file directly to the root of
63 your \daps{} drive. Do not put it inside a directory on your \dap.
65 \item Disconnect the jukebox from USB. (Be sure to use Windows' ``safely remove
66 hardware'' option.)
67 \warn{Before proceeding further, make sure that your player has a full charge
68 or that it is connected to the power adaptor. Interrupting the next step
69 due to a power failure most likely will brick your \dap{}.}
71 \item Update your \daps{} firmware with the patched bootloader. To do this, turn
72 the jukebox on. Press and hold the
73 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect{} button }%
74 to enter the main menu, and navigate to \setting{General $\rightarrow$ Firmware
75 Upgrade}. Select \setting{Yes} when asked to confirm if you want to upgrade the
76 firmware. The \playerman{} will display a message indicating that the
77 firmware update
78 is in progress. Do \emph{not} interrupt this process. When the
79 firmware update is complete the player will turn itself off. (The update
80 firmware process usually takes a minute or so.)
82 You have now installed the Rockbox bootloader.
83 \end{enumerate}
85 \note{If you install the Rockbox bootloader but do not install the
86 Rockbox firmware the Rockbox bootloader will load the Iriver firmware when the
87 jukebox is turned on.
88 To load the \playerman{} firmware press and hold \ButtonRec{} before
89 powering up the \dap{} until the \playerman{} logo appears.
92 \note{The bootloader has a built-in ``bootloader USB mode''. This function
93 switches to USB mode when the \dap{} is connected to a computer upon
94 power-up. This way you can access the \daps{} hard disk without the need
95 to boot any firmware (which is also useful when your hard disk is
96 damaged). The screen will simply display the text ``bootloader USB mode''.
97 After you disconnect the \dap{} from USB the bootloader will
98 continue booting Rockbox. As in bootloader USB mode the firmware
99 itself has not been loaded this is also a simple way of updating Rockbox.
100 After the disconnect the bootloader will load the updated version of
101 Rockbox.