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