summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorDave Chapman <dave@dchapman.com>2010-03-25 20:11:34 +0000
committerDave Chapman <dave@dchapman.com>2010-03-25 20:11:34 +0000
commit0fdc2d55412bb57341eb9ee852a82b3eec2854d9 (patch)
tree0c3dc731657eb5941a18f2c5d2f14a405ea1de43 /manual
parent57b3d0952540e643c03777da096580ca3dd0f11c (diff)
Initial manuals for clipv2 and clip+, with corrected installation instructions. The player picture in Chapter 3 is the same as the Clipv1 for both Clipv2 and Clip+ - this needs changing for the Clip+.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25332 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/getting_started/installation.tex19
-rw-r--r--manual/getting_started/sansaAMS_install.tex22
-rw-r--r--manual/platform/sansaclip.tex4
-rw-r--r--manual/platform/sansaclipplus.tex25
-rw-r--r--manual/platform/sansaclipv2.tex25
5 files changed, 77 insertions, 18 deletions
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index 84d29d9e71..8447c4be15 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -11,7 +11,7 @@ before beginning there are a few things it is important to know.
follow the instructions at
\url{http://www.rockbox.org/twiki/bin/view/Main/SansaE200RInstallation}.}}
-\opt{ipodnano,ipodnano2g,ipodvideo,e200,c200,e200v2,clip,cowond2,fuze}{
+\opt{ipodnano,ipodnano2g,ipodvideo,e200,c200,e200v2,clipv1,clipv2,cowond2,fuze}{
\begin{description}
\item[Supported hardware versions.]
\opt{ipodnano,ipodnano2g}{
@@ -43,13 +43,12 @@ follow the instructions at
v2 firmware begins with 03. Make sure that you are following the
instructions from the correct manual.
}
- \opt{clip}{
- The \playertype{} is available in multiple versions, not all of which
- run Rockbox. Rockbox doesn't run on the newer v2 models. They can be
- identified by checking the Sandisk firmware version number under
- Settings $\rightarrow$ System Info. The v1 firmware is named 01.xx.xx,
- while the v2 firmware begins with 02. In addition, Rockbox does not
- run on the Clip+.
+ \opt{clipv1,clipv2}{
+ The \playertype{} is available in multiple versions, and you need to make
+ sure which you have by checking the Sandisk firmware version number under
+ Settings $\rightarrow$ Info. The v1 firmware is named 01.xx.xx, while the
+ v2 firmware begins with 02. Make sure that you are following the
+ instructions from the correct manual.
}
\opt{fuze}{
The \playertype{} is available in multiple versions, not all of which
@@ -144,7 +143,7 @@ follow the instructions at
is intended to be used for USB OTG connections only (digital cameras, memory
sticks, etc.).
}
- \opt{sansa,e200v2,clip}{
+ \opt{sansa,e200v2,clipv1,clipv2,clipplus}{
\note{The following steps require you to change the setting in
\setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the
original firmware.}
@@ -287,7 +286,7 @@ housekeeping tool \caps{Rockbox Utility}. It allows you to:
Prebuilt binaries for Windows, Linux and Mac OS X are
available at the \wikilink{RockboxUtility} wiki page.\\
-\opt{gigabeats,clip}{\note{Rockbox Utility does not currently support the
+\opt{gigabeats,clipv1,clipv2,clipplus}{\note{Rockbox Utility does not currently support the
\playertype{} and you will therefore need to follow the manual install
instructions below.\\}}
diff --git a/manual/getting_started/sansaAMS_install.tex b/manual/getting_started/sansaAMS_install.tex
index 7ef2eedf17..44bfa2c64b 100644
--- a/manual/getting_started/sansaAMS_install.tex
+++ b/manual/getting_started/sansaAMS_install.tex
@@ -9,13 +9,17 @@ files:
\url{http://forums.sandisk.com/sansa/board/message?board.id=e200&thread.id=13548}}
\opt{fuze}{
\url{http://forums.sandisk.com/sansa/board/message?board.id=sansafuse&thread.id=23276}}
- \opt{clip}{
+ \opt{clipv1,clipv2}{
\url{http://forums.sandisk.com/sansa/board/message?board.id=clip&thread.id=15109}}
+ \opt{clipplus}{
+ \url{http://forums.sandisk.com/sansa/board/message?board.id=clipplus&thread.id=2911}}
\item The bootloader:
\opt{e200v2}{\download{bootloader/sandisk-sansa/e200v2/bootloader-e200v2.sansa}}
\opt{fuze}{\download{bootloader/sandisk-sansa/fuze/bootloader-fuze.sansa}}
- \opt{clip}{\download{bootloader/sandisk-sansa/clip/bootloader-clip.sansa}}
+ \opt{clipv1}{\download{bootloader/sandisk-sansa/clip/bootloader-clip.sansa}}
+ \opt{clipv2}{\download{bootloader/sandisk-sansa/clipv2/bootloader-clipv2.sansa}}
+ \opt{clipplus}{\download{bootloader/sandisk-sansa/clipplus/bootloader-clipplus.sansa}}
\item The version of mkamsboot for your operating system from
\download{bootloader/sandisk-sansa/mkamsboot/}
@@ -36,7 +40,9 @@ files:
\begin{code}
\opt{fuze}{mkamsboot.exe fuzea.bin bootloader-fuze.sansa patched.bin}
\opt{e200v2}{mkamsboot.exe e200pe.bin bootloader-e200v2.sansa patched.bin}
- \opt{clip}{mkamsboot.exe m300a.bin bootloader-clip.sansa patched.bin}
+ \opt{clipv1}{mkamsboot.exe m300a.bin bootloader-clip.sansa patched.bin}
+ \opt{clipv2}{mkamsboot.exe m30pa.bin bootloader-clipv2.sansa patched.bin}
+ \opt{clipplus}{mkamsboot.exe clppa.bin bootloader-clipplus.sansa patched.bin}
\end{code}
If mkamsboot.exe does not report success, then retry or abort.
@@ -44,7 +50,8 @@ files:
\item Copy the output file (``patched.bin'' in the example given above) to the
root of the device and rename it to the same name as the OF file you downloaded earlier
\opt{fuze}{(``fuzea.bin''} \opt{e200v2}{(``e200pe.bin''}
- \opt{clip}{(``m300a.bin''} above).
+ \opt{clipv1}{(``m300a.bin''} \opt{clipv2}{(``m30pa.bin''}
+ \opt{clipplus}{(``clppa.bin''} above).
\item Safely eject the device, unplug USB and wait for the firmware update to finish.
\end{enumerate}
@@ -64,7 +71,9 @@ files:
\begin{code}
\opt{fuze}{./mkamsboot fuzea.bin bootloader-fuze.sansa patched.bin}
\opt{e200v2}{./mkamsboot e200pe.bin bootloader-e200v2.sansa patched.bin}
- \opt{clip}{./mkamsboot m300a.bin bootloader-clip.sansa patched.bin}
+ \opt{clipv1}{./mkamsboot m300a.bin bootloader-clip.sansa patched.bin}
+ \opt{clipv2}{./mkamsboot m30pa.bin bootloader-clipv2.sansa patched.bin}
+ \opt{clipplus}{./mkamsboot clppa.bin bootloader-clipplus.sansa patched.bin}
\end{code}
If mkamsboot does not report success, then retry or abort.
@@ -72,7 +81,8 @@ files:
\item Copy the output file (``patched.bin'' in the example given above) to the
root of the device and rename it to the same name as the OF file you downloaded earlier
\opt{fuze}{(``fuzea.bin''} \opt{e200v2}{(``e200pe.bin''}
- \opt{clip}{(``m300a.bin''} above).
+ \opt{clipv1}{(``m300a.bin''} \opt{clipv2}{(``m30pa.bin''}
+ \opt{clipplus}{(``clppa.bin''} above).
\item Safely eject the device, unplug USB and wait for the firmware update to finish.
\end{enumerate}
diff --git a/manual/platform/sansaclip.tex b/manual/platform/sansaclip.tex
index c92f2d286a..a39528fdc4 100644
--- a/manual/platform/sansaclip.tex
+++ b/manual/platform/sansaclip.tex
@@ -1,5 +1,5 @@
% Id: %
-\def\UseOption{clip}
+\def\UseOption{clipv1}
\edef\UseOption{\UseOption,SANSA_CLIP_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
@@ -9,7 +9,7 @@
\newcommand{\playerman}{Sansa}
\newcommand{\playertype}{Clip}
-\newcommand{\playerlongtype}{\playertype}
+\newcommand{\playerlongtype}{Clip v1}
\newcommand{\genericimg}{128x64x1}
\newcommand{\specimg}{sansaclip}
%Used to name the player, e.g. ...to the \dap
diff --git a/manual/platform/sansaclipplus.tex b/manual/platform/sansaclipplus.tex
new file mode 100644
index 0000000000..b0cefd42e1
--- /dev/null
+++ b/manual/platform/sansaclipplus.tex
@@ -0,0 +1,25 @@
+% Id: %
+\def\UseOption{clipplus}
+\edef\UseOption{\UseOption,SANSA_CLIP_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
+\edef\UseOption{\UseOption,HAVE_BUTTON_LIGHTS}
+\edef\UseOption{\UseOption,sansaAMS}
+\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
+
+\newcommand{\playerman}{Sansa}
+\newcommand{\playertype}{Clip+}
+\newcommand{\playerlongtype}{\playertype}
+\newcommand{\genericimg}{128x64x1}
+\newcommand{\specimg}{sansaclip}
+%Used to name the player, e.g. ...to the \dap
+\newcommand{\dap}{player}
+%For use when referring to the player. E.g. the \daps\ capacity...
+\newcommand{\daps}{player's}
+\newcommand{\firmwarefilename}{\fname{rockbox.sansa}}
+\newcommand{\firmwareextension}{\fname{sansa}}
+\newcommand{\screenshotsize}{3cm}
+\newcommand{\disk}{flash storage}
+
+% link external keymap file
+\input{platform/keymap-sansaclip.tex}
diff --git a/manual/platform/sansaclipv2.tex b/manual/platform/sansaclipv2.tex
new file mode 100644
index 0000000000..ba053535a6
--- /dev/null
+++ b/manual/platform/sansaclipv2.tex
@@ -0,0 +1,25 @@
+% Id: %
+\def\UseOption{clipv2}
+\edef\UseOption{\UseOption,SANSA_CLIP_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
+\edef\UseOption{\UseOption,HAVE_BUTTON_LIGHTS}
+\edef\UseOption{\UseOption,sansaAMS}
+\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
+
+\newcommand{\playerman}{Sansa}
+\newcommand{\playertype}{Clip}
+\newcommand{\playerlongtype}{Clip v2}
+\newcommand{\genericimg}{128x64x1}
+\newcommand{\specimg}{sansaclip}
+%Used to name the player, e.g. ...to the \dap
+\newcommand{\dap}{player}
+%For use when referring to the player. E.g. the \daps\ capacity...
+\newcommand{\daps}{player's}
+\newcommand{\firmwarefilename}{\fname{rockbox.sansa}}
+\newcommand{\firmwareextension}{\fname{sansa}}
+\newcommand{\screenshotsize}{3cm}
+\newcommand{\disk}{flash storage}
+
+% link external keymap file
+\input{platform/keymap-sansaclip.tex}