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