5e5f65a475ab95c2d50b372d70d4f5533ad98f6e
[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/config.h>
26 #include <linux/module.h>
27 #include <linux/version.h>
28 #include <linux/kernel.h>
29 #include <linux/slab.h>
30 #include <linux/completion.h>
31 #include <linux/utsname.h>
32 #include <linux/mm.h>
33 #include <asm/io.h>
34 #include <asm/scatterlist.h>
35 #include <linux/device.h>
36 #include <linux/dma-mapping.h>
37 #include <asm/irq.h>
38 #include <asm/byteorder.h>
39
40 #include <linux/usb.h>
41
42 #include "usb.h"
43 #include "hcd.h"
44 #include "hub.h"
45
46
47 // #define USB_BANDWIDTH_MESSAGES
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 DECLARE_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 hcd data */
103 static DEFINE_SPINLOCK(hcd_data_lock);
104
105 /* wait queue for synchronous unlinks */
106 DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
107
108 /*-------------------------------------------------------------------------*/
109
110 /*
111  * Sharable chunks of root hub code.
112  */
113
114 /*-------------------------------------------------------------------------*/
115
116 #define KERNEL_REL      ((LINUX_VERSION_CODE >> 16) & 0x0ff)
117 #define KERNEL_VER      ((LINUX_VERSION_CODE >> 8) & 0x0ff)
118
119 /* usb 2.0 root hub device descriptor */
120 static const u8 usb2_rh_dev_descriptor [18] = {
121         0x12,       /*  __u8  bLength; */
122         0x01,       /*  __u8  bDescriptorType; Device */
123         0x00, 0x02, /*  __le16 bcdUSB; v2.0 */
124
125         0x09,       /*  __u8  bDeviceClass; HUB_CLASSCODE */
126         0x00,       /*  __u8  bDeviceSubClass; */
127         0x01,       /*  __u8  bDeviceProtocol; [ usb 2.0 single TT ]*/
128         0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
129
130         0x00, 0x00, /*  __le16 idVendor; */
131         0x00, 0x00, /*  __le16 idProduct; */
132         KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */
133
134         0x03,       /*  __u8  iManufacturer; */
135         0x02,       /*  __u8  iProduct; */
136         0x01,       /*  __u8  iSerialNumber; */
137         0x01        /*  __u8  bNumConfigurations; */
138 };
139
140 /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
141
142 /* usb 1.1 root hub device descriptor */
143 static const u8 usb11_rh_dev_descriptor [18] = {
144         0x12,       /*  __u8  bLength; */
145         0x01,       /*  __u8  bDescriptorType; Device */
146         0x10, 0x01, /*  __le16 bcdUSB; v1.1 */
147
148         0x09,       /*  __u8  bDeviceClass; HUB_CLASSCODE */
149         0x00,       /*  __u8  bDeviceSubClass; */
150         0x00,       /*  __u8  bDeviceProtocol; [ low/full speeds only ] */
151         0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
152
153         0x00, 0x00, /*  __le16 idVendor; */
154         0x00, 0x00, /*  __le16 idProduct; */
155         KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */
156
157         0x03,       /*  __u8  iManufacturer; */
158         0x02,       /*  __u8  iProduct; */
159         0x01,       /*  __u8  iSerialNumber; */
160         0x01        /*  __u8  bNumConfigurations; */
161 };
162
163
164 /*-------------------------------------------------------------------------*/
165
166 /* Configuration descriptors for our root hubs */
167
168 static const u8 fs_rh_config_descriptor [] = {
169
170         /* one configuration */
171         0x09,       /*  __u8  bLength; */
172         0x02,       /*  __u8  bDescriptorType; Configuration */
173         0x19, 0x00, /*  __le16 wTotalLength; */
174         0x01,       /*  __u8  bNumInterfaces; (1) */
175         0x01,       /*  __u8  bConfigurationValue; */
176         0x00,       /*  __u8  iConfiguration; */
177         0xc0,       /*  __u8  bmAttributes; 
178                                  Bit 7: must be set,
179                                      6: Self-powered,
180                                      5: Remote wakeup,
181                                      4..0: resvd */
182         0x00,       /*  __u8  MaxPower; */
183       
184         /* USB 1.1:
185          * USB 2.0, single TT organization (mandatory):
186          *      one interface, protocol 0
187          *
188          * USB 2.0, multiple TT organization (optional):
189          *      two interfaces, protocols 1 (like single TT)
190          *      and 2 (multiple TT mode) ... config is
191          *      sometimes settable
192          *      NOT IMPLEMENTED
193          */
194
195         /* one interface */
196         0x09,       /*  __u8  if_bLength; */
197         0x04,       /*  __u8  if_bDescriptorType; Interface */
198         0x00,       /*  __u8  if_bInterfaceNumber; */
199         0x00,       /*  __u8  if_bAlternateSetting; */
200         0x01,       /*  __u8  if_bNumEndpoints; */
201         0x09,       /*  __u8  if_bInterfaceClass; HUB_CLASSCODE */
202         0x00,       /*  __u8  if_bInterfaceSubClass; */
203         0x00,       /*  __u8  if_bInterfaceProtocol; [usb1.1 or single tt] */
204         0x00,       /*  __u8  if_iInterface; */
205      
206         /* one endpoint (status change endpoint) */
207         0x07,       /*  __u8  ep_bLength; */
208         0x05,       /*  __u8  ep_bDescriptorType; Endpoint */
209         0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
210         0x03,       /*  __u8  ep_bmAttributes; Interrupt */
211         0x02, 0x00, /*  __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
212         0xff        /*  __u8  ep_bInterval; (255ms -- usb 2.0 spec) */
213 };
214
215 static const u8 hs_rh_config_descriptor [] = {
216
217         /* one configuration */
218         0x09,       /*  __u8  bLength; */
219         0x02,       /*  __u8  bDescriptorType; Configuration */
220         0x19, 0x00, /*  __le16 wTotalLength; */
221         0x01,       /*  __u8  bNumInterfaces; (1) */
222         0x01,       /*  __u8  bConfigurationValue; */
223         0x00,       /*  __u8  iConfiguration; */
224         0xc0,       /*  __u8  bmAttributes; 
225                                  Bit 7: must be set,
226                                      6: Self-powered,
227                                      5: Remote wakeup,
228                                      4..0: resvd */
229         0x00,       /*  __u8  MaxPower; */
230       
231         /* USB 1.1:
232          * USB 2.0, single TT organization (mandatory):
233          *      one interface, protocol 0
234          *
235          * USB 2.0, multiple TT organization (optional):
236          *      two interfaces, protocols 1 (like single TT)
237          *      and 2 (multiple TT mode) ... config is
238          *      sometimes settable
239          *      NOT IMPLEMENTED
240          */
241
242         /* one interface */
243         0x09,       /*  __u8  if_bLength; */
244         0x04,       /*  __u8  if_bDescriptorType; Interface */
245         0x00,       /*  __u8  if_bInterfaceNumber; */
246         0x00,       /*  __u8  if_bAlternateSetting; */
247         0x01,       /*  __u8  if_bNumEndpoints; */
248         0x09,       /*  __u8  if_bInterfaceClass; HUB_CLASSCODE */
249         0x00,       /*  __u8  if_bInterfaceSubClass; */
250         0x00,       /*  __u8  if_bInterfaceProtocol; [usb1.1 or single tt] */
251         0x00,       /*  __u8  if_iInterface; */
252      
253         /* one endpoint (status change endpoint) */
254         0x07,       /*  __u8  ep_bLength; */
255         0x05,       /*  __u8  ep_bDescriptorType; Endpoint */
256         0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
257         0x03,       /*  __u8  ep_bmAttributes; Interrupt */
258         0x02, 0x00, /*  __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
259         0x0c        /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */
260 };
261
262 /*-------------------------------------------------------------------------*/
263
264 /*
265  * helper routine for returning string descriptors in UTF-16LE
266  * input can actually be ISO-8859-1; ASCII is its 7-bit subset
267  */
268 static int ascii2utf (char *s, u8 *utf, int utfmax)
269 {
270         int retval;
271
272         for (retval = 0; *s && utfmax > 1; utfmax -= 2, retval += 2) {
273                 *utf++ = *s++;
274                 *utf++ = 0;
275         }
276         if (utfmax > 0) {
277                 *utf = *s;
278                 ++retval;
279         }
280         return retval;
281 }
282
283 /*
284  * rh_string - provides manufacturer, product and serial strings for root hub
285  * @id: the string ID number (1: serial number, 2: product, 3: vendor)
286  * @hcd: the host controller for this root hub
287  * @type: string describing our driver 
288  * @data: return packet in UTF-16 LE
289  * @len: length of the return packet
290  *
291  * Produces either a manufacturer, product or serial number string for the
292  * virtual root hub device.
293  */
294 static int rh_string (
295         int             id,
296         struct usb_hcd  *hcd,
297         u8              *data,
298         int             len
299 ) {
300         char buf [100];
301
302         // language ids
303         if (id == 0) {
304                 buf[0] = 4;    buf[1] = 3;      /* 4 bytes string data */
305                 buf[2] = 0x09; buf[3] = 0x04;   /* MSFT-speak for "en-us" */
306                 len = min (len, 4);
307                 memcpy (data, buf, len);
308                 return len;
309
310         // serial number
311         } else if (id == 1) {
312                 strlcpy (buf, hcd->self.bus_name, sizeof buf);
313
314         // product description
315         } else if (id == 2) {
316                 strlcpy (buf, hcd->product_desc, sizeof buf);
317
318         // id 3 == vendor description
319         } else if (id == 3) {
320                 snprintf (buf, sizeof buf, "%s %s %s", system_utsname.sysname,
321                         system_utsname.release, hcd->driver->description);
322
323         // unsupported IDs --> "protocol stall"
324         } else
325                 return -EPIPE;
326
327         switch (len) {          /* All cases fall through */
328         default:
329                 len = 2 + ascii2utf (buf, data + 2, len - 2);
330         case 2:
331                 data [1] = 3;   /* type == string */
332         case 1:
333                 data [0] = 2 * (strlen (buf) + 1);
334         case 0:
335                 ;               /* Compiler wants a statement here */
336         }
337         return len;
338 }
339
340
341 /* Root hub control transfers execute synchronously */
342 static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
343 {
344         struct usb_ctrlrequest *cmd;
345         u16             typeReq, wValue, wIndex, wLength;
346         u8              *ubuf = urb->transfer_buffer;
347         u8              tbuf [sizeof (struct usb_hub_descriptor)];
348         const u8        *bufp = tbuf;
349         int             len = 0;
350         int             patch_wakeup = 0;
351         unsigned long   flags;
352         int             status = 0;
353         int             n;
354
355         cmd = (struct usb_ctrlrequest *) urb->setup_packet;
356         typeReq  = (cmd->bRequestType << 8) | cmd->bRequest;
357         wValue   = le16_to_cpu (cmd->wValue);
358         wIndex   = le16_to_cpu (cmd->wIndex);
359         wLength  = le16_to_cpu (cmd->wLength);
360
361         if (wLength > urb->transfer_buffer_length)
362                 goto error;
363
364         urb->actual_length = 0;
365         switch (typeReq) {
366
367         /* DEVICE REQUESTS */
368
369         case DeviceRequest | USB_REQ_GET_STATUS:
370                 tbuf [0] = (hcd->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP)
371                                 | (1 << USB_DEVICE_SELF_POWERED);
372                 tbuf [1] = 0;
373                 len = 2;
374                 break;
375         case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
376                 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
377                         hcd->remote_wakeup = 0;
378                 else
379                         goto error;
380                 break;
381         case DeviceOutRequest | USB_REQ_SET_FEATURE:
382                 if (hcd->can_wakeup && wValue == USB_DEVICE_REMOTE_WAKEUP)
383                         hcd->remote_wakeup = 1;
384                 else
385                         goto error;
386                 break;
387         case DeviceRequest | USB_REQ_GET_CONFIGURATION:
388                 tbuf [0] = 1;
389                 len = 1;
390                         /* FALLTHROUGH */
391         case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
392                 break;
393         case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
394                 switch (wValue & 0xff00) {
395                 case USB_DT_DEVICE << 8:
396                         if (hcd->driver->flags & HCD_USB2)
397                                 bufp = usb2_rh_dev_descriptor;
398                         else if (hcd->driver->flags & HCD_USB11)
399                                 bufp = usb11_rh_dev_descriptor;
400                         else
401                                 goto error;
402                         len = 18;
403                         break;
404                 case USB_DT_CONFIG << 8:
405                         if (hcd->driver->flags & HCD_USB2) {
406                                 bufp = hs_rh_config_descriptor;
407                                 len = sizeof hs_rh_config_descriptor;
408                         } else {
409                                 bufp = fs_rh_config_descriptor;
410                                 len = sizeof fs_rh_config_descriptor;
411                         }
412                         if (hcd->can_wakeup)
413                                 patch_wakeup = 1;
414                         break;
415                 case USB_DT_STRING << 8:
416                         n = rh_string (wValue & 0xff, hcd, ubuf, wLength);
417                         if (n < 0)
418                                 goto error;
419                         urb->actual_length = n;
420                         break;
421                 default:
422                         goto error;
423                 }
424                 break;
425         case DeviceRequest | USB_REQ_GET_INTERFACE:
426                 tbuf [0] = 0;
427                 len = 1;
428                         /* FALLTHROUGH */
429         case DeviceOutRequest | USB_REQ_SET_INTERFACE:
430                 break;
431         case DeviceOutRequest | USB_REQ_SET_ADDRESS:
432                 // wValue == urb->dev->devaddr
433                 dev_dbg (hcd->self.controller, "root hub device address %d\n",
434                         wValue);
435                 break;
436
437         /* INTERFACE REQUESTS (no defined feature/status flags) */
438
439         /* ENDPOINT REQUESTS */
440
441         case EndpointRequest | USB_REQ_GET_STATUS:
442                 // ENDPOINT_HALT flag
443                 tbuf [0] = 0;
444                 tbuf [1] = 0;
445                 len = 2;
446                         /* FALLTHROUGH */
447         case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
448         case EndpointOutRequest | USB_REQ_SET_FEATURE:
449                 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
450                 break;
451
452         /* CLASS REQUESTS (and errors) */
453
454         default:
455                 /* non-generic request */
456                 switch (typeReq) {
457                 case GetHubStatus:
458                 case GetPortStatus:
459                         len = 4;
460                         break;
461                 case GetHubDescriptor:
462                         len = sizeof (struct usb_hub_descriptor);
463                         break;
464                 }
465                 status = hcd->driver->hub_control (hcd,
466                         typeReq, wValue, wIndex,
467                         tbuf, wLength);
468                 break;
469 error:
470                 /* "protocol stall" on error */
471                 status = -EPIPE;
472         }
473
474         if (status) {
475                 len = 0;
476                 if (status != -EPIPE) {
477                         dev_dbg (hcd->self.controller,
478                                 "CTRL: TypeReq=0x%x val=0x%x "
479                                 "idx=0x%x len=%d ==> %d\n",
480                                 typeReq, wValue, wIndex,
481                                 wLength, status);
482                 }
483         }
484         if (len) {
485                 if (urb->transfer_buffer_length < len)
486                         len = urb->transfer_buffer_length;
487                 urb->actual_length = len;
488                 // always USB_DIR_IN, toward host
489                 memcpy (ubuf, bufp, len);
490
491                 /* report whether RH hardware supports remote wakeup */
492                 if (patch_wakeup &&
493                                 len > offsetof (struct usb_config_descriptor,
494                                                 bmAttributes))
495                         ((struct usb_config_descriptor *)ubuf)->bmAttributes
496                                 |= USB_CONFIG_ATT_WAKEUP;
497         }
498
499         /* any errors get returned through the urb completion */
500         local_irq_save (flags);
501         spin_lock (&urb->lock);
502         if (urb->status == -EINPROGRESS)
503                 urb->status = status;
504         spin_unlock (&urb->lock);
505         usb_hcd_giveback_urb (hcd, urb, NULL);
506         local_irq_restore (flags);
507         return 0;
508 }
509
510 /*-------------------------------------------------------------------------*/
511
512 /*
513  * Root Hub interrupt transfers are polled using a timer if the
514  * driver requests it; otherwise the driver is responsible for
515  * calling usb_hcd_poll_rh_status() when an event occurs.
516  *
517  * Completions are called in_interrupt(), but they may or may not
518  * be in_irq().
519  */
520 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
521 {
522         struct urb      *urb;
523         int             length;
524         unsigned long   flags;
525         char            buffer[4];      /* Any root hubs with > 31 ports? */
526
527         if (!hcd->uses_new_polling && !hcd->status_urb)
528                 return;
529
530         length = hcd->driver->hub_status_data(hcd, buffer);
531         if (length > 0) {
532
533                 /* try to complete the status urb */
534                 local_irq_save (flags);
535                 spin_lock(&hcd_root_hub_lock);
536                 urb = hcd->status_urb;
537                 if (urb) {
538                         spin_lock(&urb->lock);
539                         if (urb->status == -EINPROGRESS) {
540                                 hcd->poll_pending = 0;
541                                 hcd->status_urb = NULL;
542                                 urb->status = 0;
543                                 urb->hcpriv = NULL;
544                                 urb->actual_length = length;
545                                 memcpy(urb->transfer_buffer, buffer, length);
546                         } else          /* urb has been unlinked */
547                                 length = 0;
548                         spin_unlock(&urb->lock);
549                 } else
550                         length = 0;
551                 spin_unlock(&hcd_root_hub_lock);
552
553                 /* local irqs are always blocked in completions */
554                 if (length > 0)
555                         usb_hcd_giveback_urb (hcd, urb, NULL);
556                 else
557                         hcd->poll_pending = 1;
558                 local_irq_restore (flags);
559         }
560
561         /* The USB 2.0 spec says 256 ms.  This is close enough and won't
562          * exceed that limit if HZ is 100. */
563         if (hcd->uses_new_polling ? hcd->poll_rh :
564                         (length == 0 && hcd->status_urb != NULL))
565                 mod_timer (&hcd->rh_timer, jiffies + msecs_to_jiffies(250));
566 }
567 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
568
569 /* timer callback */
570 static void rh_timer_func (unsigned long _hcd)
571 {
572         usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
573 }
574
575 /*-------------------------------------------------------------------------*/
576
577 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
578 {
579         int             retval;
580         unsigned long   flags;
581         int             len = 1 + (urb->dev->maxchild / 8);
582
583         spin_lock_irqsave (&hcd_root_hub_lock, flags);
584         if (urb->status != -EINPROGRESS)        /* already unlinked */
585                 retval = urb->status;
586         else if (hcd->status_urb || urb->transfer_buffer_length < len) {
587                 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
588                 retval = -EINVAL;
589         } else {
590                 hcd->status_urb = urb;
591                 urb->hcpriv = hcd;      /* indicate it's queued */
592
593                 if (!hcd->uses_new_polling)
594                         mod_timer (&hcd->rh_timer, jiffies +
595                                         msecs_to_jiffies(250));
596
597                 /* If a status change has already occurred, report it ASAP */
598                 else if (hcd->poll_pending)
599                         mod_timer (&hcd->rh_timer, jiffies);
600                 retval = 0;
601         }
602         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
603         return retval;
604 }
605
606 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
607 {
608         if (usb_pipeint (urb->pipe))
609                 return rh_queue_status (hcd, urb);
610         if (usb_pipecontrol (urb->pipe))
611                 return rh_call_control (hcd, urb);
612         return -EINVAL;
613 }
614
615 /*-------------------------------------------------------------------------*/
616
617 /* Asynchronous unlinks of root-hub control URBs are legal, but they
618  * don't do anything.  Status URB unlinks must be made in process context
619  * with interrupts enabled.
620  */
621 static int usb_rh_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
622 {
623         if (usb_pipeendpoint(urb->pipe) == 0) { /* Control URB */
624                 if (in_interrupt())
625                         return 0;               /* nothing to do */
626
627                 spin_lock_irq(&urb->lock);      /* from usb_kill_urb */
628                 ++urb->reject;
629                 spin_unlock_irq(&urb->lock);
630
631                 wait_event(usb_kill_urb_queue,
632                                 atomic_read(&urb->use_count) == 0);
633
634                 spin_lock_irq(&urb->lock);
635                 --urb->reject;
636                 spin_unlock_irq(&urb->lock);
637
638         } else {                                /* Status URB */
639                 if (!hcd->uses_new_polling)
640                         del_timer_sync (&hcd->rh_timer);
641                 local_irq_disable ();
642                 spin_lock (&hcd_root_hub_lock);
643                 if (urb == hcd->status_urb) {
644                         hcd->status_urb = NULL;
645                         urb->hcpriv = NULL;
646                 } else
647                         urb = NULL;             /* wasn't fully queued */
648                 spin_unlock (&hcd_root_hub_lock);
649                 if (urb)
650                         usb_hcd_giveback_urb (hcd, urb, NULL);
651                 local_irq_enable ();
652         }
653
654         return 0;
655 }
656
657 /*-------------------------------------------------------------------------*/
658
659 /* exported only within usbcore */
660 struct usb_bus *usb_bus_get(struct usb_bus *bus)
661 {
662         if (bus)
663                 kref_get(&bus->kref);
664         return bus;
665 }
666
667 static void usb_host_release(struct kref *kref)
668 {
669         struct usb_bus *bus = container_of(kref, struct usb_bus, kref);
670
671         if (bus->release)
672                 bus->release(bus);
673 }
674
675 /* exported only within usbcore */
676 void usb_bus_put(struct usb_bus *bus)
677 {
678         if (bus)
679                 kref_put(&bus->kref, usb_host_release);
680 }
681
682 /*-------------------------------------------------------------------------*/
683
684 static struct class *usb_host_class;
685
686 int usb_host_init(void)
687 {
688         int retval = 0;
689
690         usb_host_class = class_create(THIS_MODULE, "usb_host");
691         if (IS_ERR(usb_host_class))
692                 retval = PTR_ERR(usb_host_class);
693         return retval;
694 }
695
696 void usb_host_cleanup(void)
697 {
698         class_destroy(usb_host_class);
699 }
700
701 /**
702  * usb_bus_init - shared initialization code
703  * @bus: the bus structure being initialized
704  *
705  * This code is used to initialize a usb_bus structure, memory for which is
706  * separately managed.
707  */
708 static void usb_bus_init (struct usb_bus *bus)
709 {
710         memset (&bus->devmap, 0, sizeof(struct usb_devmap));
711
712         bus->devnum_next = 1;
713
714         bus->root_hub = NULL;
715         bus->hcpriv = NULL;
716         bus->busnum = -1;
717         bus->bandwidth_allocated = 0;
718         bus->bandwidth_int_reqs  = 0;
719         bus->bandwidth_isoc_reqs = 0;
720
721         INIT_LIST_HEAD (&bus->bus_list);
722
723         kref_init(&bus->kref);
724 }
725
726 /**
727  * usb_alloc_bus - creates a new USB host controller structure
728  * @op: pointer to a struct usb_operations that this bus structure should use
729  * Context: !in_interrupt()
730  *
731  * Creates a USB host controller bus structure with the specified 
732  * usb_operations and initializes all the necessary internal objects.
733  *
734  * If no memory is available, NULL is returned.
735  *
736  * The caller should call usb_put_bus() when it is finished with the structure.
737  */
738 struct usb_bus *usb_alloc_bus (struct usb_operations *op)
739 {
740         struct usb_bus *bus;
741
742         bus = kzalloc (sizeof *bus, GFP_KERNEL);
743         if (!bus)
744                 return NULL;
745         usb_bus_init (bus);
746         bus->op = op;
747         return bus;
748 }
749
750 /*-------------------------------------------------------------------------*/
751
752 /**
753  * usb_register_bus - registers the USB host controller with the usb core
754  * @bus: pointer to the bus to register
755  * Context: !in_interrupt()
756  *
757  * Assigns a bus number, and links the controller into usbcore data
758  * structures so that it can be seen by scanning the bus list.
759  */
760 static int usb_register_bus(struct usb_bus *bus)
761 {
762         int busnum;
763
764         down (&usb_bus_list_lock);
765         busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
766         if (busnum < USB_MAXBUS) {
767                 set_bit (busnum, busmap.busmap);
768                 bus->busnum = busnum;
769         } else {
770                 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
771                 up(&usb_bus_list_lock);
772                 return -E2BIG;
773         }
774
775         bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
776                                              bus->controller, "usb_host%d", busnum);
777         if (IS_ERR(bus->class_dev)) {
778                 clear_bit(busnum, busmap.busmap);
779                 up(&usb_bus_list_lock);
780                 return PTR_ERR(bus->class_dev);
781         }
782
783         class_set_devdata(bus->class_dev, bus);
784
785         /* Add it to the local list of buses */
786         list_add (&bus->bus_list, &usb_bus_list);
787         up (&usb_bus_list_lock);
788
789         usb_notify_add_bus(bus);
790
791         dev_info (bus->controller, "new USB bus registered, assigned bus number %d\n", bus->busnum);
792         return 0;
793 }
794
795 /**
796  * usb_deregister_bus - deregisters the USB host controller
797  * @bus: pointer to the bus to deregister
798  * Context: !in_interrupt()
799  *
800  * Recycles the bus number, and unlinks the controller from usbcore data
801  * structures so that it won't be seen by scanning the bus list.
802  */
803 static void usb_deregister_bus (struct usb_bus *bus)
804 {
805         dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
806
807         /*
808          * NOTE: make sure that all the devices are removed by the
809          * controller code, as well as having it call this when cleaning
810          * itself up
811          */
812         down (&usb_bus_list_lock);
813         list_del (&bus->bus_list);
814         up (&usb_bus_list_lock);
815
816         usb_notify_remove_bus(bus);
817
818         clear_bit (bus->busnum, busmap.busmap);
819
820         class_device_unregister(bus->class_dev);
821 }
822
823 /**
824  * register_root_hub - called by usb_add_hcd() to register a root hub
825  * @usb_dev: the usb root hub device to be registered.
826  * @hcd: host controller for this root hub
827  *
828  * This function registers the root hub with the USB subsystem.  It sets up
829  * the device properly in the device tree and stores the root_hub pointer
830  * in the bus structure, then calls usb_new_device() to register the usb
831  * device.  It also assigns the root hub's USB address (always 1).
832  */
833 static int register_root_hub (struct usb_device *usb_dev,
834                 struct usb_hcd *hcd)
835 {
836         struct device *parent_dev = hcd->self.controller;
837         const int devnum = 1;
838         int retval;
839
840         usb_dev->devnum = devnum;
841         usb_dev->bus->devnum_next = devnum + 1;
842         memset (&usb_dev->bus->devmap.devicemap, 0,
843                         sizeof usb_dev->bus->devmap.devicemap);
844         set_bit (devnum, usb_dev->bus->devmap.devicemap);
845         usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
846
847         down (&usb_bus_list_lock);
848         usb_dev->bus->root_hub = usb_dev;
849
850         usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
851         retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
852         if (retval != sizeof usb_dev->descriptor) {
853                 usb_dev->bus->root_hub = NULL;
854                 up (&usb_bus_list_lock);
855                 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
856                                 usb_dev->dev.bus_id, retval);
857                 return (retval < 0) ? retval : -EMSGSIZE;
858         }
859
860         usb_lock_device (usb_dev);
861         retval = usb_new_device (usb_dev);
862         usb_unlock_device (usb_dev);
863         if (retval) {
864                 usb_dev->bus->root_hub = NULL;
865                 dev_err (parent_dev, "can't register root hub for %s, %d\n",
866                                 usb_dev->dev.bus_id, retval);
867         }
868         up (&usb_bus_list_lock);
869
870         if (retval == 0) {
871                 spin_lock_irq (&hcd_root_hub_lock);
872                 hcd->rh_registered = 1;
873                 spin_unlock_irq (&hcd_root_hub_lock);
874
875                 /* Did the HC die before the root hub was registered? */
876                 if (hcd->state == HC_STATE_HALT)
877                         usb_hc_died (hcd);      /* This time clean up */
878         }
879
880         return retval;
881 }
882
883 void usb_enable_root_hub_irq (struct usb_bus *bus)
884 {
885         struct usb_hcd *hcd;
886
887         hcd = container_of (bus, struct usb_hcd, self);
888         if (hcd->driver->hub_irq_enable && !hcd->poll_rh &&
889                         hcd->state != HC_STATE_HALT)
890                 hcd->driver->hub_irq_enable (hcd);
891 }
892
893
894 /*-------------------------------------------------------------------------*/
895
896 /**
897  * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
898  * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
899  * @is_input: true iff the transaction sends data to the host
900  * @isoc: true for isochronous transactions, false for interrupt ones
901  * @bytecount: how many bytes in the transaction.
902  *
903  * Returns approximate bus time in nanoseconds for a periodic transaction.
904  * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
905  * scheduled in software, this function is only used for such scheduling.
906  */
907 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
908 {
909         unsigned long   tmp;
910
911         switch (speed) {
912         case USB_SPEED_LOW:     /* INTR only */
913                 if (is_input) {
914                         tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
915                         return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
916                 } else {
917                         tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
918                         return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
919                 }
920         case USB_SPEED_FULL:    /* ISOC or INTR */
921                 if (isoc) {
922                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
923                         return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
924                 } else {
925                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
926                         return (9107L + BW_HOST_DELAY + tmp);
927                 }
928         case USB_SPEED_HIGH:    /* ISOC or INTR */
929                 // FIXME adjust for input vs output
930                 if (isoc)
931                         tmp = HS_NSECS_ISO (bytecount);
932                 else
933                         tmp = HS_NSECS (bytecount);
934                 return tmp;
935         default:
936                 pr_debug ("%s: bogus device speed!\n", usbcore_name);
937                 return -1;
938         }
939 }
940 EXPORT_SYMBOL (usb_calc_bus_time);
941
942 /*
943  * usb_check_bandwidth():
944  *
945  * old_alloc is from host_controller->bandwidth_allocated in microseconds;
946  * bustime is from calc_bus_time(), but converted to microseconds.
947  *
948  * returns <bustime in us> if successful,
949  * or -ENOSPC if bandwidth request fails.
950  *
951  * FIXME:
952  * This initial implementation does not use Endpoint.bInterval
953  * in managing bandwidth allocation.
954  * It probably needs to be expanded to use Endpoint.bInterval.
955  * This can be done as a later enhancement (correction).
956  *
957  * This will also probably require some kind of
958  * frame allocation tracking...meaning, for example,
959  * that if multiple drivers request interrupts every 10 USB frames,
960  * they don't all have to be allocated at
961  * frame numbers N, N+10, N+20, etc.  Some of them could be at
962  * N+11, N+21, N+31, etc., and others at
963  * N+12, N+22, N+32, etc.
964  *
965  * Similarly for isochronous transfers...
966  *
967  * Individual HCDs can schedule more directly ... this logic
968  * is not correct for high speed transfers.
969  */
970 int usb_check_bandwidth (struct usb_device *dev, struct urb *urb)
971 {
972         unsigned int    pipe = urb->pipe;
973         long            bustime;
974         int             is_in = usb_pipein (pipe);
975         int             is_iso = usb_pipeisoc (pipe);
976         int             old_alloc = dev->bus->bandwidth_allocated;
977         int             new_alloc;
978
979
980         bustime = NS_TO_US (usb_calc_bus_time (dev->speed, is_in, is_iso,
981                         usb_maxpacket (dev, pipe, !is_in)));
982         if (is_iso)
983                 bustime /= urb->number_of_packets;
984
985         new_alloc = old_alloc + (int) bustime;
986         if (new_alloc > FRAME_TIME_MAX_USECS_ALLOC) {
987 #ifdef  DEBUG
988                 char    *mode = 
989 #ifdef CONFIG_USB_BANDWIDTH
990                         "";
991 #else
992                         "would have ";
993 #endif
994                 dev_dbg (&dev->dev, "usb_check_bandwidth %sFAILED: %d + %ld = %d usec\n",
995                         mode, old_alloc, bustime, new_alloc);
996 #endif
997 #ifdef CONFIG_USB_BANDWIDTH
998                 bustime = -ENOSPC;      /* report error */
999 #endif
1000         }
1001
1002         return bustime;
1003 }
1004 EXPORT_SYMBOL (usb_check_bandwidth);
1005
1006
1007 /**
1008  * usb_claim_bandwidth - records bandwidth for a periodic transfer
1009  * @dev: source/target of request
1010  * @urb: request (urb->dev == dev)
1011  * @bustime: bandwidth consumed, in (average) microseconds per frame
1012  * @isoc: true iff the request is isochronous
1013  *
1014  * Bus bandwidth reservations are recorded purely for diagnostic purposes.
1015  * HCDs are expected not to overcommit periodic bandwidth, and to record such
1016  * reservations whenever endpoints are added to the periodic schedule.
1017  *
1018  * FIXME averaging per-frame is suboptimal.  Better to sum over the HCD's
1019  * entire periodic schedule ... 32 frames for OHCI, 1024 for UHCI, settable
1020  * for EHCI (256/512/1024 frames, default 1024) and have the bus expose how
1021  * large its periodic schedule is.
1022  */
1023 void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb, int bustime, int isoc)
1024 {
1025         dev->bus->bandwidth_allocated += bustime;
1026         if (isoc)
1027                 dev->bus->bandwidth_isoc_reqs++;
1028         else
1029                 dev->bus->bandwidth_int_reqs++;
1030         urb->bandwidth = bustime;
1031
1032 #ifdef USB_BANDWIDTH_MESSAGES
1033         dev_dbg (&dev->dev, "bandwidth alloc increased by %d (%s) to %d for %d requesters\n",
1034                 bustime,
1035                 isoc ? "ISOC" : "INTR",
1036                 dev->bus->bandwidth_allocated,
1037                 dev->bus->bandwidth_int_reqs + dev->bus->bandwidth_isoc_reqs);
1038 #endif
1039 }
1040 EXPORT_SYMBOL (usb_claim_bandwidth);
1041
1042
1043 /**
1044  * usb_release_bandwidth - reverses effect of usb_claim_bandwidth()
1045  * @dev: source/target of request
1046  * @urb: request (urb->dev == dev)
1047  * @isoc: true iff the request is isochronous
1048  *
1049  * This records that previously allocated bandwidth has been released.
1050  * Bandwidth is released when endpoints are removed from the host controller's
1051  * periodic schedule.
1052  */
1053 void usb_release_bandwidth (struct usb_device *dev, struct urb *urb, int isoc)
1054 {
1055         dev->bus->bandwidth_allocated -= urb->bandwidth;
1056         if (isoc)
1057                 dev->bus->bandwidth_isoc_reqs--;
1058         else
1059                 dev->bus->bandwidth_int_reqs--;
1060
1061 #ifdef USB_BANDWIDTH_MESSAGES
1062         dev_dbg (&dev->dev, "bandwidth alloc reduced by %d (%s) to %d for %d requesters\n",
1063                 urb->bandwidth,
1064                 isoc ? "ISOC" : "INTR",
1065                 dev->bus->bandwidth_allocated,
1066                 dev->bus->bandwidth_int_reqs + dev->bus->bandwidth_isoc_reqs);
1067 #endif
1068         urb->bandwidth = 0;
1069 }
1070 EXPORT_SYMBOL (usb_release_bandwidth);
1071
1072
1073 /*-------------------------------------------------------------------------*/
1074
1075 /*
1076  * Generic HC operations.
1077  */
1078
1079 /*-------------------------------------------------------------------------*/
1080
1081 static void urb_unlink (struct urb *urb)
1082 {
1083         unsigned long           flags;
1084
1085         /* Release any periodic transfer bandwidth */
1086         if (urb->bandwidth)
1087                 usb_release_bandwidth (urb->dev, urb,
1088                         usb_pipeisoc (urb->pipe));
1089
1090         /* clear all state linking urb to this dev (and hcd) */
1091
1092         spin_lock_irqsave (&hcd_data_lock, flags);
1093         list_del_init (&urb->urb_list);
1094         spin_unlock_irqrestore (&hcd_data_lock, flags);
1095         usb_put_dev (urb->dev);
1096 }
1097
1098
1099 /* may be called in any context with a valid urb->dev usecount
1100  * caller surrenders "ownership" of urb
1101  * expects usb_submit_urb() to have sanity checked and conditioned all
1102  * inputs in the urb
1103  */
1104 static int hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1105 {
1106         int                     status;
1107         struct usb_hcd          *hcd = urb->dev->bus->hcpriv;
1108         struct usb_host_endpoint *ep;
1109         unsigned long           flags;
1110
1111         if (!hcd)
1112                 return -ENODEV;
1113
1114         usbmon_urb_submit(&hcd->self, urb);
1115
1116         /*
1117          * Atomically queue the urb,  first to our records, then to the HCD.
1118          * Access to urb->status is controlled by urb->lock ... changes on
1119          * i/o completion (normal or fault) or unlinking.
1120          */
1121
1122         // FIXME:  verify that quiescing hc works right (RH cleans up)
1123
1124         spin_lock_irqsave (&hcd_data_lock, flags);
1125         ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
1126                         [usb_pipeendpoint(urb->pipe)];
1127         if (unlikely (!ep))
1128                 status = -ENOENT;
1129         else if (unlikely (urb->reject))
1130                 status = -EPERM;
1131         else switch (hcd->state) {
1132         case HC_STATE_RUNNING:
1133         case HC_STATE_RESUMING:
1134 doit:
1135                 usb_get_dev (urb->dev);
1136                 list_add_tail (&urb->urb_list, &ep->urb_list);
1137                 status = 0;
1138                 break;
1139         case HC_STATE_SUSPENDED:
1140                 /* HC upstream links (register access, wakeup signaling) can work
1141                  * even when the downstream links (and DMA etc) are quiesced; let
1142                  * usbcore talk to the root hub.
1143                  */
1144                 if (hcd->self.controller->power.power_state.event == PM_EVENT_ON
1145                                 && urb->dev->parent == NULL)
1146                         goto doit;
1147                 /* FALL THROUGH */
1148         default:
1149                 status = -ESHUTDOWN;
1150                 break;
1151         }
1152         spin_unlock_irqrestore (&hcd_data_lock, flags);
1153         if (status) {
1154                 INIT_LIST_HEAD (&urb->urb_list);
1155                 usbmon_urb_submit_error(&hcd->self, urb, status);
1156                 return status;
1157         }
1158
1159         /* increment urb's reference count as part of giving it to the HCD
1160          * (which now controls it).  HCD guarantees that it either returns
1161          * an error or calls giveback(), but not both.
1162          */
1163         urb = usb_get_urb (urb);
1164         atomic_inc (&urb->use_count);
1165
1166         if (urb->dev == hcd->self.root_hub) {
1167                 /* NOTE:  requirement on hub callers (usbfs and the hub
1168                  * driver, for now) that URBs' urb->transfer_buffer be
1169                  * valid and usb_buffer_{sync,unmap}() not be needed, since
1170                  * they could clobber root hub response data.
1171                  */
1172                 status = rh_urb_enqueue (hcd, urb);
1173                 goto done;
1174         }
1175
1176         /* lower level hcd code should use *_dma exclusively,
1177          * unless it uses pio or talks to another transport.
1178          */
1179         if (hcd->self.controller->dma_mask) {
1180                 if (usb_pipecontrol (urb->pipe)
1181                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1182                         urb->setup_dma = dma_map_single (
1183                                         hcd->self.controller,
1184                                         urb->setup_packet,
1185                                         sizeof (struct usb_ctrlrequest),
1186                                         DMA_TO_DEVICE);
1187                 if (urb->transfer_buffer_length != 0
1188                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1189                         urb->transfer_dma = dma_map_single (
1190                                         hcd->self.controller,
1191                                         urb->transfer_buffer,
1192                                         urb->transfer_buffer_length,
1193                                         usb_pipein (urb->pipe)
1194                                             ? DMA_FROM_DEVICE
1195                                             : DMA_TO_DEVICE);
1196         }
1197
1198         status = hcd->driver->urb_enqueue (hcd, ep, urb, mem_flags);
1199 done:
1200         if (unlikely (status)) {
1201                 urb_unlink (urb);
1202                 atomic_dec (&urb->use_count);
1203                 if (urb->reject)
1204                         wake_up (&usb_kill_urb_queue);
1205                 usb_put_urb (urb);
1206                 usbmon_urb_submit_error(&hcd->self, urb, status);
1207         }
1208         return status;
1209 }
1210
1211 /*-------------------------------------------------------------------------*/
1212
1213 /* called in any context */
1214 static int hcd_get_frame_number (struct usb_device *udev)
1215 {
1216         struct usb_hcd  *hcd = (struct usb_hcd *)udev->bus->hcpriv;
1217         if (!HC_IS_RUNNING (hcd->state))
1218                 return -ESHUTDOWN;
1219         return hcd->driver->get_frame_number (hcd);
1220 }
1221
1222 /*-------------------------------------------------------------------------*/
1223
1224 /* this makes the hcd giveback() the urb more quickly, by kicking it
1225  * off hardware queues (which may take a while) and returning it as
1226  * soon as practical.  we've already set up the urb's return status,
1227  * but we can't know if the callback completed already.
1228  */
1229 static int
1230 unlink1 (struct usb_hcd *hcd, struct urb *urb)
1231 {
1232         int             value;
1233
1234         if (urb->dev == hcd->self.root_hub)
1235                 value = usb_rh_urb_dequeue (hcd, urb);
1236         else {
1237
1238                 /* The only reason an HCD might fail this call is if
1239                  * it has not yet fully queued the urb to begin with.
1240                  * Such failures should be harmless. */
1241                 value = hcd->driver->urb_dequeue (hcd, urb);
1242         }
1243
1244         if (value != 0)
1245                 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1246                                 urb, value);
1247         return value;
1248 }
1249
1250 /*
1251  * called in any context
1252  *
1253  * caller guarantees urb won't be recycled till both unlink()
1254  * and the urb's completion function return
1255  */
1256 static int hcd_unlink_urb (struct urb *urb, int status)
1257 {
1258         struct usb_host_endpoint        *ep;
1259         struct usb_hcd                  *hcd = NULL;
1260         struct device                   *sys = NULL;
1261         unsigned long                   flags;
1262         struct list_head                *tmp;
1263         int                             retval;
1264
1265         if (!urb)
1266                 return -EINVAL;
1267         if (!urb->dev || !urb->dev->bus)
1268                 return -ENODEV;
1269         ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
1270                         [usb_pipeendpoint(urb->pipe)];
1271         if (!ep)
1272                 return -ENODEV;
1273
1274         /*
1275          * we contend for urb->status with the hcd core,
1276          * which changes it while returning the urb.
1277          *
1278          * Caller guaranteed that the urb pointer hasn't been freed, and
1279          * that it was submitted.  But as a rule it can't know whether or
1280          * not it's already been unlinked ... so we respect the reversed
1281          * lock sequence needed for the usb_hcd_giveback_urb() code paths
1282          * (urb lock, then hcd_data_lock) in case some other CPU is now
1283          * unlinking it.
1284          */
1285         spin_lock_irqsave (&urb->lock, flags);
1286         spin_lock (&hcd_data_lock);
1287
1288         sys = &urb->dev->dev;
1289         hcd = urb->dev->bus->hcpriv;
1290         if (hcd == NULL) {
1291                 retval = -ENODEV;
1292                 goto done;
1293         }
1294
1295         /* insist the urb is still queued */
1296         list_for_each(tmp, &ep->urb_list) {
1297                 if (tmp == &urb->urb_list)
1298                         break;
1299         }
1300         if (tmp != &urb->urb_list) {
1301                 retval = -EIDRM;
1302                 goto done;
1303         }
1304
1305         /* Any status except -EINPROGRESS means something already started to
1306          * unlink this URB from the hardware.  So there's no more work to do.
1307          */
1308         if (urb->status != -EINPROGRESS) {
1309                 retval = -EBUSY;
1310                 goto done;
1311         }
1312
1313         /* IRQ setup can easily be broken so that USB controllers
1314          * never get completion IRQs ... maybe even the ones we need to
1315          * finish unlinking the initial failed usb_set_address()
1316          * or device descriptor fetch.
1317          */
1318         if (!hcd->saw_irq && hcd->self.root_hub != urb->dev) {
1319                 dev_warn (hcd->self.controller, "Unlink after no-IRQ?  "
1320                         "Controller is probably using the wrong IRQ."
1321                         "\n");
1322                 hcd->saw_irq = 1;
1323         }
1324
1325         urb->status = status;
1326
1327         spin_unlock (&hcd_data_lock);
1328         spin_unlock_irqrestore (&urb->lock, flags);
1329
1330         retval = unlink1 (hcd, urb);
1331         if (retval == 0)
1332                 retval = -EINPROGRESS;
1333         return retval;
1334
1335 done:
1336         spin_unlock (&hcd_data_lock);
1337         spin_unlock_irqrestore (&urb->lock, flags);
1338         if (retval != -EIDRM && sys && sys->driver)
1339                 dev_dbg (sys, "hcd_unlink_urb %p fail %d\n", urb, retval);
1340         return retval;
1341 }
1342
1343 /*-------------------------------------------------------------------------*/
1344
1345 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1346  * the hcd to make sure all endpoint state is gone from hardware. use for
1347  * set_configuration, set_interface, driver removal, physical disconnect.
1348  *
1349  * example:  a qh stored in ep->hcpriv, holding state related to endpoint
1350  * type, maxpacket size, toggle, halt status, and scheduling.
1351  */
1352 static void
1353 hcd_endpoint_disable (struct usb_device *udev, struct usb_host_endpoint *ep)
1354 {
1355         struct usb_hcd          *hcd;
1356         struct urb              *urb;
1357
1358         hcd = udev->bus->hcpriv;
1359
1360         WARN_ON (!HC_IS_RUNNING (hcd->state) && hcd->state != HC_STATE_HALT &&
1361                         udev->state != USB_STATE_NOTATTACHED);
1362
1363         local_irq_disable ();
1364
1365         /* FIXME move most of this into message.c as part of its
1366          * endpoint disable logic
1367          */
1368
1369         /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1370 rescan:
1371         spin_lock (&hcd_data_lock);
1372         list_for_each_entry (urb, &ep->urb_list, urb_list) {
1373                 int     tmp;
1374
1375                 /* another cpu may be in hcd, spinning on hcd_data_lock
1376                  * to giveback() this urb.  the races here should be
1377                  * small, but a full fix needs a new "can't submit"
1378                  * urb state.
1379                  * FIXME urb->reject should allow that...
1380                  */
1381                 if (urb->status != -EINPROGRESS)
1382                         continue;
1383                 usb_get_urb (urb);
1384                 spin_unlock (&hcd_data_lock);
1385
1386                 spin_lock (&urb->lock);
1387                 tmp = urb->status;
1388                 if (tmp == -EINPROGRESS)
1389                         urb->status = -ESHUTDOWN;
1390                 spin_unlock (&urb->lock);
1391
1392                 /* kick hcd unless it's already returning this */
1393                 if (tmp == -EINPROGRESS) {
1394                         tmp = urb->pipe;
1395                         unlink1 (hcd, urb);
1396                         dev_dbg (hcd->self.controller,
1397                                 "shutdown urb %p pipe %08x ep%d%s%s\n",
1398                                 urb, tmp, usb_pipeendpoint (tmp),
1399                                 (tmp & USB_DIR_IN) ? "in" : "out",
1400                                 ({ char *s; \
1401                                  switch (usb_pipetype (tmp)) { \
1402                                  case PIPE_CONTROL:     s = ""; break; \
1403                                  case PIPE_BULK:        s = "-bulk"; break; \
1404                                  case PIPE_INTERRUPT:   s = "-intr"; break; \
1405                                  default:               s = "-iso"; break; \
1406                                 }; s;}));
1407                 }
1408                 usb_put_urb (urb);
1409
1410                 /* list contents may have changed */
1411                 goto rescan;
1412         }
1413         spin_unlock (&hcd_data_lock);
1414         local_irq_enable ();
1415
1416         /* synchronize with the hardware, so old configuration state
1417          * clears out immediately (and will be freed).
1418          */
1419         might_sleep ();
1420         if (hcd->driver->endpoint_disable)
1421                 hcd->driver->endpoint_disable (hcd, ep);
1422 }
1423
1424 /*-------------------------------------------------------------------------*/
1425
1426 #ifdef  CONFIG_PM
1427
1428 int hcd_bus_suspend (struct usb_bus *bus)
1429 {
1430         struct usb_hcd          *hcd;
1431         int                     status;
1432
1433         hcd = container_of (bus, struct usb_hcd, self);
1434         if (!hcd->driver->bus_suspend)
1435                 return -ENOENT;
1436         hcd->state = HC_STATE_QUIESCING;
1437         status = hcd->driver->bus_suspend (hcd);
1438         if (status == 0)
1439                 hcd->state = HC_STATE_SUSPENDED;
1440         else
1441                 dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n",
1442                                 "suspend", status);
1443         return status;
1444 }
1445
1446 int hcd_bus_resume (struct usb_bus *bus)
1447 {
1448         struct usb_hcd          *hcd;
1449         int                     status;
1450
1451         hcd = container_of (bus, struct usb_hcd, self);
1452         if (!hcd->driver->bus_resume)
1453                 return -ENOENT;
1454         if (hcd->state == HC_STATE_RUNNING)
1455                 return 0;
1456         hcd->state = HC_STATE_RESUMING;
1457         status = hcd->driver->bus_resume (hcd);
1458         if (status == 0)
1459                 hcd->state = HC_STATE_RUNNING;
1460         else {
1461                 dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n",
1462                                 "resume", status);
1463                 usb_hc_died(hcd);
1464         }
1465         return status;
1466 }
1467
1468 /*
1469  * usb_hcd_suspend_root_hub - HCD autosuspends downstream ports
1470  * @hcd: host controller for this root hub
1471  *
1472  * This call arranges that usb_hcd_resume_root_hub() is safe to call later;
1473  * that the HCD's root hub polling is deactivated; and that the root's hub
1474  * driver is suspended.  HCDs may call this to autosuspend when their root
1475  * hub's downstream ports are all inactive:  unpowered, disconnected,
1476  * disabled, or suspended.
1477  *
1478  * The HCD will autoresume on device connect change detection (using SRP
1479  * or a D+/D- pullup).  The HCD also autoresumes on remote wakeup signaling
1480  * from any ports that are suspended (if that is enabled).  In most cases,
1481  * overcurrent signaling (on powered ports) will also start autoresume.
1482  *
1483  * Always called with IRQs blocked.
1484  */
1485 void usb_hcd_suspend_root_hub (struct usb_hcd *hcd)
1486 {
1487         struct urb      *urb;
1488
1489         spin_lock (&hcd_root_hub_lock);
1490         usb_suspend_root_hub (hcd->self.root_hub);
1491
1492         /* force status urb to complete/unlink while suspended */
1493         if (hcd->status_urb) {
1494                 urb = hcd->status_urb;
1495                 urb->status = -ECONNRESET;
1496                 urb->hcpriv = NULL;
1497                 urb->actual_length = 0;
1498
1499                 del_timer (&hcd->rh_timer);
1500                 hcd->poll_pending = 0;
1501                 hcd->status_urb = NULL;
1502         } else
1503                 urb = NULL;
1504         spin_unlock (&hcd_root_hub_lock);
1505         hcd->state = HC_STATE_SUSPENDED;
1506
1507         if (urb)
1508                 usb_hcd_giveback_urb (hcd, urb, NULL);
1509 }
1510 EXPORT_SYMBOL_GPL(usb_hcd_suspend_root_hub);
1511
1512 /**
1513  * usb_hcd_resume_root_hub - called by HCD to resume its root hub 
1514  * @hcd: host controller for this root hub
1515  *
1516  * The USB host controller calls this function when its root hub is
1517  * suspended (with the remote wakeup feature enabled) and a remote
1518  * wakeup request is received.  It queues a request for khubd to
1519  * resume the root hub (that is, manage its downstream ports again).
1520  */
1521 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1522 {
1523         unsigned long flags;
1524
1525         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1526         if (hcd->rh_registered)
1527                 usb_resume_root_hub (hcd->self.root_hub);
1528         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1529 }
1530 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1531
1532 #endif
1533
1534 /*-------------------------------------------------------------------------*/
1535
1536 #ifdef  CONFIG_USB_OTG
1537
1538 /**
1539  * usb_bus_start_enum - start immediate enumeration (for OTG)
1540  * @bus: the bus (must use hcd framework)
1541  * @port_num: 1-based number of port; usually bus->otg_port
1542  * Context: in_interrupt()
1543  *
1544  * Starts enumeration, with an immediate reset followed later by
1545  * khubd identifying and possibly configuring the device.
1546  * This is needed by OTG controller drivers, where it helps meet
1547  * HNP protocol timing requirements for starting a port reset.
1548  */
1549 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1550 {
1551         struct usb_hcd          *hcd;
1552         int                     status = -EOPNOTSUPP;
1553
1554         /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1555          * boards with root hubs hooked up to internal devices (instead of
1556          * just the OTG port) may need more attention to resetting...
1557          */
1558         hcd = container_of (bus, struct usb_hcd, self);
1559         if (port_num && hcd->driver->start_port_reset)
1560                 status = hcd->driver->start_port_reset(hcd, port_num);
1561
1562         /* run khubd shortly after (first) root port reset finishes;
1563          * it may issue others, until at least 50 msecs have passed.
1564          */
1565         if (status == 0)
1566                 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1567         return status;
1568 }
1569 EXPORT_SYMBOL (usb_bus_start_enum);
1570
1571 #endif
1572
1573 /*-------------------------------------------------------------------------*/
1574
1575 /*
1576  * usb_hcd_operations - adapts usb_bus framework to HCD framework (bus glue)
1577  */
1578 static struct usb_operations usb_hcd_operations = {
1579         .get_frame_number =     hcd_get_frame_number,
1580         .submit_urb =           hcd_submit_urb,
1581         .unlink_urb =           hcd_unlink_urb,
1582         .buffer_alloc =         hcd_buffer_alloc,
1583         .buffer_free =          hcd_buffer_free,
1584         .disable =              hcd_endpoint_disable,
1585 };
1586
1587 /*-------------------------------------------------------------------------*/
1588
1589 /**
1590  * usb_hcd_giveback_urb - return URB from HCD to device driver
1591  * @hcd: host controller returning the URB
1592  * @urb: urb being returned to the USB device driver.
1593  * @regs: pt_regs, passed down to the URB completion handler
1594  * Context: in_interrupt()
1595  *
1596  * This hands the URB from HCD to its USB device driver, using its
1597  * completion function.  The HCD has freed all per-urb resources
1598  * (and is done using urb->hcpriv).  It also released all HCD locks;
1599  * the device driver won't cause problems if it frees, modifies,
1600  * or resubmits this URB.
1601  */
1602 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs)
1603 {
1604         int at_root_hub;
1605
1606         at_root_hub = (urb->dev == hcd->self.root_hub);
1607         urb_unlink (urb);
1608
1609         /* lower level hcd code should use *_dma exclusively */
1610         if (hcd->self.controller->dma_mask && !at_root_hub) {
1611                 if (usb_pipecontrol (urb->pipe)
1612                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1613                         dma_unmap_single (hcd->self.controller, urb->setup_dma,
1614                                         sizeof (struct usb_ctrlrequest),
1615                                         DMA_TO_DEVICE);
1616                 if (urb->transfer_buffer_length != 0
1617                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1618                         dma_unmap_single (hcd->self.controller, 
1619                                         urb->transfer_dma,
1620                                         urb->transfer_buffer_length,
1621                                         usb_pipein (urb->pipe)
1622                                             ? DMA_FROM_DEVICE
1623                                             : DMA_TO_DEVICE);
1624         }
1625
1626         usbmon_urb_complete (&hcd->self, urb);
1627         /* pass ownership to the completion handler */
1628         urb->complete (urb, regs);
1629         atomic_dec (&urb->use_count);
1630         if (unlikely (urb->reject))
1631                 wake_up (&usb_kill_urb_queue);
1632         usb_put_urb (urb);
1633 }
1634 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1635
1636 /*-------------------------------------------------------------------------*/
1637
1638 /**
1639  * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1640  * @irq: the IRQ being raised
1641  * @__hcd: pointer to the HCD whose IRQ is being signaled
1642  * @r: saved hardware registers
1643  *
1644  * If the controller isn't HALTed, calls the driver's irq handler.
1645  * Checks whether the controller is now dead.
1646  */
1647 irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs * r)
1648 {
1649         struct usb_hcd          *hcd = __hcd;
1650         int                     start = hcd->state;
1651
1652         if (start == HC_STATE_HALT)
1653                 return IRQ_NONE;
1654         if (hcd->driver->irq (hcd, r) == IRQ_NONE)
1655                 return IRQ_NONE;
1656
1657         hcd->saw_irq = 1;
1658         if (hcd->state == HC_STATE_HALT)
1659                 usb_hc_died (hcd);
1660         return IRQ_HANDLED;
1661 }
1662
1663 /*-------------------------------------------------------------------------*/
1664
1665 /**
1666  * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1667  * @hcd: pointer to the HCD representing the controller
1668  *
1669  * This is called by bus glue to report a USB host controller that died
1670  * while operations may still have been pending.  It's called automatically
1671  * by the PCI glue, so only glue for non-PCI busses should need to call it. 
1672  */
1673 void usb_hc_died (struct usb_hcd *hcd)
1674 {
1675         unsigned long flags;
1676
1677         dev_err (hcd->self.controller, "HC died; cleaning up\n");
1678
1679         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1680         if (hcd->rh_registered) {
1681                 hcd->poll_rh = 0;
1682
1683                 /* make khubd clean up old urbs and devices */
1684                 usb_set_device_state (hcd->self.root_hub,
1685                                 USB_STATE_NOTATTACHED);
1686                 usb_kick_khubd (hcd->self.root_hub);
1687         }
1688         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1689 }
1690 EXPORT_SYMBOL_GPL (usb_hc_died);
1691
1692 /*-------------------------------------------------------------------------*/
1693
1694 static void hcd_release (struct usb_bus *bus)
1695 {
1696         struct usb_hcd *hcd;
1697
1698         hcd = container_of(bus, struct usb_hcd, self);
1699         kfree(hcd);
1700 }
1701
1702 /**
1703  * usb_create_hcd - create and initialize an HCD structure
1704  * @driver: HC driver that will use this hcd
1705  * @dev: device for this HC, stored in hcd->self.controller
1706  * @bus_name: value to store in hcd->self.bus_name
1707  * Context: !in_interrupt()
1708  *
1709  * Allocate a struct usb_hcd, with extra space at the end for the
1710  * HC driver's private data.  Initialize the generic members of the
1711  * hcd structure.
1712  *
1713  * If memory is unavailable, returns NULL.
1714  */
1715 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1716                 struct device *dev, char *bus_name)
1717 {
1718         struct usb_hcd *hcd;
1719
1720         hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1721         if (!hcd) {
1722                 dev_dbg (dev, "hcd alloc failed\n");
1723                 return NULL;
1724         }
1725         dev_set_drvdata(dev, hcd);
1726
1727         usb_bus_init(&hcd->self);
1728         hcd->self.op = &usb_hcd_operations;
1729         hcd->self.hcpriv = hcd;
1730         hcd->self.release = &hcd_release;
1731         hcd->self.controller = dev;
1732         hcd->self.bus_name = bus_name;
1733
1734         init_timer(&hcd->rh_timer);
1735         hcd->rh_timer.function = rh_timer_func;
1736         hcd->rh_timer.data = (unsigned long) hcd;
1737
1738         hcd->driver = driver;
1739         hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1740                         "USB Host Controller";
1741
1742         return hcd;
1743 }
1744 EXPORT_SYMBOL (usb_create_hcd);
1745
1746 void usb_put_hcd (struct usb_hcd *hcd)
1747 {
1748         dev_set_drvdata(hcd->self.controller, NULL);
1749         usb_bus_put(&hcd->self);
1750 }
1751 EXPORT_SYMBOL (usb_put_hcd);
1752
1753 /**
1754  * usb_add_hcd - finish generic HCD structure initialization and register
1755  * @hcd: the usb_hcd structure to initialize
1756  * @irqnum: Interrupt line to allocate
1757  * @irqflags: Interrupt type flags
1758  *
1759  * Finish the remaining parts of generic HCD initialization: allocate the
1760  * buffers of consistent memory, register the bus, request the IRQ line,
1761  * and call the driver's reset() and start() routines.
1762  */
1763 int usb_add_hcd(struct usb_hcd *hcd,
1764                 unsigned int irqnum, unsigned long irqflags)
1765 {
1766         int retval;
1767         struct usb_device *rhdev;
1768
1769         dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1770
1771         /* till now HC has been in an indeterminate state ... */
1772         if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1773                 dev_err(hcd->self.controller, "can't reset\n");
1774                 return retval;
1775         }
1776
1777         if ((retval = hcd_buffer_create(hcd)) != 0) {
1778                 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1779                 return retval;
1780         }
1781
1782         if ((retval = usb_register_bus(&hcd->self)) < 0)
1783                 goto err_register_bus;
1784
1785         if (hcd->driver->irq) {
1786                 char    buf[8], *bufp = buf;
1787
1788 #ifdef __sparc__
1789                 bufp = __irq_itoa(irqnum);
1790 #else
1791                 sprintf(buf, "%d", irqnum);
1792 #endif
1793
1794                 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1795                                 hcd->driver->description, hcd->self.busnum);
1796                 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1797                                 hcd->irq_descr, hcd)) != 0) {
1798                         dev_err(hcd->self.controller,
1799                                         "request interrupt %s failed\n", bufp);
1800                         goto err_request_irq;
1801                 }
1802                 hcd->irq = irqnum;
1803                 dev_info(hcd->self.controller, "irq %s, %s 0x%08llx\n", bufp,
1804                                 (hcd->driver->flags & HCD_MEMORY) ?
1805                                         "io mem" : "io base",
1806                                         (unsigned long long)hcd->rsrc_start);
1807         } else {
1808                 hcd->irq = -1;
1809                 if (hcd->rsrc_start)
1810                         dev_info(hcd->self.controller, "%s 0x%08llx\n",
1811                                         (hcd->driver->flags & HCD_MEMORY) ?
1812                                         "io mem" : "io base",
1813                                         (unsigned long long)hcd->rsrc_start);
1814         }
1815
1816         /* Allocate the root hub before calling hcd->driver->start(),
1817          * but don't register it until afterward so that the hardware
1818          * is running.
1819          */
1820         if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1821                 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1822                 retval = -ENOMEM;
1823                 goto err_allocate_root_hub;
1824         }
1825         rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1826                         USB_SPEED_FULL;
1827
1828         /* Although in principle hcd->driver->start() might need to use rhdev,
1829          * none of the current drivers do.
1830          */
1831         if ((retval = hcd->driver->start(hcd)) < 0) {
1832                 dev_err(hcd->self.controller, "startup error %d\n", retval);
1833                 goto err_hcd_driver_start;
1834         }
1835
1836         /* hcd->driver->start() reported can_wakeup, probably with
1837          * assistance from board's boot firmware.
1838          * NOTE:  normal devices won't enable wakeup by default.
1839          */
1840         if (hcd->can_wakeup)
1841                 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1842         hcd->remote_wakeup = hcd->can_wakeup;
1843
1844         if ((retval = register_root_hub(rhdev, hcd)) != 0)
1845                 goto err_register_root_hub;
1846
1847         if (hcd->uses_new_polling && hcd->poll_rh)
1848                 usb_hcd_poll_rh_status(hcd);
1849         return retval;
1850
1851  err_register_root_hub:
1852         hcd->driver->stop(hcd);
1853
1854  err_hcd_driver_start:
1855         usb_put_dev(rhdev);
1856
1857  err_allocate_root_hub:
1858         if (hcd->irq >= 0)
1859                 free_irq(irqnum, hcd);
1860
1861  err_request_irq:
1862         usb_deregister_bus(&hcd->self);
1863
1864  err_register_bus:
1865         hcd_buffer_destroy(hcd);
1866         return retval;
1867
1868 EXPORT_SYMBOL (usb_add_hcd);
1869
1870 /**
1871  * usb_remove_hcd - shutdown processing for generic HCDs
1872  * @hcd: the usb_hcd structure to remove
1873  * Context: !in_interrupt()
1874  *
1875  * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1876  * invoking the HCD's stop() method.
1877  */
1878 void usb_remove_hcd(struct usb_hcd *hcd)
1879 {
1880         dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1881
1882         if (HC_IS_RUNNING (hcd->state))
1883                 hcd->state = HC_STATE_QUIESCING;
1884
1885         dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1886         spin_lock_irq (&hcd_root_hub_lock);
1887         hcd->rh_registered = 0;
1888         spin_unlock_irq (&hcd_root_hub_lock);
1889         usb_disconnect(&hcd->self.root_hub);
1890
1891         hcd->poll_rh = 0;
1892         del_timer_sync(&hcd->rh_timer);
1893
1894         hcd->driver->stop(hcd);
1895         hcd->state = HC_STATE_HALT;
1896
1897         if (hcd->irq >= 0)
1898                 free_irq(hcd->irq, hcd);
1899         usb_deregister_bus(&hcd->self);
1900         hcd_buffer_destroy(hcd);
1901 }
1902 EXPORT_SYMBOL (usb_remove_hcd);
1903
1904 /*-------------------------------------------------------------------------*/
1905
1906 #if defined(CONFIG_USB_MON)
1907
1908 struct usb_mon_operations *mon_ops;
1909
1910 /*
1911  * The registration is unlocked.
1912  * We do it this way because we do not want to lock in hot paths.
1913  *
1914  * Notice that the code is minimally error-proof. Because usbmon needs
1915  * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1916  */
1917  
1918 int usb_mon_register (struct usb_mon_operations *ops)
1919 {
1920
1921         if (mon_ops)
1922                 return -EBUSY;
1923
1924         mon_ops = ops;
1925         mb();
1926         return 0;
1927 }
1928 EXPORT_SYMBOL_GPL (usb_mon_register);
1929
1930 void usb_mon_deregister (void)
1931 {
1932
1933         if (mon_ops == NULL) {
1934                 printk(KERN_ERR "USB: monitor was not registered\n");
1935                 return;
1936         }
1937         mon_ops = NULL;
1938         mb();
1939 }
1940 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1941
1942 #endif /* CONFIG_USB_MON */