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