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