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