devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

Add Fiio M3K and Shanling Q1 manuals

Browse source 
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
This commit is contained in:
Aidan MacDonald 2021-07-23 21:11:59 +01:00
parent 42ba117952
commit fde6eaa8e1
8 changed files with 482 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

28
manual/platform/fiiom3k.tex Normal file
View file

@ -0,0 +1,28 @@
% $Id$ %
\def\UseOption{fiiom3k}
\edef\UseOption{\UseOption,FIIO_M3K_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
\edef\UseOption{\UseOption,fiiom3k}
\newcommand{\playerman}{FiiO}
\newcommand{\playertype}{M3K}
\newcommand{\playerlongtype}{\playertype}
\newcommand{\dapdisplaywidth}{240}
\newcommand{\dapdisplayheight}{320}
\newcommand{\dapdisplaydepth}{16}
\newcommand{\specimg}{fiiom3k}
%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.m3k}}
\newcommand{\bootfilename}{\fname{bootloader.m3k}}
\newcommand{\firmwareextension}{\fname{m3k}}
\newcommand{\bootbackupfilename}{\fname{fiiom3k-boot.bin}}
\newcommand{\jztoolsubcommand}{fiiom3k}
\newcommand{\screenshotsize}{8cm}
\newcommand{\disk}{SD card}
% link external keymap file
\input{platform/keymap-fiiom3k.tex}

100
manual/platform/keymap-fiiom3k.tex Normal file
View file

@ -0,0 +1,100 @@
% $Id$
\newcommand{\ButtonPower}{\btnfnt{Power}}
\newcommand{\ButtonPlay}{\btnfnt{Play}}
\newcommand{\ButtonVolUp}{\btnfnt{Volume Up}}
\newcommand{\ButtonVolDown}{\btnfnt{Volume Down}}
\newcommand{\ButtonUp}{\btnfnt{Up}}
\newcommand{\ButtonDown}{\btnfnt{Down}}
\newcommand{\ButtonLeft}{\btnfnt{Prev}}
\newcommand{\ButtonRight}{\btnfnt{Next}}
\newcommand{\ButtonSelect}{\btnfnt{Select}}
\newcommand{\ButtonBack}{\btnfnt{Back}}
\newcommand{\ButtonMenu}{\btnfnt{Menu}}
\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{\ActionStdOk}{\ButtonSelect}
\newcommand{\ActionStdCancel}{\ButtonBack}
\newcommand{\ActionStdContext}{\ButtonMenu{} or Long \ButtonSelect}
\newcommand{\ActionStdMenu}{Long \ButtonBack}
\newcommand{\ActionStdQuickScreen}{Long \ButtonMenu}
\newcommand{\ActionQuickScreenExit}{\ButtonBack{}, \ButtonPower{}, or \ButtonSelect}
\newcommand{\ActionStdUsbCharge}{\ButtonPlay}
%Button actions, wps context
\newcommand{\ActionWpsStop}{Long \ButtonPower}
\newcommand{\ActionWpsBrowse}{Long \ButtonBack}
\newcommand{\ActionWpsVolUp}{\ButtonVolUp}
\newcommand{\ActionWpsVolDown}{\ButtonVolDown}
\newcommand{\ActionWpsSkipPrev}{\ButtonLeft}
\newcommand{\ActionWpsSkipNext}{\ButtonRight}
\newcommand{\ActionWpsSeekBack}{Long \ButtonLeft}
\newcommand{\ActionWpsSeekFwd}{Long \ButtonRight}
\newcommand{\ActionWpsPlay}{\ButtonPlay{} or \ButtonSelect}
\newcommand{\ActionWpsContext}{\ButtonMenu}
\newcommand{\ActionWpsMenu}{\ButtonBack}
\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}
\newcommand{\ActionTreeParentDirectory}{\ButtonBack}
\newcommand{\ActionTreeEnter}{\ButtonSelect}
\newcommand{\ActionTreeHotkey}{\ButtonPlay}
%Button actions, YesNo context
\newcommand{\ActionYesNoAccept}{\ButtonPlay{} or \ButtonSelect}
%Button actions, Virtual Keyboard Context
\newcommand{\ActionKbdSelect}{\ButtonSelect}
\newcommand{\ActionKbdUp}{\ButtonUp}
\newcommand{\ActionKbdDown}{\ButtonDown}
\newcommand{\ActionKbdLeft}{\ButtonLeft}
\newcommand{\ActionKbdRight}{\ButtonRight}
\newcommand{\ActionKbdPageFlip}{\ButtonMenu}
\newcommand{\ActionKbdDone}{\ButtonPlay}
\newcommand{\ActionKbdAbort}{\ButtonPower}
%Button actions, Pitch Screen context
\newcommand{\ActionPsToggleMode}{\ButtonSelect}
\newcommand{\ActionPsIncSmall}{\ButtonUp{} or \ButtonScrollBack}
\newcommand{\ActionPsDecSmall}{\ButtonDown{} or \ButtonScrollFwd}
\newcommand{\ActionPsIncBig}{\ButtonVolUp}
\newcommand{\ActionPsDecBig}{\ButtonVolDown}
\newcommand{\ActionPsNudgeLeft}{\ButtonLeft}
\newcommand{\ActionPsNudgeRight}{\ButtonRight}
\newcommand{\ActionPsReset}{Long \ButtonSelect}
\newcommand{\ActionPsExit}{\ButtonPower}
\newcommand{\ActionPsFaster}{\ButtonBack}
\newcommand{\ActionPsSlower}{\ButtonMenu}
%Button actions, Bookmark screen context
\newcommand{\ActionBmDelete}{\ButtonPlay}
%Plugin lib actions
\newcommand{\PluginUp}{\ButtonUp}
\newcommand{\PluginDown}{\ButtonDown}
\newcommand{\PluginLeft}{\ButtonLeft}
\newcommand{\PluginRight}{\ButtonRight}
\newcommand{\PluginSelect}{\ButtonSelect}
\newcommand{\PluginSelectRepeat}{Long \ButtonSelect}
\newcommand{\PluginCancel}{\ButtonBack}
\newcommand{\PluginExit}{\ButtonPower}
\newcommand{\PluginScrollFwd}{\ButtonScrollFwd}
\newcommand{\PluginScrollBack}{\ButtonScrollBack}
%Bootloader keys
\newcommand{\ActionIngenicUSBBoot}{\ButtonVolDown}
\newcommand{\ActionBootRecoveryMenu}{\ButtonVolUp}
\newcommand{\ActionBootOFPlayer}{\ButtonPlay}
\newcommand{\ActionBootOFRecovery}{\ButtonPlay{} and \ButtonVolUp}

95
manual/platform/keymap-shanlingq1.tex Normal file
View file

@ -0,0 +1,95 @@
% $Id$
\newcommand{\ButtonPower}{\btnfnt{Power}}
\newcommand{\ButtonPlay}{\btnfnt{Play}}
\newcommand{\ButtonVolUp}{\btnfnt{Volume Up}}
\newcommand{\ButtonVolDown}{\btnfnt{Volume Down}}
\newcommand{\ButtonPrev}{\btnfnt{Previous}}
\newcommand{\ButtonNext}{\btnfnt{Next}}
%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{\ActionStdContext}{\TouchActionStdContext}
\newcommand{\ActionStdQuickScreen}{\TouchActionStdQuickScreen}
\newcommand{\ActionQuickScreenExit}{\TouchActionQuickScreenExit}
\newcommand{\ActionStdMenu}{\TouchActionStdMenu}
\newcommand{\ActionStdOk}{\ButtonPlay{} or \TouchActionStdOk}
\newcommand{\ActionStdUsbCharge}{\ButtonPlay}
%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}
\newcommand{\ActionWpsQuickScreen}{\TouchActionWpsQuickScreen}
\newcommand{\ActionWpsMenu}{\TouchActionWpsMenu}
\newcommand{\ActionWpsContext}{\TouchActionWpsContext}
\newcommand{\ActionWpsBrowse}{\TouchActionWpsBrowse}
\newcommand{\ActionWpsPitchScreen}{\TouchActionWpsPitchScreen}
\newcommand{\ActionWpsIdThreeScreen}{\TouchActionWpsIdThreeScreen}
\newcommand{\ActionWpsAbSetBNextDir}{\TouchActionWpsAbSetBNextDir}
\newcommand{\ActionWpsAbSetAPrevDir}{\TouchActionWpsAbSetAPrevDir}
\newcommand{\ActionWpsAbReset}{\TouchActionWpsAbReset}
\newcommand{\ActionWpsHotkey}{\TouchBottomRight}
%Button actions, tree context
\newcommand{\ActionTreeWps}{\TouchActionTreeWps}
\newcommand{\ActionTreeStop}{\TouchActionTreeStop}
\newcommand{\ActionTreeEnter}{\TouchActionTreeEnter}
\newcommand{\ActionTreeParentDirectory}{\TouchActionTreeParentDirectory}
%Button actions, YesNo context
\newcommand{\ActionYesNoAccept}{\TouchActionYesNoAccept}
%Button actions, Virtual Keyboard Context
\newcommand{\ActionKbdLeft}{\TouchActionKbdLeft}
\newcommand{\ActionKbdRight}{\TouchActionKbdRight}
\newcommand{\ActionKbdSelect}{\TouchActionKbdSelect}
\newcommand{\ActionKbdDone}{\TouchActionKbdDone}
\newcommand{\ActionKbdAbort}{\TouchActionKbdAbort}
\newcommand{\ActionKbdUp}{\TouchActionKbdUp}
\newcommand{\ActionKbdDown}{\TouchActionKbdDown}
\newcommand{\ActionKbdCursorLeft}{\TouchActionKbdCursorLeft}
\newcommand{\ActionKbdCursorRight}{\TouchActionKbdCursorRight}
\newcommand{\ActionKbdBackSpace}{\TouchActionKbdBackSpace}
\newcommand{\ActionKbdPageFlip}{\TouchActionKbdPageFlip}
%Button actions, Pitch Screen context
\newcommand{\ActionPsToggleMode}{\TouchActionPsToggleMode}
\newcommand{\ActionPsIncSmall}{\TouchActionPsIncSmall}
\newcommand{\ActionPsIncBig}{\TouchActionPsIncBig}
\newcommand{\ActionPsDecSmall}{\TouchActionPsDecSmall}
\newcommand{\ActionPsDecBig}{\TouchActionPsDecBig}
\newcommand{\ActionPsNudgeLeft}{\TouchActionPsNudgeLeft}
\newcommand{\ActionPsNudgeRight}{\TouchActionPsNudgeRight}
\newcommand{\ActionPsReset}{\TouchActionPsReset}
\newcommand{\ActionPsExit}{\TouchActionPsExit}
\newcommand{\ActionPsSlower}{\TouchActionPsSlower}
\newcommand{\ActionPsFaster}{\TouchActionPsFaster}
%Button actions, Bookmark screen context
\newcommand{\ActionBmDelete}{\TouchActionBmDelete}
%Plugin lib actions
\newcommand{\PluginUp}{\TouchTopMiddle}
\newcommand{\PluginDown}{\TouchBottomMiddle}
\newcommand{\PluginLeft}{\TouchMidLeft}
\newcommand{\PluginRight}{\TouchMidRight}
\newcommand{\PluginCancel}{\ButtonPower or \TouchBottomRight}
\newcommand{\PluginExit}{\ButtonPower}
\newcommand{\PluginSelect}{\TouchCenter}
\newcommand{\PluginSelectRepeat}{Long \TouchCenter}
%Bootloader keys
\newcommand{\ActionIngenicUSBBoot}{\ButtonPlay}
\newcommand{\ActionBootRecoveryMenu}{\ButtonNext}
\newcommand{\ActionBootOFPlayer}{\ButtonPrev}
\newcommand{\ActionBootOFRecovery}{\ButtonPrev{} and \ButtonNext}

29
manual/platform/shanlingq1.tex Normal file
View file

@ -0,0 +1,29 @@
% $Id$ %
\def\UseOption{shanlingq1}
\edef\UseOption{\UseOption,SHANLING_Q1_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
\edef\UseOption{\UseOption,shanlingq1}
\newcommand{\playerman}{Shanling}
\newcommand{\playertype}{Q1}
\newcommand{\playerlongtype}{\playertype}
\newcommand{\dapdisplaywidth}{360}
\newcommand{\dapdisplayheight}{400}
\newcommand{\dapdisplaydepth}{16}
\newcommand{\specimg}{shanlingq1}
%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.q1}}
\newcommand{\bootfilename}{\fname{bootloader.q1}}
\newcommand{\firmwareextension}{\fname{q1}}
\newcommand{\bootbackupfilename}{\fname{shanlingq1-boot.bin}}
\newcommand{\jztoolsubcommand}{shanlingq1}
\newcommand{\screenshotsize}{8cm}
\newcommand{\disk}{SD card}
% link external keymap file
\input{platform/keymap-shanlingq1.tex}
\input{platform/keymap-touchscreen.tex}