USB: Eliminate urb->status usage!
[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         usb_hcd_unlink_urb_from_ep(hcd, urb);
536
537         /* This peculiar use of spinlocks echoes what real HC drivers do.
538          * Avoiding calls to local_irq_disable/enable makes the code
539          * RT-friendly.
540          */
541         spin_unlock(&hcd_root_hub_lock);
542         usb_hcd_giveback_urb(hcd, urb, status);
543         spin_lock(&hcd_root_hub_lock);
544
545         spin_unlock_irq(&hcd_root_hub_lock);
546         return 0;
547 }
548
549 /*-------------------------------------------------------------------------*/
550
551 /*
552  * Root Hub interrupt transfers are polled using a timer if the
553  * driver requests it; otherwise the driver is responsible for
554  * calling usb_hcd_poll_rh_status() when an event occurs.
555  *
556  * Completions are called in_interrupt(), but they may or may not
557  * be in_irq().
558  */
559 void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
560 {
561         struct urb      *urb;
562         int             length;
563         unsigned long   flags;
564         char            buffer[4];      /* Any root hubs with > 31 ports? */
565
566         if (unlikely(!hcd->rh_registered))
567                 return;
568         if (!hcd->uses_new_polling && !hcd->status_urb)
569                 return;
570
571         length = hcd->driver->hub_status_data(hcd, buffer);
572         if (length > 0) {
573
574                 /* try to complete the status urb */
575                 spin_lock_irqsave(&hcd_root_hub_lock, flags);
576                 urb = hcd->status_urb;
577                 if (urb) {
578                         hcd->poll_pending = 0;
579                         hcd->status_urb = NULL;
580                         urb->actual_length = length;
581                         memcpy(urb->transfer_buffer, buffer, length);
582
583                         usb_hcd_unlink_urb_from_ep(hcd, urb);
584                         spin_unlock(&hcd_root_hub_lock);
585                         usb_hcd_giveback_urb(hcd, urb, 0);
586                         spin_lock(&hcd_root_hub_lock);
587                 } else {
588                         length = 0;
589                         hcd->poll_pending = 1;
590                 }
591                 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
592         }
593
594         /* The USB 2.0 spec says 256 ms.  This is close enough and won't
595          * exceed that limit if HZ is 100. The math is more clunky than
596          * maybe expected, this is to make sure that all timers for USB devices
597          * fire at the same time to give the CPU a break inbetween */
598         if (hcd->uses_new_polling ? hcd->poll_rh :
599                         (length == 0 && hcd->status_urb != NULL))
600                 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
601 }
602 EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
603
604 /* timer callback */
605 static void rh_timer_func (unsigned long _hcd)
606 {
607         usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
608 }
609
610 /*-------------------------------------------------------------------------*/
611
612 static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
613 {
614         int             retval;
615         unsigned long   flags;
616         int             len = 1 + (urb->dev->maxchild / 8);
617
618         spin_lock_irqsave (&hcd_root_hub_lock, flags);
619         if (hcd->status_urb || urb->transfer_buffer_length < len) {
620                 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
621                 retval = -EINVAL;
622                 goto done;
623         }
624
625         retval = usb_hcd_link_urb_to_ep(hcd, urb);
626         if (retval)
627                 goto done;
628
629         hcd->status_urb = urb;
630         urb->hcpriv = hcd;      /* indicate it's queued */
631         if (!hcd->uses_new_polling)
632                 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
633
634         /* If a status change has already occurred, report it ASAP */
635         else if (hcd->poll_pending)
636                 mod_timer(&hcd->rh_timer, jiffies);
637         retval = 0;
638  done:
639         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
640         return retval;
641 }
642
643 static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
644 {
645         if (usb_endpoint_xfer_int(&urb->ep->desc))
646                 return rh_queue_status (hcd, urb);
647         if (usb_endpoint_xfer_control(&urb->ep->desc))
648                 return rh_call_control (hcd, urb);
649         return -EINVAL;
650 }
651
652 /*-------------------------------------------------------------------------*/
653
654 /* Unlinks of root-hub control URBs are legal, but they don't do anything
655  * since these URBs always execute synchronously.
656  */
657 static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
658 {
659         unsigned long   flags;
660         int             rc;
661
662         spin_lock_irqsave(&hcd_root_hub_lock, flags);
663         rc = usb_hcd_check_unlink_urb(hcd, urb, status);
664         if (rc)
665                 goto done;
666
667         if (usb_endpoint_num(&urb->ep->desc) == 0) {    /* Control URB */
668                 ;       /* Do nothing */
669
670         } else {                                /* Status URB */
671                 if (!hcd->uses_new_polling)
672                         del_timer (&hcd->rh_timer);
673                 if (urb == hcd->status_urb) {
674                         hcd->status_urb = NULL;
675                         usb_hcd_unlink_urb_from_ep(hcd, urb);
676
677                         spin_unlock(&hcd_root_hub_lock);
678                         usb_hcd_giveback_urb(hcd, urb, status);
679                         spin_lock(&hcd_root_hub_lock);
680                 }
681         }
682  done:
683         spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
684         return rc;
685 }
686
687
688
689 /*
690  * Show & store the current value of authorized_default
691  */
692 static ssize_t usb_host_authorized_default_show(struct device *dev,
693                                                 struct device_attribute *attr,
694                                                 char *buf)
695 {
696         struct usb_device *rh_usb_dev = to_usb_device(dev);
697         struct usb_bus *usb_bus = rh_usb_dev->bus;
698         struct usb_hcd *usb_hcd;
699
700         if (usb_bus == NULL)    /* FIXME: not sure if this case is possible */
701                 return -ENODEV;
702         usb_hcd = bus_to_hcd(usb_bus);
703         return snprintf(buf, PAGE_SIZE, "%u\n", usb_hcd->authorized_default);
704 }
705
706 static ssize_t usb_host_authorized_default_store(struct device *dev,
707                                                  struct device_attribute *attr,
708                                                  const char *buf, size_t size)
709 {
710         ssize_t result;
711         unsigned val;
712         struct usb_device *rh_usb_dev = to_usb_device(dev);
713         struct usb_bus *usb_bus = rh_usb_dev->bus;
714         struct usb_hcd *usb_hcd;
715
716         if (usb_bus == NULL)    /* FIXME: not sure if this case is possible */
717                 return -ENODEV;
718         usb_hcd = bus_to_hcd(usb_bus);
719         result = sscanf(buf, "%u\n", &val);
720         if (result == 1) {
721                 usb_hcd->authorized_default = val? 1 : 0;
722                 result = size;
723         }
724         else
725                 result = -EINVAL;
726         return result;
727 }
728
729 static DEVICE_ATTR(authorized_default, 0644,
730             usb_host_authorized_default_show,
731             usb_host_authorized_default_store);
732
733
734 /* Group all the USB bus attributes */
735 static struct attribute *usb_bus_attrs[] = {
736                 &dev_attr_authorized_default.attr,
737                 NULL,
738 };
739
740 static struct attribute_group usb_bus_attr_group = {
741         .name = NULL,   /* we want them in the same directory */
742         .attrs = usb_bus_attrs,
743 };
744
745
746
747 /*-------------------------------------------------------------------------*/
748
749 static struct class *usb_host_class;
750
751 int usb_host_init(void)
752 {
753         int retval = 0;
754
755         usb_host_class = class_create(THIS_MODULE, "usb_host");
756         if (IS_ERR(usb_host_class))
757                 retval = PTR_ERR(usb_host_class);
758         return retval;
759 }
760
761 void usb_host_cleanup(void)
762 {
763         class_destroy(usb_host_class);
764 }
765
766 /**
767  * usb_bus_init - shared initialization code
768  * @bus: the bus structure being initialized
769  *
770  * This code is used to initialize a usb_bus structure, memory for which is
771  * separately managed.
772  */
773 static void usb_bus_init (struct usb_bus *bus)
774 {
775         memset (&bus->devmap, 0, sizeof(struct usb_devmap));
776
777         bus->devnum_next = 1;
778
779         bus->root_hub = NULL;
780         bus->busnum = -1;
781         bus->bandwidth_allocated = 0;
782         bus->bandwidth_int_reqs  = 0;
783         bus->bandwidth_isoc_reqs = 0;
784
785         INIT_LIST_HEAD (&bus->bus_list);
786 }
787
788 /*-------------------------------------------------------------------------*/
789
790 /**
791  * usb_register_bus - registers the USB host controller with the usb core
792  * @bus: pointer to the bus to register
793  * Context: !in_interrupt()
794  *
795  * Assigns a bus number, and links the controller into usbcore data
796  * structures so that it can be seen by scanning the bus list.
797  */
798 static int usb_register_bus(struct usb_bus *bus)
799 {
800         int result = -E2BIG;
801         int busnum;
802
803         mutex_lock(&usb_bus_list_lock);
804         busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
805         if (busnum >= USB_MAXBUS) {
806                 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
807                 goto error_find_busnum;
808         }
809         set_bit (busnum, busmap.busmap);
810         bus->busnum = busnum;
811         bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0),
812                                              bus->controller, "usb_host%d",
813                                              busnum);
814         result = PTR_ERR(bus->class_dev);
815         if (IS_ERR(bus->class_dev))
816                 goto error_create_class_dev;
817         class_set_devdata(bus->class_dev, bus);
818
819         /* Add it to the local list of buses */
820         list_add (&bus->bus_list, &usb_bus_list);
821         mutex_unlock(&usb_bus_list_lock);
822
823         usb_notify_add_bus(bus);
824
825         dev_info (bus->controller, "new USB bus registered, assigned bus "
826                   "number %d\n", bus->busnum);
827         return 0;
828
829 error_create_class_dev:
830         clear_bit(busnum, busmap.busmap);
831 error_find_busnum:
832         mutex_unlock(&usb_bus_list_lock);
833         return result;
834 }
835
836 /**
837  * usb_deregister_bus - deregisters the USB host controller
838  * @bus: pointer to the bus to deregister
839  * Context: !in_interrupt()
840  *
841  * Recycles the bus number, and unlinks the controller from usbcore data
842  * structures so that it won't be seen by scanning the bus list.
843  */
844 static void usb_deregister_bus (struct usb_bus *bus)
845 {
846         dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
847
848         /*
849          * NOTE: make sure that all the devices are removed by the
850          * controller code, as well as having it call this when cleaning
851          * itself up
852          */
853         mutex_lock(&usb_bus_list_lock);
854         list_del (&bus->bus_list);
855         mutex_unlock(&usb_bus_list_lock);
856
857         usb_notify_remove_bus(bus);
858
859         clear_bit (bus->busnum, busmap.busmap);
860
861         class_device_unregister(bus->class_dev);
862 }
863
864 /**
865  * register_root_hub - called by usb_add_hcd() to register a root hub
866  * @hcd: host controller for this root hub
867  *
868  * This function registers the root hub with the USB subsystem.  It sets up
869  * the device properly in the device tree and then calls usb_new_device()
870  * to register the usb device.  It also assigns the root hub's USB address
871  * (always 1).
872  */
873 static int register_root_hub(struct usb_hcd *hcd)
874 {
875         struct device *parent_dev = hcd->self.controller;
876         struct usb_device *usb_dev = hcd->self.root_hub;
877         const int devnum = 1;
878         int retval;
879
880         usb_dev->devnum = devnum;
881         usb_dev->bus->devnum_next = devnum + 1;
882         memset (&usb_dev->bus->devmap.devicemap, 0,
883                         sizeof usb_dev->bus->devmap.devicemap);
884         set_bit (devnum, usb_dev->bus->devmap.devicemap);
885         usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
886
887         mutex_lock(&usb_bus_list_lock);
888
889         usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
890         retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
891         if (retval != sizeof usb_dev->descriptor) {
892                 mutex_unlock(&usb_bus_list_lock);
893                 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
894                                 usb_dev->dev.bus_id, retval);
895                 return (retval < 0) ? retval : -EMSGSIZE;
896         }
897
898         retval = usb_new_device (usb_dev);
899         if (retval) {
900                 dev_err (parent_dev, "can't register root hub for %s, %d\n",
901                                 usb_dev->dev.bus_id, retval);
902         }
903         mutex_unlock(&usb_bus_list_lock);
904
905         if (retval == 0) {
906                 spin_lock_irq (&hcd_root_hub_lock);
907                 hcd->rh_registered = 1;
908                 spin_unlock_irq (&hcd_root_hub_lock);
909
910                 /* Did the HC die before the root hub was registered? */
911                 if (hcd->state == HC_STATE_HALT)
912                         usb_hc_died (hcd);      /* This time clean up */
913         }
914
915         return retval;
916 }
917
918 void usb_enable_root_hub_irq (struct usb_bus *bus)
919 {
920         struct usb_hcd *hcd;
921
922         hcd = container_of (bus, struct usb_hcd, self);
923         if (hcd->driver->hub_irq_enable && hcd->state != HC_STATE_HALT)
924                 hcd->driver->hub_irq_enable (hcd);
925 }
926
927
928 /*-------------------------------------------------------------------------*/
929
930 /**
931  * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
932  * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
933  * @is_input: true iff the transaction sends data to the host
934  * @isoc: true for isochronous transactions, false for interrupt ones
935  * @bytecount: how many bytes in the transaction.
936  *
937  * Returns approximate bus time in nanoseconds for a periodic transaction.
938  * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
939  * scheduled in software, this function is only used for such scheduling.
940  */
941 long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
942 {
943         unsigned long   tmp;
944
945         switch (speed) {
946         case USB_SPEED_LOW:     /* INTR only */
947                 if (is_input) {
948                         tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
949                         return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
950                 } else {
951                         tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
952                         return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
953                 }
954         case USB_SPEED_FULL:    /* ISOC or INTR */
955                 if (isoc) {
956                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
957                         return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
958                 } else {
959                         tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
960                         return (9107L + BW_HOST_DELAY + tmp);
961                 }
962         case USB_SPEED_HIGH:    /* ISOC or INTR */
963                 // FIXME adjust for input vs output
964                 if (isoc)
965                         tmp = HS_NSECS_ISO (bytecount);
966                 else
967                         tmp = HS_NSECS (bytecount);
968                 return tmp;
969         default:
970                 pr_debug ("%s: bogus device speed!\n", usbcore_name);
971                 return -1;
972         }
973 }
974 EXPORT_SYMBOL (usb_calc_bus_time);
975
976
977 /*-------------------------------------------------------------------------*/
978
979 /*
980  * Generic HC operations.
981  */
982
983 /*-------------------------------------------------------------------------*/
984
985 /**
986  * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
987  * @hcd: host controller to which @urb was submitted
988  * @urb: URB being submitted
989  *
990  * Host controller drivers should call this routine in their enqueue()
991  * method.  The HCD's private spinlock must be held and interrupts must
992  * be disabled.  The actions carried out here are required for URB
993  * submission, as well as for endpoint shutdown and for usb_kill_urb.
994  *
995  * Returns 0 for no error, otherwise a negative error code (in which case
996  * the enqueue() method must fail).  If no error occurs but enqueue() fails
997  * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
998  * the private spinlock and returning.
999  */
1000 int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1001 {
1002         int             rc = 0;
1003
1004         spin_lock(&hcd_urb_list_lock);
1005
1006         /* Check that the URB isn't being killed */
1007         if (unlikely(urb->reject)) {
1008                 rc = -EPERM;
1009                 goto done;
1010         }
1011
1012         if (unlikely(!urb->ep->enabled)) {
1013                 rc = -ENOENT;
1014                 goto done;
1015         }
1016
1017         /*
1018          * Check the host controller's state and add the URB to the
1019          * endpoint's queue.
1020          */
1021         switch (hcd->state) {
1022         case HC_STATE_RUNNING:
1023         case HC_STATE_RESUMING:
1024                 urb->unlinked = 0;
1025                 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1026                 break;
1027         default:
1028                 rc = -ESHUTDOWN;
1029                 goto done;
1030         }
1031  done:
1032         spin_unlock(&hcd_urb_list_lock);
1033         return rc;
1034 }
1035 EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1036
1037 /**
1038  * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1039  * @hcd: host controller to which @urb was submitted
1040  * @urb: URB being checked for unlinkability
1041  * @status: error code to store in @urb if the unlink succeeds
1042  *
1043  * Host controller drivers should call this routine in their dequeue()
1044  * method.  The HCD's private spinlock must be held and interrupts must
1045  * be disabled.  The actions carried out here are required for making
1046  * sure than an unlink is valid.
1047  *
1048  * Returns 0 for no error, otherwise a negative error code (in which case
1049  * the dequeue() method must fail).  The possible error codes are:
1050  *
1051  *      -EIDRM: @urb was not submitted or has already completed.
1052  *              The completion function may not have been called yet.
1053  *
1054  *      -EBUSY: @urb has already been unlinked.
1055  */
1056 int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1057                 int status)
1058 {
1059         struct list_head        *tmp;
1060
1061         /* insist the urb is still queued */
1062         list_for_each(tmp, &urb->ep->urb_list) {
1063                 if (tmp == &urb->urb_list)
1064                         break;
1065         }
1066         if (tmp != &urb->urb_list)
1067                 return -EIDRM;
1068
1069         /* Any status except -EINPROGRESS means something already started to
1070          * unlink this URB from the hardware.  So there's no more work to do.
1071          */
1072         if (urb->unlinked)
1073                 return -EBUSY;
1074         urb->unlinked = status;
1075
1076         /* IRQ setup can easily be broken so that USB controllers
1077          * never get completion IRQs ... maybe even the ones we need to
1078          * finish unlinking the initial failed usb_set_address()
1079          * or device descriptor fetch.
1080          */
1081         if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags) &&
1082                         !is_root_hub(urb->dev)) {
1083                 dev_warn(hcd->self.controller, "Unlink after no-IRQ?  "
1084                         "Controller is probably using the wrong IRQ.\n");
1085                 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1086         }
1087
1088         return 0;
1089 }
1090 EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1091
1092 /**
1093  * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1094  * @hcd: host controller to which @urb was submitted
1095  * @urb: URB being unlinked
1096  *
1097  * Host controller drivers should call this routine before calling
1098  * usb_hcd_giveback_urb().  The HCD's private spinlock must be held and
1099  * interrupts must be disabled.  The actions carried out here are required
1100  * for URB completion.
1101  */
1102 void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1103 {
1104         /* clear all state linking urb to this dev (and hcd) */
1105         spin_lock(&hcd_urb_list_lock);
1106         list_del_init(&urb->urb_list);
1107         spin_unlock(&hcd_urb_list_lock);
1108 }
1109 EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1110
1111 static void map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1112 {
1113         /* Map the URB's buffers for DMA access.
1114          * Lower level HCD code should use *_dma exclusively,
1115          * unless it uses pio or talks to another transport.
1116          */
1117         if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
1118                 if (usb_endpoint_xfer_control(&urb->ep->desc)
1119                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1120                         urb->setup_dma = dma_map_single (
1121                                         hcd->self.controller,
1122                                         urb->setup_packet,
1123                                         sizeof (struct usb_ctrlrequest),
1124                                         DMA_TO_DEVICE);
1125                 if (urb->transfer_buffer_length != 0
1126                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1127                         urb->transfer_dma = dma_map_single (
1128                                         hcd->self.controller,
1129                                         urb->transfer_buffer,
1130                                         urb->transfer_buffer_length,
1131                                         usb_urb_dir_in(urb)
1132                                             ? DMA_FROM_DEVICE
1133                                             : DMA_TO_DEVICE);
1134         }
1135 }
1136
1137 static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1138 {
1139         if (hcd->self.uses_dma && !is_root_hub(urb->dev)) {
1140                 if (usb_endpoint_xfer_control(&urb->ep->desc)
1141                         && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
1142                         dma_unmap_single(hcd->self.controller, urb->setup_dma,
1143                                         sizeof(struct usb_ctrlrequest),
1144                                         DMA_TO_DEVICE);
1145                 if (urb->transfer_buffer_length != 0
1146                         && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP))
1147                         dma_unmap_single(hcd->self.controller,
1148                                         urb->transfer_dma,
1149                                         urb->transfer_buffer_length,
1150                                         usb_urb_dir_in(urb)
1151                                             ? DMA_FROM_DEVICE
1152                                             : DMA_TO_DEVICE);
1153         }
1154 }
1155
1156 /*-------------------------------------------------------------------------*/
1157
1158 /* may be called in any context with a valid urb->dev usecount
1159  * caller surrenders "ownership" of urb
1160  * expects usb_submit_urb() to have sanity checked and conditioned all
1161  * inputs in the urb
1162  */
1163 int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1164 {
1165         int                     status;
1166         struct usb_hcd          *hcd = bus_to_hcd(urb->dev->bus);
1167
1168         /* increment urb's reference count as part of giving it to the HCD
1169          * (which will control it).  HCD guarantees that it either returns
1170          * an error or calls giveback(), but not both.
1171          */
1172         usb_get_urb(urb);
1173         atomic_inc(&urb->use_count);
1174         usbmon_urb_submit(&hcd->self, urb);
1175
1176         /* NOTE requirements on root-hub callers (usbfs and the hub
1177          * driver, for now):  URBs' urb->transfer_buffer must be
1178          * valid and usb_buffer_{sync,unmap}() not be needed, since
1179          * they could clobber root hub response data.  Also, control
1180          * URBs must be submitted in process context with interrupts
1181          * enabled.
1182          */
1183         map_urb_for_dma(hcd, urb);
1184         if (is_root_hub(urb->dev))
1185                 status = rh_urb_enqueue(hcd, urb);
1186         else
1187                 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1188
1189         if (unlikely(status)) {
1190                 usbmon_urb_submit_error(&hcd->self, urb, status);
1191                 unmap_urb_for_dma(hcd, urb);
1192                 urb->hcpriv = NULL;
1193                 INIT_LIST_HEAD(&urb->urb_list);
1194                 atomic_dec(&urb->use_count);
1195                 if (urb->reject)
1196                         wake_up(&usb_kill_urb_queue);
1197                 usb_put_urb(urb);
1198         }
1199         return status;
1200 }
1201
1202 /*-------------------------------------------------------------------------*/
1203
1204 /* this makes the hcd giveback() the urb more quickly, by kicking it
1205  * off hardware queues (which may take a while) and returning it as
1206  * soon as practical.  we've already set up the urb's return status,
1207  * but we can't know if the callback completed already.
1208  */
1209 static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1210 {
1211         int             value;
1212
1213         if (is_root_hub(urb->dev))
1214                 value = usb_rh_urb_dequeue(hcd, urb, status);
1215         else {
1216
1217                 /* The only reason an HCD might fail this call is if
1218                  * it has not yet fully queued the urb to begin with.
1219                  * Such failures should be harmless. */
1220                 value = hcd->driver->urb_dequeue(hcd, urb, status);
1221         }
1222         return value;
1223 }
1224
1225 /*
1226  * called in any context
1227  *
1228  * caller guarantees urb won't be recycled till both unlink()
1229  * and the urb's completion function return
1230  */
1231 int usb_hcd_unlink_urb (struct urb *urb, int status)
1232 {
1233         struct usb_hcd          *hcd;
1234         int                     retval;
1235
1236         hcd = bus_to_hcd(urb->dev->bus);
1237         retval = unlink1(hcd, urb, status);
1238
1239         if (retval == 0)
1240                 retval = -EINPROGRESS;
1241         else if (retval != -EIDRM && retval != -EBUSY)
1242                 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1243                                 urb, retval);
1244         return retval;
1245 }
1246
1247 /*-------------------------------------------------------------------------*/
1248
1249 /**
1250  * usb_hcd_giveback_urb - return URB from HCD to device driver
1251  * @hcd: host controller returning the URB
1252  * @urb: urb being returned to the USB device driver.
1253  * @status: completion status code for the URB.
1254  * Context: in_interrupt()
1255  *
1256  * This hands the URB from HCD to its USB device driver, using its
1257  * completion function.  The HCD has freed all per-urb resources
1258  * (and is done using urb->hcpriv).  It also released all HCD locks;
1259  * the device driver won't cause problems if it frees, modifies,
1260  * or resubmits this URB.
1261  *
1262  * If @urb was unlinked, the value of @status will be overridden by
1263  * @urb->unlinked.  Erroneous short transfers are detected in case
1264  * the HCD hasn't checked for them.
1265  */
1266 void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
1267 {
1268         urb->hcpriv = NULL;
1269         if (unlikely(urb->unlinked))
1270                 status = urb->unlinked;
1271         else if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1272                         urb->actual_length < urb->transfer_buffer_length &&
1273                         !status))
1274                 status = -EREMOTEIO;
1275
1276         unmap_urb_for_dma(hcd, urb);
1277         usbmon_urb_complete(&hcd->self, urb, status);
1278         usb_unanchor_urb(urb);
1279
1280         /* pass ownership to the completion handler */
1281         urb->status = status;
1282         urb->complete (urb);
1283         atomic_dec (&urb->use_count);
1284         if (unlikely (urb->reject))
1285                 wake_up (&usb_kill_urb_queue);
1286         usb_put_urb (urb);
1287 }
1288 EXPORT_SYMBOL (usb_hcd_giveback_urb);
1289
1290 /*-------------------------------------------------------------------------*/
1291
1292 /* disables the endpoint: cancels any pending urbs, then synchronizes with
1293  * the hcd to make sure all endpoint state is gone from hardware, and then
1294  * waits until the endpoint's queue is completely drained. use for
1295  * set_configuration, set_interface, driver removal, physical disconnect.
1296  *
1297  * example:  a qh stored in ep->hcpriv, holding state related to endpoint
1298  * type, maxpacket size, toggle, halt status, and scheduling.
1299  */
1300 void usb_hcd_endpoint_disable (struct usb_device *udev,
1301                 struct usb_host_endpoint *ep)
1302 {
1303         struct usb_hcd          *hcd;
1304         struct urb              *urb;
1305
1306         might_sleep();
1307         hcd = bus_to_hcd(udev->bus);
1308
1309         /* ep is already gone from udev->ep_{in,out}[]; no more submits */
1310 rescan:
1311         spin_lock_irq(&hcd_urb_list_lock);
1312         list_for_each_entry (urb, &ep->urb_list, urb_list) {
1313                 int     is_in;
1314
1315                 if (urb->unlinked)
1316                         continue;
1317                 usb_get_urb (urb);
1318                 is_in = usb_urb_dir_in(urb);
1319                 spin_unlock(&hcd_urb_list_lock);
1320
1321                 /* kick hcd */
1322                 unlink1(hcd, urb, -ESHUTDOWN);
1323                 dev_dbg (hcd->self.controller,
1324                         "shutdown urb %p ep%d%s%s\n",
1325                         urb, usb_endpoint_num(&ep->desc),
1326                         is_in ? "in" : "out",
1327                         ({      char *s;
1328
1329                                  switch (usb_endpoint_type(&ep->desc)) {
1330                                  case USB_ENDPOINT_XFER_CONTROL:
1331                                         s = ""; break;
1332                                  case USB_ENDPOINT_XFER_BULK:
1333                                         s = "-bulk"; break;
1334                                  case USB_ENDPOINT_XFER_INT:
1335                                         s = "-intr"; break;
1336                                  default:
1337                                         s = "-iso"; break;
1338                                 };
1339                                 s;
1340                         }));
1341                 usb_put_urb (urb);
1342
1343                 /* list contents may have changed */
1344                 goto rescan;
1345         }
1346         spin_unlock_irq(&hcd_urb_list_lock);
1347
1348         /* synchronize with the hardware, so old configuration state
1349          * clears out immediately (and will be freed).
1350          */
1351         if (hcd->driver->endpoint_disable)
1352                 hcd->driver->endpoint_disable (hcd, ep);
1353
1354         /* Wait until the endpoint queue is completely empty.  Most HCDs
1355          * will have done this already in their endpoint_disable method,
1356          * but some might not.  And there could be root-hub control URBs
1357          * still pending since they aren't affected by the HCDs'
1358          * endpoint_disable methods.
1359          */
1360         while (!list_empty (&ep->urb_list)) {
1361                 spin_lock_irq(&hcd_urb_list_lock);
1362
1363                 /* The list may have changed while we acquired the spinlock */
1364                 urb = NULL;
1365                 if (!list_empty (&ep->urb_list)) {
1366                         urb = list_entry (ep->urb_list.prev, struct urb,
1367                                         urb_list);
1368                         usb_get_urb (urb);
1369                 }
1370                 spin_unlock_irq(&hcd_urb_list_lock);
1371
1372                 if (urb) {
1373                         usb_kill_urb (urb);
1374                         usb_put_urb (urb);
1375                 }
1376         }
1377 }
1378
1379 /*-------------------------------------------------------------------------*/
1380
1381 /* called in any context */
1382 int usb_hcd_get_frame_number (struct usb_device *udev)
1383 {
1384         struct usb_hcd  *hcd = bus_to_hcd(udev->bus);
1385
1386         if (!HC_IS_RUNNING (hcd->state))
1387                 return -ESHUTDOWN;
1388         return hcd->driver->get_frame_number (hcd);
1389 }
1390
1391 /*-------------------------------------------------------------------------*/
1392
1393 #ifdef  CONFIG_PM
1394
1395 int hcd_bus_suspend(struct usb_device *rhdev)
1396 {
1397         struct usb_hcd  *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1398         int             status;
1399         int             old_state = hcd->state;
1400
1401         dev_dbg(&rhdev->dev, "bus %s%s\n",
1402                         rhdev->auto_pm ? "auto-" : "", "suspend");
1403         if (!hcd->driver->bus_suspend) {
1404                 status = -ENOENT;
1405         } else {
1406                 hcd->state = HC_STATE_QUIESCING;
1407                 status = hcd->driver->bus_suspend(hcd);
1408         }
1409         if (status == 0) {
1410                 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
1411                 hcd->state = HC_STATE_SUSPENDED;
1412         } else {
1413                 hcd->state = old_state;
1414                 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1415                                 "suspend", status);
1416         }
1417         return status;
1418 }
1419
1420 int hcd_bus_resume(struct usb_device *rhdev)
1421 {
1422         struct usb_hcd  *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1423         int             status;
1424         int             old_state = hcd->state;
1425
1426         dev_dbg(&rhdev->dev, "usb %s%s\n",
1427                         rhdev->auto_pm ? "auto-" : "", "resume");
1428         if (!hcd->driver->bus_resume)
1429                 return -ENOENT;
1430         if (hcd->state == HC_STATE_RUNNING)
1431                 return 0;
1432
1433         hcd->state = HC_STATE_RESUMING;
1434         status = hcd->driver->bus_resume(hcd);
1435         if (status == 0) {
1436                 /* TRSMRCY = 10 msec */
1437                 msleep(10);
1438                 usb_set_device_state(rhdev, rhdev->actconfig
1439                                 ? USB_STATE_CONFIGURED
1440                                 : USB_STATE_ADDRESS);
1441                 hcd->state = HC_STATE_RUNNING;
1442         } else {
1443                 hcd->state = old_state;
1444                 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1445                                 "resume", status);
1446                 if (status != -ESHUTDOWN)
1447                         usb_hc_died(hcd);
1448         }
1449         return status;
1450 }
1451
1452 /* Workqueue routine for root-hub remote wakeup */
1453 static void hcd_resume_work(struct work_struct *work)
1454 {
1455         struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
1456         struct usb_device *udev = hcd->self.root_hub;
1457
1458         usb_lock_device(udev);
1459         usb_mark_last_busy(udev);
1460         usb_external_resume_device(udev);
1461         usb_unlock_device(udev);
1462 }
1463
1464 /**
1465  * usb_hcd_resume_root_hub - called by HCD to resume its root hub 
1466  * @hcd: host controller for this root hub
1467  *
1468  * The USB host controller calls this function when its root hub is
1469  * suspended (with the remote wakeup feature enabled) and a remote
1470  * wakeup request is received.  The routine submits a workqueue request
1471  * to resume the root hub (that is, manage its downstream ports again).
1472  */
1473 void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
1474 {
1475         unsigned long flags;
1476
1477         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1478         if (hcd->rh_registered)
1479                 queue_work(ksuspend_usb_wq, &hcd->wakeup_work);
1480         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1481 }
1482 EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1483
1484 #endif
1485
1486 /*-------------------------------------------------------------------------*/
1487
1488 #ifdef  CONFIG_USB_OTG
1489
1490 /**
1491  * usb_bus_start_enum - start immediate enumeration (for OTG)
1492  * @bus: the bus (must use hcd framework)
1493  * @port_num: 1-based number of port; usually bus->otg_port
1494  * Context: in_interrupt()
1495  *
1496  * Starts enumeration, with an immediate reset followed later by
1497  * khubd identifying and possibly configuring the device.
1498  * This is needed by OTG controller drivers, where it helps meet
1499  * HNP protocol timing requirements for starting a port reset.
1500  */
1501 int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
1502 {
1503         struct usb_hcd          *hcd;
1504         int                     status = -EOPNOTSUPP;
1505
1506         /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
1507          * boards with root hubs hooked up to internal devices (instead of
1508          * just the OTG port) may need more attention to resetting...
1509          */
1510         hcd = container_of (bus, struct usb_hcd, self);
1511         if (port_num && hcd->driver->start_port_reset)
1512                 status = hcd->driver->start_port_reset(hcd, port_num);
1513
1514         /* run khubd shortly after (first) root port reset finishes;
1515          * it may issue others, until at least 50 msecs have passed.
1516          */
1517         if (status == 0)
1518                 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
1519         return status;
1520 }
1521 EXPORT_SYMBOL (usb_bus_start_enum);
1522
1523 #endif
1524
1525 /*-------------------------------------------------------------------------*/
1526
1527 /**
1528  * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
1529  * @irq: the IRQ being raised
1530  * @__hcd: pointer to the HCD whose IRQ is being signaled
1531  * @r: saved hardware registers
1532  *
1533  * If the controller isn't HALTed, calls the driver's irq handler.
1534  * Checks whether the controller is now dead.
1535  */
1536 irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1537 {
1538         struct usb_hcd          *hcd = __hcd;
1539         int                     start = hcd->state;
1540
1541         if (unlikely(start == HC_STATE_HALT ||
1542             !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)))
1543                 return IRQ_NONE;
1544         if (hcd->driver->irq (hcd) == IRQ_NONE)
1545                 return IRQ_NONE;
1546
1547         set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1548
1549         if (unlikely(hcd->state == HC_STATE_HALT))
1550                 usb_hc_died (hcd);
1551         return IRQ_HANDLED;
1552 }
1553
1554 /*-------------------------------------------------------------------------*/
1555
1556 /**
1557  * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
1558  * @hcd: pointer to the HCD representing the controller
1559  *
1560  * This is called by bus glue to report a USB host controller that died
1561  * while operations may still have been pending.  It's called automatically
1562  * by the PCI glue, so only glue for non-PCI busses should need to call it. 
1563  */
1564 void usb_hc_died (struct usb_hcd *hcd)
1565 {
1566         unsigned long flags;
1567
1568         dev_err (hcd->self.controller, "HC died; cleaning up\n");
1569
1570         spin_lock_irqsave (&hcd_root_hub_lock, flags);
1571         if (hcd->rh_registered) {
1572                 hcd->poll_rh = 0;
1573
1574                 /* make khubd clean up old urbs and devices */
1575                 usb_set_device_state (hcd->self.root_hub,
1576                                 USB_STATE_NOTATTACHED);
1577                 usb_kick_khubd (hcd->self.root_hub);
1578         }
1579         spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
1580 }
1581 EXPORT_SYMBOL_GPL (usb_hc_died);
1582
1583 /*-------------------------------------------------------------------------*/
1584
1585 /**
1586  * usb_create_hcd - create and initialize an HCD structure
1587  * @driver: HC driver that will use this hcd
1588  * @dev: device for this HC, stored in hcd->self.controller
1589  * @bus_name: value to store in hcd->self.bus_name
1590  * Context: !in_interrupt()
1591  *
1592  * Allocate a struct usb_hcd, with extra space at the end for the
1593  * HC driver's private data.  Initialize the generic members of the
1594  * hcd structure.
1595  *
1596  * If memory is unavailable, returns NULL.
1597  */
1598 struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1599                 struct device *dev, char *bus_name)
1600 {
1601         struct usb_hcd *hcd;
1602
1603         hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1604         if (!hcd) {
1605                 dev_dbg (dev, "hcd alloc failed\n");
1606                 return NULL;
1607         }
1608         dev_set_drvdata(dev, hcd);
1609         kref_init(&hcd->kref);
1610
1611         usb_bus_init(&hcd->self);
1612         hcd->self.controller = dev;
1613         hcd->self.bus_name = bus_name;
1614         hcd->self.uses_dma = (dev->dma_mask != NULL);
1615
1616         init_timer(&hcd->rh_timer);
1617         hcd->rh_timer.function = rh_timer_func;
1618         hcd->rh_timer.data = (unsigned long) hcd;
1619 #ifdef CONFIG_PM
1620         INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
1621 #endif
1622
1623         hcd->driver = driver;
1624         hcd->product_desc = (driver->product_desc) ? driver->product_desc :
1625                         "USB Host Controller";
1626         return hcd;
1627 }
1628 EXPORT_SYMBOL (usb_create_hcd);
1629
1630 static void hcd_release (struct kref *kref)
1631 {
1632         struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
1633
1634         kfree(hcd);
1635 }
1636
1637 struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
1638 {
1639         if (hcd)
1640                 kref_get (&hcd->kref);
1641         return hcd;
1642 }
1643 EXPORT_SYMBOL (usb_get_hcd);
1644
1645 void usb_put_hcd (struct usb_hcd *hcd)
1646 {
1647         if (hcd)
1648                 kref_put (&hcd->kref, hcd_release);
1649 }
1650 EXPORT_SYMBOL (usb_put_hcd);
1651
1652 /**
1653  * usb_add_hcd - finish generic HCD structure initialization and register
1654  * @hcd: the usb_hcd structure to initialize
1655  * @irqnum: Interrupt line to allocate
1656  * @irqflags: Interrupt type flags
1657  *
1658  * Finish the remaining parts of generic HCD initialization: allocate the
1659  * buffers of consistent memory, register the bus, request the IRQ line,
1660  * and call the driver's reset() and start() routines.
1661  */
1662 int usb_add_hcd(struct usb_hcd *hcd,
1663                 unsigned int irqnum, unsigned long irqflags)
1664 {
1665         int retval;
1666         struct usb_device *rhdev;
1667
1668         dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
1669
1670         hcd->authorized_default = hcd->wireless? 0 : 1;
1671         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1672
1673         /* HC is in reset state, but accessible.  Now do the one-time init,
1674          * bottom up so that hcds can customize the root hubs before khubd
1675          * starts talking to them.  (Note, bus id is assigned early too.)
1676          */
1677         if ((retval = hcd_buffer_create(hcd)) != 0) {
1678                 dev_dbg(hcd->self.controller, "pool alloc failed\n");
1679                 return retval;
1680         }
1681
1682         if ((retval = usb_register_bus(&hcd->self)) < 0)
1683                 goto err_register_bus;
1684
1685         if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
1686                 dev_err(hcd->self.controller, "unable to allocate root hub\n");
1687                 retval = -ENOMEM;
1688                 goto err_allocate_root_hub;
1689         }
1690         rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
1691                         USB_SPEED_FULL;
1692         hcd->self.root_hub = rhdev;
1693
1694         /* wakeup flag init defaults to "everything works" for root hubs,
1695          * but drivers can override it in reset() if needed, along with
1696          * recording the overall controller's system wakeup capability.
1697          */
1698         device_init_wakeup(&rhdev->dev, 1);
1699
1700         /* "reset" is misnamed; its role is now one-time init. the controller
1701          * should already have been reset (and boot firmware kicked off etc).
1702          */
1703         if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
1704                 dev_err(hcd->self.controller, "can't setup\n");
1705                 goto err_hcd_driver_setup;
1706         }
1707
1708         /* NOTE: root hub and controller capabilities may not be the same */
1709         if (device_can_wakeup(hcd->self.controller)
1710                         && device_can_wakeup(&hcd->self.root_hub->dev))
1711                 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
1712
1713         /* enable irqs just before we start the controller */
1714         if (hcd->driver->irq) {
1715                 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
1716                                 hcd->driver->description, hcd->self.busnum);
1717                 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
1718                                 hcd->irq_descr, hcd)) != 0) {
1719                         dev_err(hcd->self.controller,
1720                                         "request interrupt %d failed\n", irqnum);
1721                         goto err_request_irq;
1722                 }
1723                 hcd->irq = irqnum;
1724                 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1725                                 (hcd->driver->flags & HCD_MEMORY) ?
1726                                         "io mem" : "io base",
1727                                         (unsigned long long)hcd->rsrc_start);
1728         } else {
1729                 hcd->irq = -1;
1730                 if (hcd->rsrc_start)
1731                         dev_info(hcd->self.controller, "%s 0x%08llx\n",
1732                                         (hcd->driver->flags & HCD_MEMORY) ?
1733                                         "io mem" : "io base",
1734                                         (unsigned long long)hcd->rsrc_start);
1735         }
1736
1737         if ((retval = hcd->driver->start(hcd)) < 0) {
1738                 dev_err(hcd->self.controller, "startup error %d\n", retval);
1739                 goto err_hcd_driver_start;
1740         }
1741
1742         /* starting here, usbcore will pay attention to this root hub */
1743         rhdev->bus_mA = min(500u, hcd->power_budget);
1744         if ((retval = register_root_hub(hcd)) != 0)
1745                 goto err_register_root_hub;
1746
1747         retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
1748         if (retval < 0) {
1749                 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
1750                        retval);
1751                 goto error_create_attr_group;
1752         }
1753         if (hcd->uses_new_polling && hcd->poll_rh)
1754                 usb_hcd_poll_rh_status(hcd);
1755         return retval;
1756
1757 error_create_attr_group:
1758         mutex_lock(&usb_bus_list_lock);
1759         usb_disconnect(&hcd->self.root_hub);
1760         mutex_unlock(&usb_bus_list_lock);
1761 err_register_root_hub:
1762         hcd->driver->stop(hcd);
1763 err_hcd_driver_start:
1764         if (hcd->irq >= 0)
1765                 free_irq(irqnum, hcd);
1766 err_request_irq:
1767 err_hcd_driver_setup:
1768         hcd->self.root_hub = NULL;
1769         usb_put_dev(rhdev);
1770 err_allocate_root_hub:
1771         usb_deregister_bus(&hcd->self);
1772 err_register_bus:
1773         hcd_buffer_destroy(hcd);
1774         return retval;
1775
1776 EXPORT_SYMBOL (usb_add_hcd);
1777
1778 /**
1779  * usb_remove_hcd - shutdown processing for generic HCDs
1780  * @hcd: the usb_hcd structure to remove
1781  * Context: !in_interrupt()
1782  *
1783  * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
1784  * invoking the HCD's stop() method.
1785  */
1786 void usb_remove_hcd(struct usb_hcd *hcd)
1787 {
1788         dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
1789
1790         if (HC_IS_RUNNING (hcd->state))
1791                 hcd->state = HC_STATE_QUIESCING;
1792
1793         dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
1794         spin_lock_irq (&hcd_root_hub_lock);
1795         hcd->rh_registered = 0;
1796         spin_unlock_irq (&hcd_root_hub_lock);
1797
1798 #ifdef CONFIG_PM
1799         cancel_work_sync(&hcd->wakeup_work);
1800 #endif
1801
1802         sysfs_remove_group(&hcd->self.root_hub->dev.kobj, &usb_bus_attr_group);
1803         mutex_lock(&usb_bus_list_lock);
1804         usb_disconnect(&hcd->self.root_hub);
1805         mutex_unlock(&usb_bus_list_lock);
1806
1807         hcd->driver->stop(hcd);
1808         hcd->state = HC_STATE_HALT;
1809
1810         hcd->poll_rh = 0;
1811         del_timer_sync(&hcd->rh_timer);
1812
1813         if (hcd->irq >= 0)
1814                 free_irq(hcd->irq, hcd);
1815         usb_deregister_bus(&hcd->self);
1816         hcd_buffer_destroy(hcd);
1817 }
1818 EXPORT_SYMBOL (usb_remove_hcd);
1819
1820 void
1821 usb_hcd_platform_shutdown(struct platform_device* dev)
1822 {
1823         struct usb_hcd *hcd = platform_get_drvdata(dev);
1824
1825         if (hcd->driver->shutdown)
1826                 hcd->driver->shutdown(hcd);
1827 }
1828 EXPORT_SYMBOL (usb_hcd_platform_shutdown);
1829
1830 /*-------------------------------------------------------------------------*/
1831
1832 #if defined(CONFIG_USB_MON)
1833
1834 struct usb_mon_operations *mon_ops;
1835
1836 /*
1837  * The registration is unlocked.
1838  * We do it this way because we do not want to lock in hot paths.
1839  *
1840  * Notice that the code is minimally error-proof. Because usbmon needs
1841  * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
1842  */
1843  
1844 int usb_mon_register (struct usb_mon_operations *ops)
1845 {
1846
1847         if (mon_ops)
1848                 return -EBUSY;
1849
1850         mon_ops = ops;
1851         mb();
1852         return 0;
1853 }
1854 EXPORT_SYMBOL_GPL (usb_mon_register);
1855
1856 void usb_mon_deregister (void)
1857 {
1858
1859         if (mon_ops == NULL) {
1860                 printk(KERN_ERR "USB: monitor was not registered\n");
1861                 return;
1862         }
1863         mon_ops = NULL;
1864         mb();
1865 }
1866 EXPORT_SYMBOL_GPL (usb_mon_deregister);
1867
1868 #endif /* CONFIG_USB_MON */