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