Dominik Riebeling | 2a731e4 | 2006-06-04 17:16:24 +0000 | [diff] [blame] | 1 | % $Id$ % |
Michael DiFebbo | 1f08551 | 2006-09-10 19:03:52 +0000 | [diff] [blame] | 2 | |
Dominik Riebeling | 40afbd2 | 2007-01-02 20:50:03 +0000 | [diff] [blame] | 3 | \opt{ipodvideo}{\newcommand{\bootloaderfile}{bootloader-ipodvideo.ipod}}% |
Michael DiFebbo | 5f61bb9 | 2007-01-17 22:00:37 +0000 | [diff] [blame] | 4 | \opt{ipodmini}{\newcommand{\bootloaderfile}{bootloader-ipodmini.ipod}}% |
Dominik Riebeling | 40afbd2 | 2007-01-02 20:50:03 +0000 | [diff] [blame] | 5 | \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 Arver | f1a848d | 2006-10-22 22:22:31 +0000 | [diff] [blame] | 10 | \opt{ipodnano}{\warn{If your Nano has a stainless steel back and plastic front |
| 11 | it is a 1st generation and is compatible with Rockbox. If, on the other hand, |
| 12 | your Nano has a one-piece aluminum body it is a 2nd generation Nano and there |
| 13 | is currently no Rockbox port available. Do not attempt to install the |
| 14 | bootloader on a 2nd generation Nano}} |
| 15 | |
Dave Chapman | 55aabe3 | 2007-03-03 01:11:28 +0000 | [diff] [blame^] | 16 | \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 DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 18 | In order to make your Ipod load and execute the Rockbox firmware you have just |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 19 | installed, you will need to install the Rockbox bootloader. Unless bugs are |
| 20 | found in the bootloader code, or significant new feature are added, you will |
| 21 | only have to perform this step once. |
Michael DiFebbo | 95afcf5 | 2006-06-04 14:44:10 +0000 | [diff] [blame] | 22 | |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 23 | The following instructions refer to the ``installation folder.'' For Windows |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 24 | users, the ``installation folder'' is a folder in the root (top-level) of the C: |
| 25 | drive called \fname{\textbackslash{}rockbox} (you will obviously need to create |
| 26 | this folder yourself). For Mac OS X and Linux users, the ``installation |
| 27 | folder'' is assumed to be the Desktop folder. Note that the bootloader |
| 28 | installation files should be saved onto your computer's hard disk, \emph{not} on |
| 29 | your Ipod. |
Michael DiFebbo | 95afcf5 | 2006-06-04 14:44:10 +0000 | [diff] [blame] | 30 | |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 31 | \begin{enumerate} |
Dominik Riebeling | 840b1c2 | 2006-07-10 07:04:43 +0000 | [diff] [blame] | 32 | |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 33 | \item First, download the \fname{ipodpatcher} tool to your installation |
Paul Louden | d71b44c | 2007-02-05 21:16:16 +0000 | [diff] [blame] | 34 | folder. You can download the \fname{ipodpatcher} tool for your operating |
Dominik Riebeling | e370776 | 2007-01-05 23:01:51 +0000 | [diff] [blame] | 35 | system at \download{bootloader/ipod/ipodpatcher/}. |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 36 | |
| 37 | \item Next, download the following file to the installation folder: |
Dominik Riebeling | 840b1c2 | 2006-07-10 07:04:43 +0000 | [diff] [blame] | 38 | |
Dominik Riebeling | 40afbd2 | 2007-01-02 20:50:03 +0000 | [diff] [blame] | 39 | \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 Riebeling | 840b1c2 | 2006-07-10 07:04:43 +0000 | [diff] [blame] | 47 | |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 48 | \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 DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 51 | 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 DiFebbo | 95afcf5 | 2006-06-04 14:44:10 +0000 | [diff] [blame] | 54 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 55 | \begin{code} |
| 56 | cd \textbackslash{}rockbox |
| 57 | \end{code} |
| 58 | |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 59 | 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 DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 63 | ipodpatcher and then pressing \fname{Enter}. |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 64 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 65 | \item Connect your Ipod to your computer. |
Michael DiFebbo | 95afcf5 | 2006-06-04 14:44:10 +0000 | [diff] [blame] | 66 | |
Paul Louden | d71b44c | 2007-02-05 21:16:16 +0000 | [diff] [blame] | 67 | If you haven't already done so, you should now plug your Ipod into your |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 68 | computer (via either the USB or Firewire cable). |
Michael DiFebbo | 95afcf5 | 2006-06-04 14:44:10 +0000 | [diff] [blame] | 69 | |
Paul Louden | d71b44c | 2007-02-05 21:16:16 +0000 | [diff] [blame] | 70 | \fixme{Notes about closing itunes, enabling the ``show ipod as disk'' option |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 71 | in ipod, anything else?} |
Michael DiFebbo | 95afcf5 | 2006-06-04 14:44:10 +0000 | [diff] [blame] | 72 | |
Paul Louden | d71b44c | 2007-02-05 21:16:16 +0000 | [diff] [blame] | 73 | \item Find your Ipod with ipodpatcher (Windows and Linux users only) |
Michael DiFebbo | 95afcf5 | 2006-06-04 14:44:10 +0000 | [diff] [blame] | 74 | |
Paul Louden | d71b44c | 2007-02-05 21:16:16 +0000 | [diff] [blame] | 75 | Type the following command to search for Ipods attached to |
| 76 | your computer: |
| 77 | \begin{code} |
| 78 | ipodpatcher --scan |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 79 | \end{code} |
Paul Louden | d71b44c | 2007-02-05 21:16:16 +0000 | [diff] [blame] | 80 | |
| 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 DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 84 | device 1'' you will use the number 1 in the commands described below. |
Michael DiFebbo | 95afcf5 | 2006-06-04 14:44:10 +0000 | [diff] [blame] | 85 | |
Paul Louden | d71b44c | 2007-02-05 21:16:16 +0000 | [diff] [blame] | 86 | 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 DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 91 | administrator account by using one of the "Run as" features of Windows XP.} |
Dominik Riebeling | 5325401 | 2006-10-10 13:21:09 +0000 | [diff] [blame] | 92 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 93 | \item Find your Ipod (Mac OS X users only) |
Michael DiFebbo | 95afcf5 | 2006-06-04 14:44:10 +0000 | [diff] [blame] | 94 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 95 | Attach your Ipod to your Mac (using either USB or Firewire) and wait for |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 96 | 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 DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 99 | list should be your Ipod. For example: |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 100 | \begin{code} |
| 101 | /dev/disk1s2 on /Volumes/DAVE_S IPOD 1 (local, nodev, nosuid) |
| 102 | \end{code} |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 103 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 104 | In order to install the ipod bootloader, you need to ``unmount'' this disk |
Michael DiFebbo | 8bde947 | 2007-01-02 18:27:29 +0000 | [diff] [blame] | 105 | using the following command: |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 106 | \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 DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 111 | Ipod. This may take a few seconds, after which Mac OS will say ``Volume |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 112 | /dev/disk1s2 unmounted.'' ``/dev/disk1s2'' refers to the second partition on |
| 113 | /dev/disk1 - remember ``/dev/disk1'' for the next step. |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 114 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 115 | It's possible that itunes will try to be ``helpful'' and remount your Ipod |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 116 | after you modify it with ipodpatcher. If this happens, you need to unmount |
| 117 | it again using the above command. |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 118 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 119 | \item Create a backup of your Ipod's firmware partition |
Michael DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 120 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 121 | Type the following command, replacing ``N'' with the number (for |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 122 | Windows users) or the device name (Mac OS X and Unix users) assigned to |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 123 | your Ipod that you identified in the previous step: |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 124 | \begin{code} |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 125 | ipodpatcher N -r bootpartition.bin (Windows) |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 126 | \end{code} |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 127 | or |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 128 | \begin{code} |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 129 | ./ipodpatcher N -r bootpartition.bin (Mac OS X/Unix) |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 130 | \end{code} |
| 131 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 132 | 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 DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 136 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 137 | 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 DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 141 | |
Dominik Riebeling | 40afbd2 | 2007-01-02 20:50:03 +0000 | [diff] [blame] | 142 | \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 DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 148 | Windows users should now type: |
Dominik Riebeling | 40afbd2 | 2007-01-02 20:50:03 +0000 | [diff] [blame] | 149 | \begin{code} |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 150 | ipodpatcher N -a \bootloaderfile |
Dominik Riebeling | 40afbd2 | 2007-01-02 20:50:03 +0000 | [diff] [blame] | 151 | \end{code} |
| 152 | % |
Michael DiFebbo | 6f3914d | 2007-01-02 23:22:44 +0000 | [diff] [blame] | 153 | |
Michael DiFebbo | 5d61c0b | 2006-12-21 21:19:41 +0000 | [diff] [blame] | 154 | and Mac OS X/Unix users should type: |
Michael DiFebbo | 6f3914d | 2007-01-02 23:22:44 +0000 | [diff] [blame] | 155 | |
Dominik Riebeling | 40afbd2 | 2007-01-02 20:50:03 +0000 | [diff] [blame] | 156 | \begin{code} |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 157 | ./ipodpatcher N -a \bootloaderfile |
Dominik Riebeling | 40afbd2 | 2007-01-02 20:50:03 +0000 | [diff] [blame] | 158 | \end{code} |
| 159 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 160 | 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 DiFebbo | 8bde947 | 2007-01-02 18:27:29 +0000 | [diff] [blame] | 162 | |
Michael DiFebbo | 728dd27 | 2007-01-16 16:43:57 +0000 | [diff] [blame] | 163 | 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 DiFebbo | 19e3084 | 2006-12-21 20:54:20 +0000 | [diff] [blame] | 172 | |
Dominik Riebeling | 40afbd2 | 2007-01-02 20:50:03 +0000 | [diff] [blame] | 173 | \end{enumerate} |