diff options
authorAidan MacDonald <>2021-07-23 21:11:59 +0100
committerAidan MacDonald <>2021-07-24 14:07:09 +0000
commitfde6eaa8e105eb2a177d826867f8e2fc3e066463 (patch)
parent42ba117952fcb4e486aa7a0e27add800a8649e31 (diff)
Add Fiio M3K and Shanling Q1 manuals
Includes installation instructions and a description of Rockbox's limitations versus the original firmware. Some things are still missing, notably screenshots for the Q1. The M3K image also needs to be updated to include the 'select' button. Change-Id: Ib533206df01925203edeccdd75e1bf22f407e794
8 files changed, 482 insertions, 7 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index f1d1de69a1..940852d593 100755
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -667,6 +667,8 @@ You just ``play'' a file with the extension %
\opt{sansa,iriverh10,iriverh10_5gb,mrobe100,vibe500,samsungyh}{\fname{.mi4}.} %
\opt{sansaAMS,fuzeplus}{\fname{.sansa}.} %
\opt{gigabeatf,gigabeats}{\fname{.gigabeat}.} %
+\opt{fiiom3k}{\fname{.m3k}} %
+\opt{shanlingq1}{\fname{.q1}} %
This can be used to test new firmware versions without deleting your
current version.
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index 241c41d3f2..cc0c7af919 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -111,7 +111,36 @@ follow the instructions at
+Although Rockbox is considered fully functional on the \playername{}, there are
+a few limitations compared to the original firmware which you should be aware
+of before installing.
+ \item[Filesystem support.] Rockbox only supports the FAT32 filesystem. Other
+ filesystems such as exFAT or NTFS are not supported.
+ \item[USB DAC.] This feature is not supported by Rockbox, but you can
+ dual-boot the original firmware if you want to use it.
+ \opt{shanlingq1}{\item[Wireless.] There is no support for Bluetooth or WiFi.
+ You can dual-boot the original firmware to use wireless functionality.}
+ \item[Hotswapping SD cards.] Rockbox runs from the SD card, not the internal
+ flash memory. Hotswapping is technically possible, but you need to install
+ the same version of Rockbox to each SD card.
+ Some features might not work correctly after hotswapping and you may
+ experience crashes or instability. Removing the SD card while data is being
+ written is liable to cause crashes and data loss, and possibly corrupt your
+ filesystem.
+ \opt{shanlingq1}{\item[Touchscreen.] 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 3$\times$3 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.\\}}
@@ -237,7 +266,8 @@ people. Rockbox Utility is a graphical application that does almost everything
for you. However, should you encounter a problem, then the manual way is
still available to you.\\
-\opt{gigabeats}{\note{The automated install is not yet available for the
+ \note{The automated install is not yet available for the
\playerlongtype{}. For now you can use the manual method to install Rockbox.
Please still read the section on the automatic install as it explains
various important aspects of Rockbox, such as the different versions
@@ -312,9 +342,9 @@ 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}{\note{Rockbox Utility does not currently support the
-\playertype{} and you will therefore need to follow the manual install
-instructions below.\\}}
+\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
@@ -514,6 +544,7 @@ by Rockbox, in the main directory of your \daps{} drive.
+ \opt{fiiom3k,shanlingq1}{\input{getting_started/jztool_install.tex}}
@@ -609,6 +640,9 @@ by Rockbox, in the main directory of your \daps{} drive.
\opt{e200}{Your e200 will automatically reboot and Rockbox should load.}
+ Safely eject / unmount your \dap{}.
\subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
@@ -772,11 +806,25 @@ completely follow the manual uninstallation instructions below.}}
\playerman{} firmware.
+ If you want to remove the Rockbox bootloader, copy an original firmware
+ update to your microSD card and run the \playerman{} update by holding
+ \ActionBootOFRecovery{} while powering on the \dap{}.
+ Alternatively, if you took a backup of the original \playerman{} bootloader
+ you can copy the backup file, \bootbackupfilename{}, to your SD card and
+ select \emph{Restore bootloader} from the recovery menu. The recovery menu
+ can be accessed by holding \ActionBootRecoveryMenu{} when powering on. If
+ your \dap won't boot, use \fname{jztool} to load the bootloader over USB
+ and enter the recovery menu -- see \reference{ref:jztool_load_bootloader}.
If you wish to clean up your disk, you may also wish to delete the
\fname{.rockbox} directory and its contents.
- \nopt{iaudiom3,iaudiom5,iaudiox5}{Turn the \playerman{} off.
- Turn the \dap{} back on and the original \playerman{} software will load.}
+ \nopt{iaudiom3,iaudiom5,iaudiox5,fiiom3k,shanlingq1}{
+ Turn the \playerman{} off. Turn the \dap{} back on and the original
+ \playerman{} software will load.}
diff --git a/manual/getting_started/jztool_install.tex b/manual/getting_started/jztool_install.tex
new file mode 100644
index 0000000000..c492b6987e
--- /dev/null
+++ b/manual/getting_started/jztool_install.tex
@@ -0,0 +1,156 @@
+You need a computer running Windows, Linux, or Mac to install the bootloader.
+The installation utility \fname{jztool} is a command line tool used to load the
+Rockbox bootloader on your \dap{}. Please note that it \emph{only} loads the
+Rockbox bootloader and does not modify your \dap{} in any way. Flashing the
+bootloader happens entirely on the \dap{}, without the intervention of your PC.
+It's possible to install Rockbox alongside any original firmware version.
+\opt{fiiom3k}{This includes the ``unofficial'' XVortex firmware.}
+It's also possible to update the original firmware after installing the Rockbox
+bootloader, but this will erase the Rockbox bootloader and you will have to
+install it again if you want to keep using Rockbox.
+\item Download the Rockbox bootloader, \bootfilename{}, from
+ \opt{fiiom3k}{\download{bootloader/fiio/m3k/}.}
+ \opt{shanlingq1}{\download{bootloader/shanling/q1/}.}
+\item Download \fname{jztool} from \download{bootloader/fiio/m3k/}.
+\item Connect your player in USB boot mode:
+ \begin{enumerate}
+ \item Make sure your player is fully powered off.
+ \item Connect a USB cable to your player -- but don't plug it in to your
+ computer yet!
+ \item While holding the \ActionIngenicUSBBoot{} button, plug the other end
+ of the USB cable into your computer.
+ \item If your player has entered USB boot mode%
+ \opt{fiiom3k}{the button light will light up and the LCD will remain
+ black. The \playerman{} splash screen will not be displayed.}
+ \opt{shanlingq1}{the LCD will remain black and the \playerman{} splash
+ screen will not be displayed.}
+ \end{enumerate}
+\item Windows users need to follow \reference{ref:install_usb_driver} now
+ to make the \playertype{} accessible to \fname{jztool} before continuing.
+\item Open a command prompt or terminal in the folder where you downloaded
+ \fname{jztool}. Copy \bootfilename{} to that folder so you can easily refer
+ to it on the command line.
+ On Windows, run this command to load the bootloader onto your \dap{}.
+ \begin{code}
+ jztool.exe \jztoolsubcommand{} load \bootfilename{}
+ \end{code}
+ Linux or Mac users should run this command. Linux users need to run
+ \fname{jztool} as root to allow it access the USB device.
+ \begin{code}
+ ./jztool \jztoolsubcommand{} load \bootfilename{}
+ \end{code}
+\item If your \dap{} is showing the Rockbox recovery menu, then the Rockbox
+ bootloader has been loaded correctly.
+ % TODO: Screenshot of the recovery menu
+To finish the install, you need to flash the Rockbox bootloader to your \dap{}
+using the recovery menu.
+\item Copy \bootfilename{} to the root of a FAT32-formatted SD card, and insert
+ it into your \dap{}.
+\item Select \emph{Backup bootloader} to back up the original firmware's
+ bootloader. This will create a file \bootbackupfilename{} on the root of your
+ SD card. You should back up this file somewhere safe before continuing with
+ the installation. In the unlikely event anything goes wrong, you can copy
+ \bootbackupfilename{} onto your SD card and choose \emph{Restore bootloader}
+ to restore the original \playerman{} bootloader.
+\item Select \emph{Install/update bootloader} from the menu. The installation
+ takes less than a second and once it has finished successfully, you can
+ unplug and power off your \dap{}.
+Rarely, a new bootloader might be released to fix bugs or add certain features.
+Updating the bootloader follows the same process as the initial installation.
+Taking a backup is not necessary if you are only updating an existing Rockbox
+Normally the installation will complete without incident, but you may encounter
+one of the following errors. Some are benign and easily corrected while others
+are more serious. You should seek help on one of the Rockbox support channels
+if you get a serious error.
+\item[File not found.]
+ If you selected \emph{Install/update bootloader}, the missing file is
+ \bootfilename{}; if you selected \emph{Restore bootloader}, the missing file
+ is \bootbackupfilename{}. Copy the missing file to your SD card, and make
+ sure your card is formatted to FAT32, then try again.
+\item[Bad archive.]
+ The file \bootfilename{} appears to be corrupted or doesn't contain the
+ expected contents. Try deleting it from your SD card and copying it again.
+ If the error persists, you might have a corrupted download; try downloading
+ the bootloader again.
+\item[NAND open/read/write error.]
+ This indicates a problem accessing your \daps{} internal flash memory.
+ Write errors are the most serious -- your existing bootloader may be
+ corrupted, leaving your \dap{} unbootable. Seek assistance if you encounter
+ any of these errors \emph{before} retrying the installation.
+\item[Disk I/O error.]
+ There was a problem reading or writing data on the SD card. This message can
+ also be displayed by \emph{Restore bootloader} if the backup file
+ \bootbackupfilename{} does not have the correct size.
+\item[Out of memory or Unknown error.]
+ These are serious errors indicating some low-level system problem.
+ They should never be encountered in normal circumstances.
+\subsubsection{Install the USB driver}\label{ref:install_usb_driver}
+\note{This section is only applicable if you are running \fname{jztool} from
+a Windows computer. Linux and Mac users can safely ignore this section.}
+To use \fname{jztool} on a Windows computer, you need to install a USB driver
+so it can access the \dap{} in USB boot mode. \fname{jztool} uses a library
+called \fname{libusb} to access your \dap{}, and on Windows \fname{libusb} can
+use a number of different back-end drivers to access USB devices.
+Zadig (\url{}) is a third-party tool which allows you to
+install various back-end drivers for use with \fname{libusb}-based programs.
+The recommended driver is WinUSB, which is provided by Microsoft and comes
+bundled with recent versions of Windows.
+\note{The Rockbox project is not associated with Zadig or its development.
+ In the unlikely event you encounter a Zadig-specific issue that cannot be
+ resolved on Rockbox support channels you may need to seek help elsewhere.}
+You will need administrator access to run Zadig. When you are ready, follow the
+steps below to install the driver.
+\item Download Zadig from \url{}.
+\item Make sure your \dap{} is connected in USB boot mode
+ (see \reference{ref:jztool_load_bootloader}).
+\item Run Zadig and select the USB device corresponding to your player.
+ The USB ID of the \playername{} is \texttt{A108 1000} when it is connected in
+ USB boot mode.
+ % TODO: Screenshot of Zadig window
+ \warn{Be careful not to select the wrong USB device in Zadig! Zadig allows
+ you to override the USB driver of any USB device, and accidentally
+ overwriting the driver for an important device like your mouse or keyboard
+ can cause major problems. Always double check the device before clicking
+ install.}
+\item Select the WinUSB driver from the list and click \emph{Install}.
+\item Wait for the installation to finish, then close Zadig.
+If the installation was successful you can return to
+\reference{ref:jztool_load_bootloader} and run \fname{jztool}. If you get
+``Cannot open USB device'' errors from \fname{jztool} or any
+\fname{libusb}-related errors, you can try some of the steps below to fix the
+\item Unplug your \dap{} and force a power-off by holding the power button
+ for 10 seconds. Then reconnect it and try running \fname{jztool} again.
+\item Restart your computer and try again.
+\item Try installing a different USB driver, for example ``libusbK''.
+ Some users have reported difficulties with the WinUSB driver and have
+ had success by trying an alternate driver.
+If problems persist you should ask for help on the Rockbox support channels.
diff --git a/manual/platform/fiiom3k.tex b/manual/platform/fiiom3k.tex
new file mode 100644
index 0000000000..0f44683214
--- /dev/null
+++ b/manual/platform/fiiom3k.tex
@@ -0,0 +1,28 @@
+% $Id$ %
+%Used to name the player, e.g. the \dap
+%For use when referring to the player. E.g. the \daps\ capacity ...
+\newcommand{\disk}{SD card}
+% link external keymap file
diff --git a/manual/platform/keymap-fiiom3k.tex b/manual/platform/keymap-fiiom3k.tex
new file mode 100644
index 0000000000..ecf07bebd4
--- /dev/null
+++ b/manual/platform/keymap-fiiom3k.tex
@@ -0,0 +1,100 @@
+% $Id$
+\newcommand{\ButtonVolUp}{\btnfnt{Volume Up}}
+\newcommand{\ButtonVolDown}{\btnfnt{Volume Down}}
+\newcommand{\ButtonScrollFwd}{\btnfnt{Scroll Down}}
+\newcommand{\ButtonScrollBack}{\btnfnt{Scroll Up}}
+%Button actions, standard context
+\newcommand{\ActionStdPrev}{\ButtonUp{} or \ButtonScrollBack}
+\newcommand{\ActionStdPrevRepeat}{\ButtonUp{} or \ButtonScrollBack}
+\newcommand{\ActionStdNext}{\ButtonDown{} or \ButtonScrollFwd}
+\newcommand{\ActionStdNextRepeat}{\ButtonDown{} or \ButtonScrollFwd}
+\newcommand{\ActionStdContext}{\ButtonMenu{} or Long \ButtonSelect}
+\newcommand{\ActionStdMenu}{Long \ButtonBack}
+\newcommand{\ActionStdQuickScreen}{Long \ButtonMenu}
+\newcommand{\ActionQuickScreenExit}{\ButtonBack{}, \ButtonPower{}, or \ButtonSelect}
+%Button actions, wps context
+\newcommand{\ActionWpsStop}{Long \ButtonPower}
+\newcommand{\ActionWpsBrowse}{Long \ButtonBack}
+\newcommand{\ActionWpsSeekBack}{Long \ButtonLeft}
+\newcommand{\ActionWpsSeekFwd}{Long \ButtonRight}
+\newcommand{\ActionWpsPlay}{\ButtonPlay{} or \ButtonSelect}
+\newcommand{\ActionWpsQuickScreen}{Long \ButtonMenu}
+\newcommand{\ActionWpsHotkey}{Long \ButtonPlay}
+\newcommand{\ActionWpsAbSetAPrevDir}{Long \ButtonUp}
+\newcommand{\ActionWpsAbSetBNextDir}{Long \ButtonDown}
+\newcommand{\ActionWpsAbReset}{Long \ButtonSelect}
+%Button actions, tree context
+\newcommand{\ActionTreeWps}{Long \ButtonBack}
+\newcommand{\ActionTreeStop}{Long \ButtonPlay}
+%Button actions, YesNo context
+\newcommand{\ActionYesNoAccept}{\ButtonPlay{} or \ButtonSelect}
+%Button actions, Virtual Keyboard Context
+%Button actions, Pitch Screen context
+\newcommand{\ActionPsIncSmall}{\ButtonUp{} or \ButtonScrollBack}
+\newcommand{\ActionPsDecSmall}{\ButtonDown{} or \ButtonScrollFwd}
+\newcommand{\ActionPsReset}{Long \ButtonSelect}
+%Button actions, Bookmark screen context
+%Plugin lib actions
+\newcommand{\PluginSelectRepeat}{Long \ButtonSelect}
+%Bootloader keys
+\newcommand{\ActionBootOFRecovery}{\ButtonPlay{} and \ButtonVolUp}
diff --git a/manual/platform/keymap-shanlingq1.tex b/manual/platform/keymap-shanlingq1.tex
new file mode 100644
index 0000000000..9476ca8a70
--- /dev/null
+++ b/manual/platform/keymap-shanlingq1.tex
@@ -0,0 +1,95 @@
+% $Id$
+\newcommand{\ButtonVolUp}{\btnfnt{Volume Up}}
+\newcommand{\ButtonVolDown}{\btnfnt{Volume Down}}
+%Button actions, standard context
+\newcommand{\ActionStdPrev}{\ButtonPrev{} or \TouchActionStdPrev}
+\newcommand{\ActionStdPrevRepeat}{Long \ButtonPrev{} or \TouchActionStdPrevRepeat}
+\newcommand{\ActionStdNext}{\ButtonNext{} or \TouchActionStdNext}
+\newcommand{\ActionStdNextRepeat}{Long \ButtonNext{} or \TouchActionStdNextRepeat}
+\newcommand{\ActionStdCancel}{\ButtonPower{} or \TouchActionStdCancel}
+\newcommand{\ActionStdOk}{\ButtonPlay{} or \TouchActionStdOk}
+%Button actions, wps context
+\newcommand{\ActionWpsPlay}{\ButtonPlay{} or \TouchActionWpsPlay}
+\newcommand{\ActionWpsSkipNext}{\ButtonNext{} or \TouchActionWpsSkipNext}
+\newcommand{\ActionWpsSeekFwd}{Long \ButtonNext{} \TouchActionWpsSeekFwd}
+\newcommand{\ActionWpsSkipPrev}{\ButtonPrev{} or \TouchActionWpsSkipPrev}
+\newcommand{\ActionWpsSeekBack}{Long \ButtonPrev{} or \TouchActionWpsSeekBack}
+\newcommand{\ActionWpsStop}{Long \ButtonPlay{} or \TouchActionWpsStop}
+\newcommand{\ActionWpsVolDown}{\ButtonVolDown{} or \TouchActionWpsVolDown}
+\newcommand{\ActionWpsVolUp}{\ButtonVolUp{} or \TouchActionWpsVolUp}
+%Button actions, tree context
+%Button actions, YesNo context
+%Button actions, Virtual Keyboard Context
+%Button actions, Pitch Screen context
+%Button actions, Bookmark screen context
+%Plugin lib actions
+\newcommand{\PluginCancel}{\ButtonPower or \TouchBottomRight}
+\newcommand{\PluginSelectRepeat}{Long \TouchCenter}
+%Bootloader keys
+\newcommand{\ActionBootOFRecovery}{\ButtonPrev{} and \ButtonNext}
diff --git a/manual/platform/shanlingq1.tex b/manual/platform/shanlingq1.tex
new file mode 100644
index 0000000000..a2dc6855dc
--- /dev/null
+++ b/manual/platform/shanlingq1.tex
@@ -0,0 +1,29 @@
+% $Id$ %
+%Used to name the player, e.g. the \dap
+%For use when referring to the player. E.g. the \daps\ capacity ...
+\newcommand{\disk}{SD card}
+% link external keymap file
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
index 8e42e3ef4c..92d50ccd0a 100644
--- a/manual/rockbox_interface/main.tex
+++ b/manual/rockbox_interface/main.tex
@@ -715,6 +715,23 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
and then press the \ButtonPower{} button.
+ \opt{fiiom3k,shanlingq1}
+ {
+ Rockbox has a dual-boot feature. To boot into the original firmware,
+ hold \ActionBootOFPlayer{} when powering on the \dap{}.
+ You can trigger a normal \playerman{} firmware update by holding
+ \ActionBootOFRecovery{} when powering on the \dap{}.
+ \warn{Updating the original firmware will \textbf{erase} the Rockbox
+ bootloader.}
+ \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{}
+ over USB to transfer files, update the Rockbox bootloader, or revert to a
+ bootloader you've previously backed up.
+ }
\subsection{Putting music on your \dap{}}