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