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