USB: add urb->ep
[linux-2.6.git] / drivers / usb / core / hcd.c
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
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>
36 #include <linux/mutex.h>
37 #include <asm/irq.h>
38 #include <asm/byteorder.h>
39 #include <linux/platform_device.h>
40 #include <linux/workqueue.h>
41
42 #include <linux/usb.h>
43
44 #include "usb.h"
45 #include "hcd.h"
46 #include "hub.h"
47
48
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 */
85 LIST_HEAD (usb_bus_list);
86 EXPORT_SYMBOL_GPL (usb_bus_list);
87
88 /* used when allocating bus numbers */
89 #define USB_MAXBUS              64
90 struct usb_busmap {
91         unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
92 };
93 static struct usb_busmap busmap;
94
95 /* used when updating list of hcds */
96 DEFINE_MUTEX(usb_bus_list_lock);        /* exported only for usbfs */
97 EXPORT_SYMBOL_GPL (usb_bus_list_lock);
98
99 /* used for controlling access to virtual root hubs */
100 static DEFINE_SPINLOCK(hcd_root_hub_lock);
101
102 /* used when updating an endpoint's URB list */
103 static DEFINE_SPINLOCK(hcd_urb_list_lock);
104
105 /* wait queue for synchronous unlinks */
106 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
107
108 static inline int is_root_hub(struct usb_device *udev)
109 {
110         return (udev->parent == NULL);
111 }
112
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 */
125 static 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 ]*/
133         0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
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 */
148 static 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 ] */
156         0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
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
173 static 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
220 static 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 */
263                     /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
264                      * see hub.c:hub_configure() for details. */
265         (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
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  */
275 static 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  */
301 static 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) {
327                 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
328                         init_utsname()->release, hcd->driver->description);
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 */
349 static 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;
354         u8              tbuf [sizeof (struct usb_hub_descriptor)]
355                 __attribute__((aligned(4)));
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
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
393         case DeviceRequest | USB_REQ_GET_STATUS:
394                 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
395                                         << USB_DEVICE_REMOTE_WAKEUP)
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)
402                         device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
403                 else
404                         goto error;
405                 break;
406         case DeviceOutRequest | USB_REQ_SET_FEATURE:
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);
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                         }
438                         if (device_can_wakeup(&hcd->self.root_hub->dev))
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 */
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;
490                 }
491                 status = hcd->driver->hub_control (hcd,
492                         typeReq, wValue, wIndex,
493                         tbuf, wLength);
494                 break;
495 error:
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,
507                                 wLength, status);
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);
531         usb_hcd_giveback_urb (hcd, urb);
532         local_irq_restore (flags);
533         return 0;
534 }
535
536 /*-------------------------------------------------------------------------*/
537
538 /*
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.
542  *
543  * Completions are called in_interrupt(), but they may or may not
544  * be in_irq().
545  */
546 void 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? */
552
553         if (unlikely(!hcd->rh_registered))
554                 return;
555         if (!hcd->uses_new_polling && !hcd->status_urb)
556                 return;
557
558         length = hcd->driver->hub_status_data(hcd, buffer);
559         if (length > 0) {
560
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)
583                         usb_hcd_giveback_urb (hcd, urb);
584                 else
585                         hcd->poll_pending = 1;
586                 local_irq_restore (flags);
587         }
588
589         /* The USB 2.0 spec says 256 ms.  This is close enough and won't
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 */
593         if (hcd->uses_new_polling ? hcd->poll_rh :
594                         (length == 0 && hcd->status_urb != NULL))
595                 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
596 }
597 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
598
599 /* timer callback */
600 static void rh_timer_func (unsigned long _hcd)
601 {
602         usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
603 }
604
605 /*-------------------------------------------------------------------------*/
606
607 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
608 {
609         int             retval;
610         unsigned long   flags;
611         int             len = 1 + (urb->dev->maxchild / 8);
612
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 */
622
623                 if (!hcd->uses_new_polling)
624                         mod_timer (&hcd->rh_timer,
625                                 (jiffies/(HZ/4) + 1) * (HZ/4));
626
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;
631         }
632         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
633         return retval;
634 }
635
636 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
637 {
638         if (usb_pipeint (urb->pipe))
639                 return rh_queue_status (hcd, urb);
640         if (usb_pipecontrol (urb->pipe))
641                 return rh_call_control (hcd, urb);
642         return -EINVAL;
643 }
644
645 /*-------------------------------------------------------------------------*/
646
647 /* Unlinks of root-hub control URBs are legal, but they don't do anything
648  * since these URBs always execute synchronously.
649  */
650 static int usb_rh_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
651 {
652         unsigned long   flags;
653
654         if (usb_pipeendpoint(urb->pipe) == 0) { /* Control URB */
655                 ;       /* Do nothing */
656
657         } else {                                /* Status URB */
658                 if (!hcd->uses_new_polling)
659                         del_timer (&hcd->rh_timer);
660                 local_irq_save (flags);
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)
669                         usb_hcd_giveback_urb (hcd, urb);
670                 local_irq_restore (flags);
671         }
672
673         return 0;
674 }
675
676 /*-------------------------------------------------------------------------*/
677
678 static struct class *usb_host_class;
679
680 int usb_host_init(void)
681 {
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;
688 }
689
690 void usb_host_cleanup(void)
691 {
692         class_destroy(usb_host_class);
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  */
702 static 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;
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);
715 }
716
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  */
727 static int usb_register_bus(struct usb_bus *bus)
728 {
729         int busnum;
730
731         mutex_lock(&usb_bus_list_lock);
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);
738                 mutex_unlock(&usb_bus_list_lock);
739                 return -E2BIG;
740         }
741
742         bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
743                                              bus->controller, "usb_host%d", busnum);
744         if (IS_ERR(bus->class_dev)) {
745                 clear_bit(busnum, busmap.busmap);
746                 mutex_unlock(&usb_bus_list_lock);
747                 return PTR_ERR(bus->class_dev);
748         }
749
750         class_set_devdata(bus->class_dev, bus);
751
752         /* Add it to the local list of buses */
753         list_add (&bus->bus_list, &usb_bus_list);
754         mutex_unlock(&usb_bus_list_lock);
755
756         usb_notify_add_bus(bus);
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  */
770 static 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          */
779         mutex_lock(&usb_bus_list_lock);
780         list_del (&bus->bus_list);
781         mutex_unlock(&usb_bus_list_lock);
782
783         usb_notify_remove_bus(bus);
784
785         clear_bit (bus->busnum, busmap.busmap);
786
787         class_device_unregister(bus->class_dev);
788 }
789
790 /**
791  * register_root_hub - called by usb_add_hcd() to register a root hub
792  * @hcd: host controller for this root hub
793  *
794  * This function registers the root hub with the USB subsystem.  It sets up
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).
798  */
799 static int register_root_hub(struct usb_hcd *hcd)
800 {
801         struct device *parent_dev = hcd->self.controller;
802         struct usb_device *usb_dev = hcd->self.root_hub;
803         const int devnum = 1;
804         int retval;
805
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
813         mutex_lock(&usb_bus_list_lock);
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) {
818                 mutex_unlock(&usb_bus_list_lock);
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
824         retval = usb_new_device (usb_dev);
825         if (retval) {
826                 dev_err (parent_dev, "can't register root hub for %s, %d\n",
827                                 usb_dev->dev.bus_id, retval);
828         }
829         mutex_unlock(&usb_bus_list_lock);
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 }
843
844 void 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);
849         if (hcd->driver->hub_irq_enable && hcd->state != HC_STATE_HALT)
850                 hcd->driver->hub_irq_enable (hcd);
851 }
852
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  */
867 long 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)
891                         tmp = HS_NSECS_ISO (bytecount);
892                 else
893                         tmp = HS_NSECS (bytecount);
894                 return tmp;
895         default:
896                 pr_debug ("%s: bogus device speed!\n", usbcore_name);
897                 return -1;
898         }
899 }
900 EXPORT_SYMBOL (usb_calc_bus_time);
901
902
903 /*-------------------------------------------------------------------------*/
904
905 /*
906  * Generic HC operations.
907  */
908
909 /*-------------------------------------------------------------------------*/
910
911 static void urb_unlink(struct usb_hcd *hcd, struct urb *urb)
912 {
913         unsigned long           flags;
914
915         /* clear all state linking urb to this dev (and hcd) */
916         spin_lock_irqsave(&hcd_urb_list_lock, flags);
917         list_del_init (&urb->urb_list);
918         spin_unlock_irqrestore(&hcd_urb_list_lock, flags);
919
920         if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
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,
931                                         usb_pipein (urb->pipe)
932                                             ? DMA_FROM_DEVICE
933                                             : DMA_TO_DEVICE);
934         }
935 }
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  */
942 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
943 {
944         int                     status;
945         struct usb_hcd          *hcd = bus_to_hcd(urb->dev->bus);
946         struct usb_host_endpoint *ep;
947         unsigned long           flags;
948
949         if (!hcd)
950                 return -ENODEV;
951
952         usbmon_urb_submit(&hcd->self, urb);
953
954         /*
955          * Atomically queue the urb,  first to our records, then to the HCD.
956          * Access to urb->status is controlled by urb->lock ... changes on
957          * i/o completion (normal or fault) or unlinking.
958          */
959
960         // FIXME:  verify that quiescing hc works right (RH cleans up)
961
962         spin_lock_irqsave(&hcd_urb_list_lock, flags);
963         ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
964                         [usb_pipeendpoint(urb->pipe)];
965         if (unlikely(ep != urb->ep))
966                 status = -ENOENT;
967         else if (unlikely (urb->reject))
968                 status = -EPERM;
969         else switch (hcd->state) {
970         case HC_STATE_RUNNING:
971         case HC_STATE_RESUMING:
972                 list_add_tail (&urb->urb_list, &urb->ep->urb_list);
973                 status = 0;
974                 break;
975         default:
976                 status = -ESHUTDOWN;
977                 break;
978         }
979         spin_unlock_irqrestore(&hcd_urb_list_lock, flags);
980         if (status) {
981                 INIT_LIST_HEAD (&urb->urb_list);
982                 usbmon_urb_submit_error(&hcd->self, urb, status);
983                 return status;
984         }
985
986         /* increment urb's reference count as part of giving it to the HCD
987          * (which now controls it).  HCD guarantees that it either returns
988          * an error or calls giveback(), but not both.
989          */
990         urb = usb_get_urb (urb);
991         atomic_inc (&urb->use_count);
992
993         if (is_root_hub(urb->dev)) {
994                 /* NOTE:  requirement on hub callers (usbfs and the hub
995                  * driver, for now) that URBs' urb->transfer_buffer be
996                  * valid and usb_buffer_{sync,unmap}() not be needed, since
997                  * they could clobber root hub response data.
998                  */
999                 status = rh_urb_enqueue (hcd, urb);
1000                 goto done;
1001         }
1002
1003         /* lower level hcd code should use *_dma exclusively,
1004          * unless it uses pio or talks to another transport.
1005          */
1006         if (hcd->self.uses_dma) {
1007                 if (usb_pipecontrol (urb->pipe)
1008                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1009                         urb->setup_dma = dma_map_single (
1010                                         hcd->self.controller,
1011                                         urb->setup_packet,
1012                                         sizeof (struct usb_ctrlrequest),
1013                                         DMA_TO_DEVICE);
1014                 if (urb->transfer_buffer_length != 0
1015                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1016                         urb->transfer_dma = dma_map_single (
1017                                         hcd->self.controller,
1018                                         urb->transfer_buffer,
1019                                         urb->transfer_buffer_length,
1020                                         usb_pipein (urb->pipe)
1021                                             ? DMA_FROM_DEVICE
1022                                             : DMA_TO_DEVICE);
1023         }
1024
1025         status = hcd->driver->urb_enqueue (hcd, urb->ep, urb, mem_flags);
1026 done:
1027         if (unlikely (status)) {
1028                 urb_unlink(hcd, urb);
1029                 atomic_dec (&urb->use_count);
1030                 if (urb->reject)
1031                         wake_up (&usb_kill_urb_queue);
1032                 usbmon_urb_submit_error(&hcd->self, urb, status);
1033                 usb_put_urb (urb);
1034         }
1035         return status;
1036 }
1037
1038 /*-------------------------------------------------------------------------*/
1039
1040 /* this makes the hcd giveback() the urb more quickly, by kicking it
1041  * off hardware queues (which may take a while) and returning it as
1042  * soon as practical.  we've already set up the urb's return status,
1043  * but we can't know if the callback completed already.
1044  */
1045 static int
1046 unlink1 (struct usb_hcd *hcd, struct urb *urb)
1047 {
1048         int             value;
1049
1050         if (is_root_hub(urb->dev))
1051                 value = usb_rh_urb_dequeue (hcd, urb);
1052         else {
1053
1054                 /* The only reason an HCD might fail this call is if
1055                  * it has not yet fully queued the urb to begin with.
1056                  * Such failures should be harmless. */
1057                 value = hcd->driver->urb_dequeue (hcd, urb);
1058         }
1059
1060         if (value != 0)
1061                 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1062                                 urb, value);
1063         return value;
1064 }
1065
1066 /*
1067  * called in any context
1068  *
1069  * caller guarantees urb won't be recycled till both unlink()
1070  * and the urb's completion function return
1071  */
1072 int usb_hcd_unlink_urb (struct urb *urb, int status)
1073 {
1074         struct usb_hcd                  *hcd = NULL;
1075         struct device                   *sys = NULL;
1076         unsigned long                   flags;
1077         struct list_head                *tmp;
1078         int                             retval;
1079
1080         if (!urb)
1081                 return -EINVAL;
1082         if (!urb->dev || !urb->dev->bus)
1083                 return -ENODEV;
1084
1085         /*
1086          * we contend for urb->status with the hcd core,
1087          * which changes it while returning the urb.
1088          *
1089          * Caller guaranteed that the urb pointer hasn't been freed, and
1090          * that it was submitted.  But as a rule it can't know whether or
1091          * not it's already been unlinked ... so we respect the reversed
1092          * lock sequence needed for the usb_hcd_giveback_urb() code paths
1093          * (urb lock, then hcd_urb_list_lock) in case some other CPU is now
1094          * unlinking it.
1095          */
1096         spin_lock_irqsave (&urb->lock, flags);
1097         spin_lock(&hcd_urb_list_lock);
1098
1099         sys = &urb->dev->dev;
1100         hcd = bus_to_hcd(urb->dev->bus);
1101         if (hcd == NULL) {
1102                 retval = -ENODEV;
1103                 goto done;
1104         }
1105
1106         /* insist the urb is still queued */
1107         list_for_each(tmp, &urb->ep->urb_list) {
1108                 if (tmp == &urb->urb_list)
1109                         break;
1110         }
1111         if (tmp != &urb->urb_list) {
1112                 retval = -EIDRM;
1113                 goto done;
1114         }
1115
1116         /* Any status except -EINPROGRESS means something already started to
1117          * unlink this URB from the hardware.  So there's no more work to do.
1118          */
1119         if (urb->status != -EINPROGRESS) {
1120                 retval = -EBUSY;
1121                 goto done;
1122         }
1123
1124         /* IRQ setup can easily be broken so that USB controllers
1125          * never get completion IRQs ... maybe even the ones we need to
1126          * finish unlinking the initial failed usb_set_address()
1127          * or device descriptor fetch.
1128          */
1129         if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags) &&
1130                         !is_root_hub(urb->dev)) {
1131                 dev_warn (hcd->self.controller, "Unlink after no-IRQ?  "
1132                         "Controller is probably using the wrong IRQ.\n");
1133                 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1134         }
1135
1136         urb->status = status;
1137
1138         spin_unlock(&hcd_urb_list_lock);
1139         spin_unlock_irqrestore (&urb->lock, flags);
1140
1141         retval = unlink1 (hcd, urb);
1142         if (retval == 0)
1143                 retval = -EINPROGRESS;
1144         return retval;
1145
1146 done:
1147         spin_unlock(&hcd_urb_list_lock);
1148         spin_unlock_irqrestore (&urb->lock, flags);
1149         if (retval != -EIDRM && sys && sys->driver)
1150                 dev_dbg (sys, "hcd_unlink_urb %p fail %d\n", urb, retval);
1151         return retval;
1152 }
1153
1154 /*-------------------------------------------------------------------------*/
1155
1156 /**
1157  * usb_hcd_giveback_urb - return URB from HCD to device driver
1158  * @hcd: host controller returning the URB
1159  * @urb: urb being returned to the USB device driver.
1160  * Context: in_interrupt()
1161  *
1162  * This hands the URB from HCD to its USB device driver, using its
1163  * completion function.  The HCD has freed all per-urb resources
1164  * (and is done using urb->hcpriv).  It also released all HCD locks;
1165  * the device driver won't cause problems if it frees, modifies,
1166  * or resubmits this URB.
1167  */
1168 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb)
1169 {
1170         urb_unlink(hcd, urb);
1171         usbmon_urb_complete (&hcd->self, urb);
1172         usb_unanchor_urb(urb);
1173
1174         /* pass ownership to the completion handler */
1175         urb->complete (urb);
1176         atomic_dec (&urb->use_count);
1177         if (unlikely (urb->reject))
1178                 wake_up (&usb_kill_urb_queue);
1179         usb_put_urb (urb);
1180 }
1181 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1182
1183 /*-------------------------------------------------------------------------*/
1184
1185 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1186  * the hcd to make sure all endpoint state is gone from hardware, and then
1187  * waits until the endpoint's queue is completely drained. use for
1188  * set_configuration, set_interface, driver removal, physical disconnect.
1189  *
1190  * example:  a qh stored in ep->hcpriv, holding state related to endpoint
1191  * type, maxpacket size, toggle, halt status, and scheduling.
1192  */
1193 void usb_hcd_endpoint_disable (struct usb_device *udev,
1194                 struct usb_host_endpoint *ep)
1195 {
1196         struct usb_hcd          *hcd;
1197         struct urb              *urb;
1198
1199         hcd = bus_to_hcd(udev->bus);
1200         local_irq_disable ();
1201
1202         /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1203 rescan:
1204         spin_lock(&hcd_urb_list_lock);
1205         list_for_each_entry (urb, &ep->urb_list, urb_list) {
1206                 int     tmp;
1207
1208                 /* the urb may already have been unlinked */
1209                 if (urb->status != -EINPROGRESS)
1210                         continue;
1211                 usb_get_urb (urb);
1212                 spin_unlock(&hcd_urb_list_lock);
1213
1214                 spin_lock (&urb->lock);
1215                 tmp = urb->status;
1216                 if (tmp == -EINPROGRESS)
1217                         urb->status = -ESHUTDOWN;
1218                 spin_unlock (&urb->lock);
1219
1220                 /* kick hcd unless it's already returning this */
1221                 if (tmp == -EINPROGRESS) {
1222                         tmp = urb->pipe;
1223                         unlink1 (hcd, urb);
1224                         dev_dbg (hcd->self.controller,
1225                                 "shutdown urb %p pipe %08x ep%d%s%s\n",
1226                                 urb, tmp, usb_pipeendpoint (tmp),
1227                                 (tmp & USB_DIR_IN) ? "in" : "out",
1228                                 ({ char *s; \
1229                                  switch (usb_pipetype (tmp)) { \
1230                                  case PIPE_CONTROL:     s = ""; break; \
1231                                  case PIPE_BULK:        s = "-bulk"; break; \
1232                                  case PIPE_INTERRUPT:   s = "-intr"; break; \
1233                                  default:               s = "-iso"; break; \
1234                                 }; s;}));
1235                 }
1236                 usb_put_urb (urb);
1237
1238                 /* list contents may have changed */
1239                 goto rescan;
1240         }
1241         spin_unlock(&hcd_urb_list_lock);
1242         local_irq_enable ();
1243
1244         /* synchronize with the hardware, so old configuration state
1245          * clears out immediately (and will be freed).
1246          */
1247         might_sleep ();
1248         if (hcd->driver->endpoint_disable)
1249                 hcd->driver->endpoint_disable (hcd, ep);
1250
1251         /* Wait until the endpoint queue is completely empty.  Most HCDs
1252          * will have done this already in their endpoint_disable method,
1253          * but some might not.  And there could be root-hub control URBs
1254          * still pending since they aren't affected by the HCDs'
1255          * endpoint_disable methods.
1256          */
1257         while (!list_empty (&ep->urb_list)) {
1258                 spin_lock_irq(&hcd_urb_list_lock);
1259
1260                 /* The list may have changed while we acquired the spinlock */
1261                 urb = NULL;
1262                 if (!list_empty (&ep->urb_list)) {
1263                         urb = list_entry (ep->urb_list.prev, struct urb,
1264                                         urb_list);
1265                         usb_get_urb (urb);
1266                 }
1267                 spin_unlock_irq(&hcd_urb_list_lock);
1268
1269                 if (urb) {
1270                         usb_kill_urb (urb);
1271                         usb_put_urb (urb);
1272                 }
1273         }
1274 }
1275
1276 /*-------------------------------------------------------------------------*/
1277
1278 /* called in any context */
1279 int usb_hcd_get_frame_number (struct usb_device *udev)
1280 {
1281         struct usb_hcd  *hcd = bus_to_hcd(udev->bus);
1282
1283         if (!HC_IS_RUNNING (hcd->state))
1284                 return -ESHUTDOWN;
1285         return hcd->driver->get_frame_number (hcd);
1286 }
1287
1288 /*-------------------------------------------------------------------------*/
1289
1290 #ifdef  CONFIG_PM
1291
1292 int hcd_bus_suspend(struct usb_device *rhdev)
1293 {
1294         struct usb_hcd  *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1295         int             status;
1296         int             old_state = hcd->state;
1297
1298         dev_dbg(&rhdev->dev, "bus %s%s\n",
1299                         rhdev->auto_pm ? "auto-" : "", "suspend");
1300         if (!hcd->driver->bus_suspend) {
1301                 status = -ENOENT;
1302         } else {
1303                 hcd->state = HC_STATE_QUIESCING;
1304                 status = hcd->driver->bus_suspend(hcd);
1305         }
1306         if (status == 0) {
1307                 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
1308                 hcd->state = HC_STATE_SUSPENDED;
1309         } else {
1310                 hcd->state = old_state;
1311                 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1312                                 "suspend", status);
1313         }
1314         return status;
1315 }
1316
1317 int hcd_bus_resume(struct usb_device *rhdev)
1318 {
1319         struct usb_hcd  *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1320         int             status;
1321         int             old_state = hcd->state;
1322
1323         dev_dbg(&rhdev->dev, "usb %s%s\n",
1324                         rhdev->auto_pm ? "auto-" : "", "resume");
1325         if (!hcd->driver->bus_resume)
1326                 return -ENOENT;
1327         if (hcd->state == HC_STATE_RUNNING)
1328                 return 0;
1329
1330         hcd->state = HC_STATE_RESUMING;
1331         status = hcd->driver->bus_resume(hcd);
1332         if (status == 0) {
1333                 /* TRSMRCY = 10 msec */
1334                 msleep(10);
1335                 usb_set_device_state(rhdev, rhdev->actconfig
1336                                 ? USB_STATE_CONFIGURED
1337                                 : USB_STATE_ADDRESS);
1338                 hcd->state = HC_STATE_RUNNING;
1339         } else {
1340                 hcd->state = old_state;
1341                 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1342                                 "resume", status);
1343                 if (status != -ESHUTDOWN)
1344                         usb_hc_died(hcd);
1345         }
1346         return status;
1347 }
1348
1349 /* Workqueue routine for root-hub remote wakeup */
1350 static void hcd_resume_work(struct work_struct *work)
1351 {
1352         struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
1353         struct usb_device *udev = hcd->self.root_hub;
1354
1355         usb_lock_device(udev);
1356         usb_mark_last_busy(udev);
1357         usb_external_resume_device(udev);
1358         usb_unlock_device(udev);
1359 }
1360
1361 /**
1362  * usb_hcd_resume_root_hub - called by HCD to resume its root hub 
1363  * @hcd: host controller for this root hub
1364  *
1365  * The USB host controller calls this function when its root hub is
1366  * suspended (with the remote wakeup feature enabled) and a remote
1367  * wakeup request is received.  The routine submits a workqueue request
1368  * to resume the root hub (that is, manage its downstream ports again).
1369  */
1370 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1371 {
1372         unsigned long flags;
1373
1374         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1375         if (hcd->rh_registered)
1376                 queue_work(ksuspend_usb_wq, &hcd->wakeup_work);
1377         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1378 }
1379 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1380
1381 #endif
1382
1383 /*-------------------------------------------------------------------------*/
1384
1385 #ifdef  CONFIG_USB_OTG
1386
1387 /**
1388  * usb_bus_start_enum - start immediate enumeration (for OTG)
1389  * @bus: the bus (must use hcd framework)
1390  * @port_num: 1-based number of port; usually bus->otg_port
1391  * Context: in_interrupt()
1392  *
1393  * Starts enumeration, with an immediate reset followed later by
1394  * khubd identifying and possibly configuring the device.
1395  * This is needed by OTG controller drivers, where it helps meet
1396  * HNP protocol timing requirements for starting a port reset.
1397  */
1398 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1399 {
1400         struct usb_hcd          *hcd;
1401         int                     status = -EOPNOTSUPP;
1402
1403         /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1404          * boards with root hubs hooked up to internal devices (instead of
1405          * just the OTG port) may need more attention to resetting...
1406          */
1407         hcd = container_of (bus, struct usb_hcd, self);
1408         if (port_num && hcd->driver->start_port_reset)
1409                 status = hcd->driver->start_port_reset(hcd, port_num);
1410
1411         /* run khubd shortly after (first) root port reset finishes;
1412          * it may issue others, until at least 50 msecs have passed.
1413          */
1414         if (status == 0)
1415                 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1416         return status;
1417 }
1418 EXPORT_SYMBOL (usb_bus_start_enum);
1419
1420 #endif
1421
1422 /*-------------------------------------------------------------------------*/
1423
1424 /**
1425  * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1426  * @irq: the IRQ being raised
1427  * @__hcd: pointer to the HCD whose IRQ is being signaled
1428  * @r: saved hardware registers
1429  *
1430  * If the controller isn't HALTed, calls the driver's irq handler.
1431  * Checks whether the controller is now dead.
1432  */
1433 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1434 {
1435         struct usb_hcd          *hcd = __hcd;
1436         int                     start = hcd->state;
1437
1438         if (unlikely(start == HC_STATE_HALT ||
1439             !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1440                 return IRQ_NONE;
1441         if (hcd->driver->irq (hcd) == IRQ_NONE)
1442                 return IRQ_NONE;
1443
1444         set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1445
1446         if (unlikely(hcd->state == HC_STATE_HALT))
1447                 usb_hc_died (hcd);
1448         return IRQ_HANDLED;
1449 }
1450
1451 /*-------------------------------------------------------------------------*/
1452
1453 /**
1454  * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1455  * @hcd: pointer to the HCD representing the controller
1456  *
1457  * This is called by bus glue to report a USB host controller that died
1458  * while operations may still have been pending.  It's called automatically
1459  * by the PCI glue, so only glue for non-PCI busses should need to call it. 
1460  */
1461 void usb_hc_died (struct usb_hcd *hcd)
1462 {
1463         unsigned long flags;
1464
1465         dev_err (hcd->self.controller, "HC died; cleaning up\n");
1466
1467         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1468         if (hcd->rh_registered) {
1469                 hcd->poll_rh = 0;
1470
1471                 /* make khubd clean up old urbs and devices */
1472                 usb_set_device_state (hcd->self.root_hub,
1473                                 USB_STATE_NOTATTACHED);
1474                 usb_kick_khubd (hcd->self.root_hub);
1475         }
1476         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1477 }
1478 EXPORT_SYMBOL_GPL (usb_hc_died);
1479
1480 /*-------------------------------------------------------------------------*/
1481
1482 /**
1483  * usb_create_hcd - create and initialize an HCD structure
1484  * @driver: HC driver that will use this hcd
1485  * @dev: device for this HC, stored in hcd->self.controller
1486  * @bus_name: value to store in hcd->self.bus_name
1487  * Context: !in_interrupt()
1488  *
1489  * Allocate a struct usb_hcd, with extra space at the end for the
1490  * HC driver's private data.  Initialize the generic members of the
1491  * hcd structure.
1492  *
1493  * If memory is unavailable, returns NULL.
1494  */
1495 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1496                 struct device *dev, char *bus_name)
1497 {
1498         struct usb_hcd *hcd;
1499
1500         hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1501         if (!hcd) {
1502                 dev_dbg (dev, "hcd alloc failed\n");
1503                 return NULL;
1504         }
1505         dev_set_drvdata(dev, hcd);
1506         kref_init(&hcd->kref);
1507
1508         usb_bus_init(&hcd->self);
1509         hcd->self.controller = dev;
1510         hcd->self.bus_name = bus_name;
1511         hcd->self.uses_dma = (dev->dma_mask != NULL);
1512
1513         init_timer(&hcd->rh_timer);
1514         hcd->rh_timer.function = rh_timer_func;
1515         hcd->rh_timer.data = (unsigned long) hcd;
1516 #ifdef CONFIG_PM
1517         INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
1518 #endif
1519
1520         hcd->driver = driver;
1521         hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1522                         "USB Host Controller";
1523
1524         return hcd;
1525 }
1526 EXPORT_SYMBOL (usb_create_hcd);
1527
1528 static void hcd_release (struct kref *kref)
1529 {
1530         struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1531
1532         kfree(hcd);
1533 }
1534
1535 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1536 {
1537         if (hcd)
1538                 kref_get (&hcd->kref);
1539         return hcd;
1540 }
1541 EXPORT_SYMBOL (usb_get_hcd);
1542
1543 void usb_put_hcd (struct usb_hcd *hcd)
1544 {
1545         if (hcd)
1546                 kref_put (&hcd->kref, hcd_release);
1547 }
1548 EXPORT_SYMBOL (usb_put_hcd);
1549
1550 /**
1551  * usb_add_hcd - finish generic HCD structure initialization and register
1552  * @hcd: the usb_hcd structure to initialize
1553  * @irqnum: Interrupt line to allocate
1554  * @irqflags: Interrupt type flags
1555  *
1556  * Finish the remaining parts of generic HCD initialization: allocate the
1557  * buffers of consistent memory, register the bus, request the IRQ line,
1558  * and call the driver's reset() and start() routines.
1559  */
1560 int usb_add_hcd(struct usb_hcd *hcd,
1561                 unsigned int irqnum, unsigned long irqflags)
1562 {
1563         int retval;
1564         struct usb_device *rhdev;
1565
1566         dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1567
1568         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1569
1570         /* HC is in reset state, but accessible.  Now do the one-time init,
1571          * bottom up so that hcds can customize the root hubs before khubd
1572          * starts talking to them.  (Note, bus id is assigned early too.)
1573          */
1574         if ((retval = hcd_buffer_create(hcd)) != 0) {
1575                 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1576                 return retval;
1577         }
1578
1579         if ((retval = usb_register_bus(&hcd->self)) < 0)
1580                 goto err_register_bus;
1581
1582         if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1583                 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1584                 retval = -ENOMEM;
1585                 goto err_allocate_root_hub;
1586         }
1587         rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1588                         USB_SPEED_FULL;
1589         hcd->self.root_hub = rhdev;
1590
1591         /* wakeup flag init defaults to "everything works" for root hubs,
1592          * but drivers can override it in reset() if needed, along with
1593          * recording the overall controller's system wakeup capability.
1594          */
1595         device_init_wakeup(&rhdev->dev, 1);
1596
1597         /* "reset" is misnamed; its role is now one-time init. the controller
1598          * should already have been reset (and boot firmware kicked off etc).
1599          */
1600         if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1601                 dev_err(hcd->self.controller, "can't setup\n");
1602                 goto err_hcd_driver_setup;
1603         }
1604
1605         /* NOTE: root hub and controller capabilities may not be the same */
1606         if (device_can_wakeup(hcd->self.controller)
1607                         && device_can_wakeup(&hcd->self.root_hub->dev))
1608                 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1609
1610         /* enable irqs just before we start the controller */
1611         if (hcd->driver->irq) {
1612                 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1613                                 hcd->driver->description, hcd->self.busnum);
1614                 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1615                                 hcd->irq_descr, hcd)) != 0) {
1616                         dev_err(hcd->self.controller,
1617                                         "request interrupt %d failed\n", irqnum);
1618                         goto err_request_irq;
1619                 }
1620                 hcd->irq = irqnum;
1621                 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1622                                 (hcd->driver->flags & HCD_MEMORY) ?
1623                                         "io mem" : "io base",
1624                                         (unsigned long long)hcd->rsrc_start);
1625         } else {
1626                 hcd->irq = -1;
1627                 if (hcd->rsrc_start)
1628                         dev_info(hcd->self.controller, "%s 0x%08llx\n",
1629                                         (hcd->driver->flags & HCD_MEMORY) ?
1630                                         "io mem" : "io base",
1631                                         (unsigned long long)hcd->rsrc_start);
1632         }
1633
1634         if ((retval = hcd->driver->start(hcd)) < 0) {
1635                 dev_err(hcd->self.controller, "startup error %d\n", retval);
1636                 goto err_hcd_driver_start;
1637         }
1638
1639         /* starting here, usbcore will pay attention to this root hub */
1640         rhdev->bus_mA = min(500u, hcd->power_budget);
1641         if ((retval = register_root_hub(hcd)) != 0)
1642                 goto err_register_root_hub;
1643
1644         if (hcd->uses_new_polling && hcd->poll_rh)
1645                 usb_hcd_poll_rh_status(hcd);
1646         return retval;
1647
1648 err_register_root_hub:
1649         hcd->driver->stop(hcd);
1650 err_hcd_driver_start:
1651         if (hcd->irq >= 0)
1652                 free_irq(irqnum, hcd);
1653 err_request_irq:
1654 err_hcd_driver_setup:
1655         hcd->self.root_hub = NULL;
1656         usb_put_dev(rhdev);
1657 err_allocate_root_hub:
1658         usb_deregister_bus(&hcd->self);
1659 err_register_bus:
1660         hcd_buffer_destroy(hcd);
1661         return retval;
1662
1663 EXPORT_SYMBOL (usb_add_hcd);
1664
1665 /**
1666  * usb_remove_hcd - shutdown processing for generic HCDs
1667  * @hcd: the usb_hcd structure to remove
1668  * Context: !in_interrupt()
1669  *
1670  * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1671  * invoking the HCD's stop() method.
1672  */
1673 void usb_remove_hcd(struct usb_hcd *hcd)
1674 {
1675         dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1676
1677         if (HC_IS_RUNNING (hcd->state))
1678                 hcd->state = HC_STATE_QUIESCING;
1679
1680         dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1681         spin_lock_irq (&hcd_root_hub_lock);
1682         hcd->rh_registered = 0;
1683         spin_unlock_irq (&hcd_root_hub_lock);
1684
1685 #ifdef CONFIG_PM
1686         cancel_work_sync(&hcd->wakeup_work);
1687 #endif
1688
1689         mutex_lock(&usb_bus_list_lock);
1690         usb_disconnect(&hcd->self.root_hub);
1691         mutex_unlock(&usb_bus_list_lock);
1692
1693         hcd->driver->stop(hcd);
1694         hcd->state = HC_STATE_HALT;
1695
1696         hcd->poll_rh = 0;
1697         del_timer_sync(&hcd->rh_timer);
1698
1699         if (hcd->irq >= 0)
1700                 free_irq(hcd->irq, hcd);
1701         usb_deregister_bus(&hcd->self);
1702         hcd_buffer_destroy(hcd);
1703 }
1704 EXPORT_SYMBOL (usb_remove_hcd);
1705
1706 void
1707 usb_hcd_platform_shutdown(struct platform_device* dev)
1708 {
1709         struct usb_hcd *hcd = platform_get_drvdata(dev);
1710
1711         if (hcd->driver->shutdown)
1712                 hcd->driver->shutdown(hcd);
1713 }
1714 EXPORT_SYMBOL (usb_hcd_platform_shutdown);
1715
1716 /*-------------------------------------------------------------------------*/
1717
1718 #if defined(CONFIG_USB_MON)
1719
1720 struct usb_mon_operations *mon_ops;
1721
1722 /*
1723  * The registration is unlocked.
1724  * We do it this way because we do not want to lock in hot paths.
1725  *
1726  * Notice that the code is minimally error-proof. Because usbmon needs
1727  * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1728  */
1729  
1730 int usb_mon_register (struct usb_mon_operations *ops)
1731 {
1732
1733         if (mon_ops)
1734                 return -EBUSY;
1735
1736         mon_ops = ops;
1737         mb();
1738         return 0;
1739 }
1740 EXPORT_SYMBOL_GPL (usb_mon_register);
1741
1742 void usb_mon_deregister (void)
1743 {
1744
1745         if (mon_ops == NULL) {
1746                 printk(KERN_ERR "USB: monitor was not registered\n");
1747                 return;
1748         }
1749         mon_ops = NULL;
1750         mb();
1751 }
1752 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1753
1754 #endif /* CONFIG_USB_MON */