]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/usb/core/hcd.c
projects / mirror_ubuntu-bionic-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
USB: core, devio: use to_usb_device
[mirror_ubuntu-bionic-kernel.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
14557359 9 *
1da177e4
LT		 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
b53d657d 25#include <linux/bcd.h>
1da177e4
LT		 26#include <linux/module.h>
27#include <linux/version.h>
28#include <linux/kernel.h>
29#include <linux/slab.h>
30#include <linux/completion.h>
31#include <linux/utsname.h>
32#include <linux/mm.h>
33#include <asm/io.h>
1da177e4
LT		 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>
b3476675 39#include <asm/unaligned.h>
64a21d02 40#include <linux/platform_device.h>
6b157c9b 41#include <linux/workqueue.h>
da0aa716 42#include <linux/pm_runtime.h>
059239ad 43#include <linux/types.h>
1da177e4 44
00433254 45#include <linux/phy/phy.h>
1da177e4 46#include <linux/usb.h>
27729aad 47#include <linux/usb/hcd.h>
103e127d 48#include <linux/usb/phy.h>
1da177e4
LT		 49
50#include "usb.h"
1da177e4
LT		 51
52
1da177e4
LT		 53/*-------------------------------------------------------------------------*/
54
55/*
56 * USB Host Controller Driver framework
57 *
58 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
59 * HCD-specific behaviors/bugs.
60 *
61 * This does error checks, tracks devices and urbs, and delegates to a
62 * "hc_driver" only for code (and data) that really needs to know about
63 * hardware differences. That includes root hub registers, i/o queues,
64 * and so on ... but as little else as possible.
65 *
66 * Shared code includes most of the "root hub" code (these are emulated,
67 * though each HC's hardware works differently) and PCI glue, plus request
68 * tracking overhead. The HCD code should only block on spinlocks or on
69 * hardware handshaking; blocking on software events (such as other kernel
70 * threads releasing resources, or completing actions) is all generic.
71 *
72 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
73 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
74 * only by the hub driver ... and that neither should be seen or used by
75 * usb client device drivers.
76 *
77 * Contributors of ideas or unattributed patches include: David Brownell,
78 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
79 *
80 * HISTORY:
81 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
82 * associated cleanup. "usb_hcd" still != "usb_bus".
83 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
84 */
85
86/*-------------------------------------------------------------------------*/
87
9beeee65
AS		 88/* Keep track of which host controller drivers are loaded */
89unsigned long usb_hcds_loaded;
90EXPORT_SYMBOL_GPL(usb_hcds_loaded);
91
1da177e4
LT		 92/* host controllers we manage */
93LIST_HEAD (usb_bus_list);
94EXPORT_SYMBOL_GPL (usb_bus_list);
95
96/* used when allocating bus numbers */
97#define USB_MAXBUS 64
059239ad 98static DECLARE_BITMAP(busmap, USB_MAXBUS);
1da177e4
LT		 99
100/* used when updating list of hcds */
4186ecf8 101DEFINE_MUTEX(usb_bus_list_lock); /* exported only for usbfs */
1da177e4
LT		 102EXPORT_SYMBOL_GPL (usb_bus_list_lock);
103
104/* used for controlling access to virtual root hubs */
105static DEFINE_SPINLOCK(hcd_root_hub_lock);
106
809a58b8
AS		 107/* used when updating an endpoint's URB list */
108static DEFINE_SPINLOCK(hcd_urb_list_lock);
1da177e4 109
cde217a5
AS		 110/* used to protect against unlinking URBs after the device is gone */
111static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
112
1da177e4
LT		 113/* wait queue for synchronous unlinks */
114DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
115
809a58b8
AS		 116static inline int is_root_hub(struct usb_device *udev)
117{
118 return (udev->parent == NULL);
119}
120
1da177e4
LT		 121/*-------------------------------------------------------------------------*/
122
123/*
124 * Sharable chunks of root hub code.
125 */
126
127/*-------------------------------------------------------------------------*/
b53d657d
SAS		 128#define KERNEL_REL bin2bcd(((LINUX_VERSION_CODE >> 16) & 0x0ff))
129#define KERNEL_VER bin2bcd(((LINUX_VERSION_CODE >> 8) & 0x0ff))
1da177e4 130
9508e3b7
MN		 131/* usb 3.1 root hub device descriptor */
132static const u8 usb31_rh_dev_descriptor[18] = {
133 0x12, /* __u8 bLength; */
134 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
135 0x10, 0x03, /* __le16 bcdUSB; v3.1 */
136
137 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
138 0x00, /* __u8 bDeviceSubClass; */
139 0x03, /* __u8 bDeviceProtocol; USB 3 hub */
140 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
141
142 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
143 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
144 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
145
146 0x03, /* __u8 iManufacturer; */
147 0x02, /* __u8 iProduct; */
148 0x01, /* __u8 iSerialNumber; */
149 0x01 /* __u8 bNumConfigurations; */
150};
151
d2e9b4d6
SS		 152/* usb 3.0 root hub device descriptor */
153static const u8 usb3_rh_dev_descriptor[18] = {
154 0x12, /* __u8 bLength; */
d491fe75 155 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
d2e9b4d6
SS		 156 0x00, 0x03, /* __le16 bcdUSB; v3.0 */
157
158 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
159 0x00, /* __u8 bDeviceSubClass; */
160 0x03, /* __u8 bDeviceProtocol; USB 3.0 hub */
161 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
162
bfb8bfad 163 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
cd780694 164 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
d2e9b4d6
SS		 165 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
166
167 0x03, /* __u8 iManufacturer; */
168 0x02, /* __u8 iProduct; */
169 0x01, /* __u8 iSerialNumber; */
170 0x01 /* __u8 bNumConfigurations; */
171};
172
1a81f881
TP		 173/* usb 2.5 (wireless USB 1.0) root hub device descriptor */
174static const u8 usb25_rh_dev_descriptor[18] = {
175 0x12, /* __u8 bLength; */
d491fe75 176 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
1a81f881
TP		 177 0x50, 0x02, /* __le16 bcdUSB; v2.5 */
178
179 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
180 0x00, /* __u8 bDeviceSubClass; */
181 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
182 0xFF, /* __u8 bMaxPacketSize0; always 0xFF (WUSB Spec 7.4.1). */
183
184 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
185 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
186 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
187
188 0x03, /* __u8 iManufacturer; */
189 0x02, /* __u8 iProduct; */
190 0x01, /* __u8 iSerialNumber; */
191 0x01 /* __u8 bNumConfigurations; */
192};
193
1da177e4 194/* usb 2.0 root hub device descriptor */
14557359 195static const u8 usb2_rh_dev_descriptor[18] = {
1da177e4 196 0x12, /* __u8 bLength; */
d491fe75 197 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
1da177e4
LT		 198 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
199
200 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
201 0x00, /* __u8 bDeviceSubClass; */
7329e211 202 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
16f16d11 203 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
1da177e4 204
bfb8bfad 205 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
667d691e 206 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
1da177e4
LT		 207 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
208
209 0x03, /* __u8 iManufacturer; */
210 0x02, /* __u8 iProduct; */
211 0x01, /* __u8 iSerialNumber; */
212 0x01 /* __u8 bNumConfigurations; */
213};
214
215/* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
216
217/* usb 1.1 root hub device descriptor */
14557359 218static const u8 usb11_rh_dev_descriptor[18] = {
1da177e4 219 0x12, /* __u8 bLength; */
d491fe75 220 USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
1da177e4
LT		 221 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
222
223 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
224 0x00, /* __u8 bDeviceSubClass; */
225 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
16f16d11 226 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
1da177e4 227
bfb8bfad 228 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
667d691e 229 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
1da177e4
LT		 230 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
231
232 0x03, /* __u8 iManufacturer; */
233 0x02, /* __u8 iProduct; */
234 0x01, /* __u8 iSerialNumber; */
235 0x01 /* __u8 bNumConfigurations; */
236};
237
238
239/*-------------------------------------------------------------------------*/
240
241/* Configuration descriptors for our root hubs */
242
14557359 243static const u8 fs_rh_config_descriptor[] = {
1da177e4
LT		 244
245 /* one configuration */
246 0x09, /* __u8 bLength; */
d491fe75 247 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
1da177e4
LT		 248 0x19, 0x00, /* __le16 wTotalLength; */
249 0x01, /* __u8 bNumInterfaces; (1) */
250 0x01, /* __u8 bConfigurationValue; */
251 0x00, /* __u8 iConfiguration; */
14557359 252 0xc0, /* __u8 bmAttributes;
1da177e4
LT		 253 Bit 7: must be set,
254 6: Self-powered,
255 5: Remote wakeup,
256 4..0: resvd */
257 0x00, /* __u8 MaxPower; */
14557359 258
1da177e4
LT		 259 /* USB 1.1:
260 * USB 2.0, single TT organization (mandatory):
261 * one interface, protocol 0
262 *
263 * USB 2.0, multiple TT organization (optional):
264 * two interfaces, protocols 1 (like single TT)
265 * and 2 (multiple TT mode) ... config is
266 * sometimes settable
267 * NOT IMPLEMENTED
268 */
269
270 /* one interface */
271 0x09, /* __u8 if_bLength; */
d491fe75 272 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
1da177e4
LT		 273 0x00, /* __u8 if_bInterfaceNumber; */
274 0x00, /* __u8 if_bAlternateSetting; */
275 0x01, /* __u8 if_bNumEndpoints; */
276 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
277 0x00, /* __u8 if_bInterfaceSubClass; */
278 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
279 0x00, /* __u8 if_iInterface; */
14557359 280
1da177e4
LT		 281 /* one endpoint (status change endpoint) */
282 0x07, /* __u8 ep_bLength; */
d491fe75 283 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
1da177e4 284 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
14557359
MB		 285 0x03, /* __u8 ep_bmAttributes; Interrupt */
286 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
1da177e4
LT		 287 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
288};
289
14557359 290static const u8 hs_rh_config_descriptor[] = {
1da177e4
LT		 291
292 /* one configuration */
293 0x09, /* __u8 bLength; */
d491fe75 294 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
1da177e4
LT		 295 0x19, 0x00, /* __le16 wTotalLength; */
296 0x01, /* __u8 bNumInterfaces; (1) */
297 0x01, /* __u8 bConfigurationValue; */
298 0x00, /* __u8 iConfiguration; */
14557359 299 0xc0, /* __u8 bmAttributes;
1da177e4
LT		 300 Bit 7: must be set,
301 6: Self-powered,
302 5: Remote wakeup,
303 4..0: resvd */
304 0x00, /* __u8 MaxPower; */
14557359 305
1da177e4
LT		 306 /* USB 1.1:
307 * USB 2.0, single TT organization (mandatory):
308 * one interface, protocol 0
309 *
310 * USB 2.0, multiple TT organization (optional):
311 * two interfaces, protocols 1 (like single TT)
312 * and 2 (multiple TT mode) ... config is
313 * sometimes settable
314 * NOT IMPLEMENTED
315 */
316
317 /* one interface */
318 0x09, /* __u8 if_bLength; */
d491fe75 319 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
1da177e4
LT		 320 0x00, /* __u8 if_bInterfaceNumber; */
321 0x00, /* __u8 if_bAlternateSetting; */
322 0x01, /* __u8 if_bNumEndpoints; */
323 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
324 0x00, /* __u8 if_bInterfaceSubClass; */
325 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
326 0x00, /* __u8 if_iInterface; */
14557359 327
1da177e4
LT		 328 /* one endpoint (status change endpoint) */
329 0x07, /* __u8 ep_bLength; */
d491fe75 330 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
1da177e4 331 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
14557359 332 0x03, /* __u8 ep_bmAttributes; Interrupt */
88fafff9 333 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
334 * see hub.c:hub_configure() for details. */
335 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
1da177e4
LT		 336 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
337};
338
d2e9b4d6
SS		 339static const u8 ss_rh_config_descriptor[] = {
340 /* one configuration */
341 0x09, /* __u8 bLength; */
d491fe75 342 USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
22c6a35d 343 0x1f, 0x00, /* __le16 wTotalLength; */
d2e9b4d6
SS		 344 0x01, /* __u8 bNumInterfaces; (1) */
345 0x01, /* __u8 bConfigurationValue; */
346 0x00, /* __u8 iConfiguration; */
347 0xc0, /* __u8 bmAttributes;
348 Bit 7: must be set,
349 6: Self-powered,
350 5: Remote wakeup,
351 4..0: resvd */
352 0x00, /* __u8 MaxPower; */
353
354 /* one interface */
355 0x09, /* __u8 if_bLength; */
d491fe75 356 USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
d2e9b4d6
SS		 357 0x00, /* __u8 if_bInterfaceNumber; */
358 0x00, /* __u8 if_bAlternateSetting; */
359 0x01, /* __u8 if_bNumEndpoints; */
360 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
361 0x00, /* __u8 if_bInterfaceSubClass; */
362 0x00, /* __u8 if_bInterfaceProtocol; */
363 0x00, /* __u8 if_iInterface; */
364
365 /* one endpoint (status change endpoint) */
366 0x07, /* __u8 ep_bLength; */
d491fe75 367 USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
d2e9b4d6
SS		 368 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
369 0x03, /* __u8 ep_bmAttributes; Interrupt */
370 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
371 * see hub.c:hub_configure() for details. */
372 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
22c6a35d
SS		 373 0x0c, /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
374
375 /* one SuperSpeed endpoint companion descriptor */
376 0x06, /* __u8 ss_bLength */
d491fe75
SS		 377 USB_DT_SS_ENDPOINT_COMP, /* __u8 ss_bDescriptorType; SuperSpeed EP */
378 /* Companion */
22c6a35d
SS		 379 0x00, /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
380 0x00, /* __u8 ss_bmAttributes; 1 packet per service interval */
381 0x02, 0x00 /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
d2e9b4d6
SS		 382};
383
c4fc2342
CDH		 384/* authorized_default behaviour:
385 * -1 is authorized for all devices except wireless (old behaviour)
386 * 0 is unauthorized for all devices
387 * 1 is authorized for all devices
388 */
389static int authorized_default = -1;
390module_param(authorized_default, int, S_IRUGO|S_IWUSR);
391MODULE_PARM_DESC(authorized_default,
392 "Default USB device authorization: 0 is not authorized, 1 is "
393 "authorized, -1 is authorized except for wireless USB (default, "
394 "old behaviour");
1da177e4
LT		 395/*-------------------------------------------------------------------------*/
396
392ca68b
GS		 397/**
398 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
399 * @s: Null-terminated ASCII (actually ISO-8859-1) string
400 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
401 * @len: Length (in bytes; may be odd) of descriptor buffer.
402 *
626f090c
YB		 403 * Return: The number of bytes filled in: 2 + 2*strlen(s) or @len,
404 * whichever is less.
392ca68b 405 *
626f090c 406 * Note:
392ca68b
GS		 407 * USB String descriptors can contain at most 126 characters; input
408 * strings longer than that are truncated.
1da177e4 409 */
392ca68b
GS		 410static unsigned
411ascii2desc(char const *s, u8 *buf, unsigned len)
1da177e4 412{
392ca68b
GS		 413 unsigned n, t = 2 + 2*strlen(s);
414
415 if (t > 254)
416 t = 254; /* Longest possible UTF string descriptor */
417 if (len > t)
418 len = t;
419
420 t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
421
422 n = len;
423 while (n--) {
424 *buf++ = t;
425 if (!n--)
426 break;
427 *buf++ = t >> 8;
428 t = (unsigned char)*s++;
1da177e4 429 }
392ca68b 430 return len;
1da177e4
LT		 431}
432
392ca68b
GS		 433/**
434 * rh_string() - provides string descriptors for root hub
435 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
1da177e4 436 * @hcd: the host controller for this root hub
392ca68b
GS		 437 * @data: buffer for output packet
438 * @len: length of the provided buffer
1da177e4
LT		 439 *
440 * Produces either a manufacturer, product or serial number string for the
441 * virtual root hub device.
626f090c
YB		 442 *
443 * Return: The number of bytes filled in: the length of the descriptor or
392ca68b 444 * of the provided buffer, whichever is less.
1da177e4 445 */
392ca68b
GS		 446static unsigned
447rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
71d2718f 448{
392ca68b
GS		 449 char buf[100];
450 char const *s;
451 static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
1da177e4 452
048cb21c 453 /* language ids */
392ca68b
GS		 454 switch (id) {
455 case 0:
456 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
457 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
458 if (len > 4)
459 len = 4;
460 memcpy(data, langids, len);
1da177e4 461 return len;
392ca68b
GS		 462 case 1:
463 /* Serial number */
464 s = hcd->self.bus_name;
465 break;
466 case 2:
467 /* Product name */
468 s = hcd->product_desc;
469 break;
470 case 3:
471 /* Manufacturer */
96b644bd
SH		 472 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
473 init_utsname()->release, hcd->driver->description);
392ca68b
GS		 474 s = buf;
475 break;
1da177e4 476 default:
392ca68b
GS		 477 /* Can't happen; caller guarantees it */
478 return 0;
1da177e4 479 }
392ca68b
GS		 480
481 return ascii2desc(s, data, len);
1da177e4
LT		 482}
483
484
485/* Root hub control transfers execute synchronously */
486static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
487{
488 struct usb_ctrlrequest *cmd;
14557359 489 u16 typeReq, wValue, wIndex, wLength;
1da177e4 490 u8 *ubuf = urb->transfer_buffer;
71d2718f 491 unsigned len = 0;
e9df41c5 492 int status;
7329e211
AS		 493 u8 patch_wakeup = 0;
494 u8 patch_protocol = 0;
e57e780b
SS		 495 u16 tbuf_size;
496 u8 *tbuf = NULL;
497 const u8 *bufp;
1da177e4 498
9439eb94
AS		 499 might_sleep();
500
e9df41c5
AS		 501 spin_lock_irq(&hcd_root_hub_lock);
502 status = usb_hcd_link_urb_to_ep(hcd, urb);
503 spin_unlock_irq(&hcd_root_hub_lock);
504 if (status)
505 return status;
b0d9efba 506 urb->hcpriv = hcd; /* Indicate it's queued */
e9df41c5 507
1da177e4
LT		 508 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
509 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
510 wValue = le16_to_cpu (cmd->wValue);
511 wIndex = le16_to_cpu (cmd->wIndex);
512 wLength = le16_to_cpu (cmd->wLength);
513
514 if (wLength > urb->transfer_buffer_length)
515 goto error;
516
e57e780b
SS		 517 /*
518 * tbuf should be at least as big as the
519 * USB hub descriptor.
520 */
521 tbuf_size = max_t(u16, sizeof(struct usb_hub_descriptor), wLength);
522 tbuf = kzalloc(tbuf_size, GFP_KERNEL);
523 if (!tbuf)
524 return -ENOMEM;
525
526 bufp = tbuf;
527
528
1da177e4
LT		 529 urb->actual_length = 0;
530 switch (typeReq) {
531
532 /* DEVICE REQUESTS */
533
fb669cc0
DB		 534 /* The root hub's remote wakeup enable bit is implemented using
535 * driver model wakeup flags. If this system supports wakeup
536 * through USB, userspace may change the default "allow wakeup"
537 * policy through sysfs or these calls.
538 *
539 * Most root hubs support wakeup from downstream devices, for
540 * runtime power management (disabling USB clocks and reducing
541 * VBUS power usage). However, not all of them do so; silicon,
542 * board, and BIOS bugs here are not uncommon, so these can't
543 * be treated quite like external hubs.
544 *
545 * Likewise, not all root hubs will pass wakeup events upstream,
546 * to wake up the whole system. So don't assume root hub and
547 * controller capabilities are identical.
548 */
549
1da177e4 550 case DeviceRequest | USB_REQ_GET_STATUS:
14557359 551 tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
fb669cc0 552 << USB_DEVICE_REMOTE_WAKEUP)
1da177e4 553 | (1 << USB_DEVICE_SELF_POWERED);
14557359 554 tbuf[1] = 0;
1da177e4
LT		 555 len = 2;
556 break;
557 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
558 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
fb669cc0 559 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
1da177e4
LT		 560 else
561 goto error;
562 break;
563 case DeviceOutRequest | USB_REQ_SET_FEATURE:
fb669cc0
DB		 564 if (device_can_wakeup(&hcd->self.root_hub->dev)
565 && wValue == USB_DEVICE_REMOTE_WAKEUP)
566 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
1da177e4
LT		 567 else
568 goto error;
569 break;
570 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
14557359 571 tbuf[0] = 1;
1da177e4
LT		 572 len = 1;
573 /* FALLTHROUGH */
574 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
575 break;
576 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
577 switch (wValue & 0xff00) {
578 case USB_DT_DEVICE << 8:
83de4b2b 579 switch (hcd->speed) {
71175225 580 case HCD_USB31:
9508e3b7
MN		 581 bufp = usb31_rh_dev_descriptor;
582 break;
7dd19e69 583 case HCD_USB3:
d2e9b4d6 584 bufp = usb3_rh_dev_descriptor;
7dd19e69 585 break;
1a81f881
TP		 586 case HCD_USB25:
587 bufp = usb25_rh_dev_descriptor;
588 break;
7dd19e69 589 case HCD_USB2:
1da177e4 590 bufp = usb2_rh_dev_descriptor;
7dd19e69
VM		 591 break;
592 case HCD_USB11:
1da177e4 593 bufp = usb11_rh_dev_descriptor;
7dd19e69
VM		 594 break;
595 default:
1da177e4 596 goto error;
7dd19e69 597 }
1da177e4 598 len = 18;
7329e211
AS		 599 if (hcd->has_tt)
600 patch_protocol = 1;
1da177e4
LT		 601 break;
602 case USB_DT_CONFIG << 8:
83de4b2b 603 switch (hcd->speed) {
71175225 604 case HCD_USB31:
7dd19e69 605 case HCD_USB3:
d2e9b4d6
SS		 606 bufp = ss_rh_config_descriptor;
607 len = sizeof ss_rh_config_descriptor;
7dd19e69 608 break;
1a81f881 609 case HCD_USB25:
7dd19e69 610 case HCD_USB2:
1da177e4
LT		 611 bufp = hs_rh_config_descriptor;
612 len = sizeof hs_rh_config_descriptor;
7dd19e69
VM		 613 break;
614 case HCD_USB11:
1da177e4
LT		 615 bufp = fs_rh_config_descriptor;
616 len = sizeof fs_rh_config_descriptor;
7dd19e69
VM		 617 break;
618 default:
619 goto error;
1da177e4 620 }
fb669cc0 621 if (device_can_wakeup(&hcd->self.root_hub->dev))
1da177e4
LT		 622 patch_wakeup = 1;
623 break;
624 case USB_DT_STRING << 8:
71d2718f
RK		 625 if ((wValue & 0xff) < 4)
626 urb->actual_length = rh_string(wValue & 0xff,
627 hcd, ubuf, wLength);
628 else /* unsupported IDs --> "protocol stall" */
1da177e4 629 goto error;
1da177e4 630 break;
48e82361
SS		 631 case USB_DT_BOS << 8:
632 goto nongeneric;
1da177e4
LT		 633 default:
634 goto error;
635 }
636 break;
637 case DeviceRequest | USB_REQ_GET_INTERFACE:
14557359 638 tbuf[0] = 0;
1da177e4
LT		 639 len = 1;
640 /* FALLTHROUGH */
641 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
642 break;
643 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
048cb21c 644 /* wValue == urb->dev->devaddr */
1da177e4
LT		 645 dev_dbg (hcd->self.controller, "root hub device address %d\n",
646 wValue);
647 break;
648
649 /* INTERFACE REQUESTS (no defined feature/status flags) */
650
651 /* ENDPOINT REQUESTS */
652
653 case EndpointRequest | USB_REQ_GET_STATUS:
048cb21c 654 /* ENDPOINT_HALT flag */
14557359
MB		 655 tbuf[0] = 0;
656 tbuf[1] = 0;
1da177e4
LT		 657 len = 2;
658 /* FALLTHROUGH */
659 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
660 case EndpointOutRequest | USB_REQ_SET_FEATURE:
661 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
662 break;
663
664 /* CLASS REQUESTS (and errors) */
665
666 default:
48e82361 667nongeneric:
1da177e4 668 /* non-generic request */
b13296c6
DB		 669 switch (typeReq) {
670 case GetHubStatus:
b13296c6
DB		 671 len = 4;
672 break;
0cdd49a1
MN		 673 case GetPortStatus:
674 if (wValue == HUB_PORT_STATUS)
675 len = 4;
676 else
677 /* other port status types return 8 bytes */
678 len = 8;
679 break;
b13296c6
DB		 680 case GetHubDescriptor:
681 len = sizeof (struct usb_hub_descriptor);
682 break;
48e82361
SS		 683 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
684 /* len is returned by hub_control */
685 break;
1da177e4 686 }
b13296c6
DB		 687 status = hcd->driver->hub_control (hcd,
688 typeReq, wValue, wIndex,
689 tbuf, wLength);
d2123fd9
LT		 690
691 if (typeReq == GetHubDescriptor)
692 usb_hub_adjust_deviceremovable(hcd->self.root_hub,
693 (struct usb_hub_descriptor *)tbuf);
1da177e4
LT		 694 break;
695error:
696 /* "protocol stall" on error */
697 status = -EPIPE;
698 }
699
48e82361 700 if (status < 0) {
1da177e4
LT		 701 len = 0;
702 if (status != -EPIPE) {
703 dev_dbg (hcd->self.controller,
704 "CTRL: TypeReq=0x%x val=0x%x "
705 "idx=0x%x len=%d ==> %d\n",
706 typeReq, wValue, wIndex,
b13296c6 707 wLength, status);
1da177e4 708 }
48e82361
SS		 709 } else if (status > 0) {
710 /* hub_control may return the length of data copied. */
711 len = status;
712 status = 0;
1da177e4
LT		 713 }
714 if (len) {
715 if (urb->transfer_buffer_length < len)
716 len = urb->transfer_buffer_length;
717 urb->actual_length = len;
048cb21c 718 /* always USB_DIR_IN, toward host */
1da177e4
LT		 719 memcpy (ubuf, bufp, len);
720
721 /* report whether RH hardware supports remote wakeup */
722 if (patch_wakeup &&
723 len > offsetof (struct usb_config_descriptor,
724 bmAttributes))
725 ((struct usb_config_descriptor *)ubuf)->bmAttributes
726 |= USB_CONFIG_ATT_WAKEUP;
7329e211
AS		 727
728 /* report whether RH hardware has an integrated TT */
729 if (patch_protocol &&
730 len > offsetof(struct usb_device_descriptor,
731 bDeviceProtocol))
732 ((struct usb_device_descriptor *) ubuf)->
7bf01185 733 bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
1da177e4
LT		 734 }
735
e57e780b
SS		 736 kfree(tbuf);
737
1da177e4 738 /* any errors get returned through the urb completion */
9439eb94 739 spin_lock_irq(&hcd_root_hub_lock);
e9df41c5 740 usb_hcd_unlink_urb_from_ep(hcd, urb);
4a00027d 741 usb_hcd_giveback_urb(hcd, urb, status);
9439eb94 742 spin_unlock_irq(&hcd_root_hub_lock);
1da177e4
LT		 743 return 0;
744}
745
746/*-------------------------------------------------------------------------*/
747
748/*
d5926ae7
AS		 749 * Root Hub interrupt transfers are polled using a timer if the
750 * driver requests it; otherwise the driver is responsible for
751 * calling usb_hcd_poll_rh_status() when an event occurs.
1da177e4 752 *
d5926ae7
AS		 753 * Completions are called in_interrupt(), but they may or may not
754 * be in_irq().
1da177e4 755 */
d5926ae7
AS		 756void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
757{
758 struct urb *urb;
759 int length;
760 unsigned long flags;
ad361c98 761 char buffer[6]; /* Any root hubs with > 31 ports? */
1da177e4 762
6d88e679 763 if (unlikely(!hcd->rh_pollable))
1b42ae6d 764 return;
d5926ae7
AS		 765 if (!hcd->uses_new_polling && !hcd->status_urb)
766 return;
1da177e4 767
d5926ae7
AS		 768 length = hcd->driver->hub_status_data(hcd, buffer);
769 if (length > 0) {
1da177e4 770
d5926ae7 771 /* try to complete the status urb */
9439eb94 772 spin_lock_irqsave(&hcd_root_hub_lock, flags);
d5926ae7
AS		 773 urb = hcd->status_urb;
774 if (urb) {
541c7d43 775 clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
e9df41c5 776 hcd->status_urb = NULL;
e9df41c5
AS		 777 urb->actual_length = length;
778 memcpy(urb->transfer_buffer, buffer, length);
9439eb94 779
e9df41c5 780 usb_hcd_unlink_urb_from_ep(hcd, urb);
4a00027d 781 usb_hcd_giveback_urb(hcd, urb, 0);
e9df41c5 782 } else {
d5926ae7 783 length = 0;
541c7d43 784 set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
e9df41c5 785 }
9439eb94 786 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
1da177e4
LT		 787 }
788
d5926ae7 789 /* The USB 2.0 spec says 256 ms. This is close enough and won't
01cd0819
AV		 790 * exceed that limit if HZ is 100. The math is more clunky than
791 * maybe expected, this is to make sure that all timers for USB devices
25985edc 792 * fire at the same time to give the CPU a break in between */
541c7d43 793 if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
d5926ae7 794 (length == 0 && hcd->status_urb != NULL))
01cd0819 795 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
1da177e4 796}
d5926ae7 797EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
1da177e4
LT		 798
799/* timer callback */
d5926ae7
AS		 800static void rh_timer_func (unsigned long _hcd)
801{
802 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
803}
804
805/*-------------------------------------------------------------------------*/
1da177e4 806
d5926ae7 807static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
1da177e4 808{
d5926ae7 809 int retval;
1da177e4 810 unsigned long flags;
71d2718f 811 unsigned len = 1 + (urb->dev->maxchild / 8);
1da177e4 812
d5926ae7 813 spin_lock_irqsave (&hcd_root_hub_lock, flags);
e9df41c5 814 if (hcd->status_urb || urb->transfer_buffer_length < len) {
d5926ae7
AS		 815 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
816 retval = -EINVAL;
e9df41c5
AS		 817 goto done;
818 }
1da177e4 819
e9df41c5
AS		 820 retval = usb_hcd_link_urb_to_ep(hcd, urb);
821 if (retval)
822 goto done;
1da177e4 823
e9df41c5
AS		 824 hcd->status_urb = urb;
825 urb->hcpriv = hcd; /* indicate it's queued */
826 if (!hcd->uses_new_polling)
827 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
828
829 /* If a status change has already occurred, report it ASAP */
541c7d43 830 else if (HCD_POLL_PENDING(hcd))
e9df41c5
AS		 831 mod_timer(&hcd->rh_timer, jiffies);
832 retval = 0;
833 done:
d5926ae7
AS		 834 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
835 return retval;
1da177e4
LT		 836}
837
1da177e4
LT		 838static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
839{
5e60a161 840 if (usb_endpoint_xfer_int(&urb->ep->desc))
d5926ae7 841 return rh_queue_status (hcd, urb);
5e60a161 842 if (usb_endpoint_xfer_control(&urb->ep->desc))
1da177e4 843 return rh_call_control (hcd, urb);
d5926ae7 844 return -EINVAL;
1da177e4
LT		 845}
846
847/*-------------------------------------------------------------------------*/
848
455b25fb
AS		 849/* Unlinks of root-hub control URBs are legal, but they don't do anything
850 * since these URBs always execute synchronously.
d5926ae7 851 */
e9df41c5 852static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1da177e4 853{
455b25fb 854 unsigned long flags;
e9df41c5 855 int rc;
1da177e4 856
9439eb94 857 spin_lock_irqsave(&hcd_root_hub_lock, flags);
e9df41c5
AS		 858 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
859 if (rc)
860 goto done;
861
5e60a161 862 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
455b25fb 863 ; /* Do nothing */
d5926ae7
AS		 864
865 } else { /* Status URB */
866 if (!hcd->uses_new_polling)
455b25fb 867 del_timer (&hcd->rh_timer);
d5926ae7
AS		 868 if (urb == hcd->status_urb) {
869 hcd->status_urb = NULL;
e9df41c5 870 usb_hcd_unlink_urb_from_ep(hcd, urb);
4a00027d 871 usb_hcd_giveback_urb(hcd, urb, status);
9439eb94
AS		 872 }
873 }
e9df41c5 874 done:
9439eb94 875 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
e9df41c5 876 return rc;
1da177e4
LT		 877}
878
5234ce1b
IPG		 879
880
881/*
882 * Show & store the current value of authorized_default
883 */
d03f254f
GKH		 884static ssize_t authorized_default_show(struct device *dev,
885 struct device_attribute *attr, char *buf)
5234ce1b
IPG		 886{
887 struct usb_device *rh_usb_dev = to_usb_device(dev);
888 struct usb_bus *usb_bus = rh_usb_dev->bus;
ff8e2c56 889 struct usb_hcd *hcd;
5234ce1b 890
ff8e2c56
SK		 891 hcd = bus_to_hcd(usb_bus);
892 return snprintf(buf, PAGE_SIZE, "%u\n", !!HCD_DEV_AUTHORIZED(hcd));
5234ce1b
IPG		 893}
894
d03f254f
GKH		 895static ssize_t authorized_default_store(struct device *dev,
896 struct device_attribute *attr,
897 const char *buf, size_t size)
5234ce1b
IPG		 898{
899 ssize_t result;
900 unsigned val;
901 struct usb_device *rh_usb_dev = to_usb_device(dev);
902 struct usb_bus *usb_bus = rh_usb_dev->bus;
ff8e2c56 903 struct usb_hcd *hcd;
5234ce1b 904
ff8e2c56 905 hcd = bus_to_hcd(usb_bus);
5234ce1b
IPG		 906 result = sscanf(buf, "%u\n", &val);
907 if (result == 1) {
ff8e2c56
SK		 908 if (val)
909 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
910 else
911 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
912
5234ce1b 913 result = size;
d1ddb0a6 914 } else {
5234ce1b 915 result = -EINVAL;
d1ddb0a6 916 }
5234ce1b
IPG		 917 return result;
918}
d03f254f 919static DEVICE_ATTR_RW(authorized_default);
5234ce1b 920
6b2bd3c8
SK		 921/*
922 * interface_authorized_default_show - show default authorization status
923 * for USB interfaces
924 *
925 * note: interface_authorized_default is the default value
926 * for initializing the authorized attribute of interfaces
927 */
928static ssize_t interface_authorized_default_show(struct device *dev,
929 struct device_attribute *attr, char *buf)
930{
931 struct usb_device *usb_dev = to_usb_device(dev);
932 struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
933
934 return sprintf(buf, "%u\n", !!HCD_INTF_AUTHORIZED(hcd));
935}
936
937/*
938 * interface_authorized_default_store - store default authorization status
939 * for USB interfaces
940 *
941 * note: interface_authorized_default is the default value
942 * for initializing the authorized attribute of interfaces
943 */
944static ssize_t interface_authorized_default_store(struct device *dev,
945 struct device_attribute *attr, const char *buf, size_t count)
946{
947 struct usb_device *usb_dev = to_usb_device(dev);
948 struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
949 int rc = count;
950 bool val;
951
952 if (strtobool(buf, &val) != 0)
953 return -EINVAL;
954
955 if (val)
956 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
957 else
958 clear_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
959
960 return rc;
961}
962static DEVICE_ATTR_RW(interface_authorized_default);
963
5234ce1b
IPG		 964/* Group all the USB bus attributes */
965static struct attribute *usb_bus_attrs[] = {
966 &dev_attr_authorized_default.attr,
6b2bd3c8 967 &dev_attr_interface_authorized_default.attr,
5234ce1b
IPG		 968 NULL,
969};
970
971static struct attribute_group usb_bus_attr_group = {
972 .name = NULL, /* we want them in the same directory */
973 .attrs = usb_bus_attrs,
974};
975
976
977
1da177e4
LT		 978/*-------------------------------------------------------------------------*/
979
1da177e4
LT		 980/**
981 * usb_bus_init - shared initialization code
982 * @bus: the bus structure being initialized
983 *
984 * This code is used to initialize a usb_bus structure, memory for which is
985 * separately managed.
986 */
987static void usb_bus_init (struct usb_bus *bus)
988{
989 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
990
991 bus->devnum_next = 1;
992
993 bus->root_hub = NULL;
1da177e4
LT		 994 bus->busnum = -1;
995 bus->bandwidth_allocated = 0;
996 bus->bandwidth_int_reqs = 0;
997 bus->bandwidth_isoc_reqs = 0;
6fecd4f2 998 mutex_init(&bus->usb_address0_mutex);
1da177e4
LT		 999
1000 INIT_LIST_HEAD (&bus->bus_list);
1da177e4
LT		 1001}
1002
1da177e4
LT		 1003/*-------------------------------------------------------------------------*/
1004
1005/**
1006 * usb_register_bus - registers the USB host controller with the usb core
1007 * @bus: pointer to the bus to register
1008 * Context: !in_interrupt()
1009 *
1010 * Assigns a bus number, and links the controller into usbcore data
1011 * structures so that it can be seen by scanning the bus list.
626f090c
YB		 1012 *
1013 * Return: 0 if successful. A negative error code otherwise.
1da177e4
LT		 1014 */
1015static int usb_register_bus(struct usb_bus *bus)
1016{
eb579f58 1017 int result = -E2BIG;
1da177e4 1018 int busnum;
1da177e4 1019
4186ecf8 1020 mutex_lock(&usb_bus_list_lock);
059239ad 1021 busnum = find_next_zero_bit(busmap, USB_MAXBUS, 1);
eb579f58 1022 if (busnum >= USB_MAXBUS) {
1da177e4 1023 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
eb579f58 1024 goto error_find_busnum;
1da177e4 1025 }
059239ad 1026 set_bit(busnum, busmap);
eb579f58 1027 bus->busnum = busnum;
5a3201b2 1028
1da177e4
LT		 1029 /* Add it to the local list of buses */
1030 list_add (&bus->bus_list, &usb_bus_list);
4186ecf8 1031 mutex_unlock(&usb_bus_list_lock);
1da177e4 1032
3099e75a 1033 usb_notify_add_bus(bus);
1da177e4 1034
eb579f58
IPG		 1035 dev_info (bus->controller, "new USB bus registered, assigned bus "
1036 "number %d\n", bus->busnum);
1da177e4 1037 return 0;
eb579f58 1038
eb579f58
IPG		 1039error_find_busnum:
1040 mutex_unlock(&usb_bus_list_lock);
1041 return result;
1da177e4
LT		 1042}
1043
1044/**
1045 * usb_deregister_bus - deregisters the USB host controller
1046 * @bus: pointer to the bus to deregister
1047 * Context: !in_interrupt()
1048 *
1049 * Recycles the bus number, and unlinks the controller from usbcore data
1050 * structures so that it won't be seen by scanning the bus list.
1051 */
1052static void usb_deregister_bus (struct usb_bus *bus)
1053{
1054 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
1055
1056 /*
1057 * NOTE: make sure that all the devices are removed by the
1058 * controller code, as well as having it call this when cleaning
1059 * itself up
1060 */
4186ecf8 1061 mutex_lock(&usb_bus_list_lock);
1da177e4 1062 list_del (&bus->bus_list);
4186ecf8 1063 mutex_unlock(&usb_bus_list_lock);
1da177e4 1064
3099e75a 1065 usb_notify_remove_bus(bus);
1da177e4 1066
059239ad 1067 clear_bit(bus->busnum, busmap);
1da177e4
LT		 1068}
1069
1070/**
8ec8d20b 1071 * register_root_hub - called by usb_add_hcd() to register a root hub
1da177e4
LT		 1072 * @hcd: host controller for this root hub
1073 *
8ec8d20b 1074 * This function registers the root hub with the USB subsystem. It sets up
b1e8f0a6
DB		 1075 * the device properly in the device tree and then calls usb_new_device()
1076 * to register the usb device. It also assigns the root hub's USB address
1077 * (always 1).
626f090c
YB		 1078 *
1079 * Return: 0 if successful. A negative error code otherwise.
1da177e4 1080 */
b1e8f0a6 1081static int register_root_hub(struct usb_hcd *hcd)
1da177e4
LT		 1082{
1083 struct device *parent_dev = hcd->self.controller;
b1e8f0a6 1084 struct usb_device *usb_dev = hcd->self.root_hub;
1da177e4
LT		 1085 const int devnum = 1;
1086 int retval;
1087
1da177e4
LT		 1088 usb_dev->devnum = devnum;
1089 usb_dev->bus->devnum_next = devnum + 1;
1090 memset (&usb_dev->bus->devmap.devicemap, 0,
1091 sizeof usb_dev->bus->devmap.devicemap);
1092 set_bit (devnum, usb_dev->bus->devmap.devicemap);
1093 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
1094
4186ecf8 1095 mutex_lock(&usb_bus_list_lock);
1da177e4 1096
551509d2 1097 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
1da177e4
LT		 1098 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
1099 if (retval != sizeof usb_dev->descriptor) {
4186ecf8 1100 mutex_unlock(&usb_bus_list_lock);
1da177e4 1101 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
7071a3ce 1102 dev_name(&usb_dev->dev), retval);
1da177e4
LT		 1103 return (retval < 0) ? retval : -EMSGSIZE;
1104 }
2d2a3167
LB		 1105
1106 if (le16_to_cpu(usb_dev->descriptor.bcdUSB) >= 0x0201) {
448b6eb1 1107 retval = usb_get_bos_descriptor(usb_dev);
2d2a3167
LB		 1108 if (!retval) {
1109 usb_dev->lpm_capable = usb_device_supports_lpm(usb_dev);
8a1b2725 1110 } else if (usb_dev->speed >= USB_SPEED_SUPER) {
448b6eb1
SS		 1111 mutex_unlock(&usb_bus_list_lock);
1112 dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
1113 dev_name(&usb_dev->dev), retval);
1114 return retval;
1115 }
1116 }
1da177e4 1117
1da177e4 1118 retval = usb_new_device (usb_dev);
1da177e4 1119 if (retval) {
1da177e4 1120 dev_err (parent_dev, "can't register root hub for %s, %d\n",
7071a3ce 1121 dev_name(&usb_dev->dev), retval);
0a231403 1122 } else {
1da177e4
LT		 1123 spin_lock_irq (&hcd_root_hub_lock);
1124 hcd->rh_registered = 1;
1125 spin_unlock_irq (&hcd_root_hub_lock);
1126
1127 /* Did the HC die before the root hub was registered? */
69fff59d 1128 if (HCD_DEAD(hcd))
1da177e4
LT		 1129 usb_hc_died (hcd); /* This time clean up */
1130 }
0a231403 1131 mutex_unlock(&usb_bus_list_lock);
1da177e4
LT		 1132
1133 return retval;
1134}
1da177e4 1135
da0aa716
AS		 1136/*
1137 * usb_hcd_start_port_resume - a root-hub port is sending a resume signal
1138 * @bus: the bus which the root hub belongs to
1139 * @portnum: the port which is being resumed
1140 *
1141 * HCDs should call this function when they know that a resume signal is
1142 * being sent to a root-hub port. The root hub will be prevented from
1143 * going into autosuspend until usb_hcd_end_port_resume() is called.
1144 *
1145 * The bus's private lock must be held by the caller.
1146 */
1147void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum)
1148{
1149 unsigned bit = 1 << portnum;
1150
1151 if (!(bus->resuming_ports & bit)) {
1152 bus->resuming_ports |= bit;
1153 pm_runtime_get_noresume(&bus->root_hub->dev);
1154 }
1155}
1156EXPORT_SYMBOL_GPL(usb_hcd_start_port_resume);
1157
1158/*
1159 * usb_hcd_end_port_resume - a root-hub port has stopped sending a resume signal
1160 * @bus: the bus which the root hub belongs to
1161 * @portnum: the port which is being resumed
1162 *
1163 * HCDs should call this function when they know that a resume signal has
1164 * stopped being sent to a root-hub port. The root hub will be allowed to
1165 * autosuspend again.
1166 *
1167 * The bus's private lock must be held by the caller.
1168 */
1169void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum)
1170{
1171 unsigned bit = 1 << portnum;
1172
1173 if (bus->resuming_ports & bit) {
1174 bus->resuming_ports &= ~bit;
1175 pm_runtime_put_noidle(&bus->root_hub->dev);
1176 }
1177}
1178EXPORT_SYMBOL_GPL(usb_hcd_end_port_resume);
1da177e4
LT		 1179
1180/*-------------------------------------------------------------------------*/
1181
1182/**
1183 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1184 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1185 * @is_input: true iff the transaction sends data to the host
1186 * @isoc: true for isochronous transactions, false for interrupt ones
1187 * @bytecount: how many bytes in the transaction.
1188 *
626f090c
YB		 1189 * Return: Approximate bus time in nanoseconds for a periodic transaction.
1190 *
1191 * Note:
1da177e4
LT		 1192 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1193 * scheduled in software, this function is only used for such scheduling.
1194 */
1195long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1196{
1197 unsigned long tmp;
1198
1199 switch (speed) {
1200 case USB_SPEED_LOW: /* INTR only */
1201 if (is_input) {
1202 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
07010496 1203 return 64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1da177e4
LT		 1204 } else {
1205 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
07010496 1206 return 64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1da177e4
LT		 1207 }
1208 case USB_SPEED_FULL: /* ISOC or INTR */
1209 if (isoc) {
1210 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
07010496 1211 return ((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp;
1da177e4
LT		 1212 } else {
1213 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
07010496 1214 return 9107L + BW_HOST_DELAY + tmp;
1da177e4
LT		 1215 }
1216 case USB_SPEED_HIGH: /* ISOC or INTR */
048cb21c 1217 /* FIXME adjust for input vs output */
1da177e4 1218 if (isoc)
498f78e6 1219 tmp = HS_NSECS_ISO (bytecount);
1da177e4 1220 else
498f78e6 1221 tmp = HS_NSECS (bytecount);
1da177e4
LT		 1222 return tmp;
1223 default:
1224 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1225 return -1;
1226 }
1227}
782e70c6 1228EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1da177e4 1229
1da177e4
LT		 1230
1231/*-------------------------------------------------------------------------*/
1232
1233/*
1234 * Generic HC operations.
1235 */
1236
1237/*-------------------------------------------------------------------------*/
1238
e9df41c5
AS		 1239/**
1240 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1241 * @hcd: host controller to which @urb was submitted
1242 * @urb: URB being submitted
1243 *
1244 * Host controller drivers should call this routine in their enqueue()
1245 * method. The HCD's private spinlock must be held and interrupts must
1246 * be disabled. The actions carried out here are required for URB
1247 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1248 *
626f090c 1249 * Return: 0 for no error, otherwise a negative error code (in which case
e9df41c5
AS		 1250 * the enqueue() method must fail). If no error occurs but enqueue() fails
1251 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1252 * the private spinlock and returning.
1253 */
1254int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1da177e4 1255{
9a9bf406 1256 int rc = 0;
1da177e4 1257
e9df41c5 1258 spin_lock(&hcd_urb_list_lock);
1da177e4 1259
9a9bf406 1260 /* Check that the URB isn't being killed */
49367d8f 1261 if (unlikely(atomic_read(&urb->reject))) {
9a9bf406
AS		 1262 rc = -EPERM;
1263 goto done;
9f6a93f7 1264 }
1da177e4 1265
9a9bf406
AS		 1266 if (unlikely(!urb->ep->enabled)) {
1267 rc = -ENOENT;
1268 goto done;
1269 }
1da177e4 1270
6840d255
AS		 1271 if (unlikely(!urb->dev->can_submit)) {
1272 rc = -EHOSTUNREACH;
1273 goto done;
1274 }
1275
1da177e4 1276 /*
9a9bf406
AS		 1277 * Check the host controller's state and add the URB to the
1278 * endpoint's queue.
1da177e4 1279 */
9b37596a 1280 if (HCD_RH_RUNNING(hcd)) {
eb231054 1281 urb->unlinked = 0;
9a9bf406 1282 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
9b37596a 1283 } else {
9a9bf406
AS		 1284 rc = -ESHUTDOWN;
1285 goto done;
1da177e4 1286 }
9a9bf406 1287 done:
e9df41c5 1288 spin_unlock(&hcd_urb_list_lock);
9a9bf406
AS		 1289 return rc;
1290}
e9df41c5 1291EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
9a9bf406 1292
e9df41c5
AS		 1293/**
1294 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1295 * @hcd: host controller to which @urb was submitted
1296 * @urb: URB being checked for unlinkability
1297 * @status: error code to store in @urb if the unlink succeeds
1298 *
1299 * Host controller drivers should call this routine in their dequeue()
1300 * method. The HCD's private spinlock must be held and interrupts must
1301 * be disabled. The actions carried out here are required for making
1302 * sure than an unlink is valid.
1303 *
626f090c 1304 * Return: 0 for no error, otherwise a negative error code (in which case
e9df41c5
AS		 1305 * the dequeue() method must fail). The possible error codes are:
1306 *
1307 * -EIDRM: @urb was not submitted or has already completed.
1308 * The completion function may not have been called yet.
1309 *
1310 * -EBUSY: @urb has already been unlinked.
1311 */
1312int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
9a9bf406
AS		 1313 int status)
1314{
9a9bf406 1315 struct list_head *tmp;
9a9bf406
AS		 1316
1317 /* insist the urb is still queued */
1318 list_for_each(tmp, &urb->ep->urb_list) {
1319 if (tmp == &urb->urb_list)
1320 break;
1321 }
e9df41c5
AS		 1322 if (tmp != &urb->urb_list)
1323 return -EIDRM;
1da177e4 1324
9a9bf406
AS		 1325 /* Any status except -EINPROGRESS means something already started to
1326 * unlink this URB from the hardware. So there's no more work to do.
1da177e4 1327 */
eb231054 1328 if (urb->unlinked)
e9df41c5 1329 return -EBUSY;
eb231054 1330 urb->unlinked = status;
e9df41c5 1331 return 0;
9a9bf406 1332}
e9df41c5 1333EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
9a9bf406 1334
e9df41c5
AS		 1335/**
1336 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1337 * @hcd: host controller to which @urb was submitted
1338 * @urb: URB being unlinked
1339 *
1340 * Host controller drivers should call this routine before calling
1341 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1342 * interrupts must be disabled. The actions carried out here are required
1343 * for URB completion.
1344 */
1345void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
9a9bf406 1346{
9a9bf406 1347 /* clear all state linking urb to this dev (and hcd) */
e9df41c5 1348 spin_lock(&hcd_urb_list_lock);
9a9bf406 1349 list_del_init(&urb->urb_list);
e9df41c5 1350 spin_unlock(&hcd_urb_list_lock);
9a9bf406 1351}
e9df41c5 1352EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
9a9bf406 1353
b3476675
MD		 1354/*
1355 * Some usb host controllers can only perform dma using a small SRAM area.
1356 * The usb core itself is however optimized for host controllers that can dma
1357 * using regular system memory - like pci devices doing bus mastering.
1358 *
a6cd244b 1359 * To support host controllers with limited dma capabilities we provide dma
b3476675
MD		 1360 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1361 * For this to work properly the host controller code must first use the
1362 * function dma_declare_coherent_memory() to point out which memory area
1363 * that should be used for dma allocations.
1364 *
1365 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1366 * dma using dma_alloc_coherent() which in turn allocates from the memory
1367 * area pointed out with dma_declare_coherent_memory().
1368 *
1369 * So, to summarize...
1370 *
1371 * - We need "local" memory, canonical example being
1372 * a small SRAM on a discrete controller being the
1373 * only memory that the controller can read ...
1374 * (a) "normal" kernel memory is no good, and
1375 * (b) there's not enough to share
1376 *
1377 * - The only *portable* hook for such stuff in the
1378 * DMA framework is dma_declare_coherent_memory()
1379 *
1380 * - So we use that, even though the primary requirement
025d4430 1381 * is that the memory be "local" (hence addressable
b3476675
MD		 1382 * by that device), not "coherent".
1383 *
1384 */
1385
1386static int hcd_alloc_coherent(struct usb_bus *bus,
1387 gfp_t mem_flags, dma_addr_t *dma_handle,
1388 void **vaddr_handle, size_t size,
1389 enum dma_data_direction dir)
1390{
1391 unsigned char *vaddr;
1392
4307a28e
AR		 1393 if (*vaddr_handle == NULL) {
1394 WARN_ON_ONCE(1);
1395 return -EFAULT;
1396 }
1397
b3476675
MD		 1398 vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1399 mem_flags, dma_handle);
1400 if (!vaddr)
1401 return -ENOMEM;
1402
1403 /*
1404 * Store the virtual address of the buffer at the end
1405 * of the allocated dma buffer. The size of the buffer
1406 * may be uneven so use unaligned functions instead
1407 * of just rounding up. It makes sense to optimize for
1408 * memory footprint over access speed since the amount
1409 * of memory available for dma may be limited.
1410 */
1411 put_unaligned((unsigned long)*vaddr_handle,
1412 (unsigned long *)(vaddr + size));
1413
1414 if (dir == DMA_TO_DEVICE)
1415 memcpy(vaddr, *vaddr_handle, size);
1416
1417 *vaddr_handle = vaddr;
1418 return 0;
1419}
1420
1421static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1422 void **vaddr_handle, size_t size,
1423 enum dma_data_direction dir)
1424{
1425 unsigned char *vaddr = *vaddr_handle;
1426
1427 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1428
1429 if (dir == DMA_FROM_DEVICE)
1430 memcpy(vaddr, *vaddr_handle, size);
1431
1432 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1433
1434 *vaddr_handle = vaddr;
1435 *dma_handle = 0;
1436}
1437
c8cf203a 1438void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
ff9c895f 1439{
ff9c895f
AS		 1440 if (urb->transfer_flags & URB_SETUP_MAP_SINGLE)
1441 dma_unmap_single(hcd->self.controller,
1442 urb->setup_dma,
1443 sizeof(struct usb_ctrlrequest),
1444 DMA_TO_DEVICE);
1445 else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1446 hcd_free_coherent(urb->dev->bus,
1447 &urb->setup_dma,
1448 (void **) &urb->setup_packet,
1449 sizeof(struct usb_ctrlrequest),
1450 DMA_TO_DEVICE);
1451
1dae423d
MF		 1452 /* Make it safe to call this routine more than once */
1453 urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1454}
c8cf203a 1455EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1dae423d 1456
2694a48d
RM		 1457static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1458{
1459 if (hcd->driver->unmap_urb_for_dma)
1460 hcd->driver->unmap_urb_for_dma(hcd, urb);
1461 else
1462 usb_hcd_unmap_urb_for_dma(hcd, urb);
1463}
1464
c8cf203a 1465void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1dae423d
MF		 1466{
1467 enum dma_data_direction dir;
1468
c8cf203a 1469 usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1dae423d 1470
ff9c895f
AS		 1471 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1472 if (urb->transfer_flags & URB_DMA_MAP_SG)
1473 dma_unmap_sg(hcd->self.controller,
910f8d0c 1474 urb->sg,
ff9c895f
AS		 1475 urb->num_sgs,
1476 dir);
1477 else if (urb->transfer_flags & URB_DMA_MAP_PAGE)
1478 dma_unmap_page(hcd->self.controller,
1479 urb->transfer_dma,
1480 urb->transfer_buffer_length,
1481 dir);
1482 else if (urb->transfer_flags & URB_DMA_MAP_SINGLE)
1483 dma_unmap_single(hcd->self.controller,
1484 urb->transfer_dma,
1485 urb->transfer_buffer_length,
1486 dir);
1487 else if (urb->transfer_flags & URB_MAP_LOCAL)
1488 hcd_free_coherent(urb->dev->bus,
1489 &urb->transfer_dma,
1490 &urb->transfer_buffer,
1491 urb->transfer_buffer_length,
1492 dir);
1493
1494 /* Make it safe to call this routine more than once */
1dae423d 1495 urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
ff9c895f
AS		 1496 URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1497}
c8cf203a 1498EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
ff9c895f 1499
b3476675
MD		 1500static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1501 gfp_t mem_flags)
2694a48d
RM		 1502{
1503 if (hcd->driver->map_urb_for_dma)
1504 return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1505 else
1506 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1507}
1508
1509int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1510 gfp_t mem_flags)
9a9bf406 1511{
b3476675
MD		 1512 enum dma_data_direction dir;
1513 int ret = 0;
1514
9a9bf406
AS		 1515 /* Map the URB's buffers for DMA access.
1516 * Lower level HCD code should use *_dma exclusively,
e04748e3
SS		 1517 * unless it uses pio or talks to another transport,
1518 * or uses the provided scatter gather list for bulk.
1da177e4 1519 */
b3476675 1520
85bcb5ee 1521 if (usb_endpoint_xfer_control(&urb->ep->desc)) {
07a8cdd2
AG		 1522 if (hcd->self.uses_pio_for_control)
1523 return ret;
85e034fd 1524 if (hcd->self.uses_dma) {
b3476675 1525 urb->setup_dma = dma_map_single(
1da177e4
LT		 1526 hcd->self.controller,
1527 urb->setup_packet,
b3476675 1528 sizeof(struct usb_ctrlrequest),
1da177e4 1529 DMA_TO_DEVICE);
85e034fd
LF		 1530 if (dma_mapping_error(hcd->self.controller,
1531 urb->setup_dma))
1532 return -EAGAIN;
ff9c895f 1533 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
f537da68 1534 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
b3476675
MD		 1535 ret = hcd_alloc_coherent(
1536 urb->dev->bus, mem_flags,
1537 &urb->setup_dma,
1538 (void **)&urb->setup_packet,
1539 sizeof(struct usb_ctrlrequest),
1540 DMA_TO_DEVICE);
ff9c895f
AS		 1541 if (ret)
1542 return ret;
1543 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
f537da68 1544 }
b3476675
MD		 1545 }
1546
1547 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
ff9c895f 1548 if (urb->transfer_buffer_length != 0
b3476675 1549 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
85e034fd 1550 if (hcd->self.uses_dma) {
ff9c895f 1551 if (urb->num_sgs) {
fe2072cc
HG		 1552 int n;
1553
1554 /* We don't support sg for isoc transfers ! */
1555 if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1556 WARN_ON(1);
1557 return -EINVAL;
1558 }
1559
1560 n = dma_map_sg(
ff9c895f 1561 hcd->self.controller,
910f8d0c 1562 urb->sg,
ff9c895f
AS		 1563 urb->num_sgs,
1564 dir);
1565 if (n <= 0)
1566 ret = -EAGAIN;
1567 else
1568 urb->transfer_flags |= URB_DMA_MAP_SG;
bc677d5b
CL		 1569 urb->num_mapped_sgs = n;
1570 if (n != urb->num_sgs)
ff9c895f
AS		 1571 urb->transfer_flags |=
1572 URB_DMA_SG_COMBINED;
ff9c895f 1573 } else if (urb->sg) {
910f8d0c 1574 struct scatterlist *sg = urb->sg;
ff9c895f
AS		 1575 urb->transfer_dma = dma_map_page(
1576 hcd->self.controller,
1577 sg_page(sg),
1578 sg->offset,
1579 urb->transfer_buffer_length,
1580 dir);
1581 if (dma_mapping_error(hcd->self.controller,
85e034fd 1582 urb->transfer_dma))
ff9c895f
AS		 1583 ret = -EAGAIN;
1584 else
1585 urb->transfer_flags |= URB_DMA_MAP_PAGE;
29d2fef8
DW		 1586 } else if (is_vmalloc_addr(urb->transfer_buffer)) {
1587 WARN_ONCE(1, "transfer buffer not dma capable\n");
1588 ret = -EAGAIN;
ff9c895f
AS		 1589 } else {
1590 urb->transfer_dma = dma_map_single(
1591 hcd->self.controller,
1592 urb->transfer_buffer,
1593 urb->transfer_buffer_length,
1594 dir);
1595 if (dma_mapping_error(hcd->self.controller,
1596 urb->transfer_dma))
1597 ret = -EAGAIN;
1598 else
1599 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1600 }
85e034fd 1601 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
b3476675
MD		 1602 ret = hcd_alloc_coherent(
1603 urb->dev->bus, mem_flags,
1604 &urb->transfer_dma,
1605 &urb->transfer_buffer,
1606 urb->transfer_buffer_length,
1607 dir);
ff9c895f
AS		 1608 if (ret == 0)
1609 urb->transfer_flags |= URB_MAP_LOCAL;
b3476675 1610 }
ff9c895f
AS		 1611 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1612 URB_SETUP_MAP_LOCAL)))
c8cf203a 1613 usb_hcd_unmap_urb_for_dma(hcd, urb);
1da177e4 1614 }
b3476675 1615 return ret;
9a9bf406 1616}
2694a48d 1617EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1da177e4 1618
9a9bf406
AS		 1619/*-------------------------------------------------------------------------*/
1620
1621/* may be called in any context with a valid urb->dev usecount
1622 * caller surrenders "ownership" of urb
1623 * expects usb_submit_urb() to have sanity checked and conditioned all
1624 * inputs in the urb
1625 */
1626int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1627{
1628 int status;
1629 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1630
1631 /* increment urb's reference count as part of giving it to the HCD
1632 * (which will control it). HCD guarantees that it either returns
1633 * an error or calls giveback(), but not both.
1634 */
1635 usb_get_urb(urb);
1636 atomic_inc(&urb->use_count);
4d59d8a1 1637 atomic_inc(&urb->dev->urbnum);
9a9bf406
AS		 1638 usbmon_urb_submit(&hcd->self, urb);
1639
1640 /* NOTE requirements on root-hub callers (usbfs and the hub
1641 * driver, for now): URBs' urb->transfer_buffer must be
1642 * valid and usb_buffer_{sync,unmap}() not be needed, since
1643 * they could clobber root hub response data. Also, control
1644 * URBs must be submitted in process context with interrupts
1645 * enabled.
1646 */
b3476675 1647
ff9c895f 1648 if (is_root_hub(urb->dev)) {
e9df41c5 1649 status = rh_urb_enqueue(hcd, urb);
ff9c895f
AS		 1650 } else {
1651 status = map_urb_for_dma(hcd, urb, mem_flags);
1652 if (likely(status == 0)) {
1653 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1654 if (unlikely(status))
2694a48d 1655 unmap_urb_for_dma(hcd, urb);
ff9c895f
AS		 1656 }
1657 }
9a9bf406
AS		 1658
1659 if (unlikely(status)) {
1da177e4 1660 usbmon_urb_submit_error(&hcd->self, urb, status);
b0d9efba 1661 urb->hcpriv = NULL;
9a9bf406
AS		 1662 INIT_LIST_HEAD(&urb->urb_list);
1663 atomic_dec(&urb->use_count);
4d59d8a1 1664 atomic_dec(&urb->dev->urbnum);
49367d8f 1665 if (atomic_read(&urb->reject))
9a9bf406
AS		 1666 wake_up(&usb_kill_urb_queue);
1667 usb_put_urb(urb);
1da177e4
LT		 1668 }
1669 return status;
1670}
1671
1672/*-------------------------------------------------------------------------*/
1673
1da177e4
LT		 1674/* this makes the hcd giveback() the urb more quickly, by kicking it
1675 * off hardware queues (which may take a while) and returning it as
1676 * soon as practical. we've already set up the urb's return status,
1677 * but we can't know if the callback completed already.
1678 */
e9df41c5 1679static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1da177e4
LT		 1680{
1681 int value;
1682
809a58b8 1683 if (is_root_hub(urb->dev))
e9df41c5 1684 value = usb_rh_urb_dequeue(hcd, urb, status);
1da177e4
LT		 1685 else {
1686
1687 /* The only reason an HCD might fail this call is if
1688 * it has not yet fully queued the urb to begin with.
1689 * Such failures should be harmless. */
e9df41c5 1690 value = hcd->driver->urb_dequeue(hcd, urb, status);
1da177e4 1691 }
1da177e4
LT		 1692 return value;
1693}
1694
1695/*
1696 * called in any context
1697 *
1698 * caller guarantees urb won't be recycled till both unlink()
1699 * and the urb's completion function return
1700 */
a6d2bb9f 1701int usb_hcd_unlink_urb (struct urb *urb, int status)
1da177e4 1702{
9a9bf406 1703 struct usb_hcd *hcd;
c9919790 1704 struct usb_device *udev = urb->dev;
cde217a5
AS		 1705 int retval = -EIDRM;
1706 unsigned long flags;
1da177e4 1707
cde217a5
AS		 1708 /* Prevent the device and bus from going away while
1709 * the unlink is carried out. If they are already gone
1710 * then urb->use_count must be 0, since disconnected
1711 * devices can't have any active URBs.
1712 */
1713 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1714 if (atomic_read(&urb->use_count) > 0) {
1715 retval = 0;
c9919790 1716 usb_get_dev(udev);
cde217a5
AS		 1717 }
1718 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1719 if (retval == 0) {
1720 hcd = bus_to_hcd(urb->dev->bus);
1721 retval = unlink1(hcd, urb, status);
c9919790
AS		 1722 if (retval == 0)
1723 retval = -EINPROGRESS;
1724 else if (retval != -EIDRM && retval != -EBUSY)
1725 dev_dbg(&udev->dev, "hcd_unlink_urb %p fail %d\n",
1726 urb, retval);
1727 usb_put_dev(udev);
cde217a5 1728 }
1da177e4
LT		 1729 return retval;
1730}
1731
1732/*-------------------------------------------------------------------------*/
1733
94dfd7ed
ML		 1734static void __usb_hcd_giveback_urb(struct urb *urb)
1735{
1736 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
6ec4147e 1737 struct usb_anchor *anchor = urb->anchor;
94dfd7ed
ML		 1738 int status = urb->unlinked;
1739 unsigned long flags;
1740
1741 urb->hcpriv = NULL;
1742 if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1743 urb->actual_length < urb->transfer_buffer_length &&
1744 !status))
1745 status = -EREMOTEIO;
1746
1747 unmap_urb_for_dma(hcd, urb);
1748 usbmon_urb_complete(&hcd->self, urb, status);
6ec4147e 1749 usb_anchor_suspend_wakeups(anchor);
94dfd7ed 1750 usb_unanchor_urb(urb);
0cfbd328
MS		 1751 if (likely(status == 0))
1752 usb_led_activity(USB_LED_EVENT_HOST);
94dfd7ed
ML		 1753
1754 /* pass ownership to the completion handler */
1755 urb->status = status;
1756
1757 /*
1758 * We disable local IRQs here avoid possible deadlock because
1759 * drivers may call spin_lock() to hold lock which might be
1760 * acquired in one hard interrupt handler.
1761 *
1762 * The local_irq_save()/local_irq_restore() around complete()
1763 * will be removed if current USB drivers have been cleaned up
1764 * and no one may trigger the above deadlock situation when
1765 * running complete() in tasklet.
1766 */
1767 local_irq_save(flags);
1768 urb->complete(urb);
1769 local_irq_restore(flags);
1770
6ec4147e 1771 usb_anchor_resume_wakeups(anchor);
94dfd7ed
ML		 1772 atomic_dec(&urb->use_count);
1773 if (unlikely(atomic_read(&urb->reject)))
1774 wake_up(&usb_kill_urb_queue);
1775 usb_put_urb(urb);
1776}
1777
1778static void usb_giveback_urb_bh(unsigned long param)
1779{
1780 struct giveback_urb_bh *bh = (struct giveback_urb_bh *)param;
1781 struct list_head local_list;
1782
1783 spin_lock_irq(&bh->lock);
1784 bh->running = true;
1785 restart:
1786 list_replace_init(&bh->head, &local_list);
1787 spin_unlock_irq(&bh->lock);
1788
1789 while (!list_empty(&local_list)) {
1790 struct urb *urb;
1791
1792 urb = list_entry(local_list.next, struct urb, urb_list);
1793 list_del_init(&urb->urb_list);
c7ccde6e 1794 bh->completing_ep = urb->ep;
94dfd7ed 1795 __usb_hcd_giveback_urb(urb);
c7ccde6e 1796 bh->completing_ep = NULL;
94dfd7ed
ML		 1797 }
1798
1799 /* check if there are new URBs to giveback */
1800 spin_lock_irq(&bh->lock);
1801 if (!list_empty(&bh->head))
1802 goto restart;
1803 bh->running = false;
1804 spin_unlock_irq(&bh->lock);
1805}
1806
32aca560
AS		 1807/**
1808 * usb_hcd_giveback_urb - return URB from HCD to device driver
1809 * @hcd: host controller returning the URB
1810 * @urb: urb being returned to the USB device driver.
4a00027d 1811 * @status: completion status code for the URB.
32aca560
AS		 1812 * Context: in_interrupt()
1813 *
1814 * This hands the URB from HCD to its USB device driver, using its
1815 * completion function. The HCD has freed all per-urb resources
1816 * (and is done using urb->hcpriv). It also released all HCD locks;
1817 * the device driver won't cause problems if it frees, modifies,
1818 * or resubmits this URB.
eb231054 1819 *
4a00027d 1820 * If @urb was unlinked, the value of @status will be overridden by
eb231054
AS		 1821 * @urb->unlinked. Erroneous short transfers are detected in case
1822 * the HCD hasn't checked for them.
32aca560 1823 */
4a00027d 1824void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
32aca560 1825{
94dfd7ed
ML		 1826 struct giveback_urb_bh *bh;
1827 bool running, high_prio_bh;
32aca560 1828
94dfd7ed
ML		 1829 /* pass status to tasklet via unlinked */
1830 if (likely(!urb->unlinked))
1831 urb->unlinked = status;
1f5a3d0f 1832
94dfd7ed
ML		 1833 if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
1834 __usb_hcd_giveback_urb(urb);
1835 return;
1836 }
1837
1838 if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe)) {
1839 bh = &hcd->high_prio_bh;
1840 high_prio_bh = true;
1841 } else {
1842 bh = &hcd->low_prio_bh;
1843 high_prio_bh = false;
1844 }
1845
1846 spin_lock(&bh->lock);
1847 list_add_tail(&urb->urb_list, &bh->head);
1848 running = bh->running;
1849 spin_unlock(&bh->lock);
1850
1851 if (running)
1852 ;
1853 else if (high_prio_bh)
1854 tasklet_hi_schedule(&bh->bh);
1855 else
1856 tasklet_schedule(&bh->bh);
32aca560 1857}
782e70c6 1858EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
32aca560
AS		 1859
1860/*-------------------------------------------------------------------------*/
1861
95cf82f9
AS		 1862/* Cancel all URBs pending on this endpoint and wait for the endpoint's
1863 * queue to drain completely. The caller must first insure that no more
1864 * URBs can be submitted for this endpoint.
1da177e4 1865 */
95cf82f9 1866void usb_hcd_flush_endpoint(struct usb_device *udev,
a6d2bb9f 1867 struct usb_host_endpoint *ep)
1da177e4
LT		 1868{
1869 struct usb_hcd *hcd;
1870 struct urb *urb;
1871
95cf82f9
AS		 1872 if (!ep)
1873 return;
9a9bf406 1874 might_sleep();
17200583 1875 hcd = bus_to_hcd(udev->bus);
1da177e4 1876
95cf82f9 1877 /* No more submits can occur */
9a9bf406 1878 spin_lock_irq(&hcd_urb_list_lock);
ddc1fd6a 1879rescan:
1da177e4 1880 list_for_each_entry (urb, &ep->urb_list, urb_list) {
5e60a161 1881 int is_in;
1da177e4 1882
eb231054 1883 if (urb->unlinked)
1da177e4
LT		 1884 continue;
1885 usb_get_urb (urb);
5e60a161 1886 is_in = usb_urb_dir_in(urb);
809a58b8 1887 spin_unlock(&hcd_urb_list_lock);
1da177e4 1888
e9df41c5
AS		 1889 /* kick hcd */
1890 unlink1(hcd, urb, -ESHUTDOWN);
1891 dev_dbg (hcd->self.controller,
1892 "shutdown urb %p ep%d%s%s\n",
1893 urb, usb_endpoint_num(&ep->desc),
1894 is_in ? "in" : "out",
1895 ({ char *s;
1896
1897 switch (usb_endpoint_type(&ep->desc)) {
1898 case USB_ENDPOINT_XFER_CONTROL:
1899 s = ""; break;
1900 case USB_ENDPOINT_XFER_BULK:
1901 s = "-bulk"; break;
1902 case USB_ENDPOINT_XFER_INT:
1903 s = "-intr"; break;
1904 default:
14557359 1905 s = "-iso"; break;
e9df41c5
AS		 1906 };
1907 s;
1908 }));
1da177e4
LT		 1909 usb_put_urb (urb);
1910
1911 /* list contents may have changed */
ddc1fd6a 1912 spin_lock(&hcd_urb_list_lock);
1da177e4
LT		 1913 goto rescan;
1914 }
9a9bf406 1915 spin_unlock_irq(&hcd_urb_list_lock);
1da177e4 1916
95cf82f9 1917 /* Wait until the endpoint queue is completely empty */
455b25fb 1918 while (!list_empty (&ep->urb_list)) {
809a58b8 1919 spin_lock_irq(&hcd_urb_list_lock);
455b25fb
AS		 1920
1921 /* The list may have changed while we acquired the spinlock */
1922 urb = NULL;
1923 if (!list_empty (&ep->urb_list)) {
1924 urb = list_entry (ep->urb_list.prev, struct urb,
1925 urb_list);
1926 usb_get_urb (urb);
1927 }
809a58b8 1928 spin_unlock_irq(&hcd_urb_list_lock);
455b25fb
AS		 1929
1930 if (urb) {
1931 usb_kill_urb (urb);
1932 usb_put_urb (urb);
1933 }
1934 }
1da177e4
LT		 1935}
1936
3f0479e0 1937/**
70445ae6
RD		 1938 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1939 * the bus bandwidth
1940 * @udev: target &usb_device
3f0479e0
SS		 1941 * @new_config: new configuration to install
1942 * @cur_alt: the current alternate interface setting
1943 * @new_alt: alternate interface setting that is being installed
1944 *
1945 * To change configurations, pass in the new configuration in new_config,
1946 * and pass NULL for cur_alt and new_alt.
1947 *
1948 * To reset a device's configuration (put the device in the ADDRESSED state),
1949 * pass in NULL for new_config, cur_alt, and new_alt.
1950 *
1951 * To change alternate interface settings, pass in NULL for new_config,
1952 * pass in the current alternate interface setting in cur_alt,
1953 * and pass in the new alternate interface setting in new_alt.
1954 *
626f090c 1955 * Return: An error if the requested bandwidth change exceeds the
3f0479e0 1956 * bus bandwidth or host controller internal resources.
79abb1ab 1957 */
3f0479e0 1958int usb_hcd_alloc_bandwidth(struct usb_device *udev,
79abb1ab 1959 struct usb_host_config *new_config,
3f0479e0
SS		 1960 struct usb_host_interface *cur_alt,
1961 struct usb_host_interface *new_alt)
79abb1ab
SS		 1962{
1963 int num_intfs, i, j;
576a362a 1964 struct usb_host_interface *alt = NULL;
79abb1ab
SS		 1965 int ret = 0;
1966 struct usb_hcd *hcd;
1967 struct usb_host_endpoint *ep;
1968
1969 hcd = bus_to_hcd(udev->bus);
1970 if (!hcd->driver->check_bandwidth)
1971 return 0;
1972
1973 /* Configuration is being removed - set configuration 0 */
3f0479e0 1974 if (!new_config && !cur_alt) {
79abb1ab
SS		 1975 for (i = 1; i < 16; ++i) {
1976 ep = udev->ep_out[i];
1977 if (ep)
1978 hcd->driver->drop_endpoint(hcd, udev, ep);
1979 ep = udev->ep_in[i];
1980 if (ep)
1981 hcd->driver->drop_endpoint(hcd, udev, ep);
1982 }
1983 hcd->driver->check_bandwidth(hcd, udev);
1984 return 0;
1985 }
1986 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1987 * each interface's alt setting 0 and ask the HCD to check the bandwidth
1988 * of the bus. There will always be bandwidth for endpoint 0, so it's
1989 * ok to exclude it.
1990 */
1991 if (new_config) {
1992 num_intfs = new_config->desc.bNumInterfaces;
1993 /* Remove endpoints (except endpoint 0, which is always on the
1994 * schedule) from the old config from the schedule
1995 */
1996 for (i = 1; i < 16; ++i) {
1997 ep = udev->ep_out[i];
1998 if (ep) {
1999 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
2000 if (ret < 0)
2001 goto reset;
2002 }
2003 ep = udev->ep_in[i];
2004 if (ep) {
2005 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
2006 if (ret < 0)
2007 goto reset;
2008 }
2009 }
2010 for (i = 0; i < num_intfs; ++i) {
d837e219
SS		 2011 struct usb_host_interface *first_alt;
2012 int iface_num;
2013
2014 first_alt = &new_config->intf_cache[i]->altsetting[0];
2015 iface_num = first_alt->desc.bInterfaceNumber;
91017f9c 2016 /* Set up endpoints for alternate interface setting 0 */
d837e219 2017 alt = usb_find_alt_setting(new_config, iface_num, 0);
3f0479e0
SS		 2018 if (!alt)
2019 /* No alt setting 0? Pick the first setting. */
d837e219 2020 alt = first_alt;
3f0479e0 2021
79abb1ab
SS		 2022 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
2023 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
2024 if (ret < 0)
2025 goto reset;
2026 }
2027 }
2028 }
3f0479e0 2029 if (cur_alt && new_alt) {
04a723ea
SS		 2030 struct usb_interface *iface = usb_ifnum_to_if(udev,
2031 cur_alt->desc.bInterfaceNumber);
2032
8a9af4fd
SS		 2033 if (!iface)
2034 return -EINVAL;
04a723ea
SS		 2035 if (iface->resetting_device) {
2036 /*
2037 * The USB core just reset the device, so the xHCI host
2038 * and the device will think alt setting 0 is installed.
2039 * However, the USB core will pass in the alternate
2040 * setting installed before the reset as cur_alt. Dig
2041 * out the alternate setting 0 structure, or the first
2042 * alternate setting if a broken device doesn't have alt
2043 * setting 0.
2044 */
2045 cur_alt = usb_altnum_to_altsetting(iface, 0);
2046 if (!cur_alt)
2047 cur_alt = &iface->altsetting[0];
2048 }
2049
3f0479e0
SS		 2050 /* Drop all the endpoints in the current alt setting */
2051 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
2052 ret = hcd->driver->drop_endpoint(hcd, udev,
2053 &cur_alt->endpoint[i]);
2054 if (ret < 0)
2055 goto reset;
2056 }
2057 /* Add all the endpoints in the new alt setting */
2058 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
2059 ret = hcd->driver->add_endpoint(hcd, udev,
2060 &new_alt->endpoint[i]);
2061 if (ret < 0)
2062 goto reset;
2063 }
2064 }
79abb1ab
SS		 2065 ret = hcd->driver->check_bandwidth(hcd, udev);
2066reset:
2067 if (ret < 0)
2068 hcd->driver->reset_bandwidth(hcd, udev);
2069 return ret;
2070}
2071
95cf82f9
AS		 2072/* Disables the endpoint: synchronizes with the hcd to make sure all
2073 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
2074 * have been called previously. Use for set_configuration, set_interface,
2075 * driver removal, physical disconnect.
2076 *
2077 * example: a qh stored in ep->hcpriv, holding state related to endpoint
2078 * type, maxpacket size, toggle, halt status, and scheduling.
2079 */
2080void usb_hcd_disable_endpoint(struct usb_device *udev,
2081 struct usb_host_endpoint *ep)
2082{
2083 struct usb_hcd *hcd;
2084
2085 might_sleep();
2086 hcd = bus_to_hcd(udev->bus);
2087 if (hcd->driver->endpoint_disable)
2088 hcd->driver->endpoint_disable(hcd, ep);
2089}
2090
3444b26a
DV		 2091/**
2092 * usb_hcd_reset_endpoint - reset host endpoint state
2093 * @udev: USB device.
2094 * @ep: the endpoint to reset.
2095 *
2096 * Resets any host endpoint state such as the toggle bit, sequence
2097 * number and current window.
2098 */
2099void usb_hcd_reset_endpoint(struct usb_device *udev,
2100 struct usb_host_endpoint *ep)
2101{
2102 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2103
2104 if (hcd->driver->endpoint_reset)
2105 hcd->driver->endpoint_reset(hcd, ep);
2106 else {
2107 int epnum = usb_endpoint_num(&ep->desc);
2108 int is_out = usb_endpoint_dir_out(&ep->desc);
2109 int is_control = usb_endpoint_xfer_control(&ep->desc);
2110
2111 usb_settoggle(udev, epnum, is_out, 0);
2112 if (is_control)
2113 usb_settoggle(udev, epnum, !is_out, 0);
2114 }
2115}
2116
eab1cafc
SS		 2117/**
2118 * usb_alloc_streams - allocate bulk endpoint stream IDs.
2119 * @interface: alternate setting that includes all endpoints.
2120 * @eps: array of endpoints that need streams.
2121 * @num_eps: number of endpoints in the array.
2122 * @num_streams: number of streams to allocate.
2123 * @mem_flags: flags hcd should use to allocate memory.
2124 *
626f090c 2125 * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
eab1cafc
SS		 2126 * Drivers may queue multiple transfers to different stream IDs, which may
2127 * complete in a different order than they were queued.
626f090c
YB		 2128 *
2129 * Return: On success, the number of allocated streams. On failure, a negative
2130 * error code.
eab1cafc
SS		 2131 */
2132int usb_alloc_streams(struct usb_interface *interface,
2133 struct usb_host_endpoint **eps, unsigned int num_eps,
2134 unsigned int num_streams, gfp_t mem_flags)
2135{
2136 struct usb_hcd *hcd;
2137 struct usb_device *dev;
8d4f70b2 2138 int i, ret;
eab1cafc
SS		 2139
2140 dev = interface_to_usbdev(interface);
2141 hcd = bus_to_hcd(dev->bus);
2142 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
2143 return -EINVAL;
8a1b2725 2144 if (dev->speed < USB_SPEED_SUPER)
eab1cafc 2145 return -EINVAL;
90a646c7
HG		 2146 if (dev->state < USB_STATE_CONFIGURED)
2147 return -ENODEV;
eab1cafc 2148
8d4f70b2
HG		 2149 for (i = 0; i < num_eps; i++) {
2150 /* Streams only apply to bulk endpoints. */
eab1cafc
SS		 2151 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
2152 return -EINVAL;
8d4f70b2
HG		 2153 /* Re-alloc is not allowed */
2154 if (eps[i]->streams)
2155 return -EINVAL;
2156 }
eab1cafc 2157
8d4f70b2 2158 ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
eab1cafc 2159 num_streams, mem_flags);
8d4f70b2
HG		 2160 if (ret < 0)
2161 return ret;
2162
2163 for (i = 0; i < num_eps; i++)
2164 eps[i]->streams = ret;
2165
2166 return ret;
eab1cafc
SS		 2167}
2168EXPORT_SYMBOL_GPL(usb_alloc_streams);
2169
2170/**
2171 * usb_free_streams - free bulk endpoint stream IDs.
2172 * @interface: alternate setting that includes all endpoints.
2173 * @eps: array of endpoints to remove streams from.
2174 * @num_eps: number of endpoints in the array.
2175 * @mem_flags: flags hcd should use to allocate memory.
2176 *
2177 * Reverts a group of bulk endpoints back to not using stream IDs.
2178 * Can fail if we are given bad arguments, or HCD is broken.
6c74dada 2179 *
12d4bbce 2180 * Return: 0 on success. On failure, a negative error code.
eab1cafc 2181 */
6c74dada 2182int usb_free_streams(struct usb_interface *interface,
eab1cafc
SS		 2183 struct usb_host_endpoint **eps, unsigned int num_eps,
2184 gfp_t mem_flags)
2185{
2186 struct usb_hcd *hcd;
2187 struct usb_device *dev;
8d4f70b2 2188 int i, ret;
eab1cafc
SS		 2189
2190 dev = interface_to_usbdev(interface);
2191 hcd = bus_to_hcd(dev->bus);
8a1b2725 2192 if (dev->speed < USB_SPEED_SUPER)
6c74dada 2193 return -EINVAL;
eab1cafc 2194
8d4f70b2 2195 /* Double-free is not allowed */
eab1cafc 2196 for (i = 0; i < num_eps; i++)
8d4f70b2 2197 if (!eps[i] || !eps[i]->streams)
6c74dada 2198 return -EINVAL;
eab1cafc 2199
8d4f70b2
HG		 2200 ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2201 if (ret < 0)
2202 return ret;
2203
2204 for (i = 0; i < num_eps; i++)
2205 eps[i]->streams = 0;
2206
2207 return ret;
eab1cafc
SS		 2208}
2209EXPORT_SYMBOL_GPL(usb_free_streams);
2210
cde217a5
AS		 2211/* Protect against drivers that try to unlink URBs after the device
2212 * is gone, by waiting until all unlinks for @udev are finished.
2213 * Since we don't currently track URBs by device, simply wait until
2214 * nothing is running in the locked region of usb_hcd_unlink_urb().
2215 */
2216void usb_hcd_synchronize_unlinks(struct usb_device *udev)
2217{
2218 spin_lock_irq(&hcd_urb_unlink_lock);
2219 spin_unlock_irq(&hcd_urb_unlink_lock);
2220}
2221
1da177e4
LT		 2222/*-------------------------------------------------------------------------*/
2223
32aca560
AS		 2224/* called in any context */
2225int usb_hcd_get_frame_number (struct usb_device *udev)
2226{
2227 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2228
9b37596a 2229 if (!HCD_RH_RUNNING(hcd))
32aca560
AS		 2230 return -ESHUTDOWN;
2231 return hcd->driver->get_frame_number (hcd);
2232}
2233
2234/*-------------------------------------------------------------------------*/
2235
9293677a 2236#ifdef CONFIG_PM
1da177e4 2237
65bfd296 2238int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
1da177e4 2239{
686314cf
AS		 2240 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
2241 int status;
2242 int old_state = hcd->state;
1da177e4 2243
30b1a7a3
AS		 2244 dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2245 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2246 rhdev->do_remote_wakeup);
9b37596a
AS		 2247 if (HCD_DEAD(hcd)) {
2248 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2249 return 0;
2250 }
2251
686314cf
AS		 2252 if (!hcd->driver->bus_suspend) {
2253 status = -ENOENT;
2254 } else {
9b37596a 2255 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
686314cf
AS		 2256 hcd->state = HC_STATE_QUIESCING;
2257 status = hcd->driver->bus_suspend(hcd);
2258 }
2259 if (status == 0) {
2260 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
9293677a 2261 hcd->state = HC_STATE_SUSPENDED;
879d38e6
AS		 2262
2263 /* Did we race with a root-hub wakeup event? */
2264 if (rhdev->do_remote_wakeup) {
2265 char buffer[6];
2266
2267 status = hcd->driver->hub_status_data(hcd, buffer);
2268 if (status != 0) {
2269 dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2270 hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2271 status = -EBUSY;
2272 }
2273 }
686314cf 2274 } else {
9b37596a
AS		 2275 spin_lock_irq(&hcd_root_hub_lock);
2276 if (!HCD_DEAD(hcd)) {
2277 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2278 hcd->state = old_state;
2279 }
2280 spin_unlock_irq(&hcd_root_hub_lock);
686314cf 2281 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
9293677a 2282 "suspend", status);
686314cf 2283 }
9293677a 2284 return status;
1da177e4
LT		 2285}
2286
65bfd296 2287int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
1da177e4 2288{
686314cf
AS		 2289 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
2290 int status;
cfa59dab 2291 int old_state = hcd->state;
1da177e4 2292
30b1a7a3
AS		 2293 dev_dbg(&rhdev->dev, "usb %sresume\n",
2294 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
9b37596a
AS		 2295 if (HCD_DEAD(hcd)) {
2296 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2297 return 0;
2298 }
0c0382e3 2299 if (!hcd->driver->bus_resume)
9293677a 2300 return -ENOENT;
9b37596a 2301 if (HCD_RH_RUNNING(hcd))
979d5199 2302 return 0;
686314cf 2303
9293677a 2304 hcd->state = HC_STATE_RESUMING;
686314cf 2305 status = hcd->driver->bus_resume(hcd);
bf3d7d40 2306 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
686314cf 2307 if (status == 0) {
bfd1e910
AS		 2308 struct usb_device *udev;
2309 int port1;
2310
9b37596a
AS		 2311 spin_lock_irq(&hcd_root_hub_lock);
2312 if (!HCD_DEAD(hcd)) {
2313 usb_set_device_state(rhdev, rhdev->actconfig
2314 ? USB_STATE_CONFIGURED
2315 : USB_STATE_ADDRESS);
2316 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2317 hcd->state = HC_STATE_RUNNING;
2318 }
2319 spin_unlock_irq(&hcd_root_hub_lock);
bfd1e910
AS		 2320
2321 /*
2322 * Check whether any of the enabled ports on the root hub are
2323 * unsuspended. If they are then a TRSMRCY delay is needed
2324 * (this is what the USB-2 spec calls a "global resume").
2325 * Otherwise we can skip the delay.
2326 */
2327 usb_hub_for_each_child(rhdev, port1, udev) {
2328 if (udev->state != USB_STATE_NOTATTACHED &&
2329 !udev->port_is_suspended) {
2330 usleep_range(10000, 11000); /* TRSMRCY */
2331 break;
2332 }
2333 }
686314cf 2334 } else {
cfa59dab 2335 hcd->state = old_state;
686314cf 2336 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
9293677a 2337 "resume", status);
cfa59dab
AS		 2338 if (status != -ESHUTDOWN)
2339 usb_hc_died(hcd);
9293677a
DB		 2340 }
2341 return status;
1da177e4
LT		 2342}
2343
6b157c9b
AS		 2344/* Workqueue routine for root-hub remote wakeup */
2345static void hcd_resume_work(struct work_struct *work)
2346{
2347 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2348 struct usb_device *udev = hcd->self.root_hub;
2349
0534d468 2350 usb_remote_wakeup(udev);
6b157c9b
AS		 2351}
2352
1da177e4 2353/**
14557359 2354 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1da177e4
LT		 2355 * @hcd: host controller for this root hub
2356 *
2357 * The USB host controller calls this function when its root hub is
2358 * suspended (with the remote wakeup feature enabled) and a remote
6b157c9b
AS		 2359 * wakeup request is received. The routine submits a workqueue request
2360 * to resume the root hub (that is, manage its downstream ports again).
1da177e4
LT		 2361 */
2362void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2363{
2364 unsigned long flags;
2365
2366 spin_lock_irqsave (&hcd_root_hub_lock, flags);
ff2f0787
AS		 2367 if (hcd->rh_registered) {
2368 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
9bbdf1e0 2369 queue_work(pm_wq, &hcd->wakeup_work);
ff2f0787 2370 }
1da177e4
LT		 2371 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2372}
9293677a 2373EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1da177e4 2374
ceb6c9c8 2375#endif /* CONFIG_PM */
1da177e4
LT		 2376
2377/*-------------------------------------------------------------------------*/
2378
2379#ifdef CONFIG_USB_OTG
2380
2381/**
2382 * usb_bus_start_enum - start immediate enumeration (for OTG)
2383 * @bus: the bus (must use hcd framework)
2384 * @port_num: 1-based number of port; usually bus->otg_port
2385 * Context: in_interrupt()
2386 *
2387 * Starts enumeration, with an immediate reset followed later by
37ebb549 2388 * hub_wq identifying and possibly configuring the device.
1da177e4
LT		 2389 * This is needed by OTG controller drivers, where it helps meet
2390 * HNP protocol timing requirements for starting a port reset.
626f090c
YB		 2391 *
2392 * Return: 0 if successful.
1da177e4
LT		 2393 */
2394int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2395{
2396 struct usb_hcd *hcd;
2397 int status = -EOPNOTSUPP;
2398
2399 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2400 * boards with root hubs hooked up to internal devices (instead of
2401 * just the OTG port) may need more attention to resetting...
2402 */
2403 hcd = container_of (bus, struct usb_hcd, self);
2404 if (port_num && hcd->driver->start_port_reset)
2405 status = hcd->driver->start_port_reset(hcd, port_num);
2406
37ebb549 2407 /* allocate hub_wq shortly after (first) root port reset finishes;
1da177e4
LT		 2408 * it may issue others, until at least 50 msecs have passed.
2409 */
2410 if (status == 0)
2411 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2412 return status;
2413}
782e70c6 2414EXPORT_SYMBOL_GPL(usb_bus_start_enum);
1da177e4
LT		 2415
2416#endif
2417
2418/*-------------------------------------------------------------------------*/
2419
1da177e4
LT		 2420/**
2421 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2422 * @irq: the IRQ being raised
2423 * @__hcd: pointer to the HCD whose IRQ is being signaled
1da177e4
LT		 2424 *
2425 * If the controller isn't HALTed, calls the driver's irq handler.
2426 * Checks whether the controller is now dead.
626f090c
YB		 2427 *
2428 * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
1da177e4 2429 */
7d12e780 2430irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1da177e4
LT		 2431{
2432 struct usb_hcd *hcd = __hcd;
de85422b 2433 irqreturn_t rc;
1da177e4 2434
968b822c 2435 if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
de85422b 2436 rc = IRQ_NONE;
968b822c 2437 else if (hcd->driver->irq(hcd) == IRQ_NONE)
de85422b 2438 rc = IRQ_NONE;
968b822c 2439 else
de85422b 2440 rc = IRQ_HANDLED;
de85422b 2441
de85422b 2442 return rc;
1da177e4 2443}
43b86af8 2444EXPORT_SYMBOL_GPL(usb_hcd_irq);
1da177e4
LT		 2445
2446/*-------------------------------------------------------------------------*/
2447
2448/**
2449 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2450 * @hcd: pointer to the HCD representing the controller
2451 *
2452 * This is called by bus glue to report a USB host controller that died
2453 * while operations may still have been pending. It's called automatically
c5635437
SS		 2454 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2455 *
2456 * Only call this function with the primary HCD.
1da177e4
LT		 2457 */
2458void usb_hc_died (struct usb_hcd *hcd)
2459{
2460 unsigned long flags;
2461
2462 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2463
2464 spin_lock_irqsave (&hcd_root_hub_lock, flags);
9b37596a
AS		 2465 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2466 set_bit(HCD_FLAG_DEAD, &hcd->flags);
1da177e4 2467 if (hcd->rh_registered) {
541c7d43 2468 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1da177e4 2469
37ebb549 2470 /* make hub_wq clean up old urbs and devices */
1da177e4
LT		 2471 usb_set_device_state (hcd->self.root_hub,
2472 USB_STATE_NOTATTACHED);
59d48b3f 2473 usb_kick_hub_wq(hcd->self.root_hub);
1da177e4 2474 }
c5635437
SS		 2475 if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2476 hcd = hcd->shared_hcd;
2477 if (hcd->rh_registered) {
2478 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2479
37ebb549 2480 /* make hub_wq clean up old urbs and devices */
c5635437
SS		 2481 usb_set_device_state(hcd->self.root_hub,
2482 USB_STATE_NOTATTACHED);
59d48b3f 2483 usb_kick_hub_wq(hcd->self.root_hub);
c5635437
SS		 2484 }
2485 }
1da177e4 2486 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
c5635437 2487 /* Make sure that the other roothub is also deallocated. */
1da177e4
LT		 2488}
2489EXPORT_SYMBOL_GPL (usb_hc_died);
2490
2491/*-------------------------------------------------------------------------*/
2492
94dfd7ed
ML		 2493static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
2494{
2495
2496 spin_lock_init(&bh->lock);
2497 INIT_LIST_HEAD(&bh->head);
2498 tasklet_init(&bh->bh, usb_giveback_urb_bh, (unsigned long)bh);
2499}
2500
1da177e4 2501/**
c5635437 2502 * usb_create_shared_hcd - create and initialize an HCD structure
1da177e4
LT		 2503 * @driver: HC driver that will use this hcd
2504 * @dev: device for this HC, stored in hcd->self.controller
2505 * @bus_name: value to store in hcd->self.bus_name
c5635437
SS		 2506 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2507 * PCI device. Only allocate certain resources for the primary HCD
1da177e4
LT		 2508 * Context: !in_interrupt()
2509 *
2510 * Allocate a struct usb_hcd, with extra space at the end for the
2511 * HC driver's private data. Initialize the generic members of the
2512 * hcd structure.
2513 *
626f090c
YB		 2514 * Return: On success, a pointer to the created and initialized HCD structure.
2515 * On failure (e.g. if memory is unavailable), %NULL.
1da177e4 2516 */
c5635437
SS		 2517struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2518 struct device *dev, const char *bus_name,
2519 struct usb_hcd *primary_hcd)
1da177e4
LT		 2520{
2521 struct usb_hcd *hcd;
2522
7b842b6e 2523 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
1da177e4
LT		 2524 if (!hcd) {
2525 dev_dbg (dev, "hcd alloc failed\n");
2526 return NULL;
2527 }
c5635437
SS		 2528 if (primary_hcd == NULL) {
2529 hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2530 GFP_KERNEL);
2531 if (!hcd->bandwidth_mutex) {
2532 kfree(hcd);
2533 dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2534 return NULL;
2535 }
2536 mutex_init(hcd->bandwidth_mutex);
2537 dev_set_drvdata(dev, hcd);
2538 } else {
d8521afe 2539 mutex_lock(&usb_port_peer_mutex);
c5635437
SS		 2540 hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2541 hcd->primary_hcd = primary_hcd;
2542 primary_hcd->primary_hcd = primary_hcd;
2543 hcd->shared_hcd = primary_hcd;
2544 primary_hcd->shared_hcd = hcd;
d8521afe 2545 mutex_unlock(&usb_port_peer_mutex);
d673bfcb 2546 }
d673bfcb 2547
17200583 2548 kref_init(&hcd->kref);
1da177e4
LT		 2549
2550 usb_bus_init(&hcd->self);
1da177e4
LT		 2551 hcd->self.controller = dev;
2552 hcd->self.bus_name = bus_name;
dd990f16 2553 hcd->self.uses_dma = (dev->dma_mask != NULL);
1da177e4
LT		 2554
2555 init_timer(&hcd->rh_timer);
d5926ae7
AS		 2556 hcd->rh_timer.function = rh_timer_func;
2557 hcd->rh_timer.data = (unsigned long) hcd;
ceb6c9c8 2558#ifdef CONFIG_PM
6b157c9b
AS		 2559 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2560#endif
1da177e4
LT		 2561
2562 hcd->driver = driver;
83de4b2b 2563 hcd->speed = driver->flags & HCD_MASK;
1da177e4
LT		 2564 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2565 "USB Host Controller";
1da177e4
LT		 2566 return hcd;
2567}
c5635437
SS		 2568EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2569
2570/**
2571 * usb_create_hcd - create and initialize an HCD structure
2572 * @driver: HC driver that will use this hcd
2573 * @dev: device for this HC, stored in hcd->self.controller
2574 * @bus_name: value to store in hcd->self.bus_name
2575 * Context: !in_interrupt()
2576 *
2577 * Allocate a struct usb_hcd, with extra space at the end for the
2578 * HC driver's private data. Initialize the generic members of the
2579 * hcd structure.
2580 *
626f090c
YB		 2581 * Return: On success, a pointer to the created and initialized HCD
2582 * structure. On failure (e.g. if memory is unavailable), %NULL.
c5635437
SS		 2583 */
2584struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2585 struct device *dev, const char *bus_name)
2586{
2587 return usb_create_shared_hcd(driver, dev, bus_name, NULL);
2588}
782e70c6 2589EXPORT_SYMBOL_GPL(usb_create_hcd);
1da177e4 2590
c5635437
SS		 2591/*
2592 * Roothubs that share one PCI device must also share the bandwidth mutex.
2593 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2594 * deallocated.
2595 *
2596 * Make sure to only deallocate the bandwidth_mutex when the primary HCD is
d8521afe
DW		 2597 * freed. When hcd_release() is called for either hcd in a peer set
2598 * invalidate the peer's ->shared_hcd and ->primary_hcd pointers to
2599 * block new peering attempts
c5635437 2600 */
d8521afe 2601static void hcd_release(struct kref *kref)
17200583
AS		 2602{
2603 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2604
d8521afe 2605 mutex_lock(&usb_port_peer_mutex);
c5635437
SS		 2606 if (usb_hcd_is_primary_hcd(hcd))
2607 kfree(hcd->bandwidth_mutex);
d8521afe
DW		 2608 if (hcd->shared_hcd) {
2609 struct usb_hcd *peer = hcd->shared_hcd;
2610
2611 peer->shared_hcd = NULL;
2612 if (peer->primary_hcd == hcd)
2613 peer->primary_hcd = NULL;
2614 }
2615 mutex_unlock(&usb_port_peer_mutex);
17200583
AS		 2616 kfree(hcd);
2617}
2618
2619struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2620{
2621 if (hcd)
2622 kref_get (&hcd->kref);
2623 return hcd;
2624}
782e70c6 2625EXPORT_SYMBOL_GPL(usb_get_hcd);
17200583 2626
1da177e4
LT		 2627void usb_put_hcd (struct usb_hcd *hcd)
2628{
17200583
AS		 2629 if (hcd)
2630 kref_put (&hcd->kref, hcd_release);
1da177e4 2631}
782e70c6 2632EXPORT_SYMBOL_GPL(usb_put_hcd);
1da177e4 2633
c5635437
SS		 2634int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2635{
2636 if (!hcd->primary_hcd)
2637 return 1;
2638 return hcd == hcd->primary_hcd;
2639}
2640EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2641
3f5eb141
LT		 2642int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
2643{
2644 if (!hcd->driver->find_raw_port_number)
2645 return port1;
2646
2647 return hcd->driver->find_raw_port_number(hcd, port1);
2648}
2649
23e0d106
SS		 2650static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2651 unsigned int irqnum, unsigned long irqflags)
2652{
2653 int retval;
2654
2655 if (hcd->driver->irq) {
e592c5d0 2656
23e0d106
SS		 2657 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2658 hcd->driver->description, hcd->self.busnum);
2659 retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2660 hcd->irq_descr, hcd);
2661 if (retval != 0) {
2662 dev_err(hcd->self.controller,
2663 "request interrupt %d failed\n",
2664 irqnum);
2665 return retval;
2666 }
2667 hcd->irq = irqnum;
2668 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2669 (hcd->driver->flags & HCD_MEMORY) ?
2670 "io mem" : "io base",
2671 (unsigned long long)hcd->rsrc_start);
2672 } else {
cd70469d 2673 hcd->irq = 0;
23e0d106
SS		 2674 if (hcd->rsrc_start)
2675 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2676 (hcd->driver->flags & HCD_MEMORY) ?
2677 "io mem" : "io base",
2678 (unsigned long long)hcd->rsrc_start);
2679 }
2680 return 0;
2681}
2682
d8521afe
DW		 2683/*
2684 * Before we free this root hub, flush in-flight peering attempts
2685 * and disable peer lookups
2686 */
2687static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
2688{
2689 struct usb_device *rhdev;
2690
2691 mutex_lock(&usb_port_peer_mutex);
2692 rhdev = hcd->self.root_hub;
2693 hcd->self.root_hub = NULL;
2694 mutex_unlock(&usb_port_peer_mutex);
2695 usb_put_dev(rhdev);
2696}
2697
1da177e4
LT		 2698/**
2699 * usb_add_hcd - finish generic HCD structure initialization and register
2700 * @hcd: the usb_hcd structure to initialize
2701 * @irqnum: Interrupt line to allocate
2702 * @irqflags: Interrupt type flags
2703 *
2704 * Finish the remaining parts of generic HCD initialization: allocate the
2705 * buffers of consistent memory, register the bus, request the IRQ line,
2706 * and call the driver's reset() and start() routines.
2707 */
2708int usb_add_hcd(struct usb_hcd *hcd,
2709 unsigned int irqnum, unsigned long irqflags)
2710{
8ec8d20b
AS		 2711 int retval;
2712 struct usb_device *rhdev;
1da177e4 2713
3d46e73d 2714 if (IS_ENABLED(CONFIG_USB_PHY) && !hcd->usb_phy) {
1ae5799e
VB		 2715 struct usb_phy *phy = usb_get_phy_dev(hcd->self.controller, 0);
2716
2717 if (IS_ERR(phy)) {
2718 retval = PTR_ERR(phy);
2719 if (retval == -EPROBE_DEFER)
2720 return retval;
2721 } else {
2722 retval = usb_phy_init(phy);
2723 if (retval) {
2724 usb_put_phy(phy);
2725 return retval;
2726 }
3d46e73d 2727 hcd->usb_phy = phy;
1ae5799e
VB		 2728 hcd->remove_phy = 1;
2729 }
2730 }
2731
ef44cb42 2732 if (IS_ENABLED(CONFIG_GENERIC_PHY) && !hcd->phy) {
00433254
SS		 2733 struct phy *phy = phy_get(hcd->self.controller, "usb");
2734
2735 if (IS_ERR(phy)) {
2736 retval = PTR_ERR(phy);
2737 if (retval == -EPROBE_DEFER)
2738 goto err_phy;
2739 } else {
2740 retval = phy_init(phy);
2741 if (retval) {
2742 phy_put(phy);
2743 goto err_phy;
2744 }
2745 retval = phy_power_on(phy);
2746 if (retval) {
2747 phy_exit(phy);
2748 phy_put(phy);
2749 goto err_phy;
2750 }
2751 hcd->phy = phy;
ef44cb42 2752 hcd->remove_phy = 1;
00433254
SS		 2753 }
2754 }
2755
1da177e4
LT		 2756 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2757
c4fc2342 2758 /* Keep old behaviour if authorized_default is not in [0, 1]. */
ff8e2c56
SK		 2759 if (authorized_default < 0 || authorized_default > 1) {
2760 if (hcd->wireless)
2761 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2762 else
2763 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2764 } else {
2765 if (authorized_default)
2766 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2767 else
2768 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2769 }
8de98402
BH		 2770 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2771
6b2bd3c8
SK		 2772 /* per default all interfaces are authorized */
2773 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
2774
b1e8f0a6 2775 /* HC is in reset state, but accessible. Now do the one-time init,
37ebb549 2776 * bottom up so that hcds can customize the root hubs before hub_wq
b1e8f0a6
DB		 2777 * starts talking to them. (Note, bus id is assigned early too.)
2778 */
0faaad46
KB		 2779 retval = hcd_buffer_create(hcd);
2780 if (retval != 0) {
1da177e4 2781 dev_dbg(hcd->self.controller, "pool alloc failed\n");
00433254 2782 goto err_create_buf;
1da177e4
LT		 2783 }
2784
0faaad46
KB		 2785 retval = usb_register_bus(&hcd->self);
2786 if (retval < 0)
8ec8d20b 2787 goto err_register_bus;
1da177e4 2788
c688d621
GKH		 2789 rhdev = usb_alloc_dev(NULL, &hcd->self, 0);
2790 if (rhdev == NULL) {
b1e8f0a6
DB		 2791 dev_err(hcd->self.controller, "unable to allocate root hub\n");
2792 retval = -ENOMEM;
2793 goto err_allocate_root_hub;
2794 }
d8521afe 2795 mutex_lock(&usb_port_peer_mutex);
6d88e679 2796 hcd->self.root_hub = rhdev;
d8521afe 2797 mutex_unlock(&usb_port_peer_mutex);
6b403b02 2798
83de4b2b 2799 switch (hcd->speed) {
6b403b02
SS		 2800 case HCD_USB11:
2801 rhdev->speed = USB_SPEED_FULL;
2802 break;
2803 case HCD_USB2:
2804 rhdev->speed = USB_SPEED_HIGH;
2805 break;
1a81f881
TP		 2806 case HCD_USB25:
2807 rhdev->speed = USB_SPEED_WIRELESS;
2808 break;
6b403b02
SS		 2809 case HCD_USB3:
2810 rhdev->speed = USB_SPEED_SUPER;
2811 break;
5f9c3a66
MN		 2812 case HCD_USB31:
2813 rhdev->speed = USB_SPEED_SUPER_PLUS;
2814 break;
6b403b02 2815 default:
1d15ee4c 2816 retval = -EINVAL;
96e077ae 2817 goto err_set_rh_speed;
6b403b02 2818 }
b1e8f0a6 2819
db4cefaa
DB		 2820 /* wakeup flag init defaults to "everything works" for root hubs,
2821 * but drivers can override it in reset() if needed, along with
2822 * recording the overall controller's system wakeup capability.
2823 */
a6eeeb9f 2824 device_set_wakeup_capable(&rhdev->dev, 1);
db4cefaa 2825
9b37596a
AS		 2826 /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2827 * registered. But since the controller can die at any time,
2828 * let's initialize the flag before touching the hardware.
2829 */
2830 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2831
b1e8f0a6
DB		 2832 /* "reset" is misnamed; its role is now one-time init. the controller
2833 * should already have been reset (and boot firmware kicked off etc).
2834 */
0faaad46
KB		 2835 if (hcd->driver->reset) {
2836 retval = hcd->driver->reset(hcd);
2837 if (retval < 0) {
2838 dev_err(hcd->self.controller, "can't setup: %d\n",
2839 retval);
2840 goto err_hcd_driver_setup;
2841 }
b1e8f0a6 2842 }
6d88e679 2843 hcd->rh_pollable = 1;
b1e8f0a6 2844
fb669cc0
DB		 2845 /* NOTE: root hub and controller capabilities may not be the same */
2846 if (device_can_wakeup(hcd->self.controller)
2847 && device_can_wakeup(&hcd->self.root_hub->dev))
b1e8f0a6 2848 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
b1e8f0a6 2849
94dfd7ed
ML		 2850 /* initialize tasklets */
2851 init_giveback_urb_bh(&hcd->high_prio_bh);
2852 init_giveback_urb_bh(&hcd->low_prio_bh);
2853
68d07f64
SS		 2854 /* enable irqs just before we start the controller,
2855 * if the BIOS provides legacy PCI irqs.
2856 */
2857 if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
c5635437
SS		 2858 retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2859 if (retval)
2860 goto err_request_irq;
2861 }
1da177e4 2862
4814030c 2863 hcd->state = HC_STATE_RUNNING;
abc4f9b0
SS		 2864 retval = hcd->driver->start(hcd);
2865 if (retval < 0) {
1da177e4 2866 dev_err(hcd->self.controller, "startup error %d\n", retval);
8ec8d20b 2867 goto err_hcd_driver_start;
1da177e4
LT		 2868 }
2869
b1e8f0a6 2870 /* starting here, usbcore will pay attention to this root hub */
0faaad46
KB		 2871 retval = register_root_hub(hcd);
2872 if (retval != 0)
8ec8d20b
AS		 2873 goto err_register_root_hub;
2874
5234ce1b
IPG		 2875 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2876 if (retval < 0) {
2877 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2878 retval);
2879 goto error_create_attr_group;
2880 }
541c7d43 2881 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
d5926ae7 2882 usb_hcd_poll_rh_status(hcd);
a6eeeb9f 2883
1da177e4
LT		 2884 return retval;
2885
5234ce1b 2886error_create_attr_group:
9b37596a 2887 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
96e077ae
AS		 2888 if (HC_IS_RUNNING(hcd->state))
2889 hcd->state = HC_STATE_QUIESCING;
2890 spin_lock_irq(&hcd_root_hub_lock);
2891 hcd->rh_registered = 0;
2892 spin_unlock_irq(&hcd_root_hub_lock);
2893
ceb6c9c8 2894#ifdef CONFIG_PM
96e077ae
AS		 2895 cancel_work_sync(&hcd->wakeup_work);
2896#endif
5234ce1b 2897 mutex_lock(&usb_bus_list_lock);
6d88e679 2898 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
5234ce1b 2899 mutex_unlock(&usb_bus_list_lock);
b1e8f0a6 2900err_register_root_hub:
6d88e679 2901 hcd->rh_pollable = 0;
541c7d43 2902 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
6d88e679 2903 del_timer_sync(&hcd->rh_timer);
8ec8d20b 2904 hcd->driver->stop(hcd);
96e077ae 2905 hcd->state = HC_STATE_HALT;
541c7d43 2906 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
96e077ae 2907 del_timer_sync(&hcd->rh_timer);
b1e8f0a6 2908err_hcd_driver_start:
cd70469d 2909 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
1da177e4 2910 free_irq(irqnum, hcd);
b1e8f0a6
DB		 2911err_request_irq:
2912err_hcd_driver_setup:
96e077ae 2913err_set_rh_speed:
d8521afe 2914 usb_put_invalidate_rhdev(hcd);
b1e8f0a6 2915err_allocate_root_hub:
1da177e4 2916 usb_deregister_bus(&hcd->self);
b1e8f0a6 2917err_register_bus:
1da177e4 2918 hcd_buffer_destroy(hcd);
00433254 2919err_create_buf:
ef44cb42 2920 if (IS_ENABLED(CONFIG_GENERIC_PHY) && hcd->remove_phy && hcd->phy) {
00433254
SS		 2921 phy_power_off(hcd->phy);
2922 phy_exit(hcd->phy);
2923 phy_put(hcd->phy);
2924 hcd->phy = NULL;
2925 }
2926err_phy:
3d46e73d
AT		 2927 if (hcd->remove_phy && hcd->usb_phy) {
2928 usb_phy_shutdown(hcd->usb_phy);
2929 usb_put_phy(hcd->usb_phy);
2930 hcd->usb_phy = NULL;
103e127d 2931 }
1da177e4 2932 return retval;
14557359 2933}
782e70c6 2934EXPORT_SYMBOL_GPL(usb_add_hcd);
1da177e4
LT		 2935
2936/**
2937 * usb_remove_hcd - shutdown processing for generic HCDs
2938 * @hcd: the usb_hcd structure to remove
2939 * Context: !in_interrupt()
2940 *
2941 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2942 * invoking the HCD's stop() method.
2943 */
2944void usb_remove_hcd(struct usb_hcd *hcd)
2945{
6d88e679
AS		 2946 struct usb_device *rhdev = hcd->self.root_hub;
2947
1da177e4
LT		 2948 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2949
6d88e679
AS		 2950 usb_get_dev(rhdev);
2951 sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
96e077ae 2952
9b37596a 2953 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
1da177e4
LT		 2954 if (HC_IS_RUNNING (hcd->state))
2955 hcd->state = HC_STATE_QUIESCING;
2956
2957 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2958 spin_lock_irq (&hcd_root_hub_lock);
2959 hcd->rh_registered = 0;
2960 spin_unlock_irq (&hcd_root_hub_lock);
9ad3d6cc 2961
ceb6c9c8 2962#ifdef CONFIG_PM
d5d4db70 2963 cancel_work_sync(&hcd->wakeup_work);
6b157c9b
AS		 2964#endif
2965
4186ecf8 2966 mutex_lock(&usb_bus_list_lock);
6d88e679 2967 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
4186ecf8 2968 mutex_unlock(&usb_bus_list_lock);
1da177e4 2969
94dfd7ed
ML		 2970 /*
2971 * tasklet_kill() isn't needed here because:
2972 * - driver's disconnect() called from usb_disconnect() should
2973 * make sure its URBs are completed during the disconnect()
2974 * callback
2975 *
2976 * - it is too late to run complete() here since driver may have
2977 * been removed already now
2978 */
2979
6d88e679
AS		 2980 /* Prevent any more root-hub status calls from the timer.
2981 * The HCD might still restart the timer (if a port status change
2982 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2983 * the hub_status_data() callback.
2984 */
2985 hcd->rh_pollable = 0;
541c7d43 2986 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
6d88e679
AS		 2987 del_timer_sync(&hcd->rh_timer);
2988
1da177e4
LT		 2989 hcd->driver->stop(hcd);
2990 hcd->state = HC_STATE_HALT;
2991
6d88e679 2992 /* In case the HCD restarted the timer, stop it again. */
541c7d43 2993 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1b42ae6d
AS		 2994 del_timer_sync(&hcd->rh_timer);
2995
c5635437 2996 if (usb_hcd_is_primary_hcd(hcd)) {
cd70469d 2997 if (hcd->irq > 0)
c5635437
SS		 2998 free_irq(hcd->irq, hcd);
2999 }
6d88e679 3000
1da177e4
LT		 3001 usb_deregister_bus(&hcd->self);
3002 hcd_buffer_destroy(hcd);
00433254 3003
ef44cb42 3004 if (IS_ENABLED(CONFIG_GENERIC_PHY) && hcd->remove_phy && hcd->phy) {
00433254
SS		 3005 phy_power_off(hcd->phy);
3006 phy_exit(hcd->phy);
3007 phy_put(hcd->phy);
3008 hcd->phy = NULL;
3009 }
3d46e73d
AT		 3010 if (hcd->remove_phy && hcd->usb_phy) {
3011 usb_phy_shutdown(hcd->usb_phy);
3012 usb_put_phy(hcd->usb_phy);
3013 hcd->usb_phy = NULL;
103e127d 3014 }
d8521afe
DW		 3015
3016 usb_put_invalidate_rhdev(hcd);
1da177e4 3017}
782e70c6 3018EXPORT_SYMBOL_GPL(usb_remove_hcd);
1da177e4 3019
64a21d02 3020void
842c1960 3021usb_hcd_platform_shutdown(struct platform_device *dev)
64a21d02
AG		 3022{
3023 struct usb_hcd *hcd = platform_get_drvdata(dev);
3024
3025 if (hcd->driver->shutdown)
3026 hcd->driver->shutdown(hcd);
3027}
782e70c6 3028EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
64a21d02 3029
1da177e4
LT		 3030/*-------------------------------------------------------------------------*/
3031
f150fa1a 3032#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
1da177e4 3033
6fb8ac81 3034const struct usb_mon_operations *mon_ops;
1da177e4
LT		 3035
3036/*
3037 * The registration is unlocked.
3038 * We do it this way because we do not want to lock in hot paths.
3039 *
3040 * Notice that the code is minimally error-proof. Because usbmon needs
3041 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
3042 */
14557359 3043
6fb8ac81 3044int usb_mon_register(const struct usb_mon_operations *ops)
1da177e4
LT		 3045{
3046
3047 if (mon_ops)
3048 return -EBUSY;
3049
3050 mon_ops = ops;
3051 mb();
3052 return 0;
3053}
3054EXPORT_SYMBOL_GPL (usb_mon_register);
3055
3056void usb_mon_deregister (void)
3057{
3058
3059 if (mon_ops == NULL) {
3060 printk(KERN_ERR "USB: monitor was not registered\n");
3061 return;
3062 }
3063 mon_ops = NULL;
3064 mb();
3065}
3066EXPORT_SYMBOL_GPL (usb_mon_deregister);
3067
f150fa1a 3068#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
ubuntu-bionic-kernel mirror