KVM: PPC: Book3S HV: Don't use compound_order to determine host mapping size
[linux-2.6-microblaze.git] / drivers / usb / core / quirks.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * USB device quirk handling logic and table
4  *
5  * Copyright (c) 2007 Oliver Neukum
6  * Copyright (c) 2007 Greg Kroah-Hartman <gregkh@suse.de>
7  */
8
9 #include <linux/moduleparam.h>
10 #include <linux/usb.h>
11 #include <linux/usb/quirks.h>
12 #include <linux/usb/hcd.h>
13 #include "usb.h"
14
15 struct quirk_entry {
16         u16 vid;
17         u16 pid;
18         u32 flags;
19 };
20
21 static DEFINE_MUTEX(quirk_mutex);
22
23 static struct quirk_entry *quirk_list;
24 static unsigned int quirk_count;
25
26 static char quirks_param[128];
27
28 static int quirks_param_set(const char *val, const struct kernel_param *kp)
29 {
30         char *p, *field;
31         u16 vid, pid;
32         u32 flags;
33         size_t i;
34         int err;
35
36         err = param_set_copystring(val, kp);
37         if (err)
38                 return err;
39
40         mutex_lock(&quirk_mutex);
41
42         if (!*val) {
43                 quirk_count = 0;
44                 kfree(quirk_list);
45                 quirk_list = NULL;
46                 goto unlock;
47         }
48
49         for (quirk_count = 1, i = 0; val[i]; i++)
50                 if (val[i] == ',')
51                         quirk_count++;
52
53         if (quirk_list) {
54                 kfree(quirk_list);
55                 quirk_list = NULL;
56         }
57
58         quirk_list = kcalloc(quirk_count, sizeof(struct quirk_entry),
59                              GFP_KERNEL);
60         if (!quirk_list) {
61                 mutex_unlock(&quirk_mutex);
62                 return -ENOMEM;
63         }
64
65         for (i = 0, p = (char *)val; p && *p;) {
66                 /* Each entry consists of VID:PID:flags */
67                 field = strsep(&p, ":");
68                 if (!field)
69                         break;
70
71                 if (kstrtou16(field, 16, &vid))
72                         break;
73
74                 field = strsep(&p, ":");
75                 if (!field)
76                         break;
77
78                 if (kstrtou16(field, 16, &pid))
79                         break;
80
81                 field = strsep(&p, ",");
82                 if (!field || !*field)
83                         break;
84
85                 /* Collect the flags */
86                 for (flags = 0; *field; field++) {
87                         switch (*field) {
88                         case 'a':
89                                 flags |= USB_QUIRK_STRING_FETCH_255;
90                                 break;
91                         case 'b':
92                                 flags |= USB_QUIRK_RESET_RESUME;
93                                 break;
94                         case 'c':
95                                 flags |= USB_QUIRK_NO_SET_INTF;
96                                 break;
97                         case 'd':
98                                 flags |= USB_QUIRK_CONFIG_INTF_STRINGS;
99                                 break;
100                         case 'e':
101                                 flags |= USB_QUIRK_RESET;
102                                 break;
103                         case 'f':
104                                 flags |= USB_QUIRK_HONOR_BNUMINTERFACES;
105                                 break;
106                         case 'g':
107                                 flags |= USB_QUIRK_DELAY_INIT;
108                                 break;
109                         case 'h':
110                                 flags |= USB_QUIRK_LINEAR_UFRAME_INTR_BINTERVAL;
111                                 break;
112                         case 'i':
113                                 flags |= USB_QUIRK_DEVICE_QUALIFIER;
114                                 break;
115                         case 'j':
116                                 flags |= USB_QUIRK_IGNORE_REMOTE_WAKEUP;
117                                 break;
118                         case 'k':
119                                 flags |= USB_QUIRK_NO_LPM;
120                                 break;
121                         case 'l':
122                                 flags |= USB_QUIRK_LINEAR_FRAME_INTR_BINTERVAL;
123                                 break;
124                         case 'm':
125                                 flags |= USB_QUIRK_DISCONNECT_SUSPEND;
126                                 break;
127                         case 'n':
128                                 flags |= USB_QUIRK_DELAY_CTRL_MSG;
129                                 break;
130                         /* Ignore unrecognized flag characters */
131                         }
132                 }
133
134                 quirk_list[i++] = (struct quirk_entry)
135                         { .vid = vid, .pid = pid, .flags = flags };
136         }
137
138         if (i < quirk_count)
139                 quirk_count = i;
140
141 unlock:
142         mutex_unlock(&quirk_mutex);
143
144         return 0;
145 }
146
147 static const struct kernel_param_ops quirks_param_ops = {
148         .set = quirks_param_set,
149         .get = param_get_string,
150 };
151
152 static struct kparam_string quirks_param_string = {
153         .maxlen = sizeof(quirks_param),
154         .string = quirks_param,
155 };
156
157 module_param_cb(quirks, &quirks_param_ops, &quirks_param_string, 0644);
158 MODULE_PARM_DESC(quirks, "Add/modify USB quirks by specifying quirks=vendorID:productID:quirks");
159
160 /* Lists of quirky USB devices, split in device quirks and interface quirks.
161  * Device quirks are applied at the very beginning of the enumeration process,
162  * right after reading the device descriptor. They can thus only match on device
163  * information.
164  *
165  * Interface quirks are applied after reading all the configuration descriptors.
166  * They can match on both device and interface information.
167  *
168  * Note that the DELAY_INIT and HONOR_BNUMINTERFACES quirks do not make sense as
169  * interface quirks, as they only influence the enumeration process which is run
170  * before processing the interface quirks.
171  *
172  * Please keep the lists ordered by:
173  *      1) Vendor ID
174  *      2) Product ID
175  *      3) Class ID
176  */
177 static const struct usb_device_id usb_quirk_list[] = {
178         /* CBM - Flash disk */
179         { USB_DEVICE(0x0204, 0x6025), .driver_info = USB_QUIRK_RESET_RESUME },
180
181         /* WORLDE easy key (easykey.25) MIDI controller  */
182         { USB_DEVICE(0x0218, 0x0401), .driver_info =
183                         USB_QUIRK_CONFIG_INTF_STRINGS },
184
185         /* HP 5300/5370C scanner */
186         { USB_DEVICE(0x03f0, 0x0701), .driver_info =
187                         USB_QUIRK_STRING_FETCH_255 },
188
189         /* HP v222w 16GB Mini USB Drive */
190         { USB_DEVICE(0x03f0, 0x3f40), .driver_info = USB_QUIRK_DELAY_INIT },
191
192         /* Creative SB Audigy 2 NX */
193         { USB_DEVICE(0x041e, 0x3020), .driver_info = USB_QUIRK_RESET_RESUME },
194
195         /* USB3503 */
196         { USB_DEVICE(0x0424, 0x3503), .driver_info = USB_QUIRK_RESET_RESUME },
197
198         /* Microsoft Wireless Laser Mouse 6000 Receiver */
199         { USB_DEVICE(0x045e, 0x00e1), .driver_info = USB_QUIRK_RESET_RESUME },
200
201         /* Microsoft LifeCam-VX700 v2.0 */
202         { USB_DEVICE(0x045e, 0x0770), .driver_info = USB_QUIRK_RESET_RESUME },
203
204         /* Logitech HD Pro Webcams C920, C920-C, C925e and C930e */
205         { USB_DEVICE(0x046d, 0x082d), .driver_info = USB_QUIRK_DELAY_INIT },
206         { USB_DEVICE(0x046d, 0x0841), .driver_info = USB_QUIRK_DELAY_INIT },
207         { USB_DEVICE(0x046d, 0x0843), .driver_info = USB_QUIRK_DELAY_INIT },
208         { USB_DEVICE(0x046d, 0x085b), .driver_info = USB_QUIRK_DELAY_INIT },
209
210         /* Logitech ConferenceCam CC3000e */
211         { USB_DEVICE(0x046d, 0x0847), .driver_info = USB_QUIRK_DELAY_INIT },
212         { USB_DEVICE(0x046d, 0x0848), .driver_info = USB_QUIRK_DELAY_INIT },
213
214         /* Logitech PTZ Pro Camera */
215         { USB_DEVICE(0x046d, 0x0853), .driver_info = USB_QUIRK_DELAY_INIT },
216
217         /* Logitech Quickcam Fusion */
218         { USB_DEVICE(0x046d, 0x08c1), .driver_info = USB_QUIRK_RESET_RESUME },
219
220         /* Logitech Quickcam Orbit MP */
221         { USB_DEVICE(0x046d, 0x08c2), .driver_info = USB_QUIRK_RESET_RESUME },
222
223         /* Logitech Quickcam Pro for Notebook */
224         { USB_DEVICE(0x046d, 0x08c3), .driver_info = USB_QUIRK_RESET_RESUME },
225
226         /* Logitech Quickcam Pro 5000 */
227         { USB_DEVICE(0x046d, 0x08c5), .driver_info = USB_QUIRK_RESET_RESUME },
228
229         /* Logitech Quickcam OEM Dell Notebook */
230         { USB_DEVICE(0x046d, 0x08c6), .driver_info = USB_QUIRK_RESET_RESUME },
231
232         /* Logitech Quickcam OEM Cisco VT Camera II */
233         { USB_DEVICE(0x046d, 0x08c7), .driver_info = USB_QUIRK_RESET_RESUME },
234
235         /* Logitech Harmony 700-series */
236         { USB_DEVICE(0x046d, 0xc122), .driver_info = USB_QUIRK_DELAY_INIT },
237
238         /* Philips PSC805 audio device */
239         { USB_DEVICE(0x0471, 0x0155), .driver_info = USB_QUIRK_RESET_RESUME },
240
241         /* Plantronic Audio 655 DSP */
242         { USB_DEVICE(0x047f, 0xc008), .driver_info = USB_QUIRK_RESET_RESUME },
243
244         /* Plantronic Audio 648 USB */
245         { USB_DEVICE(0x047f, 0xc013), .driver_info = USB_QUIRK_RESET_RESUME },
246
247         /* Artisman Watchdog Dongle */
248         { USB_DEVICE(0x04b4, 0x0526), .driver_info =
249                         USB_QUIRK_CONFIG_INTF_STRINGS },
250
251         /* Microchip Joss Optical infrared touchboard device */
252         { USB_DEVICE(0x04d8, 0x000c), .driver_info =
253                         USB_QUIRK_CONFIG_INTF_STRINGS },
254
255         /* CarrolTouch 4000U */
256         { USB_DEVICE(0x04e7, 0x0009), .driver_info = USB_QUIRK_RESET_RESUME },
257
258         /* CarrolTouch 4500U */
259         { USB_DEVICE(0x04e7, 0x0030), .driver_info = USB_QUIRK_RESET_RESUME },
260
261         /* Samsung Android phone modem - ID conflict with SPH-I500 */
262         { USB_DEVICE(0x04e8, 0x6601), .driver_info =
263                         USB_QUIRK_CONFIG_INTF_STRINGS },
264
265         /* Elan Touchscreen */
266         { USB_DEVICE(0x04f3, 0x0089), .driver_info =
267                         USB_QUIRK_DEVICE_QUALIFIER },
268
269         { USB_DEVICE(0x04f3, 0x009b), .driver_info =
270                         USB_QUIRK_DEVICE_QUALIFIER },
271
272         { USB_DEVICE(0x04f3, 0x010c), .driver_info =
273                         USB_QUIRK_DEVICE_QUALIFIER },
274
275         { USB_DEVICE(0x04f3, 0x0125), .driver_info =
276                         USB_QUIRK_DEVICE_QUALIFIER },
277
278         { USB_DEVICE(0x04f3, 0x016f), .driver_info =
279                         USB_QUIRK_DEVICE_QUALIFIER },
280
281         { USB_DEVICE(0x04f3, 0x0381), .driver_info =
282                         USB_QUIRK_NO_LPM },
283
284         { USB_DEVICE(0x04f3, 0x21b8), .driver_info =
285                         USB_QUIRK_DEVICE_QUALIFIER },
286
287         /* Roland SC-8820 */
288         { USB_DEVICE(0x0582, 0x0007), .driver_info = USB_QUIRK_RESET_RESUME },
289
290         /* Edirol SD-20 */
291         { USB_DEVICE(0x0582, 0x0027), .driver_info = USB_QUIRK_RESET_RESUME },
292
293         /* Alcor Micro Corp. Hub */
294         { USB_DEVICE(0x058f, 0x9254), .driver_info = USB_QUIRK_RESET_RESUME },
295
296         /* appletouch */
297         { USB_DEVICE(0x05ac, 0x021a), .driver_info = USB_QUIRK_RESET_RESUME },
298
299         /* Genesys Logic hub, internally used by KY-688 USB 3.1 Type-C Hub */
300         { USB_DEVICE(0x05e3, 0x0612), .driver_info = USB_QUIRK_NO_LPM },
301
302         /* ELSA MicroLink 56K */
303         { USB_DEVICE(0x05cc, 0x2267), .driver_info = USB_QUIRK_RESET_RESUME },
304
305         /* Genesys Logic hub, internally used by Moshi USB to Ethernet Adapter */
306         { USB_DEVICE(0x05e3, 0x0616), .driver_info = USB_QUIRK_NO_LPM },
307
308         /* Avision AV600U */
309         { USB_DEVICE(0x0638, 0x0a13), .driver_info =
310           USB_QUIRK_STRING_FETCH_255 },
311
312         /* Saitek Cyborg Gold Joystick */
313         { USB_DEVICE(0x06a3, 0x0006), .driver_info =
314                         USB_QUIRK_CONFIG_INTF_STRINGS },
315
316         /* Guillemot Webcam Hercules Dualpix Exchange (2nd ID) */
317         { USB_DEVICE(0x06f8, 0x0804), .driver_info = USB_QUIRK_RESET_RESUME },
318
319         /* Guillemot Webcam Hercules Dualpix Exchange*/
320         { USB_DEVICE(0x06f8, 0x3005), .driver_info = USB_QUIRK_RESET_RESUME },
321
322         /* Midiman M-Audio Keystation 88es */
323         { USB_DEVICE(0x0763, 0x0192), .driver_info = USB_QUIRK_RESET_RESUME },
324
325         /* M-Systems Flash Disk Pioneers */
326         { USB_DEVICE(0x08ec, 0x1000), .driver_info = USB_QUIRK_RESET_RESUME },
327
328         /* Baum Vario Ultra */
329         { USB_DEVICE(0x0904, 0x6101), .driver_info =
330                         USB_QUIRK_LINEAR_FRAME_INTR_BINTERVAL },
331         { USB_DEVICE(0x0904, 0x6102), .driver_info =
332                         USB_QUIRK_LINEAR_FRAME_INTR_BINTERVAL },
333         { USB_DEVICE(0x0904, 0x6103), .driver_info =
334                         USB_QUIRK_LINEAR_FRAME_INTR_BINTERVAL },
335
336         /* Keytouch QWERTY Panel keyboard */
337         { USB_DEVICE(0x0926, 0x3333), .driver_info =
338                         USB_QUIRK_CONFIG_INTF_STRINGS },
339
340         /* X-Rite/Gretag-Macbeth Eye-One Pro display colorimeter */
341         { USB_DEVICE(0x0971, 0x2000), .driver_info = USB_QUIRK_NO_SET_INTF },
342
343         /* Broadcom BCM92035DGROM BT dongle */
344         { USB_DEVICE(0x0a5c, 0x2021), .driver_info = USB_QUIRK_RESET_RESUME },
345
346         /* MAYA44USB sound device */
347         { USB_DEVICE(0x0a92, 0x0091), .driver_info = USB_QUIRK_RESET_RESUME },
348
349         /* ASUS Base Station(T100) */
350         { USB_DEVICE(0x0b05, 0x17e0), .driver_info =
351                         USB_QUIRK_IGNORE_REMOTE_WAKEUP },
352
353         /* Action Semiconductor flash disk */
354         { USB_DEVICE(0x10d6, 0x2200), .driver_info =
355                         USB_QUIRK_STRING_FETCH_255 },
356
357         /* Huawei 4G LTE module */
358         { USB_DEVICE(0x12d1, 0x15bb), .driver_info =
359                         USB_QUIRK_DISCONNECT_SUSPEND },
360         { USB_DEVICE(0x12d1, 0x15c3), .driver_info =
361                         USB_QUIRK_DISCONNECT_SUSPEND },
362
363         /* SKYMEDI USB_DRIVE */
364         { USB_DEVICE(0x1516, 0x8628), .driver_info = USB_QUIRK_RESET_RESUME },
365
366         /* Razer - Razer Blade Keyboard */
367         { USB_DEVICE(0x1532, 0x0116), .driver_info =
368                         USB_QUIRK_LINEAR_UFRAME_INTR_BINTERVAL },
369
370         /* BUILDWIN Photo Frame */
371         { USB_DEVICE(0x1908, 0x1315), .driver_info =
372                         USB_QUIRK_HONOR_BNUMINTERFACES },
373
374         /* Protocol and OTG Electrical Test Device */
375         { USB_DEVICE(0x1a0a, 0x0200), .driver_info =
376                         USB_QUIRK_LINEAR_UFRAME_INTR_BINTERVAL },
377
378         /* Corsair K70 RGB */
379         { USB_DEVICE(0x1b1c, 0x1b13), .driver_info = USB_QUIRK_DELAY_INIT },
380
381         /* Corsair Strafe */
382         { USB_DEVICE(0x1b1c, 0x1b15), .driver_info = USB_QUIRK_DELAY_INIT |
383           USB_QUIRK_DELAY_CTRL_MSG },
384
385         /* Corsair Strafe RGB */
386         { USB_DEVICE(0x1b1c, 0x1b20), .driver_info = USB_QUIRK_DELAY_INIT |
387           USB_QUIRK_DELAY_CTRL_MSG },
388
389         /* Corsair K70 LUX */
390         { USB_DEVICE(0x1b1c, 0x1b36), .driver_info = USB_QUIRK_DELAY_INIT },
391
392         /* MIDI keyboard WORLDE MINI */
393         { USB_DEVICE(0x1c75, 0x0204), .driver_info =
394                         USB_QUIRK_CONFIG_INTF_STRINGS },
395
396         /* Acer C120 LED Projector */
397         { USB_DEVICE(0x1de1, 0xc102), .driver_info = USB_QUIRK_NO_LPM },
398
399         /* Blackmagic Design Intensity Shuttle */
400         { USB_DEVICE(0x1edb, 0xbd3b), .driver_info = USB_QUIRK_NO_LPM },
401
402         /* Blackmagic Design UltraStudio SDI */
403         { USB_DEVICE(0x1edb, 0xbd4f), .driver_info = USB_QUIRK_NO_LPM },
404
405         /* Hauppauge HVR-950q */
406         { USB_DEVICE(0x2040, 0x7200), .driver_info =
407                         USB_QUIRK_CONFIG_INTF_STRINGS },
408
409         /* INTEL VALUE SSD */
410         { USB_DEVICE(0x8086, 0xf1a5), .driver_info = USB_QUIRK_RESET_RESUME },
411
412         { }  /* terminating entry must be last */
413 };
414
415 static const struct usb_device_id usb_interface_quirk_list[] = {
416         /* Logitech UVC Cameras */
417         { USB_VENDOR_AND_INTERFACE_INFO(0x046d, USB_CLASS_VIDEO, 1, 0),
418           .driver_info = USB_QUIRK_RESET_RESUME },
419
420         { }  /* terminating entry must be last */
421 };
422
423 static const struct usb_device_id usb_amd_resume_quirk_list[] = {
424         /* Lenovo Mouse with Pixart controller */
425         { USB_DEVICE(0x17ef, 0x602e), .driver_info = USB_QUIRK_RESET_RESUME },
426
427         /* Pixart Mouse */
428         { USB_DEVICE(0x093a, 0x2500), .driver_info = USB_QUIRK_RESET_RESUME },
429         { USB_DEVICE(0x093a, 0x2510), .driver_info = USB_QUIRK_RESET_RESUME },
430         { USB_DEVICE(0x093a, 0x2521), .driver_info = USB_QUIRK_RESET_RESUME },
431         { USB_DEVICE(0x03f0, 0x2b4a), .driver_info = USB_QUIRK_RESET_RESUME },
432
433         /* Logitech Optical Mouse M90/M100 */
434         { USB_DEVICE(0x046d, 0xc05a), .driver_info = USB_QUIRK_RESET_RESUME },
435
436         { }  /* terminating entry must be last */
437 };
438
439 static bool usb_match_any_interface(struct usb_device *udev,
440                                     const struct usb_device_id *id)
441 {
442         unsigned int i;
443
444         for (i = 0; i < udev->descriptor.bNumConfigurations; ++i) {
445                 struct usb_host_config *cfg = &udev->config[i];
446                 unsigned int j;
447
448                 for (j = 0; j < cfg->desc.bNumInterfaces; ++j) {
449                         struct usb_interface_cache *cache;
450                         struct usb_host_interface *intf;
451
452                         cache = cfg->intf_cache[j];
453                         if (cache->num_altsetting == 0)
454                                 continue;
455
456                         intf = &cache->altsetting[0];
457                         if (usb_match_one_id_intf(udev, intf, id))
458                                 return true;
459                 }
460         }
461
462         return false;
463 }
464
465 static int usb_amd_resume_quirk(struct usb_device *udev)
466 {
467         struct usb_hcd *hcd;
468
469         hcd = bus_to_hcd(udev->bus);
470         /* The device should be attached directly to root hub */
471         if (udev->level == 1 && hcd->amd_resume_bug == 1)
472                 return 1;
473
474         return 0;
475 }
476
477 static u32 usb_detect_static_quirks(struct usb_device *udev,
478                                     const struct usb_device_id *id)
479 {
480         u32 quirks = 0;
481
482         for (; id->match_flags; id++) {
483                 if (!usb_match_device(udev, id))
484                         continue;
485
486                 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_INFO) &&
487                     !usb_match_any_interface(udev, id))
488                         continue;
489
490                 quirks |= (u32)(id->driver_info);
491         }
492
493         return quirks;
494 }
495
496 static u32 usb_detect_dynamic_quirks(struct usb_device *udev)
497 {
498         u16 vid = le16_to_cpu(udev->descriptor.idVendor);
499         u16 pid = le16_to_cpu(udev->descriptor.idProduct);
500         int i, flags = 0;
501
502         mutex_lock(&quirk_mutex);
503
504         for (i = 0; i < quirk_count; i++) {
505                 if (vid == quirk_list[i].vid && pid == quirk_list[i].pid) {
506                         flags = quirk_list[i].flags;
507                         break;
508                 }
509         }
510
511         mutex_unlock(&quirk_mutex);
512
513         return flags;
514 }
515
516 /*
517  * Detect any quirks the device has, and do any housekeeping for it if needed.
518  */
519 void usb_detect_quirks(struct usb_device *udev)
520 {
521         udev->quirks = usb_detect_static_quirks(udev, usb_quirk_list);
522
523         /*
524          * Pixart-based mice would trigger remote wakeup issue on AMD
525          * Yangtze chipset, so set them as RESET_RESUME flag.
526          */
527         if (usb_amd_resume_quirk(udev))
528                 udev->quirks |= usb_detect_static_quirks(udev,
529                                 usb_amd_resume_quirk_list);
530
531         udev->quirks ^= usb_detect_dynamic_quirks(udev);
532
533         if (udev->quirks)
534                 dev_dbg(&udev->dev, "USB quirks for this device: %x\n",
535                         udev->quirks);
536
537 #ifdef CONFIG_USB_DEFAULT_PERSIST
538         if (!(udev->quirks & USB_QUIRK_RESET))
539                 udev->persist_enabled = 1;
540 #else
541         /* Hubs are automatically enabled for USB-PERSIST */
542         if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
543                 udev->persist_enabled = 1;
544 #endif  /* CONFIG_USB_DEFAULT_PERSIST */
545 }
546
547 void usb_detect_interface_quirks(struct usb_device *udev)
548 {
549         u32 quirks;
550
551         quirks = usb_detect_static_quirks(udev, usb_interface_quirk_list);
552         if (quirks == 0)
553                 return;
554
555         dev_dbg(&udev->dev, "USB interface quirks for this device: %x\n",
556                 quirks);
557         udev->quirks |= quirks;
558 }
559
560 void usb_release_quirk_list(void)
561 {
562         mutex_lock(&quirk_mutex);
563         kfree(quirk_list);
564         quirk_list = NULL;
565         mutex_unlock(&quirk_mutex);
566 }