Initial draft of installation instructions for iriver platforms and some accompanying restructuring of the Getting Started chapter. Still needs some cleanup.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9957 a1c6a512-1295-4272-9138-f99709370657

2 files changed, 113 insertions, 43 deletions

diff --git a/manual/getting_started/iriver_install.tex b/manual/getting_started/iriver_install.tex
index 6b5c12c4f7..4dcf971047 100644
--- a/manual/getting_started/iriver_install.tex
+++ b/manual/getting_started/iriver_install.tex
@@ -1,13 +1,80 @@
-\section{Preparing for Rockbox}
-There are two separate components of Rockbox that need to be installed in order
-to run Rockbox.
+\subsection{Installing the bootloader}
+  Installing the bootloader is the trickiest part of the installation.
+  The Rockbox bootloader allows users to boot into either the Rockbox 
+  firmware or the iriver firmware. For legal reasons, we cannot distribute 
+  the bootloader. Instead, we have developed a program that will patch the 
+  Iriver firmware with the Rockbox bootloader. These instructions will explain 
+  how to download and patch the Iriver firmware with the Rockbox bootloader 
+  and install it on your jukebox.
+
 \begin{enumerate}
-\item The Rockbox bootloader. This is the component of Rockbox that is installed
-  to the flash memory of your \playerman. The bootloader is the program that tells
-  your \dap\ how to boot and load other components of Rockbox.
-\item The Rockbox firmware. Unlike the \playerman\ firmware, which runs entirely
-  from flash memory, most of the Rockbox code is contained in the build that
-  resides on your jukebox's hard drive. This makes it easy to update Rockbox. The
-  build contain a file named \firmwarefilename\ and a directory called
-  \fname{.rockbox} which are located in the root directory of your  hard drive.
-\end{enumerate}
+        \item Download a supported version of the Iriver firmware for your \playername\ from 
+        the Iriver website or from 
+        \url{http://www.rockbox.org/twiki/bin/view/Main/ManualRockboxInstall}.
+        Supported       Iriver firmware versions currently include 
+                \opt{IRIVER_H100_PAD}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US, 1.66EU 
+                and 1.66K.  Note that the H140 uses the same firmware as the H120; H120 and H140 owners should use the
+                        firmware called \fname{ihp\_120.hex}.  Likewise, the iHP110 and iHP115 use the same 
+                        firmware,       called \fname{ihp\_100.hex}.   Be sure to use the correct firmware file
+                        for your player.
+                }
+                \opt{IRIVER_H300_PAD}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.\\
+                        \note{The US H3xx firmware is not currently supported and cannot be patched to be 
+                        used with the bootloader. If you wish to install Rockbox on a US \playername\, you 
+                        must use an international firmware, which will permanently remove DRM support from 
+                        the player.}
+                }
+                If the file that you downloaded is a \fname{.zip} file, use an unzip 
+                utility such as \fname{InfoZip}, \fname{7zip}, \fname{WinRAR},  or 
+                \fname{WinZip} to extract the \fname{.hex} from the \fname{.zip} file
+                to your desktop. Likewise, if the file that you downloaded is an 
+                \fname{.exe} file, double-click on the \fname{.exe}     file to extract 
+                the \fname{.hex} file to your desktop.
+                
+        \item Download the firmware patcher \fname{fwpatcher.exe} from the site 
+        listed in the prior step and save it to your desktop.
+
+        \warn{The firmware patcher contains Unicode support, which is not supported by 
+        all versions of Windows. If you have difficulty with the firmware patcher, try 
+        downloading the alternate firmware patcher \fname{fwpatchernu.exe}, which is 
+        built without Unicode support.}
+
+  \item Go to your desktop and double-click on whichever version of the firmware 
+  patcher you downloaded in the prior step.
+  
+  \item In the firmware patcher dialog box, click on the BROWSE button and navigate
+  to the \fname{.hex} file that you previously downloaded to your desktop.
+        
+  \item Click PATCH. The firmware patcher will patch the original firmware to 
+  include the Rockbox bootloader. The \fname{.hex} file on your desktop is now
+  a modified version of the original \fname{.hex} file.
+  
+  \item Turn on your \playername\ and connect it to your computer via USB.
+  
+        \item Copy or move the modified \fname{.hex} file to the ROOT directory of 
+        your jukebox.
+
+  \item Disconnect the jukebox from USB. (Be sure to use Windows' ``safely remove
+  hardware'' option.)
+
+        \warn{Before proceeding further, make sure that your player has a full charge, 
+        or that it is connected to the power adaptor.}
+
+        \item Update your \playername s firmware with the patched bootloader. To do this, turn 
+        the jukebox on. Press and hold the 
+        \opt{IRIVER_H100_PAD}{\ButtonSelect\ button }
+        \opt{IRIVER_H300_PAD}{\ButtonSelect button }
+         to enter the main menu, and navigate to \setting{General} --> \setting{Firmware 
+         Upgrade}. Select \setting{Yes} when asked to confirm if you want to upgrade the 
+         firmware. The \playername\ will display a message indicating that the firmware update 
+         is in progress. Do not interrupt this process. When the firmware update is 
+         complete, the player will turn itself off. (The update firmware process usually 
+         takes a minute or so.)
+
+You have now installed the Rockbox bootloader. 
+
+\opt{H1xx}{\note{If you install the Rockbox bootloader, but do not install the
+Rockbox firmware, the Rockbox bootloader will load the iriver firmware when the
+jukebox is turned on.}}
+
+\end{enumerate}
\ No newline at end of file
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
index 4b36a061c7..addf434b6e 100644
--- a/manual/getting_started/main.tex
+++ b/manual/getting_started/main.tex
@@ -32,18 +32,6 @@ software. There is, however, more help available.  The Rockbox website at
 written by members of the Rockbox community and this should be your first port
 of call when looking for further help.
 
-\opt{h1xx,h300}{\input{getting_started/iriver_install}}
-
-\section{Downloading Rockbox}
-The latest release of the Rockbox software will always be available from
-\url{http://www.rockbox.org/download/}.
-\opt{MASCODEC}{
-  Windows users may wish to download the self-extracting Windows installer,
-  which works for all Jukebox models, but those wishing to install manually or
-  using a different operating system should choose the .zip archive containing
-  the firmware for their model of the Jukebox.
-}
-
 \section{Installing Rockbox}\label{sec:installing_rockbox}
 \opt{MASCODEC}{
   \subsection{Using the windows installer}
@@ -58,33 +46,40 @@ The latest release of the Rockbox software will always be available from
   the procedure is still fairly simple.
 }
 \opt{SWCODEC}{
-  \subsection{Installing the bootloader}
-  Installing the bootloader is the trickiest part of the installation.
-  \fixme{add note for other OS as windows. Point to the appropriate wiki page}
-  Due to legal reasons the Rockbox project can not provide ready-to-use flash
-  images. Instead, you need to get an original firmware from your \dap s
-  manufacturer homepage and modify it to include the rockbox bootloader.
-  \fixme{include further bootloader install instructions: iriver, ipod, iaudio}
-  \fixme{add something about the bootloader, esp. the bootloader usb mode}
+There are two separate components of Rockbox that need to be installed in order
+to run Rockbox.
+\begin{enumerate}
+\item The Rockbox bootloader. This is the component of Rockbox that is installed
+  to the flash memory of your \playerman. The bootloader is the program that tells
+  your \dap\ how to boot and load other components of Rockbox.
+\item The Rockbox firmware. Unlike the \playerman\ firmware, which runs entirely
+  from flash memory, most of the Rockbox code is contained in the build that
+  resides on your jukebox's hard drive. This makes it easy to update Rockbox. The
+  build contain a file named \firmwarefilename\ and a directory called
+  \fname{.rockbox} which are located in the root directory of your  hard drive.
+\end{enumerate}
+\opt{h1xx,h300}{\input{getting_started/iriver_install}}
+   
   \subsection{Installing the firmware}
   After installing the bootloader the installation becomes fairly easy.
 }
-  Connect your \playername\ to the
-computer via USB as described in the manual that came with your \playername. On
-Windows, the \playername\ drive will appear as a drive letter in your
-``My Computer'' folder. Take the file that you downloaded above, and unpack
-its contents to your \playername\ drive. You can do this using a program such
-as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
 
-You will need to unpack all of the files in the archive onto your hard disk. If
- this has been done correctly, you will have a file called 
+Connect your \playername\ to the computer via USB as described in the 
+manual that came with your \playername. On Windows, the \playername\ drive 
+will appear as a drive letter in your ``My Computer'' folder. Take the file 
+that you downloaded above, and unpack its contents to your \playername\ drive.
+You can do this using a program such as \url{http://www.info-zip.org/} or 
+\url{http://www.winzip.org/}.
+
+You will need to unpack all of the files in the archive onto your hard disk. If 
+this has been done correctly, you will have a file called 
 \fname{\firmwarefilename} in the main folder of your \playername\ drive, and
 also a folder called /\fname{.rockbox}, which contains a number of system files
 used by the software.
 \note{Please note that the firmware folder starts with a leading dot. You may
 experience problems when trying to create such folders when using Windows.
-Directly unzipping to your \dap's drive works flawlessly, only Windows'
-explorer is limited handling with such files.}
+Directly unzipping to your \dap's drive works flawlessly; it is only Windows'
+Explorer that is limited in handling such files.}
 
 \section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
 If you wish to use speech support you will also need a language file, available
@@ -95,7 +90,6 @@ inside the /\fname{.rockbox} folder on your Jukebox. Voice menus are turned on
 by default. See page \pageref{ref:Voiceconfiguration} for details on voice
 settings.
 
-
 \section{Running Rockbox}
 Remove your Jukebox from the computer's USB port. Unplug any connected power
 supply and turn the unit off. When you next turn the unit on, the Jukebox
@@ -109,3 +103,12 @@ connect the \playername\ to your computer, and delete the
 wish to delete the \fname{.rockbox} folder and its contents. Turn the
 \playername\ off and on and the normal \playername\ software will load.
 
+\section{Updating Rockbox}
+The latest release of the Rockbox software will always be available from
+\url{http://www.rockbox.org/download/}.
+\opt{MASCODEC}{
+  Windows users may wish to download the self-extracting Windows installer,
+  which works for all Jukebox models, but those wishing to install manually or
+  using a different operating system should choose the .zip archive containing
+  the firmware for their model of the Jukebox.
+}
\ No newline at end of file