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 : 0 : ascii2desc(char const *s, u8 *buf, unsigned len)
403 : : {
404 : 0 : unsigned n, t = 2 + 2*strlen(s);
405 : :
406 : 0 : if (t > 254)
407 : : t = 254; /* Longest possible UTF string descriptor */
408 : 0 : if (len > t)
409 : : len = t;
410 : :
411 : 0 : t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
412 : :
413 : 0 : n = len;
414 [ # # ]: 0 : while (n--) {
415 : 0 : *buf++ = t;
416 [ # # ]: 0 : if (!n--)
417 : : break;
418 : 0 : *buf++ = t >> 8;
419 : 0 : t = (unsigned char)*s++;
420 : : }
421 : 0 : 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 : 0 : rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
439 : : {
440 : 0 : char buf[100];
441 : 0 : char const *s;
442 : 0 : static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
443 : :
444 : : /* language ids */
445 [ # # # # : 0 : switch (id) {
# ]
446 : 0 : 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 : 0 : if (len > 4)
450 : : len = 4;
451 : 0 : memcpy(data, langids, len);
452 : 0 : return len;
453 : 0 : case 1:
454 : : /* Serial number */
455 : 0 : s = hcd->self.bus_name;
456 : 0 : break;
457 : 0 : case 2:
458 : : /* Product name */
459 : 0 : s = hcd->product_desc;
460 : 0 : break;
461 : 0 : case 3:
462 : : /* Manufacturer */
463 : 0 : snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
464 : 0 : init_utsname()->release, hcd->driver->description);
465 : 0 : s = buf;
466 : 0 : break;
467 : : default:
468 : : /* Can't happen; caller guarantees it */
469 : : return 0;
470 : : }
471 : :
472 : 0 : return ascii2desc(s, data, len);
473 : : }
474 : :
475 : :
476 : : /* Root hub control transfers execute synchronously */
477 : 0 : static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
478 : : {
479 : 0 : struct usb_ctrlrequest *cmd;
480 : 0 : u16 typeReq, wValue, wIndex, wLength;
481 : 0 : u8 *ubuf = urb->transfer_buffer;
482 : 0 : unsigned len = 0;
483 : 0 : int status;
484 : 0 : u8 patch_wakeup = 0;
485 : 0 : u8 patch_protocol = 0;
486 : 0 : u16 tbuf_size;
487 : 0 : u8 *tbuf = NULL;
488 : 0 : const u8 *bufp;
489 : :
490 : 0 : might_sleep();
491 : :
492 : 0 : spin_lock_irq(&hcd_root_hub_lock);
493 : 0 : status = usb_hcd_link_urb_to_ep(hcd, urb);
494 : 0 : spin_unlock_irq(&hcd_root_hub_lock);
495 [ # # ]: 0 : if (status)
496 : : return status;
497 : 0 : urb->hcpriv = hcd; /* Indicate it's queued */
498 : :
499 : 0 : cmd = (struct usb_ctrlrequest *) urb->setup_packet;
500 : 0 : typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
501 : 0 : wValue = le16_to_cpu (cmd->wValue);
502 : 0 : wIndex = le16_to_cpu (cmd->wIndex);
503 : 0 : wLength = le16_to_cpu (cmd->wLength);
504 : :
505 [ # # ]: 0 : if (wLength > urb->transfer_buffer_length)
506 : 0 : goto error;
507 : :
508 : : /*
509 : : * tbuf should be at least as big as the
510 : : * USB hub descriptor.
511 : : */
512 : 0 : tbuf_size = max_t(u16, sizeof(struct usb_hub_descriptor), wLength);
513 : 0 : tbuf = kzalloc(tbuf_size, GFP_KERNEL);
514 [ # # ]: 0 : if (!tbuf) {
515 : 0 : status = -ENOMEM;
516 : 0 : goto err_alloc;
517 : : }
518 : :
519 : 0 : bufp = tbuf;
520 : :
521 : :
522 : 0 : urb->actual_length = 0;
523 [ # # # # : 0 : 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 : 0 : case DeviceRequest | USB_REQ_GET_STATUS:
544 [ # # ]: 0 : tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
545 : 0 : << USB_DEVICE_REMOTE_WAKEUP)
546 : 0 : | (1 << USB_DEVICE_SELF_POWERED);
547 : 0 : tbuf[1] = 0;
548 : 0 : len = 2;
549 : 0 : break;
550 : 0 : 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 : 0 : goto error;
555 : 0 : break;
556 : 0 : 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 : 0 : device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
560 : : else
561 : 0 : goto error;
562 : 0 : break;
563 : 0 : case DeviceRequest | USB_REQ_GET_CONFIGURATION:
564 : 0 : tbuf[0] = 1;
565 : 0 : len = 1;
566 : : /* FALLTHROUGH */
567 : : case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
568 : : break;
569 : 0 : case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
570 [ # # # # : 0 : switch (wValue & 0xff00) {
# ]
571 : 0 : case USB_DT_DEVICE << 8:
572 [ # # # # : 0 : switch (hcd->speed) {
# # ]
573 : : case HCD_USB32:
574 : : case HCD_USB31:
575 : : bufp = usb31_rh_dev_descriptor;
576 : : break;
577 : 0 : case HCD_USB3:
578 : 0 : bufp = usb3_rh_dev_descriptor;
579 : 0 : break;
580 : 0 : case HCD_USB25:
581 : 0 : bufp = usb25_rh_dev_descriptor;
582 : 0 : break;
583 : 0 : case HCD_USB2:
584 : 0 : bufp = usb2_rh_dev_descriptor;
585 : 0 : break;
586 : 0 : case HCD_USB11:
587 : 0 : bufp = usb11_rh_dev_descriptor;
588 : 0 : break;
589 : 0 : default:
590 : 0 : goto error;
591 : : }
592 : 0 : len = 18;
593 [ # # ]: 0 : if (hcd->has_tt)
594 : 0 : patch_protocol = 1;
595 : : break;
596 : 0 : case USB_DT_CONFIG << 8:
597 [ # # # # ]: 0 : 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 : 0 : case HCD_USB25:
605 : : case HCD_USB2:
606 : 0 : bufp = hs_rh_config_descriptor;
607 : 0 : len = sizeof hs_rh_config_descriptor;
608 : 0 : break;
609 : 0 : case HCD_USB11:
610 : 0 : bufp = fs_rh_config_descriptor;
611 : 0 : len = sizeof fs_rh_config_descriptor;
612 : 0 : break;
613 : 0 : default:
614 : 0 : goto error;
615 : : }
616 [ # # ]: 0 : if (device_can_wakeup(&hcd->self.root_hub->dev))
617 : 0 : patch_wakeup = 1;
618 : : break;
619 : 0 : case USB_DT_STRING << 8:
620 [ # # ]: 0 : if ((wValue & 0xff) < 4)
621 : 0 : urb->actual_length = rh_string(wValue & 0xff,
622 : : hcd, ubuf, wLength);
623 : : else /* unsupported IDs --> "protocol stall" */
624 : 0 : goto error;
625 : 0 : break;
626 : 0 : case USB_DT_BOS << 8:
627 : 0 : goto nongeneric;
628 : 0 : default:
629 : 0 : goto error;
630 : : }
631 : : break;
632 : 0 : case DeviceRequest | USB_REQ_GET_INTERFACE:
633 : 0 : tbuf[0] = 0;
634 : 0 : 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 : 0 : case EndpointRequest | USB_REQ_GET_STATUS:
649 : : /* ENDPOINT_HALT flag */
650 : 0 : tbuf[0] = 0;
651 : 0 : tbuf[1] = 0;
652 : 0 : 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 : 0 : nongeneric:
663 : : /* non-generic request */
664 [ # # # # ]: 0 : switch (typeReq) {
665 : 0 : case GetHubStatus:
666 : 0 : len = 4;
667 : 0 : break;
668 : 0 : case GetPortStatus:
669 [ # # ]: 0 : if (wValue == HUB_PORT_STATUS)
670 : : len = 4;
671 : : else
672 : : /* other port status types return 8 bytes */
673 : 0 : len = 8;
674 : : break;
675 : 0 : case GetHubDescriptor:
676 : 0 : len = sizeof (struct usb_hub_descriptor);
677 : 0 : break;
678 : : case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
679 : : /* len is returned by hub_control */
680 : : break;
681 : : }
682 : 0 : status = hcd->driver->hub_control (hcd,
683 : : typeReq, wValue, wIndex,
684 : : tbuf, wLength);
685 : :
686 [ # # ]: 0 : if (typeReq == GetHubDescriptor)
687 : 0 : 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 [ # # ]: 0 : 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 [ # # ]: 0 : } else if (status > 0) {
705 : : /* hub_control may return the length of data copied. */
706 : 0 : len = status;
707 : 0 : status = 0;
708 : : }
709 [ # # ]: 0 : if (len) {
710 : 0 : if (urb->transfer_buffer_length < len)
711 : : len = urb->transfer_buffer_length;
712 : 0 : urb->actual_length = len;
713 : : /* always USB_DIR_IN, toward host */
714 : 0 : memcpy (ubuf, bufp, len);
715 : :
716 : : /* report whether RH hardware supports remote wakeup */
717 : 0 : if (patch_wakeup &&
718 [ # # ]: 0 : len > offsetof (struct usb_config_descriptor,
719 : : bmAttributes))
720 : 0 : ((struct usb_config_descriptor *)ubuf)->bmAttributes
721 : 0 : |= USB_CONFIG_ATT_WAKEUP;
722 : :
723 : : /* report whether RH hardware has an integrated TT */
724 : 0 : if (patch_protocol &&
725 [ # # ]: 0 : len > offsetof(struct usb_device_descriptor,
726 : : bDeviceProtocol))
727 : 0 : ((struct usb_device_descriptor *) ubuf)->
728 : 0 : bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
729 : : }
730 : :
731 : 0 : kfree(tbuf);
732 : 0 : err_alloc:
733 : :
734 : : /* any errors get returned through the urb completion */
735 : 0 : spin_lock_irq(&hcd_root_hub_lock);
736 : 0 : usb_hcd_unlink_urb_from_ep(hcd, urb);
737 : 0 : usb_hcd_giveback_urb(hcd, urb, status);
738 : 0 : spin_unlock_irq(&hcd_root_hub_lock);
739 : 0 : 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 : 0 : void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
753 : : {
754 : 0 : struct urb *urb;
755 : 0 : int length;
756 : 0 : unsigned long flags;
757 : 0 : char buffer[6]; /* Any root hubs with > 31 ports? */
758 : :
759 [ # # ]: 0 : if (unlikely(!hcd->rh_pollable))
760 : 0 : return;
761 [ # # # # ]: 0 : if (!hcd->uses_new_polling && !hcd->status_urb)
762 : : return;
763 : :
764 : 0 : length = hcd->driver->hub_status_data(hcd, buffer);
765 [ # # ]: 0 : if (length > 0) {
766 : :
767 : : /* try to complete the status urb */
768 : 0 : spin_lock_irqsave(&hcd_root_hub_lock, flags);
769 : 0 : urb = hcd->status_urb;
770 [ # # ]: 0 : if (urb) {
771 : 0 : clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
772 : 0 : hcd->status_urb = NULL;
773 : 0 : urb->actual_length = length;
774 : 0 : memcpy(urb->transfer_buffer, buffer, length);
775 : :
776 : 0 : usb_hcd_unlink_urb_from_ep(hcd, urb);
777 : 0 : usb_hcd_giveback_urb(hcd, urb, 0);
778 : : } else {
779 : 0 : length = 0;
780 : 0 : set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
781 : : }
782 : 0 : 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 [ # # # # ]: 0 : if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
790 [ # # # # ]: 0 : (length == 0 && hcd->status_urb != NULL))
791 : 0 : 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 : 0 : static void rh_timer_func (struct timer_list *t)
797 : : {
798 : 0 : struct usb_hcd *_hcd = from_timer(_hcd, t, rh_timer);
799 : :
800 : 0 : usb_hcd_poll_rh_status(_hcd);
801 : 0 : }
802 : :
803 : : /*-------------------------------------------------------------------------*/
804 : :
805 : 0 : static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
806 : : {
807 : 0 : int retval;
808 : 0 : unsigned long flags;
809 : 0 : unsigned len = 1 + (urb->dev->maxchild / 8);
810 : :
811 : 0 : spin_lock_irqsave (&hcd_root_hub_lock, flags);
812 [ # # # # ]: 0 : if (hcd->status_urb || urb->transfer_buffer_length < len) {
813 : 0 : dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
814 : 0 : retval = -EINVAL;
815 : 0 : goto done;
816 : : }
817 : :
818 : 0 : retval = usb_hcd_link_urb_to_ep(hcd, urb);
819 [ # # ]: 0 : if (retval)
820 : 0 : goto done;
821 : :
822 : 0 : hcd->status_urb = urb;
823 : 0 : urb->hcpriv = hcd; /* indicate it's queued */
824 [ # # ]: 0 : if (!hcd->uses_new_polling)
825 : 0 : 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 : 0 : done:
832 : 0 : spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
833 : 0 : return retval;
834 : : }
835 : :
836 : 0 : static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
837 : : {
838 [ # # ]: 0 : if (usb_endpoint_xfer_int(&urb->ep->desc))
839 : 0 : return rh_queue_status (hcd, urb);
840 [ # # ]: 0 : if (usb_endpoint_xfer_control(&urb->ep->desc))
841 : 0 : 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 : 0 : unsigned long flags;
853 : 0 : int rc;
854 : :
855 : 0 : spin_lock_irqsave(&hcd_root_hub_lock, flags);
856 : 0 : rc = usb_hcd_check_unlink_urb(hcd, urb, status);
857 : 0 : if (rc)
858 : 0 : 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 : 0 : done:
873 : 0 : 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 : 0 : static void usb_bus_init (struct usb_bus *bus)
888 : : {
889 : 0 : memset (&bus->devmap, 0, sizeof(struct usb_devmap));
890 : :
891 : 0 : bus->devnum_next = 1;
892 : :
893 : 0 : bus->root_hub = NULL;
894 : 0 : bus->busnum = -1;
895 : 0 : bus->bandwidth_allocated = 0;
896 : 0 : bus->bandwidth_int_reqs = 0;
897 : 0 : bus->bandwidth_isoc_reqs = 0;
898 : 0 : mutex_init(&bus->devnum_next_mutex);
899 : 0 : }
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 : 0 : static int usb_register_bus(struct usb_bus *bus)
914 : : {
915 : 0 : int result = -E2BIG;
916 : 0 : int busnum;
917 : :
918 : 0 : mutex_lock(&usb_bus_idr_lock);
919 : 0 : busnum = idr_alloc(&usb_bus_idr, bus, 1, USB_MAXBUS, GFP_KERNEL);
920 [ # # ]: 0 : if (busnum < 0) {
921 : 0 : pr_err("%s: failed to get bus number\n", usbcore_name);
922 : 0 : goto error_find_busnum;
923 : : }
924 : 0 : bus->busnum = busnum;
925 : 0 : mutex_unlock(&usb_bus_idr_lock);
926 : :
927 : 0 : usb_notify_add_bus(bus);
928 : :
929 : 0 : dev_info (bus->controller, "new USB bus registered, assigned bus "
930 : : "number %d\n", bus->busnum);
931 : 0 : 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 : 0 : static int register_root_hub(struct usb_hcd *hcd)
974 : : {
975 : 0 : struct device *parent_dev = hcd->self.controller;
976 : 0 : struct usb_device *usb_dev = hcd->self.root_hub;
977 : 0 : const int devnum = 1;
978 : 0 : int retval;
979 : :
980 : 0 : usb_dev->devnum = devnum;
981 : 0 : usb_dev->bus->devnum_next = devnum + 1;
982 : 0 : set_bit (devnum, usb_dev->bus->devmap.devicemap);
983 : 0 : usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
984 : :
985 : 0 : mutex_lock(&usb_bus_idr_lock);
986 : :
987 : 0 : usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
988 : 0 : retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
989 [ # # ]: 0 : if (retval != sizeof usb_dev->descriptor) {
990 : 0 : mutex_unlock(&usb_bus_idr_lock);
991 : 0 : 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 [ # # ]: 0 : 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 : 0 : 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 : 0 : retval = usb_new_device (usb_dev);
1009 [ # # ]: 0 : 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 : 0 : spin_lock_irq (&hcd_root_hub_lock);
1014 : 0 : hcd->rh_registered = 1;
1015 : 0 : spin_unlock_irq (&hcd_root_hub_lock);
1016 : :
1017 : : /* Did the HC die before the root hub was registered? */
1018 [ # # ]: 0 : if (HCD_DEAD(hcd))
1019 : 0 : usb_hc_died (hcd); /* This time clean up */
1020 : : }
1021 : 0 : mutex_unlock(&usb_bus_idr_lock);
1022 : :
1023 : 0 : 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 : 0 : unsigned long tmp;
1088 : :
1089 [ # # # # ]: 0 : switch (speed) {
1090 : 0 : 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 : 0 : 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 : 0 : 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 : 0 : int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1145 : : {
1146 : 0 : int rc = 0;
1147 : :
1148 : 0 : spin_lock(&hcd_urb_list_lock);
1149 : :
1150 : : /* Check that the URB isn't being killed */
1151 [ # # ]: 0 : if (unlikely(atomic_read(&urb->reject))) {
1152 : 0 : rc = -EPERM;
1153 : 0 : goto done;
1154 : : }
1155 : :
1156 [ # # ]: 0 : if (unlikely(!urb->ep->enabled)) {
1157 : 0 : rc = -ENOENT;
1158 : 0 : goto done;
1159 : : }
1160 : :
1161 [ # # ]: 0 : if (unlikely(!urb->dev->can_submit)) {
1162 : 0 : rc = -EHOSTUNREACH;
1163 : 0 : goto done;
1164 : : }
1165 : :
1166 : : /*
1167 : : * Check the host controller's state and add the URB to the
1168 : : * endpoint's queue.
1169 : : */
1170 [ # # ]: 0 : if (HCD_RH_RUNNING(hcd)) {
1171 : 0 : urb->unlinked = 0;
1172 : 0 : list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1173 : : } else {
1174 : 0 : rc = -ESHUTDOWN;
1175 : 0 : goto done;
1176 : : }
1177 : 0 : done:
1178 : 0 : spin_unlock(&hcd_urb_list_lock);
1179 : 0 : 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 : 0 : int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1203 : : int status)
1204 : : {
1205 : 0 : struct list_head *tmp;
1206 : :
1207 : : /* insist the urb is still queued */
1208 [ # # # # ]: 0 : list_for_each(tmp, &urb->ep->urb_list) {
1209 [ # # # # ]: 0 : if (tmp == &urb->urb_list)
1210 : : break;
1211 : : }
1212 [ # # # # ]: 0 : 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 [ # # # # ]: 0 : if (urb->unlinked)
1219 : : return -EBUSY;
1220 : 0 : urb->unlinked = status;
1221 [ # # ]: 0 : 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 : 0 : 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 : 0 : spin_lock(&hcd_urb_list_lock);
1239 : 0 : list_del_init(&urb->urb_list);
1240 : 0 : spin_unlock(&hcd_urb_list_lock);
1241 : 0 : }
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 : 0 : unsigned char *vaddr;
1276 : :
1277 [ # # ]: 0 : if (*vaddr_handle == NULL) {
1278 : 0 : WARN_ON_ONCE(1);
1279 : 0 : 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 : 0 : void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
1323 : : {
1324 : 0 : if (IS_ENABLED(CONFIG_HAS_DMA) &&
1325 [ # # ]: 0 : (urb->transfer_flags & URB_SETUP_MAP_SINGLE))
1326 : 0 : dma_unmap_single(hcd->self.sysdev,
1327 : : urb->setup_dma,
1328 : : sizeof(struct usb_ctrlrequest),
1329 : : DMA_TO_DEVICE);
1330 [ # # ]: 0 : else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1331 : 0 : hcd_free_coherent(urb->dev->bus,
1332 : : &urb->setup_dma,
1333 : : (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 : 0 : urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1339 : 0 : }
1340 : : EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1341 : :
1342 : 0 : static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1343 : : {
1344 [ # # ]: 0 : if (hcd->driver->unmap_urb_for_dma)
1345 : 0 : hcd->driver->unmap_urb_for_dma(hcd, urb);
1346 : : else
1347 : 0 : usb_hcd_unmap_urb_for_dma(hcd, urb);
1348 : 0 : }
1349 : :
1350 : 0 : void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1351 : : {
1352 : 0 : enum dma_data_direction dir;
1353 : :
1354 : 0 : usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1355 : :
1356 [ # # ]: 0 : dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1357 : 0 : if (IS_ENABLED(CONFIG_HAS_DMA) &&
1358 [ # # ]: 0 : (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 : 0 : else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1364 [ # # ]: 0 : (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 : 0 : else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1370 [ # # ]: 0 : (urb->transfer_flags & URB_DMA_MAP_SINGLE))
1371 : 0 : dma_unmap_single(hcd->self.sysdev,
1372 : : urb->transfer_dma,
1373 : : urb->transfer_buffer_length,
1374 : : dir);
1375 [ # # ]: 0 : 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 : 0 : urb->transfer_buffer_length,
1380 : : dir);
1381 : :
1382 : : /* Make it safe to call this routine more than once */
1383 : 0 : urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
1384 : : URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1385 : 0 : }
1386 : : EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
1387 : :
1388 : 0 : static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1389 : : gfp_t mem_flags)
1390 : : {
1391 [ # # ]: 0 : if (hcd->driver->map_urb_for_dma)
1392 : 0 : return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1393 : : else
1394 : 0 : return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1395 : : }
1396 : :
1397 : 0 : int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1398 : : gfp_t mem_flags)
1399 : : {
1400 : 0 : enum dma_data_direction dir;
1401 : 0 : 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 [ # # ]: 0 : if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1410 [ # # ]: 0 : if (hcd->self.uses_pio_for_control)
1411 : : return ret;
1412 [ # # ]: 0 : 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 [ # # ]: 0 : } else if (hcd_uses_dma(hcd)) {
1423 [ # # ]: 0 : if (object_is_on_stack(urb->setup_packet)) {
1424 [ # # ]: 0 : WARN_ONCE(1, "setup packet is on stack\n");
1425 : 0 : return -EAGAIN;
1426 : : }
1427 : :
1428 : 0 : urb->setup_dma = dma_map_single(
1429 : : hcd->self.sysdev,
1430 : : urb->setup_packet,
1431 : : sizeof(struct usb_ctrlrequest),
1432 : : DMA_TO_DEVICE);
1433 : 0 : if (dma_mapping_error(hcd->self.sysdev,
1434 : : urb->setup_dma))
1435 : : return -EAGAIN;
1436 : 0 : urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1437 : : }
1438 : : }
1439 : :
1440 [ # # ]: 0 : dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1441 [ # # ]: 0 : if (urb->transfer_buffer_length != 0
1442 [ # # ]: 0 : && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1443 [ # # ]: 0 : if (hcd->localmem_pool) {
1444 : 0 : ret = hcd_alloc_coherent(
1445 : 0 : urb->dev->bus, mem_flags,
1446 : : &urb->transfer_dma,
1447 : : &urb->transfer_buffer,
1448 : : urb->transfer_buffer_length,
1449 : : dir);
1450 [ # # ]: 0 : if (ret == 0)
1451 : 0 : urb->transfer_flags |= URB_MAP_LOCAL;
1452 [ # # ]: 0 : } else if (hcd_uses_dma(hcd)) {
1453 [ # # ]: 0 : if (urb->num_sgs) {
1454 : 0 : int n;
1455 : :
1456 : : /* We don't support sg for isoc transfers ! */
1457 [ # # ]: 0 : if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1458 : 0 : WARN_ON(1);
1459 : 0 : return -EINVAL;
1460 : : }
1461 : :
1462 : 0 : n = dma_map_sg(
1463 : : hcd->self.sysdev,
1464 : : urb->sg,
1465 : : urb->num_sgs,
1466 : : dir);
1467 [ # # ]: 0 : if (n <= 0)
1468 : : ret = -EAGAIN;
1469 : : else
1470 : 0 : urb->transfer_flags |= URB_DMA_MAP_SG;
1471 : 0 : urb->num_mapped_sgs = n;
1472 [ # # ]: 0 : if (n != urb->num_sgs)
1473 : 0 : urb->transfer_flags |=
1474 : : URB_DMA_SG_COMBINED;
1475 [ # # ]: 0 : } else if (urb->sg) {
1476 : 0 : struct scatterlist *sg = urb->sg;
1477 : 0 : urb->transfer_dma = dma_map_page(
1478 : : hcd->self.sysdev,
1479 : : sg_page(sg),
1480 : : sg->offset,
1481 : : urb->transfer_buffer_length,
1482 : : dir);
1483 : 0 : if (dma_mapping_error(hcd->self.sysdev,
1484 : : urb->transfer_dma))
1485 : : ret = -EAGAIN;
1486 : : else
1487 : 0 : urb->transfer_flags |= URB_DMA_MAP_PAGE;
1488 [ # # ]: 0 : } else if (object_is_on_stack(urb->transfer_buffer)) {
1489 [ # # ]: 0 : WARN_ONCE(1, "transfer buffer is on stack\n");
1490 : : ret = -EAGAIN;
1491 : : } else {
1492 : 0 : urb->transfer_dma = dma_map_single(
1493 : : hcd->self.sysdev,
1494 : : urb->transfer_buffer,
1495 : : urb->transfer_buffer_length,
1496 : : dir);
1497 : 0 : if (dma_mapping_error(hcd->self.sysdev,
1498 : : urb->transfer_dma))
1499 : : ret = -EAGAIN;
1500 : : else
1501 : 0 : urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1502 : : }
1503 : : }
1504 [ # # # # ]: 0 : if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1505 : : URB_SETUP_MAP_LOCAL)))
1506 : 0 : usb_hcd_unmap_urb_for_dma(hcd, urb);
1507 : : }
1508 : : return ret;
1509 : : }
1510 : : EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1511 : :
1512 : : /*-------------------------------------------------------------------------*/
1513 : :
1514 : : /* may be called in any context with a valid urb->dev usecount
1515 : : * caller surrenders "ownership" of urb
1516 : : * expects usb_submit_urb() to have sanity checked and conditioned all
1517 : : * inputs in the urb
1518 : : */
1519 : 0 : int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1520 : : {
1521 : 0 : int status;
1522 : 0 : struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1523 : :
1524 : : /* increment urb's reference count as part of giving it to the HCD
1525 : : * (which will control it). HCD guarantees that it either returns
1526 : : * an error or calls giveback(), but not both.
1527 : : */
1528 : 0 : usb_get_urb(urb);
1529 : 0 : atomic_inc(&urb->use_count);
1530 : 0 : atomic_inc(&urb->dev->urbnum);
1531 [ # # ]: 0 : usbmon_urb_submit(&hcd->self, urb);
1532 : :
1533 : : /* NOTE requirements on root-hub callers (usbfs and the hub
1534 : : * driver, for now): URBs' urb->transfer_buffer must be
1535 : : * valid and usb_buffer_{sync,unmap}() not be needed, since
1536 : : * they could clobber root hub response data. Also, control
1537 : : * URBs must be submitted in process context with interrupts
1538 : : * enabled.
1539 : : */
1540 : :
1541 [ # # ]: 0 : if (is_root_hub(urb->dev)) {
1542 : 0 : status = rh_urb_enqueue(hcd, urb);
1543 : : } else {
1544 : 0 : status = map_urb_for_dma(hcd, urb, mem_flags);
1545 [ # # ]: 0 : if (likely(status == 0)) {
1546 : 0 : status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1547 [ # # ]: 0 : if (unlikely(status))
1548 : 0 : unmap_urb_for_dma(hcd, urb);
1549 : : }
1550 : : }
1551 : :
1552 [ # # ]: 0 : if (unlikely(status)) {
1553 [ # # ]: 0 : usbmon_urb_submit_error(&hcd->self, urb, status);
1554 : 0 : urb->hcpriv = NULL;
1555 : 0 : INIT_LIST_HEAD(&urb->urb_list);
1556 : 0 : atomic_dec(&urb->use_count);
1557 : 0 : atomic_dec(&urb->dev->urbnum);
1558 [ # # ]: 0 : if (atomic_read(&urb->reject))
1559 : 0 : wake_up(&usb_kill_urb_queue);
1560 : 0 : usb_put_urb(urb);
1561 : : }
1562 : 0 : return status;
1563 : : }
1564 : :
1565 : : /*-------------------------------------------------------------------------*/
1566 : :
1567 : : /* this makes the hcd giveback() the urb more quickly, by kicking it
1568 : : * off hardware queues (which may take a while) and returning it as
1569 : : * soon as practical. we've already set up the urb's return status,
1570 : : * but we can't know if the callback completed already.
1571 : : */
1572 : 0 : static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1573 : : {
1574 : 0 : int value;
1575 : :
1576 [ # # ]: 0 : if (is_root_hub(urb->dev))
1577 : 0 : value = usb_rh_urb_dequeue(hcd, urb, status);
1578 : : else {
1579 : :
1580 : : /* The only reason an HCD might fail this call is if
1581 : : * it has not yet fully queued the urb to begin with.
1582 : : * Such failures should be harmless. */
1583 : 0 : value = hcd->driver->urb_dequeue(hcd, urb, status);
1584 : : }
1585 : 0 : return value;
1586 : : }
1587 : :
1588 : : /*
1589 : : * called in any context
1590 : : *
1591 : : * caller guarantees urb won't be recycled till both unlink()
1592 : : * and the urb's completion function return
1593 : : */
1594 : 0 : int usb_hcd_unlink_urb (struct urb *urb, int status)
1595 : : {
1596 : 0 : struct usb_hcd *hcd;
1597 : 0 : struct usb_device *udev = urb->dev;
1598 : 0 : int retval = -EIDRM;
1599 : 0 : unsigned long flags;
1600 : :
1601 : : /* Prevent the device and bus from going away while
1602 : : * the unlink is carried out. If they are already gone
1603 : : * then urb->use_count must be 0, since disconnected
1604 : : * devices can't have any active URBs.
1605 : : */
1606 : 0 : spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1607 [ # # ]: 0 : if (atomic_read(&urb->use_count) > 0) {
1608 : 0 : retval = 0;
1609 : 0 : usb_get_dev(udev);
1610 : : }
1611 : 0 : spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1612 [ # # ]: 0 : if (retval == 0) {
1613 : 0 : hcd = bus_to_hcd(urb->dev->bus);
1614 : 0 : retval = unlink1(hcd, urb, status);
1615 [ # # ]: 0 : if (retval == 0)
1616 : : retval = -EINPROGRESS;
1617 : 0 : else if (retval != -EIDRM && retval != -EBUSY)
1618 : : dev_dbg(&udev->dev, "hcd_unlink_urb %pK fail %d\n",
1619 : : urb, retval);
1620 : 0 : usb_put_dev(udev);
1621 : : }
1622 : 0 : return retval;
1623 : : }
1624 : :
1625 : : /*-------------------------------------------------------------------------*/
1626 : :
1627 : 0 : static void __usb_hcd_giveback_urb(struct urb *urb)
1628 : : {
1629 [ # # ]: 0 : struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1630 : 0 : struct usb_anchor *anchor = urb->anchor;
1631 : 0 : int status = urb->unlinked;
1632 : :
1633 : 0 : urb->hcpriv = NULL;
1634 [ # # # # : 0 : if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
# # ]
1635 : : urb->actual_length < urb->transfer_buffer_length &&
1636 : : !status))
1637 : 0 : status = -EREMOTEIO;
1638 : :
1639 : 0 : unmap_urb_for_dma(hcd, urb);
1640 [ # # ]: 0 : usbmon_urb_complete(&hcd->self, urb, status);
1641 : 0 : usb_anchor_suspend_wakeups(anchor);
1642 : 0 : usb_unanchor_urb(urb);
1643 : 0 : if (likely(status == 0))
1644 : : usb_led_activity(USB_LED_EVENT_HOST);
1645 : :
1646 : : /* pass ownership to the completion handler */
1647 : 0 : urb->status = status;
1648 : 0 : urb->complete(urb);
1649 : :
1650 : 0 : usb_anchor_resume_wakeups(anchor);
1651 : 0 : atomic_dec(&urb->use_count);
1652 [ # # ]: 0 : if (unlikely(atomic_read(&urb->reject)))
1653 : 0 : wake_up(&usb_kill_urb_queue);
1654 : 0 : usb_put_urb(urb);
1655 : 0 : }
1656 : :
1657 : 0 : static void usb_giveback_urb_bh(unsigned long param)
1658 : : {
1659 : 0 : struct giveback_urb_bh *bh = (struct giveback_urb_bh *)param;
1660 : 0 : struct list_head local_list;
1661 : :
1662 : 0 : spin_lock_irq(&bh->lock);
1663 : 0 : bh->running = true;
1664 : 0 : restart:
1665 : 0 : list_replace_init(&bh->head, &local_list);
1666 : 0 : spin_unlock_irq(&bh->lock);
1667 : :
1668 [ # # ]: 0 : while (!list_empty(&local_list)) {
1669 : 0 : struct urb *urb;
1670 : :
1671 : 0 : urb = list_entry(local_list.next, struct urb, urb_list);
1672 : 0 : list_del_init(&urb->urb_list);
1673 : 0 : bh->completing_ep = urb->ep;
1674 : 0 : __usb_hcd_giveback_urb(urb);
1675 : 0 : bh->completing_ep = NULL;
1676 : : }
1677 : :
1678 : : /* check if there are new URBs to giveback */
1679 : 0 : spin_lock_irq(&bh->lock);
1680 [ # # ]: 0 : if (!list_empty(&bh->head))
1681 : 0 : goto restart;
1682 : 0 : bh->running = false;
1683 : 0 : spin_unlock_irq(&bh->lock);
1684 : 0 : }
1685 : :
1686 : : /**
1687 : : * usb_hcd_giveback_urb - return URB from HCD to device driver
1688 : : * @hcd: host controller returning the URB
1689 : : * @urb: urb being returned to the USB device driver.
1690 : : * @status: completion status code for the URB.
1691 : : * Context: in_interrupt()
1692 : : *
1693 : : * This hands the URB from HCD to its USB device driver, using its
1694 : : * completion function. The HCD has freed all per-urb resources
1695 : : * (and is done using urb->hcpriv). It also released all HCD locks;
1696 : : * the device driver won't cause problems if it frees, modifies,
1697 : : * or resubmits this URB.
1698 : : *
1699 : : * If @urb was unlinked, the value of @status will be overridden by
1700 : : * @urb->unlinked. Erroneous short transfers are detected in case
1701 : : * the HCD hasn't checked for them.
1702 : : */
1703 : 0 : void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1704 : : {
1705 : 0 : struct giveback_urb_bh *bh;
1706 : 0 : bool running, high_prio_bh;
1707 : :
1708 : : /* pass status to tasklet via unlinked */
1709 [ # # ]: 0 : if (likely(!urb->unlinked))
1710 : 0 : urb->unlinked = status;
1711 : :
1712 [ # # # # ]: 0 : if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
1713 : 0 : __usb_hcd_giveback_urb(urb);
1714 : 0 : return;
1715 : : }
1716 : :
1717 [ # # ]: 0 : if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe)) {
1718 : 0 : bh = &hcd->high_prio_bh;
1719 : 0 : high_prio_bh = true;
1720 : : } else {
1721 : 0 : bh = &hcd->low_prio_bh;
1722 : 0 : high_prio_bh = false;
1723 : : }
1724 : :
1725 : 0 : spin_lock(&bh->lock);
1726 : 0 : list_add_tail(&urb->urb_list, &bh->head);
1727 : 0 : running = bh->running;
1728 : 0 : spin_unlock(&bh->lock);
1729 : :
1730 [ # # ]: 0 : if (running)
1731 : : ;
1732 [ # # ]: 0 : else if (high_prio_bh)
1733 : 0 : tasklet_hi_schedule(&bh->bh);
1734 : : else
1735 : 0 : tasklet_schedule(&bh->bh);
1736 : : }
1737 : : EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
1738 : :
1739 : : /*-------------------------------------------------------------------------*/
1740 : :
1741 : : /* Cancel all URBs pending on this endpoint and wait for the endpoint's
1742 : : * queue to drain completely. The caller must first insure that no more
1743 : : * URBs can be submitted for this endpoint.
1744 : : */
1745 : 0 : void usb_hcd_flush_endpoint(struct usb_device *udev,
1746 : : struct usb_host_endpoint *ep)
1747 : : {
1748 : 0 : struct usb_hcd *hcd;
1749 : 0 : struct urb *urb;
1750 : :
1751 [ # # ]: 0 : if (!ep)
1752 : : return;
1753 : 0 : might_sleep();
1754 : 0 : hcd = bus_to_hcd(udev->bus);
1755 : :
1756 : : /* No more submits can occur */
1757 : 0 : spin_lock_irq(&hcd_urb_list_lock);
1758 : 0 : rescan:
1759 [ # # ]: 0 : list_for_each_entry_reverse(urb, &ep->urb_list, urb_list) {
1760 : 0 : int is_in;
1761 : :
1762 [ # # ]: 0 : if (urb->unlinked)
1763 : 0 : continue;
1764 : 0 : usb_get_urb (urb);
1765 : 0 : is_in = usb_urb_dir_in(urb);
1766 : 0 : spin_unlock(&hcd_urb_list_lock);
1767 : :
1768 : : /* kick hcd */
1769 : 0 : unlink1(hcd, urb, -ESHUTDOWN);
1770 : 0 : dev_dbg (hcd->self.controller,
1771 : : "shutdown urb %pK ep%d%s-%s\n",
1772 : : urb, usb_endpoint_num(&ep->desc),
1773 : : is_in ? "in" : "out",
1774 : : usb_ep_type_string(usb_endpoint_type(&ep->desc)));
1775 : 0 : usb_put_urb (urb);
1776 : :
1777 : : /* list contents may have changed */
1778 : 0 : spin_lock(&hcd_urb_list_lock);
1779 : 0 : goto rescan;
1780 : : }
1781 : 0 : spin_unlock_irq(&hcd_urb_list_lock);
1782 : :
1783 : : /* Wait until the endpoint queue is completely empty */
1784 [ # # ]: 0 : while (!list_empty (&ep->urb_list)) {
1785 : 0 : spin_lock_irq(&hcd_urb_list_lock);
1786 : :
1787 : : /* The list may have changed while we acquired the spinlock */
1788 : 0 : urb = NULL;
1789 [ # # ]: 0 : if (!list_empty (&ep->urb_list)) {
1790 : 0 : urb = list_entry (ep->urb_list.prev, struct urb,
1791 : : urb_list);
1792 : 0 : usb_get_urb (urb);
1793 : : }
1794 : 0 : spin_unlock_irq(&hcd_urb_list_lock);
1795 : :
1796 [ # # ]: 0 : if (urb) {
1797 : 0 : usb_kill_urb (urb);
1798 : 0 : usb_put_urb (urb);
1799 : : }
1800 : : }
1801 : : }
1802 : :
1803 : : /**
1804 : : * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1805 : : * the bus bandwidth
1806 : : * @udev: target &usb_device
1807 : : * @new_config: new configuration to install
1808 : : * @cur_alt: the current alternate interface setting
1809 : : * @new_alt: alternate interface setting that is being installed
1810 : : *
1811 : : * To change configurations, pass in the new configuration in new_config,
1812 : : * and pass NULL for cur_alt and new_alt.
1813 : : *
1814 : : * To reset a device's configuration (put the device in the ADDRESSED state),
1815 : : * pass in NULL for new_config, cur_alt, and new_alt.
1816 : : *
1817 : : * To change alternate interface settings, pass in NULL for new_config,
1818 : : * pass in the current alternate interface setting in cur_alt,
1819 : : * and pass in the new alternate interface setting in new_alt.
1820 : : *
1821 : : * Return: An error if the requested bandwidth change exceeds the
1822 : : * bus bandwidth or host controller internal resources.
1823 : : */
1824 : 0 : int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1825 : : struct usb_host_config *new_config,
1826 : : struct usb_host_interface *cur_alt,
1827 : : struct usb_host_interface *new_alt)
1828 : : {
1829 : 0 : int num_intfs, i, j;
1830 : 0 : struct usb_host_interface *alt = NULL;
1831 : 0 : int ret = 0;
1832 : 0 : struct usb_hcd *hcd;
1833 : 0 : struct usb_host_endpoint *ep;
1834 : :
1835 [ # # ]: 0 : hcd = bus_to_hcd(udev->bus);
1836 [ # # ]: 0 : if (!hcd->driver->check_bandwidth)
1837 : : return 0;
1838 : :
1839 : : /* Configuration is being removed - set configuration 0 */
1840 [ # # ]: 0 : if (!new_config && !cur_alt) {
1841 [ # # ]: 0 : for (i = 1; i < 16; ++i) {
1842 : 0 : ep = udev->ep_out[i];
1843 [ # # ]: 0 : if (ep)
1844 : 0 : hcd->driver->drop_endpoint(hcd, udev, ep);
1845 : 0 : ep = udev->ep_in[i];
1846 [ # # ]: 0 : if (ep)
1847 : 0 : hcd->driver->drop_endpoint(hcd, udev, ep);
1848 : : }
1849 : 0 : hcd->driver->check_bandwidth(hcd, udev);
1850 : 0 : return 0;
1851 : : }
1852 : : /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1853 : : * each interface's alt setting 0 and ask the HCD to check the bandwidth
1854 : : * of the bus. There will always be bandwidth for endpoint 0, so it's
1855 : : * ok to exclude it.
1856 : : */
1857 [ # # ]: 0 : if (new_config) {
1858 : 0 : num_intfs = new_config->desc.bNumInterfaces;
1859 : : /* Remove endpoints (except endpoint 0, which is always on the
1860 : : * schedule) from the old config from the schedule
1861 : : */
1862 [ # # ]: 0 : for (i = 1; i < 16; ++i) {
1863 : 0 : ep = udev->ep_out[i];
1864 [ # # ]: 0 : if (ep) {
1865 : 0 : ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1866 [ # # ]: 0 : if (ret < 0)
1867 : 0 : goto reset;
1868 : : }
1869 : 0 : ep = udev->ep_in[i];
1870 [ # # ]: 0 : if (ep) {
1871 : 0 : ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1872 [ # # ]: 0 : if (ret < 0)
1873 : 0 : goto reset;
1874 : : }
1875 : : }
1876 [ # # ]: 0 : for (i = 0; i < num_intfs; ++i) {
1877 : 0 : struct usb_host_interface *first_alt;
1878 : 0 : int iface_num;
1879 : :
1880 : 0 : first_alt = &new_config->intf_cache[i]->altsetting[0];
1881 : 0 : iface_num = first_alt->desc.bInterfaceNumber;
1882 : : /* Set up endpoints for alternate interface setting 0 */
1883 : 0 : alt = usb_find_alt_setting(new_config, iface_num, 0);
1884 [ # # ]: 0 : if (!alt)
1885 : : /* No alt setting 0? Pick the first setting. */
1886 : 0 : alt = first_alt;
1887 : :
1888 [ # # ]: 0 : for (j = 0; j < alt->desc.bNumEndpoints; j++) {
1889 : 0 : ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
1890 [ # # ]: 0 : if (ret < 0)
1891 : 0 : goto reset;
1892 : : }
1893 : : }
1894 : : }
1895 [ # # ]: 0 : if (cur_alt && new_alt) {
1896 : 0 : struct usb_interface *iface = usb_ifnum_to_if(udev,
1897 : 0 : cur_alt->desc.bInterfaceNumber);
1898 : :
1899 [ # # ]: 0 : if (!iface)
1900 : : return -EINVAL;
1901 [ # # ]: 0 : if (iface->resetting_device) {
1902 : : /*
1903 : : * The USB core just reset the device, so the xHCI host
1904 : : * and the device will think alt setting 0 is installed.
1905 : : * However, the USB core will pass in the alternate
1906 : : * setting installed before the reset as cur_alt. Dig
1907 : : * out the alternate setting 0 structure, or the first
1908 : : * alternate setting if a broken device doesn't have alt
1909 : : * setting 0.
1910 : : */
1911 : 0 : cur_alt = usb_altnum_to_altsetting(iface, 0);
1912 [ # # ]: 0 : if (!cur_alt)
1913 : 0 : cur_alt = &iface->altsetting[0];
1914 : : }
1915 : :
1916 : : /* Drop all the endpoints in the current alt setting */
1917 [ # # ]: 0 : for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
1918 : 0 : ret = hcd->driver->drop_endpoint(hcd, udev,
1919 : 0 : &cur_alt->endpoint[i]);
1920 [ # # ]: 0 : if (ret < 0)
1921 : 0 : goto reset;
1922 : : }
1923 : : /* Add all the endpoints in the new alt setting */
1924 [ # # ]: 0 : for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
1925 : 0 : ret = hcd->driver->add_endpoint(hcd, udev,
1926 : 0 : &new_alt->endpoint[i]);
1927 [ # # ]: 0 : if (ret < 0)
1928 : 0 : goto reset;
1929 : : }
1930 : : }
1931 : 0 : ret = hcd->driver->check_bandwidth(hcd, udev);
1932 : 0 : reset:
1933 [ # # ]: 0 : if (ret < 0)
1934 : 0 : hcd->driver->reset_bandwidth(hcd, udev);
1935 : : return ret;
1936 : : }
1937 : :
1938 : : /* Disables the endpoint: synchronizes with the hcd to make sure all
1939 : : * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
1940 : : * have been called previously. Use for set_configuration, set_interface,
1941 : : * driver removal, physical disconnect.
1942 : : *
1943 : : * example: a qh stored in ep->hcpriv, holding state related to endpoint
1944 : : * type, maxpacket size, toggle, halt status, and scheduling.
1945 : : */
1946 : 0 : void usb_hcd_disable_endpoint(struct usb_device *udev,
1947 : : struct usb_host_endpoint *ep)
1948 : : {
1949 : 0 : struct usb_hcd *hcd;
1950 : :
1951 : 0 : might_sleep();
1952 [ # # ]: 0 : hcd = bus_to_hcd(udev->bus);
1953 [ # # ]: 0 : if (hcd->driver->endpoint_disable)
1954 : 0 : hcd->driver->endpoint_disable(hcd, ep);
1955 : 0 : }
1956 : :
1957 : : /**
1958 : : * usb_hcd_reset_endpoint - reset host endpoint state
1959 : : * @udev: USB device.
1960 : : * @ep: the endpoint to reset.
1961 : : *
1962 : : * Resets any host endpoint state such as the toggle bit, sequence
1963 : : * number and current window.
1964 : : */
1965 : 0 : void usb_hcd_reset_endpoint(struct usb_device *udev,
1966 : : struct usb_host_endpoint *ep)
1967 : : {
1968 [ # # ]: 0 : struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1969 : :
1970 [ # # ]: 0 : if (hcd->driver->endpoint_reset)
1971 : 0 : hcd->driver->endpoint_reset(hcd, ep);
1972 : : else {
1973 [ # # ]: 0 : int epnum = usb_endpoint_num(&ep->desc);
1974 [ # # ]: 0 : int is_out = usb_endpoint_dir_out(&ep->desc);
1975 [ # # ]: 0 : int is_control = usb_endpoint_xfer_control(&ep->desc);
1976 : :
1977 : 0 : usb_settoggle(udev, epnum, is_out, 0);
1978 [ # # ]: 0 : if (is_control)
1979 : 0 : usb_settoggle(udev, epnum, !is_out, 0);
1980 : : }
1981 : 0 : }
1982 : :
1983 : : /**
1984 : : * usb_alloc_streams - allocate bulk endpoint stream IDs.
1985 : : * @interface: alternate setting that includes all endpoints.
1986 : : * @eps: array of endpoints that need streams.
1987 : : * @num_eps: number of endpoints in the array.
1988 : : * @num_streams: number of streams to allocate.
1989 : : * @mem_flags: flags hcd should use to allocate memory.
1990 : : *
1991 : : * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
1992 : : * Drivers may queue multiple transfers to different stream IDs, which may
1993 : : * complete in a different order than they were queued.
1994 : : *
1995 : : * Return: On success, the number of allocated streams. On failure, a negative
1996 : : * error code.
1997 : : */
1998 : 0 : int usb_alloc_streams(struct usb_interface *interface,
1999 : : struct usb_host_endpoint **eps, unsigned int num_eps,
2000 : : unsigned int num_streams, gfp_t mem_flags)
2001 : : {
2002 : 0 : struct usb_hcd *hcd;
2003 : 0 : struct usb_device *dev;
2004 : 0 : int i, ret;
2005 : :
2006 [ # # ]: 0 : dev = interface_to_usbdev(interface);
2007 [ # # ]: 0 : hcd = bus_to_hcd(dev->bus);
2008 [ # # # # ]: 0 : if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
2009 : : return -EINVAL;
2010 [ # # ]: 0 : if (dev->speed < USB_SPEED_SUPER)
2011 : : return -EINVAL;
2012 [ # # ]: 0 : if (dev->state < USB_STATE_CONFIGURED)
2013 : : return -ENODEV;
2014 : :
2015 [ # # ]: 0 : for (i = 0; i < num_eps; i++) {
2016 : : /* Streams only apply to bulk endpoints. */
2017 [ # # ]: 0 : if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
2018 : : return -EINVAL;
2019 : : /* Re-alloc is not allowed */
2020 [ # # ]: 0 : if (eps[i]->streams)
2021 : : return -EINVAL;
2022 : : }
2023 : :
2024 : 0 : ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
2025 : : num_streams, mem_flags);
2026 [ # # ]: 0 : if (ret < 0)
2027 : : return ret;
2028 : :
2029 [ # # ]: 0 : for (i = 0; i < num_eps; i++)
2030 : 0 : eps[i]->streams = ret;
2031 : :
2032 : : return ret;
2033 : : }
2034 : : EXPORT_SYMBOL_GPL(usb_alloc_streams);
2035 : :
2036 : : /**
2037 : : * usb_free_streams - free bulk endpoint stream IDs.
2038 : : * @interface: alternate setting that includes all endpoints.
2039 : : * @eps: array of endpoints to remove streams from.
2040 : : * @num_eps: number of endpoints in the array.
2041 : : * @mem_flags: flags hcd should use to allocate memory.
2042 : : *
2043 : : * Reverts a group of bulk endpoints back to not using stream IDs.
2044 : : * Can fail if we are given bad arguments, or HCD is broken.
2045 : : *
2046 : : * Return: 0 on success. On failure, a negative error code.
2047 : : */
2048 : 0 : int usb_free_streams(struct usb_interface *interface,
2049 : : struct usb_host_endpoint **eps, unsigned int num_eps,
2050 : : gfp_t mem_flags)
2051 : : {
2052 : 0 : struct usb_hcd *hcd;
2053 : 0 : struct usb_device *dev;
2054 : 0 : int i, ret;
2055 : :
2056 [ # # ]: 0 : dev = interface_to_usbdev(interface);
2057 [ # # ]: 0 : hcd = bus_to_hcd(dev->bus);
2058 [ # # ]: 0 : if (dev->speed < USB_SPEED_SUPER)
2059 : : return -EINVAL;
2060 : :
2061 : : /* Double-free is not allowed */
2062 [ # # ]: 0 : for (i = 0; i < num_eps; i++)
2063 [ # # # # ]: 0 : if (!eps[i] || !eps[i]->streams)
2064 : : return -EINVAL;
2065 : :
2066 : 0 : ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2067 [ # # ]: 0 : if (ret < 0)
2068 : : return ret;
2069 : :
2070 [ # # ]: 0 : for (i = 0; i < num_eps; i++)
2071 : 0 : eps[i]->streams = 0;
2072 : :
2073 : : return ret;
2074 : : }
2075 : : EXPORT_SYMBOL_GPL(usb_free_streams);
2076 : :
2077 : : /* Protect against drivers that try to unlink URBs after the device
2078 : : * is gone, by waiting until all unlinks for @udev are finished.
2079 : : * Since we don't currently track URBs by device, simply wait until
2080 : : * nothing is running in the locked region of usb_hcd_unlink_urb().
2081 : : */
2082 : 0 : void usb_hcd_synchronize_unlinks(struct usb_device *udev)
2083 : : {
2084 : 0 : spin_lock_irq(&hcd_urb_unlink_lock);
2085 : 0 : spin_unlock_irq(&hcd_urb_unlink_lock);
2086 : 0 : }
2087 : :
2088 : : /*-------------------------------------------------------------------------*/
2089 : :
2090 : : /* called in any context */
2091 : 0 : int usb_hcd_get_frame_number (struct usb_device *udev)
2092 : : {
2093 [ # # ]: 0 : struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2094 : :
2095 [ # # ]: 0 : if (!HCD_RH_RUNNING(hcd))
2096 : : return -ESHUTDOWN;
2097 : 0 : return hcd->driver->get_frame_number (hcd);
2098 : : }
2099 : :
2100 : : /*-------------------------------------------------------------------------*/
2101 : :
2102 : : #ifdef CONFIG_PM
2103 : :
2104 : 0 : int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
2105 : : {
2106 [ # # ]: 0 : struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2107 : 0 : int status;
2108 : 0 : int old_state = hcd->state;
2109 : :
2110 : 0 : dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2111 : : (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2112 : : rhdev->do_remote_wakeup);
2113 [ # # ]: 0 : if (HCD_DEAD(hcd)) {
2114 : : dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2115 : : return 0;
2116 : : }
2117 : :
2118 [ # # ]: 0 : if (!hcd->driver->bus_suspend) {
2119 : : status = -ENOENT;
2120 : : } else {
2121 : 0 : clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2122 : 0 : hcd->state = HC_STATE_QUIESCING;
2123 : 0 : status = hcd->driver->bus_suspend(hcd);
2124 : : }
2125 [ # # ]: 0 : if (status == 0) {
2126 : 0 : usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
2127 : 0 : hcd->state = HC_STATE_SUSPENDED;
2128 : :
2129 [ # # ]: 0 : if (!PMSG_IS_AUTO(msg))
2130 : 0 : usb_phy_roothub_suspend(hcd->self.sysdev,
2131 : : hcd->phy_roothub);
2132 : :
2133 : : /* Did we race with a root-hub wakeup event? */
2134 [ # # ]: 0 : if (rhdev->do_remote_wakeup) {
2135 : 0 : char buffer[6];
2136 : :
2137 : 0 : status = hcd->driver->hub_status_data(hcd, buffer);
2138 [ # # ]: 0 : if (status != 0) {
2139 : 0 : dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2140 : 0 : hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2141 : 0 : status = -EBUSY;
2142 : : }
2143 : : }
2144 : : } else {
2145 : 0 : spin_lock_irq(&hcd_root_hub_lock);
2146 [ # # ]: 0 : if (!HCD_DEAD(hcd)) {
2147 : 0 : set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2148 : 0 : hcd->state = old_state;
2149 : : }
2150 : 0 : spin_unlock_irq(&hcd_root_hub_lock);
2151 : : dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2152 : : "suspend", status);
2153 : : }
2154 : : return status;
2155 : : }
2156 : :
2157 : 0 : int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
2158 : : {
2159 [ # # ]: 0 : struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
2160 : 0 : int status;
2161 : 0 : int old_state = hcd->state;
2162 : :
2163 : 0 : dev_dbg(&rhdev->dev, "usb %sresume\n",
2164 : : (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2165 [ # # ]: 0 : if (HCD_DEAD(hcd)) {
2166 : : dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2167 : : return 0;
2168 : : }
2169 : :
2170 [ # # ]: 0 : if (!PMSG_IS_AUTO(msg)) {
2171 : 0 : status = usb_phy_roothub_resume(hcd->self.sysdev,
2172 : : hcd->phy_roothub);
2173 [ # # ]: 0 : if (status)
2174 : : return status;
2175 : : }
2176 : :
2177 [ # # ]: 0 : if (!hcd->driver->bus_resume)
2178 : : return -ENOENT;
2179 [ # # ]: 0 : if (HCD_RH_RUNNING(hcd))
2180 : : return 0;
2181 : :
2182 : 0 : hcd->state = HC_STATE_RESUMING;
2183 : 0 : status = hcd->driver->bus_resume(hcd);
2184 : 0 : clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2185 [ # # ]: 0 : if (status == 0)
2186 : 0 : status = usb_phy_roothub_calibrate(hcd->phy_roothub);
2187 : :
2188 [ # # ]: 0 : if (status == 0) {
2189 : 0 : struct usb_device *udev;
2190 : 0 : int port1;
2191 : :
2192 : 0 : spin_lock_irq(&hcd_root_hub_lock);
2193 [ # # ]: 0 : if (!HCD_DEAD(hcd)) {
2194 [ # # ]: 0 : usb_set_device_state(rhdev, rhdev->actconfig
2195 : : ? USB_STATE_CONFIGURED
2196 : : : USB_STATE_ADDRESS);
2197 : 0 : set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2198 : 0 : hcd->state = HC_STATE_RUNNING;
2199 : : }
2200 : 0 : spin_unlock_irq(&hcd_root_hub_lock);
2201 : :
2202 : : /*
2203 : : * Check whether any of the enabled ports on the root hub are
2204 : : * unsuspended. If they are then a TRSMRCY delay is needed
2205 : : * (this is what the USB-2 spec calls a "global resume").
2206 : : * Otherwise we can skip the delay.
2207 : : */
2208 [ # # # # ]: 0 : usb_hub_for_each_child(rhdev, port1, udev) {
2209 [ # # ]: 0 : if (udev->state != USB_STATE_NOTATTACHED &&
2210 [ # # ]: 0 : !udev->port_is_suspended) {
2211 : 0 : usleep_range(10000, 11000); /* TRSMRCY */
2212 : 0 : break;
2213 : : }
2214 : : }
2215 : : } else {
2216 : 0 : hcd->state = old_state;
2217 : 0 : usb_phy_roothub_suspend(hcd->self.sysdev, hcd->phy_roothub);
2218 : 0 : dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2219 : : "resume", status);
2220 [ # # ]: 0 : if (status != -ESHUTDOWN)
2221 : 0 : usb_hc_died(hcd);
2222 : : }
2223 : : return status;
2224 : : }
2225 : :
2226 : : /* Workqueue routine for root-hub remote wakeup */
2227 : 0 : static void hcd_resume_work(struct work_struct *work)
2228 : : {
2229 : 0 : struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2230 : 0 : struct usb_device *udev = hcd->self.root_hub;
2231 : :
2232 : 0 : usb_remote_wakeup(udev);
2233 : 0 : }
2234 : :
2235 : : /**
2236 : : * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2237 : : * @hcd: host controller for this root hub
2238 : : *
2239 : : * The USB host controller calls this function when its root hub is
2240 : : * suspended (with the remote wakeup feature enabled) and a remote
2241 : : * wakeup request is received. The routine submits a workqueue request
2242 : : * to resume the root hub (that is, manage its downstream ports again).
2243 : : */
2244 : 0 : void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2245 : : {
2246 : 0 : unsigned long flags;
2247 : :
2248 : 0 : spin_lock_irqsave (&hcd_root_hub_lock, flags);
2249 [ # # ]: 0 : if (hcd->rh_registered) {
2250 : 0 : pm_wakeup_event(&hcd->self.root_hub->dev, 0);
2251 : 0 : set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2252 : 0 : queue_work(pm_wq, &hcd->wakeup_work);
2253 : : }
2254 : 0 : spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2255 : 0 : }
2256 : : EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2257 : :
2258 : : #endif /* CONFIG_PM */
2259 : :
2260 : : /*-------------------------------------------------------------------------*/
2261 : :
2262 : : #ifdef CONFIG_USB_OTG
2263 : :
2264 : : /**
2265 : : * usb_bus_start_enum - start immediate enumeration (for OTG)
2266 : : * @bus: the bus (must use hcd framework)
2267 : : * @port_num: 1-based number of port; usually bus->otg_port
2268 : : * Context: in_interrupt()
2269 : : *
2270 : : * Starts enumeration, with an immediate reset followed later by
2271 : : * hub_wq identifying and possibly configuring the device.
2272 : : * This is needed by OTG controller drivers, where it helps meet
2273 : : * HNP protocol timing requirements for starting a port reset.
2274 : : *
2275 : : * Return: 0 if successful.
2276 : : */
2277 : : int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2278 : : {
2279 : : struct usb_hcd *hcd;
2280 : : int status = -EOPNOTSUPP;
2281 : :
2282 : : /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2283 : : * boards with root hubs hooked up to internal devices (instead of
2284 : : * just the OTG port) may need more attention to resetting...
2285 : : */
2286 : : hcd = bus_to_hcd(bus);
2287 : : if (port_num && hcd->driver->start_port_reset)
2288 : : status = hcd->driver->start_port_reset(hcd, port_num);
2289 : :
2290 : : /* allocate hub_wq shortly after (first) root port reset finishes;
2291 : : * it may issue others, until at least 50 msecs have passed.
2292 : : */
2293 : : if (status == 0)
2294 : : mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2295 : : return status;
2296 : : }
2297 : : EXPORT_SYMBOL_GPL(usb_bus_start_enum);
2298 : :
2299 : : #endif
2300 : :
2301 : : /*-------------------------------------------------------------------------*/
2302 : :
2303 : : /**
2304 : : * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2305 : : * @irq: the IRQ being raised
2306 : : * @__hcd: pointer to the HCD whose IRQ is being signaled
2307 : : *
2308 : : * If the controller isn't HALTed, calls the driver's irq handler.
2309 : : * Checks whether the controller is now dead.
2310 : : *
2311 : : * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
2312 : : */
2313 : 0 : irqreturn_t usb_hcd_irq (int irq, void *__hcd)
2314 : : {
2315 : 0 : struct usb_hcd *hcd = __hcd;
2316 : 0 : irqreturn_t rc;
2317 : :
2318 [ # # ]: 0 : if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
2319 : : rc = IRQ_NONE;
2320 [ # # ]: 0 : else if (hcd->driver->irq(hcd) == IRQ_NONE)
2321 : : rc = IRQ_NONE;
2322 : : else
2323 : 0 : rc = IRQ_HANDLED;
2324 : :
2325 : 0 : return rc;
2326 : : }
2327 : : EXPORT_SYMBOL_GPL(usb_hcd_irq);
2328 : :
2329 : : /*-------------------------------------------------------------------------*/
2330 : :
2331 : : /* Workqueue routine for when the root-hub has died. */
2332 : 0 : static void hcd_died_work(struct work_struct *work)
2333 : : {
2334 : 0 : struct usb_hcd *hcd = container_of(work, struct usb_hcd, died_work);
2335 : 0 : static char *env[] = {
2336 : : "ERROR=DEAD",
2337 : : NULL
2338 : : };
2339 : :
2340 : : /* Notify user space that the host controller has died */
2341 : 0 : kobject_uevent_env(&hcd->self.root_hub->dev.kobj, KOBJ_OFFLINE, env);
2342 : 0 : }
2343 : :
2344 : : /**
2345 : : * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2346 : : * @hcd: pointer to the HCD representing the controller
2347 : : *
2348 : : * This is called by bus glue to report a USB host controller that died
2349 : : * while operations may still have been pending. It's called automatically
2350 : : * by the PCI glue, so only glue for non-PCI busses should need to call it.
2351 : : *
2352 : : * Only call this function with the primary HCD.
2353 : : */
2354 : 0 : void usb_hc_died (struct usb_hcd *hcd)
2355 : : {
2356 : 0 : unsigned long flags;
2357 : :
2358 : 0 : dev_err (hcd->self.controller, "HC died; cleaning up\n");
2359 : :
2360 : 0 : spin_lock_irqsave (&hcd_root_hub_lock, flags);
2361 : 0 : clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2362 : 0 : set_bit(HCD_FLAG_DEAD, &hcd->flags);
2363 [ # # ]: 0 : if (hcd->rh_registered) {
2364 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2365 : :
2366 : : /* make hub_wq clean up old urbs and devices */
2367 : 0 : usb_set_device_state (hcd->self.root_hub,
2368 : : USB_STATE_NOTATTACHED);
2369 : 0 : usb_kick_hub_wq(hcd->self.root_hub);
2370 : : }
2371 [ # # ]: 0 : if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2372 : 0 : hcd = hcd->shared_hcd;
2373 : 0 : clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2374 : 0 : set_bit(HCD_FLAG_DEAD, &hcd->flags);
2375 [ # # ]: 0 : if (hcd->rh_registered) {
2376 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2377 : :
2378 : : /* make hub_wq clean up old urbs and devices */
2379 : 0 : usb_set_device_state(hcd->self.root_hub,
2380 : : USB_STATE_NOTATTACHED);
2381 : 0 : usb_kick_hub_wq(hcd->self.root_hub);
2382 : : }
2383 : : }
2384 : :
2385 : : /* Handle the case where this function gets called with a shared HCD */
2386 : 0 : if (usb_hcd_is_primary_hcd(hcd))
2387 : 0 : schedule_work(&hcd->died_work);
2388 : : else
2389 : 0 : schedule_work(&hcd->primary_hcd->died_work);
2390 : :
2391 : 0 : spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2392 : : /* Make sure that the other roothub is also deallocated. */
2393 : 0 : }
2394 : : EXPORT_SYMBOL_GPL (usb_hc_died);
2395 : :
2396 : : /*-------------------------------------------------------------------------*/
2397 : :
2398 : 0 : static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
2399 : : {
2400 : :
2401 : 0 : spin_lock_init(&bh->lock);
2402 : 0 : INIT_LIST_HEAD(&bh->head);
2403 : 0 : tasklet_init(&bh->bh, usb_giveback_urb_bh, (unsigned long)bh);
2404 : : }
2405 : :
2406 : 0 : struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver,
2407 : : struct device *sysdev, struct device *dev, const char *bus_name,
2408 : : struct usb_hcd *primary_hcd)
2409 : : {
2410 : 0 : struct usb_hcd *hcd;
2411 : :
2412 : 0 : hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
2413 [ # # ]: 0 : if (!hcd)
2414 : : return NULL;
2415 [ # # ]: 0 : if (primary_hcd == NULL) {
2416 : 0 : hcd->address0_mutex = kmalloc(sizeof(*hcd->address0_mutex),
2417 : : GFP_KERNEL);
2418 [ # # ]: 0 : if (!hcd->address0_mutex) {
2419 : 0 : kfree(hcd);
2420 : 0 : dev_dbg(dev, "hcd address0 mutex alloc failed\n");
2421 : 0 : return NULL;
2422 : : }
2423 : 0 : mutex_init(hcd->address0_mutex);
2424 : 0 : hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2425 : : GFP_KERNEL);
2426 [ # # ]: 0 : if (!hcd->bandwidth_mutex) {
2427 : 0 : kfree(hcd->address0_mutex);
2428 : 0 : kfree(hcd);
2429 : 0 : dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2430 : 0 : return NULL;
2431 : : }
2432 : 0 : mutex_init(hcd->bandwidth_mutex);
2433 : 0 : dev_set_drvdata(dev, hcd);
2434 : : } else {
2435 : 0 : mutex_lock(&usb_port_peer_mutex);
2436 : 0 : hcd->address0_mutex = primary_hcd->address0_mutex;
2437 : 0 : hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2438 : 0 : hcd->primary_hcd = primary_hcd;
2439 : 0 : primary_hcd->primary_hcd = primary_hcd;
2440 : 0 : hcd->shared_hcd = primary_hcd;
2441 : 0 : primary_hcd->shared_hcd = hcd;
2442 : 0 : mutex_unlock(&usb_port_peer_mutex);
2443 : : }
2444 : :
2445 : 0 : kref_init(&hcd->kref);
2446 : :
2447 : 0 : usb_bus_init(&hcd->self);
2448 : 0 : hcd->self.controller = dev;
2449 : 0 : hcd->self.sysdev = sysdev;
2450 : 0 : hcd->self.bus_name = bus_name;
2451 : :
2452 : 0 : timer_setup(&hcd->rh_timer, rh_timer_func, 0);
2453 : : #ifdef CONFIG_PM
2454 [ # # ]: 0 : INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2455 : : #endif
2456 : :
2457 : 0 : INIT_WORK(&hcd->died_work, hcd_died_work);
2458 : :
2459 : 0 : hcd->driver = driver;
2460 : 0 : hcd->speed = driver->flags & HCD_MASK;
2461 [ # # ]: 0 : hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2462 : : "USB Host Controller";
2463 : 0 : return hcd;
2464 : : }
2465 : : EXPORT_SYMBOL_GPL(__usb_create_hcd);
2466 : :
2467 : : /**
2468 : : * usb_create_shared_hcd - create and initialize an HCD structure
2469 : : * @driver: HC driver that will use this hcd
2470 : : * @dev: device for this HC, stored in hcd->self.controller
2471 : : * @bus_name: value to store in hcd->self.bus_name
2472 : : * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2473 : : * PCI device. Only allocate certain resources for the primary HCD
2474 : : * Context: !in_interrupt()
2475 : : *
2476 : : * Allocate a struct usb_hcd, with extra space at the end for the
2477 : : * HC driver's private data. Initialize the generic members of the
2478 : : * hcd structure.
2479 : : *
2480 : : * Return: On success, a pointer to the created and initialized HCD structure.
2481 : : * On failure (e.g. if memory is unavailable), %NULL.
2482 : : */
2483 : 0 : struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2484 : : struct device *dev, const char *bus_name,
2485 : : struct usb_hcd *primary_hcd)
2486 : : {
2487 : 0 : return __usb_create_hcd(driver, dev, dev, bus_name, primary_hcd);
2488 : : }
2489 : : EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2490 : :
2491 : : /**
2492 : : * usb_create_hcd - create and initialize an HCD structure
2493 : : * @driver: HC driver that will use this hcd
2494 : : * @dev: device for this HC, stored in hcd->self.controller
2495 : : * @bus_name: value to store in hcd->self.bus_name
2496 : : * Context: !in_interrupt()
2497 : : *
2498 : : * Allocate a struct usb_hcd, with extra space at the end for the
2499 : : * HC driver's private data. Initialize the generic members of the
2500 : : * hcd structure.
2501 : : *
2502 : : * Return: On success, a pointer to the created and initialized HCD
2503 : : * structure. On failure (e.g. if memory is unavailable), %NULL.
2504 : : */
2505 : 0 : struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2506 : : struct device *dev, const char *bus_name)
2507 : : {
2508 : 0 : return __usb_create_hcd(driver, dev, dev, bus_name, NULL);
2509 : : }
2510 : : EXPORT_SYMBOL_GPL(usb_create_hcd);
2511 : :
2512 : : /*
2513 : : * Roothubs that share one PCI device must also share the bandwidth mutex.
2514 : : * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2515 : : * deallocated.
2516 : : *
2517 : : * Make sure to deallocate the bandwidth_mutex only when the last HCD is
2518 : : * freed. When hcd_release() is called for either hcd in a peer set,
2519 : : * invalidate the peer's ->shared_hcd and ->primary_hcd pointers.
2520 : : */
2521 : 0 : static void hcd_release(struct kref *kref)
2522 : : {
2523 : 0 : struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2524 : :
2525 : 0 : mutex_lock(&usb_port_peer_mutex);
2526 [ # # ]: 0 : if (hcd->shared_hcd) {
2527 : 0 : struct usb_hcd *peer = hcd->shared_hcd;
2528 : :
2529 : 0 : peer->shared_hcd = NULL;
2530 : 0 : peer->primary_hcd = NULL;
2531 : : } else {
2532 : 0 : kfree(hcd->address0_mutex);
2533 : 0 : kfree(hcd->bandwidth_mutex);
2534 : : }
2535 : 0 : mutex_unlock(&usb_port_peer_mutex);
2536 : 0 : kfree(hcd);
2537 : 0 : }
2538 : :
2539 : 0 : struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2540 : : {
2541 [ # # ]: 0 : if (hcd)
2542 : 0 : kref_get (&hcd->kref);
2543 : 0 : return hcd;
2544 : : }
2545 : : EXPORT_SYMBOL_GPL(usb_get_hcd);
2546 : :
2547 : 0 : void usb_put_hcd (struct usb_hcd *hcd)
2548 : : {
2549 [ # # ]: 0 : if (hcd)
2550 : 0 : kref_put (&hcd->kref, hcd_release);
2551 : 0 : }
2552 : : EXPORT_SYMBOL_GPL(usb_put_hcd);
2553 : :
2554 : 0 : int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2555 : : {
2556 [ # # # # : 0 : if (!hcd->primary_hcd)
# # # # ]
2557 : : return 1;
2558 [ # # # # ]: 0 : return hcd == hcd->primary_hcd;
2559 : : }
2560 : : EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2561 : :
2562 : 0 : int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
2563 : : {
2564 [ # # ]: 0 : if (!hcd->driver->find_raw_port_number)
2565 : : return port1;
2566 : :
2567 : 0 : return hcd->driver->find_raw_port_number(hcd, port1);
2568 : : }
2569 : :
2570 : 0 : static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2571 : : unsigned int irqnum, unsigned long irqflags)
2572 : : {
2573 : 0 : int retval;
2574 : :
2575 [ # # ]: 0 : if (hcd->driver->irq) {
2576 : :
2577 : 0 : snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2578 : : hcd->driver->description, hcd->self.busnum);
2579 : 0 : retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2580 : : hcd->irq_descr, hcd);
2581 [ # # ]: 0 : if (retval != 0) {
2582 : 0 : dev_err(hcd->self.controller,
2583 : : "request interrupt %d failed\n",
2584 : : irqnum);
2585 : 0 : return retval;
2586 : : }
2587 : 0 : hcd->irq = irqnum;
2588 [ # # ]: 0 : dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2589 : : (hcd->driver->flags & HCD_MEMORY) ?
2590 : : "io mem" : "io base",
2591 : : (unsigned long long)hcd->rsrc_start);
2592 : : } else {
2593 : 0 : hcd->irq = 0;
2594 [ # # ]: 0 : if (hcd->rsrc_start)
2595 [ # # ]: 0 : dev_info(hcd->self.controller, "%s 0x%08llx\n",
2596 : : (hcd->driver->flags & HCD_MEMORY) ?
2597 : : "io mem" : "io base",
2598 : : (unsigned long long)hcd->rsrc_start);
2599 : : }
2600 : : return 0;
2601 : : }
2602 : :
2603 : : /*
2604 : : * Before we free this root hub, flush in-flight peering attempts
2605 : : * and disable peer lookups
2606 : : */
2607 : : static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
2608 : : {
2609 : : struct usb_device *rhdev;
2610 : :
2611 : : mutex_lock(&usb_port_peer_mutex);
2612 : : rhdev = hcd->self.root_hub;
2613 : : hcd->self.root_hub = NULL;
2614 : : mutex_unlock(&usb_port_peer_mutex);
2615 : : usb_put_dev(rhdev);
2616 : : }
2617 : :
2618 : : /**
2619 : : * usb_add_hcd - finish generic HCD structure initialization and register
2620 : : * @hcd: the usb_hcd structure to initialize
2621 : : * @irqnum: Interrupt line to allocate
2622 : : * @irqflags: Interrupt type flags
2623 : : *
2624 : : * Finish the remaining parts of generic HCD initialization: allocate the
2625 : : * buffers of consistent memory, register the bus, request the IRQ line,
2626 : : * and call the driver's reset() and start() routines.
2627 : : */
2628 : 0 : int usb_add_hcd(struct usb_hcd *hcd,
2629 : : unsigned int irqnum, unsigned long irqflags)
2630 : : {
2631 : 0 : int retval;
2632 : 0 : struct usb_device *rhdev;
2633 : :
2634 [ # # # # ]: 0 : if (!hcd->skip_phy_initialization && usb_hcd_is_primary_hcd(hcd)) {
2635 : 0 : hcd->phy_roothub = usb_phy_roothub_alloc(hcd->self.sysdev);
2636 [ # # ]: 0 : if (IS_ERR(hcd->phy_roothub))
2637 : 0 : return PTR_ERR(hcd->phy_roothub);
2638 : :
2639 : 0 : retval = usb_phy_roothub_init(hcd->phy_roothub);
2640 [ # # ]: 0 : if (retval)
2641 : : return retval;
2642 : :
2643 : 0 : retval = usb_phy_roothub_set_mode(hcd->phy_roothub,
2644 : : PHY_MODE_USB_HOST_SS);
2645 [ # # ]: 0 : if (retval)
2646 : 0 : retval = usb_phy_roothub_set_mode(hcd->phy_roothub,
2647 : : PHY_MODE_USB_HOST);
2648 [ # # ]: 0 : if (retval)
2649 : 0 : goto err_usb_phy_roothub_power_on;
2650 : :
2651 : 0 : retval = usb_phy_roothub_power_on(hcd->phy_roothub);
2652 [ # # ]: 0 : if (retval)
2653 : 0 : goto err_usb_phy_roothub_power_on;
2654 : : }
2655 : :
2656 : 0 : dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2657 : :
2658 [ # # # # ]: 0 : switch (authorized_default) {
2659 : 0 : case USB_AUTHORIZE_NONE:
2660 : 0 : hcd->dev_policy = USB_DEVICE_AUTHORIZE_NONE;
2661 : 0 : break;
2662 : :
2663 : 0 : case USB_AUTHORIZE_ALL:
2664 : 0 : hcd->dev_policy = USB_DEVICE_AUTHORIZE_ALL;
2665 : 0 : break;
2666 : :
2667 : 0 : case USB_AUTHORIZE_INTERNAL:
2668 : 0 : hcd->dev_policy = USB_DEVICE_AUTHORIZE_INTERNAL;
2669 : 0 : break;
2670 : :
2671 : 0 : case USB_AUTHORIZE_WIRED:
2672 : : default:
2673 : 0 : hcd->dev_policy = hcd->wireless ?
2674 : 0 : USB_DEVICE_AUTHORIZE_NONE : USB_DEVICE_AUTHORIZE_ALL;
2675 : 0 : break;
2676 : : }
2677 : :
2678 : 0 : set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2679 : :
2680 : : /* per default all interfaces are authorized */
2681 : 0 : set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
2682 : :
2683 : : /* HC is in reset state, but accessible. Now do the one-time init,
2684 : : * bottom up so that hcds can customize the root hubs before hub_wq
2685 : : * starts talking to them. (Note, bus id is assigned early too.)
2686 : : */
2687 : 0 : retval = hcd_buffer_create(hcd);
2688 [ # # ]: 0 : if (retval != 0) {
2689 : 0 : dev_dbg(hcd->self.sysdev, "pool alloc failed\n");
2690 : 0 : goto err_create_buf;
2691 : : }
2692 : :
2693 : 0 : retval = usb_register_bus(&hcd->self);
2694 [ # # ]: 0 : if (retval < 0)
2695 : 0 : goto err_register_bus;
2696 : :
2697 : 0 : rhdev = usb_alloc_dev(NULL, &hcd->self, 0);
2698 [ # # ]: 0 : if (rhdev == NULL) {
2699 : 0 : dev_err(hcd->self.sysdev, "unable to allocate root hub\n");
2700 : 0 : retval = -ENOMEM;
2701 : 0 : goto err_allocate_root_hub;
2702 : : }
2703 : 0 : mutex_lock(&usb_port_peer_mutex);
2704 : 0 : hcd->self.root_hub = rhdev;
2705 : 0 : mutex_unlock(&usb_port_peer_mutex);
2706 : :
2707 : 0 : rhdev->rx_lanes = 1;
2708 : 0 : rhdev->tx_lanes = 1;
2709 : :
2710 [ # # # # : 0 : switch (hcd->speed) {
# # # ]
2711 : 0 : case HCD_USB11:
2712 : 0 : rhdev->speed = USB_SPEED_FULL;
2713 : 0 : break;
2714 : 0 : case HCD_USB2:
2715 : 0 : rhdev->speed = USB_SPEED_HIGH;
2716 : 0 : break;
2717 : 0 : case HCD_USB25:
2718 : 0 : rhdev->speed = USB_SPEED_WIRELESS;
2719 : 0 : break;
2720 : 0 : case HCD_USB3:
2721 : 0 : rhdev->speed = USB_SPEED_SUPER;
2722 : 0 : break;
2723 : 0 : case HCD_USB32:
2724 : 0 : rhdev->rx_lanes = 2;
2725 : 0 : rhdev->tx_lanes = 2;
2726 : : /* fall through */
2727 : 0 : case HCD_USB31:
2728 : 0 : rhdev->speed = USB_SPEED_SUPER_PLUS;
2729 : 0 : break;
2730 : 0 : default:
2731 : 0 : retval = -EINVAL;
2732 : 0 : goto err_set_rh_speed;
2733 : : }
2734 : :
2735 : : /* wakeup flag init defaults to "everything works" for root hubs,
2736 : : * but drivers can override it in reset() if needed, along with
2737 : : * recording the overall controller's system wakeup capability.
2738 : : */
2739 : 0 : device_set_wakeup_capable(&rhdev->dev, 1);
2740 : :
2741 : : /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2742 : : * registered. But since the controller can die at any time,
2743 : : * let's initialize the flag before touching the hardware.
2744 : : */
2745 : 0 : set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2746 : :
2747 : : /* "reset" is misnamed; its role is now one-time init. the controller
2748 : : * should already have been reset (and boot firmware kicked off etc).
2749 : : */
2750 [ # # ]: 0 : if (hcd->driver->reset) {
2751 : 0 : retval = hcd->driver->reset(hcd);
2752 [ # # ]: 0 : if (retval < 0) {
2753 : 0 : dev_err(hcd->self.controller, "can't setup: %d\n",
2754 : : retval);
2755 : 0 : goto err_hcd_driver_setup;
2756 : : }
2757 : : }
2758 : 0 : hcd->rh_pollable = 1;
2759 : :
2760 : 0 : retval = usb_phy_roothub_calibrate(hcd->phy_roothub);
2761 [ # # ]: 0 : if (retval)
2762 : 0 : goto err_hcd_driver_setup;
2763 : :
2764 : : /* NOTE: root hub and controller capabilities may not be the same */
2765 : 0 : if (device_can_wakeup(hcd->self.controller)
2766 : : && device_can_wakeup(&hcd->self.root_hub->dev))
2767 : : dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
2768 : :
2769 : : /* initialize tasklets */
2770 : 0 : init_giveback_urb_bh(&hcd->high_prio_bh);
2771 : 0 : init_giveback_urb_bh(&hcd->low_prio_bh);
2772 : :
2773 : : /* enable irqs just before we start the controller,
2774 : : * if the BIOS provides legacy PCI irqs.
2775 : : */
2776 [ # # # # : 0 : if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
# # ]
2777 : 0 : retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2778 [ # # ]: 0 : if (retval)
2779 : 0 : goto err_request_irq;
2780 : : }
2781 : :
2782 : 0 : hcd->state = HC_STATE_RUNNING;
2783 : 0 : retval = hcd->driver->start(hcd);
2784 [ # # ]: 0 : if (retval < 0) {
2785 : 0 : dev_err(hcd->self.controller, "startup error %d\n", retval);
2786 : 0 : goto err_hcd_driver_start;
2787 : : }
2788 : :
2789 : : /* starting here, usbcore will pay attention to this root hub */
2790 : 0 : retval = register_root_hub(hcd);
2791 [ # # ]: 0 : if (retval != 0)
2792 : 0 : goto err_register_root_hub;
2793 : :
2794 [ # # # # ]: 0 : if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2795 : 0 : usb_hcd_poll_rh_status(hcd);
2796 : :
2797 : : return retval;
2798 : :
2799 : : err_register_root_hub:
2800 : 0 : hcd->rh_pollable = 0;
2801 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2802 : 0 : del_timer_sync(&hcd->rh_timer);
2803 : 0 : hcd->driver->stop(hcd);
2804 : 0 : hcd->state = HC_STATE_HALT;
2805 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2806 : 0 : del_timer_sync(&hcd->rh_timer);
2807 : 0 : err_hcd_driver_start:
2808 [ # # # # : 0 : if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
# # ]
2809 : 0 : free_irq(irqnum, hcd);
2810 : 0 : err_request_irq:
2811 : 0 : err_hcd_driver_setup:
2812 : 0 : err_set_rh_speed:
2813 : 0 : usb_put_invalidate_rhdev(hcd);
2814 : 0 : err_allocate_root_hub:
2815 : 0 : usb_deregister_bus(&hcd->self);
2816 : 0 : err_register_bus:
2817 : 0 : hcd_buffer_destroy(hcd);
2818 : 0 : err_create_buf:
2819 : 0 : usb_phy_roothub_power_off(hcd->phy_roothub);
2820 : 0 : err_usb_phy_roothub_power_on:
2821 : 0 : usb_phy_roothub_exit(hcd->phy_roothub);
2822 : :
2823 : 0 : return retval;
2824 : : }
2825 : : EXPORT_SYMBOL_GPL(usb_add_hcd);
2826 : :
2827 : : /**
2828 : : * usb_remove_hcd - shutdown processing for generic HCDs
2829 : : * @hcd: the usb_hcd structure to remove
2830 : : * Context: !in_interrupt()
2831 : : *
2832 : : * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2833 : : * invoking the HCD's stop() method.
2834 : : */
2835 : 0 : void usb_remove_hcd(struct usb_hcd *hcd)
2836 : : {
2837 : 0 : struct usb_device *rhdev = hcd->self.root_hub;
2838 : :
2839 : 0 : dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2840 : :
2841 : 0 : usb_get_dev(rhdev);
2842 : 0 : clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2843 [ # # ]: 0 : if (HC_IS_RUNNING (hcd->state))
2844 : 0 : hcd->state = HC_STATE_QUIESCING;
2845 : :
2846 : 0 : dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2847 : 0 : spin_lock_irq (&hcd_root_hub_lock);
2848 : 0 : hcd->rh_registered = 0;
2849 : 0 : spin_unlock_irq (&hcd_root_hub_lock);
2850 : :
2851 : : #ifdef CONFIG_PM
2852 : 0 : cancel_work_sync(&hcd->wakeup_work);
2853 : : #endif
2854 : 0 : cancel_work_sync(&hcd->died_work);
2855 : :
2856 : 0 : mutex_lock(&usb_bus_idr_lock);
2857 : 0 : usb_disconnect(&rhdev); /* Sets rhdev to NULL */
2858 : 0 : mutex_unlock(&usb_bus_idr_lock);
2859 : :
2860 : : /*
2861 : : * tasklet_kill() isn't needed here because:
2862 : : * - driver's disconnect() called from usb_disconnect() should
2863 : : * make sure its URBs are completed during the disconnect()
2864 : : * callback
2865 : : *
2866 : : * - it is too late to run complete() here since driver may have
2867 : : * been removed already now
2868 : : */
2869 : :
2870 : : /* Prevent any more root-hub status calls from the timer.
2871 : : * The HCD might still restart the timer (if a port status change
2872 : : * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2873 : : * the hub_status_data() callback.
2874 : : */
2875 : 0 : hcd->rh_pollable = 0;
2876 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2877 : 0 : del_timer_sync(&hcd->rh_timer);
2878 : :
2879 : 0 : hcd->driver->stop(hcd);
2880 : 0 : hcd->state = HC_STATE_HALT;
2881 : :
2882 : : /* In case the HCD restarted the timer, stop it again. */
2883 : 0 : clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2884 : 0 : del_timer_sync(&hcd->rh_timer);
2885 : :
2886 [ # # # # ]: 0 : if (usb_hcd_is_primary_hcd(hcd)) {
2887 [ # # ]: 0 : if (hcd->irq > 0)
2888 : 0 : free_irq(hcd->irq, hcd);
2889 : : }
2890 : :
2891 : 0 : usb_deregister_bus(&hcd->self);
2892 : 0 : hcd_buffer_destroy(hcd);
2893 : :
2894 : 0 : usb_phy_roothub_power_off(hcd->phy_roothub);
2895 : 0 : usb_phy_roothub_exit(hcd->phy_roothub);
2896 : :
2897 : 0 : usb_put_invalidate_rhdev(hcd);
2898 : 0 : hcd->flags = 0;
2899 : 0 : }
2900 : : EXPORT_SYMBOL_GPL(usb_remove_hcd);
2901 : :
2902 : : void
2903 : 0 : usb_hcd_platform_shutdown(struct platform_device *dev)
2904 : : {
2905 : 0 : struct usb_hcd *hcd = platform_get_drvdata(dev);
2906 : :
2907 : : /* No need for pm_runtime_put(), we're shutting down */
2908 : 0 : pm_runtime_get_sync(&dev->dev);
2909 : :
2910 [ # # ]: 0 : if (hcd->driver->shutdown)
2911 : 0 : hcd->driver->shutdown(hcd);
2912 : 0 : }
2913 : : EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
2914 : :
2915 : 0 : int usb_hcd_setup_local_mem(struct usb_hcd *hcd, phys_addr_t phys_addr,
2916 : : dma_addr_t dma, size_t size)
2917 : : {
2918 : 0 : int err;
2919 : 0 : void *local_mem;
2920 : :
2921 : 0 : hcd->localmem_pool = devm_gen_pool_create(hcd->self.sysdev, 4,
2922 : : dev_to_node(hcd->self.sysdev),
2923 [ # # ]: 0 : dev_name(hcd->self.sysdev));
2924 [ # # ]: 0 : if (IS_ERR(hcd->localmem_pool))
2925 : 0 : return PTR_ERR(hcd->localmem_pool);
2926 : :
2927 : 0 : local_mem = devm_memremap(hcd->self.sysdev, phys_addr,
2928 : : size, MEMREMAP_WC);
2929 [ # # ]: 0 : if (IS_ERR(local_mem))
2930 : 0 : return PTR_ERR(local_mem);
2931 : :
2932 : : /*
2933 : : * Here we pass a dma_addr_t but the arg type is a phys_addr_t.
2934 : : * It's not backed by system memory and thus there's no kernel mapping
2935 : : * for it.
2936 : : */
2937 : 0 : err = gen_pool_add_virt(hcd->localmem_pool, (unsigned long)local_mem,
2938 : : dma, size, dev_to_node(hcd->self.sysdev));
2939 [ # # ]: 0 : if (err < 0) {
2940 : 0 : dev_err(hcd->self.sysdev, "gen_pool_add_virt failed with %d\n",
2941 : : err);
2942 : 0 : return err;
2943 : : }
2944 : :
2945 : : return 0;
2946 : : }
2947 : : EXPORT_SYMBOL_GPL(usb_hcd_setup_local_mem);
2948 : :
2949 : : /*-------------------------------------------------------------------------*/
2950 : :
2951 : : #if IS_ENABLED(CONFIG_USB_MON)
2952 : :
2953 : : const struct usb_mon_operations *mon_ops;
2954 : :
2955 : : /*
2956 : : * The registration is unlocked.
2957 : : * We do it this way because we do not want to lock in hot paths.
2958 : : *
2959 : : * Notice that the code is minimally error-proof. Because usbmon needs
2960 : : * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
2961 : : */
2962 : :
2963 : 3 : int usb_mon_register(const struct usb_mon_operations *ops)
2964 : : {
2965 : :
2966 [ + - ]: 3 : if (mon_ops)
2967 : : return -EBUSY;
2968 : :
2969 : 3 : mon_ops = ops;
2970 : 3 : mb();
2971 : 3 : return 0;
2972 : : }
2973 : : EXPORT_SYMBOL_GPL (usb_mon_register);
2974 : :
2975 : 0 : void usb_mon_deregister (void)
2976 : : {
2977 : :
2978 [ # # ]: 0 : if (mon_ops == NULL) {
2979 : 0 : printk(KERN_ERR "USB: monitor was not registered\n");
2980 : 0 : return;
2981 : : }
2982 : 0 : mon_ops = NULL;
2983 : 0 : mb();
2984 : : }
2985 : : EXPORT_SYMBOL_GPL (usb_mon_deregister);
2986 : :
2987 : : #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
|
