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