summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--manual/getting_started/gigabeats_install.tex80
-rw-r--r--manual/getting_started/installation.tex157
2 files changed, 198 insertions, 39 deletions
diff --git a/manual/getting_started/gigabeats_install.tex b/manual/getting_started/gigabeats_install.tex
index 56de5adcc7..2bc8e094c8 100644
--- a/manual/getting_started/gigabeats_install.tex
+++ b/manual/getting_started/gigabeats_install.tex
@@ -1,8 +1,78 @@
1% $Id$ 1% $Id$
2 2
3\warn{Before starting this procedure, ensure that you have a copy
4of the original \playerman{} firmware. Without this, it is
5\emph{not} possible to uninstall Rockbox. The \playerman{}
6firmware can be downloaded from
7\url{http://www.tacp.toshiba.com/tacpassets-images/firmware/MESV12US.zip}.\\}
8
3Installing the bootloader is only needed once. It involves replacing the 9Installing the bootloader is only needed once. It involves replacing the
4existing firmware file on your \dap{} with another version. To be able 10existing firmware file on your \dap{} with another version.
5to boot the original firmware you must generate your own \fname{nk.bin} file 11When running the original \playerman{} firmware (a version of Windows CE), it is
6using the mknkboot utility. Alternatively you can use a pre-built bootloader, 12only possible to connect the \dap{} to a PC in ``MTP mode'', which hides
7however you must keep in mind that by using the pre-built version you will be 13the actual content of your \daps{} disk and provides restricted access
8unable to dual-boot your \dap{}. 14to its contents.
15In reality, the \daps{} hard disk contains two partitions, a small
16(150MB) ``firmware partition'' containing the \daps{} firmware (operating
17system), and a second ``data partition'' containing your media files. The main
18firmware file in the bootloader partition is called \fname{nk.bin}, and
19this is the file that is loaded into RAM (by the \daps{} ROM-based
20bootloader) and executed when your \dap{} is powered on.
21
22\subsubsection{Bootloader installation from Windows}
23
24\begin{enumerate}
25\item Download \fname{sendfirm.exe} from \fixme{add download location}.
26\item Download the bootloader (\fname{nk.bin}) from \fixme{add download location}.
27\item From the command prompt, enter the directory into which you downloaded
28\fname{sendfirm.exe} and \fname{nk.bin} and run:
29\begin{code}
30 sendfirm.exe nk.bin
31\end{code}
32\item After a successful installation, your \dap{} will immediately reboot
33and (because it is still connected to your PC) enter the Rockbox bootloader's
34``USB Mass Storage'' mode, which exposes your \daps{} disk to your computer
35as a standard USB Mass Storage device.
36\end{enumerate}
37
38\subsubsection{Bootloader installation from Unix (Linux / Mac OS X)}
39
40\begin{enumerate}
41\item Download \fname{sendfirm} from \fixme{add download location}.
42\item Download the bootloader (\fname{nk.bin}) from \fixme{add download location}.
43\item From the terminal, enter the directory into which you downloaded
44\fname{sendfirm} and \fname{nk.bin} and run:
45\begin{code}
46 chmod +x sendfirm
47 ./sendfirm nk.bin
48\end{code}
49\item After a successful installation, your \dap{} will immediately reboot
50and (because it is still connected to your PC) enter the Rockbox bootloader's
51``USB Mass Storage'' mode, which exposes your \daps{} disk to your computer
52as a standard USB Mass Storage device.
53\end{enumerate}
54
55\subsubsection{Fixing the partition table}
56The factory-standard partition table on your \daps{} disk is technically
57invalid, and the Linux kernel (and maybe other operating systems) rejects it.
58To fix this, you need to use the fdisk utility to correctly set the ``bootable
59flag'' field to a valid value (it doesn't matter if this is true or false).\\
60
61\note{Windows does not seem to mind this, so if you only use your \dap{} with
62Windows the following steps are not necessary.\\}
63
64Assuming your \dap{} is appearing as /dev/sdz (the output of the dmesg
65command will show the log messages including the device node assigned to
66your \dap{}), type the following:
67
68\begin{code}
69 fdisk /dev/sdz
70 a
71 1
72 a
73 2
74 w
75\end{code}
76
77After exiting fdisk, you may need to unplug and then reattach your \dap{}
78in order for it to be recognised by your computer. \ No newline at end of file
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index bfcc7ea4d3..9299aefb8a 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -40,14 +40,15 @@ follow the instructions at
40} 40}
41 41
42\opt{h300}{ 42\opt{h300}{
43\begin{description} 43\begin{description}
44 \item[DRM capability.] If your \dap{} has a US firmware, then by installing Rockbox you will 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. 45 \emph{permanently} lose the ability to playback files with DRM.
46\end{description} 46\end{description}
47} 47}
48 48
49\begin{description} 49\nopt{gigabeats}{
50\item[USB connection.] To transfer Rockbox to your \dap{} you need to 50\begin{description}
51 \item[USB connection.] To transfer Rockbox to your \dap{} you need to
51 connect it to your computer. For manual installation/uninstallation, or 52 connect it to your computer. For manual installation/uninstallation, or
52 should autodetection fail during automatic installation, you need to know 53 should autodetection fail during automatic installation, you need to know
53 where to access the \dap{}. On Windows this means you need to know 54 where to access the \dap{}. On Windows this means you need to know
@@ -105,9 +106,10 @@ follow the instructions at
105 using the cradle but plug the USB cable directly to the \dap{}. 106 using the cradle but plug the USB cable directly to the \dap{}.
106 } 107 }
107\end{description} 108\end{description}
109}
108 110
109\opt{ipod,sansa}{ 111\opt{ipod,sansa}{
110\begin{description} 112\begin{description}
111 \item[Administrator/Root rights.] Installing the bootloader portion of Rockbox 113 \item[Administrator/Root rights.] Installing the bootloader portion of Rockbox
112 requires you to have administrative (Windows) or root (Linux) rights. 114 requires you to have administrative (Windows) or root (Linux) rights.
113 Consequently when doing either the automatic or manual bootloader install, 115 Consequently when doing either the automatic or manual bootloader install,
@@ -131,10 +133,15 @@ follow the instructions at
131\section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation} 133\section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation}
132There are two ways to install Rockbox: automated and manual. The automated 134There are two ways to install Rockbox: automated and manual. The automated
133way is the preferred method of installing Rockbox for the majority of 135way is the preferred method of installing Rockbox for the majority of
134people. Rockbox Utility is a graphical 136people. Rockbox Utility is a graphical application that does almost everything
135application that does almost everything for you. 137for you. However, should you encounter a problem, then the manual way is
136However, should you encounter a problem, then the manual way is 138still available to you.\\
137still available to you. 139
140\opt{gigabeats}{\note{The automated install is not yet available for the
141 \playertype{}. For now you can use the manual method to install Rockbox.
142 Please still read the section on the automatic install as it explains
143 various important aspects of Rockbox, such as the different versions
144 available.\\}}
138 145
139\opt{MASCODEC}{Rockbox itself comes as a single package. There is no need 146\opt{MASCODEC}{Rockbox itself comes as a single package. There is no need
140 to install additional software to run Rockbox.} 147 to install additional software to run Rockbox.}
@@ -309,10 +316,19 @@ by following the instructions below. If you have used Rockbox Utility
309to install Rockbox, then you do not need to follow the next section and can skip 316to install Rockbox, then you do not need to follow the next section and can skip
310straight to \reference{ref:finish_install} 317straight to \reference{ref:finish_install}
311 318
319\opt{gigabeats}{\subsubsection{Installing the bootloader}
320 \input{getting_started/gigabeats_install.tex}
321}
322
312\subsubsection{Installing the firmware}\label{sec:installing_firmware} 323\subsubsection{Installing the firmware}\label{sec:installing_firmware}
313 324
314\begin{enumerate} 325\opt{gigabeats}{\note{When your \dap{} is in the Rockbox USB or bootloader
326USB mode, you will see two visible partitions - the 150MB firmware
327partition (containing at least a file called \fname{nk.bin}) and
328the main data partition. Rockbox \emph{must} be installed onto the main
329data partiton.}}
315 330
331\begin{enumerate}
316\item Download your chosen version of Rockbox from the links in the 332\item Download your chosen version of Rockbox from the links in the
317 previous section. 333 previous section.
318\opt{ipodvideo}{\note{There are separate versions of Rockbox for the 30GB and 334\opt{ipodvideo}{\note{There are separate versions of Rockbox for the 30GB and
@@ -326,6 +342,7 @@ straight to \reference{ref:finish_install}
326\item Take the \fname{.zip} file that you downloaded and use 342\item Take the \fname{.zip} file that you downloaded and use
327 the ``Extract all'' command of your unzip program to extract 343 the ``Extract all'' command of your unzip program to extract
328 the files onto your \dap{}. 344 the files onto your \dap{}.
345\end{enumerate}
329 346
330\note{The entire contents of the \fname{.zip} file should be extracted 347\note{The entire contents of the \fname{.zip} file should be extracted
331directly to the root of your \daps{} drive. Do not try to 348directly to the root of your \daps{} drive. Do not try to
@@ -333,8 +350,6 @@ create a separate directory on your \dap{} for the Rockbox
333files! The \fname{.zip} file already contains the internal 350files! The \fname{.zip} file already contains the internal
334structure that Rockbox needs.} 351structure that Rockbox needs.}
335 352
336\end{enumerate}
337
338\opt{archos}{ 353\opt{archos}{
339 If the contents of the \fname{.zip} file are extracted correctly, you will 354 If the contents of the \fname{.zip} file are extracted correctly, you will
340 have a file called \fname{\firmwarefilename} in the main directory of your 355 have a file called \fname{\firmwarefilename} in the main directory of your
@@ -350,7 +365,7 @@ structure that Rockbox needs.}
350 by Rockbox, in the main directory of your \daps{} drive. 365 by Rockbox, in the main directory of your \daps{} drive.
351} 366}
352 367
353\opt{swcodec}{ 368\opt{swcodec}{\nopt{gigabeats}{
354 \subsubsection{Installing the bootloader} 369 \subsubsection{Installing the bootloader}
355 \opt{h100,h300}{\input{getting_started/iriver_install.tex}} 370 \opt{h100,h300}{\input{getting_started/iriver_install.tex}}
356 \opt{ipod}{\input{getting_started/ipod_install.tex}} 371 \opt{ipod}{\input{getting_started/ipod_install.tex}}
@@ -359,8 +374,7 @@ structure that Rockbox needs.}
359 \opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}} 374 \opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}}
360 \opt{sansa}{\input{getting_started/sansa_install.tex}} 375 \opt{sansa}{\input{getting_started/sansa_install.tex}}
361 \opt{mrobe100}{\input{getting_started/mrobe100_install.tex}} 376 \opt{mrobe100}{\input{getting_started/mrobe100_install.tex}}
362 \opt{gigabeats}{\input{getting_started/gigabeats_install.tex}} 377}}
363}
364 378
365\subsection{Finishing the install}\label{ref:finish_install} 379\subsection{Finishing the install}\label{ref:finish_install}
366 380
@@ -391,6 +405,10 @@ structure that Rockbox needs.}
391 Safely eject / unmount the USB drive, unplug the cable and restart. 405 Safely eject / unmount the USB drive, unplug the cable and restart.
392} 406}
393 407
408\opt{gigabeats}{
409 Safely eject / unmount your \dap{}.
410}
411
394\opt{h100,h300}{ 412\opt{h100,h300}{
395 \begin{itemize} 413 \begin{itemize}
396 \item Safely eject / unmount your \dap{}. 414 \item Safely eject / unmount your \dap{}.
@@ -425,7 +443,7 @@ Rockbox Utility can also aid in the production of talk files, which allow Rockbo
425to speak file and folder names. 443to speak file and folder names.
426 444
427\section{Running Rockbox} 445\section{Running Rockbox}
428\nopt{ipod,e200}{Unplug any connected power supply and turn the unit off. When 446\nopt{ipod,e200,gigabeats}{Unplug any connected power supply and turn the unit off. When
429you next turn the unit on, Rockbox should load.}% 447you next turn the unit on, Rockbox should load.}%
430\opt{ipod}{Hard resetting the Ipod by holding 448\opt{ipod}{Hard resetting the Ipod by holding
431 \opt{IPOD_4G_PAD}{\ButtonMenu{}+\ButtonSelect{}}% 449 \opt{IPOD_4G_PAD}{\ButtonMenu{}+\ButtonSelect{}}%
@@ -436,6 +454,16 @@ you next turn the unit on, Rockbox should load.}%
436When you see the Rockbox splash screen, Rockbox is loaded and ready for 454When you see the Rockbox splash screen, Rockbox is loaded and ready for
437use. 455use.
438 456
457\opt{gigabeats}{Rockbox should automatically load when you unplug the USB
458cable.
459 \note{
460 If you have loaded music onto your \dap{} using the \playerman{} firmaware,
461 you will not be able to see your music properly in the \setting{File Browser}.
462 Files placed on your \dap{} using the \playerman{} can be viewed by
463 initialising and using Rockbox's database.
464 See \reference{ref:database} for more information.}
465}
466
439\opt{ipod}{ 467\opt{ipod}{
440 \note{ 468 \note{
441 If you have loaded music onto your \dap{} using Itunes, 469 If you have loaded music onto your \dap{} using Itunes,
@@ -453,22 +481,32 @@ You can also update Rockbox manually - download a Rockbox build
453as detailed above, and unzip the build to the root directory 481as detailed above, and unzip the build to the root directory
454of your \dap{} as in the manual installation stage. If your unzip 482of your \dap{} as in the manual installation stage. If your unzip
455program asks you whether to overwrite files, choose the ``Yes to all'' option. 483program asks you whether to overwrite files, choose the ``Yes to all'' option.
456The new build will be installed over your current build. 484The new build will be installed over your current build.\\
485
486\opt{gigabeats}{
487 \note{When your \dap{} is in the Rockbox USB or bootloader
488 USB mode, you will see two visible partitions, the 150MB firmware
489 partition (containing at least a file called \fname{nk.bin}) and
490 the main data partition. Rockbox \emph{must} be installed onto the main
491 data partiton.\\}
492}
457 493
458The bootloader only changes rarely, and should not normally 494The bootloader only changes rarely, and should not normally
459need to be updated. 495need to be updated.\\
460 496
461\note{If you use Rockbox Utility be aware that it cannot detect manually 497\note{If you use Rockbox Utility be aware that it cannot detect manually
462 installed components.} 498 installed components.}
463 499
464\section{Uninstalling Rockbox}\index{Installation!uninstall} 500\section{Uninstalling Rockbox}\index{Installation!uninstall}
465 501
466\nopt{gigabeatf,m5,x5,archos,mrobe100}{ 502\nopt{gigabeatf,m5,x5,archos,mrobe100,gigabeats}{
467 \note{The Rockbox bootloader allows you to choose between Rockbox and 503 \note{The Rockbox bootloader allows you to choose between Rockbox and
468 the original firmware. (See \reference{ref:Dualboot} for more information.)} 504 the original firmware. (See \reference{ref:Dualboot} for more information.)}
469} 505}
470 506
471\subsection{Automatic Uninstallation} 507\subsection{Automatic Uninstallation}
508\opt{gigabeats}{\note{Rockbox can only be uninstalled manually for now.}}
509
472You can uninstall Rockbox automatically by using Rockbox Utility. If you 510You can uninstall Rockbox automatically by using Rockbox Utility. If you
473installed Rockbox manually you can still use Rockbox Utility for uninstallation 511installed Rockbox manually you can still use Rockbox Utility for uninstallation
474but will not be able to do this selectively. 512but will not be able to do this selectively.
@@ -542,23 +580,37 @@ completely follow the manual uninstallation instructions below.}}
542 } 580 }
543} 581}
544 582
545If you wish to clean up your disk, you may also wish to delete the 583\nopt{gigabeats}{
546\fname{.rockbox} directory and its contents. 584 If you wish to clean up your disk, you may also wish to delete the
547\nopt{m5,x5}{Turn the \playerman{} off. 585 \fname{.rockbox} directory and its contents.
548 Turn the \dap{} back on and the original \playerman{} software will load.} 586 \nopt{m5,x5}{Turn the \playerman{} off.
549 587 Turn the \dap{} back on and the original \playerman{} software will load.}
550\section{Troubleshooting} 588}
551\begin{description}
552 \item[``-1 error'']
553 If you receive a ``-1 error'' from the bootloader, then
554 the bootloader cannot find the Rockbox firmware. This is usually a result of
555 not extracting the contents of the \fname{.zip} file to the proper location,
556 and should not happen when Rockbox has been installed with Rockbox Utility.
557 589
558 To fix this, either install Rockbox with the Rockbox Utility which will take care 590\opt{gigabeats}{
559 of this for you, or recheck the Manual Install section to see where the files 591 Before installation you should have downloaded a copy of the \playerman{}
560 need to be located. 592 firmware from
593 \url{http://www.tacp.toshiba.com/tacpassets-images/firmware/MESV12US.zip}.
594 \begin{itemize}
595 \item Extract \fname{MES12US.iso} from the \fname{.zip} downloaded above.
596 \item There are two files within \fname{MES12US.iso} called
597 \fname{Autorun.inf} and \fname{gbs\_update\_1\_2\_us.exe}. Extract them with
598 your favourite unzipping utility e.g. 7zip.
599 \item Connect your \dap{} to your computer.
600 \item From Windows, you can run \fname{gbs\_update\_1\_2\_us.exe} to restore
601 your \dap{}
602 \warn{This will format your \dap{}, removing all files}
603 \item From Linux, extract \fname{nk.bin} from within
604 \fname{gbs\_update\_1\_2\_us.exe} using e.g. 7zip and copy it to the 150 MB
605 firmware partition of your \dap{}. If you wish to clean up your disk,
606 you may also wish to delete the \fname{.rockbox} directory and its contents
607 from the main partition.
608 \item Safely eject / unmount the USB drive, unplug the cable and restart.
609 \end{itemize}
610}
561 611
612\section{Troubleshooting}
613\begin{description}
562\opt{sansa,ipod}{ 614\opt{sansa,ipod}{
563 \item[Bootloader install problems] 615 \item[Bootloader install problems]
564 If you have trouble installing the bootloader, 616 If you have trouble installing the bootloader,
@@ -572,4 +624,41 @@ If you wish to clean up your disk, you may also wish to delete the
572 has not been correctly installed. The original firmware update will only perform 624 has not been correctly installed. The original firmware update will only perform
573 the update if the filename is correct, including case. Make sure that the patched 625 the update if the filename is correct, including case. Make sure that the patched
574 Iriver firmware is called \fname{.hex}.} 626 Iriver firmware is called \fname{.hex}.}
575\end{description} \ No newline at end of file 627
628\nopt{h100,h300}{\item[``File Not Found'']}
629\opt{h100,h300}{\item[``-1 error'']}
630 If you receive a
631 \nopt{h100,h300}{``File Not Found''}\opt{h100,h300}{``-1 error''} from the
632 bootloader, then the bootloader cannot find the Rockbox firmware. This is
633 usually a result of not extracting the contents of the \fname{.zip} file
634 to the proper location, and should not happen when Rockbox has been
635 installed with Rockbox Utility.
636
637 To fix this, either install Rockbox with the Rockbox Utility which will take care
638 of this for you, or recheck the Manual Install section to see where the files
639 need to be located.
640\end{description}
641
642\optv{gigabeats}{
643If this does not fix the problem, there are two additional procedures that you
644can try to solve this:
645
646\begin{itemize}
647\item Formatting the storage partition. It is possible that using the
648mkdosfs utility from Linux to format the data partition from your PC
649before installing will resolve this problem. The appropriate format command is:
650\begin{code}
651 mkdosfs -f 2 -F 32 -S 512 -s 64 -v -n TFAT /path/to/partition/device
652\end{code}
653\warn{This will remove all your files.}
654
655\item Copying a \fname{tar}. If you have a Rockbox build environment
656then you can try generating \fname{rockbox.tar} instead of
657\fname{rockbox.zip} as follows:
658\begin{code}
659 make tar
660\end{code}
661and copying it to the data partition. During the next boot, the bootloader
662will extract it.
663\end{itemize}
664} \ No newline at end of file