Nyaaori/rockbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

First draft of updates to manual to include the installation instructions for the new ipod bootloader. Still needs a lot of clean-up. Also flipped the installation instructions for the bootloader and the firmware build for all SWCODEC platforms. Instructions for installing the build now come before instructions for installing the bootloader. This should eliminate some confusion from those who tried to boot Rockbox after installing the bootloader but before installing a build, and received the -1 error.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11829 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Michael DiFebbo 2006-12-21 20:54:20 +00:00
parent a26519680a
commit 19e30840b3
2 changed files with 164 additions and 377 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
manual/getting_started/installation.tex
View file

@ -111,14 +111,7 @@ software.
\end{description}
\subsection{Installing the boot loader}
\opt{h1xx,h300}{\input{getting_started/iriver_install.tex}}
\opt{ipod}{\input{getting_started/ipod_install.tex}}
\opt{x5}{\input{getting_started/iaudio_install.tex}}
\opt{h10,h10_5gb}{\input{getting_started/h10_install.tex}}
\subsection{Installing the firmware}
After installing the boot loader, the installation becomes fairly easy.
}
There are three different types of firmware binaries from Rockbox website:
@ -192,6 +185,14 @@ directory structure that Rockbox needs.
number of other folders and system files needed by Rockbox. If you receive a
``-1'' error when you start Rockbox, you have not extracted the contents of
the \fname{.zip} file to the proper location.
}
\opt{SWCODEC}{
\subsection{Installing the boot loader}
\opt{h1xx,h300}{\input{getting_started/iriver_install.tex}}
\opt{ipod}{\input{getting_started/ipod_install.tex}}
\opt{x5}{\input{getting_started/iaudio_install.tex}}
\opt{h10,h10_5gb}{\input{getting_started/h10_install.tex}}
}
\section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}

526
manual/getting_started/ipod_install.tex
View file

@ -1,391 +1,177 @@
% $Id$ %
\warn{A significantly easier installation method has been
developed for the ipods, but is not yet included in this manual. Until this
manual is updated, please visit
\url{http://www.rockbox.org/twiki/bin/view/Main/IpodInstallationBeta}
for the most up-to-date version of the installation instructions.}
\opt{ipodvideo}{\warn{In addition, the instructions in this manual do not work
at all on the new ``5.5g'' video ipod. If you own such an ipod - you
\emph{must} use the new instructions at
\url{http://www.rockbox.org/twiki/bin/view/Main/IpodInstallationBeta}}}
\opt{ipodnano}{\warn{If your Nano has a stainless steel back and plastic front
it is a 1st generation and is compatible with Rockbox. If, on the other hand,
your Nano has a one-piece aluminum body it is a 2nd generation Nano and there
is currently no Rockbox port available. Do not attempt to install the
bootloader on a 2nd generation Nano}}
Installing the boot loader is the trickiest part of the installation.
\opt{ipodnano}{First, you need to find out which version of the Apple
firmware you're running. To do this, start the Apple firmware and go to
Settings screen. In the ``About'' screen you'll find the version number
of the Apple firmware. Depending on the version number the installation
is slightly different.}%
The process is different depending on your operating system, but before
starting, connect the \dap{} to the computer using either an USB
%\fixme{or Firewire?} % Firewire is currently not supported.
cable. Next, create a folder on the computer's hard drive and
download the following file to that folder:
\opt{ipodvideo}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-video.bin}}
\opt{ipodnano}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-nano.bin}}
\opt{ipodmini}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-mini1g.bin} or
\url{http://download.rockbox.org/bootloader/ipod/bootloader-mini2g.bin} depending on which
generation your \dap{} is.\fixme{Describe how to identify 1/2G}}
\opt{ipodcolor}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-color.bin}}
\opt{ipod4g}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-4g.bin}}
\opt{ipod3g}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-3g.bin}}
In order to make your iPod load and execute the Rockbox firmware you have just
installed, you will need to install the Rockbox bootloader. Unless bugs are
found in the bootloader code, or significant new feature are added, you will
only have to perform this step once.
When that is done, proceed to the section below that matches the operating
system on the computer.
\note{These instructions all require you to have administrator rights
on your computer, regardless of the operating system.}
\note{Rockbox only works on FAT32 partitions (called ``Windows formatted'' by
Apple). So if your \dap{} is Mac formatted (HFS+), you should first convert
it to FAT32. Information on how to do this can be found on the Rockbox
website. \fixme{Include these instructions?}}
The following instructions refer to the ``installation folder.'' For Windows
users, the "installation folder" is assumed to be a folder in the root (top-
level) of the C: drive called \fname{rockbox} (you will obviously need to
create this folder yourself). For Mac OS X and Linux users, the ``installation
folder'' is assumed to be the Desktop folder. But you can use any folder
you wish. Note that these files should be saved onto your computer's hard disk,
\emph{not} on your Ipod.
\subsubsection{Windows users}
\begin{enumerate}
\item Download the following two programs and save them in the folder just
created. These programs will be used in the next steps:
\begin{itemize}
\item \url{http://download.rockbox.org/bootloader/ipod/ipodpatcher.exe}
\item \url{http://download.rockbox.org/bootloader/ipod/ipod_fw.exe}
\end{itemize}
\item Locate the \dap{} by opening a command window. You can do this by
clicking ``Start'', ``Run'' and typing \fname{cmd}. Press Enter to
execute that command. Now change directory to the
folder you created and run the following commands:
\begin{code}
ipodpatcher 0
ipodpatcher 1
ipodpatcher 2
ipodpatcher 3
\end{code}
Keep increasing the number until the \dap{} is located.
\begin{enumerate}
The output for an unsuccessful attempt to contact the \dap{} looks like
this:
\begin{code}
C:\textbackslash{}rockbox>ipodpatcher 0
ipodpatcher v0.3 - (C) Dave Chapman 2006
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
\item First, download the \fname{ipodpatcher} tool to your installation
folder. You can download the \fname{ipodpatcher} tool for your operating
system at
\url{http://www.rockbox.org/twiki/bin/view/Main/IpodInstallationBeta}.
\item Next, download the following file to the installation folder:
[INFO] Reading partition table from \textbackslash\textbackslash{}.\textbackslash{}PhysicalDrive0
Drive is not an iPod, aborting
\end{code}
A successful connection to the \dap{} will look similar to this...
\begin{code}
C:\textbackslash{}rockbox>ipodpatcher 6
ipodpatcher v0.3 - (C) Dave Chapman 2006
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
\opt{ipodvideo}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-
video.ipod}}
\opt{ipodnano}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-
nano.ipod}}
\opt{ipodmini}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-
mini1g.ipod} or \url{http://download.rockbox.org/bootloader/ipod/bootloader-
mini2g.ipod} depending on which generation your \dap{} is. \fixme{Describe
how to identify 1/2G}}
\opt{ipodcolor}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-
color.ipod}}
\opt{ipod4g}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-
4g.ipod}}
\opt{ipod3g}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-
3g.ipod}}
[INFO] Reading partition table from \textbackslash\textbackslash{}.\textbackslash{}PhysicalDrive6
Part Start Sector End Sector Size (MB) Type
0 63 160649 78.4 Empty (0x00)
1 160650 7984304 3820.1 W95 FAT32 (0x0b)
\end{code}
Remember the number that corresponds to your \dap{} -- in the
following steps, \emph{N} should be replaced with the number just found.
\item Now, extract the firmware partition currently on the \dap{} with the
following command:
\begin{code}
ipodpatcher -r \emph{N} bootpartition.bin
\end{code}
\note{You should keep a safe backup of this \fname{bootpartition.bin} file
for use if you ever wish to either upgrade the Rockbox boot loader or
uninstall Rockbox from your Ipod}
\item Extract the Apple firmware from the partition image image just created:
\begin{code}
ipod_fw -o apple_os.bin -e 0 bootpartition.bin
\end{code}
\opt{ipodnano}{\note{The following step is only necessary if your Apple
firmware has version 1.2 or later. If this doesn't apply to you, simply
skip it.}}
\optv{ipodvideo,ipodnano}{
\item
Similarly, extract the Broadcom firmware:
\begin{code}
ipod_fw -o apple_sw_5g_rcsc.bin -e 1 bootpartition.bin
\end{code}
}
\item Merge the Rockbox boot loader you downloaded previously with the Apple
firm\-ware.%
\optv{ipodnano}{
If your firmware version is lower than 1.2 this works you need
this command:
\begin{code}
ipod_fw -g nano -o rockboot.bin -i apple_os.bin bootloader-nano.bin
\end{code}
If your firmware version is 1.2 or later you need to use the following
command instead. Please note that the ``video'' is correct.
\begin{code}
ipod_fw -g video -o rockboot.bin -i apple_os.bin bootloader-nano.bin
\end{code}
}
\optv{ipodvideo}{
\begin{code}
ipod_fw -g video -o rockboot.bin -i apple_os.bin bootloader-video.bin
\end{code}
}
\optv{ipodmini}{
\begin{code}
ipod_fw -g mini -o rockboot.bin -i apple_os.bin bootloader-mini1g.bin
\end{code}
Or, if you have a 2G mini:
\begin{code}
ipod_fw -g mini -o rockboot.bin -i apple_os.bin bootloader-mini2g.bin
\end{code}
}
\optv{ipodcolor}{
\begin{code}
ipod_fw -g color -o rockboot.bin -i apple_os.bin bootloader-color.bin
\end{code}
}
\optv{ipod4g}{
\begin{code}
ipod_fw -g 4g -o rockboot.bin -i apple_os.bin bootloader-4g.bin
\end{code}
}
\optv{ipod3g}{
\begin{code}
ipod_fw -g 3g -o rockboot.bin -i apple_os.bin bootloader-3g.bin
\end{code}
}
\item
Install the Rockbox-enabled firmware:
\begin{code}
ipodpatcher -w \emph{N} rockboot.bin
\end{code}
\end{enumerate}
\item Next, open a command prompt (Windows) or terminal window (Mac OSX and Linux).
Windows users will perform this and the following steps from the Windows
command prompt. Start a command prompt and navigate to the isntallation
directory.
Now you can proceed installing the firmware itself.
Mac OS X and Linux/Unix users will perform these steps from the Terminal.
Start a new terminal window and navigate to the Desktop folder (type cd
Desktop into the terminal and press enter). You then need to ensure that the
ipodpatcher program is ``executable'' by typing the command chmod +x
ipodpatcher and then pressing enter.
\item Connect your ipod to your computer.
\subsubsection{Mac OS X users}
\begin{enumerate}
\item Download the following two programs and save them in the folder just
created. These programs will be used in the next steps:
\begin{itemize}
\item \url{http://download.rockbox.org/bootloader/ipod/diskdump}
\item \url{http://download.rockbox.org/bootloader/ipod/ipod_fw}
\end{itemize}
Start a Terminal and type navigate into the folder you created. Before
you can continue, you need to ensure that Mac OS knows that the
\fname{ipod\_fw}
and diskdump files you downloaded are executable programs. To do this,
type the following command:
\begin{code}
chmod +x ipod_fw diskdump
\end{code}
\item Locate the \dap{} by running the following command:
\begin{code}
mount
\end{code}
The output will look something like this: \fixme{Add full example}
\begin{code}
/dev/disk1s2 on /Volumes/DAVE_S IPOD 1 (local, nodev, nosuid)
\end{code}
In this example, the \dap\ is located at /dev/disk1s2 Remember the
location of your \dap\ -- in the following steps, /dev/disk1s2 should be
replaced with the location just found.
\item Before continuing, the \dap\ must be ``unmounted'', which is
done with the following command:
\begin{code}
diskutil unmount /dev/disk1s2
\end{code}
\item Now, extract the Apple firmware currently on the \dap{} with the
following command:
\note{The last part of the location is left out.}
\begin{code}
./diskdump -r /dev/disk1 bootpartition.bin
\end{code}
\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
uninstall Rockbox from your iPod
}
\item Extract the Apple firmware from this partition image:
\begin{code}
./ipod_fw -o apple_os.bin -e 0 bootpartition.bin
\end{code}
\opt{ipodnano}{\note{The following step is only necessary if your Apple
firmware has version 1.2 or later. If this doesn't apply to you, simply
skip it.}}
\optv{ipodvideo,ipodnano}{
\item
Similarly, extract the Broadcom firmware:
\begin{code}
./ipod_fw -o apple_sw_5g_rcsc.bin -e 1 bootpartition.bin
\end{code}
}
\item Merge the Rockbox bootloader you downloaded previously with the Apple
firm\-ware.%
\optv{ipodnano}{
If your firmware version is lower than 1.2 this works you need
this command:
\begin{code}
./ipod_fw -g nano -o rockboot.bin -i apple_os.bin bootloader-nano.bin
\end{code}
If your firmware version is 1.2 or later you need to use the following
command instead. Please note that the ``video'' is correct.
\begin{code}
./ipod_fw -g video -o rockboot.bin -i apple_os.bin bootloader-nano.bin
\end{code}
}
\optv{ipodvideo}{
\begin{code}
./ipod_fw -g video -o rockboot.bin -i apple_os.bin bootloader-video.bin
\end{code}
}
\optv{ipodmini}{
\begin{code}
./ipod_fw -g mini -o rockboot.bin -i apple_os.bin bootloader-mini1g.bin
\end{code}
Or, if you have a 2G Mini:
\begin{code}
./ipod_fw -g mini -o rockboot.bin -i apple_os.bin bootloader-mini2g.bin
\end{code}
}
\optv{ipodcolor}{
\begin{code}
./ipod_fw -g color -o rockboot.bin -i apple_os.bin bootloader-color.bin
\end{code}
}
\optv{ipod4g}{
\begin{code}
./ipod_fw -g 4g -o rockboot.bin -i apple_os.bin bootloader-4g.bin
\end{code}
}
\optv{ipod3g}{
\begin{code}
./ipod_fw -g 3g -o rockboot.bin -i apple_os.bin bootloader-3g.bin
\end{code}
}
\item
Install the Rockbox-enabled firmware:
\note{The last part of the location is left out.}
\begin{code}
./diskdump -w /dev/disk1 rockboot.bin
\end{code}
\end{enumerate}
If you haven't already done so, you should now plug your iPod into your
computer (via either the USB or Firewire cable).
Now, proceed with installing the firmware itself.
\fixme{Notes about closing itunes, enabling the ``show ipod as disk'' option
in ipod, anything else?}
\subsubsection{Linux users}
\begin{enumerate}
\item Download the following and save it in the folder just
created:
\begin{itemize}
\item \url{http://www.rockbox.org/viewcvs.cgi/*checkout*/tools/ipod_fw.c}
\end{itemize}
Now compile it to an executable by opening a command prompt and changing
to the folder created previously. Then run the following command:
\begin{code}
gcc -o ipod_fw ipod_fw.c
\end{code}
If you get the message that the command gcc is not found, you need to
install gcc. How to do this depends on your Linux distribution, and
you should consult its documentation for help on this.
\item Locate your Ipod by running the command \verb|dmesg|. In the output
something like the following should be seen:
\begin{code}
usb 4-1: new high speed USB device using ehci_hcd and address 7
scsi4 : SCSI emulation for USB Mass Storage devices
usb-storage: device found at 7
usb-storage: waiting for device to settle before scanning
Vendor: Apple Model: iPod Rev: 1.62
Type: Direct-Access ANSI SCSI revision: 00
SCSI device sdb: 58605120 512-byte hdwr sectors (30006 MB)
\end{code}
You need the device name of your \dap, which you can find in the last line.
In this example, the \dap\ is located on \fname{/dev/sdb}. In the following,
\fname{/dev/sdb} should be replaced with the location just found.
\item Run \verb|fdisk -l /dev/sdb|. Verify that the
output is similar to the one below:
\begin{code}
Device Boot Start End Blocks Id System
/dev/sdb1 1 10 80293+ 0 Empty
/dev/sdb2 11 3648 29222235 b W95 FAT32
\end{code}
\item Back up the partition table using the following command:
\note{The last part of the location is left out.}
\begin{code}
dd if=/dev/\emph{sdb} of=mbr.bin count=1
\end{code}
\item Find your ipod with ipodpatcher (Windows users only)
\item Now, extract the firmware partition currently on the \dap{} with the
following command:
\begin{code}
dd if=/dev/\emph{sdb1} of=bootpartition.bin
\end{code}
\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
uninstall Rockbox from your Ipod
}
\item Extract the Apple firmware from this partition image:
\begin{code}
./ipod_fw -o apple_os.bin -e 0 bootpartition.bin
\end{code}
\opt{ipodnano}{\note{The following step is only necessary if your Apple
firmware has version 1.2 or later. If this doesn't apply to you, simply
skip it.}}
\optv{ipodvideo,ipodnano}{
\item
Similarly, extract the Broadcom firmware:
\begin{code}
./ipod_fw -o apple_sw_5g_rcsc.bin -e 1 bootpartition.bin
\end{code}
}
Windows users: Type the following command to search for ipods attached to
your computer:
\begin{code}
ipodpatcher \-\-scan
\end{code}
When ipodpatcher finds your ipod, remember the number it displays - this
will be the number you use to access your ipod in the following steps.
\item Merge the Rockbox bootloader you downloaded previously with the Apple
firm\-ware.%
\optv{ipodnano}{
If your firmware version is lower than 1.2 this works you need
this command:
\begin{code}
./ipod_fw -g nano -o rockboot.bin -i apple_os.bin bootloader-nano.bin
\end{code}
If your firmware version is 1.2 or later you need to use the following
command instead. Please note that the ``video'' is correct.
\begin{code}
./ipod_fw -g video -o rockboot.bin -i apple_os.bin bootloader-nano.bin
\end{code}
\note{Windows users require administrator rights for running ipodpatcher.
Either re-login as administrator, or open a command prompt running under an
administrator account by using one of the "Run as" features of Windows XP.}
}
\optv{ipodvideo}{
\begin{code}
./ipod_fw -g video -o rockboot.bin -i apple_os.bin bootloader-video.bin
\end{code}
}
\optv{ipodmini}{
\begin{code}
./ipod_fw -g mini -o rockboot.bin -i apple_os.bin bootloader-mini1g.bin
\end{code}
Or, if you have a 2G Mini:
\begin{code}
./ipod_fw -g mini -o rockboot.bin -i apple_os.bin bootloader-mini2g.bin
\end{code}
}
\optv{ipodcolor}{
\begin{code}
./ipod_fw -g color -o rockboot.bin -i apple_os.bin bootloader-color.bin
\end{code}
}
\optv{ipod4g}{
\begin{code}
./ipod_fw -g 4g -o rockboot.bin -i apple_os.bin bootloader-4g.bin
\end{code}
}
\item
Install the Rockbox-enabled firmware:
\begin{code}
dd if=rockboot.bin of=/dev/\emph{sdb1}
\end{code}
\end{enumerate}
Now you can install the firmware itself.
\item Find your ipod (Mac OS X users only)
Attach your iPod to your Mac (using either USB or Firewire) and wait for
iTunes to open. When iTunes opens, close it down. In your Terminal window,
type the command mount and press enter. This will list all the disks (and
other devices) that are "mounted" on your computer. The last drive in the
list should be your iPod. For example:
\begin{code}
/dev/disk1s2 on /Volumes/DAVE_S IPOD 1 (local, nodev, nosuid)
\end{code}
In order to install the ipod bootloader, you need to "unmount" this disk
using the following command:
\begin{code}
diskutil unmount /dev/disk1s2
\end{code}
replacing ``/dev/disk1s2'' with the device name Mac OS has assigned to your
ipod. This may take a few seconds, after which Mac OS will say ``Volume
/dev/disk1s2 unmounted.'' ``/dev/disk1s2'' refers to the second partition on
/dev/disk1 - remember ``/dev/disk1'' for the next step.
It's possible that itunes will try to be ``helpful'' and remount your ipod
after you modify it with ipodpatcher. If this happens, you need to unmount
it again using the above command.
\item Create a backup of your ipod's firmware partition
Type the following command, replacing "[device]" with the number (for
Windows users) or the device name (Mac OS X and Unix users) assigned to
your ipod that you found in the previous step:
\begin{code}
ipodpatcher [device] -r bootpartition.bin (Windows)
\end{code}
or
\begin{code}
./ipodpatcher [device] -r bootpartition.bin (Mac OS X/Unix)
\end{code}
This should create a file in the current folder called bootpartition.bin
(approximately 40MB for the iPod 3G, 4G and Color/Photo, 80MB for the Nano
1st gen and 30GB Video, and 112MB for the 60GB Video) containing a copy of
the ``firmware partition'' from your iPod.
If it ever becomes necessary (i.e. your ipod refuses to start), you can
restore this backup to your ipod using the command ipodpatcher [device] -w
bootpartition.bin (Windows) or ./ipodpatcher [device] -w bootpartition.bin
(Mac OS X/Unix).
\item Install the bootloader.
Windows users should now type:
\begin{code}
ipodpatcher [device] -a
\opt{ipodvideo}{bootloader-video.ipod}
\opt{ipodnano}{bootloader-nano.ipod}
\opt{ipodmini}{bootloader-mini1g.ipod
\end{code}
or
\begin{code}
ipodpatcher [device] -a bootloader-mini2g.ipod
}
\opt{ipodcolor}{bootloader-color.ipod}
\opt{ipod4g}{bootloader-4g.ipod}
\opt{ipod3g}{bootloader-3g.ipod}
\end{code}
and Mac OS X/Unix users should type:
\begin{code}
./ipodpatcher [device] -a
\opt{ipodvideo}{bootloader-video.ipod}
\opt{ipodnano}{bootloader-nano.ipod}
\opt{ipodmini}{bootloader-mini1g.ipod
\end{code}
or
\begin{code}
or ipodpatcher [device] -a bootloader-mini2g.ipod
}
\opt{ipodcolor}{bootloader-color.ipod}
\opt{ipod4g}{bootloader-4g.ipod}
\opt{ipod3g}{bootloader-3g.ipod}
\end{code}
Replace [device] with the number (Windows users) or device name (Mac OS X/Unix
users) you've been using to access your ipod.
You can now disconnect your ipod from your computer in the normal way. This
should cause your iPod to reboot and start Rockbox.
\item Troubleshooting.
\fixme{Add some notes here about common problems - "rockbox error -1" is the
main one. Or maybe have a new troubleshooting page.}
\end{enumerate}