xref: /openbmc/linux/include/media/rc-map.h (revision f7d84fa7)
1 /*
2  * rc-map.h - define RC map names used by RC drivers
3  *
4  * Copyright (c) 2010 by Mauro Carvalho Chehab
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  */
11 
12 #include <linux/input.h>
13 
14 /**
15  * enum rc_type - type of the Remote Controller protocol
16  *
17  * @RC_TYPE_UNKNOWN: Protocol not known
18  * @RC_TYPE_OTHER: Protocol known but proprietary
19  * @RC_TYPE_RC5: Philips RC5 protocol
20  * @RC_TYPE_RC5X_20: Philips RC5x 20 bit protocol
21  * @RC_TYPE_RC5_SZ: StreamZap variant of RC5
22  * @RC_TYPE_JVC: JVC protocol
23  * @RC_TYPE_SONY12: Sony 12 bit protocol
24  * @RC_TYPE_SONY15: Sony 15 bit protocol
25  * @RC_TYPE_SONY20: Sony 20 bit protocol
26  * @RC_TYPE_NEC: NEC protocol
27  * @RC_TYPE_NECX: Extended NEC protocol
28  * @RC_TYPE_NEC32: NEC 32 bit protocol
29  * @RC_TYPE_SANYO: Sanyo protocol
30  * @RC_TYPE_MCIR2_KBD: RC6-ish MCE keyboard
31  * @RC_TYPE_MCIR2_MSE: RC6-ish MCE mouse
32  * @RC_TYPE_RC6_0: Philips RC6-0-16 protocol
33  * @RC_TYPE_RC6_6A_20: Philips RC6-6A-20 protocol
34  * @RC_TYPE_RC6_6A_24: Philips RC6-6A-24 protocol
35  * @RC_TYPE_RC6_6A_32: Philips RC6-6A-32 protocol
36  * @RC_TYPE_RC6_MCE: MCE (Philips RC6-6A-32 subtype) protocol
37  * @RC_TYPE_SHARP: Sharp protocol
38  * @RC_TYPE_XMP: XMP protocol
39  * @RC_TYPE_CEC: CEC protocol
40  */
41 enum rc_type {
42 	RC_TYPE_UNKNOWN		= 0,
43 	RC_TYPE_OTHER		= 1,
44 	RC_TYPE_RC5		= 2,
45 	RC_TYPE_RC5X_20		= 3,
46 	RC_TYPE_RC5_SZ		= 4,
47 	RC_TYPE_JVC		= 5,
48 	RC_TYPE_SONY12		= 6,
49 	RC_TYPE_SONY15		= 7,
50 	RC_TYPE_SONY20		= 8,
51 	RC_TYPE_NEC		= 9,
52 	RC_TYPE_NECX		= 10,
53 	RC_TYPE_NEC32		= 11,
54 	RC_TYPE_SANYO		= 12,
55 	RC_TYPE_MCIR2_KBD	= 13,
56 	RC_TYPE_MCIR2_MSE	= 14,
57 	RC_TYPE_RC6_0		= 15,
58 	RC_TYPE_RC6_6A_20	= 16,
59 	RC_TYPE_RC6_6A_24	= 17,
60 	RC_TYPE_RC6_6A_32	= 18,
61 	RC_TYPE_RC6_MCE		= 19,
62 	RC_TYPE_SHARP		= 20,
63 	RC_TYPE_XMP		= 21,
64 	RC_TYPE_CEC		= 22,
65 };
66 
67 #define RC_BIT_NONE		0ULL
68 #define RC_BIT_UNKNOWN		BIT_ULL(RC_TYPE_UNKNOWN)
69 #define RC_BIT_OTHER		BIT_ULL(RC_TYPE_OTHER)
70 #define RC_BIT_RC5		BIT_ULL(RC_TYPE_RC5)
71 #define RC_BIT_RC5X_20		BIT_ULL(RC_TYPE_RC5X_20)
72 #define RC_BIT_RC5_SZ		BIT_ULL(RC_TYPE_RC5_SZ)
73 #define RC_BIT_JVC		BIT_ULL(RC_TYPE_JVC)
74 #define RC_BIT_SONY12		BIT_ULL(RC_TYPE_SONY12)
75 #define RC_BIT_SONY15		BIT_ULL(RC_TYPE_SONY15)
76 #define RC_BIT_SONY20		BIT_ULL(RC_TYPE_SONY20)
77 #define RC_BIT_NEC		BIT_ULL(RC_TYPE_NEC)
78 #define RC_BIT_NECX		BIT_ULL(RC_TYPE_NECX)
79 #define RC_BIT_NEC32		BIT_ULL(RC_TYPE_NEC32)
80 #define RC_BIT_SANYO		BIT_ULL(RC_TYPE_SANYO)
81 #define RC_BIT_MCIR2_KBD	BIT_ULL(RC_TYPE_MCIR2_KBD)
82 #define RC_BIT_MCIR2_MSE	BIT_ULL(RC_TYPE_MCIR2_MSE)
83 #define RC_BIT_RC6_0		BIT_ULL(RC_TYPE_RC6_0)
84 #define RC_BIT_RC6_6A_20	BIT_ULL(RC_TYPE_RC6_6A_20)
85 #define RC_BIT_RC6_6A_24	BIT_ULL(RC_TYPE_RC6_6A_24)
86 #define RC_BIT_RC6_6A_32	BIT_ULL(RC_TYPE_RC6_6A_32)
87 #define RC_BIT_RC6_MCE		BIT_ULL(RC_TYPE_RC6_MCE)
88 #define RC_BIT_SHARP		BIT_ULL(RC_TYPE_SHARP)
89 #define RC_BIT_XMP		BIT_ULL(RC_TYPE_XMP)
90 #define RC_BIT_CEC		BIT_ULL(RC_TYPE_CEC)
91 
92 #define RC_BIT_ALL	(RC_BIT_UNKNOWN | RC_BIT_OTHER | \
93 			 RC_BIT_RC5 | RC_BIT_RC5X_20 | RC_BIT_RC5_SZ | \
94 			 RC_BIT_JVC | \
95 			 RC_BIT_SONY12 | RC_BIT_SONY15 | RC_BIT_SONY20 | \
96 			 RC_BIT_NEC | RC_BIT_NECX | RC_BIT_NEC32 | \
97 			 RC_BIT_SANYO | \
98 			 RC_BIT_MCIR2_KBD | RC_BIT_MCIR2_MSE | \
99 			 RC_BIT_RC6_0 | RC_BIT_RC6_6A_20 | RC_BIT_RC6_6A_24 | \
100 			 RC_BIT_RC6_6A_32 | RC_BIT_RC6_MCE | RC_BIT_SHARP | \
101 			 RC_BIT_XMP | RC_BIT_CEC)
102 /* All rc protocols for which we have decoders */
103 #define RC_BIT_ALL_IR_DECODER \
104 			(RC_BIT_RC5 | RC_BIT_RC5X_20 | RC_BIT_RC5_SZ | \
105 			 RC_BIT_JVC | \
106 			 RC_BIT_SONY12 | RC_BIT_SONY15 | RC_BIT_SONY20 | \
107 			 RC_BIT_NEC | RC_BIT_NECX | RC_BIT_NEC32 | \
108 			 RC_BIT_SANYO | RC_BIT_MCIR2_KBD | RC_BIT_MCIR2_MSE | \
109 			 RC_BIT_RC6_0 | RC_BIT_RC6_6A_20 | RC_BIT_RC6_6A_24 | \
110 			 RC_BIT_RC6_6A_32 | RC_BIT_RC6_MCE | RC_BIT_SHARP | \
111 			 RC_BIT_XMP)
112 
113 #define RC_BIT_ALL_IR_ENCODER \
114 			(RC_BIT_RC5 | RC_BIT_RC5X_20 | RC_BIT_RC5_SZ | \
115 			 RC_BIT_JVC | \
116 			 RC_BIT_SONY12 | RC_BIT_SONY15 | RC_BIT_SONY20 | \
117 			 RC_BIT_NEC | RC_BIT_NECX | RC_BIT_NEC32 | \
118 			 RC_BIT_SANYO | RC_BIT_MCIR2_KBD | RC_BIT_MCIR2_MSE | \
119 			 RC_BIT_RC6_0 | RC_BIT_RC6_6A_20 | RC_BIT_RC6_6A_24 | \
120 			 RC_BIT_RC6_6A_32 | RC_BIT_RC6_MCE | \
121 			 RC_BIT_SHARP)
122 
123 #define RC_SCANCODE_UNKNOWN(x)			(x)
124 #define RC_SCANCODE_OTHER(x)			(x)
125 #define RC_SCANCODE_NEC(addr, cmd)		(((addr) << 8) | (cmd))
126 #define RC_SCANCODE_NECX(addr, cmd)		(((addr) << 8) | (cmd))
127 #define RC_SCANCODE_NEC32(data)			((data) & 0xffffffff)
128 #define RC_SCANCODE_RC5(sys, cmd)		(((sys) << 8) | (cmd))
129 #define RC_SCANCODE_RC5_SZ(sys, cmd)		(((sys) << 8) | (cmd))
130 #define RC_SCANCODE_RC6_0(sys, cmd)		(((sys) << 8) | (cmd))
131 #define RC_SCANCODE_RC6_6A(vendor, sys, cmd)	(((vendor) << 16) | ((sys) << 8) | (cmd))
132 
133 /**
134  * struct rc_map_table - represents a scancode/keycode pair
135  *
136  * @scancode: scan code (u32)
137  * @keycode: Linux input keycode
138  */
139 struct rc_map_table {
140 	u32	scancode;
141 	u32	keycode;
142 };
143 
144 /**
145  * struct rc_map - represents a keycode map table
146  *
147  * @scan: pointer to struct &rc_map_table
148  * @size: Max number of entries
149  * @len: Number of entries that are in use
150  * @alloc: size of \*scan, in bytes
151  * @rc_type: type of the remote controller protocol, as defined at
152  *	     enum &rc_type
153  * @name: name of the key map table
154  * @lock: lock to protect access to this structure
155  */
156 struct rc_map {
157 	struct rc_map_table	*scan;
158 	unsigned int		size;
159 	unsigned int		len;
160 	unsigned int		alloc;
161 	enum rc_type		rc_type;
162 	const char		*name;
163 	spinlock_t		lock;
164 };
165 
166 /**
167  * struct rc_map_list - list of the registered &rc_map maps
168  *
169  * @list: pointer to struct &list_head
170  * @map: pointer to struct &rc_map
171  */
172 struct rc_map_list {
173 	struct list_head	 list;
174 	struct rc_map map;
175 };
176 
177 /* Routines from rc-map.c */
178 
179 /**
180  * rc_map_register() - Registers a Remote Controler scancode map
181  *
182  * @map:	pointer to struct rc_map_list
183  */
184 int rc_map_register(struct rc_map_list *map);
185 
186 /**
187  * rc_map_unregister() - Unregisters a Remote Controler scancode map
188  *
189  * @map:	pointer to struct rc_map_list
190  */
191 void rc_map_unregister(struct rc_map_list *map);
192 
193 /**
194  * rc_map_get - gets an RC map from its name
195  * @name: name of the RC scancode map
196  */
197 struct rc_map *rc_map_get(const char *name);
198 
199 /* Names of the several keytables defined in-kernel */
200 
201 #define RC_MAP_ADSTECH_DVB_T_PCI         "rc-adstech-dvb-t-pci"
202 #define RC_MAP_ALINK_DTU_M               "rc-alink-dtu-m"
203 #define RC_MAP_ANYSEE                    "rc-anysee"
204 #define RC_MAP_APAC_VIEWCOMP             "rc-apac-viewcomp"
205 #define RC_MAP_ASUS_PC39                 "rc-asus-pc39"
206 #define RC_MAP_ASUS_PS3_100              "rc-asus-ps3-100"
207 #define RC_MAP_ATI_TV_WONDER_HD_600      "rc-ati-tv-wonder-hd-600"
208 #define RC_MAP_ATI_X10                   "rc-ati-x10"
209 #define RC_MAP_AVERMEDIA_A16D            "rc-avermedia-a16d"
210 #define RC_MAP_AVERMEDIA_CARDBUS         "rc-avermedia-cardbus"
211 #define RC_MAP_AVERMEDIA_DVBT            "rc-avermedia-dvbt"
212 #define RC_MAP_AVERMEDIA_M135A           "rc-avermedia-m135a"
213 #define RC_MAP_AVERMEDIA_M733A_RM_K6     "rc-avermedia-m733a-rm-k6"
214 #define RC_MAP_AVERMEDIA_RM_KS           "rc-avermedia-rm-ks"
215 #define RC_MAP_AVERMEDIA                 "rc-avermedia"
216 #define RC_MAP_AVERTV_303                "rc-avertv-303"
217 #define RC_MAP_AZUREWAVE_AD_TU700        "rc-azurewave-ad-tu700"
218 #define RC_MAP_BEHOLD_COLUMBUS           "rc-behold-columbus"
219 #define RC_MAP_BEHOLD                    "rc-behold"
220 #define RC_MAP_BUDGET_CI_OLD             "rc-budget-ci-old"
221 #define RC_MAP_CEC                       "rc-cec"
222 #define RC_MAP_CINERGY_1400              "rc-cinergy-1400"
223 #define RC_MAP_CINERGY                   "rc-cinergy"
224 #define RC_MAP_D680_DMB                  "rc-d680-dmb"
225 #define RC_MAP_DELOCK_61959              "rc-delock-61959"
226 #define RC_MAP_DIB0700_NEC_TABLE         "rc-dib0700-nec"
227 #define RC_MAP_DIB0700_RC5_TABLE         "rc-dib0700-rc5"
228 #define RC_MAP_DIGITALNOW_TINYTWIN       "rc-digitalnow-tinytwin"
229 #define RC_MAP_DIGITTRADE                "rc-digittrade"
230 #define RC_MAP_DM1105_NEC                "rc-dm1105-nec"
231 #define RC_MAP_DNTV_LIVE_DVBT_PRO        "rc-dntv-live-dvbt-pro"
232 #define RC_MAP_DNTV_LIVE_DVB_T           "rc-dntv-live-dvb-t"
233 #define RC_MAP_DTT200U                   "rc-dtt200u"
234 #define RC_MAP_DVBSKY                    "rc-dvbsky"
235 #define RC_MAP_DVICO_MCE		 "rc-dvico-mce"
236 #define RC_MAP_DVICO_PORTABLE		 "rc-dvico-portable"
237 #define RC_MAP_EMPTY                     "rc-empty"
238 #define RC_MAP_EM_TERRATEC               "rc-em-terratec"
239 #define RC_MAP_ENCORE_ENLTV2             "rc-encore-enltv2"
240 #define RC_MAP_ENCORE_ENLTV_FM53         "rc-encore-enltv-fm53"
241 #define RC_MAP_ENCORE_ENLTV              "rc-encore-enltv"
242 #define RC_MAP_EVGA_INDTUBE              "rc-evga-indtube"
243 #define RC_MAP_EZTV                      "rc-eztv"
244 #define RC_MAP_FLYDVB                    "rc-flydvb"
245 #define RC_MAP_FLYVIDEO                  "rc-flyvideo"
246 #define RC_MAP_FUSIONHDTV_MCE            "rc-fusionhdtv-mce"
247 #define RC_MAP_GADMEI_RM008Z             "rc-gadmei-rm008z"
248 #define RC_MAP_GEEKBOX                   "rc-geekbox"
249 #define RC_MAP_GENIUS_TVGO_A11MCE        "rc-genius-tvgo-a11mce"
250 #define RC_MAP_GOTVIEW7135               "rc-gotview7135"
251 #define RC_MAP_HAUPPAUGE_NEW             "rc-hauppauge"
252 #define RC_MAP_IMON_MCE                  "rc-imon-mce"
253 #define RC_MAP_IMON_PAD                  "rc-imon-pad"
254 #define RC_MAP_IODATA_BCTV7E             "rc-iodata-bctv7e"
255 #define RC_MAP_IT913X_V1                 "rc-it913x-v1"
256 #define RC_MAP_IT913X_V2                 "rc-it913x-v2"
257 #define RC_MAP_KAIOMY                    "rc-kaiomy"
258 #define RC_MAP_KWORLD_315U               "rc-kworld-315u"
259 #define RC_MAP_KWORLD_PC150U             "rc-kworld-pc150u"
260 #define RC_MAP_KWORLD_PLUS_TV_ANALOG     "rc-kworld-plus-tv-analog"
261 #define RC_MAP_LEADTEK_Y04G0051          "rc-leadtek-y04g0051"
262 #define RC_MAP_LME2510                   "rc-lme2510"
263 #define RC_MAP_MANLI                     "rc-manli"
264 #define RC_MAP_MEDION_X10                "rc-medion-x10"
265 #define RC_MAP_MEDION_X10_DIGITAINER     "rc-medion-x10-digitainer"
266 #define RC_MAP_MEDION_X10_OR2X           "rc-medion-x10-or2x"
267 #define RC_MAP_MSI_DIGIVOX_II            "rc-msi-digivox-ii"
268 #define RC_MAP_MSI_DIGIVOX_III           "rc-msi-digivox-iii"
269 #define RC_MAP_MSI_TVANYWHERE_PLUS       "rc-msi-tvanywhere-plus"
270 #define RC_MAP_MSI_TVANYWHERE            "rc-msi-tvanywhere"
271 #define RC_MAP_NEBULA                    "rc-nebula"
272 #define RC_MAP_NEC_TERRATEC_CINERGY_XS   "rc-nec-terratec-cinergy-xs"
273 #define RC_MAP_NORWOOD                   "rc-norwood"
274 #define RC_MAP_NPGTECH                   "rc-npgtech"
275 #define RC_MAP_PCTV_SEDNA                "rc-pctv-sedna"
276 #define RC_MAP_PINNACLE_COLOR            "rc-pinnacle-color"
277 #define RC_MAP_PINNACLE_GREY             "rc-pinnacle-grey"
278 #define RC_MAP_PINNACLE_PCTV_HD          "rc-pinnacle-pctv-hd"
279 #define RC_MAP_PIXELVIEW_NEW             "rc-pixelview-new"
280 #define RC_MAP_PIXELVIEW                 "rc-pixelview"
281 #define RC_MAP_PIXELVIEW_002T		 "rc-pixelview-002t"
282 #define RC_MAP_PIXELVIEW_MK12            "rc-pixelview-mk12"
283 #define RC_MAP_POWERCOLOR_REAL_ANGEL     "rc-powercolor-real-angel"
284 #define RC_MAP_PROTEUS_2309              "rc-proteus-2309"
285 #define RC_MAP_PURPLETV                  "rc-purpletv"
286 #define RC_MAP_PV951                     "rc-pv951"
287 #define RC_MAP_HAUPPAUGE                 "rc-hauppauge"
288 #define RC_MAP_RC5_TV                    "rc-rc5-tv"
289 #define RC_MAP_RC6_MCE                   "rc-rc6-mce"
290 #define RC_MAP_REAL_AUDIO_220_32_KEYS    "rc-real-audio-220-32-keys"
291 #define RC_MAP_REDDO                     "rc-reddo"
292 #define RC_MAP_SNAPSTREAM_FIREFLY        "rc-snapstream-firefly"
293 #define RC_MAP_STREAMZAP                 "rc-streamzap"
294 #define RC_MAP_TBS_NEC                   "rc-tbs-nec"
295 #define RC_MAP_TECHNISAT_TS35            "rc-technisat-ts35"
296 #define RC_MAP_TECHNISAT_USB2            "rc-technisat-usb2"
297 #define RC_MAP_TERRATEC_CINERGY_C_PCI    "rc-terratec-cinergy-c-pci"
298 #define RC_MAP_TERRATEC_CINERGY_S2_HD    "rc-terratec-cinergy-s2-hd"
299 #define RC_MAP_TERRATEC_CINERGY_XS       "rc-terratec-cinergy-xs"
300 #define RC_MAP_TERRATEC_SLIM             "rc-terratec-slim"
301 #define RC_MAP_TERRATEC_SLIM_2           "rc-terratec-slim-2"
302 #define RC_MAP_TEVII_NEC                 "rc-tevii-nec"
303 #define RC_MAP_TIVO                      "rc-tivo"
304 #define RC_MAP_TOTAL_MEDIA_IN_HAND       "rc-total-media-in-hand"
305 #define RC_MAP_TOTAL_MEDIA_IN_HAND_02    "rc-total-media-in-hand-02"
306 #define RC_MAP_TREKSTOR                  "rc-trekstor"
307 #define RC_MAP_TT_1500                   "rc-tt-1500"
308 #define RC_MAP_TWINHAN_DTV_CAB_CI        "rc-twinhan-dtv-cab-ci"
309 #define RC_MAP_TWINHAN_VP1027_DVBS       "rc-twinhan1027"
310 #define RC_MAP_VIDEOMATE_K100            "rc-videomate-k100"
311 #define RC_MAP_VIDEOMATE_S350            "rc-videomate-s350"
312 #define RC_MAP_VIDEOMATE_TV_PVR          "rc-videomate-tv-pvr"
313 #define RC_MAP_WINFAST                   "rc-winfast"
314 #define RC_MAP_WINFAST_USBII_DELUXE      "rc-winfast-usbii-deluxe"
315 #define RC_MAP_SU3000                    "rc-su3000"
316 
317 /*
318  * Please, do not just append newer Remote Controller names at the end.
319  * The names should be ordered in alphabetical order
320  */
321