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