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