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