Add beastpatcher download location to the Gigabeat S manual, and add dual-boot bootlo...
[kugel-rb.git] / manual / getting_started / installation.tex
blobe5bf71365c76680ad12c4a4960fc319bdf4964f5
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}{
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 \end{description}
49 \opt{h300}{
50 \begin{description}
51 \item[DRM capability.] If your \dap{} has a US firmware, then by installing Rockbox you will
52 \emph{permanently} lose the ability to playback files with DRM.
53 \end{description}
56 \opt{sansaAMS}{
57 \begin{description}
58 \item[DRM capability.] It is possible that installation of the bootloader
59 may lead to you \emph{permanently} losing the ability to playback files
60 with DRM.
61 \end{description}
64 \nopt{gigabeats}{
65 \begin{description}
67 \nopt{ipod1g2g}{
68 \item[USB connection.]
70 \opt{ipod1g2g}{
71 \item[Firewire connection.]
73 To transfer Rockbox to your \dap{} you need to
74 connect it to your computer. For manual installation/uninstallation, or
75 should autodetection fail during automatic installation, you need to know
76 where to access the \dap{}. On Windows this means you need to know
77 the drive letter associated with the \dap{}. On Linux you need to know
78 the mount point of your \dap{}. On Mac OS X you need to know the volume
79 name of your \dap{}.
81 \opt{ipod}{
82 If you have Itunes installed and it is configured to open automatically
83 when your \dap{} is attached (the default behaviour),
84 then wait for it to open and then quit it. You
85 also need to ensure the ``Enable use as disk'' option is enabled for
86 your \dap{} in Itunes. Your \dap{} should then enter disk mode
87 automatically when connected to a computer via \nopt{ipod1g2g}{USB.}\opt{ipod1g2g}{Firewire.}
88 If your computer does not recognise your \dap{}, you may
89 need to enter disk mode manually. Disconnect your \dap{} from the
90 computer. Hard reset the \dap{} by pressing and holding the \ButtonMenu{} and
91 \ButtonSelect{} buttons simultaneously. As soon as the \dap{} resets, press
92 and hold the \ButtonSelect{} and \ButtonPlay{} buttons simultaneously. Your
93 \dap{} should enter disk mode and you can try reconnecting to the computer.
95 \opt{x5}{
96 When instructed to connect/disconnect the USB cable, always use
97 the USB port through the subpack, not the side 'USB Host' port. The side port
98 is intended to be used for USB OTG connections only (digital cameras, memory
99 sticks, etc.).
101 \opt{sansa,e200v2}{
102 \note{The following steps require you to change the setting in
103 \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the
104 original firmware.}
106 \nopt{e200v2}{\warn{Never extract files to your \dap{} while it is in recovery mode.}}
108 \opt{h10,h10_5gb}{
109 The installation requires you to use UMS mode and so
110 may require use of the UMS trick, whereby it is possible to force a MTP
111 \playertype{} to start up in UMS mode as follows:
112 \begin{enumerate}
113 \item Ensure the \dap{} is fully powered off by \opt{h10}{using a pin to
114 push the small reset button inside the hole between the Hold switch and
115 remote control connector.}\opt{h10_5gb}{removing the battery and putting it back in again.}
116 \item Connect your \playertype{} to the computer using the data cable.
117 \item Hold \ButtonRight{} and push \ButtonPower{} to turn the \dap{} on.
118 \item Continue holding \ButtonRight{} until the USB Connected screen appears.
119 \item The \dap{} will now appear as a regular disk on your computer.
120 \end{enumerate}
121 \note{Once Rockbox has been installed, when you shut down your \dap{} from Rockbox it will totally
122 power the player off so step 1 is no longer necessary.}
124 \opt{gigabeatf}{During installation, do not connect your \dap{}
125 using the cradle but plug the USB cable directly to the \dap{}.
127 \end{description}
130 \opt{ipod,sansa}{
131 \begin{description}
132 \item[Administrator/Root rights.] Installing the bootloader portion of Rockbox
133 requires you to have administrative (Windows) or root (Linux) rights.
134 Consequently when doing either the automatic or manual bootloader install,
135 please ensure that you are logged in with an administrator account or have root rights.
136 \end{description}
139 \opt{ipod}{
140 \begin{description}
141 \item[File system format.] Rockbox only works on Ipods formatted with
142 the FAT32 filesystem (i.e. Ipods initialised by Itunes
143 for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
144 initialised by Itunes for the Mac). More information and instructions for
145 converting an Ipod to FAT32 can be found on the
146 \wikilink{IpodConversionToFAT32} wiki
147 page on the Rockbox website. Note that after conversion, you can still use
148 a FAT32 Ipod with a Mac.
149 \end{description}
152 \section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation}
153 There are two ways to install Rockbox: automated and manual. The automated
154 way is the preferred method of installing Rockbox for the majority of
155 people. Rockbox Utility is a graphical application that does almost everything
156 for you. However, should you encounter a problem, then the manual way is
157 still available to you.\\
159 \opt{gigabeats,ipodnano2g}{\note{The automated install is not yet available for the
160 \playerlongtype{}. For now you can use the manual method to install Rockbox.
161 Please still read the section on the automatic install as it explains
162 various important aspects of Rockbox, such as the different versions
163 available.\\}}
165 \opt{hwcodec}{Rockbox itself comes as a single package. There is no need
166 to install additional software to run Rockbox.}
167 \opt{swcodec} {
168 \opt{HAVE_RB_BL_ON_DISK}{There are three separate components,
169 two of which need to be installed in order to run Rockbox:}
170 \opt{HAVE_RB_BL_IN_FLASH}{There are two separate components
171 which need to be installed in order to run Rockbox:}
173 \begin{description}
174 \opt{HAVE_RB_BL_ON_DISK}{
175 \item[The \playerman{} bootloader.]
176 The \playerman{} bootloader is the program that tells your \dap{} how to load
177 and start the original firmware. It is also responsible for any emergency,
178 recovery, or disk modes on your \dap{}. This bootloader is stored in special flash
179 memory in your \playerman{} and comes factory-installed. It is not necessary
180 to modify this in order to install Rockbox.}
182 \item[The Rockbox bootloader.] \index{Bootloader}
183 \opt{HAVE_RB_BL_ON_DISK}{The Rockbox bootloader is loaded from disk by
184 the \playerman{} bootloader. It is responsible for loading the Rockbox
185 firmware and for providing the dual boot function. It directly replaces the
186 \playerman{} firmware in the \daps{} boot sequence.
187 \opt{gigabeatf}{\note{Dual boot does not currently work on the Gigabeat.}}}
189 \opt{HAVE_RB_BL_IN_FLASH}{
190 The bootloader is the program that tells your
191 \dap{} how to load and start other components of Rockbox and for providing
192 the dual boot function. This is the component of Rockbox that is installed
193 to the flash memory of your \playerman.
194 \opt{iaudio}{\note{Dual boot does not currently work on the \playertype{}.}}}
196 \item[The Rockbox firmware.]
197 \opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs
198 entirely from flash memory,}
199 \opt{HAVE_RB_BL_ON_DISK}{Similar to the \playerman{} firmware,}
200 most of the Rockbox code is contained in a
201 ``build'' that resides on your \daps{} drive. This makes it easy to
202 update Rockbox. The build consists of a directory called
203 \fname{.rockbox} which contains all of the Rockbox files, and is
204 located in the root of your \daps{} drive.
206 \end{description}
209 \nopt{player} {
210 Apart from the required parts there are some addons you might be interested
211 in installing.
212 \begin{description}
213 \item[Fonts.] Rockbox can load custom fonts. The fonts are
214 distributed as a separate package and thus need to be installed
215 separately. They are not required to run Rockbox itself but
216 a lot of themes require the fonts package to be installed.
218 \item[Themes.] The appearance of Rockbox can be customised by themes. Depending
219 on your taste you might want to install additional themes to change
220 the look of Rockbox.
221 \end{description}
224 \subsection{Automated Installation}
226 To automatically install Rockbox, download the official installer and
227 housekeeping tool \caps{Rockbox Utility}. It allows you to:
228 \begin{itemize}
229 \item Automatically install all needed components for using Rockbox
230 (``Minimal Installation'').
231 \item Automatically install all suggested components (``Complete Installation'').
232 \item Selectively install optional components.
233 \nopt{player}{\item Install additional fonts and themes.}
234 \item Install voice files and generate talk clips.
235 \item Uninstall all components you installed using Rockbox Utility.
236 \end{itemize}
238 Prebuilt binaries for Windows, Linux and Mac OS X are
239 available at the \wikilink{RockboxUtility} wiki page.\\
241 \opt{gigabeats}{\note{Rockbox Utility does not currently support the Gigabeat S
242 and you will therefore need to follow the manual install instructions below.\\}}
244 When first starting \caps{Rockbox Utility} run ``Autodetect'',
245 found in the configuration dialog (File $\rightarrow$ Configure). Autodetection
246 can detect most player types. If autodetection fails or is unable to detect
247 the mountpoint, make sure to enter the correct values. The mountpoint indicates
248 the location of the \dap{} in your filesystem. On Windows, this is the drive
249 letter the \dap{} gets assigned, on other systems this is a path in the
250 filesystem.\\*
252 \opt{ipodvideo}
253 {\note{Autodetection is unable to distinguish between the
254 \playerman{} 30~GB and 60~GB / 80~GB models and defaults to the
255 30~GB model. This will usually work but you might want to check the
256 detected value, especially if you experience problems with Rockbox.}
259 \opt{h100,h300}{
260 Rockbox Utility will ask you for a compatible copy of the original
261 firmware. This is because for legal reasons we cannot distribute
262 the bootloader directly. Instead, we have to patch the Iriver firmware
263 with the Rockbox bootloader.
265 Download a supported version of the Iriver firmware for your
266 \playername{} from the Iriver website, links can be found on
267 \wikilink{IriverBoot}.
269 Supported Iriver firmware versions currently include
270 \opt{h100}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US,
271 1.66EU and 1.66K. Note that the H140 uses the same firmware as the H120;
272 H120 and H140 owners should use the firmware called \fname{ihp\_120.hex}.
273 Likewise, the iHP110 and iHP115 use the same firmware, called
274 \fname{ihp\_100.hex}. Be sure to use the correct firmware file for
275 your player.}
276 \opt{h300}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.
277 \note{The US \playername{} firmware is not supported and cannot be
278 patched to be used with the bootloader. If you wish to install Rockbox
279 on a US \playername{}, you must first install a non-US version of the
280 original firmware and then install one of the supported versions patched
281 with the Rockbox bootloader.}
282 \warn{Installing a non-US firmware on a US \playername{} will
283 \emph{permanently} remove DRM support from the player.}}
285 If the file that you downloaded is a \fname{.zip} file, use an unzip
286 utility like mentioned in the prerequisites section to extract
287 the \fname{.hex} from the \fname{.zip} file
288 to your desktop. Likewise, if the file that you downloaded is an
289 \fname{.exe} file, double-click on the \fname{.exe} file to extract
290 the \fname{.hex} file to your desktop.
291 When running Linux you should be able to extract \fname{.exe}
292 files using \fname{unzip}.
295 \subsubsection{Choosing a Rockbox version}\label{sec:choosing_version}
297 There are three different versions of Rockbox available from the
298 Rockbox website:
299 \label{Version}
300 Release version, current build and archived daily build. You need to decide which one
301 you want to install and get the appropriate version for your \dap{}. If you
302 select either ``Minimal Installation'' or ``Complete Installation'' from the
303 ``Quick Start'' tab, then Rockbox Utility will automatically install the
304 release version of Rockbox. Using the ``Installation'' tab will allow you
305 to select which version you wish to install.
307 \begin{description}
309 \item[Release.] The release version is the latest stable release, free
310 of known critical bugs. For a manual install, the current stable release of Rockbox is
311 available at \url{http://www.rockbox.org/download/}.
313 \item[Current Build.] The current build is built at each source code change to
314 the Rockbox SVN repository and represents the current state of Rockbox
315 development. This means that the build could contain bugs but most of
316 the time is safe to use. For a manual install, you can download the current build from
317 \url{http://build.rockbox.org/}.
319 \item[Archived Build.] In addition to the release version and the current build,
320 there is also an archive of daily builds available for download. These are
321 built once a day from the latest source code in the SVN repository. For a manual install,
322 you can download archived builds from \url{http://www.rockbox.org/daily.shtml}.
324 \end{description}
326 \note{Because current and archived builds are development versions that
327 change frequently, they may behave differently than described in this manual,
328 or they may introduce new (and potentially annoying) bugs. Unless you wish to
329 try the latest and greatest features at the price of possibly greater instability,
330 or you wish to help with development, you should stick with the release.\\*}
332 Please now go to \reference{ref:finish_install} to complete the installation procedure.
334 \subsection{Manual Installation}
336 The manual installation method is still available to you, should you need or desire it
337 by following the instructions below. If you have used Rockbox Utility
338 to install Rockbox, then you do not need to follow the next section and can skip
339 straight to \reference{ref:finish_install}
341 \opt{gigabeats}{\subsubsection{Installing the bootloader}
342 \input{getting_started/gigabeats_install.tex}
345 \subsubsection{Installing the firmware}\label{sec:installing_firmware}
347 \opt{gigabeats}{\note{When your \dap{} is in the Rockbox USB or bootloader
348 USB mode, you will see two visible partitions - the 150MB firmware
349 partition (containing at least a file called \fname{nk.bin}) and
350 the main data partition. Rockbox \emph{must} be installed onto the main
351 data partiton.}}
353 \begin{enumerate}
354 \item Download your chosen version of Rockbox from the links in the
355 previous section.
356 \opt{ipodvideo}{\note{There are separate versions of Rockbox for the 30GB and
357 60GB/80GB models. You must ensure you download the correct version for your
358 \dap{}.}}
360 \item Connect your \dap{} to the computer via USB
361 \opt{sansa,sansaAMS,h10,h10_5gb}{ in MSC mode }
362 \opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire }as described in
363 the manual that came with your \dap{}.
365 \item Take the \fname{.zip} file that you downloaded and use
366 the ``Extract all'' command of your unzip program to extract
367 the files onto \opt{gigabeats}{the main data partition of }your \dap{}.
368 \end{enumerate}
370 \note{The entire contents of the \fname{.zip} file should be extracted
371 directly to the root of your \daps{} drive. Do not try to
372 create a separate directory on your \dap{} for the Rockbox
373 files! The \fname{.zip} file already contains the internal
374 structure that Rockbox needs.\\}
376 \opt{archos}{
377 If the contents of the \fname{.zip} file are extracted correctly, you will
378 have a file called \fname{\firmwarefilename} in the main directory of your
379 \daps{} drive, and also a directory called \fname{.rockbox}, which contains a
380 number of other directories and system files needed by Rockbox.
383 % This has nothing to do with swcodec, just that these players need our own
384 % bootloader so we can decide where we want the main binary.
385 \opt{swcodec}{
386 If the contents of the \fname{.zip} file are extracted correctly, you will
387 have a directory called \fname{.rockbox}, which contains all the files needed
388 by Rockbox, in the main directory of your \daps{} drive.
391 \opt{swcodec}{\nopt{gigabeats}{
392 \subsubsection{Installing the bootloader}
393 \opt{h100,h300}{\input{getting_started/iriver_install.tex}}
394 \opt{ipod}{\input{getting_started/ipod_install.tex}}
395 \opt{m3,m5,x5}{\input{getting_started/iaudio_install.tex}}
396 \opt{h10,h10_5gb}{\input{getting_started/h10_install.tex}}
397 \opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}}
398 \opt{sansa}{\input{getting_started/sansa_install.tex}}
399 \opt{sansaAMS}{\input{getting_started/sansaAMS_install.tex}}
400 \opt{mrobe100}{\input{getting_started/mrobe100_install.tex}}
403 \subsection{Finishing the install}\label{ref:finish_install}
405 \opt{gigabeatf}{
406 After installing you \emph{need} to power-cycle the
407 \dap{} by doing the following steps. Failure to do so may result in problems.
408 \begin{itemize}
409 \item Safely eject / unmount your \dap{} and unplug the USB cable.
410 \item Unplug any power adapter.
411 \item Hold the \ButtonPower{} button to turn off the \dap{}.
412 \item Slide the battery switch located on the bottom of the \dap{} from
413 `on' to `off'.
414 \item Slide the battery switch back from `off' to `on'.
415 \end{itemize}
418 \opt{m3,m5,x5}{
419 After installing you \emph{need} to power-cycle the
420 \dap{} by doing the following steps.
421 \begin{itemize}
422 \item Safely eject / unmount your \dap{} and unplug the USB cable.
423 \item Hold the
424 \opt{IAUDIO_X5_PAD}{\ButtonPower}
425 \opt{IAUDIO_M3_PAD}{\ButtonPlay}
426 button to turn off the \dap{}.
427 \item Insert the charger. The Rockbox bootloader will automatically be flashed.
428 \end{itemize}
431 \opt{h10,h10_5gb,ipod,mrobe100,sansa,archos}{
432 Safely eject / unmount the USB drive, unplug the cable and restart.
435 \opt{gigabeats}{
436 Safely eject / unmount your \dap{}.
439 \opt{h100,h300}{
440 \begin{itemize}
441 \item Safely eject / unmount your \dap{}.
443 \item \warn{Before proceeding further, make sure that your player has a full charge
444 or that it is connected to the power adaptor. Interrupting the next step
445 due to a power failure most likely will brick your \dap{}.}
446 Update your \daps{} firmware with the patched bootloader. To do this, turn
447 the jukebox on. Press and hold the \ButtonSelect{} button to enter the main menu,
448 and navigate to \setting{General $\rightarrow$ Firmware Upgrade}. Select
449 \setting{Yes} when asked to confirm if you want to upgrade the
450 firmware. The \playerman{} will display a message indicating that the
451 firmware update is in progress. Do \emph{not} interrupt this process. When the
452 firmware update is complete the player will turn itself off. (The update
453 firmware process usually takes a minute or so.). You are now ready to go.
454 \end{itemize}
457 \opt{e200}{Your e200 will automatically reboot and Rockbox should load.}
461 \subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
462 \index{Speech}\index{Installation!Optional Steps}
463 If you wish to use speech support you will also need a voice file. Voice files
464 allow Rockbox to speak the user interface to you. Rockbox Utility can install
465 an English voice file, or you can download it from \url{http://www.rockbox.org/daily.shtml}
466 and unzip it to the root of your \dap{}.
467 Rockbox Utility can also aid you in the creation of voice files with different voices
468 or in other languages if you have a suitable speech engine installed on your computer.
469 Voice menus are enabled by default and will come
470 into effect after a reboot. See \reference{ref:Voiceconfiguration} for details
471 on voice settings.
472 Rockbox Utility can also aid in the production of talk files, which allow Rockbox
473 to speak file and folder names.
475 \section{Running Rockbox}
476 \nopt{ipod,gigabeats}{When
477 you turn the unit on, Rockbox should load.}
478 \opt{ipod}{Hard reset the Ipod by holding
479 \opt{IPOD_4G_PAD}{\ButtonMenu{}+\ButtonSelect{}}%
480 \opt{IPOD_3G_PAD}{\ButtonMenu{}+\ButtonPlay{}}
481 for a couple of seconds until the \dap{} resets. Now Rockbox should load.
484 \opt{gigabeats}{Rockbox should automatically load when you turn on your player.\\
486 \note{
487 If you have loaded music onto your \dap{} using the \playerman{}
488 firmware, you will not be able to see your music properly in the
489 \setting{File Browser} as MTP mode changes the location and file names.
490 Files placed on your \dap{} using the \playerman{} firmware can be
491 viewed by initialising and using Rockbox's database.
492 See \reference{ref:database} for more information.}
495 \opt{ipod}{
496 \note{
497 If you have loaded music onto your \dap{} using Itunes,
498 you will not be able to see your music properly in the \setting{File Browser}.
499 This is because Itunes changes your files' names and hides them in
500 directories in the \fname{Ipod\_Control} directory. Files placed on your
501 \dap{} using Itunes can be viewed by initialising and using Rockbox's database.
502 See \reference{ref:database} for more information.
506 \opt{m3}{
507 \fixme{Add a note about the charging trick and place it here?}
510 \section{Updating Rockbox}
511 Rockbox can be easily updated with Rockbox Utility.
512 You can also update Rockbox manually - download a Rockbox build
513 as detailed above, and unzip the build to the root directory
514 of your \dap{} as in the manual installation stage. If your unzip
515 program asks you whether to overwrite files, choose the ``Yes to all'' option.
516 The new build will be installed over your current build.\\
518 \opt{gigabeats}{
519 \note{When your \dap{} is in the Rockbox USB or bootloader
520 USB mode, you will see two visible partitions, the 150MB firmware
521 partition (containing at least a file called \fname{nk.bin}) and
522 the main data partition. Rockbox \emph{must} be installed onto the main
523 data partiton.\\}
526 \nopt{hwcodec}{
527 The bootloader only changes rarely, and should not normally
528 need to be updated.\\
531 \note{If you use Rockbox Utility be aware that it cannot detect manually
532 installed components.}
534 \section{Uninstalling Rockbox}\index{Installation!uninstall}
536 \nopt{gigabeatf,m5,x5,archos,mrobe100,gigabeats}{
537 \note{The Rockbox bootloader allows you to choose between Rockbox and
538 the original firmware. (See \reference{ref:Dualboot} for more information.)}
541 \subsection{Automatic Uninstallation}
542 \opt{gigabeats}{\note{Rockbox can only be uninstalled manually for now.}}
544 You can uninstall Rockbox automatically by using Rockbox Utility. If you
545 installed Rockbox manually you can still use Rockbox Utility for uninstallation
546 but will not be able to do this selectively.
548 \opt{h100,h300}{\note{Rockbox Utility cannot uninstall the bootloader due to
549 the fact that it requires a flashing procedure. To uninstall the bootloader
550 completely follow the manual uninstallation instructions below.}}
552 \subsection{Manual Uninstallation}
554 \opt{archos}{
555 If you would like to go back to using the original \playerman{} software,
556 connect the \dap{} to your computer, and delete the
557 \fname{\firmwarefilename} file.
560 \opt{h10,h10_5gb}{
561 If you would like to go back to using the original \playerman{} software,
562 connect the \dap{} to your computer, and delete the
563 \opt{h10}{\fname{H10\_20GC.mi4}}\opt{h10_5gb}{\fname{H10.mi4}} file and rename
564 \fname{OF.mi4} to \opt{h10}{\fname{H10\_20GC.mi4}}\opt{h10_5gb}{\fname{H10.mi4}}
565 in the \fname{System} directory on your \playertype{}. As in the installation,
566 it may be necessary to first put your device into UMS mode.
569 \opt{mrobe100}{
570 If you would like to go back to using the original \playerman{} software,
571 connect the \dap{} to your computer, and delete the
572 \fname{pp5020.mi4} file and rename
573 \fname{OF.mi4} to \fname{pp5020.mi4}
574 in the \fname{System} directory on your \playertype{}.
577 \opt{e200}{
578 If you would like to go back to using the original \playerman{} software,
579 connect the \dap{} to your computer, and follow the instructions to install
580 the bootloader, but when prompted by sansapatcher, enter \texttt{u} for uninstall,
581 instead of \texttt{i} for install. As in the installation, it may be necessary to
582 first put your \dap{} into MSC mode.
585 \optv{ipod}{
586 To uninstall Rockbox and go back to using just the original Ipod software, connect
587 the \dap{} to your computer and follow the instructions to install
588 the bootloader but, when prompted by ipodpatcher, enter \texttt{u} for uninstall
589 instead of \texttt{i} for install.
592 \opt{m5,x5}{
593 If you would like to go back to using the original \playerman{} software,
594 connect the \dap{} to your computer, download the original \playername{}
595 firmware from the \playerman{} website, and copy it to the \fname{FIRMWARE}
596 directory on your \playername{}. Turn off the \dap{}, remove the USB cable
597 and insert the charger. The original firmware will automatically be flashed.
600 \opt{h100,h300}{
601 If you want to remove the Rockbox bootloader, simply flash an unpatched
602 \playerman{} firmware. Be aware that doing so will also remove the bootloader
603 USB mode. As that mode can come in quite handy (especially if you experience
604 disk errors) it is recommended to keep the bootloader. It also
605 gives you the possibility of trying Rockbox anytime later by simply
606 installing the distribution files.
607 \opt{h100}{
608 The Rockbox bootloader will automatically start the original firmware if
609 the \fname{.rockbox} directory has been deleted.
611 \opt{h300}{
612 Although if you retain the Rockbox bootloader, you will need to hold the
613 \ButtonRec{} button each time you want to start the original firmware.
617 \opt{sansaAMS}{
618 Copy an unmodified original firmware to your player and update it.
621 \nopt{gigabeats}{
622 If you wish to clean up your disk, you may also wish to delete the
623 \fname{.rockbox} directory and its contents.
624 \nopt{m5,x5}{Turn the \playerman{} off.
625 Turn the \dap{} back on and the original \playerman{} software will load.}
628 \opt{gigabeats}{
629 If you wish to clean up your disk by deleting the
630 \fname{.rockbox} directory and its contents, this must be done
631 before uninstalling the bootloader in the next step.
633 Before installation you should have downloaded a copy of the \playerman{}
634 firmware from
635 \url{http://www.tacp.toshiba.com/tacpassets-images/firmware/MESV12US.zip}.
636 \begin{itemize}
637 \item Extract \fname{MES12US.iso} from the \fname{.zip} downloaded above.
638 \item There are two files within \fname{MES12US.iso} called
639 \fname{Autorun.inf} and \fname{gbs\_update\_1\_2\_us.exe}. Extract them with
640 your favourite unzipping utility e.g. 7zip.
641 \item Connect your \dap{} to your computer.
642 \item Extract \fname{nk.bin} from within
643 \fname{gbs\_update\_1\_2\_us.exe} using e.g. 7zip and copy it to the 150 MB
644 firmware partition of your \dap{}.
645 \item Safely eject / unmount the USB drive, unplug the cable and restart.
646 \end{itemize}
648 \note{From Windows, you can also run \fname{gbs\_update\_1\_2\_us.exe}
649 directly to restore your \dap{}. This will format your \dap{},
650 removing all files.}
653 \section{Troubleshooting}
654 \begin{description}
655 \opt{sansa,ipod}{
656 \item[Bootloader install problems]
657 If you have trouble installing the bootloader,
658 please ensure that you are either logged in as an administrator (Windows), or
659 you have root rights (Linux)}
661 \opt{h100,h300}{
662 \item[Immediately loading original firmware.]
663 If the original firmware is immediately
664 loaded without the Rockbox bootloader appearing first, then the Rockbox bootloader
665 has not been correctly installed. The original firmware update will only perform
666 the update if the filename is correct, including case. Make sure that the patched
667 Iriver firmware is called \fname{.hex}.}
669 \nopt{h100,h300}{\item[``File Not Found'']}
670 \opt{h100,h300}{\item[``-1 error'']}
671 If you receive a
672 \nopt{h100,h300}{``File Not Found''}\opt{h100,h300}{``-1 error''} from the
673 bootloader, then the bootloader cannot find the Rockbox firmware. This is
674 usually a result of not extracting the contents of the \fname{.zip} file
675 to the proper location, and should not happen when Rockbox has been
676 installed with Rockbox Utility.
678 To fix this, either install Rockbox with the Rockbox Utility which will take care
679 of this for you, or recheck the Manual Install section to see where the files
680 need to be located.
681 \end{description}
683 \optv{gigabeats}{
684 If this does not fix the problem, there are two additional procedures that you
685 can try to solve this:
687 \begin{itemize}
688 \item Formatting the storage partition. It is possible that using the
689 mkdosfs utility from Linux to format the data partition from your PC
690 before installing will resolve this problem. The appropriate format command is:
691 \begin{code}
692 mkdosfs -f 2 -F 32 -S 512 -s 64 -v -n TFAT /path/to/partition/device
693 \end{code}
694 \warn{This will remove all your files.}
696 \item Copying a \fname{tar}. If you have a Rockbox build environment
697 then you can try generating \fname{rockbox.tar} instead of
698 \fname{rockbox.zip} as follows:
699 \begin{code}
700 make tar
701 \end{code}
702 and copying it to the data partition. During the next boot, the bootloader
703 will extract it.
704 \end{itemize}