xref: /openbmc/linux/drivers/usb/core/quirks.c (revision e2c75e76)
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/usb.h>
10 #include <linux/usb/quirks.h>
11 #include <linux/usb/hcd.h>
12 #include "usb.h"
13 
14 /* Lists of quirky USB devices, split in device quirks and interface quirks.
15  * Device quirks are applied at the very beginning of the enumeration process,
16  * right after reading the device descriptor. They can thus only match on device
17  * information.
18  *
19  * Interface quirks are applied after reading all the configuration descriptors.
20  * They can match on both device and interface information.
21  *
22  * Note that the DELAY_INIT and HONOR_BNUMINTERFACES quirks do not make sense as
23  * interface quirks, as they only influence the enumeration process which is run
24  * before processing the interface quirks.
25  *
26  * Please keep the lists ordered by:
27  * 	1) Vendor ID
28  * 	2) Product ID
29  * 	3) Class ID
30  */
31 static const struct usb_device_id usb_quirk_list[] = {
32 	/* CBM - Flash disk */
33 	{ USB_DEVICE(0x0204, 0x6025), .driver_info = USB_QUIRK_RESET_RESUME },
34 
35 	/* WORLDE easy key (easykey.25) MIDI controller  */
36 	{ USB_DEVICE(0x0218, 0x0401), .driver_info =
37 			USB_QUIRK_CONFIG_INTF_STRINGS },
38 
39 	/* HP 5300/5370C scanner */
40 	{ USB_DEVICE(0x03f0, 0x0701), .driver_info =
41 			USB_QUIRK_STRING_FETCH_255 },
42 
43 	/* Creative SB Audigy 2 NX */
44 	{ USB_DEVICE(0x041e, 0x3020), .driver_info = USB_QUIRK_RESET_RESUME },
45 
46 	/* USB3503 */
47 	{ USB_DEVICE(0x0424, 0x3503), .driver_info = USB_QUIRK_RESET_RESUME },
48 
49 	/* Microsoft Wireless Laser Mouse 6000 Receiver */
50 	{ USB_DEVICE(0x045e, 0x00e1), .driver_info = USB_QUIRK_RESET_RESUME },
51 
52 	/* Microsoft LifeCam-VX700 v2.0 */
53 	{ USB_DEVICE(0x045e, 0x0770), .driver_info = USB_QUIRK_RESET_RESUME },
54 
55 	/* Logitech HD Pro Webcams C920, C920-C, C925e and C930e */
56 	{ USB_DEVICE(0x046d, 0x082d), .driver_info = USB_QUIRK_DELAY_INIT },
57 	{ USB_DEVICE(0x046d, 0x0841), .driver_info = USB_QUIRK_DELAY_INIT },
58 	{ USB_DEVICE(0x046d, 0x0843), .driver_info = USB_QUIRK_DELAY_INIT },
59 	{ USB_DEVICE(0x046d, 0x085b), .driver_info = USB_QUIRK_DELAY_INIT },
60 
61 	/* Logitech ConferenceCam CC3000e */
62 	{ USB_DEVICE(0x046d, 0x0847), .driver_info = USB_QUIRK_DELAY_INIT },
63 	{ USB_DEVICE(0x046d, 0x0848), .driver_info = USB_QUIRK_DELAY_INIT },
64 
65 	/* Logitech PTZ Pro Camera */
66 	{ USB_DEVICE(0x046d, 0x0853), .driver_info = USB_QUIRK_DELAY_INIT },
67 
68 	/* Logitech Quickcam Fusion */
69 	{ USB_DEVICE(0x046d, 0x08c1), .driver_info = USB_QUIRK_RESET_RESUME },
70 
71 	/* Logitech Quickcam Orbit MP */
72 	{ USB_DEVICE(0x046d, 0x08c2), .driver_info = USB_QUIRK_RESET_RESUME },
73 
74 	/* Logitech Quickcam Pro for Notebook */
75 	{ USB_DEVICE(0x046d, 0x08c3), .driver_info = USB_QUIRK_RESET_RESUME },
76 
77 	/* Logitech Quickcam Pro 5000 */
78 	{ USB_DEVICE(0x046d, 0x08c5), .driver_info = USB_QUIRK_RESET_RESUME },
79 
80 	/* Logitech Quickcam OEM Dell Notebook */
81 	{ USB_DEVICE(0x046d, 0x08c6), .driver_info = USB_QUIRK_RESET_RESUME },
82 
83 	/* Logitech Quickcam OEM Cisco VT Camera II */
84 	{ USB_DEVICE(0x046d, 0x08c7), .driver_info = USB_QUIRK_RESET_RESUME },
85 
86 	/* Logitech Harmony 700-series */
87 	{ USB_DEVICE(0x046d, 0xc122), .driver_info = USB_QUIRK_DELAY_INIT },
88 
89 	/* Philips PSC805 audio device */
90 	{ USB_DEVICE(0x0471, 0x0155), .driver_info = USB_QUIRK_RESET_RESUME },
91 
92 	/* Plantronic Audio 655 DSP */
93 	{ USB_DEVICE(0x047f, 0xc008), .driver_info = USB_QUIRK_RESET_RESUME },
94 
95 	/* Plantronic Audio 648 USB */
96 	{ USB_DEVICE(0x047f, 0xc013), .driver_info = USB_QUIRK_RESET_RESUME },
97 
98 	/* Artisman Watchdog Dongle */
99 	{ USB_DEVICE(0x04b4, 0x0526), .driver_info =
100 			USB_QUIRK_CONFIG_INTF_STRINGS },
101 
102 	/* Microchip Joss Optical infrared touchboard device */
103 	{ USB_DEVICE(0x04d8, 0x000c), .driver_info =
104 			USB_QUIRK_CONFIG_INTF_STRINGS },
105 
106 	/* CarrolTouch 4000U */
107 	{ USB_DEVICE(0x04e7, 0x0009), .driver_info = USB_QUIRK_RESET_RESUME },
108 
109 	/* CarrolTouch 4500U */
110 	{ USB_DEVICE(0x04e7, 0x0030), .driver_info = USB_QUIRK_RESET_RESUME },
111 
112 	/* Samsung Android phone modem - ID conflict with SPH-I500 */
113 	{ USB_DEVICE(0x04e8, 0x6601), .driver_info =
114 			USB_QUIRK_CONFIG_INTF_STRINGS },
115 
116 	/* Elan Touchscreen */
117 	{ USB_DEVICE(0x04f3, 0x0089), .driver_info =
118 			USB_QUIRK_DEVICE_QUALIFIER },
119 
120 	{ USB_DEVICE(0x04f3, 0x009b), .driver_info =
121 			USB_QUIRK_DEVICE_QUALIFIER },
122 
123 	{ USB_DEVICE(0x04f3, 0x010c), .driver_info =
124 			USB_QUIRK_DEVICE_QUALIFIER },
125 
126 	{ USB_DEVICE(0x04f3, 0x0125), .driver_info =
127 			USB_QUIRK_DEVICE_QUALIFIER },
128 
129 	{ USB_DEVICE(0x04f3, 0x016f), .driver_info =
130 			USB_QUIRK_DEVICE_QUALIFIER },
131 
132 	{ USB_DEVICE(0x04f3, 0x0381), .driver_info =
133 			USB_QUIRK_NO_LPM },
134 
135 	{ USB_DEVICE(0x04f3, 0x21b8), .driver_info =
136 			USB_QUIRK_DEVICE_QUALIFIER },
137 
138 	/* Roland SC-8820 */
139 	{ USB_DEVICE(0x0582, 0x0007), .driver_info = USB_QUIRK_RESET_RESUME },
140 
141 	/* Edirol SD-20 */
142 	{ USB_DEVICE(0x0582, 0x0027), .driver_info = USB_QUIRK_RESET_RESUME },
143 
144 	/* Alcor Micro Corp. Hub */
145 	{ USB_DEVICE(0x058f, 0x9254), .driver_info = USB_QUIRK_RESET_RESUME },
146 
147 	/* appletouch */
148 	{ USB_DEVICE(0x05ac, 0x021a), .driver_info = USB_QUIRK_RESET_RESUME },
149 
150 	/* Genesys Logic hub, internally used by KY-688 USB 3.1 Type-C Hub */
151 	{ USB_DEVICE(0x05e3, 0x0612), .driver_info = USB_QUIRK_NO_LPM },
152 
153 	/* ELSA MicroLink 56K */
154 	{ USB_DEVICE(0x05cc, 0x2267), .driver_info = USB_QUIRK_RESET_RESUME },
155 
156 	/* Genesys Logic hub, internally used by Moshi USB to Ethernet Adapter */
157 	{ USB_DEVICE(0x05e3, 0x0616), .driver_info = USB_QUIRK_NO_LPM },
158 
159 	/* Avision AV600U */
160 	{ USB_DEVICE(0x0638, 0x0a13), .driver_info =
161 	  USB_QUIRK_STRING_FETCH_255 },
162 
163 	/* Saitek Cyborg Gold Joystick */
164 	{ USB_DEVICE(0x06a3, 0x0006), .driver_info =
165 			USB_QUIRK_CONFIG_INTF_STRINGS },
166 
167 	/* Guillemot Webcam Hercules Dualpix Exchange (2nd ID) */
168 	{ USB_DEVICE(0x06f8, 0x0804), .driver_info = USB_QUIRK_RESET_RESUME },
169 
170 	/* Guillemot Webcam Hercules Dualpix Exchange*/
171 	{ USB_DEVICE(0x06f8, 0x3005), .driver_info = USB_QUIRK_RESET_RESUME },
172 
173 	/* Midiman M-Audio Keystation 88es */
174 	{ USB_DEVICE(0x0763, 0x0192), .driver_info = USB_QUIRK_RESET_RESUME },
175 
176 	/* M-Systems Flash Disk Pioneers */
177 	{ USB_DEVICE(0x08ec, 0x1000), .driver_info = USB_QUIRK_RESET_RESUME },
178 
179 	/* Baum Vario Ultra */
180 	{ USB_DEVICE(0x0904, 0x6101), .driver_info =
181 			USB_QUIRK_LINEAR_FRAME_INTR_BINTERVAL },
182 	{ USB_DEVICE(0x0904, 0x6102), .driver_info =
183 			USB_QUIRK_LINEAR_FRAME_INTR_BINTERVAL },
184 	{ USB_DEVICE(0x0904, 0x6103), .driver_info =
185 			USB_QUIRK_LINEAR_FRAME_INTR_BINTERVAL },
186 
187 	/* Keytouch QWERTY Panel keyboard */
188 	{ USB_DEVICE(0x0926, 0x3333), .driver_info =
189 			USB_QUIRK_CONFIG_INTF_STRINGS },
190 
191 	/* X-Rite/Gretag-Macbeth Eye-One Pro display colorimeter */
192 	{ USB_DEVICE(0x0971, 0x2000), .driver_info = USB_QUIRK_NO_SET_INTF },
193 
194 	/* Broadcom BCM92035DGROM BT dongle */
195 	{ USB_DEVICE(0x0a5c, 0x2021), .driver_info = USB_QUIRK_RESET_RESUME },
196 
197 	/* MAYA44USB sound device */
198 	{ USB_DEVICE(0x0a92, 0x0091), .driver_info = USB_QUIRK_RESET_RESUME },
199 
200 	/* ASUS Base Station(T100) */
201 	{ USB_DEVICE(0x0b05, 0x17e0), .driver_info =
202 			USB_QUIRK_IGNORE_REMOTE_WAKEUP },
203 
204 	/* Action Semiconductor flash disk */
205 	{ USB_DEVICE(0x10d6, 0x2200), .driver_info =
206 			USB_QUIRK_STRING_FETCH_255 },
207 
208 	/* Huawei 4G LTE module */
209 	{ USB_DEVICE(0x12d1, 0x15bb), .driver_info =
210 			USB_QUIRK_DISCONNECT_SUSPEND },
211 	{ USB_DEVICE(0x12d1, 0x15c3), .driver_info =
212 			USB_QUIRK_DISCONNECT_SUSPEND },
213 
214 	/* SKYMEDI USB_DRIVE */
215 	{ USB_DEVICE(0x1516, 0x8628), .driver_info = USB_QUIRK_RESET_RESUME },
216 
217 	/* Razer - Razer Blade Keyboard */
218 	{ USB_DEVICE(0x1532, 0x0116), .driver_info =
219 			USB_QUIRK_LINEAR_UFRAME_INTR_BINTERVAL },
220 
221 	/* BUILDWIN Photo Frame */
222 	{ USB_DEVICE(0x1908, 0x1315), .driver_info =
223 			USB_QUIRK_HONOR_BNUMINTERFACES },
224 
225 	/* Protocol and OTG Electrical Test Device */
226 	{ USB_DEVICE(0x1a0a, 0x0200), .driver_info =
227 			USB_QUIRK_LINEAR_UFRAME_INTR_BINTERVAL },
228 
229 	/* Corsair K70 RGB */
230 	{ USB_DEVICE(0x1b1c, 0x1b13), .driver_info = USB_QUIRK_DELAY_INIT },
231 
232 	/* Corsair Strafe RGB */
233 	{ USB_DEVICE(0x1b1c, 0x1b20), .driver_info = USB_QUIRK_DELAY_INIT },
234 
235 	/* Corsair K70 LUX */
236 	{ USB_DEVICE(0x1b1c, 0x1b36), .driver_info = USB_QUIRK_DELAY_INIT },
237 
238 	/* MIDI keyboard WORLDE MINI */
239 	{ USB_DEVICE(0x1c75, 0x0204), .driver_info =
240 			USB_QUIRK_CONFIG_INTF_STRINGS },
241 
242 	/* Acer C120 LED Projector */
243 	{ USB_DEVICE(0x1de1, 0xc102), .driver_info = USB_QUIRK_NO_LPM },
244 
245 	/* Blackmagic Design Intensity Shuttle */
246 	{ USB_DEVICE(0x1edb, 0xbd3b), .driver_info = USB_QUIRK_NO_LPM },
247 
248 	/* Blackmagic Design UltraStudio SDI */
249 	{ USB_DEVICE(0x1edb, 0xbd4f), .driver_info = USB_QUIRK_NO_LPM },
250 
251 	/* Hauppauge HVR-950q */
252 	{ USB_DEVICE(0x2040, 0x7200), .driver_info =
253 			USB_QUIRK_CONFIG_INTF_STRINGS },
254 
255 	/* INTEL VALUE SSD */
256 	{ USB_DEVICE(0x8086, 0xf1a5), .driver_info = USB_QUIRK_RESET_RESUME },
257 
258 	{ }  /* terminating entry must be last */
259 };
260 
261 static const struct usb_device_id usb_interface_quirk_list[] = {
262 	/* Logitech UVC Cameras */
263 	{ USB_VENDOR_AND_INTERFACE_INFO(0x046d, USB_CLASS_VIDEO, 1, 0),
264 	  .driver_info = USB_QUIRK_RESET_RESUME },
265 
266 	{ }  /* terminating entry must be last */
267 };
268 
269 static const struct usb_device_id usb_amd_resume_quirk_list[] = {
270 	/* Lenovo Mouse with Pixart controller */
271 	{ USB_DEVICE(0x17ef, 0x602e), .driver_info = USB_QUIRK_RESET_RESUME },
272 
273 	/* Pixart Mouse */
274 	{ USB_DEVICE(0x093a, 0x2500), .driver_info = USB_QUIRK_RESET_RESUME },
275 	{ USB_DEVICE(0x093a, 0x2510), .driver_info = USB_QUIRK_RESET_RESUME },
276 	{ USB_DEVICE(0x093a, 0x2521), .driver_info = USB_QUIRK_RESET_RESUME },
277 	{ USB_DEVICE(0x03f0, 0x2b4a), .driver_info = USB_QUIRK_RESET_RESUME },
278 
279 	/* Logitech Optical Mouse M90/M100 */
280 	{ USB_DEVICE(0x046d, 0xc05a), .driver_info = USB_QUIRK_RESET_RESUME },
281 
282 	{ }  /* terminating entry must be last */
283 };
284 
285 static bool usb_match_any_interface(struct usb_device *udev,
286 				    const struct usb_device_id *id)
287 {
288 	unsigned int i;
289 
290 	for (i = 0; i < udev->descriptor.bNumConfigurations; ++i) {
291 		struct usb_host_config *cfg = &udev->config[i];
292 		unsigned int j;
293 
294 		for (j = 0; j < cfg->desc.bNumInterfaces; ++j) {
295 			struct usb_interface_cache *cache;
296 			struct usb_host_interface *intf;
297 
298 			cache = cfg->intf_cache[j];
299 			if (cache->num_altsetting == 0)
300 				continue;
301 
302 			intf = &cache->altsetting[0];
303 			if (usb_match_one_id_intf(udev, intf, id))
304 				return true;
305 		}
306 	}
307 
308 	return false;
309 }
310 
311 static int usb_amd_resume_quirk(struct usb_device *udev)
312 {
313 	struct usb_hcd *hcd;
314 
315 	hcd = bus_to_hcd(udev->bus);
316 	/* The device should be attached directly to root hub */
317 	if (udev->level == 1 && hcd->amd_resume_bug == 1)
318 		return 1;
319 
320 	return 0;
321 }
322 
323 static u32 __usb_detect_quirks(struct usb_device *udev,
324 			       const struct usb_device_id *id)
325 {
326 	u32 quirks = 0;
327 
328 	for (; id->match_flags; id++) {
329 		if (!usb_match_device(udev, id))
330 			continue;
331 
332 		if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_INFO) &&
333 		    !usb_match_any_interface(udev, id))
334 			continue;
335 
336 		quirks |= (u32)(id->driver_info);
337 	}
338 
339 	return quirks;
340 }
341 
342 /*
343  * Detect any quirks the device has, and do any housekeeping for it if needed.
344  */
345 void usb_detect_quirks(struct usb_device *udev)
346 {
347 	udev->quirks = __usb_detect_quirks(udev, usb_quirk_list);
348 
349 	/*
350 	 * Pixart-based mice would trigger remote wakeup issue on AMD
351 	 * Yangtze chipset, so set them as RESET_RESUME flag.
352 	 */
353 	if (usb_amd_resume_quirk(udev))
354 		udev->quirks |= __usb_detect_quirks(udev,
355 				usb_amd_resume_quirk_list);
356 
357 	if (udev->quirks)
358 		dev_dbg(&udev->dev, "USB quirks for this device: %x\n",
359 			udev->quirks);
360 
361 #ifdef CONFIG_USB_DEFAULT_PERSIST
362 	if (!(udev->quirks & USB_QUIRK_RESET))
363 		udev->persist_enabled = 1;
364 #else
365 	/* Hubs are automatically enabled for USB-PERSIST */
366 	if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
367 		udev->persist_enabled = 1;
368 #endif	/* CONFIG_USB_DEFAULT_PERSIST */
369 }
370 
371 void usb_detect_interface_quirks(struct usb_device *udev)
372 {
373 	u32 quirks;
374 
375 	quirks = __usb_detect_quirks(udev, usb_interface_quirk_list);
376 	if (quirks == 0)
377 		return;
378 
379 	dev_dbg(&udev->dev, "USB interface quirks for this device: %x\n",
380 		quirks);
381 	udev->quirks |= quirks;
382 }
383