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