drivers/hid/usbhid/hid-quirks.c

   1 /*
   2  *  USB HID quirks support for Linux
   3  *
   4  *  Copyright (c) 1999 Andreas Gal
   5  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
   6  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
   7  *  Copyright (c) 2006-2007 Jiri Kosina
   8  *  Copyright (c) 2007 Paul Walmsley
   9  */
  10
  11 /*
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 2 of the License, or (at your option)
  15  * any later version.
  16  */
  17
  18 #include <linux/hid.h>
  19 #include <linux/export.h>
  20 #include <linux/slab.h>
  21
  22 #include "../hid-ids.h"
  23
  24 /*
  25  * Alphabetically sorted blacklist by quirk type.
  26  */
  27
  28 static const struct hid_blacklist {
  29         __u16 idVendor;
  30         __u16 idProduct;
  31         __u32 quirks;
  32 } hid_blacklist[] = {
  33         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
  34         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
  35         { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
  36         { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
  37         { USB_VENDOR_ID_DWAV, USB_DEVICE_ID_EGALAX_TOUCHCONTROLLER, HID_QUIRK_MULTI_INPUT | HID_QUIRK_NOGET },
  38         { USB_VENDOR_ID_MOJO, USB_DEVICE_ID_RETRO_ADAPTER, HID_QUIRK_MULTI_INPUT },
  39         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
  40         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
  41         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
  42         { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
  43         { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
  44         { USB_VENDOR_ID_NEXTWINDOW, USB_DEVICE_ID_NEXTWINDOW_TOUCHSCREEN, HID_QUIRK_MULTI_INPUT},
  45         { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
  46         { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
  47
  48         { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
  49
  50         { USB_VENDOR_ID_ETURBOTOUCH, USB_DEVICE_ID_ETURBOTOUCH, HID_QUIRK_MULTI_INPUT },
  51         { USB_VENDOR_ID_GREENASIA, USB_DEVICE_ID_GREENASIA_DUAL_USB_JOYPAD, HID_QUIRK_MULTI_INPUT },
  52         { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
  53         { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
  54         { USB_VENDOR_ID_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT },
  55
  56         { USB_VENDOR_ID_AIREN, USB_DEVICE_ID_AIREN_SLIMPLUS, HID_QUIRK_NOGET },
  57         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
  58         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
  59         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
  60         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
  61         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
  62         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
  63         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET },
  64         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
  65         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_THROTTLE, HID_QUIRK_NOGET },
  66         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
  67         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET },
  68         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_AXIS_295, HID_QUIRK_NOGET },
  69         { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
  70         { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
  71         { USB_VENDOR_ID_FREESCALE, USB_DEVICE_ID_FREESCALE_MX28, HID_QUIRK_NOGET },
  72         { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS, HID_QUIRK_NOGET },
  73         { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NO_INIT_REPORTS },
  74         { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1, HID_QUIRK_NO_INIT_REPORTS },
  75         { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2, HID_QUIRK_NO_INIT_REPORTS },
  76         { USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
  77         { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NOGET },
  78         { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
  79         { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_1, HID_QUIRK_NOGET },
  80         { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_2, HID_QUIRK_NOGET },
  81         { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
  82         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
  83         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U, HID_QUIRK_MULTI_INPUT },
  84         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5, HID_QUIRK_MULTI_INPUT },
  85         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_TWA60, HID_QUIRK_MULTI_INPUT },
  86         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U, HID_QUIRK_MULTI_INPUT },
  87         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U, HID_QUIRK_MULTI_INPUT },
  88         { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_10_6_INCH, HID_QUIRK_MULTI_INPUT },
  89         { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_14_1_INCH, HID_QUIRK_MULTI_INPUT },
  90         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  91
  92         { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  93
  94         { USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },
  95
  96         { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_MULTI_TOUCH, HID_QUIRK_MULTI_INPUT },
  97         { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_WIRELESS, HID_QUIRK_MULTI_INPUT },
  98         { USB_VENDOR_ID_SIGMA_MICRO, USB_DEVICE_ID_SIGMA_MICRO_KEYBOARD, HID_QUIRK_NO_INIT_REPORTS },
  99         { 0, 0 }
 100 };
 101
 102 /* Dynamic HID quirks list - specified at runtime */
 103 struct quirks_list_struct {
 104         struct hid_blacklist hid_bl_item;
 105         struct list_head node;
 106 };
 107
 108 static LIST_HEAD(dquirks_list);
 109 static DECLARE_RWSEM(dquirks_rwsem);
 110
 111 /* Runtime ("dynamic") quirks manipulation functions */
 112
 113 /**
 114  * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
 115  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 116  * @idProduct: the 16-bit USB product ID, in native byteorder
 117  *
 118  * Description:
 119  *         Scans dquirks_list for a matching dynamic quirk and returns
 120  *         the pointer to the relevant struct hid_blacklist if found.
 121  *         Must be called with a read lock held on dquirks_rwsem.
 122  *
 123  * Returns: NULL if no quirk found, struct hid_blacklist * if found.
 124  */
 125 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
 126                 const u16 idProduct)
 127 {
 128         struct quirks_list_struct *q;
 129         struct hid_blacklist *bl_entry = NULL;
 130
 131         list_for_each_entry(q, &dquirks_list, node) {
 132                 if (q->hid_bl_item.idVendor == idVendor &&
 133                                 q->hid_bl_item.idProduct == idProduct) {
 134                         bl_entry = &q->hid_bl_item;
 135                         break;
 136                 }
 137         }
 138
 139         if (bl_entry != NULL)
 140                 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
 141                                 bl_entry->quirks, bl_entry->idVendor,
 142                                 bl_entry->idProduct);
 143
 144         return bl_entry;
 145 }
 146
 147
 148 /**
 149  * usbhid_modify_dquirk: add/replace a HID quirk
 150  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 151  * @idProduct: the 16-bit USB product ID, in native byteorder
 152  * @quirks: the u32 quirks value to add/replace
 153  *
 154  * Description:
 155  *         If an dynamic quirk exists in memory for this (idVendor,
 156  *         idProduct) pair, replace its quirks value with what was
 157  *         provided.  Otherwise, add the quirk to the dynamic quirks list.
 158  *
 159  * Returns: 0 OK, -error on failure.
 160  */
 161 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
 162                                 const u32 quirks)
 163 {
 164         struct quirks_list_struct *q_new, *q;
 165         int list_edited = 0;
 166
 167         if (!idVendor) {
 168                 dbg_hid("Cannot add a quirk with idVendor = 0\n");
 169                 return -EINVAL;
 170         }
 171
 172         q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
 173         if (!q_new) {
 174                 dbg_hid("Could not allocate quirks_list_struct\n");
 175                 return -ENOMEM;
 176         }
 177
 178         q_new->hid_bl_item.idVendor = idVendor;
 179         q_new->hid_bl_item.idProduct = idProduct;
 180         q_new->hid_bl_item.quirks = quirks;
 181
 182         down_write(&dquirks_rwsem);
 183
 184         list_for_each_entry(q, &dquirks_list, node) {
 185
 186                 if (q->hid_bl_item.idVendor == idVendor &&
 187                                 q->hid_bl_item.idProduct == idProduct) {
 188
 189                         list_replace(&q->node, &q_new->node);
 190                         kfree(q);
 191                         list_edited = 1;
 192                         break;
 193
 194                 }
 195
 196         }
 197
 198         if (!list_edited)
 199                 list_add_tail(&q_new->node, &dquirks_list);
 200
 201         up_write(&dquirks_rwsem);
 202
 203         return 0;
 204 }
 205
 206 /**
 207  * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
 208  *
 209  * Description:
 210  *         Free all memory associated with dynamic quirks - called before
 211  *         module unload.
 212  *
 213  */
 214 static void usbhid_remove_all_dquirks(void)
 215 {
 216         struct quirks_list_struct *q, *temp;
 217
 218         down_write(&dquirks_rwsem);
 219         list_for_each_entry_safe(q, temp, &dquirks_list, node) {
 220                 list_del(&q->node);
 221                 kfree(q);
 222         }
 223         up_write(&dquirks_rwsem);
 224
 225 }
 226
 227 /**
 228  * usbhid_quirks_init: apply USB HID quirks specified at module load time
 229  */
 230 int usbhid_quirks_init(char **quirks_param)
 231 {
 232         u16 idVendor, idProduct;
 233         u32 quirks;
 234         int n = 0, m;
 235
 236         for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) {
 237
 238                 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
 239                                 &idVendor, &idProduct, &quirks);
 240
 241                 if (m != 3 ||
 242                                 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
 243                         printk(KERN_WARNING
 244                                         "Could not parse HID quirk module param %s\n",
 245                                         quirks_param[n]);
 246                 }
 247         }
 248
 249         return 0;
 250 }
 251
 252 /**
 253  * usbhid_quirks_exit: release memory associated with dynamic_quirks
 254  *
 255  * Description:
 256  *     Release all memory associated with dynamic quirks.  Called upon
 257  *     module unload.
 258  *
 259  * Returns: nothing
 260  */
 261 void usbhid_quirks_exit(void)
 262 {
 263         usbhid_remove_all_dquirks();
 264 }
 265
 266 /**
 267  * usbhid_exists_squirk: return any static quirks for a USB HID device
 268  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 269  * @idProduct: the 16-bit USB product ID, in native byteorder
 270  *
 271  * Description:
 272  *     Given a USB vendor ID and product ID, return a pointer to
 273  *     the hid_blacklist entry associated with that device.
 274  *
 275  * Returns: pointer if quirk found, or NULL if no quirks found.
 276  */
 277 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
 278                 const u16 idProduct)
 279 {
 280         const struct hid_blacklist *bl_entry = NULL;
 281         int n = 0;
 282
 283         for (; hid_blacklist[n].idVendor; n++)
 284                 if (hid_blacklist[n].idVendor == idVendor &&
 285                                 hid_blacklist[n].idProduct == idProduct)
 286                         bl_entry = &hid_blacklist[n];
 287
 288         if (bl_entry != NULL)
 289                 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
 290                                 bl_entry->quirks, bl_entry->idVendor,
 291                                 bl_entry->idProduct);
 292         return bl_entry;
 293 }
 294
 295 /**
 296  * usbhid_lookup_quirk: return any quirks associated with a USB HID device
 297  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 298  * @idProduct: the 16-bit USB product ID, in native byteorder
 299  *
 300  * Description:
 301  *     Given a USB vendor ID and product ID, return any quirks associated
 302  *     with that device.
 303  *
 304  * Returns: a u32 quirks value.
 305  */
 306 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
 307 {
 308         u32 quirks = 0;
 309         const struct hid_blacklist *bl_entry = NULL;
 310
 311         /* NCR devices must not be queried for reports */
 312         if (idVendor == USB_VENDOR_ID_NCR &&
 313                         idProduct >= USB_DEVICE_ID_NCR_FIRST &&
 314                         idProduct <= USB_DEVICE_ID_NCR_LAST)
 315                         return HID_QUIRK_NO_INIT_REPORTS;
 316
 317         down_read(&dquirks_rwsem);
 318         bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
 319         if (!bl_entry)
 320                 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
 321         if (bl_entry)
 322                 quirks = bl_entry->quirks;
 323         up_read(&dquirks_rwsem);
 324
 325         return quirks;
 326 }
 327
 328 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);