summaryrefslogtreecommitdiff
path: root/manual/platform
diff options
context:
space:
mode:
Diffstat (limited to 'manual/platform')
-rw-r--r--manual/platform/fiiom3k.tex28
-rw-r--r--manual/platform/keymap-fiiom3k.tex100
-rw-r--r--manual/platform/keymap-shanlingq1.tex95
-rw-r--r--manual/platform/shanlingq1.tex29
4 files changed, 252 insertions, 0 deletions
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 @@
1% $Id$ %
2\def\UseOption{fiiom3k}
3\edef\UseOption{\UseOption,FIIO_M3K_PAD}
4\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
5\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
6\edef\UseOption{\UseOption,fiiom3k}
7
8\newcommand{\playerman}{FiiO}
9\newcommand{\playertype}{M3K}
10\newcommand{\playerlongtype}{\playertype}
11\newcommand{\dapdisplaywidth}{240}
12\newcommand{\dapdisplayheight}{320}
13\newcommand{\dapdisplaydepth}{16}
14\newcommand{\specimg}{fiiom3k}
15%Used to name the player, e.g. ...to the \dap
16\newcommand{\dap}{player}
17%For use when referring to the player. E.g. the \daps\ capacity ...
18\newcommand{\daps}{player's}
19\newcommand{\firmwarefilename}{\fname{rockbox.m3k}}
20\newcommand{\bootfilename}{\fname{bootloader.m3k}}
21\newcommand{\firmwareextension}{\fname{m3k}}
22\newcommand{\bootbackupfilename}{\fname{fiiom3k-boot.bin}}
23\newcommand{\jztoolsubcommand}{fiiom3k}
24\newcommand{\screenshotsize}{8cm}
25\newcommand{\disk}{SD card}
26
27% link external keymap file
28\input{platform/keymap-fiiom3k.tex}
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 @@
1% $Id$
2
3\newcommand{\ButtonPower}{\btnfnt{Power}}
4\newcommand{\ButtonPlay}{\btnfnt{Play}}
5\newcommand{\ButtonVolUp}{\btnfnt{Volume Up}}
6\newcommand{\ButtonVolDown}{\btnfnt{Volume Down}}
7\newcommand{\ButtonUp}{\btnfnt{Up}}
8\newcommand{\ButtonDown}{\btnfnt{Down}}
9\newcommand{\ButtonLeft}{\btnfnt{Prev}}
10\newcommand{\ButtonRight}{\btnfnt{Next}}
11\newcommand{\ButtonSelect}{\btnfnt{Select}}
12\newcommand{\ButtonBack}{\btnfnt{Back}}
13\newcommand{\ButtonMenu}{\btnfnt{Menu}}
14\newcommand{\ButtonScrollFwd}{\btnfnt{Scroll Down}}
15\newcommand{\ButtonScrollBack}{\btnfnt{Scroll Up}}
16
17%Button actions, standard context
18\newcommand{\ActionStdPrev}{\ButtonUp{} or \ButtonScrollBack}
19\newcommand{\ActionStdPrevRepeat}{\ButtonUp{} or \ButtonScrollBack}
20\newcommand{\ActionStdNext}{\ButtonDown{} or \ButtonScrollFwd}
21\newcommand{\ActionStdNextRepeat}{\ButtonDown{} or \ButtonScrollFwd}
22\newcommand{\ActionStdOk}{\ButtonSelect}
23\newcommand{\ActionStdCancel}{\ButtonBack}
24\newcommand{\ActionStdContext}{\ButtonMenu{} or Long \ButtonSelect}
25\newcommand{\ActionStdMenu}{Long \ButtonBack}
26\newcommand{\ActionStdQuickScreen}{Long \ButtonMenu}
27\newcommand{\ActionQuickScreenExit}{\ButtonBack{}, \ButtonPower{}, or \ButtonSelect}
28\newcommand{\ActionStdUsbCharge}{\ButtonPlay}
29
30%Button actions, wps context
31\newcommand{\ActionWpsStop}{Long \ButtonPower}
32\newcommand{\ActionWpsBrowse}{Long \ButtonBack}
33\newcommand{\ActionWpsVolUp}{\ButtonVolUp}
34\newcommand{\ActionWpsVolDown}{\ButtonVolDown}
35\newcommand{\ActionWpsSkipPrev}{\ButtonLeft}
36\newcommand{\ActionWpsSkipNext}{\ButtonRight}
37\newcommand{\ActionWpsSeekBack}{Long \ButtonLeft}
38\newcommand{\ActionWpsSeekFwd}{Long \ButtonRight}
39\newcommand{\ActionWpsPlay}{\ButtonPlay{} or \ButtonSelect}
40\newcommand{\ActionWpsContext}{\ButtonMenu}
41\newcommand{\ActionWpsMenu}{\ButtonBack}
42\newcommand{\ActionWpsQuickScreen}{Long \ButtonMenu}
43\newcommand{\ActionWpsHotkey}{Long \ButtonPlay}
44\newcommand{\ActionWpsAbSetAPrevDir}{Long \ButtonUp}
45\newcommand{\ActionWpsAbSetBNextDir}{Long \ButtonDown}
46\newcommand{\ActionWpsAbReset}{Long \ButtonSelect}
47
48%Button actions, tree context
49\newcommand{\ActionTreeWps}{Long \ButtonBack}
50\newcommand{\ActionTreeStop}{Long \ButtonPlay}
51\newcommand{\ActionTreeParentDirectory}{\ButtonBack}
52\newcommand{\ActionTreeEnter}{\ButtonSelect}
53\newcommand{\ActionTreeHotkey}{\ButtonPlay}
54
55%Button actions, YesNo context
56\newcommand{\ActionYesNoAccept}{\ButtonPlay{} or \ButtonSelect}
57
58%Button actions, Virtual Keyboard Context
59\newcommand{\ActionKbdSelect}{\ButtonSelect}
60\newcommand{\ActionKbdUp}{\ButtonUp}
61\newcommand{\ActionKbdDown}{\ButtonDown}
62\newcommand{\ActionKbdLeft}{\ButtonLeft}
63\newcommand{\ActionKbdRight}{\ButtonRight}
64\newcommand{\ActionKbdPageFlip}{\ButtonMenu}
65\newcommand{\ActionKbdDone}{\ButtonPlay}
66\newcommand{\ActionKbdAbort}{\ButtonPower}
67
68%Button actions, Pitch Screen context
69\newcommand{\ActionPsToggleMode}{\ButtonSelect}
70\newcommand{\ActionPsIncSmall}{\ButtonUp{} or \ButtonScrollBack}
71\newcommand{\ActionPsDecSmall}{\ButtonDown{} or \ButtonScrollFwd}
72\newcommand{\ActionPsIncBig}{\ButtonVolUp}
73\newcommand{\ActionPsDecBig}{\ButtonVolDown}
74\newcommand{\ActionPsNudgeLeft}{\ButtonLeft}
75\newcommand{\ActionPsNudgeRight}{\ButtonRight}
76\newcommand{\ActionPsReset}{Long \ButtonSelect}
77\newcommand{\ActionPsExit}{\ButtonPower}
78\newcommand{\ActionPsFaster}{\ButtonBack}
79\newcommand{\ActionPsSlower}{\ButtonMenu}
80
81%Button actions, Bookmark screen context
82\newcommand{\ActionBmDelete}{\ButtonPlay}
83
84%Plugin lib actions
85\newcommand{\PluginUp}{\ButtonUp}
86\newcommand{\PluginDown}{\ButtonDown}
87\newcommand{\PluginLeft}{\ButtonLeft}
88\newcommand{\PluginRight}{\ButtonRight}
89\newcommand{\PluginSelect}{\ButtonSelect}
90\newcommand{\PluginSelectRepeat}{Long \ButtonSelect}
91\newcommand{\PluginCancel}{\ButtonBack}
92\newcommand{\PluginExit}{\ButtonPower}
93\newcommand{\PluginScrollFwd}{\ButtonScrollFwd}
94\newcommand{\PluginScrollBack}{\ButtonScrollBack}
95
96%Bootloader keys
97\newcommand{\ActionIngenicUSBBoot}{\ButtonVolDown}
98\newcommand{\ActionBootRecoveryMenu}{\ButtonVolUp}
99\newcommand{\ActionBootOFPlayer}{\ButtonPlay}
100\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 @@
1% $Id$
2
3\newcommand{\ButtonPower}{\btnfnt{Power}}
4\newcommand{\ButtonPlay}{\btnfnt{Play}}
5\newcommand{\ButtonVolUp}{\btnfnt{Volume Up}}
6\newcommand{\ButtonVolDown}{\btnfnt{Volume Down}}
7\newcommand{\ButtonPrev}{\btnfnt{Previous}}
8\newcommand{\ButtonNext}{\btnfnt{Next}}
9
10%Button actions, standard context
11\newcommand{\ActionStdPrev}{\ButtonPrev{} or \TouchActionStdPrev}
12\newcommand{\ActionStdPrevRepeat}{Long \ButtonPrev{} or \TouchActionStdPrevRepeat}
13\newcommand{\ActionStdNext}{\ButtonNext{} or \TouchActionStdNext}
14\newcommand{\ActionStdNextRepeat}{Long \ButtonNext{} or \TouchActionStdNextRepeat}
15\newcommand{\ActionStdCancel}{\ButtonPower{} or \TouchActionStdCancel}
16\newcommand{\ActionStdContext}{\TouchActionStdContext}
17\newcommand{\ActionStdQuickScreen}{\TouchActionStdQuickScreen}
18\newcommand{\ActionQuickScreenExit}{\TouchActionQuickScreenExit}
19\newcommand{\ActionStdMenu}{\TouchActionStdMenu}
20\newcommand{\ActionStdOk}{\ButtonPlay{} or \TouchActionStdOk}
21\newcommand{\ActionStdUsbCharge}{\ButtonPlay}
22
23%Button actions, wps context
24\newcommand{\ActionWpsPlay}{\ButtonPlay{} or \TouchActionWpsPlay}
25\newcommand{\ActionWpsSkipNext}{\ButtonNext{} or \TouchActionWpsSkipNext}
26\newcommand{\ActionWpsSeekFwd}{Long \ButtonNext{} \TouchActionWpsSeekFwd}
27\newcommand{\ActionWpsSkipPrev}{\ButtonPrev{} or \TouchActionWpsSkipPrev}
28\newcommand{\ActionWpsSeekBack}{Long \ButtonPrev{} or \TouchActionWpsSeekBack}
29\newcommand{\ActionWpsStop}{Long \ButtonPlay{} or \TouchActionWpsStop}
30\newcommand{\ActionWpsVolDown}{\ButtonVolDown{} or \TouchActionWpsVolDown}
31\newcommand{\ActionWpsVolUp}{\ButtonVolUp{} or \TouchActionWpsVolUp}
32\newcommand{\ActionWpsQuickScreen}{\TouchActionWpsQuickScreen}
33\newcommand{\ActionWpsMenu}{\TouchActionWpsMenu}
34\newcommand{\ActionWpsContext}{\TouchActionWpsContext}
35\newcommand{\ActionWpsBrowse}{\TouchActionWpsBrowse}
36\newcommand{\ActionWpsPitchScreen}{\TouchActionWpsPitchScreen}
37\newcommand{\ActionWpsIdThreeScreen}{\TouchActionWpsIdThreeScreen}
38\newcommand{\ActionWpsAbSetBNextDir}{\TouchActionWpsAbSetBNextDir}
39\newcommand{\ActionWpsAbSetAPrevDir}{\TouchActionWpsAbSetAPrevDir}
40\newcommand{\ActionWpsAbReset}{\TouchActionWpsAbReset}
41\newcommand{\ActionWpsHotkey}{\TouchBottomRight}
42
43%Button actions, tree context
44\newcommand{\ActionTreeWps}{\TouchActionTreeWps}
45\newcommand{\ActionTreeStop}{\TouchActionTreeStop}
46\newcommand{\ActionTreeEnter}{\TouchActionTreeEnter}
47\newcommand{\ActionTreeParentDirectory}{\TouchActionTreeParentDirectory}
48
49%Button actions, YesNo context
50\newcommand{\ActionYesNoAccept}{\TouchActionYesNoAccept}
51
52%Button actions, Virtual Keyboard Context
53\newcommand{\ActionKbdLeft}{\TouchActionKbdLeft}
54\newcommand{\ActionKbdRight}{\TouchActionKbdRight}
55\newcommand{\ActionKbdSelect}{\TouchActionKbdSelect}
56\newcommand{\ActionKbdDone}{\TouchActionKbdDone}
57\newcommand{\ActionKbdAbort}{\TouchActionKbdAbort}
58\newcommand{\ActionKbdUp}{\TouchActionKbdUp}
59\newcommand{\ActionKbdDown}{\TouchActionKbdDown}
60\newcommand{\ActionKbdCursorLeft}{\TouchActionKbdCursorLeft}
61\newcommand{\ActionKbdCursorRight}{\TouchActionKbdCursorRight}
62\newcommand{\ActionKbdBackSpace}{\TouchActionKbdBackSpace}
63\newcommand{\ActionKbdPageFlip}{\TouchActionKbdPageFlip}
64
65%Button actions, Pitch Screen context
66\newcommand{\ActionPsToggleMode}{\TouchActionPsToggleMode}
67\newcommand{\ActionPsIncSmall}{\TouchActionPsIncSmall}
68\newcommand{\ActionPsIncBig}{\TouchActionPsIncBig}
69\newcommand{\ActionPsDecSmall}{\TouchActionPsDecSmall}
70\newcommand{\ActionPsDecBig}{\TouchActionPsDecBig}
71\newcommand{\ActionPsNudgeLeft}{\TouchActionPsNudgeLeft}
72\newcommand{\ActionPsNudgeRight}{\TouchActionPsNudgeRight}
73\newcommand{\ActionPsReset}{\TouchActionPsReset}
74\newcommand{\ActionPsExit}{\TouchActionPsExit}
75\newcommand{\ActionPsSlower}{\TouchActionPsSlower}
76\newcommand{\ActionPsFaster}{\TouchActionPsFaster}
77
78%Button actions, Bookmark screen context
79\newcommand{\ActionBmDelete}{\TouchActionBmDelete}
80
81%Plugin lib actions
82\newcommand{\PluginUp}{\TouchTopMiddle}
83\newcommand{\PluginDown}{\TouchBottomMiddle}
84\newcommand{\PluginLeft}{\TouchMidLeft}
85\newcommand{\PluginRight}{\TouchMidRight}
86\newcommand{\PluginCancel}{\ButtonPower or \TouchBottomRight}
87\newcommand{\PluginExit}{\ButtonPower}
88\newcommand{\PluginSelect}{\TouchCenter}
89\newcommand{\PluginSelectRepeat}{Long \TouchCenter}
90
91%Bootloader keys
92\newcommand{\ActionIngenicUSBBoot}{\ButtonPlay}
93\newcommand{\ActionBootRecoveryMenu}{\ButtonNext}
94\newcommand{\ActionBootOFPlayer}{\ButtonPrev}
95\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 @@
1% $Id$ %
2\def\UseOption{shanlingq1}
3\edef\UseOption{\UseOption,SHANLING_Q1_PAD}
4\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
5\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
6\edef\UseOption{\UseOption,shanlingq1}
7
8\newcommand{\playerman}{Shanling}
9\newcommand{\playertype}{Q1}
10\newcommand{\playerlongtype}{\playertype}
11\newcommand{\dapdisplaywidth}{360}
12\newcommand{\dapdisplayheight}{400}
13\newcommand{\dapdisplaydepth}{16}
14\newcommand{\specimg}{shanlingq1}
15%Used to name the player, e.g. ...to the \dap
16\newcommand{\dap}{player}
17%For use when referring to the player. E.g. the \daps\ capacity ...
18\newcommand{\daps}{player's}
19\newcommand{\firmwarefilename}{\fname{rockbox.q1}}
20\newcommand{\bootfilename}{\fname{bootloader.q1}}
21\newcommand{\firmwareextension}{\fname{q1}}
22\newcommand{\bootbackupfilename}{\fname{shanlingq1-boot.bin}}
23\newcommand{\jztoolsubcommand}{shanlingq1}
24\newcommand{\screenshotsize}{8cm}
25\newcommand{\disk}{SD card}
26
27% link external keymap file
28\input{platform/keymap-shanlingq1.tex}
29\input{platform/keymap-touchscreen.tex}