ErosQNative: Update and clarify manual

Rework installation instructions, add blind users button
description, and generally clean up and make more readable.

Change-Id: I81fd4a7abf2ccc886cdc029afb73b1d0a71a35d1

manual/getting_started/hibyos_nativeinstall.tex

@@ -1,18 +1,30 @@
+In order to install Rockbox onto the \dap{}, we need to first install the bootloader
+onto the device's internal memory. The bootloader is the only modification to the device
+we will make - Rockbox itself will exist only on the SD card.
+
+Once the bootloader is installed onto the device, it is exceedingly rare to need to change it.
+Updating Rockbox is as simple as overwriting it on the SD card and rebooting the device.
+
 We will install the bootloader with the original firmware's recovery
-mode. The process is summed up as the following:
+mode. Please follow the instructions detailed below.
+% mode. The process is summed up by the following:
 
-\begin{itemize}
+% \begin{enumerate}
-  \item Determine what hardware version your player is and download
+%   \item Determine what hardware version your player is and download
-    the correct bootloader update file
+%     the correct bootloader update file
-  \item Place the bootloader \fname{update.upt} file on the SD card
+%   \item Place the bootloader \fname{update.upt} file on the SD card
-  \item In the original firmware, run the Firmware Update: \\
+%   \item In the original firmware, run the Firmware Update: \\
-    \fname{System Settings --> Firmware Update}
+%     \fname{System Settings --> Firmware Update}
-\end{itemize}
+% \end{enumerate}
+
+% \textbf{These steps, in detail, are:}
+
+\begin{enumerate}
+\item \textbf{Determine hardware version}
 
-\subsubsection{Determine hardware version}\label{ref:determine_hardware_version}
 Determine what hardware version your player is. Go to \fname{System Settings --> About The Player --> Version} and reference
 the list below. hw1, hw1.5, and hw2 players all use the same update
-file (with one exception), while hw3 players use a different one.
+file (with one exception), while hw3 players and hw4 players each use a different one.
 
 \note{Important: If your player's version is not contained in this list,
 for example if the firmware version is newer than what is listed here,
@@ -26,15 +38,17 @@ may not be the most up to date, please see the wiki page at
 
 \begin{description}
 \item[hw1/hw1.5/hw2 players]
+\hfill{}
   \begin{itemize}
     \item Aigo Eros Q V1.8 - V2.0
     \item Hifiwalker H2 V1.1 - V1.6
     \item Surfans F20 V2.2 - V2.7
   \end{itemize}
   These players use \fname{erosqnative-hw1hw2-erosq.upt} as the update file.
-  The lone exception is the Hifiwalker H2 V1.3, which uses the update file
+  The lone exception is the Hifiwalker H2 V1.3, which uses the update file \\
   \fname{erosqnative-hw1hw2-eros\_h2.upt}.
 \item[hw3 players]
+\hfill{}
   \begin{itemize}
     \item Aigo Eros Q V2.1
     \item Hifiwalker H2 V1.7 - V1.8
@@ -42,29 +56,41 @@ may not be the most up to date, please see the wiki page at
   \end{itemize}
   These players use \fname{erosqnative-hw3-erosq.upt} as the update file.
 \item[hw4 players]
+\hfill{}
   \begin{itemize}
     \item Aigo Eros Q V2.2
     \item Hifiwalker H2 V1.9 - V2.0
     \item Surfans F20 V3.4
   \end{itemize}
-  These players use \fname{erosqnative-hw4-erosq_2024.upt} as the update file.
+  These players use \fname{erosqnative-hw4-erosq\_2024.upt} as the update file.
 \end{description}
 
 Download the \fname{.upt} file for these players from \download{bootloader/aigo/native/}.
 
-\note{All players use the same Rockbox build, only the bootloader is different.}
+% \subsubsection{Format the SD card with the stock firmware}\label{ref:format_sd_card}
+% This is a convenient time to format the SD card. We need to ensure the SD card is formatted
+% as FAT - most cards come from the factory with exFAT on them. The stock firmware can be used to do this.
+% Back up any file you do not want to lose and go to \fname{System Settings --> Reset --> Format TF Card}
+% in the stock firmware. Once done, you can put your files back on the SD card.
+
+% \note{Remember, this must also be done if you acquire a new SD card in the future!}
+
+\item \textbf{Place update file on SD card}
 
-\subsubsection{Place update file on SD card}\label{ref:place_on_sd_card}
 Place the appropriate bootloader file on the root of the SD card and name it
 \emph{exactly} \fname{update.upt}.
 
-\note{This is a good time to ensure that your Rockbox installation \fname{.rockbox}
-is present on your SD card.}
-
 Don't forget to safely eject/unmount your player.
 
-\subsubsection{Run Firmware Update}\label{ref:run_firmware_update}
+\item \textbf{Run Firmware Update}
+
 In the original firmware, run the firmware updater by going to
-\fname{System Settings --> Firmware Update}. At this point, you can delete
+\fname{System Settings --> Firmware Update}. The player will reboot into the updater and self-install
-\fname{update.upt} from the SD card if you wish. \emph{Do not delete .rockbox,
+the bootloader.
-this is your Rockbox installation and needs to stay there!}
+
+If you have not installed the Rockbox build onto the SD card yet, it will reboot and fail
+to find Rockbox. We simply then need to install Rockbox onto the SD card. Please continue to
+section \ref{sec:installing_firmware}, \textit{Installing the Firmware}.
+
+Once the bootloader is installed onto the device, \fname{update.upt} can be deleted from the SD card if you wish.
+\end{enumerate}

manual/getting_started/installation.tex

@@ -125,7 +125,8 @@ of before installing.
       \note{The SD card that sometimes come bundled with these players are usually
       of substandard quality and are not to be trusted. It is recommended to source
       a card of a reputable brand, from a reputable source, such as direct from
-      the manufacturer.}
+      the manufacturer. Do check the bundled card for any update file which may
+      be included, though. It may be useful for the community if it is a new version.}
     }
   \item[USB DAC.] This feature is not supported by Rockbox, but you can
     dual-boot the original firmware if you want to use it.
@@ -389,6 +390,10 @@ in installing.
 
 \subsection{Automated Installation}
 
+\opt{gigabeats,ondavx777,fiiom3k,shanlingq1,erosqnative}{
+\note{Rockbox Utility does not currently support the \playertype{} and you will
+therefore need to follow the manual install instructions.}}
+\nopt{erosqnative}{
 To automatically install Rockbox, download the official installer and
 housekeeping tool \caps{Rockbox Utility}. It allows you to:
 \begin{itemize}
@@ -404,10 +409,6 @@ 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,ondavx777,fiiom3k,shanlingq1,erosqnative}{
-\note{Rockbox Utility does not currently support the \playertype{} and you will
-therefore need to follow the manual install instructions below.\\}}
-
 When first starting \caps{Rockbox Utility} run ``Autodetect'',
 found in the configuration dialog (File $\rightarrow$ Configure). Autodetection
 can detect most player types. If autodetection fails or is unable to detect
@@ -416,6 +417,11 @@ the location of the \dap{} in your filesystem. On Windows, this is the drive
 letter the \dap{} gets assigned, on other systems this is a path in the
 filesystem.\\*
 
+\opt{erosqnative}{
+  Due to some quirks with the original firmware on the \playertype{}, you will need
+  to match the brand and original firmware version in \caps{Rockbox Utility} to your
+  player. This, unfortunately, cannot be done automatically by \caps{Rockbox Utility}.
+}
 
 \opt{iriverh100,iriverh300}{
   Rockbox Utility will ask you for a compatible copy of the original
@@ -493,6 +499,7 @@ filesystem.\\*
     utility like mentioned in the prerequisites section to extract the
     \fname{firmware.sb} from the \fname{.zip} file to your desktop.}
 }
+}
 \subsubsection{Choosing a Rockbox version}\label{sec:choosing_version}
 
 There are three different versions of Rockbox available from the
@@ -505,6 +512,10 @@ select either ``Minimal Installation'' or ``Complete Installation'' from the
 release version of Rockbox. Using the ``Installation'' tab will allow you
 to select which version you wish to install.
 
+\note{\textbf{There are two different versions of Rockbox for the \playertype{}. This manual only
+refers to the \playertype{} Native version, and thus when downloading Rockbox, ensure
+that the download name includes "erosqnative"!}}
+
 \begin{description}
 
 \item[Release.] The release version is the latest stable release, free
@@ -534,13 +545,16 @@ Please now go to \reference{ref:finish_install} to complete the installation pro
 
 \subsection{Manual Installation}
 
+\nopt{erosqnative}{
 The manual installation method is still available to you, should you need or desire it
 by following the instructions below. If you have used Rockbox Utility
 to install Rockbox, then you do not need to follow the next section and can skip
-straight to \reference{ref:finish_install}
+straight to \reference{ref:finish_install}.
+}
 
-\opt{gigabeats}{\subsubsection{Installing the bootloader}
+\opt{gigabeats,erosqnative}{\subsubsection{Installing the bootloader}
-    \input{getting_started/gigabeats_install.tex}
+    \opt{gigabeats}{input{getting_started/gigabeats_install.tex}}
+    \opt{erosqnative}{\input{getting_started/hibyos_nativeinstall.tex}}
 }
 
 \subsubsection{Installing the firmware}\label{sec:installing_firmware}
@@ -551,15 +565,47 @@ partition (containing at least a file called \fname{nk.bin}) and
 the main data partition. Rockbox \emph{must} be installed onto the main
 data partition.}}
 
+\opt{erosqnative}{
+  Rockbox itself is installed to the SD card, and unlike the Bootloader,
+  the installation of it does not modify the device \textit{at all}.
+  Please follow the instructions below to install it to your SD card.
+
+  \note{Remember that this operation will need to be repeated if you switch to a different SD card!}
+}
+
 \begin{enumerate}
 \item Download your chosen version of Rockbox from the links in the
   previous section.
 
+  \opt{erosqnative}{
+    \note{\textbf{There are two different versions of Rockbox for the \playertype{}. This manual only
+      refers to the \playertype{} Native version, and thus when downloading Rockbox, ensure
+      that the download name includes "erosqnative"!}}
+
+    \item Ensure that your SD card is formatted as FAT32, \textit{not exFAT!} Reformat
+      the SD card with the original firmware's formatting tool by doing the following:
+
+      \begin{enumerate}
+        \item Insert the SD card into the \dap{}.
+        \item With the player OFF, boot the \dap{} into the original firmware by
+          holding \ButtonPlay{} and \ButtonPower{}.
+        \item Ensure that any files on the card you want to save are backed up,
+          as this operation will wipe the drive entirely.
+        \item Go to \fname{System Settings --> Reset --> Format TF Card} in the stock
+          firmware to format the SD card to FAT32.
+      \end{enumerate}
+  }
+
 \item Connect your \dap{} to the computer via USB
-  \opt{sansa,sansaAMS,iriverh10,iriverh10_5gb,vibe500,fuzeplus,samsungyh}
+  \nopt{erosqnative}{
-  { in MSC mode }
+    \opt{sansa,sansaAMS,iriverh10,iriverh10_5gb,vibe500,fuzeplus,samsungyh}
-  \opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire }as described in
+    { in MSC mode }
-  the manual that came with your \dap{}.
+    \opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire }as described in
+    the manual that came with your \dap{}.
+  }
+  \opt{erosqnative}{by, with the player OFF, holding \ButtonPlay{} and \ButtonPower{}
+    to boot into the original firmware, and then plugging in the USB cable.
+  }
 
 \item Take the \fname{.zip} file that you downloaded and use
  the ``Extract all'' command of your unzip program to extract
@@ -585,7 +631,7 @@ have a directory called \fname{.rockbox}, which contains all the files needed
 by Rockbox, in the main directory of your \daps{} drive.
 
 \opt{swcodec}{%
-    \nopt{gigabeats}{%
+    \nopt{gigabeats,erosqnative}{%
     \subsubsection{Installing the bootloader}
         \opt{iriverh100,iriverh300}{\input{getting_started/iriver_install.tex}}
         \opt{mpiohd200,mpiohd300}{\input{getting_started/mpio_install.tex}}
@@ -608,7 +654,6 @@ by Rockbox, in the main directory of your \daps{} drive.
         \opt{xduoox3}{\input{getting_started/xduoox3_install.tex}}
         \opt{xduoox3ii,xduoox20,agptekrocker,aigoerosq}{\input{getting_started/hibyos_install.tex}}
         \opt{fiiom3k,shanlingq1}{\input{getting_started/jztool_install.tex}}
-        \opt{erosqnative}{\input{getting_started/hibyos_nativeinstall.tex}}
     }
 }
 
@@ -705,7 +750,7 @@ by Rockbox, in the main directory of your \daps{} drive.
 \opt{e200}{Your e200 will automatically reboot and Rockbox should load.}
 
 \opt{fiiom3k,shanlingq1,erosqnative}{
-  Safely eject / unmount your \dap{}.
+  Safely eject / unmount your \dap{} and reboot it.
 }
 
 
@@ -791,17 +836,19 @@ need to be updated.\\
 
 \section{Uninstalling Rockbox}\index{Installation!uninstall}
 
-\nopt{gigabeatf,iaudiom3,iaudiom5,iaudiox5,mrobe100,gigabeats,fuzeplus}{
+\nopt{gigabeatf,iaudiom3,iaudiom5,iaudiox5,mrobe100,gigabeats,fuzeplus,erosqnative}{
   \note{The Rockbox bootloader allows you to choose between Rockbox and
   the original firmware. (See \reference{ref:Dualboot} for more information.)}
 }
 
 \subsection{Automatic Uninstallation}
-\opt{gigabeats}{\note{Rockbox can only be uninstalled manually for now.}}
+\opt{gigabeats,erosqnative}{\note{Rockbox can only be uninstalled manually from the \playername{} for now.}}
 
-You can uninstall Rockbox automatically by using Rockbox Utility. If you
+\nopt{erosqnative}{
-installed Rockbox manually you can still use Rockbox Utility for uninstallation
+  You can uninstall Rockbox automatically by using Rockbox Utility. If you
-but will not be able to do this selectively.
+  installed Rockbox manually you can still use Rockbox Utility for uninstallation
+  but will not be able to do this selectively.
+}
 
 \opt{iriverh100,iriverh300,fuzeplus}{\note{Rockbox Utility cannot uninstall the bootloader due to
 the fact that it requires a flashing procedure. To uninstall the bootloader
@@ -889,12 +936,12 @@ completely follow the manual uninstallation instructions below.}}
     update file for your brand player and original firmware version number. The
     uninstallation procedure can then be done as follows:
 
-    \begin{itemize}
+    \begin{enumerate}
       \item If the update file is unmodified, use \fname{tools/hibyos\_nativepatcher/hibyos\_nativepatcher.sh} to mark the original bootloader for updating
       \item Place the update file on the SD card and ensure it is named \emph{exactly} \fname{update.upt}
       \item Boot into the Rockbox bootloader menu: With the player off, hold \ButtonVolUp{} + \ButtonPower{}
       \item Select "Aigo Recovery"
-    \end{itemize}
+    \end{enumerate}
 }
 
 \nopt{gigabeats}{
@@ -931,7 +978,14 @@ completely follow the manual uninstallation instructions below.}}
 }
 
 \section{Troubleshooting}
+\opt{erosqnative}{
+  For common troubleshooting issues, please see wiki page ErosQNativeTroubleshooting
+  at \url{https://www.rockbox.org/wiki/ErosQNativeTroubleshooting.html}.
+  
+  For more detailed information about this device, please see the wiki page AIGOErosQK
+  at \url{https://www.rockbox.org/wiki/AIGOErosQK}.}
 \begin{description}
+
 \opt{sansa,ipod}{
   \item[Bootloader install problems]
   If you have trouble installing the bootloader,
@@ -965,9 +1019,15 @@ completely follow the manual uninstallation instructions below.}}
   file to the proper location, and should not happen when Rockbox has been
   installed with Rockbox Utility.
 
+  \nopt{erosqnative}{
   To fix this, either install Rockbox with the Rockbox Utility which will take care
   of this for you, or recheck the Manual Install section to see where the files
   need to be located.
+  }
+  \opt{erosqnative}{
+    To fix this, re-copy the entirety of the \fname{.zip} file's contents to the root
+    of the SD card and reboot the device.
+  }
 \end{description}
 
 \optv{gigabeats}{

manual/platform/keymap-erosqnative.tex

@@ -7,7 +7,9 @@
 \newcommand{\ButtonUp}{\btnfnt{Prev}}
 \newcommand{\ButtonDown}{\btnfnt{Next}}
 \newcommand{\ButtonPrev}{\btnfnt{Prev}}
+\newcommand{\ButtonRW}{\btnfnt{Rewind}}
 \newcommand{\ButtonNext}{\btnfnt{Next}}
+\newcommand{\ButtonFF}{\btnfnt{Fast-Forward}}
 \newcommand{\ButtonSelect}{\btnfnt{Play}}
 \newcommand{\ButtonBack}{\btnfnt{Back}}
 \newcommand{\ButtonMenu}{\btnfnt{Menu}}

manual/rockbox_interface/main.tex

@@ -69,8 +69,11 @@ The areas of the touchscreen in the 3$\times$3 grid mode are in turn referred as
 \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
+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
   \wikilink{BlindFAQ}.
@@ -519,6 +522,26 @@ detail in the following paragraph.
   the bottom panel of the \dap{}.
   }
   %
+  \opt{erosqnative}{
+  Hold or lay the \dap{} so that the side with the controls and LCD is facing towards you.
+  Below the LCD is a scrollwheel, with clockwise movement being \ButtonScrollFwd{} and counterclockwise
+  movement being \ButtonScrollBack{}. In the center of the scrollwheel is \ButtonPlay{}.
+
+  To the right of the scrollwheel are a pair of buttons, the upper one being \ButtonPrev{} (which doubles as \ButtonRW{})
+  and the lower one being \ButtonNext{} (which doubles as \ButtonFF{}). Below and to the left of the scrollwheel is the
+  \ButtonMenu{} button, and below and to the right of the scrollwheel is the \ButtonBack{} button.
+
+  \note{While every effort was made to make the scrollwheel as reliable as possible, it is not perfect and sometimes
+  can go two menu entries for one indent on the wheel. Fortunately, Rockbox menus (as well as original firmware menus)
+  also allow using the \ButtonPrev{} and \ButtonNext{} buttons to scroll through them, which can be much more reliable.}
+
+  On the right-hand edge of the device is, from top to bottom, \ButtonVolUp{}, \ButtonVolDown{}, and the microSD
+  slot.
+
+  On the top edge of the device is the \ButtonPower{} button.
+
+  On the bottom edge of the device is, from left to right, the headphone jack, the USB port, and the line-out jack.
+  }
 }
 
 \subsection{Turning the \dap{} on and off}
@@ -750,9 +773,9 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
 
     \subsection{Entering the recovery menu}
     You can access the Rockbox bootloader's ``recovery menu'' by holding
-    \ActionBootRecoveryMenu{}. This menu can be used to connect your \dap{}
+    \ActionBootRecoveryMenu{} while powering on the player. This menu can be
-    over USB to transfer files, update the Rockbox bootloader, or revert to a
+    used to connect your \dap{} over USB to transfer files, update the Rockbox
-    bootloader you've previously backed up.
+    bootloader, or revert to a bootloader you've previously backed up.
     }
 
   }