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