xref: /openbmc/linux/drivers/media/rc/keymaps/rc-cec.c (revision 82e6fdd6)
1 /* Keytable for the CEC remote control
2  *
3  * Copyright (c) 2015 by Kamil Debski
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  */
10 
11 #include <media/rc-map.h>
12 #include <linux/module.h>
13 
14 /*
15  * CEC Spec "High-Definition Multimedia Interface Specification" can be obtained
16  * here: http://xtreamerdev.googlecode.com/files/CEC_Specs.pdf
17  * The list of control codes is listed in Table 27: User Control Codes p. 95
18  */
19 
20 static struct rc_map_table cec[] = {
21 	{ 0x00, KEY_OK },
22 	{ 0x01, KEY_UP },
23 	{ 0x02, KEY_DOWN },
24 	{ 0x03, KEY_LEFT },
25 	{ 0x04, KEY_RIGHT },
26 	{ 0x05, KEY_RIGHT_UP },
27 	{ 0x06, KEY_RIGHT_DOWN },
28 	{ 0x07, KEY_LEFT_UP },
29 	{ 0x08, KEY_LEFT_DOWN },
30 	{ 0x09, KEY_ROOT_MENU }, /* CEC Spec: Device Root Menu - see Note 2 */
31 	/*
32 	 * Note 2: This is the initial display that a device shows. It is
33 	 * device-dependent and can be, for example, a contents menu, setup
34 	 * menu, favorite menu or other menu. The actual menu displayed
35 	 * may also depend on the device's current state.
36 	 */
37 	{ 0x0a, KEY_SETUP },
38 	{ 0x0b, KEY_MENU }, /* CEC Spec: Contents Menu */
39 	{ 0x0c, KEY_FAVORITES }, /* CEC Spec: Favorite Menu */
40 	{ 0x0d, KEY_EXIT },
41 	/* 0x0e-0x0f: Reserved */
42 	{ 0x10, KEY_MEDIA_TOP_MENU },
43 	{ 0x11, KEY_CONTEXT_MENU },
44 	/* 0x12-0x1c: Reserved */
45 	{ 0x1d, KEY_DIGITS }, /* CEC Spec: select/toggle a Number Entry Mode */
46 	{ 0x1e, KEY_NUMERIC_11 },
47 	{ 0x1f, KEY_NUMERIC_12 },
48 	/* 0x20-0x29: Keys 0 to 9 */
49 	{ 0x20, KEY_NUMERIC_0 },
50 	{ 0x21, KEY_NUMERIC_1 },
51 	{ 0x22, KEY_NUMERIC_2 },
52 	{ 0x23, KEY_NUMERIC_3 },
53 	{ 0x24, KEY_NUMERIC_4 },
54 	{ 0x25, KEY_NUMERIC_5 },
55 	{ 0x26, KEY_NUMERIC_6 },
56 	{ 0x27, KEY_NUMERIC_7 },
57 	{ 0x28, KEY_NUMERIC_8 },
58 	{ 0x29, KEY_NUMERIC_9 },
59 	{ 0x2a, KEY_DOT },
60 	{ 0x2b, KEY_ENTER },
61 	{ 0x2c, KEY_CLEAR },
62 	/* 0x2d-0x2e: Reserved */
63 	{ 0x2f, KEY_NEXT_FAVORITE }, /* CEC Spec: Next Favorite */
64 	{ 0x30, KEY_CHANNELUP },
65 	{ 0x31, KEY_CHANNELDOWN },
66 	{ 0x32, KEY_PREVIOUS }, /* CEC Spec: Previous Channel */
67 	{ 0x33, KEY_SOUND }, /* CEC Spec: Sound Select */
68 	{ 0x34, KEY_VIDEO }, /* 0x34: CEC Spec: Input Select */
69 	{ 0x35, KEY_INFO }, /* CEC Spec: Display Information */
70 	{ 0x36, KEY_HELP },
71 	{ 0x37, KEY_PAGEUP },
72 	{ 0x38, KEY_PAGEDOWN },
73 	/* 0x39-0x3f: Reserved */
74 	{ 0x40, KEY_POWER },
75 	{ 0x41, KEY_VOLUMEUP },
76 	{ 0x42, KEY_VOLUMEDOWN },
77 	{ 0x43, KEY_MUTE },
78 	{ 0x44, KEY_PLAYCD },
79 	{ 0x45, KEY_STOPCD },
80 	{ 0x46, KEY_PAUSECD },
81 	{ 0x47, KEY_RECORD },
82 	{ 0x48, KEY_REWIND },
83 	{ 0x49, KEY_FASTFORWARD },
84 	{ 0x4a, KEY_EJECTCD }, /* CEC Spec: Eject */
85 	{ 0x4b, KEY_FORWARD },
86 	{ 0x4c, KEY_BACK },
87 	{ 0x4d, KEY_STOP_RECORD }, /* CEC Spec: Stop-Record */
88 	{ 0x4e, KEY_PAUSE_RECORD }, /* CEC Spec: Pause-Record */
89 	/* 0x4f: Reserved */
90 	{ 0x50, KEY_ANGLE },
91 	{ 0x51, KEY_TV2 },
92 	{ 0x52, KEY_VOD }, /* CEC Spec: Video on Demand */
93 	{ 0x53, KEY_EPG },
94 	{ 0x54, KEY_TIME }, /* CEC Spec: Timer */
95 	{ 0x55, KEY_CONFIG },
96 	/*
97 	 * The following codes are hard to implement at this moment, as they
98 	 * carry an additional additional argument. Most likely changes to RC
99 	 * framework are necessary.
100 	 * For now they are interpreted by the CEC framework as non keycodes
101 	 * and are passed as messages enabling user application to parse them.
102 	 */
103 	/* 0x56: CEC Spec: Select Broadcast Type */
104 	/* 0x57: CEC Spec: Select Sound presentation */
105 	{ 0x58, KEY_AUDIO_DESC }, /* CEC 2.0 and up */
106 	{ 0x59, KEY_WWW }, /* CEC 2.0 and up */
107 	{ 0x5a, KEY_3D_MODE }, /* CEC 2.0 and up */
108 	/* 0x5b-0x5f: Reserved */
109 	{ 0x60, KEY_PLAYCD }, /* CEC Spec: Play Function */
110 	{ 0x6005, KEY_FASTFORWARD },
111 	{ 0x6006, KEY_FASTFORWARD },
112 	{ 0x6007, KEY_FASTFORWARD },
113 	{ 0x6015, KEY_SLOW },
114 	{ 0x6016, KEY_SLOW },
115 	{ 0x6017, KEY_SLOW },
116 	{ 0x6009, KEY_FASTREVERSE },
117 	{ 0x600a, KEY_FASTREVERSE },
118 	{ 0x600b, KEY_FASTREVERSE },
119 	{ 0x6019, KEY_SLOWREVERSE },
120 	{ 0x601a, KEY_SLOWREVERSE },
121 	{ 0x601b, KEY_SLOWREVERSE },
122 	{ 0x6020, KEY_REWIND },
123 	{ 0x6024, KEY_PLAYCD },
124 	{ 0x6025, KEY_PAUSECD },
125 	{ 0x61, KEY_PLAYPAUSE }, /* CEC Spec: Pause-Play Function */
126 	{ 0x62, KEY_RECORD }, /* Spec: Record Function */
127 	{ 0x63, KEY_PAUSE_RECORD }, /* CEC Spec: Pause-Record Function */
128 	{ 0x64, KEY_STOPCD }, /* CEC Spec: Stop Function */
129 	{ 0x65, KEY_MUTE }, /* CEC Spec: Mute Function */
130 	{ 0x66, KEY_UNMUTE }, /* CEC Spec: Restore the volume */
131 	/*
132 	 * The following codes are hard to implement at this moment, as they
133 	 * carry an additional additional argument. Most likely changes to RC
134 	 * framework are necessary.
135 	 * For now they are interpreted by the CEC framework as non keycodes
136 	 * and are passed as messages enabling user application to parse them.
137 	 */
138 	/* 0x67: CEC Spec: Tune Function */
139 	/* 0x68: CEC Spec: Seleect Media Function */
140 	/* 0x69: CEC Spec: Select A/V Input Function */
141 	/* 0x6a: CEC Spec: Select Audio Input Function */
142 	{ 0x6b, KEY_POWER }, /* CEC Spec: Power Toggle Function */
143 	{ 0x6c, KEY_SLEEP }, /* CEC Spec: Power Off Function */
144 	{ 0x6d, KEY_WAKEUP }, /* CEC Spec: Power On Function */
145 	/* 0x6e-0x70: Reserved */
146 	{ 0x71, KEY_BLUE }, /* CEC Spec: F1 (Blue) */
147 	{ 0x72, KEY_RED }, /* CEC Spec: F2 (Red) */
148 	{ 0x73, KEY_GREEN }, /* CEC Spec: F3 (Green) */
149 	{ 0x74, KEY_YELLOW }, /* CEC Spec: F4 (Yellow) */
150 	{ 0x75, KEY_F5 },
151 	{ 0x76, KEY_DATA }, /* CEC Spec: Data - see Note 3 */
152 	/*
153 	 * Note 3: This is used, for example, to enter or leave a digital TV
154 	 * data broadcast application.
155 	 */
156 	/* 0x77-0xff: Reserved */
157 };
158 
159 static struct rc_map_list cec_map = {
160 	.map = {
161 		.scan		= cec,
162 		.size		= ARRAY_SIZE(cec),
163 		.rc_proto	= RC_PROTO_CEC,
164 		.name		= RC_MAP_CEC,
165 	}
166 };
167 
168 static int __init init_rc_map_cec(void)
169 {
170 	return rc_map_register(&cec_map);
171 }
172 
173 static void __exit exit_rc_map_cec(void)
174 {
175 	rc_map_unregister(&cec_map);
176 }
177 
178 module_init(init_rc_map_cec);
179 module_exit(exit_rc_map_cec);
180 
181 MODULE_LICENSE("GPL");
182 MODULE_AUTHOR("Kamil Debski");
183