xref: /openbmc/linux/include/media/rc-map.h (revision 5e012745)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * rc-map.h - define RC map names used by RC drivers
4  *
5  * Copyright (c) 2010 by Mauro Carvalho Chehab
6  */
7 
8 #include <linux/input.h>
9 #include <uapi/linux/lirc.h>
10 
11 #define RC_PROTO_BIT_NONE		0ULL
12 #define RC_PROTO_BIT_UNKNOWN		BIT_ULL(RC_PROTO_UNKNOWN)
13 #define RC_PROTO_BIT_OTHER		BIT_ULL(RC_PROTO_OTHER)
14 #define RC_PROTO_BIT_RC5		BIT_ULL(RC_PROTO_RC5)
15 #define RC_PROTO_BIT_RC5X_20		BIT_ULL(RC_PROTO_RC5X_20)
16 #define RC_PROTO_BIT_RC5_SZ		BIT_ULL(RC_PROTO_RC5_SZ)
17 #define RC_PROTO_BIT_JVC		BIT_ULL(RC_PROTO_JVC)
18 #define RC_PROTO_BIT_SONY12		BIT_ULL(RC_PROTO_SONY12)
19 #define RC_PROTO_BIT_SONY15		BIT_ULL(RC_PROTO_SONY15)
20 #define RC_PROTO_BIT_SONY20		BIT_ULL(RC_PROTO_SONY20)
21 #define RC_PROTO_BIT_NEC		BIT_ULL(RC_PROTO_NEC)
22 #define RC_PROTO_BIT_NECX		BIT_ULL(RC_PROTO_NECX)
23 #define RC_PROTO_BIT_NEC32		BIT_ULL(RC_PROTO_NEC32)
24 #define RC_PROTO_BIT_SANYO		BIT_ULL(RC_PROTO_SANYO)
25 #define RC_PROTO_BIT_MCIR2_KBD		BIT_ULL(RC_PROTO_MCIR2_KBD)
26 #define RC_PROTO_BIT_MCIR2_MSE		BIT_ULL(RC_PROTO_MCIR2_MSE)
27 #define RC_PROTO_BIT_RC6_0		BIT_ULL(RC_PROTO_RC6_0)
28 #define RC_PROTO_BIT_RC6_6A_20		BIT_ULL(RC_PROTO_RC6_6A_20)
29 #define RC_PROTO_BIT_RC6_6A_24		BIT_ULL(RC_PROTO_RC6_6A_24)
30 #define RC_PROTO_BIT_RC6_6A_32		BIT_ULL(RC_PROTO_RC6_6A_32)
31 #define RC_PROTO_BIT_RC6_MCE		BIT_ULL(RC_PROTO_RC6_MCE)
32 #define RC_PROTO_BIT_SHARP		BIT_ULL(RC_PROTO_SHARP)
33 #define RC_PROTO_BIT_XMP		BIT_ULL(RC_PROTO_XMP)
34 #define RC_PROTO_BIT_CEC		BIT_ULL(RC_PROTO_CEC)
35 #define RC_PROTO_BIT_IMON		BIT_ULL(RC_PROTO_IMON)
36 #define RC_PROTO_BIT_RCMM12		BIT_ULL(RC_PROTO_RCMM12)
37 #define RC_PROTO_BIT_RCMM24		BIT_ULL(RC_PROTO_RCMM24)
38 #define RC_PROTO_BIT_RCMM32		BIT_ULL(RC_PROTO_RCMM32)
39 #define RC_PROTO_BIT_XBOX_DVD		BIT_ULL(RC_PROTO_XBOX_DVD)
40 
41 #define RC_PROTO_BIT_ALL \
42 			(RC_PROTO_BIT_UNKNOWN | RC_PROTO_BIT_OTHER | \
43 			 RC_PROTO_BIT_RC5 | RC_PROTO_BIT_RC5X_20 | \
44 			 RC_PROTO_BIT_RC5_SZ | RC_PROTO_BIT_JVC | \
45 			 RC_PROTO_BIT_SONY12 | RC_PROTO_BIT_SONY15 | \
46 			 RC_PROTO_BIT_SONY20 | RC_PROTO_BIT_NEC | \
47 			 RC_PROTO_BIT_NECX | RC_PROTO_BIT_NEC32 | \
48 			 RC_PROTO_BIT_SANYO | \
49 			 RC_PROTO_BIT_MCIR2_KBD | RC_PROTO_BIT_MCIR2_MSE | \
50 			 RC_PROTO_BIT_RC6_0 | RC_PROTO_BIT_RC6_6A_20 | \
51 			 RC_PROTO_BIT_RC6_6A_24 | RC_PROTO_BIT_RC6_6A_32 | \
52 			 RC_PROTO_BIT_RC6_MCE | RC_PROTO_BIT_SHARP | \
53 			 RC_PROTO_BIT_XMP | RC_PROTO_BIT_CEC | \
54 			 RC_PROTO_BIT_IMON | RC_PROTO_BIT_RCMM12 | \
55 			 RC_PROTO_BIT_RCMM24 | RC_PROTO_BIT_RCMM32 | \
56 			 RC_PROTO_BIT_XBOX_DVD)
57 /* All rc protocols for which we have decoders */
58 #define RC_PROTO_BIT_ALL_IR_DECODER \
59 			(RC_PROTO_BIT_RC5 | RC_PROTO_BIT_RC5X_20 | \
60 			 RC_PROTO_BIT_RC5_SZ | RC_PROTO_BIT_JVC | \
61 			 RC_PROTO_BIT_SONY12 | RC_PROTO_BIT_SONY15 | \
62 			 RC_PROTO_BIT_SONY20 | RC_PROTO_BIT_NEC | \
63 			 RC_PROTO_BIT_NECX | RC_PROTO_BIT_NEC32 | \
64 			 RC_PROTO_BIT_SANYO | RC_PROTO_BIT_MCIR2_KBD | \
65 			 RC_PROTO_BIT_MCIR2_MSE | \
66 			 RC_PROTO_BIT_RC6_0 | RC_PROTO_BIT_RC6_6A_20 | \
67 			 RC_PROTO_BIT_RC6_6A_24 |  RC_PROTO_BIT_RC6_6A_32 | \
68 			 RC_PROTO_BIT_RC6_MCE | RC_PROTO_BIT_SHARP | \
69 			 RC_PROTO_BIT_XMP | RC_PROTO_BIT_IMON | \
70 			 RC_PROTO_BIT_RCMM12 | RC_PROTO_BIT_RCMM24 | \
71 			 RC_PROTO_BIT_RCMM32)
72 
73 #define RC_PROTO_BIT_ALL_IR_ENCODER \
74 			(RC_PROTO_BIT_RC5 | RC_PROTO_BIT_RC5X_20 | \
75 			 RC_PROTO_BIT_RC5_SZ | RC_PROTO_BIT_JVC | \
76 			 RC_PROTO_BIT_SONY12 | RC_PROTO_BIT_SONY15 | \
77 			 RC_PROTO_BIT_SONY20 |  RC_PROTO_BIT_NEC | \
78 			 RC_PROTO_BIT_NECX | RC_PROTO_BIT_NEC32 | \
79 			 RC_PROTO_BIT_SANYO | RC_PROTO_BIT_MCIR2_KBD | \
80 			 RC_PROTO_BIT_MCIR2_MSE | \
81 			 RC_PROTO_BIT_RC6_0 | RC_PROTO_BIT_RC6_6A_20 | \
82 			 RC_PROTO_BIT_RC6_6A_24 | \
83 			 RC_PROTO_BIT_RC6_6A_32 | RC_PROTO_BIT_RC6_MCE | \
84 			 RC_PROTO_BIT_SHARP | RC_PROTO_BIT_IMON | \
85 			 RC_PROTO_BIT_RCMM12 | RC_PROTO_BIT_RCMM24 | \
86 			 RC_PROTO_BIT_RCMM32)
87 
88 #define RC_SCANCODE_UNKNOWN(x)			(x)
89 #define RC_SCANCODE_OTHER(x)			(x)
90 #define RC_SCANCODE_NEC(addr, cmd)		(((addr) << 8) | (cmd))
91 #define RC_SCANCODE_NECX(addr, cmd)		(((addr) << 8) | (cmd))
92 #define RC_SCANCODE_NEC32(data)			((data) & 0xffffffff)
93 #define RC_SCANCODE_RC5(sys, cmd)		(((sys) << 8) | (cmd))
94 #define RC_SCANCODE_RC5_SZ(sys, cmd)		(((sys) << 8) | (cmd))
95 #define RC_SCANCODE_RC6_0(sys, cmd)		(((sys) << 8) | (cmd))
96 #define RC_SCANCODE_RC6_6A(vendor, sys, cmd)	(((vendor) << 16) | ((sys) << 8) | (cmd))
97 
98 /**
99  * struct rc_map_table - represents a scancode/keycode pair
100  *
101  * @scancode: scan code (u32)
102  * @keycode: Linux input keycode
103  */
104 struct rc_map_table {
105 	u32	scancode;
106 	u32	keycode;
107 };
108 
109 /**
110  * struct rc_map - represents a keycode map table
111  *
112  * @scan: pointer to struct &rc_map_table
113  * @size: Max number of entries
114  * @len: Number of entries that are in use
115  * @alloc: size of \*scan, in bytes
116  * @rc_proto: type of the remote controller protocol, as defined at
117  *	     enum &rc_proto
118  * @name: name of the key map table
119  * @lock: lock to protect access to this structure
120  */
121 struct rc_map {
122 	struct rc_map_table	*scan;
123 	unsigned int		size;
124 	unsigned int		len;
125 	unsigned int		alloc;
126 	enum rc_proto		rc_proto;
127 	const char		*name;
128 	spinlock_t		lock;
129 };
130 
131 /**
132  * struct rc_map_list - list of the registered &rc_map maps
133  *
134  * @list: pointer to struct &list_head
135  * @map: pointer to struct &rc_map
136  */
137 struct rc_map_list {
138 	struct list_head	 list;
139 	struct rc_map map;
140 };
141 
142 /* Routines from rc-map.c */
143 
144 /**
145  * rc_map_register() - Registers a Remote Controller scancode map
146  *
147  * @map:	pointer to struct rc_map_list
148  */
149 int rc_map_register(struct rc_map_list *map);
150 
151 /**
152  * rc_map_unregister() - Unregisters a Remote Controller scancode map
153  *
154  * @map:	pointer to struct rc_map_list
155  */
156 void rc_map_unregister(struct rc_map_list *map);
157 
158 /**
159  * rc_map_get - gets an RC map from its name
160  * @name: name of the RC scancode map
161  */
162 struct rc_map *rc_map_get(const char *name);
163 
164 /* Names of the several keytables defined in-kernel */
165 
166 #define RC_MAP_ADSTECH_DVB_T_PCI         "rc-adstech-dvb-t-pci"
167 #define RC_MAP_ALINK_DTU_M               "rc-alink-dtu-m"
168 #define RC_MAP_ANYSEE                    "rc-anysee"
169 #define RC_MAP_APAC_VIEWCOMP             "rc-apac-viewcomp"
170 #define RC_MAP_ASTROMETA_T2HYBRID        "rc-astrometa-t2hybrid"
171 #define RC_MAP_ASUS_PC39                 "rc-asus-pc39"
172 #define RC_MAP_ASUS_PS3_100              "rc-asus-ps3-100"
173 #define RC_MAP_ATI_TV_WONDER_HD_600      "rc-ati-tv-wonder-hd-600"
174 #define RC_MAP_ATI_X10                   "rc-ati-x10"
175 #define RC_MAP_AVERMEDIA_A16D            "rc-avermedia-a16d"
176 #define RC_MAP_AVERMEDIA_CARDBUS         "rc-avermedia-cardbus"
177 #define RC_MAP_AVERMEDIA_DVBT            "rc-avermedia-dvbt"
178 #define RC_MAP_AVERMEDIA_M135A           "rc-avermedia-m135a"
179 #define RC_MAP_AVERMEDIA_M733A_RM_K6     "rc-avermedia-m733a-rm-k6"
180 #define RC_MAP_AVERMEDIA_RM_KS           "rc-avermedia-rm-ks"
181 #define RC_MAP_AVERMEDIA                 "rc-avermedia"
182 #define RC_MAP_AVERTV_303                "rc-avertv-303"
183 #define RC_MAP_AZUREWAVE_AD_TU700        "rc-azurewave-ad-tu700"
184 #define RC_MAP_BEHOLD_COLUMBUS           "rc-behold-columbus"
185 #define RC_MAP_BEHOLD                    "rc-behold"
186 #define RC_MAP_BUDGET_CI_OLD             "rc-budget-ci-old"
187 #define RC_MAP_CEC                       "rc-cec"
188 #define RC_MAP_CINERGY_1400              "rc-cinergy-1400"
189 #define RC_MAP_CINERGY                   "rc-cinergy"
190 #define RC_MAP_D680_DMB                  "rc-d680-dmb"
191 #define RC_MAP_DELOCK_61959              "rc-delock-61959"
192 #define RC_MAP_DIB0700_NEC_TABLE         "rc-dib0700-nec"
193 #define RC_MAP_DIB0700_RC5_TABLE         "rc-dib0700-rc5"
194 #define RC_MAP_DIGITALNOW_TINYTWIN       "rc-digitalnow-tinytwin"
195 #define RC_MAP_DIGITTRADE                "rc-digittrade"
196 #define RC_MAP_DM1105_NEC                "rc-dm1105-nec"
197 #define RC_MAP_DNTV_LIVE_DVBT_PRO        "rc-dntv-live-dvbt-pro"
198 #define RC_MAP_DNTV_LIVE_DVB_T           "rc-dntv-live-dvb-t"
199 #define RC_MAP_DTT200U                   "rc-dtt200u"
200 #define RC_MAP_DVBSKY                    "rc-dvbsky"
201 #define RC_MAP_DVICO_MCE		 "rc-dvico-mce"
202 #define RC_MAP_DVICO_PORTABLE		 "rc-dvico-portable"
203 #define RC_MAP_EMPTY                     "rc-empty"
204 #define RC_MAP_EM_TERRATEC               "rc-em-terratec"
205 #define RC_MAP_ENCORE_ENLTV2             "rc-encore-enltv2"
206 #define RC_MAP_ENCORE_ENLTV_FM53         "rc-encore-enltv-fm53"
207 #define RC_MAP_ENCORE_ENLTV              "rc-encore-enltv"
208 #define RC_MAP_EVGA_INDTUBE              "rc-evga-indtube"
209 #define RC_MAP_EZTV                      "rc-eztv"
210 #define RC_MAP_FLYDVB                    "rc-flydvb"
211 #define RC_MAP_FLYVIDEO                  "rc-flyvideo"
212 #define RC_MAP_FUSIONHDTV_MCE            "rc-fusionhdtv-mce"
213 #define RC_MAP_GADMEI_RM008Z             "rc-gadmei-rm008z"
214 #define RC_MAP_GEEKBOX                   "rc-geekbox"
215 #define RC_MAP_GENIUS_TVGO_A11MCE        "rc-genius-tvgo-a11mce"
216 #define RC_MAP_GOTVIEW7135               "rc-gotview7135"
217 #define RC_MAP_HAUPPAUGE_NEW             "rc-hauppauge"
218 #define RC_MAP_HISI_POPLAR               "rc-hisi-poplar"
219 #define RC_MAP_HISI_TV_DEMO              "rc-hisi-tv-demo"
220 #define RC_MAP_IMON_MCE                  "rc-imon-mce"
221 #define RC_MAP_IMON_PAD                  "rc-imon-pad"
222 #define RC_MAP_IMON_RSC                  "rc-imon-rsc"
223 #define RC_MAP_IODATA_BCTV7E             "rc-iodata-bctv7e"
224 #define RC_MAP_IT913X_V1                 "rc-it913x-v1"
225 #define RC_MAP_IT913X_V2                 "rc-it913x-v2"
226 #define RC_MAP_KAIOMY                    "rc-kaiomy"
227 #define RC_MAP_KWORLD_315U               "rc-kworld-315u"
228 #define RC_MAP_KWORLD_PC150U             "rc-kworld-pc150u"
229 #define RC_MAP_KWORLD_PLUS_TV_ANALOG     "rc-kworld-plus-tv-analog"
230 #define RC_MAP_LEADTEK_Y04G0051          "rc-leadtek-y04g0051"
231 #define RC_MAP_LME2510                   "rc-lme2510"
232 #define RC_MAP_MANLI                     "rc-manli"
233 #define RC_MAP_MEDION_X10                "rc-medion-x10"
234 #define RC_MAP_MEDION_X10_DIGITAINER     "rc-medion-x10-digitainer"
235 #define RC_MAP_MEDION_X10_OR2X           "rc-medion-x10-or2x"
236 #define RC_MAP_MSI_DIGIVOX_II            "rc-msi-digivox-ii"
237 #define RC_MAP_MSI_DIGIVOX_III           "rc-msi-digivox-iii"
238 #define RC_MAP_MSI_TVANYWHERE_PLUS       "rc-msi-tvanywhere-plus"
239 #define RC_MAP_MSI_TVANYWHERE            "rc-msi-tvanywhere"
240 #define RC_MAP_NEBULA                    "rc-nebula"
241 #define RC_MAP_NEC_TERRATEC_CINERGY_XS   "rc-nec-terratec-cinergy-xs"
242 #define RC_MAP_NORWOOD                   "rc-norwood"
243 #define RC_MAP_NPGTECH                   "rc-npgtech"
244 #define RC_MAP_PCTV_SEDNA                "rc-pctv-sedna"
245 #define RC_MAP_PINNACLE_COLOR            "rc-pinnacle-color"
246 #define RC_MAP_PINNACLE_GREY             "rc-pinnacle-grey"
247 #define RC_MAP_PINNACLE_PCTV_HD          "rc-pinnacle-pctv-hd"
248 #define RC_MAP_PIXELVIEW_NEW             "rc-pixelview-new"
249 #define RC_MAP_PIXELVIEW                 "rc-pixelview"
250 #define RC_MAP_PIXELVIEW_002T		 "rc-pixelview-002t"
251 #define RC_MAP_PIXELVIEW_MK12            "rc-pixelview-mk12"
252 #define RC_MAP_POWERCOLOR_REAL_ANGEL     "rc-powercolor-real-angel"
253 #define RC_MAP_PROTEUS_2309              "rc-proteus-2309"
254 #define RC_MAP_PURPLETV                  "rc-purpletv"
255 #define RC_MAP_PV951                     "rc-pv951"
256 #define RC_MAP_HAUPPAUGE                 "rc-hauppauge"
257 #define RC_MAP_RC5_TV                    "rc-rc5-tv"
258 #define RC_MAP_RC6_MCE                   "rc-rc6-mce"
259 #define RC_MAP_REAL_AUDIO_220_32_KEYS    "rc-real-audio-220-32-keys"
260 #define RC_MAP_REDDO                     "rc-reddo"
261 #define RC_MAP_SNAPSTREAM_FIREFLY        "rc-snapstream-firefly"
262 #define RC_MAP_STREAMZAP                 "rc-streamzap"
263 #define RC_MAP_TANGO                     "rc-tango"
264 #define RC_MAP_TBS_NEC                   "rc-tbs-nec"
265 #define RC_MAP_TECHNISAT_TS35            "rc-technisat-ts35"
266 #define RC_MAP_TECHNISAT_USB2            "rc-technisat-usb2"
267 #define RC_MAP_TERRATEC_CINERGY_C_PCI    "rc-terratec-cinergy-c-pci"
268 #define RC_MAP_TERRATEC_CINERGY_S2_HD    "rc-terratec-cinergy-s2-hd"
269 #define RC_MAP_TERRATEC_CINERGY_XS       "rc-terratec-cinergy-xs"
270 #define RC_MAP_TERRATEC_SLIM             "rc-terratec-slim"
271 #define RC_MAP_TERRATEC_SLIM_2           "rc-terratec-slim-2"
272 #define RC_MAP_TEVII_NEC                 "rc-tevii-nec"
273 #define RC_MAP_TIVO                      "rc-tivo"
274 #define RC_MAP_TOTAL_MEDIA_IN_HAND       "rc-total-media-in-hand"
275 #define RC_MAP_TOTAL_MEDIA_IN_HAND_02    "rc-total-media-in-hand-02"
276 #define RC_MAP_TREKSTOR                  "rc-trekstor"
277 #define RC_MAP_TT_1500                   "rc-tt-1500"
278 #define RC_MAP_TWINHAN_DTV_CAB_CI        "rc-twinhan-dtv-cab-ci"
279 #define RC_MAP_TWINHAN_VP1027_DVBS       "rc-twinhan1027"
280 #define RC_MAP_VIDEOMATE_K100            "rc-videomate-k100"
281 #define RC_MAP_VIDEOMATE_S350            "rc-videomate-s350"
282 #define RC_MAP_VIDEOMATE_TV_PVR          "rc-videomate-tv-pvr"
283 #define RC_MAP_WINFAST                   "rc-winfast"
284 #define RC_MAP_WINFAST_USBII_DELUXE      "rc-winfast-usbii-deluxe"
285 #define RC_MAP_SU3000                    "rc-su3000"
286 #define RC_MAP_XBOX_DVD                  "rc-xbox-dvd"
287 #define RC_MAP_ZX_IRDEC                  "rc-zx-irdec"
288 
289 /*
290  * Please, do not just append newer Remote Controller names at the end.
291  * The names should be ordered in alphabetical order
292  */
293