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