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