USB: add direction bit to urb->transfer_flags
[GitHub/mt8127/android_kernel_alcatel_ttab.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
1da177e4
LT
25#include <linux/module.h>
26#include <linux/version.h>
27#include <linux/kernel.h>
28#include <linux/slab.h>
29#include <linux/completion.h>
30#include <linux/utsname.h>
31#include <linux/mm.h>
32#include <asm/io.h>
33#include <asm/scatterlist.h>
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>
64a21d02 39#include <linux/platform_device.h>
6b157c9b 40#include <linux/workqueue.h>
1da177e4
LT
41
42#include <linux/usb.h>
43
44#include "usb.h"
45#include "hcd.h"
46#include "hub.h"
47
48
1da177e4
LT
49/*-------------------------------------------------------------------------*/
50
51/*
52 * USB Host Controller Driver framework
53 *
54 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
55 * HCD-specific behaviors/bugs.
56 *
57 * This does error checks, tracks devices and urbs, and delegates to a
58 * "hc_driver" only for code (and data) that really needs to know about
59 * hardware differences. That includes root hub registers, i/o queues,
60 * and so on ... but as little else as possible.
61 *
62 * Shared code includes most of the "root hub" code (these are emulated,
63 * though each HC's hardware works differently) and PCI glue, plus request
64 * tracking overhead. The HCD code should only block on spinlocks or on
65 * hardware handshaking; blocking on software events (such as other kernel
66 * threads releasing resources, or completing actions) is all generic.
67 *
68 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
69 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
70 * only by the hub driver ... and that neither should be seen or used by
71 * usb client device drivers.
72 *
73 * Contributors of ideas or unattributed patches include: David Brownell,
74 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
75 *
76 * HISTORY:
77 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
78 * associated cleanup. "usb_hcd" still != "usb_bus".
79 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
80 */
81
82/*-------------------------------------------------------------------------*/
83
84/* host controllers we manage */
85LIST_HEAD (usb_bus_list);
86EXPORT_SYMBOL_GPL (usb_bus_list);
87
88/* used when allocating bus numbers */
89#define USB_MAXBUS 64
90struct usb_busmap {
91 unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
92};
93static struct usb_busmap busmap;
94
95/* used when updating list of hcds */
4186ecf8 96DEFINE_MUTEX(usb_bus_list_lock); /* exported only for usbfs */
1da177e4
LT
97EXPORT_SYMBOL_GPL (usb_bus_list_lock);
98
99/* used for controlling access to virtual root hubs */
100static DEFINE_SPINLOCK(hcd_root_hub_lock);
101
809a58b8
AS
102/* used when updating an endpoint's URB list */
103static DEFINE_SPINLOCK(hcd_urb_list_lock);
1da177e4
LT
104
105/* wait queue for synchronous unlinks */
106DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
107
809a58b8
AS
108static inline int is_root_hub(struct usb_device *udev)
109{
110 return (udev->parent == NULL);
111}
112
1da177e4
LT
113/*-------------------------------------------------------------------------*/
114
115/*
116 * Sharable chunks of root hub code.
117 */
118
119/*-------------------------------------------------------------------------*/
120
121#define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
122#define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
123
124/* usb 2.0 root hub device descriptor */
125static const u8 usb2_rh_dev_descriptor [18] = {
126 0x12, /* __u8 bLength; */
127 0x01, /* __u8 bDescriptorType; Device */
128 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
129
130 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
131 0x00, /* __u8 bDeviceSubClass; */
132 0x01, /* __u8 bDeviceProtocol; [ usb 2.0 single TT ]*/
16f16d11 133 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
1da177e4
LT
134
135 0x00, 0x00, /* __le16 idVendor; */
136 0x00, 0x00, /* __le16 idProduct; */
137 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
138
139 0x03, /* __u8 iManufacturer; */
140 0x02, /* __u8 iProduct; */
141 0x01, /* __u8 iSerialNumber; */
142 0x01 /* __u8 bNumConfigurations; */
143};
144
145/* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
146
147/* usb 1.1 root hub device descriptor */
148static const u8 usb11_rh_dev_descriptor [18] = {
149 0x12, /* __u8 bLength; */
150 0x01, /* __u8 bDescriptorType; Device */
151 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
152
153 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
154 0x00, /* __u8 bDeviceSubClass; */
155 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
16f16d11 156 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
1da177e4
LT
157
158 0x00, 0x00, /* __le16 idVendor; */
159 0x00, 0x00, /* __le16 idProduct; */
160 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
161
162 0x03, /* __u8 iManufacturer; */
163 0x02, /* __u8 iProduct; */
164 0x01, /* __u8 iSerialNumber; */
165 0x01 /* __u8 bNumConfigurations; */
166};
167
168
169/*-------------------------------------------------------------------------*/
170
171/* Configuration descriptors for our root hubs */
172
173static const u8 fs_rh_config_descriptor [] = {
174
175 /* one configuration */
176 0x09, /* __u8 bLength; */
177 0x02, /* __u8 bDescriptorType; Configuration */
178 0x19, 0x00, /* __le16 wTotalLength; */
179 0x01, /* __u8 bNumInterfaces; (1) */
180 0x01, /* __u8 bConfigurationValue; */
181 0x00, /* __u8 iConfiguration; */
182 0xc0, /* __u8 bmAttributes;
183 Bit 7: must be set,
184 6: Self-powered,
185 5: Remote wakeup,
186 4..0: resvd */
187 0x00, /* __u8 MaxPower; */
188
189 /* USB 1.1:
190 * USB 2.0, single TT organization (mandatory):
191 * one interface, protocol 0
192 *
193 * USB 2.0, multiple TT organization (optional):
194 * two interfaces, protocols 1 (like single TT)
195 * and 2 (multiple TT mode) ... config is
196 * sometimes settable
197 * NOT IMPLEMENTED
198 */
199
200 /* one interface */
201 0x09, /* __u8 if_bLength; */
202 0x04, /* __u8 if_bDescriptorType; Interface */
203 0x00, /* __u8 if_bInterfaceNumber; */
204 0x00, /* __u8 if_bAlternateSetting; */
205 0x01, /* __u8 if_bNumEndpoints; */
206 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
207 0x00, /* __u8 if_bInterfaceSubClass; */
208 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
209 0x00, /* __u8 if_iInterface; */
210
211 /* one endpoint (status change endpoint) */
212 0x07, /* __u8 ep_bLength; */
213 0x05, /* __u8 ep_bDescriptorType; Endpoint */
214 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
215 0x03, /* __u8 ep_bmAttributes; Interrupt */
216 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
217 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
218};
219
220static const u8 hs_rh_config_descriptor [] = {
221
222 /* one configuration */
223 0x09, /* __u8 bLength; */
224 0x02, /* __u8 bDescriptorType; Configuration */
225 0x19, 0x00, /* __le16 wTotalLength; */
226 0x01, /* __u8 bNumInterfaces; (1) */
227 0x01, /* __u8 bConfigurationValue; */
228 0x00, /* __u8 iConfiguration; */
229 0xc0, /* __u8 bmAttributes;
230 Bit 7: must be set,
231 6: Self-powered,
232 5: Remote wakeup,
233 4..0: resvd */
234 0x00, /* __u8 MaxPower; */
235
236 /* USB 1.1:
237 * USB 2.0, single TT organization (mandatory):
238 * one interface, protocol 0
239 *
240 * USB 2.0, multiple TT organization (optional):
241 * two interfaces, protocols 1 (like single TT)
242 * and 2 (multiple TT mode) ... config is
243 * sometimes settable
244 * NOT IMPLEMENTED
245 */
246
247 /* one interface */
248 0x09, /* __u8 if_bLength; */
249 0x04, /* __u8 if_bDescriptorType; Interface */
250 0x00, /* __u8 if_bInterfaceNumber; */
251 0x00, /* __u8 if_bAlternateSetting; */
252 0x01, /* __u8 if_bNumEndpoints; */
253 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
254 0x00, /* __u8 if_bInterfaceSubClass; */
255 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
256 0x00, /* __u8 if_iInterface; */
257
258 /* one endpoint (status change endpoint) */
259 0x07, /* __u8 ep_bLength; */
260 0x05, /* __u8 ep_bDescriptorType; Endpoint */
261 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
262 0x03, /* __u8 ep_bmAttributes; Interrupt */
88fafff9 263 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
264 * see hub.c:hub_configure() for details. */
265 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
1da177e4
LT
266 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
267};
268
269/*-------------------------------------------------------------------------*/
270
271/*
272 * helper routine for returning string descriptors in UTF-16LE
273 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
274 */
275static int ascii2utf (char *s, u8 *utf, int utfmax)
276{
277 int retval;
278
279 for (retval = 0; *s && utfmax > 1; utfmax -= 2, retval += 2) {
280 *utf++ = *s++;
281 *utf++ = 0;
282 }
283 if (utfmax > 0) {
284 *utf = *s;
285 ++retval;
286 }
287 return retval;
288}
289
290/*
291 * rh_string - provides manufacturer, product and serial strings for root hub
292 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
293 * @hcd: the host controller for this root hub
294 * @type: string describing our driver
295 * @data: return packet in UTF-16 LE
296 * @len: length of the return packet
297 *
298 * Produces either a manufacturer, product or serial number string for the
299 * virtual root hub device.
300 */
301static int rh_string (
302 int id,
303 struct usb_hcd *hcd,
304 u8 *data,
305 int len
306) {
307 char buf [100];
308
309 // language ids
310 if (id == 0) {
311 buf[0] = 4; buf[1] = 3; /* 4 bytes string data */
312 buf[2] = 0x09; buf[3] = 0x04; /* MSFT-speak for "en-us" */
313 len = min (len, 4);
314 memcpy (data, buf, len);
315 return len;
316
317 // serial number
318 } else if (id == 1) {
319 strlcpy (buf, hcd->self.bus_name, sizeof buf);
320
321 // product description
322 } else if (id == 2) {
323 strlcpy (buf, hcd->product_desc, sizeof buf);
324
325 // id 3 == vendor description
326 } else if (id == 3) {
96b644bd
SH
327 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
328 init_utsname()->release, hcd->driver->description);
1da177e4
LT
329
330 // unsupported IDs --> "protocol stall"
331 } else
332 return -EPIPE;
333
334 switch (len) { /* All cases fall through */
335 default:
336 len = 2 + ascii2utf (buf, data + 2, len - 2);
337 case 2:
338 data [1] = 3; /* type == string */
339 case 1:
340 data [0] = 2 * (strlen (buf) + 1);
341 case 0:
342 ; /* Compiler wants a statement here */
343 }
344 return len;
345}
346
347
348/* Root hub control transfers execute synchronously */
349static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
350{
351 struct usb_ctrlrequest *cmd;
352 u16 typeReq, wValue, wIndex, wLength;
353 u8 *ubuf = urb->transfer_buffer;
54bee6e1
MP
354 u8 tbuf [sizeof (struct usb_hub_descriptor)]
355 __attribute__((aligned(4)));
1da177e4
LT
356 const u8 *bufp = tbuf;
357 int len = 0;
358 int patch_wakeup = 0;
359 unsigned long flags;
360 int status = 0;
361 int n;
362
363 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
364 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
365 wValue = le16_to_cpu (cmd->wValue);
366 wIndex = le16_to_cpu (cmd->wIndex);
367 wLength = le16_to_cpu (cmd->wLength);
368
369 if (wLength > urb->transfer_buffer_length)
370 goto error;
371
372 urb->actual_length = 0;
373 switch (typeReq) {
374
375 /* DEVICE REQUESTS */
376
fb669cc0
DB
377 /* The root hub's remote wakeup enable bit is implemented using
378 * driver model wakeup flags. If this system supports wakeup
379 * through USB, userspace may change the default "allow wakeup"
380 * policy through sysfs or these calls.
381 *
382 * Most root hubs support wakeup from downstream devices, for
383 * runtime power management (disabling USB clocks and reducing
384 * VBUS power usage). However, not all of them do so; silicon,
385 * board, and BIOS bugs here are not uncommon, so these can't
386 * be treated quite like external hubs.
387 *
388 * Likewise, not all root hubs will pass wakeup events upstream,
389 * to wake up the whole system. So don't assume root hub and
390 * controller capabilities are identical.
391 */
392
1da177e4 393 case DeviceRequest | USB_REQ_GET_STATUS:
fb669cc0
DB
394 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
395 << USB_DEVICE_REMOTE_WAKEUP)
1da177e4
LT
396 | (1 << USB_DEVICE_SELF_POWERED);
397 tbuf [1] = 0;
398 len = 2;
399 break;
400 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
401 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
fb669cc0 402 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
1da177e4
LT
403 else
404 goto error;
405 break;
406 case DeviceOutRequest | USB_REQ_SET_FEATURE:
fb669cc0
DB
407 if (device_can_wakeup(&hcd->self.root_hub->dev)
408 && wValue == USB_DEVICE_REMOTE_WAKEUP)
409 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
1da177e4
LT
410 else
411 goto error;
412 break;
413 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
414 tbuf [0] = 1;
415 len = 1;
416 /* FALLTHROUGH */
417 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
418 break;
419 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
420 switch (wValue & 0xff00) {
421 case USB_DT_DEVICE << 8:
422 if (hcd->driver->flags & HCD_USB2)
423 bufp = usb2_rh_dev_descriptor;
424 else if (hcd->driver->flags & HCD_USB11)
425 bufp = usb11_rh_dev_descriptor;
426 else
427 goto error;
428 len = 18;
429 break;
430 case USB_DT_CONFIG << 8:
431 if (hcd->driver->flags & HCD_USB2) {
432 bufp = hs_rh_config_descriptor;
433 len = sizeof hs_rh_config_descriptor;
434 } else {
435 bufp = fs_rh_config_descriptor;
436 len = sizeof fs_rh_config_descriptor;
437 }
fb669cc0 438 if (device_can_wakeup(&hcd->self.root_hub->dev))
1da177e4
LT
439 patch_wakeup = 1;
440 break;
441 case USB_DT_STRING << 8:
442 n = rh_string (wValue & 0xff, hcd, ubuf, wLength);
443 if (n < 0)
444 goto error;
445 urb->actual_length = n;
446 break;
447 default:
448 goto error;
449 }
450 break;
451 case DeviceRequest | USB_REQ_GET_INTERFACE:
452 tbuf [0] = 0;
453 len = 1;
454 /* FALLTHROUGH */
455 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
456 break;
457 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
458 // wValue == urb->dev->devaddr
459 dev_dbg (hcd->self.controller, "root hub device address %d\n",
460 wValue);
461 break;
462
463 /* INTERFACE REQUESTS (no defined feature/status flags) */
464
465 /* ENDPOINT REQUESTS */
466
467 case EndpointRequest | USB_REQ_GET_STATUS:
468 // ENDPOINT_HALT flag
469 tbuf [0] = 0;
470 tbuf [1] = 0;
471 len = 2;
472 /* FALLTHROUGH */
473 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
474 case EndpointOutRequest | USB_REQ_SET_FEATURE:
475 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
476 break;
477
478 /* CLASS REQUESTS (and errors) */
479
480 default:
481 /* non-generic request */
b13296c6
DB
482 switch (typeReq) {
483 case GetHubStatus:
484 case GetPortStatus:
485 len = 4;
486 break;
487 case GetHubDescriptor:
488 len = sizeof (struct usb_hub_descriptor);
489 break;
1da177e4 490 }
b13296c6
DB
491 status = hcd->driver->hub_control (hcd,
492 typeReq, wValue, wIndex,
493 tbuf, wLength);
1da177e4
LT
494 break;
495error:
496 /* "protocol stall" on error */
497 status = -EPIPE;
498 }
499
500 if (status) {
501 len = 0;
502 if (status != -EPIPE) {
503 dev_dbg (hcd->self.controller,
504 "CTRL: TypeReq=0x%x val=0x%x "
505 "idx=0x%x len=%d ==> %d\n",
506 typeReq, wValue, wIndex,
b13296c6 507 wLength, status);
1da177e4
LT
508 }
509 }
510 if (len) {
511 if (urb->transfer_buffer_length < len)
512 len = urb->transfer_buffer_length;
513 urb->actual_length = len;
514 // always USB_DIR_IN, toward host
515 memcpy (ubuf, bufp, len);
516
517 /* report whether RH hardware supports remote wakeup */
518 if (patch_wakeup &&
519 len > offsetof (struct usb_config_descriptor,
520 bmAttributes))
521 ((struct usb_config_descriptor *)ubuf)->bmAttributes
522 |= USB_CONFIG_ATT_WAKEUP;
523 }
524
525 /* any errors get returned through the urb completion */
526 local_irq_save (flags);
527 spin_lock (&urb->lock);
528 if (urb->status == -EINPROGRESS)
529 urb->status = status;
530 spin_unlock (&urb->lock);
7d12e780 531 usb_hcd_giveback_urb (hcd, urb);
1da177e4
LT
532 local_irq_restore (flags);
533 return 0;
534}
535
536/*-------------------------------------------------------------------------*/
537
538/*
d5926ae7
AS
539 * Root Hub interrupt transfers are polled using a timer if the
540 * driver requests it; otherwise the driver is responsible for
541 * calling usb_hcd_poll_rh_status() when an event occurs.
1da177e4 542 *
d5926ae7
AS
543 * Completions are called in_interrupt(), but they may or may not
544 * be in_irq().
1da177e4 545 */
d5926ae7
AS
546void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
547{
548 struct urb *urb;
549 int length;
550 unsigned long flags;
551 char buffer[4]; /* Any root hubs with > 31 ports? */
1da177e4 552
1b42ae6d
AS
553 if (unlikely(!hcd->rh_registered))
554 return;
d5926ae7
AS
555 if (!hcd->uses_new_polling && !hcd->status_urb)
556 return;
1da177e4 557
d5926ae7
AS
558 length = hcd->driver->hub_status_data(hcd, buffer);
559 if (length > 0) {
1da177e4 560
d5926ae7
AS
561 /* try to complete the status urb */
562 local_irq_save (flags);
563 spin_lock(&hcd_root_hub_lock);
564 urb = hcd->status_urb;
565 if (urb) {
566 spin_lock(&urb->lock);
567 if (urb->status == -EINPROGRESS) {
568 hcd->poll_pending = 0;
569 hcd->status_urb = NULL;
570 urb->status = 0;
571 urb->hcpriv = NULL;
572 urb->actual_length = length;
573 memcpy(urb->transfer_buffer, buffer, length);
574 } else /* urb has been unlinked */
575 length = 0;
576 spin_unlock(&urb->lock);
577 } else
578 length = 0;
579 spin_unlock(&hcd_root_hub_lock);
580
581 /* local irqs are always blocked in completions */
582 if (length > 0)
7d12e780 583 usb_hcd_giveback_urb (hcd, urb);
d5926ae7
AS
584 else
585 hcd->poll_pending = 1;
586 local_irq_restore (flags);
1da177e4
LT
587 }
588
d5926ae7 589 /* The USB 2.0 spec says 256 ms. This is close enough and won't
01cd0819
AV
590 * exceed that limit if HZ is 100. The math is more clunky than
591 * maybe expected, this is to make sure that all timers for USB devices
592 * fire at the same time to give the CPU a break inbetween */
d5926ae7
AS
593 if (hcd->uses_new_polling ? hcd->poll_rh :
594 (length == 0 && hcd->status_urb != NULL))
01cd0819 595 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
1da177e4 596}
d5926ae7 597EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
1da177e4
LT
598
599/* timer callback */
d5926ae7
AS
600static void rh_timer_func (unsigned long _hcd)
601{
602 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
603}
604
605/*-------------------------------------------------------------------------*/
1da177e4 606
d5926ae7 607static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
1da177e4 608{
d5926ae7 609 int retval;
1da177e4 610 unsigned long flags;
d5926ae7 611 int len = 1 + (urb->dev->maxchild / 8);
1da177e4 612
d5926ae7
AS
613 spin_lock_irqsave (&hcd_root_hub_lock, flags);
614 if (urb->status != -EINPROGRESS) /* already unlinked */
615 retval = urb->status;
616 else if (hcd->status_urb || urb->transfer_buffer_length < len) {
617 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
618 retval = -EINVAL;
619 } else {
620 hcd->status_urb = urb;
621 urb->hcpriv = hcd; /* indicate it's queued */
1da177e4 622
d5926ae7 623 if (!hcd->uses_new_polling)
01cd0819
AV
624 mod_timer (&hcd->rh_timer,
625 (jiffies/(HZ/4) + 1) * (HZ/4));
1da177e4 626
d5926ae7
AS
627 /* If a status change has already occurred, report it ASAP */
628 else if (hcd->poll_pending)
629 mod_timer (&hcd->rh_timer, jiffies);
630 retval = 0;
1da177e4 631 }
d5926ae7
AS
632 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
633 return retval;
1da177e4
LT
634}
635
1da177e4
LT
636static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
637{
d5926ae7
AS
638 if (usb_pipeint (urb->pipe))
639 return rh_queue_status (hcd, urb);
1da177e4
LT
640 if (usb_pipecontrol (urb->pipe))
641 return rh_call_control (hcd, urb);
d5926ae7 642 return -EINVAL;
1da177e4
LT
643}
644
645/*-------------------------------------------------------------------------*/
646
455b25fb
AS
647/* Unlinks of root-hub control URBs are legal, but they don't do anything
648 * since these URBs always execute synchronously.
d5926ae7 649 */
1da177e4
LT
650static int usb_rh_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
651{
455b25fb 652 unsigned long flags;
1da177e4 653
455b25fb
AS
654 if (usb_pipeendpoint(urb->pipe) == 0) { /* Control URB */
655 ; /* Do nothing */
d5926ae7
AS
656
657 } else { /* Status URB */
658 if (!hcd->uses_new_polling)
455b25fb
AS
659 del_timer (&hcd->rh_timer);
660 local_irq_save (flags);
d5926ae7
AS
661 spin_lock (&hcd_root_hub_lock);
662 if (urb == hcd->status_urb) {
663 hcd->status_urb = NULL;
664 urb->hcpriv = NULL;
665 } else
666 urb = NULL; /* wasn't fully queued */
667 spin_unlock (&hcd_root_hub_lock);
668 if (urb)
7d12e780 669 usb_hcd_giveback_urb (hcd, urb);
455b25fb 670 local_irq_restore (flags);
d5926ae7 671 }
1da177e4
LT
672
673 return 0;
674}
675
676/*-------------------------------------------------------------------------*/
677
8561b10f 678static struct class *usb_host_class;
1da177e4
LT
679
680int usb_host_init(void)
681{
8561b10f
GKH
682 int retval = 0;
683
684 usb_host_class = class_create(THIS_MODULE, "usb_host");
685 if (IS_ERR(usb_host_class))
686 retval = PTR_ERR(usb_host_class);
687 return retval;
1da177e4
LT
688}
689
690void usb_host_cleanup(void)
691{
8561b10f 692 class_destroy(usb_host_class);
1da177e4
LT
693}
694
695/**
696 * usb_bus_init - shared initialization code
697 * @bus: the bus structure being initialized
698 *
699 * This code is used to initialize a usb_bus structure, memory for which is
700 * separately managed.
701 */
702static void usb_bus_init (struct usb_bus *bus)
703{
704 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
705
706 bus->devnum_next = 1;
707
708 bus->root_hub = NULL;
1da177e4
LT
709 bus->busnum = -1;
710 bus->bandwidth_allocated = 0;
711 bus->bandwidth_int_reqs = 0;
712 bus->bandwidth_isoc_reqs = 0;
713
714 INIT_LIST_HEAD (&bus->bus_list);
1da177e4
LT
715}
716
1da177e4
LT
717/*-------------------------------------------------------------------------*/
718
719/**
720 * usb_register_bus - registers the USB host controller with the usb core
721 * @bus: pointer to the bus to register
722 * Context: !in_interrupt()
723 *
724 * Assigns a bus number, and links the controller into usbcore data
725 * structures so that it can be seen by scanning the bus list.
726 */
727static int usb_register_bus(struct usb_bus *bus)
728{
729 int busnum;
1da177e4 730
4186ecf8 731 mutex_lock(&usb_bus_list_lock);
1da177e4
LT
732 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
733 if (busnum < USB_MAXBUS) {
734 set_bit (busnum, busmap.busmap);
735 bus->busnum = busnum;
736 } else {
737 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
4186ecf8 738 mutex_unlock(&usb_bus_list_lock);
1da177e4
LT
739 return -E2BIG;
740 }
741
53f46542
GKH
742 bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
743 bus->controller, "usb_host%d", busnum);
8561b10f 744 if (IS_ERR(bus->class_dev)) {
1da177e4 745 clear_bit(busnum, busmap.busmap);
4186ecf8 746 mutex_unlock(&usb_bus_list_lock);
8561b10f 747 return PTR_ERR(bus->class_dev);
1da177e4
LT
748 }
749
8561b10f
GKH
750 class_set_devdata(bus->class_dev, bus);
751
1da177e4
LT
752 /* Add it to the local list of buses */
753 list_add (&bus->bus_list, &usb_bus_list);
4186ecf8 754 mutex_unlock(&usb_bus_list_lock);
1da177e4 755
3099e75a 756 usb_notify_add_bus(bus);
1da177e4
LT
757
758 dev_info (bus->controller, "new USB bus registered, assigned bus number %d\n", bus->busnum);
759 return 0;
760}
761
762/**
763 * usb_deregister_bus - deregisters the USB host controller
764 * @bus: pointer to the bus to deregister
765 * Context: !in_interrupt()
766 *
767 * Recycles the bus number, and unlinks the controller from usbcore data
768 * structures so that it won't be seen by scanning the bus list.
769 */
770static void usb_deregister_bus (struct usb_bus *bus)
771{
772 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
773
774 /*
775 * NOTE: make sure that all the devices are removed by the
776 * controller code, as well as having it call this when cleaning
777 * itself up
778 */
4186ecf8 779 mutex_lock(&usb_bus_list_lock);
1da177e4 780 list_del (&bus->bus_list);
4186ecf8 781 mutex_unlock(&usb_bus_list_lock);
1da177e4 782
3099e75a 783 usb_notify_remove_bus(bus);
1da177e4
LT
784
785 clear_bit (bus->busnum, busmap.busmap);
786
8561b10f 787 class_device_unregister(bus->class_dev);
1da177e4
LT
788}
789
790/**
8ec8d20b 791 * register_root_hub - called by usb_add_hcd() to register a root hub
1da177e4
LT
792 * @hcd: host controller for this root hub
793 *
8ec8d20b 794 * This function registers the root hub with the USB subsystem. It sets up
b1e8f0a6
DB
795 * the device properly in the device tree and then calls usb_new_device()
796 * to register the usb device. It also assigns the root hub's USB address
797 * (always 1).
1da177e4 798 */
b1e8f0a6 799static int register_root_hub(struct usb_hcd *hcd)
1da177e4
LT
800{
801 struct device *parent_dev = hcd->self.controller;
b1e8f0a6 802 struct usb_device *usb_dev = hcd->self.root_hub;
1da177e4
LT
803 const int devnum = 1;
804 int retval;
805
1da177e4
LT
806 usb_dev->devnum = devnum;
807 usb_dev->bus->devnum_next = devnum + 1;
808 memset (&usb_dev->bus->devmap.devicemap, 0,
809 sizeof usb_dev->bus->devmap.devicemap);
810 set_bit (devnum, usb_dev->bus->devmap.devicemap);
811 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
812
4186ecf8 813 mutex_lock(&usb_bus_list_lock);
1da177e4
LT
814
815 usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
816 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
817 if (retval != sizeof usb_dev->descriptor) {
4186ecf8 818 mutex_unlock(&usb_bus_list_lock);
1da177e4
LT
819 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
820 usb_dev->dev.bus_id, retval);
821 return (retval < 0) ? retval : -EMSGSIZE;
822 }
823
1da177e4 824 retval = usb_new_device (usb_dev);
1da177e4 825 if (retval) {
1da177e4
LT
826 dev_err (parent_dev, "can't register root hub for %s, %d\n",
827 usb_dev->dev.bus_id, retval);
828 }
4186ecf8 829 mutex_unlock(&usb_bus_list_lock);
1da177e4
LT
830
831 if (retval == 0) {
832 spin_lock_irq (&hcd_root_hub_lock);
833 hcd->rh_registered = 1;
834 spin_unlock_irq (&hcd_root_hub_lock);
835
836 /* Did the HC die before the root hub was registered? */
837 if (hcd->state == HC_STATE_HALT)
838 usb_hc_died (hcd); /* This time clean up */
839 }
840
841 return retval;
842}
1da177e4 843
d5926ae7
AS
844void usb_enable_root_hub_irq (struct usb_bus *bus)
845{
846 struct usb_hcd *hcd;
847
848 hcd = container_of (bus, struct usb_hcd, self);
d19ac7da 849 if (hcd->driver->hub_irq_enable && hcd->state != HC_STATE_HALT)
d5926ae7
AS
850 hcd->driver->hub_irq_enable (hcd);
851}
852
1da177e4
LT
853
854/*-------------------------------------------------------------------------*/
855
856/**
857 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
858 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
859 * @is_input: true iff the transaction sends data to the host
860 * @isoc: true for isochronous transactions, false for interrupt ones
861 * @bytecount: how many bytes in the transaction.
862 *
863 * Returns approximate bus time in nanoseconds for a periodic transaction.
864 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
865 * scheduled in software, this function is only used for such scheduling.
866 */
867long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
868{
869 unsigned long tmp;
870
871 switch (speed) {
872 case USB_SPEED_LOW: /* INTR only */
873 if (is_input) {
874 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
875 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
876 } else {
877 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
878 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
879 }
880 case USB_SPEED_FULL: /* ISOC or INTR */
881 if (isoc) {
882 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
883 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
884 } else {
885 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
886 return (9107L + BW_HOST_DELAY + tmp);
887 }
888 case USB_SPEED_HIGH: /* ISOC or INTR */
889 // FIXME adjust for input vs output
890 if (isoc)
498f78e6 891 tmp = HS_NSECS_ISO (bytecount);
1da177e4 892 else
498f78e6 893 tmp = HS_NSECS (bytecount);
1da177e4
LT
894 return tmp;
895 default:
896 pr_debug ("%s: bogus device speed!\n", usbcore_name);
897 return -1;
898 }
899}
900EXPORT_SYMBOL (usb_calc_bus_time);
901
1da177e4
LT
902
903/*-------------------------------------------------------------------------*/
904
905/*
906 * Generic HC operations.
907 */
908
909/*-------------------------------------------------------------------------*/
910
9f6a93f7 911static void urb_unlink(struct usb_hcd *hcd, struct urb *urb)
1da177e4
LT
912{
913 unsigned long flags;
914
1da177e4 915 /* clear all state linking urb to this dev (and hcd) */
809a58b8 916 spin_lock_irqsave(&hcd_urb_list_lock, flags);
1da177e4 917 list_del_init (&urb->urb_list);
809a58b8 918 spin_unlock_irqrestore(&hcd_urb_list_lock, flags);
1da177e4 919
809a58b8 920 if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
9f6a93f7
PZ
921 if (usb_pipecontrol (urb->pipe)
922 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
923 dma_unmap_single (hcd->self.controller, urb->setup_dma,
924 sizeof (struct usb_ctrlrequest),
925 DMA_TO_DEVICE);
926 if (urb->transfer_buffer_length != 0
927 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
928 dma_unmap_single (hcd->self.controller,
929 urb->transfer_dma,
930 urb->transfer_buffer_length,
fea34091 931 usb_urb_dir_in(urb)
9f6a93f7
PZ
932 ? DMA_FROM_DEVICE
933 : DMA_TO_DEVICE);
934 }
935}
1da177e4
LT
936
937/* may be called in any context with a valid urb->dev usecount
938 * caller surrenders "ownership" of urb
939 * expects usb_submit_urb() to have sanity checked and conditioned all
940 * inputs in the urb
941 */
a6d2bb9f 942int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1da177e4
LT
943{
944 int status;
17200583 945 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1da177e4
LT
946 unsigned long flags;
947
948 if (!hcd)
949 return -ENODEV;
950
951 usbmon_urb_submit(&hcd->self, urb);
952
953 /*
954 * Atomically queue the urb, first to our records, then to the HCD.
955 * Access to urb->status is controlled by urb->lock ... changes on
956 * i/o completion (normal or fault) or unlinking.
957 */
958
959 // FIXME: verify that quiescing hc works right (RH cleans up)
960
809a58b8 961 spin_lock_irqsave(&hcd_urb_list_lock, flags);
bdd016ba 962 if (unlikely(!urb->ep->enabled))
1da177e4
LT
963 status = -ENOENT;
964 else if (unlikely (urb->reject))
965 status = -EPERM;
966 else switch (hcd->state) {
967 case HC_STATE_RUNNING:
968 case HC_STATE_RESUMING:
5b653c79 969 list_add_tail (&urb->urb_list, &urb->ep->urb_list);
1da177e4
LT
970 status = 0;
971 break;
972 default:
973 status = -ESHUTDOWN;
974 break;
975 }
809a58b8 976 spin_unlock_irqrestore(&hcd_urb_list_lock, flags);
1da177e4
LT
977 if (status) {
978 INIT_LIST_HEAD (&urb->urb_list);
979 usbmon_urb_submit_error(&hcd->self, urb, status);
980 return status;
981 }
982
983 /* increment urb's reference count as part of giving it to the HCD
984 * (which now controls it). HCD guarantees that it either returns
985 * an error or calls giveback(), but not both.
986 */
987 urb = usb_get_urb (urb);
988 atomic_inc (&urb->use_count);
989
809a58b8 990 if (is_root_hub(urb->dev)) {
1da177e4
LT
991 /* NOTE: requirement on hub callers (usbfs and the hub
992 * driver, for now) that URBs' urb->transfer_buffer be
993 * valid and usb_buffer_{sync,unmap}() not be needed, since
994 * they could clobber root hub response data.
995 */
996 status = rh_urb_enqueue (hcd, urb);
997 goto done;
998 }
999
1000 /* lower level hcd code should use *_dma exclusively,
1001 * unless it uses pio or talks to another transport.
1002 */
dd990f16 1003 if (hcd->self.uses_dma) {
1da177e4
LT
1004 if (usb_pipecontrol (urb->pipe)
1005 && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1006 urb->setup_dma = dma_map_single (
1007 hcd->self.controller,
1008 urb->setup_packet,
1009 sizeof (struct usb_ctrlrequest),
1010 DMA_TO_DEVICE);
1011 if (urb->transfer_buffer_length != 0
1012 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1013 urb->transfer_dma = dma_map_single (
1014 hcd->self.controller,
1015 urb->transfer_buffer,
1016 urb->transfer_buffer_length,
fea34091 1017 usb_urb_dir_in(urb)
1da177e4
LT
1018 ? DMA_FROM_DEVICE
1019 : DMA_TO_DEVICE);
1020 }
1021
5b653c79 1022 status = hcd->driver->urb_enqueue (hcd, urb->ep, urb, mem_flags);
1da177e4
LT
1023done:
1024 if (unlikely (status)) {
9f6a93f7 1025 urb_unlink(hcd, urb);
1da177e4
LT
1026 atomic_dec (&urb->use_count);
1027 if (urb->reject)
1028 wake_up (&usb_kill_urb_queue);
1da177e4 1029 usbmon_urb_submit_error(&hcd->self, urb, status);
d984abc9 1030 usb_put_urb (urb);
1da177e4
LT
1031 }
1032 return status;
1033}
1034
1035/*-------------------------------------------------------------------------*/
1036
1da177e4
LT
1037/* this makes the hcd giveback() the urb more quickly, by kicking it
1038 * off hardware queues (which may take a while) and returning it as
1039 * soon as practical. we've already set up the urb's return status,
1040 * but we can't know if the callback completed already.
1041 */
1042static int
1043unlink1 (struct usb_hcd *hcd, struct urb *urb)
1044{
1045 int value;
1046
809a58b8 1047 if (is_root_hub(urb->dev))
1da177e4
LT
1048 value = usb_rh_urb_dequeue (hcd, urb);
1049 else {
1050
1051 /* The only reason an HCD might fail this call is if
1052 * it has not yet fully queued the urb to begin with.
1053 * Such failures should be harmless. */
1054 value = hcd->driver->urb_dequeue (hcd, urb);
1055 }
1056
1057 if (value != 0)
1058 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1059 urb, value);
1060 return value;
1061}
1062
1063/*
1064 * called in any context
1065 *
1066 * caller guarantees urb won't be recycled till both unlink()
1067 * and the urb's completion function return
1068 */
a6d2bb9f 1069int usb_hcd_unlink_urb (struct urb *urb, int status)
1da177e4 1070{
1da177e4
LT
1071 struct usb_hcd *hcd = NULL;
1072 struct device *sys = NULL;
1073 unsigned long flags;
1074 struct list_head *tmp;
1075 int retval;
1076
1077 if (!urb)
1078 return -EINVAL;
1079 if (!urb->dev || !urb->dev->bus)
1080 return -ENODEV;
1da177e4
LT
1081
1082 /*
1083 * we contend for urb->status with the hcd core,
1084 * which changes it while returning the urb.
1085 *
1086 * Caller guaranteed that the urb pointer hasn't been freed, and
1087 * that it was submitted. But as a rule it can't know whether or
1088 * not it's already been unlinked ... so we respect the reversed
1089 * lock sequence needed for the usb_hcd_giveback_urb() code paths
809a58b8 1090 * (urb lock, then hcd_urb_list_lock) in case some other CPU is now
1da177e4
LT
1091 * unlinking it.
1092 */
1093 spin_lock_irqsave (&urb->lock, flags);
809a58b8 1094 spin_lock(&hcd_urb_list_lock);
1da177e4
LT
1095
1096 sys = &urb->dev->dev;
17200583 1097 hcd = bus_to_hcd(urb->dev->bus);
1da177e4
LT
1098 if (hcd == NULL) {
1099 retval = -ENODEV;
1100 goto done;
1101 }
1102
1da177e4 1103 /* insist the urb is still queued */
5b653c79 1104 list_for_each(tmp, &urb->ep->urb_list) {
1da177e4
LT
1105 if (tmp == &urb->urb_list)
1106 break;
1107 }
1108 if (tmp != &urb->urb_list) {
1109 retval = -EIDRM;
1110 goto done;
1111 }
1112
1113 /* Any status except -EINPROGRESS means something already started to
1114 * unlink this URB from the hardware. So there's no more work to do.
1115 */
1116 if (urb->status != -EINPROGRESS) {
1117 retval = -EBUSY;
1118 goto done;
1119 }
1120
1121 /* IRQ setup can easily be broken so that USB controllers
1122 * never get completion IRQs ... maybe even the ones we need to
1123 * finish unlinking the initial failed usb_set_address()
1124 * or device descriptor fetch.
1125 */
809a58b8
AS
1126 if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags) &&
1127 !is_root_hub(urb->dev)) {
1da177e4 1128 dev_warn (hcd->self.controller, "Unlink after no-IRQ? "
809a58b8 1129 "Controller is probably using the wrong IRQ.\n");
8de98402 1130 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1da177e4
LT
1131 }
1132
1133 urb->status = status;
1134
809a58b8 1135 spin_unlock(&hcd_urb_list_lock);
1da177e4
LT
1136 spin_unlock_irqrestore (&urb->lock, flags);
1137
1138 retval = unlink1 (hcd, urb);
1139 if (retval == 0)
1140 retval = -EINPROGRESS;
1141 return retval;
1142
1143done:
809a58b8 1144 spin_unlock(&hcd_urb_list_lock);
1da177e4
LT
1145 spin_unlock_irqrestore (&urb->lock, flags);
1146 if (retval != -EIDRM && sys && sys->driver)
1147 dev_dbg (sys, "hcd_unlink_urb %p fail %d\n", urb, retval);
1148 return retval;
1149}
1150
1151/*-------------------------------------------------------------------------*/
1152
32aca560
AS
1153/**
1154 * usb_hcd_giveback_urb - return URB from HCD to device driver
1155 * @hcd: host controller returning the URB
1156 * @urb: urb being returned to the USB device driver.
1157 * Context: in_interrupt()
1158 *
1159 * This hands the URB from HCD to its USB device driver, using its
1160 * completion function. The HCD has freed all per-urb resources
1161 * (and is done using urb->hcpriv). It also released all HCD locks;
1162 * the device driver won't cause problems if it frees, modifies,
1163 * or resubmits this URB.
1164 */
1165void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb)
1166{
1167 urb_unlink(hcd, urb);
1168 usbmon_urb_complete (&hcd->self, urb);
1169 usb_unanchor_urb(urb);
1170
1171 /* pass ownership to the completion handler */
1172 urb->complete (urb);
1173 atomic_dec (&urb->use_count);
1174 if (unlikely (urb->reject))
1175 wake_up (&usb_kill_urb_queue);
1176 usb_put_urb (urb);
1177}
1178EXPORT_SYMBOL (usb_hcd_giveback_urb);
1179
1180/*-------------------------------------------------------------------------*/
1181
1da177e4 1182/* disables the endpoint: cancels any pending urbs, then synchronizes with
455b25fb
AS
1183 * the hcd to make sure all endpoint state is gone from hardware, and then
1184 * waits until the endpoint's queue is completely drained. use for
1da177e4
LT
1185 * set_configuration, set_interface, driver removal, physical disconnect.
1186 *
1187 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1188 * type, maxpacket size, toggle, halt status, and scheduling.
1189 */
a6d2bb9f
AS
1190void usb_hcd_endpoint_disable (struct usb_device *udev,
1191 struct usb_host_endpoint *ep)
1da177e4
LT
1192{
1193 struct usb_hcd *hcd;
1194 struct urb *urb;
1195
17200583 1196 hcd = bus_to_hcd(udev->bus);
1da177e4
LT
1197 local_irq_disable ();
1198
1da177e4
LT
1199 /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1200rescan:
809a58b8 1201 spin_lock(&hcd_urb_list_lock);
1da177e4
LT
1202 list_for_each_entry (urb, &ep->urb_list, urb_list) {
1203 int tmp;
1204
455b25fb 1205 /* the urb may already have been unlinked */
1da177e4
LT
1206 if (urb->status != -EINPROGRESS)
1207 continue;
1208 usb_get_urb (urb);
809a58b8 1209 spin_unlock(&hcd_urb_list_lock);
1da177e4
LT
1210
1211 spin_lock (&urb->lock);
1212 tmp = urb->status;
1213 if (tmp == -EINPROGRESS)
1214 urb->status = -ESHUTDOWN;
1215 spin_unlock (&urb->lock);
1216
1217 /* kick hcd unless it's already returning this */
1218 if (tmp == -EINPROGRESS) {
1219 tmp = urb->pipe;
1220 unlink1 (hcd, urb);
1221 dev_dbg (hcd->self.controller,
1222 "shutdown urb %p pipe %08x ep%d%s%s\n",
1223 urb, tmp, usb_pipeendpoint (tmp),
1224 (tmp & USB_DIR_IN) ? "in" : "out",
1225 ({ char *s; \
1226 switch (usb_pipetype (tmp)) { \
1227 case PIPE_CONTROL: s = ""; break; \
1228 case PIPE_BULK: s = "-bulk"; break; \
1229 case PIPE_INTERRUPT: s = "-intr"; break; \
1230 default: s = "-iso"; break; \
1231 }; s;}));
1232 }
1233 usb_put_urb (urb);
1234
1235 /* list contents may have changed */
1236 goto rescan;
1237 }
809a58b8 1238 spin_unlock(&hcd_urb_list_lock);
1da177e4
LT
1239 local_irq_enable ();
1240
1241 /* synchronize with the hardware, so old configuration state
1242 * clears out immediately (and will be freed).
1243 */
1244 might_sleep ();
1245 if (hcd->driver->endpoint_disable)
1246 hcd->driver->endpoint_disable (hcd, ep);
455b25fb
AS
1247
1248 /* Wait until the endpoint queue is completely empty. Most HCDs
1249 * will have done this already in their endpoint_disable method,
1250 * but some might not. And there could be root-hub control URBs
1251 * still pending since they aren't affected by the HCDs'
1252 * endpoint_disable methods.
1253 */
1254 while (!list_empty (&ep->urb_list)) {
809a58b8 1255 spin_lock_irq(&hcd_urb_list_lock);
455b25fb
AS
1256
1257 /* The list may have changed while we acquired the spinlock */
1258 urb = NULL;
1259 if (!list_empty (&ep->urb_list)) {
1260 urb = list_entry (ep->urb_list.prev, struct urb,
1261 urb_list);
1262 usb_get_urb (urb);
1263 }
809a58b8 1264 spin_unlock_irq(&hcd_urb_list_lock);
455b25fb
AS
1265
1266 if (urb) {
1267 usb_kill_urb (urb);
1268 usb_put_urb (urb);
1269 }
1270 }
1da177e4
LT
1271}
1272
1273/*-------------------------------------------------------------------------*/
1274
32aca560
AS
1275/* called in any context */
1276int usb_hcd_get_frame_number (struct usb_device *udev)
1277{
1278 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1279
1280 if (!HC_IS_RUNNING (hcd->state))
1281 return -ESHUTDOWN;
1282 return hcd->driver->get_frame_number (hcd);
1283}
1284
1285/*-------------------------------------------------------------------------*/
1286
9293677a 1287#ifdef CONFIG_PM
1da177e4 1288
686314cf 1289int hcd_bus_suspend(struct usb_device *rhdev)
1da177e4 1290{
686314cf
AS
1291 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1292 int status;
1293 int old_state = hcd->state;
1da177e4 1294
686314cf
AS
1295 dev_dbg(&rhdev->dev, "bus %s%s\n",
1296 rhdev->auto_pm ? "auto-" : "", "suspend");
1297 if (!hcd->driver->bus_suspend) {
1298 status = -ENOENT;
1299 } else {
1300 hcd->state = HC_STATE_QUIESCING;
1301 status = hcd->driver->bus_suspend(hcd);
1302 }
1303 if (status == 0) {
1304 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
9293677a 1305 hcd->state = HC_STATE_SUSPENDED;
686314cf
AS
1306 } else {
1307 hcd->state = old_state;
1308 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
9293677a 1309 "suspend", status);
686314cf 1310 }
9293677a 1311 return status;
1da177e4
LT
1312}
1313
686314cf 1314int hcd_bus_resume(struct usb_device *rhdev)
1da177e4 1315{
686314cf
AS
1316 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1317 int status;
cfa59dab 1318 int old_state = hcd->state;
1da177e4 1319
686314cf
AS
1320 dev_dbg(&rhdev->dev, "usb %s%s\n",
1321 rhdev->auto_pm ? "auto-" : "", "resume");
0c0382e3 1322 if (!hcd->driver->bus_resume)
9293677a 1323 return -ENOENT;
979d5199
DB
1324 if (hcd->state == HC_STATE_RUNNING)
1325 return 0;
686314cf 1326
9293677a 1327 hcd->state = HC_STATE_RESUMING;
686314cf
AS
1328 status = hcd->driver->bus_resume(hcd);
1329 if (status == 0) {
1330 /* TRSMRCY = 10 msec */
1331 msleep(10);
1332 usb_set_device_state(rhdev, rhdev->actconfig
1333 ? USB_STATE_CONFIGURED
1334 : USB_STATE_ADDRESS);
9293677a 1335 hcd->state = HC_STATE_RUNNING;
686314cf 1336 } else {
cfa59dab 1337 hcd->state = old_state;
686314cf 1338 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
9293677a 1339 "resume", status);
cfa59dab
AS
1340 if (status != -ESHUTDOWN)
1341 usb_hc_died(hcd);
9293677a
DB
1342 }
1343 return status;
1da177e4
LT
1344}
1345
6b157c9b
AS
1346/* Workqueue routine for root-hub remote wakeup */
1347static void hcd_resume_work(struct work_struct *work)
1348{
1349 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
1350 struct usb_device *udev = hcd->self.root_hub;
1351
1352 usb_lock_device(udev);
1941044a 1353 usb_mark_last_busy(udev);
6b157c9b
AS
1354 usb_external_resume_device(udev);
1355 usb_unlock_device(udev);
1356}
1357
1da177e4
LT
1358/**
1359 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1360 * @hcd: host controller for this root hub
1361 *
1362 * The USB host controller calls this function when its root hub is
1363 * suspended (with the remote wakeup feature enabled) and a remote
6b157c9b
AS
1364 * wakeup request is received. The routine submits a workqueue request
1365 * to resume the root hub (that is, manage its downstream ports again).
1da177e4
LT
1366 */
1367void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1368{
1369 unsigned long flags;
1370
1371 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1372 if (hcd->rh_registered)
6b157c9b 1373 queue_work(ksuspend_usb_wq, &hcd->wakeup_work);
1da177e4
LT
1374 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1375}
9293677a 1376EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1da177e4 1377
1da177e4 1378#endif
1da177e4
LT
1379
1380/*-------------------------------------------------------------------------*/
1381
1382#ifdef CONFIG_USB_OTG
1383
1384/**
1385 * usb_bus_start_enum - start immediate enumeration (for OTG)
1386 * @bus: the bus (must use hcd framework)
1387 * @port_num: 1-based number of port; usually bus->otg_port
1388 * Context: in_interrupt()
1389 *
1390 * Starts enumeration, with an immediate reset followed later by
1391 * khubd identifying and possibly configuring the device.
1392 * This is needed by OTG controller drivers, where it helps meet
1393 * HNP protocol timing requirements for starting a port reset.
1394 */
1395int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1396{
1397 struct usb_hcd *hcd;
1398 int status = -EOPNOTSUPP;
1399
1400 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1401 * boards with root hubs hooked up to internal devices (instead of
1402 * just the OTG port) may need more attention to resetting...
1403 */
1404 hcd = container_of (bus, struct usb_hcd, self);
1405 if (port_num && hcd->driver->start_port_reset)
1406 status = hcd->driver->start_port_reset(hcd, port_num);
1407
1408 /* run khubd shortly after (first) root port reset finishes;
1409 * it may issue others, until at least 50 msecs have passed.
1410 */
1411 if (status == 0)
1412 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1413 return status;
1414}
1415EXPORT_SYMBOL (usb_bus_start_enum);
1416
1417#endif
1418
1419/*-------------------------------------------------------------------------*/
1420
1da177e4
LT
1421/**
1422 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1423 * @irq: the IRQ being raised
1424 * @__hcd: pointer to the HCD whose IRQ is being signaled
1425 * @r: saved hardware registers
1426 *
1427 * If the controller isn't HALTed, calls the driver's irq handler.
1428 * Checks whether the controller is now dead.
1429 */
7d12e780 1430irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1da177e4
LT
1431{
1432 struct usb_hcd *hcd = __hcd;
1433 int start = hcd->state;
1434
8de98402
BH
1435 if (unlikely(start == HC_STATE_HALT ||
1436 !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1da177e4 1437 return IRQ_NONE;
7d12e780 1438 if (hcd->driver->irq (hcd) == IRQ_NONE)
1da177e4
LT
1439 return IRQ_NONE;
1440
8de98402
BH
1441 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1442
1443 if (unlikely(hcd->state == HC_STATE_HALT))
1da177e4
LT
1444 usb_hc_died (hcd);
1445 return IRQ_HANDLED;
1446}
1447
1448/*-------------------------------------------------------------------------*/
1449
1450/**
1451 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1452 * @hcd: pointer to the HCD representing the controller
1453 *
1454 * This is called by bus glue to report a USB host controller that died
1455 * while operations may still have been pending. It's called automatically
1456 * by the PCI glue, so only glue for non-PCI busses should need to call it.
1457 */
1458void usb_hc_died (struct usb_hcd *hcd)
1459{
1460 unsigned long flags;
1461
1462 dev_err (hcd->self.controller, "HC died; cleaning up\n");
1463
1464 spin_lock_irqsave (&hcd_root_hub_lock, flags);
1465 if (hcd->rh_registered) {
d5926ae7 1466 hcd->poll_rh = 0;
1da177e4
LT
1467
1468 /* make khubd clean up old urbs and devices */
1469 usb_set_device_state (hcd->self.root_hub,
1470 USB_STATE_NOTATTACHED);
1471 usb_kick_khubd (hcd->self.root_hub);
1472 }
1473 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1474}
1475EXPORT_SYMBOL_GPL (usb_hc_died);
1476
1477/*-------------------------------------------------------------------------*/
1478
1da177e4
LT
1479/**
1480 * usb_create_hcd - create and initialize an HCD structure
1481 * @driver: HC driver that will use this hcd
1482 * @dev: device for this HC, stored in hcd->self.controller
1483 * @bus_name: value to store in hcd->self.bus_name
1484 * Context: !in_interrupt()
1485 *
1486 * Allocate a struct usb_hcd, with extra space at the end for the
1487 * HC driver's private data. Initialize the generic members of the
1488 * hcd structure.
1489 *
1490 * If memory is unavailable, returns NULL.
1491 */
1492struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1493 struct device *dev, char *bus_name)
1494{
1495 struct usb_hcd *hcd;
1496
7b842b6e 1497 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1da177e4
LT
1498 if (!hcd) {
1499 dev_dbg (dev, "hcd alloc failed\n");
1500 return NULL;
1501 }
1502 dev_set_drvdata(dev, hcd);
17200583 1503 kref_init(&hcd->kref);
1da177e4
LT
1504
1505 usb_bus_init(&hcd->self);
1da177e4
LT
1506 hcd->self.controller = dev;
1507 hcd->self.bus_name = bus_name;
dd990f16 1508 hcd->self.uses_dma = (dev->dma_mask != NULL);
1da177e4
LT
1509
1510 init_timer(&hcd->rh_timer);
d5926ae7
AS
1511 hcd->rh_timer.function = rh_timer_func;
1512 hcd->rh_timer.data = (unsigned long) hcd;
6b157c9b
AS
1513#ifdef CONFIG_PM
1514 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
1515#endif
1da177e4
LT
1516
1517 hcd->driver = driver;
1518 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1519 "USB Host Controller";
1520
1521 return hcd;
1522}
1523EXPORT_SYMBOL (usb_create_hcd);
1524
17200583
AS
1525static void hcd_release (struct kref *kref)
1526{
1527 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1528
1529 kfree(hcd);
1530}
1531
1532struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1533{
1534 if (hcd)
1535 kref_get (&hcd->kref);
1536 return hcd;
1537}
1538EXPORT_SYMBOL (usb_get_hcd);
1539
1da177e4
LT
1540void usb_put_hcd (struct usb_hcd *hcd)
1541{
17200583
AS
1542 if (hcd)
1543 kref_put (&hcd->kref, hcd_release);
1da177e4
LT
1544}
1545EXPORT_SYMBOL (usb_put_hcd);
1546
1547/**
1548 * usb_add_hcd - finish generic HCD structure initialization and register
1549 * @hcd: the usb_hcd structure to initialize
1550 * @irqnum: Interrupt line to allocate
1551 * @irqflags: Interrupt type flags
1552 *
1553 * Finish the remaining parts of generic HCD initialization: allocate the
1554 * buffers of consistent memory, register the bus, request the IRQ line,
1555 * and call the driver's reset() and start() routines.
1556 */
1557int usb_add_hcd(struct usb_hcd *hcd,
1558 unsigned int irqnum, unsigned long irqflags)
1559{
8ec8d20b
AS
1560 int retval;
1561 struct usb_device *rhdev;
1da177e4
LT
1562
1563 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1564
8de98402
BH
1565 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1566
b1e8f0a6
DB
1567 /* HC is in reset state, but accessible. Now do the one-time init,
1568 * bottom up so that hcds can customize the root hubs before khubd
1569 * starts talking to them. (Note, bus id is assigned early too.)
1570 */
1da177e4
LT
1571 if ((retval = hcd_buffer_create(hcd)) != 0) {
1572 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1573 return retval;
1574 }
1575
1576 if ((retval = usb_register_bus(&hcd->self)) < 0)
8ec8d20b 1577 goto err_register_bus;
1da177e4 1578
b1e8f0a6
DB
1579 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1580 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1581 retval = -ENOMEM;
1582 goto err_allocate_root_hub;
1583 }
1584 rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1585 USB_SPEED_FULL;
1586 hcd->self.root_hub = rhdev;
1587
db4cefaa
DB
1588 /* wakeup flag init defaults to "everything works" for root hubs,
1589 * but drivers can override it in reset() if needed, along with
1590 * recording the overall controller's system wakeup capability.
1591 */
1592 device_init_wakeup(&rhdev->dev, 1);
1593
b1e8f0a6
DB
1594 /* "reset" is misnamed; its role is now one-time init. the controller
1595 * should already have been reset (and boot firmware kicked off etc).
1596 */
1597 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1598 dev_err(hcd->self.controller, "can't setup\n");
1599 goto err_hcd_driver_setup;
1600 }
1601
fb669cc0
DB
1602 /* NOTE: root hub and controller capabilities may not be the same */
1603 if (device_can_wakeup(hcd->self.controller)
1604 && device_can_wakeup(&hcd->self.root_hub->dev))
b1e8f0a6 1605 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
b1e8f0a6
DB
1606
1607 /* enable irqs just before we start the controller */
1da177e4 1608 if (hcd->driver->irq) {
1da177e4
LT
1609 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1610 hcd->driver->description, hcd->self.busnum);
1611 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1612 hcd->irq_descr, hcd)) != 0) {
1613 dev_err(hcd->self.controller,
c6387a48 1614 "request interrupt %d failed\n", irqnum);
8ec8d20b 1615 goto err_request_irq;
1da177e4
LT
1616 }
1617 hcd->irq = irqnum;
c6387a48 1618 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1da177e4
LT
1619 (hcd->driver->flags & HCD_MEMORY) ?
1620 "io mem" : "io base",
1621 (unsigned long long)hcd->rsrc_start);
1622 } else {
1623 hcd->irq = -1;
1624 if (hcd->rsrc_start)
1625 dev_info(hcd->self.controller, "%s 0x%08llx\n",
1626 (hcd->driver->flags & HCD_MEMORY) ?
1627 "io mem" : "io base",
1628 (unsigned long long)hcd->rsrc_start);
1629 }
1630
1631 if ((retval = hcd->driver->start(hcd)) < 0) {
1632 dev_err(hcd->self.controller, "startup error %d\n", retval);
8ec8d20b 1633 goto err_hcd_driver_start;
1da177e4
LT
1634 }
1635
b1e8f0a6 1636 /* starting here, usbcore will pay attention to this root hub */
55c52718 1637 rhdev->bus_mA = min(500u, hcd->power_budget);
b1e8f0a6 1638 if ((retval = register_root_hub(hcd)) != 0)
8ec8d20b
AS
1639 goto err_register_root_hub;
1640
d5926ae7
AS
1641 if (hcd->uses_new_polling && hcd->poll_rh)
1642 usb_hcd_poll_rh_status(hcd);
1da177e4
LT
1643 return retval;
1644
b1e8f0a6 1645err_register_root_hub:
8ec8d20b 1646 hcd->driver->stop(hcd);
b1e8f0a6 1647err_hcd_driver_start:
1da177e4
LT
1648 if (hcd->irq >= 0)
1649 free_irq(irqnum, hcd);
b1e8f0a6
DB
1650err_request_irq:
1651err_hcd_driver_setup:
1652 hcd->self.root_hub = NULL;
1653 usb_put_dev(rhdev);
1654err_allocate_root_hub:
1da177e4 1655 usb_deregister_bus(&hcd->self);
b1e8f0a6 1656err_register_bus:
1da177e4
LT
1657 hcd_buffer_destroy(hcd);
1658 return retval;
1659}
1660EXPORT_SYMBOL (usb_add_hcd);
1661
1662/**
1663 * usb_remove_hcd - shutdown processing for generic HCDs
1664 * @hcd: the usb_hcd structure to remove
1665 * Context: !in_interrupt()
1666 *
1667 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1668 * invoking the HCD's stop() method.
1669 */
1670void usb_remove_hcd(struct usb_hcd *hcd)
1671{
1672 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1673
1674 if (HC_IS_RUNNING (hcd->state))
1675 hcd->state = HC_STATE_QUIESCING;
1676
1677 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1678 spin_lock_irq (&hcd_root_hub_lock);
1679 hcd->rh_registered = 0;
1680 spin_unlock_irq (&hcd_root_hub_lock);
9ad3d6cc 1681
6b157c9b 1682#ifdef CONFIG_PM
d5d4db70 1683 cancel_work_sync(&hcd->wakeup_work);
6b157c9b
AS
1684#endif
1685
4186ecf8 1686 mutex_lock(&usb_bus_list_lock);
1da177e4 1687 usb_disconnect(&hcd->self.root_hub);
4186ecf8 1688 mutex_unlock(&usb_bus_list_lock);
1da177e4
LT
1689
1690 hcd->driver->stop(hcd);
1691 hcd->state = HC_STATE_HALT;
1692
1b42ae6d
AS
1693 hcd->poll_rh = 0;
1694 del_timer_sync(&hcd->rh_timer);
1695
1da177e4
LT
1696 if (hcd->irq >= 0)
1697 free_irq(hcd->irq, hcd);
1698 usb_deregister_bus(&hcd->self);
1699 hcd_buffer_destroy(hcd);
1700}
1701EXPORT_SYMBOL (usb_remove_hcd);
1702
64a21d02
AG
1703void
1704usb_hcd_platform_shutdown(struct platform_device* dev)
1705{
1706 struct usb_hcd *hcd = platform_get_drvdata(dev);
1707
1708 if (hcd->driver->shutdown)
1709 hcd->driver->shutdown(hcd);
1710}
1711EXPORT_SYMBOL (usb_hcd_platform_shutdown);
1712
1da177e4
LT
1713/*-------------------------------------------------------------------------*/
1714
4749f32d 1715#if defined(CONFIG_USB_MON)
1da177e4
LT
1716
1717struct usb_mon_operations *mon_ops;
1718
1719/*
1720 * The registration is unlocked.
1721 * We do it this way because we do not want to lock in hot paths.
1722 *
1723 * Notice that the code is minimally error-proof. Because usbmon needs
1724 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1725 */
1726
1727int usb_mon_register (struct usb_mon_operations *ops)
1728{
1729
1730 if (mon_ops)
1731 return -EBUSY;
1732
1733 mon_ops = ops;
1734 mb();
1735 return 0;
1736}
1737EXPORT_SYMBOL_GPL (usb_mon_register);
1738
1739void usb_mon_deregister (void)
1740{
1741
1742 if (mon_ops == NULL) {
1743 printk(KERN_ERR "USB: monitor was not registered\n");
1744 return;
1745 }
1746 mon_ops = NULL;
1747 mb();
1748}
1749EXPORT_SYMBOL_GPL (usb_mon_deregister);
1750
1751#endif /* CONFIG_USB_MON */