Rewrite dircache generation to take advantage for the FAT code. Reduce RAM usage...
[kugel-rb.git] / manual / getting_started / installation.tex
blob826189fe4de65b523aed684308ceb83326adbc6d
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,e200v2,clip,cowond2,fuze}{
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}{
32 The \playertype{} is available in multiple versions, not
33 all of which run Rockbox. Rockbox doesn't run on the
34 newer v2 models. They can be identified
35 by checking the Sandisk firmware version number under
36 Settings $\rightarrow$ Info. The v1
37 firmware is named 01.xx.xx, while the v2 firmware begins with 03.
39 \opt{e200,e200v2}{
40 The \playertype{} is available in multiple versions, and you need to make
41 sure which you have by checking the Sandisk firmware version number under
42 Settings $\rightarrow$ Info. The v1 firmware is named 01.xx.xx, while the
43 v2 firmware begins with 03. Make sure that you are following the
44 instructions from the correct manual.
46 \opt{clip}{
47 The \playertype{} is available in multiple versions, not all of which
48 run Rockbox. Rockbox doesn't run on the newer v2 models. They can be
49 identified by checking the Sandisk firmware version number under
50 Settings $\rightarrow$ System Info. The v1 firmware is named 01.xx.xx,
51 while the v2 firmware begins with 02. In addition, Rockbox does not
52 run on the Clip+.
54 \opt{fuze}{
55 The \playertype{} is available in multiple versions, not all of which
56 run Rockbox. Rockbox doesn't run on the newer v2 models. They can be
57 identified by checking the Sandisk firmware version number under
58 System Settings $\rightarrow$ System Info. The v1 firmware is named
59 01.xx.xx, while the v2 firmware begins with 02.
61 \opt{cowond2}{
62 Rockbox runs on all \playerman{} \playertype{} and \playertype{}+ variants
63 (2 / 4 / 8 / 16GB, with or without DAB/DMB).
64 \note{Newer \playertype{}+ hardware revisions use an updated power
65 management chip, and some functionality is not yet implemented on these
66 players (e.g. touchscreen support).}
68 \end{description}
71 \opt{cowond2}{
72 \begin{description}
73 \item[Current limitations.] Most Rockbox functions are usable on the
74 \playertype{}/\playertype{}+, including music playback and most plugins, but
75 there are a number of shortcomings that prevent it from being a fully
76 supported target:
77 \begin{itemize}
78 \item An SD card is required to use many features, since the internal
79 flash memory is read-only in Rockbox.
80 \warn{The SD driver is still in development and may contain bugs.
81 There have been reports of SD cards becoming unusable after being used
82 with Rockbox on \playerman{} \playertype{}. Only use old, low-capacity
83 cards until we are satisfied the driver is safe to use.\\}
84 \item There is only basic touchscreen support. Further work is
85 required to make the UI more usable with a touchscreen in general.
86 \note{The touchscreen can be used in two modes, either a 3x3 grid mode
87 which divides the screen into areas to emulate a set of physical
88 buttons (the default setting), or ``absolute point'' mode where the
89 touchscreen is used to point to items on the screen.\\}
90 \end{itemize}
91 \end{description}
93 \opt{h300}{
94 \begin{description}
95 \item[DRM capability.] If your \dap{} has a US firmware, then by installing Rockbox you will
96 \emph{permanently} lose the ability to playback files with DRM.
97 \end{description}
100 \opt{sansaAMS}{
101 \begin{description}
102 \item[DRM capability.] It is possible that installation of the bootloader
103 may lead to you \emph{permanently} losing the ability to playback files
104 with DRM.
105 \end{description}
108 \nopt{gigabeats}{
109 \begin{description}
111 \nopt{ipod1g2g}{
112 \item[USB connection.]
114 \opt{ipod1g2g}{
115 \item[Firewire connection.]
117 To transfer Rockbox to your \dap{} you need to
118 connect it to your computer. For manual installation/uninstallation, or
119 should autodetection fail during automatic installation, you need to know
120 where to access the \dap{}. On Windows this means you need to know
121 the drive letter associated with the \dap{}. On Linux you need to know
122 the mount point of your \dap{}. On Mac OS X you need to know the volume
123 name of your \dap{}.
125 \opt{ipod}{
126 If you have Itunes installed and it is configured to open automatically
127 when your \dap{} is attached (the default behaviour),
128 then wait for it to open and then quit it. You
129 also need to ensure the ``Enable use as disk'' option is enabled for
130 your \dap{} in Itunes. Your \dap{} should then enter disk mode
131 automatically when connected to a computer via \nopt{ipod1g2g}{USB.}\opt{ipod1g2g}{Firewire.}
132 If your computer does not recognise your \dap{}, you may
133 need to enter disk mode manually. Disconnect your \dap{} from the
134 computer. Hard reset the \dap{} by pressing and holding the \ButtonMenu{} and
135 \ButtonSelect{} buttons simultaneously. As soon as the \dap{} resets, press
136 and hold the \ButtonSelect{} and \ButtonPlay{} buttons simultaneously. Your
137 \dap{} should enter disk mode and you can try reconnecting to the computer.
139 \opt{x5}{
140 When instructed to connect/disconnect the USB cable, always use
141 the USB port through the subpack, not the side 'USB Host' port. The side port
142 is intended to be used for USB OTG connections only (digital cameras, memory
143 sticks, etc.).
145 \opt{sansa,e200v2,clip}{
146 \note{The following steps require you to change the setting in
147 \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the
148 original firmware.}
150 \nopt{sansaAMS}{\warn{Never extract files to your \dap{} while it is in recovery mode.}}
152 \opt{h10,h10_5gb}{
153 The installation requires you to use UMS mode and so
154 may require use of the UMS trick, whereby it is possible to force a MTP
155 \playertype{} to start up in UMS mode as follows:
156 \begin{enumerate}
157 \item Ensure the \dap{} is fully powered off by \opt{h10}{using a pin to
158 push the small reset button inside the hole between the Hold switch and
159 remote control connector.}\opt{h10_5gb}{removing the battery and putting it back in again.}
160 \item Connect your \playertype{} to the computer using the data cable.
161 \item Hold \ButtonRight{} and push \ButtonPower{} to turn the \dap{} on.
162 \item Continue holding \ButtonRight{} until the USB Connected screen appears.
163 \item The \dap{} will now appear as a regular disk on your computer.
164 \end{enumerate}
165 \note{Once Rockbox has been installed, when you shut down your \dap{} from Rockbox it will totally
166 power the player off so step 1 is no longer necessary.}
168 \opt{gigabeatf}{During installation, do not connect your \dap{}
169 using the cradle but plug the USB cable directly to the \dap{}.
171 \end{description}
174 \opt{ipod,sansa}{
175 \begin{description}
176 \item[Administrator/Root rights.] Installing the bootloader portion of Rockbox
177 requires you to have administrative (Windows) or root (Linux) rights.
178 Consequently when doing either the automatic or manual bootloader install,
179 please ensure that you are logged in with an administrator account or have root rights.
180 \end{description}
183 \opt{ipod}{
184 \begin{description}
185 \item[File system format.] Rockbox only works on Ipods formatted with
186 the FAT32 filesystem (i.e. Ipods initialised by Itunes
187 for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
188 initialised by Itunes for the Mac). More information and instructions for
189 converting an Ipod to FAT32 can be found on the
190 \wikilink{IpodConversionToFAT32} wiki
191 page on the Rockbox website. Note that after conversion, you can still use
192 a FAT32 Ipod with a Mac.
193 \end{description}
196 \section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation}
197 There are two ways to install Rockbox: automated and manual. The automated
198 way is the preferred method of installing Rockbox for the majority of
199 people. Rockbox Utility is a graphical application that does almost everything
200 for you. However, should you encounter a problem, then the manual way is
201 still available to you.\\
203 \opt{gigabeats}{\note{The automated install is not yet available for the
204 \playerlongtype{}. For now you can use the manual method to install Rockbox.
205 Please still read the section on the automatic install as it explains
206 various important aspects of Rockbox, such as the different versions
207 available.\\}}
209 \opt{hwcodec}{Rockbox itself comes as a single package. There is no need
210 to install additional software to run Rockbox.}
211 \opt{swcodec} {
212 \opt{HAVE_RB_BL_ON_DISK}{There are three separate components,
213 two of which need to be installed in order to run Rockbox:}
214 \opt{HAVE_RB_BL_IN_FLASH}{There are two separate components
215 which need to be installed in order to run Rockbox:}
217 \begin{description}
218 \opt{HAVE_RB_BL_ON_DISK}{
219 \item[The \playerman{} bootloader.]
220 The \playerman{} bootloader is the program that tells your \dap{} how to load
221 and start the original firmware. It is also responsible for any emergency,
222 recovery, or disk modes on your \dap{}. This bootloader is stored in special flash
223 memory in your \playerman{} and comes factory-installed. It is not necessary
224 to modify this in order to install Rockbox.}
226 \item[The Rockbox bootloader.] \index{Bootloader}
227 \opt{HAVE_RB_BL_ON_DISK}{The Rockbox bootloader is loaded from disk by
228 the \playerman{} bootloader. It is responsible for loading the Rockbox
229 firmware and for providing the dual boot function. It directly replaces the
230 \playerman{} firmware in the \daps{} boot sequence.
231 \opt{gigabeatf}{\note{Dual boot does not currently work on the Gigabeat.}}}
233 \opt{HAVE_RB_BL_IN_FLASH}{
234 The bootloader is the program that tells your
235 \dap{} how to load and start other components of Rockbox and for providing
236 the dual boot function. This is the component of Rockbox that is installed
237 to the flash memory of your \playerman.
238 \opt{iaudio}{\note{Dual boot does not currently work on the \playertype{}.}}}
240 \item[The Rockbox firmware.]
241 \opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs
242 entirely from flash memory,}
243 \opt{HAVE_RB_BL_ON_DISK}{Similar to the \playerman{} firmware,}
244 most of the Rockbox code is contained in a
245 ``build'' that resides on your \daps{} drive. This makes it easy to
246 update Rockbox. The build consists of a directory called
247 \fname{.rockbox} which contains all of the Rockbox files, and is
248 located in the root of your \daps{} drive.
250 \end{description}
253 \nopt{player} {
254 Apart from the required parts there are some addons you might be interested
255 in installing.
256 \begin{description}
257 \item[Fonts.] Rockbox can load custom fonts. The fonts are
258 distributed as a separate package and thus need to be installed
259 separately. They are not required to run Rockbox itself but
260 a lot of themes require the fonts package to be installed.
262 \item[Themes.] The appearance of Rockbox can be customised by themes. Depending
263 on your taste you might want to install additional themes to change
264 the look of Rockbox.
265 \end{description}
268 \subsection{Automated Installation}
270 To automatically install Rockbox, download the official installer and
271 housekeeping tool \caps{Rockbox Utility}. It allows you to:
272 \begin{itemize}
273 \item Automatically install all needed components for using Rockbox
274 (``Minimal Installation'').
275 \item Automatically install all suggested components (``Complete Installation'').
276 \item Selectively install optional components.
277 \nopt{player}{\item Install additional fonts and themes.}
278 \item Install voice files and generate talk clips.
279 \item Uninstall all components you installed using Rockbox Utility.
280 \end{itemize}
282 Prebuilt binaries for Windows, Linux and Mac OS X are
283 available at the \wikilink{RockboxUtility} wiki page.\\
285 \opt{gigabeats,clip}{\note{Rockbox Utility does not currently support the
286 \playertype{} and you will therefore need to follow the manual install
287 instructions below.\\}}
289 When first starting \caps{Rockbox Utility} run ``Autodetect'',
290 found in the configuration dialog (File $\rightarrow$ Configure). Autodetection
291 can detect most player types. If autodetection fails or is unable to detect
292 the mountpoint, make sure to enter the correct values. The mountpoint indicates
293 the location of the \dap{} in your filesystem. On Windows, this is the drive
294 letter the \dap{} gets assigned, on other systems this is a path in the
295 filesystem.\\*
297 \opt{ipodvideo}
298 {\note{Autodetection is unable to distinguish between the
299 \playerman{} 30~GB and 60~GB / 80~GB models and defaults to the
300 30~GB model. This will usually work but you might want to check the
301 detected value, especially if you experience problems with Rockbox.}
304 \opt{h100,h300}{
305 Rockbox Utility will ask you for a compatible copy of the original
306 firmware. This is because for legal reasons we cannot distribute
307 the bootloader directly. Instead, we have to patch the Iriver firmware
308 with the Rockbox bootloader.
310 Download a supported version of the Iriver firmware for your
311 \playername{} from the Iriver website, links can be found on
312 \wikilink{IriverBoot}.
314 Supported Iriver firmware versions currently include
315 \opt{h100}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US,
316 1.66EU and 1.66K. Note that the H140 uses the same firmware as the H120;
317 H120 and H140 owners should use the firmware called \fname{ihp\_120.hex}.
318 Likewise, the iHP110 and iHP115 use the same firmware, called
319 \fname{ihp\_100.hex}. Be sure to use the correct firmware file for
320 your player.}
321 \opt{h300}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.
322 \note{The US \playername{} firmware is not supported and cannot be
323 patched to be used with the bootloader. If you wish to install Rockbox
324 on a US \playername{}, you must first install a non-US version of the
325 original firmware and then install one of the supported versions patched
326 with the Rockbox bootloader.}
327 \warn{Installing a non-US firmware on a US \playername{} will
328 \emph{permanently} remove DRM support from the player.}}
330 If the file that you downloaded is a \fname{.zip} file, use an unzip
331 utility like mentioned in the prerequisites section to extract
332 the \fname{.hex} from the \fname{.zip} file
333 to your desktop. Likewise, if the file that you downloaded is an
334 \fname{.exe} file, double-click on the \fname{.exe} file to extract
335 the \fname{.hex} file to your desktop.
336 When running Linux you should be able to extract \fname{.exe}
337 files using \fname{unzip}.
340 \subsubsection{Choosing a Rockbox version}\label{sec:choosing_version}
342 There are three different versions of Rockbox available from the
343 Rockbox website:
344 \label{Version}
345 Release version, current build and archived daily build. You need to decide which one
346 you want to install and get the appropriate version for your \dap{}. If you
347 select either ``Minimal Installation'' or ``Complete Installation'' from the
348 ``Quick Start'' tab, then Rockbox Utility will automatically install the
349 release version of Rockbox. Using the ``Installation'' tab will allow you
350 to select which version you wish to install.
352 \begin{description}
354 \item[Release.] The release version is the latest stable release, free
355 of known critical bugs. For a manual install, the current stable release of Rockbox is
356 available at \url{http://www.rockbox.org/download/}.
358 \item[Current Build.] The current build is built at each source code change to
359 the Rockbox SVN repository and represents the current state of Rockbox
360 development. This means that the build could contain bugs but most of
361 the time is safe to use. For a manual install, you can download the current build from
362 \url{http://build.rockbox.org/}.
364 \item[Archived Build.] In addition to the release version and the current build,
365 there is also an archive of daily builds available for download. These are
366 built once a day from the latest source code in the SVN repository. For a manual install,
367 you can download archived builds from \url{http://www.rockbox.org/daily.shtml}.
369 \end{description}
371 \note{Because current and archived builds are development versions that
372 change frequently, they may behave differently than described in this manual,
373 or they may introduce new (and potentially annoying) bugs. Unless you wish to
374 try the latest and greatest features at the price of possibly greater instability,
375 or you wish to help with development, you should stick with the release.\\*}
377 Please now go to \reference{ref:finish_install} to complete the installation procedure.
379 \subsection{Manual Installation}
381 The manual installation method is still available to you, should you need or desire it
382 by following the instructions below. If you have used Rockbox Utility
383 to install Rockbox, then you do not need to follow the next section and can skip
384 straight to \reference{ref:finish_install}
386 \opt{gigabeats}{\subsubsection{Installing the bootloader}
387 \input{getting_started/gigabeats_install.tex}
390 \subsubsection{Installing the firmware}\label{sec:installing_firmware}
392 \opt{gigabeats}{\note{When your \dap{} is in the Rockbox USB or bootloader
393 USB mode, you will see two visible partitions - the 150MB firmware
394 partition (containing at least a file called \fname{nk.bin}) and
395 the main data partition. Rockbox \emph{must} be installed onto the main
396 data partiton.}}
398 \begin{enumerate}
399 \item Download your chosen version of Rockbox from the links in the
400 previous section.
401 \opt{ipodvideo}{\note{There are separate versions of Rockbox for the 30GB and
402 60GB/80GB models. You must ensure you download the correct version for your
403 \dap{}.}}
405 \item Connect your \dap{} to the computer via USB
406 \opt{sansa,sansaAMS,h10,h10_5gb}{ in MSC mode }
407 \opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire }as described in
408 the manual that came with your \dap{}.
410 \item Take the \fname{.zip} file that you downloaded and use
411 the ``Extract all'' command of your unzip program to extract
412 the files onto%
413 \opt{gigabeats}{the main data partition of }
414 \opt{cowond2}{either an SD card or the internal memory of }
415 your \dap{}.
416 \opt{cowond2}{\note{If you have chosen to extract to the internal memory, it
417 will not be possible to save settings.}}
418 \end{enumerate}
420 \note{The entire contents of the \fname{.zip} file should be extracted
421 directly to the root of your \daps{} drive. Do not try to
422 create a separate directory on your \dap{} for the Rockbox
423 files! The \fname{.zip} file already contains the internal
424 structure that Rockbox needs.\\}
426 \opt{archos}{
427 If the contents of the \fname{.zip} file are extracted correctly, you will
428 have a file called \fname{\firmwarefilename} in the main directory of your
429 \daps{} drive, and also a directory called \fname{.rockbox}, which contains a
430 number of other directories and system files needed by Rockbox.
433 % This has nothing to do with swcodec, just that these players need our own
434 % bootloader so we can decide where we want the main binary.
435 \opt{swcodec}{
436 If the contents of the \fname{.zip} file are extracted correctly, you will
437 have a directory called \fname{.rockbox}, which contains all the files needed
438 by Rockbox, in the main directory of your \daps{} drive.
441 \opt{swcodec}{\nopt{gigabeats}{
442 \subsubsection{Installing the bootloader}
443 \opt{h100,h300}{\input{getting_started/iriver_install.tex}}
444 \opt{ipod}{\input{getting_started/ipod_install.tex}}
445 \opt{m3,m5,x5}{\input{getting_started/iaudio_install.tex}}
446 \opt{h10,h10_5gb}{\input{getting_started/h10_install.tex}}
447 \opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}}
448 \opt{sansa}{\input{getting_started/sansa_install.tex}}
449 \opt{sansaAMS}{\input{getting_started/sansaAMS_install.tex}}
450 \opt{mrobe100}{\input{getting_started/mrobe100_install.tex}}
451 \opt{cowond2}{\input{getting_started/cowond2_install.tex}}
454 \subsection{Finishing the install}\label{ref:finish_install}
456 \opt{gigabeatf}{
457 After installing you \emph{need} to power-cycle the
458 \dap{} by doing the following steps. Failure to do so may result in problems.
459 \begin{itemize}
460 \item Safely eject / unmount your \dap{} and unplug the USB cable.
461 \item Unplug any power adapter.
462 \item Hold the \ButtonPower{} button to turn off the \dap{}.
463 \item Slide the battery switch located on the bottom of the \dap{} from
464 `on' to `off'.
465 \item Slide the battery switch back from `off' to `on'.
466 \end{itemize}
469 \opt{m3,m5,x5}{
470 After installing you \emph{need} to power-cycle the
471 \dap{} by doing the following steps.
472 \begin{itemize}
473 \item Safely eject / unmount your \dap{} and unplug the USB cable.
474 \item Hold the
475 \opt{IAUDIO_X5_PAD}{\ButtonPower}
476 \opt{IAUDIO_M3_PAD}{\ButtonPlay}
477 button to turn off the \dap{}.
478 \item Insert the charger. The Rockbox bootloader will automatically be flashed.
479 \end{itemize}
482 \opt{h10,h10_5gb,ipod,mrobe100,sansa,archos,sansaAMS,cowond2}{
483 Safely eject / unmount the USB drive, unplug the cable and restart.
486 \opt{gigabeats}{
487 Safely eject / unmount your \dap{}.
490 \opt{h100,h300}{
491 \begin{itemize}
492 \item Safely eject / unmount your \dap{}.
494 \item \warn{Before proceeding further, make sure that your player has a full charge
495 or that it is connected to the power adaptor. Interrupting the next step
496 due to a power failure most likely will brick your \dap{}.}
497 Update your \daps{} firmware with the patched bootloader. To do this, turn
498 the jukebox on. Press and hold the \ButtonSelect{} button to enter the main menu,
499 and navigate to \setting{General $\rightarrow$ Firmware Upgrade}. Select
500 \setting{Yes} when asked to confirm if you want to upgrade the
501 firmware. The \playerman{} will display a message indicating that the
502 firmware update is in progress. Do \emph{not} interrupt this process. When the
503 firmware update is complete the player will turn itself off. (The update
504 firmware process usually takes a minute or so.). You are now ready to go.
505 \end{itemize}
508 \opt{e200}{Your e200 will automatically reboot and Rockbox should load.}
512 \subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
513 \index{Speech}\index{Installation!Optional Steps}
514 If you wish to use speech support you will also need a voice file. Voice files
515 allow Rockbox to speak the user interface to you. Rockbox Utility can install
516 an English voice file, or you can download it from \url{http://www.rockbox.org/daily.shtml}
517 and unzip it to the root of your \dap{}.
518 Rockbox Utility can also aid you in the creation of voice files with different voices
519 or in other languages if you have a suitable speech engine installed on your computer.
520 Voice menus are enabled by default and will come
521 into effect after a reboot. See \reference{ref:Voiceconfiguration} for details
522 on voice settings.
523 Rockbox Utility can also aid in the production of talk files, which allow Rockbox
524 to speak file and folder names.
526 \section{Running Rockbox}
527 \nopt{ipod,gigabeats,cowond2}{When
528 you turn the unit on, Rockbox should load.}
529 \opt{ipod}{Hard reset the Ipod by holding
530 \opt{IPOD_4G_PAD}{\ButtonMenu{}+\ButtonSelect{}}%
531 \opt{IPOD_3G_PAD}{\ButtonMenu{}+\ButtonPlay{}}
532 for a couple of seconds until the \dap{} resets. Now Rockbox should load.
535 \opt{gigabeats}{Rockbox should automatically load when you turn on your player.\\
537 \note{
538 If you have loaded music onto your \dap{} using the \playerman{}
539 firmware, you will not be able to see your music properly in the
540 \setting{File Browser} as MTP mode changes the location and file names.
541 Files placed on your \dap{} using the \playerman{} firmware can be
542 viewed by initialising and using Rockbox's database.
543 See \reference{ref:database} for more information.}
546 \opt{cowond2}{
547 To boot the Rockbox firmware set the \ButtonHold{} switch immediately after
548 power on.\\
549 \note{If you have chosen to install to an SD card and it is inserted at power
550 on, Rockbox will boot from that card and use it as the primary drive for
551 storing settings, etc. If there is no SD card inserted, Rockbox will boot
552 from the internal memory, and it will not be possible to save settings.}
555 \opt{ipod}{
556 \note{
557 If you have loaded music onto your \dap{} using Itunes,
558 you will not be able to see your music properly in the \setting{File Browser}.
559 This is because Itunes changes your files' names and hides them in
560 directories in the \fname{Ipod\_Control} directory. Files placed on your
561 \dap{} using Itunes can be viewed by initialising and using Rockbox's database.
562 See \reference{ref:database} for more information.
566 \opt{m3}{
567 \fixme{Add a note about the charging trick and place it here?}
570 \section{Updating Rockbox}
571 Rockbox can be easily updated with Rockbox Utility.
572 You can also update Rockbox manually -- download a Rockbox build
573 as detailed above, and unzip the build to the root directory
574 of your \dap{} as in the manual installation stage. If your unzip
575 program asks you whether to overwrite files, choose the ``Yes to all'' option.
576 The new build will be installed over your current build.\\
578 \opt{gigabeats}{
579 \note{When your \dap{} is in the Rockbox USB or bootloader
580 USB mode, you will see two visible partitions, the 150MB firmware
581 partition (containing at least a file called \fname{nk.bin}) and
582 the main data partition. Rockbox \emph{must} be installed onto the main
583 data partiton.\\}
586 \nopt{hwcodec}{
587 The bootloader only changes rarely, and should not normally
588 need to be updated.\\
591 \note{If you use Rockbox Utility be aware that it cannot detect manually
592 installed components.}
594 \section{Uninstalling Rockbox}\index{Installation!uninstall}
596 \nopt{gigabeatf,m5,x5,archos,mrobe100,gigabeats}{
597 \note{The Rockbox bootloader allows you to choose between Rockbox and
598 the original firmware. (See \reference{ref:Dualboot} for more information.)}
601 \subsection{Automatic Uninstallation}
602 \opt{gigabeats}{\note{Rockbox can only be uninstalled manually for now.}}
604 You can uninstall Rockbox automatically by using Rockbox Utility. If you
605 installed Rockbox manually you can still use Rockbox Utility for uninstallation
606 but will not be able to do this selectively.
608 \opt{h100,h300}{\note{Rockbox Utility cannot uninstall the bootloader due to
609 the fact that it requires a flashing procedure. To uninstall the bootloader
610 completely follow the manual uninstallation instructions below.}}
612 \subsection{Manual Uninstallation}
614 \opt{archos}{
615 If you would like to go back to using the original \playerman{} software,
616 connect the \dap{} to your computer, and delete the
617 \fname{\firmwarefilename} file.
620 \opt{h10,h10_5gb}{
621 If you would like to go back to using the original \playerman{} software,
622 connect the \dap{} to your computer, and delete the
623 \opt{h10}{\fname{H10\_20GC.mi4}}\opt{h10_5gb}{\fname{H10.mi4}} file and rename
624 \fname{OF.mi4} to \opt{h10}{\fname{H10\_20GC.mi4}}\opt{h10_5gb}{\fname{H10.mi4}}
625 in the \fname{System} directory on your \playertype{}. As in the installation,
626 it may be necessary to first put your device into UMS mode.
629 \opt{mrobe100}{
630 If you would like to go back to using the original \playerman{} software,
631 connect the \dap{} to your computer, and delete the
632 \fname{pp5020.mi4} file and rename
633 \fname{OF.mi4} to \fname{pp5020.mi4}
634 in the \fname{System} directory on your \playertype{}.
637 \opt{e200}{
638 If you would like to go back to using the original \playerman{} software,
639 connect the \dap{} to your computer, and follow the instructions to install
640 the bootloader, but when prompted by sansapatcher, enter \texttt{u} for uninstall,
641 instead of \texttt{i} for install. As in the installation, it may be necessary to
642 first put your \dap{} into MSC mode.
645 \optv{ipod}{
646 To uninstall Rockbox and go back to using just the original Ipod software, connect
647 the \dap{} to your computer and follow the instructions to install
648 the bootloader but, when prompted by ipodpatcher, enter \texttt{u} for uninstall
649 instead of \texttt{i} for install.
652 \opt{m5,x5}{
653 If you would like to go back to using the original \playerman{} software,
654 connect the \dap{} to your computer, download the original \playername{}
655 firmware from the \playerman{} website, and copy it to the \fname{FIRMWARE}
656 directory on your \playername{}. Turn off the \dap{}, remove the USB cable
657 and insert the charger. The original firmware will automatically be flashed.
660 \opt{h100,h300}{
661 If you want to remove the Rockbox bootloader, simply flash an unpatched
662 \playerman{} firmware. Be aware that doing so will also remove the bootloader
663 USB mode. As that mode can come in quite handy (especially if you experience
664 disk errors) it is recommended to keep the bootloader. It also
665 gives you the possibility of trying Rockbox anytime later by simply
666 installing the distribution files.
667 \opt{h100}{
668 The Rockbox bootloader will automatically start the original firmware if
669 the \fname{.rockbox} directory has been deleted.
671 \opt{h300}{
672 Although if you retain the Rockbox bootloader, you will need to hold the
673 \ButtonRec{} button each time you want to start the original firmware.
677 \opt{sansaAMS}{
678 Copy an unmodified original firmware to your player and update it.
681 \nopt{gigabeats}{
682 If you wish to clean up your disk, you may also wish to delete the
683 \fname{.rockbox} directory and its contents.
684 \nopt{m5,x5}{Turn the \playerman{} off.
685 Turn the \dap{} back on and the original \playerman{} software will load.}
688 \opt{gigabeats}{
689 If you wish to clean up your disk by deleting the
690 \fname{.rockbox} directory and its contents, this must be done
691 before uninstalling the bootloader in the next step.
693 Before installation you should have downloaded a copy of the \playerman{}
694 firmware from
695 \url{http://www.tacp.toshiba.com/tacpassets-images/firmware/MESV12US.zip}.
696 \begin{itemize}
697 \item Extract \fname{MES12US.iso} from the \fname{.zip} downloaded above.
698 \item There are two files within \fname{MES12US.iso} called
699 \fname{Autorun.inf} and \fname{gbs\_update\_1\_2\_us.exe}. Extract them with
700 your favourite unzipping utility e.g. 7zip.
701 \item Connect your \dap{} to your computer.
702 \item Extract \fname{nk.bin} from within
703 \fname{gbs\_update\_1\_2\_us.exe} using e.g. 7zip and copy it to the 150 MB
704 firmware partition of your \dap{}.
705 \item Safely eject / unmount the USB drive, unplug the cable and restart.
706 \end{itemize}
708 \note{From Windows, you can also run \fname{gbs\_update\_1\_2\_us.exe}
709 directly to restore your \dap{}. This will format your \dap{},
710 removing all files.}
713 \section{Troubleshooting}
714 \begin{description}
715 \opt{sansa,ipod}{
716 \item[Bootloader install problems]
717 If you have trouble installing the bootloader,
718 please ensure that you are either logged in as an administrator (Windows), or
719 you have root rights (Linux)}
721 \opt{h100,h300}{
722 \item[Immediately loading original firmware.]
723 If the original firmware is immediately
724 loaded without the Rockbox bootloader appearing first, then the Rockbox bootloader
725 has not been correctly installed. The original firmware update will only perform
726 the update if the filename is correct, including case. Make sure that the patched
727 Iriver firmware is called \fname{.hex}.}
729 \nopt{h100,h300}{\item[``File Not Found'']}
730 \opt{h100,h300}{\item[``-1 error'']}
731 If you receive a
732 \nopt{h100,h300}{``File Not Found''}\opt{h100,h300}{``-1 error''} from the
733 bootloader, then the bootloader cannot find the Rockbox firmware. This is
734 usually a result of not extracting the contents of the \fname{.zip} file
735 to the proper location, and should not happen when Rockbox has been
736 installed with Rockbox Utility.
738 To fix this, either install Rockbox with the Rockbox Utility which will take care
739 of this for you, or recheck the Manual Install section to see where the files
740 need to be located.
741 \end{description}
743 \optv{gigabeats}{
744 If this does not fix the problem, there are two additional procedures that you
745 can try to solve this:
747 \begin{itemize}
748 \item Formatting the storage partition. It is possible that using the
749 mkdosfs utility from Linux to format the data partition from your PC
750 before installing will resolve this problem. The appropriate format command is:
751 \begin{code}
752 mkdosfs -f 2 -F 32 -S 512 -s 64 -v -n TFAT /path/to/partition/device
753 \end{code}
754 \warn{This will remove all your files.}
756 \item Copying a \fname{tar}. If you have a Rockbox build environment
757 then you can try generating \fname{rockbox.tar} instead of
758 \fname{rockbox.zip} as follows:
759 \begin{code}
760 make tar
761 \end{code}
762 and copying it to the data partition. During the next boot, the bootloader
763 will extract it.
764 \end{itemize}