177ac44fa0fac33363d34f840c663d4699039a79
[sfrench/cifs-2.6.git] / Documentation / media / uapi / rc / rc-tables.rst
1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10 .. _Remote_controllers_tables:
11
12 ************************
13 Remote controller tables
14 ************************
15
16 Unfortunately, for several years, there was no effort to create uniform
17 IR keycodes for different devices. This caused the same IR keyname to be
18 mapped completely differently on different IR devices. This resulted
19 that the same IR keyname to be mapped completely different on different
20 IR's. Due to that, V4L2 API now specifies a standard for mapping Media
21 keys on IR.
22
23 This standard should be used by both V4L/DVB drivers and userspace
24 applications
25
26 The modules register the remote as keyboard within the linux input
27 layer. This means that the IR key strokes will look like normal keyboard
28 key strokes (if CONFIG_INPUT_KEYBOARD is enabled). Using the event
29 devices (CONFIG_INPUT_EVDEV) it is possible for applications to access
30 the remote via /dev/input/event devices.
31
32
33 .. _rc_standard_keymap:
34
35 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
36
37 .. flat-table:: IR default keymapping
38     :header-rows:  0
39     :stub-columns: 0
40     :widths:       1 1 2
41
42
43     -  .. row 1
44
45        -  Key code
46
47        -  Meaning
48
49        -  Key examples on IR
50
51     -  .. row 2
52
53        -  **Numeric keys**
54
55     -  .. row 3
56
57        -  ``KEY_0``
58
59        -  Keyboard digit 0
60
61        -  0
62
63     -  .. row 4
64
65        -  ``KEY_1``
66
67        -  Keyboard digit 1
68
69        -  1
70
71     -  .. row 5
72
73        -  ``KEY_2``
74
75        -  Keyboard digit 2
76
77        -  2
78
79     -  .. row 6
80
81        -  ``KEY_3``
82
83        -  Keyboard digit 3
84
85        -  3
86
87     -  .. row 7
88
89        -  ``KEY_4``
90
91        -  Keyboard digit 4
92
93        -  4
94
95     -  .. row 8
96
97        -  ``KEY_5``
98
99        -  Keyboard digit 5
100
101        -  5
102
103     -  .. row 9
104
105        -  ``KEY_6``
106
107        -  Keyboard digit 6
108
109        -  6
110
111     -  .. row 10
112
113        -  ``KEY_7``
114
115        -  Keyboard digit 7
116
117        -  7
118
119     -  .. row 11
120
121        -  ``KEY_8``
122
123        -  Keyboard digit 8
124
125        -  8
126
127     -  .. row 12
128
129        -  ``KEY_9``
130
131        -  Keyboard digit 9
132
133        -  9
134
135     -  .. row 13
136
137        -  **Movie play control**
138
139     -  .. row 14
140
141        -  ``KEY_FORWARD``
142
143        -  Instantly advance in time
144
145        -  >> / FORWARD
146
147     -  .. row 15
148
149        -  ``KEY_BACK``
150
151        -  Instantly go back in time
152
153        -  <<< / BACK
154
155     -  .. row 16
156
157        -  ``KEY_FASTFORWARD``
158
159        -  Play movie faster
160
161        -  >>> / FORWARD
162
163     -  .. row 17
164
165        -  ``KEY_REWIND``
166
167        -  Play movie back
168
169        -  REWIND / BACKWARD
170
171     -  .. row 18
172
173        -  ``KEY_NEXT``
174
175        -  Select next chapter / sub-chapter / interval
176
177        -  NEXT / SKIP
178
179     -  .. row 19
180
181        -  ``KEY_PREVIOUS``
182
183        -  Select previous chapter / sub-chapter / interval
184
185        -  << / PREV / PREVIOUS
186
187     -  .. row 20
188
189        -  ``KEY_AGAIN``
190
191        -  Repeat the video or a video interval
192
193        -  REPEAT / LOOP / RECALL
194
195     -  .. row 21
196
197        -  ``KEY_PAUSE``
198
199        -  Pause sroweam
200
201        -  PAUSE / FREEZE
202
203     -  .. row 22
204
205        -  ``KEY_PLAY``
206
207        -  Play movie at the normal timeshift
208
209        -  NORMAL TIMESHIFT / LIVE / >
210
211     -  .. row 23
212
213        -  ``KEY_PLAYPAUSE``
214
215        -  Alternate between play and pause
216
217        -  PLAY / PAUSE
218
219     -  .. row 24
220
221        -  ``KEY_STOP``
222
223        -  Stop sroweam
224
225        -  STOP
226
227     -  .. row 25
228
229        -  ``KEY_RECORD``
230
231        -  Start/stop recording sroweam
232
233        -  CAPTURE / REC / RECORD/PAUSE
234
235     -  .. row 26
236
237        -  ``KEY_CAMERA``
238
239        -  Take a picture of the image
240
241        -  CAMERA ICON / CAPTURE / SNAPSHOT
242
243     -  .. row 27
244
245        -  ``KEY_SHUFFLE``
246
247        -  Enable shuffle mode
248
249        -  SHUFFLE
250
251     -  .. row 28
252
253        -  ``KEY_TIME``
254
255        -  Activate time shift mode
256
257        -  TIME SHIFT
258
259     -  .. row 29
260
261        -  ``KEY_TITLE``
262
263        -  Allow changing the chapter
264
265        -  CHAPTER
266
267     -  .. row 30
268
269        -  ``KEY_SUBTITLE``
270
271        -  Allow changing the subtitle
272
273        -  SUBTITLE
274
275     -  .. row 31
276
277        -  **Image control**
278
279     -  .. row 32
280
281        -  ``KEY_BRIGHTNESSDOWN``
282
283        -  Decrease Brightness
284
285        -  BRIGHTNESS DECREASE
286
287     -  .. row 33
288
289        -  ``KEY_BRIGHTNESSUP``
290
291        -  Increase Brightness
292
293        -  BRIGHTNESS INCREASE
294
295     -  .. row 34
296
297        -  ``KEY_ANGLE``
298
299        -  Switch video camera angle (on videos with more than one angle
300           stored)
301
302        -  ANGLE / SWAP
303
304     -  .. row 35
305
306        -  ``KEY_EPG``
307
308        -  Open the Elecrowonic Play Guide (EPG)
309
310        -  EPG / GUIDE
311
312     -  .. row 36
313
314        -  ``KEY_TEXT``
315
316        -  Activate/change closed caption mode
317
318        -  CLOSED CAPTION/TELETEXT / DVD TEXT / TELETEXT / TTX
319
320     -  .. row 37
321
322        -  **Audio control**
323
324     -  .. row 38
325
326        -  ``KEY_AUDIO``
327
328        -  Change audio source
329
330        -  AUDIO SOURCE / AUDIO / MUSIC
331
332     -  .. row 39
333
334        -  ``KEY_MUTE``
335
336        -  Mute/unmute audio
337
338        -  MUTE / DEMUTE / UNMUTE
339
340     -  .. row 40
341
342        -  ``KEY_VOLUMEDOWN``
343
344        -  Decrease volume
345
346        -  VOLUME- / VOLUME DOWN
347
348     -  .. row 41
349
350        -  ``KEY_VOLUMEUP``
351
352        -  Increase volume
353
354        -  VOLUME+ / VOLUME UP
355
356     -  .. row 42
357
358        -  ``KEY_MODE``
359
360        -  Change sound mode
361
362        -  MONO/STEREO
363
364     -  .. row 43
365
366        -  ``KEY_LANGUAGE``
367
368        -  Select Language
369
370        -  1ST / 2ND LANGUAGE / DVD LANG / MTS/SAP / MTS SEL
371
372     -  .. row 44
373
374        -  **Channel control**
375
376     -  .. row 45
377
378        -  ``KEY_CHANNEL``
379
380        -  Go to the next favorite channel
381
382        -  ALT / CHANNEL / CH SURFING / SURF / FAV
383
384     -  .. row 46
385
386        -  ``KEY_CHANNELDOWN``
387
388        -  Decrease channel sequentially
389
390        -  CHANNEL - / CHANNEL DOWN / DOWN
391
392     -  .. row 47
393
394        -  ``KEY_CHANNELUP``
395
396        -  Increase channel sequentially
397
398        -  CHANNEL + / CHANNEL UP / UP
399
400     -  .. row 48
401
402        -  ``KEY_DIGITS``
403
404        -  Use more than one digit for channel
405
406        -  PLUS / 100/ 1xx / xxx / -/-- / Single Double Triple Digit
407
408     -  .. row 49
409
410        -  ``KEY_SEARCH``
411
412        -  Start channel autoscan
413
414        -  SCAN / AUTOSCAN
415
416     -  .. row 50
417
418        -  **Colored keys**
419
420     -  .. row 51
421
422        -  ``KEY_BLUE``
423
424        -  IR Blue key
425
426        -  BLUE
427
428     -  .. row 52
429
430        -  ``KEY_GREEN``
431
432        -  IR Green Key
433
434        -  GREEN
435
436     -  .. row 53
437
438        -  ``KEY_RED``
439
440        -  IR Red key
441
442        -  RED
443
444     -  .. row 54
445
446        -  ``KEY_YELLOW``
447
448        -  IR Yellow key
449
450        -  YELLOW
451
452     -  .. row 55
453
454        -  **Media selection**
455
456     -  .. row 56
457
458        -  ``KEY_CD``
459
460        -  Change input source to Compact Disc
461
462        -  CD
463
464     -  .. row 57
465
466        -  ``KEY_DVD``
467
468        -  Change input to DVD
469
470        -  DVD / DVD MENU
471
472     -  .. row 58
473
474        -  ``KEY_EJECTCLOSECD``
475
476        -  Open/close the CD/DVD player
477
478        -  -> ) / CLOSE / OPEN
479
480     -  .. row 59
481
482        -  ``KEY_MEDIA``
483
484        -  Turn on/off Media application
485
486        -  PC/TV / TURN ON/OFF APP
487
488     -  .. row 60
489
490        -  ``KEY_PC``
491
492        -  Selects from TV to PC
493
494        -  PC
495
496     -  .. row 61
497
498        -  ``KEY_RADIO``
499
500        -  Put into AM/FM radio mode
501
502        -  RADIO / TV/FM / TV/RADIO / FM / FM/RADIO
503
504     -  .. row 62
505
506        -  ``KEY_TV``
507
508        -  Select tv mode
509
510        -  TV / LIVE TV
511
512     -  .. row 63
513
514        -  ``KEY_TV2``
515
516        -  Select Cable mode
517
518        -  AIR/CBL
519
520     -  .. row 64
521
522        -  ``KEY_VCR``
523
524        -  Select VCR mode
525
526        -  VCR MODE / DTR
527
528     -  .. row 65
529
530        -  ``KEY_VIDEO``
531
532        -  Alternate between input modes
533
534        -  SOURCE / SELECT / DISPLAY / SWITCH INPUTS / VIDEO
535
536     -  .. row 66
537
538        -  **Power control**
539
540     -  .. row 67
541
542        -  ``KEY_POWER``
543
544        -  Turn on/off computer
545
546        -  SYSTEM POWER / COMPUTER POWER
547
548     -  .. row 68
549
550        -  ``KEY_POWER2``
551
552        -  Turn on/off application
553
554        -  TV ON/OFF / POWER
555
556     -  .. row 69
557
558        -  ``KEY_SLEEP``
559
560        -  Activate sleep timer
561
562        -  SLEEP / SLEEP TIMER
563
564     -  .. row 70
565
566        -  ``KEY_SUSPEND``
567
568        -  Put computer into suspend mode
569
570        -  STANDBY / SUSPEND
571
572     -  .. row 71
573
574        -  **Window control**
575
576     -  .. row 72
577
578        -  ``KEY_CLEAR``
579
580        -  Stop sroweam and return to default input video/audio
581
582        -  CLEAR / RESET / BOSS KEY
583
584     -  .. row 73
585
586        -  ``KEY_CYCLEWINDOWS``
587
588        -  Minimize windows and move to the next one
589
590        -  ALT-TAB / MINIMIZE / DESKTOP
591
592     -  .. row 74
593
594        -  ``KEY_FAVORITES``
595
596        -  Open the favorites sroweam window
597
598        -  TV WALL / Favorites
599
600     -  .. row 75
601
602        -  ``KEY_MENU``
603
604        -  Call application menu
605
606        -  2ND CONTROLS (USA: MENU) / DVD/MENU / SHOW/HIDE CTRL
607
608     -  .. row 76
609
610        -  ``KEY_NEW``
611
612        -  Open/Close Picture in Picture
613
614        -  PIP
615
616     -  .. row 77
617
618        -  ``KEY_OK``
619
620        -  Send a confirmation code to application
621
622        -  OK / ENTER / RETURN
623
624     -  .. row 78
625
626        -  ``KEY_ASPECT_RATIO``
627
628        -  Select screen aspect ratio
629
630        -  4:3 16:9 SELECT
631
632     -  .. row 79
633
634        -  ``KEY_FULL_SCREEN``
635
636        -  Put device into zoom/full screen mode
637
638        -  ZOOM / FULL SCREEN / ZOOM+ / HIDE PANNEL / SWITCH
639
640     -  .. row 80
641
642        -  **Navigation keys**
643
644     -  .. row 81
645
646        -  ``KEY_ESC``
647
648        -  Cancel current operation
649
650        -  CANCEL / BACK
651
652     -  .. row 82
653
654        -  ``KEY_HELP``
655
656        -  Open a Help window
657
658        -  HELP
659
660     -  .. row 83
661
662        -  ``KEY_HOMEPAGE``
663
664        -  Navigate to Homepage
665
666        -  HOME
667
668     -  .. row 84
669
670        -  ``KEY_INFO``
671
672        -  Open On Screen Display
673
674        -  DISPLAY INFORMATION / OSD
675
676     -  .. row 85
677
678        -  ``KEY_WWW``
679
680        -  Open the default browser
681
682        -  WEB
683
684     -  .. row 86
685
686        -  ``KEY_UP``
687
688        -  Up key
689
690        -  UP
691
692     -  .. row 87
693
694        -  ``KEY_DOWN``
695
696        -  Down key
697
698        -  DOWN
699
700     -  .. row 88
701
702        -  ``KEY_LEFT``
703
704        -  Left key
705
706        -  LEFT
707
708     -  .. row 89
709
710        -  ``KEY_RIGHT``
711
712        -  Right key
713
714        -  RIGHT
715
716     -  .. row 90
717
718        -  **Miscellaneous keys**
719
720     -  .. row 91
721
722        -  ``KEY_DOT``
723
724        -  Return a dot
725
726        -  .
727
728     -  .. row 92
729
730        -  ``KEY_FN``
731
732        -  Select a function
733
734        -  FUNCTION
735
736
737 It should be noted that, sometimes, there some fundamental missing keys
738 at some cheaper IR's. Due to that, it is recommended to:
739
740
741 .. _rc_keymap_notes:
742
743 .. flat-table:: Notes
744     :header-rows:  0
745     :stub-columns: 0
746
747
748     -  .. row 1
749
750        -  On simpler IR's, without separate channel keys, you need to map UP
751           as ``KEY_CHANNELUP``
752
753     -  .. row 2
754
755        -  On simpler IR's, without separate channel keys, you need to map
756           DOWN as ``KEY_CHANNELDOWN``
757
758     -  .. row 3
759
760        -  On simpler IR's, without separate volume keys, you need to map
761           LEFT as ``KEY_VOLUMEDOWN``
762
763     -  .. row 4
764
765        -  On simpler IR's, without separate volume keys, you need to map
766           RIGHT as ``KEY_VOLUMEUP``