diff options
author | Dominik Riebeling <Dominik.Riebeling@gmail.com> | 2006-06-06 17:42:27 +0000 |
---|---|---|
committer | Dominik Riebeling <Dominik.Riebeling@gmail.com> | 2006-06-06 17:42:27 +0000 |
commit | 89a2a28ef3ec8301eb00a3dad01e8046701626d7 (patch) | |
tree | a6c30bf3b78c173d6651c7074f9817d14671bc51 /manual/getting_started | |
parent | ba53a26088414fbe0562acf172146e34c7bb2103 (diff) | |
download | rockbox-89a2a28ef3ec8301eb00a3dad01e8046701626d7.tar.gz rockbox-89a2a28ef3ec8301eb00a3dad01e8046701626d7.zip |
Fix commands display in ipod installation instructions by introducing a new code environment.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10077 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/getting_started')
-rwxr-xr-x | manual/getting_started/ipod_install.tex | 203 |
1 files changed, 99 insertions, 104 deletions
diff --git a/manual/getting_started/ipod_install.tex b/manual/getting_started/ipod_install.tex index 32b9794b38..08ba07db8c 100755 --- a/manual/getting_started/ipod_install.tex +++ b/manual/getting_started/ipod_install.tex | |||
@@ -1,18 +1,20 @@ | |||
1 | % $Id$ % | 1 | % $Id$ % |
2 | \subsection{Installing the bootloader} | 2 | \subsection{Installing the bootloader} |
3 | \warn{These instructions are preliminary! Please check the wiki for up-to-date | 3 | \warn{These instructions are preliminary and may contain errors! |
4 | and improved installation instructions!} | 4 | Please check the wiki for up-to-date and improved installation instructions! |
5 | If you find errors you're of course welcomed to report them so we can fix it | ||
6 | for the next daily builds.} | ||
5 | 7 | ||
6 | Installing the bootloader is the trickiest part of the installation. | 8 | Installing the bootloader is the trickiest part of the installation. |
7 | The process is different depending on your operating system, but before | 9 | The process is different depending on your operating system, but before |
8 | starting, connect the \dap\ to the computer using either an USB \fixme{or | 10 | starting, connect the \dap{} to the computer using either an USB \fixme{or |
9 | Firewire?} cable. Next, create a folder on the computer's harddrive and | 11 | Firewire?} cable. Next, create a folder on the computer's harddrive and |
10 | download the following file to that folder: | 12 | download the following file to that folder: |
11 | \opt{ipodvideo}{\wikilink{IpodInstallation/bootloader-video.bin}} | 13 | \opt{ipodvideo}{\wikilink{IpodInstallation/bootloader-video.bin}} |
12 | \opt{ipodnano}{\wikilink{IpodInstallation/bootloader-nano.bin}} | 14 | \opt{ipodnano}{\wikilink{IpodInstallation/bootloader-nano.bin}} |
13 | \opt{ipodmini}{\wikilink{IpodInstallation/bootloader-mini1g.bin} or | 15 | \opt{ipodmini}{\wikilink{IpodInstallation/bootloader-mini1g.bin} or |
14 | \wikilink{IpodInstallation/bootloader-mini1g.bin} depending on which | 16 | \wikilink{IpodInstallation/bootloader-mini1g.bin} depending on which |
15 | generation your \dap\ is.\fixme{Describe how to identify 1/2G}} | 17 | generation your \dap{} is.\fixme{Describe how to identify 1/2G}} |
16 | \opt{ipodcolor}{\wikilink{IpodInstallation/bootloader-color.bin}} | 18 | \opt{ipodcolor}{\wikilink{IpodInstallation/bootloader-color.bin}} |
17 | \opt{ipod4g}{\wikilink{IpodInstallation/bootloader-4g.bin}} | 19 | \opt{ipod4g}{\wikilink{IpodInstallation/bootloader-4g.bin}} |
18 | 20 | ||
@@ -20,8 +22,8 @@ and improved installation instructions!} | |||
20 | system on the computer. | 22 | system on the computer. |
21 | \note{These instructions all require you to have administrator rights | 23 | \note{These instructions all require you to have administrator rights |
22 | on your computer, regardless of the operating system.} | 24 | on your computer, regardless of the operating system.} |
23 | \note{Rockbox only works on FAT32 partitions (called Windows formatted by | 25 | \note{Rockbox only works on FAT32 partitions (called ``Windows formatted'' by |
24 | Apple). So if your \dap\ is Mac formatted (HFS+), you should first convert | 26 | Apple). So if your \dap{} is Mac formatted (HFS+), you should first convert |
25 | it to FAT32. Information on how to do this can be found on the Rockbox | 27 | it to FAT32. Information on how to do this can be found on the Rockbox |
26 | website. \fixme{Include these instructions?}} | 28 | website. \fixme{Include these instructions?}} |
27 | 29 | ||
@@ -33,44 +35,43 @@ and improved installation instructions!} | |||
33 | \item \wikilink{IpodInstallation/ipodpatcher.exe} | 35 | \item \wikilink{IpodInstallation/ipodpatcher.exe} |
34 | \item \wikilink{IpodInstallation/ipod_fw.exe} | 36 | \item \wikilink{IpodInstallation/ipod_fw.exe} |
35 | \end{itemize} | 37 | \end{itemize} |
36 | \item Locate the \dap\ by opening a commandprompt, change directory to the | 38 | \item Locate the \dap{} by opening a command windows. You can do this by |
39 | clicking ``Start'', ``Execute'' and typing \fname{cmd}. Press Enter to | ||
40 | execute that command. Now change directory to the | ||
37 | folder you created and run the following commands: | 41 | folder you created and run the following commands: |
38 | \begin{verbatim} | 42 | \begin{code} |
39 | ipodpatcher 0 | 43 | ipodpatcher 0 |
40 | ipodpatcher 1 | 44 | ipodpatcher 1 |
41 | ipodpatcher 2 | 45 | ipodpatcher 2 |
42 | ipodpatcher 3 | 46 | ipodpatcher 3 |
43 | etc. | 47 | \end{code} |
44 | \end{verbatim} | 48 | Keep increasing the number until the \dap{} is located. \fixme{What is the |
45 | Keep increasing the number until the \dap\ is located. \fixme{What is the | 49 | output?} Remember the number that corresponds to your \dap{} -- in the |
46 | output?} Remember the number that corresponds to your \dap\ -- in the | 50 | following steps, \emph{N} should be replaced with the number just found. |
47 | following steps, N should be replaced with the number just found. | 51 | \item Now, extract the firmware partition currently on the \dap{} with the |
48 | \item Now, extract the firmware partition currently on the \dap\ with the | ||
49 | following command: | 52 | following command: |
50 | \begin{verbatim} | 53 | \begin{code} |
51 | ipodpatcher -r N bootpartition.bin | 54 | ipodpatcher -r \emph{N} bootpartition.bin |
52 | \end{verbatim} | 55 | \end{code} |
53 | \note{You should keep a safe backup of this \fname{bootpartition.bin} file | 56 | \note{You should keep a safe backup of this \fname{bootpartition.bin} file |
54 | for use if you ever wish to either upgrade the Rockbox bootloader or | 57 | for use if you ever wish to either upgrade the Rockbox bootloader or |
55 | uninstall Rockbox from your iPod | 58 | uninstall Rockbox from your Ipod} |
56 | } | ||
57 | \item Extract the Apple firmware from the partition image image just created: | 59 | \item Extract the Apple firmware from the partition image image just created: |
58 | \begin{verbatim} | 60 | \begin{code} |
59 | ipodpatcher -r N bootpartition.bin | 61 | ipodpatcher -r \emph{N} bootpartition.bin |
60 | \end{verbatim} | 62 | \end{code} |
61 | \opt{ipodvideo}{ | 63 | \optv{ipodvideo}{ |
62 | \item Similarly, extract the Broadcom firmware: | 64 | \item Similarly, extract the Broadcom firmware: |
63 | \fixme{Formatting broken. Let's cause a break.} | 65 | \begin{code} |
66 | ipod_fw -o apple_sw_5g_rcsc.bin -e 1 bootpartition.bin | ||
67 | ipod_fw -g \emph{GEN} -o rockboot.bin -i apple_os.bin bootloader-\emph{GEN}.bin | ||
68 | \end{code} | ||
64 | } | 69 | } |
65 | \optv{ipodvideo}{\verb|ipod_fw -o apple_sw_5g_rcsc.bin -e 1 bootpartition.bin|} | ||
66 | \begin{verbatim} | ||
67 | ipod_fw -g GEN -o rockboot.bin -i apple_os.bin bootloader-GEN.bin | ||
68 | \end{verbatim} | ||
69 | \item | 70 | \item |
70 | Install the Rockbox-enabled firmware: | 71 | Install the Rockbox-enabled firmware: |
71 | \begin{verbatim} | 72 | \begin{code} |
72 | ipodpatcher -w N rockboot.bin | 73 | ipodpatcher -w \emph{N} rockboot.bin |
73 | \end{verbatim} | 74 | \end{code} |
74 | \end{enumerate} | 75 | \end{enumerate} |
75 | 76 | ||
76 | Now you can proceed installing the firmware itself. | 77 | Now you can proceed installing the firmware itself. |
@@ -88,60 +89,57 @@ Now you can proceed installing the firmware itself. | |||
88 | \fname{ipod\_fw} | 89 | \fname{ipod\_fw} |
89 | and diskdump files you downloaded are executable programs. To do this, | 90 | and diskdump files you downloaded are executable programs. To do this, |
90 | type the following command: | 91 | type the following command: |
91 | \begin{verbatim} | 92 | \begin{code} |
92 | chmod +x ipod_fw diskdump | 93 | chmod +x ipod_fw diskdump |
93 | \end{verbatim} | 94 | \end{code} |
94 | \fixme{Is this needed?} | 95 | \item Locate the \dap{} by running the following command: |
95 | These two programs are both licensed under the GPL, just like Rockbox | 96 | \begin{code} |
96 | itself. The source can be downloaded from the Rockbox website. | ||
97 | \item Locate the \dap\ by running the following command: | ||
98 | \begin{verbatim} | ||
99 | mount | 97 | mount |
100 | \end{verbatim} | 98 | \end{code} |
101 | The output will look something like this: \fixme{Add full example} | 99 | The output will look something like this: \fixme{Add full example} |
102 | \begin{verbatim} | 100 | \begin{code} |
103 | /dev/disk1s2 on /Volumes/DAVE_S IPOD 1 (local, nodev, nosuid) | 101 | /dev/disk1s2 on /Volumes/DAVE_S IPOD 1 (local, nodev, nosuid) |
104 | \end{verbatim} | 102 | \end{code} |
105 | In this example, the \dap\ is located at /dev/disk1s2 Remember the | 103 | In this example, the \dap\ is located at /dev/disk1s2 Remember the |
106 | location of your \dap\ -- in the following steps, /dev/disk1s2 should be | 104 | location of your \dap\ -- in the following steps, /dev/disk1s2 should be |
107 | replaced with the location just found. | 105 | replaced with the location just found. |
108 | \item Before continuing, the \dap\ must be ``unmounted'', which is | 106 | \item Before continuing, the \dap\ must be ``unmounted'', which is |
109 | done with the following command: | 107 | done with the following command: |
110 | \begin{verbatim} | 108 | \begin{code} |
111 | diskutil unmount /dev/disk1s2 | 109 | diskutil unmount /dev/disk1s2 |
112 | \end{verbatim} | 110 | \end{code} |
113 | \item Now, extract the Apple firmware currently on the \dap\ with the | 111 | \item Now, extract the Apple firmware currently on the \dap{} with the |
114 | following command: | 112 | following command: |
115 | \note{The last part of the location is left out.} | 113 | \note{The last part of the location is left out.} |
116 | \begin{verbatim} | 114 | \begin{code} |
117 | ./diskdump -r /dev/disk1 bootpartition.bin | 115 | ./diskdump -r /dev/disk1 bootpartition.bin |
118 | \end{verbatim} | 116 | \end{code} |
119 | \note{You should keep a safe backup of this \fname{bootpartition.bin} file | 117 | \note{You should keep a safe backup of this \fname{bootpartition.bin} file |
120 | for use if you ever wish to either upgrade the Rockbox bootloader or | 118 | for use if you ever wish to either upgrade the Rockbox bootloader or |
121 | uninstall Rockbox from your iPod | 119 | uninstall Rockbox from your iPod |
122 | } | 120 | } |
123 | \item Extract the Apple firmware from this partition image: | 121 | \item Extract the Apple firmware from this partition image: |
124 | \begin{verbatim} | 122 | \begin{code} |
125 | ./ipod_fw -o apple_os.bin -e 0 bootpartition.bin | 123 | ./ipod_fw -o apple_os.bin -e 0 bootpartition.bin |
126 | \end{verbatim} | 124 | \end{code} |
127 | \opt{ipodvideo}{ | 125 | \optv{ipodvideo}{ |
128 | \item Similarly, extract the Broadcom firmware: | 126 | \item Similarly, extract the Broadcom firmware: |
129 | \fixme{Formatting broken. Let's cause a break.} | 127 | \begin{code} |
128 | ./ipod_fw -o apple_sw_5g_rcsc.bin -e 1 bootpartition.bin | ||
129 | \end{code} | ||
130 | } | 130 | } |
131 | \optv{ipodvideo}{\verb|./ipod_fw -o apple_sw_5g_rcsc.bin -e 1 bootpartition.bin|} | ||
132 | |||
133 | \item Merge the Rockbox bootloader you downloaded previously with the Apple | 131 | \item Merge the Rockbox bootloader you downloaded previously with the Apple |
134 | firmware \fixme{Substitute GEN with your \daps\ generation: | 132 | firmware \fixme{Substitute GEN with your \daps{} generation: |
135 | color,video,nano,4g,mini1g,mini2g}: | 133 | color,video,nano,4g,mini1g,mini2g}: |
136 | \begin{verbatim} | 134 | \begin{code} |
137 | ./ipod_fw -g GEN -o rockbox.bin -i apple_os.bin bootloader-GEN.bin | 135 | ./ipod_fw -g \emph{GEN} -o rockbox.bin -i apple_os.bin bootloader-\emph{GEN}.bin |
138 | \end{verbatim} | 136 | \end{code} |
139 | \item | 137 | \item |
140 | Install the Rockbox-enabled firmware: | 138 | Install the Rockbox-enabled firmware: |
141 | \note{The last part of the location is left out.} | 139 | \note{The last part of the location is left out.} |
142 | \begin{verbatim} | 140 | \begin{code} |
143 | ./diskdump -w /dev/disk1 rockboot.bin | 141 | ./diskdump -w /dev/disk1 rockboot.bin |
144 | \end{verbatim} | 142 | \end{code} |
145 | \end{enumerate} | 143 | \end{enumerate} |
146 | 144 | ||
147 | Now, proceed with installing the firmware itself. | 145 | Now, proceed with installing the firmware itself. |
@@ -155,73 +153,70 @@ Now, proceed with installing the firmware itself. | |||
155 | \end{itemize} | 153 | \end{itemize} |
156 | Now compile it to an executable by opening a command prompt and changing | 154 | Now compile it to an executable by opening a command prompt and changing |
157 | to the folder created previously. Thn run the following command: | 155 | to the folder created previously. Thn run the following command: |
158 | \begin{verbatim} | 156 | \begin{code} |
159 | gcc -o ipod_fw ipod_fw.c | 157 | gcc -o ipod_fw ipod_fw.c |
160 | \end{verbatim} | 158 | \end{code} |
161 | If you get the message that the command gcc is not found, you need to | 159 | If you get the message that the command gcc is not found, you need to |
162 | install gcc. How to do this depends on your Linux distribution, and | 160 | install gcc. How to do this depends on your Linux distribution, and |
163 | you should consult its documentation for help on this. | 161 | you should consult its documentation for help on this. |
164 | \fixme{Is this needed?} | ||
165 | This program is licensed under the GPL, just like Rockbox itself. The | ||
166 | source can be downloaded from the Rockbox website. | ||
167 | \item Locate your Ipod by running the command \verb|dmesg|. In the output | 162 | \item Locate your Ipod by running the command \verb|dmesg|. In the output |
168 | something like the following should be seen: | 163 | something like the following should be seen: |
169 | \begin{verbatim} | 164 | \begin{code} |
170 | usb 4-1: new high speed USB device using ehci_hcd and address 7 | 165 | usb 4-1: new high speed USB device using ehci_hcd and address 7 |
171 | scsi4 : SCSI emulation for USB Mass Storage devices | 166 | scsi4 : SCSI emulation for USB Mass Storage devices |
172 | usb-storage: device found at 7 | 167 | usb-storage: device found at 7 |
173 | usb-storage: waiting for device to settle before scanning | 168 | usb-storage: waiting for device to settle before scanning |
174 | Vendor: Apple Model: iPod Rev: 1.62 | 169 | Vendor: Apple Model: iPod Rev: 1.62 |
175 | Type: Direct-Access ANSI SCSI revision: 00 | 170 | Type: Direct-Access ANSI SCSI revision: 00 |
176 | SCSI device sdb: 58605120 512-byte hdwr sectors (30006 MB) | 171 | SCSI device sdb: 58605120 512-byte hdwr sectors (30006 MB) |
177 | \end{verbatim} | 172 | \end{code} |
178 | In this example, the \dap\ is located on /dev/sdb. In the following, | 173 | You need the device name of your \dap, which you can find in the last line. |
179 | /dev/sdb should be replaced with the location just found. | 174 | In this example, the \dap\ is located on \fname{/dev/sdb}. In the following, |
180 | \item Run \verb|fdisk -l /dev/sdb| and press \verb|p|. Verify that the | 175 | \fname{/dev/sdb} should be replaced with the location just found. |
176 | \item Run \verb|fdisk -l /dev/sdb|. Verify that the | ||
181 | output is similar to the one below: | 177 | output is similar to the one below: |
182 | \begin{verbatim} | 178 | \begin{code} |
183 | ## Some text removed | 179 | Device Boot Start End Blocks Id System |
184 | Device Boot Start End Blocks Id System | 180 | /dev/sdb1 1 10 80293+ 0 Empty |
185 | /dev/sdb1 1 10 80293+ 0 Empty | 181 | /dev/sdb2 11 3648 29222235 b W95 FAT32 |
186 | /dev/sdb2 11 3648 29222235 b W95 FAT32 | 182 | \end{code} |
187 | \end{verbatim} | ||
188 | Exit fdisk by pressing \verb|q| | ||
189 | \item Back up the partition table using the following command: | 183 | \item Back up the partition table using the following command: |
190 | \note{The last part of the location is left out.} | 184 | \note{The last part of the location is left out.} |
191 | \begin{verbatim} | 185 | \begin{code} |
192 | dd if=/dev/sdb of=mbr.bin count=1 | 186 | dd if=/dev/\emph{sdb} of=mbr.bin count=1 |
193 | \end{verbatim} | 187 | \end{code} |
194 | 188 | ||
195 | \item Now, extract the firmware partition currently on the \dap\ with the | 189 | \item Now, extract the firmware partition currently on the \dap{} with the |
196 | following command: | 190 | following command: |
197 | \begin{verbatim} | 191 | \begin{code} |
198 | dd if=/dev/sdb1 of=bootpartition.bin | 192 | dd if=/dev/\emph{sdb1} of=bootpartition.bin |
199 | \end{verbatim} | 193 | \end{code} |
200 | \note{You should keep a safe backup of this \fname{bootpartition.bin} file | 194 | \note{You should keep a safe backup of this \fname{bootpartition.bin} file |
201 | for use if you ever wish to either upgrade the Rockbox bootloader or | 195 | for use if you ever wish to either upgrade the Rockbox bootloader or |
202 | uninstall Rockbox from your iPod | 196 | uninstall Rockbox from your Ipod |
203 | } | 197 | } |
204 | \item Extract the Apple firmware from this partition image: | 198 | \item Extract the Apple firmware from this partition image: |
205 | \begin{verbatim} | 199 | \begin{code} |
206 | ./ipod_fw -o apple_os.bin -e 0 bootpartition.bin | 200 | ./ipod_fw -o apple_os.bin -e 0 bootpartition.bin |
207 | \end{verbatim} | 201 | \end{code} |
208 | \opt{ipodvideo}{ | 202 | \optv{ipodvideo}{ |
209 | \item Similarly, extract the Broadcom firmware: | 203 | \item Similarly, extract the Broadcom firmware: |
210 | \fixme{Formatting broken. Let's cause a break.} | 204 | \begin{code} |
205 | ./ipod_fw -o apple_sw_5g_rcsc.bin -e 1 bootpartition.bin | ||
206 | \end{code} | ||
211 | } | 207 | } |
212 | \optv{ipodvideo}{\verb|./ipod_fw -o apple_sw_5g_rcsc.bin -e 1 bootpartition.bin|} | ||
213 | 208 | ||
214 | \item Merge the Rockbox bootloader you downloaded previously with the Apple | 209 | \item Merge the Rockbox bootloader you downloaded previously with the Apple |
215 | firmware \fixme{Substitute GEN with your \daps\ generation: | 210 | firmware \fixme{Substitute \emph{GEN} with your \daps{} generation: |
216 | color,video,nano,4g,mini1g,mini2g}: | 211 | color,video,nano,4g,mini1g,mini2g}: |
217 | \begin{verbatim} | 212 | \begin{code} |
218 | ./ipod_fw -g GEN -o rockbox.bin -i apple_os.bin bootloader-GEN.bin | 213 | ./ipod_fw -g \emph{GEN} -o rockbox.bin -i apple_os.bin bootloader-\emph{GEN}.bin |
219 | \end{verbatim} | 214 | \end{code} |
220 | \item | 215 | \item |
221 | Install the Rockbox-enabled firmware: | 216 | Install the Rockbox-enabled firmware: |
222 | \begin{verbatim} | 217 | \begin{code} |
223 | dd if=rockboot.bin of=/dev/sdb1 | 218 | dd if=rockboot.bin of=/dev/\emph{sdb1} |
224 | \end{verbatim} | 219 | \end{code} |
225 | \end{enumerate} | 220 | \end{enumerate} |
226 | Now you can install the firmware itself. | 221 | Now you can install the firmware itself. |
227 | 222 | ||