include/media/rc-map.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  * rc-map.h - define RC map names used by RC drivers
0004  *
0005  * Copyright (c) 2010 by Mauro Carvalho Chehab
0006  */
0007
0008 #ifndef _MEDIA_RC_MAP_H
0009 #define _MEDIA_RC_MAP_H
0010
0011 #include <linux/input.h>
0012 #include <uapi/linux/lirc.h>
0013
0014 #define RC_PROTO_BIT_NONE       0ULL
0015 #define RC_PROTO_BIT_UNKNOWN        BIT_ULL(RC_PROTO_UNKNOWN)
0016 #define RC_PROTO_BIT_OTHER      BIT_ULL(RC_PROTO_OTHER)
0017 #define RC_PROTO_BIT_RC5        BIT_ULL(RC_PROTO_RC5)
0018 #define RC_PROTO_BIT_RC5X_20        BIT_ULL(RC_PROTO_RC5X_20)
0019 #define RC_PROTO_BIT_RC5_SZ     BIT_ULL(RC_PROTO_RC5_SZ)
0020 #define RC_PROTO_BIT_JVC        BIT_ULL(RC_PROTO_JVC)
0021 #define RC_PROTO_BIT_SONY12     BIT_ULL(RC_PROTO_SONY12)
0022 #define RC_PROTO_BIT_SONY15     BIT_ULL(RC_PROTO_SONY15)
0023 #define RC_PROTO_BIT_SONY20     BIT_ULL(RC_PROTO_SONY20)
0024 #define RC_PROTO_BIT_NEC        BIT_ULL(RC_PROTO_NEC)
0025 #define RC_PROTO_BIT_NECX       BIT_ULL(RC_PROTO_NECX)
0026 #define RC_PROTO_BIT_NEC32      BIT_ULL(RC_PROTO_NEC32)
0027 #define RC_PROTO_BIT_SANYO      BIT_ULL(RC_PROTO_SANYO)
0028 #define RC_PROTO_BIT_MCIR2_KBD      BIT_ULL(RC_PROTO_MCIR2_KBD)
0029 #define RC_PROTO_BIT_MCIR2_MSE      BIT_ULL(RC_PROTO_MCIR2_MSE)
0030 #define RC_PROTO_BIT_RC6_0      BIT_ULL(RC_PROTO_RC6_0)
0031 #define RC_PROTO_BIT_RC6_6A_20      BIT_ULL(RC_PROTO_RC6_6A_20)
0032 #define RC_PROTO_BIT_RC6_6A_24      BIT_ULL(RC_PROTO_RC6_6A_24)
0033 #define RC_PROTO_BIT_RC6_6A_32      BIT_ULL(RC_PROTO_RC6_6A_32)
0034 #define RC_PROTO_BIT_RC6_MCE        BIT_ULL(RC_PROTO_RC6_MCE)
0035 #define RC_PROTO_BIT_SHARP      BIT_ULL(RC_PROTO_SHARP)
0036 #define RC_PROTO_BIT_XMP        BIT_ULL(RC_PROTO_XMP)
0037 #define RC_PROTO_BIT_CEC        BIT_ULL(RC_PROTO_CEC)
0038 #define RC_PROTO_BIT_IMON       BIT_ULL(RC_PROTO_IMON)
0039 #define RC_PROTO_BIT_RCMM12     BIT_ULL(RC_PROTO_RCMM12)
0040 #define RC_PROTO_BIT_RCMM24     BIT_ULL(RC_PROTO_RCMM24)
0041 #define RC_PROTO_BIT_RCMM32     BIT_ULL(RC_PROTO_RCMM32)
0042 #define RC_PROTO_BIT_XBOX_DVD       BIT_ULL(RC_PROTO_XBOX_DVD)
0043
0044 #if IS_ENABLED(CONFIG_IR_RC5_DECODER)
0045 #define __RC_PROTO_RC5_CODEC \
0046     (RC_PROTO_BIT_RC5 | RC_PROTO_BIT_RC5X_20 |  RC_PROTO_BIT_RC5_SZ)
0047 #else
0048 #define __RC_PROTO_RC5_CODEC 0
0049 #endif
0050
0051 #if IS_ENABLED(CONFIG_IR_JVC_DECODER)
0052 #define __RC_PROTO_JVC_CODEC RC_PROTO_BIT_JVC
0053 #else
0054 #define __RC_PROTO_JVC_CODEC 0
0055 #endif
0056 #if IS_ENABLED(CONFIG_IR_SONY_DECODER)
0057 #define __RC_PROTO_SONY_CODEC \
0058     (RC_PROTO_BIT_SONY12 | RC_PROTO_BIT_SONY15 |  RC_PROTO_BIT_SONY20)
0059 #else
0060 #define __RC_PROTO_SONY_CODEC 0
0061 #endif
0062 #if IS_ENABLED(CONFIG_IR_NEC_DECODER)
0063 #define __RC_PROTO_NEC_CODEC \
0064     (RC_PROTO_BIT_NEC | RC_PROTO_BIT_NECX | RC_PROTO_BIT_NEC32)
0065 #else
0066 #define __RC_PROTO_NEC_CODEC 0
0067 #endif
0068 #if IS_ENABLED(CONFIG_IR_SANYO_DECODER)
0069 #define __RC_PROTO_SANYO_CODEC RC_PROTO_BIT_SANYO
0070 #else
0071 #define __RC_PROTO_SANYO_CODEC 0
0072 #endif
0073 #if IS_ENABLED(CONFIG_IR_MCE_KBD_DECODER)
0074 #define __RC_PROTO_MCE_KBD_CODEC \
0075     (RC_PROTO_BIT_MCIR2_KBD |  RC_PROTO_BIT_MCIR2_MSE)
0076 #else
0077 #define __RC_PROTO_MCE_KBD_CODEC 0
0078 #endif
0079 #if IS_ENABLED(CONFIG_IR_RC6_DECODER)
0080 #define __RC_PROTO_RC6_CODEC \
0081     (RC_PROTO_BIT_RC6_0 | RC_PROTO_BIT_RC6_6A_20 | \
0082      RC_PROTO_BIT_RC6_6A_24 |  RC_PROTO_BIT_RC6_6A_32 | \
0083      RC_PROTO_BIT_RC6_MCE)
0084 #else
0085 #define __RC_PROTO_RC6_CODEC 0
0086 #endif
0087 #if IS_ENABLED(CONFIG_IR_SHARP_DECODER)
0088 #define __RC_PROTO_SHARP_CODEC RC_PROTO_BIT_SHARP
0089 #else
0090 #define __RC_PROTO_SHARP_CODEC 0
0091 #endif
0092 #if IS_ENABLED(CONFIG_IR_XMP_DECODER)
0093 #define __RC_PROTO_XMP_CODEC RC_PROTO_BIT_XMP
0094 #else
0095 #define __RC_PROTO_XMP_CODEC 0
0096 #endif
0097 #if IS_ENABLED(CONFIG_IR_IMON_DECODER)
0098 #define __RC_PROTO_IMON_CODEC RC_PROTO_BIT_IMON
0099 #else
0100 #define __RC_PROTO_IMON_CODEC 0
0101 #endif
0102 #if IS_ENABLED(CONFIG_IR_RCMM_DECODER)
0103 #define __RC_PROTO_RCMM_CODEC \
0104     (RC_PROTO_BIT_RCMM12 | RC_PROTO_BIT_RCMM24 | RC_PROTO_BIT_RCMM32)
0105 #else
0106 #define __RC_PROTO_RCMM_CODEC 0
0107 #endif
0108
0109 /* All kernel-based codecs have encoders and decoders */
0110 #define RC_PROTO_BIT_ALL_IR_DECODER \
0111     (__RC_PROTO_RC5_CODEC | __RC_PROTO_JVC_CODEC | __RC_PROTO_SONY_CODEC | \
0112      __RC_PROTO_NEC_CODEC | __RC_PROTO_SANYO_CODEC | \
0113      __RC_PROTO_MCE_KBD_CODEC | __RC_PROTO_RC6_CODEC | \
0114      __RC_PROTO_SHARP_CODEC | __RC_PROTO_XMP_CODEC | \
0115      __RC_PROTO_IMON_CODEC | __RC_PROTO_RCMM_CODEC)
0116
0117 #define RC_PROTO_BIT_ALL_IR_ENCODER \
0118     (__RC_PROTO_RC5_CODEC | __RC_PROTO_JVC_CODEC | __RC_PROTO_SONY_CODEC | \
0119      __RC_PROTO_NEC_CODEC | __RC_PROTO_SANYO_CODEC | \
0120      __RC_PROTO_MCE_KBD_CODEC | __RC_PROTO_RC6_CODEC | \
0121      __RC_PROTO_SHARP_CODEC | __RC_PROTO_XMP_CODEC | \
0122      __RC_PROTO_IMON_CODEC | __RC_PROTO_RCMM_CODEC)
0123
0124 #define RC_SCANCODE_UNKNOWN(x)          (x)
0125 #define RC_SCANCODE_OTHER(x)            (x)
0126 #define RC_SCANCODE_NEC(addr, cmd)      (((addr) << 8) | (cmd))
0127 #define RC_SCANCODE_NECX(addr, cmd)     (((addr) << 8) | (cmd))
0128 #define RC_SCANCODE_NEC32(data)         ((data) & 0xffffffff)
0129 #define RC_SCANCODE_RC5(sys, cmd)       (((sys) << 8) | (cmd))
0130 #define RC_SCANCODE_RC5_SZ(sys, cmd)        (((sys) << 8) | (cmd))
0131 #define RC_SCANCODE_RC6_0(sys, cmd)     (((sys) << 8) | (cmd))
0132 #define RC_SCANCODE_RC6_6A(vendor, sys, cmd)    (((vendor) << 16) | ((sys) << 8) | (cmd))
0133
0134 /**
0135  * struct rc_map_table - represents a scancode/keycode pair
0136  *
0137  * @scancode: scan code (u64)
0138  * @keycode: Linux input keycode
0139  */
0140 struct rc_map_table {
0141     u64 scancode;
0142     u32 keycode;
0143 };
0144
0145 /**
0146  * struct rc_map - represents a keycode map table
0147  *
0148  * @scan: pointer to struct &rc_map_table
0149  * @size: Max number of entries
0150  * @len: Number of entries that are in use
0151  * @alloc: size of \*scan, in bytes
0152  * @rc_proto: type of the remote controller protocol, as defined at
0153  *       enum &rc_proto
0154  * @name: name of the key map table
0155  * @lock: lock to protect access to this structure
0156  */
0157 struct rc_map {
0158     struct rc_map_table *scan;
0159     unsigned int        size;
0160     unsigned int        len;
0161     unsigned int        alloc;
0162     enum rc_proto       rc_proto;
0163     const char      *name;
0164     spinlock_t      lock;
0165 };
0166
0167 /**
0168  * struct rc_map_list - list of the registered &rc_map maps
0169  *
0170  * @list: pointer to struct &list_head
0171  * @map: pointer to struct &rc_map
0172  */
0173 struct rc_map_list {
0174     struct list_head     list;
0175     struct rc_map map;
0176 };
0177
0178 #ifdef CONFIG_MEDIA_CEC_RC
0179 /*
0180  * rc_map_list from rc-cec.c
0181  */
0182 extern struct rc_map_list cec_map;
0183 #endif
0184
0185 /* Routines from rc-map.c */
0186
0187 /**
0188  * rc_map_register() - Registers a Remote Controller scancode map
0189  *
0190  * @map:    pointer to struct rc_map_list
0191  */
0192 int rc_map_register(struct rc_map_list *map);
0193
0194 /**
0195  * rc_map_unregister() - Unregisters a Remote Controller scancode map
0196  *
0197  * @map:    pointer to struct rc_map_list
0198  */
0199 void rc_map_unregister(struct rc_map_list *map);
0200
0201 /**
0202  * rc_map_get - gets an RC map from its name
0203  * @name: name of the RC scancode map
0204  */
0205 struct rc_map *rc_map_get(const char *name);
0206
0207 /* Names of the several keytables defined in-kernel */
0208
0209 #define RC_MAP_ADSTECH_DVB_T_PCI         "rc-adstech-dvb-t-pci"
0210 #define RC_MAP_ALINK_DTU_M               "rc-alink-dtu-m"
0211 #define RC_MAP_ANYSEE                    "rc-anysee"
0212 #define RC_MAP_APAC_VIEWCOMP             "rc-apac-viewcomp"
0213 #define RC_MAP_ASTROMETA_T2HYBRID        "rc-astrometa-t2hybrid"
0214 #define RC_MAP_ASUS_PC39                 "rc-asus-pc39"
0215 #define RC_MAP_ASUS_PS3_100              "rc-asus-ps3-100"
0216 #define RC_MAP_ATI_TV_WONDER_HD_600      "rc-ati-tv-wonder-hd-600"
0217 #define RC_MAP_ATI_X10                   "rc-ati-x10"
0218 #define RC_MAP_AVERMEDIA                 "rc-avermedia"
0219 #define RC_MAP_AVERMEDIA_A16D            "rc-avermedia-a16d"
0220 #define RC_MAP_AVERMEDIA_CARDBUS         "rc-avermedia-cardbus"
0221 #define RC_MAP_AVERMEDIA_DVBT            "rc-avermedia-dvbt"
0222 #define RC_MAP_AVERMEDIA_M135A           "rc-avermedia-m135a"
0223 #define RC_MAP_AVERMEDIA_M733A_RM_K6     "rc-avermedia-m733a-rm-k6"
0224 #define RC_MAP_AVERMEDIA_RM_KS           "rc-avermedia-rm-ks"
0225 #define RC_MAP_AVERTV_303                "rc-avertv-303"
0226 #define RC_MAP_AZUREWAVE_AD_TU700        "rc-azurewave-ad-tu700"
0227 #define RC_MAP_BEELINK_GS1               "rc-beelink-gs1"
0228 #define RC_MAP_BEHOLD                    "rc-behold"
0229 #define RC_MAP_BEHOLD_COLUMBUS           "rc-behold-columbus"
0230 #define RC_MAP_BUDGET_CI_OLD             "rc-budget-ci-old"
0231 #define RC_MAP_CEC                       "rc-cec"
0232 #define RC_MAP_CINERGY                   "rc-cinergy"
0233 #define RC_MAP_CINERGY_1400              "rc-cinergy-1400"
0234 #define RC_MAP_CT_90405                  "rc-ct-90405"
0235 #define RC_MAP_D680_DMB                  "rc-d680-dmb"
0236 #define RC_MAP_DELOCK_61959              "rc-delock-61959"
0237 #define RC_MAP_DIB0700_NEC_TABLE         "rc-dib0700-nec"
0238 #define RC_MAP_DIB0700_RC5_TABLE         "rc-dib0700-rc5"
0239 #define RC_MAP_DIGITALNOW_TINYTWIN       "rc-digitalnow-tinytwin"
0240 #define RC_MAP_DIGITTRADE                "rc-digittrade"
0241 #define RC_MAP_DM1105_NEC                "rc-dm1105-nec"
0242 #define RC_MAP_DNTV_LIVE_DVB_T           "rc-dntv-live-dvb-t"
0243 #define RC_MAP_DNTV_LIVE_DVBT_PRO        "rc-dntv-live-dvbt-pro"
0244 #define RC_MAP_DTT200U                   "rc-dtt200u"
0245 #define RC_MAP_DVBSKY                    "rc-dvbsky"
0246 #define RC_MAP_DVICO_MCE         "rc-dvico-mce"
0247 #define RC_MAP_DVICO_PORTABLE        "rc-dvico-portable"
0248 #define RC_MAP_EMPTY                     "rc-empty"
0249 #define RC_MAP_EM_TERRATEC               "rc-em-terratec"
0250 #define RC_MAP_ENCORE_ENLTV              "rc-encore-enltv"
0251 #define RC_MAP_ENCORE_ENLTV2             "rc-encore-enltv2"
0252 #define RC_MAP_ENCORE_ENLTV_FM53         "rc-encore-enltv-fm53"
0253 #define RC_MAP_EVGA_INDTUBE              "rc-evga-indtube"
0254 #define RC_MAP_EZTV                      "rc-eztv"
0255 #define RC_MAP_FLYDVB                    "rc-flydvb"
0256 #define RC_MAP_FLYVIDEO                  "rc-flyvideo"
0257 #define RC_MAP_FUSIONHDTV_MCE            "rc-fusionhdtv-mce"
0258 #define RC_MAP_GADMEI_RM008Z             "rc-gadmei-rm008z"
0259 #define RC_MAP_GEEKBOX                   "rc-geekbox"
0260 #define RC_MAP_GENIUS_TVGO_A11MCE        "rc-genius-tvgo-a11mce"
0261 #define RC_MAP_GOTVIEW7135               "rc-gotview7135"
0262 #define RC_MAP_HAUPPAUGE                 "rc-hauppauge"
0263 #define RC_MAP_HAUPPAUGE_NEW             "rc-hauppauge"
0264 #define RC_MAP_HISI_POPLAR               "rc-hisi-poplar"
0265 #define RC_MAP_HISI_TV_DEMO              "rc-hisi-tv-demo"
0266 #define RC_MAP_IMON_MCE                  "rc-imon-mce"
0267 #define RC_MAP_IMON_PAD                  "rc-imon-pad"
0268 #define RC_MAP_IMON_RSC                  "rc-imon-rsc"
0269 #define RC_MAP_IODATA_BCTV7E             "rc-iodata-bctv7e"
0270 #define RC_MAP_IT913X_V1                 "rc-it913x-v1"
0271 #define RC_MAP_IT913X_V2                 "rc-it913x-v2"
0272 #define RC_MAP_KAIOMY                    "rc-kaiomy"
0273 #define RC_MAP_KHADAS                    "rc-khadas"
0274 #define RC_MAP_KHAMSIN                   "rc-khamsin"
0275 #define RC_MAP_KWORLD_315U               "rc-kworld-315u"
0276 #define RC_MAP_KWORLD_PC150U             "rc-kworld-pc150u"
0277 #define RC_MAP_KWORLD_PLUS_TV_ANALOG     "rc-kworld-plus-tv-analog"
0278 #define RC_MAP_LEADTEK_Y04G0051          "rc-leadtek-y04g0051"
0279 #define RC_MAP_LME2510                   "rc-lme2510"
0280 #define RC_MAP_MANLI                     "rc-manli"
0281 #define RC_MAP_MECOOL_KII_PRO            "rc-mecool-kii-pro"
0282 #define RC_MAP_MECOOL_KIII_PRO           "rc-mecool-kiii-pro"
0283 #define RC_MAP_MEDION_X10                "rc-medion-x10"
0284 #define RC_MAP_MEDION_X10_DIGITAINER     "rc-medion-x10-digitainer"
0285 #define RC_MAP_MEDION_X10_OR2X           "rc-medion-x10-or2x"
0286 #define RC_MAP_MINIX_NEO                 "rc-minix-neo"
0287 #define RC_MAP_MSI_DIGIVOX_II            "rc-msi-digivox-ii"
0288 #define RC_MAP_MSI_DIGIVOX_III           "rc-msi-digivox-iii"
0289 #define RC_MAP_MSI_TVANYWHERE            "rc-msi-tvanywhere"
0290 #define RC_MAP_MSI_TVANYWHERE_PLUS       "rc-msi-tvanywhere-plus"
0291 #define RC_MAP_NEBULA                    "rc-nebula"
0292 #define RC_MAP_NEC_TERRATEC_CINERGY_XS   "rc-nec-terratec-cinergy-xs"
0293 #define RC_MAP_NORWOOD                   "rc-norwood"
0294 #define RC_MAP_NPGTECH                   "rc-npgtech"
0295 #define RC_MAP_ODROID                    "rc-odroid"
0296 #define RC_MAP_PCTV_SEDNA                "rc-pctv-sedna"
0297 #define RC_MAP_PINE64                    "rc-pine64"
0298 #define RC_MAP_PINNACLE_COLOR            "rc-pinnacle-color"
0299 #define RC_MAP_PINNACLE_GREY             "rc-pinnacle-grey"
0300 #define RC_MAP_PINNACLE_PCTV_HD          "rc-pinnacle-pctv-hd"
0301 #define RC_MAP_PIXELVIEW                 "rc-pixelview"
0302 #define RC_MAP_PIXELVIEW_002T            "rc-pixelview-002t"
0303 #define RC_MAP_PIXELVIEW_MK12            "rc-pixelview-mk12"
0304 #define RC_MAP_PIXELVIEW_NEW             "rc-pixelview-new"
0305 #define RC_MAP_POWERCOLOR_REAL_ANGEL     "rc-powercolor-real-angel"
0306 #define RC_MAP_PROTEUS_2309              "rc-proteus-2309"
0307 #define RC_MAP_PURPLETV                  "rc-purpletv"
0308 #define RC_MAP_PV951                     "rc-pv951"
0309 #define RC_MAP_RC5_TV                    "rc-rc5-tv"
0310 #define RC_MAP_RC6_MCE                   "rc-rc6-mce"
0311 #define RC_MAP_REAL_AUDIO_220_32_KEYS    "rc-real-audio-220-32-keys"
0312 #define RC_MAP_REDDO                     "rc-reddo"
0313 #define RC_MAP_SNAPSTREAM_FIREFLY        "rc-snapstream-firefly"
0314 #define RC_MAP_STREAMZAP                 "rc-streamzap"
0315 #define RC_MAP_SU3000                    "rc-su3000"
0316 #define RC_MAP_TANIX_TX3MINI             "rc-tanix-tx3mini"
0317 #define RC_MAP_TANIX_TX5MAX              "rc-tanix-tx5max"
0318 #define RC_MAP_TBS_NEC                   "rc-tbs-nec"
0319 #define RC_MAP_TECHNISAT_TS35            "rc-technisat-ts35"
0320 #define RC_MAP_TECHNISAT_USB2            "rc-technisat-usb2"
0321 #define RC_MAP_TERRATEC_CINERGY_C_PCI    "rc-terratec-cinergy-c-pci"
0322 #define RC_MAP_TERRATEC_CINERGY_S2_HD    "rc-terratec-cinergy-s2-hd"
0323 #define RC_MAP_TERRATEC_CINERGY_XS       "rc-terratec-cinergy-xs"
0324 #define RC_MAP_TERRATEC_SLIM             "rc-terratec-slim"
0325 #define RC_MAP_TERRATEC_SLIM_2           "rc-terratec-slim-2"
0326 #define RC_MAP_TEVII_NEC                 "rc-tevii-nec"
0327 #define RC_MAP_TIVO                      "rc-tivo"
0328 #define RC_MAP_TOTAL_MEDIA_IN_HAND       "rc-total-media-in-hand"
0329 #define RC_MAP_TOTAL_MEDIA_IN_HAND_02    "rc-total-media-in-hand-02"
0330 #define RC_MAP_TREKSTOR                  "rc-trekstor"
0331 #define RC_MAP_TT_1500                   "rc-tt-1500"
0332 #define RC_MAP_TWINHAN_DTV_CAB_CI        "rc-twinhan-dtv-cab-ci"
0333 #define RC_MAP_TWINHAN_VP1027_DVBS       "rc-twinhan1027"
0334 #define RC_MAP_VEGA_S9X                  "rc-vega-s9x"
0335 #define RC_MAP_VIDEOMATE_K100            "rc-videomate-k100"
0336 #define RC_MAP_VIDEOMATE_S350            "rc-videomate-s350"
0337 #define RC_MAP_VIDEOMATE_TV_PVR          "rc-videomate-tv-pvr"
0338 #define RC_MAP_KII_PRO                   "rc-videostrong-kii-pro"
0339 #define RC_MAP_WETEK_HUB                 "rc-wetek-hub"
0340 #define RC_MAP_WETEK_PLAY2               "rc-wetek-play2"
0341 #define RC_MAP_WINFAST                   "rc-winfast"
0342 #define RC_MAP_WINFAST_USBII_DELUXE      "rc-winfast-usbii-deluxe"
0343 #define RC_MAP_X96MAX                    "rc-x96max"
0344 #define RC_MAP_XBOX_360                  "rc-xbox-360"
0345 #define RC_MAP_XBOX_DVD                  "rc-xbox-dvd"
0346 #define RC_MAP_ZX_IRDEC                  "rc-zx-irdec"
0347
0348 /*
0349  * Please, do not just append newer Remote Controller names at the end.
0350  * The names should be ordered in alphabetical order
0351  */
0352
0353 #endif /* _MEDIA_RC_MAP_H */