[PATCH] USB: add notifier functions to the USB core for devices and busses
[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         0x08,       /*  __u8  bMaxPacketSize0; 8 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         0x08,       /*  __u8  bMaxPacketSize0; 8 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 = kmalloc (sizeof *bus, GFP_KERNEL);
748         if (!bus)
749                 return NULL;
750         memset(bus, 0, sizeof(struct usb_bus));
751         usb_bus_init (bus);
752         bus->op = op;
753         return bus;
754 }
755
756 /*-------------------------------------------------------------------------*/
757
758 /**
759  * usb_register_bus - registers the USB host controller with the usb core
760  * @bus: pointer to the bus to register
761  * Context: !in_interrupt()
762  *
763  * Assigns a bus number, and links the controller into usbcore data
764  * structures so that it can be seen by scanning the bus list.
765  */
766 static int usb_register_bus(struct usb_bus *bus)
767 {
768         int busnum;
769
770         down (&usb_bus_list_lock);
771         busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
772         if (busnum < USB_MAXBUS) {
773                 set_bit (busnum, busmap.busmap);
774                 bus->busnum = busnum;
775         } else {
776                 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
777                 up(&usb_bus_list_lock);
778                 return -E2BIG;
779         }
780
781         bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
782                                              bus->controller, "usb_host%d", busnum);
783         if (IS_ERR(bus->class_dev)) {
784                 clear_bit(busnum, busmap.busmap);
785                 up(&usb_bus_list_lock);
786                 return PTR_ERR(bus->class_dev);
787         }
788
789         class_set_devdata(bus->class_dev, bus);
790
791         /* Add it to the local list of buses */
792         list_add (&bus->bus_list, &usb_bus_list);
793         up (&usb_bus_list_lock);
794
795         usb_notify_add_bus(bus);
796         usbfs_add_bus (bus);
797         usbmon_notify_bus_add (bus);
798
799         dev_info (bus->controller, "new USB bus registered, assigned bus number %d\n", bus->busnum);
800         return 0;
801 }
802
803 /**
804  * usb_deregister_bus - deregisters the USB host controller
805  * @bus: pointer to the bus to deregister
806  * Context: !in_interrupt()
807  *
808  * Recycles the bus number, and unlinks the controller from usbcore data
809  * structures so that it won't be seen by scanning the bus list.
810  */
811 static void usb_deregister_bus (struct usb_bus *bus)
812 {
813         dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
814
815         /*
816          * NOTE: make sure that all the devices are removed by the
817          * controller code, as well as having it call this when cleaning
818          * itself up
819          */
820         down (&usb_bus_list_lock);
821         list_del (&bus->bus_list);
822         up (&usb_bus_list_lock);
823
824         usb_notify_remove_bus(bus);
825         usbmon_notify_bus_remove (bus);
826         usbfs_remove_bus (bus);
827
828         clear_bit (bus->busnum, busmap.busmap);
829
830         class_device_unregister(bus->class_dev);
831 }
832
833 /**
834  * register_root_hub - called by usb_add_hcd() to register a root hub
835  * @usb_dev: the usb root hub device to be registered.
836  * @hcd: host controller for this root hub
837  *
838  * This function registers the root hub with the USB subsystem.  It sets up
839  * the device properly in the device tree and stores the root_hub pointer
840  * in the bus structure, then calls usb_new_device() to register the usb
841  * device.  It also assigns the root hub's USB address (always 1).
842  */
843 static int register_root_hub (struct usb_device *usb_dev,
844                 struct usb_hcd *hcd)
845 {
846         struct device *parent_dev = hcd->self.controller;
847         const int devnum = 1;
848         int retval;
849
850         usb_dev->devnum = devnum;
851         usb_dev->bus->devnum_next = devnum + 1;
852         memset (&usb_dev->bus->devmap.devicemap, 0,
853                         sizeof usb_dev->bus->devmap.devicemap);
854         set_bit (devnum, usb_dev->bus->devmap.devicemap);
855         usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
856
857         down (&usb_bus_list_lock);
858         usb_dev->bus->root_hub = usb_dev;
859
860         usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
861         retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
862         if (retval != sizeof usb_dev->descriptor) {
863                 usb_dev->bus->root_hub = NULL;
864                 up (&usb_bus_list_lock);
865                 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
866                                 usb_dev->dev.bus_id, retval);
867                 return (retval < 0) ? retval : -EMSGSIZE;
868         }
869
870         usb_lock_device (usb_dev);
871         retval = usb_new_device (usb_dev);
872         usb_unlock_device (usb_dev);
873         if (retval) {
874                 usb_dev->bus->root_hub = NULL;
875                 dev_err (parent_dev, "can't register root hub for %s, %d\n",
876                                 usb_dev->dev.bus_id, retval);
877         }
878         up (&usb_bus_list_lock);
879
880         if (retval == 0) {
881                 spin_lock_irq (&hcd_root_hub_lock);
882                 hcd->rh_registered = 1;
883                 spin_unlock_irq (&hcd_root_hub_lock);
884
885                 /* Did the HC die before the root hub was registered? */
886                 if (hcd->state == HC_STATE_HALT)
887                         usb_hc_died (hcd);      /* This time clean up */
888         }
889
890         return retval;
891 }
892
893 void usb_enable_root_hub_irq (struct usb_bus *bus)
894 {
895         struct usb_hcd *hcd;
896
897         hcd = container_of (bus, struct usb_hcd, self);
898         if (hcd->driver->hub_irq_enable && !hcd->poll_rh &&
899                         hcd->state != HC_STATE_HALT)
900                 hcd->driver->hub_irq_enable (hcd);
901 }
902
903
904 /*-------------------------------------------------------------------------*/
905
906 /**
907  * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
908  * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
909  * @is_input: true iff the transaction sends data to the host
910  * @isoc: true for isochronous transactions, false for interrupt ones
911  * @bytecount: how many bytes in the transaction.
912  *
913  * Returns approximate bus time in nanoseconds for a periodic transaction.
914  * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
915  * scheduled in software, this function is only used for such scheduling.
916  */
917 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
918 {
919         unsigned long   tmp;
920
921         switch (speed) {
922         case USB_SPEED_LOW:     /* INTR only */
923                 if (is_input) {
924                         tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
925                         return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
926                 } else {
927                         tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
928                         return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
929                 }
930         case USB_SPEED_FULL:    /* ISOC or INTR */
931                 if (isoc) {
932                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
933                         return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
934                 } else {
935                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
936                         return (9107L + BW_HOST_DELAY + tmp);
937                 }
938         case USB_SPEED_HIGH:    /* ISOC or INTR */
939                 // FIXME adjust for input vs output
940                 if (isoc)
941                         tmp = HS_NSECS_ISO (bytecount);
942                 else
943                         tmp = HS_NSECS (bytecount);
944                 return tmp;
945         default:
946                 pr_debug ("%s: bogus device speed!\n", usbcore_name);
947                 return -1;
948         }
949 }
950 EXPORT_SYMBOL (usb_calc_bus_time);
951
952 /*
953  * usb_check_bandwidth():
954  *
955  * old_alloc is from host_controller->bandwidth_allocated in microseconds;
956  * bustime is from calc_bus_time(), but converted to microseconds.
957  *
958  * returns <bustime in us> if successful,
959  * or -ENOSPC if bandwidth request fails.
960  *
961  * FIXME:
962  * This initial implementation does not use Endpoint.bInterval
963  * in managing bandwidth allocation.
964  * It probably needs to be expanded to use Endpoint.bInterval.
965  * This can be done as a later enhancement (correction).
966  *
967  * This will also probably require some kind of
968  * frame allocation tracking...meaning, for example,
969  * that if multiple drivers request interrupts every 10 USB frames,
970  * they don't all have to be allocated at
971  * frame numbers N, N+10, N+20, etc.  Some of them could be at
972  * N+11, N+21, N+31, etc., and others at
973  * N+12, N+22, N+32, etc.
974  *
975  * Similarly for isochronous transfers...
976  *
977  * Individual HCDs can schedule more directly ... this logic
978  * is not correct for high speed transfers.
979  */
980 int usb_check_bandwidth (struct usb_device *dev, struct urb *urb)
981 {
982         unsigned int    pipe = urb->pipe;
983         long            bustime;
984         int             is_in = usb_pipein (pipe);
985         int             is_iso = usb_pipeisoc (pipe);
986         int             old_alloc = dev->bus->bandwidth_allocated;
987         int             new_alloc;
988
989
990         bustime = NS_TO_US (usb_calc_bus_time (dev->speed, is_in, is_iso,
991                         usb_maxpacket (dev, pipe, !is_in)));
992         if (is_iso)
993                 bustime /= urb->number_of_packets;
994
995         new_alloc = old_alloc + (int) bustime;
996         if (new_alloc > FRAME_TIME_MAX_USECS_ALLOC) {
997 #ifdef  DEBUG
998                 char    *mode = 
999 #ifdef CONFIG_USB_BANDWIDTH
1000                         "";
1001 #else
1002                         "would have ";
1003 #endif
1004                 dev_dbg (&dev->dev, "usb_check_bandwidth %sFAILED: %d + %ld = %d usec\n",
1005                         mode, old_alloc, bustime, new_alloc);
1006 #endif
1007 #ifdef CONFIG_USB_BANDWIDTH
1008                 bustime = -ENOSPC;      /* report error */
1009 #endif
1010         }
1011
1012         return bustime;
1013 }
1014 EXPORT_SYMBOL (usb_check_bandwidth);
1015
1016
1017 /**
1018  * usb_claim_bandwidth - records bandwidth for a periodic transfer
1019  * @dev: source/target of request
1020  * @urb: request (urb->dev == dev)
1021  * @bustime: bandwidth consumed, in (average) microseconds per frame
1022  * @isoc: true iff the request is isochronous
1023  *
1024  * Bus bandwidth reservations are recorded purely for diagnostic purposes.
1025  * HCDs are expected not to overcommit periodic bandwidth, and to record such
1026  * reservations whenever endpoints are added to the periodic schedule.
1027  *
1028  * FIXME averaging per-frame is suboptimal.  Better to sum over the HCD's
1029  * entire periodic schedule ... 32 frames for OHCI, 1024 for UHCI, settable
1030  * for EHCI (256/512/1024 frames, default 1024) and have the bus expose how
1031  * large its periodic schedule is.
1032  */
1033 void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb, int bustime, int isoc)
1034 {
1035         dev->bus->bandwidth_allocated += bustime;
1036         if (isoc)
1037                 dev->bus->bandwidth_isoc_reqs++;
1038         else
1039                 dev->bus->bandwidth_int_reqs++;
1040         urb->bandwidth = bustime;
1041
1042 #ifdef USB_BANDWIDTH_MESSAGES
1043         dev_dbg (&dev->dev, "bandwidth alloc increased by %d (%s) to %d for %d requesters\n",
1044                 bustime,
1045                 isoc ? "ISOC" : "INTR",
1046                 dev->bus->bandwidth_allocated,
1047                 dev->bus->bandwidth_int_reqs + dev->bus->bandwidth_isoc_reqs);
1048 #endif
1049 }
1050 EXPORT_SYMBOL (usb_claim_bandwidth);
1051
1052
1053 /**
1054  * usb_release_bandwidth - reverses effect of usb_claim_bandwidth()
1055  * @dev: source/target of request
1056  * @urb: request (urb->dev == dev)
1057  * @isoc: true iff the request is isochronous
1058  *
1059  * This records that previously allocated bandwidth has been released.
1060  * Bandwidth is released when endpoints are removed from the host controller's
1061  * periodic schedule.
1062  */
1063 void usb_release_bandwidth (struct usb_device *dev, struct urb *urb, int isoc)
1064 {
1065         dev->bus->bandwidth_allocated -= urb->bandwidth;
1066         if (isoc)
1067                 dev->bus->bandwidth_isoc_reqs--;
1068         else
1069                 dev->bus->bandwidth_int_reqs--;
1070
1071 #ifdef USB_BANDWIDTH_MESSAGES
1072         dev_dbg (&dev->dev, "bandwidth alloc reduced by %d (%s) to %d for %d requesters\n",
1073                 urb->bandwidth,
1074                 isoc ? "ISOC" : "INTR",
1075                 dev->bus->bandwidth_allocated,
1076                 dev->bus->bandwidth_int_reqs + dev->bus->bandwidth_isoc_reqs);
1077 #endif
1078         urb->bandwidth = 0;
1079 }
1080 EXPORT_SYMBOL (usb_release_bandwidth);
1081
1082
1083 /*-------------------------------------------------------------------------*/
1084
1085 /*
1086  * Generic HC operations.
1087  */
1088
1089 /*-------------------------------------------------------------------------*/
1090
1091 static void urb_unlink (struct urb *urb)
1092 {
1093         unsigned long           flags;
1094
1095         /* Release any periodic transfer bandwidth */
1096         if (urb->bandwidth)
1097                 usb_release_bandwidth (urb->dev, urb,
1098                         usb_pipeisoc (urb->pipe));
1099
1100         /* clear all state linking urb to this dev (and hcd) */
1101
1102         spin_lock_irqsave (&hcd_data_lock, flags);
1103         list_del_init (&urb->urb_list);
1104         spin_unlock_irqrestore (&hcd_data_lock, flags);
1105         usb_put_dev (urb->dev);
1106 }
1107
1108
1109 /* may be called in any context with a valid urb->dev usecount
1110  * caller surrenders "ownership" of urb
1111  * expects usb_submit_urb() to have sanity checked and conditioned all
1112  * inputs in the urb
1113  */
1114 static int hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1115 {
1116         int                     status;
1117         struct usb_hcd          *hcd = urb->dev->bus->hcpriv;
1118         struct usb_host_endpoint *ep;
1119         unsigned long           flags;
1120
1121         if (!hcd)
1122                 return -ENODEV;
1123
1124         usbmon_urb_submit(&hcd->self, urb);
1125
1126         /*
1127          * Atomically queue the urb,  first to our records, then to the HCD.
1128          * Access to urb->status is controlled by urb->lock ... changes on
1129          * i/o completion (normal or fault) or unlinking.
1130          */
1131
1132         // FIXME:  verify that quiescing hc works right (RH cleans up)
1133
1134         spin_lock_irqsave (&hcd_data_lock, flags);
1135         ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
1136                         [usb_pipeendpoint(urb->pipe)];
1137         if (unlikely (!ep))
1138                 status = -ENOENT;
1139         else if (unlikely (urb->reject))
1140                 status = -EPERM;
1141         else switch (hcd->state) {
1142         case HC_STATE_RUNNING:
1143         case HC_STATE_RESUMING:
1144 doit:
1145                 usb_get_dev (urb->dev);
1146                 list_add_tail (&urb->urb_list, &ep->urb_list);
1147                 status = 0;
1148                 break;
1149         case HC_STATE_SUSPENDED:
1150                 /* HC upstream links (register access, wakeup signaling) can work
1151                  * even when the downstream links (and DMA etc) are quiesced; let
1152                  * usbcore talk to the root hub.
1153                  */
1154                 if (hcd->self.controller->power.power_state.event == PM_EVENT_ON
1155                                 && urb->dev->parent == NULL)
1156                         goto doit;
1157                 /* FALL THROUGH */
1158         default:
1159                 status = -ESHUTDOWN;
1160                 break;
1161         }
1162         spin_unlock_irqrestore (&hcd_data_lock, flags);
1163         if (status) {
1164                 INIT_LIST_HEAD (&urb->urb_list);
1165                 usbmon_urb_submit_error(&hcd->self, urb, status);
1166                 return status;
1167         }
1168
1169         /* increment urb's reference count as part of giving it to the HCD
1170          * (which now controls it).  HCD guarantees that it either returns
1171          * an error or calls giveback(), but not both.
1172          */
1173         urb = usb_get_urb (urb);
1174         atomic_inc (&urb->use_count);
1175
1176         if (urb->dev == hcd->self.root_hub) {
1177                 /* NOTE:  requirement on hub callers (usbfs and the hub
1178                  * driver, for now) that URBs' urb->transfer_buffer be
1179                  * valid and usb_buffer_{sync,unmap}() not be needed, since
1180                  * they could clobber root hub response data.
1181                  */
1182                 status = rh_urb_enqueue (hcd, urb);
1183                 goto done;
1184         }
1185
1186         /* lower level hcd code should use *_dma exclusively,
1187          * unless it uses pio or talks to another transport.
1188          */
1189         if (hcd->self.controller->dma_mask) {
1190                 if (usb_pipecontrol (urb->pipe)
1191                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1192                         urb->setup_dma = dma_map_single (
1193                                         hcd->self.controller,
1194                                         urb->setup_packet,
1195                                         sizeof (struct usb_ctrlrequest),
1196                                         DMA_TO_DEVICE);
1197                 if (urb->transfer_buffer_length != 0
1198                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1199                         urb->transfer_dma = dma_map_single (
1200                                         hcd->self.controller,
1201                                         urb->transfer_buffer,
1202                                         urb->transfer_buffer_length,
1203                                         usb_pipein (urb->pipe)
1204                                             ? DMA_FROM_DEVICE
1205                                             : DMA_TO_DEVICE);
1206         }
1207
1208         status = hcd->driver->urb_enqueue (hcd, ep, urb, mem_flags);
1209 done:
1210         if (unlikely (status)) {
1211                 urb_unlink (urb);
1212                 atomic_dec (&urb->use_count);
1213                 if (urb->reject)
1214                         wake_up (&usb_kill_urb_queue);
1215                 usb_put_urb (urb);
1216                 usbmon_urb_submit_error(&hcd->self, urb, status);
1217         }
1218         return status;
1219 }
1220
1221 /*-------------------------------------------------------------------------*/
1222
1223 /* called in any context */
1224 static int hcd_get_frame_number (struct usb_device *udev)
1225 {
1226         struct usb_hcd  *hcd = (struct usb_hcd *)udev->bus->hcpriv;
1227         if (!HC_IS_RUNNING (hcd->state))
1228                 return -ESHUTDOWN;
1229         return hcd->driver->get_frame_number (hcd);
1230 }
1231
1232 /*-------------------------------------------------------------------------*/
1233
1234 /* this makes the hcd giveback() the urb more quickly, by kicking it
1235  * off hardware queues (which may take a while) and returning it as
1236  * soon as practical.  we've already set up the urb's return status,
1237  * but we can't know if the callback completed already.
1238  */
1239 static int
1240 unlink1 (struct usb_hcd *hcd, struct urb *urb)
1241 {
1242         int             value;
1243
1244         if (urb->dev == hcd->self.root_hub)
1245                 value = usb_rh_urb_dequeue (hcd, urb);
1246         else {
1247
1248                 /* The only reason an HCD might fail this call is if
1249                  * it has not yet fully queued the urb to begin with.
1250                  * Such failures should be harmless. */
1251                 value = hcd->driver->urb_dequeue (hcd, urb);
1252         }
1253
1254         if (value != 0)
1255                 dev_dbg (hcd->self.controller, "dequeue %p --> %d\n",
1256                                 urb, value);
1257         return value;
1258 }
1259
1260 /*
1261  * called in any context
1262  *
1263  * caller guarantees urb won't be recycled till both unlink()
1264  * and the urb's completion function return
1265  */
1266 static int hcd_unlink_urb (struct urb *urb, int status)
1267 {
1268         struct usb_host_endpoint        *ep;
1269         struct usb_hcd                  *hcd = NULL;
1270         struct device                   *sys = NULL;
1271         unsigned long                   flags;
1272         struct list_head                *tmp;
1273         int                             retval;
1274
1275         if (!urb)
1276                 return -EINVAL;
1277         if (!urb->dev || !urb->dev->bus)
1278                 return -ENODEV;
1279         ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out)
1280                         [usb_pipeendpoint(urb->pipe)];
1281         if (!ep)
1282                 return -ENODEV;
1283
1284         /*
1285          * we contend for urb->status with the hcd core,
1286          * which changes it while returning the urb.
1287          *
1288          * Caller guaranteed that the urb pointer hasn't been freed, and
1289          * that it was submitted.  But as a rule it can't know whether or
1290          * not it's already been unlinked ... so we respect the reversed
1291          * lock sequence needed for the usb_hcd_giveback_urb() code paths
1292          * (urb lock, then hcd_data_lock) in case some other CPU is now
1293          * unlinking it.
1294          */
1295         spin_lock_irqsave (&urb->lock, flags);
1296         spin_lock (&hcd_data_lock);
1297
1298         sys = &urb->dev->dev;
1299         hcd = urb->dev->bus->hcpriv;
1300         if (hcd == NULL) {
1301                 retval = -ENODEV;
1302                 goto done;
1303         }
1304
1305         /* insist the urb is still queued */
1306         list_for_each(tmp, &ep->urb_list) {
1307                 if (tmp == &urb->urb_list)
1308                         break;
1309         }
1310         if (tmp != &urb->urb_list) {
1311                 retval = -EIDRM;
1312                 goto done;
1313         }
1314
1315         /* Any status except -EINPROGRESS means something already started to
1316          * unlink this URB from the hardware.  So there's no more work to do.
1317          */
1318         if (urb->status != -EINPROGRESS) {
1319                 retval = -EBUSY;
1320                 goto done;
1321         }
1322
1323         /* IRQ setup can easily be broken so that USB controllers
1324          * never get completion IRQs ... maybe even the ones we need to
1325          * finish unlinking the initial failed usb_set_address()
1326          * or device descriptor fetch.
1327          */
1328         if (!hcd->saw_irq && hcd->self.root_hub != urb->dev) {
1329                 dev_warn (hcd->self.controller, "Unlink after no-IRQ?  "
1330                         "Controller is probably using the wrong IRQ."
1331                         "\n");
1332                 hcd->saw_irq = 1;
1333         }
1334
1335         urb->status = status;
1336
1337         spin_unlock (&hcd_data_lock);
1338         spin_unlock_irqrestore (&urb->lock, flags);
1339
1340         retval = unlink1 (hcd, urb);
1341         if (retval == 0)
1342                 retval = -EINPROGRESS;
1343         return retval;
1344
1345 done:
1346         spin_unlock (&hcd_data_lock);
1347         spin_unlock_irqrestore (&urb->lock, flags);
1348         if (retval != -EIDRM && sys && sys->driver)
1349                 dev_dbg (sys, "hcd_unlink_urb %p fail %d\n", urb, retval);
1350         return retval;
1351 }
1352
1353 /*-------------------------------------------------------------------------*/
1354
1355 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1356  * the hcd to make sure all endpoint state is gone from hardware. use for
1357  * set_configuration, set_interface, driver removal, physical disconnect.
1358  *
1359  * example:  a qh stored in ep->hcpriv, holding state related to endpoint
1360  * type, maxpacket size, toggle, halt status, and scheduling.
1361  */
1362 static void
1363 hcd_endpoint_disable (struct usb_device *udev, struct usb_host_endpoint *ep)
1364 {
1365         struct usb_hcd          *hcd;
1366         struct urb              *urb;
1367
1368         hcd = udev->bus->hcpriv;
1369
1370         WARN_ON (!HC_IS_RUNNING (hcd->state) && hcd->state != HC_STATE_HALT &&
1371                         udev->state != USB_STATE_NOTATTACHED);
1372
1373         local_irq_disable ();
1374
1375         /* FIXME move most of this into message.c as part of its
1376          * endpoint disable logic
1377          */
1378
1379         /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1380 rescan:
1381         spin_lock (&hcd_data_lock);
1382         list_for_each_entry (urb, &ep->urb_list, urb_list) {
1383                 int     tmp;
1384
1385                 /* another cpu may be in hcd, spinning on hcd_data_lock
1386                  * to giveback() this urb.  the races here should be
1387                  * small, but a full fix needs a new "can't submit"
1388                  * urb state.
1389                  * FIXME urb->reject should allow that...
1390                  */
1391                 if (urb->status != -EINPROGRESS)
1392                         continue;
1393                 usb_get_urb (urb);
1394                 spin_unlock (&hcd_data_lock);
1395
1396                 spin_lock (&urb->lock);
1397                 tmp = urb->status;
1398                 if (tmp == -EINPROGRESS)
1399                         urb->status = -ESHUTDOWN;
1400                 spin_unlock (&urb->lock);
1401
1402                 /* kick hcd unless it's already returning this */
1403                 if (tmp == -EINPROGRESS) {
1404                         tmp = urb->pipe;
1405                         unlink1 (hcd, urb);
1406                         dev_dbg (hcd->self.controller,
1407                                 "shutdown urb %p pipe %08x ep%d%s%s\n",
1408                                 urb, tmp, usb_pipeendpoint (tmp),
1409                                 (tmp & USB_DIR_IN) ? "in" : "out",
1410                                 ({ char *s; \
1411                                  switch (usb_pipetype (tmp)) { \
1412                                  case PIPE_CONTROL:     s = ""; break; \
1413                                  case PIPE_BULK:        s = "-bulk"; break; \
1414                                  case PIPE_INTERRUPT:   s = "-intr"; break; \
1415                                  default:               s = "-iso"; break; \
1416                                 }; s;}));
1417                 }
1418                 usb_put_urb (urb);
1419
1420                 /* list contents may have changed */
1421                 goto rescan;
1422         }
1423         spin_unlock (&hcd_data_lock);
1424         local_irq_enable ();
1425
1426         /* synchronize with the hardware, so old configuration state
1427          * clears out immediately (and will be freed).
1428          */
1429         might_sleep ();
1430         if (hcd->driver->endpoint_disable)
1431                 hcd->driver->endpoint_disable (hcd, ep);
1432 }
1433
1434 /*-------------------------------------------------------------------------*/
1435
1436 #ifdef  CONFIG_PM
1437
1438 int hcd_bus_suspend (struct usb_bus *bus)
1439 {
1440         struct usb_hcd          *hcd;
1441         int                     status;
1442
1443         hcd = container_of (bus, struct usb_hcd, self);
1444         if (!hcd->driver->bus_suspend)
1445                 return -ENOENT;
1446         hcd->state = HC_STATE_QUIESCING;
1447         status = hcd->driver->bus_suspend (hcd);
1448         if (status == 0)
1449                 hcd->state = HC_STATE_SUSPENDED;
1450         else
1451                 dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n",
1452                                 "suspend", status);
1453         return status;
1454 }
1455
1456 int hcd_bus_resume (struct usb_bus *bus)
1457 {
1458         struct usb_hcd          *hcd;
1459         int                     status;
1460
1461         hcd = container_of (bus, struct usb_hcd, self);
1462         if (!hcd->driver->bus_resume)
1463                 return -ENOENT;
1464         if (hcd->state == HC_STATE_RUNNING)
1465                 return 0;
1466         hcd->state = HC_STATE_RESUMING;
1467         status = hcd->driver->bus_resume (hcd);
1468         if (status == 0)
1469                 hcd->state = HC_STATE_RUNNING;
1470         else {
1471                 dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n",
1472                                 "resume", status);
1473                 usb_hc_died(hcd);
1474         }
1475         return status;
1476 }
1477
1478 /*
1479  * usb_hcd_suspend_root_hub - HCD autosuspends downstream ports
1480  * @hcd: host controller for this root hub
1481  *
1482  * This call arranges that usb_hcd_resume_root_hub() is safe to call later;
1483  * that the HCD's root hub polling is deactivated; and that the root's hub
1484  * driver is suspended.  HCDs may call this to autosuspend when their root
1485  * hub's downstream ports are all inactive:  unpowered, disconnected,
1486  * disabled, or suspended.
1487  *
1488  * The HCD will autoresume on device connect change detection (using SRP
1489  * or a D+/D- pullup).  The HCD also autoresumes on remote wakeup signaling
1490  * from any ports that are suspended (if that is enabled).  In most cases,
1491  * overcurrent signaling (on powered ports) will also start autoresume.
1492  *
1493  * Always called with IRQs blocked.
1494  */
1495 void usb_hcd_suspend_root_hub (struct usb_hcd *hcd)
1496 {
1497         struct urb      *urb;
1498
1499         spin_lock (&hcd_root_hub_lock);
1500         usb_suspend_root_hub (hcd->self.root_hub);
1501
1502         /* force status urb to complete/unlink while suspended */
1503         if (hcd->status_urb) {
1504                 urb = hcd->status_urb;
1505                 urb->status = -ECONNRESET;
1506                 urb->hcpriv = NULL;
1507                 urb->actual_length = 0;
1508
1509                 del_timer (&hcd->rh_timer);
1510                 hcd->poll_pending = 0;
1511                 hcd->status_urb = NULL;
1512         } else
1513                 urb = NULL;
1514         spin_unlock (&hcd_root_hub_lock);
1515         hcd->state = HC_STATE_SUSPENDED;
1516
1517         if (urb)
1518                 usb_hcd_giveback_urb (hcd, urb, NULL);
1519 }
1520 EXPORT_SYMBOL_GPL(usb_hcd_suspend_root_hub);
1521
1522 /**
1523  * usb_hcd_resume_root_hub - called by HCD to resume its root hub 
1524  * @hcd: host controller for this root hub
1525  *
1526  * The USB host controller calls this function when its root hub is
1527  * suspended (with the remote wakeup feature enabled) and a remote
1528  * wakeup request is received.  It queues a request for khubd to
1529  * resume the root hub (that is, manage its downstream ports again).
1530  */
1531 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1532 {
1533         unsigned long flags;
1534
1535         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1536         if (hcd->rh_registered)
1537                 usb_resume_root_hub (hcd->self.root_hub);
1538         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1539 }
1540 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1541
1542 #endif
1543
1544 /*-------------------------------------------------------------------------*/
1545
1546 #ifdef  CONFIG_USB_OTG
1547
1548 /**
1549  * usb_bus_start_enum - start immediate enumeration (for OTG)
1550  * @bus: the bus (must use hcd framework)
1551  * @port_num: 1-based number of port; usually bus->otg_port
1552  * Context: in_interrupt()
1553  *
1554  * Starts enumeration, with an immediate reset followed later by
1555  * khubd identifying and possibly configuring the device.
1556  * This is needed by OTG controller drivers, where it helps meet
1557  * HNP protocol timing requirements for starting a port reset.
1558  */
1559 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1560 {
1561         struct usb_hcd          *hcd;
1562         int                     status = -EOPNOTSUPP;
1563
1564         /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1565          * boards with root hubs hooked up to internal devices (instead of
1566          * just the OTG port) may need more attention to resetting...
1567          */
1568         hcd = container_of (bus, struct usb_hcd, self);
1569         if (port_num && hcd->driver->start_port_reset)
1570                 status = hcd->driver->start_port_reset(hcd, port_num);
1571
1572         /* run khubd shortly after (first) root port reset finishes;
1573          * it may issue others, until at least 50 msecs have passed.
1574          */
1575         if (status == 0)
1576                 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1577         return status;
1578 }
1579 EXPORT_SYMBOL (usb_bus_start_enum);
1580
1581 #endif
1582
1583 /*-------------------------------------------------------------------------*/
1584
1585 /*
1586  * usb_hcd_operations - adapts usb_bus framework to HCD framework (bus glue)
1587  */
1588 static struct usb_operations usb_hcd_operations = {
1589         .get_frame_number =     hcd_get_frame_number,
1590         .submit_urb =           hcd_submit_urb,
1591         .unlink_urb =           hcd_unlink_urb,
1592         .buffer_alloc =         hcd_buffer_alloc,
1593         .buffer_free =          hcd_buffer_free,
1594         .disable =              hcd_endpoint_disable,
1595 };
1596
1597 /*-------------------------------------------------------------------------*/
1598
1599 /**
1600  * usb_hcd_giveback_urb - return URB from HCD to device driver
1601  * @hcd: host controller returning the URB
1602  * @urb: urb being returned to the USB device driver.
1603  * @regs: pt_regs, passed down to the URB completion handler
1604  * Context: in_interrupt()
1605  *
1606  * This hands the URB from HCD to its USB device driver, using its
1607  * completion function.  The HCD has freed all per-urb resources
1608  * (and is done using urb->hcpriv).  It also released all HCD locks;
1609  * the device driver won't cause problems if it frees, modifies,
1610  * or resubmits this URB.
1611  */
1612 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs)
1613 {
1614         int at_root_hub;
1615
1616         at_root_hub = (urb->dev == hcd->self.root_hub);
1617         urb_unlink (urb);
1618
1619         /* lower level hcd code should use *_dma exclusively */
1620         if (hcd->self.controller->dma_mask && !at_root_hub) {
1621                 if (usb_pipecontrol (urb->pipe)
1622                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1623                         dma_unmap_single (hcd->self.controller, urb->setup_dma,
1624                                         sizeof (struct usb_ctrlrequest),
1625                                         DMA_TO_DEVICE);
1626                 if (urb->transfer_buffer_length != 0
1627                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1628                         dma_unmap_single (hcd->self.controller, 
1629                                         urb->transfer_dma,
1630                                         urb->transfer_buffer_length,
1631                                         usb_pipein (urb->pipe)
1632                                             ? DMA_FROM_DEVICE
1633                                             : DMA_TO_DEVICE);
1634         }
1635
1636         usbmon_urb_complete (&hcd->self, urb);
1637         /* pass ownership to the completion handler */
1638         urb->complete (urb, regs);
1639         atomic_dec (&urb->use_count);
1640         if (unlikely (urb->reject))
1641                 wake_up (&usb_kill_urb_queue);
1642         usb_put_urb (urb);
1643 }
1644 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1645
1646 /*-------------------------------------------------------------------------*/
1647
1648 /**
1649  * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1650  * @irq: the IRQ being raised
1651  * @__hcd: pointer to the HCD whose IRQ is being signaled
1652  * @r: saved hardware registers
1653  *
1654  * If the controller isn't HALTed, calls the driver's irq handler.
1655  * Checks whether the controller is now dead.
1656  */
1657 irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs * r)
1658 {
1659         struct usb_hcd          *hcd = __hcd;
1660         int                     start = hcd->state;
1661
1662         if (start == HC_STATE_HALT)
1663                 return IRQ_NONE;
1664         if (hcd->driver->irq (hcd, r) == IRQ_NONE)
1665                 return IRQ_NONE;
1666
1667         hcd->saw_irq = 1;
1668         if (hcd->state == HC_STATE_HALT)
1669                 usb_hc_died (hcd);
1670         return IRQ_HANDLED;
1671 }
1672
1673 /*-------------------------------------------------------------------------*/
1674
1675 /**
1676  * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1677  * @hcd: pointer to the HCD representing the controller
1678  *
1679  * This is called by bus glue to report a USB host controller that died
1680  * while operations may still have been pending.  It's called automatically
1681  * by the PCI glue, so only glue for non-PCI busses should need to call it. 
1682  */
1683 void usb_hc_died (struct usb_hcd *hcd)
1684 {
1685         unsigned long flags;
1686
1687         dev_err (hcd->self.controller, "HC died; cleaning up\n");
1688
1689         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1690         if (hcd->rh_registered) {
1691                 hcd->poll_rh = 0;
1692
1693                 /* make khubd clean up old urbs and devices */
1694                 usb_set_device_state (hcd->self.root_hub,
1695                                 USB_STATE_NOTATTACHED);
1696                 usb_kick_khubd (hcd->self.root_hub);
1697         }
1698         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1699 }
1700 EXPORT_SYMBOL_GPL (usb_hc_died);
1701
1702 /*-------------------------------------------------------------------------*/
1703
1704 static void hcd_release (struct usb_bus *bus)
1705 {
1706         struct usb_hcd *hcd;
1707
1708         hcd = container_of(bus, struct usb_hcd, self);
1709         kfree(hcd);
1710 }
1711
1712 /**
1713  * usb_create_hcd - create and initialize an HCD structure
1714  * @driver: HC driver that will use this hcd
1715  * @dev: device for this HC, stored in hcd->self.controller
1716  * @bus_name: value to store in hcd->self.bus_name
1717  * Context: !in_interrupt()
1718  *
1719  * Allocate a struct usb_hcd, with extra space at the end for the
1720  * HC driver's private data.  Initialize the generic members of the
1721  * hcd structure.
1722  *
1723  * If memory is unavailable, returns NULL.
1724  */
1725 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1726                 struct device *dev, char *bus_name)
1727 {
1728         struct usb_hcd *hcd;
1729
1730         hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1731         if (!hcd) {
1732                 dev_dbg (dev, "hcd alloc failed\n");
1733                 return NULL;
1734         }
1735         dev_set_drvdata(dev, hcd);
1736
1737         usb_bus_init(&hcd->self);
1738         hcd->self.op = &usb_hcd_operations;
1739         hcd->self.hcpriv = hcd;
1740         hcd->self.release = &hcd_release;
1741         hcd->self.controller = dev;
1742         hcd->self.bus_name = bus_name;
1743
1744         init_timer(&hcd->rh_timer);
1745         hcd->rh_timer.function = rh_timer_func;
1746         hcd->rh_timer.data = (unsigned long) hcd;
1747
1748         hcd->driver = driver;
1749         hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1750                         "USB Host Controller";
1751
1752         return hcd;
1753 }
1754 EXPORT_SYMBOL (usb_create_hcd);
1755
1756 void usb_put_hcd (struct usb_hcd *hcd)
1757 {
1758         dev_set_drvdata(hcd->self.controller, NULL);
1759         usb_bus_put(&hcd->self);
1760 }
1761 EXPORT_SYMBOL (usb_put_hcd);
1762
1763 /**
1764  * usb_add_hcd - finish generic HCD structure initialization and register
1765  * @hcd: the usb_hcd structure to initialize
1766  * @irqnum: Interrupt line to allocate
1767  * @irqflags: Interrupt type flags
1768  *
1769  * Finish the remaining parts of generic HCD initialization: allocate the
1770  * buffers of consistent memory, register the bus, request the IRQ line,
1771  * and call the driver's reset() and start() routines.
1772  */
1773 int usb_add_hcd(struct usb_hcd *hcd,
1774                 unsigned int irqnum, unsigned long irqflags)
1775 {
1776         int retval;
1777         struct usb_device *rhdev;
1778
1779         dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1780
1781         /* till now HC has been in an indeterminate state ... */
1782         if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1783                 dev_err(hcd->self.controller, "can't reset\n");
1784                 return retval;
1785         }
1786
1787         if ((retval = hcd_buffer_create(hcd)) != 0) {
1788                 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1789                 return retval;
1790         }
1791
1792         if ((retval = usb_register_bus(&hcd->self)) < 0)
1793                 goto err_register_bus;
1794
1795         if (hcd->driver->irq) {
1796                 char    buf[8], *bufp = buf;
1797
1798 #ifdef __sparc__
1799                 bufp = __irq_itoa(irqnum);
1800 #else
1801                 sprintf(buf, "%d", irqnum);
1802 #endif
1803
1804                 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1805                                 hcd->driver->description, hcd->self.busnum);
1806                 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1807                                 hcd->irq_descr, hcd)) != 0) {
1808                         dev_err(hcd->self.controller,
1809                                         "request interrupt %s failed\n", bufp);
1810                         goto err_request_irq;
1811                 }
1812                 hcd->irq = irqnum;
1813                 dev_info(hcd->self.controller, "irq %s, %s 0x%08llx\n", bufp,
1814                                 (hcd->driver->flags & HCD_MEMORY) ?
1815                                         "io mem" : "io base",
1816                                         (unsigned long long)hcd->rsrc_start);
1817         } else {
1818                 hcd->irq = -1;
1819                 if (hcd->rsrc_start)
1820                         dev_info(hcd->self.controller, "%s 0x%08llx\n",
1821                                         (hcd->driver->flags & HCD_MEMORY) ?
1822                                         "io mem" : "io base",
1823                                         (unsigned long long)hcd->rsrc_start);
1824         }
1825
1826         /* Allocate the root hub before calling hcd->driver->start(),
1827          * but don't register it until afterward so that the hardware
1828          * is running.
1829          */
1830         if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1831                 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1832                 retval = -ENOMEM;
1833                 goto err_allocate_root_hub;
1834         }
1835         rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1836                         USB_SPEED_FULL;
1837
1838         /* Although in principle hcd->driver->start() might need to use rhdev,
1839          * none of the current drivers do.
1840          */
1841         if ((retval = hcd->driver->start(hcd)) < 0) {
1842                 dev_err(hcd->self.controller, "startup error %d\n", retval);
1843                 goto err_hcd_driver_start;
1844         }
1845
1846         /* hcd->driver->start() reported can_wakeup, probably with
1847          * assistance from board's boot firmware.
1848          * NOTE:  normal devices won't enable wakeup by default.
1849          */
1850         if (hcd->can_wakeup)
1851                 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1852         hcd->remote_wakeup = hcd->can_wakeup;
1853
1854         if ((retval = register_root_hub(rhdev, hcd)) != 0)
1855                 goto err_register_root_hub;
1856
1857         if (hcd->uses_new_polling && hcd->poll_rh)
1858                 usb_hcd_poll_rh_status(hcd);
1859         return retval;
1860
1861  err_register_root_hub:
1862         hcd->driver->stop(hcd);
1863
1864  err_hcd_driver_start:
1865         usb_put_dev(rhdev);
1866
1867  err_allocate_root_hub:
1868         if (hcd->irq >= 0)
1869                 free_irq(irqnum, hcd);
1870
1871  err_request_irq:
1872         usb_deregister_bus(&hcd->self);
1873
1874  err_register_bus:
1875         hcd_buffer_destroy(hcd);
1876         return retval;
1877
1878 EXPORT_SYMBOL (usb_add_hcd);
1879
1880 /**
1881  * usb_remove_hcd - shutdown processing for generic HCDs
1882  * @hcd: the usb_hcd structure to remove
1883  * Context: !in_interrupt()
1884  *
1885  * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1886  * invoking the HCD's stop() method.
1887  */
1888 void usb_remove_hcd(struct usb_hcd *hcd)
1889 {
1890         dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1891
1892         if (HC_IS_RUNNING (hcd->state))
1893                 hcd->state = HC_STATE_QUIESCING;
1894
1895         dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1896         spin_lock_irq (&hcd_root_hub_lock);
1897         hcd->rh_registered = 0;
1898         spin_unlock_irq (&hcd_root_hub_lock);
1899         usb_disconnect(&hcd->self.root_hub);
1900
1901         hcd->poll_rh = 0;
1902         del_timer_sync(&hcd->rh_timer);
1903
1904         hcd->driver->stop(hcd);
1905         hcd->state = HC_STATE_HALT;
1906
1907         if (hcd->irq >= 0)
1908                 free_irq(hcd->irq, hcd);
1909         usb_deregister_bus(&hcd->self);
1910         hcd_buffer_destroy(hcd);
1911 }
1912 EXPORT_SYMBOL (usb_remove_hcd);
1913
1914 /*-------------------------------------------------------------------------*/
1915
1916 #if defined(CONFIG_USB_MON)
1917
1918 struct usb_mon_operations *mon_ops;
1919
1920 /*
1921  * The registration is unlocked.
1922  * We do it this way because we do not want to lock in hot paths.
1923  *
1924  * Notice that the code is minimally error-proof. Because usbmon needs
1925  * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1926  */
1927  
1928 int usb_mon_register (struct usb_mon_operations *ops)
1929 {
1930
1931         if (mon_ops)
1932                 return -EBUSY;
1933
1934         mon_ops = ops;
1935         mb();
1936         return 0;
1937 }
1938 EXPORT_SYMBOL_GPL (usb_mon_register);
1939
1940 void usb_mon_deregister (void)
1941 {
1942
1943         if (mon_ops == NULL) {
1944                 printk(KERN_ERR "USB: monitor was not registered\n");
1945                 return;
1946         }
1947         mon_ops = NULL;
1948         mb();
1949 }
1950 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1951
1952 #endif /* CONFIG_USB_MON */