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