]> 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: hub: Do not attempt to autosuspend disconnected devices
[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>
35be784c 49#include <linux/usb/otg.h>
1da177e4
LT		 50
51#include "usb.h"
1da177e4
LT		 52
53
1da177e4
LT		 54/*-------------------------------------------------------------------------*/
55
56/*
57 * USB Host Controller Driver framework
58 *
59 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
60 * HCD-specific behaviors/bugs.
61 *
62 * This does error checks, tracks devices and urbs, and delegates to a
63 * "hc_driver" only for code (and data) that really needs to know about
64 * hardware differences. That includes root hub registers, i/o queues,
65 * and so on ... but as little else as possible.
66 *
67 * Shared code includes most of the "root hub" code (these are emulated,
68 * though each HC's hardware works differently) and PCI glue, plus request
69 * tracking overhead. The HCD code should only block on spinlocks or on
70 * hardware handshaking; blocking on software events (such as other kernel
71 * threads releasing resources, or completing actions) is all generic.
72 *
73 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
74 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
75 * only by the hub driver ... and that neither should be seen or used by
76 * usb client device drivers.
77 *
78 * Contributors of ideas or unattributed patches include: David Brownell,
79 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
80 *
81 * HISTORY:
82 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
83 * associated cleanup. "usb_hcd" still != "usb_bus".
84 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
85 */
86
87/*-------------------------------------------------------------------------*/
88
9beeee65
AS		 89/* Keep track of which host controller drivers are loaded */
90unsigned long usb_hcds_loaded;
91EXPORT_SYMBOL_GPL(usb_hcds_loaded);
92
1da177e4 93/* host controllers we manage */
5363de75
HK		 94DEFINE_IDR (usb_bus_idr);
95EXPORT_SYMBOL_GPL (usb_bus_idr);
1da177e4
LT		 96
97/* used when allocating bus numbers */
98#define USB_MAXBUS 64
1da177e4
LT		 99
100/* used when updating list of hcds */
a4b5d606
HK		 101DEFINE_MUTEX(usb_bus_idr_lock); /* exported only for usbfs */
102EXPORT_SYMBOL_GPL (usb_bus_idr_lock);
1da177e4
LT		 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;
feb26ac3 998 mutex_init(&bus->devnum_next_mutex);
1da177e4
LT		 999}
1000
1da177e4
LT		 1001/*-------------------------------------------------------------------------*/
1002
1003/**
1004 * usb_register_bus - registers the USB host controller with the usb core
1005 * @bus: pointer to the bus to register
1006 * Context: !in_interrupt()
1007 *
1008 * Assigns a bus number, and links the controller into usbcore data
1009 * structures so that it can be seen by scanning the bus list.
626f090c
YB		 1010 *
1011 * Return: 0 if successful. A negative error code otherwise.
1da177e4
LT		 1012 */
1013static int usb_register_bus(struct usb_bus *bus)
1014{
eb579f58 1015 int result = -E2BIG;
1da177e4 1016 int busnum;
1da177e4 1017
a4b5d606 1018 mutex_lock(&usb_bus_idr_lock);
5363de75
HK		 1019 busnum = idr_alloc(&usb_bus_idr, bus, 1, USB_MAXBUS, GFP_KERNEL);
1020 if (busnum < 0) {
1021 pr_err("%s: failed to get bus number\n", usbcore_name);
eb579f58 1022 goto error_find_busnum;
1da177e4 1023 }
eb579f58 1024 bus->busnum = busnum;
a4b5d606 1025 mutex_unlock(&usb_bus_idr_lock);
1da177e4 1026
3099e75a 1027 usb_notify_add_bus(bus);
1da177e4 1028
eb579f58
IPG		 1029 dev_info (bus->controller, "new USB bus registered, assigned bus "
1030 "number %d\n", bus->busnum);
1da177e4 1031 return 0;
eb579f58 1032
eb579f58 1033error_find_busnum:
a4b5d606 1034 mutex_unlock(&usb_bus_idr_lock);
eb579f58 1035 return result;
1da177e4
LT		 1036}
1037
1038/**
1039 * usb_deregister_bus - deregisters the USB host controller
1040 * @bus: pointer to the bus to deregister
1041 * Context: !in_interrupt()
1042 *
1043 * Recycles the bus number, and unlinks the controller from usbcore data
1044 * structures so that it won't be seen by scanning the bus list.
1045 */
1046static void usb_deregister_bus (struct usb_bus *bus)
1047{
1048 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
1049
1050 /*
1051 * NOTE: make sure that all the devices are removed by the
1052 * controller code, as well as having it call this when cleaning
1053 * itself up
1054 */
a4b5d606 1055 mutex_lock(&usb_bus_idr_lock);
5363de75 1056 idr_remove(&usb_bus_idr, bus->busnum);
a4b5d606 1057 mutex_unlock(&usb_bus_idr_lock);
1da177e4 1058
3099e75a 1059 usb_notify_remove_bus(bus);
1da177e4
LT		 1060}
1061
1062/**
8ec8d20b 1063 * register_root_hub - called by usb_add_hcd() to register a root hub
1da177e4
LT		 1064 * @hcd: host controller for this root hub
1065 *
8ec8d20b 1066 * This function registers the root hub with the USB subsystem. It sets up
b1e8f0a6
DB		 1067 * the device properly in the device tree and then calls usb_new_device()
1068 * to register the usb device. It also assigns the root hub's USB address
1069 * (always 1).
626f090c
YB		 1070 *
1071 * Return: 0 if successful. A negative error code otherwise.
1da177e4 1072 */
b1e8f0a6 1073static int register_root_hub(struct usb_hcd *hcd)
1da177e4
LT		 1074{
1075 struct device *parent_dev = hcd->self.controller;
b1e8f0a6 1076 struct usb_device *usb_dev = hcd->self.root_hub;
1da177e4
LT		 1077 const int devnum = 1;
1078 int retval;
1079
1da177e4
LT		 1080 usb_dev->devnum = devnum;
1081 usb_dev->bus->devnum_next = devnum + 1;
1082 memset (&usb_dev->bus->devmap.devicemap, 0,
1083 sizeof usb_dev->bus->devmap.devicemap);
1084 set_bit (devnum, usb_dev->bus->devmap.devicemap);
1085 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
1086
a4b5d606 1087 mutex_lock(&usb_bus_idr_lock);
1da177e4 1088
551509d2 1089 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
1da177e4
LT		 1090 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
1091 if (retval != sizeof usb_dev->descriptor) {
a4b5d606 1092 mutex_unlock(&usb_bus_idr_lock);
1da177e4 1093 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
7071a3ce 1094 dev_name(&usb_dev->dev), retval);
1da177e4
LT		 1095 return (retval < 0) ? retval : -EMSGSIZE;
1096 }
2d2a3167
LB		 1097
1098 if (le16_to_cpu(usb_dev->descriptor.bcdUSB) >= 0x0201) {
448b6eb1 1099 retval = usb_get_bos_descriptor(usb_dev);
2d2a3167
LB		 1100 if (!retval) {
1101 usb_dev->lpm_capable = usb_device_supports_lpm(usb_dev);
8a1b2725 1102 } else if (usb_dev->speed >= USB_SPEED_SUPER) {
a4b5d606 1103 mutex_unlock(&usb_bus_idr_lock);
448b6eb1
SS		 1104 dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
1105 dev_name(&usb_dev->dev), retval);
1106 return retval;
1107 }
1108 }
1da177e4 1109
1da177e4 1110 retval = usb_new_device (usb_dev);
1da177e4 1111 if (retval) {
1da177e4 1112 dev_err (parent_dev, "can't register root hub for %s, %d\n",
7071a3ce 1113 dev_name(&usb_dev->dev), retval);
0a231403 1114 } else {
1da177e4
LT		 1115 spin_lock_irq (&hcd_root_hub_lock);
1116 hcd->rh_registered = 1;
1117 spin_unlock_irq (&hcd_root_hub_lock);
1118
1119 /* Did the HC die before the root hub was registered? */
69fff59d 1120 if (HCD_DEAD(hcd))
1da177e4 1121 usb_hc_died (hcd); /* This time clean up */
dc5878ab 1122 usb_dev->dev.of_node = parent_dev->of_node;
1da177e4 1123 }
a4b5d606 1124 mutex_unlock(&usb_bus_idr_lock);
1da177e4
LT		 1125
1126 return retval;
1127}
1da177e4 1128
da0aa716
AS		 1129/*
1130 * usb_hcd_start_port_resume - a root-hub port is sending a resume signal
1131 * @bus: the bus which the root hub belongs to
1132 * @portnum: the port which is being resumed
1133 *
1134 * HCDs should call this function when they know that a resume signal is
1135 * being sent to a root-hub port. The root hub will be prevented from
1136 * going into autosuspend until usb_hcd_end_port_resume() is called.
1137 *
1138 * The bus's private lock must be held by the caller.
1139 */
1140void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum)
1141{
1142 unsigned bit = 1 << portnum;
1143
1144 if (!(bus->resuming_ports & bit)) {
1145 bus->resuming_ports |= bit;
1146 pm_runtime_get_noresume(&bus->root_hub->dev);
1147 }
1148}
1149EXPORT_SYMBOL_GPL(usb_hcd_start_port_resume);
1150
1151/*
1152 * usb_hcd_end_port_resume - a root-hub port has stopped sending a resume signal
1153 * @bus: the bus which the root hub belongs to
1154 * @portnum: the port which is being resumed
1155 *
1156 * HCDs should call this function when they know that a resume signal has
1157 * stopped being sent to a root-hub port. The root hub will be allowed to
1158 * autosuspend again.
1159 *
1160 * The bus's private lock must be held by the caller.
1161 */
1162void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum)
1163{
1164 unsigned bit = 1 << portnum;
1165
1166 if (bus->resuming_ports & bit) {
1167 bus->resuming_ports &= ~bit;
1168 pm_runtime_put_noidle(&bus->root_hub->dev);
1169 }
1170}
1171EXPORT_SYMBOL_GPL(usb_hcd_end_port_resume);
1da177e4
LT		 1172
1173/*-------------------------------------------------------------------------*/
1174
1175/**
1176 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1177 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1178 * @is_input: true iff the transaction sends data to the host
1179 * @isoc: true for isochronous transactions, false for interrupt ones
1180 * @bytecount: how many bytes in the transaction.
1181 *
626f090c
YB		 1182 * Return: Approximate bus time in nanoseconds for a periodic transaction.
1183 *
1184 * Note:
1da177e4
LT		 1185 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1186 * scheduled in software, this function is only used for such scheduling.
1187 */
1188long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1189{
1190 unsigned long tmp;
1191
1192 switch (speed) {
1193 case USB_SPEED_LOW: /* INTR only */
1194 if (is_input) {
1195 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
07010496 1196 return 64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1da177e4
LT		 1197 } else {
1198 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
07010496 1199 return 64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
1da177e4
LT		 1200 }
1201 case USB_SPEED_FULL: /* ISOC or INTR */
1202 if (isoc) {
1203 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
07010496 1204 return ((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp;
1da177e4
LT		 1205 } else {
1206 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
07010496 1207 return 9107L + BW_HOST_DELAY + tmp;
1da177e4
LT		 1208 }
1209 case USB_SPEED_HIGH: /* ISOC or INTR */
048cb21c 1210 /* FIXME adjust for input vs output */
1da177e4 1211 if (isoc)
498f78e6 1212 tmp = HS_NSECS_ISO (bytecount);
1da177e4 1213 else
498f78e6 1214 tmp = HS_NSECS (bytecount);
1da177e4
LT		 1215 return tmp;
1216 default:
1217 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1218 return -1;
1219 }
1220}
782e70c6 1221EXPORT_SYMBOL_GPL(usb_calc_bus_time);
1da177e4 1222
1da177e4
LT		 1223
1224/*-------------------------------------------------------------------------*/
1225
1226/*
1227 * Generic HC operations.
1228 */
1229
1230/*-------------------------------------------------------------------------*/
1231
e9df41c5
AS		 1232/**
1233 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1234 * @hcd: host controller to which @urb was submitted
1235 * @urb: URB being submitted
1236 *
1237 * Host controller drivers should call this routine in their enqueue()
1238 * method. The HCD's private spinlock must be held and interrupts must
1239 * be disabled. The actions carried out here are required for URB
1240 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1241 *
626f090c 1242 * Return: 0 for no error, otherwise a negative error code (in which case
e9df41c5
AS		 1243 * the enqueue() method must fail). If no error occurs but enqueue() fails
1244 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1245 * the private spinlock and returning.
1246 */
1247int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
1da177e4 1248{
9a9bf406 1249 int rc = 0;
1da177e4 1250
e9df41c5 1251 spin_lock(&hcd_urb_list_lock);
1da177e4 1252
9a9bf406 1253 /* Check that the URB isn't being killed */
49367d8f 1254 if (unlikely(atomic_read(&urb->reject))) {
9a9bf406
AS		 1255 rc = -EPERM;
1256 goto done;
9f6a93f7 1257 }
1da177e4 1258
9a9bf406
AS		 1259 if (unlikely(!urb->ep->enabled)) {
1260 rc = -ENOENT;
1261 goto done;
1262 }
1da177e4 1263
6840d255
AS		 1264 if (unlikely(!urb->dev->can_submit)) {
1265 rc = -EHOSTUNREACH;
1266 goto done;
1267 }
1268
1da177e4 1269 /*
9a9bf406
AS		 1270 * Check the host controller's state and add the URB to the
1271 * endpoint's queue.
1da177e4 1272 */
9b37596a 1273 if (HCD_RH_RUNNING(hcd)) {
eb231054 1274 urb->unlinked = 0;
9a9bf406 1275 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
9b37596a 1276 } else {
9a9bf406
AS		 1277 rc = -ESHUTDOWN;
1278 goto done;
1da177e4 1279 }
9a9bf406 1280 done:
e9df41c5 1281 spin_unlock(&hcd_urb_list_lock);
9a9bf406
AS		 1282 return rc;
1283}
e9df41c5 1284EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
9a9bf406 1285
e9df41c5
AS		 1286/**
1287 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1288 * @hcd: host controller to which @urb was submitted
1289 * @urb: URB being checked for unlinkability
1290 * @status: error code to store in @urb if the unlink succeeds
1291 *
1292 * Host controller drivers should call this routine in their dequeue()
1293 * method. The HCD's private spinlock must be held and interrupts must
1294 * be disabled. The actions carried out here are required for making
1295 * sure than an unlink is valid.
1296 *
626f090c 1297 * Return: 0 for no error, otherwise a negative error code (in which case
e9df41c5
AS		 1298 * the dequeue() method must fail). The possible error codes are:
1299 *
1300 * -EIDRM: @urb was not submitted or has already completed.
1301 * The completion function may not have been called yet.
1302 *
1303 * -EBUSY: @urb has already been unlinked.
1304 */
1305int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
9a9bf406
AS		 1306 int status)
1307{
9a9bf406 1308 struct list_head *tmp;
9a9bf406
AS		 1309
1310 /* insist the urb is still queued */
1311 list_for_each(tmp, &urb->ep->urb_list) {
1312 if (tmp == &urb->urb_list)
1313 break;
1314 }
e9df41c5
AS		 1315 if (tmp != &urb->urb_list)
1316 return -EIDRM;
1da177e4 1317
9a9bf406
AS		 1318 /* Any status except -EINPROGRESS means something already started to
1319 * unlink this URB from the hardware. So there's no more work to do.
1da177e4 1320 */
eb231054 1321 if (urb->unlinked)
e9df41c5 1322 return -EBUSY;
eb231054 1323 urb->unlinked = status;
e9df41c5 1324 return 0;
9a9bf406 1325}
e9df41c5 1326EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
9a9bf406 1327
e9df41c5
AS		 1328/**
1329 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1330 * @hcd: host controller to which @urb was submitted
1331 * @urb: URB being unlinked
1332 *
1333 * Host controller drivers should call this routine before calling
1334 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1335 * interrupts must be disabled. The actions carried out here are required
1336 * for URB completion.
1337 */
1338void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
9a9bf406 1339{
9a9bf406 1340 /* clear all state linking urb to this dev (and hcd) */
e9df41c5 1341 spin_lock(&hcd_urb_list_lock);
9a9bf406 1342 list_del_init(&urb->urb_list);
e9df41c5 1343 spin_unlock(&hcd_urb_list_lock);
9a9bf406 1344}
e9df41c5 1345EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
9a9bf406 1346
b3476675
MD		 1347/*
1348 * Some usb host controllers can only perform dma using a small SRAM area.
1349 * The usb core itself is however optimized for host controllers that can dma
1350 * using regular system memory - like pci devices doing bus mastering.
1351 *
a6cd244b 1352 * To support host controllers with limited dma capabilities we provide dma
b3476675
MD		 1353 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1354 * For this to work properly the host controller code must first use the
1355 * function dma_declare_coherent_memory() to point out which memory area
1356 * that should be used for dma allocations.
1357 *
1358 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1359 * dma using dma_alloc_coherent() which in turn allocates from the memory
1360 * area pointed out with dma_declare_coherent_memory().
1361 *
1362 * So, to summarize...
1363 *
1364 * - We need "local" memory, canonical example being
1365 * a small SRAM on a discrete controller being the
1366 * only memory that the controller can read ...
1367 * (a) "normal" kernel memory is no good, and
1368 * (b) there's not enough to share
1369 *
1370 * - The only *portable* hook for such stuff in the
1371 * DMA framework is dma_declare_coherent_memory()
1372 *
1373 * - So we use that, even though the primary requirement
025d4430 1374 * is that the memory be "local" (hence addressable
b3476675
MD		 1375 * by that device), not "coherent".
1376 *
1377 */
1378
1379static int hcd_alloc_coherent(struct usb_bus *bus,
1380 gfp_t mem_flags, dma_addr_t *dma_handle,
1381 void **vaddr_handle, size_t size,
1382 enum dma_data_direction dir)
1383{
1384 unsigned char *vaddr;
1385
4307a28e
AR		 1386 if (*vaddr_handle == NULL) {
1387 WARN_ON_ONCE(1);
1388 return -EFAULT;
1389 }
1390
b3476675
MD		 1391 vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1392 mem_flags, dma_handle);
1393 if (!vaddr)
1394 return -ENOMEM;
1395
1396 /*
1397 * Store the virtual address of the buffer at the end
1398 * of the allocated dma buffer. The size of the buffer
1399 * may be uneven so use unaligned functions instead
1400 * of just rounding up. It makes sense to optimize for
1401 * memory footprint over access speed since the amount
1402 * of memory available for dma may be limited.
1403 */
1404 put_unaligned((unsigned long)*vaddr_handle,
1405 (unsigned long *)(vaddr + size));
1406
1407 if (dir == DMA_TO_DEVICE)
1408 memcpy(vaddr, *vaddr_handle, size);
1409
1410 *vaddr_handle = vaddr;
1411 return 0;
1412}
1413
1414static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1415 void **vaddr_handle, size_t size,
1416 enum dma_data_direction dir)
1417{
1418 unsigned char *vaddr = *vaddr_handle;
1419
1420 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1421
1422 if (dir == DMA_FROM_DEVICE)
1423 memcpy(vaddr, *vaddr_handle, size);
1424
1425 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1426
1427 *vaddr_handle = vaddr;
1428 *dma_handle = 0;
1429}
1430
c8cf203a 1431void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
ff9c895f 1432{
58f2266f
GU		 1433 if (IS_ENABLED(CONFIG_HAS_DMA) &&
1434 (urb->transfer_flags & URB_SETUP_MAP_SINGLE))
ff9c895f
AS		 1435 dma_unmap_single(hcd->self.controller,
1436 urb->setup_dma,
1437 sizeof(struct usb_ctrlrequest),
1438 DMA_TO_DEVICE);
1439 else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1440 hcd_free_coherent(urb->dev->bus,
1441 &urb->setup_dma,
1442 (void **) &urb->setup_packet,
1443 sizeof(struct usb_ctrlrequest),
1444 DMA_TO_DEVICE);
1445
1dae423d
MF		 1446 /* Make it safe to call this routine more than once */
1447 urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1448}
c8cf203a 1449EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1dae423d 1450
2694a48d
RM		 1451static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1452{
1453 if (hcd->driver->unmap_urb_for_dma)
1454 hcd->driver->unmap_urb_for_dma(hcd, urb);
1455 else
1456 usb_hcd_unmap_urb_for_dma(hcd, urb);
1457}
1458
c8cf203a 1459void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1dae423d
MF		 1460{
1461 enum dma_data_direction dir;
1462
c8cf203a 1463 usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1dae423d 1464
ff9c895f 1465 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
58f2266f
GU		 1466 if (IS_ENABLED(CONFIG_HAS_DMA) &&
1467 (urb->transfer_flags & URB_DMA_MAP_SG))
ff9c895f 1468 dma_unmap_sg(hcd->self.controller,
910f8d0c 1469 urb->sg,
ff9c895f
AS		 1470 urb->num_sgs,
1471 dir);
58f2266f
GU		 1472 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1473 (urb->transfer_flags & URB_DMA_MAP_PAGE))
ff9c895f
AS		 1474 dma_unmap_page(hcd->self.controller,
1475 urb->transfer_dma,
1476 urb->transfer_buffer_length,
1477 dir);
58f2266f
GU		 1478 else if (IS_ENABLED(CONFIG_HAS_DMA) &&
1479 (urb->transfer_flags & URB_DMA_MAP_SINGLE))
ff9c895f
AS		 1480 dma_unmap_single(hcd->self.controller,
1481 urb->transfer_dma,
1482 urb->transfer_buffer_length,
1483 dir);
1484 else if (urb->transfer_flags & URB_MAP_LOCAL)
1485 hcd_free_coherent(urb->dev->bus,
1486 &urb->transfer_dma,
1487 &urb->transfer_buffer,
1488 urb->transfer_buffer_length,
1489 dir);
1490
1491 /* Make it safe to call this routine more than once */
1dae423d 1492 urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
ff9c895f
AS		 1493 URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1494}
c8cf203a 1495EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
ff9c895f 1496
b3476675
MD		 1497static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1498 gfp_t mem_flags)
2694a48d
RM		 1499{
1500 if (hcd->driver->map_urb_for_dma)
1501 return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1502 else
1503 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1504}
1505
1506int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1507 gfp_t mem_flags)
9a9bf406 1508{
b3476675
MD		 1509 enum dma_data_direction dir;
1510 int ret = 0;
1511
9a9bf406
AS		 1512 /* Map the URB's buffers for DMA access.
1513 * Lower level HCD code should use *_dma exclusively,
e04748e3
SS		 1514 * unless it uses pio or talks to another transport,
1515 * or uses the provided scatter gather list for bulk.
1da177e4 1516 */
b3476675 1517
85bcb5ee 1518 if (usb_endpoint_xfer_control(&urb->ep->desc)) {
07a8cdd2
AG		 1519 if (hcd->self.uses_pio_for_control)
1520 return ret;
58f2266f 1521 if (IS_ENABLED(CONFIG_HAS_DMA) && hcd->self.uses_dma) {
b3476675 1522 urb->setup_dma = dma_map_single(
1da177e4
LT		 1523 hcd->self.controller,
1524 urb->setup_packet,
b3476675 1525 sizeof(struct usb_ctrlrequest),
1da177e4 1526 DMA_TO_DEVICE);
85e034fd
LF		 1527 if (dma_mapping_error(hcd->self.controller,
1528 urb->setup_dma))
1529 return -EAGAIN;
ff9c895f 1530 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
f537da68 1531 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
b3476675
MD		 1532 ret = hcd_alloc_coherent(
1533 urb->dev->bus, mem_flags,
1534 &urb->setup_dma,
1535 (void **)&urb->setup_packet,
1536 sizeof(struct usb_ctrlrequest),
1537 DMA_TO_DEVICE);
ff9c895f
AS		 1538 if (ret)
1539 return ret;
1540 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
f537da68 1541 }
b3476675
MD		 1542 }
1543
1544 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
ff9c895f 1545 if (urb->transfer_buffer_length != 0
b3476675 1546 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
58f2266f 1547 if (IS_ENABLED(CONFIG_HAS_DMA) && hcd->self.uses_dma) {
ff9c895f 1548 if (urb->num_sgs) {
fe2072cc
HG		 1549 int n;
1550
1551 /* We don't support sg for isoc transfers ! */
1552 if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1553 WARN_ON(1);
1554 return -EINVAL;
1555 }
1556
1557 n = dma_map_sg(
ff9c895f 1558 hcd->self.controller,
910f8d0c 1559 urb->sg,
ff9c895f
AS		 1560 urb->num_sgs,
1561 dir);
1562 if (n <= 0)
1563 ret = -EAGAIN;
1564 else
1565 urb->transfer_flags |= URB_DMA_MAP_SG;
bc677d5b
CL		 1566 urb->num_mapped_sgs = n;
1567 if (n != urb->num_sgs)
ff9c895f
AS		 1568 urb->transfer_flags |=
1569 URB_DMA_SG_COMBINED;
ff9c895f 1570 } else if (urb->sg) {
910f8d0c 1571 struct scatterlist *sg = urb->sg;
ff9c895f
AS		 1572 urb->transfer_dma = dma_map_page(
1573 hcd->self.controller,
1574 sg_page(sg),
1575 sg->offset,
1576 urb->transfer_buffer_length,
1577 dir);
1578 if (dma_mapping_error(hcd->self.controller,
85e034fd 1579 urb->transfer_dma))
ff9c895f
AS		 1580 ret = -EAGAIN;
1581 else
1582 urb->transfer_flags |= URB_DMA_MAP_PAGE;
29d2fef8
DW		 1583 } else if (is_vmalloc_addr(urb->transfer_buffer)) {
1584 WARN_ONCE(1, "transfer buffer not dma capable\n");
1585 ret = -EAGAIN;
ff9c895f
AS		 1586 } else {
1587 urb->transfer_dma = dma_map_single(
1588 hcd->self.controller,
1589 urb->transfer_buffer,
1590 urb->transfer_buffer_length,
1591 dir);
1592 if (dma_mapping_error(hcd->self.controller,
1593 urb->transfer_dma))
1594 ret = -EAGAIN;
1595 else
1596 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1597 }
85e034fd 1598 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
b3476675
MD		 1599 ret = hcd_alloc_coherent(
1600 urb->dev->bus, mem_flags,
1601 &urb->transfer_dma,
1602 &urb->transfer_buffer,
1603 urb->transfer_buffer_length,
1604 dir);
ff9c895f
AS		 1605 if (ret == 0)
1606 urb->transfer_flags |= URB_MAP_LOCAL;
b3476675 1607 }
ff9c895f
AS		 1608 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1609 URB_SETUP_MAP_LOCAL)))
c8cf203a 1610 usb_hcd_unmap_urb_for_dma(hcd, urb);
1da177e4 1611 }
b3476675 1612 return ret;
9a9bf406 1613}
2694a48d 1614EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
1da177e4 1615
9a9bf406
AS		 1616/*-------------------------------------------------------------------------*/
1617
1618/* may be called in any context with a valid urb->dev usecount
1619 * caller surrenders "ownership" of urb
1620 * expects usb_submit_urb() to have sanity checked and conditioned all
1621 * inputs in the urb
1622 */
1623int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1624{
1625 int status;
1626 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1627
1628 /* increment urb's reference count as part of giving it to the HCD
1629 * (which will control it). HCD guarantees that it either returns
1630 * an error or calls giveback(), but not both.
1631 */
1632 usb_get_urb(urb);
1633 atomic_inc(&urb->use_count);
4d59d8a1 1634 atomic_inc(&urb->dev->urbnum);
9a9bf406
AS		 1635 usbmon_urb_submit(&hcd->self, urb);
1636
1637 /* NOTE requirements on root-hub callers (usbfs and the hub
1638 * driver, for now): URBs' urb->transfer_buffer must be
1639 * valid and usb_buffer_{sync,unmap}() not be needed, since
1640 * they could clobber root hub response data. Also, control
1641 * URBs must be submitted in process context with interrupts
1642 * enabled.
1643 */
b3476675 1644
ff9c895f 1645 if (is_root_hub(urb->dev)) {
e9df41c5 1646 status = rh_urb_enqueue(hcd, urb);
ff9c895f
AS		 1647 } else {
1648 status = map_urb_for_dma(hcd, urb, mem_flags);
1649 if (likely(status == 0)) {
1650 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1651 if (unlikely(status))
2694a48d 1652 unmap_urb_for_dma(hcd, urb);
ff9c895f
AS		 1653 }
1654 }
9a9bf406
AS		 1655
1656 if (unlikely(status)) {
1da177e4 1657 usbmon_urb_submit_error(&hcd->self, urb, status);
b0d9efba 1658 urb->hcpriv = NULL;
9a9bf406
AS		 1659 INIT_LIST_HEAD(&urb->urb_list);
1660 atomic_dec(&urb->use_count);
4d59d8a1 1661 atomic_dec(&urb->dev->urbnum);
49367d8f 1662 if (atomic_read(&urb->reject))
9a9bf406
AS		 1663 wake_up(&usb_kill_urb_queue);
1664 usb_put_urb(urb);
1da177e4
LT		 1665 }
1666 return status;
1667}
1668
1669/*-------------------------------------------------------------------------*/
1670
1da177e4
LT		 1671/* this makes the hcd giveback() the urb more quickly, by kicking it
1672 * off hardware queues (which may take a while) and returning it as
1673 * soon as practical. we've already set up the urb's return status,
1674 * but we can't know if the callback completed already.
1675 */
e9df41c5 1676static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
1da177e4
LT		 1677{
1678 int value;
1679
809a58b8 1680 if (is_root_hub(urb->dev))
e9df41c5 1681 value = usb_rh_urb_dequeue(hcd, urb, status);
1da177e4
LT		 1682 else {
1683
1684 /* The only reason an HCD might fail this call is if
1685 * it has not yet fully queued the urb to begin with.
1686 * Such failures should be harmless. */
e9df41c5 1687 value = hcd->driver->urb_dequeue(hcd, urb, status);
1da177e4 1688 }
1da177e4
LT		 1689 return value;
1690}
1691
1692/*
1693 * called in any context
1694 *
1695 * caller guarantees urb won't be recycled till both unlink()
1696 * and the urb's completion function return
1697 */
a6d2bb9f 1698int usb_hcd_unlink_urb (struct urb *urb, int status)
1da177e4 1699{
9a9bf406 1700 struct usb_hcd *hcd;
c9919790 1701 struct usb_device *udev = urb->dev;
cde217a5
AS		 1702 int retval = -EIDRM;
1703 unsigned long flags;
1da177e4 1704
cde217a5
AS		 1705 /* Prevent the device and bus from going away while
1706 * the unlink is carried out. If they are already gone
1707 * then urb->use_count must be 0, since disconnected
1708 * devices can't have any active URBs.
1709 */
1710 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1711 if (atomic_read(&urb->use_count) > 0) {
1712 retval = 0;
c9919790 1713 usb_get_dev(udev);
cde217a5
AS		 1714 }
1715 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1716 if (retval == 0) {
1717 hcd = bus_to_hcd(urb->dev->bus);
1718 retval = unlink1(hcd, urb, status);
c9919790
AS		 1719 if (retval == 0)
1720 retval = -EINPROGRESS;
1721 else if (retval != -EIDRM && retval != -EBUSY)
1722 dev_dbg(&udev->dev, "hcd_unlink_urb %p fail %d\n",
1723 urb, retval);
1724 usb_put_dev(udev);
cde217a5 1725 }
1da177e4
LT		 1726 return retval;
1727}
1728
1729/*-------------------------------------------------------------------------*/
1730
94dfd7ed
ML		 1731static void __usb_hcd_giveback_urb(struct urb *urb)
1732{
1733 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
6ec4147e 1734 struct usb_anchor *anchor = urb->anchor;
94dfd7ed
ML		 1735 int status = urb->unlinked;
1736 unsigned long flags;
1737
1738 urb->hcpriv = NULL;
1739 if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1740 urb->actual_length < urb->transfer_buffer_length &&
1741 !status))
1742 status = -EREMOTEIO;
1743
1744 unmap_urb_for_dma(hcd, urb);
1745 usbmon_urb_complete(&hcd->self, urb, status);
6ec4147e 1746 usb_anchor_suspend_wakeups(anchor);
94dfd7ed 1747 usb_unanchor_urb(urb);
0cfbd328
MS		 1748 if (likely(status == 0))
1749 usb_led_activity(USB_LED_EVENT_HOST);
94dfd7ed
ML		 1750
1751 /* pass ownership to the completion handler */
1752 urb->status = status;
1753
1754 /*
1755 * We disable local IRQs here avoid possible deadlock because
1756 * drivers may call spin_lock() to hold lock which might be
1757 * acquired in one hard interrupt handler.
1758 *
1759 * The local_irq_save()/local_irq_restore() around complete()
1760 * will be removed if current USB drivers have been cleaned up
1761 * and no one may trigger the above deadlock situation when
1762 * running complete() in tasklet.
1763 */
1764 local_irq_save(flags);
1765 urb->complete(urb);
1766 local_irq_restore(flags);
1767
6ec4147e 1768 usb_anchor_resume_wakeups(anchor);
94dfd7ed
ML		 1769 atomic_dec(&urb->use_count);
1770 if (unlikely(atomic_read(&urb->reject)))
1771 wake_up(&usb_kill_urb_queue);
1772 usb_put_urb(urb);
1773}
1774
1775static void usb_giveback_urb_bh(unsigned long param)
1776{
1777 struct giveback_urb_bh *bh = (struct giveback_urb_bh *)param;
1778 struct list_head local_list;
1779
1780 spin_lock_irq(&bh->lock);
1781 bh->running = true;
1782 restart:
1783 list_replace_init(&bh->head, &local_list);
1784 spin_unlock_irq(&bh->lock);
1785
1786 while (!list_empty(&local_list)) {
1787 struct urb *urb;
1788
1789 urb = list_entry(local_list.next, struct urb, urb_list);
1790 list_del_init(&urb->urb_list);
c7ccde6e 1791 bh->completing_ep = urb->ep;
94dfd7ed 1792 __usb_hcd_giveback_urb(urb);
c7ccde6e 1793 bh->completing_ep = NULL;
94dfd7ed
ML		 1794 }
1795
1796 /* check if there are new URBs to giveback */
1797 spin_lock_irq(&bh->lock);
1798 if (!list_empty(&bh->head))
1799 goto restart;
1800 bh->running = false;
1801 spin_unlock_irq(&bh->lock);
1802}
1803
32aca560
AS		 1804/**
1805 * usb_hcd_giveback_urb - return URB from HCD to device driver
1806 * @hcd: host controller returning the URB
1807 * @urb: urb being returned to the USB device driver.
4a00027d 1808 * @status: completion status code for the URB.
32aca560
AS		 1809 * Context: in_interrupt()
1810 *
1811 * This hands the URB from HCD to its USB device driver, using its
1812 * completion function. The HCD has freed all per-urb resources
1813 * (and is done using urb->hcpriv). It also released all HCD locks;
1814 * the device driver won't cause problems if it frees, modifies,
1815 * or resubmits this URB.
eb231054 1816 *
4a00027d 1817 * If @urb was unlinked, the value of @status will be overridden by
eb231054
AS		 1818 * @urb->unlinked. Erroneous short transfers are detected in case
1819 * the HCD hasn't checked for them.
32aca560 1820 */
4a00027d 1821void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
32aca560 1822{
94dfd7ed
ML		 1823 struct giveback_urb_bh *bh;
1824 bool running, high_prio_bh;
32aca560 1825
94dfd7ed
ML		 1826 /* pass status to tasklet via unlinked */
1827 if (likely(!urb->unlinked))
1828 urb->unlinked = status;
1f5a3d0f 1829
94dfd7ed
ML		 1830 if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
1831 __usb_hcd_giveback_urb(urb);
1832 return;
1833 }
1834
1835 if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe)) {
1836 bh = &hcd->high_prio_bh;
1837 high_prio_bh = true;
1838 } else {
1839 bh = &hcd->low_prio_bh;
1840 high_prio_bh = false;
1841 }
1842
1843 spin_lock(&bh->lock);
1844 list_add_tail(&urb->urb_list, &bh->head);
1845 running = bh->running;
1846 spin_unlock(&bh->lock);
1847
1848 if (running)
1849 ;
1850 else if (high_prio_bh)
1851 tasklet_hi_schedule(&bh->bh);
1852 else
1853 tasklet_schedule(&bh->bh);
32aca560 1854}
782e70c6 1855EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
32aca560
AS		 1856
1857/*-------------------------------------------------------------------------*/
1858
95cf82f9
AS		 1859/* Cancel all URBs pending on this endpoint and wait for the endpoint's
1860 * queue to drain completely. The caller must first insure that no more
1861 * URBs can be submitted for this endpoint.
1da177e4 1862 */
95cf82f9 1863void usb_hcd_flush_endpoint(struct usb_device *udev,
a6d2bb9f 1864 struct usb_host_endpoint *ep)
1da177e4
LT		 1865{
1866 struct usb_hcd *hcd;
1867 struct urb *urb;
1868
95cf82f9
AS		 1869 if (!ep)
1870 return;
9a9bf406 1871 might_sleep();
17200583 1872 hcd = bus_to_hcd(udev->bus);
1da177e4 1873
95cf82f9 1874 /* No more submits can occur */
9a9bf406 1875 spin_lock_irq(&hcd_urb_list_lock);
ddc1fd6a 1876rescan:
1da177e4 1877 list_for_each_entry (urb, &ep->urb_list, urb_list) {
5e60a161 1878 int is_in;
1da177e4 1879
eb231054 1880 if (urb->unlinked)
1da177e4
LT		 1881 continue;
1882 usb_get_urb (urb);
5e60a161 1883 is_in = usb_urb_dir_in(urb);
809a58b8 1884 spin_unlock(&hcd_urb_list_lock);
1da177e4 1885
e9df41c5
AS		 1886 /* kick hcd */
1887 unlink1(hcd, urb, -ESHUTDOWN);
1888 dev_dbg (hcd->self.controller,
1889 "shutdown urb %p ep%d%s%s\n",
1890 urb, usb_endpoint_num(&ep->desc),
1891 is_in ? "in" : "out",
1892 ({ char *s;
1893
1894 switch (usb_endpoint_type(&ep->desc)) {
1895 case USB_ENDPOINT_XFER_CONTROL:
1896 s = ""; break;
1897 case USB_ENDPOINT_XFER_BULK:
1898 s = "-bulk"; break;
1899 case USB_ENDPOINT_XFER_INT:
1900 s = "-intr"; break;
1901 default:
14557359 1902 s = "-iso"; break;
e9df41c5
AS		 1903 };
1904 s;
1905 }));
1da177e4
LT		 1906 usb_put_urb (urb);
1907
1908 /* list contents may have changed */
ddc1fd6a 1909 spin_lock(&hcd_urb_list_lock);
1da177e4
LT		 1910 goto rescan;
1911 }
9a9bf406 1912 spin_unlock_irq(&hcd_urb_list_lock);
1da177e4 1913
95cf82f9 1914 /* Wait until the endpoint queue is completely empty */
455b25fb 1915 while (!list_empty (&ep->urb_list)) {
809a58b8 1916 spin_lock_irq(&hcd_urb_list_lock);
455b25fb
AS		 1917
1918 /* The list may have changed while we acquired the spinlock */
1919 urb = NULL;
1920 if (!list_empty (&ep->urb_list)) {
1921 urb = list_entry (ep->urb_list.prev, struct urb,
1922 urb_list);
1923 usb_get_urb (urb);
1924 }
809a58b8 1925 spin_unlock_irq(&hcd_urb_list_lock);
455b25fb
AS		 1926
1927 if (urb) {
1928 usb_kill_urb (urb);
1929 usb_put_urb (urb);
1930 }
1931 }
1da177e4
LT		 1932}
1933
3f0479e0 1934/**
70445ae6
RD		 1935 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1936 * the bus bandwidth
1937 * @udev: target &usb_device
3f0479e0
SS		 1938 * @new_config: new configuration to install
1939 * @cur_alt: the current alternate interface setting
1940 * @new_alt: alternate interface setting that is being installed
1941 *
1942 * To change configurations, pass in the new configuration in new_config,
1943 * and pass NULL for cur_alt and new_alt.
1944 *
1945 * To reset a device's configuration (put the device in the ADDRESSED state),
1946 * pass in NULL for new_config, cur_alt, and new_alt.
1947 *
1948 * To change alternate interface settings, pass in NULL for new_config,
1949 * pass in the current alternate interface setting in cur_alt,
1950 * and pass in the new alternate interface setting in new_alt.
1951 *
626f090c 1952 * Return: An error if the requested bandwidth change exceeds the
3f0479e0 1953 * bus bandwidth or host controller internal resources.
79abb1ab 1954 */
3f0479e0 1955int usb_hcd_alloc_bandwidth(struct usb_device *udev,
79abb1ab 1956 struct usb_host_config *new_config,
3f0479e0
SS		 1957 struct usb_host_interface *cur_alt,
1958 struct usb_host_interface *new_alt)
79abb1ab
SS		 1959{
1960 int num_intfs, i, j;
576a362a 1961 struct usb_host_interface *alt = NULL;
79abb1ab
SS		 1962 int ret = 0;
1963 struct usb_hcd *hcd;
1964 struct usb_host_endpoint *ep;
1965
1966 hcd = bus_to_hcd(udev->bus);
1967 if (!hcd->driver->check_bandwidth)
1968 return 0;
1969
1970 /* Configuration is being removed - set configuration 0 */
3f0479e0 1971 if (!new_config && !cur_alt) {
79abb1ab
SS		 1972 for (i = 1; i < 16; ++i) {
1973 ep = udev->ep_out[i];
1974 if (ep)
1975 hcd->driver->drop_endpoint(hcd, udev, ep);
1976 ep = udev->ep_in[i];
1977 if (ep)
1978 hcd->driver->drop_endpoint(hcd, udev, ep);
1979 }
1980 hcd->driver->check_bandwidth(hcd, udev);
1981 return 0;
1982 }
1983 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1984 * each interface's alt setting 0 and ask the HCD to check the bandwidth
1985 * of the bus. There will always be bandwidth for endpoint 0, so it's
1986 * ok to exclude it.
1987 */
1988 if (new_config) {
1989 num_intfs = new_config->desc.bNumInterfaces;
1990 /* Remove endpoints (except endpoint 0, which is always on the
1991 * schedule) from the old config from the schedule
1992 */
1993 for (i = 1; i < 16; ++i) {
1994 ep = udev->ep_out[i];
1995 if (ep) {
1996 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1997 if (ret < 0)
1998 goto reset;
1999 }
2000 ep = udev->ep_in[i];
2001 if (ep) {
2002 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
2003 if (ret < 0)
2004 goto reset;
2005 }
2006 }
2007 for (i = 0; i < num_intfs; ++i) {
d837e219
SS		 2008 struct usb_host_interface *first_alt;
2009 int iface_num;
2010
2011 first_alt = &new_config->intf_cache[i]->altsetting[0];
2012 iface_num = first_alt->desc.bInterfaceNumber;
91017f9c 2013 /* Set up endpoints for alternate interface setting 0 */
d837e219 2014 alt = usb_find_alt_setting(new_config, iface_num, 0);
3f0479e0
SS		 2015 if (!alt)
2016 /* No alt setting 0? Pick the first setting. */
d837e219 2017 alt = first_alt;
3f0479e0 2018
79abb1ab
SS		 2019 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
2020 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
2021 if (ret < 0)
2022 goto reset;
2023 }
2024 }
2025 }
3f0479e0 2026 if (cur_alt && new_alt) {
04a723ea
SS		 2027 struct usb_interface *iface = usb_ifnum_to_if(udev,
2028 cur_alt->desc.bInterfaceNumber);
2029
8a9af4fd
SS		 2030 if (!iface)
2031 return -EINVAL;
04a723ea
SS		 2032 if (iface->resetting_device) {
2033 /*
2034 * The USB core just reset the device, so the xHCI host
2035 * and the device will think alt setting 0 is installed.
2036 * However, the USB core will pass in the alternate
2037 * setting installed before the reset as cur_alt. Dig
2038 * out the alternate setting 0 structure, or the first
2039 * alternate setting if a broken device doesn't have alt
2040 * setting 0.
2041 */
2042 cur_alt = usb_altnum_to_altsetting(iface, 0);
2043 if (!cur_alt)
2044 cur_alt = &iface->altsetting[0];
2045 }
2046
3f0479e0
SS		 2047 /* Drop all the endpoints in the current alt setting */
2048 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
2049 ret = hcd->driver->drop_endpoint(hcd, udev,
2050 &cur_alt->endpoint[i]);
2051 if (ret < 0)
2052 goto reset;
2053 }
2054 /* Add all the endpoints in the new alt setting */
2055 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
2056 ret = hcd->driver->add_endpoint(hcd, udev,
2057 &new_alt->endpoint[i]);
2058 if (ret < 0)
2059 goto reset;
2060 }
2061 }
79abb1ab
SS		 2062 ret = hcd->driver->check_bandwidth(hcd, udev);
2063reset:
2064 if (ret < 0)
2065 hcd->driver->reset_bandwidth(hcd, udev);
2066 return ret;
2067}
2068
95cf82f9
AS		 2069/* Disables the endpoint: synchronizes with the hcd to make sure all
2070 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
2071 * have been called previously. Use for set_configuration, set_interface,
2072 * driver removal, physical disconnect.
2073 *
2074 * example: a qh stored in ep->hcpriv, holding state related to endpoint
2075 * type, maxpacket size, toggle, halt status, and scheduling.
2076 */
2077void usb_hcd_disable_endpoint(struct usb_device *udev,
2078 struct usb_host_endpoint *ep)
2079{
2080 struct usb_hcd *hcd;
2081
2082 might_sleep();
2083 hcd = bus_to_hcd(udev->bus);
2084 if (hcd->driver->endpoint_disable)
2085 hcd->driver->endpoint_disable(hcd, ep);
2086}
2087
3444b26a
DV		 2088/**
2089 * usb_hcd_reset_endpoint - reset host endpoint state
2090 * @udev: USB device.
2091 * @ep: the endpoint to reset.
2092 *
2093 * Resets any host endpoint state such as the toggle bit, sequence
2094 * number and current window.
2095 */
2096void usb_hcd_reset_endpoint(struct usb_device *udev,
2097 struct usb_host_endpoint *ep)
2098{
2099 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2100
2101 if (hcd->driver->endpoint_reset)
2102 hcd->driver->endpoint_reset(hcd, ep);
2103 else {
2104 int epnum = usb_endpoint_num(&ep->desc);
2105 int is_out = usb_endpoint_dir_out(&ep->desc);
2106 int is_control = usb_endpoint_xfer_control(&ep->desc);
2107
2108 usb_settoggle(udev, epnum, is_out, 0);
2109 if (is_control)
2110 usb_settoggle(udev, epnum, !is_out, 0);
2111 }
2112}
2113
eab1cafc
SS		 2114/**
2115 * usb_alloc_streams - allocate bulk endpoint stream IDs.
2116 * @interface: alternate setting that includes all endpoints.
2117 * @eps: array of endpoints that need streams.
2118 * @num_eps: number of endpoints in the array.
2119 * @num_streams: number of streams to allocate.
2120 * @mem_flags: flags hcd should use to allocate memory.
2121 *
626f090c 2122 * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
eab1cafc
SS		 2123 * Drivers may queue multiple transfers to different stream IDs, which may
2124 * complete in a different order than they were queued.
626f090c
YB		 2125 *
2126 * Return: On success, the number of allocated streams. On failure, a negative
2127 * error code.
eab1cafc
SS		 2128 */
2129int usb_alloc_streams(struct usb_interface *interface,
2130 struct usb_host_endpoint **eps, unsigned int num_eps,
2131 unsigned int num_streams, gfp_t mem_flags)
2132{
2133 struct usb_hcd *hcd;
2134 struct usb_device *dev;
8d4f70b2 2135 int i, ret;
eab1cafc
SS		 2136
2137 dev = interface_to_usbdev(interface);
2138 hcd = bus_to_hcd(dev->bus);
2139 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
2140 return -EINVAL;
8a1b2725 2141 if (dev->speed < USB_SPEED_SUPER)
eab1cafc 2142 return -EINVAL;
90a646c7
HG		 2143 if (dev->state < USB_STATE_CONFIGURED)
2144 return -ENODEV;
eab1cafc 2145
8d4f70b2
HG		 2146 for (i = 0; i < num_eps; i++) {
2147 /* Streams only apply to bulk endpoints. */
eab1cafc
SS		 2148 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
2149 return -EINVAL;
8d4f70b2
HG		 2150 /* Re-alloc is not allowed */
2151 if (eps[i]->streams)
2152 return -EINVAL;
2153 }
eab1cafc 2154
8d4f70b2 2155 ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
eab1cafc 2156 num_streams, mem_flags);
8d4f70b2
HG		 2157 if (ret < 0)
2158 return ret;
2159
2160 for (i = 0; i < num_eps; i++)
2161 eps[i]->streams = ret;
2162
2163 return ret;
eab1cafc
SS		 2164}
2165EXPORT_SYMBOL_GPL(usb_alloc_streams);
2166
2167/**
2168 * usb_free_streams - free bulk endpoint stream IDs.
2169 * @interface: alternate setting that includes all endpoints.
2170 * @eps: array of endpoints to remove streams from.
2171 * @num_eps: number of endpoints in the array.
2172 * @mem_flags: flags hcd should use to allocate memory.
2173 *
2174 * Reverts a group of bulk endpoints back to not using stream IDs.
2175 * Can fail if we are given bad arguments, or HCD is broken.
6c74dada 2176 *
12d4bbce 2177 * Return: 0 on success. On failure, a negative error code.
eab1cafc 2178 */
6c74dada 2179int usb_free_streams(struct usb_interface *interface,
eab1cafc
SS		 2180 struct usb_host_endpoint **eps, unsigned int num_eps,
2181 gfp_t mem_flags)
2182{
2183 struct usb_hcd *hcd;
2184 struct usb_device *dev;
8d4f70b2 2185 int i, ret;
eab1cafc
SS		 2186
2187 dev = interface_to_usbdev(interface);
2188 hcd = bus_to_hcd(dev->bus);
8a1b2725 2189 if (dev->speed < USB_SPEED_SUPER)
6c74dada 2190 return -EINVAL;
eab1cafc 2191
8d4f70b2 2192 /* Double-free is not allowed */
eab1cafc 2193 for (i = 0; i < num_eps; i++)
8d4f70b2 2194 if (!eps[i] || !eps[i]->streams)
6c74dada 2195 return -EINVAL;
eab1cafc 2196
8d4f70b2
HG		 2197 ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2198 if (ret < 0)
2199 return ret;
2200
2201 for (i = 0; i < num_eps; i++)
2202 eps[i]->streams = 0;
2203
2204 return ret;
eab1cafc
SS		 2205}
2206EXPORT_SYMBOL_GPL(usb_free_streams);
2207
cde217a5
AS		 2208/* Protect against drivers that try to unlink URBs after the device
2209 * is gone, by waiting until all unlinks for @udev are finished.
2210 * Since we don't currently track URBs by device, simply wait until
2211 * nothing is running in the locked region of usb_hcd_unlink_urb().
2212 */
2213void usb_hcd_synchronize_unlinks(struct usb_device *udev)
2214{
2215 spin_lock_irq(&hcd_urb_unlink_lock);
2216 spin_unlock_irq(&hcd_urb_unlink_lock);
2217}
2218
1da177e4
LT		 2219/*-------------------------------------------------------------------------*/
2220
32aca560
AS		 2221/* called in any context */
2222int usb_hcd_get_frame_number (struct usb_device *udev)
2223{
2224 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2225
9b37596a 2226 if (!HCD_RH_RUNNING(hcd))
32aca560
AS		 2227 return -ESHUTDOWN;
2228 return hcd->driver->get_frame_number (hcd);
2229}
2230
2231/*-------------------------------------------------------------------------*/
2232
9293677a 2233#ifdef CONFIG_PM
1da177e4 2234
65bfd296 2235int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
1da177e4 2236{
6ae706ae 2237 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
686314cf
AS		 2238 int status;
2239 int old_state = hcd->state;
1da177e4 2240
30b1a7a3
AS		 2241 dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2242 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2243 rhdev->do_remote_wakeup);
9b37596a
AS		 2244 if (HCD_DEAD(hcd)) {
2245 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2246 return 0;
2247 }
2248
686314cf
AS		 2249 if (!hcd->driver->bus_suspend) {
2250 status = -ENOENT;
2251 } else {
9b37596a 2252 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
686314cf
AS		 2253 hcd->state = HC_STATE_QUIESCING;
2254 status = hcd->driver->bus_suspend(hcd);
2255 }
2256 if (status == 0) {
2257 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
9293677a 2258 hcd->state = HC_STATE_SUSPENDED;
879d38e6
AS		 2259
2260 /* Did we race with a root-hub wakeup event? */
2261 if (rhdev->do_remote_wakeup) {
2262 char buffer[6];
2263
2264 status = hcd->driver->hub_status_data(hcd, buffer);
2265 if (status != 0) {
2266 dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2267 hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2268 status = -EBUSY;
2269 }
2270 }
686314cf 2271 } else {
9b37596a
AS		 2272 spin_lock_irq(&hcd_root_hub_lock);
2273 if (!HCD_DEAD(hcd)) {
2274 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2275 hcd->state = old_state;
2276 }
2277 spin_unlock_irq(&hcd_root_hub_lock);
686314cf 2278 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
9293677a 2279 "suspend", status);
686314cf 2280 }
9293677a 2281 return status;
1da177e4
LT		 2282}
2283
65bfd296 2284int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
1da177e4 2285{
6ae706ae 2286 struct usb_hcd *hcd = bus_to_hcd(rhdev->bus);
686314cf 2287 int status;
cfa59dab 2288 int old_state = hcd->state;
1da177e4 2289
30b1a7a3
AS		 2290 dev_dbg(&rhdev->dev, "usb %sresume\n",
2291 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
9b37596a
AS		 2292 if (HCD_DEAD(hcd)) {
2293 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2294 return 0;
2295 }
0c0382e3 2296 if (!hcd->driver->bus_resume)
9293677a 2297 return -ENOENT;
9b37596a 2298 if (HCD_RH_RUNNING(hcd))
979d5199 2299 return 0;
686314cf 2300
9293677a 2301 hcd->state = HC_STATE_RESUMING;
686314cf 2302 status = hcd->driver->bus_resume(hcd);
bf3d7d40 2303 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
686314cf 2304 if (status == 0) {
bfd1e910
AS		 2305 struct usb_device *udev;
2306 int port1;
2307
9b37596a
AS		 2308 spin_lock_irq(&hcd_root_hub_lock);
2309 if (!HCD_DEAD(hcd)) {
2310 usb_set_device_state(rhdev, rhdev->actconfig
2311 ? USB_STATE_CONFIGURED
2312 : USB_STATE_ADDRESS);
2313 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2314 hcd->state = HC_STATE_RUNNING;
2315 }
2316 spin_unlock_irq(&hcd_root_hub_lock);
bfd1e910
AS		 2317
2318 /*
2319 * Check whether any of the enabled ports on the root hub are
2320 * unsuspended. If they are then a TRSMRCY delay is needed
2321 * (this is what the USB-2 spec calls a "global resume").
2322 * Otherwise we can skip the delay.
2323 */
2324 usb_hub_for_each_child(rhdev, port1, udev) {
2325 if (udev->state != USB_STATE_NOTATTACHED &&
2326 !udev->port_is_suspended) {
2327 usleep_range(10000, 11000); /* TRSMRCY */
2328 break;
2329 }
2330 }
686314cf 2331 } else {
cfa59dab 2332 hcd->state = old_state;
686314cf 2333 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
9293677a 2334 "resume", status);
cfa59dab
AS		 2335 if (status != -ESHUTDOWN)
2336 usb_hc_died(hcd);
9293677a
DB		 2337 }
2338 return status;
1da177e4
LT		 2339}
2340
6b157c9b
AS		 2341/* Workqueue routine for root-hub remote wakeup */
2342static void hcd_resume_work(struct work_struct *work)
2343{
2344 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2345 struct usb_device *udev = hcd->self.root_hub;
2346
0534d468 2347 usb_remote_wakeup(udev);
6b157c9b
AS		 2348}
2349
1da177e4 2350/**
14557359 2351 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1da177e4
LT		 2352 * @hcd: host controller for this root hub
2353 *
2354 * The USB host controller calls this function when its root hub is
2355 * suspended (with the remote wakeup feature enabled) and a remote
6b157c9b
AS		 2356 * wakeup request is received. The routine submits a workqueue request
2357 * to resume the root hub (that is, manage its downstream ports again).
1da177e4
LT		 2358 */
2359void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2360{
2361 unsigned long flags;
2362
2363 spin_lock_irqsave (&hcd_root_hub_lock, flags);
ff2f0787
AS		 2364 if (hcd->rh_registered) {
2365 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
9bbdf1e0 2366 queue_work(pm_wq, &hcd->wakeup_work);
ff2f0787 2367 }
1da177e4
LT		 2368 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2369}
9293677a 2370EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
1da177e4 2371
ceb6c9c8 2372#endif /* CONFIG_PM */
1da177e4
LT		 2373
2374/*-------------------------------------------------------------------------*/
2375
2376#ifdef CONFIG_USB_OTG
2377
2378/**
2379 * usb_bus_start_enum - start immediate enumeration (for OTG)
2380 * @bus: the bus (must use hcd framework)
2381 * @port_num: 1-based number of port; usually bus->otg_port
2382 * Context: in_interrupt()
2383 *
2384 * Starts enumeration, with an immediate reset followed later by
37ebb549 2385 * hub_wq identifying and possibly configuring the device.
1da177e4
LT		 2386 * This is needed by OTG controller drivers, where it helps meet
2387 * HNP protocol timing requirements for starting a port reset.
626f090c
YB		 2388 *
2389 * Return: 0 if successful.
1da177e4
LT		 2390 */
2391int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2392{
2393 struct usb_hcd *hcd;
2394 int status = -EOPNOTSUPP;
2395
2396 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2397 * boards with root hubs hooked up to internal devices (instead of
2398 * just the OTG port) may need more attention to resetting...
2399 */
6ae706ae 2400 hcd = bus_to_hcd(bus);
1da177e4
LT		 2401 if (port_num && hcd->driver->start_port_reset)
2402 status = hcd->driver->start_port_reset(hcd, port_num);
2403
37ebb549 2404 /* allocate hub_wq shortly after (first) root port reset finishes;
1da177e4
LT		 2405 * it may issue others, until at least 50 msecs have passed.
2406 */
2407 if (status == 0)
2408 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2409 return status;
2410}
782e70c6 2411EXPORT_SYMBOL_GPL(usb_bus_start_enum);
1da177e4
LT		 2412
2413#endif
2414
2415/*-------------------------------------------------------------------------*/
2416
1da177e4
LT		 2417/**
2418 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2419 * @irq: the IRQ being raised
2420 * @__hcd: pointer to the HCD whose IRQ is being signaled
1da177e4
LT		 2421 *
2422 * If the controller isn't HALTed, calls the driver's irq handler.
2423 * Checks whether the controller is now dead.
626f090c
YB		 2424 *
2425 * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
1da177e4 2426 */
7d12e780 2427irqreturn_t usb_hcd_irq (int irq, void *__hcd)
1da177e4
LT		 2428{
2429 struct usb_hcd *hcd = __hcd;
de85422b 2430 irqreturn_t rc;
1da177e4 2431
968b822c 2432 if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
de85422b 2433 rc = IRQ_NONE;
968b822c 2434 else if (hcd->driver->irq(hcd) == IRQ_NONE)
de85422b 2435 rc = IRQ_NONE;
968b822c 2436 else
de85422b 2437 rc = IRQ_HANDLED;
de85422b 2438
de85422b 2439 return rc;
1da177e4 2440}
43b86af8 2441EXPORT_SYMBOL_GPL(usb_hcd_irq);
1da177e4
LT		 2442
2443/*-------------------------------------------------------------------------*/
2444
2445/**
2446 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2447 * @hcd: pointer to the HCD representing the controller
2448 *
2449 * This is called by bus glue to report a USB host controller that died
2450 * while operations may still have been pending. It's called automatically
c5635437
SS		 2451 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2452 *
2453 * Only call this function with the primary HCD.
1da177e4
LT		 2454 */
2455void usb_hc_died (struct usb_hcd *hcd)
2456{
2457 unsigned long flags;
2458
2459 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2460
2461 spin_lock_irqsave (&hcd_root_hub_lock, flags);
9b37596a
AS		 2462 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2463 set_bit(HCD_FLAG_DEAD, &hcd->flags);
1da177e4 2464 if (hcd->rh_registered) {
541c7d43 2465 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1da177e4 2466
37ebb549 2467 /* make hub_wq clean up old urbs and devices */
1da177e4
LT		 2468 usb_set_device_state (hcd->self.root_hub,
2469 USB_STATE_NOTATTACHED);
59d48b3f 2470 usb_kick_hub_wq(hcd->self.root_hub);
1da177e4 2471 }
c5635437
SS		 2472 if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2473 hcd = hcd->shared_hcd;
2474 if (hcd->rh_registered) {
2475 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2476
37ebb549 2477 /* make hub_wq clean up old urbs and devices */
c5635437
SS		 2478 usb_set_device_state(hcd->self.root_hub,
2479 USB_STATE_NOTATTACHED);
59d48b3f 2480 usb_kick_hub_wq(hcd->self.root_hub);
c5635437
SS		 2481 }
2482 }
1da177e4 2483 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
c5635437 2484 /* Make sure that the other roothub is also deallocated. */
1da177e4
LT		 2485}
2486EXPORT_SYMBOL_GPL (usb_hc_died);
2487
2488/*-------------------------------------------------------------------------*/
2489
94dfd7ed
ML		 2490static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
2491{
2492
2493 spin_lock_init(&bh->lock);
2494 INIT_LIST_HEAD(&bh->head);
2495 tasklet_init(&bh->bh, usb_giveback_urb_bh, (unsigned long)bh);
2496}
2497
1da177e4 2498/**
c5635437 2499 * usb_create_shared_hcd - create and initialize an HCD structure
1da177e4
LT		 2500 * @driver: HC driver that will use this hcd
2501 * @dev: device for this HC, stored in hcd->self.controller
2502 * @bus_name: value to store in hcd->self.bus_name
c5635437
SS		 2503 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2504 * PCI device. Only allocate certain resources for the primary HCD
1da177e4
LT		 2505 * Context: !in_interrupt()
2506 *
2507 * Allocate a struct usb_hcd, with extra space at the end for the
2508 * HC driver's private data. Initialize the generic members of the
2509 * hcd structure.
2510 *
626f090c
YB		 2511 * Return: On success, a pointer to the created and initialized HCD structure.
2512 * On failure (e.g. if memory is unavailable), %NULL.
1da177e4 2513 */
c5635437
SS		 2514struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2515 struct device *dev, const char *bus_name,
2516 struct usb_hcd *primary_hcd)
1da177e4
LT		 2517{
2518 struct usb_hcd *hcd;
2519
7b842b6e 2520 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
36af2db8 2521 if (!hcd)
1da177e4 2522 return NULL;
c5635437 2523 if (primary_hcd == NULL) {
feb26ac3
CB		 2524 hcd->address0_mutex = kmalloc(sizeof(*hcd->address0_mutex),
2525 GFP_KERNEL);
2526 if (!hcd->address0_mutex) {
2527 kfree(hcd);
2528 dev_dbg(dev, "hcd address0 mutex alloc failed\n");
2529 return NULL;
2530 }
2531 mutex_init(hcd->address0_mutex);
c5635437
SS		 2532 hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2533 GFP_KERNEL);
2534 if (!hcd->bandwidth_mutex) {
2535 kfree(hcd);
2536 dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2537 return NULL;
2538 }
2539 mutex_init(hcd->bandwidth_mutex);
2540 dev_set_drvdata(dev, hcd);
2541 } else {
d8521afe 2542 mutex_lock(&usb_port_peer_mutex);
feb26ac3 2543 hcd->address0_mutex = primary_hcd->address0_mutex;
c5635437
SS		 2544 hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2545 hcd->primary_hcd = primary_hcd;
2546 primary_hcd->primary_hcd = primary_hcd;
2547 hcd->shared_hcd = primary_hcd;
2548 primary_hcd->shared_hcd = hcd;
d8521afe 2549 mutex_unlock(&usb_port_peer_mutex);
d673bfcb 2550 }
d673bfcb 2551
17200583 2552 kref_init(&hcd->kref);
1da177e4
LT		 2553
2554 usb_bus_init(&hcd->self);
1da177e4
LT		 2555 hcd->self.controller = dev;
2556 hcd->self.bus_name = bus_name;
dd990f16 2557 hcd->self.uses_dma = (dev->dma_mask != NULL);
1da177e4
LT		 2558
2559 init_timer(&hcd->rh_timer);
d5926ae7
AS		 2560 hcd->rh_timer.function = rh_timer_func;
2561 hcd->rh_timer.data = (unsigned long) hcd;
ceb6c9c8 2562#ifdef CONFIG_PM
6b157c9b
AS		 2563 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2564#endif
1da177e4
LT		 2565
2566 hcd->driver = driver;
83de4b2b 2567 hcd->speed = driver->flags & HCD_MASK;
1da177e4
LT		 2568 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2569 "USB Host Controller";
1da177e4
LT		 2570 return hcd;
2571}
c5635437
SS		 2572EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2573
2574/**
2575 * usb_create_hcd - create and initialize an HCD structure
2576 * @driver: HC driver that will use this hcd
2577 * @dev: device for this HC, stored in hcd->self.controller
2578 * @bus_name: value to store in hcd->self.bus_name
2579 * Context: !in_interrupt()
2580 *
2581 * Allocate a struct usb_hcd, with extra space at the end for the
2582 * HC driver's private data. Initialize the generic members of the
2583 * hcd structure.
2584 *
626f090c
YB		 2585 * Return: On success, a pointer to the created and initialized HCD
2586 * structure. On failure (e.g. if memory is unavailable), %NULL.
c5635437
SS		 2587 */
2588struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2589 struct device *dev, const char *bus_name)
2590{
2591 return usb_create_shared_hcd(driver, dev, bus_name, NULL);
2592}
782e70c6 2593EXPORT_SYMBOL_GPL(usb_create_hcd);
1da177e4 2594
c5635437
SS		 2595/*
2596 * Roothubs that share one PCI device must also share the bandwidth mutex.
2597 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2598 * deallocated.
2599 *
ab2a4bf8
AS		 2600 * Make sure to deallocate the bandwidth_mutex only when the last HCD is
2601 * freed. When hcd_release() is called for either hcd in a peer set,
2602 * invalidate the peer's ->shared_hcd and ->primary_hcd pointers.
c5635437 2603 */
d8521afe 2604static void hcd_release(struct kref *kref)
17200583
AS		 2605{
2606 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2607
d8521afe 2608 mutex_lock(&usb_port_peer_mutex);
d8521afe
DW		 2609 if (hcd->shared_hcd) {
2610 struct usb_hcd *peer = hcd->shared_hcd;
2611
2612 peer->shared_hcd = NULL;
ab2a4bf8
AS		 2613 peer->primary_hcd = NULL;
2614 } else {
2615 kfree(hcd->address0_mutex);
2616 kfree(hcd->bandwidth_mutex);
d8521afe
DW		 2617 }
2618 mutex_unlock(&usb_port_peer_mutex);
17200583
AS		 2619 kfree(hcd);
2620}
2621
2622struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2623{
2624 if (hcd)
2625 kref_get (&hcd->kref);
2626 return hcd;
2627}
782e70c6 2628EXPORT_SYMBOL_GPL(usb_get_hcd);
17200583 2629
1da177e4
LT		 2630void usb_put_hcd (struct usb_hcd *hcd)
2631{
17200583
AS		 2632 if (hcd)
2633 kref_put (&hcd->kref, hcd_release);
1da177e4 2634}
782e70c6 2635EXPORT_SYMBOL_GPL(usb_put_hcd);
1da177e4 2636
c5635437
SS		 2637int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2638{
2639 if (!hcd->primary_hcd)
2640 return 1;
2641 return hcd == hcd->primary_hcd;
2642}
2643EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2644
3f5eb141
LT		 2645int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
2646{
2647 if (!hcd->driver->find_raw_port_number)
2648 return port1;
2649
2650 return hcd->driver->find_raw_port_number(hcd, port1);
2651}
2652
23e0d106
SS		 2653static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2654 unsigned int irqnum, unsigned long irqflags)
2655{
2656 int retval;
2657
2658 if (hcd->driver->irq) {
e592c5d0 2659
23e0d106
SS		 2660 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2661 hcd->driver->description, hcd->self.busnum);
2662 retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2663 hcd->irq_descr, hcd);
2664 if (retval != 0) {
2665 dev_err(hcd->self.controller,
2666 "request interrupt %d failed\n",
2667 irqnum);
2668 return retval;
2669 }
2670 hcd->irq = irqnum;
2671 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2672 (hcd->driver->flags & HCD_MEMORY) ?
2673 "io mem" : "io base",
2674 (unsigned long long)hcd->rsrc_start);
2675 } else {
cd70469d 2676 hcd->irq = 0;
23e0d106
SS		 2677 if (hcd->rsrc_start)
2678 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2679 (hcd->driver->flags & HCD_MEMORY) ?
2680 "io mem" : "io base",
2681 (unsigned long long)hcd->rsrc_start);
2682 }
2683 return 0;
2684}
2685
d8521afe
DW		 2686/*
2687 * Before we free this root hub, flush in-flight peering attempts
2688 * and disable peer lookups
2689 */
2690static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
2691{
2692 struct usb_device *rhdev;
2693
2694 mutex_lock(&usb_port_peer_mutex);
2695 rhdev = hcd->self.root_hub;
2696 hcd->self.root_hub = NULL;
2697 mutex_unlock(&usb_port_peer_mutex);
2698 usb_put_dev(rhdev);
2699}
2700
1da177e4
LT		 2701/**
2702 * usb_add_hcd - finish generic HCD structure initialization and register
2703 * @hcd: the usb_hcd structure to initialize
2704 * @irqnum: Interrupt line to allocate
2705 * @irqflags: Interrupt type flags
2706 *
2707 * Finish the remaining parts of generic HCD initialization: allocate the
2708 * buffers of consistent memory, register the bus, request the IRQ line,
2709 * and call the driver's reset() and start() routines.
2710 */
2711int usb_add_hcd(struct usb_hcd *hcd,
2712 unsigned int irqnum, unsigned long irqflags)
2713{
8ec8d20b
AS		 2714 int retval;
2715 struct usb_device *rhdev;
1da177e4 2716
3d46e73d 2717 if (IS_ENABLED(CONFIG_USB_PHY) && !hcd->usb_phy) {
1ae5799e
VB		 2718 struct usb_phy *phy = usb_get_phy_dev(hcd->self.controller, 0);
2719
2720 if (IS_ERR(phy)) {
2721 retval = PTR_ERR(phy);
2722 if (retval == -EPROBE_DEFER)
2723 return retval;
2724 } else {
2725 retval = usb_phy_init(phy);
2726 if (retval) {
2727 usb_put_phy(phy);
2728 return retval;
2729 }
3d46e73d 2730 hcd->usb_phy = phy;
1ae5799e
VB		 2731 hcd->remove_phy = 1;
2732 }
2733 }
2734
ef44cb42 2735 if (IS_ENABLED(CONFIG_GENERIC_PHY) && !hcd->phy) {
00433254
SS		 2736 struct phy *phy = phy_get(hcd->self.controller, "usb");
2737
2738 if (IS_ERR(phy)) {
2739 retval = PTR_ERR(phy);
2740 if (retval == -EPROBE_DEFER)
2741 goto err_phy;
2742 } else {
2743 retval = phy_init(phy);
2744 if (retval) {
2745 phy_put(phy);
2746 goto err_phy;
2747 }
2748 retval = phy_power_on(phy);
2749 if (retval) {
2750 phy_exit(phy);
2751 phy_put(phy);
2752 goto err_phy;
2753 }
2754 hcd->phy = phy;
ef44cb42 2755 hcd->remove_phy = 1;
00433254
SS		 2756 }
2757 }
2758
1da177e4
LT		 2759 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2760
c4fc2342 2761 /* Keep old behaviour if authorized_default is not in [0, 1]. */
ff8e2c56
SK		 2762 if (authorized_default < 0 || authorized_default > 1) {
2763 if (hcd->wireless)
2764 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2765 else
2766 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2767 } else {
2768 if (authorized_default)
2769 set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2770 else
2771 clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
2772 }
8de98402
BH		 2773 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2774
6b2bd3c8
SK		 2775 /* per default all interfaces are authorized */
2776 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
2777
b1e8f0a6 2778 /* HC is in reset state, but accessible. Now do the one-time init,
37ebb549 2779 * bottom up so that hcds can customize the root hubs before hub_wq
b1e8f0a6
DB		 2780 * starts talking to them. (Note, bus id is assigned early too.)
2781 */
0faaad46
KB		 2782 retval = hcd_buffer_create(hcd);
2783 if (retval != 0) {
1da177e4 2784 dev_dbg(hcd->self.controller, "pool alloc failed\n");
00433254 2785 goto err_create_buf;
1da177e4
LT		 2786 }
2787
0faaad46
KB		 2788 retval = usb_register_bus(&hcd->self);
2789 if (retval < 0)
8ec8d20b 2790 goto err_register_bus;
1da177e4 2791
c688d621
GKH		 2792 rhdev = usb_alloc_dev(NULL, &hcd->self, 0);
2793 if (rhdev == NULL) {
b1e8f0a6
DB		 2794 dev_err(hcd->self.controller, "unable to allocate root hub\n");
2795 retval = -ENOMEM;
2796 goto err_allocate_root_hub;
2797 }
d8521afe 2798 mutex_lock(&usb_port_peer_mutex);
6d88e679 2799 hcd->self.root_hub = rhdev;
d8521afe 2800 mutex_unlock(&usb_port_peer_mutex);
6b403b02 2801
83de4b2b 2802 switch (hcd->speed) {
6b403b02
SS		 2803 case HCD_USB11:
2804 rhdev->speed = USB_SPEED_FULL;
2805 break;
2806 case HCD_USB2:
2807 rhdev->speed = USB_SPEED_HIGH;
2808 break;
1a81f881
TP		 2809 case HCD_USB25:
2810 rhdev->speed = USB_SPEED_WIRELESS;
2811 break;
6b403b02
SS		 2812 case HCD_USB3:
2813 rhdev->speed = USB_SPEED_SUPER;
2814 break;
5f9c3a66
MN		 2815 case HCD_USB31:
2816 rhdev->speed = USB_SPEED_SUPER_PLUS;
2817 break;
6b403b02 2818 default:
1d15ee4c 2819 retval = -EINVAL;
96e077ae 2820 goto err_set_rh_speed;
6b403b02 2821 }
b1e8f0a6 2822
db4cefaa
DB		 2823 /* wakeup flag init defaults to "everything works" for root hubs,
2824 * but drivers can override it in reset() if needed, along with
2825 * recording the overall controller's system wakeup capability.
2826 */
a6eeeb9f 2827 device_set_wakeup_capable(&rhdev->dev, 1);
db4cefaa 2828
9b37596a
AS		 2829 /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2830 * registered. But since the controller can die at any time,
2831 * let's initialize the flag before touching the hardware.
2832 */
2833 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2834
b1e8f0a6
DB		 2835 /* "reset" is misnamed; its role is now one-time init. the controller
2836 * should already have been reset (and boot firmware kicked off etc).
2837 */
0faaad46
KB		 2838 if (hcd->driver->reset) {
2839 retval = hcd->driver->reset(hcd);
2840 if (retval < 0) {
2841 dev_err(hcd->self.controller, "can't setup: %d\n",
2842 retval);
2843 goto err_hcd_driver_setup;
2844 }
b1e8f0a6 2845 }
6d88e679 2846 hcd->rh_pollable = 1;
b1e8f0a6 2847
fb669cc0
DB		 2848 /* NOTE: root hub and controller capabilities may not be the same */
2849 if (device_can_wakeup(hcd->self.controller)
2850 && device_can_wakeup(&hcd->self.root_hub->dev))
b1e8f0a6 2851 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
b1e8f0a6 2852
94dfd7ed
ML		 2853 /* initialize tasklets */
2854 init_giveback_urb_bh(&hcd->high_prio_bh);
2855 init_giveback_urb_bh(&hcd->low_prio_bh);
2856
68d07f64
SS		 2857 /* enable irqs just before we start the controller,
2858 * if the BIOS provides legacy PCI irqs.
2859 */
2860 if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
c5635437
SS		 2861 retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2862 if (retval)
2863 goto err_request_irq;
2864 }
1da177e4 2865
4814030c 2866 hcd->state = HC_STATE_RUNNING;
abc4f9b0
SS		 2867 retval = hcd->driver->start(hcd);
2868 if (retval < 0) {
1da177e4 2869 dev_err(hcd->self.controller, "startup error %d\n", retval);
8ec8d20b 2870 goto err_hcd_driver_start;
1da177e4
LT		 2871 }
2872
b1e8f0a6 2873 /* starting here, usbcore will pay attention to this root hub */
0faaad46
KB		 2874 retval = register_root_hub(hcd);
2875 if (retval != 0)
8ec8d20b
AS		 2876 goto err_register_root_hub;
2877
5234ce1b
IPG		 2878 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2879 if (retval < 0) {
2880 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2881 retval);
2882 goto error_create_attr_group;
2883 }
541c7d43 2884 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
d5926ae7 2885 usb_hcd_poll_rh_status(hcd);
a6eeeb9f 2886
1da177e4
LT		 2887 return retval;
2888
5234ce1b 2889error_create_attr_group:
9b37596a 2890 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
96e077ae
AS		 2891 if (HC_IS_RUNNING(hcd->state))
2892 hcd->state = HC_STATE_QUIESCING;
2893 spin_lock_irq(&hcd_root_hub_lock);
2894 hcd->rh_registered = 0;
2895 spin_unlock_irq(&hcd_root_hub_lock);
2896
ceb6c9c8 2897#ifdef CONFIG_PM
96e077ae
AS		 2898 cancel_work_sync(&hcd->wakeup_work);
2899#endif
a4b5d606 2900 mutex_lock(&usb_bus_idr_lock);
6d88e679 2901 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
a4b5d606 2902 mutex_unlock(&usb_bus_idr_lock);
b1e8f0a6 2903err_register_root_hub:
6d88e679 2904 hcd->rh_pollable = 0;
541c7d43 2905 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
6d88e679 2906 del_timer_sync(&hcd->rh_timer);
8ec8d20b 2907 hcd->driver->stop(hcd);
96e077ae 2908 hcd->state = HC_STATE_HALT;
541c7d43 2909 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
96e077ae 2910 del_timer_sync(&hcd->rh_timer);
b1e8f0a6 2911err_hcd_driver_start:
cd70469d 2912 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
1da177e4 2913 free_irq(irqnum, hcd);
b1e8f0a6
DB		 2914err_request_irq:
2915err_hcd_driver_setup:
96e077ae 2916err_set_rh_speed:
d8521afe 2917 usb_put_invalidate_rhdev(hcd);
b1e8f0a6 2918err_allocate_root_hub:
1da177e4 2919 usb_deregister_bus(&hcd->self);
b1e8f0a6 2920err_register_bus:
1da177e4 2921 hcd_buffer_destroy(hcd);
00433254 2922err_create_buf:
ef44cb42 2923 if (IS_ENABLED(CONFIG_GENERIC_PHY) && hcd->remove_phy && hcd->phy) {
00433254
SS		 2924 phy_power_off(hcd->phy);
2925 phy_exit(hcd->phy);
2926 phy_put(hcd->phy);
2927 hcd->phy = NULL;
2928 }
2929err_phy:
3d46e73d
AT		 2930 if (hcd->remove_phy && hcd->usb_phy) {
2931 usb_phy_shutdown(hcd->usb_phy);
2932 usb_put_phy(hcd->usb_phy);
2933 hcd->usb_phy = NULL;
103e127d 2934 }
1da177e4 2935 return retval;
14557359 2936}
782e70c6 2937EXPORT_SYMBOL_GPL(usb_add_hcd);
1da177e4
LT		 2938
2939/**
2940 * usb_remove_hcd - shutdown processing for generic HCDs
2941 * @hcd: the usb_hcd structure to remove
2942 * Context: !in_interrupt()
2943 *
2944 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2945 * invoking the HCD's stop() method.
2946 */
2947void usb_remove_hcd(struct usb_hcd *hcd)
2948{
6d88e679
AS		 2949 struct usb_device *rhdev = hcd->self.root_hub;
2950
1da177e4
LT		 2951 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2952
6d88e679
AS		 2953 usb_get_dev(rhdev);
2954 sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
96e077ae 2955
9b37596a 2956 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
1da177e4
LT		 2957 if (HC_IS_RUNNING (hcd->state))
2958 hcd->state = HC_STATE_QUIESCING;
2959
2960 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2961 spin_lock_irq (&hcd_root_hub_lock);
2962 hcd->rh_registered = 0;
2963 spin_unlock_irq (&hcd_root_hub_lock);
9ad3d6cc 2964
ceb6c9c8 2965#ifdef CONFIG_PM
d5d4db70 2966 cancel_work_sync(&hcd->wakeup_work);
6b157c9b
AS		 2967#endif
2968
a4b5d606 2969 mutex_lock(&usb_bus_idr_lock);
6d88e679 2970 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
a4b5d606 2971 mutex_unlock(&usb_bus_idr_lock);
1da177e4 2972
94dfd7ed
ML		 2973 /*
2974 * tasklet_kill() isn't needed here because:
2975 * - driver's disconnect() called from usb_disconnect() should
2976 * make sure its URBs are completed during the disconnect()
2977 * callback
2978 *
2979 * - it is too late to run complete() here since driver may have
2980 * been removed already now
2981 */
2982
6d88e679
AS		 2983 /* Prevent any more root-hub status calls from the timer.
2984 * The HCD might still restart the timer (if a port status change
2985 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2986 * the hub_status_data() callback.
2987 */
2988 hcd->rh_pollable = 0;
541c7d43 2989 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
6d88e679
AS		 2990 del_timer_sync(&hcd->rh_timer);
2991
1da177e4
LT		 2992 hcd->driver->stop(hcd);
2993 hcd->state = HC_STATE_HALT;
2994
6d88e679 2995 /* In case the HCD restarted the timer, stop it again. */
541c7d43 2996 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1b42ae6d
AS		 2997 del_timer_sync(&hcd->rh_timer);
2998
c5635437 2999 if (usb_hcd_is_primary_hcd(hcd)) {
cd70469d 3000 if (hcd->irq > 0)
c5635437
SS		 3001 free_irq(hcd->irq, hcd);
3002 }
6d88e679 3003
1da177e4
LT		 3004 usb_deregister_bus(&hcd->self);
3005 hcd_buffer_destroy(hcd);
00433254 3006
ef44cb42 3007 if (IS_ENABLED(CONFIG_GENERIC_PHY) && hcd->remove_phy && hcd->phy) {
00433254
SS		 3008 phy_power_off(hcd->phy);
3009 phy_exit(hcd->phy);
3010 phy_put(hcd->phy);
3011 hcd->phy = NULL;
3012 }
3d46e73d
AT		 3013 if (hcd->remove_phy && hcd->usb_phy) {
3014 usb_phy_shutdown(hcd->usb_phy);
3015 usb_put_phy(hcd->usb_phy);
3016 hcd->usb_phy = NULL;
103e127d 3017 }
d8521afe
DW		 3018
3019 usb_put_invalidate_rhdev(hcd);
76b8db0d 3020 hcd->flags = 0;
1da177e4 3021}
782e70c6 3022EXPORT_SYMBOL_GPL(usb_remove_hcd);
1da177e4 3023
64a21d02 3024void
842c1960 3025usb_hcd_platform_shutdown(struct platform_device *dev)
64a21d02
AG		 3026{
3027 struct usb_hcd *hcd = platform_get_drvdata(dev);
3028
3029 if (hcd->driver->shutdown)
3030 hcd->driver->shutdown(hcd);
3031}
782e70c6 3032EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
64a21d02 3033
1da177e4
LT		 3034/*-------------------------------------------------------------------------*/
3035
f7b7f375 3036#if IS_ENABLED(CONFIG_USB_MON)
1da177e4 3037
6fb8ac81 3038const struct usb_mon_operations *mon_ops;
1da177e4
LT		 3039
3040/*
3041 * The registration is unlocked.
3042 * We do it this way because we do not want to lock in hot paths.
3043 *
3044 * Notice that the code is minimally error-proof. Because usbmon needs
3045 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
3046 */
14557359 3047
6fb8ac81 3048int usb_mon_register(const struct usb_mon_operations *ops)
1da177e4
LT		 3049{
3050
3051 if (mon_ops)
3052 return -EBUSY;
3053
3054 mon_ops = ops;
3055 mb();
3056 return 0;
3057}
3058EXPORT_SYMBOL_GPL (usb_mon_register);
3059
3060void usb_mon_deregister (void)
3061{
3062
3063 if (mon_ops == NULL) {
3064 printk(KERN_ERR "USB: monitor was not registered\n");
3065 return;
3066 }
3067 mon_ops = NULL;
3068 mb();
3069}
3070EXPORT_SYMBOL_GPL (usb_mon_deregister);
3071
f150fa1a 3072#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
ubuntu-bionic-kernel mirror