Cowon D2 manual: Platform specific information and installation instructions

FS#10735 - Platform files for Cowon D2 manual
Author: Aleksei Kaveshnikov (4nykey)

I've modified the original patch to comply with current state of both the
player and manual.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@24008 a1c6a512-1295-4272-9138-f99709370657

manual/configure_rockbox/sound_settings.tex

@@ -327,6 +327,7 @@ change to customise your listening experience.
       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonUp}
       \opt{SANSA_E200_PAD}{\ButtonScrollBack}
       \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonRight}
+      \opt{COWON_D2_PAD}{\TouchMidRight}
     \opt{HAVEREMOTEKEYMAP}{& 
       \opt{IRIVER_RC_H100_PAD,GIGABEAT_RC_PAD}{\ButtonRCFF}
         }
@@ -336,6 +337,7 @@ change to customise your listening experience.
       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonDown}
       \opt{SANSA_E200_PAD}{\ButtonScrollFwd}
       \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonLeft}
+      \opt{touchscreen}{\TouchMidLeft}
     \opt{HAVEREMOTEKEYMAP}{& 
       \opt{IRIVER_RC_H100_PAD,GIGABEAT_RC_PAD}{\ButtonRCRew}
         }
@@ -344,6 +346,7 @@ change to customise your listening experience.
       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonLeft}
       \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD}{\ButtonLeft}
       \opt{SANSA_E200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonUp}
+      \opt{COWON_D2_PAD}{\ActionStdPrev}
     \opt{HAVEREMOTEKEYMAP}{& }
       \opt{GIGABEAT_RC_PAD}{\ButtonRCVolUp}
       & Moves to the previous EQ band. \\
@@ -351,12 +354,14 @@ change to customise your listening experience.
       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonRight}
       \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD}{\ButtonRight}
       \opt{SANSA_E200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonDown}
+      \opt{COWON_D2_PAD}{\ActionStdNext}
     \opt{HAVEREMOTEKEYMAP}{& }
       \opt{GIGABEAT_RC_PAD}{\ButtonRCVolDown}
       & Moves to the next EQ band. \\
       %
       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonSelect}
       \opt{IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD,SANSA_E200_PAD}{\ButtonSelect}
+      \opt{touchscreen}{\ButtonMenu{} or \TouchCenter}
     \opt{HAVEREMOTEKEYMAP}{&       
       \opt{IRIVER_RC_H100_PAD}{\ButtonRCSelect}
       \opt{GIGABEAT_RC_PAD}{\ButtonRCPlay}
@@ -369,6 +374,7 @@ change to customise your listening experience.
       \opt{IAUDIO_X5_PAD}{\ButtonPower/\ButtonRec}
       \opt{SANSA_E200_PAD}{\ButtonPower/\ButtonRight}
       \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonPower}
+      \opt{touchscreen}{\ButtonPower{} or \TouchTopLeft}
     \opt{HAVEREMOTEKEYMAP}{& 
       \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop}
       \opt{GIGABEAT_RC_PAD}{\ButtonRCDsp}

manual/configure_rockbox/system_options.tex

@@ -29,6 +29,7 @@
       \opt{m5,x5}{950mAh}%
       \opt{gigabeatf}{2000mAh}%
       \opt{gigabeats}{700mAh}%
+      \opt{cowond2}{1600mAh}%
       , which is the capacity value for the standard
       \opt{archos}{batteries}\nopt{archos}{battery} shipped with the \dap.
         Rockbox uses this value for runtime estimation, not battery percentage

manual/getting_started/cowond2_install.tex

@@ -0,0 +1,28 @@
+\begin{enumerate}
+\item Get a copy of the original \playerman{} \playertype{} firmware from
+  \url{http://www.cowonglobal.com/zeroboard/zboard.php?id=C08&bmenu=support}.
+  It has to be of the same version that is currently installed on your \dap{}.
+
+\item Build the mktccboot tool or download a binary for your operating system.
+
+\item Build the bootloader (\fname{bootloader-cowond2.bin}). Pre-built binary
+  is available at \download{bootloader/cowon/d2/bootloader-cowond2.bin}.
+
+\item Patch the bootloader into the \playerman{} firmware using mktccboot:
+  \begin{code}
+    mktccboot D2N.bin bootloader-cowond2.bin D2N-patched.bin
+  \end{code}
+  \note{The filename depends on the firmware version and hardware revision as
+    shown in the table below (for the \playertype{} use the file found in folder
+    ``\fname{1}'', not ``\fname{0}'')
+    \begin{table}
+      \begin{rbtabular}{0.6\textwidth}{XXX}%
+        { \textbf{FW / HW} & \textbf{\playertype{}} & \textbf{\playertype{}+}}{}{}
+        \textbf{1.xx, 3.xx} & \fname{D2.bin} & \fname{D2\_P.bin} \\
+        \textbf{2.xx, 4.xx} & \fname{D2N.bin} & \fname{D2N\_P.bin} \\
+      \end{rbtabular}
+    \end{table}}
+
+\item Copy the output file (``\fname{D2N-patched.bin}'' in our example) to the
+  root of the \daps{} internal memory and rename it according to the above table.
+\end{enumerate}

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}{
+\opt{ipodnano,ipodnano2g,ipodvideo,e200,c200,e200v2,clip,cowond2}{
 \begin{description}  
 \item[Supported hardware versions.] 
     \opt{ipodnano,ipodnano2g}{
@@ -50,10 +50,39 @@ follow the instructions at
     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{cowond2}{
+    Rockbox runs on all \playerman{} \playertype{} and \playertype{}+ variants
+    (2 / 4 / 8 / 16GB, with or without DAB/DMB).
+    \note{Newer \playertype{}+ hardware revisions use an updated power
+    management chip, and some functionality is not yet implemented on these
+    players (e.g. touchscreen support).}
 }
 \end{description}
 }
 
+\opt{cowond2}{
+\begin{description}
+  \item[Current limitations.] Most Rockbox functions are usable on the
+    \playertype{}/\playertype{}+, including music playback and most plugins, but
+    there are a number of shortcomings that prevent it from being a fully
+    supported target:
+    \begin{itemize}
+      \item An SD card is required to use many features, since the internal
+        flash memory is read-only in Rockbox.
+        \warn{The SD driver is still in development and may contain bugs.
+          There have been reports of SD cards becoming unusable after being used
+          with Rockbox on \playerman{} \playertype{}. Only use old, low-capacity
+          cards until we are satisfied the driver is safe to use.\\}
+      \item There is only basic touchscreen support. Further work is
+        required to make the UI more usable with a touchscreen in general.
+        \note{The touchscreen can be used in two modes, either a 3x3 grid mode
+          which divides the screen into areas to emulate a set of physical
+          buttons (the default setting), or ``absolute point'' mode where the
+          touchscreen is used to point to items on the screen.\\}
+    \end{itemize}
+\end{description}
+}
 \opt{h300}{
 \begin{description}  
   \item[DRM capability.] If your \dap{} has a US firmware, then by installing Rockbox you will
@@ -373,7 +402,12 @@ data partiton.}}
 
 \item Take the \fname{.zip} file that you downloaded and use
  the ``Extract all'' command of your unzip program to extract 
- the files onto \opt{gigabeats}{the main data partition of }your \dap{}.
+ the files onto%
+ \opt{gigabeats}{the main data partition of }
+ \opt{cowond2}{either an SD card or the internal memory of }
+ your \dap{}.
+ \opt{cowond2}{\note{If you have chosen to extract to the internal memory, it
+     will not be possible to save settings.}}
 \end{enumerate}
 
 \note{The entire contents of the \fname{.zip} file should be extracted 
@@ -407,6 +441,7 @@ structure that Rockbox needs.\\}
   \opt{sansa}{\input{getting_started/sansa_install.tex}}
   \opt{sansaAMS}{\input{getting_started/sansaAMS_install.tex}}
   \opt{mrobe100}{\input{getting_started/mrobe100_install.tex}}
+  \opt{cowond2}{\input{getting_started/cowond2_install.tex}}
 }}
 
 \subsection{Finishing the install}\label{ref:finish_install}
@@ -437,7 +472,7 @@ structure that Rockbox needs.\\}
   \end{itemize}
 }
 
-\opt{h10,h10_5gb,ipod,mrobe100,sansa,archos,sansaAMS}{
+\opt{h10,h10_5gb,ipod,mrobe100,sansa,archos,sansaAMS,cowond2}{
   Safely eject / unmount the USB drive, unplug the cable and restart.
 }
 
@@ -482,7 +517,7 @@ Rockbox Utility can also aid in the production of talk files, which allow Rockbo
 to speak file and folder names.
 
 \section{Running Rockbox}
-\nopt{ipod,gigabeats}{When
+\nopt{ipod,gigabeats,cowond2}{When
 you turn the unit on, Rockbox should load.}
 \opt{ipod}{Hard reset the Ipod by holding
   \opt{IPOD_4G_PAD}{\ButtonMenu{}+\ButtonSelect{}}%
@@ -501,6 +536,15 @@ you turn the unit on, Rockbox should load.}
     See \reference{ref:database} for more information.}
 }
 
+\opt{cowond2}{
+  To boot the Rockbox firmware set the \ButtonHold{} switch immediately after
+  power on.\\
+  \note{If you have chosen to install to an SD card and it is inserted at power
+    on, Rockbox will boot from that card and use it as the primary drive for
+    storing settings, etc. If there is no SD card inserted, Rockbox will boot
+    from the internal memory, and it will not be possible to save settings.}
+}
+
 \opt{ipod}{
   \note{
     If you have loaded music onto your \dap{} using Itunes, 

manual/platform/cowond2.tex

@@ -3,6 +3,8 @@
 \edef\UseOption{\UseOption,COWON_D2_PAD}
 \edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
+\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
+\edef\UseOption{\UseOption,cowond2}
 
 \newcommand{\playerman}{Cowon}
 \newcommand{\playertype}{D2}

manual/rockbox_interface/main.tex

@@ -18,9 +18,27 @@
 \end{center}
 
 Throughout this manual, the buttons on the \dap{} are labelled according to the
-picture above. Whenever a button name is prefixed by ``Long'', a long press of
-approximately one second should be performed on that button. The buttons are
-described in detail in the following paragraph.
+picture above.
+\opt{touchscreen}{
+The areas of the touchscreen in the 3x3 grid mode are in turn referred as follows:
+\begin{table}
+    \begin{center}
+    %\begin{tabularx}{.82\textwidth}{l|c|r}
+    \begin{tabularx}{.9\textwidth}{X|X|X}
+    \toprule
+        \TouchTopLeft & \TouchTopMiddle & \TouchTopRight \\
+    \midrule
+        \TouchMidLeft & \TouchCenter & \TouchMidRight \\
+    \midrule
+        \TouchBottomLeft & \TouchBottomMiddle & \TouchBottomRight \\
+    \bottomrule
+    \end{tabularx}
+    \end{center}
+\end{table}
+}
+Whenever a button name is prefixed by ``Long'', a long press of approximately
+one second should be performed on that button. The buttons are described in
+detail in the following paragraph.
 
 \blind{
   Additional information for blind users is available on the Rockbox website at 
@@ -443,6 +461,8 @@ described in detail in the following paragraph.
 }
 
 \subsection{Turning the \dap{} on and off}
+\opt{cowond2}{Rockbox has a dual-boot feature with the original firmware being
+  the default.\\}
 To turn on and off your Rockbox enabled \dap{} use the following keys:
   \begin{table}
     \begin{btnmap}{}{}
@@ -452,8 +472,8 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
       \opt{ONDIO_PAD}{\ButtonOff}\opt{RECORDER_PAD,PLAYER_PAD}%
           {Long \ButtonOn}%
       \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD%
-          ,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD,sansaAMS,COWON_D2_PAD}
-          {\ButtonPower}%
+          ,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD,sansaAMS}{\ButtonPower}%
+      \opt{COWON_D2_PAD} {\ButtonPower{}, then \ButtonHold}%
     \opt{HAVEREMOTEKEYMAP}{&
       \opt{IRIVER_RC_H100_PAD}{\ButtonRCOn}%
           }
@@ -579,6 +599,11 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
     turn the \ButtonHold{} switch on just after turning on the \dap{}.
     }
 
+  \opt{cowond2}
+    {
+    Use \ButtonPower{} to boot the original \playerman{} firmware.
+    }
+
   }
 \subsection{Putting music on your \dap{}}