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