hcd.c 87.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8
/*
 * (C) Copyright Linus Torvalds 1999
 * (C) Copyright Johannes Erdfelt 1999-2001
 * (C) Copyright Andreas Gal 1999
 * (C) Copyright Gregory P. Smith 1999
 * (C) Copyright Deti Fliegl 1999
 * (C) Copyright Randy Dunlap 2000
 * (C) Copyright David Brownell 2000-2002
9
 *
L
Linus Torvalds 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

25
#include <linux/bcd.h>
L
Linus Torvalds 已提交
26 27 28 29 30 31 32 33 34 35
#include <linux/module.h>
#include <linux/version.h>
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/completion.h>
#include <linux/utsname.h>
#include <linux/mm.h>
#include <asm/io.h>
#include <linux/device.h>
#include <linux/dma-mapping.h>
36
#include <linux/mutex.h>
L
Linus Torvalds 已提交
37 38
#include <asm/irq.h>
#include <asm/byteorder.h>
M
Magnus Damm 已提交
39
#include <asm/unaligned.h>
40
#include <linux/platform_device.h>
41
#include <linux/workqueue.h>
42
#include <linux/pm_runtime.h>
43
#include <linux/types.h>
L
Linus Torvalds 已提交
44

45
#include <linux/phy/phy.h>
L
Linus Torvalds 已提交
46
#include <linux/usb.h>
47
#include <linux/usb/hcd.h>
48
#include <linux/usb/phy.h>
L
Linus Torvalds 已提交
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87

#include "usb.h"


/*-------------------------------------------------------------------------*/

/*
 * USB Host Controller Driver framework
 *
 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
 * HCD-specific behaviors/bugs.
 *
 * This does error checks, tracks devices and urbs, and delegates to a
 * "hc_driver" only for code (and data) that really needs to know about
 * hardware differences.  That includes root hub registers, i/o queues,
 * and so on ... but as little else as possible.
 *
 * Shared code includes most of the "root hub" code (these are emulated,
 * though each HC's hardware works differently) and PCI glue, plus request
 * tracking overhead.  The HCD code should only block on spinlocks or on
 * hardware handshaking; blocking on software events (such as other kernel
 * threads releasing resources, or completing actions) is all generic.
 *
 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
 * only by the hub driver ... and that neither should be seen or used by
 * usb client device drivers.
 *
 * Contributors of ideas or unattributed patches include: David Brownell,
 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
 *
 * HISTORY:
 * 2002-02-21	Pull in most of the usb_bus support from usb.c; some
 *		associated cleanup.  "usb_hcd" still != "usb_bus".
 * 2001-12-12	Initial patch version for Linux 2.5.1 kernel.
 */

/*-------------------------------------------------------------------------*/

88 89 90 91
/* Keep track of which host controller drivers are loaded */
unsigned long usb_hcds_loaded;
EXPORT_SYMBOL_GPL(usb_hcds_loaded);

L
Linus Torvalds 已提交
92
/* host controllers we manage */
93 94
DEFINE_IDR (usb_bus_idr);
EXPORT_SYMBOL_GPL (usb_bus_idr);
L
Linus Torvalds 已提交
95 96 97 98 99

/* used when allocating bus numbers */
#define USB_MAXBUS		64

/* used when updating list of hcds */
100
DEFINE_MUTEX(usb_bus_list_lock);	/* exported only for usbfs */
L
Linus Torvalds 已提交
101 102 103 104 105
EXPORT_SYMBOL_GPL (usb_bus_list_lock);

/* used for controlling access to virtual root hubs */
static DEFINE_SPINLOCK(hcd_root_hub_lock);

106 107
/* used when updating an endpoint's URB list */
static DEFINE_SPINLOCK(hcd_urb_list_lock);
L
Linus Torvalds 已提交
108

109 110 111
/* used to protect against unlinking URBs after the device is gone */
static DEFINE_SPINLOCK(hcd_urb_unlink_lock);

L
Linus Torvalds 已提交
112 113 114
/* wait queue for synchronous unlinks */
DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);

115 116 117 118 119
static inline int is_root_hub(struct usb_device *udev)
{
	return (udev->parent == NULL);
}

L
Linus Torvalds 已提交
120 121 122 123 124 125 126
/*-------------------------------------------------------------------------*/

/*
 * Sharable chunks of root hub code.
 */

/*-------------------------------------------------------------------------*/
127 128
#define KERNEL_REL	bin2bcd(((LINUX_VERSION_CODE >> 16) & 0x0ff))
#define KERNEL_VER	bin2bcd(((LINUX_VERSION_CODE >> 8) & 0x0ff))
L
Linus Torvalds 已提交
129

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
/* usb 3.1 root hub device descriptor */
static const u8 usb31_rh_dev_descriptor[18] = {
	0x12,       /*  __u8  bLength; */
	USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
	0x10, 0x03, /*  __le16 bcdUSB; v3.1 */

	0x09,	    /*  __u8  bDeviceClass; HUB_CLASSCODE */
	0x00,	    /*  __u8  bDeviceSubClass; */
	0x03,       /*  __u8  bDeviceProtocol; USB 3 hub */
	0x09,       /*  __u8  bMaxPacketSize0; 2^9 = 512 Bytes */

	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation 0x1d6b */
	0x03, 0x00, /*  __le16 idProduct; device 0x0003 */
	KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */

	0x03,       /*  __u8  iManufacturer; */
	0x02,       /*  __u8  iProduct; */
	0x01,       /*  __u8  iSerialNumber; */
	0x01        /*  __u8  bNumConfigurations; */
};

151 152 153
/* usb 3.0 root hub device descriptor */
static const u8 usb3_rh_dev_descriptor[18] = {
	0x12,       /*  __u8  bLength; */
S
Sergei Shtylyov 已提交
154
	USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
155 156 157 158 159 160 161
	0x00, 0x03, /*  __le16 bcdUSB; v3.0 */

	0x09,	    /*  __u8  bDeviceClass; HUB_CLASSCODE */
	0x00,	    /*  __u8  bDeviceSubClass; */
	0x03,       /*  __u8  bDeviceProtocol; USB 3.0 hub */
	0x09,       /*  __u8  bMaxPacketSize0; 2^9 = 512 Bytes */

162
	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation 0x1d6b */
163
	0x03, 0x00, /*  __le16 idProduct; device 0x0003 */
164 165 166 167 168 169 170 171
	KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */

	0x03,       /*  __u8  iManufacturer; */
	0x02,       /*  __u8  iProduct; */
	0x01,       /*  __u8  iSerialNumber; */
	0x01        /*  __u8  bNumConfigurations; */
};

172 173 174
/* usb 2.5 (wireless USB 1.0) root hub device descriptor */
static const u8 usb25_rh_dev_descriptor[18] = {
	0x12,       /*  __u8  bLength; */
S
Sergei Shtylyov 已提交
175
	USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
	0x50, 0x02, /*  __le16 bcdUSB; v2.5 */

	0x09,	    /*  __u8  bDeviceClass; HUB_CLASSCODE */
	0x00,	    /*  __u8  bDeviceSubClass; */
	0x00,       /*  __u8  bDeviceProtocol; [ usb 2.0 no TT ] */
	0xFF,       /*  __u8  bMaxPacketSize0; always 0xFF (WUSB Spec 7.4.1). */

	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation 0x1d6b */
	0x02, 0x00, /*  __le16 idProduct; device 0x0002 */
	KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */

	0x03,       /*  __u8  iManufacturer; */
	0x02,       /*  __u8  iProduct; */
	0x01,       /*  __u8  iSerialNumber; */
	0x01        /*  __u8  bNumConfigurations; */
};

L
Linus Torvalds 已提交
193
/* usb 2.0 root hub device descriptor */
194
static const u8 usb2_rh_dev_descriptor[18] = {
L
Linus Torvalds 已提交
195
	0x12,       /*  __u8  bLength; */
S
Sergei Shtylyov 已提交
196
	USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
L
Linus Torvalds 已提交
197 198 199 200
	0x00, 0x02, /*  __le16 bcdUSB; v2.0 */

	0x09,	    /*  __u8  bDeviceClass; HUB_CLASSCODE */
	0x00,	    /*  __u8  bDeviceSubClass; */
201
	0x00,       /*  __u8  bDeviceProtocol; [ usb 2.0 no TT ] */
202
	0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
L
Linus Torvalds 已提交
203

204
	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation 0x1d6b */
205
	0x02, 0x00, /*  __le16 idProduct; device 0x0002 */
L
Linus Torvalds 已提交
206 207 208 209 210 211 212 213 214 215 216
	KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */

	0x03,       /*  __u8  iManufacturer; */
	0x02,       /*  __u8  iProduct; */
	0x01,       /*  __u8  iSerialNumber; */
	0x01        /*  __u8  bNumConfigurations; */
};

/* no usb 2.0 root hub "device qualifier" descriptor: one speed only */

/* usb 1.1 root hub device descriptor */
217
static const u8 usb11_rh_dev_descriptor[18] = {
L
Linus Torvalds 已提交
218
	0x12,       /*  __u8  bLength; */
S
Sergei Shtylyov 已提交
219
	USB_DT_DEVICE, /* __u8 bDescriptorType; Device */
L
Linus Torvalds 已提交
220 221 222 223 224
	0x10, 0x01, /*  __le16 bcdUSB; v1.1 */

	0x09,	    /*  __u8  bDeviceClass; HUB_CLASSCODE */
	0x00,	    /*  __u8  bDeviceSubClass; */
	0x00,       /*  __u8  bDeviceProtocol; [ low/full speeds only ] */
225
	0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
L
Linus Torvalds 已提交
226

227
	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation 0x1d6b */
228
	0x01, 0x00, /*  __le16 idProduct; device 0x0001 */
L
Linus Torvalds 已提交
229 230 231 232 233 234 235 236 237 238 239 240 241
	KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */

	0x03,       /*  __u8  iManufacturer; */
	0x02,       /*  __u8  iProduct; */
	0x01,       /*  __u8  iSerialNumber; */
	0x01        /*  __u8  bNumConfigurations; */
};


/*-------------------------------------------------------------------------*/

/* Configuration descriptors for our root hubs */

242
static const u8 fs_rh_config_descriptor[] = {
L
Linus Torvalds 已提交
243 244 245

	/* one configuration */
	0x09,       /*  __u8  bLength; */
S
Sergei Shtylyov 已提交
246
	USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
L
Linus Torvalds 已提交
247 248 249 250
	0x19, 0x00, /*  __le16 wTotalLength; */
	0x01,       /*  __u8  bNumInterfaces; (1) */
	0x01,       /*  __u8  bConfigurationValue; */
	0x00,       /*  __u8  iConfiguration; */
251
	0xc0,       /*  __u8  bmAttributes;
L
Linus Torvalds 已提交
252 253 254 255 256
				 Bit 7: must be set,
				     6: Self-powered,
				     5: Remote wakeup,
				     4..0: resvd */
	0x00,       /*  __u8  MaxPower; */
257

L
Linus Torvalds 已提交
258 259 260 261 262 263 264 265 266 267 268 269 270
	/* USB 1.1:
	 * USB 2.0, single TT organization (mandatory):
	 *	one interface, protocol 0
	 *
	 * USB 2.0, multiple TT organization (optional):
	 *	two interfaces, protocols 1 (like single TT)
	 *	and 2 (multiple TT mode) ... config is
	 *	sometimes settable
	 *	NOT IMPLEMENTED
	 */

	/* one interface */
	0x09,       /*  __u8  if_bLength; */
S
Sergei Shtylyov 已提交
271
	USB_DT_INTERFACE,  /* __u8 if_bDescriptorType; Interface */
L
Linus Torvalds 已提交
272 273 274 275 276 277 278
	0x00,       /*  __u8  if_bInterfaceNumber; */
	0x00,       /*  __u8  if_bAlternateSetting; */
	0x01,       /*  __u8  if_bNumEndpoints; */
	0x09,       /*  __u8  if_bInterfaceClass; HUB_CLASSCODE */
	0x00,       /*  __u8  if_bInterfaceSubClass; */
	0x00,       /*  __u8  if_bInterfaceProtocol; [usb1.1 or single tt] */
	0x00,       /*  __u8  if_iInterface; */
279

L
Linus Torvalds 已提交
280 281
	/* one endpoint (status change endpoint) */
	0x07,       /*  __u8  ep_bLength; */
S
Sergei Shtylyov 已提交
282
	USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
L
Linus Torvalds 已提交
283
	0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
284 285
	0x03,       /*  __u8  ep_bmAttributes; Interrupt */
	0x02, 0x00, /*  __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
L
Linus Torvalds 已提交
286 287 288
	0xff        /*  __u8  ep_bInterval; (255ms -- usb 2.0 spec) */
};

289
static const u8 hs_rh_config_descriptor[] = {
L
Linus Torvalds 已提交
290 291 292

	/* one configuration */
	0x09,       /*  __u8  bLength; */
S
Sergei Shtylyov 已提交
293
	USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
L
Linus Torvalds 已提交
294 295 296 297
	0x19, 0x00, /*  __le16 wTotalLength; */
	0x01,       /*  __u8  bNumInterfaces; (1) */
	0x01,       /*  __u8  bConfigurationValue; */
	0x00,       /*  __u8  iConfiguration; */
298
	0xc0,       /*  __u8  bmAttributes;
L
Linus Torvalds 已提交
299 300 301 302 303
				 Bit 7: must be set,
				     6: Self-powered,
				     5: Remote wakeup,
				     4..0: resvd */
	0x00,       /*  __u8  MaxPower; */
304

L
Linus Torvalds 已提交
305 306 307 308 309 310 311 312 313 314 315 316 317
	/* USB 1.1:
	 * USB 2.0, single TT organization (mandatory):
	 *	one interface, protocol 0
	 *
	 * USB 2.0, multiple TT organization (optional):
	 *	two interfaces, protocols 1 (like single TT)
	 *	and 2 (multiple TT mode) ... config is
	 *	sometimes settable
	 *	NOT IMPLEMENTED
	 */

	/* one interface */
	0x09,       /*  __u8  if_bLength; */
S
Sergei Shtylyov 已提交
318
	USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
L
Linus Torvalds 已提交
319 320 321 322 323 324 325
	0x00,       /*  __u8  if_bInterfaceNumber; */
	0x00,       /*  __u8  if_bAlternateSetting; */
	0x01,       /*  __u8  if_bNumEndpoints; */
	0x09,       /*  __u8  if_bInterfaceClass; HUB_CLASSCODE */
	0x00,       /*  __u8  if_bInterfaceSubClass; */
	0x00,       /*  __u8  if_bInterfaceProtocol; [usb1.1 or single tt] */
	0x00,       /*  __u8  if_iInterface; */
326

L
Linus Torvalds 已提交
327 328
	/* one endpoint (status change endpoint) */
	0x07,       /*  __u8  ep_bLength; */
S
Sergei Shtylyov 已提交
329
	USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
L
Linus Torvalds 已提交
330
	0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
331
	0x03,       /*  __u8  ep_bmAttributes; Interrupt */
332 333 334
		    /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
		     * see hub.c:hub_configure() for details. */
	(USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
L
Linus Torvalds 已提交
335 336 337
	0x0c        /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */
};

338 339 340
static const u8 ss_rh_config_descriptor[] = {
	/* one configuration */
	0x09,       /*  __u8  bLength; */
S
Sergei Shtylyov 已提交
341
	USB_DT_CONFIG, /* __u8 bDescriptorType; Configuration */
342
	0x1f, 0x00, /*  __le16 wTotalLength; */
343 344 345 346 347 348 349 350 351 352 353 354
	0x01,       /*  __u8  bNumInterfaces; (1) */
	0x01,       /*  __u8  bConfigurationValue; */
	0x00,       /*  __u8  iConfiguration; */
	0xc0,       /*  __u8  bmAttributes;
				 Bit 7: must be set,
				     6: Self-powered,
				     5: Remote wakeup,
				     4..0: resvd */
	0x00,       /*  __u8  MaxPower; */

	/* one interface */
	0x09,       /*  __u8  if_bLength; */
S
Sergei Shtylyov 已提交
355
	USB_DT_INTERFACE, /* __u8 if_bDescriptorType; Interface */
356 357 358 359 360 361 362 363 364 365
	0x00,       /*  __u8  if_bInterfaceNumber; */
	0x00,       /*  __u8  if_bAlternateSetting; */
	0x01,       /*  __u8  if_bNumEndpoints; */
	0x09,       /*  __u8  if_bInterfaceClass; HUB_CLASSCODE */
	0x00,       /*  __u8  if_bInterfaceSubClass; */
	0x00,       /*  __u8  if_bInterfaceProtocol; */
	0x00,       /*  __u8  if_iInterface; */

	/* one endpoint (status change endpoint) */
	0x07,       /*  __u8  ep_bLength; */
S
Sergei Shtylyov 已提交
366
	USB_DT_ENDPOINT, /* __u8 ep_bDescriptorType; Endpoint */
367 368 369 370 371
	0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
	0x03,       /*  __u8  ep_bmAttributes; Interrupt */
		    /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
		     * see hub.c:hub_configure() for details. */
	(USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
372 373 374 375
	0x0c,       /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */

	/* one SuperSpeed endpoint companion descriptor */
	0x06,        /* __u8 ss_bLength */
S
Sergei Shtylyov 已提交
376 377
	USB_DT_SS_ENDPOINT_COMP, /* __u8 ss_bDescriptorType; SuperSpeed EP */
		     /* Companion */
378 379 380
	0x00,        /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
	0x00,        /* __u8 ss_bmAttributes; 1 packet per service interval */
	0x02, 0x00   /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
381 382
};

383 384 385 386 387 388 389 390 391 392 393
/* authorized_default behaviour:
 * -1 is authorized for all devices except wireless (old behaviour)
 * 0 is unauthorized for all devices
 * 1 is authorized for all devices
 */
static int authorized_default = -1;
module_param(authorized_default, int, S_IRUGO|S_IWUSR);
MODULE_PARM_DESC(authorized_default,
		"Default USB device authorization: 0 is not authorized, 1 is "
		"authorized, -1 is authorized except for wireless USB (default, "
		"old behaviour");
L
Linus Torvalds 已提交
394 395
/*-------------------------------------------------------------------------*/

396 397 398 399 400 401
/**
 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
 * @s: Null-terminated ASCII (actually ISO-8859-1) string
 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
 * @len: Length (in bytes; may be odd) of descriptor buffer.
 *
402 403
 * Return: The number of bytes filled in: 2 + 2*strlen(s) or @len,
 * whichever is less.
404
 *
405
 * Note:
406 407
 * USB String descriptors can contain at most 126 characters; input
 * strings longer than that are truncated.
L
Linus Torvalds 已提交
408
 */
409 410
static unsigned
ascii2desc(char const *s, u8 *buf, unsigned len)
L
Linus Torvalds 已提交
411
{
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
	unsigned n, t = 2 + 2*strlen(s);

	if (t > 254)
		t = 254;	/* Longest possible UTF string descriptor */
	if (len > t)
		len = t;

	t += USB_DT_STRING << 8;	/* Now t is first 16 bits to store */

	n = len;
	while (n--) {
		*buf++ = t;
		if (!n--)
			break;
		*buf++ = t >> 8;
		t = (unsigned char)*s++;
L
Linus Torvalds 已提交
428
	}
429
	return len;
L
Linus Torvalds 已提交
430 431
}

432 433 434
/**
 * rh_string() - provides string descriptors for root hub
 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
L
Linus Torvalds 已提交
435
 * @hcd: the host controller for this root hub
436 437
 * @data: buffer for output packet
 * @len: length of the provided buffer
L
Linus Torvalds 已提交
438 439 440
 *
 * Produces either a manufacturer, product or serial number string for the
 * virtual root hub device.
441 442
 *
 * Return: The number of bytes filled in: the length of the descriptor or
443
 * of the provided buffer, whichever is less.
L
Linus Torvalds 已提交
444
 */
445 446
static unsigned
rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
447
{
448 449 450
	char buf[100];
	char const *s;
	static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
L
Linus Torvalds 已提交
451

452
	/* language ids */
453 454 455 456 457 458 459
	switch (id) {
	case 0:
		/* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
		/* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
		if (len > 4)
			len = 4;
		memcpy(data, langids, len);
L
Linus Torvalds 已提交
460
		return len;
461 462 463 464 465 466 467 468 469 470
	case 1:
		/* Serial number */
		s = hcd->self.bus_name;
		break;
	case 2:
		/* Product name */
		s = hcd->product_desc;
		break;
	case 3:
		/* Manufacturer */
471 472
		snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
			init_utsname()->release, hcd->driver->description);
473 474
		s = buf;
		break;
L
Linus Torvalds 已提交
475
	default:
476 477
		/* Can't happen; caller guarantees it */
		return 0;
L
Linus Torvalds 已提交
478
	}
479 480

	return ascii2desc(s, data, len);
L
Linus Torvalds 已提交
481 482 483 484 485 486 487
}


/* Root hub control transfers execute synchronously */
static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
{
	struct usb_ctrlrequest *cmd;
488
	u16		typeReq, wValue, wIndex, wLength;
L
Linus Torvalds 已提交
489
	u8		*ubuf = urb->transfer_buffer;
490
	unsigned	len = 0;
491
	int		status;
492 493
	u8		patch_wakeup = 0;
	u8		patch_protocol = 0;
494 495 496
	u16		tbuf_size;
	u8		*tbuf = NULL;
	const u8	*bufp;
L
Linus Torvalds 已提交
497

498 499
	might_sleep();

500 501 502 503 504
	spin_lock_irq(&hcd_root_hub_lock);
	status = usb_hcd_link_urb_to_ep(hcd, urb);
	spin_unlock_irq(&hcd_root_hub_lock);
	if (status)
		return status;
A
Alan Stern 已提交
505
	urb->hcpriv = hcd;	/* Indicate it's queued */
506

L
Linus Torvalds 已提交
507 508 509 510 511 512 513 514 515
	cmd = (struct usb_ctrlrequest *) urb->setup_packet;
	typeReq  = (cmd->bRequestType << 8) | cmd->bRequest;
	wValue   = le16_to_cpu (cmd->wValue);
	wIndex   = le16_to_cpu (cmd->wIndex);
	wLength  = le16_to_cpu (cmd->wLength);

	if (wLength > urb->transfer_buffer_length)
		goto error;

516 517 518 519 520 521 522 523 524 525 526 527
	/*
	 * tbuf should be at least as big as the
	 * USB hub descriptor.
	 */
	tbuf_size =  max_t(u16, sizeof(struct usb_hub_descriptor), wLength);
	tbuf = kzalloc(tbuf_size, GFP_KERNEL);
	if (!tbuf)
		return -ENOMEM;

	bufp = tbuf;


L
Linus Torvalds 已提交
528 529 530 531 532
	urb->actual_length = 0;
	switch (typeReq) {

	/* DEVICE REQUESTS */

533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
	/* The root hub's remote wakeup enable bit is implemented using
	 * driver model wakeup flags.  If this system supports wakeup
	 * through USB, userspace may change the default "allow wakeup"
	 * policy through sysfs or these calls.
	 *
	 * Most root hubs support wakeup from downstream devices, for
	 * runtime power management (disabling USB clocks and reducing
	 * VBUS power usage).  However, not all of them do so; silicon,
	 * board, and BIOS bugs here are not uncommon, so these can't
	 * be treated quite like external hubs.
	 *
	 * Likewise, not all root hubs will pass wakeup events upstream,
	 * to wake up the whole system.  So don't assume root hub and
	 * controller capabilities are identical.
	 */

L
Linus Torvalds 已提交
549
	case DeviceRequest | USB_REQ_GET_STATUS:
550
		tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
551
					<< USB_DEVICE_REMOTE_WAKEUP)
L
Linus Torvalds 已提交
552
				| (1 << USB_DEVICE_SELF_POWERED);
553
		tbuf[1] = 0;
L
Linus Torvalds 已提交
554 555 556 557
		len = 2;
		break;
	case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
		if (wValue == USB_DEVICE_REMOTE_WAKEUP)
558
			device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
L
Linus Torvalds 已提交
559 560 561 562
		else
			goto error;
		break;
	case DeviceOutRequest | USB_REQ_SET_FEATURE:
563 564 565
		if (device_can_wakeup(&hcd->self.root_hub->dev)
				&& wValue == USB_DEVICE_REMOTE_WAKEUP)
			device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
L
Linus Torvalds 已提交
566 567 568 569
		else
			goto error;
		break;
	case DeviceRequest | USB_REQ_GET_CONFIGURATION:
570
		tbuf[0] = 1;
L
Linus Torvalds 已提交
571 572 573 574 575 576 577
		len = 1;
			/* FALLTHROUGH */
	case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
		break;
	case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
		switch (wValue & 0xff00) {
		case USB_DT_DEVICE << 8:
578
			switch (hcd->speed) {
579
			case HCD_USB31:
580 581
				bufp = usb31_rh_dev_descriptor;
				break;
582
			case HCD_USB3:
583
				bufp = usb3_rh_dev_descriptor;
584
				break;
585 586 587
			case HCD_USB25:
				bufp = usb25_rh_dev_descriptor;
				break;
588
			case HCD_USB2:
L
Linus Torvalds 已提交
589
				bufp = usb2_rh_dev_descriptor;
590 591
				break;
			case HCD_USB11:
L
Linus Torvalds 已提交
592
				bufp = usb11_rh_dev_descriptor;
593 594
				break;
			default:
L
Linus Torvalds 已提交
595
				goto error;
596
			}
L
Linus Torvalds 已提交
597
			len = 18;
598 599
			if (hcd->has_tt)
				patch_protocol = 1;
L
Linus Torvalds 已提交
600 601
			break;
		case USB_DT_CONFIG << 8:
602
			switch (hcd->speed) {
603
			case HCD_USB31:
604
			case HCD_USB3:
605 606
				bufp = ss_rh_config_descriptor;
				len = sizeof ss_rh_config_descriptor;
607
				break;
608
			case HCD_USB25:
609
			case HCD_USB2:
L
Linus Torvalds 已提交
610 611
				bufp = hs_rh_config_descriptor;
				len = sizeof hs_rh_config_descriptor;
612 613
				break;
			case HCD_USB11:
L
Linus Torvalds 已提交
614 615
				bufp = fs_rh_config_descriptor;
				len = sizeof fs_rh_config_descriptor;
616 617 618
				break;
			default:
				goto error;
L
Linus Torvalds 已提交
619
			}
620
			if (device_can_wakeup(&hcd->self.root_hub->dev))
L
Linus Torvalds 已提交
621 622 623
				patch_wakeup = 1;
			break;
		case USB_DT_STRING << 8:
624 625 626 627
			if ((wValue & 0xff) < 4)
				urb->actual_length = rh_string(wValue & 0xff,
						hcd, ubuf, wLength);
			else /* unsupported IDs --> "protocol stall" */
L
Linus Torvalds 已提交
628 629
				goto error;
			break;
630 631
		case USB_DT_BOS << 8:
			goto nongeneric;
L
Linus Torvalds 已提交
632 633 634 635 636
		default:
			goto error;
		}
		break;
	case DeviceRequest | USB_REQ_GET_INTERFACE:
637
		tbuf[0] = 0;
L
Linus Torvalds 已提交
638 639 640 641 642
		len = 1;
			/* FALLTHROUGH */
	case DeviceOutRequest | USB_REQ_SET_INTERFACE:
		break;
	case DeviceOutRequest | USB_REQ_SET_ADDRESS:
643
		/* wValue == urb->dev->devaddr */
L
Linus Torvalds 已提交
644 645 646 647 648 649 650 651 652
		dev_dbg (hcd->self.controller, "root hub device address %d\n",
			wValue);
		break;

	/* INTERFACE REQUESTS (no defined feature/status flags) */

	/* ENDPOINT REQUESTS */

	case EndpointRequest | USB_REQ_GET_STATUS:
653
		/* ENDPOINT_HALT flag */
654 655
		tbuf[0] = 0;
		tbuf[1] = 0;
L
Linus Torvalds 已提交
656 657 658 659 660 661 662 663 664 665
		len = 2;
			/* FALLTHROUGH */
	case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
	case EndpointOutRequest | USB_REQ_SET_FEATURE:
		dev_dbg (hcd->self.controller, "no endpoint features yet\n");
		break;

	/* CLASS REQUESTS (and errors) */

	default:
666
nongeneric:
L
Linus Torvalds 已提交
667
		/* non-generic request */
668 669 670 671
		switch (typeReq) {
		case GetHubStatus:
			len = 4;
			break;
672 673 674 675 676 677 678
		case GetPortStatus:
			if (wValue == HUB_PORT_STATUS)
				len = 4;
			else
				/* other port status types return 8 bytes */
				len = 8;
			break;
679 680 681
		case GetHubDescriptor:
			len = sizeof (struct usb_hub_descriptor);
			break;
682 683 684
		case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
			/* len is returned by hub_control */
			break;
L
Linus Torvalds 已提交
685
		}
686 687 688
		status = hcd->driver->hub_control (hcd,
			typeReq, wValue, wIndex,
			tbuf, wLength);
689 690 691 692

		if (typeReq == GetHubDescriptor)
			usb_hub_adjust_deviceremovable(hcd->self.root_hub,
				(struct usb_hub_descriptor *)tbuf);
L
Linus Torvalds 已提交
693 694 695 696 697 698
		break;
error:
		/* "protocol stall" on error */
		status = -EPIPE;
	}

699
	if (status < 0) {
L
Linus Torvalds 已提交
700 701 702 703 704 705
		len = 0;
		if (status != -EPIPE) {
			dev_dbg (hcd->self.controller,
				"CTRL: TypeReq=0x%x val=0x%x "
				"idx=0x%x len=%d ==> %d\n",
				typeReq, wValue, wIndex,
706
				wLength, status);
L
Linus Torvalds 已提交
707
		}
708 709 710 711
	} else if (status > 0) {
		/* hub_control may return the length of data copied. */
		len = status;
		status = 0;
L
Linus Torvalds 已提交
712 713 714 715 716
	}
	if (len) {
		if (urb->transfer_buffer_length < len)
			len = urb->transfer_buffer_length;
		urb->actual_length = len;
717
		/* always USB_DIR_IN, toward host */
L
Linus Torvalds 已提交
718 719 720 721 722 723 724 725
		memcpy (ubuf, bufp, len);

		/* report whether RH hardware supports remote wakeup */
		if (patch_wakeup &&
				len > offsetof (struct usb_config_descriptor,
						bmAttributes))
			((struct usb_config_descriptor *)ubuf)->bmAttributes
				|= USB_CONFIG_ATT_WAKEUP;
726 727 728 729 730 731

		/* report whether RH hardware has an integrated TT */
		if (patch_protocol &&
				len > offsetof(struct usb_device_descriptor,
						bDeviceProtocol))
			((struct usb_device_descriptor *) ubuf)->
732
				bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
L
Linus Torvalds 已提交
733 734
	}

735 736
	kfree(tbuf);

L
Linus Torvalds 已提交
737
	/* any errors get returned through the urb completion */
738
	spin_lock_irq(&hcd_root_hub_lock);
739
	usb_hcd_unlink_urb_from_ep(hcd, urb);
A
Alan Stern 已提交
740
	usb_hcd_giveback_urb(hcd, urb, status);
741
	spin_unlock_irq(&hcd_root_hub_lock);
L
Linus Torvalds 已提交
742 743 744 745 746 747
	return 0;
}

/*-------------------------------------------------------------------------*/

/*
748 749 750
 * Root Hub interrupt transfers are polled using a timer if the
 * driver requests it; otherwise the driver is responsible for
 * calling usb_hcd_poll_rh_status() when an event occurs.
L
Linus Torvalds 已提交
751
 *
752 753
 * Completions are called in_interrupt(), but they may or may not
 * be in_irq().
L
Linus Torvalds 已提交
754
 */
755 756 757 758 759
void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
{
	struct urb	*urb;
	int		length;
	unsigned long	flags;
760
	char		buffer[6];	/* Any root hubs with > 31 ports? */
L
Linus Torvalds 已提交
761

762
	if (unlikely(!hcd->rh_pollable))
A
Alan Stern 已提交
763
		return;
764 765
	if (!hcd->uses_new_polling && !hcd->status_urb)
		return;
L
Linus Torvalds 已提交
766

767 768
	length = hcd->driver->hub_status_data(hcd, buffer);
	if (length > 0) {
L
Linus Torvalds 已提交
769

770
		/* try to complete the status urb */
771
		spin_lock_irqsave(&hcd_root_hub_lock, flags);
772 773
		urb = hcd->status_urb;
		if (urb) {
774
			clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
775 776 777
			hcd->status_urb = NULL;
			urb->actual_length = length;
			memcpy(urb->transfer_buffer, buffer, length);
778

779
			usb_hcd_unlink_urb_from_ep(hcd, urb);
A
Alan Stern 已提交
780
			usb_hcd_giveback_urb(hcd, urb, 0);
781
		} else {
782
			length = 0;
783
			set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
784
		}
785
		spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
L
Linus Torvalds 已提交
786 787
	}

788
	/* The USB 2.0 spec says 256 ms.  This is close enough and won't
789 790
	 * exceed that limit if HZ is 100. The math is more clunky than
	 * maybe expected, this is to make sure that all timers for USB devices
L
Lucas De Marchi 已提交
791
	 * fire at the same time to give the CPU a break in between */
792
	if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
793
			(length == 0 && hcd->status_urb != NULL))
794
		mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
L
Linus Torvalds 已提交
795
}
796
EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
L
Linus Torvalds 已提交
797 798

/* timer callback */
799 800 801 802 803 804
static void rh_timer_func (unsigned long _hcd)
{
	usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
}

/*-------------------------------------------------------------------------*/
L
Linus Torvalds 已提交
805

806
static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
L
Linus Torvalds 已提交
807
{
808
	int		retval;
L
Linus Torvalds 已提交
809
	unsigned long	flags;
810
	unsigned	len = 1 + (urb->dev->maxchild / 8);
L
Linus Torvalds 已提交
811

812
	spin_lock_irqsave (&hcd_root_hub_lock, flags);
813
	if (hcd->status_urb || urb->transfer_buffer_length < len) {
814 815
		dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
		retval = -EINVAL;
816 817
		goto done;
	}
L
Linus Torvalds 已提交
818

819 820 821
	retval = usb_hcd_link_urb_to_ep(hcd, urb);
	if (retval)
		goto done;
L
Linus Torvalds 已提交
822

823 824 825 826 827 828
	hcd->status_urb = urb;
	urb->hcpriv = hcd;	/* indicate it's queued */
	if (!hcd->uses_new_polling)
		mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));

	/* If a status change has already occurred, report it ASAP */
829
	else if (HCD_POLL_PENDING(hcd))
830 831 832
		mod_timer(&hcd->rh_timer, jiffies);
	retval = 0;
 done:
833 834
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
	return retval;
L
Linus Torvalds 已提交
835 836 837 838
}

static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
{
A
Alan Stern 已提交
839
	if (usb_endpoint_xfer_int(&urb->ep->desc))
840
		return rh_queue_status (hcd, urb);
A
Alan Stern 已提交
841
	if (usb_endpoint_xfer_control(&urb->ep->desc))
L
Linus Torvalds 已提交
842
		return rh_call_control (hcd, urb);
843
	return -EINVAL;
L
Linus Torvalds 已提交
844 845 846 847
}

/*-------------------------------------------------------------------------*/

848 849
/* Unlinks of root-hub control URBs are legal, but they don't do anything
 * since these URBs always execute synchronously.
850
 */
851
static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
L
Linus Torvalds 已提交
852
{
853
	unsigned long	flags;
854
	int		rc;
L
Linus Torvalds 已提交
855

856
	spin_lock_irqsave(&hcd_root_hub_lock, flags);
857 858 859 860
	rc = usb_hcd_check_unlink_urb(hcd, urb, status);
	if (rc)
		goto done;

A
Alan Stern 已提交
861
	if (usb_endpoint_num(&urb->ep->desc) == 0) {	/* Control URB */
862
		;	/* Do nothing */
863 864 865

	} else {				/* Status URB */
		if (!hcd->uses_new_polling)
866
			del_timer (&hcd->rh_timer);
867 868
		if (urb == hcd->status_urb) {
			hcd->status_urb = NULL;
869
			usb_hcd_unlink_urb_from_ep(hcd, urb);
A
Alan Stern 已提交
870
			usb_hcd_giveback_urb(hcd, urb, status);
871 872
		}
	}
873
 done:
874
	spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
875
	return rc;
L
Linus Torvalds 已提交
876 877
}

878 879 880 881 882


/*
 * Show & store the current value of authorized_default
 */
883 884
static ssize_t authorized_default_show(struct device *dev,
				       struct device_attribute *attr, char *buf)
885 886 887
{
	struct usb_device *rh_usb_dev = to_usb_device(dev);
	struct usb_bus *usb_bus = rh_usb_dev->bus;
888
	struct usb_hcd *hcd;
889

890 891
	hcd = bus_to_hcd(usb_bus);
	return snprintf(buf, PAGE_SIZE, "%u\n", !!HCD_DEV_AUTHORIZED(hcd));
892 893
}

894 895 896
static ssize_t authorized_default_store(struct device *dev,
					struct device_attribute *attr,
					const char *buf, size_t size)
897 898 899 900 901
{
	ssize_t result;
	unsigned val;
	struct usb_device *rh_usb_dev = to_usb_device(dev);
	struct usb_bus *usb_bus = rh_usb_dev->bus;
902
	struct usb_hcd *hcd;
903

904
	hcd = bus_to_hcd(usb_bus);
905 906
	result = sscanf(buf, "%u\n", &val);
	if (result == 1) {
907 908 909 910 911
		if (val)
			set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
		else
			clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);

912
		result = size;
913
	} else {
914
		result = -EINVAL;
915
	}
916 917
	return result;
}
918
static DEVICE_ATTR_RW(authorized_default);
919

920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
/*
 * interface_authorized_default_show - show default authorization status
 * for USB interfaces
 *
 * note: interface_authorized_default is the default value
 *       for initializing the authorized attribute of interfaces
 */
static ssize_t interface_authorized_default_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct usb_device *usb_dev = to_usb_device(dev);
	struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);

	return sprintf(buf, "%u\n", !!HCD_INTF_AUTHORIZED(hcd));
}

/*
 * interface_authorized_default_store - store default authorization status
 * for USB interfaces
 *
 * note: interface_authorized_default is the default value
 *       for initializing the authorized attribute of interfaces
 */
static ssize_t interface_authorized_default_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t count)
{
	struct usb_device *usb_dev = to_usb_device(dev);
	struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
	int rc = count;
	bool val;

	if (strtobool(buf, &val) != 0)
		return -EINVAL;

	if (val)
		set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
	else
		clear_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);

	return rc;
}
static DEVICE_ATTR_RW(interface_authorized_default);

963 964 965
/* Group all the USB bus attributes */
static struct attribute *usb_bus_attrs[] = {
		&dev_attr_authorized_default.attr,
966
		&dev_attr_interface_authorized_default.attr,
967 968 969 970 971 972 973 974 975 976
		NULL,
};

static struct attribute_group usb_bus_attr_group = {
	.name = NULL,	/* we want them in the same directory */
	.attrs = usb_bus_attrs,
};



L
Linus Torvalds 已提交
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
/*-------------------------------------------------------------------------*/

/**
 * usb_bus_init - shared initialization code
 * @bus: the bus structure being initialized
 *
 * This code is used to initialize a usb_bus structure, memory for which is
 * separately managed.
 */
static void usb_bus_init (struct usb_bus *bus)
{
	memset (&bus->devmap, 0, sizeof(struct usb_devmap));

	bus->devnum_next = 1;

	bus->root_hub = NULL;
	bus->busnum = -1;
	bus->bandwidth_allocated = 0;
	bus->bandwidth_int_reqs  = 0;
	bus->bandwidth_isoc_reqs = 0;
997
	mutex_init(&bus->usb_address0_mutex);
L
Linus Torvalds 已提交
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
}

/*-------------------------------------------------------------------------*/

/**
 * usb_register_bus - registers the USB host controller with the usb core
 * @bus: pointer to the bus to register
 * Context: !in_interrupt()
 *
 * Assigns a bus number, and links the controller into usbcore data
 * structures so that it can be seen by scanning the bus list.
1009 1010
 *
 * Return: 0 if successful. A negative error code otherwise.
L
Linus Torvalds 已提交
1011 1012 1013
 */
static int usb_register_bus(struct usb_bus *bus)
{
1014
	int result = -E2BIG;
L
Linus Torvalds 已提交
1015 1016
	int busnum;

1017
	mutex_lock(&usb_bus_list_lock);
1018 1019 1020
	busnum = idr_alloc(&usb_bus_idr, bus, 1, USB_MAXBUS, GFP_KERNEL);
	if (busnum < 0) {
		pr_err("%s: failed to get bus number\n", usbcore_name);
1021
		goto error_find_busnum;
L
Linus Torvalds 已提交
1022
	}
1023
	bus->busnum = busnum;
1024
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
1025

1026
	usb_notify_add_bus(bus);
L
Linus Torvalds 已提交
1027

1028 1029
	dev_info (bus->controller, "new USB bus registered, assigned bus "
		  "number %d\n", bus->busnum);
L
Linus Torvalds 已提交
1030
	return 0;
1031 1032 1033 1034

error_find_busnum:
	mutex_unlock(&usb_bus_list_lock);
	return result;
L
Linus Torvalds 已提交
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
}

/**
 * usb_deregister_bus - deregisters the USB host controller
 * @bus: pointer to the bus to deregister
 * Context: !in_interrupt()
 *
 * Recycles the bus number, and unlinks the controller from usbcore data
 * structures so that it won't be seen by scanning the bus list.
 */
static void usb_deregister_bus (struct usb_bus *bus)
{
	dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);

	/*
	 * NOTE: make sure that all the devices are removed by the
	 * controller code, as well as having it call this when cleaning
	 * itself up
	 */
1054
	mutex_lock(&usb_bus_list_lock);
1055
	idr_remove(&usb_bus_idr, bus->busnum);
1056
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
1057

1058
	usb_notify_remove_bus(bus);
L
Linus Torvalds 已提交
1059 1060 1061
}

/**
1062
 * register_root_hub - called by usb_add_hcd() to register a root hub
L
Linus Torvalds 已提交
1063 1064
 * @hcd: host controller for this root hub
 *
1065
 * This function registers the root hub with the USB subsystem.  It sets up
1066 1067 1068
 * the device properly in the device tree and then calls usb_new_device()
 * to register the usb device.  It also assigns the root hub's USB address
 * (always 1).
1069 1070
 *
 * Return: 0 if successful. A negative error code otherwise.
L
Linus Torvalds 已提交
1071
 */
1072
static int register_root_hub(struct usb_hcd *hcd)
L
Linus Torvalds 已提交
1073 1074
{
	struct device *parent_dev = hcd->self.controller;
1075
	struct usb_device *usb_dev = hcd->self.root_hub;
L
Linus Torvalds 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
	const int devnum = 1;
	int retval;

	usb_dev->devnum = devnum;
	usb_dev->bus->devnum_next = devnum + 1;
	memset (&usb_dev->bus->devmap.devicemap, 0,
			sizeof usb_dev->bus->devmap.devicemap);
	set_bit (devnum, usb_dev->bus->devmap.devicemap);
	usb_set_device_state(usb_dev, USB_STATE_ADDRESS);

1086
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
1087

1088
	usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
L
Linus Torvalds 已提交
1089 1090
	retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
	if (retval != sizeof usb_dev->descriptor) {
1091
		mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
1092
		dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
1093
				dev_name(&usb_dev->dev), retval);
L
Linus Torvalds 已提交
1094 1095
		return (retval < 0) ? retval : -EMSGSIZE;
	}
1096 1097

	if (le16_to_cpu(usb_dev->descriptor.bcdUSB) >= 0x0201) {
1098
		retval = usb_get_bos_descriptor(usb_dev);
1099 1100
		if (!retval) {
			usb_dev->lpm_capable = usb_device_supports_lpm(usb_dev);
1101
		} else if (usb_dev->speed >= USB_SPEED_SUPER) {
1102 1103 1104 1105 1106 1107
			mutex_unlock(&usb_bus_list_lock);
			dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
					dev_name(&usb_dev->dev), retval);
			return retval;
		}
	}
L
Linus Torvalds 已提交
1108 1109 1110 1111

	retval = usb_new_device (usb_dev);
	if (retval) {
		dev_err (parent_dev, "can't register root hub for %s, %d\n",
1112
				dev_name(&usb_dev->dev), retval);
1113
	} else {
L
Linus Torvalds 已提交
1114 1115 1116 1117 1118
		spin_lock_irq (&hcd_root_hub_lock);
		hcd->rh_registered = 1;
		spin_unlock_irq (&hcd_root_hub_lock);

		/* Did the HC die before the root hub was registered? */
1119
		if (HCD_DEAD(hcd))
L
Linus Torvalds 已提交
1120 1121
			usb_hc_died (hcd);	/* This time clean up */
	}
1122
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
1123 1124 1125 1126

	return retval;
}

1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
/*
 * usb_hcd_start_port_resume - a root-hub port is sending a resume signal
 * @bus: the bus which the root hub belongs to
 * @portnum: the port which is being resumed
 *
 * HCDs should call this function when they know that a resume signal is
 * being sent to a root-hub port.  The root hub will be prevented from
 * going into autosuspend until usb_hcd_end_port_resume() is called.
 *
 * The bus's private lock must be held by the caller.
 */
void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum)
{
	unsigned bit = 1 << portnum;

	if (!(bus->resuming_ports & bit)) {
		bus->resuming_ports |= bit;
		pm_runtime_get_noresume(&bus->root_hub->dev);
	}
}
EXPORT_SYMBOL_GPL(usb_hcd_start_port_resume);

/*
 * usb_hcd_end_port_resume - a root-hub port has stopped sending a resume signal
 * @bus: the bus which the root hub belongs to
 * @portnum: the port which is being resumed
 *
 * HCDs should call this function when they know that a resume signal has
 * stopped being sent to a root-hub port.  The root hub will be allowed to
 * autosuspend again.
 *
 * The bus's private lock must be held by the caller.
 */
void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum)
{
	unsigned bit = 1 << portnum;

	if (bus->resuming_ports & bit) {
		bus->resuming_ports &= ~bit;
		pm_runtime_put_noidle(&bus->root_hub->dev);
	}
}
EXPORT_SYMBOL_GPL(usb_hcd_end_port_resume);
L
Linus Torvalds 已提交
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179

/*-------------------------------------------------------------------------*/

/**
 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
 * @is_input: true iff the transaction sends data to the host
 * @isoc: true for isochronous transactions, false for interrupt ones
 * @bytecount: how many bytes in the transaction.
 *
1180 1181 1182
 * Return: Approximate bus time in nanoseconds for a periodic transaction.
 *
 * Note:
L
Linus Torvalds 已提交
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
 * scheduled in software, this function is only used for such scheduling.
 */
long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
{
	unsigned long	tmp;

	switch (speed) {
	case USB_SPEED_LOW: 	/* INTR only */
		if (is_input) {
			tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
1194
			return 64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
L
Linus Torvalds 已提交
1195 1196
		} else {
			tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1197
			return 64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
L
Linus Torvalds 已提交
1198 1199 1200 1201
		}
	case USB_SPEED_FULL:	/* ISOC or INTR */
		if (isoc) {
			tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1202
			return ((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp;
L
Linus Torvalds 已提交
1203 1204
		} else {
			tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1205
			return 9107L + BW_HOST_DELAY + tmp;
L
Linus Torvalds 已提交
1206 1207
		}
	case USB_SPEED_HIGH:	/* ISOC or INTR */
1208
		/* FIXME adjust for input vs output */
L
Linus Torvalds 已提交
1209
		if (isoc)
1210
			tmp = HS_NSECS_ISO (bytecount);
L
Linus Torvalds 已提交
1211
		else
1212
			tmp = HS_NSECS (bytecount);
L
Linus Torvalds 已提交
1213 1214 1215 1216 1217 1218
		return tmp;
	default:
		pr_debug ("%s: bogus device speed!\n", usbcore_name);
		return -1;
	}
}
1219
EXPORT_SYMBOL_GPL(usb_calc_bus_time);
L
Linus Torvalds 已提交
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229


/*-------------------------------------------------------------------------*/

/*
 * Generic HC operations.
 */

/*-------------------------------------------------------------------------*/

1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
/**
 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
 * @hcd: host controller to which @urb was submitted
 * @urb: URB being submitted
 *
 * Host controller drivers should call this routine in their enqueue()
 * method.  The HCD's private spinlock must be held and interrupts must
 * be disabled.  The actions carried out here are required for URB
 * submission, as well as for endpoint shutdown and for usb_kill_urb.
 *
1240
 * Return: 0 for no error, otherwise a negative error code (in which case
1241 1242 1243 1244 1245
 * the enqueue() method must fail).  If no error occurs but enqueue() fails
 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
 * the private spinlock and returning.
 */
int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
L
Linus Torvalds 已提交
1246
{
1247
	int		rc = 0;
L
Linus Torvalds 已提交
1248

1249
	spin_lock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1250

1251
	/* Check that the URB isn't being killed */
1252
	if (unlikely(atomic_read(&urb->reject))) {
1253 1254
		rc = -EPERM;
		goto done;
1255
	}
L
Linus Torvalds 已提交
1256

1257 1258 1259 1260
	if (unlikely(!urb->ep->enabled)) {
		rc = -ENOENT;
		goto done;
	}
L
Linus Torvalds 已提交
1261

1262 1263 1264 1265 1266
	if (unlikely(!urb->dev->can_submit)) {
		rc = -EHOSTUNREACH;
		goto done;
	}

L
Linus Torvalds 已提交
1267
	/*
1268 1269
	 * Check the host controller's state and add the URB to the
	 * endpoint's queue.
L
Linus Torvalds 已提交
1270
	 */
1271
	if (HCD_RH_RUNNING(hcd)) {
A
Alan Stern 已提交
1272
		urb->unlinked = 0;
1273
		list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1274
	} else {
1275 1276
		rc = -ESHUTDOWN;
		goto done;
L
Linus Torvalds 已提交
1277
	}
1278
 done:
1279
	spin_unlock(&hcd_urb_list_lock);
1280 1281
	return rc;
}
1282
EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1283

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
/**
 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
 * @hcd: host controller to which @urb was submitted
 * @urb: URB being checked for unlinkability
 * @status: error code to store in @urb if the unlink succeeds
 *
 * Host controller drivers should call this routine in their dequeue()
 * method.  The HCD's private spinlock must be held and interrupts must
 * be disabled.  The actions carried out here are required for making
 * sure than an unlink is valid.
 *
1295
 * Return: 0 for no error, otherwise a negative error code (in which case
1296 1297 1298 1299 1300 1301 1302 1303
 * the dequeue() method must fail).  The possible error codes are:
 *
 *	-EIDRM: @urb was not submitted or has already completed.
 *		The completion function may not have been called yet.
 *
 *	-EBUSY: @urb has already been unlinked.
 */
int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
1304 1305 1306 1307 1308 1309 1310 1311 1312
		int status)
{
	struct list_head	*tmp;

	/* insist the urb is still queued */
	list_for_each(tmp, &urb->ep->urb_list) {
		if (tmp == &urb->urb_list)
			break;
	}
1313 1314
	if (tmp != &urb->urb_list)
		return -EIDRM;
L
Linus Torvalds 已提交
1315

1316 1317
	/* Any status except -EINPROGRESS means something already started to
	 * unlink this URB from the hardware.  So there's no more work to do.
L
Linus Torvalds 已提交
1318
	 */
A
Alan Stern 已提交
1319
	if (urb->unlinked)
1320
		return -EBUSY;
A
Alan Stern 已提交
1321
	urb->unlinked = status;
1322
	return 0;
1323
}
1324
EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1325

1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
/**
 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
 * @hcd: host controller to which @urb was submitted
 * @urb: URB being unlinked
 *
 * Host controller drivers should call this routine before calling
 * usb_hcd_giveback_urb().  The HCD's private spinlock must be held and
 * interrupts must be disabled.  The actions carried out here are required
 * for URB completion.
 */
void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
1337 1338
{
	/* clear all state linking urb to this dev (and hcd) */
1339
	spin_lock(&hcd_urb_list_lock);
1340
	list_del_init(&urb->urb_list);
1341
	spin_unlock(&hcd_urb_list_lock);
1342
}
1343
EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1344

M
Magnus Damm 已提交
1345 1346 1347 1348 1349
/*
 * Some usb host controllers can only perform dma using a small SRAM area.
 * The usb core itself is however optimized for host controllers that can dma
 * using regular system memory - like pci devices doing bus mastering.
 *
M
Mickael Maison 已提交
1350
 * To support host controllers with limited dma capabilities we provide dma
M
Magnus Damm 已提交
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
 * For this to work properly the host controller code must first use the
 * function dma_declare_coherent_memory() to point out which memory area
 * that should be used for dma allocations.
 *
 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
 * dma using dma_alloc_coherent() which in turn allocates from the memory
 * area pointed out with dma_declare_coherent_memory().
 *
 * So, to summarize...
 *
 * - We need "local" memory, canonical example being
 *   a small SRAM on a discrete controller being the
 *   only memory that the controller can read ...
 *   (a) "normal" kernel memory is no good, and
 *   (b) there's not enough to share
 *
 * - The only *portable* hook for such stuff in the
 *   DMA framework is dma_declare_coherent_memory()
 *
 * - So we use that, even though the primary requirement
1372
 *   is that the memory be "local" (hence addressable
M
Magnus Damm 已提交
1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
 *   by that device), not "coherent".
 *
 */

static int hcd_alloc_coherent(struct usb_bus *bus,
			      gfp_t mem_flags, dma_addr_t *dma_handle,
			      void **vaddr_handle, size_t size,
			      enum dma_data_direction dir)
{
	unsigned char *vaddr;

1384 1385 1386 1387 1388
	if (*vaddr_handle == NULL) {
		WARN_ON_ONCE(1);
		return -EFAULT;
	}

M
Magnus Damm 已提交
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
	vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
				 mem_flags, dma_handle);
	if (!vaddr)
		return -ENOMEM;

	/*
	 * Store the virtual address of the buffer at the end
	 * of the allocated dma buffer. The size of the buffer
	 * may be uneven so use unaligned functions instead
	 * of just rounding up. It makes sense to optimize for
	 * memory footprint over access speed since the amount
	 * of memory available for dma may be limited.
	 */
	put_unaligned((unsigned long)*vaddr_handle,
		      (unsigned long *)(vaddr + size));

	if (dir == DMA_TO_DEVICE)
		memcpy(vaddr, *vaddr_handle, size);

	*vaddr_handle = vaddr;
	return 0;
}

static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
			      void **vaddr_handle, size_t size,
			      enum dma_data_direction dir)
{
	unsigned char *vaddr = *vaddr_handle;

	vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));

	if (dir == DMA_FROM_DEVICE)
		memcpy(vaddr, *vaddr_handle, size);

	hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);

	*vaddr_handle = vaddr;
	*dma_handle = 0;
}

1429
void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
{
	if (urb->transfer_flags & URB_SETUP_MAP_SINGLE)
		dma_unmap_single(hcd->self.controller,
				urb->setup_dma,
				sizeof(struct usb_ctrlrequest),
				DMA_TO_DEVICE);
	else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
		hcd_free_coherent(urb->dev->bus,
				&urb->setup_dma,
				(void **) &urb->setup_packet,
				sizeof(struct usb_ctrlrequest),
				DMA_TO_DEVICE);

1443 1444 1445
	/* Make it safe to call this routine more than once */
	urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
}
1446
EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1447

1448 1449 1450 1451 1452 1453 1454 1455
static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
{
	if (hcd->driver->unmap_urb_for_dma)
		hcd->driver->unmap_urb_for_dma(hcd, urb);
	else
		usb_hcd_unmap_urb_for_dma(hcd, urb);
}

1456
void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1457 1458 1459
{
	enum dma_data_direction dir;

1460
	usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1461

1462 1463 1464
	dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
	if (urb->transfer_flags & URB_DMA_MAP_SG)
		dma_unmap_sg(hcd->self.controller,
1465
				urb->sg,
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
				urb->num_sgs,
				dir);
	else if (urb->transfer_flags & URB_DMA_MAP_PAGE)
		dma_unmap_page(hcd->self.controller,
				urb->transfer_dma,
				urb->transfer_buffer_length,
				dir);
	else if (urb->transfer_flags & URB_DMA_MAP_SINGLE)
		dma_unmap_single(hcd->self.controller,
				urb->transfer_dma,
				urb->transfer_buffer_length,
				dir);
	else if (urb->transfer_flags & URB_MAP_LOCAL)
		hcd_free_coherent(urb->dev->bus,
				&urb->transfer_dma,
				&urb->transfer_buffer,
				urb->transfer_buffer_length,
				dir);

	/* Make it safe to call this routine more than once */
1486
	urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
1487 1488
			URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
}
1489
EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
1490

M
Magnus Damm 已提交
1491 1492
static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
			   gfp_t mem_flags)
1493 1494 1495 1496 1497 1498 1499 1500 1501
{
	if (hcd->driver->map_urb_for_dma)
		return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
	else
		return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
}

int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
			    gfp_t mem_flags)
1502
{
M
Magnus Damm 已提交
1503 1504 1505
	enum dma_data_direction dir;
	int ret = 0;

1506 1507
	/* Map the URB's buffers for DMA access.
	 * Lower level HCD code should use *_dma exclusively,
1508 1509
	 * unless it uses pio or talks to another transport,
	 * or uses the provided scatter gather list for bulk.
L
Linus Torvalds 已提交
1510
	 */
M
Magnus Damm 已提交
1511

A
Alan Stern 已提交
1512
	if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1513 1514
		if (hcd->self.uses_pio_for_control)
			return ret;
1515
		if (hcd->self.uses_dma) {
M
Magnus Damm 已提交
1516
			urb->setup_dma = dma_map_single(
L
Linus Torvalds 已提交
1517 1518
					hcd->self.controller,
					urb->setup_packet,
M
Magnus Damm 已提交
1519
					sizeof(struct usb_ctrlrequest),
L
Linus Torvalds 已提交
1520
					DMA_TO_DEVICE);
1521 1522 1523
			if (dma_mapping_error(hcd->self.controller,
						urb->setup_dma))
				return -EAGAIN;
1524
			urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1525
		} else if (hcd->driver->flags & HCD_LOCAL_MEM) {
M
Magnus Damm 已提交
1526 1527 1528 1529 1530 1531
			ret = hcd_alloc_coherent(
					urb->dev->bus, mem_flags,
					&urb->setup_dma,
					(void **)&urb->setup_packet,
					sizeof(struct usb_ctrlrequest),
					DMA_TO_DEVICE);
1532 1533 1534
			if (ret)
				return ret;
			urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1535
		}
M
Magnus Damm 已提交
1536 1537 1538
	}

	dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1539
	if (urb->transfer_buffer_length != 0
M
Magnus Damm 已提交
1540
	    && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1541
		if (hcd->self.uses_dma) {
1542
			if (urb->num_sgs) {
1543 1544 1545 1546 1547 1548 1549 1550 1551
				int n;

				/* We don't support sg for isoc transfers ! */
				if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
					WARN_ON(1);
					return -EINVAL;
				}

				n = dma_map_sg(
1552
						hcd->self.controller,
1553
						urb->sg,
1554 1555 1556 1557 1558 1559
						urb->num_sgs,
						dir);
				if (n <= 0)
					ret = -EAGAIN;
				else
					urb->transfer_flags |= URB_DMA_MAP_SG;
1560 1561
				urb->num_mapped_sgs = n;
				if (n != urb->num_sgs)
1562 1563 1564
					urb->transfer_flags |=
							URB_DMA_SG_COMBINED;
			} else if (urb->sg) {
1565
				struct scatterlist *sg = urb->sg;
1566 1567 1568 1569 1570 1571 1572
				urb->transfer_dma = dma_map_page(
						hcd->self.controller,
						sg_page(sg),
						sg->offset,
						urb->transfer_buffer_length,
						dir);
				if (dma_mapping_error(hcd->self.controller,
1573
						urb->transfer_dma))
1574 1575 1576
					ret = -EAGAIN;
				else
					urb->transfer_flags |= URB_DMA_MAP_PAGE;
1577 1578 1579
			} else if (is_vmalloc_addr(urb->transfer_buffer)) {
				WARN_ONCE(1, "transfer buffer not dma capable\n");
				ret = -EAGAIN;
1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
			} else {
				urb->transfer_dma = dma_map_single(
						hcd->self.controller,
						urb->transfer_buffer,
						urb->transfer_buffer_length,
						dir);
				if (dma_mapping_error(hcd->self.controller,
						urb->transfer_dma))
					ret = -EAGAIN;
				else
					urb->transfer_flags |= URB_DMA_MAP_SINGLE;
			}
1592
		} else if (hcd->driver->flags & HCD_LOCAL_MEM) {
M
Magnus Damm 已提交
1593 1594 1595 1596 1597 1598
			ret = hcd_alloc_coherent(
					urb->dev->bus, mem_flags,
					&urb->transfer_dma,
					&urb->transfer_buffer,
					urb->transfer_buffer_length,
					dir);
1599 1600
			if (ret == 0)
				urb->transfer_flags |= URB_MAP_LOCAL;
M
Magnus Damm 已提交
1601
		}
1602 1603
		if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
				URB_SETUP_MAP_LOCAL)))
1604
			usb_hcd_unmap_urb_for_dma(hcd, urb);
L
Linus Torvalds 已提交
1605
	}
M
Magnus Damm 已提交
1606
	return ret;
1607
}
1608
EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
L
Linus Torvalds 已提交
1609

1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
/*-------------------------------------------------------------------------*/

/* may be called in any context with a valid urb->dev usecount
 * caller surrenders "ownership" of urb
 * expects usb_submit_urb() to have sanity checked and conditioned all
 * inputs in the urb
 */
int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
{
	int			status;
	struct usb_hcd		*hcd = bus_to_hcd(urb->dev->bus);

	/* increment urb's reference count as part of giving it to the HCD
	 * (which will control it).  HCD guarantees that it either returns
	 * an error or calls giveback(), but not both.
	 */
	usb_get_urb(urb);
	atomic_inc(&urb->use_count);
1628
	atomic_inc(&urb->dev->urbnum);
1629 1630 1631 1632 1633 1634 1635 1636 1637
	usbmon_urb_submit(&hcd->self, urb);

	/* NOTE requirements on root-hub callers (usbfs and the hub
	 * driver, for now):  URBs' urb->transfer_buffer must be
	 * valid and usb_buffer_{sync,unmap}() not be needed, since
	 * they could clobber root hub response data.  Also, control
	 * URBs must be submitted in process context with interrupts
	 * enabled.
	 */
M
Magnus Damm 已提交
1638

1639
	if (is_root_hub(urb->dev)) {
1640
		status = rh_urb_enqueue(hcd, urb);
1641 1642 1643 1644 1645
	} else {
		status = map_urb_for_dma(hcd, urb, mem_flags);
		if (likely(status == 0)) {
			status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
			if (unlikely(status))
1646
				unmap_urb_for_dma(hcd, urb);
1647 1648
		}
	}
1649 1650

	if (unlikely(status)) {
L
Linus Torvalds 已提交
1651
		usbmon_urb_submit_error(&hcd->self, urb, status);
A
Alan Stern 已提交
1652
		urb->hcpriv = NULL;
1653 1654
		INIT_LIST_HEAD(&urb->urb_list);
		atomic_dec(&urb->use_count);
1655
		atomic_dec(&urb->dev->urbnum);
1656
		if (atomic_read(&urb->reject))
1657 1658
			wake_up(&usb_kill_urb_queue);
		usb_put_urb(urb);
L
Linus Torvalds 已提交
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669
	}
	return status;
}

/*-------------------------------------------------------------------------*/

/* this makes the hcd giveback() the urb more quickly, by kicking it
 * off hardware queues (which may take a while) and returning it as
 * soon as practical.  we've already set up the urb's return status,
 * but we can't know if the callback completed already.
 */
1670
static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
L
Linus Torvalds 已提交
1671 1672 1673
{
	int		value;

1674
	if (is_root_hub(urb->dev))
1675
		value = usb_rh_urb_dequeue(hcd, urb, status);
L
Linus Torvalds 已提交
1676 1677 1678 1679 1680
	else {

		/* The only reason an HCD might fail this call is if
		 * it has not yet fully queued the urb to begin with.
		 * Such failures should be harmless. */
1681
		value = hcd->driver->urb_dequeue(hcd, urb, status);
L
Linus Torvalds 已提交
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
	}
	return value;
}

/*
 * called in any context
 *
 * caller guarantees urb won't be recycled till both unlink()
 * and the urb's completion function return
 */
A
Alan Stern 已提交
1692
int usb_hcd_unlink_urb (struct urb *urb, int status)
L
Linus Torvalds 已提交
1693
{
1694
	struct usb_hcd		*hcd;
1695
	struct usb_device	*udev = urb->dev;
1696 1697
	int			retval = -EIDRM;
	unsigned long		flags;
L
Linus Torvalds 已提交
1698

1699 1700 1701 1702 1703 1704 1705 1706
	/* Prevent the device and bus from going away while
	 * the unlink is carried out.  If they are already gone
	 * then urb->use_count must be 0, since disconnected
	 * devices can't have any active URBs.
	 */
	spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
	if (atomic_read(&urb->use_count) > 0) {
		retval = 0;
1707
		usb_get_dev(udev);
1708 1709 1710 1711 1712
	}
	spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
	if (retval == 0) {
		hcd = bus_to_hcd(urb->dev->bus);
		retval = unlink1(hcd, urb, status);
1713 1714 1715 1716 1717 1718
		if (retval == 0)
			retval = -EINPROGRESS;
		else if (retval != -EIDRM && retval != -EBUSY)
			dev_dbg(&udev->dev, "hcd_unlink_urb %p fail %d\n",
					urb, retval);
		usb_put_dev(udev);
1719
	}
L
Linus Torvalds 已提交
1720 1721 1722 1723 1724
	return retval;
}

/*-------------------------------------------------------------------------*/

1725 1726 1727
static void __usb_hcd_giveback_urb(struct urb *urb)
{
	struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1728
	struct usb_anchor *anchor = urb->anchor;
1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
	int status = urb->unlinked;
	unsigned long flags;

	urb->hcpriv = NULL;
	if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
	    urb->actual_length < urb->transfer_buffer_length &&
	    !status))
		status = -EREMOTEIO;

	unmap_urb_for_dma(hcd, urb);
	usbmon_urb_complete(&hcd->self, urb, status);
1740
	usb_anchor_suspend_wakeups(anchor);
1741
	usb_unanchor_urb(urb);
1742 1743
	if (likely(status == 0))
		usb_led_activity(USB_LED_EVENT_HOST);
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761

	/* pass ownership to the completion handler */
	urb->status = status;

	/*
	 * We disable local IRQs here avoid possible deadlock because
	 * drivers may call spin_lock() to hold lock which might be
	 * acquired in one hard interrupt handler.
	 *
	 * The local_irq_save()/local_irq_restore() around complete()
	 * will be removed if current USB drivers have been cleaned up
	 * and no one may trigger the above deadlock situation when
	 * running complete() in tasklet.
	 */
	local_irq_save(flags);
	urb->complete(urb);
	local_irq_restore(flags);

1762
	usb_anchor_resume_wakeups(anchor);
1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
	atomic_dec(&urb->use_count);
	if (unlikely(atomic_read(&urb->reject)))
		wake_up(&usb_kill_urb_queue);
	usb_put_urb(urb);
}

static void usb_giveback_urb_bh(unsigned long param)
{
	struct giveback_urb_bh *bh = (struct giveback_urb_bh *)param;
	struct list_head local_list;

	spin_lock_irq(&bh->lock);
	bh->running = true;
 restart:
	list_replace_init(&bh->head, &local_list);
	spin_unlock_irq(&bh->lock);

	while (!list_empty(&local_list)) {
		struct urb *urb;

		urb = list_entry(local_list.next, struct urb, urb_list);
		list_del_init(&urb->urb_list);
1785
		bh->completing_ep = urb->ep;
1786
		__usb_hcd_giveback_urb(urb);
1787
		bh->completing_ep = NULL;
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
	}

	/* check if there are new URBs to giveback */
	spin_lock_irq(&bh->lock);
	if (!list_empty(&bh->head))
		goto restart;
	bh->running = false;
	spin_unlock_irq(&bh->lock);
}

A
Alan Stern 已提交
1798 1799 1800 1801
/**
 * usb_hcd_giveback_urb - return URB from HCD to device driver
 * @hcd: host controller returning the URB
 * @urb: urb being returned to the USB device driver.
A
Alan Stern 已提交
1802
 * @status: completion status code for the URB.
A
Alan Stern 已提交
1803 1804 1805 1806 1807 1808 1809
 * Context: in_interrupt()
 *
 * This hands the URB from HCD to its USB device driver, using its
 * completion function.  The HCD has freed all per-urb resources
 * (and is done using urb->hcpriv).  It also released all HCD locks;
 * the device driver won't cause problems if it frees, modifies,
 * or resubmits this URB.
A
Alan Stern 已提交
1810
 *
A
Alan Stern 已提交
1811
 * If @urb was unlinked, the value of @status will be overridden by
A
Alan Stern 已提交
1812 1813
 * @urb->unlinked.  Erroneous short transfers are detected in case
 * the HCD hasn't checked for them.
A
Alan Stern 已提交
1814
 */
A
Alan Stern 已提交
1815
void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
A
Alan Stern 已提交
1816
{
1817 1818
	struct giveback_urb_bh *bh;
	bool running, high_prio_bh;
A
Alan Stern 已提交
1819

1820 1821 1822
	/* pass status to tasklet via unlinked */
	if (likely(!urb->unlinked))
		urb->unlinked = status;
1823

1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
	if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
		__usb_hcd_giveback_urb(urb);
		return;
	}

	if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe)) {
		bh = &hcd->high_prio_bh;
		high_prio_bh = true;
	} else {
		bh = &hcd->low_prio_bh;
		high_prio_bh = false;
	}

	spin_lock(&bh->lock);
	list_add_tail(&urb->urb_list, &bh->head);
	running = bh->running;
	spin_unlock(&bh->lock);

	if (running)
		;
	else if (high_prio_bh)
		tasklet_hi_schedule(&bh->bh);
	else
		tasklet_schedule(&bh->bh);
A
Alan Stern 已提交
1848
}
1849
EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
A
Alan Stern 已提交
1850 1851 1852

/*-------------------------------------------------------------------------*/

1853 1854 1855
/* Cancel all URBs pending on this endpoint and wait for the endpoint's
 * queue to drain completely.  The caller must first insure that no more
 * URBs can be submitted for this endpoint.
L
Linus Torvalds 已提交
1856
 */
1857
void usb_hcd_flush_endpoint(struct usb_device *udev,
A
Alan Stern 已提交
1858
		struct usb_host_endpoint *ep)
L
Linus Torvalds 已提交
1859 1860 1861 1862
{
	struct usb_hcd		*hcd;
	struct urb		*urb;

1863 1864
	if (!ep)
		return;
1865
	might_sleep();
1866
	hcd = bus_to_hcd(udev->bus);
L
Linus Torvalds 已提交
1867

1868
	/* No more submits can occur */
1869
	spin_lock_irq(&hcd_urb_list_lock);
1870
rescan:
L
Linus Torvalds 已提交
1871
	list_for_each_entry (urb, &ep->urb_list, urb_list) {
A
Alan Stern 已提交
1872
		int	is_in;
L
Linus Torvalds 已提交
1873

A
Alan Stern 已提交
1874
		if (urb->unlinked)
L
Linus Torvalds 已提交
1875 1876
			continue;
		usb_get_urb (urb);
A
Alan Stern 已提交
1877
		is_in = usb_urb_dir_in(urb);
1878
		spin_unlock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1879

1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895
		/* kick hcd */
		unlink1(hcd, urb, -ESHUTDOWN);
		dev_dbg (hcd->self.controller,
			"shutdown urb %p ep%d%s%s\n",
			urb, usb_endpoint_num(&ep->desc),
			is_in ? "in" : "out",
			({	char *s;

				 switch (usb_endpoint_type(&ep->desc)) {
				 case USB_ENDPOINT_XFER_CONTROL:
					s = ""; break;
				 case USB_ENDPOINT_XFER_BULK:
					s = "-bulk"; break;
				 case USB_ENDPOINT_XFER_INT:
					s = "-intr"; break;
				 default:
1896
					s = "-iso"; break;
1897 1898 1899
				};
				s;
			}));
L
Linus Torvalds 已提交
1900 1901 1902
		usb_put_urb (urb);

		/* list contents may have changed */
1903
		spin_lock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1904 1905
		goto rescan;
	}
1906
	spin_unlock_irq(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1907

1908
	/* Wait until the endpoint queue is completely empty */
1909
	while (!list_empty (&ep->urb_list)) {
1910
		spin_lock_irq(&hcd_urb_list_lock);
1911 1912 1913 1914 1915 1916 1917 1918

		/* The list may have changed while we acquired the spinlock */
		urb = NULL;
		if (!list_empty (&ep->urb_list)) {
			urb = list_entry (ep->urb_list.prev, struct urb,
					urb_list);
			usb_get_urb (urb);
		}
1919
		spin_unlock_irq(&hcd_urb_list_lock);
1920 1921 1922 1923 1924 1925

		if (urb) {
			usb_kill_urb (urb);
			usb_put_urb (urb);
		}
	}
L
Linus Torvalds 已提交
1926 1927
}

1928
/**
1929 1930 1931
 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
 *				the bus bandwidth
 * @udev: target &usb_device
1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945
 * @new_config: new configuration to install
 * @cur_alt: the current alternate interface setting
 * @new_alt: alternate interface setting that is being installed
 *
 * To change configurations, pass in the new configuration in new_config,
 * and pass NULL for cur_alt and new_alt.
 *
 * To reset a device's configuration (put the device in the ADDRESSED state),
 * pass in NULL for new_config, cur_alt, and new_alt.
 *
 * To change alternate interface settings, pass in NULL for new_config,
 * pass in the current alternate interface setting in cur_alt,
 * and pass in the new alternate interface setting in new_alt.
 *
1946
 * Return: An error if the requested bandwidth change exceeds the
1947
 * bus bandwidth or host controller internal resources.
1948
 */
1949
int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1950
		struct usb_host_config *new_config,
1951 1952
		struct usb_host_interface *cur_alt,
		struct usb_host_interface *new_alt)
1953 1954
{
	int num_intfs, i, j;
1955
	struct usb_host_interface *alt = NULL;
1956 1957 1958 1959 1960 1961 1962 1963 1964
	int ret = 0;
	struct usb_hcd *hcd;
	struct usb_host_endpoint *ep;

	hcd = bus_to_hcd(udev->bus);
	if (!hcd->driver->check_bandwidth)
		return 0;

	/* Configuration is being removed - set configuration 0 */
1965
	if (!new_config && !cur_alt) {
1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001
		for (i = 1; i < 16; ++i) {
			ep = udev->ep_out[i];
			if (ep)
				hcd->driver->drop_endpoint(hcd, udev, ep);
			ep = udev->ep_in[i];
			if (ep)
				hcd->driver->drop_endpoint(hcd, udev, ep);
		}
		hcd->driver->check_bandwidth(hcd, udev);
		return 0;
	}
	/* Check if the HCD says there's enough bandwidth.  Enable all endpoints
	 * each interface's alt setting 0 and ask the HCD to check the bandwidth
	 * of the bus.  There will always be bandwidth for endpoint 0, so it's
	 * ok to exclude it.
	 */
	if (new_config) {
		num_intfs = new_config->desc.bNumInterfaces;
		/* Remove endpoints (except endpoint 0, which is always on the
		 * schedule) from the old config from the schedule
		 */
		for (i = 1; i < 16; ++i) {
			ep = udev->ep_out[i];
			if (ep) {
				ret = hcd->driver->drop_endpoint(hcd, udev, ep);
				if (ret < 0)
					goto reset;
			}
			ep = udev->ep_in[i];
			if (ep) {
				ret = hcd->driver->drop_endpoint(hcd, udev, ep);
				if (ret < 0)
					goto reset;
			}
		}
		for (i = 0; i < num_intfs; ++i) {
2002 2003 2004 2005 2006
			struct usb_host_interface *first_alt;
			int iface_num;

			first_alt = &new_config->intf_cache[i]->altsetting[0];
			iface_num = first_alt->desc.bInterfaceNumber;
2007
			/* Set up endpoints for alternate interface setting 0 */
2008
			alt = usb_find_alt_setting(new_config, iface_num, 0);
2009 2010
			if (!alt)
				/* No alt setting 0? Pick the first setting. */
2011
				alt = first_alt;
2012

2013 2014 2015 2016 2017 2018 2019
			for (j = 0; j < alt->desc.bNumEndpoints; j++) {
				ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
				if (ret < 0)
					goto reset;
			}
		}
	}
2020
	if (cur_alt && new_alt) {
2021 2022 2023
		struct usb_interface *iface = usb_ifnum_to_if(udev,
				cur_alt->desc.bInterfaceNumber);

2024 2025
		if (!iface)
			return -EINVAL;
2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040
		if (iface->resetting_device) {
			/*
			 * The USB core just reset the device, so the xHCI host
			 * and the device will think alt setting 0 is installed.
			 * However, the USB core will pass in the alternate
			 * setting installed before the reset as cur_alt.  Dig
			 * out the alternate setting 0 structure, or the first
			 * alternate setting if a broken device doesn't have alt
			 * setting 0.
			 */
			cur_alt = usb_altnum_to_altsetting(iface, 0);
			if (!cur_alt)
				cur_alt = &iface->altsetting[0];
		}

2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
		/* Drop all the endpoints in the current alt setting */
		for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
			ret = hcd->driver->drop_endpoint(hcd, udev,
					&cur_alt->endpoint[i]);
			if (ret < 0)
				goto reset;
		}
		/* Add all the endpoints in the new alt setting */
		for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
			ret = hcd->driver->add_endpoint(hcd, udev,
					&new_alt->endpoint[i]);
			if (ret < 0)
				goto reset;
		}
	}
2056 2057 2058 2059 2060 2061 2062
	ret = hcd->driver->check_bandwidth(hcd, udev);
reset:
	if (ret < 0)
		hcd->driver->reset_bandwidth(hcd, udev);
	return ret;
}

2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081
/* Disables the endpoint: synchronizes with the hcd to make sure all
 * endpoint state is gone from hardware.  usb_hcd_flush_endpoint() must
 * have been called previously.  Use for set_configuration, set_interface,
 * driver removal, physical disconnect.
 *
 * example:  a qh stored in ep->hcpriv, holding state related to endpoint
 * type, maxpacket size, toggle, halt status, and scheduling.
 */
void usb_hcd_disable_endpoint(struct usb_device *udev,
		struct usb_host_endpoint *ep)
{
	struct usb_hcd		*hcd;

	might_sleep();
	hcd = bus_to_hcd(udev->bus);
	if (hcd->driver->endpoint_disable)
		hcd->driver->endpoint_disable(hcd, ep);
}

2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
/**
 * usb_hcd_reset_endpoint - reset host endpoint state
 * @udev: USB device.
 * @ep:   the endpoint to reset.
 *
 * Resets any host endpoint state such as the toggle bit, sequence
 * number and current window.
 */
void usb_hcd_reset_endpoint(struct usb_device *udev,
			    struct usb_host_endpoint *ep)
{
	struct usb_hcd *hcd = bus_to_hcd(udev->bus);

	if (hcd->driver->endpoint_reset)
		hcd->driver->endpoint_reset(hcd, ep);
	else {
		int epnum = usb_endpoint_num(&ep->desc);
		int is_out = usb_endpoint_dir_out(&ep->desc);
		int is_control = usb_endpoint_xfer_control(&ep->desc);

		usb_settoggle(udev, epnum, is_out, 0);
		if (is_control)
			usb_settoggle(udev, epnum, !is_out, 0);
	}
}

2108 2109 2110 2111 2112 2113 2114 2115
/**
 * usb_alloc_streams - allocate bulk endpoint stream IDs.
 * @interface:		alternate setting that includes all endpoints.
 * @eps:		array of endpoints that need streams.
 * @num_eps:		number of endpoints in the array.
 * @num_streams:	number of streams to allocate.
 * @mem_flags:		flags hcd should use to allocate memory.
 *
2116
 * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
2117 2118
 * Drivers may queue multiple transfers to different stream IDs, which may
 * complete in a different order than they were queued.
2119 2120 2121
 *
 * Return: On success, the number of allocated streams. On failure, a negative
 * error code.
2122 2123 2124 2125 2126 2127 2128
 */
int usb_alloc_streams(struct usb_interface *interface,
		struct usb_host_endpoint **eps, unsigned int num_eps,
		unsigned int num_streams, gfp_t mem_flags)
{
	struct usb_hcd *hcd;
	struct usb_device *dev;
2129
	int i, ret;
2130 2131 2132 2133 2134

	dev = interface_to_usbdev(interface);
	hcd = bus_to_hcd(dev->bus);
	if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
		return -EINVAL;
2135
	if (dev->speed < USB_SPEED_SUPER)
2136
		return -EINVAL;
2137 2138
	if (dev->state < USB_STATE_CONFIGURED)
		return -ENODEV;
2139

2140 2141
	for (i = 0; i < num_eps; i++) {
		/* Streams only apply to bulk endpoints. */
2142 2143
		if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
			return -EINVAL;
2144 2145 2146 2147
		/* Re-alloc is not allowed */
		if (eps[i]->streams)
			return -EINVAL;
	}
2148

2149
	ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
2150
			num_streams, mem_flags);
2151 2152 2153 2154 2155 2156 2157
	if (ret < 0)
		return ret;

	for (i = 0; i < num_eps; i++)
		eps[i]->streams = ret;

	return ret;
2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169
}
EXPORT_SYMBOL_GPL(usb_alloc_streams);

/**
 * usb_free_streams - free bulk endpoint stream IDs.
 * @interface:	alternate setting that includes all endpoints.
 * @eps:	array of endpoints to remove streams from.
 * @num_eps:	number of endpoints in the array.
 * @mem_flags:	flags hcd should use to allocate memory.
 *
 * Reverts a group of bulk endpoints back to not using stream IDs.
 * Can fail if we are given bad arguments, or HCD is broken.
2170
 *
2171
 * Return: 0 on success. On failure, a negative error code.
2172
 */
2173
int usb_free_streams(struct usb_interface *interface,
2174 2175 2176 2177 2178
		struct usb_host_endpoint **eps, unsigned int num_eps,
		gfp_t mem_flags)
{
	struct usb_hcd *hcd;
	struct usb_device *dev;
2179
	int i, ret;
2180 2181 2182

	dev = interface_to_usbdev(interface);
	hcd = bus_to_hcd(dev->bus);
2183
	if (dev->speed < USB_SPEED_SUPER)
2184
		return -EINVAL;
2185

2186
	/* Double-free is not allowed */
2187
	for (i = 0; i < num_eps; i++)
2188
		if (!eps[i] || !eps[i]->streams)
2189
			return -EINVAL;
2190

2191 2192 2193 2194 2195 2196 2197 2198
	ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
	if (ret < 0)
		return ret;

	for (i = 0; i < num_eps; i++)
		eps[i]->streams = 0;

	return ret;
2199 2200 2201
}
EXPORT_SYMBOL_GPL(usb_free_streams);

2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212
/* Protect against drivers that try to unlink URBs after the device
 * is gone, by waiting until all unlinks for @udev are finished.
 * Since we don't currently track URBs by device, simply wait until
 * nothing is running in the locked region of usb_hcd_unlink_urb().
 */
void usb_hcd_synchronize_unlinks(struct usb_device *udev)
{
	spin_lock_irq(&hcd_urb_unlink_lock);
	spin_unlock_irq(&hcd_urb_unlink_lock);
}

L
Linus Torvalds 已提交
2213 2214
/*-------------------------------------------------------------------------*/

A
Alan Stern 已提交
2215 2216 2217 2218 2219
/* called in any context */
int usb_hcd_get_frame_number (struct usb_device *udev)
{
	struct usb_hcd	*hcd = bus_to_hcd(udev->bus);

2220
	if (!HCD_RH_RUNNING(hcd))
A
Alan Stern 已提交
2221 2222 2223 2224 2225 2226
		return -ESHUTDOWN;
	return hcd->driver->get_frame_number (hcd);
}

/*-------------------------------------------------------------------------*/

2227
#ifdef	CONFIG_PM
L
Linus Torvalds 已提交
2228

A
Alan Stern 已提交
2229
int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
L
Linus Torvalds 已提交
2230
{
2231
	struct usb_hcd	*hcd = bus_to_hcd(rhdev->bus);
2232 2233
	int		status;
	int		old_state = hcd->state;
L
Linus Torvalds 已提交
2234

2235 2236 2237
	dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
			(PMSG_IS_AUTO(msg) ? "auto-" : ""),
			rhdev->do_remote_wakeup);
2238 2239 2240 2241 2242
	if (HCD_DEAD(hcd)) {
		dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
		return 0;
	}

2243 2244 2245
	if (!hcd->driver->bus_suspend) {
		status = -ENOENT;
	} else {
2246
		clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2247 2248 2249 2250 2251
		hcd->state = HC_STATE_QUIESCING;
		status = hcd->driver->bus_suspend(hcd);
	}
	if (status == 0) {
		usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
2252
		hcd->state = HC_STATE_SUSPENDED;
2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264

		/* Did we race with a root-hub wakeup event? */
		if (rhdev->do_remote_wakeup) {
			char	buffer[6];

			status = hcd->driver->hub_status_data(hcd, buffer);
			if (status != 0) {
				dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
				hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
				status = -EBUSY;
			}
		}
2265
	} else {
2266 2267 2268 2269 2270 2271
		spin_lock_irq(&hcd_root_hub_lock);
		if (!HCD_DEAD(hcd)) {
			set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
			hcd->state = old_state;
		}
		spin_unlock_irq(&hcd_root_hub_lock);
2272
		dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2273
				"suspend", status);
2274
	}
2275
	return status;
L
Linus Torvalds 已提交
2276 2277
}

A
Alan Stern 已提交
2278
int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
L
Linus Torvalds 已提交
2279
{
2280
	struct usb_hcd	*hcd = bus_to_hcd(rhdev->bus);
2281
	int		status;
2282
	int		old_state = hcd->state;
L
Linus Torvalds 已提交
2283

2284 2285
	dev_dbg(&rhdev->dev, "usb %sresume\n",
			(PMSG_IS_AUTO(msg) ? "auto-" : ""));
2286 2287 2288 2289
	if (HCD_DEAD(hcd)) {
		dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
		return 0;
	}
2290
	if (!hcd->driver->bus_resume)
2291
		return -ENOENT;
2292
	if (HCD_RH_RUNNING(hcd))
2293
		return 0;
2294

2295
	hcd->state = HC_STATE_RESUMING;
2296
	status = hcd->driver->bus_resume(hcd);
2297
	clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2298
	if (status == 0) {
A
Alan Stern 已提交
2299 2300 2301
		struct usb_device *udev;
		int port1;

2302 2303 2304 2305 2306 2307 2308 2309 2310
		spin_lock_irq(&hcd_root_hub_lock);
		if (!HCD_DEAD(hcd)) {
			usb_set_device_state(rhdev, rhdev->actconfig
					? USB_STATE_CONFIGURED
					: USB_STATE_ADDRESS);
			set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
			hcd->state = HC_STATE_RUNNING;
		}
		spin_unlock_irq(&hcd_root_hub_lock);
A
Alan Stern 已提交
2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324

		/*
		 * Check whether any of the enabled ports on the root hub are
		 * unsuspended.  If they are then a TRSMRCY delay is needed
		 * (this is what the USB-2 spec calls a "global resume").
		 * Otherwise we can skip the delay.
		 */
		usb_hub_for_each_child(rhdev, port1, udev) {
			if (udev->state != USB_STATE_NOTATTACHED &&
					!udev->port_is_suspended) {
				usleep_range(10000, 11000);	/* TRSMRCY */
				break;
			}
		}
2325
	} else {
2326
		hcd->state = old_state;
2327
		dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2328
				"resume", status);
2329 2330
		if (status != -ESHUTDOWN)
			usb_hc_died(hcd);
2331 2332
	}
	return status;
L
Linus Torvalds 已提交
2333 2334
}

2335 2336 2337 2338 2339 2340
/* Workqueue routine for root-hub remote wakeup */
static void hcd_resume_work(struct work_struct *work)
{
	struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
	struct usb_device *udev = hcd->self.root_hub;

2341
	usb_remote_wakeup(udev);
2342 2343
}

L
Linus Torvalds 已提交
2344
/**
2345
 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
L
Linus Torvalds 已提交
2346 2347 2348 2349
 * @hcd: host controller for this root hub
 *
 * The USB host controller calls this function when its root hub is
 * suspended (with the remote wakeup feature enabled) and a remote
2350 2351
 * wakeup request is received.  The routine submits a workqueue request
 * to resume the root hub (that is, manage its downstream ports again).
L
Linus Torvalds 已提交
2352 2353 2354 2355 2356 2357
 */
void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
{
	unsigned long flags;

	spin_lock_irqsave (&hcd_root_hub_lock, flags);
2358 2359
	if (hcd->rh_registered) {
		set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2360
		queue_work(pm_wq, &hcd->wakeup_work);
2361
	}
L
Linus Torvalds 已提交
2362 2363
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
}
2364
EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
L
Linus Torvalds 已提交
2365

2366
#endif	/* CONFIG_PM */
L
Linus Torvalds 已提交
2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378

/*-------------------------------------------------------------------------*/

#ifdef	CONFIG_USB_OTG

/**
 * usb_bus_start_enum - start immediate enumeration (for OTG)
 * @bus: the bus (must use hcd framework)
 * @port_num: 1-based number of port; usually bus->otg_port
 * Context: in_interrupt()
 *
 * Starts enumeration, with an immediate reset followed later by
2379
 * hub_wq identifying and possibly configuring the device.
L
Linus Torvalds 已提交
2380 2381
 * This is needed by OTG controller drivers, where it helps meet
 * HNP protocol timing requirements for starting a port reset.
2382 2383
 *
 * Return: 0 if successful.
L
Linus Torvalds 已提交
2384 2385 2386 2387 2388 2389 2390 2391 2392 2393
 */
int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
{
	struct usb_hcd		*hcd;
	int			status = -EOPNOTSUPP;

	/* NOTE: since HNP can't start by grabbing the bus's address0_sem,
	 * boards with root hubs hooked up to internal devices (instead of
	 * just the OTG port) may need more attention to resetting...
	 */
2394
	hcd = bus_to_hcd(bus);
L
Linus Torvalds 已提交
2395 2396 2397
	if (port_num && hcd->driver->start_port_reset)
		status = hcd->driver->start_port_reset(hcd, port_num);

2398
	/* allocate hub_wq shortly after (first) root port reset finishes;
L
Linus Torvalds 已提交
2399 2400 2401 2402 2403 2404
	 * it may issue others, until at least 50 msecs have passed.
	 */
	if (status == 0)
		mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
	return status;
}
2405
EXPORT_SYMBOL_GPL(usb_bus_start_enum);
L
Linus Torvalds 已提交
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417

#endif

/*-------------------------------------------------------------------------*/

/**
 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
 * @irq: the IRQ being raised
 * @__hcd: pointer to the HCD whose IRQ is being signaled
 *
 * If the controller isn't HALTed, calls the driver's irq handler.
 * Checks whether the controller is now dead.
2418 2419
 *
 * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
L
Linus Torvalds 已提交
2420
 */
2421
irqreturn_t usb_hcd_irq (int irq, void *__hcd)
L
Linus Torvalds 已提交
2422 2423
{
	struct usb_hcd		*hcd = __hcd;
2424
	irqreturn_t		rc;
L
Linus Torvalds 已提交
2425

A
Alan Stern 已提交
2426
	if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
2427
		rc = IRQ_NONE;
A
Alan Stern 已提交
2428
	else if (hcd->driver->irq(hcd) == IRQ_NONE)
2429
		rc = IRQ_NONE;
A
Alan Stern 已提交
2430
	else
2431 2432 2433
		rc = IRQ_HANDLED;

	return rc;
L
Linus Torvalds 已提交
2434
}
D
Dong Nguyen 已提交
2435
EXPORT_SYMBOL_GPL(usb_hcd_irq);
L
Linus Torvalds 已提交
2436 2437 2438 2439 2440 2441 2442 2443 2444

/*-------------------------------------------------------------------------*/

/**
 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
 * @hcd: pointer to the HCD representing the controller
 *
 * This is called by bus glue to report a USB host controller that died
 * while operations may still have been pending.  It's called automatically
2445 2446 2447
 * by the PCI glue, so only glue for non-PCI busses should need to call it.
 *
 * Only call this function with the primary HCD.
L
Linus Torvalds 已提交
2448 2449 2450 2451 2452 2453 2454 2455
 */
void usb_hc_died (struct usb_hcd *hcd)
{
	unsigned long flags;

	dev_err (hcd->self.controller, "HC died; cleaning up\n");

	spin_lock_irqsave (&hcd_root_hub_lock, flags);
2456 2457
	clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
	set_bit(HCD_FLAG_DEAD, &hcd->flags);
L
Linus Torvalds 已提交
2458
	if (hcd->rh_registered) {
2459
		clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
L
Linus Torvalds 已提交
2460

2461
		/* make hub_wq clean up old urbs and devices */
L
Linus Torvalds 已提交
2462 2463
		usb_set_device_state (hcd->self.root_hub,
				USB_STATE_NOTATTACHED);
2464
		usb_kick_hub_wq(hcd->self.root_hub);
L
Linus Torvalds 已提交
2465
	}
2466 2467 2468 2469 2470
	if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
		hcd = hcd->shared_hcd;
		if (hcd->rh_registered) {
			clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);

2471
			/* make hub_wq clean up old urbs and devices */
2472 2473
			usb_set_device_state(hcd->self.root_hub,
					USB_STATE_NOTATTACHED);
2474
			usb_kick_hub_wq(hcd->self.root_hub);
2475 2476
		}
	}
L
Linus Torvalds 已提交
2477
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2478
	/* Make sure that the other roothub is also deallocated. */
L
Linus Torvalds 已提交
2479 2480 2481 2482 2483
}
EXPORT_SYMBOL_GPL (usb_hc_died);

/*-------------------------------------------------------------------------*/

2484 2485 2486 2487 2488 2489 2490 2491
static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
{

	spin_lock_init(&bh->lock);
	INIT_LIST_HEAD(&bh->head);
	tasklet_init(&bh->bh, usb_giveback_urb_bh, (unsigned long)bh);
}

L
Linus Torvalds 已提交
2492
/**
2493
 * usb_create_shared_hcd - create and initialize an HCD structure
L
Linus Torvalds 已提交
2494 2495 2496
 * @driver: HC driver that will use this hcd
 * @dev: device for this HC, stored in hcd->self.controller
 * @bus_name: value to store in hcd->self.bus_name
2497 2498
 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
 *              PCI device.  Only allocate certain resources for the primary HCD
L
Linus Torvalds 已提交
2499 2500 2501 2502 2503 2504
 * Context: !in_interrupt()
 *
 * Allocate a struct usb_hcd, with extra space at the end for the
 * HC driver's private data.  Initialize the generic members of the
 * hcd structure.
 *
2505 2506
 * Return: On success, a pointer to the created and initialized HCD structure.
 * On failure (e.g. if memory is unavailable), %NULL.
L
Linus Torvalds 已提交
2507
 */
2508 2509 2510
struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
		struct device *dev, const char *bus_name,
		struct usb_hcd *primary_hcd)
L
Linus Torvalds 已提交
2511 2512 2513
{
	struct usb_hcd *hcd;

2514
	hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
L
Linus Torvalds 已提交
2515 2516 2517 2518
	if (!hcd) {
		dev_dbg (dev, "hcd alloc failed\n");
		return NULL;
	}
2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529
	if (primary_hcd == NULL) {
		hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
				GFP_KERNEL);
		if (!hcd->bandwidth_mutex) {
			kfree(hcd);
			dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
			return NULL;
		}
		mutex_init(hcd->bandwidth_mutex);
		dev_set_drvdata(dev, hcd);
	} else {
2530
		mutex_lock(&usb_port_peer_mutex);
2531 2532 2533 2534 2535
		hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
		hcd->primary_hcd = primary_hcd;
		primary_hcd->primary_hcd = primary_hcd;
		hcd->shared_hcd = primary_hcd;
		primary_hcd->shared_hcd = hcd;
2536
		mutex_unlock(&usb_port_peer_mutex);
2537 2538
	}

2539
	kref_init(&hcd->kref);
L
Linus Torvalds 已提交
2540 2541 2542 2543

	usb_bus_init(&hcd->self);
	hcd->self.controller = dev;
	hcd->self.bus_name = bus_name;
2544
	hcd->self.uses_dma = (dev->dma_mask != NULL);
L
Linus Torvalds 已提交
2545 2546

	init_timer(&hcd->rh_timer);
2547 2548
	hcd->rh_timer.function = rh_timer_func;
	hcd->rh_timer.data = (unsigned long) hcd;
2549
#ifdef CONFIG_PM
2550 2551
	INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
#endif
L
Linus Torvalds 已提交
2552 2553

	hcd->driver = driver;
2554
	hcd->speed = driver->flags & HCD_MASK;
L
Linus Torvalds 已提交
2555 2556 2557 2558
	hcd->product_desc = (driver->product_desc) ? driver->product_desc :
			"USB Host Controller";
	return hcd;
}
2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571
EXPORT_SYMBOL_GPL(usb_create_shared_hcd);

/**
 * usb_create_hcd - create and initialize an HCD structure
 * @driver: HC driver that will use this hcd
 * @dev: device for this HC, stored in hcd->self.controller
 * @bus_name: value to store in hcd->self.bus_name
 * Context: !in_interrupt()
 *
 * Allocate a struct usb_hcd, with extra space at the end for the
 * HC driver's private data.  Initialize the generic members of the
 * hcd structure.
 *
2572 2573
 * Return: On success, a pointer to the created and initialized HCD
 * structure. On failure (e.g. if memory is unavailable), %NULL.
2574 2575 2576 2577 2578 2579
 */
struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
		struct device *dev, const char *bus_name)
{
	return usb_create_shared_hcd(driver, dev, bus_name, NULL);
}
2580
EXPORT_SYMBOL_GPL(usb_create_hcd);
L
Linus Torvalds 已提交
2581

2582 2583 2584 2585 2586 2587
/*
 * Roothubs that share one PCI device must also share the bandwidth mutex.
 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
 * deallocated.
 *
 * Make sure to only deallocate the bandwidth_mutex when the primary HCD is
2588 2589 2590
 * freed.  When hcd_release() is called for either hcd in a peer set
 * invalidate the peer's ->shared_hcd and ->primary_hcd pointers to
 * block new peering attempts
2591
 */
2592
static void hcd_release(struct kref *kref)
2593 2594 2595
{
	struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);

2596
	mutex_lock(&usb_port_peer_mutex);
2597 2598
	if (usb_hcd_is_primary_hcd(hcd))
		kfree(hcd->bandwidth_mutex);
2599 2600 2601 2602 2603 2604 2605 2606
	if (hcd->shared_hcd) {
		struct usb_hcd *peer = hcd->shared_hcd;

		peer->shared_hcd = NULL;
		if (peer->primary_hcd == hcd)
			peer->primary_hcd = NULL;
	}
	mutex_unlock(&usb_port_peer_mutex);
2607 2608 2609 2610 2611 2612 2613 2614 2615
	kfree(hcd);
}

struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
{
	if (hcd)
		kref_get (&hcd->kref);
	return hcd;
}
2616
EXPORT_SYMBOL_GPL(usb_get_hcd);
2617

L
Linus Torvalds 已提交
2618 2619
void usb_put_hcd (struct usb_hcd *hcd)
{
2620 2621
	if (hcd)
		kref_put (&hcd->kref, hcd_release);
L
Linus Torvalds 已提交
2622
}
2623
EXPORT_SYMBOL_GPL(usb_put_hcd);
L
Linus Torvalds 已提交
2624

2625 2626 2627 2628 2629 2630 2631 2632
int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
{
	if (!hcd->primary_hcd)
		return 1;
	return hcd == hcd->primary_hcd;
}
EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);

2633 2634 2635 2636 2637 2638 2639 2640
int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
{
	if (!hcd->driver->find_raw_port_number)
		return port1;

	return hcd->driver->find_raw_port_number(hcd, port1);
}

2641 2642 2643 2644 2645 2646
static int usb_hcd_request_irqs(struct usb_hcd *hcd,
		unsigned int irqnum, unsigned long irqflags)
{
	int retval;

	if (hcd->driver->irq) {
2647

2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663
		snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
				hcd->driver->description, hcd->self.busnum);
		retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
				hcd->irq_descr, hcd);
		if (retval != 0) {
			dev_err(hcd->self.controller,
					"request interrupt %d failed\n",
					irqnum);
			return retval;
		}
		hcd->irq = irqnum;
		dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
				(hcd->driver->flags & HCD_MEMORY) ?
					"io mem" : "io base",
					(unsigned long long)hcd->rsrc_start);
	} else {
2664
		hcd->irq = 0;
2665 2666 2667 2668 2669 2670 2671 2672 2673
		if (hcd->rsrc_start)
			dev_info(hcd->self.controller, "%s 0x%08llx\n",
					(hcd->driver->flags & HCD_MEMORY) ?
					"io mem" : "io base",
					(unsigned long long)hcd->rsrc_start);
	}
	return 0;
}

2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688
/*
 * Before we free this root hub, flush in-flight peering attempts
 * and disable peer lookups
 */
static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
{
	struct usb_device *rhdev;

	mutex_lock(&usb_port_peer_mutex);
	rhdev = hcd->self.root_hub;
	hcd->self.root_hub = NULL;
	mutex_unlock(&usb_port_peer_mutex);
	usb_put_dev(rhdev);
}

L
Linus Torvalds 已提交
2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701
/**
 * usb_add_hcd - finish generic HCD structure initialization and register
 * @hcd: the usb_hcd structure to initialize
 * @irqnum: Interrupt line to allocate
 * @irqflags: Interrupt type flags
 *
 * Finish the remaining parts of generic HCD initialization: allocate the
 * buffers of consistent memory, register the bus, request the IRQ line,
 * and call the driver's reset() and start() routines.
 */
int usb_add_hcd(struct usb_hcd *hcd,
		unsigned int irqnum, unsigned long irqflags)
{
2702 2703
	int retval;
	struct usb_device *rhdev;
L
Linus Torvalds 已提交
2704

2705
	if (IS_ENABLED(CONFIG_USB_PHY) && !hcd->usb_phy) {
2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717
		struct usb_phy *phy = usb_get_phy_dev(hcd->self.controller, 0);

		if (IS_ERR(phy)) {
			retval = PTR_ERR(phy);
			if (retval == -EPROBE_DEFER)
				return retval;
		} else {
			retval = usb_phy_init(phy);
			if (retval) {
				usb_put_phy(phy);
				return retval;
			}
2718
			hcd->usb_phy = phy;
2719 2720 2721 2722
			hcd->remove_phy = 1;
		}
	}

2723
	if (IS_ENABLED(CONFIG_GENERIC_PHY) && !hcd->phy) {
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742
		struct phy *phy = phy_get(hcd->self.controller, "usb");

		if (IS_ERR(phy)) {
			retval = PTR_ERR(phy);
			if (retval == -EPROBE_DEFER)
				goto err_phy;
		} else {
			retval = phy_init(phy);
			if (retval) {
				phy_put(phy);
				goto err_phy;
			}
			retval = phy_power_on(phy);
			if (retval) {
				phy_exit(phy);
				phy_put(phy);
				goto err_phy;
			}
			hcd->phy = phy;
2743
			hcd->remove_phy = 1;
2744 2745 2746
		}
	}

L
Linus Torvalds 已提交
2747 2748
	dev_info(hcd->self.controller, "%s\n", hcd->product_desc);

2749
	/* Keep old behaviour if authorized_default is not in [0, 1]. */
2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760
	if (authorized_default < 0 || authorized_default > 1) {
		if (hcd->wireless)
			clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
		else
			set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
	} else {
		if (authorized_default)
			set_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
		else
			clear_bit(HCD_FLAG_DEV_AUTHORIZED, &hcd->flags);
	}
2761 2762
	set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);

2763 2764 2765
	/* per default all interfaces are authorized */
	set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);

2766
	/* HC is in reset state, but accessible.  Now do the one-time init,
2767
	 * bottom up so that hcds can customize the root hubs before hub_wq
2768 2769
	 * starts talking to them.  (Note, bus id is assigned early too.)
	 */
2770 2771
	retval = hcd_buffer_create(hcd);
	if (retval != 0) {
L
Linus Torvalds 已提交
2772
		dev_dbg(hcd->self.controller, "pool alloc failed\n");
2773
		goto err_create_buf;
L
Linus Torvalds 已提交
2774 2775
	}

2776 2777
	retval = usb_register_bus(&hcd->self);
	if (retval < 0)
2778
		goto err_register_bus;
L
Linus Torvalds 已提交
2779

2780 2781
	rhdev = usb_alloc_dev(NULL, &hcd->self, 0);
	if (rhdev == NULL) {
2782 2783 2784 2785
		dev_err(hcd->self.controller, "unable to allocate root hub\n");
		retval = -ENOMEM;
		goto err_allocate_root_hub;
	}
2786
	mutex_lock(&usb_port_peer_mutex);
2787
	hcd->self.root_hub = rhdev;
2788
	mutex_unlock(&usb_port_peer_mutex);
2789

2790
	switch (hcd->speed) {
2791 2792 2793 2794 2795 2796
	case HCD_USB11:
		rhdev->speed = USB_SPEED_FULL;
		break;
	case HCD_USB2:
		rhdev->speed = USB_SPEED_HIGH;
		break;
2797 2798 2799
	case HCD_USB25:
		rhdev->speed = USB_SPEED_WIRELESS;
		break;
2800 2801 2802
	case HCD_USB3:
		rhdev->speed = USB_SPEED_SUPER;
		break;
2803 2804 2805
	case HCD_USB31:
		rhdev->speed = USB_SPEED_SUPER_PLUS;
		break;
2806
	default:
2807
		retval = -EINVAL;
2808
		goto err_set_rh_speed;
2809
	}
2810

2811 2812 2813 2814
	/* wakeup flag init defaults to "everything works" for root hubs,
	 * but drivers can override it in reset() if needed, along with
	 * recording the overall controller's system wakeup capability.
	 */
2815
	device_set_wakeup_capable(&rhdev->dev, 1);
2816

2817 2818 2819 2820 2821 2822
	/* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
	 * registered.  But since the controller can die at any time,
	 * let's initialize the flag before touching the hardware.
	 */
	set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);

2823 2824 2825
	/* "reset" is misnamed; its role is now one-time init. the controller
	 * should already have been reset (and boot firmware kicked off etc).
	 */
2826 2827 2828 2829 2830 2831 2832
	if (hcd->driver->reset) {
		retval = hcd->driver->reset(hcd);
		if (retval < 0) {
			dev_err(hcd->self.controller, "can't setup: %d\n",
					retval);
			goto err_hcd_driver_setup;
		}
2833
	}
2834
	hcd->rh_pollable = 1;
2835

2836 2837 2838
	/* NOTE: root hub and controller capabilities may not be the same */
	if (device_can_wakeup(hcd->self.controller)
			&& device_can_wakeup(&hcd->self.root_hub->dev))
2839 2840
		dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");

2841 2842 2843 2844
	/* initialize tasklets */
	init_giveback_urb_bh(&hcd->high_prio_bh);
	init_giveback_urb_bh(&hcd->low_prio_bh);

2845 2846 2847 2848
	/* enable irqs just before we start the controller,
	 * if the BIOS provides legacy PCI irqs.
	 */
	if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
2849 2850 2851 2852
		retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
		if (retval)
			goto err_request_irq;
	}
L
Linus Torvalds 已提交
2853

2854
	hcd->state = HC_STATE_RUNNING;
2855 2856
	retval = hcd->driver->start(hcd);
	if (retval < 0) {
L
Linus Torvalds 已提交
2857
		dev_err(hcd->self.controller, "startup error %d\n", retval);
2858
		goto err_hcd_driver_start;
L
Linus Torvalds 已提交
2859 2860
	}

2861
	/* starting here, usbcore will pay attention to this root hub */
2862 2863
	retval = register_root_hub(hcd);
	if (retval != 0)
2864 2865
		goto err_register_root_hub;

2866 2867 2868 2869 2870 2871
	retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
	if (retval < 0) {
		printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
		       retval);
		goto error_create_attr_group;
	}
2872
	if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2873
		usb_hcd_poll_rh_status(hcd);
2874

L
Linus Torvalds 已提交
2875 2876
	return retval;

2877
error_create_attr_group:
2878
	clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2879 2880 2881 2882 2883 2884
	if (HC_IS_RUNNING(hcd->state))
		hcd->state = HC_STATE_QUIESCING;
	spin_lock_irq(&hcd_root_hub_lock);
	hcd->rh_registered = 0;
	spin_unlock_irq(&hcd_root_hub_lock);

2885
#ifdef CONFIG_PM
2886 2887
	cancel_work_sync(&hcd->wakeup_work);
#endif
2888
	mutex_lock(&usb_bus_list_lock);
2889
	usb_disconnect(&rhdev);		/* Sets rhdev to NULL */
2890
	mutex_unlock(&usb_bus_list_lock);
2891
err_register_root_hub:
2892
	hcd->rh_pollable = 0;
2893
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2894
	del_timer_sync(&hcd->rh_timer);
2895
	hcd->driver->stop(hcd);
2896
	hcd->state = HC_STATE_HALT;
2897
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2898
	del_timer_sync(&hcd->rh_timer);
2899
err_hcd_driver_start:
2900
	if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
L
Linus Torvalds 已提交
2901
		free_irq(irqnum, hcd);
2902 2903
err_request_irq:
err_hcd_driver_setup:
2904
err_set_rh_speed:
2905
	usb_put_invalidate_rhdev(hcd);
2906
err_allocate_root_hub:
L
Linus Torvalds 已提交
2907
	usb_deregister_bus(&hcd->self);
2908
err_register_bus:
L
Linus Torvalds 已提交
2909
	hcd_buffer_destroy(hcd);
2910
err_create_buf:
2911
	if (IS_ENABLED(CONFIG_GENERIC_PHY) && hcd->remove_phy && hcd->phy) {
2912 2913 2914 2915 2916 2917
		phy_power_off(hcd->phy);
		phy_exit(hcd->phy);
		phy_put(hcd->phy);
		hcd->phy = NULL;
	}
err_phy:
2918 2919 2920 2921
	if (hcd->remove_phy && hcd->usb_phy) {
		usb_phy_shutdown(hcd->usb_phy);
		usb_put_phy(hcd->usb_phy);
		hcd->usb_phy = NULL;
2922
	}
L
Linus Torvalds 已提交
2923
	return retval;
2924
}
2925
EXPORT_SYMBOL_GPL(usb_add_hcd);
L
Linus Torvalds 已提交
2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936

/**
 * usb_remove_hcd - shutdown processing for generic HCDs
 * @hcd: the usb_hcd structure to remove
 * Context: !in_interrupt()
 *
 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
 * invoking the HCD's stop() method.
 */
void usb_remove_hcd(struct usb_hcd *hcd)
{
2937 2938
	struct usb_device *rhdev = hcd->self.root_hub;

L
Linus Torvalds 已提交
2939 2940
	dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);

2941 2942
	usb_get_dev(rhdev);
	sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2943

2944
	clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
L
Linus Torvalds 已提交
2945 2946 2947 2948 2949 2950 2951
	if (HC_IS_RUNNING (hcd->state))
		hcd->state = HC_STATE_QUIESCING;

	dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
	spin_lock_irq (&hcd_root_hub_lock);
	hcd->rh_registered = 0;
	spin_unlock_irq (&hcd_root_hub_lock);
2952

2953
#ifdef CONFIG_PM
2954
	cancel_work_sync(&hcd->wakeup_work);
2955 2956
#endif

2957
	mutex_lock(&usb_bus_list_lock);
2958
	usb_disconnect(&rhdev);		/* Sets rhdev to NULL */
2959
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
2960

2961 2962 2963 2964 2965 2966 2967 2968 2969 2970
	/*
	 * tasklet_kill() isn't needed here because:
	 * - driver's disconnect() called from usb_disconnect() should
	 *   make sure its URBs are completed during the disconnect()
	 *   callback
	 *
	 * - it is too late to run complete() here since driver may have
	 *   been removed already now
	 */

2971 2972 2973 2974 2975 2976
	/* Prevent any more root-hub status calls from the timer.
	 * The HCD might still restart the timer (if a port status change
	 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
	 * the hub_status_data() callback.
	 */
	hcd->rh_pollable = 0;
2977
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2978 2979
	del_timer_sync(&hcd->rh_timer);

L
Linus Torvalds 已提交
2980 2981 2982
	hcd->driver->stop(hcd);
	hcd->state = HC_STATE_HALT;

2983
	/* In case the HCD restarted the timer, stop it again. */
2984
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
A
Alan Stern 已提交
2985 2986
	del_timer_sync(&hcd->rh_timer);

2987
	if (usb_hcd_is_primary_hcd(hcd)) {
2988
		if (hcd->irq > 0)
2989 2990
			free_irq(hcd->irq, hcd);
	}
2991

L
Linus Torvalds 已提交
2992 2993
	usb_deregister_bus(&hcd->self);
	hcd_buffer_destroy(hcd);
2994

2995
	if (IS_ENABLED(CONFIG_GENERIC_PHY) && hcd->remove_phy && hcd->phy) {
2996 2997 2998 2999 3000
		phy_power_off(hcd->phy);
		phy_exit(hcd->phy);
		phy_put(hcd->phy);
		hcd->phy = NULL;
	}
3001 3002 3003 3004
	if (hcd->remove_phy && hcd->usb_phy) {
		usb_phy_shutdown(hcd->usb_phy);
		usb_put_phy(hcd->usb_phy);
		hcd->usb_phy = NULL;
3005
	}
3006 3007

	usb_put_invalidate_rhdev(hcd);
L
Linus Torvalds 已提交
3008
}
3009
EXPORT_SYMBOL_GPL(usb_remove_hcd);
L
Linus Torvalds 已提交
3010

3011
void
3012
usb_hcd_platform_shutdown(struct platform_device *dev)
3013 3014 3015 3016 3017 3018
{
	struct usb_hcd *hcd = platform_get_drvdata(dev);

	if (hcd->driver->shutdown)
		hcd->driver->shutdown(hcd);
}
3019
EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
3020

L
Linus Torvalds 已提交
3021 3022
/*-------------------------------------------------------------------------*/

3023
#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
L
Linus Torvalds 已提交
3024

3025
const struct usb_mon_operations *mon_ops;
L
Linus Torvalds 已提交
3026 3027 3028 3029 3030 3031 3032 3033

/*
 * The registration is unlocked.
 * We do it this way because we do not want to lock in hot paths.
 *
 * Notice that the code is minimally error-proof. Because usbmon needs
 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
 */
3034

3035
int usb_mon_register(const struct usb_mon_operations *ops)
L
Linus Torvalds 已提交
3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058
{

	if (mon_ops)
		return -EBUSY;

	mon_ops = ops;
	mb();
	return 0;
}
EXPORT_SYMBOL_GPL (usb_mon_register);

void usb_mon_deregister (void)
{

	if (mon_ops == NULL) {
		printk(KERN_ERR "USB: monitor was not registered\n");
		return;
	}
	mon_ops = NULL;
	mb();
}
EXPORT_SYMBOL_GPL (usb_mon_deregister);

3059
#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */