Branch data Line data Source code
1 : : // SPDX-License-Identifier: GPL-2.0+
2 : : /*
3 : : * (C) Copyright Linus Torvalds 1999
4 : : * (C) Copyright Johannes Erdfelt 1999-2001
5 : : * (C) Copyright Andreas Gal 1999
6 : : * (C) Copyright Gregory P. Smith 1999
7 : : * (C) Copyright Deti Fliegl 1999
8 : : * (C) Copyright Randy Dunlap 2000
9 : : * (C) Copyright David Brownell 2000-2002
10 : : */
11 : :
12 : : #include <linux/bcd.h>
13 : : #include <linux/module.h>
14 : : #include <linux/version.h>
15 : : #include <linux/kernel.h>
16 : : #include <linux/sched/task_stack.h>
17 : : #include <linux/slab.h>
18 : : #include <linux/completion.h>
19 : : #include <linux/utsname.h>
20 : : #include <linux/mm.h>
21 : : #include <asm/io.h>
22 : : #include <linux/device.h>
23 : : #include <linux/dma-mapping.h>
24 : : #include <linux/mutex.h>
25 : : #include <asm/irq.h>
26 : : #include <asm/byteorder.h>
27 : : #include <asm/unaligned.h>
28 : : #include <linux/platform_device.h>
29 : : #include <linux/workqueue.h>
30 : : #include <linux/pm_runtime.h>
31 : : #include <linux/types.h>
32 : : #include <linux/genalloc.h>
33 : : #include <linux/io.h>
34 : :
35 : : #include <linux/phy/phy.h>
36 : : #include <linux/usb.h>
37 : : #include <linux/usb/hcd.h>
38 : : #include <linux/usb/otg.h>
39 : :
40 : : #include "usb.h"
41 : : #include "phy.h"
42 : :
43 : :
44 : : /*-------------------------------------------------------------------------*/
45 : :
46 : : /*
47 : : * USB Host Controller Driver framework
48 : : *
49 : : * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
50 : : * HCD-specific behaviors/bugs.
51 : : *
52 : : * This does error checks, tracks devices and urbs, and delegates to a
53 : : * "hc_driver" only for code (and data) that really needs to know about
54 : : * hardware differences. That includes root hub registers, i/o queues,
55 : : * and so on ... but as little else as possible.
56 : : *
57 : : * Shared code includes most of the "root hub" code (these are emulated,
58 : : * though each HC's hardware works differently) and PCI glue, plus request
59 : : * tracking overhead. The HCD code should only block on spinlocks or on
60 : : * hardware handshaking; blocking on software events (such as other kernel
61 : : * threads releasing resources, or completing actions) is all generic.
62 : : *
63 : : * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
64 : : * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
65 : : * only by the hub driver ... and that neither should be seen or used by
66 : : * usb client device drivers.
67 : : *
68 : : * Contributors of ideas or unattributed patches include: David Brownell,
69 : : * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
70 : : *
71 : : * HISTORY:
72 : : * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
73 : : * associated cleanup. "usb_hcd" still != "usb_bus".
74 : : * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
75 : : */
76 : :
77 : : /*-------------------------------------------------------------------------*/
78 : :
79 : : /* Keep track of which host controller drivers are loaded */
80 : : unsigned long usb_hcds_loaded;
81 : : EXPORT_SYMBOL_GPL(usb_hcds_loaded);
82 : :
83 : : /* host controllers we manage */
84 : : DEFINE_IDR (usb_bus_idr);
85 : : EXPORT_SYMBOL_GPL (usb_bus_idr);
86 : :
87 : : /* used when allocating bus numbers */
88 : : #define USB_MAXBUS 64
89 : :
90 : : /* used when updating list of hcds */
91 : : DEFINE_MUTEX(usb_bus_idr_lock); /* exported only for usbfs */
92 : : EXPORT_SYMBOL_GPL (usb_bus_idr_lock);
93 : :
94 : : /* used for controlling access to virtual root hubs */
95 : : static DEFINE_SPINLOCK(hcd_root_hub_lock);
96 : :
97 : : /* used when updating an endpoint's URB list */
98 : : static DEFINE_SPINLOCK(hcd_urb_list_lock);
99 : :
100 : : /* used to protect against unlinking URBs after the device is gone */
101 : : static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
102 : :
103 : : /* wait queue for synchronous unlinks */
104 : : DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
105 : :
106 : : /*-------------------------------------------------------------------------*/
107 : :
108 : : /*
109 : : * Sharable chunks of root hub code.
110 : : */
111 : :
112 : : /*-------------------------------------------------------------------------*/
113 : : #define KERNEL_REL bin2bcd(((LINUX_VERSION_CODE >> 16) & 0x0ff))
114 : : #define KERNEL_VER bin2bcd(((LINUX_VERSION_CODE >> 8) & 0x0ff))
115 : :
116 : : /* usb 3.1 root hub device descriptor */
117 : : static const u8 usb31_rh_dev_descriptor[18] = {
118 : : 0x12, /* __u8 bLength; */
119 : : USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
120 : : 0x10, 0x03, /* __le16 bcdUSB; v3.1 */
121 : :
122 : : 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
123 : : 0x00, /* __u8 bDeviceSubClass; */
124 : : 0x03, /* __u8 bDeviceProtocol; USB 3 hub */
125 : : 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
126 : :
127 : : 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
128 : : 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
129 : : KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
130 : :
131 : : 0x03, /* __u8 iManufacturer; */
132 : : 0x02, /* __u8 iProduct; */
133 : : 0x01, /* __u8 iSerialNumber; */
134 : : 0x01 /* __u8 bNumConfigurations; */
135 : : };
136 : :
137 : : /* usb 3.0 root hub device descriptor */
138 : : static const u8 usb3_rh_dev_descriptor[18] = {
139 : : 0x12, /* __u8 bLength; */
140 : : USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
141 : : 0x00, 0x03, /* __le16 bcdUSB; v3.0 */
142 : :
143 : : 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
144 : : 0x00, /* __u8 bDeviceSubClass; */
145 : : 0x03, /* __u8 bDeviceProtocol; USB 3.0 hub */
146 : : 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
147 : :
148 : : 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
149 : : 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
150 : : KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
151 : :
152 : : 0x03, /* __u8 iManufacturer; */
153 : : 0x02, /* __u8 iProduct; */
154 : : 0x01, /* __u8 iSerialNumber; */
155 : : 0x01 /* __u8 bNumConfigurations; */
156 : : };
157 : :
158 : : /* usb 2.5 (wireless USB 1.0) root hub device descriptor */
159 : : static const u8 usb25_rh_dev_descriptor[18] = {
160 : : 0x12, /* __u8 bLength; */
161 : : USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
162 : : 0x50, 0x02, /* __le16 bcdUSB; v2.5 */
163 : :
164 : : 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
165 : : 0x00, /* __u8 bDeviceSubClass; */
166 : : 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
167 : : 0xFF, /* __u8 bMaxPacketSize0; always 0xFF (WUSB Spec 7.4.1). */
168 : :
169 : : 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
170 : : 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
171 : : KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
172 : :
173 : : 0x03, /* __u8 iManufacturer; */
174 : : 0x02, /* __u8 iProduct; */
175 : : 0x01, /* __u8 iSerialNumber; */
176 : : 0x01 /* __u8 bNumConfigurations; */
177 : : };
178 : :
179 : : /* usb 2.0 root hub device descriptor */
180 : : static const u8 usb2_rh_dev_descriptor[18] = {
181 : : 0x12, /* __u8 bLength; */
182 : : USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
183 : : 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
184 : :
185 : : 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
186 : : 0x00, /* __u8 bDeviceSubClass; */
187 : : 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
188 : : 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
189 : :
190 : : 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
191 : : 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
192 : : KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
193 : :
194 : : 0x03, /* __u8 iManufacturer; */
195 : : 0x02, /* __u8 iProduct; */
196 : : 0x01, /* __u8 iSerialNumber; */
197 : : 0x01 /* __u8 bNumConfigurations; */
198 : : };
199 : :
200 : : /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
201 : :
202 : : /* usb 1.1 root hub device descriptor */
203 : : static const u8 usb11_rh_dev_descriptor[18] = {
204 : : 0x12, /* __u8 bLength; */
205 : : USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
206 : : 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
207 : :
208 : : 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
209 : : 0x00, /* __u8 bDeviceSubClass; */
210 : : 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
211 : : 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
212 : :
213 : : 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
214 : : 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
215 : : KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
216 : :
217 : : 0x03, /* __u8 iManufacturer; */
218 : : 0x02, /* __u8 iProduct; */
219 : : 0x01, /* __u8 iSerialNumber; */
220 : : 0x01 /* __u8 bNumConfigurations; */
221 : : };
222 : :
223 : :
224 : : /*-------------------------------------------------------------------------*/
225 : :
226 : : /* Configuration descriptors for our root hubs */
227 : :
228 : : static const u8 fs_rh_config_descriptor[] = {
229 : :
230 : : /* one configuration */
231 : : 0x09, /* __u8 bLength; */
232 : : USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
233 : : 0x19, 0x00, /* __le16 wTotalLength; */
234 : : 0x01, /* __u8 bNumInterfaces; (1) */
235 : : 0x01, /* __u8 bConfigurationValue; */
236 : : 0x00, /* __u8 iConfiguration; */
237 : : 0xc0, /* __u8 bmAttributes;
238 : : Bit 7: must be set,
239 : : 6: Self-powered,
240 : : 5: Remote wakeup,
241 : : 4..0: resvd */
242 : : 0x00, /* __u8 MaxPower; */
243 : :
244 : : /* USB 1.1:
245 : : * USB 2.0, single TT organization (mandatory):
246 : : * one interface, protocol 0
247 : : *
248 : : * USB 2.0, multiple TT organization (optional):
249 : : * two interfaces, protocols 1 (like single TT)
250 : : * and 2 (multiple TT mode) ... config is
251 : : * sometimes settable
252 : : * NOT IMPLEMENTED
253 : : */
254 : :
255 : : /* one interface */
256 : : 0x09, /* __u8 if_bLength; */
257 : : USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
258 : : 0x00, /* __u8 if_bInterfaceNumber; */
259 : : 0x00, /* __u8 if_bAlternateSetting; */
260 : : 0x01, /* __u8 if_bNumEndpoints; */
261 : : 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
262 : : 0x00, /* __u8 if_bInterfaceSubClass; */
263 : : 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
264 : : 0x00, /* __u8 if_iInterface; */
265 : :
266 : : /* one endpoint (status change endpoint) */
267 : : 0x07, /* __u8 ep_bLength; */
268 : : USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
269 : : 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
270 : : 0x03, /* __u8 ep_bmAttributes; Interrupt */
271 : : 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
272 : : 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
273 : : };
274 : :
275 : : static const u8 hs_rh_config_descriptor[] = {
276 : :
277 : : /* one configuration */
278 : : 0x09, /* __u8 bLength; */
279 : : USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
280 : : 0x19, 0x00, /* __le16 wTotalLength; */
281 : : 0x01, /* __u8 bNumInterfaces; (1) */
282 : : 0x01, /* __u8 bConfigurationValue; */
283 : : 0x00, /* __u8 iConfiguration; */
284 : : 0xc0, /* __u8 bmAttributes;
285 : : Bit 7: must be set,
286 : : 6: Self-powered,
287 : : 5: Remote wakeup,
288 : : 4..0: resvd */
289 : : 0x00, /* __u8 MaxPower; */
290 : :
291 : : /* USB 1.1:
292 : : * USB 2.0, single TT organization (mandatory):
293 : : * one interface, protocol 0
294 : : *
295 : : * USB 2.0, multiple TT organization (optional):
296 : : * two interfaces, protocols 1 (like single TT)
297 : : * and 2 (multiple TT mode) ... config is
298 : : * sometimes settable
299 : : * NOT IMPLEMENTED
300 : : */
301 : :
302 : : /* one interface */
303 : : 0x09, /* __u8 if_bLength; */
304 : : USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
305 : : 0x00, /* __u8 if_bInterfaceNumber; */
306 : : 0x00, /* __u8 if_bAlternateSetting; */
307 : : 0x01, /* __u8 if_bNumEndpoints; */
308 : : 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
309 : : 0x00, /* __u8 if_bInterfaceSubClass; */
310 : : 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
311 : : 0x00, /* __u8 if_iInterface; */
312 : :
313 : : /* one endpoint (status change endpoint) */
314 : : 0x07, /* __u8 ep_bLength; */
315 : : USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
316 : : 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
317 : : 0x03, /* __u8 ep_bmAttributes; Interrupt */
318 : : /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
319 : : * see hub.c:hub_configure() for details. */
320 : : (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
321 : : 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
322 : : };
323 : :
324 : : static const u8 ss_rh_config_descriptor[] = {
325 : : /* one configuration */
326 : : 0x09, /* __u8 bLength; */
327 : : USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
328 : : 0x1f, 0x00, /* __le16 wTotalLength; */
329 : : 0x01, /* __u8 bNumInterfaces; (1) */
330 : : 0x01, /* __u8 bConfigurationValue; */
331 : : 0x00, /* __u8 iConfiguration; */
332 : : 0xc0, /* __u8 bmAttributes;
333 : : Bit 7: must be set,
334 : : 6: Self-powered,
335 : : 5: Remote wakeup,
336 : : 4..0: resvd */
337 : : 0x00, /* __u8 MaxPower; */
338 : :
339 : : /* one interface */
340 : : 0x09, /* __u8 if_bLength; */
341 : : USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
342 : : 0x00, /* __u8 if_bInterfaceNumber; */
343 : : 0x00, /* __u8 if_bAlternateSetting; */
344 : : 0x01, /* __u8 if_bNumEndpoints; */
345 : : 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
346 : : 0x00, /* __u8 if_bInterfaceSubClass; */
347 : : 0x00, /* __u8 if_bInterfaceProtocol; */
348 : : 0x00, /* __u8 if_iInterface; */
349 : :
350 : : /* one endpoint (status change endpoint) */
351 : : 0x07, /* __u8 ep_bLength; */
352 : : USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
353 : : 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
354 : : 0x03, /* __u8 ep_bmAttributes; Interrupt */
355 : : /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
356 : : * see hub.c:hub_configure() for details. */
357 : : (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
358 : : 0x0c, /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
359 : :
360 : : /* one SuperSpeed endpoint companion descriptor */
361 : : 0x06, /* __u8 ss_bLength */
362 : : USB_DT_SS_ENDPOINT_COMP, /* __u8 ss_bDescriptorType; SuperSpeed EP */
363 : : /* Companion */
364 : : 0x00, /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
365 : : 0x00, /* __u8 ss_bmAttributes; 1 packet per service interval */
366 : : 0x02, 0x00 /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
367 : : };
368 : :
369 : : /* authorized_default behaviour:
370 : : * -1 is authorized for all devices except wireless (old behaviour)
371 : : * 0 is unauthorized for all devices
372 : : * 1 is authorized for all devices
373 : : * 2 is authorized for internal devices
374 : : */
375 : : #define USB_AUTHORIZE_WIRED -1
376 : : #define USB_AUTHORIZE_NONE 0
377 : : #define USB_AUTHORIZE_ALL 1
378 : : #define USB_AUTHORIZE_INTERNAL 2
379 : :
380 : : static int authorized_default = USB_AUTHORIZE_WIRED;
381 : : module_param(authorized_default, int, S_IRUGO|S_IWUSR);
382 : : MODULE_PARM_DESC(authorized_default,
383 : : "Default USB device authorization: 0 is not authorized, 1 is "
384 : : "authorized, 2 is authorized for internal devices, -1 is "
385 : : "authorized except for wireless USB (default, old behaviour)");
386 : : /*-------------------------------------------------------------------------*/
387 : :
388 : : /**
389 : : * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
390 : : * @s: Null-terminated ASCII (actually ISO-8859-1) string
391 : : * @buf: Buffer for USB string descriptor (header + UTF-16LE)
392 : : * @len: Length (in bytes; may be odd) of descriptor buffer.
393 : : *
394 : : * Return: The number of bytes filled in: 2 + 2*strlen(s) or @len,
395 : : * whichever is less.
396 : : *
397 : : * Note:
398 : : * USB String descriptors can contain at most 126 characters; input
399 : : * strings longer than that are truncated.
400 : : */
401 : : static unsigned
402 : 1212 : ascii2desc(char const *s, u8 *buf, unsigned len)
403 : : {
404 : 1212 : unsigned n, t = 2 + 2*strlen(s);
405 : :
406 [ - + ]: 1212 : if (t > 254)
407 : : t = 254; /* Longest possible UTF string descriptor */
408 [ + - ]: 1212 : if (len > t)
409 : : len = t;
410 : :
411 : 1212 : t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
412 : :
413 : : n = len;
414 [ + + ]: 27068 : while (n--) {
415 : 24644 : *buf++ = t;
416 [ + - ]: 24644 : if (!n--)
417 : : break;
418 : 24644 : *buf++ = t >> 8;
419 : 24644 : t = (unsigned char)*s++;
420 : : }
421 : 1212 : return len;
422 : : }
423 : :
424 : : /**
425 : : * rh_string() - provides string descriptors for root hub
426 : : * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
427 : : * @hcd: the host controller for this root hub
428 : : * @data: buffer for output packet
429 : : * @len: length of the provided buffer
430 : : *
431 : : * Produces either a manufacturer, product or serial number string for the
432 : : * virtual root hub device.
433 : : *
434 : : * Return: The number of bytes filled in: the length of the descriptor or
435 : : * of the provided buffer, whichever is less.
436 : : */
437 : : static unsigned
438 : 1616 : rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
439 : : {
440 : : char buf[100];
441 : : char const *s;
442 : : static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
443 : :
444 : : /* language ids */
445 [ + + + + : 1616 : switch (id) {
- ]
446 : : case 0:
447 : : /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
448 : : /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
449 [ + - ]: 404 : if (len > 4)
450 : : len = 4;
451 : 404 : memcpy(data, langids, len);
452 : 404 : return len;
453 : : case 1:
454 : : /* Serial number */
455 : 404 : s = hcd->self.bus_name;
456 : 404 : break;
457 : : case 2:
458 : : /* Product name */
459 : 404 : s = hcd->product_desc;
460 : 404 : break;
461 : : case 3:
462 : : /* Manufacturer */
463 : 404 : snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
464 : 404 : init_utsname()->release, hcd->driver->description);
465 : : s = buf;
466 : 404 : break;
467 : : default:
468 : : /* Can't happen; caller guarantees it */
469 : : return 0;
470 : : }
471 : :
472 : 1212 : return ascii2desc(s, data, len);
473 : : }
474 : :
475 : :
476 : : /* Root hub control transfers execute synchronously */
477 : 8856 : static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
478 : : {
479 : : struct usb_ctrlrequest *cmd;
480 : : u16 typeReq, wValue, wIndex, wLength;
481 : 8856 : u8 *ubuf = urb->transfer_buffer;
482 : : unsigned len = 0;
483 : : int status;
484 : : u8 patch_wakeup = 0;
485 : : u8 patch_protocol = 0;
486 : : u16 tbuf_size;
487 : : u8 *tbuf = NULL;
488 : : const u8 *bufp;
489 : :
490 : 8856 : might_sleep();
491 : :
492 : : spin_lock_irq(&hcd_root_hub_lock);
493 : 8856 : status = usb_hcd_link_urb_to_ep(hcd, urb);
494 : : spin_unlock_irq(&hcd_root_hub_lock);
495 [ + - ]: 8856 : if (status)
496 : : return status;
497 : 8856 : urb->hcpriv = hcd; /* Indicate it's queued */
498 : :
499 : 8856 : cmd = (struct usb_ctrlrequest *) urb->setup_packet;
500 : 8856 : typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
501 : 8856 : wValue = le16_to_cpu (cmd->wValue);
502 : 8856 : wIndex = le16_to_cpu (cmd->wIndex);
503 : 8856 : wLength = le16_to_cpu (cmd->wLength);
504 : :
505 [ + - ]: 8856 : if (wLength > urb->transfer_buffer_length)
506 : : goto error;
507 : :
508 : : /*
509 : : * tbuf should be at least as big as the
510 : : * USB hub descriptor.
511 : : */
512 [ + + ]: 8856 : tbuf_size = max_t(u16, sizeof(struct usb_hub_descriptor), wLength);
513 : 8856 : tbuf = kzalloc(tbuf_size, GFP_KERNEL);
514 [ + - ]: 8856 : if (!tbuf) {
515 : : status = -ENOMEM;
516 : : goto err_alloc;
517 : : }
518 : :
519 : : bufp = tbuf;
520 : :
521 : :
522 : 8856 : urb->actual_length = 0;
523 [ + - - - : 8856 : switch (typeReq) {
+ - - +
+ ]
524 : :
525 : : /* DEVICE REQUESTS */
526 : :
527 : : /* The root hub's remote wakeup enable bit is implemented using
528 : : * driver model wakeup flags. If this system supports wakeup
529 : : * through USB, userspace may change the default "allow wakeup"
530 : : * policy through sysfs or these calls.
531 : : *
532 : : * Most root hubs support wakeup from downstream devices, for
533 : : * runtime power management (disabling USB clocks and reducing
534 : : * VBUS power usage). However, not all of them do so; silicon,
535 : : * board, and BIOS bugs here are not uncommon, so these can't
536 : : * be treated quite like external hubs.
537 : : *
538 : : * Likewise, not all root hubs will pass wakeup events upstream,
539 : : * to wake up the whole system. So don't assume root hub and
540 : : * controller capabilities are identical.
541 : : */
542 : :
543 : : case DeviceRequest | USB_REQ_GET_STATUS:
544 : 808 : tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
545 : 404 : << USB_DEVICE_REMOTE_WAKEUP)
546 : : | (1 << USB_DEVICE_SELF_POWERED);
547 : 404 : tbuf[1] = 0;
548 : : len = 2;
549 : 404 : break;
550 : : case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
551 [ # # ]: 0 : if (wValue == USB_DEVICE_REMOTE_WAKEUP)
552 : 0 : device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
553 : : else
554 : : goto error;
555 : : break;
556 : : case DeviceOutRequest | USB_REQ_SET_FEATURE:
557 [ # # ]: 0 : if (device_can_wakeup(&hcd->self.root_hub->dev)
558 [ # # ]: 0 : && wValue == USB_DEVICE_REMOTE_WAKEUP)
559 : : device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
560 : : else
561 : : goto error;
562 : : break;
563 : : case DeviceRequest | USB_REQ_GET_CONFIGURATION:
564 : 0 : tbuf[0] = 1;
565 : : len = 1;
566 : : /* FALLTHROUGH */
567 : : case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
568 : : break;
569 : : case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
570 [ + + + - : 2828 : switch (wValue & 0xff00) {
- ]
571 : : case USB_DT_DEVICE << 8:
572 [ - - + - : 404 : switch (hcd->speed) {
- - ]
573 : : case HCD_USB32:
574 : : case HCD_USB31:
575 : : bufp = usb31_rh_dev_descriptor;
576 : : break;
577 : : case HCD_USB3:
578 : : bufp = usb3_rh_dev_descriptor;
579 : 0 : break;
580 : : case HCD_USB25:
581 : : bufp = usb25_rh_dev_descriptor;
582 : 0 : break;
583 : : case HCD_USB2:
584 : : bufp = usb2_rh_dev_descriptor;
585 : 404 : break;
586 : : case HCD_USB11:
587 : : bufp = usb11_rh_dev_descriptor;
588 : 0 : break;
589 : : default:
590 : : goto error;
591 : : }
592 : : len = 18;
593 [ + - ]: 404 : if (hcd->has_tt)
594 : : patch_protocol = 1;
595 : : break;
596 : : case USB_DT_CONFIG << 8:
597 [ + - - - ]: 808 : switch (hcd->speed) {
598 : : case HCD_USB32:
599 : : case HCD_USB31:
600 : : case HCD_USB3:
601 : : bufp = ss_rh_config_descriptor;
602 : : len = sizeof ss_rh_config_descriptor;
603 : : break;
604 : : case HCD_USB25:
605 : : case HCD_USB2:
606 : : bufp = hs_rh_config_descriptor;
607 : : len = sizeof hs_rh_config_descriptor;
608 : 808 : break;
609 : : case HCD_USB11:
610 : : bufp = fs_rh_config_descriptor;
611 : : len = sizeof fs_rh_config_descriptor;
612 : 0 : break;
613 : : default:
614 : : goto error;
615 : : }
616 [ + - ]: 1616 : if (device_can_wakeup(&hcd->self.root_hub->dev))
617 : : patch_wakeup = 1;
618 : : break;
619 : : case USB_DT_STRING << 8:
620 [ + - ]: 1616 : if ((wValue & 0xff) < 4)
621 : 1616 : urb->actual_length = rh_string(wValue & 0xff,
622 : : hcd, ubuf, wLength);
623 : : else /* unsupported IDs --> "protocol stall" */
624 : : goto error;
625 : 1616 : break;
626 : : case USB_DT_BOS << 8:
627 : : goto nongeneric;
628 : : default:
629 : : goto error;
630 : : }
631 : : break;
632 : : case DeviceRequest | USB_REQ_GET_INTERFACE:
633 : 0 : tbuf[0] = 0;
634 : : len = 1;
635 : : /* FALLTHROUGH */
636 : : case DeviceOutRequest | USB_REQ_SET_INTERFACE:
637 : : break;
638 : : case DeviceOutRequest | USB_REQ_SET_ADDRESS:
639 : : /* wValue == urb->dev->devaddr */
640 : : dev_dbg (hcd->self.controller, "root hub device address %d\n",
641 : : wValue);
642 : : break;
643 : :
644 : : /* INTERFACE REQUESTS (no defined feature/status flags) */
645 : :
646 : : /* ENDPOINT REQUESTS */
647 : :
648 : : case EndpointRequest | USB_REQ_GET_STATUS:
649 : : /* ENDPOINT_HALT flag */
650 : 0 : tbuf[0] = 0;
651 : 0 : tbuf[1] = 0;
652 : : len = 2;
653 : : /* FALLTHROUGH */
654 : : case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
655 : : case EndpointOutRequest | USB_REQ_SET_FEATURE:
656 : : dev_dbg (hcd->self.controller, "no endpoint features yet\n");
657 : : break;
658 : :
659 : : /* CLASS REQUESTS (and errors) */
660 : :
661 : : default:
662 : : nongeneric:
663 : : /* non-generic request */
664 [ + + + + ]: 5220 : switch (typeReq) {
665 : : case GetHubStatus:
666 : : len = 4;
667 : 404 : break;
668 : : case GetPortStatus:
669 [ - + ]: 1988 : if (wValue == HUB_PORT_STATUS)
670 : : len = 4;
671 : : else
672 : : /* other port status types return 8 bytes */
673 : : len = 8;
674 : : break;
675 : : case GetHubDescriptor:
676 : : len = sizeof (struct usb_hub_descriptor);
677 : 404 : break;
678 : : case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
679 : : /* len is returned by hub_control */
680 : : break;
681 : : }
682 : 5220 : status = hcd->driver->hub_control (hcd,
683 : : typeReq, wValue, wIndex,
684 : : tbuf, wLength);
685 : :
686 [ + + ]: 5220 : if (typeReq == GetHubDescriptor)
687 : 404 : usb_hub_adjust_deviceremovable(hcd->self.root_hub,
688 : : (struct usb_hub_descriptor *)tbuf);
689 : : break;
690 : : error:
691 : : /* "protocol stall" on error */
692 : : status = -EPIPE;
693 : : }
694 : :
695 [ + - ]: 8856 : if (status < 0) {
696 : : len = 0;
697 : : if (status != -EPIPE) {
698 : : dev_dbg (hcd->self.controller,
699 : : "CTRL: TypeReq=0x%x val=0x%x "
700 : : "idx=0x%x len=%d ==> %d\n",
701 : : typeReq, wValue, wIndex,
702 : : wLength, status);
703 : : }
704 [ - + ]: 8856 : } else if (status > 0) {
705 : : /* hub_control may return the length of data copied. */
706 : 0 : len = status;
707 : : status = 0;
708 : : }
709 [ + + ]: 8856 : if (len) {
710 [ + + ]: 4412 : if (urb->transfer_buffer_length < len)
711 : : len = urb->transfer_buffer_length;
712 : 4412 : urb->actual_length = len;
713 : : /* always USB_DIR_IN, toward host */
714 : 4412 : memcpy (ubuf, bufp, len);
715 : :
716 : : /* report whether RH hardware supports remote wakeup */
717 [ + + ]: 8824 : if (patch_wakeup &&
718 : 4412 : len > offsetof (struct usb_config_descriptor,
719 : : bmAttributes))
720 : : ((struct usb_config_descriptor *)ubuf)->bmAttributes
721 : 808 : |= USB_CONFIG_ATT_WAKEUP;
722 : :
723 : : /* report whether RH hardware has an integrated TT */
724 [ + + ]: 8824 : if (patch_protocol &&
725 : 4412 : len > offsetof(struct usb_device_descriptor,
726 : : bDeviceProtocol))
727 : : ((struct usb_device_descriptor *) ubuf)->
728 : 404 : bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
729 : : }
730 : :
731 : 8856 : kfree(tbuf);
732 : : err_alloc:
733 : :
734 : : /* any errors get returned through the urb completion */
735 : : spin_lock_irq(&hcd_root_hub_lock);
736 : 8856 : usb_hcd_unlink_urb_from_ep(hcd, urb);
737 : 8856 : usb_hcd_giveback_urb(hcd, urb, status);
738 : : spin_unlock_irq(&hcd_root_hub_lock);
739 : 8856 : return 0;
740 : : }
741 : :
742 : : /*-------------------------------------------------------------------------*/
743 : :
744 : : /*
745 : : * Root Hub interrupt transfers are polled using a timer if the
746 : : * driver requests it; otherwise the driver is responsible for
747 : : * calling usb_hcd_poll_rh_status() when an event occurs.
748 : : *
749 : : * Completions are called in_interrupt(), but they may or may not
750 : : * be in_irq().
751 : : */
752 : 273924 : void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
753 : : {
754 : : struct urb *urb;
755 : : int length;
756 : : unsigned long flags;
757 : : char buffer[6]; /* Any root hubs with > 31 ports? */
758 : :
759 [ + - ]: 273924 : if (unlikely(!hcd->rh_pollable))
760 : 0 : return;
761 [ + - + - ]: 273924 : if (!hcd->uses_new_polling && !hcd->status_urb)
762 : : return;
763 : :
764 : 273924 : length = hcd->driver->hub_status_data(hcd, buffer);
765 [ + + ]: 273924 : if (length > 0) {
766 : :
767 : : /* try to complete the status urb */
768 : 640 : spin_lock_irqsave(&hcd_root_hub_lock, flags);
769 : 640 : urb = hcd->status_urb;
770 [ + - ]: 640 : if (urb) {
771 : 640 : clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
772 : 640 : hcd->status_urb = NULL;
773 : 640 : urb->actual_length = length;
774 : 640 : memcpy(urb->transfer_buffer, buffer, length);
775 : :
776 : 640 : usb_hcd_unlink_urb_from_ep(hcd, urb);
777 : 640 : usb_hcd_giveback_urb(hcd, urb, 0);
778 : : } else {
779 : : length = 0;
780 : 0 : set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
781 : : }
782 : : spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
783 : : }
784 : :
785 : : /* The USB 2.0 spec says 256 ms. This is close enough and won't
786 : : * exceed that limit if HZ is 100. The math is more clunky than
787 : : * maybe expected, this is to make sure that all timers for USB devices
788 : : * fire at the same time to give the CPU a break in between */
789 [ - + + + ]: 547848 : if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
790 [ + + - + ]: 273924 : (length == 0 && hcd->status_urb != NULL))
791 : 273284 : mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
792 : : }
793 : : EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
794 : :
795 : : /* timer callback */
796 : 273924 : static void rh_timer_func (struct timer_list *t)
797 : : {
798 : 273924 : struct usb_hcd *_hcd = from_timer(_hcd, t, rh_timer);
799 : :
800 : 273924 : usb_hcd_poll_rh_status(_hcd);
801 : 273924 : }
802 : :
803 : : /*-------------------------------------------------------------------------*/
804 : :
805 : 1044 : static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
806 : : {
807 : : int retval;
808 : : unsigned long flags;
809 : 1044 : unsigned len = 1 + (urb->dev->maxchild / 8);
810 : :
811 : 1044 : spin_lock_irqsave (&hcd_root_hub_lock, flags);
812 [ + - + - ]: 1044 : if (hcd->status_urb || urb->transfer_buffer_length < len) {
813 : : dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
814 : : retval = -EINVAL;
815 : : goto done;
816 : : }
817 : :
818 : 1044 : retval = usb_hcd_link_urb_to_ep(hcd, urb);
819 [ + - ]: 1044 : if (retval)
820 : : goto done;
821 : :
822 : 1044 : hcd->status_urb = urb;
823 : 1044 : urb->hcpriv = hcd; /* indicate it's queued */
824 [ + - ]: 1044 : if (!hcd->uses_new_polling)
825 : 1044 : mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
826 : :
827 : : /* If a status change has already occurred, report it ASAP */
828 [ # # ]: 0 : else if (HCD_POLL_PENDING(hcd))
829 : 0 : mod_timer(&hcd->rh_timer, jiffies);
830 : : retval = 0;
831 : : done:
832 : : spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
833 : 1044 : return retval;
834 : : }
835 : :
836 : 9900 : static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
837 : : {
838 [ + + ]: 19800 : if (usb_endpoint_xfer_int(&urb->ep->desc))
839 : 1044 : return rh_queue_status (hcd, urb);
840 [ + - ]: 8856 : if (usb_endpoint_xfer_control(&urb->ep->desc))
841 : 8856 : return rh_call_control (hcd, urb);
842 : : return -EINVAL;
843 : : }
844 : :
845 : : /*-------------------------------------------------------------------------*/
846 : :
847 : : /* Unlinks of root-hub control URBs are legal, but they don't do anything
848 : : * since these URBs always execute synchronously.
849 : : */
850 : 0 : static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
851 : : {
852 : : unsigned long flags;
853 : : int rc;
854 : :
855 : 0 : spin_lock_irqsave(&hcd_root_hub_lock, flags);
856 : : rc = usb_hcd_check_unlink_urb(hcd, urb, status);
857 [ # # ]: 0 : if (rc)
858 : : goto done;
859 : :
860 [ # # ]: 0 : if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
861 : : ; /* Do nothing */
862 : :
863 : : } else { /* Status URB */
864 [ # # ]: 0 : if (!hcd->uses_new_polling)
865 : 0 : del_timer (&hcd->rh_timer);
866 [ # # ]: 0 : if (urb == hcd->status_urb) {
867 : 0 : hcd->status_urb = NULL;
868 : 0 : usb_hcd_unlink_urb_from_ep(hcd, urb);
869 : 0 : usb_hcd_giveback_urb(hcd, urb, status);
870 : : }
871 : : }
872 : : done:
873 : : spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
874 : 0 : return rc;
875 : : }
876 : :
877 : :
878 : : /*-------------------------------------------------------------------------*/
879 : :
880 : : /**
881 : : * usb_bus_init - shared initialization code
882 : : * @bus: the bus structure being initialized
883 : : *
884 : : * This code is used to initialize a usb_bus structure, memory for which is
885 : : * separately managed.
886 : : */
887 : 404 : static void usb_bus_init (struct usb_bus *bus)
888 : : {
889 : 404 : memset (&bus->devmap, 0, sizeof(struct usb_devmap));
890 : :
891 : 404 : bus->devnum_next = 1;
892 : :
893 : 404 : bus->root_hub = NULL;
894 : 404 : bus->busnum = -1;
895 : 404 : bus->bandwidth_allocated = 0;
896 : 404 : bus->bandwidth_int_reqs = 0;
897 : 404 : bus->bandwidth_isoc_reqs = 0;
898 : 404 : mutex_init(&bus->devnum_next_mutex);
899 : 404 : }
900 : :
901 : : /*-------------------------------------------------------------------------*/
902 : :
903 : : /**
904 : : * usb_register_bus - registers the USB host controller with the usb core
905 : : * @bus: pointer to the bus to register
906 : : * Context: !in_interrupt()
907 : : *
908 : : * Assigns a bus number, and links the controller into usbcore data
909 : : * structures so that it can be seen by scanning the bus list.
910 : : *
911 : : * Return: 0 if successful. A negative error code otherwise.
912 : : */
913 : 404 : static int usb_register_bus(struct usb_bus *bus)
914 : : {
915 : : int result = -E2BIG;
916 : : int busnum;
917 : :
918 : 404 : mutex_lock(&usb_bus_idr_lock);
919 : 404 : busnum = idr_alloc(&usb_bus_idr, bus, 1, USB_MAXBUS, GFP_KERNEL);
920 [ - + ]: 404 : if (busnum < 0) {
921 : 0 : pr_err("%s: failed to get bus number\n", usbcore_name);
922 : : goto error_find_busnum;
923 : : }
924 : 404 : bus->busnum = busnum;
925 : 404 : mutex_unlock(&usb_bus_idr_lock);
926 : :
927 : 404 : usb_notify_add_bus(bus);
928 : :
929 : 404 : dev_info (bus->controller, "new USB bus registered, assigned bus "
930 : : "number %d\n", bus->busnum);
931 : 404 : return 0;
932 : :
933 : : error_find_busnum:
934 : 0 : mutex_unlock(&usb_bus_idr_lock);
935 : 0 : return result;
936 : : }
937 : :
938 : : /**
939 : : * usb_deregister_bus - deregisters the USB host controller
940 : : * @bus: pointer to the bus to deregister
941 : : * Context: !in_interrupt()
942 : : *
943 : : * Recycles the bus number, and unlinks the controller from usbcore data
944 : : * structures so that it won't be seen by scanning the bus list.
945 : : */
946 : 0 : static void usb_deregister_bus (struct usb_bus *bus)
947 : : {
948 : 0 : dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
949 : :
950 : : /*
951 : : * NOTE: make sure that all the devices are removed by the
952 : : * controller code, as well as having it call this when cleaning
953 : : * itself up
954 : : */
955 : 0 : mutex_lock(&usb_bus_idr_lock);
956 : 0 : idr_remove(&usb_bus_idr, bus->busnum);
957 : 0 : mutex_unlock(&usb_bus_idr_lock);
958 : :
959 : 0 : usb_notify_remove_bus(bus);
960 : 0 : }
961 : :
962 : : /**
963 : : * register_root_hub - called by usb_add_hcd() to register a root hub
964 : : * @hcd: host controller for this root hub
965 : : *
966 : : * This function registers the root hub with the USB subsystem. It sets up
967 : : * the device properly in the device tree and then calls usb_new_device()
968 : : * to register the usb device. It also assigns the root hub's USB address
969 : : * (always 1).
970 : : *
971 : : * Return: 0 if successful. A negative error code otherwise.
972 : : */
973 : 404 : static int register_root_hub(struct usb_hcd *hcd)
974 : : {
975 : 404 : struct device *parent_dev = hcd->self.controller;
976 : 404 : struct usb_device *usb_dev = hcd->self.root_hub;
977 : : const int devnum = 1;
978 : : int retval;
979 : :
980 : 404 : usb_dev->devnum = devnum;
981 : 404 : usb_dev->bus->devnum_next = devnum + 1;
982 : 404 : set_bit (devnum, usb_dev->bus->devmap.devicemap);
983 : 404 : usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
984 : :
985 : 404 : mutex_lock(&usb_bus_idr_lock);
986 : :
987 : 404 : usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
988 : 404 : retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
989 [ - + ]: 404 : if (retval != sizeof usb_dev->descriptor) {
990 : 0 : mutex_unlock(&usb_bus_idr_lock);
991 : : dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
992 : : dev_name(&usb_dev->dev), retval);
993 [ # # ]: 0 : return (retval < 0) ? retval : -EMSGSIZE;
994 : : }
995 : :
996 [ - + ]: 404 : if (le16_to_cpu(usb_dev->descriptor.bcdUSB) >= 0x0201) {
997 : 0 : retval = usb_get_bos_descriptor(usb_dev);
998 [ # # ]: 0 : if (!retval) {
999 : 0 : usb_dev->lpm_capable = usb_device_supports_lpm(usb_dev);
1000 [ # # ]: 0 : } else if (usb_dev->speed >= USB_SPEED_SUPER) {
1001 : 0 : mutex_unlock(&usb_bus_idr_lock);
1002 : : dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
1003 : : dev_name(&usb_dev->dev), retval);
1004 : 0 : return retval;
1005 : : }
1006 : : }
1007 : :
1008 : 404 : retval = usb_new_device (usb_dev);
1009 [ - + ]: 404 : if (retval) {
1010 : 0 : dev_err (parent_dev, "can't register root hub for %s, %d\n",
1011 : : dev_name(&usb_dev->dev), retval);
1012 : : } else {
1013 : : spin_lock_irq (&hcd_root_hub_lock);
1014 : 404 : hcd->rh_registered = 1;
1015 : : spin_unlock_irq (&hcd_root_hub_lock);
1016 : :
1017 : : /* Did the HC die before the root hub was registered? */
1018 [ - + ]: 404 : if (HCD_DEAD(hcd))
1019 : 0 : usb_hc_died (hcd); /* This time clean up */
1020 : : }
1021 : 404 : mutex_unlock(&usb_bus_idr_lock);
1022 : :
1023 : 404 : return retval;
1024 : : }
1025 : :
1026 : : /*
1027 : : * usb_hcd_start_port_resume - a root-hub port is sending a resume signal
1028 : : * @bus: the bus which the root hub belongs to
1029 : : * @portnum: the port which is being resumed
1030 : : *
1031 : : * HCDs should call this function when they know that a resume signal is
1032 : : * being sent to a root-hub port. The root hub will be prevented from
1033 : : * going into autosuspend until usb_hcd_end_port_resume() is called.
1034 : : *
1035 : : * The bus's private lock must be held by the caller.
1036 : : */
1037 : 0 : void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum)
1038 : : {
1039 : 0 : unsigned bit = 1 << portnum;
1040 : :
1041 [ # # ]: 0 : if (!(bus->resuming_ports & bit)) {
1042 : 0 : bus->resuming_ports |= bit;
1043 : 0 : pm_runtime_get_noresume(&bus->root_hub->dev);
1044 : : }
1045 : 0 : }
1046 : : EXPORT_SYMBOL_GPL(usb_hcd_start_port_resume);
1047 : :
1048 : : /*
1049 : : * usb_hcd_end_port_resume - a root-hub port has stopped sending a resume signal
1050 : : * @bus: the bus which the root hub belongs to
1051 : : * @portnum: the port which is being resumed
1052 : : *
1053 : : * HCDs should call this function when they know that a resume signal has
1054 : : * stopped being sent to a root-hub port. The root hub will be allowed to
1055 : : * autosuspend again.
1056 : : *
1057 : : * The bus's private lock must be held by the caller.
1058 : : */
1059 : 0 : void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum)
1060 : : {
1061 : 0 : unsigned bit = 1 << portnum;
1062 : :
1063 [ # # ]: 0 : if (bus->resuming_ports & bit) {
1064 : 0 : bus->resuming_ports &= ~bit;
1065 : 0 : pm_runtime_put_noidle(&bus->root_hub->dev);
1066 : : }
1067 : 0 : }
1068 : : EXPORT_SYMBOL_GPL(usb_hcd_end_port_resume);
1069 : :
1070 : : /*-------------------------------------------------------------------------*/
1071 : :
1072 : : /**
1073 : : * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1074 : : * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1075 : : * @is_input: true iff the transaction sends data to the host
1076 : : * @isoc: true for isochronous transactions, false for interrupt ones
1077 : : * @bytecount: how many bytes in the transaction.
1078 : : *
1079 : : * Return: Approximate bus time in nanoseconds for a periodic transaction.
1080 : : *
1081 : : * Note:
1082 : : * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1083 : : * scheduled in software, this function is only used for such scheduling.
1084 : : */
1085 : 0 : long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1086 : : {
1087 : : unsigned long tmp;
1088 : :
1089 [ # # # # ]: 0 : switch (speed) {
1090 : : case USB_SPEED_LOW: /* INTR only */
1091 [ # # ]: 0 : if (is_input) {
1092 : 0 : tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
1093 : 0 : return 64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1094 : : } else {
1095 : 0 : tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1096 : 0 : return 64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1097 : : }
1098 : : case USB_SPEED_FULL: /* ISOC or INTR */
1099 [ # # ]: 0 : if (isoc) {
1100 : 0 : tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1101 [ # # ]: 0 : return ((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp;
1102 : : } else {
1103 : 0 : tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1104 : 0 : return 9107L + BW_HOST_DELAY + tmp;
1105 : : }
1106 : : case USB_SPEED_HIGH: /* ISOC or INTR */
1107 : : /* FIXME adjust for input vs output */
1108 [ # # ]: 0 : if (isoc)
1109 : 0 : tmp = HS_NSECS_ISO (bytecount);
1110 : : else
1111 : 0 : tmp = HS_NSECS (bytecount);
1112 : 0 : return tmp;
1113 : : default:
1114 : : pr_debug ("%s: bogus device speed!\n", usbcore_name);
1115 : : return -1;
1116 : : }
1117 : : }
1118 : : EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1119 : :
1120 : :
1121 : : /*-------------------------------------------------------------------------*/
1122 : :
1123 : : /*
1124 : : * Generic HC operations.
1125 : : */
1126 : :
1127 : : /*-------------------------------------------------------------------------*/
1128 : :
1129 : : /**
1130 : : * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1131 : : * @hcd: host controller to which @urb was submitted
1132 : : * @urb: URB being submitted
1133 : : *
1134 : : * Host controller drivers should call this routine in their enqueue()
1135 : : * method. The HCD's private spinlock must be held and interrupts must
1136 : : * be disabled. The actions carried out here are required for URB
1137 : : * submission, as well as for endpoint shutdown and for usb_kill_urb.
1138 : : *
1139 : : * Return: 0 for no error, otherwise a negative error code (in which case
1140 : : * the enqueue() method must fail). If no error occurs but enqueue() fails
1141 : : * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1142 : : * the private spinlock and returning.
1143 : : */
1144 : 195470 : int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1145 : : {
1146 : : int rc = 0;
1147 : :
1148 : : spin_lock(&hcd_urb_list_lock);
1149 : :
1150 : : /* Check that the URB isn't being killed */
1151 [ + - ]: 195470 : if (unlikely(atomic_read(&urb->reject))) {
1152 : : rc = -EPERM;
1153 : : goto done;
1154 : : }
1155 : :
1156 [ + - ]: 195470 : if (unlikely(!urb->ep->enabled)) {
1157 : : rc = -ENOENT;
1158 : : goto done;
1159 : : }
1160 : :
1161 [ + - ]: 195470 : if (unlikely(!urb->dev->can_submit)) {
1162 : : rc = -EHOSTUNREACH;
1163 : : goto done;
1164 : : }
1165 : :
1166 : : /*
1167 : : * Check the host controller's state and add the URB to the
1168 : : * endpoint's queue.
1169 : : */
1170 [ + - ]: 195470 : if (HCD_RH_RUNNING(hcd)) {
1171 : 195470 : urb->unlinked = 0;
1172 : 195470 : list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1173 : : } else {
1174 : : rc = -ESHUTDOWN;
1175 : : goto done;
1176 : : }
1177 : : done:
1178 : : spin_unlock(&hcd_urb_list_lock);
1179 : 195470 : return rc;
1180 : : }
1181 : : EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1182 : :
1183 : : /**
1184 : : * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1185 : : * @hcd: host controller to which @urb was submitted
1186 : : * @urb: URB being checked for unlinkability
1187 : : * @status: error code to store in @urb if the unlink succeeds
1188 : : *
1189 : : * Host controller drivers should call this routine in their dequeue()
1190 : : * method. The HCD's private spinlock must be held and interrupts must
1191 : : * be disabled. The actions carried out here are required for making
1192 : : * sure than an unlink is valid.
1193 : : *
1194 : : * Return: 0 for no error, otherwise a negative error code (in which case
1195 : : * the dequeue() method must fail). The possible error codes are:
1196 : : *
1197 : : * -EIDRM: @urb was not submitted or has already completed.
1198 : : * The completion function may not have been called yet.
1199 : : *
1200 : : * -EBUSY: @urb has already been unlinked.
1201 : : */
1202 : 182586 : int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1203 : : int status)
1204 : : {
1205 : : struct list_head *tmp;
1206 : :
1207 : : /* insist the urb is still queued */
1208 [ + - # # ]: 182586 : list_for_each(tmp, &urb->ep->urb_list) {
1209 [ - + # # ]: 182586 : if (tmp == &urb->urb_list)
1210 : : break;
1211 : : }
1212 [ + - # # ]: 182586 : if (tmp != &urb->urb_list)
1213 : : return -EIDRM;
1214 : :
1215 : : /* Any status except -EINPROGRESS means something already started to
1216 : : * unlink this URB from the hardware. So there's no more work to do.
1217 : : */
1218 [ + - # # ]: 182586 : if (urb->unlinked)
1219 : : return -EBUSY;
1220 : 182586 : urb->unlinked = status;
1221 : 182586 : return 0;
1222 : : }
1223 : : EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1224 : :
1225 : : /**
1226 : : * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1227 : : * @hcd: host controller to which @urb was submitted
1228 : : * @urb: URB being unlinked
1229 : : *
1230 : : * Host controller drivers should call this routine before calling
1231 : : * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1232 : : * interrupts must be disabled. The actions carried out here are required
1233 : : * for URB completion.
1234 : : */
1235 : 192082 : void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1236 : : {
1237 : : /* clear all state linking urb to this dev (and hcd) */
1238 : : spin_lock(&hcd_urb_list_lock);
1239 : 192082 : list_del_init(&urb->urb_list);
1240 : : spin_unlock(&hcd_urb_list_lock);
1241 : 192082 : }
1242 : : EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1243 : :
1244 : : /*
1245 : : * Some usb host controllers can only perform dma using a small SRAM area.
1246 : : * The usb core itself is however optimized for host controllers that can dma
1247 : : * using regular system memory - like pci devices doing bus mastering.
1248 : : *
1249 : : * To support host controllers with limited dma capabilities we provide dma
1250 : : * bounce buffers. This feature can be enabled by initializing
1251 : : * hcd->localmem_pool using usb_hcd_setup_local_mem().
1252 : : *
1253 : : * The initialized hcd->localmem_pool then tells the usb code to allocate all
1254 : : * data for dma using the genalloc API.
1255 : : *
1256 : : * So, to summarize...
1257 : : *
1258 : : * - We need "local" memory, canonical example being
1259 : : * a small SRAM on a discrete controller being the
1260 : : * only memory that the controller can read ...
1261 : : * (a) "normal" kernel memory is no good, and
1262 : : * (b) there's not enough to share
1263 : : *
1264 : : * - So we use that, even though the primary requirement
1265 : : * is that the memory be "local" (hence addressable
1266 : : * by that device), not "coherent".
1267 : : *
1268 : : */
1269 : :
1270 : 0 : static int hcd_alloc_coherent(struct usb_bus *bus,
1271 : : gfp_t mem_flags, dma_addr_t *dma_handle,
1272 : : void **vaddr_handle, size_t size,
1273 : : enum dma_data_direction dir)
1274 : : {
1275 : : unsigned char *vaddr;
1276 : :
1277 [ # # ]: 0 : if (*vaddr_handle == NULL) {
1278 [ # # ]: 0 : WARN_ON_ONCE(1);
1279 : : return -EFAULT;
1280 : : }
1281 : :
1282 : 0 : vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1283 : : mem_flags, dma_handle);
1284 [ # # ]: 0 : if (!vaddr)
1285 : : return -ENOMEM;
1286 : :
1287 : : /*
1288 : : * Store the virtual address of the buffer at the end
1289 : : * of the allocated dma buffer. The size of the buffer
1290 : : * may be uneven so use unaligned functions instead
1291 : : * of just rounding up. It makes sense to optimize for
1292 : : * memory footprint over access speed since the amount
1293 : : * of memory available for dma may be limited.
1294 : : */
1295 : 0 : put_unaligned((unsigned long)*vaddr_handle,
1296 : : (unsigned long *)(vaddr + size));
1297 : :
1298 [ # # ]: 0 : if (dir == DMA_TO_DEVICE)
1299 : 0 : memcpy(vaddr, *vaddr_handle, size);
1300 : :
1301 : 0 : *vaddr_handle = vaddr;
1302 : 0 : return 0;
1303 : : }
1304 : :
1305 : 0 : static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1306 : : void **vaddr_handle, size_t size,
1307 : : enum dma_data_direction dir)
1308 : : {
1309 : 0 : unsigned char *vaddr = *vaddr_handle;
1310 : :
1311 : 0 : vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1312 : :
1313 [ # # ]: 0 : if (dir == DMA_FROM_DEVICE)
1314 : 0 : memcpy(vaddr, *vaddr_handle, size);
1315 : :
1316 : 0 : hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1317 : :
1318 : 0 : *vaddr_handle = vaddr;
1319 : 0 : *dma_handle = 0;
1320 : 0 : }
1321 : :
1322 : 192082 : void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
1323 : : {
1324 [ + + ]: 192082 : if (IS_ENABLED(CONFIG_HAS_DMA) &&
1325 : 192082 : (urb->transfer_flags & URB_SETUP_MAP_SINGLE))
1326 : 45706 : dma_unmap_single(hcd->self.sysdev,
1327 : : urb->setup_dma,
1328 : : sizeof(struct usb_ctrlrequest),
1329 : : DMA_TO_DEVICE);
1330 [ - + ]: 146376 : else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1331 : 0 : hcd_free_coherent(urb->dev->bus,
1332 : : &urb->setup_dma,
1333 : 0 : (void **) &urb->setup_packet,
1334 : : sizeof(struct usb_ctrlrequest),
1335 : : DMA_TO_DEVICE);
1336 : :
1337 : : /* Make it safe to call this routine more than once */
1338 : 192082 : urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1339 : 192082 : }
1340 : : EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1341 : :
1342 : 192082 : static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1343 : : {
1344 [ - + ]: 192082 : if (hcd->driver->unmap_urb_for_dma)
1345 : 0 : hcd->driver->unmap_urb_for_dma(hcd, urb);
1346 : : else
1347 : 192082 : usb_hcd_unmap_urb_for_dma(hcd, urb);
1348 : 192082 : }
1349 : :
1350 : 192082 : void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1351 : : {
1352 : : enum dma_data_direction dir;
1353 : :
1354 : 192082 : usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1355 : :
1356 [ + + ]: 192082 : dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1357 [ - + ]: 192082 : if (IS_ENABLED(CONFIG_HAS_DMA) &&
1358 : 192082 : (urb->transfer_flags & URB_DMA_MAP_SG))
1359 : 0 : dma_unmap_sg(hcd->self.sysdev,
1360 : : urb->sg,
1361 : : urb->num_sgs,
1362 : : dir);
1363 [ - + ]: 192082 : else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1364 : 192082 : (urb->transfer_flags & URB_DMA_MAP_PAGE))
1365 : 0 : dma_unmap_page(hcd->self.sysdev,
1366 : : urb->transfer_dma,
1367 : : urb->transfer_buffer_length,
1368 : : dir);
1369 [ + + ]: 192082 : else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1370 : 192082 : (urb->transfer_flags & URB_DMA_MAP_SINGLE))
1371 : 158070 : dma_unmap_single(hcd->self.sysdev,
1372 : : urb->transfer_dma,
1373 : : urb->transfer_buffer_length,
1374 : : dir);
1375 [ - + ]: 34012 : else if (urb->transfer_flags & URB_MAP_LOCAL)
1376 : 0 : hcd_free_coherent(urb->dev->bus,
1377 : : &urb->transfer_dma,
1378 : : &urb->transfer_buffer,
1379 : : urb->transfer_buffer_length,
1380 : : dir);
1381 : :
1382 : : /* Make it safe to call this routine more than once */
1383 : 192082 : urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
1384 : : URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1385 : 192082 : }
1386 : : EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
1387 : :
1388 : 185568 : static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1389 : : gfp_t mem_flags)
1390 : : {
1391 [ - + ]: 185568 : if (hcd->driver->map_urb_for_dma)
1392 : 0 : return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1393 : : else
1394 : 185568 : return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1395 : : }
1396 : :
1397 : 185570 : int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1398 : : gfp_t mem_flags)
1399 : : {
1400 : : enum dma_data_direction dir;
1401 : : int ret = 0;
1402 : :
1403 : : /* Map the URB's buffers for DMA access.
1404 : : * Lower level HCD code should use *_dma exclusively,
1405 : : * unless it uses pio or talks to another transport,
1406 : : * or uses the provided scatter gather list for bulk.
1407 : : */
1408 : :
1409 [ + + ]: 371140 : if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1410 [ + - ]: 45706 : if (hcd->self.uses_pio_for_control)
1411 : : return ret;
1412 [ - + ]: 45706 : if (hcd->localmem_pool) {
1413 : 0 : ret = hcd_alloc_coherent(
1414 : 0 : urb->dev->bus, mem_flags,
1415 : : &urb->setup_dma,
1416 : 0 : (void **)&urb->setup_packet,
1417 : : sizeof(struct usb_ctrlrequest),
1418 : : DMA_TO_DEVICE);
1419 [ # # ]: 0 : if (ret)
1420 : : return ret;
1421 : 0 : urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1422 [ + - ]: 45706 : } else if (hcd_uses_dma(hcd)) {
1423 [ - + ]: 91412 : if (is_vmalloc_addr(urb->setup_packet)) {
1424 [ # # ]: 0 : WARN_ONCE(1, "setup packet is not dma capable\n");
1425 : : return -EAGAIN;
1426 [ - + ]: 45706 : } else if (object_is_on_stack(urb->setup_packet)) {
1427 [ # # ]: 0 : WARN_ONCE(1, "setup packet is on stack\n");
1428 : : return -EAGAIN;
1429 : : }
1430 : :
1431 : 45706 : urb->setup_dma = dma_map_single(
1432 : : hcd->self.sysdev,
1433 : : urb->setup_packet,
1434 : : sizeof(struct usb_ctrlrequest),
1435 : : DMA_TO_DEVICE);
1436 [ + - ]: 45706 : if (dma_mapping_error(hcd->self.sysdev,
1437 : : urb->setup_dma))
1438 : : return -EAGAIN;
1439 : 45706 : urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1440 : : }
1441 : : }
1442 : :
1443 [ + + ]: 185570 : dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1444 [ + + ]: 185570 : if (urb->transfer_buffer_length != 0
1445 [ + + ]: 169330 : && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1446 [ - + ]: 160246 : if (hcd->localmem_pool) {
1447 : 0 : ret = hcd_alloc_coherent(
1448 : 0 : urb->dev->bus, mem_flags,
1449 : : &urb->transfer_dma,
1450 : : &urb->transfer_buffer,
1451 : : urb->transfer_buffer_length,
1452 : : dir);
1453 [ # # ]: 0 : if (ret == 0)
1454 : 0 : urb->transfer_flags |= URB_MAP_LOCAL;
1455 [ + + ]: 160246 : } else if (hcd_uses_dma(hcd)) {
1456 [ - + ]: 160244 : if (urb->num_sgs) {
1457 : : int n;
1458 : :
1459 : : /* We don't support sg for isoc transfers ! */
1460 [ # # ]: 0 : if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1461 : 0 : WARN_ON(1);
1462 : 0 : return -EINVAL;
1463 : : }
1464 : :
1465 : 0 : n = dma_map_sg(
1466 : : hcd->self.sysdev,
1467 : : urb->sg,
1468 : : urb->num_sgs,
1469 : : dir);
1470 [ # # ]: 0 : if (n <= 0)
1471 : : ret = -EAGAIN;
1472 : : else
1473 : 0 : urb->transfer_flags |= URB_DMA_MAP_SG;
1474 : 0 : urb->num_mapped_sgs = n;
1475 [ # # ]: 0 : if (n != urb->num_sgs)
1476 : 0 : urb->transfer_flags |=
1477 : : URB_DMA_SG_COMBINED;
1478 [ - + ]: 160244 : } else if (urb->sg) {
1479 : : struct scatterlist *sg = urb->sg;
1480 : 0 : urb->transfer_dma = dma_map_page(
1481 : : hcd->self.sysdev,
1482 : : sg_page(sg),
1483 : : sg->offset,
1484 : : urb->transfer_buffer_length,
1485 : : dir);
1486 [ # # ]: 0 : if (dma_mapping_error(hcd->self.sysdev,
1487 : : urb->transfer_dma))
1488 : : ret = -EAGAIN;
1489 : : else
1490 : 0 : urb->transfer_flags |= URB_DMA_MAP_PAGE;
1491 [ - + ]: 320488 : } else if (is_vmalloc_addr(urb->transfer_buffer)) {
1492 [ # # ]: 0 : WARN_ONCE(1, "transfer buffer not dma capable\n");
1493 : : ret = -EAGAIN;
1494 [ - + ]: 160244 : } else if (object_is_on_stack(urb->transfer_buffer)) {
1495 [ # # ]: 0 : WARN_ONCE(1, "transfer buffer is on stack\n");
1496 : : ret = -EAGAIN;
1497 : : } else {
1498 : 160244 : urb->transfer_dma = dma_map_single(
1499 : : hcd->self.sysdev,
1500 : : urb->transfer_buffer,
1501 : : urb->transfer_buffer_length,
1502 : : dir);
1503 [ + - ]: 160246 : if (dma_mapping_error(hcd->self.sysdev,
1504 : : urb->transfer_dma))
1505 : : ret = -EAGAIN;
1506 : : else
1507 : 160246 : urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1508 : : }
1509 : : }
1510 [ - + # # ]: 160246 : if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1511 : : URB_SETUP_MAP_LOCAL)))
1512 : 0 : usb_hcd_unmap_urb_for_dma(hcd, urb);
1513 : : }
1514 : 185570 : return ret;
1515 : : }
1516 : : EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1517 : :
1518 : : /*-------------------------------------------------------------------------*/
1519 : :
1520 : : /* may be called in any context with a valid urb->dev usecount
1521 : : * caller surrenders "ownership" of urb
1522 : : * expects usb_submit_urb() to have sanity checked and conditioned all
1523 : : * inputs in the urb
1524 : : */
1525 : 195468 : int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1526 : : {
1527 : : int status;
1528 : 195468 : struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1529 : :
1530 : : /* increment urb's reference count as part of giving it to the HCD
1531 : : * (which will control it). HCD guarantees that it either returns
1532 : : * an error or calls giveback(), but not both.
1533 : : */
1534 : 195468 : usb_get_urb(urb);
1535 : 195470 : atomic_inc(&urb->use_count);
1536 : 195468 : atomic_inc(&urb->dev->urbnum);
1537 : 195466 : usbmon_urb_submit(&hcd->self, urb);
1538 : :
1539 : : /* NOTE requirements on root-hub callers (usbfs and the hub
1540 : : * driver, for now): URBs' urb->transfer_buffer must be
1541 : : * valid and usb_buffer_{sync,unmap}() not be needed, since
1542 : : * they could clobber root hub response data. Also, control
1543 : : * URBs must be submitted in process context with interrupts
1544 : : * enabled.
1545 : : */
1546 : :
1547 [ + + ]: 390936 : if (is_root_hub(urb->dev)) {
1548 : 9900 : status = rh_urb_enqueue(hcd, urb);
1549 : : } else {
1550 : 185568 : status = map_urb_for_dma(hcd, urb, mem_flags);
1551 [ + + ]: 185564 : if (likely(status == 0)) {
1552 : 185562 : status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1553 [ - + ]: 185570 : if (unlikely(status))
1554 : 0 : unmap_urb_for_dma(hcd, urb);
1555 : : }
1556 : : }
1557 : :
1558 [ - + ]: 195470 : if (unlikely(status)) {
1559 : : usbmon_urb_submit_error(&hcd->self, urb, status);
1560 : 0 : urb->hcpriv = NULL;
1561 : 0 : INIT_LIST_HEAD(&urb->urb_list);
1562 : : atomic_dec(&urb->use_count);
1563 : 0 : atomic_dec(&urb->dev->urbnum);
1564 [ # # ]: 0 : if (atomic_read(&urb->reject))
1565 : 0 : wake_up(&usb_kill_urb_queue);
1566 : 0 : usb_put_urb(urb);
1567 : : }
1568 : 195470 : return status;
1569 : : }
1570 : :
1571 : : /*-------------------------------------------------------------------------*/
1572 : :
1573 : : /* this makes the hcd giveback() the urb more quickly, by kicking it
1574 : : * off hardware queues (which may take a while) and returning it as
1575 : : * soon as practical. we've already set up the urb's return status,
1576 : : * but we can't know if the callback completed already.
1577 : : */
1578 : 1038 : static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1579 : : {
1580 : : int value;
1581 : :
1582 [ - + ]: 2076 : if (is_root_hub(urb->dev))
1583 : 0 : value = usb_rh_urb_dequeue(hcd, urb, status);
1584 : : else {
1585 : :
1586 : : /* The only reason an HCD might fail this call is if
1587 : : * it has not yet fully queued the urb to begin with.
1588 : : * Such failures should be harmless. */
1589 : 1038 : value = hcd->driver->urb_dequeue(hcd, urb, status);
1590 : : }
1591 : 1038 : return value;
1592 : : }
1593 : :
1594 : : /*
1595 : : * called in any context
1596 : : *
1597 : : * caller guarantees urb won't be recycled till both unlink()
1598 : : * and the urb's completion function return
1599 : : */
1600 : 1038 : int usb_hcd_unlink_urb (struct urb *urb, int status)
1601 : : {
1602 : : struct usb_hcd *hcd;
1603 : 1038 : struct usb_device *udev = urb->dev;
1604 : : int retval = -EIDRM;
1605 : : unsigned long flags;
1606 : :
1607 : : /* Prevent the device and bus from going away while
1608 : : * the unlink is carried out. If they are already gone
1609 : : * then urb->use_count must be 0, since disconnected
1610 : : * devices can't have any active URBs.
1611 : : */
1612 : 1038 : spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1613 [ + - ]: 1038 : if (atomic_read(&urb->use_count) > 0) {
1614 : : retval = 0;
1615 : 1038 : usb_get_dev(udev);
1616 : : }
1617 : : spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1618 [ + - ]: 1038 : if (retval == 0) {
1619 : 1038 : hcd = bus_to_hcd(urb->dev->bus);
1620 : 1038 : retval = unlink1(hcd, urb, status);
1621 [ + - ]: 1038 : if (retval == 0)
1622 : : retval = -EINPROGRESS;
1623 : : else if (retval != -EIDRM && retval != -EBUSY)
1624 : : dev_dbg(&udev->dev, "hcd_unlink_urb %pK fail %d\n",
1625 : : urb, retval);
1626 : 1038 : usb_put_dev(udev);
1627 : : }
1628 : 1038 : return retval;
1629 : : }
1630 : :
1631 : : /*-------------------------------------------------------------------------*/
1632 : :
1633 : 192082 : static void __usb_hcd_giveback_urb(struct urb *urb)
1634 : : {
1635 : 192082 : struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1636 : 192082 : struct usb_anchor *anchor = urb->anchor;
1637 : 192082 : int status = urb->unlinked;
1638 : :
1639 : 192082 : urb->hcpriv = NULL;
1640 [ - + # # : 192082 : if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
- + # # ]
1641 : : urb->actual_length < urb->transfer_buffer_length &&
1642 : : !status))
1643 : : status = -EREMOTEIO;
1644 : :
1645 : 192082 : unmap_urb_for_dma(hcd, urb);
1646 : 192082 : usbmon_urb_complete(&hcd->self, urb, status);
1647 : 192082 : usb_anchor_suspend_wakeups(anchor);
1648 : 192082 : usb_unanchor_urb(urb);
1649 : : if (likely(status == 0))
1650 : : usb_led_activity(USB_LED_EVENT_HOST);
1651 : :
1652 : : /* pass ownership to the completion handler */
1653 : 192082 : urb->status = status;
1654 : 192082 : urb->complete(urb);
1655 : :
1656 : 192082 : usb_anchor_resume_wakeups(anchor);
1657 : 192082 : atomic_dec(&urb->use_count);
1658 [ + + ]: 192082 : if (unlikely(atomic_read(&urb->reject)))
1659 : 1038 : wake_up(&usb_kill_urb_queue);
1660 : 192082 : usb_put_urb(urb);
1661 : 192082 : }
1662 : :
1663 : 9496 : static void usb_giveback_urb_bh(unsigned long param)
1664 : : {
1665 : 9496 : struct giveback_urb_bh *bh = (struct giveback_urb_bh *)param;
1666 : : struct list_head local_list;
1667 : :
1668 : : spin_lock_irq(&bh->lock);
1669 : 9496 : bh->running = true;
1670 : : restart:
1671 : 9496 : list_replace_init(&bh->head, &local_list);
1672 : : spin_unlock_irq(&bh->lock);
1673 : :
1674 [ + + ]: 18992 : while (!list_empty(&local_list)) {
1675 : : struct urb *urb;
1676 : :
1677 : 9496 : urb = list_entry(local_list.next, struct urb, urb_list);
1678 : 9496 : list_del_init(&urb->urb_list);
1679 : 9496 : bh->completing_ep = urb->ep;
1680 : 9496 : __usb_hcd_giveback_urb(urb);
1681 : 9496 : bh->completing_ep = NULL;
1682 : : }
1683 : :
1684 : : /* check if there are new URBs to giveback */
1685 : : spin_lock_irq(&bh->lock);
1686 [ - + ]: 9496 : if (!list_empty(&bh->head))
1687 : : goto restart;
1688 : 9496 : bh->running = false;
1689 : : spin_unlock_irq(&bh->lock);
1690 : 9496 : }
1691 : :
1692 : : /**
1693 : : * usb_hcd_giveback_urb - return URB from HCD to device driver
1694 : : * @hcd: host controller returning the URB
1695 : : * @urb: urb being returned to the USB device driver.
1696 : : * @status: completion status code for the URB.
1697 : : * Context: in_interrupt()
1698 : : *
1699 : : * This hands the URB from HCD to its USB device driver, using its
1700 : : * completion function. The HCD has freed all per-urb resources
1701 : : * (and is done using urb->hcpriv). It also released all HCD locks;
1702 : : * the device driver won't cause problems if it frees, modifies,
1703 : : * or resubmits this URB.
1704 : : *
1705 : : * If @urb was unlinked, the value of @status will be overridden by
1706 : : * @urb->unlinked. Erroneous short transfers are detected in case
1707 : : * the HCD hasn't checked for them.
1708 : : */
1709 : 192082 : void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1710 : : {
1711 : : struct giveback_urb_bh *bh;
1712 : : bool running, high_prio_bh;
1713 : :
1714 : : /* pass status to tasklet via unlinked */
1715 [ + + ]: 192082 : if (likely(!urb->unlinked))
1716 : 188540 : urb->unlinked = status;
1717 : :
1718 [ + - + + ]: 384164 : if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
1719 : 182586 : __usb_hcd_giveback_urb(urb);
1720 : 374668 : return;
1721 : : }
1722 : :
1723 [ + + ]: 9496 : if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe)) {
1724 : 640 : bh = &hcd->high_prio_bh;
1725 : : high_prio_bh = true;
1726 : : } else {
1727 : 8856 : bh = &hcd->low_prio_bh;
1728 : : high_prio_bh = false;
1729 : : }
1730 : :
1731 : : spin_lock(&bh->lock);
1732 : 9496 : list_add_tail(&urb->urb_list, &bh->head);
1733 : 9496 : running = bh->running;
1734 : : spin_unlock(&bh->lock);
1735 : :
1736 [ + - ]: 9496 : if (running)
1737 : : ;
1738 [ + + ]: 9496 : else if (high_prio_bh)
1739 : 640 : tasklet_hi_schedule(&bh->bh);
1740 : : else
1741 : 8856 : tasklet_schedule(&bh->bh);
1742 : : }
1743 : : EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
1744 : :
1745 : : /*-------------------------------------------------------------------------*/
1746 : :
1747 : : /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1748 : : * queue to drain completely. The caller must first insure that no more
1749 : : * URBs can be submitted for this endpoint.
1750 : : */
1751 : 5656 : void usb_hcd_flush_endpoint(struct usb_device *udev,
1752 : : struct usb_host_endpoint *ep)
1753 : : {
1754 : : struct usb_hcd *hcd;
1755 : : struct urb *urb;
1756 : :
1757 [ + - ]: 5656 : if (!ep)
1758 : 5656 : return;
1759 : 5656 : might_sleep();
1760 : 5656 : hcd = bus_to_hcd(udev->bus);
1761 : :
1762 : : /* No more submits can occur */
1763 : : spin_lock_irq(&hcd_urb_list_lock);
1764 : : rescan:
1765 [ - + ]: 11312 : list_for_each_entry_reverse(urb, &ep->urb_list, urb_list) {
1766 : : int is_in;
1767 : :
1768 [ # # ]: 0 : if (urb->unlinked)
1769 : 0 : continue;
1770 : 0 : usb_get_urb (urb);
1771 : : is_in = usb_urb_dir_in(urb);
1772 : : spin_unlock(&hcd_urb_list_lock);
1773 : :
1774 : : /* kick hcd */
1775 : 0 : unlink1(hcd, urb, -ESHUTDOWN);
1776 : : dev_dbg (hcd->self.controller,
1777 : : "shutdown urb %pK ep%d%s-%s\n",
1778 : : urb, usb_endpoint_num(&ep->desc),
1779 : : is_in ? "in" : "out",
1780 : : usb_ep_type_string(usb_endpoint_type(&ep->desc)));
1781 : 0 : usb_put_urb (urb);
1782 : :
1783 : : /* list contents may have changed */
1784 : : spin_lock(&hcd_urb_list_lock);
1785 : : goto rescan;
1786 : : }
1787 : : spin_unlock_irq(&hcd_urb_list_lock);
1788 : :
1789 : : /* Wait until the endpoint queue is completely empty */
1790 [ - + ]: 11312 : while (!list_empty (&ep->urb_list)) {
1791 : : spin_lock_irq(&hcd_urb_list_lock);
1792 : :
1793 : : /* The list may have changed while we acquired the spinlock */
1794 : : urb = NULL;
1795 [ # # ]: 0 : if (!list_empty (&ep->urb_list)) {
1796 : 0 : urb = list_entry (ep->urb_list.prev, struct urb,
1797 : : urb_list);
1798 : 0 : usb_get_urb (urb);
1799 : : }
1800 : : spin_unlock_irq(&hcd_urb_list_lock);
1801 : :
1802 [ # # ]: 0 : if (urb) {
1803 : 0 : usb_kill_urb (urb);
1804 : 0 : usb_put_urb (urb);
1805 : : }
1806 : : }
1807 : : }
1808 : :
1809 : : /**
1810 : : * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1811 : : * the bus bandwidth
1812 : : * @udev: target &usb_device
1813 : : * @new_config: new configuration to install
1814 : : * @cur_alt: the current alternate interface setting
1815 : : * @new_alt: alternate interface setting that is being installed
1816 : : *
1817 : : * To change configurations, pass in the new configuration in new_config,
1818 : : * and pass NULL for cur_alt and new_alt.
1819 : : *
1820 : : * To reset a device's configuration (put the device in the ADDRESSED state),
1821 : : * pass in NULL for new_config, cur_alt, and new_alt.
1822 : : *
1823 : : * To change alternate interface settings, pass in NULL for new_config,
1824 : : * pass in the current alternate interface setting in cur_alt,
1825 : : * and pass in the new alternate interface setting in new_alt.
1826 : : *
1827 : : * Return: An error if the requested bandwidth change exceeds the
1828 : : * bus bandwidth or host controller internal resources.
1829 : : */
1830 : 2424 : int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1831 : : struct usb_host_config *new_config,
1832 : : struct usb_host_interface *cur_alt,
1833 : : struct usb_host_interface *new_alt)
1834 : : {
1835 : : int num_intfs, i, j;
1836 : : struct usb_host_interface *alt = NULL;
1837 : : int ret = 0;
1838 : : struct usb_hcd *hcd;
1839 : : struct usb_host_endpoint *ep;
1840 : :
1841 : 2424 : hcd = bus_to_hcd(udev->bus);
1842 [ - + ]: 2424 : if (!hcd->driver->check_bandwidth)
1843 : : return 0;
1844 : :
1845 : : /* Configuration is being removed - set configuration 0 */
1846 [ # # ]: 0 : if (!new_config && !cur_alt) {
1847 [ # # ]: 0 : for (i = 1; i < 16; ++i) {
1848 : 0 : ep = udev->ep_out[i];
1849 [ # # ]: 0 : if (ep)
1850 : 0 : hcd->driver->drop_endpoint(hcd, udev, ep);
1851 : 0 : ep = udev->ep_in[i];
1852 [ # # ]: 0 : if (ep)
1853 : 0 : hcd->driver->drop_endpoint(hcd, udev, ep);
1854 : : }
1855 : 0 : hcd->driver->check_bandwidth(hcd, udev);
1856 : 0 : return 0;
1857 : : }
1858 : : /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1859 : : * each interface's alt setting 0 and ask the HCD to check the bandwidth
1860 : : * of the bus. There will always be bandwidth for endpoint 0, so it's
1861 : : * ok to exclude it.
1862 : : */
1863 [ # # ]: 0 : if (new_config) {
1864 : 0 : num_intfs = new_config->desc.bNumInterfaces;
1865 : : /* Remove endpoints (except endpoint 0, which is always on the
1866 : : * schedule) from the old config from the schedule
1867 : : */
1868 [ # # ]: 0 : for (i = 1; i < 16; ++i) {
1869 : 0 : ep = udev->ep_out[i];
1870 [ # # ]: 0 : if (ep) {
1871 : 0 : ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1872 [ # # ]: 0 : if (ret < 0)
1873 : : goto reset;
1874 : : }
1875 : 0 : ep = udev->ep_in[i];
1876 [ # # ]: 0 : if (ep) {
1877 : 0 : ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1878 [ # # ]: 0 : if (ret < 0)
1879 : : goto reset;
1880 : : }
1881 : : }
1882 [ # # ]: 0 : for (i = 0; i < num_intfs; ++i) {
1883 : : struct usb_host_interface *first_alt;
1884 : : int iface_num;
1885 : :
1886 : 0 : first_alt = &new_config->intf_cache[i]->altsetting[0];
1887 : 0 : iface_num = first_alt->desc.bInterfaceNumber;
1888 : : /* Set up endpoints for alternate interface setting 0 */
1889 : 0 : alt = usb_find_alt_setting(new_config, iface_num, 0);
1890 [ # # ]: 0 : if (!alt)
1891 : : /* No alt setting 0? Pick the first setting. */
1892 : : alt = first_alt;
1893 : :
1894 [ # # ]: 0 : for (j = 0; j < alt->desc.bNumEndpoints; j++) {
1895 : 0 : ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
1896 [ # # ]: 0 : if (ret < 0)
1897 : : goto reset;
1898 : : }
1899 : : }
1900 : : }
1901 [ # # ]: 0 : if (cur_alt && new_alt) {
1902 : 0 : struct usb_interface *iface = usb_ifnum_to_if(udev,
1903 : 0 : cur_alt->desc.bInterfaceNumber);
1904 : :
1905 [ # # ]: 0 : if (!iface)
1906 : : return -EINVAL;
1907 [ # # ]: 0 : if (iface->resetting_device) {
1908 : : /*
1909 : : * The USB core just reset the device, so the xHCI host
1910 : : * and the device will think alt setting 0 is installed.
1911 : : * However, the USB core will pass in the alternate
1912 : : * setting installed before the reset as cur_alt. Dig
1913 : : * out the alternate setting 0 structure, or the first
1914 : : * alternate setting if a broken device doesn't have alt
1915 : : * setting 0.
1916 : : */
1917 : 0 : cur_alt = usb_altnum_to_altsetting(iface, 0);
1918 [ # # ]: 0 : if (!cur_alt)
1919 : 0 : cur_alt = &iface->altsetting[0];
1920 : : }
1921 : :
1922 : : /* Drop all the endpoints in the current alt setting */
1923 [ # # ]: 0 : for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
1924 : 0 : ret = hcd->driver->drop_endpoint(hcd, udev,
1925 : 0 : &cur_alt->endpoint[i]);
1926 [ # # ]: 0 : if (ret < 0)
1927 : : goto reset;
1928 : : }
1929 : : /* Add all the endpoints in the new alt setting */
1930 [ # # ]: 0 : for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
1931 : 0 : ret = hcd->driver->add_endpoint(hcd, udev,
1932 : 0 : &new_alt->endpoint[i]);
1933 [ # # ]: 0 : if (ret < 0)
1934 : : goto reset;
1935 : : }
1936 : : }
1937 : 0 : ret = hcd->driver->check_bandwidth(hcd, udev);
1938 : : reset:
1939 [ # # ]: 0 : if (ret < 0)
1940 : 0 : hcd->driver->reset_bandwidth(hcd, udev);
1941 : 0 : return ret;
1942 : : }
1943 : :
1944 : 808 : void usb_hcd_fixup_endpoint(struct usb_device *udev,
1945 : : struct usb_host_endpoint *ep, int interval)
1946 : : {
1947 : : struct usb_hcd *hcd;
1948 : :
1949 : 808 : hcd = bus_to_hcd(udev->bus);
1950 [ - + ]: 808 : if (hcd->driver->fixup_endpoint)
1951 : 0 : hcd->driver->fixup_endpoint(hcd, udev, ep, interval);
1952 : 808 : }
1953 : :
1954 : : /* Disables the endpoint: synchronizes with the hcd to make sure all
1955 : : * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
1956 : : * have been called previously. Use for set_configuration, set_interface,
1957 : : * driver removal, physical disconnect.
1958 : : *
1959 : : * example: a qh stored in ep->hcpriv, holding state related to endpoint
1960 : : * type, maxpacket size, toggle, halt status, and scheduling.
1961 : : */
1962 : 5656 : void usb_hcd_disable_endpoint(struct usb_device *udev,
1963 : : struct usb_host_endpoint *ep)
1964 : : {
1965 : : struct usb_hcd *hcd;
1966 : :
1967 : 5656 : might_sleep();
1968 : 5656 : hcd = bus_to_hcd(udev->bus);
1969 [ + - ]: 5656 : if (hcd->driver->endpoint_disable)
1970 : 5656 : hcd->driver->endpoint_disable(hcd, ep);
1971 : 5656 : }
1972 : :
1973 : : /**
1974 : : * usb_hcd_reset_endpoint - reset host endpoint state
1975 : : * @udev: USB device.
1976 : : * @ep: the endpoint to reset.
1977 : : *
1978 : : * Resets any host endpoint state such as the toggle bit, sequence
1979 : : * number and current window.
1980 : : */
1981 : 5656 : void usb_hcd_reset_endpoint(struct usb_device *udev,
1982 : : struct usb_host_endpoint *ep)
1983 : : {
1984 : 5656 : struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1985 : :
1986 [ + - ]: 5656 : if (hcd->driver->endpoint_reset)
1987 : 5656 : hcd->driver->endpoint_reset(hcd, ep);
1988 : : else {
1989 : : int epnum = usb_endpoint_num(&ep->desc);
1990 : : int is_out = usb_endpoint_dir_out(&ep->desc);
1991 : : int is_control = usb_endpoint_xfer_control(&ep->desc);
1992 : :
1993 : 0 : usb_settoggle(udev, epnum, is_out, 0);
1994 [ # # ]: 0 : if (is_control)
1995 : 0 : usb_settoggle(udev, epnum, !is_out, 0);
1996 : : }
1997 : 5656 : }
1998 : :
1999 : : /**
2000 : : * usb_alloc_streams - allocate bulk endpoint stream IDs.
2001 : : * @interface: alternate setting that includes all endpoints.
2002 : : * @eps: array of endpoints that need streams.
2003 : : * @num_eps: number of endpoints in the array.
2004 : : * @num_streams: number of streams to allocate.
2005 : : * @mem_flags: flags hcd should use to allocate memory.
2006 : : *
2007 : : * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
2008 : : * Drivers may queue multiple transfers to different stream IDs, which may
2009 : : * complete in a different order than they were queued.
2010 : : *
2011 : : * Return: On success, the number of allocated streams. On failure, a negative
2012 : : * error code.
2013 : : */
2014 : 0 : int usb_alloc_streams(struct usb_interface *interface,
2015 : : struct usb_host_endpoint **eps, unsigned int num_eps,
2016 : : unsigned int num_streams, gfp_t mem_flags)
2017 : : {
2018 : : struct usb_hcd *hcd;
2019 : : struct usb_device *dev;
2020 : : int i, ret;
2021 : :
2022 : : dev = interface_to_usbdev(interface);
2023 : 0 : hcd = bus_to_hcd(dev->bus);
2024 [ # # # # ]: 0 : if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
2025 : : return -EINVAL;
2026 [ # # ]: 0 : if (dev->speed < USB_SPEED_SUPER)
2027 : : return -EINVAL;
2028 [ # # ]: 0 : if (dev->state < USB_STATE_CONFIGURED)
2029 : : return -ENODEV;
2030 : :
2031 [ # # ]: 0 : for (i = 0; i < num_eps; i++) {
2032 : : /* Streams only apply to bulk endpoints. */
2033 [ # # ]: 0 : if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
2034 : : return -EINVAL;
2035 : : /* Re-alloc is not allowed */
2036 [ # # ]: 0 : if (eps[i]->streams)
2037 : : return -EINVAL;
2038 : : }
2039 : :
2040 : 0 : ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
2041 : : num_streams, mem_flags);
2042 [ # # ]: 0 : if (ret < 0)
2043 : : return ret;
2044 : :
2045 [ # # ]: 0 : for (i = 0; i < num_eps; i++)
2046 : 0 : eps[i]->streams = ret;
2047 : :
2048 : : return ret;
2049 : : }
2050 : : EXPORT_SYMBOL_GPL(usb_alloc_streams);
2051 : :
2052 : : /**
2053 : : * usb_free_streams - free bulk endpoint stream IDs.
2054 : : * @interface: alternate setting that includes all endpoints.
2055 : : * @eps: array of endpoints to remove streams from.
2056 : : * @num_eps: number of endpoints in the array.
2057 : : * @mem_flags: flags hcd should use to allocate memory.
2058 : : *
2059 : : * Reverts a group of bulk endpoints back to not using stream IDs.
2060 : : * Can fail if we are given bad arguments, or HCD is broken.
2061 : : *
2062 : : * Return: 0 on success. On failure, a negative error code.
2063 : : */
2064 : 0 : int usb_free_streams(struct usb_interface *interface,
2065 : : struct usb_host_endpoint **eps, unsigned int num_eps,
2066 : : gfp_t mem_flags)
2067 : : {
2068 : : struct usb_hcd *hcd;
2069 : : struct usb_device *dev;
2070 : : int i, ret;
2071 : :
2072 : : dev = interface_to_usbdev(interface);
2073 : 0 : hcd = bus_to_hcd(dev->bus);
2074 [ # # ]: 0 : if (dev->speed < USB_SPEED_SUPER)
2075 : : return -EINVAL;
2076 : :
2077 : : /* Double-free is not allowed */
2078 [ # # ]: 0 : for (i = 0; i < num_eps; i++)
2079 [ # # # # ]: 0 : if (!eps[i] || !eps[i]->streams)
2080 : : return -EINVAL;
2081 : :
2082 : 0 : ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2083 [ # # ]: 0 : if (ret < 0)
2084 : : return ret;
2085 : :
2086 [ # # ]: 0 : for (i = 0; i < num_eps; i++)
2087 : 0 : eps[i]->streams = 0;
2088 : :
2089 : : return ret;
2090 : : }
2091 : : EXPORT_SYMBOL_GPL(usb_free_streams);
2092 : :
2093 : : /* Protect against drivers that try to unlink URBs after the device
2094 : : * is gone, by waiting until all unlinks for @udev are finished.
2095 : : * Since we don't currently track URBs by device, simply wait until
2096 : : * nothing is running in the locked region of usb_hcd_unlink_urb().
2097 : : */
2098 : 0 : void usb_hcd_synchronize_unlinks(struct usb_device *udev)
2099 : : {
2100 : : spin_lock_irq(&hcd_urb_unlink_lock);
2101 : : spin_unlock_irq(&hcd_urb_unlink_lock);
2102 : 0 : }
2103 : :
2104 : : /*-------------------------------------------------------------------------*/
2105 : :
2106 : : /* called in any context */
2107 : 0 : int usb_hcd_get_frame_number (struct usb_device *udev)
2108 : : {
2109 : 0 : struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2110 : :
2111 [ # # ]: 0 : if (!HCD_RH_RUNNING(hcd))
2112 : : return -ESHUTDOWN;
2113 : 0 : return hcd->driver->get_frame_number (hcd);
2114 : : }
2115 : :
2116 : : /*-------------------------------------------------------------------------*/
2117 : :
2118 : : #ifdef CONFIG_PM
2119 : :
2120 : 0 : int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
2121 : : {
2122 : 0 : struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2123 : : int status;
2124 : 0 : int old_state = hcd->state;
2125 : :
2126 : : dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2127 : : (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2128 : : rhdev->do_remote_wakeup);
2129 [ # # ]: 0 : if (HCD_DEAD(hcd)) {
2130 : : dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2131 : : return 0;
2132 : : }
2133 : :
2134 [ # # ]: 0 : if (!hcd->driver->bus_suspend) {
2135 : : status = -ENOENT;
2136 : : } else {
2137 : 0 : clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2138 : 0 : hcd->state = HC_STATE_QUIESCING;
2139 : 0 : status = hcd->driver->bus_suspend(hcd);
2140 : : }
2141 [ # # ]: 0 : if (status == 0) {
2142 : 0 : usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
2143 : 0 : hcd->state = HC_STATE_SUSPENDED;
2144 : :
2145 [ # # ]: 0 : if (!PMSG_IS_AUTO(msg))
2146 : 0 : usb_phy_roothub_suspend(hcd->self.sysdev,
2147 : : hcd->phy_roothub);
2148 : :
2149 : : /* Did we race with a root-hub wakeup event? */
2150 [ # # ]: 0 : if (rhdev->do_remote_wakeup) {
2151 : : char buffer[6];
2152 : :
2153 : 0 : status = hcd->driver->hub_status_data(hcd, buffer);
2154 [ # # ]: 0 : if (status != 0) {
2155 : : dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2156 : 0 : hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2157 : : status = -EBUSY;
2158 : : }
2159 : : }
2160 : : } else {
2161 : : spin_lock_irq(&hcd_root_hub_lock);
2162 [ # # ]: 0 : if (!HCD_DEAD(hcd)) {
2163 : 0 : set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2164 : 0 : hcd->state = old_state;
2165 : : }
2166 : : spin_unlock_irq(&hcd_root_hub_lock);
2167 : : dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2168 : : "suspend", status);
2169 : : }
2170 : 0 : return status;
2171 : : }
2172 : :
2173 : 0 : int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
2174 : : {
2175 : 0 : struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2176 : : int status;
2177 : 0 : int old_state = hcd->state;
2178 : :
2179 : : dev_dbg(&rhdev->dev, "usb %sresume\n",
2180 : : (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2181 [ # # ]: 0 : if (HCD_DEAD(hcd)) {
2182 : : dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2183 : : return 0;
2184 : : }
2185 : :
2186 [ # # ]: 0 : if (!PMSG_IS_AUTO(msg)) {
2187 : 0 : status = usb_phy_roothub_resume(hcd->self.sysdev,
2188 : : hcd->phy_roothub);
2189 [ # # ]: 0 : if (status)
2190 : : return status;
2191 : : }
2192 : :
2193 [ # # ]: 0 : if (!hcd->driver->bus_resume)
2194 : : return -ENOENT;
2195 [ # # ]: 0 : if (HCD_RH_RUNNING(hcd))
2196 : : return 0;
2197 : :
2198 : 0 : hcd->state = HC_STATE_RESUMING;
2199 : 0 : status = hcd->driver->bus_resume(hcd);
2200 : 0 : clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2201 [ # # ]: 0 : if (status == 0)
2202 : 0 : status = usb_phy_roothub_calibrate(hcd->phy_roothub);
2203 : :
2204 [ # # ]: 0 : if (status == 0) {
2205 : : struct usb_device *udev;
2206 : : int port1;
2207 : :
2208 : : spin_lock_irq(&hcd_root_hub_lock);
2209 [ # # ]: 0 : if (!HCD_DEAD(hcd)) {
2210 [ # # ]: 0 : usb_set_device_state(rhdev, rhdev->actconfig
2211 : : ? USB_STATE_CONFIGURED
2212 : : : USB_STATE_ADDRESS);
2213 : 0 : set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2214 : 0 : hcd->state = HC_STATE_RUNNING;
2215 : : }
2216 : : spin_unlock_irq(&hcd_root_hub_lock);
2217 : :
2218 : : /*
2219 : : * Check whether any of the enabled ports on the root hub are
2220 : : * unsuspended. If they are then a TRSMRCY delay is needed
2221 : : * (this is what the USB-2 spec calls a "global resume").
2222 : : * Otherwise we can skip the delay.
2223 : : */
2224 [ # # # # ]: 0 : usb_hub_for_each_child(rhdev, port1, udev) {
2225 [ # # # # ]: 0 : if (udev->state != USB_STATE_NOTATTACHED &&
2226 : 0 : !udev->port_is_suspended) {
2227 : 0 : usleep_range(10000, 11000); /* TRSMRCY */
2228 : 0 : break;
2229 : : }
2230 : : }
2231 : : } else {
2232 : 0 : hcd->state = old_state;
2233 : 0 : usb_phy_roothub_suspend(hcd->self.sysdev, hcd->phy_roothub);
2234 : : dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2235 : : "resume", status);
2236 [ # # ]: 0 : if (status != -ESHUTDOWN)
2237 : 0 : usb_hc_died(hcd);
2238 : : }
2239 : 0 : return status;
2240 : : }
2241 : :
2242 : : /* Workqueue routine for root-hub remote wakeup */
2243 : 0 : static void hcd_resume_work(struct work_struct *work)
2244 : : {
2245 : : struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2246 : 0 : struct usb_device *udev = hcd->self.root_hub;
2247 : :
2248 : 0 : usb_remote_wakeup(udev);
2249 : 0 : }
2250 : :
2251 : : /**
2252 : : * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2253 : : * @hcd: host controller for this root hub
2254 : : *
2255 : : * The USB host controller calls this function when its root hub is
2256 : : * suspended (with the remote wakeup feature enabled) and a remote
2257 : : * wakeup request is received. The routine submits a workqueue request
2258 : : * to resume the root hub (that is, manage its downstream ports again).
2259 : : */
2260 : 404 : void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2261 : : {
2262 : : unsigned long flags;
2263 : :
2264 : 404 : spin_lock_irqsave (&hcd_root_hub_lock, flags);
2265 [ - + ]: 404 : if (hcd->rh_registered) {
2266 : : pm_wakeup_event(&hcd->self.root_hub->dev, 0);
2267 : 0 : set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2268 : 0 : queue_work(pm_wq, &hcd->wakeup_work);
2269 : : }
2270 : : spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2271 : 404 : }
2272 : : EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2273 : :
2274 : : #endif /* CONFIG_PM */
2275 : :
2276 : : /*-------------------------------------------------------------------------*/
2277 : :
2278 : : #ifdef CONFIG_USB_OTG
2279 : :
2280 : : /**
2281 : : * usb_bus_start_enum - start immediate enumeration (for OTG)
2282 : : * @bus: the bus (must use hcd framework)
2283 : : * @port_num: 1-based number of port; usually bus->otg_port
2284 : : * Context: in_interrupt()
2285 : : *
2286 : : * Starts enumeration, with an immediate reset followed later by
2287 : : * hub_wq identifying and possibly configuring the device.
2288 : : * This is needed by OTG controller drivers, where it helps meet
2289 : : * HNP protocol timing requirements for starting a port reset.
2290 : : *
2291 : : * Return: 0 if successful.
2292 : : */
2293 : : int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2294 : : {
2295 : : struct usb_hcd *hcd;
2296 : : int status = -EOPNOTSUPP;
2297 : :
2298 : : /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2299 : : * boards with root hubs hooked up to internal devices (instead of
2300 : : * just the OTG port) may need more attention to resetting...
2301 : : */
2302 : : hcd = bus_to_hcd(bus);
2303 : : if (port_num && hcd->driver->start_port_reset)
2304 : : status = hcd->driver->start_port_reset(hcd, port_num);
2305 : :
2306 : : /* allocate hub_wq shortly after (first) root port reset finishes;
2307 : : * it may issue others, until at least 50 msecs have passed.
2308 : : */
2309 : : if (status == 0)
2310 : : mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2311 : : return status;
2312 : : }
2313 : : EXPORT_SYMBOL_GPL(usb_bus_start_enum);
2314 : :
2315 : : #endif
2316 : :
2317 : : /*-------------------------------------------------------------------------*/
2318 : :
2319 : : /**
2320 : : * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2321 : : * @irq: the IRQ being raised
2322 : : * @__hcd: pointer to the HCD whose IRQ is being signaled
2323 : : *
2324 : : * If the controller isn't HALTed, calls the driver's irq handler.
2325 : : * Checks whether the controller is now dead.
2326 : : *
2327 : : * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
2328 : : */
2329 : 133368004 : irqreturn_t usb_hcd_irq (int irq, void *__hcd)
2330 : : {
2331 : : struct usb_hcd *hcd = __hcd;
2332 : : irqreturn_t rc;
2333 : :
2334 [ + - ]: 133368004 : if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
2335 : : rc = IRQ_NONE;
2336 [ + + ]: 133368004 : else if (hcd->driver->irq(hcd) == IRQ_NONE)
2337 : : rc = IRQ_NONE;
2338 : : else
2339 : : rc = IRQ_HANDLED;
2340 : :
2341 : 133367968 : return rc;
2342 : : }
2343 : : EXPORT_SYMBOL_GPL(usb_hcd_irq);
2344 : :
2345 : : /*-------------------------------------------------------------------------*/
2346 : :
2347 : : /* Workqueue routine for when the root-hub has died. */
2348 : 0 : static void hcd_died_work(struct work_struct *work)
2349 : : {
2350 : : struct usb_hcd *hcd = container_of(work, struct usb_hcd, died_work);
2351 : : static char *env[] = {
2352 : : "ERROR=DEAD",
2353 : : NULL
2354 : : };
2355 : :
2356 : : /* Notify user space that the host controller has died */
2357 : 0 : kobject_uevent_env(&hcd->self.root_hub->dev.kobj, KOBJ_OFFLINE, env);
2358 : 0 : }
2359 : :
2360 : : /**
2361 : : * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2362 : : * @hcd: pointer to the HCD representing the controller
2363 : : *
2364 : : * This is called by bus glue to report a USB host controller that died
2365 : : * while operations may still have been pending. It's called automatically
2366 : : * by the PCI glue, so only glue for non-PCI busses should need to call it.
2367 : : *
2368 : : * Only call this function with the primary HCD.
2369 : : */
2370 : 0 : void usb_hc_died (struct usb_hcd *hcd)
2371 : : {
2372 : : unsigned long flags;
2373 : :
2374 : 0 : dev_err (hcd->self.controller, "HC died; cleaning up\n");
2375 : :
2376 : 0 : spin_lock_irqsave (&hcd_root_hub_lock, flags);
2377 : 0 : clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2378 : 0 : set_bit(HCD_FLAG_DEAD, &hcd->flags);
2379 [ # # ]: 0 : if (hcd->rh_registered) {
2380 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2381 : :
2382 : : /* make hub_wq clean up old urbs and devices */
2383 : 0 : usb_set_device_state (hcd->self.root_hub,
2384 : : USB_STATE_NOTATTACHED);
2385 : 0 : usb_kick_hub_wq(hcd->self.root_hub);
2386 : : }
2387 [ # # # # ]: 0 : if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2388 : : hcd = hcd->shared_hcd;
2389 : 0 : clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2390 : 0 : set_bit(HCD_FLAG_DEAD, &hcd->flags);
2391 [ # # ]: 0 : if (hcd->rh_registered) {
2392 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2393 : :
2394 : : /* make hub_wq clean up old urbs and devices */
2395 : 0 : usb_set_device_state(hcd->self.root_hub,
2396 : : USB_STATE_NOTATTACHED);
2397 : 0 : usb_kick_hub_wq(hcd->self.root_hub);
2398 : : }
2399 : : }
2400 : :
2401 : : /* Handle the case where this function gets called with a shared HCD */
2402 [ # # ]: 0 : if (usb_hcd_is_primary_hcd(hcd))
2403 : 0 : schedule_work(&hcd->died_work);
2404 : : else
2405 : 0 : schedule_work(&hcd->primary_hcd->died_work);
2406 : :
2407 : : spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2408 : : /* Make sure that the other roothub is also deallocated. */
2409 : 0 : }
2410 : : EXPORT_SYMBOL_GPL (usb_hc_died);
2411 : :
2412 : : /*-------------------------------------------------------------------------*/
2413 : :
2414 : : static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
2415 : : {
2416 : :
2417 : 808 : spin_lock_init(&bh->lock);
2418 : 808 : INIT_LIST_HEAD(&bh->head);
2419 : 808 : tasklet_init(&bh->bh, usb_giveback_urb_bh, (unsigned long)bh);
2420 : : }
2421 : :
2422 : 404 : struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver,
2423 : : struct device *sysdev, struct device *dev, const char *bus_name,
2424 : : struct usb_hcd *primary_hcd)
2425 : : {
2426 : : struct usb_hcd *hcd;
2427 : :
2428 : 404 : hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
2429 [ + - ]: 404 : if (!hcd)
2430 : : return NULL;
2431 [ + - ]: 404 : if (primary_hcd == NULL) {
2432 : 404 : hcd->address0_mutex = kmalloc(sizeof(*hcd->address0_mutex),
2433 : : GFP_KERNEL);
2434 [ - + ]: 404 : if (!hcd->address0_mutex) {
2435 : 0 : kfree(hcd);
2436 : : dev_dbg(dev, "hcd address0 mutex alloc failed\n");
2437 : 0 : return NULL;
2438 : : }
2439 : 404 : mutex_init(hcd->address0_mutex);
2440 : 404 : hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2441 : : GFP_KERNEL);
2442 [ - + ]: 404 : if (!hcd->bandwidth_mutex) {
2443 : 0 : kfree(hcd->address0_mutex);
2444 : 0 : kfree(hcd);
2445 : : dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2446 : 0 : return NULL;
2447 : : }
2448 : 404 : mutex_init(hcd->bandwidth_mutex);
2449 : : dev_set_drvdata(dev, hcd);
2450 : : } else {
2451 : 0 : mutex_lock(&usb_port_peer_mutex);
2452 : 0 : hcd->address0_mutex = primary_hcd->address0_mutex;
2453 : 0 : hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2454 : 0 : hcd->primary_hcd = primary_hcd;
2455 : 0 : primary_hcd->primary_hcd = primary_hcd;
2456 : 0 : hcd->shared_hcd = primary_hcd;
2457 : 0 : primary_hcd->shared_hcd = hcd;
2458 : 0 : mutex_unlock(&usb_port_peer_mutex);
2459 : : }
2460 : :
2461 : : kref_init(&hcd->kref);
2462 : :
2463 : 404 : usb_bus_init(&hcd->self);
2464 : 404 : hcd->self.controller = dev;
2465 : 404 : hcd->self.sysdev = sysdev;
2466 : 404 : hcd->self.bus_name = bus_name;
2467 : :
2468 : 404 : timer_setup(&hcd->rh_timer, rh_timer_func, 0);
2469 : : #ifdef CONFIG_PM
2470 : 808 : INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2471 : : #endif
2472 : :
2473 : 808 : INIT_WORK(&hcd->died_work, hcd_died_work);
2474 : :
2475 : 404 : hcd->driver = driver;
2476 : 404 : hcd->speed = driver->flags & HCD_MASK;
2477 [ + - ]: 404 : hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2478 : : "USB Host Controller";
2479 : 404 : return hcd;
2480 : : }
2481 : : EXPORT_SYMBOL_GPL(__usb_create_hcd);
2482 : :
2483 : : /**
2484 : : * usb_create_shared_hcd - create and initialize an HCD structure
2485 : : * @driver: HC driver that will use this hcd
2486 : : * @dev: device for this HC, stored in hcd->self.controller
2487 : : * @bus_name: value to store in hcd->self.bus_name
2488 : : * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2489 : : * PCI device. Only allocate certain resources for the primary HCD
2490 : : * Context: !in_interrupt()
2491 : : *
2492 : : * Allocate a struct usb_hcd, with extra space at the end for the
2493 : : * HC driver's private data. Initialize the generic members of the
2494 : : * hcd structure.
2495 : : *
2496 : : * Return: On success, a pointer to the created and initialized HCD structure.
2497 : : * On failure (e.g. if memory is unavailable), %NULL.
2498 : : */
2499 : 0 : struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2500 : : struct device *dev, const char *bus_name,
2501 : : struct usb_hcd *primary_hcd)
2502 : : {
2503 : 0 : return __usb_create_hcd(driver, dev, dev, bus_name, primary_hcd);
2504 : : }
2505 : : EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2506 : :
2507 : : /**
2508 : : * usb_create_hcd - create and initialize an HCD structure
2509 : : * @driver: HC driver that will use this hcd
2510 : : * @dev: device for this HC, stored in hcd->self.controller
2511 : : * @bus_name: value to store in hcd->self.bus_name
2512 : : * Context: !in_interrupt()
2513 : : *
2514 : : * Allocate a struct usb_hcd, with extra space at the end for the
2515 : : * HC driver's private data. Initialize the generic members of the
2516 : : * hcd structure.
2517 : : *
2518 : : * Return: On success, a pointer to the created and initialized HCD
2519 : : * structure. On failure (e.g. if memory is unavailable), %NULL.
2520 : : */
2521 : 404 : struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2522 : : struct device *dev, const char *bus_name)
2523 : : {
2524 : 404 : return __usb_create_hcd(driver, dev, dev, bus_name, NULL);
2525 : : }
2526 : : EXPORT_SYMBOL_GPL(usb_create_hcd);
2527 : :
2528 : : /*
2529 : : * Roothubs that share one PCI device must also share the bandwidth mutex.
2530 : : * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2531 : : * deallocated.
2532 : : *
2533 : : * Make sure to deallocate the bandwidth_mutex only when the last HCD is
2534 : : * freed. When hcd_release() is called for either hcd in a peer set,
2535 : : * invalidate the peer's ->shared_hcd and ->primary_hcd pointers.
2536 : : */
2537 : 0 : static void hcd_release(struct kref *kref)
2538 : : {
2539 : 0 : struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2540 : :
2541 : 0 : mutex_lock(&usb_port_peer_mutex);
2542 [ # # ]: 0 : if (hcd->shared_hcd) {
2543 : : struct usb_hcd *peer = hcd->shared_hcd;
2544 : :
2545 : 0 : peer->shared_hcd = NULL;
2546 : 0 : peer->primary_hcd = NULL;
2547 : : } else {
2548 : 0 : kfree(hcd->address0_mutex);
2549 : 0 : kfree(hcd->bandwidth_mutex);
2550 : : }
2551 : 0 : mutex_unlock(&usb_port_peer_mutex);
2552 : 0 : kfree(hcd);
2553 : 0 : }
2554 : :
2555 : 2020 : struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2556 : : {
2557 [ + - ]: 2020 : if (hcd)
2558 : : kref_get (&hcd->kref);
2559 : 2020 : return hcd;
2560 : : }
2561 : : EXPORT_SYMBOL_GPL(usb_get_hcd);
2562 : :
2563 : 0 : void usb_put_hcd (struct usb_hcd *hcd)
2564 : : {
2565 [ # # ]: 0 : if (hcd)
2566 : 0 : kref_put (&hcd->kref, hcd_release);
2567 : 0 : }
2568 : : EXPORT_SYMBOL_GPL(usb_put_hcd);
2569 : :
2570 : 0 : int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2571 : : {
2572 [ # # - + : 808 : if (!hcd->primary_hcd)
- + # # #
# # # #
# ]
2573 : : return 1;
2574 : 0 : return hcd == hcd->primary_hcd;
2575 : : }
2576 : : EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2577 : :
2578 : 404 : int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
2579 : : {
2580 [ - + ]: 404 : if (!hcd->driver->find_raw_port_number)
2581 : : return port1;
2582 : :
2583 : 0 : return hcd->driver->find_raw_port_number(hcd, port1);
2584 : : }
2585 : :
2586 : 404 : static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2587 : : unsigned int irqnum, unsigned long irqflags)
2588 : : {
2589 : : int retval;
2590 : :
2591 [ + - ]: 404 : if (hcd->driver->irq) {
2592 : :
2593 : 404 : snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2594 : : hcd->driver->description, hcd->self.busnum);
2595 : : retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2596 : : hcd->irq_descr, hcd);
2597 [ - + ]: 404 : if (retval != 0) {
2598 : 0 : dev_err(hcd->self.controller,
2599 : : "request interrupt %d failed\n",
2600 : : irqnum);
2601 : 0 : return retval;
2602 : : }
2603 : 404 : hcd->irq = irqnum;
2604 [ - + ]: 404 : dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2605 : : (hcd->driver->flags & HCD_MEMORY) ?
2606 : : "io mem" : "io base",
2607 : : (unsigned long long)hcd->rsrc_start);
2608 : : } else {
2609 : 0 : hcd->irq = 0;
2610 [ # # ]: 0 : if (hcd->rsrc_start)
2611 [ # # ]: 0 : dev_info(hcd->self.controller, "%s 0x%08llx\n",
2612 : : (hcd->driver->flags & HCD_MEMORY) ?
2613 : : "io mem" : "io base",
2614 : : (unsigned long long)hcd->rsrc_start);
2615 : : }
2616 : : return 0;
2617 : : }
2618 : :
2619 : : /*
2620 : : * Before we free this root hub, flush in-flight peering attempts
2621 : : * and disable peer lookups
2622 : : */
2623 : 0 : static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
2624 : : {
2625 : : struct usb_device *rhdev;
2626 : :
2627 : 0 : mutex_lock(&usb_port_peer_mutex);
2628 : 0 : rhdev = hcd->self.root_hub;
2629 : 0 : hcd->self.root_hub = NULL;
2630 : 0 : mutex_unlock(&usb_port_peer_mutex);
2631 : 0 : usb_put_dev(rhdev);
2632 : 0 : }
2633 : :
2634 : : /**
2635 : : * usb_add_hcd - finish generic HCD structure initialization and register
2636 : : * @hcd: the usb_hcd structure to initialize
2637 : : * @irqnum: Interrupt line to allocate
2638 : : * @irqflags: Interrupt type flags
2639 : : *
2640 : : * Finish the remaining parts of generic HCD initialization: allocate the
2641 : : * buffers of consistent memory, register the bus, request the IRQ line,
2642 : : * and call the driver's reset() and start() routines.
2643 : : */
2644 : 404 : int usb_add_hcd(struct usb_hcd *hcd,
2645 : : unsigned int irqnum, unsigned long irqflags)
2646 : : {
2647 : : int retval;
2648 : : struct usb_device *rhdev;
2649 : :
2650 [ + - + - ]: 808 : if (!hcd->skip_phy_initialization && usb_hcd_is_primary_hcd(hcd)) {
2651 : 404 : hcd->phy_roothub = usb_phy_roothub_alloc(hcd->self.sysdev);
2652 [ - + ]: 404 : if (IS_ERR(hcd->phy_roothub))
2653 : 0 : return PTR_ERR(hcd->phy_roothub);
2654 : :
2655 : 404 : retval = usb_phy_roothub_init(hcd->phy_roothub);
2656 [ + - ]: 404 : if (retval)
2657 : : return retval;
2658 : :
2659 : 404 : retval = usb_phy_roothub_set_mode(hcd->phy_roothub,
2660 : : PHY_MODE_USB_HOST_SS);
2661 [ - + ]: 404 : if (retval)
2662 : 0 : retval = usb_phy_roothub_set_mode(hcd->phy_roothub,
2663 : : PHY_MODE_USB_HOST);
2664 [ + - ]: 404 : if (retval)
2665 : : goto err_usb_phy_roothub_power_on;
2666 : :
2667 : 404 : retval = usb_phy_roothub_power_on(hcd->phy_roothub);
2668 [ + - ]: 404 : if (retval)
2669 : : goto err_usb_phy_roothub_power_on;
2670 : : }
2671 : :
2672 : 404 : dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2673 : :
2674 [ - - - + ]: 404 : switch (authorized_default) {
2675 : : case USB_AUTHORIZE_NONE:
2676 : 0 : hcd->dev_policy = USB_DEVICE_AUTHORIZE_NONE;
2677 : 0 : break;
2678 : :
2679 : : case USB_AUTHORIZE_ALL:
2680 : 0 : hcd->dev_policy = USB_DEVICE_AUTHORIZE_ALL;
2681 : 0 : break;
2682 : :
2683 : : case USB_AUTHORIZE_INTERNAL:
2684 : 0 : hcd->dev_policy = USB_DEVICE_AUTHORIZE_INTERNAL;
2685 : 0 : break;
2686 : :
2687 : : case USB_AUTHORIZE_WIRED:
2688 : : default:
2689 : 808 : hcd->dev_policy = hcd->wireless ?
2690 : 404 : USB_DEVICE_AUTHORIZE_NONE : USB_DEVICE_AUTHORIZE_ALL;
2691 : 404 : break;
2692 : : }
2693 : :
2694 : 404 : set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2695 : :
2696 : : /* per default all interfaces are authorized */
2697 : 404 : set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
2698 : :
2699 : : /* HC is in reset state, but accessible. Now do the one-time init,
2700 : : * bottom up so that hcds can customize the root hubs before hub_wq
2701 : : * starts talking to them. (Note, bus id is assigned early too.)
2702 : : */
2703 : 404 : retval = hcd_buffer_create(hcd);
2704 [ + - ]: 404 : if (retval != 0) {
2705 : : dev_dbg(hcd->self.sysdev, "pool alloc failed\n");
2706 : : goto err_create_buf;
2707 : : }
2708 : :
2709 : 404 : retval = usb_register_bus(&hcd->self);
2710 [ + - ]: 404 : if (retval < 0)
2711 : : goto err_register_bus;
2712 : :
2713 : 404 : rhdev = usb_alloc_dev(NULL, &hcd->self, 0);
2714 [ - + ]: 404 : if (rhdev == NULL) {
2715 : 0 : dev_err(hcd->self.sysdev, "unable to allocate root hub\n");
2716 : : retval = -ENOMEM;
2717 : 0 : goto err_allocate_root_hub;
2718 : : }
2719 : 404 : mutex_lock(&usb_port_peer_mutex);
2720 : 404 : hcd->self.root_hub = rhdev;
2721 : 404 : mutex_unlock(&usb_port_peer_mutex);
2722 : :
2723 : 404 : rhdev->rx_lanes = 1;
2724 : 404 : rhdev->tx_lanes = 1;
2725 : :
2726 [ - + - - : 404 : switch (hcd->speed) {
- - - ]
2727 : : case HCD_USB11:
2728 : 0 : rhdev->speed = USB_SPEED_FULL;
2729 : 0 : break;
2730 : : case HCD_USB2:
2731 : 404 : rhdev->speed = USB_SPEED_HIGH;
2732 : 404 : break;
2733 : : case HCD_USB25:
2734 : 0 : rhdev->speed = USB_SPEED_WIRELESS;
2735 : 0 : break;
2736 : : case HCD_USB3:
2737 : 0 : rhdev->speed = USB_SPEED_SUPER;
2738 : 0 : break;
2739 : : case HCD_USB32:
2740 : 0 : rhdev->rx_lanes = 2;
2741 : 0 : rhdev->tx_lanes = 2;
2742 : : /* fall through */
2743 : : case HCD_USB31:
2744 : 0 : rhdev->speed = USB_SPEED_SUPER_PLUS;
2745 : 0 : break;
2746 : : default:
2747 : : retval = -EINVAL;
2748 : : goto err_set_rh_speed;
2749 : : }
2750 : :
2751 : : /* wakeup flag init defaults to "everything works" for root hubs,
2752 : : * but drivers can override it in reset() if needed, along with
2753 : : * recording the overall controller's system wakeup capability.
2754 : : */
2755 : : device_set_wakeup_capable(&rhdev->dev, 1);
2756 : :
2757 : : /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2758 : : * registered. But since the controller can die at any time,
2759 : : * let's initialize the flag before touching the hardware.
2760 : : */
2761 : 404 : set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2762 : :
2763 : : /* "reset" is misnamed; its role is now one-time init. the controller
2764 : : * should already have been reset (and boot firmware kicked off etc).
2765 : : */
2766 [ - + ]: 404 : if (hcd->driver->reset) {
2767 : 0 : retval = hcd->driver->reset(hcd);
2768 [ # # ]: 0 : if (retval < 0) {
2769 : 0 : dev_err(hcd->self.controller, "can't setup: %d\n",
2770 : : retval);
2771 : 0 : goto err_hcd_driver_setup;
2772 : : }
2773 : : }
2774 : 404 : hcd->rh_pollable = 1;
2775 : :
2776 : 404 : retval = usb_phy_roothub_calibrate(hcd->phy_roothub);
2777 [ + - ]: 404 : if (retval)
2778 : : goto err_hcd_driver_setup;
2779 : :
2780 : : /* NOTE: root hub and controller capabilities may not be the same */
2781 : : if (device_can_wakeup(hcd->self.controller)
2782 : : && device_can_wakeup(&hcd->self.root_hub->dev))
2783 : : dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
2784 : :
2785 : : /* initialize tasklets */
2786 : 404 : init_giveback_urb_bh(&hcd->high_prio_bh);
2787 : 404 : init_giveback_urb_bh(&hcd->low_prio_bh);
2788 : :
2789 : : /* enable irqs just before we start the controller,
2790 : : * if the BIOS provides legacy PCI irqs.
2791 : : */
2792 [ + - + - ]: 404 : if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
2793 : 404 : retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2794 [ + - ]: 404 : if (retval)
2795 : : goto err_request_irq;
2796 : : }
2797 : :
2798 : 404 : hcd->state = HC_STATE_RUNNING;
2799 : 404 : retval = hcd->driver->start(hcd);
2800 [ - + ]: 404 : if (retval < 0) {
2801 : 0 : dev_err(hcd->self.controller, "startup error %d\n", retval);
2802 : 0 : goto err_hcd_driver_start;
2803 : : }
2804 : :
2805 : : /* starting here, usbcore will pay attention to this root hub */
2806 : 404 : retval = register_root_hub(hcd);
2807 [ + - ]: 404 : if (retval != 0)
2808 : : goto err_register_root_hub;
2809 : :
2810 [ - + # # ]: 404 : if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2811 : 0 : usb_hcd_poll_rh_status(hcd);
2812 : :
2813 : 404 : return retval;
2814 : :
2815 : : err_register_root_hub:
2816 : 0 : hcd->rh_pollable = 0;
2817 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2818 : 0 : del_timer_sync(&hcd->rh_timer);
2819 : 0 : hcd->driver->stop(hcd);
2820 : 0 : hcd->state = HC_STATE_HALT;
2821 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2822 : 0 : del_timer_sync(&hcd->rh_timer);
2823 : : err_hcd_driver_start:
2824 [ # # # # ]: 0 : if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
2825 : 0 : free_irq(irqnum, hcd);
2826 : : err_request_irq:
2827 : : err_hcd_driver_setup:
2828 : : err_set_rh_speed:
2829 : 0 : usb_put_invalidate_rhdev(hcd);
2830 : : err_allocate_root_hub:
2831 : 0 : usb_deregister_bus(&hcd->self);
2832 : : err_register_bus:
2833 : 0 : hcd_buffer_destroy(hcd);
2834 : : err_create_buf:
2835 : 0 : usb_phy_roothub_power_off(hcd->phy_roothub);
2836 : : err_usb_phy_roothub_power_on:
2837 : 0 : usb_phy_roothub_exit(hcd->phy_roothub);
2838 : :
2839 : 0 : return retval;
2840 : : }
2841 : : EXPORT_SYMBOL_GPL(usb_add_hcd);
2842 : :
2843 : : /**
2844 : : * usb_remove_hcd - shutdown processing for generic HCDs
2845 : : * @hcd: the usb_hcd structure to remove
2846 : : * Context: !in_interrupt()
2847 : : *
2848 : : * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2849 : : * invoking the HCD's stop() method.
2850 : : */
2851 : 0 : void usb_remove_hcd(struct usb_hcd *hcd)
2852 : : {
2853 : 0 : struct usb_device *rhdev = hcd->self.root_hub;
2854 : :
2855 : 0 : dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2856 : :
2857 : 0 : usb_get_dev(rhdev);
2858 : 0 : clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2859 [ # # ]: 0 : if (HC_IS_RUNNING (hcd->state))
2860 : 0 : hcd->state = HC_STATE_QUIESCING;
2861 : :
2862 : : dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2863 : : spin_lock_irq (&hcd_root_hub_lock);
2864 : 0 : hcd->rh_registered = 0;
2865 : : spin_unlock_irq (&hcd_root_hub_lock);
2866 : :
2867 : : #ifdef CONFIG_PM
2868 : 0 : cancel_work_sync(&hcd->wakeup_work);
2869 : : #endif
2870 : 0 : cancel_work_sync(&hcd->died_work);
2871 : :
2872 : 0 : mutex_lock(&usb_bus_idr_lock);
2873 : 0 : usb_disconnect(&rhdev); /* Sets rhdev to NULL */
2874 : 0 : mutex_unlock(&usb_bus_idr_lock);
2875 : :
2876 : : /*
2877 : : * tasklet_kill() isn't needed here because:
2878 : : * - driver's disconnect() called from usb_disconnect() should
2879 : : * make sure its URBs are completed during the disconnect()
2880 : : * callback
2881 : : *
2882 : : * - it is too late to run complete() here since driver may have
2883 : : * been removed already now
2884 : : */
2885 : :
2886 : : /* Prevent any more root-hub status calls from the timer.
2887 : : * The HCD might still restart the timer (if a port status change
2888 : : * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2889 : : * the hub_status_data() callback.
2890 : : */
2891 : 0 : hcd->rh_pollable = 0;
2892 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2893 : 0 : del_timer_sync(&hcd->rh_timer);
2894 : :
2895 : 0 : hcd->driver->stop(hcd);
2896 : 0 : hcd->state = HC_STATE_HALT;
2897 : :
2898 : : /* In case the HCD restarted the timer, stop it again. */
2899 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2900 : 0 : del_timer_sync(&hcd->rh_timer);
2901 : :
2902 [ # # ]: 0 : if (usb_hcd_is_primary_hcd(hcd)) {
2903 [ # # ]: 0 : if (hcd->irq > 0)
2904 : 0 : free_irq(hcd->irq, hcd);
2905 : : }
2906 : :
2907 : 0 : usb_deregister_bus(&hcd->self);
2908 : 0 : hcd_buffer_destroy(hcd);
2909 : :
2910 : 0 : usb_phy_roothub_power_off(hcd->phy_roothub);
2911 : 0 : usb_phy_roothub_exit(hcd->phy_roothub);
2912 : :
2913 : 0 : usb_put_invalidate_rhdev(hcd);
2914 : 0 : hcd->flags = 0;
2915 : 0 : }
2916 : : EXPORT_SYMBOL_GPL(usb_remove_hcd);
2917 : :
2918 : : void
2919 : 0 : usb_hcd_platform_shutdown(struct platform_device *dev)
2920 : : {
2921 : : struct usb_hcd *hcd = platform_get_drvdata(dev);
2922 : :
2923 : : /* No need for pm_runtime_put(), we're shutting down */
2924 : 0 : pm_runtime_get_sync(&dev->dev);
2925 : :
2926 [ # # ]: 0 : if (hcd->driver->shutdown)
2927 : 0 : hcd->driver->shutdown(hcd);
2928 : 0 : }
2929 : : EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
2930 : :
2931 : 0 : int usb_hcd_setup_local_mem(struct usb_hcd *hcd, phys_addr_t phys_addr,
2932 : : dma_addr_t dma, size_t size)
2933 : : {
2934 : : int err;
2935 : : void *local_mem;
2936 : :
2937 : 0 : hcd->localmem_pool = devm_gen_pool_create(hcd->self.sysdev, 4,
2938 : : dev_to_node(hcd->self.sysdev),
2939 : 0 : dev_name(hcd->self.sysdev));
2940 [ # # ]: 0 : if (IS_ERR(hcd->localmem_pool))
2941 : 0 : return PTR_ERR(hcd->localmem_pool);
2942 : :
2943 : 0 : local_mem = devm_memremap(hcd->self.sysdev, phys_addr,
2944 : : size, MEMREMAP_WC);
2945 [ # # ]: 0 : if (IS_ERR(local_mem))
2946 : 0 : return PTR_ERR(local_mem);
2947 : :
2948 : : /*
2949 : : * Here we pass a dma_addr_t but the arg type is a phys_addr_t.
2950 : : * It's not backed by system memory and thus there's no kernel mapping
2951 : : * for it.
2952 : : */
2953 : 0 : err = gen_pool_add_virt(hcd->localmem_pool, (unsigned long)local_mem,
2954 : : dma, size, dev_to_node(hcd->self.sysdev));
2955 [ # # ]: 0 : if (err < 0) {
2956 : 0 : dev_err(hcd->self.sysdev, "gen_pool_add_virt failed with %d\n",
2957 : : err);
2958 : 0 : return err;
2959 : : }
2960 : :
2961 : : return 0;
2962 : : }
2963 : : EXPORT_SYMBOL_GPL(usb_hcd_setup_local_mem);
2964 : :
2965 : : /*-------------------------------------------------------------------------*/
2966 : :
2967 : : #if IS_ENABLED(CONFIG_USB_MON)
2968 : :
2969 : : const struct usb_mon_operations *mon_ops;
2970 : :
2971 : : /*
2972 : : * The registration is unlocked.
2973 : : * We do it this way because we do not want to lock in hot paths.
2974 : : *
2975 : : * Notice that the code is minimally error-proof. Because usbmon needs
2976 : : * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
2977 : : */
2978 : :
2979 : 0 : int usb_mon_register(const struct usb_mon_operations *ops)
2980 : : {
2981 : :
2982 [ # # ]: 0 : if (mon_ops)
2983 : : return -EBUSY;
2984 : :
2985 : 0 : mon_ops = ops;
2986 : 0 : mb();
2987 : 0 : return 0;
2988 : : }
2989 : : EXPORT_SYMBOL_GPL (usb_mon_register);
2990 : :
2991 : 0 : void usb_mon_deregister (void)
2992 : : {
2993 : :
2994 [ # # ]: 0 : if (mon_ops == NULL) {
2995 : 0 : printk(KERN_ERR "USB: monitor was not registered\n");
2996 : 0 : return;
2997 : : }
2998 : 0 : mon_ops = NULL;
2999 : 0 : mb();
3000 : : }
3001 : : EXPORT_SYMBOL_GPL (usb_mon_deregister);
3002 : :
3003 : : #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
|
