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