projects / GitHub / mt8127 / android_kernel_alcatel_ttab.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
USB: Remove unused timeout from io_edgeport.c
[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>
1da177e4
LT		 33#include <linux/device.h>
34#include <linux/dma-mapping.h>
4186ecf8 35#include <linux/mutex.h>
1da177e4
LT		 36#include <asm/irq.h>
37#include <asm/byteorder.h>
b3476675 38#include <asm/unaligned.h>
64a21d02 39#include <linux/platform_device.h>
6b157c9b 40#include <linux/workqueue.h>
1da177e4
LT		 41
42#include <linux/usb.h>
27729aad 43#include <linux/usb/hcd.h>
1da177e4
LT		 44
45#include "usb.h"
1da177e4
LT		 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
9beeee65
AS		 83/* Keep track of which host controller drivers are loaded */
84unsigned long usb_hcds_loaded;
85EXPORT_SYMBOL_GPL(usb_hcds_loaded);
86
1da177e4
LT		 87/* host controllers we manage */
88LIST_HEAD (usb_bus_list);
89EXPORT_SYMBOL_GPL (usb_bus_list);
90
91/* used when allocating bus numbers */
92#define USB_MAXBUS 64
93struct usb_busmap {
94 unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
95};
96static struct usb_busmap busmap;
97
98/* used when updating list of hcds */
4186ecf8 99DEFINE_MUTEX(usb_bus_list_lock); /* exported only for usbfs */
1da177e4
LT		 100EXPORT_SYMBOL_GPL (usb_bus_list_lock);
101
102/* used for controlling access to virtual root hubs */
103static DEFINE_SPINLOCK(hcd_root_hub_lock);
104
809a58b8
AS		 105/* used when updating an endpoint's URB list */
106static DEFINE_SPINLOCK(hcd_urb_list_lock);
1da177e4 107
cde217a5
AS		 108/* used to protect against unlinking URBs after the device is gone */
109static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
110
1da177e4
LT		 111/* wait queue for synchronous unlinks */
112DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
113
809a58b8
AS		 114static inline int is_root_hub(struct usb_device *udev)
115{
116 return (udev->parent == NULL);
117}
118
1da177e4
LT		 119/*-------------------------------------------------------------------------*/
120
121/*
122 * Sharable chunks of root hub code.
123 */
124
125/*-------------------------------------------------------------------------*/
126
127#define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
128#define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
129
d2e9b4d6
SS		 130/* usb 3.0 root hub device descriptor */
131static const u8 usb3_rh_dev_descriptor[18] = {
132 0x12, /* __u8 bLength; */
133 0x01, /* __u8 bDescriptorType; Device */
134 0x00, 0x03, /* __le16 bcdUSB; v3.0 */
135
136 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
137 0x00, /* __u8 bDeviceSubClass; */
138 0x03, /* __u8 bDeviceProtocol; USB 3.0 hub */
139 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
140
141 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation */
cd780694 142 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
d2e9b4d6
SS		 143 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
144
145 0x03, /* __u8 iManufacturer; */
146 0x02, /* __u8 iProduct; */
147 0x01, /* __u8 iSerialNumber; */
148 0x01 /* __u8 bNumConfigurations; */
149};
150
1da177e4
LT		 151/* usb 2.0 root hub device descriptor */
152static const u8 usb2_rh_dev_descriptor [18] = {
153 0x12, /* __u8 bLength; */
154 0x01, /* __u8 bDescriptorType; Device */
155 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
156
157 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
158 0x00, /* __u8 bDeviceSubClass; */
7329e211 159 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
16f16d11 160 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
1da177e4 161
667d691e
GKH		 162 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation */
163 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
1da177e4
LT		 164 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
165
166 0x03, /* __u8 iManufacturer; */
167 0x02, /* __u8 iProduct; */
168 0x01, /* __u8 iSerialNumber; */
169 0x01 /* __u8 bNumConfigurations; */
170};
171
172/* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
173
174/* usb 1.1 root hub device descriptor */
175static const u8 usb11_rh_dev_descriptor [18] = {
176 0x12, /* __u8 bLength; */
177 0x01, /* __u8 bDescriptorType; Device */
178 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
179
180 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
181 0x00, /* __u8 bDeviceSubClass; */
182 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
16f16d11 183 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
1da177e4 184
667d691e
GKH		 185 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation */
186 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
1da177e4
LT		 187 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
188
189 0x03, /* __u8 iManufacturer; */
190 0x02, /* __u8 iProduct; */
191 0x01, /* __u8 iSerialNumber; */
192 0x01 /* __u8 bNumConfigurations; */
193};
194
195
196/*-------------------------------------------------------------------------*/
197
198/* Configuration descriptors for our root hubs */
199
200static const u8 fs_rh_config_descriptor [] = {
201
202 /* one configuration */
203 0x09, /* __u8 bLength; */
204 0x02, /* __u8 bDescriptorType; Configuration */
205 0x19, 0x00, /* __le16 wTotalLength; */
206 0x01, /* __u8 bNumInterfaces; (1) */
207 0x01, /* __u8 bConfigurationValue; */
208 0x00, /* __u8 iConfiguration; */
209 0xc0, /* __u8 bmAttributes;
210 Bit 7: must be set,
211 6: Self-powered,
212 5: Remote wakeup,
213 4..0: resvd */
214 0x00, /* __u8 MaxPower; */
215
216 /* USB 1.1:
217 * USB 2.0, single TT organization (mandatory):
218 * one interface, protocol 0
219 *
220 * USB 2.0, multiple TT organization (optional):
221 * two interfaces, protocols 1 (like single TT)
222 * and 2 (multiple TT mode) ... config is
223 * sometimes settable
224 * NOT IMPLEMENTED
225 */
226
227 /* one interface */
228 0x09, /* __u8 if_bLength; */
229 0x04, /* __u8 if_bDescriptorType; Interface */
230 0x00, /* __u8 if_bInterfaceNumber; */
231 0x00, /* __u8 if_bAlternateSetting; */
232 0x01, /* __u8 if_bNumEndpoints; */
233 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
234 0x00, /* __u8 if_bInterfaceSubClass; */
235 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
236 0x00, /* __u8 if_iInterface; */
237
238 /* one endpoint (status change endpoint) */
239 0x07, /* __u8 ep_bLength; */
240 0x05, /* __u8 ep_bDescriptorType; Endpoint */
241 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
242 0x03, /* __u8 ep_bmAttributes; Interrupt */
243 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
244 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
245};
246
247static const u8 hs_rh_config_descriptor [] = {
248
249 /* one configuration */
250 0x09, /* __u8 bLength; */
251 0x02, /* __u8 bDescriptorType; Configuration */
252 0x19, 0x00, /* __le16 wTotalLength; */
253 0x01, /* __u8 bNumInterfaces; (1) */
254 0x01, /* __u8 bConfigurationValue; */
255 0x00, /* __u8 iConfiguration; */
256 0xc0, /* __u8 bmAttributes;
257 Bit 7: must be set,
258 6: Self-powered,
259 5: Remote wakeup,
260 4..0: resvd */
261 0x00, /* __u8 MaxPower; */
262
263 /* USB 1.1:
264 * USB 2.0, single TT organization (mandatory):
265 * one interface, protocol 0
266 *
267 * USB 2.0, multiple TT organization (optional):
268 * two interfaces, protocols 1 (like single TT)
269 * and 2 (multiple TT mode) ... config is
270 * sometimes settable
271 * NOT IMPLEMENTED
272 */
273
274 /* one interface */
275 0x09, /* __u8 if_bLength; */
276 0x04, /* __u8 if_bDescriptorType; Interface */
277 0x00, /* __u8 if_bInterfaceNumber; */
278 0x00, /* __u8 if_bAlternateSetting; */
279 0x01, /* __u8 if_bNumEndpoints; */
280 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
281 0x00, /* __u8 if_bInterfaceSubClass; */
282 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
283 0x00, /* __u8 if_iInterface; */
284
285 /* one endpoint (status change endpoint) */
286 0x07, /* __u8 ep_bLength; */
287 0x05, /* __u8 ep_bDescriptorType; Endpoint */
288 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
289 0x03, /* __u8 ep_bmAttributes; Interrupt */
88fafff9 290 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
291 * see hub.c:hub_configure() for details. */
292 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
1da177e4
LT		 293 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
294};
295
d2e9b4d6
SS		 296static const u8 ss_rh_config_descriptor[] = {
297 /* one configuration */
298 0x09, /* __u8 bLength; */
299 0x02, /* __u8 bDescriptorType; Configuration */
300 0x19, 0x00, /* __le16 wTotalLength; FIXME */
301 0x01, /* __u8 bNumInterfaces; (1) */
302 0x01, /* __u8 bConfigurationValue; */
303 0x00, /* __u8 iConfiguration; */
304 0xc0, /* __u8 bmAttributes;
305 Bit 7: must be set,
306 6: Self-powered,
307 5: Remote wakeup,
308 4..0: resvd */
309 0x00, /* __u8 MaxPower; */
310
311 /* one interface */
312 0x09, /* __u8 if_bLength; */
313 0x04, /* __u8 if_bDescriptorType; Interface */
314 0x00, /* __u8 if_bInterfaceNumber; */
315 0x00, /* __u8 if_bAlternateSetting; */
316 0x01, /* __u8 if_bNumEndpoints; */
317 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
318 0x00, /* __u8 if_bInterfaceSubClass; */
319 0x00, /* __u8 if_bInterfaceProtocol; */
320 0x00, /* __u8 if_iInterface; */
321
322 /* one endpoint (status change endpoint) */
323 0x07, /* __u8 ep_bLength; */
324 0x05, /* __u8 ep_bDescriptorType; Endpoint */
325 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
326 0x03, /* __u8 ep_bmAttributes; Interrupt */
327 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
328 * see hub.c:hub_configure() for details. */
329 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
330 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
331 /*
332 * All 3.0 hubs should have an endpoint companion descriptor,
333 * but we're ignoring that for now. FIXME?
334 */
335};
336
1da177e4
LT		 337/*-------------------------------------------------------------------------*/
338
392ca68b
GS		 339/**
340 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
341 * @s: Null-terminated ASCII (actually ISO-8859-1) string
342 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
343 * @len: Length (in bytes; may be odd) of descriptor buffer.
344 *
345 * The return value is the number of bytes filled in: 2 + 2*strlen(s) or
346 * buflen, whichever is less.
347 *
348 * USB String descriptors can contain at most 126 characters; input
349 * strings longer than that are truncated.
1da177e4 350 */
392ca68b
GS		 351static unsigned
352ascii2desc(char const *s, u8 *buf, unsigned len)
1da177e4 353{
392ca68b
GS		 354 unsigned n, t = 2 + 2*strlen(s);
355
356 if (t > 254)
357 t = 254; /* Longest possible UTF string descriptor */
358 if (len > t)
359 len = t;
360
361 t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
362
363 n = len;
364 while (n--) {
365 *buf++ = t;
366 if (!n--)
367 break;
368 *buf++ = t >> 8;
369 t = (unsigned char)*s++;
1da177e4 370 }
392ca68b 371 return len;
1da177e4
LT		 372}
373
392ca68b
GS		 374/**
375 * rh_string() - provides string descriptors for root hub
376 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
1da177e4 377 * @hcd: the host controller for this root hub
392ca68b
GS		 378 * @data: buffer for output packet
379 * @len: length of the provided buffer
1da177e4
LT		 380 *
381 * Produces either a manufacturer, product or serial number string for the
382 * virtual root hub device.
392ca68b
GS		 383 * Returns the number of bytes filled in: the length of the descriptor or
384 * of the provided buffer, whichever is less.
1da177e4 385 */
392ca68b
GS		 386static unsigned
387rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
71d2718f 388{
392ca68b
GS		 389 char buf[100];
390 char const *s;
391 static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
1da177e4
LT		 392
393 // language ids
392ca68b
GS		 394 switch (id) {
395 case 0:
396 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
397 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
398 if (len > 4)
399 len = 4;
400 memcpy(data, langids, len);
1da177e4 401 return len;
392ca68b
GS		 402 case 1:
403 /* Serial number */
404 s = hcd->self.bus_name;
405 break;
406 case 2:
407 /* Product name */
408 s = hcd->product_desc;
409 break;
410 case 3:
411 /* Manufacturer */
96b644bd
SH		 412 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
413 init_utsname()->release, hcd->driver->description);
392ca68b
GS		 414 s = buf;
415 break;
1da177e4 416 default:
392ca68b
GS		 417 /* Can't happen; caller guarantees it */
418 return 0;
1da177e4 419 }
392ca68b
GS		 420
421 return ascii2desc(s, data, len);
1da177e4
LT		 422}
423
424
425/* Root hub control transfers execute synchronously */
426static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
427{
428 struct usb_ctrlrequest *cmd;
429 u16 typeReq, wValue, wIndex, wLength;
430 u8 *ubuf = urb->transfer_buffer;
54bee6e1
MP		 431 u8 tbuf [sizeof (struct usb_hub_descriptor)]
432 __attribute__((aligned(4)));
1da177e4 433 const u8 *bufp = tbuf;
71d2718f 434 unsigned len = 0;
e9df41c5 435 int status;
7329e211
AS		 436 u8 patch_wakeup = 0;
437 u8 patch_protocol = 0;
1da177e4 438
9439eb94
AS		 439 might_sleep();
440
e9df41c5
AS		 441 spin_lock_irq(&hcd_root_hub_lock);
442 status = usb_hcd_link_urb_to_ep(hcd, urb);
443 spin_unlock_irq(&hcd_root_hub_lock);
444 if (status)
445 return status;
b0d9efba 446 urb->hcpriv = hcd; /* Indicate it's queued */
e9df41c5 447
1da177e4
LT		 448 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
449 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
450 wValue = le16_to_cpu (cmd->wValue);
451 wIndex = le16_to_cpu (cmd->wIndex);
452 wLength = le16_to_cpu (cmd->wLength);
453
454 if (wLength > urb->transfer_buffer_length)
455 goto error;
456
457 urb->actual_length = 0;
458 switch (typeReq) {
459
460 /* DEVICE REQUESTS */
461
fb669cc0
DB		 462 /* The root hub's remote wakeup enable bit is implemented using
463 * driver model wakeup flags. If this system supports wakeup
464 * through USB, userspace may change the default "allow wakeup"
465 * policy through sysfs or these calls.
466 *
467 * Most root hubs support wakeup from downstream devices, for
468 * runtime power management (disabling USB clocks and reducing
469 * VBUS power usage). However, not all of them do so; silicon,
470 * board, and BIOS bugs here are not uncommon, so these can't
471 * be treated quite like external hubs.
472 *
473 * Likewise, not all root hubs will pass wakeup events upstream,
474 * to wake up the whole system. So don't assume root hub and
475 * controller capabilities are identical.
476 */
477
1da177e4 478 case DeviceRequest | USB_REQ_GET_STATUS:
fb669cc0
DB		 479 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
480 << USB_DEVICE_REMOTE_WAKEUP)
1da177e4
LT		 481 | (1 << USB_DEVICE_SELF_POWERED);
482 tbuf [1] = 0;
483 len = 2;
484 break;
485 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
486 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
fb669cc0 487 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
1da177e4
LT		 488 else
489 goto error;
490 break;
491 case DeviceOutRequest | USB_REQ_SET_FEATURE:
fb669cc0
DB		 492 if (device_can_wakeup(&hcd->self.root_hub->dev)
493 && wValue == USB_DEVICE_REMOTE_WAKEUP)
494 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
1da177e4
LT		 495 else
496 goto error;
497 break;
498 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
499 tbuf [0] = 1;
500 len = 1;
501 /* FALLTHROUGH */
502 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
503 break;
504 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
505 switch (wValue & 0xff00) {
506 case USB_DT_DEVICE << 8:
7dd19e69
VM		 507 switch (hcd->driver->flags & HCD_MASK) {
508 case HCD_USB3:
d2e9b4d6 509 bufp = usb3_rh_dev_descriptor;
7dd19e69
VM		 510 break;
511 case HCD_USB2:
1da177e4 512 bufp = usb2_rh_dev_descriptor;
7dd19e69
VM		 513 break;
514 case HCD_USB11:
1da177e4 515 bufp = usb11_rh_dev_descriptor;
7dd19e69
VM		 516 break;
517 default:
1da177e4 518 goto error;
7dd19e69 519 }
1da177e4 520 len = 18;
7329e211
AS		 521 if (hcd->has_tt)
522 patch_protocol = 1;
1da177e4
LT		 523 break;
524 case USB_DT_CONFIG << 8:
7dd19e69
VM		 525 switch (hcd->driver->flags & HCD_MASK) {
526 case HCD_USB3:
d2e9b4d6
SS		 527 bufp = ss_rh_config_descriptor;
528 len = sizeof ss_rh_config_descriptor;
7dd19e69
VM		 529 break;
530 case HCD_USB2:
1da177e4
LT		 531 bufp = hs_rh_config_descriptor;
532 len = sizeof hs_rh_config_descriptor;
7dd19e69
VM		 533 break;
534 case HCD_USB11:
1da177e4
LT		 535 bufp = fs_rh_config_descriptor;
536 len = sizeof fs_rh_config_descriptor;
7dd19e69
VM		 537 break;
538 default:
539 goto error;
1da177e4 540 }
fb669cc0 541 if (device_can_wakeup(&hcd->self.root_hub->dev))
1da177e4
LT		 542 patch_wakeup = 1;
543 break;
544 case USB_DT_STRING << 8:
71d2718f
RK		 545 if ((wValue & 0xff) < 4)
546 urb->actual_length = rh_string(wValue & 0xff,
547 hcd, ubuf, wLength);
548 else /* unsupported IDs --> "protocol stall" */
1da177e4 549 goto error;
1da177e4
LT		 550 break;
551 default:
552 goto error;
553 }
554 break;
555 case DeviceRequest | USB_REQ_GET_INTERFACE:
556 tbuf [0] = 0;
557 len = 1;
558 /* FALLTHROUGH */
559 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
560 break;
561 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
562 // wValue == urb->dev->devaddr
563 dev_dbg (hcd->self.controller, "root hub device address %d\n",
564 wValue);
565 break;
566
567 /* INTERFACE REQUESTS (no defined feature/status flags) */
568
569 /* ENDPOINT REQUESTS */
570
571 case EndpointRequest | USB_REQ_GET_STATUS:
572 // ENDPOINT_HALT flag
573 tbuf [0] = 0;
574 tbuf [1] = 0;
575 len = 2;
576 /* FALLTHROUGH */
577 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
578 case EndpointOutRequest | USB_REQ_SET_FEATURE:
579 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
580 break;
581
582 /* CLASS REQUESTS (and errors) */
583
584 default:
585 /* non-generic request */
b13296c6
DB		 586 switch (typeReq) {
587 case GetHubStatus:
588 case GetPortStatus:
589 len = 4;
590 break;
591 case GetHubDescriptor:
592 len = sizeof (struct usb_hub_descriptor);
593 break;
1da177e4 594 }
b13296c6
DB		 595 status = hcd->driver->hub_control (hcd,
596 typeReq, wValue, wIndex,
597 tbuf, wLength);
1da177e4
LT		 598 break;
599error:
600 /* "protocol stall" on error */
601 status = -EPIPE;
602 }
603
604 if (status) {
605 len = 0;
606 if (status != -EPIPE) {
607 dev_dbg (hcd->self.controller,
608 "CTRL: TypeReq=0x%x val=0x%x "
609 "idx=0x%x len=%d ==> %d\n",
610 typeReq, wValue, wIndex,
b13296c6 611 wLength, status);
1da177e4
LT		 612 }
613 }
614 if (len) {
615 if (urb->transfer_buffer_length < len)
616 len = urb->transfer_buffer_length;
617 urb->actual_length = len;
618 // always USB_DIR_IN, toward host
619 memcpy (ubuf, bufp, len);
620
621 /* report whether RH hardware supports remote wakeup */
622 if (patch_wakeup &&
623 len > offsetof (struct usb_config_descriptor,
624 bmAttributes))
625 ((struct usb_config_descriptor *)ubuf)->bmAttributes
626 |= USB_CONFIG_ATT_WAKEUP;
7329e211
AS		 627
628 /* report whether RH hardware has an integrated TT */
629 if (patch_protocol &&
630 len > offsetof(struct usb_device_descriptor,
631 bDeviceProtocol))
632 ((struct usb_device_descriptor *) ubuf)->
633 bDeviceProtocol = 1;
1da177e4
LT		 634 }
635
636 /* any errors get returned through the urb completion */
9439eb94 637 spin_lock_irq(&hcd_root_hub_lock);
e9df41c5 638 usb_hcd_unlink_urb_from_ep(hcd, urb);
9439eb94
AS		 639
640 /* This peculiar use of spinlocks echoes what real HC drivers do.
641 * Avoiding calls to local_irq_disable/enable makes the code
642 * RT-friendly.
643 */
644 spin_unlock(&hcd_root_hub_lock);
4a00027d 645 usb_hcd_giveback_urb(hcd, urb, status);
9439eb94
AS		 646 spin_lock(&hcd_root_hub_lock);
647
648 spin_unlock_irq(&hcd_root_hub_lock);
1da177e4
LT		 649 return 0;
650}
651
652/*-------------------------------------------------------------------------*/
653
654/*
d5926ae7
AS		 655 * Root Hub interrupt transfers are polled using a timer if the
656 * driver requests it; otherwise the driver is responsible for
657 * calling usb_hcd_poll_rh_status() when an event occurs.
1da177e4 658 *
d5926ae7
AS		 659 * Completions are called in_interrupt(), but they may or may not
660 * be in_irq().
1da177e4 661 */
d5926ae7
AS		 662void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
663{
664 struct urb *urb;
665 int length;
666 unsigned long flags;
ad361c98 667 char buffer[6]; /* Any root hubs with > 31 ports? */
1da177e4 668
6d88e679 669 if (unlikely(!hcd->rh_pollable))
1b42ae6d 670 return;
d5926ae7
AS		 671 if (!hcd->uses_new_polling && !hcd->status_urb)
672 return;
1da177e4 673
d5926ae7
AS		 674 length = hcd->driver->hub_status_data(hcd, buffer);
675 if (length > 0) {
1da177e4 676
d5926ae7 677 /* try to complete the status urb */
9439eb94 678 spin_lock_irqsave(&hcd_root_hub_lock, flags);
d5926ae7
AS		 679 urb = hcd->status_urb;
680 if (urb) {
541c7d43 681 clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
e9df41c5 682 hcd->status_urb = NULL;
e9df41c5
AS		 683 urb->actual_length = length;
684 memcpy(urb->transfer_buffer, buffer, length);
9439eb94 685
e9df41c5 686 usb_hcd_unlink_urb_from_ep(hcd, urb);
9439eb94 687 spin_unlock(&hcd_root_hub_lock);
4a00027d 688 usb_hcd_giveback_urb(hcd, urb, 0);
9439eb94 689 spin_lock(&hcd_root_hub_lock);
e9df41c5 690 } else {
d5926ae7 691 length = 0;
541c7d43 692 set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
e9df41c5 693 }
9439eb94 694 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
1da177e4
LT		 695 }
696
d5926ae7 697 /* The USB 2.0 spec says 256 ms. This is close enough and won't
01cd0819
AV		 698 * exceed that limit if HZ is 100. The math is more clunky than
699 * maybe expected, this is to make sure that all timers for USB devices
700 * fire at the same time to give the CPU a break inbetween */
541c7d43 701 if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
d5926ae7 702 (length == 0 && hcd->status_urb != NULL))
01cd0819 703 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
1da177e4 704}
d5926ae7 705EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
1da177e4
LT		 706
707/* timer callback */
d5926ae7
AS		 708static void rh_timer_func (unsigned long _hcd)
709{
710 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
711}
712
713/*-------------------------------------------------------------------------*/
1da177e4 714
d5926ae7 715static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
1da177e4 716{
d5926ae7 717 int retval;
1da177e4 718 unsigned long flags;
71d2718f 719 unsigned len = 1 + (urb->dev->maxchild / 8);
1da177e4 720
d5926ae7 721 spin_lock_irqsave (&hcd_root_hub_lock, flags);
e9df41c5 722 if (hcd->status_urb || urb->transfer_buffer_length < len) {
d5926ae7
AS		 723 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
724 retval = -EINVAL;
e9df41c5
AS		 725 goto done;
726 }
1da177e4 727
e9df41c5
AS		 728 retval = usb_hcd_link_urb_to_ep(hcd, urb);
729 if (retval)
730 goto done;
1da177e4 731
e9df41c5
AS		 732 hcd->status_urb = urb;
733 urb->hcpriv = hcd; /* indicate it's queued */
734 if (!hcd->uses_new_polling)
735 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
736
737 /* If a status change has already occurred, report it ASAP */
541c7d43 738 else if (HCD_POLL_PENDING(hcd))
e9df41c5
AS		 739 mod_timer(&hcd->rh_timer, jiffies);
740 retval = 0;
741 done:
d5926ae7
AS		 742 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
743 return retval;
1da177e4
LT		 744}
745
1da177e4
LT		 746static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
747{
5e60a161 748 if (usb_endpoint_xfer_int(&urb->ep->desc))
d5926ae7 749 return rh_queue_status (hcd, urb);
5e60a161 750 if (usb_endpoint_xfer_control(&urb->ep->desc))
1da177e4 751 return rh_call_control (hcd, urb);
d5926ae7 752 return -EINVAL;
1da177e4
LT		 753}
754
755/*-------------------------------------------------------------------------*/
756
455b25fb
AS		 757/* Unlinks of root-hub control URBs are legal, but they don't do anything
758 * since these URBs always execute synchronously.
d5926ae7 759 */
e9df41c5 760static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1da177e4 761{
455b25fb 762 unsigned long flags;
e9df41c5 763 int rc;
1da177e4 764
9439eb94 765 spin_lock_irqsave(&hcd_root_hub_lock, flags);
e9df41c5
AS		 766 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
767 if (rc)
768 goto done;
769
5e60a161 770 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
455b25fb 771 ; /* Do nothing */
d5926ae7
AS		 772
773 } else { /* Status URB */
774 if (!hcd->uses_new_polling)
455b25fb 775 del_timer (&hcd->rh_timer);
d5926ae7
AS		 776 if (urb == hcd->status_urb) {
777 hcd->status_urb = NULL;
e9df41c5 778 usb_hcd_unlink_urb_from_ep(hcd, urb);
1da177e4 779
9439eb94 780 spin_unlock(&hcd_root_hub_lock);
4a00027d 781 usb_hcd_giveback_urb(hcd, urb, status);
9439eb94
AS		 782 spin_lock(&hcd_root_hub_lock);
783 }
784 }
e9df41c5 785 done:
9439eb94 786 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
e9df41c5 787 return rc;
1da177e4
LT		 788}
789
5234ce1b
IPG		 790
791
792/*
793 * Show & store the current value of authorized_default
794 */
795static ssize_t usb_host_authorized_default_show(struct device *dev,
796 struct device_attribute *attr,
797 char *buf)
798{
799 struct usb_device *rh_usb_dev = to_usb_device(dev);
800 struct usb_bus *usb_bus = rh_usb_dev->bus;
801 struct usb_hcd *usb_hcd;
802
803 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
804 return -ENODEV;
805 usb_hcd = bus_to_hcd(usb_bus);
806 return snprintf(buf, PAGE_SIZE, "%u\n", usb_hcd->authorized_default);
807}
808
809static ssize_t usb_host_authorized_default_store(struct device *dev,
810 struct device_attribute *attr,
811 const char *buf, size_t size)
812{
813 ssize_t result;
814 unsigned val;
815 struct usb_device *rh_usb_dev = to_usb_device(dev);
816 struct usb_bus *usb_bus = rh_usb_dev->bus;
817 struct usb_hcd *usb_hcd;
818
819 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
820 return -ENODEV;
821 usb_hcd = bus_to_hcd(usb_bus);
822 result = sscanf(buf, "%u\n", &val);
823 if (result == 1) {
824 usb_hcd->authorized_default = val? 1 : 0;
825 result = size;
826 }
827 else
828 result = -EINVAL;
829 return result;
830}
831
832static DEVICE_ATTR(authorized_default, 0644,
833 usb_host_authorized_default_show,
834 usb_host_authorized_default_store);
835
836
837/* Group all the USB bus attributes */
838static struct attribute *usb_bus_attrs[] = {
839 &dev_attr_authorized_default.attr,
840 NULL,
841};
842
843static struct attribute_group usb_bus_attr_group = {
844 .name = NULL, /* we want them in the same directory */
845 .attrs = usb_bus_attrs,
846};
847
848
849
1da177e4
LT		 850/*-------------------------------------------------------------------------*/
851
1da177e4
LT		 852/**
853 * usb_bus_init - shared initialization code
854 * @bus: the bus structure being initialized
855 *
856 * This code is used to initialize a usb_bus structure, memory for which is
857 * separately managed.
858 */
859static void usb_bus_init (struct usb_bus *bus)
860{
861 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
862
863 bus->devnum_next = 1;
864
865 bus->root_hub = NULL;
1da177e4
LT		 866 bus->busnum = -1;
867 bus->bandwidth_allocated = 0;
868 bus->bandwidth_int_reqs = 0;
869 bus->bandwidth_isoc_reqs = 0;
870
871 INIT_LIST_HEAD (&bus->bus_list);
1da177e4
LT		 872}
873
1da177e4
LT		 874/*-------------------------------------------------------------------------*/
875
876/**
877 * usb_register_bus - registers the USB host controller with the usb core
878 * @bus: pointer to the bus to register
879 * Context: !in_interrupt()
880 *
881 * Assigns a bus number, and links the controller into usbcore data
882 * structures so that it can be seen by scanning the bus list.
883 */
884static int usb_register_bus(struct usb_bus *bus)
885{
eb579f58 886 int result = -E2BIG;
1da177e4 887 int busnum;
1da177e4 888
4186ecf8 889 mutex_lock(&usb_bus_list_lock);
1da177e4 890 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
eb579f58 891 if (busnum >= USB_MAXBUS) {
1da177e4 892 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
eb579f58 893 goto error_find_busnum;
1da177e4 894 }
eb579f58
IPG		 895 set_bit (busnum, busmap.busmap);
896 bus->busnum = busnum;
5a3201b2 897
1da177e4
LT		 898 /* Add it to the local list of buses */
899 list_add (&bus->bus_list, &usb_bus_list);
4186ecf8 900 mutex_unlock(&usb_bus_list_lock);
1da177e4 901
3099e75a 902 usb_notify_add_bus(bus);
1da177e4 903
eb579f58
IPG		 904 dev_info (bus->controller, "new USB bus registered, assigned bus "
905 "number %d\n", bus->busnum);
1da177e4 906 return 0;
eb579f58 907
eb579f58
IPG		 908error_find_busnum:
909 mutex_unlock(&usb_bus_list_lock);
910 return result;
1da177e4
LT		 911}
912
913/**
914 * usb_deregister_bus - deregisters the USB host controller
915 * @bus: pointer to the bus to deregister
916 * Context: !in_interrupt()
917 *
918 * Recycles the bus number, and unlinks the controller from usbcore data
919 * structures so that it won't be seen by scanning the bus list.
920 */
921static void usb_deregister_bus (struct usb_bus *bus)
922{
923 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
924
925 /*
926 * NOTE: make sure that all the devices are removed by the
927 * controller code, as well as having it call this when cleaning
928 * itself up
929 */
4186ecf8 930 mutex_lock(&usb_bus_list_lock);
1da177e4 931 list_del (&bus->bus_list);
4186ecf8 932 mutex_unlock(&usb_bus_list_lock);
1da177e4 933
3099e75a 934 usb_notify_remove_bus(bus);
1da177e4
LT		 935
936 clear_bit (bus->busnum, busmap.busmap);
1da177e4
LT		 937}
938
939/**
8ec8d20b 940 * register_root_hub - called by usb_add_hcd() to register a root hub
1da177e4
LT		 941 * @hcd: host controller for this root hub
942 *
8ec8d20b 943 * This function registers the root hub with the USB subsystem. It sets up
b1e8f0a6
DB		 944 * the device properly in the device tree and then calls usb_new_device()
945 * to register the usb device. It also assigns the root hub's USB address
946 * (always 1).
1da177e4 947 */
b1e8f0a6 948static int register_root_hub(struct usb_hcd *hcd)
1da177e4
LT		 949{
950 struct device *parent_dev = hcd->self.controller;
b1e8f0a6 951 struct usb_device *usb_dev = hcd->self.root_hub;
1da177e4
LT		 952 const int devnum = 1;
953 int retval;
954
1da177e4
LT		 955 usb_dev->devnum = devnum;
956 usb_dev->bus->devnum_next = devnum + 1;
957 memset (&usb_dev->bus->devmap.devicemap, 0,
958 sizeof usb_dev->bus->devmap.devicemap);
959 set_bit (devnum, usb_dev->bus->devmap.devicemap);
960 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
961
4186ecf8 962 mutex_lock(&usb_bus_list_lock);
1da177e4 963
551509d2 964 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
1da177e4
LT		 965 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
966 if (retval != sizeof usb_dev->descriptor) {
4186ecf8 967 mutex_unlock(&usb_bus_list_lock);
1da177e4 968 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
7071a3ce 969 dev_name(&usb_dev->dev), retval);
1da177e4
LT		 970 return (retval < 0) ? retval : -EMSGSIZE;
971 }
972
1da177e4 973 retval = usb_new_device (usb_dev);
1da177e4 974 if (retval) {
1da177e4 975 dev_err (parent_dev, "can't register root hub for %s, %d\n",
7071a3ce 976 dev_name(&usb_dev->dev), retval);
1da177e4 977 }
4186ecf8 978 mutex_unlock(&usb_bus_list_lock);
1da177e4
LT		 979
980 if (retval == 0) {
981 spin_lock_irq (&hcd_root_hub_lock);
982 hcd->rh_registered = 1;
983 spin_unlock_irq (&hcd_root_hub_lock);
984
985 /* Did the HC die before the root hub was registered? */
986 if (hcd->state == HC_STATE_HALT)
987 usb_hc_died (hcd); /* This time clean up */
988 }
989
990 return retval;
991}
1da177e4
LT		 992
993
994/*-------------------------------------------------------------------------*/
995
996/**
997 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
998 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
999 * @is_input: true iff the transaction sends data to the host
1000 * @isoc: true for isochronous transactions, false for interrupt ones
1001 * @bytecount: how many bytes in the transaction.
1002 *
1003 * Returns approximate bus time in nanoseconds for a periodic transaction.
1004 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1005 * scheduled in software, this function is only used for such scheduling.
1006 */
1007long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1008{
1009 unsigned long tmp;
1010
1011 switch (speed) {
1012 case USB_SPEED_LOW: /* INTR only */
1013 if (is_input) {
1014 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
1015 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
1016 } else {
1017 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1018 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
1019 }
1020 case USB_SPEED_FULL: /* ISOC or INTR */
1021 if (isoc) {
1022 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1023 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
1024 } else {
1025 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1026 return (9107L + BW_HOST_DELAY + tmp);
1027 }
1028 case USB_SPEED_HIGH: /* ISOC or INTR */
1029 // FIXME adjust for input vs output
1030 if (isoc)
498f78e6 1031 tmp = HS_NSECS_ISO (bytecount);
1da177e4 1032 else
498f78e6 1033 tmp = HS_NSECS (bytecount);
1da177e4
LT		 1034 return tmp;
1035 default:
1036 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1037 return -1;
1038 }
1039}
782e70c6 1040EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1da177e4 1041
1da177e4
LT		 1042
1043/*-------------------------------------------------------------------------*/
1044
1045/*
1046 * Generic HC operations.
1047 */
1048
1049/*-------------------------------------------------------------------------*/
1050
e9df41c5
AS		 1051/**
1052 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1053 * @hcd: host controller to which @urb was submitted
1054 * @urb: URB being submitted
1055 *
1056 * Host controller drivers should call this routine in their enqueue()
1057 * method. The HCD's private spinlock must be held and interrupts must
1058 * be disabled. The actions carried out here are required for URB
1059 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1060 *
1061 * Returns 0 for no error, otherwise a negative error code (in which case
1062 * the enqueue() method must fail). If no error occurs but enqueue() fails
1063 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1064 * the private spinlock and returning.
1065 */
1066int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1da177e4 1067{
9a9bf406 1068 int rc = 0;
1da177e4 1069
e9df41c5 1070 spin_lock(&hcd_urb_list_lock);
1da177e4 1071
9a9bf406 1072 /* Check that the URB isn't being killed */
49367d8f 1073 if (unlikely(atomic_read(&urb->reject))) {
9a9bf406
AS		 1074 rc = -EPERM;
1075 goto done;
9f6a93f7 1076 }
1da177e4 1077
9a9bf406
AS		 1078 if (unlikely(!urb->ep->enabled)) {
1079 rc = -ENOENT;
1080 goto done;
1081 }
1da177e4 1082
6840d255
AS		 1083 if (unlikely(!urb->dev->can_submit)) {
1084 rc = -EHOSTUNREACH;
1085 goto done;
1086 }
1087
1da177e4 1088 /*
9a9bf406
AS		 1089 * Check the host controller's state and add the URB to the
1090 * endpoint's queue.
1da177e4 1091 */
9a9bf406 1092 switch (hcd->state) {
1da177e4
LT		 1093 case HC_STATE_RUNNING:
1094 case HC_STATE_RESUMING:
eb231054 1095 urb->unlinked = 0;
9a9bf406 1096 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1da177e4
LT		 1097 break;
1098 default:
9a9bf406
AS		 1099 rc = -ESHUTDOWN;
1100 goto done;
1da177e4 1101 }
9a9bf406 1102 done:
e9df41c5 1103 spin_unlock(&hcd_urb_list_lock);
9a9bf406
AS		 1104 return rc;
1105}
e9df41c5 1106EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
9a9bf406 1107
e9df41c5
AS		 1108/**
1109 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1110 * @hcd: host controller to which @urb was submitted
1111 * @urb: URB being checked for unlinkability
1112 * @status: error code to store in @urb if the unlink succeeds
1113 *
1114 * Host controller drivers should call this routine in their dequeue()
1115 * method. The HCD's private spinlock must be held and interrupts must
1116 * be disabled. The actions carried out here are required for making
1117 * sure than an unlink is valid.
1118 *
1119 * Returns 0 for no error, otherwise a negative error code (in which case
1120 * the dequeue() method must fail). The possible error codes are:
1121 *
1122 * -EIDRM: @urb was not submitted or has already completed.
1123 * The completion function may not have been called yet.
1124 *
1125 * -EBUSY: @urb has already been unlinked.
1126 */
1127int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
9a9bf406
AS		 1128 int status)
1129{
9a9bf406 1130 struct list_head *tmp;
9a9bf406
AS		 1131
1132 /* insist the urb is still queued */
1133 list_for_each(tmp, &urb->ep->urb_list) {
1134 if (tmp == &urb->urb_list)
1135 break;
1136 }
e9df41c5
AS		 1137 if (tmp != &urb->urb_list)
1138 return -EIDRM;
1da177e4 1139
9a9bf406
AS		 1140 /* Any status except -EINPROGRESS means something already started to
1141 * unlink this URB from the hardware. So there's no more work to do.
1da177e4 1142 */
eb231054 1143 if (urb->unlinked)
e9df41c5 1144 return -EBUSY;
eb231054 1145 urb->unlinked = status;
1da177e4 1146
9a9bf406
AS		 1147 /* IRQ setup can easily be broken so that USB controllers
1148 * never get completion IRQs ... maybe even the ones we need to
1149 * finish unlinking the initial failed usb_set_address()
1150 * or device descriptor fetch.
1151 */
541c7d43 1152 if (!HCD_SAW_IRQ(hcd) && !is_root_hub(urb->dev)) {
9a9bf406
AS		 1153 dev_warn(hcd->self.controller, "Unlink after no-IRQ? "
1154 "Controller is probably using the wrong IRQ.\n");
1155 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1156 }
1157
e9df41c5 1158 return 0;
9a9bf406 1159}
e9df41c5 1160EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
9a9bf406 1161
e9df41c5
AS		 1162/**
1163 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1164 * @hcd: host controller to which @urb was submitted
1165 * @urb: URB being unlinked
1166 *
1167 * Host controller drivers should call this routine before calling
1168 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1169 * interrupts must be disabled. The actions carried out here are required
1170 * for URB completion.
1171 */
1172void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
9a9bf406 1173{
9a9bf406 1174 /* clear all state linking urb to this dev (and hcd) */
e9df41c5 1175 spin_lock(&hcd_urb_list_lock);
9a9bf406 1176 list_del_init(&urb->urb_list);
e9df41c5 1177 spin_unlock(&hcd_urb_list_lock);
9a9bf406 1178}
e9df41c5 1179EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
9a9bf406 1180
b3476675
MD		 1181/*
1182 * Some usb host controllers can only perform dma using a small SRAM area.
1183 * The usb core itself is however optimized for host controllers that can dma
1184 * using regular system memory - like pci devices doing bus mastering.
1185 *
1186 * To support host controllers with limited dma capabilites we provide dma
1187 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1188 * For this to work properly the host controller code must first use the
1189 * function dma_declare_coherent_memory() to point out which memory area
1190 * that should be used for dma allocations.
1191 *
1192 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1193 * dma using dma_alloc_coherent() which in turn allocates from the memory
1194 * area pointed out with dma_declare_coherent_memory().
1195 *
1196 * So, to summarize...
1197 *
1198 * - We need "local" memory, canonical example being
1199 * a small SRAM on a discrete controller being the
1200 * only memory that the controller can read ...
1201 * (a) "normal" kernel memory is no good, and
1202 * (b) there's not enough to share
1203 *
1204 * - The only *portable* hook for such stuff in the
1205 * DMA framework is dma_declare_coherent_memory()
1206 *
1207 * - So we use that, even though the primary requirement
1208 * is that the memory be "local" (hence addressible
1209 * by that device), not "coherent".
1210 *
1211 */
1212
1213static int hcd_alloc_coherent(struct usb_bus *bus,
1214 gfp_t mem_flags, dma_addr_t *dma_handle,
1215 void **vaddr_handle, size_t size,
1216 enum dma_data_direction dir)
1217{
1218 unsigned char *vaddr;
1219
4307a28e
AR		 1220 if (*vaddr_handle == NULL) {
1221 WARN_ON_ONCE(1);
1222 return -EFAULT;
1223 }
1224
b3476675
MD		 1225 vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1226 mem_flags, dma_handle);
1227 if (!vaddr)
1228 return -ENOMEM;
1229
1230 /*
1231 * Store the virtual address of the buffer at the end
1232 * of the allocated dma buffer. The size of the buffer
1233 * may be uneven so use unaligned functions instead
1234 * of just rounding up. It makes sense to optimize for
1235 * memory footprint over access speed since the amount
1236 * of memory available for dma may be limited.
1237 */
1238 put_unaligned((unsigned long)*vaddr_handle,
1239 (unsigned long *)(vaddr + size));
1240
1241 if (dir == DMA_TO_DEVICE)
1242 memcpy(vaddr, *vaddr_handle, size);
1243
1244 *vaddr_handle = vaddr;
1245 return 0;
1246}
1247
1248static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1249 void **vaddr_handle, size_t size,
1250 enum dma_data_direction dir)
1251{
1252 unsigned char *vaddr = *vaddr_handle;
1253
1254 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1255
1256 if (dir == DMA_FROM_DEVICE)
1257 memcpy(vaddr, *vaddr_handle, size);
1258
1259 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1260
1261 *vaddr_handle = vaddr;
1262 *dma_handle = 0;
1263}
1264
c8cf203a 1265void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
ff9c895f 1266{
ff9c895f
AS		 1267 if (urb->transfer_flags & URB_SETUP_MAP_SINGLE)
1268 dma_unmap_single(hcd->self.controller,
1269 urb->setup_dma,
1270 sizeof(struct usb_ctrlrequest),
1271 DMA_TO_DEVICE);
1272 else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1273 hcd_free_coherent(urb->dev->bus,
1274 &urb->setup_dma,
1275 (void **) &urb->setup_packet,
1276 sizeof(struct usb_ctrlrequest),
1277 DMA_TO_DEVICE);
1278
1dae423d
MF		 1279 /* Make it safe to call this routine more than once */
1280 urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1281}
c8cf203a 1282EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1dae423d 1283
2694a48d
RM		 1284static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1285{
1286 if (hcd->driver->unmap_urb_for_dma)
1287 hcd->driver->unmap_urb_for_dma(hcd, urb);
1288 else
1289 usb_hcd_unmap_urb_for_dma(hcd, urb);
1290}
1291
c8cf203a 1292void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1dae423d
MF		 1293{
1294 enum dma_data_direction dir;
1295
c8cf203a 1296 usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1dae423d 1297
ff9c895f
AS		 1298 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1299 if (urb->transfer_flags & URB_DMA_MAP_SG)
1300 dma_unmap_sg(hcd->self.controller,
910f8d0c 1301 urb->sg,
ff9c895f
AS		 1302 urb->num_sgs,
1303 dir);
1304 else if (urb->transfer_flags & URB_DMA_MAP_PAGE)
1305 dma_unmap_page(hcd->self.controller,
1306 urb->transfer_dma,
1307 urb->transfer_buffer_length,
1308 dir);
1309 else if (urb->transfer_flags & URB_DMA_MAP_SINGLE)
1310 dma_unmap_single(hcd->self.controller,
1311 urb->transfer_dma,
1312 urb->transfer_buffer_length,
1313 dir);
1314 else if (urb->transfer_flags & URB_MAP_LOCAL)
1315 hcd_free_coherent(urb->dev->bus,
1316 &urb->transfer_dma,
1317 &urb->transfer_buffer,
1318 urb->transfer_buffer_length,
1319 dir);
1320
1321 /* Make it safe to call this routine more than once */
1dae423d 1322 urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
ff9c895f
AS		 1323 URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1324}
c8cf203a 1325EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
ff9c895f 1326
b3476675
MD		 1327static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1328 gfp_t mem_flags)
2694a48d
RM		 1329{
1330 if (hcd->driver->map_urb_for_dma)
1331 return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1332 else
1333 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1334}
1335
1336int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1337 gfp_t mem_flags)
9a9bf406 1338{
b3476675
MD		 1339 enum dma_data_direction dir;
1340 int ret = 0;
1341
9a9bf406
AS		 1342 /* Map the URB's buffers for DMA access.
1343 * Lower level HCD code should use *_dma exclusively,
e04748e3
SS		 1344 * unless it uses pio or talks to another transport,
1345 * or uses the provided scatter gather list for bulk.
1da177e4 1346 */
b3476675 1347
85bcb5ee 1348 if (usb_endpoint_xfer_control(&urb->ep->desc)) {
07a8cdd2
AG		 1349 if (hcd->self.uses_pio_for_control)
1350 return ret;
85e034fd 1351 if (hcd->self.uses_dma) {
b3476675 1352 urb->setup_dma = dma_map_single(
1da177e4
LT		 1353 hcd->self.controller,
1354 urb->setup_packet,
b3476675 1355 sizeof(struct usb_ctrlrequest),
1da177e4 1356 DMA_TO_DEVICE);
85e034fd
LF		 1357 if (dma_mapping_error(hcd->self.controller,
1358 urb->setup_dma))
1359 return -EAGAIN;
ff9c895f 1360 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
f537da68 1361 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
b3476675
MD		 1362 ret = hcd_alloc_coherent(
1363 urb->dev->bus, mem_flags,
1364 &urb->setup_dma,
1365 (void **)&urb->setup_packet,
1366 sizeof(struct usb_ctrlrequest),
1367 DMA_TO_DEVICE);
ff9c895f
AS		 1368 if (ret)
1369 return ret;
1370 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
f537da68 1371 }
b3476675
MD		 1372 }
1373
1374 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
ff9c895f 1375 if (urb->transfer_buffer_length != 0
b3476675 1376 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
85e034fd 1377 if (hcd->self.uses_dma) {
ff9c895f
AS		 1378 if (urb->num_sgs) {
1379 int n = dma_map_sg(
1380 hcd->self.controller,
910f8d0c 1381 urb->sg,
ff9c895f
AS		 1382 urb->num_sgs,
1383 dir);
1384 if (n <= 0)
1385 ret = -EAGAIN;
1386 else
1387 urb->transfer_flags |= URB_DMA_MAP_SG;
1388 if (n != urb->num_sgs) {
1389 urb->num_sgs = n;
1390 urb->transfer_flags |=
1391 URB_DMA_SG_COMBINED;
1392 }
1393 } else if (urb->sg) {
910f8d0c 1394 struct scatterlist *sg = urb->sg;
ff9c895f
AS		 1395 urb->transfer_dma = dma_map_page(
1396 hcd->self.controller,
1397 sg_page(sg),
1398 sg->offset,
1399 urb->transfer_buffer_length,
1400 dir);
1401 if (dma_mapping_error(hcd->self.controller,
85e034fd 1402 urb->transfer_dma))
ff9c895f
AS		 1403 ret = -EAGAIN;
1404 else
1405 urb->transfer_flags |= URB_DMA_MAP_PAGE;
1406 } else {
1407 urb->transfer_dma = dma_map_single(
1408 hcd->self.controller,
1409 urb->transfer_buffer,
1410 urb->transfer_buffer_length,
1411 dir);
1412 if (dma_mapping_error(hcd->self.controller,
1413 urb->transfer_dma))
1414 ret = -EAGAIN;
1415 else
1416 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1417 }
85e034fd 1418 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
b3476675
MD		 1419 ret = hcd_alloc_coherent(
1420 urb->dev->bus, mem_flags,
1421 &urb->transfer_dma,
1422 &urb->transfer_buffer,
1423 urb->transfer_buffer_length,
1424 dir);
ff9c895f
AS		 1425 if (ret == 0)
1426 urb->transfer_flags |= URB_MAP_LOCAL;
b3476675 1427 }
ff9c895f
AS		 1428 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1429 URB_SETUP_MAP_LOCAL)))
c8cf203a 1430 usb_hcd_unmap_urb_for_dma(hcd, urb);
1da177e4 1431 }
b3476675 1432 return ret;
9a9bf406 1433}
2694a48d 1434EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1da177e4 1435
9a9bf406
AS		 1436/*-------------------------------------------------------------------------*/
1437
1438/* may be called in any context with a valid urb->dev usecount
1439 * caller surrenders "ownership" of urb
1440 * expects usb_submit_urb() to have sanity checked and conditioned all
1441 * inputs in the urb
1442 */
1443int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1444{
1445 int status;
1446 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1447
1448 /* increment urb's reference count as part of giving it to the HCD
1449 * (which will control it). HCD guarantees that it either returns
1450 * an error or calls giveback(), but not both.
1451 */
1452 usb_get_urb(urb);
1453 atomic_inc(&urb->use_count);
4d59d8a1 1454 atomic_inc(&urb->dev->urbnum);
9a9bf406
AS		 1455 usbmon_urb_submit(&hcd->self, urb);
1456
1457 /* NOTE requirements on root-hub callers (usbfs and the hub
1458 * driver, for now): URBs' urb->transfer_buffer must be
1459 * valid and usb_buffer_{sync,unmap}() not be needed, since
1460 * they could clobber root hub response data. Also, control
1461 * URBs must be submitted in process context with interrupts
1462 * enabled.
1463 */
b3476675 1464
ff9c895f 1465 if (is_root_hub(urb->dev)) {
e9df41c5 1466 status = rh_urb_enqueue(hcd, urb);
ff9c895f
AS		 1467 } else {
1468 status = map_urb_for_dma(hcd, urb, mem_flags);
1469 if (likely(status == 0)) {
1470 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1471 if (unlikely(status))
2694a48d 1472 unmap_urb_for_dma(hcd, urb);
ff9c895f
AS		 1473 }
1474 }
9a9bf406
AS		 1475
1476 if (unlikely(status)) {
1da177e4 1477 usbmon_urb_submit_error(&hcd->self, urb, status);
b0d9efba 1478 urb->hcpriv = NULL;
9a9bf406
AS		 1479 INIT_LIST_HEAD(&urb->urb_list);
1480 atomic_dec(&urb->use_count);
4d59d8a1 1481 atomic_dec(&urb->dev->urbnum);
49367d8f 1482 if (atomic_read(&urb->reject))
9a9bf406
AS		 1483 wake_up(&usb_kill_urb_queue);
1484 usb_put_urb(urb);
1da177e4
LT		 1485 }
1486 return status;
1487}
1488
1489/*-------------------------------------------------------------------------*/
1490
1da177e4
LT		 1491/* this makes the hcd giveback() the urb more quickly, by kicking it
1492 * off hardware queues (which may take a while) and returning it as
1493 * soon as practical. we've already set up the urb's return status,
1494 * but we can't know if the callback completed already.
1495 */
e9df41c5 1496static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1da177e4
LT		 1497{
1498 int value;
1499
809a58b8 1500 if (is_root_hub(urb->dev))
e9df41c5 1501 value = usb_rh_urb_dequeue(hcd, urb, status);
1da177e4
LT		 1502 else {
1503
1504 /* The only reason an HCD might fail this call is if
1505 * it has not yet fully queued the urb to begin with.
1506 * Such failures should be harmless. */
e9df41c5 1507 value = hcd->driver->urb_dequeue(hcd, urb, status);
1da177e4 1508 }
1da177e4
LT		 1509 return value;
1510}
1511
1512/*
1513 * called in any context
1514 *
1515 * caller guarantees urb won't be recycled till both unlink()
1516 * and the urb's completion function return
1517 */
a6d2bb9f 1518int usb_hcd_unlink_urb (struct urb *urb, int status)
1da177e4 1519{
9a9bf406 1520 struct usb_hcd *hcd;
cde217a5
AS		 1521 int retval = -EIDRM;
1522 unsigned long flags;
1da177e4 1523
cde217a5
AS		 1524 /* Prevent the device and bus from going away while
1525 * the unlink is carried out. If they are already gone
1526 * then urb->use_count must be 0, since disconnected
1527 * devices can't have any active URBs.
1528 */
1529 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1530 if (atomic_read(&urb->use_count) > 0) {
1531 retval = 0;
1532 usb_get_dev(urb->dev);
1533 }
1534 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1535 if (retval == 0) {
1536 hcd = bus_to_hcd(urb->dev->bus);
1537 retval = unlink1(hcd, urb, status);
1538 usb_put_dev(urb->dev);
1539 }
1da177e4 1540
1da177e4
LT		 1541 if (retval == 0)
1542 retval = -EINPROGRESS;
e9df41c5 1543 else if (retval != -EIDRM && retval != -EBUSY)
9a9bf406
AS		 1544 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1545 urb, retval);
1da177e4
LT		 1546 return retval;
1547}
1548
1549/*-------------------------------------------------------------------------*/
1550
32aca560
AS		 1551/**
1552 * usb_hcd_giveback_urb - return URB from HCD to device driver
1553 * @hcd: host controller returning the URB
1554 * @urb: urb being returned to the USB device driver.
4a00027d 1555 * @status: completion status code for the URB.
32aca560
AS		 1556 * Context: in_interrupt()
1557 *
1558 * This hands the URB from HCD to its USB device driver, using its
1559 * completion function. The HCD has freed all per-urb resources
1560 * (and is done using urb->hcpriv). It also released all HCD locks;
1561 * the device driver won't cause problems if it frees, modifies,
1562 * or resubmits this URB.
eb231054 1563 *
4a00027d 1564 * If @urb was unlinked, the value of @status will be overridden by
eb231054
AS		 1565 * @urb->unlinked. Erroneous short transfers are detected in case
1566 * the HCD hasn't checked for them.
32aca560 1567 */
4a00027d 1568void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
32aca560 1569{
b0d9efba 1570 urb->hcpriv = NULL;
eb231054 1571 if (unlikely(urb->unlinked))
4a00027d 1572 status = urb->unlinked;
eb231054 1573 else if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
b0d9efba 1574 urb->actual_length < urb->transfer_buffer_length &&
4a00027d
AS		 1575 !status))
1576 status = -EREMOTEIO;
32aca560 1577
2694a48d 1578 unmap_urb_for_dma(hcd, urb);
4a00027d 1579 usbmon_urb_complete(&hcd->self, urb, status);
1f5a3d0f
AS		 1580 usb_unanchor_urb(urb);
1581
32aca560 1582 /* pass ownership to the completion handler */
4a00027d 1583 urb->status = status;
32aca560
AS		 1584 urb->complete (urb);
1585 atomic_dec (&urb->use_count);
49367d8f 1586 if (unlikely(atomic_read(&urb->reject)))
32aca560
AS		 1587 wake_up (&usb_kill_urb_queue);
1588 usb_put_urb (urb);
1589}
782e70c6 1590EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
32aca560
AS		 1591
1592/*-------------------------------------------------------------------------*/
1593
95cf82f9
AS		 1594/* Cancel all URBs pending on this endpoint and wait for the endpoint's
1595 * queue to drain completely. The caller must first insure that no more
1596 * URBs can be submitted for this endpoint.
1da177e4 1597 */
95cf82f9 1598void usb_hcd_flush_endpoint(struct usb_device *udev,
a6d2bb9f 1599 struct usb_host_endpoint *ep)
1da177e4
LT		 1600{
1601 struct usb_hcd *hcd;
1602 struct urb *urb;
1603
95cf82f9
AS		 1604 if (!ep)
1605 return;
9a9bf406 1606 might_sleep();
17200583 1607 hcd = bus_to_hcd(udev->bus);
1da177e4 1608
95cf82f9 1609 /* No more submits can occur */
9a9bf406 1610 spin_lock_irq(&hcd_urb_list_lock);
ddc1fd6a 1611rescan:
1da177e4 1612 list_for_each_entry (urb, &ep->urb_list, urb_list) {
5e60a161 1613 int is_in;
1da177e4 1614
eb231054 1615 if (urb->unlinked)
1da177e4
LT		 1616 continue;
1617 usb_get_urb (urb);
5e60a161 1618 is_in = usb_urb_dir_in(urb);
809a58b8 1619 spin_unlock(&hcd_urb_list_lock);
1da177e4 1620
e9df41c5
AS		 1621 /* kick hcd */
1622 unlink1(hcd, urb, -ESHUTDOWN);
1623 dev_dbg (hcd->self.controller,
1624 "shutdown urb %p ep%d%s%s\n",
1625 urb, usb_endpoint_num(&ep->desc),
1626 is_in ? "in" : "out",
1627 ({ char *s;
1628
1629 switch (usb_endpoint_type(&ep->desc)) {
1630 case USB_ENDPOINT_XFER_CONTROL:
1631 s = ""; break;
1632 case USB_ENDPOINT_XFER_BULK:
1633 s = "-bulk"; break;
1634 case USB_ENDPOINT_XFER_INT:
1635 s = "-intr"; break;
1636 default:
1637 s = "-iso"; break;
1638 };
1639 s;
1640 }));
1da177e4
LT		 1641 usb_put_urb (urb);
1642
1643 /* list contents may have changed */
ddc1fd6a 1644 spin_lock(&hcd_urb_list_lock);
1da177e4
LT		 1645 goto rescan;
1646 }
9a9bf406 1647 spin_unlock_irq(&hcd_urb_list_lock);
1da177e4 1648
95cf82f9 1649 /* Wait until the endpoint queue is completely empty */
455b25fb 1650 while (!list_empty (&ep->urb_list)) {
809a58b8 1651 spin_lock_irq(&hcd_urb_list_lock);
455b25fb
AS		 1652
1653 /* The list may have changed while we acquired the spinlock */
1654 urb = NULL;
1655 if (!list_empty (&ep->urb_list)) {
1656 urb = list_entry (ep->urb_list.prev, struct urb,
1657 urb_list);
1658 usb_get_urb (urb);
1659 }
809a58b8 1660 spin_unlock_irq(&hcd_urb_list_lock);
455b25fb
AS		 1661
1662 if (urb) {
1663 usb_kill_urb (urb);
1664 usb_put_urb (urb);
1665 }
1666 }
1da177e4
LT		 1667}
1668
3f0479e0 1669/**
70445ae6
RD		 1670 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1671 * the bus bandwidth
1672 * @udev: target &usb_device
3f0479e0
SS		 1673 * @new_config: new configuration to install
1674 * @cur_alt: the current alternate interface setting
1675 * @new_alt: alternate interface setting that is being installed
1676 *
1677 * To change configurations, pass in the new configuration in new_config,
1678 * and pass NULL for cur_alt and new_alt.
1679 *
1680 * To reset a device's configuration (put the device in the ADDRESSED state),
1681 * pass in NULL for new_config, cur_alt, and new_alt.
1682 *
1683 * To change alternate interface settings, pass in NULL for new_config,
1684 * pass in the current alternate interface setting in cur_alt,
1685 * and pass in the new alternate interface setting in new_alt.
1686 *
1687 * Returns an error if the requested bandwidth change exceeds the
1688 * bus bandwidth or host controller internal resources.
79abb1ab 1689 */
3f0479e0 1690int usb_hcd_alloc_bandwidth(struct usb_device *udev,
79abb1ab 1691 struct usb_host_config *new_config,
3f0479e0
SS		 1692 struct usb_host_interface *cur_alt,
1693 struct usb_host_interface *new_alt)
79abb1ab
SS		 1694{
1695 int num_intfs, i, j;
576a362a 1696 struct usb_host_interface *alt = NULL;
79abb1ab
SS		 1697 int ret = 0;
1698 struct usb_hcd *hcd;
1699 struct usb_host_endpoint *ep;
1700
1701 hcd = bus_to_hcd(udev->bus);
1702 if (!hcd->driver->check_bandwidth)
1703 return 0;
1704
1705 /* Configuration is being removed - set configuration 0 */
3f0479e0 1706 if (!new_config && !cur_alt) {
79abb1ab
SS		 1707 for (i = 1; i < 16; ++i) {
1708 ep = udev->ep_out[i];
1709 if (ep)
1710 hcd->driver->drop_endpoint(hcd, udev, ep);
1711 ep = udev->ep_in[i];
1712 if (ep)
1713 hcd->driver->drop_endpoint(hcd, udev, ep);
1714 }
1715 hcd->driver->check_bandwidth(hcd, udev);
1716 return 0;
1717 }
1718 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1719 * each interface's alt setting 0 and ask the HCD to check the bandwidth
1720 * of the bus. There will always be bandwidth for endpoint 0, so it's
1721 * ok to exclude it.
1722 */
1723 if (new_config) {
1724 num_intfs = new_config->desc.bNumInterfaces;
1725 /* Remove endpoints (except endpoint 0, which is always on the
1726 * schedule) from the old config from the schedule
1727 */
1728 for (i = 1; i < 16; ++i) {
1729 ep = udev->ep_out[i];
1730 if (ep) {
1731 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1732 if (ret < 0)
1733 goto reset;
1734 }
1735 ep = udev->ep_in[i];
1736 if (ep) {
1737 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1738 if (ret < 0)
1739 goto reset;
1740 }
1741 }
1742 for (i = 0; i < num_intfs; ++i) {
d837e219
SS		 1743 struct usb_host_interface *first_alt;
1744 int iface_num;
1745
1746 first_alt = &new_config->intf_cache[i]->altsetting[0];
1747 iface_num = first_alt->desc.bInterfaceNumber;
91017f9c 1748 /* Set up endpoints for alternate interface setting 0 */
d837e219 1749 alt = usb_find_alt_setting(new_config, iface_num, 0);
3f0479e0
SS		 1750 if (!alt)
1751 /* No alt setting 0? Pick the first setting. */
d837e219 1752 alt = first_alt;
3f0479e0 1753
79abb1ab
SS		 1754 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
1755 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
1756 if (ret < 0)
1757 goto reset;
1758 }
1759 }
1760 }
3f0479e0 1761 if (cur_alt && new_alt) {
04a723ea
SS		 1762 struct usb_interface *iface = usb_ifnum_to_if(udev,
1763 cur_alt->desc.bInterfaceNumber);
1764
1765 if (iface->resetting_device) {
1766 /*
1767 * The USB core just reset the device, so the xHCI host
1768 * and the device will think alt setting 0 is installed.
1769 * However, the USB core will pass in the alternate
1770 * setting installed before the reset as cur_alt. Dig
1771 * out the alternate setting 0 structure, or the first
1772 * alternate setting if a broken device doesn't have alt
1773 * setting 0.
1774 */
1775 cur_alt = usb_altnum_to_altsetting(iface, 0);
1776 if (!cur_alt)
1777 cur_alt = &iface->altsetting[0];
1778 }
1779
3f0479e0
SS		 1780 /* Drop all the endpoints in the current alt setting */
1781 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
1782 ret = hcd->driver->drop_endpoint(hcd, udev,
1783 &cur_alt->endpoint[i]);
1784 if (ret < 0)
1785 goto reset;
1786 }
1787 /* Add all the endpoints in the new alt setting */
1788 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
1789 ret = hcd->driver->add_endpoint(hcd, udev,
1790 &new_alt->endpoint[i]);
1791 if (ret < 0)
1792 goto reset;
1793 }
1794 }
79abb1ab
SS		 1795 ret = hcd->driver->check_bandwidth(hcd, udev);
1796reset:
1797 if (ret < 0)
1798 hcd->driver->reset_bandwidth(hcd, udev);
1799 return ret;
1800}
1801
95cf82f9
AS		 1802/* Disables the endpoint: synchronizes with the hcd to make sure all
1803 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
1804 * have been called previously. Use for set_configuration, set_interface,
1805 * driver removal, physical disconnect.
1806 *
1807 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1808 * type, maxpacket size, toggle, halt status, and scheduling.
1809 */
1810void usb_hcd_disable_endpoint(struct usb_device *udev,
1811 struct usb_host_endpoint *ep)
1812{
1813 struct usb_hcd *hcd;
1814
1815 might_sleep();
1816 hcd = bus_to_hcd(udev->bus);
1817 if (hcd->driver->endpoint_disable)
1818 hcd->driver->endpoint_disable(hcd, ep);
1819}
1820
3444b26a
DV		 1821/**
1822 * usb_hcd_reset_endpoint - reset host endpoint state
1823 * @udev: USB device.
1824 * @ep: the endpoint to reset.
1825 *
1826 * Resets any host endpoint state such as the toggle bit, sequence
1827 * number and current window.
1828 */
1829void usb_hcd_reset_endpoint(struct usb_device *udev,
1830 struct usb_host_endpoint *ep)
1831{
1832 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1833
1834 if (hcd->driver->endpoint_reset)
1835 hcd->driver->endpoint_reset(hcd, ep);
1836 else {
1837 int epnum = usb_endpoint_num(&ep->desc);
1838 int is_out = usb_endpoint_dir_out(&ep->desc);
1839 int is_control = usb_endpoint_xfer_control(&ep->desc);
1840
1841 usb_settoggle(udev, epnum, is_out, 0);
1842 if (is_control)
1843 usb_settoggle(udev, epnum, !is_out, 0);
1844 }
1845}
1846
eab1cafc
SS		 1847/**
1848 * usb_alloc_streams - allocate bulk endpoint stream IDs.
1849 * @interface: alternate setting that includes all endpoints.
1850 * @eps: array of endpoints that need streams.
1851 * @num_eps: number of endpoints in the array.
1852 * @num_streams: number of streams to allocate.
1853 * @mem_flags: flags hcd should use to allocate memory.
1854 *
1855 * Sets up a group of bulk endpoints to have num_streams stream IDs available.
1856 * Drivers may queue multiple transfers to different stream IDs, which may
1857 * complete in a different order than they were queued.
1858 */
1859int usb_alloc_streams(struct usb_interface *interface,
1860 struct usb_host_endpoint **eps, unsigned int num_eps,
1861 unsigned int num_streams, gfp_t mem_flags)
1862{
1863 struct usb_hcd *hcd;
1864 struct usb_device *dev;
1865 int i;
1866
1867 dev = interface_to_usbdev(interface);
1868 hcd = bus_to_hcd(dev->bus);
1869 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
1870 return -EINVAL;
1871 if (dev->speed != USB_SPEED_SUPER)
1872 return -EINVAL;
1873
1874 /* Streams only apply to bulk endpoints. */
1875 for (i = 0; i < num_eps; i++)
1876 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
1877 return -EINVAL;
1878
1879 return hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
1880 num_streams, mem_flags);
1881}
1882EXPORT_SYMBOL_GPL(usb_alloc_streams);
1883
1884/**
1885 * usb_free_streams - free bulk endpoint stream IDs.
1886 * @interface: alternate setting that includes all endpoints.
1887 * @eps: array of endpoints to remove streams from.
1888 * @num_eps: number of endpoints in the array.
1889 * @mem_flags: flags hcd should use to allocate memory.
1890 *
1891 * Reverts a group of bulk endpoints back to not using stream IDs.
1892 * Can fail if we are given bad arguments, or HCD is broken.
1893 */
1894void usb_free_streams(struct usb_interface *interface,
1895 struct usb_host_endpoint **eps, unsigned int num_eps,
1896 gfp_t mem_flags)
1897{
1898 struct usb_hcd *hcd;
1899 struct usb_device *dev;
1900 int i;
1901
1902 dev = interface_to_usbdev(interface);
1903 hcd = bus_to_hcd(dev->bus);
1904 if (dev->speed != USB_SPEED_SUPER)
1905 return;
1906
1907 /* Streams only apply to bulk endpoints. */
1908 for (i = 0; i < num_eps; i++)
1909 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
1910 return;
1911
1912 hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
1913}
1914EXPORT_SYMBOL_GPL(usb_free_streams);
1915
cde217a5
AS		 1916/* Protect against drivers that try to unlink URBs after the device
1917 * is gone, by waiting until all unlinks for @udev are finished.
1918 * Since we don't currently track URBs by device, simply wait until
1919 * nothing is running in the locked region of usb_hcd_unlink_urb().
1920 */
1921void usb_hcd_synchronize_unlinks(struct usb_device *udev)
1922{
1923 spin_lock_irq(&hcd_urb_unlink_lock);
1924 spin_unlock_irq(&hcd_urb_unlink_lock);
1925}
1926
1da177e4
LT		 1927/*-------------------------------------------------------------------------*/
1928
32aca560
AS		 1929/* called in any context */
1930int usb_hcd_get_frame_number (struct usb_device *udev)
1931{
1932 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1933
1934 if (!HC_IS_RUNNING (hcd->state))
1935 return -ESHUTDOWN;
1936 return hcd->driver->get_frame_number (hcd);
1937}
1938
1939/*-------------------------------------------------------------------------*/
1940
9293677a 1941#ifdef CONFIG_PM
1da177e4 1942
65bfd296 1943int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
1da177e4 1944{
686314cf
AS		 1945 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1946 int status;
1947 int old_state = hcd->state;
1da177e4 1948
686314cf 1949 dev_dbg(&rhdev->dev, "bus %s%s\n",
65bfd296 1950 (msg.event & PM_EVENT_AUTO ? "auto-" : ""), "suspend");
686314cf
AS		 1951 if (!hcd->driver->bus_suspend) {
1952 status = -ENOENT;
1953 } else {
1954 hcd->state = HC_STATE_QUIESCING;
1955 status = hcd->driver->bus_suspend(hcd);
1956 }
1957 if (status == 0) {
1958 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
9293677a 1959 hcd->state = HC_STATE_SUSPENDED;
686314cf
AS		 1960 } else {
1961 hcd->state = old_state;
1962 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
9293677a 1963 "suspend", status);
686314cf 1964 }
9293677a 1965 return status;
1da177e4
LT		 1966}
1967
65bfd296 1968int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
1da177e4 1969{
686314cf
AS		 1970 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1971 int status;
cfa59dab 1972 int old_state = hcd->state;
1da177e4 1973
686314cf 1974 dev_dbg(&rhdev->dev, "usb %s%s\n",
65bfd296 1975 (msg.event & PM_EVENT_AUTO ? "auto-" : ""), "resume");
0c0382e3 1976 if (!hcd->driver->bus_resume)
9293677a 1977 return -ENOENT;
979d5199
DB		 1978 if (hcd->state == HC_STATE_RUNNING)
1979 return 0;
686314cf 1980
9293677a 1981 hcd->state = HC_STATE_RESUMING;
686314cf 1982 status = hcd->driver->bus_resume(hcd);
bf3d7d40 1983 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
686314cf
AS		 1984 if (status == 0) {
1985 /* TRSMRCY = 10 msec */
1986 msleep(10);
1987 usb_set_device_state(rhdev, rhdev->actconfig
1988 ? USB_STATE_CONFIGURED
1989 : USB_STATE_ADDRESS);
9293677a 1990 hcd->state = HC_STATE_RUNNING;
686314cf 1991 } else {
cfa59dab 1992 hcd->state = old_state;
686314cf 1993 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
9293677a 1994 "resume", status);
cfa59dab
AS		 1995 if (status != -ESHUTDOWN)
1996 usb_hc_died(hcd);
9293677a
DB		 1997 }
1998 return status;
1da177e4
LT		 1999}
2000
9bbdf1e0
AS		 2001#endif /* CONFIG_PM */
2002
2003#ifdef CONFIG_USB_SUSPEND
2004
6b157c9b
AS		 2005/* Workqueue routine for root-hub remote wakeup */
2006static void hcd_resume_work(struct work_struct *work)
2007{
2008 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2009 struct usb_device *udev = hcd->self.root_hub;
2010
2011 usb_lock_device(udev);
0534d468 2012 usb_remote_wakeup(udev);
6b157c9b
AS		 2013 usb_unlock_device(udev);
2014}
2015
1da177e4
LT		 2016/**
2017 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
2018 * @hcd: host controller for this root hub
2019 *
2020 * The USB host controller calls this function when its root hub is
2021 * suspended (with the remote wakeup feature enabled) and a remote
6b157c9b
AS		 2022 * wakeup request is received. The routine submits a workqueue request
2023 * to resume the root hub (that is, manage its downstream ports again).
1da177e4
LT		 2024 */
2025void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2026{
2027 unsigned long flags;
2028
2029 spin_lock_irqsave (&hcd_root_hub_lock, flags);
ff2f0787
AS		 2030 if (hcd->rh_registered) {
2031 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
9bbdf1e0 2032 queue_work(pm_wq, &hcd->wakeup_work);
ff2f0787 2033 }
1da177e4
LT		 2034 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2035}
9293677a 2036EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1da177e4 2037
9bbdf1e0 2038#endif /* CONFIG_USB_SUSPEND */
1da177e4
LT		 2039
2040/*-------------------------------------------------------------------------*/
2041
2042#ifdef CONFIG_USB_OTG
2043
2044/**
2045 * usb_bus_start_enum - start immediate enumeration (for OTG)
2046 * @bus: the bus (must use hcd framework)
2047 * @port_num: 1-based number of port; usually bus->otg_port
2048 * Context: in_interrupt()
2049 *
2050 * Starts enumeration, with an immediate reset followed later by
2051 * khubd identifying and possibly configuring the device.
2052 * This is needed by OTG controller drivers, where it helps meet
2053 * HNP protocol timing requirements for starting a port reset.
2054 */
2055int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2056{
2057 struct usb_hcd *hcd;
2058 int status = -EOPNOTSUPP;
2059
2060 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2061 * boards with root hubs hooked up to internal devices (instead of
2062 * just the OTG port) may need more attention to resetting...
2063 */
2064 hcd = container_of (bus, struct usb_hcd, self);
2065 if (port_num && hcd->driver->start_port_reset)
2066 status = hcd->driver->start_port_reset(hcd, port_num);
2067
2068 /* run khubd shortly after (first) root port reset finishes;
2069 * it may issue others, until at least 50 msecs have passed.
2070 */
2071 if (status == 0)
2072 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2073 return status;
2074}
782e70c6 2075EXPORT_SYMBOL_GPL(usb_bus_start_enum);
1da177e4
LT		 2076
2077#endif
2078
2079/*-------------------------------------------------------------------------*/
2080
1da177e4
LT		 2081/**
2082 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2083 * @irq: the IRQ being raised
2084 * @__hcd: pointer to the HCD whose IRQ is being signaled
1da177e4
LT		 2085 *
2086 * If the controller isn't HALTed, calls the driver's irq handler.
2087 * Checks whether the controller is now dead.
2088 */
7d12e780 2089irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1da177e4
LT		 2090{
2091 struct usb_hcd *hcd = __hcd;
de85422b
SB		 2092 unsigned long flags;
2093 irqreturn_t rc;
1da177e4 2094
de85422b
SB		 2095 /* IRQF_DISABLED doesn't work correctly with shared IRQs
2096 * when the first handler doesn't use it. So let's just
2097 * assume it's never used.
2098 */
2099 local_irq_save(flags);
1da177e4 2100
541c7d43 2101 if (unlikely(hcd->state == HC_STATE_HALT || !HCD_HW_ACCESSIBLE(hcd))) {
de85422b
SB		 2102 rc = IRQ_NONE;
2103 } else if (hcd->driver->irq(hcd) == IRQ_NONE) {
2104 rc = IRQ_NONE;
2105 } else {
2106 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
8de98402 2107
de85422b
SB		 2108 if (unlikely(hcd->state == HC_STATE_HALT))
2109 usb_hc_died(hcd);
2110 rc = IRQ_HANDLED;
2111 }
2112
2113 local_irq_restore(flags);
2114 return rc;
1da177e4 2115}
43b86af8 2116EXPORT_SYMBOL_GPL(usb_hcd_irq);
1da177e4
LT		 2117
2118/*-------------------------------------------------------------------------*/
2119
2120/**
2121 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2122 * @hcd: pointer to the HCD representing the controller
2123 *
2124 * This is called by bus glue to report a USB host controller that died
2125 * while operations may still have been pending. It's called automatically
2126 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2127 */
2128void usb_hc_died (struct usb_hcd *hcd)
2129{
2130 unsigned long flags;
2131
2132 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2133
2134 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2135 if (hcd->rh_registered) {
541c7d43 2136 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1da177e4
LT		 2137
2138 /* make khubd clean up old urbs and devices */
2139 usb_set_device_state (hcd->self.root_hub,
2140 USB_STATE_NOTATTACHED);
2141 usb_kick_khubd (hcd->self.root_hub);
2142 }
2143 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2144}
2145EXPORT_SYMBOL_GPL (usb_hc_died);
2146
2147/*-------------------------------------------------------------------------*/
2148
1da177e4
LT		 2149/**
2150 * usb_create_hcd - create and initialize an HCD structure
2151 * @driver: HC driver that will use this hcd
2152 * @dev: device for this HC, stored in hcd->self.controller
2153 * @bus_name: value to store in hcd->self.bus_name
2154 * Context: !in_interrupt()
2155 *
2156 * Allocate a struct usb_hcd, with extra space at the end for the
2157 * HC driver's private data. Initialize the generic members of the
2158 * hcd structure.
2159 *
2160 * If memory is unavailable, returns NULL.
2161 */
2162struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
1b26da15 2163 struct device *dev, const char *bus_name)
1da177e4
LT		 2164{
2165 struct usb_hcd *hcd;
2166
7b842b6e 2167 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1da177e4
LT		 2168 if (!hcd) {
2169 dev_dbg (dev, "hcd alloc failed\n");
2170 return NULL;
2171 }
2172 dev_set_drvdata(dev, hcd);
17200583 2173 kref_init(&hcd->kref);
1da177e4
LT		 2174
2175 usb_bus_init(&hcd->self);
1da177e4
LT		 2176 hcd->self.controller = dev;
2177 hcd->self.bus_name = bus_name;
dd990f16 2178 hcd->self.uses_dma = (dev->dma_mask != NULL);
1da177e4
LT		 2179
2180 init_timer(&hcd->rh_timer);
d5926ae7
AS		 2181 hcd->rh_timer.function = rh_timer_func;
2182 hcd->rh_timer.data = (unsigned long) hcd;
9bbdf1e0 2183#ifdef CONFIG_USB_SUSPEND
6b157c9b
AS		 2184 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2185#endif
3f0479e0 2186 mutex_init(&hcd->bandwidth_mutex);
1da177e4
LT		 2187
2188 hcd->driver = driver;
2189 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2190 "USB Host Controller";
1da177e4
LT		 2191 return hcd;
2192}
782e70c6 2193EXPORT_SYMBOL_GPL(usb_create_hcd);
1da177e4 2194
17200583
AS		 2195static void hcd_release (struct kref *kref)
2196{
2197 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2198
2199 kfree(hcd);
2200}
2201
2202struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2203{
2204 if (hcd)
2205 kref_get (&hcd->kref);
2206 return hcd;
2207}
782e70c6 2208EXPORT_SYMBOL_GPL(usb_get_hcd);
17200583 2209
1da177e4
LT		 2210void usb_put_hcd (struct usb_hcd *hcd)
2211{
17200583
AS		 2212 if (hcd)
2213 kref_put (&hcd->kref, hcd_release);
1da177e4 2214}
782e70c6 2215EXPORT_SYMBOL_GPL(usb_put_hcd);
1da177e4
LT		 2216
2217/**
2218 * usb_add_hcd - finish generic HCD structure initialization and register
2219 * @hcd: the usb_hcd structure to initialize
2220 * @irqnum: Interrupt line to allocate
2221 * @irqflags: Interrupt type flags
2222 *
2223 * Finish the remaining parts of generic HCD initialization: allocate the
2224 * buffers of consistent memory, register the bus, request the IRQ line,
2225 * and call the driver's reset() and start() routines.
2226 */
2227int usb_add_hcd(struct usb_hcd *hcd,
2228 unsigned int irqnum, unsigned long irqflags)
2229{
8ec8d20b
AS		 2230 int retval;
2231 struct usb_device *rhdev;
1da177e4
LT		 2232
2233 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2234
5234ce1b 2235 hcd->authorized_default = hcd->wireless? 0 : 1;
8de98402
BH		 2236 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2237
b1e8f0a6
DB		 2238 /* HC is in reset state, but accessible. Now do the one-time init,
2239 * bottom up so that hcds can customize the root hubs before khubd
2240 * starts talking to them. (Note, bus id is assigned early too.)
2241 */
1da177e4
LT		 2242 if ((retval = hcd_buffer_create(hcd)) != 0) {
2243 dev_dbg(hcd->self.controller, "pool alloc failed\n");
2244 return retval;
2245 }
2246
2247 if ((retval = usb_register_bus(&hcd->self)) < 0)
8ec8d20b 2248 goto err_register_bus;
1da177e4 2249
b1e8f0a6
DB		 2250 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
2251 dev_err(hcd->self.controller, "unable to allocate root hub\n");
2252 retval = -ENOMEM;
2253 goto err_allocate_root_hub;
2254 }
6d88e679 2255 hcd->self.root_hub = rhdev;
6b403b02
SS		 2256
2257 switch (hcd->driver->flags & HCD_MASK) {
2258 case HCD_USB11:
2259 rhdev->speed = USB_SPEED_FULL;
2260 break;
2261 case HCD_USB2:
2262 rhdev->speed = USB_SPEED_HIGH;
2263 break;
2264 case HCD_USB3:
2265 rhdev->speed = USB_SPEED_SUPER;
2266 break;
2267 default:
96e077ae 2268 goto err_set_rh_speed;
6b403b02 2269 }
b1e8f0a6 2270
db4cefaa
DB		 2271 /* wakeup flag init defaults to "everything works" for root hubs,
2272 * but drivers can override it in reset() if needed, along with
2273 * recording the overall controller's system wakeup capability.
2274 */
2275 device_init_wakeup(&rhdev->dev, 1);
2276
b1e8f0a6
DB		 2277 /* "reset" is misnamed; its role is now one-time init. the controller
2278 * should already have been reset (and boot firmware kicked off etc).
2279 */
2280 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
2281 dev_err(hcd->self.controller, "can't setup\n");
2282 goto err_hcd_driver_setup;
2283 }
6d88e679 2284 hcd->rh_pollable = 1;
b1e8f0a6 2285
fb669cc0
DB		 2286 /* NOTE: root hub and controller capabilities may not be the same */
2287 if (device_can_wakeup(hcd->self.controller)
2288 && device_can_wakeup(&hcd->self.root_hub->dev))
b1e8f0a6 2289 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
b1e8f0a6
DB		 2290
2291 /* enable irqs just before we start the controller */
1da177e4 2292 if (hcd->driver->irq) {
de85422b
SB		 2293
2294 /* IRQF_DISABLED doesn't work as advertised when used together
2295 * with IRQF_SHARED. As usb_hcd_irq() will always disable
2296 * interrupts we can remove it here.
2297 */
83a79820
GL		 2298 if (irqflags & IRQF_SHARED)
2299 irqflags &= ~IRQF_DISABLED;
de85422b 2300
1da177e4
LT		 2301 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2302 hcd->driver->description, hcd->self.busnum);
2303 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2304 hcd->irq_descr, hcd)) != 0) {
2305 dev_err(hcd->self.controller,
c6387a48 2306 "request interrupt %d failed\n", irqnum);
8ec8d20b 2307 goto err_request_irq;
1da177e4
LT		 2308 }
2309 hcd->irq = irqnum;
c6387a48 2310 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
1da177e4
LT		 2311 (hcd->driver->flags & HCD_MEMORY) ?
2312 "io mem" : "io base",
2313 (unsigned long long)hcd->rsrc_start);
2314 } else {
2315 hcd->irq = -1;
2316 if (hcd->rsrc_start)
2317 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2318 (hcd->driver->flags & HCD_MEMORY) ?
2319 "io mem" : "io base",
2320 (unsigned long long)hcd->rsrc_start);
2321 }
2322
2323 if ((retval = hcd->driver->start(hcd)) < 0) {
2324 dev_err(hcd->self.controller, "startup error %d\n", retval);
8ec8d20b 2325 goto err_hcd_driver_start;
1da177e4
LT		 2326 }
2327
b1e8f0a6 2328 /* starting here, usbcore will pay attention to this root hub */
55c52718 2329 rhdev->bus_mA = min(500u, hcd->power_budget);
b1e8f0a6 2330 if ((retval = register_root_hub(hcd)) != 0)
8ec8d20b
AS		 2331 goto err_register_root_hub;
2332
5234ce1b
IPG		 2333 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2334 if (retval < 0) {
2335 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2336 retval);
2337 goto error_create_attr_group;
2338 }
541c7d43 2339 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
d5926ae7 2340 usb_hcd_poll_rh_status(hcd);
1da177e4
LT		 2341 return retval;
2342
5234ce1b 2343error_create_attr_group:
96e077ae
AS		 2344 if (HC_IS_RUNNING(hcd->state))
2345 hcd->state = HC_STATE_QUIESCING;
2346 spin_lock_irq(&hcd_root_hub_lock);
2347 hcd->rh_registered = 0;
2348 spin_unlock_irq(&hcd_root_hub_lock);
2349
2350#ifdef CONFIG_USB_SUSPEND
2351 cancel_work_sync(&hcd->wakeup_work);
2352#endif
5234ce1b 2353 mutex_lock(&usb_bus_list_lock);
6d88e679 2354 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
5234ce1b 2355 mutex_unlock(&usb_bus_list_lock);
b1e8f0a6 2356err_register_root_hub:
6d88e679 2357 hcd->rh_pollable = 0;
541c7d43 2358 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
6d88e679 2359 del_timer_sync(&hcd->rh_timer);
8ec8d20b 2360 hcd->driver->stop(hcd);
96e077ae 2361 hcd->state = HC_STATE_HALT;
541c7d43 2362 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
96e077ae 2363 del_timer_sync(&hcd->rh_timer);
b1e8f0a6 2364err_hcd_driver_start:
1da177e4
LT		 2365 if (hcd->irq >= 0)
2366 free_irq(irqnum, hcd);
b1e8f0a6
DB		 2367err_request_irq:
2368err_hcd_driver_setup:
96e077ae 2369err_set_rh_speed:
6d88e679 2370 usb_put_dev(hcd->self.root_hub);
b1e8f0a6 2371err_allocate_root_hub:
1da177e4 2372 usb_deregister_bus(&hcd->self);
b1e8f0a6 2373err_register_bus:
1da177e4
LT		 2374 hcd_buffer_destroy(hcd);
2375 return retval;
2376}
782e70c6 2377EXPORT_SYMBOL_GPL(usb_add_hcd);
1da177e4
LT		 2378
2379/**
2380 * usb_remove_hcd - shutdown processing for generic HCDs
2381 * @hcd: the usb_hcd structure to remove
2382 * Context: !in_interrupt()
2383 *
2384 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2385 * invoking the HCD's stop() method.
2386 */
2387void usb_remove_hcd(struct usb_hcd *hcd)
2388{
6d88e679
AS		 2389 struct usb_device *rhdev = hcd->self.root_hub;
2390
1da177e4
LT		 2391 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2392
6d88e679
AS		 2393 usb_get_dev(rhdev);
2394 sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
96e077ae 2395
1da177e4
LT		 2396 if (HC_IS_RUNNING (hcd->state))
2397 hcd->state = HC_STATE_QUIESCING;
2398
2399 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2400 spin_lock_irq (&hcd_root_hub_lock);
2401 hcd->rh_registered = 0;
2402 spin_unlock_irq (&hcd_root_hub_lock);
9ad3d6cc 2403
9bbdf1e0 2404#ifdef CONFIG_USB_SUSPEND
d5d4db70 2405 cancel_work_sync(&hcd->wakeup_work);
6b157c9b
AS		 2406#endif
2407
4186ecf8 2408 mutex_lock(&usb_bus_list_lock);
6d88e679 2409 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
4186ecf8 2410 mutex_unlock(&usb_bus_list_lock);
1da177e4 2411
6d88e679
AS		 2412 /* Prevent any more root-hub status calls from the timer.
2413 * The HCD might still restart the timer (if a port status change
2414 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2415 * the hub_status_data() callback.
2416 */
2417 hcd->rh_pollable = 0;
541c7d43 2418 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
6d88e679
AS		 2419 del_timer_sync(&hcd->rh_timer);
2420
1da177e4
LT		 2421 hcd->driver->stop(hcd);
2422 hcd->state = HC_STATE_HALT;
2423
6d88e679 2424 /* In case the HCD restarted the timer, stop it again. */
541c7d43 2425 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1b42ae6d
AS		 2426 del_timer_sync(&hcd->rh_timer);
2427
1da177e4
LT		 2428 if (hcd->irq >= 0)
2429 free_irq(hcd->irq, hcd);
6d88e679
AS		 2430
2431 usb_put_dev(hcd->self.root_hub);
1da177e4
LT		 2432 usb_deregister_bus(&hcd->self);
2433 hcd_buffer_destroy(hcd);
2434}
782e70c6 2435EXPORT_SYMBOL_GPL(usb_remove_hcd);
1da177e4 2436
64a21d02
AG		 2437void
2438usb_hcd_platform_shutdown(struct platform_device* dev)
2439{
2440 struct usb_hcd *hcd = platform_get_drvdata(dev);
2441
2442 if (hcd->driver->shutdown)
2443 hcd->driver->shutdown(hcd);
2444}
782e70c6 2445EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
64a21d02 2446
1da177e4
LT		 2447/*-------------------------------------------------------------------------*/
2448
f150fa1a 2449#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
1da177e4
LT		 2450
2451struct usb_mon_operations *mon_ops;
2452
2453/*
2454 * The registration is unlocked.
2455 * We do it this way because we do not want to lock in hot paths.
2456 *
2457 * Notice that the code is minimally error-proof. Because usbmon needs
2458 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
2459 */
2460
2461int usb_mon_register (struct usb_mon_operations *ops)
2462{
2463
2464 if (mon_ops)
2465 return -EBUSY;
2466
2467 mon_ops = ops;
2468 mb();
2469 return 0;
2470}
2471EXPORT_SYMBOL_GPL (usb_mon_register);
2472
2473void usb_mon_deregister (void)
2474{
2475
2476 if (mon_ops == NULL) {
2477 printk(KERN_ERR "USB: monitor was not registered\n");
2478 return;
2479 }
2480 mon_ops = NULL;
2481 mb();
2482}
2483EXPORT_SYMBOL_GPL (usb_mon_deregister);
2484
f150fa1a 2485#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
kernel source for telekom puls (alcatel/mediatek)