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