HID: add battery quirk for Apple Wireless ANSI
[linux-2.6-block.git] / drivers / hid / usbhid / hid-quirks.c
CommitLineData
2eb5dc30
PW
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>
ec37d321 19#include <linux/export.h>
5a0e3ad6 20#include <linux/slab.h>
2eb5dc30 21
990436a7 22#include "../hid-ids.h"
a32bcc45 23
2eb5dc30
PW
24/*
25 * Alphabetically sorted blacklist by quirk type.
26 */
27
28static const struct hid_blacklist {
29 __u16 idVendor;
30 __u16 idProduct;
31 __u32 quirks;
32} hid_blacklist[] = {
2eb5dc30
PW
33 { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
34 { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
35 { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
36 { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
d34c4aa4 37 { USB_VENDOR_ID_DWAV, USB_DEVICE_ID_EGALAX_TOUCHCONTROLLER, HID_QUIRK_MULTI_INPUT | HID_QUIRK_NOGET },
1f45e324 38 { USB_VENDOR_ID_MOJO, USB_DEVICE_ID_RETRO_ADAPTER, HID_QUIRK_MULTI_INPUT },
2eb5dc30
PW
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 },
c9bde7ad 42 { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
2eb5dc30 43 { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
9db630b4 44 { USB_VENDOR_ID_NEXTWINDOW, USB_DEVICE_ID_NEXTWINDOW_TOUCHSCREEN, HID_QUIRK_MULTI_INPUT},
2eb5dc30
PW
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 },
2c3e3bfb 47
f345c37c
PS
48 { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
49
cd07655e 50 { USB_VENDOR_ID_EMS, USB_DEVICE_ID_EMS_TRIO_LINKER_PLUS_II, HID_QUIRK_MULTI_INPUT },
8127f4e8 51 { USB_VENDOR_ID_ETURBOTOUCH, USB_DEVICE_ID_ETURBOTOUCH, HID_QUIRK_MULTI_INPUT },
6d1db077 52 { USB_VENDOR_ID_GREENASIA, USB_DEVICE_ID_GREENASIA_DUAL_USB_JOYPAD, HID_QUIRK_MULTI_INPUT },
2eb5dc30
PW
53 { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
54 { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
c2c3489c 55 { USB_VENDOR_ID_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT },
2eb5dc30 56
37891abc 57 { USB_VENDOR_ID_AIREN, USB_DEVICE_ID_AIREN_SLIMPLUS, HID_QUIRK_NOGET },
2eb5dc30
PW
58 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
59 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
60 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
61 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
62 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
724ed328 63 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FIGHTERSTICK, HID_QUIRK_NOGET },
b820aabf 64 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
c8e84646 65 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET },
b820aabf 66 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
da60325d 67 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_THROTTLE, HID_QUIRK_NOGET },
b820aabf 68 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
73cdcf56 69 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET },
8038298f 70 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_AXIS_295, HID_QUIRK_NOGET },
02008faa 71 { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
d500d116 72 { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
b7ea95ff
AT
73 { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NO_INIT_REPORTS },
74 { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1, HID_QUIRK_NO_INIT_REPORTS },
75 { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2, HID_QUIRK_NO_INIT_REPORTS },
c2c3489c 76 { USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
c565c54d 77 { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NOGET },
8d31321c 78 { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3008, HID_QUIRK_NOGET },
2eb5dc30 79 { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
4b5730fa
JK
80 { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_1, HID_QUIRK_NOGET },
81 { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_2, HID_QUIRK_NOGET },
2eb5dc30 82 { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
25e61613 83 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
eff7f270 84 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U, HID_QUIRK_MULTI_INPUT },
426409b1 85 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5, HID_QUIRK_MULTI_INPUT },
e23be0a2 86 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_TWA60, HID_QUIRK_MULTI_INPUT },
f8a489cc
NK
87 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U, HID_QUIRK_MULTI_INPUT },
88 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U, HID_QUIRK_MULTI_INPUT },
72a46344 89 { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_10_6_INCH, HID_QUIRK_MULTI_INPUT },
8f1acc32 90 { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_14_1_INCH, HID_QUIRK_MULTI_INPUT },
d2ee4dd9 91 { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_SIRIUS_BATTERY_FREE_TABLET, HID_QUIRK_MULTI_INPUT },
2eb5dc30
PW
92 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
93
66ebf66e 94 { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
2eb5dc30 95
70c7c9c4
DM
96 { USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },
97
7cacfa87 98 { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_MULTI_TOUCH, HID_QUIRK_MULTI_INPUT },
b9e4b1e0 99 { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_WIRELESS, HID_QUIRK_MULTI_INPUT },
f5e42825 100 { USB_VENDOR_ID_SIGMA_MICRO, USB_DEVICE_ID_SIGMA_MICRO_KEYBOARD, HID_QUIRK_NO_INIT_REPORTS },
22ca20b2
NK
101 { USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_MOUSEPEN_I608X, HID_QUIRK_MULTI_INPUT },
102 { USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_EASYPEN_M610X, HID_QUIRK_MULTI_INPUT },
ea9a4a8b
JK
103 { 0, 0 }
104};
105
8cef9082
PW
106/* Dynamic HID quirks list - specified at runtime */
107struct quirks_list_struct {
108 struct hid_blacklist hid_bl_item;
109 struct list_head node;
110};
111
112static LIST_HEAD(dquirks_list);
113static DECLARE_RWSEM(dquirks_rwsem);
114
115/* Runtime ("dynamic") quirks manipulation functions */
116
8222fbe6 117/**
8cef9082
PW
118 * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
119 * @idVendor: the 16-bit USB vendor ID, in native byteorder
120 * @idProduct: the 16-bit USB product ID, in native byteorder
121 *
122 * Description:
123 * Scans dquirks_list for a matching dynamic quirk and returns
124 * the pointer to the relevant struct hid_blacklist if found.
125 * Must be called with a read lock held on dquirks_rwsem.
126 *
127 * Returns: NULL if no quirk found, struct hid_blacklist * if found.
128 */
129static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
130 const u16 idProduct)
131{
132 struct quirks_list_struct *q;
133 struct hid_blacklist *bl_entry = NULL;
134
8cef9082
PW
135 list_for_each_entry(q, &dquirks_list, node) {
136 if (q->hid_bl_item.idVendor == idVendor &&
137 q->hid_bl_item.idProduct == idProduct) {
138 bl_entry = &q->hid_bl_item;
139 break;
140 }
141 }
142
143 if (bl_entry != NULL)
58037eb9 144 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
8cef9082
PW
145 bl_entry->quirks, bl_entry->idVendor,
146 bl_entry->idProduct);
147
148 return bl_entry;
149}
150
151
152/**
153 * usbhid_modify_dquirk: add/replace a HID quirk
154 * @idVendor: the 16-bit USB vendor ID, in native byteorder
155 * @idProduct: the 16-bit USB product ID, in native byteorder
156 * @quirks: the u32 quirks value to add/replace
157 *
158 * Description:
159 * If an dynamic quirk exists in memory for this (idVendor,
160 * idProduct) pair, replace its quirks value with what was
161 * provided. Otherwise, add the quirk to the dynamic quirks list.
162 *
163 * Returns: 0 OK, -error on failure.
164 */
abdff0f7
AB
165static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
166 const u32 quirks)
8cef9082
PW
167{
168 struct quirks_list_struct *q_new, *q;
169 int list_edited = 0;
170
171 if (!idVendor) {
58037eb9 172 dbg_hid("Cannot add a quirk with idVendor = 0\n");
8cef9082
PW
173 return -EINVAL;
174 }
175
176 q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
177 if (!q_new) {
58037eb9 178 dbg_hid("Could not allocate quirks_list_struct\n");
8cef9082
PW
179 return -ENOMEM;
180 }
181
182 q_new->hid_bl_item.idVendor = idVendor;
183 q_new->hid_bl_item.idProduct = idProduct;
184 q_new->hid_bl_item.quirks = quirks;
185
186 down_write(&dquirks_rwsem);
187
188 list_for_each_entry(q, &dquirks_list, node) {
189
190 if (q->hid_bl_item.idVendor == idVendor &&
191 q->hid_bl_item.idProduct == idProduct) {
192
193 list_replace(&q->node, &q_new->node);
194 kfree(q);
195 list_edited = 1;
196 break;
197
198 }
199
200 }
201
202 if (!list_edited)
203 list_add_tail(&q_new->node, &dquirks_list);
204
205 up_write(&dquirks_rwsem);
206
207 return 0;
208}
209
8cef9082
PW
210/**
211 * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
212 *
213 * Description:
214 * Free all memory associated with dynamic quirks - called before
215 * module unload.
216 *
217 */
218static void usbhid_remove_all_dquirks(void)
219{
220 struct quirks_list_struct *q, *temp;
221
222 down_write(&dquirks_rwsem);
223 list_for_each_entry_safe(q, temp, &dquirks_list, node) {
224 list_del(&q->node);
225 kfree(q);
226 }
227 up_write(&dquirks_rwsem);
228
229}
230
876b9276
PW
231/**
232 * usbhid_quirks_init: apply USB HID quirks specified at module load time
233 */
234int usbhid_quirks_init(char **quirks_param)
235{
236 u16 idVendor, idProduct;
237 u32 quirks;
238 int n = 0, m;
239
44cb2db1 240 for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) {
876b9276
PW
241
242 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
243 &idVendor, &idProduct, &quirks);
244
245 if (m != 3 ||
246 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
247 printk(KERN_WARNING
248 "Could not parse HID quirk module param %s\n",
249 quirks_param[n]);
250 }
251 }
252
253 return 0;
254}
255
256/**
257 * usbhid_quirks_exit: release memory associated with dynamic_quirks
258 *
259 * Description:
260 * Release all memory associated with dynamic quirks. Called upon
261 * module unload.
262 *
263 * Returns: nothing
264 */
265void usbhid_quirks_exit(void)
266{
267 usbhid_remove_all_dquirks();
268}
8cef9082
PW
269
270/**
271 * usbhid_exists_squirk: return any static quirks for 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 a pointer to
277 * the hid_blacklist entry associated with that device.
278 *
279 * Returns: pointer if quirk found, or NULL if no quirks found.
280 */
8222fbe6 281static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
8cef9082 282 const u16 idProduct)
8222fbe6 283{
8cef9082
PW
284 const struct hid_blacklist *bl_entry = NULL;
285 int n = 0;
8222fbe6
PW
286
287 for (; hid_blacklist[n].idVendor; n++)
288 if (hid_blacklist[n].idVendor == idVendor &&
289 hid_blacklist[n].idProduct == idProduct)
290 bl_entry = &hid_blacklist[n];
291
292 if (bl_entry != NULL)
58037eb9 293 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
8222fbe6
PW
294 bl_entry->quirks, bl_entry->idVendor,
295 bl_entry->idProduct);
296 return bl_entry;
297}
2eb5dc30
PW
298
299/**
300 * usbhid_lookup_quirk: return any quirks associated with a USB HID device
301 * @idVendor: the 16-bit USB vendor ID, in native byteorder
302 * @idProduct: the 16-bit USB product ID, in native byteorder
303 *
304 * Description:
305 * Given a USB vendor ID and product ID, return any quirks associated
306 * with that device.
307 *
308 * Returns: a u32 quirks value.
309 */
310u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
311{
312 u32 quirks = 0;
8222fbe6 313 const struct hid_blacklist *bl_entry = NULL;
2eb5dc30 314
b8e98f1c
JK
315 /* NCR devices must not be queried for reports */
316 if (idVendor == USB_VENDOR_ID_NCR &&
317 idProduct >= USB_DEVICE_ID_NCR_FIRST &&
318 idProduct <= USB_DEVICE_ID_NCR_LAST)
5b915d9e 319 return HID_QUIRK_NO_INIT_REPORTS;
b8e98f1c 320
8cef9082
PW
321 down_read(&dquirks_rwsem);
322 bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
323 if (!bl_entry)
324 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
8222fbe6
PW
325 if (bl_entry)
326 quirks = bl_entry->quirks;
8cef9082
PW
327 up_read(&dquirks_rwsem);
328
2eb5dc30
PW
329 return quirks;
330}
8222fbe6 331
9f6b3727 332EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);