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