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