MPIO HD200 manual - tex files
[kugel-rb.git] / manual / getting_started / installation.tex
blob0bc03d88f4103d4ae64899daf36bd9b2329695cb
1 % $Id$ %
2 \chapter{Installation}\label{sec:installation}
4 Installing Rockbox is generally a quick and easy procedure. However
5 before beginning there are a few things it is important to know.
7 \section{Before Starting}
9 \opt{e200}{\fixme{NOTE: These instructions will not work on the
10 ``Rhapsody'' version of the E200 series (also known as E200R). Please
11 follow the instructions at
12 \url{http://www.rockbox.org/twiki/bin/view/Main/SansaE200RInstallation}.}}
14 \opt{ipodnano,ipodnano2g,ipodvideo,e200,c200,c200v2,e200v2,clipv1,clipv2,cowond2,fuze,fuzev2}{
15 \begin{description}
16 \item[Supported hardware versions.]
17 \opt{ipodnano,ipodnano2g}{
18 The \playertype{} is available in multiple versions, not
19 all of which run Rockbox. Rockbox presently runs only on
20 the first and second generation Ipod Nano. Rockbox does
21 \emph{not} run on the third, fourth or fifth generation Ipod Nano.
22 For information on identifying which Ipod you own, see this page on
23 Apple's website: \url{http://www.info.apple.com/kbnum/n61688}.
25 \opt{ipodvideo}{
26 The \playertype{} is the 5th/5.5th generation \playerman{} only.
27 Rockbox does \emph{not} run on the newer, 6th/Classic generation Ipod.
28 For information on identifying which Ipod you own, see this page on Apple's
29 website: \url{http://www.info.apple.com/kbnum/n61688}.
31 \opt{c200,c200v2,e200,e200v2}{
32 The \playertype{} is available in multiple versions, and you need to make
33 sure which you have by checking the Sandisk firmware version number under
34 Settings $\rightarrow$ Info. The v1 firmware is named 01.xx.xx, while the
35 v2 firmware begins with 03. Make sure that you are following the
36 instructions from the correct manual.
38 \opt{clipv1,clipv2,fuze,fuzev2}{
39 The \playertype{} is available in multiple versions, and you need to make
40 sure which you have by checking the Sandisk firmware version number under
41 Settings $\rightarrow$ \opt{fuze,fuzev2}{System Settings $\rightarrow$}
42 Info. The v1 firmware is named 01.xx.xx, while the v2 firmware begins with
43 02. Make sure that you are following the instructions from the correct
44 manual.
46 \opt{cowond2}{
47 Rockbox runs on all \playerman{} \playertype{} and \playertype{}+ variants
48 (2 / 4 / 8 / 16~GB, with or without DAB/DMB).
49 \note{Newer \playertype{}+ hardware revisions use an updated power
50 management chip, and some functionality is not yet implemented on these
51 players (e.g. touchscreen support).}
53 \end{description}
56 \opt{cowond2}{
57 \begin{description}
58 \item[Current limitations.] Most Rockbox functions are usable on the
59 \playertype{}/\playertype{}+, including music playback and most plugins, but
60 there are a number of shortcomings that prevent it from being a fully
61 supported target:
62 \begin{itemize}
63 \item An SD card is required to use many features, since the internal
64 flash memory is read-only in Rockbox.
65 \warn{The SD driver is still in development and may contain bugs.
66 There have been reports of SD cards becoming unusable after being used
67 with Rockbox on \playerman{} \playertype{}. Only use old, low-capacity
68 cards until we are satisfied the driver is safe to use.\\}
69 \item There is only basic touchscreen support. Further work is
70 required to make the UI more usable with a touchscreen in general.
71 \note{The touchscreen can be used in two modes, either a 3$\times$3 grid mode
72 which divides the screen into areas to emulate a set of physical
73 buttons (the default setting), or ``absolute point'' mode where the
74 touchscreen is used to point to items on the screen.\\}
75 \end{itemize}
76 \end{description}
78 \opt{ondavx777}{
79 \begin{description}
80 \item[Current limitations.] Most Rockbox functions are usable on the
81 \playertype{}, including music playback and most plugins, but
82 there are a number of shortcomings that prevent it from being a fully
83 supported target:
84 \begin{itemize}
85 \item A MicroSD card is required to run Rockbox, since the internal
86 flash memory hasn't been figured out yet.
87 \item There is only basic touchscreen support. Further work is
88 required to make the UI more usable with a touchscreen in general.
89 \note{The touchscreen can be used in two modes, either a 3$\times$3 grid mode
90 which divides the screen into areas to emulate a set of physical
91 buttons (the default setting), or ``absolute point'' mode where the
92 touchscreen is used to point to items on the screen.\\}
93 \end{itemize}
94 \end{description}
96 \opt{h300}{
97 \begin{description}
98 \item[DRM capability.] If your \dap{} has a US firmware, then by installing Rockbox you will
99 \emph{permanently} lose the ability to playback files with DRM.
100 \end{description}
103 \opt{sansaAMS}{
104 \begin{description}
105 \item[DRM capability.] It is possible that installation of the bootloader
106 may lead to you \emph{permanently} losing the ability to playback files
107 with DRM.
108 \end{description}
111 \nopt{gigabeats}{
112 \begin{description}
114 \nopt{ipod1g2g}{
115 \item[USB connection.]
117 \opt{ipod1g2g}{
118 \item[Firewire connection.]
120 To transfer Rockbox to your \dap{} you need to
121 connect it to your computer. For manual installation/uninstallation, or
122 should autodetection fail during automatic installation, you need to know
123 where to access the \dap{}. On Windows this means you need to know
124 the drive letter associated with the \dap{}. On Linux you need to know
125 the mount point of your \dap{}. On Mac OS X you need to know the volume
126 name of your \dap{}.
128 \opt{ipod}{
129 If you have Itunes installed and it is configured to open automatically
130 when your \dap{} is attached (the default behaviour), then wait for it to
131 open and then quit it. You also need to ensure the ``Enable use as disk''
132 option is enabled for your \dap{} in Itunes. Your \dap{} should then enter
133 disk mode automatically when connected to a computer via
134 \nopt{ipod1g2g}{USB.}\opt{ipod1g2g}{Firewire.} If your computer does not
135 recognise your \dap{}, you may need to enter disk mode manually. Disconnect
136 your \dap{} from the computer. Hard reset the \dap{} by pressing and
137 holding the \ButtonMenu{} and \nopt{IPOD_3G_PAD}{\ButtonSelect{}}%
138 \opt{IPOD_3G_PAD}{\ButtonPlay{}} buttons simultaneously. As soon as the
139 \dap{} resets, press and hold the \nopt{IPOD_3G_PAD}{\ButtonSelect{} and
140 \ButtonPlay{}}\opt{IPOD_3G_PAD}{\ButtonLeft{} and \ButtonRight{}} buttons
141 simultaneously. Your \dap{} should enter disk mode and you can try
142 reconnecting to the computer.
144 \opt{iaudiox5}{
145 When instructed to connect/disconnect the USB cable, always use
146 the USB port through the subpack, not the side `USB Host' port. The side port
147 is intended to be used for USB OTG connections only (digital cameras, memory
148 sticks, etc.).
150 \opt{sansa,e200v2,clipv1,clipv2}{
151 \note{The following steps require you to change the setting in
152 \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the
153 original firmware.}
155 \nopt{sansaAMS}{\warn{Never extract files to your \dap{} while it is in recovery mode.}}
158 \opt{fuze,fuzev2,clipplus}{
159 \note{The following steps require you to change the setting in
160 \setting{Settings $\rightarrow$ System Settings $\rightarrow$ USB Mode} to
161 \setting{MSC} from within the original firmware.}
164 \opt{h10,h10_5gb}{
165 The installation requires you to use UMS mode and so
166 may require use of the UMS trick, whereby it is possible to force a MTP
167 \playertype{} to start up in UMS mode as follows:
168 \begin{enumerate}
169 \item Ensure the \dap{} is fully powered off by \opt{h10}{using a pin to
170 push the small reset button inside the hole between the Hold switch and
171 remote control connector.}\opt{h10_5gb}{removing the battery and putting it back in again.}
172 \item Connect your \playertype{} to the computer using the data cable.
173 \item Hold \ButtonRight{} and push \ButtonPower{} to turn the \dap{} on.
174 \item Continue holding \ButtonRight{} until the USB Connected screen appears.
175 \item The \dap{} will now appear as a regular disk on your computer.
176 \end{enumerate}
177 \note{Once Rockbox has been installed, when you shut down your \dap{} from Rockbox it will totally
178 power the player off so step 1 is no longer necessary.}
180 \opt{gigabeatf}{The installation requires you to change a setting in the
181 original firmware. Make sure the option under \setting{Setup
182 $\rightarrow$ Connections $\rightarrow$ PC Connections} is set to
183 \setting{gigabeat room}. Also, during installation, do not connect your
184 \dap{} using the cradle but plug the USB cable directly to the \dap{}.
186 \opt{vibe500}{
187 The installation requires you to use UMS mode.
188 In order to start up your \playertype{} in UMS mode you need to:
189 \begin{enumerate}
190 \item Turn off the \dap{} (Original Firmware).
191 \item Connect your \playertype{} to the computer using the data cable.
192 \item Push and hold \ButtonPower{} (for about 2 seconds) until the ``USB'' screen appears.
193 \end{enumerate}
194 The \dap{} will now appear as a regular disk on your computer.
196 \end{description}
199 \opt{ipod,sansa}{
200 \begin{description}
201 \item[Administrator/Root rights.] Installing the bootloader portion of Rockbox
202 requires you to have administrative (Windows) or root (Linux) rights.
203 Consequently when doing either the automatic or manual bootloader install,
204 please ensure that you are logged in with an administrator account or have root rights.
205 \end{description}
208 \opt{ipod}{
209 \begin{description}
210 \item[File system format.] Rockbox only works on Ipods formatted with
211 the FAT32 filesystem (i.e. Ipods initialised by Itunes
212 for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
213 initialised by Itunes for the Mac). More information and instructions for
214 converting an Ipod to FAT32 can be found on the
215 \wikilink{IpodConversionToFAT32} wiki
216 page on the Rockbox website. Note that after conversion, you can still use
217 a FAT32 Ipod with a Mac.
218 \end{description}
221 \section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation}
222 There are two ways to install Rockbox: automated and manual. The automated
223 way is the preferred method of installing Rockbox for the majority of
224 people. Rockbox Utility is a graphical application that does almost everything
225 for you. However, should you encounter a problem, then the manual way is
226 still available to you.\\
228 \opt{gigabeats}{\note{The automated install is not yet available for the
229 \playerlongtype{}. For now you can use the manual method to install Rockbox.
230 Please still read the section on the automatic install as it explains
231 various important aspects of Rockbox, such as the different versions
232 available.\\}}
234 \opt{hwcodec}{Rockbox itself comes as a single package. There is no need
235 to install additional software to run Rockbox.}
236 \opt{swcodec} {
237 \opt{HAVE_RB_BL_ON_DISK}{There are three separate components,
238 two of which need to be installed in order to run Rockbox:}
239 \opt{HAVE_RB_BL_IN_FLASH}{There are two separate components
240 which need to be installed in order to run Rockbox:}
242 \begin{description}
243 \opt{HAVE_RB_BL_ON_DISK}{
244 \item[The \playerman{} bootloader.]
245 The \playerman{} bootloader is the program that tells your \dap{} how to load
246 and start the original firmware. It is also responsible for any emergency,
247 recovery, or disk modes on your \dap{}. This bootloader is stored in special flash
248 memory in your \playerman{} and comes factory-installed. It is not necessary
249 to modify this in order to install Rockbox.}
251 \item[The Rockbox bootloader.] \index{Bootloader}
252 \opt{HAVE_RB_BL_ON_DISK}{The Rockbox bootloader is loaded from disk by
253 the \playerman{} bootloader. It is responsible for loading the Rockbox
254 firmware and for providing the dual boot function. It directly replaces the
255 \playerman{} firmware in the \daps{} boot sequence.
256 \opt{gigabeatf}{\note{Dual boot does not currently work on the Gigabeat.}}}
258 \opt{HAVE_RB_BL_IN_FLASH}{
259 The bootloader is the program that tells your
260 \dap{} how to load and start other components of Rockbox and for providing
261 the dual boot function. This is the component of Rockbox that is installed
262 to the flash memory of your \playerman.
263 \opt{iaudiom3,iaudiom5,iaudiox5}{\note{Dual boot does not currently work on the \playertype.}}}
265 \item[The Rockbox firmware.]
266 \opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs
267 entirely from flash memory,}
268 \opt{HAVE_RB_BL_ON_DISK}{Similar to the \playerman{} firmware,}
269 most of the Rockbox code is contained in a
270 ``build'' that resides on your \daps{} drive. This makes it easy to
271 update Rockbox. The build consists of a directory called
272 \fname{.rockbox} which contains all of the Rockbox files, and is
273 located in the root of your \daps{} drive.
274 \end{description}
277 \nopt{player} {
278 Apart from the required parts there are some addons you might be interested
279 in installing.
280 \begin{description}
281 \item[Fonts.] Rockbox can load custom fonts. The fonts are
282 distributed as a separate package and thus need to be installed
283 separately. They are not required to run Rockbox itself but
284 a lot of themes require the fonts package to be installed.
286 \item[Themes.] The appearance of Rockbox can be customised by themes. Depending
287 on your taste you might want to install additional themes to change
288 the look of Rockbox.
289 \end{description}
292 \subsection{Automated Installation}
294 To automatically install Rockbox, download the official installer and
295 housekeeping tool \caps{Rockbox Utility}. It allows you to:
296 \begin{itemize}
297 \item Automatically install all needed components for using Rockbox
298 (``Minimal Installation'').
299 \item Automatically install all suggested components (``Complete Installation'').
300 \item Selectively install optional components.
301 \nopt{player}{\item Install additional fonts and themes.}
302 \item Install voice files and generate talk clips.
303 \item Uninstall all components you installed using Rockbox Utility.
304 \end{itemize}
306 Prebuilt binaries for Windows, Linux and Mac OS X are
307 available at the \wikilink{RockboxUtility} wiki page.\\
309 \opt{gigabeats,ondavx777}{\note{Rockbox Utility does not currently support the
310 \playertype{} and you will therefore need to follow the manual install
311 instructions below.\\}}
313 When first starting \caps{Rockbox Utility} run ``Autodetect'',
314 found in the configuration dialog (File $\rightarrow$ Configure). Autodetection
315 can detect most player types. If autodetection fails or is unable to detect
316 the mountpoint, make sure to enter the correct values. The mountpoint indicates
317 the location of the \dap{} in your filesystem. On Windows, this is the drive
318 letter the \dap{} gets assigned, on other systems this is a path in the
319 filesystem.\\*
321 \opt{ipodvideo}
322 {\note{Autodetection is unable to distinguish between the
323 \playerman{} \playertype{} 30~GB and 60/80~GB models and defaults to the
324 30~GB model. This will usually work but you might want to check the
325 detected value, especially if you experience problems with Rockbox.}
328 \opt{h100,h300}{
329 Rockbox Utility will ask you for a compatible copy of the original
330 firmware. This is because for legal reasons we cannot distribute
331 the bootloader directly. Instead, we have to patch the Iriver firmware
332 with the Rockbox bootloader.
334 Download a supported version of the Iriver firmware for your
335 \playername{} from the Iriver website, links can be found on
336 \wikilink{IriverBoot}.
338 Supported Iriver firmware versions currently include
339 \opt{h100}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US,
340 1.66EU and 1.66K. Note that the H140 uses the same firmware as the H120;
341 H120 and H140 owners should use the firmware called \fname{ihp\_120.hex}.
342 Likewise, the iHP110 and iHP115 use the same firmware, called
343 \fname{ihp\_100.hex}. Be sure to use the correct firmware file for
344 your player.}
345 \opt{h300}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.
346 \note{The US \playername{} firmware is not supported and cannot be
347 patched to be used with the bootloader. If you wish to install Rockbox
348 on a US \playername{}, you must first install a non-US version of the
349 original firmware and then install one of the supported versions patched
350 with the Rockbox bootloader.}
351 \warn{Installing a non-US firmware on a US \playername{} will
352 \emph{permanently} remove DRM support from the player.}}
354 If the file that you downloaded is a \fname{.zip} file, use an unzip
355 utility like mentioned in the prerequisites section to extract
356 the \fname{.hex} from the \fname{.zip} file
357 to your desktop. Likewise, if the file that you downloaded is an
358 \fname{.exe} file, double-click on the \fname{.exe} file to extract
359 the \fname{.hex} file to your desktop.
360 When running Linux you should be able to extract \fname{.exe}
361 files using \fname{unzip}.
364 \opt{mpiohd200}{
365 Rockbox Utility will ask you for a compatible copy of the original
366 firmware. This is because for legal reasons we cannot distribute
367 the bootloader directly. Instead, we have to patch the MPIO firmware
368 with the Rockbox bootloader.
370 Download a supported version of the MPIO firmware for your
371 \playername{} from the MPIO website, links can be found on
372 \wikilink{MPIOHD200Port}.
374 \warn{The only tested version of the original firmware is 1.30.05
375 and as such is the only supported version}
377 If the file that you downloaded is a \fname{.zip} file, use an unzip
378 utility like mentioned in the prerequisites section to extract
379 the \fname{.SYS} from the \fname{.zip} file
380 to your desktop. Likewise, if the file that you downloaded is an
381 \fname{.exe} file, double-click on the \fname{.exe} file to extract
382 the \fname{.SYS} file to your desktop.
383 When running Linux you should be able to extract \fname{.exe}
384 files using \fname{unzip}.
387 \subsubsection{Choosing a Rockbox version}\label{sec:choosing_version}
389 There are three different versions of Rockbox available from the
390 Rockbox website:
391 \label{Version}
392 Release version, current build and archived daily build. You need to decide which one
393 you want to install and get the appropriate version for your \dap{}. If you
394 select either ``Minimal Installation'' or ``Complete Installation'' from the
395 ``Quick Start'' tab, then Rockbox Utility will automatically install the
396 release version of Rockbox. Using the ``Installation'' tab will allow you
397 to select which version you wish to install.
399 \begin{description}
401 \item[Release.] The release version is the latest stable release, free
402 of known critical bugs. For a manual install, the current stable release of Rockbox is
403 available at \url{http://www.rockbox.org/download/}.
405 \item[Current Build.] The current build is built at each source code change to
406 the Rockbox SVN repository and represents the current state of Rockbox
407 development. This means that the build could contain bugs but most of
408 the time is safe to use. For a manual install, you can download the current build from
409 \url{http://build.rockbox.org/}.
411 \item[Archived Build.] In addition to the release version and the current build,
412 there is also an archive of daily builds available for download. These are
413 built once a day from the latest source code in the SVN repository. For a manual install,
414 you can download archived builds from \url{http://www.rockbox.org/daily.shtml}.
416 \end{description}
418 \note{Because current and archived builds are development versions that
419 change frequently, they may behave differently than described in this manual,
420 or they may introduce new (and potentially annoying) bugs. Unless you wish to
421 try the latest and greatest features at the price of possibly greater instability,
422 or you wish to help with development, you should stick with the release.\\*}
424 Please now go to \reference{ref:finish_install} to complete the installation procedure.
426 \subsection{Manual Installation}
428 The manual installation method is still available to you, should you need or desire it
429 by following the instructions below. If you have used Rockbox Utility
430 to install Rockbox, then you do not need to follow the next section and can skip
431 straight to \reference{ref:finish_install}
433 \opt{gigabeats}{\subsubsection{Installing the bootloader}
434 \input{getting_started/gigabeats_install.tex}
437 \subsubsection{Installing the firmware}\label{sec:installing_firmware}
439 \opt{gigabeats}{\note{When your \dap{} is in the Rockbox USB or bootloader
440 USB mode, you will see two visible partitions - the 150~MB firmware
441 partition (containing at least a file called \fname{nk.bin}) and
442 the main data partition. Rockbox \emph{must} be installed onto the main
443 data partiton.}}
445 \begin{enumerate}
446 \item Download your chosen version of Rockbox from the links in the
447 previous section.
448 \opt{ipodvideo}{\note{There are separate versions of Rockbox for the 30~GB and
449 60/80~GB \playerman{} \playertype{} models. You must ensure you download the
450 correct version for your \dap{}.}}
452 \item Connect your \dap{} to the computer via USB
453 \opt{sansa,sansaAMS,h10,h10_5gb,vibe500}{ in MSC mode }
454 \opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire }as described in
455 the manual that came with your \dap{}.
457 \item Take the \fname{.zip} file that you downloaded and use
458 the ``Extract all'' command of your unzip program to extract
459 the files onto%
460 \opt{gigabeats}{the main data partition of }
461 \opt{cowond2}{either an SD card or the internal memory of }
462 \opt{ondavx777}{the MicroSD of }
463 your \dap{}.
464 \opt{cowond2}{\note{If you have chosen to extract to the internal memory, it
465 will not be possible to save settings.}}
466 \end{enumerate}
468 \note{The entire contents of the \fname{.zip} file should be extracted
469 directly to the root of your \daps{} drive. Do not try to
470 create a separate directory on your \dap{} for the Rockbox
471 files! The \fname{.zip} file already contains the internal
472 structure that Rockbox needs.\\}
474 \opt{archos}{
475 If the contents of the \fname{.zip} file are extracted correctly, you will
476 have a file called \fname{\firmwarefilename} in the main directory of your
477 \daps{} drive, and also a directory called \fname{.rockbox}, which contains a
478 number of other directories and system files needed by Rockbox.
481 % This has nothing to do with swcodec, just that these players need our own
482 % bootloader so we can decide where we want the main binary.
483 \opt{swcodec}{
484 If the contents of the \fname{.zip} file are extracted correctly, you will
485 have a directory called \fname{.rockbox}, which contains all the files needed
486 by Rockbox, in the main directory of your \daps{} drive.
489 \opt{swcodec}{%
490 \nopt{gigabeats}{%
491 \subsubsection{Installing the bootloader}
492 \opt{h100,h300}{\input{getting_started/iriver_install.tex}}
493 \opt{mpiohd200}{\input{getting_started/mpio_install.tex}}
494 \opt{ipod}{\input{getting_started/ipod_install.tex}}
495 \opt{iaudio}{\input{getting_started/iaudio_install.tex}}
496 \opt{h10,h10_5gb}{\input{getting_started/h10_install.tex}}
497 \opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}}
498 \opt{sansa}{\input{getting_started/sansa_install.tex}}
499 \opt{sansaAMS}{\input{getting_started/sansaAMS_install.tex}}
500 \opt{mrobe100}{\input{getting_started/mrobe100_install.tex}}
501 \opt{cowond2}{\input{getting_started/cowond2_install.tex}}
502 \opt{vibe500}{\input{getting_started/vibe500_install.tex}}
503 \opt{ondavx777}{\input{getting_started/ondavx777_install.tex}}
507 \subsection{Finishing the install}\label{ref:finish_install}
509 \opt{gigabeatf}{
510 After installing you \emph{need} to power-cycle the
511 \dap{} by doing the following steps. Failure to do so may result in problems.
512 \begin{itemize}
513 \item Safely eject / unmount your \dap{} and unplug the USB cable.
514 \item Unplug any power adapter.
515 \item Hold the \ButtonPower{} button to turn off the \dap{}.
516 \item Slide the battery switch located on the bottom of the \dap{} from
517 `on' to `off'.
518 \item Slide the battery switch back from `off' to `on'.
519 \end{itemize}
522 \opt{iaudiom3,iaudiom5,iaudiox5}{
523 After installing you \emph{need} to power-cycle the
524 \dap{} by doing the following steps.
525 \begin{itemize}
526 \item Safely eject / unmount your \dap{} and unplug the USB cable.
527 \item Hold the
528 \opt{IAUDIO_X5_PAD}{\ButtonPower}
529 \opt{IAUDIO_M3_PAD}{\ButtonPlay}
530 button to turn off the \dap{}.
531 \item Insert the charger. The Rockbox bootloader will automatically be flashed.
532 \end{itemize}
535 \opt{h10,h10_5gb,ipod,mrobe100,sansa,archos,sansaAMS,cowond2,vibe500,ondavx777}{
536 Safely eject / unmount the USB drive, unplug the cable and restart.
539 \opt{gigabeats}{
540 Safely eject / unmount your \dap{}.
543 \opt{h100,h300}{
544 \begin{itemize}
545 \item Safely eject / unmount your \dap{}.
547 \item \warn{Before proceeding further, make sure that your player has a full charge
548 or that it is connected to the power adaptor. Interrupting the next step
549 due to a power failure most likely will brick your \dap{}.}
550 Update your \daps{} firmware with the patched bootloader. To do this, turn
551 the jukebox on. Press and hold the \ButtonSelect{} button to enter the main menu,
552 and navigate to \setting{General $\rightarrow$ Firmware Upgrade}. Select
553 \setting{Yes} when asked to confirm if you want to upgrade the
554 firmware. The \playerman{} will display a message indicating that the
555 firmware update is in progress. Do \emph{not} interrupt this process. When the
556 firmware update is complete the player will turn itself off. (The update
557 firmware process usually takes a minute or so.). You are now ready to go.
558 \end{itemize}
560 \opt{mpiohd200}{
561 \begin{itemize}
562 \item Safely eject /unmount your \dap{}.
564 \item \warn{Before proceeding further, make sure that your player has a full charge
565 or that it is connected to the power adaptor. Interrupting the next step
566 due to a power failure most likely will brick your \dap{}.}
567 Update your \daps{} firmware with the patched bootloader. To do this, turn
568 the jukebox on. The update process should start automaticaly. The \playerman{} will
569 display animation indicating that the firmware update is in progress. Do \emph{not}
570 interrupt this process. When the firmware update is complete the player will restart.
571 (The update firmware process usually takes a minute or so.). You are now ready to go.
572 \end{itemize}
574 \opt{e200}{Your e200 will automatically reboot and Rockbox should load.}
578 \subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
579 \index{Speech}\index{Installation!Optional Steps}
580 If you wish to use speech support you will also need a voice file. Voice files
581 allow Rockbox to speak the user interface to you. Rockbox Utility can install
582 an English voice file, or you can download it from \url{http://www.rockbox.org/daily.shtml}
583 and unzip it to the root of your \dap{}.
584 Rockbox Utility can also aid you in the creation of voice files with different voices
585 or in other languages if you have a suitable speech engine installed on your computer.
586 Voice menus are enabled by default and will come
587 into effect after a reboot. See \reference{ref:Voiceconfiguration} for details
588 on voice settings.
589 Rockbox Utility can also aid in the production of talk files, which allow Rockbox
590 to speak file and folder names.
592 \section{Running Rockbox}
593 \nopt{ipod,gigabeats,cowond2}{When
594 you turn the unit on, Rockbox should load.}
595 \opt{ipod}{Hard reset the Ipod by holding
596 \opt{IPOD_4G_PAD}{\ButtonMenu{} and \ButtonSelect{} simultaneously}%
597 \opt{IPOD_3G_PAD}{\ButtonMenu{} and \ButtonPlay{} simultaneously}
598 for a couple of seconds until the \dap{} resets. Now Rockbox should load.
601 \opt{gigabeats}{Rockbox should automatically load when you turn on your player.\\
603 \note{
604 If you have loaded music onto your \dap{} using the \playerman{}
605 firmware, you will not be able to see your music properly in the
606 \setting{File Browser} as MTP mode changes the location and file names.
607 Files placed on your \dap{} using the \playerman{} firmware can be
608 viewed by initialising and using Rockbox's database.
609 See \reference{ref:database} for more information.}
612 \opt{cowond2}{
613 To boot the Rockbox firmware set the \ButtonHold{} switch immediately after
614 power on.\\
615 \note{If you have chosen to install to an SD card and it is inserted at power
616 on, Rockbox will boot from that card and use it as the primary drive for
617 storing settings, etc. If there is no SD card inserted, Rockbox will boot
618 from the internal memory, and it will not be possible to save settings.}
621 \opt{ipod}{
622 \note{
623 If you have loaded music onto your \dap{} using Itunes,
624 you will not be able to see your music properly in the \setting{File Browser}.
625 This is because Itunes changes your files' names and hides them in
626 directories in the \fname{Ipod\_Control} directory. Files placed on your
627 \dap{} using Itunes can be viewed by initialising and using Rockbox's database.
628 See \reference{ref:database} for more information.
632 \opt{iaudiom3}{
633 \fixme{Add a note about the charging trick and place it here?}
636 \section{Updating Rockbox}
637 Rockbox can be easily updated with Rockbox Utility.
638 You can also update Rockbox manually -- download a Rockbox build
639 as detailed above, and unzip the build to the root directory
640 of your \dap{} as in the manual installation stage. If your unzip
641 program asks you whether to overwrite files, choose the ``Yes to all'' option.
642 The new build will be installed over your current build.\\
644 \opt{gigabeats}{
645 \note{When your \dap{} is in the Rockbox USB or bootloader
646 USB mode, you will see two visible partitions, the 150~MB firmware
647 partition (containing at least a file called \fname{nk.bin}) and
648 the main data partition. Rockbox \emph{must} be installed onto the main
649 data partiton.\\}
652 \nopt{hwcodec}{
653 The bootloader only changes rarely, and should not normally
654 need to be updated.\\
657 \note{If you use Rockbox Utility be aware that it cannot detect manually
658 installed components.}
660 \section{Uninstalling Rockbox}\index{Installation!uninstall}
662 \nopt{gigabeatf,iaudiom3,iaudiom5,iaudiox5,archos,mrobe100,gigabeats}{
663 \note{The Rockbox bootloader allows you to choose between Rockbox and
664 the original firmware. (See \reference{ref:Dualboot} for more information.)}
667 \subsection{Automatic Uninstallation}
668 \opt{gigabeats}{\note{Rockbox can only be uninstalled manually for now.}}
670 You can uninstall Rockbox automatically by using Rockbox Utility. If you
671 installed Rockbox manually you can still use Rockbox Utility for uninstallation
672 but will not be able to do this selectively.
674 \opt{h100,h300}{\note{Rockbox Utility cannot uninstall the bootloader due to
675 the fact that it requires a flashing procedure. To uninstall the bootloader
676 completely follow the manual uninstallation instructions below.}}
678 \subsection{Manual Uninstallation}
680 \opt{archos}{
681 If you would like to go back to using the original \playerman{} software,
682 connect the \dap{} to your computer, and delete the
683 \fname{\firmwarefilename} file.
686 \opt{h10,h10_5gb}{
687 If you would like to go back to using the original \playerman{} software,
688 connect the \dap{} to your computer, and delete the
689 \opt{h10}{\fname{H10\_20GC.mi4}}\opt{h10_5gb}{\fname{H10.mi4}} file and rename
690 \fname{OF.mi4} to \opt{h10}{\fname{H10\_20GC.mi4}}\opt{h10_5gb}{\fname{H10.mi4}}
691 in the \fname{System} directory on your \playertype{}. As in the installation,
692 it may be necessary to first put your device into UMS mode.
695 \opt{vibe500}{
696 If you would like to go back to using the original \playerman{} software,
697 connect the \dap{} to your computer, and delete the
698 \fname{jukebox.mi4} file and rename
699 \fname{OF.mi4} to \fname{JUKEBOX.mi4}
700 in the \fname{System} directory on your \playertype{}. As in the installation,
701 it may be necessary to first put your device into UMS mode.
704 \opt{mrobe100}{
705 If you would like to go back to using the original \playerman{} software,
706 connect the \dap{} to your computer, and delete the
707 \fname{pp5020.mi4} file and rename
708 \fname{OF.mi4} to \fname{pp5020.mi4}
709 in the \fname{System} directory on your \playertype{}.
712 \opt{e200}{
713 If you would like to go back to using the original \playerman{} software,
714 connect the \dap{} to your computer, and follow the instructions to install
715 the bootloader, but when prompted by sansapatcher, enter \texttt{u} for uninstall,
716 instead of \texttt{i} for install. As in the installation, it may be necessary to
717 first put your \dap{} into MSC mode.
720 \optv{ipod}{
721 To uninstall Rockbox and go back to using just the original Ipod software, connect
722 the \dap{} to your computer and follow the instructions to install
723 the bootloader but, when prompted by ipodpatcher, enter \texttt{u} for uninstall
724 instead of \texttt{i} for install.
727 \opt{iaudiom3,iaudiom5,iaudiox5}{
728 If you would like to go back to using the original \playerman{} software,
729 connect the \dap{} to your computer, download the original \playername{}
730 firmware from the \playerman{} website, and copy it to the \fname{FIRMWARE}
731 directory on your \playername{}. Turn off the \dap{}, remove the USB cable
732 and insert the charger. The original firmware will automatically be flashed.
735 \opt{h100,h300}{
736 If you want to remove the Rockbox bootloader, simply flash an unpatched
737 \playerman{} firmware. Be aware that doing so will also remove the bootloader
738 USB mode. As that mode can come in quite handy (especially if you experience
739 disk errors) it is recommended to keep the bootloader. It also
740 gives you the possibility of trying Rockbox anytime later by simply
741 installing the distribution files.
742 \opt{h100}{
743 The Rockbox bootloader will automatically start the original firmware if
744 the \fname{.rockbox} directory has been deleted.
746 \opt{h300}{
747 Although if you retain the Rockbox bootloader, you will need to hold the
748 \ButtonRec{} button each time you want to start the original firmware.
752 \opt{sansaAMS}{
753 Copy an unmodified original firmware to your player and update it.
756 \opt{mpiohd200}{
757 If you want to remove the Rockbox bootloader, simply flash an unpatched
758 \playerman{} firmware.
761 \nopt{gigabeats}{
762 If you wish to clean up your disk, you may also wish to delete the
763 \fname{.rockbox} directory and its contents.
764 \nopt{iaudiom3,iaudiom5,iaudiox5}{Turn the \playerman{} off.
765 Turn the \dap{} back on and the original \playerman{} software will load.}
768 \opt{gigabeats}{
769 If you wish to clean up your disk by deleting the
770 \fname{.rockbox} directory and its contents, this must be done
771 before uninstalling the bootloader in the next step.
773 Before installation you should have downloaded a copy of the \playerman{}
774 firmware from
775 \url{http://www.tacp.toshiba.com/tacpassets-images/firmware/MESV12US.zip}.
776 \begin{itemize}
777 \item Extract \fname{MES12US.iso} from the \fname{.zip} downloaded above.
778 \item There are two files within \fname{MES12US.iso} called
779 \fname{Autorun.inf} and \fname{gbs\_update\_1\_2\_us.exe}. Extract them with
780 your favourite unzipping utility e.g. 7zip.
781 \item Connect your \dap{} to your computer.
782 \item Extract \fname{nk.bin} from within
783 \fname{gbs\_update\_1\_2\_us.exe} using e.g. 7zip and copy it to the 150~MB
784 firmware partition of your \dap{}.
785 \item Safely eject / unmount the USB drive, unplug the cable and restart.
786 \end{itemize}
788 \note{From Windows, you can also run \fname{gbs\_update\_1\_2\_us.exe}
789 directly to restore your \dap{}. This will format your \dap{},
790 removing all files.}
793 \section{Troubleshooting}
794 \begin{description}
795 \opt{sansa,ipod}{
796 \item[Bootloader install problems]
797 If you have trouble installing the bootloader,
798 please ensure that you are either logged in as an administrator (Windows), or
799 you have root rights (Linux)}
801 \opt{h100,h300}{
802 \item[Immediately loading original firmware.]
803 If the original firmware is immediately
804 loaded without the Rockbox bootloader appearing first, then the Rockbox bootloader
805 has not been correctly installed. The original firmware update will only perform
806 the update if the filename is correct, including case. Make sure that the patched
807 Iriver firmware is called \fname{.hex}.}
809 \nopt{h100,h300,mpiohd200}{\item[``File Not Found'']}
810 \opt{h100,h300,mpiohd200}{\item[``-1 error'']}
811 If you receive a
812 \nopt{h100,h300,mpiohd200}{``File Not Found''}
813 \opt{h100,h300,mpiohd200}{``-1 error''}
814 from the bootloader, then the bootloader cannot find the Rockbox firmware.
815 This is usually a result of not extracting the contents of the \fname{.zip}
816 file to the proper location, and should not happen when Rockbox has been
817 installed with Rockbox Utility.
819 To fix this, either install Rockbox with the Rockbox Utility which will take care
820 of this for you, or recheck the Manual Install section to see where the files
821 need to be located.
822 \end{description}
824 \optv{gigabeats}{
825 If this does not fix the problem, there are two additional procedures that you
826 can try to solve this:
828 \begin{itemize}
829 \item Formatting the storage partition. It is possible that using the
830 mkdosfs utility from Linux to format the data partition from your PC
831 before installing will resolve this problem. The appropriate format command is:
832 \begin{code}
833 mkdosfs -f 2 -F 32 -S 512 -s 64 -v -n TFAT /path/to/partition/device
834 \end{code}
835 \warn{This will remove all your files.}
837 \item Copying a \fname{tar}. If you have a Rockbox build environment
838 then you can try generating \fname{rockbox.tar} instead of
839 \fname{rockbox.zip} as follows:
840 \begin{code}
841 make tar
842 \end{code}
843 and copying it to the data partition. During the next boot, the bootloader
844 will extract it.
845 \end{itemize}