xref: /openbmc/linux/drivers/usb/core/quirks.c (revision 33ac9dba)
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 	/* Roland SC-8820 */
97 	{ USB_DEVICE(0x0582, 0x0007), .driver_info = USB_QUIRK_RESET_RESUME },
98 
99 	/* Edirol SD-20 */
100 	{ USB_DEVICE(0x0582, 0x0027), .driver_info = USB_QUIRK_RESET_RESUME },
101 
102 	/* Alcor Micro Corp. Hub */
103 	{ USB_DEVICE(0x058f, 0x9254), .driver_info = USB_QUIRK_RESET_RESUME },
104 
105 	/* appletouch */
106 	{ USB_DEVICE(0x05ac, 0x021a), .driver_info = USB_QUIRK_RESET_RESUME },
107 
108 	/* Avision AV600U */
109 	{ USB_DEVICE(0x0638, 0x0a13), .driver_info =
110 	  USB_QUIRK_STRING_FETCH_255 },
111 
112 	/* Saitek Cyborg Gold Joystick */
113 	{ USB_DEVICE(0x06a3, 0x0006), .driver_info =
114 			USB_QUIRK_CONFIG_INTF_STRINGS },
115 
116 	/* Guillemot Webcam Hercules Dualpix Exchange (2nd ID) */
117 	{ USB_DEVICE(0x06f8, 0x0804), .driver_info = USB_QUIRK_RESET_RESUME },
118 
119 	/* Guillemot Webcam Hercules Dualpix Exchange*/
120 	{ USB_DEVICE(0x06f8, 0x3005), .driver_info = USB_QUIRK_RESET_RESUME },
121 
122 	/* Midiman M-Audio Keystation 88es */
123 	{ USB_DEVICE(0x0763, 0x0192), .driver_info = USB_QUIRK_RESET_RESUME },
124 
125 	/* M-Systems Flash Disk Pioneers */
126 	{ USB_DEVICE(0x08ec, 0x1000), .driver_info = USB_QUIRK_RESET_RESUME },
127 
128 	/* Keytouch QWERTY Panel keyboard */
129 	{ USB_DEVICE(0x0926, 0x3333), .driver_info =
130 			USB_QUIRK_CONFIG_INTF_STRINGS },
131 
132 	/* X-Rite/Gretag-Macbeth Eye-One Pro display colorimeter */
133 	{ USB_DEVICE(0x0971, 0x2000), .driver_info = USB_QUIRK_NO_SET_INTF },
134 
135 	/* Broadcom BCM92035DGROM BT dongle */
136 	{ USB_DEVICE(0x0a5c, 0x2021), .driver_info = USB_QUIRK_RESET_RESUME },
137 
138 	/* MAYA44USB sound device */
139 	{ USB_DEVICE(0x0a92, 0x0091), .driver_info = USB_QUIRK_RESET_RESUME },
140 
141 	/* Action Semiconductor flash disk */
142 	{ USB_DEVICE(0x10d6, 0x2200), .driver_info =
143 			USB_QUIRK_STRING_FETCH_255 },
144 
145 	/* SKYMEDI USB_DRIVE */
146 	{ USB_DEVICE(0x1516, 0x8628), .driver_info = USB_QUIRK_RESET_RESUME },
147 
148 	/* Razer - Razer Blade Keyboard */
149 	{ USB_DEVICE(0x1532, 0x0116), .driver_info =
150 			USB_QUIRK_LINEAR_UFRAME_INTR_BINTERVAL },
151 
152 	/* BUILDWIN Photo Frame */
153 	{ USB_DEVICE(0x1908, 0x1315), .driver_info =
154 			USB_QUIRK_HONOR_BNUMINTERFACES },
155 
156 	/* INTEL VALUE SSD */
157 	{ USB_DEVICE(0x8086, 0xf1a5), .driver_info = USB_QUIRK_RESET_RESUME },
158 
159 	/* USB3503 */
160 	{ USB_DEVICE(0x0424, 0x3503), .driver_info = USB_QUIRK_RESET_RESUME },
161 
162 	{ }  /* terminating entry must be last */
163 };
164 
165 static const struct usb_device_id usb_interface_quirk_list[] = {
166 	/* Logitech UVC Cameras */
167 	{ USB_VENDOR_AND_INTERFACE_INFO(0x046d, USB_CLASS_VIDEO, 1, 0),
168 	  .driver_info = USB_QUIRK_RESET_RESUME },
169 
170 	{ }  /* terminating entry must be last */
171 };
172 
173 static const struct usb_device_id usb_amd_resume_quirk_list[] = {
174 	/* Lenovo Mouse with Pixart controller */
175 	{ USB_DEVICE(0x17ef, 0x602e), .driver_info = USB_QUIRK_RESET_RESUME },
176 
177 	/* Pixart Mouse */
178 	{ USB_DEVICE(0x093a, 0x2500), .driver_info = USB_QUIRK_RESET_RESUME },
179 	{ USB_DEVICE(0x093a, 0x2510), .driver_info = USB_QUIRK_RESET_RESUME },
180 	{ USB_DEVICE(0x093a, 0x2521), .driver_info = USB_QUIRK_RESET_RESUME },
181 
182 	/* Logitech Optical Mouse M90/M100 */
183 	{ USB_DEVICE(0x046d, 0xc05a), .driver_info = USB_QUIRK_RESET_RESUME },
184 
185 	{ }  /* terminating entry must be last */
186 };
187 
188 static bool usb_match_any_interface(struct usb_device *udev,
189 				    const struct usb_device_id *id)
190 {
191 	unsigned int i;
192 
193 	for (i = 0; i < udev->descriptor.bNumConfigurations; ++i) {
194 		struct usb_host_config *cfg = &udev->config[i];
195 		unsigned int j;
196 
197 		for (j = 0; j < cfg->desc.bNumInterfaces; ++j) {
198 			struct usb_interface_cache *cache;
199 			struct usb_host_interface *intf;
200 
201 			cache = cfg->intf_cache[j];
202 			if (cache->num_altsetting == 0)
203 				continue;
204 
205 			intf = &cache->altsetting[0];
206 			if (usb_match_one_id_intf(udev, intf, id))
207 				return true;
208 		}
209 	}
210 
211 	return false;
212 }
213 
214 static int usb_amd_resume_quirk(struct usb_device *udev)
215 {
216 	struct usb_hcd *hcd;
217 
218 	hcd = bus_to_hcd(udev->bus);
219 	/* The device should be attached directly to root hub */
220 	if (udev->level == 1 && hcd->amd_resume_bug == 1)
221 		return 1;
222 
223 	return 0;
224 }
225 
226 static u32 __usb_detect_quirks(struct usb_device *udev,
227 			       const struct usb_device_id *id)
228 {
229 	u32 quirks = 0;
230 
231 	for (; id->match_flags; id++) {
232 		if (!usb_match_device(udev, id))
233 			continue;
234 
235 		if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_INFO) &&
236 		    !usb_match_any_interface(udev, id))
237 			continue;
238 
239 		quirks |= (u32)(id->driver_info);
240 	}
241 
242 	return quirks;
243 }
244 
245 /*
246  * Detect any quirks the device has, and do any housekeeping for it if needed.
247  */
248 void usb_detect_quirks(struct usb_device *udev)
249 {
250 	udev->quirks = __usb_detect_quirks(udev, usb_quirk_list);
251 
252 	/*
253 	 * Pixart-based mice would trigger remote wakeup issue on AMD
254 	 * Yangtze chipset, so set them as RESET_RESUME flag.
255 	 */
256 	if (usb_amd_resume_quirk(udev))
257 		udev->quirks |= __usb_detect_quirks(udev,
258 				usb_amd_resume_quirk_list);
259 
260 	if (udev->quirks)
261 		dev_dbg(&udev->dev, "USB quirks for this device: %x\n",
262 			udev->quirks);
263 
264 #ifdef CONFIG_USB_DEFAULT_PERSIST
265 	if (!(udev->quirks & USB_QUIRK_RESET))
266 		udev->persist_enabled = 1;
267 #else
268 	/* Hubs are automatically enabled for USB-PERSIST */
269 	if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
270 		udev->persist_enabled = 1;
271 #endif	/* CONFIG_USB_DEFAULT_PERSIST */
272 }
273 
274 void usb_detect_interface_quirks(struct usb_device *udev)
275 {
276 	u32 quirks;
277 
278 	quirks = __usb_detect_quirks(udev, usb_interface_quirk_list);
279 	if (quirks == 0)
280 		return;
281 
282 	dev_dbg(&udev->dev, "USB interface quirks for this device: %x\n",
283 		quirks);
284 	udev->quirks |= quirks;
285 }
286