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