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/slab.h>
  20
  21 #include "../hid-ids.h"
  22
  23 /*
  24  * Alphabetically sorted blacklist by quirk type.
  25  */
  26
  27 static const struct hid_blacklist {
  28         __u16 idVendor;
  29         __u16 idProduct;
  30         __u32 quirks;
  31 } hid_blacklist[] = {
  32         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
  33         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
  34         { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
  35         { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
  36         { USB_VENDOR_ID_DWAV, USB_DEVICE_ID_EGALAX_TOUCHCONTROLLER, HID_QUIRK_MULTI_INPUT | HID_QUIRK_NOGET },
  37         { USB_VENDOR_ID_MOJO, USB_DEVICE_ID_RETRO_ADAPTER, HID_QUIRK_MULTI_INPUT },
  38         { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART, 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_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
  52         { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
  53         { USB_VENDOR_ID_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT },
  54
  55         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
  56         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
  57         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
  58         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
  59         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
  60         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
  61         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET },
  62         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
  63         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
  64         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET },
  65         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_AXIS_295, HID_QUIRK_NOGET },
  66         { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
  67         { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
  68         { USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
  69         { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NOGET },
  70         { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
  71         { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
  72         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
  73         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U, HID_QUIRK_MULTI_INPUT },
  74         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5, HID_QUIRK_MULTI_INPUT },
  75         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U, HID_QUIRK_MULTI_INPUT },
  76         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U, HID_QUIRK_MULTI_INPUT },
  77         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
  78         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  79
  80         { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  81         { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  82
  83         { USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },
  84
  85         { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_MULTI_TOUCH, HID_QUIRK_MULTI_INPUT },
  86
  87         { 0, 0 }
  88 };
  89
  90 /* Dynamic HID quirks list - specified at runtime */
  91 struct quirks_list_struct {
  92         struct hid_blacklist hid_bl_item;
  93         struct list_head node;
  94 };
  95
  96 static LIST_HEAD(dquirks_list);
  97 static DECLARE_RWSEM(dquirks_rwsem);
  98
  99 /* Runtime ("dynamic") quirks manipulation functions */
 100
 101 /**
 102  * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
 103  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 104  * @idProduct: the 16-bit USB product ID, in native byteorder
 105  *
 106  * Description:
 107  *         Scans dquirks_list for a matching dynamic quirk and returns
 108  *         the pointer to the relevant struct hid_blacklist if found.
 109  *         Must be called with a read lock held on dquirks_rwsem.
 110  *
 111  * Returns: NULL if no quirk found, struct hid_blacklist * if found.
 112  */
 113 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
 114                 const u16 idProduct)
 115 {
 116         struct quirks_list_struct *q;
 117         struct hid_blacklist *bl_entry = NULL;
 118
 119         list_for_each_entry(q, &dquirks_list, node) {
 120                 if (q->hid_bl_item.idVendor == idVendor &&
 121                                 q->hid_bl_item.idProduct == idProduct) {
 122                         bl_entry = &q->hid_bl_item;
 123                         break;
 124                 }
 125         }
 126
 127         if (bl_entry != NULL)
 128                 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
 129                                 bl_entry->quirks, bl_entry->idVendor,
 130                                 bl_entry->idProduct);
 131
 132         return bl_entry;
 133 }
 134
 135
 136 /**
 137  * usbhid_modify_dquirk: add/replace a HID quirk
 138  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 139  * @idProduct: the 16-bit USB product ID, in native byteorder
 140  * @quirks: the u32 quirks value to add/replace
 141  *
 142  * Description:
 143  *         If an dynamic quirk exists in memory for this (idVendor,
 144  *         idProduct) pair, replace its quirks value with what was
 145  *         provided.  Otherwise, add the quirk to the dynamic quirks list.
 146  *
 147  * Returns: 0 OK, -error on failure.
 148  */
 149 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
 150                                 const u32 quirks)
 151 {
 152         struct quirks_list_struct *q_new, *q;
 153         int list_edited = 0;
 154
 155         if (!idVendor) {
 156                 dbg_hid("Cannot add a quirk with idVendor = 0\n");
 157                 return -EINVAL;
 158         }
 159
 160         q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
 161         if (!q_new) {
 162                 dbg_hid("Could not allocate quirks_list_struct\n");
 163                 return -ENOMEM;
 164         }
 165
 166         q_new->hid_bl_item.idVendor = idVendor;
 167         q_new->hid_bl_item.idProduct = idProduct;
 168         q_new->hid_bl_item.quirks = quirks;
 169
 170         down_write(&dquirks_rwsem);
 171
 172         list_for_each_entry(q, &dquirks_list, node) {
 173
 174                 if (q->hid_bl_item.idVendor == idVendor &&
 175                                 q->hid_bl_item.idProduct == idProduct) {
 176
 177                         list_replace(&q->node, &q_new->node);
 178                         kfree(q);
 179                         list_edited = 1;
 180                         break;
 181
 182                 }
 183
 184         }
 185
 186         if (!list_edited)
 187                 list_add_tail(&q_new->node, &dquirks_list);
 188
 189         up_write(&dquirks_rwsem);
 190
 191         return 0;
 192 }
 193
 194 /**
 195  * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
 196  *
 197  * Description:
 198  *         Free all memory associated with dynamic quirks - called before
 199  *         module unload.
 200  *
 201  */
 202 static void usbhid_remove_all_dquirks(void)
 203 {
 204         struct quirks_list_struct *q, *temp;
 205
 206         down_write(&dquirks_rwsem);
 207         list_for_each_entry_safe(q, temp, &dquirks_list, node) {
 208                 list_del(&q->node);
 209                 kfree(q);
 210         }
 211         up_write(&dquirks_rwsem);
 212
 213 }
 214
 215 /**
 216  * usbhid_quirks_init: apply USB HID quirks specified at module load time
 217  */
 218 int usbhid_quirks_init(char **quirks_param)
 219 {
 220         u16 idVendor, idProduct;
 221         u32 quirks;
 222         int n = 0, m;
 223
 224         for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) {
 225
 226                 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
 227                                 &idVendor, &idProduct, &quirks);
 228
 229                 if (m != 3 ||
 230                                 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
 231                         printk(KERN_WARNING
 232                                         "Could not parse HID quirk module param %s\n",
 233                                         quirks_param[n]);
 234                 }
 235         }
 236
 237         return 0;
 238 }
 239
 240 /**
 241  * usbhid_quirks_exit: release memory associated with dynamic_quirks
 242  *
 243  * Description:
 244  *     Release all memory associated with dynamic quirks.  Called upon
 245  *     module unload.
 246  *
 247  * Returns: nothing
 248  */
 249 void usbhid_quirks_exit(void)
 250 {
 251         usbhid_remove_all_dquirks();
 252 }
 253
 254 /**
 255  * usbhid_exists_squirk: return any static quirks for a USB HID device
 256  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 257  * @idProduct: the 16-bit USB product ID, in native byteorder
 258  *
 259  * Description:
 260  *     Given a USB vendor ID and product ID, return a pointer to
 261  *     the hid_blacklist entry associated with that device.
 262  *
 263  * Returns: pointer if quirk found, or NULL if no quirks found.
 264  */
 265 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
 266                 const u16 idProduct)
 267 {
 268         const struct hid_blacklist *bl_entry = NULL;
 269         int n = 0;
 270
 271         for (; hid_blacklist[n].idVendor; n++)
 272                 if (hid_blacklist[n].idVendor == idVendor &&
 273                                 hid_blacklist[n].idProduct == idProduct)
 274                         bl_entry = &hid_blacklist[n];
 275
 276         if (bl_entry != NULL)
 277                 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
 278                                 bl_entry->quirks, bl_entry->idVendor,
 279                                 bl_entry->idProduct);
 280         return bl_entry;
 281 }
 282
 283 /**
 284  * usbhid_lookup_quirk: return any quirks associated with a USB HID device
 285  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 286  * @idProduct: the 16-bit USB product ID, in native byteorder
 287  *
 288  * Description:
 289  *     Given a USB vendor ID and product ID, return any quirks associated
 290  *     with that device.
 291  *
 292  * Returns: a u32 quirks value.
 293  */
 294 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
 295 {
 296         u32 quirks = 0;
 297         const struct hid_blacklist *bl_entry = NULL;
 298
 299         /* NCR devices must not be queried for reports */
 300         if (idVendor == USB_VENDOR_ID_NCR &&
 301                         idProduct >= USB_DEVICE_ID_NCR_FIRST &&
 302                         idProduct <= USB_DEVICE_ID_NCR_LAST)
 303                         return HID_QUIRK_NO_INIT_REPORTS;
 304
 305         down_read(&dquirks_rwsem);
 306         bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
 307         if (!bl_entry)
 308                 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
 309         if (bl_entry)
 310                 quirks = bl_entry->quirks;
 311         up_read(&dquirks_rwsem);
 312
 313         return quirks;
 314 }
 315
 316 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);