tsiry-sandratraina.com
A modern Music Player Daemon based on Rockbox open source high quality audio player
libadwaita
audio
rust
zig
deno
mpris
rockbox
mpd
1\chapter{Installation}\label{sec:installation}
2
3Installing Rockbox is generally a quick and easy procedure. However
4before beginning there are a few important things to know.
5
6\section{Before Starting}
7
8\opt{e200}{\fixme{NOTE: These instructions will not work on the
9``Rhapsody'' version of the E200 series (also known as E200R). Please
10follow the instructions at
11\wikilink{SansaE200RInstallation}.}}
12
13\opt{ipodnano,ipodnano2g,ipodvideo,ipod6g,e200,c200,c200v2,e200v2,clipv1,clipv2,cowond2,fuze,fuzev2}{
14\begin{description}
15\item[Supported hardware versions.]
16 \opt{ipodnano,ipodnano2g}{
17 The \playertype{} is available in multiple versions, not
18 all of which run Rockbox. Rockbox presently runs only on
19 the first and second generation Ipod Nano. Rockbox does
20 \emph{not} run on the third, fourth or fifth generation Ipod Nano.
21 For information on identifying which Ipod you own, see this page on
22 Apple's website: \url{http://www.info.apple.com/kbnum/n61688}.
23 }
24 \opt{ipodvideo}{
25 The \playertype{} is the 5th/5.5th generation \playerman{} only.
26 For information on identifying which Ipod you own, see this page on Apple's
27 website: \url{http://www.info.apple.com/kbnum/n61688}.
28 }
29 \opt{ipod6g}{
30 The \playertype{} refers to the 6th generation model of the
31 \playerman{}. It comes with disk sizes of 80GB, 120GB, and 160GB
32 in ``thick'' and ``slim'' versions.
33 }
34 \opt{c200,c200v2,e200,e200v2}{
35 The \playertype{} is available in multiple versions, and you need to make
36 sure which you have by checking the Sandisk firmware version number under
37 Settings $\rightarrow$ Info. The v1 firmware is named 01.xx.xx, while the
38 v2 firmware begins with 03. Make sure that you are following the
39 instructions from the correct manual.
40}
41 \opt{clipv1,clipv2,fuze,fuzev2}{
42 The \playertype{} is available in multiple versions, and you need to make
43 sure which you have by checking the Sandisk firmware version number under
44 Settings $\rightarrow$ \opt{fuze,fuzev2}{System Settings $\rightarrow$}
45 Info. The v1 firmware is named 01.xx.xx, while the v2 firmware begins with
46 02. Make sure that you are following the instructions from the correct
47 manual.
48}
49 \opt{cowond2}{
50 Rockbox runs on all \playerman{} \playertype{} and \playertype{}+ variants
51 (2 / 4 / 8 / 16~GB, with or without DAB/DMB).
52 \note{Newer \playertype{}+ hardware revisions use an updated power
53 management chip, and some functionality is not yet implemented on these
54 players (e.g. touchscreen support).}
55}
56\end{description}
57}
58
59\opt{cowond2}{
60\begin{description}
61 \item[Current limitations.] Most Rockbox functions are usable on the
62 \playertype{}/\playertype{}+, including music playback and most plugins, but
63 there are a number of shortcomings that prevent it from being a fully
64 supported target:
65 \begin{itemize}
66 \item An SD card is required to use many features, since the internal
67 flash memory is read-only in Rockbox.
68 \warn{The SD driver is still in development and may contain bugs.
69 There have been reports of SD cards becoming unusable after being used
70 with Rockbox on \playerman{} \playertype{}. Only use old, low-capacity
71 cards until we are satisfied the driver is safe to use.\\}
72 \item There is only basic touchscreen support. Further work is
73 required to make the UI more usable with a touchscreen in general.
74 \note{The touchscreen can be used in two modes, either a 3$\times$3 grid mode
75 which divides the screen into areas to emulate a set of physical
76 buttons (the default setting), or ``absolute point'' mode where the
77 touchscreen is used to point to items on the screen.\\}
78 \end{itemize}
79\end{description}
80}
81\opt{ondavx777}{
82\begin{description}
83 \item[Current limitations.] Most Rockbox functions are usable on the
84 \playertype{}, including music playback and most plugins, but
85 there are a number of shortcomings that prevent it from being a fully
86 supported target:
87 \begin{itemize}
88 \item A MicroSD card is required to run Rockbox, since the internal
89 flash memory hasn't been figured out yet.
90 \item There is only basic touchscreen support. Further work is
91 required to make the UI more usable with a touchscreen in general.
92 \note{The touchscreen can be used in two modes, either a 3$\times$3 grid mode
93 which divides the screen into areas to emulate a set of physical
94 buttons (the default setting), or ``absolute point'' mode where the
95 touchscreen is used to point to items on the screen.\\}
96 \end{itemize}
97\end{description}
98}
99\opt{iriverh300}{
100\begin{description}
101 \item[DRM capability.] If your \dap{} has a US firmware, then by installing Rockbox you will
102 \emph{permanently} lose the ability to playback files with DRM.
103\end{description}
104}
105
106\opt{sansaAMS,fuzeplus}{
107\begin{description}
108 \item[DRM capability.] It is possible that installation of the bootloader
109 may lead to you \emph{permanently} losing the ability to playback files
110 with DRM.
111\end{description}
112}
113
114\opt{fiiom3k,shanlingq1,agptekrocker,xduoox3ii,xduoox20,aigoerosq,erosqnative}{
115Although Rockbox is considered fully functional on the \playername{}, there are
116a few limitations compared to the original firmware which you should be aware
117of before installing.
118\begin{description}
119 \item[Filesystem support.] Rockbox only supports the FAT32 filesystem. Other
120 filesystems such as exFAT or NTFS are not supported.
121 \opt{erosqnative}{
122 \note{Many SD cards come with exFAT on them from the
123 factory. The original firmware can be used to reformat them to FAT
124 by going to: \fname{System Settings --> Reset --> Format TF Card}.}
125 \note{The SD card that sometimes come bundled with these players are usually
126 of substandard quality and are not to be trusted. It is recommended to source
127 a card of a reputable brand, from a reputable source, such as direct from
128 the manufacturer. Do check the bundled card for any update file which may
129 be included, though. It may be useful for the community if it is a new version.}
130 }
131 \item[USB DAC.] This feature is not supported by Rockbox, but you can
132 dual-boot the original firmware if you want to use it.
133 \opt{shanlingq1,agptekrocker,xduoox3ii,xduoox20,aigoerosq,erosqnative}{\item[Wireless.] There is no support for Bluetooth\opt{shanlingq1}{ or WiFi}.
134 You can dual-boot the original firmware to use wireless functionality.}
135 \item[Hotswapping SD cards.] Rockbox runs from the SD card, not the internal
136 flash memory. Hotswapping is technically possible, but you need to install
137 the same version of Rockbox to each SD card.
138
139 Some features might not work correctly after hotswapping and you may
140 experience crashes or instability. Removing the SD card while data is being
141 written is liable to cause crashes and data loss, and possibly corrupt your
142 filesystem.
143 \opt{shanlingq1}{\item[Touchscreen.] There is only basic touchscreen support.
144 Further work is required to make the UI more usable with a touchscreen in
145 general.
146 \note{The touchscreen can be used in two modes, either a 3$\times$3 grid mode
147 which divides the screen into areas to emulate a set of physical
148 buttons (the default setting), or ``absolute point'' mode where the
149 touchscreen is used to point to items on the screen.\\}}
150\end{description}
151}
152
153\nopt{gigabeats,fiiom3k,shanlingq1}{
154\begin{description}
155
156\nopt{ipod1g2g}{
157 \item[USB connection.]
158}
159\opt{ipod1g2g}{
160 \item[Firewire connection.]
161}
162 To transfer Rockbox to your \dap{} you need to
163 connect it to your computer.\nopt{rgnano}{For manual installation/uninstallation, or
164 should autodetection fail during automatic installation, you need to know
165 where to access the \dap{}.} On Windows this means you need to know
166 the drive letter associated with the \dap{}. On Linux you need to know
167 the mount point of your \dap{}. On Mac OS X you need to know the volume
168 name of your \dap{}.
169
170 \opt{ipod}{
171 If you have Itunes installed and it is configured to open automatically
172 when your \dap{} is attached (the default behaviour), then wait for it to
173 open and then quit it. You also need to ensure the ``Enable use as disk''
174 option is enabled for your \dap{} in Itunes. Your \dap{} should then enter
175 disk mode automatically when connected to a computer via
176 \nopt{ipod1g2g}{USB.}\opt{ipod1g2g}{Firewire.} If your computer does not
177 recognise your \dap{}, you may need to enter disk mode manually. Disconnect
178 your \dap{} from the computer. Hard reset the \dap{} by pressing and
179 holding the \ButtonMenu{} and \nopt{IPOD_3G_PAD}{\ButtonSelect{}}%
180 \opt{IPOD_3G_PAD}{\ButtonPlay{}} buttons simultaneously. As soon as the
181 \dap{} resets, press and hold the \nopt{IPOD_3G_PAD}{\ButtonSelect{} and
182 \ButtonPlay{}}\opt{IPOD_3G_PAD}{\ButtonLeft{} and \ButtonRight{}} buttons
183 simultaneously. Your \dap{} should enter disk mode and you can try
184 reconnecting to the computer.
185 }
186 \opt{iaudiox5}{
187 When instructed to connect/disconnect the USB cable, always use
188 the USB port through the subpack, not the side `USB Host' port. The side port
189 is intended to be used for USB OTG connections only (digital cameras, memory
190 sticks, etc.).
191 }
192 \opt{sansa,e200v2,clipv1,clipv2,fuzeplus,c200v2}{
193 \note{The following steps require you to change the setting in
194 \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the
195 original firmware.}
196
197 \nopt{sansaAMS,fuzeplus}{
198 \warn{Never extract files to your \dap{} while it
199 is in recovery mode.}
200 }
201 }
202
203 \opt{fuze,fuzev2,clipplus,clipzip}{
204 \note{The following steps require you to change the setting in
205 \setting{Settings $\rightarrow$ System Settings $\rightarrow$ USB Mode} to
206 \setting{MSC} from within the original firmware. Further note that
207 all original firmware settings will be lost immediately after patching
208 the bootloader, so you may need to correct this setting again after
209 installing rockbox.}
210 }
211
212 \opt{iriverh10,iriverh10_5gb}{
213 The installation requires you to use UMS mode and so
214 may require use of the UMS trick, whereby it is possible to force a MTP
215 \playertype{} to start up in UMS mode as follows:
216 \begin{enumerate}
217 \item Ensure the \dap{} is fully powered off by \opt{iriverh10}{using
218 a pin to push the small reset button inside the hole between the
219 \ButtonHold{} switch and remote control connector.}\opt{iriverh10_5gb}{removing
220 the battery and putting it back in again.}
221 \item Connect your \playertype{} to the computer using the data cable.
222 \item Hold \ButtonRight{} and push \ButtonPower{} to turn the \dap{} on.
223 \item Continue holding \ButtonRight{} until the USB Connected screen appears.
224 \item The \dap{} will now appear as a regular disk on your computer.
225 \end{enumerate}
226 \note{Once Rockbox has been installed, when you shut down your \dap{} from Rockbox it will totally
227 power the player off so step 1 is no longer necessary.}
228 }
229 \opt{gigabeatf}{The installation requires you to change a setting in the
230 original firmware. Make sure the option under \setting{Setup
231 $\rightarrow$ Connections $\rightarrow$ PC Connections} is set to
232 \setting{gigabeat room}. Also, during installation, do not connect your
233 \dap{} using the cradle but plug the USB cable directly to the \dap{}.
234 }
235 \opt{vibe500,samsungyh}{
236 The installation requires you to use UMS mode.
237 In order to start up your \playertype{} in UMS mode you need to:
238 \begin{enumerate}
239 \item Turn off the \dap{} (Original Firmware).
240 \item Connect your \playertype{} to the computer using the data cable.
241 \opt{vibe500}{
242 \item Push and hold \ButtonPower{} (for about 2 seconds) until the ``USB'' screen appears.
243 }
244 \end{enumerate}
245 The \dap{} will now appear as a regular disk on your computer.
246 }
247\end{description}
248}
249
250\opt{ipod,sansa}{
251\begin{description}
252 \item[Administrator/Root rights.] Installing the bootloader portion of Rockbox
253 requires you to have administrative (Windows) or root (Linux) rights.
254 Consequently when doing either the automatic or manual bootloader install,
255 please ensure that you are logged in with an administrator account or have root rights.
256\end{description}
257}
258
259\opt{ipod}{
260\begin{description}
261 \item[File system format.] Rockbox only works on Ipods formatted with
262 the FAT32 filesystem (i.e. Ipods initialised by Itunes
263 for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
264 initialised by Itunes for the Mac). More information and instructions for
265 converting an Ipod to FAT32 can be found on the
266 \wikilink{IpodConversionToFAT32} wiki
267 page on the Rockbox website. Note that after conversion, you can still use
268 a FAT32 Ipod with a Mac.
269\end{description}
270}
271
272\nopt{rgnano}{
273 \subsection{Storage/Capacity Limits}
274}
275
276\opt{disk_storage}{
277Rockbox supports very large drive capacities when used with GPT partitioning on devices that utilize ATA storage, but due to the limitations of the FAT32 filesystem, individual paritions cannot exceed 2TiB. Additionally, there may be underlying platform limitations that make it difficult, if not impossible, utilize a drive larger than some arbitrary size or boot from a drive using GPT partitioning.
278
279\opt{ipod6g}{
280For example, the stock Apple firmware on earlier 6th generation iPod Classic models\footnote{MB029, MB145, MB147, MB150} is limited to drives no larger than 128GiB, and booting into the Apple firmware firmware with larger drive sizes will result in massive data corruption. Later 6th generation iPod Classic models\footnote{MB562, MB565, MC293, MC297} (sometimes referred to as ``7th gen'') do not have this issue. Rockbox itself will function correctly on all 6th/7th generation iPod Classic models.
281}
282
283\note{In practice, no Rockbox-capable device can currently handle total drive capacities exceeding 2TiB.}
284}
285
286\opt{sd_storage}{
287 Rockbox does not currently support SDUC cards, ie those with capacities
288 exceeding 2TiB. However, this is purely a software limitation with
289 Rockbox's SD card drivers, and will be addressed in a future release.
290
291 \note{SD cards exceeding 32GiB are pre-formated using the exFAT filesystem with GPT paritioning.
292 Before they can be used with Rockbox, they must be reformatted with FAT32.}
293}
294
295\opt{disk_storage,sd_storage}{
296\note{The disk format utility included with all versions Microsoft Windows released to date will refuse to create/format FAT32 partitons exceeding 32GiB, so users of larger storage devices will need an alternative tool. Options include GParted Live\footnote{\url{https://gparted.org/}}\opt{ipod}{ or performing a restore using iTunes on Windows}. \opt{sd_storage}{Addtionally, devices that support removable storage typically have a built-in format tool that can be used.}}
297}
298
299\opt{disk_storage}{
300\subsection{Flash/SSD mods}
301 It is common to replace the device's original mechanical hard drive with
302 some sort of solid-state storage. Older versions of Rockbox (3.15 or prior) do \emph{not} work properly with many
303 of these so-called ``flash mods'', the most common symptom being data corruption on write-heavy operations. All
304 known data integrity issues have been resolved, but each type of adapter still has its own quirks:
305\begin{description}
306\item[Compact Flash.] True Compact Flash cards \emph{natively} implement the ATA command set, including
307 advanced power management and the \emph{removeable} attribute. They are performant, reliable, and physically
308 robust, but tend to be expensive and not available in larger sizes.
309\item[SATA.] These are fast, reliable, and available in high capacities, but are typically optimized for high performance
310 at the expense of power consumption.. However, as they implement the full ATA command set, we are able
311 to minimize their power consumption and power them down when not being actively used.
312\item[Single Secure Digital (SD).] While these adapters come in different form factors from multiple vendors,
313 they are all based on the same basic design. The ATA command set is incompletely emulated, notably lacking
314 support for \emph{mandatory} ATA power management commands that Rockbox uses to safely
315 transition the device in and out of low power states. Additionally, SD cards vary widely in quality
316 and power consumption with the resultant effects on data longevity and battery life. Finally, these SD adapters
317 do not support 2TiB or larger SDUC cards.
318\item[Dual/Quad SD.] These are similar to the above, only allowing use of mulitiple SD cards to
319 increase the overall storage capacity. While typically described as JBOD\footnote{Just a Bunch Of Disks}, this is not accurate as each card is not individually accessable. Instead, the adapter claims to be to be a single logical drive of the combined capacity of the individual cards in a RAID0-like manner. Consquently, if any one card fails, all data on all other cards may be rendered inacessible. Given the quality concerns mentioned earlier, this means use of multiple SD cards in one of these adapters is the least reliable/robust of the various SSD mods. Finally, in another violation of the ATA specification, these ATA-SD adapters fail to properly support LBA48 addressing, meaning that no matter what combination of cards is used, if their combined capacity exceeds 2TiB, the extra capacity will not be usable, and the device may even present as having (considerably) less space.
320\end{description}
321
322\note{All of these flash/SSD mods take up less physical space in the device enclosure than the original hard drive, so care must be taken to ensure they are securely mounted and resistant to the vibration and impacts that typically occur in portable devices. Ribbon cables are particularly vulnerable.}
323
324It is also worth noting that you will not likely see improved data transfer rates when using solid-state storage; the underlying \dap{} hardware is simply too slow to materially benefit. However, the improved access times should help the \dap{} to feel much more responsive.
325}
326
327\section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation}
328\nopt{rgnano}{
329 There are two ways to install Rockbox: automated and manual. The automated
330 way is the preferred method of installing Rockbox for the majority of
331 people. Rockbox Utility is a graphical application that does almost everything
332 for you. However, should you encounter a problem, then the manual way is
333 still available to you.\\
334}
335
336\opt{rgnano}{
337 Before installing Rockbox in your \dap{} it needs to be updated to the latest
338 DrUm78's FunKey OS CFW release, for this a microSD card reader is required, to update:
339
340 \begin{itemize}
341 \item Download the latest release of DrUm78's FunKey OS from \url{https://github.com/DrUm78/FunKey-OS/releases}, make sure to download the file named \\
342 \fname{FunKey-sdcard-DrUm78\_RG\_Nano.img}.
343 \item Download balenaEtcher for your preferred OS (Windows, macOS or Linux) from \url{https://etcher.balena.io/\#download-etcher}.
344 \item Remove the microSD card from your \dap{} and insert it into the microSD card reader.
345 \item Run balenaEtcher, click on \fname{Flash from file} and select the previously downloaded \fname{FunKey-sdcard-DrUm78\_RG\_Nano.img}.
346 \item Click on \fname{Select target} and select the microSD card previously inserted.
347 \item Click on \fname{Flash!} and wait for the process to finish.
348 \item Once the flashing process is done remove the microSD card from the reader, insert it into your \dap{} and long press the power button to power it up.
349 \end{itemize}
350}
351
352\opt{gigabeats,fiiom3k,shanlingq1}{
353 \note{The automated install is not yet available for the
354 \playerlongtype{}. For now you can use the manual method to install Rockbox.
355 Please still read the section on the automatic install as it explains
356 various important aspects of Rockbox, such as the different versions
357 available.\\}}
358
359 \opt{HAVE_RB_BL_ON_DISK}{There are three separate components,
360 two of which need to be installed in order to run Rockbox:}
361 \opt{HAVE_RB_BL_IN_FLASH}{There are two separate components
362 which need to be installed in order to run Rockbox:}
363 \opt{rgnano}{There is one main component which needs to be
364 installed in order to run Rockbox:}
365
366\begin{description}
367\opt{HAVE_RB_BL_ON_DISK}{
368\item[The \playerman{} bootloader.]
369 The \playerman{} bootloader is the program that tells your \dap{} how to load
370 and start the original firmware. It is also responsible for any emergency,
371 recovery, or disk modes on your \dap{}. This bootloader is stored in special flash
372 memory in your \playerman{} and comes factory-installed. It is not necessary
373 to modify this in order to install Rockbox.}
374
375\opt{HAVE_RB_BL_ON_DISK,HAVE_RB_BL_IN_FLASH}{
376\item[The Rockbox bootloader.] \index{Bootloader}
377 \opt{HAVE_RB_BL_ON_DISK}{The Rockbox bootloader is loaded from disk by
378 the \playerman{} bootloader. It is responsible for loading the Rockbox
379 firmware and for providing the dual boot function. It directly replaces the
380 \playerman{} firmware in the \daps{} boot sequence.
381 \opt{gigabeatf}{\note{Dual boot does not currently work on the Gigabeat.}}}
382
383 \opt{HAVE_RB_BL_IN_FLASH}{
384 The bootloader is the program that tells your
385 \dap{} how to load and start other components of Rockbox and for providing
386 the dual boot function. This is the component of Rockbox that is installed
387 to the flash memory of your \playerman.
388 \opt{iaudiom3,iaudiom5,iaudiox5}{\note{Dual boot does not currently work on the \playertype.}}}
389
390\item[The Rockbox firmware.]
391 \opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs
392 entirely from flash memory,}
393 \opt{HAVE_RB_BL_ON_DISK}{Similar to the \playerman{} firmware,}
394 most of the Rockbox code is contained in a
395 ``build'' that resides on your \daps{} drive. This makes it easy to
396 update Rockbox. The build consists of a directory called
397 \fname{.rockbox} which contains all of the Rockbox files, and is
398 located in the root of your \daps{} drive.
399}
400
401\opt{rgnano}{
402\item[The Rockbox application.]
403All of the Rockbox code is contained in an .opk file. This makes it easy to
404 update Rockbox. When launcing the .opk it installs a directory called
405 \fname{rockbox} which contains all of the Rockbox files, and is
406 located in the \fname{FunKey} folder of your \daps{} microSD card.
407}
408\end{description}
409
410Apart from the required parts there are some addons you might be interested
411in installing.
412\begin{description}
413\item[Fonts.] Rockbox can load custom fonts. The fonts are
414 distributed as a separate package and thus need to be installed
415 separately. They are not required to run Rockbox itself but
416 a lot of themes require the fonts package to be installed.
417
418\item[Themes.] The appearance of Rockbox can be customised by themes. Depending
419 on your taste you might want to install additional themes to change
420 the look of Rockbox.
421\end{description}
422
423\subsection{Automated Installation}
424
425\opt{gigabeats,ondavx777,fiiom3k,shanlingq1,erosqnative,rgnano}{
426\note{Rockbox Utility does not currently support the \playertype{} and you will
427therefore need to follow the manual install instructions.}}
428\nopt{erosqnative,rgnano}{
429To automatically install Rockbox, download the official installer and
430housekeeping tool \caps{Rockbox Utility}. It allows you to:
431\begin{itemize}
432\item Automatically install all needed components for using Rockbox
433 (``Minimal Installation'').
434\item Automatically install all suggested components (``Complete Installation'').
435\item Selectively install optional components.
436\item Install additional fonts and themes.
437\item Install voice files and generate talk clips.
438\item Uninstall all components you installed using Rockbox Utility.
439\end{itemize}
440
441Prebuilt binaries for Windows, Linux and Mac OS X are
442available at the \wikilink{RockboxUtility} wiki page.\\
443
444When first starting \caps{Rockbox Utility} run ``Autodetect'',
445found in the configuration dialog (File $\rightarrow$ Configure). Autodetection
446can detect most player types. If autodetection fails or is unable to detect
447the mountpoint, make sure to enter the correct values. The mountpoint indicates
448the location of the \dap{} in your filesystem. On Windows, this is the drive
449letter the \dap{} gets assigned, on other systems this is a path in the
450filesystem.\\*
451
452\opt{erosqnative}{
453 Due to some quirks with the original firmware on the \playertype{}, you will need
454 to match the brand and original firmware version in \caps{Rockbox Utility} to your
455 player. This, unfortunately, cannot be done automatically by \caps{Rockbox Utility}.
456}
457
458\opt{iriverh100,iriverh300}{
459 Rockbox Utility will ask you for a compatible copy of the original
460 firmware. This is because for legal reasons we cannot distribute
461 the bootloader directly. Instead, we have to patch the Iriver firmware
462 with the Rockbox bootloader.
463
464 Download a supported version of the Iriver firmware for your
465 \playername{} from the Iriver website, links can be found on
466 \wikilink{IriverBoot}.
467
468 Supported Iriver firmware versions currently include
469 \opt{iriverh100}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US,
470 1.66EU and 1.66K. Note that the H140 uses the same firmware as the H120;
471 H120 and H140 owners should use the firmware called \fname{ihp\_120.hex}.
472 Likewise, the iHP110 and iHP115 use the same firmware, called
473 \fname{ihp\_100.hex}. Be sure to use the correct firmware file for
474 your player.}
475 \opt{iriverh300}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J, 1.30EU and 1.31K.
476 \note{The US \playername{} firmware is not supported and cannot be
477 patched to be used with the bootloader. If you wish to install Rockbox
478 on a US \playername{}, you must first install a non-US version of the
479 original firmware and then install one of the supported versions patched
480 with the Rockbox bootloader.}
481 \warn{Installing a non-US firmware on a US \playername{} will
482 \emph{permanently} remove DRM support from the player.}}
483
484 If the file that you downloaded is a \fname{.zip} file, use an unzip
485 utility like mentioned in the prerequisites section to extract
486 the \fname{.hex} from the \fname{.zip} file
487 to your desktop. Likewise, if the file that you downloaded is an
488 \fname{.exe} file, double-click on the \fname{.exe} file to extract
489 the \fname{.hex} file to your desktop.
490 When running Linux you should be able to extract \fname{.exe}
491 files using \fname{unzip}.
492}
493
494\opt{mpiohd200,mpiohd300}{
495 Rockbox Utility will ask you for a compatible copy of the original
496 firmware. This is because for legal reasons we cannot distribute
497 the bootloader directly. Instead, we have to patch the MPIO firmware
498 with the Rockbox bootloader.
499
500 Download a supported version of the MPIO firmware for your
501 \playername{} from the MPIO website, links can be found on
502 \opt{mpiohd200}{\wikilink{MPIOHD200Port}}%
503 \opt{mpiohd300}{\wikilink{MPIOHD300Port}}.
504
505 \warn{The only tested version of the original firmware is
506 \opt{mpiohd200}{1.30.05}\opt{mpiohd300}{1.30.06}
507 and as such is the only supported version}
508
509 If the file that you downloaded is a \fname{.zip} file, use an unzip
510 utility like mentioned in the prerequisites section to extract
511 the \fname{.SYS} from the \fname{.zip} file
512 to your desktop. Likewise, if the file that you downloaded is an
513 \fname{.exe} file, double-click on the \fname{.exe} file to extract
514 the \fname{.SYS} file to your desktop.
515 When running Linux you should be able to extract \fname{.exe}
516 files using \fname{unzip}.
517}
518
519\opt{fuzeplus}{
520 Rockbox Utility will ask you for a compatible copy of the original
521 firmware. This is because for legal reasons we cannot distribute
522 the bootloader directly. Instead, we have to patch the \playerman{}
523 firmware with the Rockbox bootloader.
524
525 Download a supported version of the \playerman{} firmware for your
526 \playername{} from the \playerman{} website, links can be found on
527 \wikilink{SansaFuzePlusPort}.
528 \note{Although the only tested version of the original firmware is 02.38.6,
529 Rockbox Utility should be able to patch any newer version.}
530 \note{If the file that you downloaded is a \fname{.zip} file, use an unzip
531 utility like mentioned in the prerequisites section to extract the
532 \fname{firmware.sb} from the \fname{.zip} file to your desktop.}
533}
534}
535\subsubsection{Choosing a Rockbox version}\label{sec:choosing_version}
536
537There are three different versions of Rockbox available from the
538Rockbox website:
539\label{Version}
540Release version, current build and archived daily build. You need to decide which one
541you want to install and get the appropriate version for your \dap{}. \nopt{rgnano}{If you
542select either ``Minimal Installation'' or ``Complete Installation'' from the
543``Quick Start'' tab, then Rockbox Utility will automatically install the
544release version of Rockbox. Using the ``Installation'' tab will allow you
545to select which version you wish to install.}
546
547\opt{erosqnative}{
548\note{\textbf{There are two different versions of Rockbox for the \playertype{}. This manual only
549refers to the \playertype{} Native version, and thus when downloading Rockbox, ensure
550that the download name includes "erosqnative"!}}
551}
552
553\begin{description}
554
555\item[Release.] The release version is the latest stable release, free
556 of known critical bugs. For a manual install, the current stable release of Rockbox is
557 available at \url{https://www.rockbox.org/download/}.
558
559\item[Development Build.] The development build is built at each change to
560 the Rockbox source code repository and represents the current state of Rockbox
561 development. This means that the build could contain bugs but most of
562 the time is safe to use. For a manual install, you can download the current build from
563 \url{https://build.rockbox.org/}.
564
565\item[Archived Build.] In addition to the release version and the current build,
566 there is also an archive of daily builds available for download. These are
567 built once a day from the latest source code in the repository. For a manual install,
568 you can download archived builds from \url{https://www.rockbox.org/daily.shtml}.
569
570\end{description}
571
572\note{Because current and archived builds are development versions that
573 change frequently, they may behave differently than described in this manual,
574 or they may introduce new (and potentially annoying) bugs. Unless you wish to
575 try the latest and greatest features at the price of possibly greater instability,
576 or you wish to help with development, you should stick with the release.\\*}
577
578Please now go to \reference{ref:finish_install} to complete the installation procedure.
579
580\subsection{Manual Installation}
581
582\nopt{erosqnative}{
583The manual installation method is still available to you, should you need or desire it
584by following the instructions below. \nopt{rgnano}{If you have used Rockbox Utility
585to install Rockbox, then you do not need to follow the next section and can skip
586straight to \reference{ref:finish_install}.}
587}
588
589\opt{gigabeats,erosqnative}{\subsubsection{Installing the bootloader}
590 \opt{gigabeats}{input{getting_started/gigabeats_install.tex}}
591 \opt{erosqnative}{\input{getting_started/hibyos_nativeinstall.tex}}
592}
593
594\nopt{rgnano}{\subsubsection{Installing the firmware}\label{sec:installing_firmware}}
595\opt{rgnano}{\subsubsection{Installing the application}\label{sec:installing_firmware}}
596
597\opt{gigabeats}{\note{When your \dap{} is in the Rockbox USB or bootloader
598USB mode, you will see two visible partitions -- the 150~MB firmware
599partition (containing at least a file called \fname{nk.bin}) and
600the main data partition. Rockbox \emph{must} be installed onto the main
601data partition.}}
602
603\opt{erosqnative}{
604 Rockbox itself is installed to the SD card, and unlike the Bootloader,
605 the installation of it does not modify the device \textit{at all}.
606 Please follow the instructions below to install it to your SD card.
607
608 \note{Remember that this operation will need to be repeated if you switch to a different SD card!}
609}
610
611\begin{enumerate}
612\item Download your chosen version of Rockbox from the links in the
613 previous section.
614
615 \opt{erosqnative}{
616 \note{\textbf{There are two different versions of Rockbox for the \playertype{}. This manual only
617 refers to the \playertype{} Native version, and thus when downloading Rockbox, ensure
618 that the download name includes "erosqnative"!}}
619
620 \item Ensure that your SD card is formatted as FAT32, \textit{not exFAT!} Reformat
621 the SD card with the original firmware's formatting tool by doing the following:
622
623 \begin{enumerate}
624 \item Insert the SD card into the \dap{}.
625 \item With the player OFF, boot the \dap{} into the original firmware by
626 holding \ButtonPlay{} and \ButtonPower{}.
627 \item Ensure that any files on the card you want to save are backed up,
628 as this operation will wipe the drive entirely.
629 \item Go to \fname{System Settings --> Reset --> Format TF Card} in the stock
630 firmware to format the SD card to FAT32.
631 \end{enumerate}
632 }
633
634\item Connect your \dap{} to the computer via USB%
635 \nopt{erosqnative}{
636 \opt{sansa,sansaAMS,iriverh10,iriverh10_5gb,vibe500,fuzeplus,samsungyh}%
637 {in MSC mode }%
638 \opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire }%
639 as described in the manual that came with your \dap{}.
640 }
641 \opt{erosqnative}{by, with the player OFF, holding \ButtonPlay{} and \ButtonPower{}
642 to boot into the original firmware, and then plugging in the USB cable.
643 }
644
645\item Take the \fname{.zip} file that you downloaded and use
646 the ``Extract all'' command of your unzip program to extract
647 the files onto %
648 \opt{gigabeats,fuzeplus}{the main data partition of }%
649 \opt{cowond2}{either an SD card or the internal memory of }%
650 \opt{ondavx777}{the MicroSD of }%
651 \opt{rgnano}{the \fname{Applications} folder of the microSD card of }%
652 your \dap{}.
653 \opt{cowond2}{\note{If you have chosen to extract to the internal memory, it
654 will not be possible to save settings.}}
655\end{enumerate}
656
657\nopt{rgnano}{
658\note{The entire contents of the \fname{.zip} file should be extracted
659directly to the root of your \daps{} drive. Do not try to
660create a separate directory on your \dap{} for the Rockbox
661files! The \fname{.zip} file already contains the internal
662structure that Rockbox needs.\\}
663
664% This has nothing to do with swcodec, just that these players need our own
665% bootloader so we can decide where we want the main binary.
666If the contents of the \fname{.zip} file are extracted correctly, you will
667have a directory called \fname{.rockbox}, which contains all the files needed
668by Rockbox, in the main directory of your \daps{} drive.
669}
670
671\opt{swcodec}{%
672 \nopt{gigabeats,erosqnative,rgnano}{%
673 \subsubsection{Installing the bootloader}
674 \opt{iriverh100,iriverh300}{\input{getting_started/iriver_install.tex}}
675 \opt{mpiohd200,mpiohd300}{\input{getting_started/mpio_install.tex}}
676 \opt{ipod}{
677 \nopt{ipod6g} {
678 \input{getting_started/ipod_install.tex}}
679 \opt{ipod6g} {
680 \input{getting_started/ipod6g_install.tex}} }
681 \opt{iaudio}{\input{getting_started/iaudio_install.tex}}
682 \opt{iriverh10,iriverh10_5gb}{\input{getting_started/h10_install.tex}}
683 \opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}}
684 \opt{sansa}{\input{getting_started/sansa_install.tex}}
685 \opt{sansaAMS}{\input{getting_started/sansaAMS_install.tex}}
686 \opt{mrobe100}{\input{getting_started/mrobe100_install.tex}}
687 \opt{cowond2}{\input{getting_started/cowond2_install.tex}}
688 \opt{vibe500}{\input{getting_started/vibe500_install.tex}}
689 \opt{ondavx777}{\input{getting_started/ondavx777_install.tex}}
690 \opt{IMX233}{\input{getting_started/IMX233_install.tex}}
691 \opt{samsungyh}{\input{getting_started/samsungyh_install.tex}}
692 \opt{xduoox3}{\input{getting_started/xduoox3_install.tex}}
693 \opt{xduoox3ii,xduoox20,agptekrocker,aigoerosq}{\input{getting_started/hibyos_install.tex}}
694 \opt{fiiom3k,shanlingq1}{\input{getting_started/jztool_install.tex}}
695 }
696}
697
698\subsection{Finishing the install}\label{ref:finish_install}
699
700\opt{gigabeatf}{
701 After installing you \emph{need} to power-cycle the
702 \dap{} by doing the following steps. Failure to do so may result in problems.
703 \begin{itemize}
704 \item Safely eject / unmount your \dap{} and unplug the USB cable.
705 \item Unplug any power adapter.
706 \item Hold the \ButtonPower{} button to turn off the \dap{}.
707 \item Slide the battery switch located on the bottom of the \dap{} from
708 `on' to `off'.
709 \item Slide the battery switch back from `off' to `on'.
710 \end{itemize}
711}
712
713\opt{iaudiom3,iaudiom5,iaudiox5}{
714 After installing you \emph{need} to power-cycle the
715 \dap{} by doing the following steps.
716 \begin{itemize}
717 \item Safely eject / unmount your \dap{} and unplug the USB cable.
718 \item Hold the
719 \opt{IAUDIO_X5_PAD}{\ButtonPower}
720 \opt{IAUDIO_M3_PAD}{\ButtonPlay}
721 button to turn off the \dap{}.
722 \item Insert the charger. The Rockbox bootloader will automatically be flashed.
723 \end{itemize}
724}
725
726\opt{iriverh10,iriverh10_5gb,ipod,mrobe100,sansa,cowond2,vibe500,ondavx777,samsungyh}{
727 Safely eject / unmount the USB drive, unplug the cable and restart.
728}
729
730\opt{sansaAMS}{
731 Safely eject the device, unplug USB and wait for the firmware update to finish.
732 Don't try to power off the device, it will shutdown by itself after a minute.
733}
734
735\opt{gigabeats,rgnano}{
736 Safely eject / unmount your \dap{}.
737}
738
739\opt{iriverh100,iriverh300}{
740 \begin{itemize}
741 \item Safely eject / unmount your \dap{}.
742
743 \item \warn{Before proceeding further, make sure that your player has a full charge
744 or that it is connected to the power adapter. Interrupting the next step
745 due to a power failure most likely will brick your \dap{}.}
746 Update your \daps{} firmware with the patched bootloader. To do this, turn
747 the jukebox on. Press and hold the \ButtonSelect{} button to enter the main menu,
748 and navigate to \setting{General $\rightarrow$ Firmware Upgrade}. Select
749 \setting{Yes} when asked to confirm if you want to upgrade the
750 firmware. The \playerman{} will display a message indicating that the
751 firmware update is in progress. Do \emph{not} interrupt this process. When the
752 firmware update is complete the player will turn itself off. (The update
753 firmware process usually takes a minute or so.). You are now ready to go.
754\end{itemize}
755}
756\opt{fuzeplus}{
757 \warn{Before proceeding further, make sure that your player's battery is enough charged.
758 Interrupting the next step due to a power failure most likely
759 will brick your \dap{}.
760 }
761 \note{If you are updating/reinstalling the bootloader on a previously
762 rockbox installed bootloader you will need to boot into the original
763 firmware in order to perform the following step. See \reference{ref:Dualboot}
764 for details on how to do so
765 }
766 Update your \daps{} firmware with the patched bootloader. To do this,
767 safely eject /unmount your \dap{}. The update process should start
768 immediatly. The \playerman{} will display an animation indicating that the
769 firmware update is in progress with words: ``Updating Fuze+''.
770 Do \emph{not} interrupt this process. When the firmware update is complete the
771 player will restart (The update firmware process usually takes one to several
772 minutes.). You are now ready to go.
773}
774\opt{mpiohd200}{
775 \begin{itemize}
776 \item Safely eject /unmount your \dap{}.
777
778 \item \warn{Before proceeding further, make sure that your player has a full charge
779 or that it is connected to the power adapter. Interrupting the next step
780 due to a power failure most likely will brick your \dap{}.}
781 Update your \daps{} firmware with the patched bootloader. To do this, turn
782 the jukebox on. The update process should start automatically. The \playerman{} will
783 display animation indicating that the firmware update is in progress. Do \emph{not}
784 interrupt this process. When the firmware update is complete the player will restart.
785 (The update firmware process usually takes a minute or so.). You are now ready to go.
786\end{itemize}
787}
788\opt{e200}{Your e200 will automatically reboot and Rockbox should load.}
789
790\opt{fiiom3k,shanlingq1,erosqnative}{
791 Safely eject / unmount your \dap{} and reboot it.
792}
793
794
795\subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
796\index{Speech}\index{Installation!Optional Steps}
797If you wish to use speech support you will also need a voice file. Voice files
798allow Rockbox to speak the user interface to you. Rockbox Utility can install
799an English voice file, or you can download it from \url{https://www.rockbox.org/daily.shtml}
800and unzip it to the root of your \dap{}.
801Rockbox Utility can also aid you in the creation of voice files with different voices
802or in other languages if you have a suitable speech engine installed on your computer.
803Voice menus are enabled by default and will come
804into effect after a reboot. See \reference{ref:Voiceconfiguration} for details
805on voice settings.
806Rockbox Utility can also aid in the production of talk files, which allow Rockbox
807to speak file and folder names.
808
809\section{Running Rockbox}
810\nopt{ipod,gigabeats,cowond2,rgnano}{When
811you turn the unit on, Rockbox should load.}
812\opt{ipod}{Hard reset the Ipod by holding
813 \opt{IPOD_4G_PAD}{\ButtonMenu{} and \ButtonSelect{} simultaneously}%
814 \opt{IPOD_3G_PAD}{\ButtonMenu{} and \ButtonPlay{} simultaneously}
815 for a couple of seconds until the \dap{} resets. Now Rockbox should load.
816}
817
818\opt{gigabeats}{Rockbox should automatically load when you turn on your player.\\
819
820 \note{
821 If you have loaded music onto your \dap{} using the \playerman{}
822 firmware, you will not be able to see your music properly in the
823 \setting{File Browser} as MTP mode changes the location and file names.
824 Files placed on your \dap{} using the \playerman{} firmware can be
825 viewed by initialising and using Rockbox's database.
826 See \reference{ref:database} for more information.}
827}
828
829\opt{cowond2}{
830 To boot the Rockbox firmware set the \ButtonHold{} switch immediately after
831 power on.\\
832 \note{If you have chosen to install to an SD card and it is inserted at power
833 on, Rockbox will boot from that card and use it as the primary drive for
834 storing settings, etc. If there is no SD card inserted, Rockbox will boot
835 from the internal memory, and it will not be possible to save settings.}
836}
837
838\opt{ipod}{
839 \note{
840 If you have loaded music onto your \dap{} using Itunes,
841 you will not be able to see your music properly in the \setting{File Browser}.
842 This is because Itunes changes your files' names and hides them in
843 directories in the \fname{Ipod\_Control} directory. Files placed on your
844 \dap{} using Itunes can be viewed by initialising and using Rockbox's database.
845 See \reference{ref:database} for more information.
846 }
847}
848
849\opt{iaudiom3}{
850 \fixme{Add a note about the charging trick and place it here?}
851}
852
853\opt{rgnano}{
854 Start Rockbox from the \fname{Applications} category in gmenu2x.
855}
856
857\section{Updating Rockbox}
858
859\nopt{rgnano}{
860 \nopt{erosqnative}{
861 Rockbox can be easily updated with Rockbox Utility. You can also update Rockbox
862 }
863 \opt{erosqnative}{
864 The Native Port to \playername{} is not supported by Rockbox Utility yet, so Rockbox Utility cannot update it.
865 Rockbox is easily updated
866 }
867 manually -- download a Rockbox build
868 as detailed above, and unzip the build to the root directory
869 of your \dap{} as in the manual installation stage. If your unzip
870 program asks you whether to overwrite files, choose the ``Yes to all'' option.
871 The new build will be installed over your current build.\\
872}
873
874\opt{gigabeats}{
875 \note{When your \dap{} is in the Rockbox USB or bootloader
876 USB mode, you will see two visible partitions, the 150~MB firmware
877 partition (containing at least a file called \fname{nk.bin}) and
878 the main data partition. Rockbox \emph{must} be installed onto the main
879 data partition.\\}
880}
881
882\nopt{erosqnative,rgnano}{
883The bootloader only changes rarely, and should not normally
884need to be updated.\\
885}
886
887\nopt{erosqnative,rgnano}{
888\note{If you use Rockbox Utility be aware that it cannot detect manually
889 installed components.}
890}
891
892\opt{rgnano}{
893 Rockbox can be easily updated by replacing the \fname{rockbox-funkey-s.opk}
894 file in the \fname{Applications} folder of the microSD card with a newer version.
895}
896
897\section{Uninstalling Rockbox}\index{Installation!uninstall}
898
899\nopt{rgnano}{
900 \nopt{gigabeatf,iaudiom3,iaudiom5,iaudiox5,mrobe100,gigabeats,fuzeplus,erosqnative}{
901 \note{The Rockbox bootloader allows you to choose between Rockbox and
902 the original firmware. (See \reference{ref:Dualboot} for more information.)}
903 }
904
905 \subsection{Automatic Uninstallation}
906 \opt{gigabeats,erosqnative}{\note{Rockbox can only be uninstalled manually from the \playername{} for now.}}
907
908 \nopt{erosqnative}{
909 You can uninstall Rockbox automatically by using Rockbox Utility. If you
910 installed Rockbox manually you can still use Rockbox Utility for uninstallation
911 but will not be able to do this selectively.
912 }
913
914 \opt{iriverh100,iriverh300,fuzeplus}{\note{Rockbox Utility cannot uninstall the bootloader due to
915 the fact that it requires a flashing procedure. To uninstall the bootloader
916 completely follow the manual uninstallation instructions below.}}
917}
918
919\subsection{Manual Uninstallation}
920
921\opt{iriverh10,iriverh10_5gb,mrobe100,vibe500,samsungyh}{
922 If you would like to go back to using the original \playerman{} software,
923 connect the \dap{} to your computer, and delete the
924 \originalfirmwarefilename{} file and rename
925 \fname{OF.mi4} to \originalfirmwarefilename{}
926 in the \fname{System} directory on your \playertype{}.
927 \nopt{mrobe100}{As in the installation,
928 it may be necessary to first put your device into UMS mode.
929 }
930}
931
932\opt{e200}{
933 If you would like to go back to using the original \playerman{} software,
934 connect the \dap{} to your computer, and follow the instructions to install
935 the bootloader, but when prompted by sansapatcher, enter \texttt{u} for uninstall,
936 instead of \texttt{i} for install. As in the installation, it may be necessary to
937 first put your \dap{} into MSC mode.
938}
939
940\optv{ipod}{
941 To uninstall Rockbox and go back to using just the original Ipod software, connect
942 the \dap{} to your computer and follow the instructions to install
943 the bootloader but, when prompted by ipodpatcher, enter \texttt{u} for uninstall
944 instead of \texttt{i} for install.
945}
946
947\opt{iaudiom3,iaudiom5,iaudiox5}{
948 If you would like to go back to using the original \playerman{} software,
949 connect the \dap{} to your computer, download the original \playername{}
950 firmware from the \playerman{} website, and copy it to the \fname{FIRMWARE}
951 directory on your \playername{}. Turn off the \dap{}, remove the USB cable
952 and insert the charger. The original firmware will automatically be flashed.
953}
954
955\opt{iriverh100,iriverh300}{
956 If you want to remove the Rockbox bootloader, simply flash an unpatched
957 \playerman{} firmware. Be aware that doing so will also remove the bootloader
958 USB mode. As that mode can come in quite handy (especially if you experience
959 disk errors) it is recommended to keep the bootloader. It also
960 gives you the possibility of trying Rockbox anytime later by simply
961 installing the distribution files.
962 \opt{iriverh100}{
963 The Rockbox bootloader will automatically start the original firmware if
964 the \fname{.rockbox} directory has been deleted.
965 }
966 \opt{iriverh300}{
967 Although if you retain the Rockbox bootloader, you will need to hold the
968 \ButtonRec{} button each time you want to start the original firmware.
969 }
970}
971
972 \opt{sansaAMS,fuzeplus}{
973 Copy an unmodified original firmware to your player, and then reboot into
974 the Sandisk firmware. See \reference{ref:Dualboot} for more information.
975}
976
977\opt{mpiohd200}{
978 If you want to remove the Rockbox bootloader, simply flash an unpatched
979 \playerman{} firmware.
980}
981
982\opt{fiiom3k,shanlingq1}{
983 If you want to remove the Rockbox bootloader, copy an original firmware
984 update to your microSD card and run the \playerman{} update by
985 \opt{erosqnative}{running it from the Original Firmware's System Settings menu.}
986 \nopt{erosqnative}{holding \ActionBootOFRecovery{} while powering on the \dap{}.}
987
988 Alternatively, if you took a backup of the original \playerman{} bootloader
989 you can copy the backup file, \bootbackupfilename{}, to your SD card and
990 select \emph{Restore bootloader} from the recovery menu. The recovery menu
991 can be accessed by holding \ActionBootRecoveryMenu{} when powering on. If
992 your \dap{} won't boot, use \fname{jztool} to load the bootloader over USB
993 and enter the recovery menu -- see \reference{ref:jztool_load_bootloader}.
994}
995
996\opt{erosqnative}{
997 If you want to remove the Rockbox bootloader, you will need to acquire the correct
998 update file for your brand player and original firmware version number. The
999 uninstallation procedure can then be done as follows:
1000
1001 \begin{enumerate}
1002 \item If the update file is unmodified, use \fname{tools/hibyos\_nativepatcher/hibyos\_nativepatcher.sh} to mark the original bootloader for updating
1003 \item Place the update file on the SD card and ensure it is named \emph{exactly} \fname{update.upt}
1004 \item Boot into the Rockbox bootloader menu: With the player off, hold \ButtonVolUp{} + \ButtonPower{}
1005 \item Select "Aigo Recovery"
1006 \end{enumerate}
1007}
1008
1009\nopt{gigabeats,rgnano}{
1010 If you wish to clean up your disk, you may also wish to delete the
1011 \fname{.rockbox} directory and its contents.
1012 \nopt{iaudiom3,iaudiom5,iaudiox5,fiiom3k,shanlingq1}{
1013 Turn the \playerman{} off. Turn the \dap{} back on and the original
1014 \playerman{} software will load.}
1015}
1016
1017\opt{gigabeats}{
1018 If you wish to clean up your disk by deleting the
1019 \fname{.rockbox} directory and its contents, this must be done
1020 before uninstalling the bootloader in the next step.
1021
1022 Before installation you should have downloaded a copy of the \playerman{}
1023 firmware from
1024 \url{http://www.tacp.toshiba.com/tacpassets-images/firmware/MESV12US.zip}.
1025 \begin{itemize}
1026 \item Extract \fname{MES12US.iso} from the \fname{.zip} downloaded above.
1027 \item There are two files within \fname{MES12US.iso} called
1028 \fname{Autorun.inf} and \fname{gbs\_update\_1\_2\_us.exe}. Extract them with
1029 your favourite unzipping utility e.g. 7zip.
1030 \item Connect your \dap{} to your computer.
1031 \item Extract \fname{nk.bin} from within
1032 \fname{gbs\_update\_1\_2\_us.exe} using e.g. 7zip and copy it to the 150~MB
1033 firmware partition of your \dap{}.
1034 \item Safely eject / unmount the USB drive, unplug the cable and restart.
1035 \end{itemize}
1036
1037 \note{From Windows, you can also run \fname{gbs\_update\_1\_2\_us.exe}
1038 directly to restore your \dap{}. This will format your \dap{},
1039 removing all files.}
1040}
1041
1042\opt{rgnano}{
1043 You can uninstall Rockbox simply by removing:
1044 \begin{itemize}
1045 \item The \fname{Applications/rockbox-funkey-s.opk} file.
1046 \item The \fname{FunKey/.rockbox} folder.
1047 \end{itemize}
1048 in the microSD card of your \dap{}.
1049}
1050
1051\section{Troubleshooting}
1052\opt{erosqnative}{
1053 For common troubleshooting issues, please see wiki page ErosQNativeTroubleshooting
1054 at \url{https://www.rockbox.org/wiki/ErosQNativeTroubleshooting.html}.
1055
1056 For more detailed information about this device, please see the wiki page AIGOErosQK
1057 at \url{https://www.rockbox.org/wiki/AIGOErosQK}.}
1058\begin{description}
1059
1060\opt{sansa,ipod}{
1061 \item[Bootloader install problems]
1062 If you have trouble installing the bootloader,
1063 please ensure that you are either logged in as an administrator (Windows), or
1064 you have root rights (Linux)}
1065
1066\opt{fuzeplus}{
1067 \item[Immediately loading original firmware.]
1068 If the original firmware is immediately loaded without going into updating
1069 the firmware, then the Rockbox bootloader has not been correctly installed.
1070 The original firmware will only perform the update if the filename is
1071 correct, including case. Make sure that the patched Sansa firmware is called
1072 \fname{firmware.sb} and present in the root directory of your player.
1073}
1074
1075\opt{iriverh100,iriverh300}{
1076 \item[Immediately loading original firmware.]
1077 If the original firmware is immediately
1078 loaded without the Rockbox bootloader appearing first, then the Rockbox bootloader
1079 has not been correctly installed. The original firmware update will only perform
1080 the update if the filename is correct, including case. Make sure that the patched
1081 Iriver firmware is called \fname{.hex}.}
1082
1083\nopt{rgnano}{
1084 \nopt{iriverh100,iriverh300,mpiohd200}{\item[``File Not Found'']}
1085 \opt{iriverh100,iriverh300,mpiohd200}{\item[``$-1$ error'']}
1086 If you receive a
1087 \nopt{iriverh100,iriverh300,mpiohd200,rgnano}{``File Not Found''}
1088 \opt{iriverh100,iriverh300,mpiohd200}{``$-1$ error''}
1089 from the bootloader, then the bootloader cannot find the Rockbox firmware.
1090 This is usually a result of not extracting the contents of the \fname{.zip}
1091 file to the proper location\nopt{erosqnative}{, and should not happen when Rockbox has been
1092 installed with Rockbox Utility.}\opt{erosqnative}{. It could also be due to the SD card
1093 not being formatted correctly to FAT32.}
1094
1095 \nopt{erosqnative}{
1096 To fix this, either install Rockbox with the Rockbox Utility which will take care
1097 of this for you, or recheck the Manual Install section to see where the files
1098 need to be located.
1099 }
1100 \opt{erosqnative}{
1101 To fix this, ensure that the SD card is formatted to FAT32 (the original firmware
1102 can be used to do this easily), re-copy the entirety of the \fname{.zip} file's
1103 contents to the root of the SD card and reboot the device.
1104 }
1105}
1106
1107\opt{rgnano}{
1108 \item [Rockbox doesn't show up in gmenu2x.]
1109 If rockbox doesn't show up in gmenu2x after installing it means you're still running
1110 the stock Anbernic FunKey OS firmware and need to update to the latest DrUm78's
1111 FunKey OS CFW as described in \reference{sec:installing_rockbox}.
1112}
1113
1114\end{description}
1115
1116\optv{gigabeats}{
1117If this does not fix the problem, there are two additional procedures that you
1118can try to solve this:
1119
1120\begin{itemize}
1121\item Formatting the storage partition. It is possible that using the
1122mkdosfs utility from Linux to format the data partition from your PC
1123before installing will resolve this problem. The appropriate format command is:
1124\begin{code}
1125 mkdosfs -f 2 -F 32 -S 512 -s 64 -v -n TFAT /path/to/partition/device
1126\end{code}
1127\warn{This will remove all your files.}
1128
1129\item Copying a \fname{tar}. If you have a Rockbox build environment
1130then you can try generating \fname{rockbox.tar} instead of
1131\fname{rockbox.zip} as follows:
1132\begin{code}
1133 make tar
1134\end{code}
1135and copying it to the data partition. During the next boot, the bootloader
1136will extract it.
1137\end{itemize}
1138}