Initial work on a Gigabeat S manual. Still a bit to do.

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

apps/lang/english.lang

@@ -4745,12 +4745,14 @@
     alarm: "PLAY=Set OFF=Cancel"
     ipod*: "SELECT=Set MENU=Cancel"
     h10,h10_5gb: "SELECT=Set PREV=Cancel"
+    gigabeats: "SELECT=Set POWER=Cancel"
   </source>
   <dest>
     *: none
     alarm: "PLAY=Set OFF=Cancel"
     ipod*: "SELECT=Set MENU=Cancel"
     h10,h10_5gb: "SELECT=Set PREV=Cancel"
+    gigabeats: "SELECT=Set POWER=Cancel"
   </dest>
   <voice>
     *: none

docs/CREDITS-MANUAL

@@ -30,4 +30,5 @@ Tom Ross
 Philippe Latulippe
 Costas Calamvokis
 Peter Harley
+Will Robertson
 

manual/configure_rockbox/playback_options.tex

@@ -64,7 +64,7 @@ related to audio playback.
           \ButtonPower{} and \ButtonRight{}.
           To reset the markers hold \ButtonPower{} and press \ButtonUp{}.
       }
-      \opt{gigabeat}{
+      \opt{gigabeatf}{
           To set the Start Point (A) hold \ButtonA{} and press \ButtonLeft{}.
           Setting the End Point (B) is done accordingly using
           \ButtonA{} and \ButtonRight{}.
@@ -76,7 +76,13 @@ related to audio playback.
           \ButtonDisplay{} and \ButtonRight{}.
           To reset the markers hold \ButtonDisplay{} and press \ButtonSelect{}.
       }
-      \nopt{h1xx,h300,h10,h10_5gb,ipod,x5,e200,gigabeat,RECORDER_PAD,MROBE100_PAD}{
+      \opt{gigabeats}{
+          To set the Start Point (A) hold \ButtonBack{} and press \ButtonLeft{}.
+          Setting the End Point (B) is done accordingly using
+          \ButtonBack{} and \ButtonRight{}.
+          To reset the markers \ButtonBack{} and press \ButtonSelect{}.
+      }
+      \nopt{h1xx,h300,h10,h10_5gb,ipod,x5,e200,gigabeatf,RECORDER_PAD,MROBE100_PAD,gigabeats}{
         \fixme{
           --- Sets Start Point (A)\\
           --- Sets End Point (B)\\
@@ -241,7 +247,7 @@ related to audio playback.
     \setting{Auto-Change Directory} to function properly.}
 
   %
-\opt{ipodnano,ipodvideo,ipodmini,ipod4g,ipod3g,ipodcolor,gigabeatf}{
+\opt{ipodnano,ipodvideo,ipodmini,ipod4g,ipod3g,ipodcolor,gigabeatf,gigabeats}{
 \item[Pause on headphone unplug.] Enables and disables automatic pausing of 
   playback when the headphones are disconnected from the \daps{} headphone 
   socket.

manual/getting_started/gigabeats_install.tex

@@ -0,0 +1,8 @@
+% $Id$
+
+Installing the bootloader is only needed once. It involves replacing the
+existing firmware file on your \dap{} with another version. To be able
+to boot the original firmware you must generate your own \fname{nk.bin} file
+using the mknkboot utility. Alternatively you can use a pre-built bootloader,
+however you must keep in mind that by using the pre-built version you will be
+unable to dual-boot your \dap{}.

manual/getting_started/installation.tex

@@ -47,7 +47,7 @@ installation options.
   the \playerman{} bootloader. It is responsible for loading the Rockbox
   firmware and for providing the dual boot function. It directly replaces the
   \playerman{} firmware on the \daps{} disk.
-  \opt{gigabeat}{\note{Dual boot does not currently work on the gigabeat.}}}
+  \opt{gigabeatf}{\note{Dual boot does not currently work on the gigabeat.}}}
 
   \opt{HAVE_RB_BL_IN_FLASH}{
   The bootloader is the program that tells your
@@ -119,7 +119,7 @@ software.
   \opt{h10,h10_5gb}{\warn{The following steps require you to use UMS mode and so
     may require use of the UMS trick as described in the bootloader installation
     section.}}
-  \opt{gigabeat}{\warn{During installation, do not connect your \dap{}
+  \opt{gigabeatf}{\warn{During installation, do not connect your \dap{}
     using the cradle but plug the USB cable directly to the \dap{}.}}  
 \end{description}
 For manual installation and customization additional software is required.
@@ -320,9 +320,10 @@ structure that Rockbox needs.
   \opt{ipod}{\input{getting_started/ipod_install.tex}}
   \opt{m5,x5}{\input{getting_started/iaudio_install.tex}}
   \opt{h10,h10_5gb}{\input{getting_started/h10_install.tex}}
-  \opt{gigabeat}{\input{getting_started/gigabeat_install.tex}}
+  \opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}}
   \opt{sansa}{\input{getting_started/sansa_install.tex}}
   \opt{mrobe100}{\input{getting_started/mrobe100_install.tex}}
+  \opt{gigabeats}{\input{getting_started/gigabeats_install.tex}}
 }
 
 \subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
@@ -387,7 +388,7 @@ completely follow the manual uninstallation instructions below.}}
   connect the \dap{} to your computer, and delete the
   \fname{\firmwarefilename} file.
 }
-\nopt{gigabeat,m5,x5,archos,mrobe100}
+\nopt{gigabeatf,m5,x5,archos,mrobe100}
   {
   \note{The Rockbox bootloader can start the original firmware on your \dap.
   (See \reference{ref:Dualboot} for more information.)}}

manual/platform/gigabeats.tex

@@ -0,0 +1,111 @@
+% $Id$ %
+\def\UseOption{gigabeats}
+\edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
+\edef\UseOption{\UseOption,GIGABEAT_S_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
+\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
+\edef\UseOption{\UseOption,gigabeat}
+
+\newcommand{\playerman}{Toshiba}
+\newcommand{\playertype}{Gigabeat S Series}
+\newcommand{\playerlongtype}{\playertype}
+\newcommand{\genericimg}{240x320x16}
+\newcommand{\specimg}{gigabeats}
+%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.gigabeat}}
+\newcommand{\screenshotsize}{6cm}
+\newcommand{\disk}{hard disk}
+
+\newcommand{\ButtonPower}{\btnfnt{Power}}
+\newcommand{\ButtonBack}{\btnfnt{Back}}
+\newcommand{\ButtonMenu}{\btnfnt{Menu}}
+\newcommand{\ButtonLeft}{\btnfnt{Left}}
+\newcommand{\ButtonRight}{\btnfnt{Right}}
+\newcommand{\ButtonUp}{\btnfnt{Up}}
+\newcommand{\ButtonDown}{\btnfnt{Down}}
+\newcommand{\ButtonVolUp}{\btnfnt{Volume up}}
+\newcommand{\ButtonVolDown}{\btnfnt{Volume down}}
+\newcommand{\ButtonSelect}{\btnfnt{Select}}
+\newcommand{\ButtonPrev}{\btnfnt{Previous}}
+\newcommand{\ButtonPlay}{\btnfnt{Play}}
+\newcommand{\ButtonNext}{\btnfnt{Next}}
+\newcommand{\ButtonHold}{\btnfnt{Hold}}
+
+%Button actions, standard context
+\newcommand{\ActionStdPrev}{\ButtonUp}
+\newcommand{\ActionStdPrevRepeat}{Long \ButtonUp}
+\newcommand{\ActionStdNext}{\ButtonDown}
+\newcommand{\ActionStdNextRepeat}{Long \ButtonDown}
+\newcommand{\ActionStdCancel}{\ButtonLeft{}, \ButtonPower{} or \ButtonBack}
+\newcommand{\ActionStdContext}{Long \ButtonSelect}
+\newcommand{\ActionStdQuickScreen}{Long \ButtonMenu}
+\newcommand{\ActionStdMenu}{\ButtonMenu}
+\newcommand{\ActionStdOk}{\ButtonSelect{} or \ButtonRight}
+
+%Button actions, wps context
+\newcommand{\ActionWpsPlay}{\ButtonPlay}
+\newcommand{\ActionWpsSkipNext}{\ButtonRight{} or \ButtonNext}
+\newcommand{\ActionWpsSkipPrev}{\ButtonLeft{} or \ButtonPrev}
+\newcommand{\ActionWpsSeekBack}{Long \ButtonLeft{} or Long \ButtonNext}
+\newcommand{\ActionWpsSeekFwd}{Long \ButtonRight{} or Long \ButtonNext}
+\newcommand{\ActionWpsAbSetBNextDir}{\ButtonBack{} + \ButtonRight}
+\newcommand{\ActionWpsAbSetAPrevDir}{\ButtonBack{} + \ButtonLeft}
+\newcommand{\ActionWpsStop}{\ButtonPower}
+\newcommand{\ActionWpsVolDown}{\ButtonDown{} or \ButtonVolDown}
+\newcommand{\ActionWpsVolUp}{\ButtonUp{} or \ButtonVolUp}
+\newcommand{\ActionWpsPitchScreen}{\ButtonBack{} + \ButtonUp/\ButtonDown}
+\newcommand{\ActionWpsQuickScreen}{Long \ButtonMenu}
+\newcommand{\ActionWpsMenu}{\ButtonMenu}
+\newcommand{\ActionWpsContext}{Long \ButtonSelect}
+\newcommand{\ActionWpsBrowse}{\ButtonSelect}
+\newcommand{\ActionWpsAbReset}{\ButtonBack{}}
+\newcommand{\ActionWpsIdThreeScreen}{\ButtonA{} + \ButtonMenu}
+
+%Button actions, tree context
+\newcommand{\ActionTreeWps}{\ButtonPlay}
+\newcommand{\ActionTreeStop}{\ButtonPower}
+\newcommand{\ActionTreeEnter}{\ButtonSelect{} or \ButtonRight}
+\newcommand{\ActionTreeParentDirectory}{\ButtonLeft}
+
+%Button actions, YesNo context
+\newcommand{\ActionYesNoAccept}{\ButtonSelect}
+
+%Button actions, Setting context
+\newcommand{\ActionSettingInc}{\ButtonUp}
+\newcommand{\ActionSettingDec}{\ButtonDown}
+
+%Button actions, Alarm screen
+\newcommand{\ActionAlarmSet}{\ButtonSelect}
+\newcommand{\ActionAlarmCancel}{\ButtonPower}
+\newcommand{\ActionAlarmHoursInc}{\ButtonUp}
+\newcommand{\ActionAlarmHoursDec}{\ButtonDown}
+
+%Button actions, Virtual Keyboard Context
+\newcommand{\ActionKbdLeft}{\ButtonLeft}
+\newcommand{\ActionKbdRight}{\ButtonRight}
+\newcommand{\ActionKbdSelect}{\ButtonSelect}
+\newcommand{\ActionKbdCursorLeft}{\ButtonPrev}
+\newcommand{\ActionKbdCursorRight}{\ButtonNext}
+\newcommand{\ActionKbdPageFlip}{\ButtonBack{} + \ButtonMenu}
+\newcommand{\ActionKbdDone}{\ButtonPlay}
+\newcommand{\ActionKbdAbort}{\ButtonBack}
+\newcommand{\ActionKbdBackSpace}{\ButtonMenu}
+\newcommand{\ActionKbdMorseInput}{\ButtonBack{} + \ButtonVolUp}
+\newcommand{\ActionKbdMorseSelect}{\ButtonSelect}
+\newcommand{\ActionKbdUp}{\ButtonUp}
+\newcommand{\ActionKbdDown}{\ButtonDown}
+
+%Button actions, Pitch Screen context
+\newcommand{\ActionPsToggleMode}{\ButtonMenu}
+\newcommand{\ActionPsIncSmall}{\ButtonUp}
+\newcommand{\ActionPsIncBig}{Long \ButtonUp}
+\newcommand{\ActionPsDecSmall}{\ButtonDown}
+\newcommand{\ActionPsDecBig}{Long \ButtonDown}
+\newcommand{\ActionPsNudgeLeft}{\ButtonLeft}
+\newcommand{\ActionPsNudgeRight}{\ButtonRight}
+\newcommand{\ActionPsReset}{\ButtonPlay}
+\newcommand{\ActionPsExit}{\ButtonBack}

manual/rockbox_interface/main.tex

@@ -169,6 +169,30 @@ paragraph.
   button and nearest to the top of the unit the \ButtonPower{} button, which is held
   down to turn the \dap{} on or off.}
   %
+  \opt{gigabeats}{
+  Hold the \dap{} with the screen on top and the controls on the right hand side.  
+  Below the screen is a cross-shaped pad which contains the \ButtonUp{}, 
+  \ButtonDown{}, \ButtonLeft{}, \ButtonRight{} and \ButtonSelect{} controls. 
+  On the top of the unit from left to right are the headphone socket and the 
+  \ButtonHold{} switch.  The \ButtonHold{} switch puts the \dap{} into
+  hold mode when it is switched to the right of the unit. 
+  The buttons will have no effect when this is the case.  
+  
+  Starting from the left hand side on the bottom of the unit, nearer to the back
+  than the front, is a recessed switch which controls whether the battery is on 
+  or off.  When this switch is to the left, the battery is disconnected.  
+  This can be used for a hard reset of the unit, or if the \dap{} is being placed 
+  in storage.  Next to that is a custom connector, presumably for planned accessories
+  which were never released, and finally on the right hand side of the bottom of the
+  unit is a mini USB socket for connecting directly to USB.
+  
+  Finally on the right hand side of the unit are some control buttons.  Going from
+  the bottom of the unit to the top there are three small round buttons, the 
+  \ButtonNext{} buttton, \ButtonPlay{} button, and \ButtonPrev{} button (from bottom
+  to top) then a rocker volume switch with of the \ButtonVolDown{} button below the
+  \ButtonVolUp{} button.  Above that is one more small round button, the \ButtonPower{} 
+  button, which is held down to turn the \dap{} on or off.}
+  %
   \opt{mrobe100}{
   Hold the \dap{} with the black front facing you such that the m:robe writing 
   is readable. Below the writing is the touch sensitive pad with the 
@@ -283,7 +307,7 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
       \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu{} / \ButtonSelect}%
       \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}
+      \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD}
           {\ButtonPower}%
       & Start Rockbox\\
       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{Long \ButtonOff}%
@@ -291,7 +315,7 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
       \opt{ONDIO_PAD,recorderv2fm}{Long \ButtonOff}%
       \opt{recorder}{Double tap \ButtonOff\ when playback is stopped}%
       \opt{PLAYER_PAD}{From the Main Menu, select \textbf{Shutdown}}%
-      \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,MROBE100_PAD}%
+      \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD}%
           {Long \ButtonPower}%
       & Shutdown Rockbox\\
     \end{btnmap}
@@ -308,7 +332,7 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
   \opt{ondiosp,ondiofm}{\daps{} display} goes off.%
 }
 
-\nopt{gigabeat,m5,x5,archos}
+\nopt{gigabeatf,m5,x5,archos}
   {
   \subsection{Starting the original firmware}
   \label{ref:Dualboot}
@@ -366,6 +390,12 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
     message on the screen.
     }
 
+  \opt{gigabeats}
+    {
+    Rockbox has a dual-boot feature. To boot into the original firmware,
+    turn the \ButtonHold{} switch on just after turning on the \dap{}.
+    }
+
   }
 
 \subsection{The first contact}