blob: 270a2ef71838bbfc5d3c046f4238fa03e2604660 [file] [log] [blame]
Dominik Riebeling2a731e42006-06-04 17:16:24 +00001% $Id$ %
Michael DiFebbo1f085512006-09-10 19:03:52 +00002
Dominik Riebeling40afbd22007-01-02 20:50:03 +00003\opt{ipodvideo}{\newcommand{\bootloaderfile}{bootloader-ipodvideo.ipod}}%
Michael DiFebbo5f61bb92007-01-17 22:00:37 +00004\opt{ipodmini}{\newcommand{\bootloaderfile}{bootloader-ipodmini.ipod}}%
Dominik Riebeling40afbd22007-01-02 20:50:03 +00005\opt{ipodnano}{\newcommand{\bootloaderfile}{bootloader-ipodnano.ipod}}%
6\opt{ipodcolor}{\newcommand{\bootloaderfile}{bootloader-ipodcolor.ipod}}%
7\opt{ipod4g}{\newcommand{\bootloaderfile}{bootloader-ipod4g.ipod}}%
8\opt{ipod3g}{\newcommand{\bootloaderfile}{bootloader-ipod3g.ipod}}%
9%
Martin Arverf1a848d2006-10-22 22:22:31 +000010\opt{ipodnano}{\warn{If your Nano has a stainless steel back and plastic front
11it is a 1st generation and is compatible with Rockbox. If, on the other hand,
12your Nano has a one-piece aluminum body it is a 2nd generation Nano and there
13is currently no Rockbox port available. Do not attempt to install the
14bootloader on a 2nd generation Nano}}
15
Dave Chapman55aabe32007-03-03 01:11:28 +000016\opt{ipod4g,ipodmini}{\fixme{NOTE: These instructions are known to have problems with the 1st and 2nd Generation Mini and 4th Generation (Greyscale) ipods - Rockbox loads correctly, but the original Apple firmware will not start. If you wish to continue to be able to use the Apple firmware, you should continue using the old installation instructions linked to at the bottom of \url{http://www.rockbox.org/twiki/bin/view/Main/IpodPort}.}}
17
Michael DiFebbo728dd272007-01-16 16:43:57 +000018In order to make your Ipod load and execute the Rockbox firmware you have just
Michael DiFebbo19e30842006-12-21 20:54:20 +000019installed, you will need to install the Rockbox bootloader. Unless bugs are
20found in the bootloader code, or significant new feature are added, you will
21only have to perform this step once.
Michael DiFebbo95afcf52006-06-04 14:44:10 +000022
Michael DiFebbo19e30842006-12-21 20:54:20 +000023The following instructions refer to the ``installation folder.'' For Windows
Michael DiFebbo728dd272007-01-16 16:43:57 +000024users, the ``installation folder'' is a folder in the root (top-level) of the C:
25drive called \fname{\textbackslash{}rockbox} (you will obviously need to create
26this folder yourself). For Mac OS X and Linux users, the ``installation
27folder'' is assumed to be the Desktop folder. Note that the bootloader
28installation files should be saved onto your computer's hard disk, \emph{not} on
29your Ipod.
Michael DiFebbo95afcf52006-06-04 14:44:10 +000030
Michael DiFebbo19e30842006-12-21 20:54:20 +000031\begin{enumerate}
Dominik Riebeling840b1c22006-07-10 07:04:43 +000032
Michael DiFebbo19e30842006-12-21 20:54:20 +000033 \item First, download the \fname{ipodpatcher} tool to your installation
Paul Loudend71b44c2007-02-05 21:16:16 +000034 folder. You can download the \fname{ipodpatcher} tool for your operating
Dominik Riebelinge3707762007-01-05 23:01:51 +000035 system at \download{bootloader/ipod/ipodpatcher/}.
Michael DiFebbo19e30842006-12-21 20:54:20 +000036
37 \item Next, download the following file to the installation folder:
Dominik Riebeling840b1c22006-07-10 07:04:43 +000038
Dominik Riebeling40afbd22007-01-02 20:50:03 +000039 \download{bootloader/ipod/\bootloaderfile}
40 \opt{ipodmini}{%
41 or \download{bootloader/ipod/bootloader-ipodmini2g.ipod}
42 depending on which generation your \dap{} is.
43 The following page describes the differences between the two
44 generations of the \dap{}:
45 \url{http://docs.info.apple.com/article.html?artnum=300850}.
46 }
Dominik Riebeling840b1c22006-07-10 07:04:43 +000047
Michael DiFebbo19e30842006-12-21 20:54:20 +000048 \item Next, open a command prompt (Windows) or terminal window (Mac OSX and Linux).
49
50 Windows users will perform this and the following steps from the Windows
Michael DiFebbo728dd272007-01-16 16:43:57 +000051 command prompt. To start a command prompt, click \fname{start}, and then
52 click \fname{Run...}. Type ``cmd'' and press \fname{Enter}. Navigate
53 to the installation directory by typing the following command:
Michael DiFebbo95afcf52006-06-04 14:44:10 +000054
Michael DiFebbo728dd272007-01-16 16:43:57 +000055 \begin{code}
56 cd \textbackslash{}rockbox
57 \end{code}
58
Michael DiFebbo19e30842006-12-21 20:54:20 +000059 Mac OS X and Linux/Unix users will perform these steps from the Terminal.
60 Start a new terminal window and navigate to the Desktop folder (type cd
61 Desktop into the terminal and press enter). You then need to ensure that the
62 ipodpatcher program is ``executable'' by typing the command chmod +x
Michael DiFebbo728dd272007-01-16 16:43:57 +000063 ipodpatcher and then pressing \fname{Enter}.
Michael DiFebbo19e30842006-12-21 20:54:20 +000064
Michael DiFebbo728dd272007-01-16 16:43:57 +000065 \item Connect your Ipod to your computer.
Michael DiFebbo95afcf52006-06-04 14:44:10 +000066
Paul Loudend71b44c2007-02-05 21:16:16 +000067 If you haven't already done so, you should now plug your Ipod into your
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +000068 computer (via either the USB or Firewire cable).
Michael DiFebbo95afcf52006-06-04 14:44:10 +000069
Paul Loudend71b44c2007-02-05 21:16:16 +000070 \fixme{Notes about closing itunes, enabling the ``show ipod as disk'' option
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +000071 in ipod, anything else?}
Michael DiFebbo95afcf52006-06-04 14:44:10 +000072
Paul Loudend71b44c2007-02-05 21:16:16 +000073 \item Find your Ipod with ipodpatcher (Windows and Linux users only)
Michael DiFebbo95afcf52006-06-04 14:44:10 +000074
Paul Loudend71b44c2007-02-05 21:16:16 +000075 Type the following command to search for Ipods attached to
76 your computer:
77 \begin{code}
78 ipodpatcher --scan
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +000079 \end{code}
Paul Loudend71b44c2007-02-05 21:16:16 +000080
81 Windows users: when ipodpatcher finds your Ipod, remember the number it displays after the
82 words ``disk device''- this will be the number you use to access your Ipod
83 in the following steps. So, for example, if ipodpatcher displays ``disk
Michael DiFebbo728dd272007-01-16 16:43:57 +000084 device 1'' you will use the number 1 in the commands described below.
Michael DiFebbo95afcf52006-06-04 14:44:10 +000085
Paul Loudend71b44c2007-02-05 21:16:16 +000086 Linux users: you will receive something similar to /dev/sda, and will use that
87 in the commands described below.
88
89 \note{Windows users require administrator rights for running ipodpatcher.
90 Either re-login as administrator, or open a command prompt running under an
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +000091 administrator account by using one of the "Run as" features of Windows XP.}
Dominik Riebeling53254012006-10-10 13:21:09 +000092
Michael DiFebbo728dd272007-01-16 16:43:57 +000093 \item Find your Ipod (Mac OS X users only)
Michael DiFebbo95afcf52006-06-04 14:44:10 +000094
Michael DiFebbo728dd272007-01-16 16:43:57 +000095 Attach your Ipod to your Mac (using either USB or Firewire) and wait for
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +000096 iTunes to open. When iTunes opens, close it down. In your Terminal window,
97 type the command mount and press enter. This will list all the disks (and
98 other devices) that are "mounted" on your computer. The last drive in the
Michael DiFebbo728dd272007-01-16 16:43:57 +000099 list should be your Ipod. For example:
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000100 \begin{code}
101 /dev/disk1s2 on /Volumes/DAVE_S IPOD 1 (local, nodev, nosuid)
102 \end{code}
Michael DiFebbo19e30842006-12-21 20:54:20 +0000103
Michael DiFebbo728dd272007-01-16 16:43:57 +0000104 In order to install the ipod bootloader, you need to ``unmount'' this disk
Michael DiFebbo8bde9472007-01-02 18:27:29 +0000105 using the following command:
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000106 \begin{code}
107 diskutil unmount /dev/disk1s2
108 \end{code}
109
110 replacing ``/dev/disk1s2'' with the device name Mac OS has assigned to your
Michael DiFebbo728dd272007-01-16 16:43:57 +0000111 Ipod. This may take a few seconds, after which Mac OS will say ``Volume
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000112 /dev/disk1s2 unmounted.'' ``/dev/disk1s2'' refers to the second partition on
113 /dev/disk1 - remember ``/dev/disk1'' for the next step.
Michael DiFebbo19e30842006-12-21 20:54:20 +0000114
Michael DiFebbo728dd272007-01-16 16:43:57 +0000115 It's possible that itunes will try to be ``helpful'' and remount your Ipod
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000116 after you modify it with ipodpatcher. If this happens, you need to unmount
117 it again using the above command.
Michael DiFebbo19e30842006-12-21 20:54:20 +0000118
Michael DiFebbo728dd272007-01-16 16:43:57 +0000119 \item Create a backup of your Ipod's firmware partition
Michael DiFebbo19e30842006-12-21 20:54:20 +0000120
Michael DiFebbo728dd272007-01-16 16:43:57 +0000121 Type the following command, replacing ``N'' with the number (for
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000122 Windows users) or the device name (Mac OS X and Unix users) assigned to
Michael DiFebbo728dd272007-01-16 16:43:57 +0000123 your Ipod that you identified in the previous step:
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000124 \begin{code}
Michael DiFebbo728dd272007-01-16 16:43:57 +0000125 ipodpatcher N -r bootpartition.bin (Windows)
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000126 \end{code}
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000127 or
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000128 \begin{code}
Michael DiFebbo728dd272007-01-16 16:43:57 +0000129 ./ipodpatcher N -r bootpartition.bin (Mac OS X/Unix)
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000130 \end{code}
131
Michael DiFebbo728dd272007-01-16 16:43:57 +0000132 This should create a file in the current folder called
133 \fname{bootpartition.bin} (approximately 40MB for the iPod 3G, 4G and
134 Color/Photo, 80MB for the Nano 1st gen and 30GB Video, and 112MB for the
135 60GB Video) containing a copy of the ``firmware partition'' from your Ipod.
Michael DiFebbo19e30842006-12-21 20:54:20 +0000136
Michael DiFebbo728dd272007-01-16 16:43:57 +0000137 If it ever becomes necessary (for example, if your Ipod refuses to start),
138 you can restore this backup to your Ipod using the command ipodpatcher N -w
139 bootpartition.bin (Windows) or ./ipodpatcher N -w bootpartition.bin (Mac OS
140 X/Unix).
Michael DiFebbo19e30842006-12-21 20:54:20 +0000141
Dominik Riebeling40afbd22007-01-02 20:50:03 +0000142 \opt{ipodmini}{
143 \note{Ipod Mini 2g users need to replace ``1g'' with ``2g'' in the
144 following commands.}
145 }
146
147 \item Install the bootloader.
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000148 Windows users should now type:
Dominik Riebeling40afbd22007-01-02 20:50:03 +0000149 \begin{code}
Michael DiFebbo728dd272007-01-16 16:43:57 +0000150 ipodpatcher N -a \bootloaderfile
Dominik Riebeling40afbd22007-01-02 20:50:03 +0000151 \end{code}
152 %
Michael DiFebbo6f3914d2007-01-02 23:22:44 +0000153
Michael DiFebbo5d61c0b2006-12-21 21:19:41 +0000154 and Mac OS X/Unix users should type:
Michael DiFebbo6f3914d2007-01-02 23:22:44 +0000155
Dominik Riebeling40afbd22007-01-02 20:50:03 +0000156 \begin{code}
Michael DiFebbo728dd272007-01-16 16:43:57 +0000157 ./ipodpatcher N -a \bootloaderfile
Dominik Riebeling40afbd22007-01-02 20:50:03 +0000158 \end{code}
159
Michael DiFebbo728dd272007-01-16 16:43:57 +0000160 Replace N with the number (Windows users) or device name (Mac OS X/Unix
161 users) you've been using to access your Ipod.
Michael DiFebbo8bde9472007-01-02 18:27:29 +0000162
Michael DiFebbo728dd272007-01-16 16:43:57 +0000163 You can now disconnect your Ipod from your computer in the normal way. This
164 should cause your Ipod to reboot and start Rockbox.
165
166 \note{If your Ipod displays the message ``Error: -1,'' you have either
167 neglected to install a Rockbox build as described in the preceding section,
168 or you have extracted the contents of the \fname{.zip} file to some
169 directory other than the the root directory of your Ipod. To fix this
170 error, following the directions in the preceding section for downloading and
171 installing a Daily Build.}
Michael DiFebbo19e30842006-12-21 20:54:20 +0000172
Dominik Riebeling40afbd22007-01-02 20:50:03 +0000173\end{enumerate}