diff options
Diffstat (limited to 'manual/getting_started')
-rw-r--r-- | manual/getting_started/iriver_install.tex | 91 | ||||
-rw-r--r-- | manual/getting_started/main.tex | 65 |
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 @@ | |||
1 | \section{Preparing for Rockbox} | 1 | \subsection{Installing the bootloader} |
2 | There are two separate components of Rockbox that need to be installed in order | 2 | Installing the bootloader is the trickiest part of the installation. |
3 | to run Rockbox. | 3 | The Rockbox bootloader allows users to boot into either the Rockbox |
4 | firmware or the iriver firmware. For legal reasons, we cannot distribute | ||
5 | the bootloader. Instead, we have developed a program that will patch the | ||
6 | Iriver firmware with the Rockbox bootloader. These instructions will explain | ||
7 | how to download and patch the Iriver firmware with the Rockbox bootloader | ||
8 | and install it on your jukebox. | ||
9 | |||
4 | \begin{enumerate} | 10 | \begin{enumerate} |
5 | \item The Rockbox bootloader. This is the component of Rockbox that is installed | 11 | \item Download a supported version of the Iriver firmware for your \playername\ from |
6 | to the flash memory of your \playerman. The bootloader is the program that tells | 12 | the Iriver website or from |
7 | your \dap\ how to boot and load other components of Rockbox. | 13 | \url{http://www.rockbox.org/twiki/bin/view/Main/ManualRockboxInstall}. |
8 | \item The Rockbox firmware. Unlike the \playerman\ firmware, which runs entirely | 14 | Supported Iriver firmware versions currently include |
9 | from flash memory, most of the Rockbox code is contained in the build that | 15 | \opt{IRIVER_H100_PAD}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US, 1.66EU |
10 | resides on your jukebox's hard drive. This makes it easy to update Rockbox. The | 16 | and 1.66K. Note that the H140 uses the same firmware as the H120; H120 and H140 owners should use the |
11 | build contain a file named \firmwarefilename\ and a directory called | 17 | firmware called \fname{ihp\_120.hex}. Likewise, the iHP110 and iHP115 use the same |
12 | \fname{.rockbox} which are located in the root directory of your hard drive. | 18 | firmware, called \fname{ihp\_100.hex}. Be sure to use the correct firmware file |
13 | \end{enumerate} | 19 | for your player. |
20 | } | ||
21 | \opt{IRIVER_H300_PAD}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.\\ | ||
22 | \note{The US H3xx firmware is not currently supported and cannot be patched to be | ||
23 | used with the bootloader. If you wish to install Rockbox on a US \playername\, you | ||
24 | must use an international firmware, which will permanently remove DRM support from | ||
25 | the player.} | ||
26 | } | ||
27 | If the file that you downloaded is a \fname{.zip} file, use an unzip | ||
28 | utility such as \fname{InfoZip}, \fname{7zip}, \fname{WinRAR}, or | ||
29 | \fname{WinZip} to extract the \fname{.hex} from the \fname{.zip} file | ||
30 | to your desktop. Likewise, if the file that you downloaded is an | ||
31 | \fname{.exe} file, double-click on the \fname{.exe} file to extract | ||
32 | the \fname{.hex} file to your desktop. | ||
33 | |||
34 | \item Download the firmware patcher \fname{fwpatcher.exe} from the site | ||
35 | listed in the prior step and save it to your desktop. | ||
36 | |||
37 | \warn{The firmware patcher contains Unicode support, which is not supported by | ||
38 | all versions of Windows. If you have difficulty with the firmware patcher, try | ||
39 | downloading the alternate firmware patcher \fname{fwpatchernu.exe}, which is | ||
40 | built without Unicode support.} | ||
41 | |||
42 | \item Go to your desktop and double-click on whichever version of the firmware | ||
43 | patcher you downloaded in the prior step. | ||
44 | |||
45 | \item In the firmware patcher dialog box, click on the BROWSE button and navigate | ||
46 | to the \fname{.hex} file that you previously downloaded to your desktop. | ||
47 | |||
48 | \item Click PATCH. The firmware patcher will patch the original firmware to | ||
49 | include the Rockbox bootloader. The \fname{.hex} file on your desktop is now | ||
50 | a modified version of the original \fname{.hex} file. | ||
51 | |||
52 | \item Turn on your \playername\ and connect it to your computer via USB. | ||
53 | |||
54 | \item Copy or move the modified \fname{.hex} file to the ROOT directory of | ||
55 | your jukebox. | ||
56 | |||
57 | \item Disconnect the jukebox from USB. (Be sure to use Windows' ``safely remove | ||
58 | hardware'' option.) | ||
59 | |||
60 | \warn{Before proceeding further, make sure that your player has a full charge, | ||
61 | or that it is connected to the power adaptor.} | ||
62 | |||
63 | \item Update your \playername s firmware with the patched bootloader. To do this, turn | ||
64 | the jukebox on. Press and hold the | ||
65 | \opt{IRIVER_H100_PAD}{\ButtonSelect\ button } | ||
66 | \opt{IRIVER_H300_PAD}{\ButtonSelect button } | ||
67 | to enter the main menu, and navigate to \setting{General} --> \setting{Firmware | ||
68 | Upgrade}. Select \setting{Yes} when asked to confirm if you want to upgrade the | ||
69 | firmware. The \playername\ will display a message indicating that the firmware update | ||
70 | is in progress. Do not interrupt this process. When the firmware update is | ||
71 | complete, the player will turn itself off. (The update firmware process usually | ||
72 | takes a minute or so.) | ||
73 | |||
74 | You have now installed the Rockbox bootloader. | ||
75 | |||
76 | \opt{H1xx}{\note{If you install the Rockbox bootloader, but do not install the | ||
77 | Rockbox firmware, the Rockbox bootloader will load the iriver firmware when the | ||
78 | jukebox is turned on.}} | ||
79 | |||
80 | \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 | |||
32 | written by members of the Rockbox community and this should be your first port | 32 | written by members of the Rockbox community and this should be your first port |
33 | of call when looking for further help. | 33 | of call when looking for further help. |
34 | 34 | ||
35 | \opt{h1xx,h300}{\input{getting_started/iriver_install}} | ||
36 | |||
37 | \section{Downloading Rockbox} | ||
38 | The latest release of the Rockbox software will always be available from | ||
39 | \url{http://www.rockbox.org/download/}. | ||
40 | \opt{MASCODEC}{ | ||
41 | Windows users may wish to download the self-extracting Windows installer, | ||
42 | which works for all Jukebox models, but those wishing to install manually or | ||
43 | using a different operating system should choose the .zip archive containing | ||
44 | the firmware for their model of the Jukebox. | ||
45 | } | ||
46 | |||
47 | \section{Installing Rockbox}\label{sec:installing_rockbox} | 35 | \section{Installing Rockbox}\label{sec:installing_rockbox} |
48 | \opt{MASCODEC}{ | 36 | \opt{MASCODEC}{ |
49 | \subsection{Using the windows installer} | 37 | \subsection{Using the windows installer} |
@@ -58,33 +46,40 @@ The latest release of the Rockbox software will always be available from | |||
58 | the procedure is still fairly simple. | 46 | the procedure is still fairly simple. |
59 | } | 47 | } |
60 | \opt{SWCODEC}{ | 48 | \opt{SWCODEC}{ |
61 | \subsection{Installing the bootloader} | 49 | There are two separate components of Rockbox that need to be installed in order |
62 | Installing the bootloader is the trickiest part of the installation. | 50 | to run Rockbox. |
63 | \fixme{add note for other OS as windows. Point to the appropriate wiki page} | 51 | \begin{enumerate} |
64 | Due to legal reasons the Rockbox project can not provide ready-to-use flash | 52 | \item The Rockbox bootloader. This is the component of Rockbox that is installed |
65 | images. Instead, you need to get an original firmware from your \dap s | 53 | to the flash memory of your \playerman. The bootloader is the program that tells |
66 | manufacturer homepage and modify it to include the rockbox bootloader. | 54 | your \dap\ how to boot and load other components of Rockbox. |
67 | \fixme{include further bootloader install instructions: iriver, ipod, iaudio} | 55 | \item The Rockbox firmware. Unlike the \playerman\ firmware, which runs entirely |
68 | \fixme{add something about the bootloader, esp. the bootloader usb mode} | 56 | from flash memory, most of the Rockbox code is contained in the build that |
57 | resides on your jukebox's hard drive. This makes it easy to update Rockbox. The | ||
58 | build contain a file named \firmwarefilename\ and a directory called | ||
59 | \fname{.rockbox} which are located in the root directory of your hard drive. | ||
60 | \end{enumerate} | ||
61 | \opt{h1xx,h300}{\input{getting_started/iriver_install}} | ||
62 | |||
69 | \subsection{Installing the firmware} | 63 | \subsection{Installing the firmware} |
70 | After installing the bootloader the installation becomes fairly easy. | 64 | After installing the bootloader the installation becomes fairly easy. |
71 | } | 65 | } |
72 | Connect your \playername\ to the | ||
73 | computer via USB as described in the manual that came with your \playername. On | ||
74 | Windows, the \playername\ drive will appear as a drive letter in your | ||
75 | ``My Computer'' folder. Take the file that you downloaded above, and unpack | ||
76 | its contents to your \playername\ drive. You can do this using a program such | ||
77 | as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}. | ||
78 | 66 | ||
79 | You will need to unpack all of the files in the archive onto your hard disk. If | 67 | Connect your \playername\ to the computer via USB as described in the |
80 | this has been done correctly, you will have a file called | 68 | manual that came with your \playername. On Windows, the \playername\ drive |
69 | will appear as a drive letter in your ``My Computer'' folder. Take the file | ||
70 | that you downloaded above, and unpack its contents to your \playername\ drive. | ||
71 | You can do this using a program such as \url{http://www.info-zip.org/} or | ||
72 | \url{http://www.winzip.org/}. | ||
73 | |||
74 | You will need to unpack all of the files in the archive onto your hard disk. If | ||
75 | this has been done correctly, you will have a file called | ||
81 | \fname{\firmwarefilename} in the main folder of your \playername\ drive, and | 76 | \fname{\firmwarefilename} in the main folder of your \playername\ drive, and |
82 | also a folder called /\fname{.rockbox}, which contains a number of system files | 77 | also a folder called /\fname{.rockbox}, which contains a number of system files |
83 | used by the software. | 78 | used by the software. |
84 | \note{Please note that the firmware folder starts with a leading dot. You may | 79 | \note{Please note that the firmware folder starts with a leading dot. You may |
85 | experience problems when trying to create such folders when using Windows. | 80 | experience problems when trying to create such folders when using Windows. |
86 | Directly unzipping to your \dap's drive works flawlessly, only Windows' | 81 | Directly unzipping to your \dap's drive works flawlessly; it is only Windows' |
87 | explorer is limited handling with such files.} | 82 | Explorer that is limited in handling such files.} |
88 | 83 | ||
89 | \section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support} | 84 | \section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support} |
90 | If you wish to use speech support you will also need a language file, available | 85 | 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 | |||
95 | by default. See page \pageref{ref:Voiceconfiguration} for details on voice | 90 | by default. See page \pageref{ref:Voiceconfiguration} for details on voice |
96 | settings. | 91 | settings. |
97 | 92 | ||
98 | |||
99 | \section{Running Rockbox} | 93 | \section{Running Rockbox} |
100 | Remove your Jukebox from the computer's USB port. Unplug any connected power | 94 | Remove your Jukebox from the computer's USB port. Unplug any connected power |
101 | supply and turn the unit off. When you next turn the unit on, the Jukebox | 95 | 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 | |||
109 | wish to delete the \fname{.rockbox} folder and its contents. Turn the | 103 | wish to delete the \fname{.rockbox} folder and its contents. Turn the |
110 | \playername\ off and on and the normal \playername\ software will load. | 104 | \playername\ off and on and the normal \playername\ software will load. |
111 | 105 | ||
106 | \section{Updating Rockbox} | ||
107 | The latest release of the Rockbox software will always be available from | ||
108 | \url{http://www.rockbox.org/download/}. | ||
109 | \opt{MASCODEC}{ | ||
110 | Windows users may wish to download the self-extracting Windows installer, | ||
111 | which works for all Jukebox models, but those wishing to install manually or | ||
112 | using a different operating system should choose the .zip archive containing | ||
113 | the firmware for their model of the Jukebox. | ||
114 | } \ No newline at end of file | ||