summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--manual/advanced_topics/archos-flashing.tex279
-rw-r--r--manual/advanced_topics/main.tex426
-rw-r--r--manual/platform/h1xx.tex1
-rw-r--r--manual/platform/h300.tex3
-rw-r--r--manual/platform/ipodcolor.tex3
-rw-r--r--manual/platform/ipodnano.tex3
-rw-r--r--manual/platform/ipodvideo.tex1
-rw-r--r--manual/platform/ondio.tex3
-rw-r--r--manual/platform/player.tex1
-rw-r--r--manual/platform/recorder.tex3
-rw-r--r--manual/platform/recorderv2fm.tex3
-rw-r--r--manual/preamble.tex1
12 files changed, 361 insertions, 366 deletions
diff --git a/manual/advanced_topics/archos-flashing.tex b/manual/advanced_topics/archos-flashing.tex
new file mode 100644
index 0000000000..43d3cbd7ad
--- /dev/null
+++ b/manual/advanced_topics/archos-flashing.tex
@@ -0,0 +1,279 @@
1\section{\label{ref:Rockboxinflash}Rockbox in flash}
2\textbf{FLASHING ROCKBOX IS OPTIONAL!} It is not required for using
3Rockbox on your Jukebox Recorder. Please read the whole section
4thoroughly before flashing.
5
6\subsection{\label{ref:PartISection61}Introduction}
7Flashing in the sense used here and elsewhere in regard to Rockbox means
8reprogramming the flash memory of the Jukebox unit. Flash memory
9(sometimes called ``Flash ROM'') is a type of
10non{}-volatile memory that can be erased and reprogrammed in circuit. It is a variation of electrically erasable
11programmable read{}-only memory (EEPROM).
12
13A from the factory Jukebox comes with the Archos firmware flashed. It is
14possible to replace the built{}-in software with Rockbox.
15
16Terminology used in the following:\newline
17\textbf{Firmware} means the flash ROM content as a whole.\newline
18\textbf{Image} means one operating software started from there.
19
20By reprogramming the firmware, the Jukebox will boot much faster. The
21Archos boot loader seems to take forever compared to the Rockbox
22version. In fact, the Rockbox boot loader is so fast that it has to
23wait for the disk to spin up. The flashing procedure is a bit involved
24for the first time, updates are very simple later on.
25
26\subsection{\label{ref:Method}Method}
27The replaced firmware will host a bootloader and 2 images. This is made
28possible by compression. The first is the
29``permanent'' backup. The second is the
30default image to be started. The former is only used when you hold the
31F1 key during start, and is the original Archos firmware, the second is
32a current build of Rockbox. This second image is meant to be
33reprogrammed whenever a Rockbox upgrade is performed.
34
35There are two programming tools supplied:
36
37\begin{itemize}
38\item The first one is called \textbf{firmware\_flash.rock} and is used
39to program the whole flash with new content. It can also be used to
40revert back to the original firmware that is backed up as part of this
41procedure. This tool will only be needed once, and can be viewed as
42``formatting'' the flash with the desired image structure.
43\item The second one is called \textbf{rockbox\_flash.rock }and is used
44to reprogram only the second image. If the resulting programmed
45firmware image is not operational, it is
46possible to hold down the F1 key while booting to start the Jukebox
47with the Archos firmware and Rockbox booted from disk to reinstall a
48working firmware image.
49\end{itemize}
50
51\subsubsection{\label{ref:PartISection63}Risks}
52Well, is it dangerous? Yes, certainly, like programming a
53mainboard BIOS, CD/DVD drive firmware,
54mobile phone, etc. If the power fails, the chip malfunctions while
55programming or particularly if the programming software malfunctions,
56your Jukebox may stop functioning. The Rockbox team take no
57responsibility of any kind {}- do this at your own risk.
58
59However, the code has been extensively tested and is known to work well.
60 The new firmware file is completely read before it starts programming,
61there are a lot of sanity checks. If any fail, it will not program.
62There is no reason why such low level code should behave differently on
63your Jukebox.
64
65There's one ultimate safety net to bring back Jukeboxes
66with even completely garbled flash content: the UART boot mod, which in
67turn requires the serial mod. This can bring the dead back to life,
68with that it's possible to reflash independently from the outside, even
69if the flash is completely erased. It has been used during development,
70else Rockbox in flash wouldn't have been possible.
71Extensive development effort went into the development of the UART boot
72mod. Mechanically adept users with good soldering skills can easily
73perform these mods. Others may feel uncomfortable using the first tool
74(\textbf{firmware\_flash.rock}) for reflashing the firmware.
75
76If you are starting with a known{}-good image, you are unlikely to
77experience problems. The flash tools have been stable for quite a
78while. Several users have used them extensively, even flashing while
79playing! Although it worked, it's not the recommended
80method.
81
82The flashing software is very paranoid about making sure that the
83correct flash version is being installed. If the wrong file is used,
84it will simply refuse to flash the Jukebox.
85
86About the safety of operation: Since the Rockbox boot code gives ``dual
87boot'' capability, the Archos firmware is still there when you hold F1
88during startup. So even if you have problems with Rockbox from flash, you can still use
89the Jukebox, reflash the second image with an updated Rockbox copy,
90etc.
91
92The flash chip being used by Archos is specified for 100,000 cycles, so
93it's very unlikely that flashing it will wear it out.
94
95\subsection{\label{ref:Requirements}Requirements}
96You need two things:
97
98\begin{itemize}
99\item The first is a Recorder or FM model, or an Ondio SP or FM. Be sure
100you're using the correct package, they differ
101depending on your precise hardware! The technology works for the Player
102models, too. Players can also be flashed, but Rockbox does not run
103cold{}-started on those, yet.
104\item Second, you need an in{}-circuit programmable flash. Chances are
105about 85\% that you have, but Archos also used an older flash chip
106which can't do the trick. You can find out via Rockbox
107debug menu, entry Hardware Info. If the flash info gives you question
108marks, you're out of luck. The only option for
109flashing if this is the case is to solder in the right chip
110(SST39VF020), preferably with the firmware already in. If the chip is
111blank, you'll need the UART boot mod as well.
112\end{itemize}
113\subsubsection{\label{ref:FlashingProcedure}Flashing Procedure}
114Here are step{}-by{}-step instructions on how to flash and update to a
115current build. It is assumed that you can install and operate Rockbox
116the usual way. The flashing procedure has a lot of failsafes, and will
117check for correct model, file, etc. {}- if something is incompatible it
118just won't flash, that's all.
119
120Now here are the steps:
121
122\textbf{Preparation}
123
124Install (with all the files, not just the .ajz) and use the current
125daily build you'd like to have. Enable any voice
126features that are helpful throughout the process, such as menus and
127filename spelling. Set the file view to show all files, with the menu
128option \textbf{General Settings {}-{\textgreater} File View
129{}-{\textgreater} Show Files} set to ``all''.
130Have the Jukebox nicely charged to avoid
131running out of power during the flash write. Keep the Jukebox plugged
132into the charger until flashing is complete.
133
134{\bfseries
135Backup }
136
137Backup the existing flash content. This is not an essential part of the
138procedure, but is strongly recommended since you will need these files
139if you wish to reverse the flashing procedure, or if you need to update
140the bootloader (as opposed to the firmware) in the future. Keep them
141safe!
142
143Access the main menu by pressing F1 then select \textbf{Info
144{}-{\textgreater} Debug}. Select the first entry, \textbf{Dump ROM
145contents}, by pressing Play one more time. The disk should start to
146spin. Wait for it to settle down, then plug in the USB cable to copy
147the dump file this has just been created to your PC. The main folder of
148your Jukebox now should contain two strange .bin files. Copy the larger
149one named
150\textbf{internal\_rom\_2000000{}-203FFFF.bin}
151to a safe place, then delete them both from the box.
152
153{\bfseries
154Copy the new flash content file to your box }
155
156Depending on your model (recorder, FM, V2 recorder), download one of the
1573 packages:
158
159\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_rec.zip}
160
161\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_fm.zip}
162
163\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
164\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
165
166\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
167
168\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_ondiosp.zip}
169
170\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_ondiofm.zip}
171
172The zip archives contain two .bin files each. Those firmware*.bin files
173are all we want, copy them to the root directory of your box. The names
174differ depending on the model, the flash
175plugin will pick the right one, no way of
176doing this wrong.
177
178{\bfseries
179Install the Rockbox
180Bootloader (``formatting'' the flash)}
181
182This procedure is only necessary the first time you flash Rockbox.
183Unplug the USB cable again, then select \textbf{Browse
184}\textbf{Plugins}\textbf{ } from the main menu (F1). Locate \textbf{firmware\_flash.rock}, and start it with PLAY. Rockbox now displays an info screen, press F1 to acknowledge it and start a file check. Again wait for the disk to
185settle, then press F2 to proceed to a warning message (if the plugin
186has exited, you don't have the proper file) and F3 to actually program
187the file. This takes maybe 15 seconds, wait for the disk to settle
188again. Then press a key to exit the plugin.
189
190{\centering\itshape
191 [Warning: Image ignored] % Unhandled or unsupported graphics:
192%\includegraphics[width=3.609cm,height=2.062cm]{images/rockbox-manual-img75.png}
193 [Warning: Image ignored] % Unhandled or unsupported graphics:
194%\includegraphics[width=3.669cm,height=2.097cm]{images/rockbox-manual-img76.png}
195 \textmd{ } [Warning: Image ignored]
196% Unhandled or unsupported graphics:
197%\includegraphics[width=3.739cm,height=2.136cm]{images/rockbox-manual-img77.png}
198 \newline
199Flashing boot loader in 3 easy steps
200\par}
201
202{\bfseries
203\label{ref:FlashingRockbox}Install the Rockbox binary in flash}
204
205All the above was necessary only once, although there will not be any
206obvious difference (other than the Archos firmware loading a bit more quickly)
207after the step above is complete. Next install the actual Rockbox firmware thatwill be used from ROM. This is how Rockbox will be updated when
208installing a new release from now on.
209
210\begin{itemize}
211\item Unpack the whole build that you are installing onto the Jukebox,
212including plugins and support files. This can be done using the Windows setup program to install the new version onto the Jukebox.
213\item Test the build you are going to flash by playing the .ajz file so
214that ROLO loads it up. This puts the firmware in memory without
215changing your flash, so you can check that everything is working. If
216you have just installed the bootloader (see above) then this will happen automatically as the existing Archos firmware loads the .ajz that you have just installed. If upgrading ROMbox, this step \textbf{must }be carried out since Rockbox cannot overwrite the ROM while it is running from it.
217\item Play the .ucl file, which is usually found in the
218\textbf{/.rockbox} directory, this will kick off the
219\textbf{rockbox\_flash.rock} plugin. It's a bit
220similar to the other one, but it's made different to
221make the user aware. It will check the file, available size, etc. With
222F2 it begins programming, there is no need for warning this time. If it
223goes wrong, you'll still have the permanent image.
224
225{\centering\itshape
226 [Warning: Image ignored] % Unhandled or unsupported graphics:
227%\includegraphics[width=3.53cm,height=2.016cm]{images/rockbox-manual-img78.png}
228 \textmd{ } [Warning: Image ignored]
229% Unhandled or unsupported graphics:
230%\includegraphics[width=3.528cm,height=2.016cm]{images/rockbox-manual-img79.png}
231 \newline
232Using rockbox\_flash to update your boot firmware
233\par}
234\item It is possible that you could get an ``Incompatible
235Version'' error if the plugin interface has changed since
236you last flashed Rockbox. This means you are running an
237``old'' copy of Rockbox, but are trying to
238execute a newer plugin, the one you just downloaded. The easiest
239solution is to ROLO into this new version,
240by playing the\textbf{ ajbrec.ajz }file. Then you are consistent and can play
241\textbf{rockbox.ucl}.
242\item When done, you can restart the box and hopefully your new Rockbox
243image.
244\end{itemize}
245UCLs for the latest Recorder and FM firmware are included in Rockbox 2.4
246and also the daily builds.
247
248\subsection{\label{ref:KnownIssuesAndLimits}Known Issues and Limitations}
249There are two variants as to how the Jukebox starts, which is why there
250are normal and \_norom firmware files. The vast majority of Jukeboxes
251all have the same boot ROM content, but some have different flash
252content. Rockbox identifies this boot ROM with a CRC value of 0x222F in
253the hardware info screen. Some recorders have the boot ROM disabled (it
254might be unprogrammed) and start directly from a flash mirror at
255address zero. They need the \_norom firmware, it has a slightly
256different bootloader. Without a boot ROM there is no UART boot safety
257net. To compensate for that as much as possible the MiniMon monitor is
258included, and can be started by pressing F3+ON. Using this the box can
259be reprogrammed via serial if the UART mod has been applied and the
260first \~{}2000 bytes of the flash are OK.
261
262\subsubsection{ROMbox}
263ROMbox is a flashable version of Rockbox that is
264uncompressed and runs directly from the flash chip rather than being
265copied into memory first. The advantage of this is that memory that
266would normally be used for storing the Rockbox code can be used for
267buffering MP3s instead, resulting in less disk
268spin{}-ups and therefore longer battery life
269 Unfortunately being uncompressed, ROMbox requires more space in flash
270than Rockbox and will therefore not fit in the space that is left on an
271FM recorder. ROMbox therefore runs on the V1 and V2 recorder models
272only.
273
274The procedure for flashing ROMbox is identical to the procedure for
275flashing Rockbox as laid out on page \pageref{ref:FlashingRockbox}.
276The only difference is that the file to install is called
277\textbf{rombox.ucl}. ROMbox is included automatically with rockbox 2.4
278and all the current daily builds, so the procedure is identical
279otherwise. \ No newline at end of file
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 4b5957faed..d92c7b3c99 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -2,47 +2,35 @@
2 2
3\section{\label{ref:CustomisingUI}Customising the userinterface} 3\section{\label{ref:CustomisingUI}Customising the userinterface}
4\subsection{\label{ref:GettingExtras}Getting Extras (Fonts,Languages)} 4\subsection{\label{ref:GettingExtras}Getting Extras (Fonts,Languages)}
5Rockbox supports custom fonts (for the Recorder and Ondio only) and a number of different languages. Rockbox 2.4 comes with 41 fonts and 24 languages already included. If new fonts and language files have been created, then they will be found at \url{http://www.rockbox.org/fonts/} and \url{http://www.rockbox.org/lang/}. 5Rockbox supports custom fonts (for the Recorder and Ondio only) and a number of different languages. Rockbox comes with several fonts and languages already included. If new fonts and language files have been created, then they will be found at \url{http://www.rockbox.org/fonts/} and \url{http://www.rockbox.org/lang/}.
6 6
7\subsection{\label{ref:LoadingForts}Loading Fonts (Recorder, Ondio)} 7\subsection{\label{ref:LoadingForts}Loading Fonts (Recorder, Ondio)}
8Rockbox can load fonts dynamically. Simply copy the .fnt file to the 8Rockbox can load fonts dynamically. Simply copy the .fnt file to the \dap\ and ``play'' them in the directory browser or select \textbf{General Settings {\textgreater} Fonts} from the Main Menu .
9disk and ``play'' them in the directory browser or select \textbf{General Settings {\textgreater} Fonts} from the Main Menu .
10 9
11If you want a font to be loaded automatically every time you start up, 10If you want a font to be loaded automatically every time you start up,
12it must be located in the \textbf{/.rockbox }folder and the file name 11it must be located in the \fname{/.rockbox }folder and the file name
13must be at most 24 characters long. 12must be at most 24 characters long.
14 13
15Any BDF font file up to 16 pixels high should be usable with Rockbox. To 14Any BDF font file up to 16 pixels high should be usable with Rockbox. To
16convert from .bdf to .fnt, use the convbdf tool. This tool can be found 15convert from .bdf to .fnt, use the \fname{convbdf} tool. This tool can be found in the tools directory of the Rockbox source code.
17on the Rockbox website
18(Linux: \url{http://www.rockbox.org/fonts/convbdf}, Windows: \url{http://www.rockbox.org/fonts/convbdf.exe}).
19 16
20\subsection{\label{ref:Loadinglanguages}Loading Languages} 17\subsection{\label{ref:Loadinglanguages}Loading Languages}
21Rockbox can load language files at runtime. Simply copy the .lng file 18Rockbox can load language files at runtime. Simply copy the .lng file (do not use the .lang file) to the \dap\ and ``play'' it in the Rockbox directory browser or select \textbf{General Settings {}-{\textgreater} Languages }from the Main Menu.
22(do not use the .lang file) to the Jukebox and 19
23``play'' it in the Rockbox directory browser 20If you want a language to be loaded automatically every time you start up, it must be located in the \fname{/.rockbox }folder and the file name must be a maximum of 24 characters long.
24or select \textbf{General Settings {}-{\textgreater} Languages }from 21
25the Main Menu. 22Rockbox supports many different languages. You can get .lng files at \url{http://www.rockbox.org/lang/}.
26
27If you want a language to be loaded automatically every time you start
28up, it must be located in the \textbf{/.rockbox }folder and the file
29name must be a maximum of 24 characters long.
30
31Rockbox supports many different languages. You can get .lng files at
32\url{http://www.rockbox.org/lang/}.
33Currently all of these languages are included in the Rockbox 23Currently all of these languages are included in the Rockbox
34distribution. 24distribution.
35 25
36If your language is not yet supported and you want to write your own 26If your language is not yet supported and you want to write your own language file, follow these instructions:
37language file, follow these instructions:
38 27
39\begin{itemize} 28\begin{itemize}
40\item Copy the\url{./ http://www.rockbox.org/lang/english.lang }file and start filling in the ``new:'' lines. 29\item Copy the\url{./ http://www.rockbox.org/lang/english.lang} file and start filling in the ``new:'' lines.
41\item Name your file {\textless}language{\textgreater}.lang, where 30\item Name your file \fname{{\textless}language{\textgreater}.lang}, where
42{\textless}language{\textgreater} is the local name for your language. i.e. svenska.lang, francais.lang etc. 31\fname{{\textless}language{\textgreater}} is the local name for your language. i.e. \fname{svenska.lang}, \fname{francais.lang} etc.
43\item When you are done, submit your .lang file to Rockbox patch 32\item When you are done, submit your .lang file to Rockbox patch tracker.\\
44tracker. 33 (\url{http://www.rockbox.org/bugs/index.php?type=4})
45(\url{http://sourceforge.net/tracker/?group_id=44306&atid=439120})
46\end{itemize} 34\end{itemize}
47 35
48\section{\label{ref:ConfiguringtheWPS}Configuring the WPS} 36\section{\label{ref:ConfiguringtheWPS}Configuring the WPS}
@@ -58,10 +46,10 @@ tracker.
58\end{itemize} 46\end{itemize}
59 47
60\subsection{File Location} 48\subsection{File Location}
61Custom WPS files may be located anywhere on the drive. The only restriction is that they must end in .wps. When you ``play'' a .wps file, it will be used for future WPS screens. If the ``played'' .wps file is located in the /.rockbox folder, it will be remembered and used after reboot. The .wps filename must be no more than 24 characters long for it to be remembered. 49Custom WPS files may be located anywhere on the drive. The only restriction is that they must end in .wps. When you ``play'' a .wps file, it will be used for future WPS screens. If the ``played'' .wps file is located in the \fname{/.rockbox} folder, it will be remembered and used after reboot. The .wps filename must be no more than 24 characters long for it to be remembered.
62 50
63\subsection{How To Create A .wps File} 51\subsection{How To Create A .wps File}
64Quite simply, enter the WPS code in your favourite text editor, Notepad on Windows works fine. When you save it, instead of saving it as a .txt file, save it as a .wps file. Example: Instead of Rockbox.txt, save the file as Rockbox.wps. To make sure non english characters display correctly in your WPS you must save the .wps file with UTF-8 character encoding. This can be done in most editors, for example Notepad in Windows 2000 or XP (but not in 9x/ME) can do this. 52Quite simply, enter the WPS code in your favourite text editor, Notepad on Windows works fine. When you save it, instead of saving it as a .txt file, save it as a .wps file. Example: Instead of \fname{Rockbox.txt}, save the file as \fname{Rockbox.wps}. To make sure non english characters display correctly in your WPS you must save the .wps file with UTF-8 character encoding. This can be done in most editors, for example Notepad in Windows 2000 or XP (but not in 9x/ME) can do this.
65 53
66\subsection{Tags} 54\subsection{Tags}
67 55
@@ -76,6 +64,7 @@ Quite simply, enter the WPS code in your favourite text editor, Notepad on Windo
76These tags override the player setting for the display of the status bar, they must be on their own line. 64These tags override the player setting for the display of the status bar, they must be on their own line.
77 65
78\subsubsection{ID3 Info} 66\subsubsection{ID3 Info}
67
79\begin{center} 68\begin{center}
80 \begin{tabular}{@{}ll@{}}\toprule 69 \begin{tabular}{@{}ll@{}}\toprule
81 \textbf{Tag} & \textbf{Description}\\\midrule 70 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -92,6 +81,7 @@ These tags override the player setting for the display of the status bar, they m
92Remember that this information is not always available, so use the conditionals to show alternate information in preference to assuming. 81Remember that this information is not always available, so use the conditionals to show alternate information in preference to assuming.
93 82
94\subsubsection{Battery Info} 83\subsubsection{Battery Info}
84
95\begin{center} 85\begin{center}
96 \begin{tabular}{@{}ll@{}}\toprule 86 \begin{tabular}{@{}ll@{}}\toprule
97 \textbf{Tag} & \textbf{Description}\\\midrule 87 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -107,6 +97,7 @@ Remember that this information is not always available, so use the conditionals
107\end{center} 97\end{center}
108 98
109\subsubsection{File Info} 99\subsubsection{File Info}
100
110\begin{center} 101\begin{center}
111 \begin{tabular}{@{}ll@{}}\toprule 102 \begin{tabular}{@{}ll@{}}\toprule
112 \textbf{Tag} & \textbf{Description}\\\midrule 103 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -130,6 +121,7 @@ Remember that this information is not always available, so use the conditionals
130Example for the the \%dN commands: If the path is "/Rock/Kent/Isola/11 - 747.mp3", \%d1 is "Isola", \%d2 is "Kent"... You get the picture. 121Example for the the \%dN commands: If the path is "/Rock/Kent/Isola/11 - 747.mp3", \%d1 is "Isola", \%d2 is "Kent"... You get the picture.
131 122
132\subsubsection{Playlist/Song Info} 123\subsubsection{Playlist/Song Info}
124
133\begin{center} 125\begin{center}
134 \begin{tabular}{@{}ll@{}}\toprule 126 \begin{tabular}{@{}ll@{}}\toprule
135 \textbf{Tag} & \textbf{Description}\\\midrule 127 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -156,6 +148,7 @@ Example for the the \%dN commands: If the path is "/Rock/Kent/Isola/11 - 747.mp3
156\end{center} 148\end{center}
157 149
158\subsubsection{Runtime Database} 150\subsubsection{Runtime Database}
151
159\begin{center} 152\begin{center}
160 \begin{tabular}{@{}ll@{}}\toprule 153 \begin{tabular}{@{}ll@{}}\toprule
161 \textbf{Tag} & \textbf{Description}\\\midrule 154 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -167,6 +160,7 @@ Example for the the \%dN commands: If the path is "/Rock/Kent/Isola/11 - 747.mp3
167 160
168\opt{h1xx,h300}{ 161\opt{h1xx,h300}{
169\subsubsection{Hold Switches} 162\subsubsection{Hold Switches}
163
170\begin{center} 164\begin{center}
171 \begin{tabular}{@{}ll@{}}\toprule 165 \begin{tabular}{@{}ll@{}}\toprule
172 \textbf{Tag} & \textbf{Description}\\\midrule 166 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -177,6 +171,7 @@ Example for the the \%dN commands: If the path is "/Rock/Kent/Isola/11 - 747.mp3
177} 171}
178 172
179\subsubsection{Virtual LED} 173\subsubsection{Virtual LED}
174
180\begin{center} 175\begin{center}
181 \begin{tabular}{@{}ll@{}}\toprule 176 \begin{tabular}{@{}ll@{}}\toprule
182 \textbf{Tag} & \textbf{Description}\\\midrule 177 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -185,6 +180,7 @@ Example for the the \%dN commands: If the path is "/Rock/Kent/Isola/11 - 747.mp3
185\end{center} 180\end{center}
186 181
187\subsubsection{Repeat Mode} 182\subsubsection{Repeat Mode}
183
188\begin{center} 184\begin{center}
189 \begin{tabular}{@{}ll@{}}\toprule 185 \begin{tabular}{@{}ll@{}}\toprule
190 \textbf{Tag} & \textbf{Description}\\\midrule 186 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -194,6 +190,7 @@ Example for the the \%dN commands: If the path is "/Rock/Kent/Isola/11 - 747.mp3
194Example: \%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle{\textbar}A-B{\textgreater} 190Example: \%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle{\textbar}A-B{\textgreater}
195 191
196\subsubsection{Playback Mode Tags} 192\subsubsection{Playback Mode Tags}
193
197\begin{center} 194\begin{center}
198 \begin{tabular}{@{}ll@{}}\toprule 195 \begin{tabular}{@{}ll@{}}\toprule
199 \textbf{Tag} & \textbf{Description}\\\midrule 196 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -203,6 +200,7 @@ Example: \%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle{\textbar
203Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater} 200Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}
204 201
205\subsubsection{Images} 202\subsubsection{Images}
203
206\begin{center} 204\begin{center}
207 \begin{tabular}{@{}ll@{}}\toprule 205 \begin{tabular}{@{}ll@{}}\toprule
208 \textbf{Tag} & \textbf{Description}\\\midrule 206 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -225,7 +223,8 @@ Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textba
225 & n = image ID (a-z and A-Z)\\\bottomrule 223 & n = image ID (a-z and A-Z)\\\bottomrule
226 \end{tabular} 224 \end{tabular}
227\end{center} 225\end{center}
228Example: image /.rockbox/bg.bmp with ID "a" at 37, 109 would be: \%x{\textbar}a{\textbar}bg.bmp{\textbar}37{\textbar}109{\textbar} 226Example: image /.rockbox/bg.bmp with ID "a" at 37, 109 would be:\\
227\%x{\textbar}a{\textbar}bg.bmp{\textbar}37{\textbar}109{\textbar}
229 228
230\begin{itemize} 229\begin{itemize}
231\item \textbf{Note:} The images must be in a rockbox compatible format (1 bit per pixel BMP) 230\item \textbf{Note:} The images must be in a rockbox compatible format (1 bit per pixel BMP)
@@ -235,11 +234,12 @@ Example: image /.rockbox/bg.bmp with ID "a" at 37, 109 would be: \%x{\textbar}a{
235\end{itemize} 234\end{itemize}
236 235
237\subsubsection{LCD Screen Sizes} 236\subsubsection{LCD Screen Sizes}
237
238\begin{center} 238\begin{center}
239 \begin{tabular}{@{}lll@{}}\toprule 239 \begin{tabular}{@{}lll@{}}\toprule
240 \textbf{Player} & \textbf{Main LCD Size} & \textbf{Remote LCD Size}\\\midrule 240 \textbf{Player} & \textbf{Main LCD Size} & \textbf{Remote LCD Size}\\\midrule
241 iRiver H1x0 & 160x128 & 128x64\\ 241 iriver H1x0 & 160x128 & 128x64\\
242 iRiver H3x0 & 220x176 & 128x64\\ 242 iriver H3x0 & 220x176 & 128x64\\
243 Archos Recorders & 112x64 & \\ 243 Archos Recorders & 112x64 & \\
244 Archos Ondio & 112x64 & \\ 244 Archos Ondio & 112x64 & \\
245 iPod Nano & 176x132 & \\ 245 iPod Nano & 176x132 & \\
@@ -250,6 +250,7 @@ Example: image /.rockbox/bg.bmp with ID "a" at 37, 109 would be: \%x{\textbar}a{
250\end{center} 250\end{center}
251 251
252\subsubsection{Alignment} 252\subsubsection{Alignment}
253
253\begin{center} 254\begin{center}
254 \begin{tabular}{@{}lll@{}}\toprule 255 \begin{tabular}{@{}lll@{}}\toprule
255 \textbf{Tag} & \textbf{Description}\\\midrule 256 \textbf{Tag} & \textbf{Description}\\\midrule
@@ -261,20 +262,21 @@ Example: image /.rockbox/bg.bmp with ID "a" at 37, 109 would be: \%x{\textbar}a{
261All alignment tags may be present in one line, but they need to be in the order left - center - right. If the aligned texts overlap, they are merged. 262All alignment tags may be present in one line, but they need to be in the order left - center - right. If the aligned texts overlap, they are merged.
262 263
263\subsubsection{Conditional Tags} 264\subsubsection{Conditional Tags}
265
264\textbf{If/else}\\ 266\textbf{If/else}\\
265\newline 267
266Syntax: \%?xx{\textless}true{\textbar}false{\textgreater}\\ 268Syntax: \%?xx{\textless}true{\textbar}false{\textgreater}\\
267 269
268If the tag specified by ``xx'' has a value, the text between the ``{\textless}'' and the ``{\textbar}'' is displayed (the true part), else the text between the ``{\textbar}'' and the ``{\textgreater}'' is displayed (the false part). 270If the tag specified by ``xx'' has a value, the text between the ``{\textless}'' and the ``{\textbar}'' is displayed (the true part), else the text between the ``{\textbar}'' and the ``{\textgreater}'' is displayed (the false part).
269The else part is optional, so the ``{\textbar}'' does not have to be specified if no else part is desired. The conditionals nest, so the text in the if and else part can contain all \% commands, including conditionals. 271The else part is optional, so the ``{\textbar}'' does not have to be specified if no else part is desired. The conditionals nest, so the text in the if and else part can contain all \% commands, including conditionals.
270\newline 272
271\textbf{Enumerations}\\ 273\textbf{Enumerations}\\
272\newline 274
273Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater} 275Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}\\
274 276
275For tags with multiple values, like Play status, the conditional can hold a list of alternatives, one for each value the tag can have. 277For tags with multiple values, like Play status, the conditional can hold a list of alternatives, one for each value the tag can have.
276 278
277Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater} 279Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}\\
278 280
279The last else part is optional, and will be displayed if the tag has no value. The WPS parser will always display the last part if the tag has no value, or if the list of alternatives is too short. 281The last else part is optional, and will be displayed if the tag has no value. The WPS parser will always display the last part if the tag has no value, or if the list of alternatives is too short.
280 282
@@ -323,11 +325,11 @@ as they are separated into different sublines.
323Example subline definition: 325Example subline definition:
324 326
325\begin{verbatim} 327\begin{verbatim}
326 %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds, 328 %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds,
327 Display id3 title for 2 seconds, 329 Display id3 title for 2 seconds,
328 Display current and remaining track time 330 Display current and remaining track time
329 for 3 seconds, 331 for 3 seconds,
330 repeat... 332 repeat...
331\end{verbatim} 333\end{verbatim}
332 334
333Conditionals can be used with sublines to display a different set and/or number of sublines on the line depending on the evaluation of the conditional. 335Conditionals can be used with sublines to display a different set and/or number of sublines on the line depending on the evaluation of the conditional.
@@ -357,11 +359,11 @@ Note that by using a subline display time of 0 in one branch of a conditional, a
357 %| : Display a '|' 359 %| : Display a '|'
358 %> : Display a '>' 360 %> : Display a '>'
359 %; : Display a ';' 361 %; : Display a ';'
360 %s : Indicate that the line should scroll. Can occur anywhere in 362 %s : Indicate that the line should scroll. Can occur
361 a line (given that the text is displayed; see conditionals 363 anywhere in a line (given that the text is displayed;
362 above). You can specify up to 10 scrolling lines. 364 see conditionals above). You can specify up to 10 scrolling
363 Scrolling lines can not contain dynamic content such as timers, 365 lines. Scrolling lines can not contain dynamic content such
364 peak meters or progress bars. 366 as timers, peak meters or progress bars.
365\end{verbatim} 367\end{verbatim}
366 368
367\subsubsection{Using Images} 369\subsubsection{Using Images}
@@ -391,8 +393,7 @@ This example loads and displays a background image, and preloads four other imag
391That is, "tracknum - title [artist, album]", where most fields are only displayed if available. Could also be rendered as "filename" or "tracknum - title [artist]". 393That is, "tracknum - title [artist, album]", where most fields are only displayed if available. Could also be rendered as "filename" or "tracknum - title [artist]".
392 394
393\subsubsection{Default} 395\subsubsection{Default}
394If you haven't selected a .wps file in the /.rockbox 396If you haven't selected a .wps file in the \fname{/.rockbox} directory, you get the hard coded layout. The default WPS screen is:
395directory, you get the hard coded layout. The default WPS screen is:
396\opt{player}{ 397\opt{player}{
397%\begin{verbatim} 398%\begin{verbatim}
398 %s%pp/%pe: %?it<%it|%fn> - %?ia<%ia|%d2> - %?id<%id|%d1> 399 %s%pp/%pe: %?it<%it|%fn> - %?ia<%ia|%d2> - %?id<%id|%d1>
@@ -418,7 +419,7 @@ A .cfg file is used to load settings from a plain text file. A .cfg file
418may reside anywhere on the hard disk. The only restriction is that the 419may reside anywhere on the hard disk. The only restriction is that the
419filename must end in .cfg 420filename must end in .cfg
420 421
421Hint: Use the ``Write .cfg file'' feature (Main Menu{}-{\textgreater} General Settings) to save the current settings, then use a text editor to customize the settings file. 422Hint: Use the ``Write .cfg file'' feature \textbf({Main Menu{}-{\textgreater} General Settings}) to save the current settings, then use a text editor to customize the settings file.
422 423
423\subsection{Format Rules} 424\subsection{Format Rules}
424 425
@@ -430,7 +431,7 @@ Hint: Use the ``Write .cfg file'' feature (Main Menu{}-{\textgreater} General Se
430 431
431\subsection{General Settings} 432\subsection{General Settings}
432\begin{center} 433\begin{center}
433 \begin{tabular}{@{}lll@{}}\toprule 434 \begin{longtable}{@{}lll@{}}\toprule
434 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule 435 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule
435 volume & 0 to 100 & \%\\ 436 volume & 0 to 100 & \%\\
436 bass & -15 to +15 & dB\\ 437 bass & -15 to +15 & dB\\
@@ -474,12 +475,12 @@ Hint: Use the ``Write .cfg file'' feature (Main Menu{}-{\textgreater} General Se
474 talk dir & off,number,spell,enter.hover & N/A\\ 475 talk dir & off,number,spell,enter.hover & N/A\\
475 talk file & off,number,spell & N/A\\ 476 talk file & off,number,spell & N/A\\
476 talk menu & off,on & N/A\\\bottomrule 477 talk menu & off,on & N/A\\\bottomrule
477 \end{tabular} 478 \end{longtable}
478\end{center} 479\end{center}
479 480
480\subsection{Recorder{}-specific settings} 481\subsection{Recorder{}-specific settings}
481\begin{center} 482\begin{center}
482 \begin{tabular}{@{}lll@{}}\toprule 483 \begin{longtable}{@{}lll@{}}\toprule
483 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule 484 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule
484 loudness & 0 to 17 & N/A\\ 485 loudness & 0 to 17 & N/A\\
485 super bass & on,off & N/A\\ 486 super bass & on,off & N/A\\
@@ -522,7 +523,7 @@ Hint: Use the ``Write .cfg file'' feature (Main Menu{}-{\textgreater} General Se
522 & 2:00, 4:00, 6:00, 8:00, 16:00, 24:00 & \\ 523 & 2:00, 4:00, 6:00, 8:00, 16:00, 24:00 & \\
523 pre-recording time & off, 1 to 30 & s\\ 524 pre-recording time & off, 1 to 30 & s\\
524 rec directory & /recordings,current & N/A\\\bottomrule 525 rec directory & /recordings,current & N/A\\\bottomrule
525 \end{tabular} 526 \end{longtable}
526\end{center} 527\end{center}
527 528
528\subsection{FM recorder specific settings} 529\subsection{FM recorder specific settings}
@@ -536,21 +537,13 @@ Hint: Use the ``Write .cfg file'' feature (Main Menu{}-{\textgreater} General Se
536\subsection{Example File} 537\subsection{Example File}
537\begin{verbatim} 538\begin{verbatim}
538 volume: 70 539 volume: 70
539
540 bass: 11 540 bass: 11
541
542 treble: 12 541 treble: 12
543
544 balance: 0 542 balance: 0
545
546 time format: 12hour 543 time format: 12hour
547
548 volume display: numeric 544 volume display: numeric
549
550 show files: supported 545 show files: supported
551
552 wps: /.rockbox/car.wps 546 wps: /.rockbox/car.wps
553
554 lang: /.rockbox/afrikaans.lng 547 lang: /.rockbox/afrikaans.lng
555\end{verbatim} 548\end{verbatim}
556 549
@@ -558,19 +551,12 @@ Hint: Use the ``Write .cfg file'' feature (Main Menu{}-{\textgreater} General Se
558There are 3 different types of firmware binaries from Rockbox website. Current Version, Daily Builds and Bleeding Edge. 551There are 3 different types of firmware binaries from Rockbox website. Current Version, Daily Builds and Bleeding Edge.
559 552
560\begin{itemize} 553\begin{itemize}
561\item \begin{itemize} 554\item The current version is the latest stable version developed by the Rockbox Team. It's free of known critical bugs. It is available from \url{http://www.rockbox.org/download/}.
562\item The current version is the latest stable version developed by the 555\item The Daily Build is a development version of Rockbox. It supports all new features and patches developed since last stable version. It may also contain bugs! This version is generated automatically every day and can be found at \url{http://www.rockbox.org/daily.shtml}.
563Rockbox Team. It's free of known critical bugs and works with Archos 556\item Bleeding edge builds are the same as the Daily build, but built from the latest development on each commit to the CVS repository. These builds are for people who want to test the code that developers just checked in.
564Jukebox Player/Studio, Recorders and Ondio devices. It is available
565from
566\url{http://www.rockbox.org/download/}.
567\item The Daily Build is a development version of Rockbox. It supports all new features and patches developed since last stable version. It may also contain bugs! This version is generated automatically every day and can be found at
568\url{http://www.rockbox.org/daily.shtml}.
569\item Bleeding edge builds are the same as the Daily build, but built
570from the latest development code every 20 minutes. These builds are for
571people who want to test the code that developers just checked in.
572\end{itemize}
573\end{itemize} 557\end{itemize}
558
559\opt{recorder,recorderv2fm,ondo,player}{
574There are binaries for different Jukebox models: 560There are binaries for different Jukebox models:
575 561
576\begin{itemize} 562\begin{itemize}
@@ -598,8 +584,11 @@ If in doubt as to which version to use, the table on page
598Note: All references in this manual to 584Note: All references in this manual to
599``Recorder'' apply equally to the FM Recorder 585``Recorder'' apply equally to the FM Recorder
600unless otherwise specified. 586unless otherwise specified.
587}
588
601 589
602\section{\label{ref:FirmwareLoading}Firmware Loading} 590\section{\label{ref:FirmwareLoading}Firmware Loading}
591\opt{player,recorder,recorderv2fm,ondio,player}{
603When your Jukebox powers on, it loads the Archos firmware in ROM, which 592When your Jukebox powers on, it loads the Archos firmware in ROM, which
604automatically checks your Jukebox hard disk's root folder for a file 593automatically checks your Jukebox hard disk's root folder for a file
605named \textbf{archos.mod} (on the player version) or 594named \textbf{archos.mod} (on the player version) or
@@ -608,292 +597,9 @@ firmware can only read the first ten characters of each file name in
608this process, so don't rename your old firmware files with names like 597this process, so don't rename your old firmware files with names like
609archos.mod.old and so on, because it's possible that the Jukebox will 598archos.mod.old and so on, because it's possible that the Jukebox will
610load a file other than the one you intended. 599load a file other than the one you intended.
600}
611 601
612\section{\label{ref:PartISection4}Using ROLO (Rockbox loader)} 602\section{\label{ref:PartISection4}Using ROLO (Rockbox loader)}
613Rockbox is able to load and start another firmware file without 603Rockbox is able to load and start another firmware file without rebooting. You just press PLAY on an \opt{recorder,recorderv2fm,ondio}{.ajz}\opt{player}{.mod}\opt{h1xx,h300}{.iriver}\opt{ipodnano,ipodvideo,ipodnano}{.ipod} file. This can be used to test new firmware versions without deleting your current version.
614rebooting. You just press PLAY on an .ajz (Recorder, Ondio) or .mod
615(Player) file. This can be used to test new firmware versions without
616deleting your current version, or to load the original Archos firmware
617(you have to download the appropriate file from
618Archos' website).
619
620\section{\label{ref:Rockboxinflash}Rockbox in flash (Recorder, Ondio)}
621\textbf{FLASHING ROCKBOX IS OPTIONAL!} It is not required for using
622Rockbox on your Jukebox Recorder. Please read the whole section
623thoroughly before flashing.
624
625\subsection{\label{ref:PartISection61}Introduction}
626Flashing in the sense used here and elsewhere in regard to Rockbox means
627reprogramming the flash memory of the Jukebox unit. Flash memory
628(sometimes called ``Flash ROM'') is a type of
629non{}-volatile memory that can be erased and reprogrammed in circuit. It is a variation of electrically erasable
630programmable read{}-only memory (EEPROM).
631
632A from the factory Jukebox comes with the Archos firmware flashed. It is
633possible to replace the built{}-in software with Rockbox.
634
635Terminology used in the following:\newline
636\textbf{Firmware} means the flash ROM content as a whole.\newline
637\textbf{Image} means one operating software started from there.
638
639By reprogramming the firmware, the Jukebox will boot much faster. The
640Archos boot loader seems to take forever compared to the Rockbox
641version. In fact, the Rockbox boot loader is so fast that it has to
642wait for the disk to spin up. The flashing procedure is a bit involved
643for the first time, updates are very simple later on.
644
645\subsection{\label{ref:Method}Method}
646The replaced firmware will host a bootloader and 2 images. This is made
647possible by compression. The first is the
648``permanent'' backup. The second is the
649default image to be started. The former is only used when you hold the
650F1 key during start, and is the original Archos firmware, the second is
651a current build of Rockbox. This second image is meant to be
652reprogrammed whenever a Rockbox upgrade is performed.
653
654There are two programming tools supplied:
655
656\begin{itemize}
657\item The first one is called \textbf{firmware\_flash.rock} and is used
658to program the whole flash with new content. It can also be used to
659revert back to the original firmware that is backed up as part of this
660procedure. This tool will only be needed once, and can be viewed as
661``formatting'' the flash with the desired image structure.
662\item The second one is called \textbf{rockbox\_flash.rock }and is used
663to reprogram only the second image. If the resulting programmed
664firmware image is not operational, it is
665possible to hold down the F1 key while booting to start the Jukebox
666with the Archos firmware and Rockbox booted from disk to reinstall a
667working firmware image.
668\end{itemize}
669
670\subsubsection{\label{ref:PartISection63}Risks}
671Well, is it dangerous? Yes, certainly, like programming a
672mainboard BIOS, CD/DVD drive firmware,
673mobile phone, etc. If the power fails, the chip malfunctions while
674programming or particularly if the programming software malfunctions,
675your Jukebox may stop functioning. The Rockbox team take no
676responsibility of any kind {}- do this at your own risk.
677
678However, the code has been extensively tested and is known to work well.
679 The new firmware file is completely read before it starts programming,
680there are a lot of sanity checks. If any fail, it will not program.
681There is no reason why such low level code should behave differently on
682your Jukebox.
683
684There's one ultimate safety net to bring back Jukeboxes
685with even completely garbled flash content: the UART boot mod, which in
686turn requires the serial mod. This can bring the dead back to life,
687with that it's possible to reflash independently from the outside, even
688if the flash is completely erased. It has been used during development,
689else Rockbox in flash wouldn't have been possible.
690Extensive development effort went into the development of the UART boot
691mod. Mechanically adept users with good soldering skills can easily
692perform these mods. Others may feel uncomfortable using the first tool
693(\textbf{firmware\_flash.rock}) for reflashing the firmware.
694
695If you are starting with a known{}-good image, you are unlikely to
696experience problems. The flash tools have been stable for quite a
697while. Several users have used them extensively, even flashing while
698playing! Although it worked, it's not the recommended
699method.
700
701The flashing software is very paranoid about making sure that the
702correct flash version is being installed. If the wrong file is used,
703it will simply refuse to flash the Jukebox.
704
705About the safety of operation: Since the Rockbox boot code gives ``dual
706boot'' capability, the Archos firmware is still there when you hold F1
707during startup. So even if you have problems with Rockbox from flash, you can still use
708the Jukebox, reflash the second image with an updated Rockbox copy,
709etc.
710
711The flash chip being used by Archos is specified for 100,000 cycles, so
712it's very unlikely that flashing it will wear it out.
713
714\subsection{\label{ref:Requirements}Requirements}
715You need two things:
716
717\begin{itemize}
718\item The first is a Recorder or FM model, or an Ondio SP or FM. Be sure
719you're using the correct package, they differ
720depending on your precise hardware! The technology works for the Player
721models, too. Players can also be flashed, but Rockbox does not run
722cold{}-started on those, yet.
723\item Second, you need an in{}-circuit programmable flash. Chances are
724about 85\% that you have, but Archos also used an older flash chip
725which can't do the trick. You can find out via Rockbox
726debug menu, entry Hardware Info. If the flash info gives you question
727marks, you're out of luck. The only option for
728flashing if this is the case is to solder in the right chip
729(SST39VF020), preferably with the firmware already in. If the chip is
730blank, you'll need the UART boot mod as well.
731\end{itemize}
732\subsubsection{\label{ref:FlashingProcedure}Flashing Procedure}
733Here are step{}-by{}-step instructions on how to flash and update to a
734current build. It is assumed that you can install and operate Rockbox
735the usual way. The flashing procedure has a lot of failsafes, and will
736check for correct model, file, etc. {}- if something is incompatible it
737just won't flash, that's all.
738
739Now here are the steps:
740
741\textbf{Preparation}
742
743Install (with all the files, not just the .ajz) and use the current
744daily build you'd like to have. Enable any voice
745features that are helpful throughout the process, such as menus and
746filename spelling. Set the file view to show all files, with the menu
747option \textbf{General Settings {}-{\textgreater} File View
748{}-{\textgreater} Show Files} set to ``all''.
749Have the Jukebox nicely charged to avoid
750running out of power during the flash write. Keep the Jukebox plugged
751into the charger until flashing is complete.
752
753{\bfseries
754Backup }
755
756Backup the existing flash content. This is not an essential part of the
757procedure, but is strongly recommended since you will need these files
758if you wish to reverse the flashing procedure, or if you need to update
759the bootloader (as opposed to the firmware) in the future. Keep them
760safe!
761
762Access the main menu by pressing F1 then select \textbf{Info
763{}-{\textgreater} Debug}. Select the first entry, \textbf{Dump ROM
764contents}, by pressing Play one more time. The disk should start to
765spin. Wait for it to settle down, then plug in the USB cable to copy
766the dump file this has just been created to your PC. The main folder of
767your Jukebox now should contain two strange .bin files. Copy the larger
768one named
769\textbf{internal\_rom\_2000000{}-203FFFF.bin}
770to a safe place, then delete them both from the box.
771
772{\bfseries
773Copy the new flash content file to your box }
774
775Depending on your model (recorder, FM, V2 recorder), download one of the
7763 packages:
777
778\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_rec.zip}
779
780\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_fm.zip}
781
782\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
783\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
784
785\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
786
787\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_ondiosp.zip}
788
789\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_ondiofm.zip}
790
791The zip archives contain two .bin files each. Those firmware*.bin files
792are all we want, copy them to the root directory of your box. The names
793differ depending on the model, the flash
794plugin will pick the right one, no way of
795doing this wrong.
796
797{\bfseries
798Install the Rockbox
799Bootloader (``formatting'' the flash)}
800
801This procedure is only necessary the first time you flash Rockbox.
802Unplug the USB cable again, then select \textbf{Browse
803}\textbf{Plugins}\textbf{ } from the main menu (F1). Locate \textbf{firmware\_flash.rock}, and start it with PLAY. Rockbox now displays an info screen, press F1 to acknowledge it and start a file check. Again wait for the disk to
804settle, then press F2 to proceed to a warning message (if the plugin
805has exited, you don't have the proper file) and F3 to actually program
806the file. This takes maybe 15 seconds, wait for the disk to settle
807again. Then press a key to exit the plugin.
808
809{\centering\itshape
810 [Warning: Image ignored] % Unhandled or unsupported graphics:
811%\includegraphics[width=3.609cm,height=2.062cm]{images/rockbox-manual-img75.png}
812 [Warning: Image ignored] % Unhandled or unsupported graphics:
813%\includegraphics[width=3.669cm,height=2.097cm]{images/rockbox-manual-img76.png}
814 \textmd{ } [Warning: Image ignored]
815% Unhandled or unsupported graphics:
816%\includegraphics[width=3.739cm,height=2.136cm]{images/rockbox-manual-img77.png}
817 \newline
818Flashing boot loader in 3 easy steps
819\par}
820
821{\bfseries
822\label{ref:FlashingRockbox}Install the Rockbox binary in flash}
823
824All the above was necessary only once, although there will not be any
825obvious difference (other than the Archos firmware loading a bit more quickly)
826after the step above is complete. Next install the actual Rockbox firmware thatwill be used from ROM. This is how Rockbox will be updated when
827installing a new release from now on.
828
829\begin{itemize}
830\item Unpack the whole build that you are installing onto the Jukebox,
831including plugins and support files. This can be done using the Windows setup program to install the new version onto the Jukebox.
832\item Test the build you are going to flash by playing the .ajz file so
833that ROLO loads it up. This puts the firmware in memory without
834changing your flash, so you can check that everything is working. If
835you have just installed the bootloader (see above) then this will happen automatically as the existing Archos firmware loads the .ajz that you have just installed. If upgrading ROMbox, this step \textbf{must }be carried out since Rockbox cannot overwrite the ROM while it is running from it.
836\item Play the .ucl file, which is usually found in the
837\textbf{/.rockbox} directory, this will kick off the
838\textbf{rockbox\_flash.rock} plugin. It's a bit
839similar to the other one, but it's made different to
840make the user aware. It will check the file, available size, etc. With
841F2 it begins programming, there is no need for warning this time. If it
842goes wrong, you'll still have the permanent image.
843
844{\centering\itshape
845 [Warning: Image ignored] % Unhandled or unsupported graphics:
846%\includegraphics[width=3.53cm,height=2.016cm]{images/rockbox-manual-img78.png}
847 \textmd{ } [Warning: Image ignored]
848% Unhandled or unsupported graphics:
849%\includegraphics[width=3.528cm,height=2.016cm]{images/rockbox-manual-img79.png}
850 \newline
851Using rockbox\_flash to update your boot firmware
852\par}
853\item It is possible that you could get an ``Incompatible
854Version'' error if the plugin interface has changed since
855you last flashed Rockbox. This means you are running an
856``old'' copy of Rockbox, but are trying to
857execute a newer plugin, the one you just downloaded. The easiest
858solution is to ROLO into this new version,
859by playing the\textbf{ ajbrec.ajz }file. Then you are consistent and can play
860\textbf{rockbox.ucl}.
861\item When done, you can restart the box and hopefully your new Rockbox
862image.
863\end{itemize}
864UCLs for the latest Recorder and FM firmware are included in Rockbox 2.4
865and also the daily builds.
866
867\subsection{\label{ref:KnownIssuesAndLimits}Known Issues and Limitations}
868There are two variants as to how the Jukebox starts, which is why there
869are normal and \_norom firmware files. The vast majority of Jukeboxes
870all have the same boot ROM content, but some have different flash
871content. Rockbox identifies this boot ROM with a CRC value of 0x222F in
872the hardware info screen. Some recorders have the boot ROM disabled (it
873might be unprogrammed) and start directly from a flash mirror at
874address zero. They need the \_norom firmware, it has a slightly
875different bootloader. Without a boot ROM there is no UART boot safety
876net. To compensate for that as much as possible the MiniMon monitor is
877included, and can be started by pressing F3+ON. Using this the box can
878be reprogrammed via serial if the UART mod has been applied and the
879first \~{}2000 bytes of the flash are OK.
880
881\subsubsection{ROMbox}
882ROMbox is a flashable version of Rockbox that is
883uncompressed and runs directly from the flash chip rather than being
884copied into memory first. The advantage of this is that memory that
885would normally be used for storing the Rockbox code can be used for
886buffering MP3s instead, resulting in less disk
887spin{}-ups and therefore longer battery life
888 Unfortunately being uncompressed, ROMbox requires more space in flash
889than Rockbox and will therefore not fit in the space that is left on an
890FM recorder. ROMbox therefore runs on the V1 and V2 recorder models
891only.
892
893The procedure for flashing ROMbox is identical to the procedure for
894flashing Rockbox as laid out on page \pageref{ref:FlashingRockbox}.
895The only difference is that the file to install is called
896\textbf{rombox.ucl}. ROMbox is included automatically with rockbox 2.4
897and all the current daily builds, so the procedure is identical
898otherwise.
899 604
605\opt{recorder,recorderv2fm,ondio}{\input{advanced_topics/archos-flashing.tex}}
diff --git a/manual/platform/h1xx.tex b/manual/platform/h1xx.tex
index 10c48ba389..76f4f808b6 100644
--- a/manual/platform/h1xx.tex
+++ b/manual/platform/h1xx.tex
@@ -4,3 +4,4 @@
4\newcommand{\playertype}{H1xx} 4\newcommand{\playertype}{H1xx}
5\newcommand{\playerlongtype}{iHP100, iHP115, iHP120, iHP140, H120 and H140} 5\newcommand{\playerlongtype}{iHP100, iHP115, iHP120, iHP140, H120 and H140}
6\newcommand{\genericimg}{160x128x2} 6\newcommand{\genericimg}{160x128x2}
7\newcommand{\dap}{player} \ No newline at end of file
diff --git a/manual/platform/h300.tex b/manual/platform/h300.tex
index a7cdd924f4..ddeb9488ab 100644
--- a/manual/platform/h300.tex
+++ b/manual/platform/h300.tex
@@ -3,4 +3,5 @@
3\newcommand{\playerman}{iRiver} 3\newcommand{\playerman}{iRiver}
4\newcommand{\playertype}{H3xx} 4\newcommand{\playertype}{H3xx}
5\newcommand{\playerlongtype}{H320 and H340} 5\newcommand{\playerlongtype}{H320 and H340}
6\newcommand{\genericimg}{220x176x16} \ No newline at end of file 6\newcommand{\genericimg}{220x176x16}
7\newcommand{\dap}{player} \ No newline at end of file
diff --git a/manual/platform/ipodcolor.tex b/manual/platform/ipodcolor.tex
index 6bf124ec3e..cd4e609081 100644
--- a/manual/platform/ipodcolor.tex
+++ b/manual/platform/ipodcolor.tex
@@ -3,4 +3,5 @@
3\newcommand{\playerman}{Apple} 3\newcommand{\playerman}{Apple}
4\newcommand{\playertype}{iPod Color} 4\newcommand{\playertype}{iPod Color}
5\newcommand{\playerlongtype}{\playertype} 5\newcommand{\playerlongtype}{\playertype}
6\newcommand{\genericimg}{220x176x16} \ No newline at end of file 6\newcommand{\genericimg}{220x176x16}
7\newcommand{\dap}{player} \ No newline at end of file
diff --git a/manual/platform/ipodnano.tex b/manual/platform/ipodnano.tex
index bef4924ddb..5f75ea23b0 100644
--- a/manual/platform/ipodnano.tex
+++ b/manual/platform/ipodnano.tex
@@ -3,4 +3,5 @@
3\newcommand{\playerman}{Apple} 3\newcommand{\playerman}{Apple}
4\newcommand{\playertype}{iPod Nano} 4\newcommand{\playertype}{iPod Nano}
5\newcommand{\playerlongtype}{\playertype} 5\newcommand{\playerlongtype}{\playertype}
6\newcommand{\genericimg}{176x132x16} \ No newline at end of file 6\newcommand{\genericimg}{176x132x16}
7\newcommand{\dap}{player} \ No newline at end of file
diff --git a/manual/platform/ipodvideo.tex b/manual/platform/ipodvideo.tex
index bee1c3cd26..c259683fe1 100644
--- a/manual/platform/ipodvideo.tex
+++ b/manual/platform/ipodvideo.tex
@@ -4,3 +4,4 @@
4\newcommand{\playertype}{iPod Video} 4\newcommand{\playertype}{iPod Video}
5\newcommand{\playerlongtype}{\playertype} 5\newcommand{\playerlongtype}{\playertype}
6\newcommand{\genericimg}{320x240x16} 6\newcommand{\genericimg}{320x240x16}
7\newcommand{\dap}{player} \ No newline at end of file
diff --git a/manual/platform/ondio.tex b/manual/platform/ondio.tex
index dfb4bcbe42..e52a1dda12 100644
--- a/manual/platform/ondio.tex
+++ b/manual/platform/ondio.tex
@@ -3,4 +3,5 @@
3\newcommand{\playerman}{Archos} 3\newcommand{\playerman}{Archos}
4\newcommand{\playertype}{Archos Ondio} 4\newcommand{\playertype}{Archos Ondio}
5\newcommand{\playerlongtype}{Ondio SP, FM} 5\newcommand{\playerlongtype}{Ondio SP, FM}
6\newcommand{\genericimg}{112x64x1} \ No newline at end of file 6\newcommand{\genericimg}{112x64x1}
7\newcommand{\dap}{player} \ No newline at end of file
diff --git a/manual/platform/player.tex b/manual/platform/player.tex
index 2c98314b09..8ce133aa69 100644
--- a/manual/platform/player.tex
+++ b/manual/platform/player.tex
@@ -4,3 +4,4 @@
4\newcommand{\playertype}{Studio/Player} 4\newcommand{\playertype}{Studio/Player}
5\newcommand{\playerlongtype}{Jukebox Studio 5000, 6000, Player 10 and 20} 5\newcommand{\playerlongtype}{Jukebox Studio 5000, 6000, Player 10 and 20}
6\newcommand{\genericimg}{charx11x1} 6\newcommand{\genericimg}{charx11x1}
7\newcommand{\dap}{player} \ No newline at end of file
diff --git a/manual/platform/recorder.tex b/manual/platform/recorder.tex
index 1ec75193d3..733a8d9792 100644
--- a/manual/platform/recorder.tex
+++ b/manual/platform/recorder.tex
@@ -3,4 +3,5 @@
3\newcommand{\playerman}{Archos} 3\newcommand{\playerman}{Archos}
4\newcommand{\playertype}{Recorder} 4\newcommand{\playertype}{Recorder}
5\newcommand{\playerlongtype}{Recorder 6, 10, 15 and 20} 5\newcommand{\playerlongtype}{Recorder 6, 10, 15 and 20}
6\newcommand{\genericimg}{112x64x1} \ No newline at end of file 6\newcommand{\genericimg}{112x64x1}
7\newcommand{\dap}{player} \ No newline at end of file
diff --git a/manual/platform/recorderv2fm.tex b/manual/platform/recorderv2fm.tex
index da1e509b90..21801aeaac 100644
--- a/manual/platform/recorderv2fm.tex
+++ b/manual/platform/recorderv2fm.tex
@@ -3,4 +3,5 @@
3\newcommand{\playerman}{Archos} 3\newcommand{\playerman}{Archos}
4\newcommand{\playertype}{Recorder V2/FM} 4\newcommand{\playertype}{Recorder V2/FM}
5\newcommand{\playertypelong}{Recorder V2 and FM Recorder} 5\newcommand{\playertypelong}{Recorder V2 and FM Recorder}
6\newcommand{genericimg}{112x64x1} \ No newline at end of file 6\newcommand{genericimg}{112x64x1}
7\newcommand{\dap}{player} \ No newline at end of file
diff --git a/manual/preamble.tex b/manual/preamble.tex
index bc19c9e7c9..d16f10310a 100644
--- a/manual/preamble.tex
+++ b/manual/preamble.tex
@@ -30,6 +30,7 @@
30\usepackage{subfigure} 30\usepackage{subfigure}
31\usepackage{color} 31\usepackage{color}
32\usepackage{booktabs} 32\usepackage{booktabs}
33\usepackage{longtable}
33%\usepackage{url} 34%\usepackage{url}
34%\urlstyle{same} 35%\urlstyle{same}
35 36