diff options
author | Martin Arver <martin.arver@gmail.com> | 2006-06-15 11:56:50 +0000 |
---|---|---|
committer | Martin Arver <martin.arver@gmail.com> | 2006-06-15 11:56:50 +0000 |
commit | 30b0e66c602b3e3c0790d0fe89a8082590b7d058 (patch) | |
tree | 47a268a62ac5edecf95ae49b198e050f32a471a3 /manual/advanced_topics | |
parent | 9cee94f8f5ee6547f8ccf90dfbc87f1d605d64d8 (diff) | |
download | rockbox-30b0e66c602b3e3c0790d0fe89a8082590b7d058.tar.gz rockbox-30b0e66c602b3e3c0790d0fe89a8082590b7d058.zip |
Sync the flashing-chapter with the wiki (i.e. remove the old, and latexify the wiki version). Fix button-defines for player. Include flashing instructions for all the archos manuals.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10125 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/advanced_topics')
-rw-r--r-- | manual/advanced_topics/archos-flashing.tex | 525 | ||||
-rw-r--r-- | manual/advanced_topics/main.tex | 2 |
2 files changed, 258 insertions, 269 deletions
diff --git a/manual/advanced_topics/archos-flashing.tex b/manual/advanced_topics/archos-flashing.tex index 15cb1a42ea..399bf52903 100644 --- a/manual/advanced_topics/archos-flashing.tex +++ b/manual/advanced_topics/archos-flashing.tex | |||
@@ -1,278 +1,267 @@ | |||
1 | \section{\label{ref:Rockboxinflash}Rockbox in flash} | 1 | \section{\label{ref:Rockboxinflash}Rockbox in flash} |
2 | \textbf{FLASHING ROCKBOX IS OPTIONAL!} It is not required for using | 2 | \warn{Flashing Rockbox is optional. It is not required for using Rockbox on your |
3 | Rockbox on your Jukebox Recorder. Please read the whole section | 3 | \playername. Please read the whole section thoroughly before flashing. |
4 | thoroughly before flashing. | 4 | } |
5 | 5 | ||
6 | \subsection{\label{ref:PartISection61}Introduction} | 6 | \subsection{Introduction} |
7 | Flashing in the sense used here and elsewhere in regard to Rockbox means | 7 | Flashing in the sense used here and elsewhere in regard to Rockbox means |
8 | reprogramming the flash memory of the Jukebox unit. Flash memory | 8 | reprogramming the flash memory of the \playerman\ unit. |
9 | (sometimes called ``Flash ROM'') is a type of | 9 | |
10 | non{}-volatile memory that can be erased and reprogrammed in circuit. It is a variation of electrically erasable | 10 | When you bought your \playerman, it came with the \playerman\ firmware flashed. |
11 | programmable read{}-only memory (EEPROM). | 11 | Now, you can add Rockbox to the built-in software. |
12 | 12 | ||
13 | A from the factory Jukebox comes with the Archos firmware flashed. It is | 13 | \subsection{Terminology} |
14 | possible to replace the built{}-in software with Rockbox. | 14 | \begin{description} |
15 | 15 | \item[Firmware: ] The flash ROM content as a whole. | |
16 | Terminology used in the following:\newline | 16 | \item[Image: ] Means one operating software started from there |
17 | \textbf{Firmware} means the flash ROM content as a whole.\newline | 17 | \end{description} |
18 | \textbf{Image} means one operating software started from there. | 18 | |
19 | 19 | By reprogramming the firmware, we can boot much faster. \playerman\ has an | |
20 | By reprogramming the firmware, the Jukebox will boot much faster. The | 20 | unnecessary slow boot loader, versus the boot time for Rockbox is much faster |
21 | Archos boot loader seems to take forever compared to the Rockbox | 21 | than the disk spinup, in fact it has to wait for the disk. Your boot time will |
22 | version. In fact, the Rockbox boot loader is so fast that it has to | 22 | be as quick as a disk spinup (e.g. 4 seconds from powerup until resuming |
23 | wait for the disk to spin up. The flashing procedure is a bit involved | 23 | playback). |
24 | for the first time, updates are very simple later on. | 24 | |
25 | 25 | \subsection{Method} | |
26 | \subsection{\label{ref:Method}Method} | 26 | |
27 | The replaced firmware will host a bootloader and 2 images. This is made | 27 | The replaced firmware will host a bootloader and 2 images. This is possible by |
28 | possible by compression. The first is the | 28 | compression. The first is the \emph{permanent} backup, not to be changed any |
29 | ``permanent'' backup. The second is the | 29 | more.The second is the default one to be started, the first is only used when |
30 | default image to be started. The former is only used when you hold the | 30 | you hold the \opt{recorder,recorderv2fm}{\ButtonFOne}\opt{ondio}{\ButtonLeft}\opt{player}{\ButtonLeft} -key during start. Like supplied here, the first image |
31 | F1 key during start, and is the original Archos firmware, the second is | 31 | is the original Archos firmware, the second is empty, left for you to program |
32 | a current build of Rockbox. This second image is meant to be | 32 | and update. It can contain anything you like. If you prefer, you can program |
33 | reprogrammed whenever a Rockbox upgrade is performed. | 33 | the Archos firmware to there, too. |
34 | 34 | ||
35 | There are two programming tools supplied: | 35 | \note{For now, the binary contained in the brand new player flash package does |
36 | contain rockbox built from current cvs in the second image slot. This is to | ||
37 | lower the risk of flashing (at least one of the images will hopefully work) in | ||
38 | case you don't program a second image yourself in the first step. Of course the | ||
39 | second image can be replaced like with the other models.} | ||
40 | |||
41 | There are two programming tools supplied: | ||
36 | 42 | ||
37 | \begin{itemize} | 43 | \begin{itemize} |
38 | \item The first one is called \textbf{firmware\_flash.rock} and is used | 44 | \item The first one is called \fname{firmware\_flash.rock} and is used to |
39 | to program the whole flash with new content. It can also be used to | 45 | program the whole flash with a new content. You can also use it to revert |
40 | revert back to the original firmware that is backed up as part of this | 46 | back to the original firmware you've hopefully backup-ed. In the ideal case, |
41 | procedure. This tool will only be needed once, and can be viewed as | 47 | you'll need this tool only once. You can view this as "formatting" the flash |
42 | ``formatting'' the flash with the desired image structure. | 48 | with the desired image structure. |
43 | \item The second one is called \textbf{rockbox\_flash.rock }and is used | 49 | \item The second one is called \fname{rockbox\_flash.rock} and is used to |
44 | to reprogram only the second image. If the resulting programmed | 50 | reprogram only the second image. It won't touch any other byte, should be |
45 | firmware image is not operational, it is | 51 | safe to fool around with. If the programmed firmware is inoperational, you |
46 | possible to hold down the F1 key while booting to start the Jukebox | 52 | can still use the \opt{recorder,recorderv2fm}{\ButtonFOne}\opt{ondio}{\ButtonLeft}\opt{player}{\ButtonLeft} start with the Archos firmware and Rockbox booted |
47 | with the Archos firmware and Rockbox booted from disk to reinstall a | 53 | from disk to try better. |
48 | working firmware image. | ||
49 | \end{itemize} | 54 | \end{itemize} |
50 | 55 | ||
51 | \subsubsection{\label{ref:PartISection63}Risks} | 56 | The non-user tools are in the \fname{flash} subdirectory of the cvs source |
52 | Well, is it dangerous? Yes, certainly, like programming a | 57 | files. There's an authoring tool which composed the firmware file with the |
53 | mainboard BIOS, CD/DVD drive firmware, | 58 | bootloader and the 2 images. The bootloader project, a firmware extraction |
54 | mobile phone, etc. If the power fails, the chip malfunctions while | 59 | tool, the plugin sources, and the tools for the UART boot feature: a monitor |
55 | programming or particularly if the programming software malfunctions, | 60 | program for the box and a PC tool to drive it. Feel free to review the sources |
56 | your Jukebox may stop functioning. The Rockbox team take no | 61 | for all of it, but be careful when fooling around with powerful toys! |
57 | responsibility of any kind {}- do this at your own risk. | 62 | |
58 | 63 | \subsection{Risks} | |
59 | However, the code has been extensively tested and is known to work well. | 64 | Well, is it dangerous? Yes, certainly, like programming a mainboard |
60 | The new firmware file is completely read before it starts programming, | 65 | \emph{BIOS}, \emph{CD/DVD} drive firmware, mobile phone, etc. If the power |
61 | there are a lot of sanity checks. If any fail, it will not program. | 66 | fails, your chip breaks while programming or most of all the programming |
62 | There is no reason why such low level code should behave differently on | 67 | software malfunctions, you'll have a dead box. We take no responsibility of any |
63 | your Jukebox. | 68 | kind, you do that at your own risk. However, we tried as carefully as possible |
64 | 69 | to bulletproof this code. The new firmware file is completely read before it | |
65 | There's one ultimate safety net to bring back Jukeboxes | 70 | starts programming, there are a lot of sanity checks. If any fails, it will not |
66 | with even completely garbled flash content: the UART boot mod, which in | 71 | program. Before releasing this, we have checked the flow with exactly these |
67 | turn requires the serial mod. This can bring the dead back to life, | 72 | files supplied here, starting from the original firmware in flash. It worked |
68 | with that it's possible to reflash independently from the outside, even | 73 | reliably, there's no reason why such low level code should behave different on |
69 | if the flash is completely erased. It has been used during development, | 74 | your box. |
70 | else Rockbox in flash wouldn't have been possible. | 75 | |
71 | Extensive development effort went into the development of the UART boot | 76 | \opt{player}{ |
72 | mod. Mechanically adept users with good soldering skills can easily | 77 | \warn{The risk is slightly higher for player flashing, because: |
73 | perform these mods. Others may feel uncomfortable using the first tool | 78 | \begin{itemize} |
74 | (\textbf{firmware\_flash.rock}) for reflashing the firmware. | 79 | \item This is brand new |
75 | 80 | \item It could not be tested with all hardware versions. | |
76 | If you are starting with a known{}-good image, you are unlikely to | 81 | \end{itemize} |
77 | experience problems. The flash tools have been stable for quite a | 82 | Refer to this e-mail: |
78 | while. Several users have used them extensively, even flashing while | 83 | \url{http://www.rockbox.org/mail/archive/rockbox-archive-2004-12/0245.shtml} |
79 | playing! Although it worked, it's not the recommended | 84 | } |
80 | method. | 85 | } |
81 | 86 | ||
82 | The flashing software is very paranoid about making sure that the | 87 | There's one ultimate safety net to bring back boxes with even completely |
83 | correct flash version is being installed. If the wrong file is used, | 88 | garbled flash content: the \emph{UART} boot mod, which in turn requires the |
84 | it will simply refuse to flash the Jukebox. | 89 | serial mod. It can bring the dead back to life, with that it's possible to |
85 | 90 | reflash independently from the outside, even if the flash is completely erased. | |
86 | About the safety of operation: Since the Rockbox boot code gives ``dual | 91 | It has been used that during development, else Rockbox in flash wouldn't have |
87 | boot'' capability, the Archos firmware is still there when you hold F1 | 92 | been possible. Extensive development effort went into the exploitation of the |
88 | during startup. So even if you have problems with Rockbox from flash, you can still use | 93 | UART boot mod. Mechanically adept users with good soldering skills can easily |
89 | the Jukebox, reflash the second image with an updated Rockbox copy, | 94 | perform these mods. Others may feel uncomfortable using the first tool |
90 | etc. | 95 | (\fname{firmware\_flash.rock}) for reflashing the firmware. |
91 | 96 | ||
92 | The flash chip being used by Archos is specified for 100,000 cycles, so | 97 | |
93 | it's very unlikely that flashing it will wear it out. | 98 | To comfort you a bit again: If you are starting with a known-good image, you |
94 | 99 | are unlikely to experience problems. The flash tools have been stable for quite | |
95 | \subsection{\label{ref:Requirements}Requirements} | 100 | a while. Several users have used them extensively, even flashing while playing! |
96 | You need two things: | 101 | Although it worked, it's not the recommended method. |
97 | 102 | ||
103 | About the safety of operation: Since we have dual boot, you're not giving up | ||
104 | the Archos firmware. It's still there when you hold | ||
105 | \opt{recorder,recorderv2fm}{\ButtonFOne}\opt{ondio}{\ButtonLeft}\opt{player}{\ButtonLeft} during startup. So even if Rockbox from flash is not 100\% stable for | ||
106 | everyone, you can still use the box, reflash the second image with an updated | ||
107 | Rockbox copy, etc. | ||
108 | |||
109 | The flash chip being used by Archos is specified for 100,000 cycles, so you don't need to worry about that wearing out. | ||
110 | |||
111 | \subsection{Requirements} | ||
112 | You need two things: | ||
98 | \begin{itemize} | 113 | \begin{itemize} |
99 | \item The first is a Recorder or FM model, or an Ondio SP or FM. Be sure | 114 | \item The first is a \playername. Be sure you're using the correct package, |
100 | you're using the correct package, they differ | 115 | they are different! |
101 | depending on your precise hardware! The technology works for the Player | 116 | \item Second, you need an in-circuit programmable flash. \opt{recorder,recorderv2fm,player}{The older chips are not flashable.}\opt{ondio}{This should always |
102 | models, too. Players can also be flashed, but Rockbox does not run | 117 | be flashable on Ondios, because Archos does itself provide flash updates for |
103 | cold{}-started on those, yet. | 118 | these.} You can find out via Rockbox (\setting{Info $\rightarrow$ Debug $\rightarrow$ Hardware Info}). If the flash info gives you question marks (Flash M=?? D=??), |
104 | \item Second, you need an in{}-circuit programmable flash. Chances are | 119 | you're out of luck. The only chance then is to solder in the right chip |
105 | about 85\% that you have, but Archos also used an older flash chip | 120 | (SST39VF020), at best with the firmware already in. If the chip is blank, |
106 | which can't do the trick. You can find out via Rockbox | 121 | you'll need the UART boot mod as well. |
107 | debug menu, entry Hardware Info. If the flash info gives you question | ||
108 | marks, you're out of luck. The only option for | ||
109 | flashing if this is the case is to solder in the right chip | ||
110 | (SST39VF020), preferably with the firmware already in. If the chip is | ||
111 | blank, you'll need the UART boot mod as well. | ||
112 | \end{itemize} | 122 | \end{itemize} |
113 | \subsubsection{\label{ref:FlashingProcedure}Flashing Procedure} | 123 | |
114 | Here are step{}-by{}-step instructions on how to flash and update to a | 124 | \subsection{Flashing procedure} |
115 | current build. It is assumed that you can install and operate Rockbox | 125 | Short explanation: copy the \fname{firmware\_*.bin} files for your model from the |
116 | the usual way. The flashing procedure has a lot of failsafes, and will | 126 | distribution to the root directory of your \dap, then run the |
117 | check for correct model, file, etc. {}- if something is incompatible it | 127 | \fname{firmware\_flash.rock} plugin. |
118 | just won't flash, that's all. | 128 | Long version, step by step procedure: |
119 | 129 | \begin{enumerate} | |
120 | Now here are the steps: | 130 | \item Completely install the Rockbox version you want to have in flash, from a |
121 | 131 | full \fname{.zip} distribution, including all the plugins, etc. | |
122 | \textbf{Preparation} | 132 | \item Back up the current firmware, using the first option of the debug menu |
123 | 133 | (\setting{Info $\rightarrow$ Debug $\rightarrow$ Dump ROM Contents}). | |
124 | Install (with all the files, not just the .ajz) and use the current | 134 | This creates 2 files in the root directory, which you may not immediately see |
125 | daily build you'd like to have. Enable any voice | 135 | in the Rockbox browser. The 256kB-sized \fname{internal\_rom\_2000000-203FFFF.bin} one is your present firmware. Back both up to your PC. You will need them if |
126 | features that are helpful throughout the process, such as menus and | 136 | you want to restore the flash contents. |
127 | filename spelling. Set the file view to show all files, with the menu | 137 | \item Download the correct package for you model. Copy one or two files of it to |
128 | option \textbf{General Settings {}-{\textgreater} File View | 138 | your box: \fname{firmware\_*.bin} (name depends on your model) into the root |
129 | {}-{\textgreater} Show Files} set to ``all''. | 139 | directory (the initial firmware for your model, with the bootloader and the |
130 | Have the Jukebox nicely charged to avoid | 140 | Archos image). There now is also a \_norom variant, copy both, the plugin will |
131 | running out of power during the flash write. Keep the Jukebox plugged | 141 | decide which one is required for your box. |
132 | into the charger until flashing is complete. | 142 | \item Enter the debug menu and select the hardware info screen. Check your flash |
133 | 143 | IDs (bottom line), and please make a note about your \opt{recorder,recorderv2fm,ondio}{hardware mask value}\opt{player}{ROM version}. The latter is just for our | |
134 | {\bfseries | 144 | curiosity, not needed for the flow. If the flash info shows question marks, |
135 | Backup } | 145 | you can stop here, sorry. |
136 | 146 | \item Use the \opt{recorder,recorderv2fm}{\ButtonFTwo\ settings or }the menu (\setting{General settings $\rightarrow$ File view $\rightarrow$ Show files}) to | |
137 | Backup the existing flash content. This is not an essential part of the | 147 | configure seeing all files within the browser. |
138 | procedure, but is strongly recommended since you will need these files | 148 | \item Connect the charger and make sure your batteries are also in good shape. |
139 | if you wish to reverse the flashing procedure, or if you need to update | 149 | That's just for security reasons, it's not that flashing needs more power. |
140 | the bootloader (as opposed to the firmware) in the future. Keep them | 150 | \item Run the \fname{firmware\_flash.rock} plugin. It again tells you about your |
141 | safe! | 151 | flash and the file it's gonna program. After \opt{recorder,recorderv2fm}{\ButtonFOne}\opt{ondio}{\ButtonLeft}\opt{player}{\ButtonLeft} it checks the file. Your |
142 | 152 | hardware mask value will be kept, it won't overwrite it. Hitting \opt{recorder,recorderv2fm}{\ButtonFTwo}\opt{ondio}{\ButtonUp}\opt{player}{\ButtonOn} gives you | |
143 | Access the main menu by pressing F1 then select \textbf{Info | 153 | a big warning. If we still didn't manage to scare you off, you can hit\opt{recorder,recorderv2fm}{\ButtonFThree}\opt{ondio}{\ButtonRight}\opt{player}{\ButtonRight} to actually program and verify. The programming takes just a few seconds. If |
144 | {}-{\textgreater} Debug}. Select the first entry, \textbf{Dump ROM | 154 | the sanity check fails, you have the wrong kind of boot ROM and are out of luck |
145 | contents}, by pressing Play one more time. The disk should start to | 155 | by now, sorry. |
146 | spin. Wait for it to settle down, then plug in the USB cable to copy | 156 | \item In the unlikely event that the programming should give you any error, don't |
147 | the dump file this has just been created to your PC. The main folder of | 157 | switch off the box! Otherwise you'll have seen it working for the last time. |
148 | your Jukebox now should contain two strange .bin files. Copy the larger | 158 | While Rockbox is still in DRAM and operational, we could upgrade the plugin via |
149 | one named | 159 | USB and try again. If you switch it off, it's gone. |
150 | \textbf{internal\_rom\_2000000{}-203FFFF.bin} | 160 | \end{enumerate} |
151 | to a safe place, then delete them both from the box. | 161 | |
152 | 162 | \nopt{player}{ | |
153 | {\bfseries | 163 | Now the initial procedure is done. Since the second half of the flash is still |
154 | Copy the new flash content file to your box } | 164 | empty, there is ``just'' the Archos image starting when you reboot now. Not much |
155 | 165 | has changed yet. The Archos software starts a bit quicker than usual, then loads | |
156 | Depending on your model (recorder, FM, V2 recorder), download one of the | 166 | Rockbox from disk. The fun really starts when you add Rockbox to the flash, as |
157 | 3 packages: | 167 | described in the next section. |
158 | 168 | } | |
159 | \url{http://www.jens-arnold.net/Rockbox/flash_player.zip} | 169 | |
160 | 170 | \note{You may delete the \fname{.bin} files now.} | |
161 | \url{http://www.jens-arnold.net/Rockbox/flash_rec.zip} | 171 | |
162 | 172 | \subsection{Bringing in a Rockbox build} | |
163 | \url{http://www.jens-arnold.net/Rockbox/flash_fm.zip} | 173 | Short version: very easy, just play an \fname{.ucl} file like |
164 | 174 | \fname{rockbox.ucl} from a release or build: | |
165 | \url{http://www.jens-arnold.net/Rockbox/flash_v2.zip} | ||
166 | |||
167 | \url{http://www.jens-arnold.net/Rockbox/flash_ondiosp.zip} | ||
168 | |||
169 | \url{http://www.jens-arnold.net/Rockbox/flash_ondiofm.zip} | ||
170 | |||
171 | The zip archives contain two .bin files each. Those firmware*.bin files | ||
172 | are all we want, copy them to the root directory of your box. The names | ||
173 | differ depending on the model, the flash | ||
174 | plugin will pick the right one, no way of | ||
175 | doing this wrong. | ||
176 | |||
177 | {\bfseries | ||
178 | Install the Rockbox | ||
179 | Bootloader (``formatting'' the flash)} | ||
180 | |||
181 | This procedure is only necessary the first time you flash Rockbox. | ||
182 | Unplug the USB cable again, then select \textbf{Browse | ||
183 | }\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 | ||
184 | settle, then press F2 to proceed to a warning message (if the plugin | ||
185 | has exited, you don't have the proper file) and F3 to actually program | ||
186 | the file. This takes maybe 15 seconds, wait for the disk to settle | ||
187 | again. Then press a key to exit the plugin. | ||
188 | |||
189 | {\centering\itshape | ||
190 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
191 | %\includegraphics[width=3.609cm,height=2.062cm]{images/rockbox-manual-img75.png} | ||
192 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
193 | %\includegraphics[width=3.669cm,height=2.097cm]{images/rockbox-manual-img76.png} | ||
194 | \textmd{ } [Warning: Image ignored] | ||
195 | % Unhandled or unsupported graphics: | ||
196 | %\includegraphics[width=3.739cm,height=2.136cm]{images/rockbox-manual-img77.png} | ||
197 | \newline | ||
198 | Flashing boot loader in 3 easy steps | ||
199 | \par} | ||
200 | |||
201 | {\bfseries | ||
202 | \label{ref:FlashingRockbox}Install the Rockbox binary in flash} | ||
203 | |||
204 | All the above was necessary only once, although there will not be any | ||
205 | obvious difference (other than the Archos firmware loading a bit more quickly) | ||
206 | after the step above is complete. Next install the actual Rockbox firmware thatwill be used from ROM. This is how Rockbox will be updated when | ||
207 | installing a new release from now on. | ||
208 | 175 | ||
209 | \begin{itemize} | 176 | \begin{itemize} |
210 | \item Unpack the whole build that you are installing onto the Jukebox, | 177 | \item Make sure you are running the same version that you are trying to flash: |
211 | including plugins and support files. This can be done using the Windows setup program to install the new version onto the Jukebox. | 178 | play the \fname{ajbrec.ajz} file. |
212 | \item Test the build you are going to flash by playing the .ajz file so | 179 | \item Enter the \fname{.rockbox} directory in the file browser (you might need |
213 | that ROLO loads it up. This puts the firmware in memory without | 180 | to set the \setting{File View} option to \setting{All Files}). |
214 | changing your flash, so you can check that everything is working. If | 181 | \item Play the \fname{rockbox.ucl} file (or \fname{rombox.ucl} if you want to |
215 | you 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. | 182 | flash ROMBox) |
216 | \item Play the .ucl file, which is usually found in the | ||
217 | \textbf{/.rockbox} directory, this will kick off the | ||
218 | \textbf{rockbox\_flash.rock} plugin. It's a bit | ||
219 | similar to the other one, but it's made different to | ||
220 | make the user aware. It will check the file, available size, etc. With | ||
221 | F2 it begins programming, there is no need for warning this time. If it | ||
222 | goes wrong, you'll still have the permanent image. | ||
223 | |||
224 | {\centering\itshape | ||
225 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
226 | %\includegraphics[width=3.53cm,height=2.016cm]{images/rockbox-manual-img78.png} | ||
227 | \textmd{ } [Warning: Image ignored] | ||
228 | % Unhandled or unsupported graphics: | ||
229 | %\includegraphics[width=3.528cm,height=2.016cm]{images/rockbox-manual-img79.png} | ||
230 | \newline | ||
231 | Using rockbox\_flash to update your boot firmware | ||
232 | \par} | ||
233 | \item It is possible that you could get an ``Incompatible | ||
234 | Version'' error if the plugin interface has changed since | ||
235 | you last flashed Rockbox. This means you are running an | ||
236 | ``old'' copy of Rockbox, but are trying to | ||
237 | execute a newer plugin, the one you just downloaded. The easiest | ||
238 | solution is to ROLO into this new version, | ||
239 | by playing the\textbf{ ajbrec.ajz }file. Then you are consistent and can play | ||
240 | \textbf{rockbox.ucl}. | ||
241 | \item When done, you can restart the box and hopefully your new Rockbox | ||
242 | image. | ||
243 | \end{itemize} | 183 | \end{itemize} |
244 | UCLs for the latest Recorder and FM firmware are included in Rockbox 2.4 | 184 | |
245 | and also the daily builds. | 185 | Long version: |
246 | 186 | ||
247 | \subsection{\label{ref:KnownIssuesAndLimits}Known Issues and Limitations} | 187 | The second image is the working copy, the \fname{rockbox\_flash.rock} plugin from |
248 | There are two variants as to how the Jukebox starts, which is why there | 188 | this package reprograms it. The plugins needs to be consistant with the Rockbox |
249 | are normal and \_norom firmware files. The vast majority of Jukeboxes | 189 | plugin API version, otherwise it will detect mismatch and won't run. |
250 | all have the same boot ROM content, but some have different flash | 190 | |
251 | content. Rockbox identifies this boot ROM with a CRC value of 0x222F in | 191 | It requires an exotic input, a UCL-compressed image, because that's the internal |
252 | the hardware info screen. Some recorders have the boot ROM disabled (it | 192 | format. UCL is a nice open-source compression library. The decompression is very |
253 | might be unprogrammed) and start directly from a flash mirror at | 193 | fast and less than a page of C-code. The efficiency is even better than Zip with |
254 | address zero. They need the \_norom firmware, it has a slightly | 194 | maximum compression, reduces file size to about 58\% of the original size. For |
255 | different bootloader. Without a boot ROM there is no UART boot safety | 195 | details on UCL, see \url{http://www.oberhumer.com/opensource/ucl/}. |
256 | net. To compensate for that as much as possible the MiniMon monitor is | 196 | |
257 | included, and can be started by pressing F3+ON. Using this the box can | 197 | Rockbox developers using Linux will have to download it from there and compile |
258 | be reprogrammed via serial if the UART mod has been applied and the | 198 | it. For Win32 and Cygwin the executables are next to the packages. The sample |
259 | first \~{}2000 bytes of the flash are OK. | 199 | program from that download is called \fname{uclpack}. We'll use that to compress |
260 | 200 | \fname{rockbox.bin} which is the result of the compilation. This is a part of the | |
261 | \subsubsection{ROMbox} | 201 | build process meanwhile. If you compile Rockbox yourself, you should copy |
262 | ROMbox is a flashable version of Rockbox that is | 202 | \fname{uclpack} to a directory which is in the path, we recommend placing it in |
263 | uncompressed and runs directly from the flash chip rather than being | 203 | the same dir as SH compiler. |
264 | copied into memory first. The advantage of this is that memory that | 204 | |
265 | would normally be used for storing the Rockbox code can be used for | 205 | |
266 | buffering MP3s instead, resulting in less disk | 206 | Here are the steps: |
267 | spin{}-ups and therefore longer battery life | 207 | |
268 | Unfortunately being uncompressed, ROMbox requires more space in flash | 208 | \begin{enumerate} |
269 | than Rockbox and will therefore not fit in the space that is left on an | 209 | \item Normally, you'll simply download a \fname{.zip} distribution. Copy all the |
270 | FM recorder. ROMbox therefore runs on the V1 and V2 recorder models | 210 | content to the USB drive, replacing the old. |
271 | only. | 211 | \item Force a disk boot by holding \opt{recorder,recorderv2fm}{\ButtonFOne}\opt{ondio}{\ButtonLeft}\opt{player}{\ButtonLeft} during power-up, or at least rolo into |
272 | 212 | the new Rockbox version by \emph{Playing} the \fname{ajbrec.ajz}/fname{archos.mod} file. This may not always be necessary, but it's better to first run the | |
273 | The procedure for flashing ROMbox is identical to the procedure for | 213 | version you're about to flash. It is required if you are currently running |
274 | flashing Rockbox as laid out on page \pageref{ref:FlashingRockbox}. | 214 | RomBox. |
275 | The only difference is that the file to install is called | 215 | \item Just \emph{play} the \fname{.ucl} file in the \fname{.rockbox} directory, |
276 | \textbf{rombox.ucl}. ROMbox is included automatically with rockbox 2.4 | 216 | this will kick off the \fname{rockbox\_flash.rock} plugin. It's a bit similar |
277 | and all the current daily builds, so the procedure is identical | 217 | to the other one, but it's made different to make the user aware. It will check |
278 | otherwise. | 218 | the file, available size, etc. With \opt{recorder,recorderv2fm}{\ButtonFTwo}\opt{ondio}{\ButtonUp}\opt{player}{\ButtonOn} it's being programmed. No need for |
219 | warning this time. If it goes wrong, you'll still have the permanent image. | ||
220 | \item When done, you can restart the box and hopefully your new Rockbox image. | ||
221 | \end{enumerate} | ||
222 | |||
223 | You may find two \fname{.ucl} files in the \fname{.rockbox} folder. The | ||
224 | classical, compressed one is \fname{rockbox.ucl}. If your model has enough flash | ||
225 | space left, there may be an additional \fname{rombox.ucl}, which is uncompressed | ||
226 | and can run directly from flash ROM, saving some RAM. The second way is the newer | ||
227 | and now preferred one. Use this if available. | ||
228 | |||
229 | If you like or have to, you can also flash the Archos image as the second one. | ||
230 | E.g. in case Rockbox from flash doesn't work for you. This way you keep the dual | ||
231 | bootloader and you can easily try different later. The \fname{.ucl} of the Archos | ||
232 | firmware is included in the package. | ||
233 | |||
234 | \subsection{Restoring the original firmware} | ||
235 | If you'd like to revert to the original firmware, you can do like you did when | ||
236 | you flashed Rockbox for the first time. You simply use the backup files you saved | ||
237 | when flashing Rockbox for the first time and rename \fname{internal\_rom\_2000000-203FFFF.bin} to \fname{firmware\_*.bin} (name varies per model, use the filename that \fname{firmware\_flash.rock} asks for) and put it in the root. | ||
238 | |||
239 | \subsection{Known issues and limitations} | ||
240 | Rockbox has a charging screen, but it is not 100\% perfect. You'll get it when | ||
241 | the unit is off and you plug in the charger. The Rockbox charging algorithm is | ||
242 | first measuring the battery voltage for about 40 seconds, after that it only | ||
243 | starts charging when the capacity is below 85\%. | ||
244 | \opt{recorder,recorderv2fm}{You can use the Archos charging (which always tops off) by holding \ButtonFOne\ while plugging in.}\opt{recorderv2fm}{Some FM users reported charging problems even with \ButtonFOne, they had to revert to the original flash content.} | ||
245 | |||
246 | If the plugin API is changed, new builds may render the plugins incompatible. | ||
247 | When updating, make sure you grab those too, and ROLO or \opt{recorder,recorderv2fm}{\ButtonFOne}\opt{ondio}{\ButtonLeft}\opt{player}{\ButtonLeft} boot into the | ||
248 | new version before flashing it. | ||
249 | |||
250 | There are two variants of how the boxes starts, therefore the normal and the | ||
251 | \_norom firmware files. The vast majority of the \daps\ all have the same boot | ||
252 | ROM content, differentiation comes later by flash content. Rockbox identifies | ||
253 | this boot ROM with a CRC value of 0x222F in the hardware info screen. \opt{recorder,recorderv2fm}{Some recorders have the boot ROM disabled (it might be unprogrammed) and start directly from a flash mirror at address zero. They need the new | ||
254 | \_norom firmware that has a slightly different bootloader.} | ||
255 | Without a boot ROM there is no UART boot safety net. To compensate for that as | ||
256 | much as possible the MiniMon monitor is included, it starts with \opt{recorder,recorderv2fm}{\ButtonFThree+\ButtonOn}\opt{ondio}{\ButtonRight+\ButtonMenu}\opt{player}{\ButtonRight+\ButtonOn}. | ||
257 | Using that the box can be reprogrammed via serial if the first 2000 bytes of the | ||
258 | flash are OK. | ||
259 | |||
260 | \subsection{Download the new flash content file to your box} | ||
261 | Jens Arnold hosts flash content for download. Use the following url: | ||
262 | \opt{player}{\url{http://www.jens-arnold.net/Rockbox/flash\_player.zip}} | ||
263 | \opt{recorder}{\url{http://www.jens-arnold.net/Rockbox/flash\_rec.zip}} | ||
264 | \opt{recorderv2fm}{\url{http://www.jens-arnold.net/Rockbox/flash\_fm.zip}, | ||
265 | \url{http://www.jens-arnold.net/Rockbox/flash\_v2.zip}} | ||
266 | \opt{ondiofm}{\url{http://www.jens-arnold.net/Rockbox/flash\_ondiofm.zip}} | ||
267 | \opt{ondiosp}{\url{http://www.jens-arnold.net/Rockbox/flash\_ondiosp.zip}} | ||
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex index 41b52e0367..fb0f37d14f 100644 --- a/manual/advanced_topics/main.tex +++ b/manual/advanced_topics/main.tex | |||
@@ -315,4 +315,4 @@ You just press PLAY on an% | |||
315 | -file. This can be used to test new firmware versions without deleting your | 315 | -file. This can be used to test new firmware versions without deleting your |
316 | current version. | 316 | current version. |
317 | 317 | ||
318 | \opt{recorder,recorderv2fm,ondio}{\input{advanced_topics/archos-flashing.tex}} | 318 | \opt{archos}{\input{advanced_topics/archos-flashing.tex}} |