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