summaryrefslogtreecommitdiff
path: root/manual/advanced_topics/main.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/advanced_topics/main.tex')
-rw-r--r--manual/advanced_topics/main.tex840
1 files changed, 840 insertions, 0 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
new file mode 100644
index 0000000000..97165d6855
--- /dev/null
+++ b/manual/advanced_topics/main.tex
@@ -0,0 +1,840 @@
1\chapter{Advanced Topics}
2\newpage
3\section{\label{ref:CustomisingUI}Customising the userinterface}
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/}.
6
7\subsection{\label{ref:LoadingForts}Loading Fonts (Recorder, Ondio)}
8Rockbox can load fonts dynamically. Simply copy the .fnt file to the
9disk and ``play'' them in the directory browser or select \textbf{General Settings {\textgreater} Fonts} from the Main Menu .
10
11If 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
13must be at most 24 characters long.
14
15Any 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
17on the Rockbox website
18(Linux: \url{http://www.rockbox.org/fonts/convbdf}, Windows: \url{http://www.rockbox.org/fonts/convbdf.exe}).
19
20\subsection{\label{ref:Loadinglanguages}Loading Languages}
21Rockbox can load language files at runtime. Simply copy the .lng file
22(do not use the .lang file) to the Jukebox and
23``play'' it in the Rockbox directory browser
24or select \textbf{General Settings {}-{\textgreater} Languages }from
25the Main Menu.
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
34distribution.
35
36If your language is not yet supported and you want to write your own
37language file, follow these instructions:
38
39\begin{itemize}
40\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
42{\textless}language{\textgreater} is the local name for your language. i.e. svenska.lang, francais.lang etc.
43\item When you are done, submit your .lang file to Rockbox patch
44tracker.
45(\url{http://sourceforge.net/tracker/?group_id=44306&atid=439120})
46\end{itemize}
47
48\section{\label{ref:ConfiguringtheWPS}Configuring the WPS}
49
50\subsection{Description / General Info}
51
52\begin{itemize}
53\item The Custom While Playing Screen (WPS) display is used on both the
54Player and Recorder as a means to customise the WPS to the
55user's likings.
56\item After editing the .wps file, ``play'' it to make it take effect.
57\item The file may be 2 lines long for the Player, and 13 lines for the
58Recorder.
59\item All characters not preceded by \% are displayed as typed.
60\item Lines beginning with \# are comments and will be ignored.
61\end{itemize}
62
63\subsection{File Location}
64Custom WPS files may be located anywhere on the drive. The only
65restriction is that they must end in .wps. When PLAY is pressed on a
66.wps file, it will be used for future WPS screens. If the
67``played'' .wps file is located in the
68/.rockbox folder, it will be remembered and used after reboot. The .wps
69filename must be no more than 24 characters long for it to be
70remembered.
71
72\subsection{Tags}
73
74\begin{itemize}
75\item {\bfseries
76ID3 Info Tags:}
77
78\%ia : ID3 Artist
79
80\%ic : ID3 Composer
81
82\%id : ID3 Album Name
83
84\%ig : ID3 Genre Name
85
86\%in : ID3 Track Number
87
88\%it : ID3 Track Title
89
90\%iy : ID3 Year
91
92\%iv : ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)
93\item {\bfseries
94Battery Info:}
95
96\%bl : Show numeric battery level in percent
97
98\%bt : Show estimated battery time left
99\item {\bfseries
100File Info Tags:}
101
102\%fb : File Bitrate (in kbps)
103
104\%ff : File Frequency (in Hz)
105
106\%fm : File Name
107
108\%fn : File Name (without extension)
109
110\%fp : File Path
111
112\%fs : File Size (In Kilobytes)
113
114\%fv : ``(vbr)'' if variable bit rate or ``'' if constant bit rate
115
116\%d1 : First directory from end of file path.
117
118\%d2 : Second directory from end of file path.
119
120\%d3 : Third directory from end of file path.
121
122Example for the the \%dN commands: If the path is /Rock/Kent/Isola/11
123{}-747.mp3, \%d1 is ``Isola'', \%d2 is ``Kent'', \%d3 is ``Rock''.
124\end{itemize}
125
126\begin{itemize}
127\item {\bfseries
128Playlist/Song Info Tags:}
129
130\%pb : Progress Bar
131
132\begin{itemize}
133\item[] {
134Player: This will display a 1 character
135``cup'' that empties as the song progresses.}
136
137Recorder: This will replace the entire line with a progress bar.
138\end{itemize}
139\%pf : Player: Full{}-line progress bar + time display
140
141\%pc : Current Time In Song
142
143\%pe : Total Number of Playlist Entries
144
145\%pm : Peak Meter (Recorder only) {}- the entire line is used as volume
146peak meter.
147
148\%pn : Playlist Name (Without path or extension)
149
150\%pp : Playlist Position
151
152\%pr : Remaining Time In Song
153
154\%ps : Shuffle. Shows 's' if shuffle
155mode is enabled.
156
157\%pt : Total Track Time
158
159\%pv : Current volume
160\item {\bfseries
161Conditional Tags (If/Else block):}
162
163 \%?xx{\textless}{\textbar}{\textgreater} : Conditional: if the tag
164specified by ``xx'' has a value, the text
165between the ``{\textless}'' and the ``{\textbar}'' is displayed, else the text
166between the ``{\textbar}'' and the
167``{\textgreater}'' is displayed. The else part is optional, so the ``{\textbar}'' does not have to be specified if no else part is desired. The conditionals
168nest, so the text in the if and else part can contain all \% commands,
169including conditionals.
170\end{itemize}
171\begin{itemize}
172\item {\bfseries
173Next Song info}
174
175You can display information about the next song {}- the song that is
176about to play after the one currently playing (unless you change the
177plan).
178
179If you use the upper{}-case versions of the
180three tags: F, I and D, they will instead refer to the next song
181instead of the current one. Example: \%Ig is the genre name used in the
182next song and \%Ff is the mp3 frequency.
183
184Take note that the next song information WILL NOT be available at all
185times, but will most likely be available at the end of a song. We
186suggest you use the conditional display tag a lot when displaying
187information about the next song!
188\item {\bfseries
189Alternating sublines}
190
191It is possible to group items on each line into 2 or more groups or
192``sublines''. Each subline will be displayed
193in succession on the line for a specified time, alternating
194continuously through each defined subline.
195
196Items on a line are broken into sublines with the semicolon
197';' character. The display time for
198each subline defaults to 2 seconds unless modified by using the
199'\%t' tag to specify an alternate
200time (in seconds and optional tenths of a second) for the subline to be
201displayed.
202
203Subline related special characters and tags:
204
205; : Split items on a line into separate sublines
206
207\%t : Set the subline display time. The
208'\%t' is followed by either integer
209seconds (\%t5), or seconds and tenths of a second (\%t3.5).
210
211Each alternating subline can still be optionally scrolled while it is
212being displayed, and scrollable formats can be displayed on the same
213line with non{}-scrollable formats (such as track elapsed time) as long
214as they are separated into different sublines.
215\item {\bfseries
216Other Tags:}
217
218\%\% : Display a '\%'
219
220\%{\textless} : Display a
221'{\textless}'
222
223\%{\textbar} : Display a '{\textbar}'
224
225\%{\textgreater} : Display a
226'{\textgreater}'
227
228\%s : Indicate that the line should scroll. Can occur anywhere in a line
229(given that the text is displayed; see conditionals above). You can
230specify up to 10 scrolling lines. Scrolling lines can not contain
231dynamic content such as timers, peak meters or progress bars.
232\end{itemize}
233{\bfseries
234Example File}
235
236\%s\%pp/\%pe: \%?it{\textless}\%it{\textbar}\%fn{\textgreater} {}-
237\%?ia{\textless}\%ia{\textbar}\%d2{\textgreater} {}-
238\%?id{\textless}\%id{\textbar}\%d1{\textgreater}
239
240\%pb\%pc/\%pt
241
242That is, ``tracknum {}- title [artist,
243album]'', where most fields are only displayed if
244available. Could also be rendered as
245``filename'' or ``tracknum {}-title [artist]''.
246
247{\bfseries
248Default}
249
250If you haven't selected a .wps file in the /.rockbox
251directory, you get the hard coded layout. The default WPS screen for
252Players is:
253
254\%s\%pp/\%pe: \%?it{\textless}\%it{\textbar}\%fn{\textgreater} {}-
255\%?ia{\textless}\%ia{\textbar}\%d2{\textgreater} {}-
256\%?id{\textless}\%id{\textbar}\%d1{\textgreater}
257
258\%pc\%?ps{\textless}*{\textbar}/{\textgreater}\%pt
259
260And for the Recorder and Ondio:
261
262\%s\%?it{\textless}\%?in{\textless}\%in.
263{\textbar}{\textgreater}\%it{\textbar}\%fn{\textgreater}
264
265\%s\%?ia{\textless}\%ia{\textbar}\%?d2{\textless}\%d2{\textbar}(root){\textgreater}{\textgreater}
266
267\%s\%?id{\textless}\%id{\textbar}\%?d1{\textless}\%d1{\textbar}(root){\textgreater}{\textgreater}
268\%?iy{\textless}(\%iy){\textbar}{\textgreater}
269
270\%pc/\%pt [\%pp:\%pe]
271
272\%fbkBit \%?fv{\textless}avg{\textbar}{\textgreater}
273\%?iv{\textless}(id3v\%iv){\textbar}(no id3){\textgreater}
274
275\%pb
276
277\%pm
278
279\section{\label{ref:SettingsFile}Making your own settings file}
280A .cfg file is used to load settings from a plain text file. A .cfg file
281may reside anywhere on the hard disk. The only restriction is that the
282filename must end in .cfg
283
284Hint: Use the ``Write .cfg file'' feature
285(Main Menu{}-{\textgreater} General Settings) to save the current
286settings, then use a text editor to customize the settings file.
287
288{\bfseries
289Format Rules}
290
291\begin{itemize}
292\item Format: setting: value
293\item Each setting must be on a separate line.
294\item Lines starting with \# are ignored.
295\end{itemize}
296{\bfseries
297Settings (allowed values) [unit]}
298
299volume (0 {}- 100)
300
301bass ({}-15 {}- 15)
302
303treble ({}-15 {}- 15)
304
305balance ({}-100 {}- 100)
306
307channels (stereo, stereo narrow, stereo wide, mono, mono left,
308
309 mono right, karaoke)
310
311shuffle (on, off)
312
313repeat (off, all, one)
314
315play selected (on, off)
316
317resume (off, ask, ask once, on)
318
319scan min step (1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60) [secs]
320
321scan accel (0 {}- 15) [double scan speed every X seconds]
322
323antiskip (0 {}- 7) [seconds]
324
325volume fade (on, off)
326
327sort case (on, off)
328
329show files (all, supported, music, playlists)
330
331follow playlist (on, off)
332
333playlist viewer icons
334
335 (on, off)
336
337playlist viewer track display
338
339 (on, off)
340
341recursive directory insert
342
343 (on, off)
344
345scroll speed (0 {}- 15)
346
347scroll delay (0 {}- 250) [1/10s]
348
349scroll step (1 {}- 112) [pixels]
350
351bidir limit (0 {}- 200) [\% of screen width]
352
353contrast (0 {}- 63)
354
355backlight timeout (off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
35630,
357
358 45, 60, 90) [seconds]
359
360backlight when plugged
361
362 (on, off)
363
364disk spindown (3 {}- 254) [seconds]
365
366battery capacity (1500 {}- 2400) [mAh]
367
368idle poweroff (off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60)
369 [minutes]
370
371lang (/path/filename.lng)
372
373wps (/path/filename.wps)
374
375autocreate bookmarks (on, off)
376
377autoload bookmarks (on, off)
378
379use most{}-recent{}-bookmarks
380
381 (on, off)
382
383talk dir (off, number, spell, hover)
384
385talk file (off, number, spell, hover)
386
387talk menu (off, on)
388
389{\bfseries
390Recorder{}-specific settings}
391
392loudness (0 {}- 17)
393
394super bass (on, off)
395
396auto volume (off, 0.02, 2, 4, 8) [seconds]
397
398MDB enable (on, off)
399
400MDB strength (0 {--} 127) [dB]
401
402MDB harmonics (0 {--} 100) [\%]
403
404MDB center frequency (20{}-300) [Hz]
405
406MDB shape (50{}-300) [Hz]
407
408peak meter release (1 {}- 126)
409
410peak meter hold (off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8,
411
412 9, 10, 15, 20, 30, 1min)
413
414peak meter clip hold (on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
415
416
417 45, 60, 90, 2min, 3min, 5min, 10min, 20min,
418
419 45min, 90min)
420
421peak meter busy (on, off)
422
423peak meter dbfs (on, off) (on = dbfs, off = linear)
424
425peak meter min (0 {}- 89) [dB] or (0 {}- 100) [\%]
426
427peak meter max (0 {}- 89) [dB] or (0 {}- 100) [\%]
428
429statusbar (on, off)
430
431scrollbar (on, off)
432
433volume display (graphic, numeric)
434
435battery display (graphic, numeric)
436
437time format (12hour, 24hour)
438
439font (/path/filename.fnt)
440
441invert (on, off)
442
443deep discharge (on, off)
444
445trickle charge (on, off)
446
447disk poweroff (on, off)
448
449rec quality (0 {}- 7) (0=smallest size, 7=highest quality)
450
451rec frequency (48, 44, 32, 24, 22, 16) [kHz]
452
453rec source (mic, line, spdif)
454
455rec channels (mono, stereo)
456
457rec mic gain (0 to 15)
458
459rec left gain (0 to 15)
460
461rec right gain (0 to 15)
462
463editable recordings (on,off)
464
465rec timesplit (off, 00:05, 00:10, 00:20, 00:30, 01:00, 01:12, \newline
466 01:20, 02:00, 04:00, 06:00, 08:00, 16:00,\newline
467 24:00) [hh:mm]
468
469pre{}-recording time (off, 1{}-30) [secs]
470
471rec directory (/recordings, current)
472
473{\bfseries
474FM recorder specific settings}
475
476\textmd{force fm mono (on,off)}
477
478\textbf{Example File}
479
480volume: 70
481
482bass: 11
483
484treble: 12
485
486balance: 0
487
488time format: 12hour
489
490volume display: numeric
491
492show files: supported
493
494wps: /.rockbox/car.wps
495
496lang: /.rockbox/afrikaans.lng
497
498\section{\label{ref:PartISection1}Differences between binaries}
499There are 3 different types of firmware binaries from Rockbox website. Current Version, Daily Builds and Bleeding Edge.
500
501\begin{itemize}
502\item \begin{itemize}
503\item The current version is the latest stable version developed by the
504Rockbox Team. It's free of known critical bugs and works with Archos
505Jukebox Player/Studio, Recorders and Ondio devices. It is available
506from
507\url{http://www.rockbox.org/download/}.
508\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
509\url{http://www.rockbox.org/daily.shtml}.
510\item Bleeding edge builds are the same as the Daily build, but built
511from the latest development code every 20 minutes. These builds are for
512people who want to test the code that developers just checked in.
513\end{itemize}
514\end{itemize}
515There are binaries for different Jukebox models:
516
517\begin{itemize}
518\item \begin{itemize}
519\item The Player version is suitable for Archos Jukebox 5000, 6000 and
520all Studio models.
521\end{itemize}
522\end{itemize}
523\begin{itemize}
524\item \begin{itemize}
525\item If you have a recorder with cylindrically rounded bumpers, you
526need the ``regular'' recorder version.
527\item FM Recorders are models with a FM radio.
528\item The V2 recorder is a recorder in an FM Recorder form factor, but
529without radio.
530\item The 8mb version requires a hardware hack, where the RAM chips are
531replaced.
532\item The Ondio builds come with and without radio support, for the
533Ondio FM and SP respectively.
534\end{itemize}
535\end{itemize}
536If in doubt as to which version to use, the table on page
537\pageref{ref:Jukeboxtypetable} may be of assistance.
538
539Note: All references in this manual to
540``Recorder'' apply equally to the FM Recorder
541unless otherwise specified.
542
543\section{\label{ref:FirmwareLoading}Firmware Loading}
544When your Jukebox powers on, it loads the Archos firmware in ROM, which
545automatically checks your Jukebox hard disk's root folder for a file
546named \textbf{archos.mod} (on the player version) or
547\textbf{ajbrec.ajz} (on the recorder version). Note that Archos
548firmware can only read the first ten characters of each file name in
549this process, so don't rename your old firmware files with names like
550archos.mod.old and so on, because it's possible that the Jukebox will
551load a file other than the one you intended.
552
553\section{\label{ref:PartISection4}Using ROLO (Rockbox loader)}
554Rockbox is able to load and start another firmware file without
555rebooting. You just press PLAY on an .ajz (Recorder, Ondio) or .mod
556(Player) file. This can be used to test new firmware versions without
557deleting your current version, or to load the original Archos firmware
558(you have to download the appropriate file from
559Archos' website).
560
561\section{\label{ref:Rockboxinflash}Rockbox in flash (Recorder, Ondio)}
562\textbf{FLASHING ROCKBOX IS OPTIONAL!} It is not required for using
563Rockbox on your Jukebox Recorder. Please read the whole section
564thoroughly before flashing.
565
566\subsection{\label{ref:PartISection61}Introduction}
567Flashing in the sense used here and elsewhere in regard to Rockbox means
568reprogramming the flash memory of the Jukebox unit. Flash memory
569(sometimes called ``Flash ROM'') is a type of
570non{}-volatile memory that can be erased and reprogrammed in circuit. It is a variation of electrically erasable
571programmable read{}-only memory (EEPROM).
572
573A from the factory Jukebox comes with the Archos firmware flashed. It is
574possible to replace the built{}-in software with Rockbox.
575
576Terminology used in the following:\newline
577\textbf{Firmware} means the flash ROM content as a whole.\newline
578\textbf{Image} means one operating software started from there.
579
580By reprogramming the firmware, the Jukebox will boot much faster. The
581Archos boot loader seems to take forever compared to the Rockbox
582version. In fact, the Rockbox boot loader is so fast that it has to
583wait for the disk to spin up. The flashing procedure is a bit involved
584for the first time, updates are very simple later on.
585
586\subsection{\label{ref:Method}Method}
587The replaced firmware will host a bootloader and 2 images. This is made
588possible by compression. The first is the
589``permanent'' backup. The second is the
590default image to be started. The former is only used when you hold the
591F1 key during start, and is the original Archos firmware, the second is
592a current build of Rockbox. This second image is meant to be
593reprogrammed whenever a Rockbox upgrade is performed.
594
595There are two programming tools supplied:
596
597\begin{itemize}
598\item The first one is called \textbf{firmware\_flash.rock} and is used
599to program the whole flash with new content. It can also be used to
600revert back to the original firmware that is backed up as part of this
601procedure. This tool will only be needed once, and can be viewed as
602``formatting'' the flash with the desired image structure.
603\item The second one is called \textbf{rockbox\_flash.rock }and is used
604to reprogram only the second image. If the resulting programmed
605firmware image is not operational, it is
606possible to hold down the F1 key while booting to start the Jukebox
607with the Archos firmware and Rockbox booted from disk to reinstall a
608working firmware image.
609\end{itemize}
610
611\subsubsection{\label{ref:PartISection63}Risks}
612Well, is it dangerous? Yes, certainly, like programming a
613mainboard BIOS, CD/DVD drive firmware,
614mobile phone, etc. If the power fails, the chip malfunctions while
615programming or particularly if the programming software malfunctions,
616your Jukebox may stop functioning. The Rockbox team take no
617responsibility of any kind {}- do this at your own risk.
618
619However, the code has been extensively tested and is known to work well.
620 The new firmware file is completely read before it starts programming,
621there are a lot of sanity checks. If any fail, it will not program.
622There is no reason why such low level code should behave differently on
623your Jukebox.
624
625There's one ultimate safety net to bring back Jukeboxes
626with even completely garbled flash content: the UART boot mod, which in
627turn requires the serial mod. This can bring the dead back to life,
628with that it's possible to reflash independently from the outside, even
629if the flash is completely erased. It has been used during development,
630else Rockbox in flash wouldn't have been possible.
631Extensive development effort went into the development of the UART boot
632mod. Mechanically adept users with good soldering skills can easily
633perform these mods. Others may feel uncomfortable using the first tool
634(\textbf{firmware\_flash.rock}) for reflashing the firmware.
635
636If you are starting with a known{}-good image, you are unlikely to
637experience problems. The flash tools have been stable for quite a
638while. Several users have used them extensively, even flashing while
639playing! Although it worked, it's not the recommended
640method.
641
642The flashing software is very paranoid about making sure that the
643correct flash version is being installed. If the wrong file is used,
644it will simply refuse to flash the Jukebox.
645
646About the safety of operation: Since the Rockbox boot code gives ``dual
647boot'' capability, the Archos firmware is still there when you hold F1
648during startup. So even if you have problems with Rockbox from flash, you can still use
649the Jukebox, reflash the second image with an updated Rockbox copy,
650etc.
651
652The flash chip being used by Archos is specified for 100,000 cycles, so
653it's very unlikely that flashing it will wear it out.
654
655\subsection{\label{ref:Requirements}Requirements}
656You need two things:
657
658\begin{itemize}
659\item The first is a Recorder or FM model, or an Ondio SP or FM. Be sure
660you're using the correct package, they differ
661depending on your precise hardware! The technology works for the Player
662models, too. Players can also be flashed, but Rockbox does not run
663cold{}-started on those, yet.
664\item Second, you need an in{}-circuit programmable flash. Chances are
665about 85\% that you have, but Archos also used an older flash chip
666which can't do the trick. You can find out via Rockbox
667debug menu, entry Hardware Info. If the flash info gives you question
668marks, you're out of luck. The only option for
669flashing if this is the case is to solder in the right chip
670(SST39VF020), preferably with the firmware already in. If the chip is
671blank, you'll need the UART boot mod as well.
672\end{itemize}
673\subsubsection{\label{ref:FlashingProcedure}Flashing Procedure}
674Here are step{}-by{}-step instructions on how to flash and update to a
675current build. It is assumed that you can install and operate Rockbox
676the usual way. The flashing procedure has a lot of failsafes, and will
677check for correct model, file, etc. {}- if something is incompatible it
678just won't flash, that's all.
679
680Now here are the steps:
681
682\textbf{Preparation}
683
684Install (with all the files, not just the .ajz) and use the current
685daily build you'd like to have. Enable any voice
686features that are helpful throughout the process, such as menus and
687filename spelling. Set the file view to show all files, with the menu
688option \textbf{General Settings {}-{\textgreater} File View
689{}-{\textgreater} Show Files} set to ``all''.
690Have the Jukebox nicely charged to avoid
691running out of power during the flash write. Keep the Jukebox plugged
692into the charger until flashing is complete.
693
694{\bfseries
695Backup }
696
697Backup the existing flash content. This is not an essential part of the
698procedure, but is strongly recommended since you will need these files
699if you wish to reverse the flashing procedure, or if you need to update
700the bootloader (as opposed to the firmware) in the future. Keep them
701safe!
702
703Access the main menu by pressing F1 then select \textbf{Info
704{}-{\textgreater} Debug}. Select the first entry, \textbf{Dump ROM
705contents}, by pressing Play one more time. The disk should start to
706spin. Wait for it to settle down, then plug in the USB cable to copy
707the dump file this has just been created to your PC. The main folder of
708your Jukebox now should contain two strange .bin files. Copy the larger
709one named
710\textbf{internal\_rom\_2000000{}-203FFFF.bin}
711to a safe place, then delete them both from the box.
712
713{\bfseries
714Copy the new flash content file to your box }
715
716Depending on your model (recorder, FM, V2 recorder), download one of the
7173 packages:
718
719\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_rec.zip}
720
721\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_fm.zip}
722
723\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
724\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
725
726\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
727
728\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_ondiosp.zip}
729
730\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_ondiofm.zip}
731
732The zip archives contain two .bin files each. Those firmware*.bin files
733are all we want, copy them to the root directory of your box. The names
734differ depending on the model, the flash
735plugin will pick the right one, no way of
736doing this wrong.
737
738{\bfseries
739Install the Rockbox
740Bootloader (``formatting'' the flash)}
741
742This procedure is only necessary the first time you flash Rockbox.
743Unplug the USB cable again, then select \textbf{Browse
744}\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
745settle, then press F2 to proceed to a warning message (if the plugin
746has exited, you don't have the proper file) and F3 to actually program
747the file. This takes maybe 15 seconds, wait for the disk to settle
748again. Then press a key to exit the plugin.
749
750{\centering\itshape
751 [Warning: Image ignored] % Unhandled or unsupported graphics:
752%\includegraphics[width=3.609cm,height=2.062cm]{images/rockbox-manual-img75.png}
753 [Warning: Image ignored] % Unhandled or unsupported graphics:
754%\includegraphics[width=3.669cm,height=2.097cm]{images/rockbox-manual-img76.png}
755 \textmd{ } [Warning: Image ignored]
756% Unhandled or unsupported graphics:
757%\includegraphics[width=3.739cm,height=2.136cm]{images/rockbox-manual-img77.png}
758 \newline
759Flashing boot loader in 3 easy steps
760\par}
761
762{\bfseries
763\label{ref:FlashingRockbox}Install the Rockbox binary in flash}
764
765All the above was necessary only once, although there will not be any
766obvious difference (other than the Archos firmware loading a bit more quickly)
767after the step above is complete. Next install the actual Rockbox firmware thatwill be used from ROM. This is how Rockbox will be updated when
768installing a new release from now on.
769
770\begin{itemize}
771\item Unpack the whole build that you are installing onto the Jukebox,
772including plugins and support files. This can be done using the Windows setup program to install the new version onto the Jukebox.
773\item Test the build you are going to flash by playing the .ajz file so
774that ROLO loads it up. This puts the firmware in memory without
775changing your flash, so you can check that everything is working. If
776you 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.
777\item Play the .ucl file, which is usually found in the
778\textbf{/.rockbox} directory, this will kick off the
779\textbf{rockbox\_flash.rock} plugin. It's a bit
780similar to the other one, but it's made different to
781make the user aware. It will check the file, available size, etc. With
782F2 it begins programming, there is no need for warning this time. If it
783goes wrong, you'll still have the permanent image.
784
785{\centering\itshape
786 [Warning: Image ignored] % Unhandled or unsupported graphics:
787%\includegraphics[width=3.53cm,height=2.016cm]{images/rockbox-manual-img78.png}
788 \textmd{ } [Warning: Image ignored]
789% Unhandled or unsupported graphics:
790%\includegraphics[width=3.528cm,height=2.016cm]{images/rockbox-manual-img79.png}
791 \newline
792Using rockbox\_flash to update your boot firmware
793\par}
794\item It is possible that you could get an ``Incompatible
795Version'' error if the plugin interface has changed since
796you last flashed Rockbox. This means you are running an
797``old'' copy of Rockbox, but are trying to
798execute a newer plugin, the one you just downloaded. The easiest
799solution is to ROLO into this new version,
800by playing the\textbf{ ajbrec.ajz }file. Then you are consistent and can play
801\textbf{rockbox.ucl}.
802\item When done, you can restart the box and hopefully your new Rockbox
803image.
804\end{itemize}
805UCLs for the latest Recorder and FM firmware are included in Rockbox 2.4
806and also the daily builds.
807
808\subsection{\label{ref:KnownIssuesAndLimits}Known Issues and Limitations}
809There are two variants as to how the Jukebox starts, which is why there
810are normal and \_norom firmware files. The vast majority of Jukeboxes
811all have the same boot ROM content, but some have different flash
812content. Rockbox identifies this boot ROM with a CRC value of 0x222F in
813the hardware info screen. Some recorders have the boot ROM disabled (it
814might be unprogrammed) and start directly from a flash mirror at
815address zero. They need the \_norom firmware, it has a slightly
816different bootloader. Without a boot ROM there is no UART boot safety
817net. To compensate for that as much as possible the MiniMon monitor is
818included, and can be started by pressing F3+ON. Using this the box can
819be reprogrammed via serial if the UART mod has been applied and the
820first \~{}2000 bytes of the flash are OK.
821
822\subsubsection{ROMbox}
823ROMbox is a flashable version of Rockbox that is
824uncompressed and runs directly from the flash chip rather than being
825copied into memory first. The advantage of this is that memory that
826would normally be used for storing the Rockbox code can be used for
827buffering MP3s instead, resulting in less disk
828spin{}-ups and therefore longer battery life
829 Unfortunately being uncompressed, ROMbox requires more space in flash
830than Rockbox and will therefore not fit in the space that is left on an
831FM recorder. ROMbox therefore runs on the V1 and V2 recorder models
832only.
833
834The procedure for flashing ROMbox is identical to the procedure for
835flashing Rockbox as laid out on page \pageref{ref:FlashingRockbox}.
836The only difference is that the file to install is called
837\textbf{rombox.ucl}. ROMbox is included automatically with rockbox 2.4
838and all the current daily builds, so the procedure is identical
839otherwise.
840