hcd.c 82.8 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>
L
Linus Torvalds 已提交
43 44

#include <linux/usb.h>
45
#include <linux/usb/hcd.h>
L
Linus Torvalds 已提交
46 47 48 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

#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.
 */

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

85 86 87 88
/* Keep track of which host controller drivers are loaded */
unsigned long usb_hcds_loaded;
EXPORT_SYMBOL_GPL(usb_hcds_loaded);

L
Linus Torvalds 已提交
89 90 91 92 93 94 95
/* host controllers we manage */
LIST_HEAD (usb_bus_list);
EXPORT_SYMBOL_GPL (usb_bus_list);

/* used when allocating bus numbers */
#define USB_MAXBUS		64
struct usb_busmap {
96
	unsigned long busmap[USB_MAXBUS / (8*sizeof (unsigned long))];
L
Linus Torvalds 已提交
97 98 99 100
};
static struct usb_busmap busmap;

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

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

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

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

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

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

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

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

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

131 132 133 134 135 136 137 138 139 140 141
/* usb 3.0 root hub device descriptor */
static const u8 usb3_rh_dev_descriptor[18] = {
	0x12,       /*  __u8  bLength; */
	0x01,       /*  __u8  bDescriptorType; Device */
	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 */

142
	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation 0x1d6b */
143
	0x03, 0x00, /*  __le16 idProduct; device 0x0003 */
144 145 146 147 148 149 150 151
	KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */

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

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
/* usb 2.5 (wireless USB 1.0) root hub device descriptor */
static const u8 usb25_rh_dev_descriptor[18] = {
	0x12,       /*  __u8  bLength; */
	0x01,       /*  __u8  bDescriptorType; Device */
	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 已提交
173
/* usb 2.0 root hub device descriptor */
174
static const u8 usb2_rh_dev_descriptor[18] = {
L
Linus Torvalds 已提交
175 176 177 178 179 180
	0x12,       /*  __u8  bLength; */
	0x01,       /*  __u8  bDescriptorType; Device */
	0x00, 0x02, /*  __le16 bcdUSB; v2.0 */

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

184
	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation 0x1d6b */
185
	0x02, 0x00, /*  __le16 idProduct; device 0x0002 */
L
Linus Torvalds 已提交
186 187 188 189 190 191 192 193 194 195 196
	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 */
197
static const u8 usb11_rh_dev_descriptor[18] = {
L
Linus Torvalds 已提交
198 199 200 201 202 203 204
	0x12,       /*  __u8  bLength; */
	0x01,       /*  __u8  bDescriptorType; Device */
	0x10, 0x01, /*  __le16 bcdUSB; v1.1 */

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

207
	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation 0x1d6b */
208
	0x01, 0x00, /*  __le16 idProduct; device 0x0001 */
L
Linus Torvalds 已提交
209 210 211 212 213 214 215 216 217 218 219 220 221
	KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */

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


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

/* Configuration descriptors for our root hubs */

222
static const u8 fs_rh_config_descriptor[] = {
L
Linus Torvalds 已提交
223 224 225 226 227 228 229 230

	/* one configuration */
	0x09,       /*  __u8  bLength; */
	0x02,       /*  __u8  bDescriptorType; Configuration */
	0x19, 0x00, /*  __le16 wTotalLength; */
	0x01,       /*  __u8  bNumInterfaces; (1) */
	0x01,       /*  __u8  bConfigurationValue; */
	0x00,       /*  __u8  iConfiguration; */
231
	0xc0,       /*  __u8  bmAttributes;
L
Linus Torvalds 已提交
232 233 234 235 236
				 Bit 7: must be set,
				     6: Self-powered,
				     5: Remote wakeup,
				     4..0: resvd */
	0x00,       /*  __u8  MaxPower; */
237

L
Linus Torvalds 已提交
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
	/* 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; */
	0x04,       /*  __u8  if_bDescriptorType; Interface */
	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; */
259

L
Linus Torvalds 已提交
260 261 262 263
	/* one endpoint (status change endpoint) */
	0x07,       /*  __u8  ep_bLength; */
	0x05,       /*  __u8  ep_bDescriptorType; Endpoint */
	0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
264 265
	0x03,       /*  __u8  ep_bmAttributes; Interrupt */
	0x02, 0x00, /*  __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
L
Linus Torvalds 已提交
266 267 268
	0xff        /*  __u8  ep_bInterval; (255ms -- usb 2.0 spec) */
};

269
static const u8 hs_rh_config_descriptor[] = {
L
Linus Torvalds 已提交
270 271 272 273 274 275 276 277

	/* one configuration */
	0x09,       /*  __u8  bLength; */
	0x02,       /*  __u8  bDescriptorType; Configuration */
	0x19, 0x00, /*  __le16 wTotalLength; */
	0x01,       /*  __u8  bNumInterfaces; (1) */
	0x01,       /*  __u8  bConfigurationValue; */
	0x00,       /*  __u8  iConfiguration; */
278
	0xc0,       /*  __u8  bmAttributes;
L
Linus Torvalds 已提交
279 280 281 282 283
				 Bit 7: must be set,
				     6: Self-powered,
				     5: Remote wakeup,
				     4..0: resvd */
	0x00,       /*  __u8  MaxPower; */
284

L
Linus Torvalds 已提交
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
	/* 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; */
	0x04,       /*  __u8  if_bDescriptorType; Interface */
	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; */
306

L
Linus Torvalds 已提交
307 308 309 310
	/* one endpoint (status change endpoint) */
	0x07,       /*  __u8  ep_bLength; */
	0x05,       /*  __u8  ep_bDescriptorType; Endpoint */
	0x81,       /*  __u8  ep_bEndpointAddress; IN Endpoint 1 */
311
	0x03,       /*  __u8  ep_bmAttributes; Interrupt */
312 313 314
		    /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
		     * see hub.c:hub_configure() for details. */
	(USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
L
Linus Torvalds 已提交
315 316 317
	0x0c        /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */
};

318 319 320 321
static const u8 ss_rh_config_descriptor[] = {
	/* one configuration */
	0x09,       /*  __u8  bLength; */
	0x02,       /*  __u8  bDescriptorType; Configuration */
322
	0x1f, 0x00, /*  __le16 wTotalLength; */
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
	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; */
	0x04,       /*  __u8  if_bDescriptorType; Interface */
	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; */
	0x05,       /*  __u8  ep_bDescriptorType; Endpoint */
	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,
352 353 354 355 356 357 358 359
	0x0c,       /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */

	/* one SuperSpeed endpoint companion descriptor */
	0x06,        /* __u8 ss_bLength */
	0x30,        /* __u8 ss_bDescriptorType; SuperSpeed EP Companion */
	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 */
360 361
};

362 363 364 365 366 367 368 369 370 371 372
/* 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 已提交
373 374
/*-------------------------------------------------------------------------*/

375 376 377 378 379 380
/**
 * 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.
 *
381 382
 * Return: The number of bytes filled in: 2 + 2*strlen(s) or @len,
 * whichever is less.
383
 *
384
 * Note:
385 386
 * USB String descriptors can contain at most 126 characters; input
 * strings longer than that are truncated.
L
Linus Torvalds 已提交
387
 */
388 389
static unsigned
ascii2desc(char const *s, u8 *buf, unsigned len)
L
Linus Torvalds 已提交
390
{
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
	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 已提交
407
	}
408
	return len;
L
Linus Torvalds 已提交
409 410
}

411 412 413
/**
 * rh_string() - provides string descriptors for root hub
 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
L
Linus Torvalds 已提交
414
 * @hcd: the host controller for this root hub
415 416
 * @data: buffer for output packet
 * @len: length of the provided buffer
L
Linus Torvalds 已提交
417 418 419
 *
 * Produces either a manufacturer, product or serial number string for the
 * virtual root hub device.
420 421
 *
 * Return: The number of bytes filled in: the length of the descriptor or
422
 * of the provided buffer, whichever is less.
L
Linus Torvalds 已提交
423
 */
424 425
static unsigned
rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
426
{
427 428 429
	char buf[100];
	char const *s;
	static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
L
Linus Torvalds 已提交
430

431
	/* language ids */
432 433 434 435 436 437 438
	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 已提交
439
		return len;
440 441 442 443 444 445 446 447 448 449
	case 1:
		/* Serial number */
		s = hcd->self.bus_name;
		break;
	case 2:
		/* Product name */
		s = hcd->product_desc;
		break;
	case 3:
		/* Manufacturer */
450 451
		snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
			init_utsname()->release, hcd->driver->description);
452 453
		s = buf;
		break;
L
Linus Torvalds 已提交
454
	default:
455 456
		/* Can't happen; caller guarantees it */
		return 0;
L
Linus Torvalds 已提交
457
	}
458 459

	return ascii2desc(s, data, len);
L
Linus Torvalds 已提交
460 461 462 463 464 465 466
}


/* Root hub control transfers execute synchronously */
static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
{
	struct usb_ctrlrequest *cmd;
467
	u16		typeReq, wValue, wIndex, wLength;
L
Linus Torvalds 已提交
468
	u8		*ubuf = urb->transfer_buffer;
469
	unsigned	len = 0;
470
	int		status;
471 472
	u8		patch_wakeup = 0;
	u8		patch_protocol = 0;
473 474 475
	u16		tbuf_size;
	u8		*tbuf = NULL;
	const u8	*bufp;
L
Linus Torvalds 已提交
476

477 478
	might_sleep();

479 480 481 482 483
	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 已提交
484
	urb->hcpriv = hcd;	/* Indicate it's queued */
485

L
Linus Torvalds 已提交
486 487 488 489 490 491 492 493 494
	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;

495 496 497 498 499 500 501 502 503 504 505 506
	/*
	 * 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 已提交
507 508 509 510 511
	urb->actual_length = 0;
	switch (typeReq) {

	/* DEVICE REQUESTS */

512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
	/* 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 已提交
528
	case DeviceRequest | USB_REQ_GET_STATUS:
529
		tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
530
					<< USB_DEVICE_REMOTE_WAKEUP)
L
Linus Torvalds 已提交
531
				| (1 << USB_DEVICE_SELF_POWERED);
532
		tbuf[1] = 0;
L
Linus Torvalds 已提交
533 534 535 536
		len = 2;
		break;
	case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
		if (wValue == USB_DEVICE_REMOTE_WAKEUP)
537
			device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
L
Linus Torvalds 已提交
538 539 540 541
		else
			goto error;
		break;
	case DeviceOutRequest | USB_REQ_SET_FEATURE:
542 543 544
		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 已提交
545 546 547 548
		else
			goto error;
		break;
	case DeviceRequest | USB_REQ_GET_CONFIGURATION:
549
		tbuf[0] = 1;
L
Linus Torvalds 已提交
550 551 552 553 554 555 556
		len = 1;
			/* FALLTHROUGH */
	case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
		break;
	case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
		switch (wValue & 0xff00) {
		case USB_DT_DEVICE << 8:
557
			switch (hcd->speed) {
558
			case HCD_USB3:
559
				bufp = usb3_rh_dev_descriptor;
560
				break;
561 562 563
			case HCD_USB25:
				bufp = usb25_rh_dev_descriptor;
				break;
564
			case HCD_USB2:
L
Linus Torvalds 已提交
565
				bufp = usb2_rh_dev_descriptor;
566 567
				break;
			case HCD_USB11:
L
Linus Torvalds 已提交
568
				bufp = usb11_rh_dev_descriptor;
569 570
				break;
			default:
L
Linus Torvalds 已提交
571
				goto error;
572
			}
L
Linus Torvalds 已提交
573
			len = 18;
574 575
			if (hcd->has_tt)
				patch_protocol = 1;
L
Linus Torvalds 已提交
576 577
			break;
		case USB_DT_CONFIG << 8:
578
			switch (hcd->speed) {
579
			case HCD_USB3:
580 581
				bufp = ss_rh_config_descriptor;
				len = sizeof ss_rh_config_descriptor;
582
				break;
583
			case HCD_USB25:
584
			case HCD_USB2:
L
Linus Torvalds 已提交
585 586
				bufp = hs_rh_config_descriptor;
				len = sizeof hs_rh_config_descriptor;
587 588
				break;
			case HCD_USB11:
L
Linus Torvalds 已提交
589 590
				bufp = fs_rh_config_descriptor;
				len = sizeof fs_rh_config_descriptor;
591 592 593
				break;
			default:
				goto error;
L
Linus Torvalds 已提交
594
			}
595
			if (device_can_wakeup(&hcd->self.root_hub->dev))
L
Linus Torvalds 已提交
596 597 598
				patch_wakeup = 1;
			break;
		case USB_DT_STRING << 8:
599 600 601 602
			if ((wValue & 0xff) < 4)
				urb->actual_length = rh_string(wValue & 0xff,
						hcd, ubuf, wLength);
			else /* unsupported IDs --> "protocol stall" */
L
Linus Torvalds 已提交
603 604
				goto error;
			break;
605 606
		case USB_DT_BOS << 8:
			goto nongeneric;
L
Linus Torvalds 已提交
607 608 609 610 611
		default:
			goto error;
		}
		break;
	case DeviceRequest | USB_REQ_GET_INTERFACE:
612
		tbuf[0] = 0;
L
Linus Torvalds 已提交
613 614 615 616 617
		len = 1;
			/* FALLTHROUGH */
	case DeviceOutRequest | USB_REQ_SET_INTERFACE:
		break;
	case DeviceOutRequest | USB_REQ_SET_ADDRESS:
618
		/* wValue == urb->dev->devaddr */
L
Linus Torvalds 已提交
619 620 621 622 623 624 625 626 627
		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:
628
		/* ENDPOINT_HALT flag */
629 630
		tbuf[0] = 0;
		tbuf[1] = 0;
L
Linus Torvalds 已提交
631 632 633 634 635 636 637 638 639 640
		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:
641
nongeneric:
L
Linus Torvalds 已提交
642
		/* non-generic request */
643 644 645 646 647 648 649 650
		switch (typeReq) {
		case GetHubStatus:
		case GetPortStatus:
			len = 4;
			break;
		case GetHubDescriptor:
			len = sizeof (struct usb_hub_descriptor);
			break;
651 652 653
		case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
			/* len is returned by hub_control */
			break;
L
Linus Torvalds 已提交
654
		}
655 656 657
		status = hcd->driver->hub_control (hcd,
			typeReq, wValue, wIndex,
			tbuf, wLength);
658 659 660 661

		if (typeReq == GetHubDescriptor)
			usb_hub_adjust_deviceremovable(hcd->self.root_hub,
				(struct usb_hub_descriptor *)tbuf);
L
Linus Torvalds 已提交
662 663 664 665 666 667
		break;
error:
		/* "protocol stall" on error */
		status = -EPIPE;
	}

668
	if (status < 0) {
L
Linus Torvalds 已提交
669 670 671 672 673 674
		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,
675
				wLength, status);
L
Linus Torvalds 已提交
676
		}
677 678 679 680
	} else if (status > 0) {
		/* hub_control may return the length of data copied. */
		len = status;
		status = 0;
L
Linus Torvalds 已提交
681 682 683 684 685
	}
	if (len) {
		if (urb->transfer_buffer_length < len)
			len = urb->transfer_buffer_length;
		urb->actual_length = len;
686
		/* always USB_DIR_IN, toward host */
L
Linus Torvalds 已提交
687 688 689 690 691 692 693 694
		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;
695 696 697 698 699 700

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

704 705
	kfree(tbuf);

L
Linus Torvalds 已提交
706
	/* any errors get returned through the urb completion */
707
	spin_lock_irq(&hcd_root_hub_lock);
708
	usb_hcd_unlink_urb_from_ep(hcd, urb);
A
Alan Stern 已提交
709
	usb_hcd_giveback_urb(hcd, urb, status);
710
	spin_unlock_irq(&hcd_root_hub_lock);
L
Linus Torvalds 已提交
711 712 713 714 715 716
	return 0;
}

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

/*
717 718 719
 * 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 已提交
720
 *
721 722
 * Completions are called in_interrupt(), but they may or may not
 * be in_irq().
L
Linus Torvalds 已提交
723
 */
724 725 726 727 728
void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
{
	struct urb	*urb;
	int		length;
	unsigned long	flags;
729
	char		buffer[6];	/* Any root hubs with > 31 ports? */
L
Linus Torvalds 已提交
730

731
	if (unlikely(!hcd->rh_pollable))
A
Alan Stern 已提交
732
		return;
733 734
	if (!hcd->uses_new_polling && !hcd->status_urb)
		return;
L
Linus Torvalds 已提交
735

736 737
	length = hcd->driver->hub_status_data(hcd, buffer);
	if (length > 0) {
L
Linus Torvalds 已提交
738

739
		/* try to complete the status urb */
740
		spin_lock_irqsave(&hcd_root_hub_lock, flags);
741 742
		urb = hcd->status_urb;
		if (urb) {
743
			clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
744 745 746
			hcd->status_urb = NULL;
			urb->actual_length = length;
			memcpy(urb->transfer_buffer, buffer, length);
747

748
			usb_hcd_unlink_urb_from_ep(hcd, urb);
A
Alan Stern 已提交
749
			usb_hcd_giveback_urb(hcd, urb, 0);
750
		} else {
751
			length = 0;
752
			set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
753
		}
754
		spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
L
Linus Torvalds 已提交
755 756
	}

757
	/* The USB 2.0 spec says 256 ms.  This is close enough and won't
758 759
	 * 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 已提交
760
	 * fire at the same time to give the CPU a break in between */
761
	if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
762
			(length == 0 && hcd->status_urb != NULL))
763
		mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
L
Linus Torvalds 已提交
764
}
765
EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
L
Linus Torvalds 已提交
766 767

/* timer callback */
768 769 770 771 772 773
static void rh_timer_func (unsigned long _hcd)
{
	usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
}

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

775
static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
L
Linus Torvalds 已提交
776
{
777
	int		retval;
L
Linus Torvalds 已提交
778
	unsigned long	flags;
779
	unsigned	len = 1 + (urb->dev->maxchild / 8);
L
Linus Torvalds 已提交
780

781
	spin_lock_irqsave (&hcd_root_hub_lock, flags);
782
	if (hcd->status_urb || urb->transfer_buffer_length < len) {
783 784
		dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
		retval = -EINVAL;
785 786
		goto done;
	}
L
Linus Torvalds 已提交
787

788 789 790
	retval = usb_hcd_link_urb_to_ep(hcd, urb);
	if (retval)
		goto done;
L
Linus Torvalds 已提交
791

792 793 794 795 796 797
	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 */
798
	else if (HCD_POLL_PENDING(hcd))
799 800 801
		mod_timer(&hcd->rh_timer, jiffies);
	retval = 0;
 done:
802 803
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
	return retval;
L
Linus Torvalds 已提交
804 805 806 807
}

static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
{
A
Alan Stern 已提交
808
	if (usb_endpoint_xfer_int(&urb->ep->desc))
809
		return rh_queue_status (hcd, urb);
A
Alan Stern 已提交
810
	if (usb_endpoint_xfer_control(&urb->ep->desc))
L
Linus Torvalds 已提交
811
		return rh_call_control (hcd, urb);
812
	return -EINVAL;
L
Linus Torvalds 已提交
813 814 815 816
}

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

817 818
/* Unlinks of root-hub control URBs are legal, but they don't do anything
 * since these URBs always execute synchronously.
819
 */
820
static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
L
Linus Torvalds 已提交
821
{
822
	unsigned long	flags;
823
	int		rc;
L
Linus Torvalds 已提交
824

825
	spin_lock_irqsave(&hcd_root_hub_lock, flags);
826 827 828 829
	rc = usb_hcd_check_unlink_urb(hcd, urb, status);
	if (rc)
		goto done;

A
Alan Stern 已提交
830
	if (usb_endpoint_num(&urb->ep->desc) == 0) {	/* Control URB */
831
		;	/* Do nothing */
832 833 834

	} else {				/* Status URB */
		if (!hcd->uses_new_polling)
835
			del_timer (&hcd->rh_timer);
836 837
		if (urb == hcd->status_urb) {
			hcd->status_urb = NULL;
838
			usb_hcd_unlink_urb_from_ep(hcd, urb);
A
Alan Stern 已提交
839
			usb_hcd_giveback_urb(hcd, urb, status);
840 841
		}
	}
842
 done:
843
	spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
844
	return rc;
L
Linus Torvalds 已提交
845 846
}

847 848 849 850 851


/*
 * Show & store the current value of authorized_default
 */
852 853
static ssize_t authorized_default_show(struct device *dev,
				       struct device_attribute *attr, char *buf)
854 855 856 857 858 859 860 861 862 863 864
{
	struct usb_device *rh_usb_dev = to_usb_device(dev);
	struct usb_bus *usb_bus = rh_usb_dev->bus;
	struct usb_hcd *usb_hcd;

	if (usb_bus == NULL)	/* FIXME: not sure if this case is possible */
		return -ENODEV;
	usb_hcd = bus_to_hcd(usb_bus);
	return snprintf(buf, PAGE_SIZE, "%u\n", usb_hcd->authorized_default);
}

865 866 867
static ssize_t authorized_default_store(struct device *dev,
					struct device_attribute *attr,
					const char *buf, size_t size)
868 869 870 871 872 873 874 875 876 877 878 879
{
	ssize_t result;
	unsigned val;
	struct usb_device *rh_usb_dev = to_usb_device(dev);
	struct usb_bus *usb_bus = rh_usb_dev->bus;
	struct usb_hcd *usb_hcd;

	if (usb_bus == NULL)	/* FIXME: not sure if this case is possible */
		return -ENODEV;
	usb_hcd = bus_to_hcd(usb_bus);
	result = sscanf(buf, "%u\n", &val);
	if (result == 1) {
880
		usb_hcd->authorized_default = val ? 1 : 0;
881 882 883 884 885 886
		result = size;
	}
	else
		result = -EINVAL;
	return result;
}
887
static DEVICE_ATTR_RW(authorized_default);
888 889 890 891 892 893 894 895 896 897 898 899 900 901

/* Group all the USB bus attributes */
static struct attribute *usb_bus_attrs[] = {
		&dev_attr_authorized_default.attr,
		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 已提交
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
/*-------------------------------------------------------------------------*/

/**
 * 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;

	INIT_LIST_HEAD (&bus->bus_list);
}

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

/**
 * 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.
935 936
 *
 * Return: 0 if successful. A negative error code otherwise.
L
Linus Torvalds 已提交
937 938 939
 */
static int usb_register_bus(struct usb_bus *bus)
{
940
	int result = -E2BIG;
L
Linus Torvalds 已提交
941 942
	int busnum;

943
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
944
	busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
945
	if (busnum >= USB_MAXBUS) {
L
Linus Torvalds 已提交
946
		printk (KERN_ERR "%s: too many buses\n", usbcore_name);
947
		goto error_find_busnum;
L
Linus Torvalds 已提交
948
	}
949 950
	set_bit (busnum, busmap.busmap);
	bus->busnum = busnum;
951

L
Linus Torvalds 已提交
952 953
	/* Add it to the local list of buses */
	list_add (&bus->bus_list, &usb_bus_list);
954
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
955

956
	usb_notify_add_bus(bus);
L
Linus Torvalds 已提交
957

958 959
	dev_info (bus->controller, "new USB bus registered, assigned bus "
		  "number %d\n", bus->busnum);
L
Linus Torvalds 已提交
960
	return 0;
961 962 963 964

error_find_busnum:
	mutex_unlock(&usb_bus_list_lock);
	return result;
L
Linus Torvalds 已提交
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
}

/**
 * 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
	 */
984
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
985
	list_del (&bus->bus_list);
986
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
987

988
	usb_notify_remove_bus(bus);
L
Linus Torvalds 已提交
989 990 991 992 993

	clear_bit (bus->busnum, busmap.busmap);
}

/**
994
 * register_root_hub - called by usb_add_hcd() to register a root hub
L
Linus Torvalds 已提交
995 996
 * @hcd: host controller for this root hub
 *
997
 * This function registers the root hub with the USB subsystem.  It sets up
998 999 1000
 * 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).
1001 1002
 *
 * Return: 0 if successful. A negative error code otherwise.
L
Linus Torvalds 已提交
1003
 */
1004
static int register_root_hub(struct usb_hcd *hcd)
L
Linus Torvalds 已提交
1005 1006
{
	struct device *parent_dev = hcd->self.controller;
1007
	struct usb_device *usb_dev = hcd->self.root_hub;
L
Linus Torvalds 已提交
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
	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);

1018
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
1019

1020
	usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
L
Linus Torvalds 已提交
1021 1022
	retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
	if (retval != sizeof usb_dev->descriptor) {
1023
		mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
1024
		dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
1025
				dev_name(&usb_dev->dev), retval);
L
Linus Torvalds 已提交
1026 1027
		return (retval < 0) ? retval : -EMSGSIZE;
	}
1028 1029 1030 1031 1032 1033 1034 1035
	if (usb_dev->speed == USB_SPEED_SUPER) {
		retval = usb_get_bos_descriptor(usb_dev);
		if (retval < 0) {
			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;
		}
1036
		usb_dev->lpm_capable = usb_device_supports_lpm(usb_dev);
1037
	}
L
Linus Torvalds 已提交
1038 1039 1040 1041

	retval = usb_new_device (usb_dev);
	if (retval) {
		dev_err (parent_dev, "can't register root hub for %s, %d\n",
1042
				dev_name(&usb_dev->dev), retval);
1043
	} else {
L
Linus Torvalds 已提交
1044 1045 1046 1047 1048
		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? */
1049
		if (HCD_DEAD(hcd))
L
Linus Torvalds 已提交
1050 1051
			usb_hc_died (hcd);	/* This time clean up */
	}
1052
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
1053 1054 1055 1056

	return retval;
}

1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
/*
 * 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 已提交
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109

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

/**
 * 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.
 *
1110 1111 1112
 * Return: Approximate bus time in nanoseconds for a periodic transaction.
 *
 * Note:
L
Linus Torvalds 已提交
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
 * 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;
1124
			return 64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
L
Linus Torvalds 已提交
1125 1126
		} else {
			tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1127
			return 64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
L
Linus Torvalds 已提交
1128 1129 1130 1131
		}
	case USB_SPEED_FULL:	/* ISOC or INTR */
		if (isoc) {
			tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1132
			return ((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp;
L
Linus Torvalds 已提交
1133 1134
		} else {
			tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1135
			return 9107L + BW_HOST_DELAY + tmp;
L
Linus Torvalds 已提交
1136 1137
		}
	case USB_SPEED_HIGH:	/* ISOC or INTR */
1138
		/* FIXME adjust for input vs output */
L
Linus Torvalds 已提交
1139
		if (isoc)
1140
			tmp = HS_NSECS_ISO (bytecount);
L
Linus Torvalds 已提交
1141
		else
1142
			tmp = HS_NSECS (bytecount);
L
Linus Torvalds 已提交
1143 1144 1145 1146 1147 1148
		return tmp;
	default:
		pr_debug ("%s: bogus device speed!\n", usbcore_name);
		return -1;
	}
}
1149
EXPORT_SYMBOL_GPL(usb_calc_bus_time);
L
Linus Torvalds 已提交
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159


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

/*
 * Generic HC operations.
 */

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

1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
/**
 * 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.
 *
1170
 * Return: 0 for no error, otherwise a negative error code (in which case
1171 1172 1173 1174 1175
 * 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 已提交
1176
{
1177
	int		rc = 0;
L
Linus Torvalds 已提交
1178

1179
	spin_lock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1180

1181
	/* Check that the URB isn't being killed */
1182
	if (unlikely(atomic_read(&urb->reject))) {
1183 1184
		rc = -EPERM;
		goto done;
1185
	}
L
Linus Torvalds 已提交
1186

1187 1188 1189 1190
	if (unlikely(!urb->ep->enabled)) {
		rc = -ENOENT;
		goto done;
	}
L
Linus Torvalds 已提交
1191

1192 1193 1194 1195 1196
	if (unlikely(!urb->dev->can_submit)) {
		rc = -EHOSTUNREACH;
		goto done;
	}

L
Linus Torvalds 已提交
1197
	/*
1198 1199
	 * Check the host controller's state and add the URB to the
	 * endpoint's queue.
L
Linus Torvalds 已提交
1200
	 */
1201
	if (HCD_RH_RUNNING(hcd)) {
A
Alan Stern 已提交
1202
		urb->unlinked = 0;
1203
		list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1204
	} else {
1205 1206
		rc = -ESHUTDOWN;
		goto done;
L
Linus Torvalds 已提交
1207
	}
1208
 done:
1209
	spin_unlock(&hcd_urb_list_lock);
1210 1211
	return rc;
}
1212
EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1213

1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
/**
 * 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.
 *
1225
 * Return: 0 for no error, otherwise a negative error code (in which case
1226 1227 1228 1229 1230 1231 1232 1233
 * 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,
1234 1235 1236 1237 1238 1239 1240 1241 1242
		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;
	}
1243 1244
	if (tmp != &urb->urb_list)
		return -EIDRM;
L
Linus Torvalds 已提交
1245

1246 1247
	/* 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 已提交
1248
	 */
A
Alan Stern 已提交
1249
	if (urb->unlinked)
1250
		return -EBUSY;
A
Alan Stern 已提交
1251
	urb->unlinked = status;
1252
	return 0;
1253
}
1254
EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1255

1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
/**
 * 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)
1267 1268
{
	/* clear all state linking urb to this dev (and hcd) */
1269
	spin_lock(&hcd_urb_list_lock);
1270
	list_del_init(&urb->urb_list);
1271
	spin_unlock(&hcd_urb_list_lock);
1272
}
1273
EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1274

M
Magnus Damm 已提交
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
/*
 * 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.
 *
 * To support host controllers with limited dma capabilites we provide dma
 * 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
 *   is that the memory be "local" (hence addressible
 *   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;

1314 1315 1316 1317 1318
	if (*vaddr_handle == NULL) {
		WARN_ON_ONCE(1);
		return -EFAULT;
	}

M
Magnus Damm 已提交
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
	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;
}

1359
void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
{
	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);

1373 1374 1375
	/* Make it safe to call this routine more than once */
	urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
}
1376
EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
1377

1378 1379 1380 1381 1382 1383 1384 1385
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);
}

1386
void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1387 1388 1389
{
	enum dma_data_direction dir;

1390
	usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
1391

1392 1393 1394
	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,
1395
				urb->sg,
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
				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 */
1416
	urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
1417 1418
			URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
}
1419
EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
1420

M
Magnus Damm 已提交
1421 1422
static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
			   gfp_t mem_flags)
1423 1424 1425 1426 1427 1428 1429 1430 1431
{
	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)
1432
{
M
Magnus Damm 已提交
1433 1434 1435
	enum dma_data_direction dir;
	int ret = 0;

1436 1437
	/* Map the URB's buffers for DMA access.
	 * Lower level HCD code should use *_dma exclusively,
1438 1439
	 * unless it uses pio or talks to another transport,
	 * or uses the provided scatter gather list for bulk.
L
Linus Torvalds 已提交
1440
	 */
M
Magnus Damm 已提交
1441

A
Alan Stern 已提交
1442
	if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1443 1444
		if (hcd->self.uses_pio_for_control)
			return ret;
1445
		if (hcd->self.uses_dma) {
M
Magnus Damm 已提交
1446
			urb->setup_dma = dma_map_single(
L
Linus Torvalds 已提交
1447 1448
					hcd->self.controller,
					urb->setup_packet,
M
Magnus Damm 已提交
1449
					sizeof(struct usb_ctrlrequest),
L
Linus Torvalds 已提交
1450
					DMA_TO_DEVICE);
1451 1452 1453
			if (dma_mapping_error(hcd->self.controller,
						urb->setup_dma))
				return -EAGAIN;
1454
			urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1455
		} else if (hcd->driver->flags & HCD_LOCAL_MEM) {
M
Magnus Damm 已提交
1456 1457 1458 1459 1460 1461
			ret = hcd_alloc_coherent(
					urb->dev->bus, mem_flags,
					&urb->setup_dma,
					(void **)&urb->setup_packet,
					sizeof(struct usb_ctrlrequest),
					DMA_TO_DEVICE);
1462 1463 1464
			if (ret)
				return ret;
			urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1465
		}
M
Magnus Damm 已提交
1466 1467 1468
	}

	dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1469
	if (urb->transfer_buffer_length != 0
M
Magnus Damm 已提交
1470
	    && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1471
		if (hcd->self.uses_dma) {
1472
			if (urb->num_sgs) {
1473 1474 1475 1476 1477 1478 1479 1480 1481
				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(
1482
						hcd->self.controller,
1483
						urb->sg,
1484 1485 1486 1487 1488 1489
						urb->num_sgs,
						dir);
				if (n <= 0)
					ret = -EAGAIN;
				else
					urb->transfer_flags |= URB_DMA_MAP_SG;
1490 1491
				urb->num_mapped_sgs = n;
				if (n != urb->num_sgs)
1492 1493 1494
					urb->transfer_flags |=
							URB_DMA_SG_COMBINED;
			} else if (urb->sg) {
1495
				struct scatterlist *sg = urb->sg;
1496 1497 1498 1499 1500 1501 1502
				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,
1503
						urb->transfer_dma))
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
					ret = -EAGAIN;
				else
					urb->transfer_flags |= URB_DMA_MAP_PAGE;
			} 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;
			}
1519
		} else if (hcd->driver->flags & HCD_LOCAL_MEM) {
M
Magnus Damm 已提交
1520 1521 1522 1523 1524 1525
			ret = hcd_alloc_coherent(
					urb->dev->bus, mem_flags,
					&urb->transfer_dma,
					&urb->transfer_buffer,
					urb->transfer_buffer_length,
					dir);
1526 1527
			if (ret == 0)
				urb->transfer_flags |= URB_MAP_LOCAL;
M
Magnus Damm 已提交
1528
		}
1529 1530
		if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
				URB_SETUP_MAP_LOCAL)))
1531
			usb_hcd_unmap_urb_for_dma(hcd, urb);
L
Linus Torvalds 已提交
1532
	}
M
Magnus Damm 已提交
1533
	return ret;
1534
}
1535
EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
L
Linus Torvalds 已提交
1536

1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
/*-------------------------------------------------------------------------*/

/* 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);
1555
	atomic_inc(&urb->dev->urbnum);
1556 1557 1558 1559 1560 1561 1562 1563 1564
	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 已提交
1565

1566
	if (is_root_hub(urb->dev)) {
1567
		status = rh_urb_enqueue(hcd, urb);
1568 1569 1570 1571 1572
	} 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))
1573
				unmap_urb_for_dma(hcd, urb);
1574 1575
		}
	}
1576 1577

	if (unlikely(status)) {
L
Linus Torvalds 已提交
1578
		usbmon_urb_submit_error(&hcd->self, urb, status);
A
Alan Stern 已提交
1579
		urb->hcpriv = NULL;
1580 1581
		INIT_LIST_HEAD(&urb->urb_list);
		atomic_dec(&urb->use_count);
1582
		atomic_dec(&urb->dev->urbnum);
1583
		if (atomic_read(&urb->reject))
1584 1585
			wake_up(&usb_kill_urb_queue);
		usb_put_urb(urb);
L
Linus Torvalds 已提交
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596
	}
	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.
 */
1597
static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
L
Linus Torvalds 已提交
1598 1599 1600
{
	int		value;

1601
	if (is_root_hub(urb->dev))
1602
		value = usb_rh_urb_dequeue(hcd, urb, status);
L
Linus Torvalds 已提交
1603 1604 1605 1606 1607
	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. */
1608
		value = hcd->driver->urb_dequeue(hcd, urb, status);
L
Linus Torvalds 已提交
1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
	}
	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 已提交
1619
int usb_hcd_unlink_urb (struct urb *urb, int status)
L
Linus Torvalds 已提交
1620
{
1621
	struct usb_hcd		*hcd;
1622 1623
	int			retval = -EIDRM;
	unsigned long		flags;
L
Linus Torvalds 已提交
1624

1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
	/* 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;
		usb_get_dev(urb->dev);
	}
	spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
	if (retval == 0) {
		hcd = bus_to_hcd(urb->dev->bus);
		retval = unlink1(hcd, urb, status);
		usb_put_dev(urb->dev);
	}
L
Linus Torvalds 已提交
1641 1642 1643

	if (retval == 0)
		retval = -EINPROGRESS;
1644
	else if (retval != -EIDRM && retval != -EBUSY)
1645 1646
		dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
				urb, retval);
L
Linus Torvalds 已提交
1647 1648 1649 1650 1651
	return retval;
}

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

1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
static void __usb_hcd_giveback_urb(struct urb *urb)
{
	struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
	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);
	usb_unanchor_urb(urb);

	/* 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);

	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);
1707
		bh->completing_ep = urb->ep;
1708
		__usb_hcd_giveback_urb(urb);
1709
		bh->completing_ep = NULL;
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719
	}

	/* 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 已提交
1720 1721 1722 1723
/**
 * 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 已提交
1724
 * @status: completion status code for the URB.
A
Alan Stern 已提交
1725 1726 1727 1728 1729 1730 1731
 * 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 已提交
1732
 *
A
Alan Stern 已提交
1733
 * If @urb was unlinked, the value of @status will be overridden by
A
Alan Stern 已提交
1734 1735
 * @urb->unlinked.  Erroneous short transfers are detected in case
 * the HCD hasn't checked for them.
A
Alan Stern 已提交
1736
 */
A
Alan Stern 已提交
1737
void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
A
Alan Stern 已提交
1738
{
1739 1740
	struct giveback_urb_bh *bh;
	bool running, high_prio_bh;
A
Alan Stern 已提交
1741

1742 1743 1744
	/* pass status to tasklet via unlinked */
	if (likely(!urb->unlinked))
		urb->unlinked = status;
1745

1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
	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 已提交
1770
}
1771
EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
A
Alan Stern 已提交
1772 1773 1774

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

1775 1776 1777
/* 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 已提交
1778
 */
1779
void usb_hcd_flush_endpoint(struct usb_device *udev,
A
Alan Stern 已提交
1780
		struct usb_host_endpoint *ep)
L
Linus Torvalds 已提交
1781 1782 1783 1784
{
	struct usb_hcd		*hcd;
	struct urb		*urb;

1785 1786
	if (!ep)
		return;
1787
	might_sleep();
1788
	hcd = bus_to_hcd(udev->bus);
L
Linus Torvalds 已提交
1789

1790
	/* No more submits can occur */
1791
	spin_lock_irq(&hcd_urb_list_lock);
1792
rescan:
L
Linus Torvalds 已提交
1793
	list_for_each_entry (urb, &ep->urb_list, urb_list) {
A
Alan Stern 已提交
1794
		int	is_in;
L
Linus Torvalds 已提交
1795

A
Alan Stern 已提交
1796
		if (urb->unlinked)
L
Linus Torvalds 已提交
1797 1798
			continue;
		usb_get_urb (urb);
A
Alan Stern 已提交
1799
		is_in = usb_urb_dir_in(urb);
1800
		spin_unlock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1801

1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817
		/* 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:
1818
					s = "-iso"; break;
1819 1820 1821
				};
				s;
			}));
L
Linus Torvalds 已提交
1822 1823 1824
		usb_put_urb (urb);

		/* list contents may have changed */
1825
		spin_lock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1826 1827
		goto rescan;
	}
1828
	spin_unlock_irq(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1829

1830
	/* Wait until the endpoint queue is completely empty */
1831
	while (!list_empty (&ep->urb_list)) {
1832
		spin_lock_irq(&hcd_urb_list_lock);
1833 1834 1835 1836 1837 1838 1839 1840

		/* 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);
		}
1841
		spin_unlock_irq(&hcd_urb_list_lock);
1842 1843 1844 1845 1846 1847

		if (urb) {
			usb_kill_urb (urb);
			usb_put_urb (urb);
		}
	}
L
Linus Torvalds 已提交
1848 1849
}

1850
/**
1851 1852 1853
 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
 *				the bus bandwidth
 * @udev: target &usb_device
1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867
 * @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.
 *
1868
 * Return: An error if the requested bandwidth change exceeds the
1869
 * bus bandwidth or host controller internal resources.
1870
 */
1871
int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1872
		struct usb_host_config *new_config,
1873 1874
		struct usb_host_interface *cur_alt,
		struct usb_host_interface *new_alt)
1875 1876
{
	int num_intfs, i, j;
1877
	struct usb_host_interface *alt = NULL;
1878 1879 1880 1881 1882 1883 1884 1885 1886
	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 */
1887
	if (!new_config && !cur_alt) {
1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
		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) {
1924 1925 1926 1927 1928
			struct usb_host_interface *first_alt;
			int iface_num;

			first_alt = &new_config->intf_cache[i]->altsetting[0];
			iface_num = first_alt->desc.bInterfaceNumber;
1929
			/* Set up endpoints for alternate interface setting 0 */
1930
			alt = usb_find_alt_setting(new_config, iface_num, 0);
1931 1932
			if (!alt)
				/* No alt setting 0? Pick the first setting. */
1933
				alt = first_alt;
1934

1935 1936 1937 1938 1939 1940 1941
			for (j = 0; j < alt->desc.bNumEndpoints; j++) {
				ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
				if (ret < 0)
					goto reset;
			}
		}
	}
1942
	if (cur_alt && new_alt) {
1943 1944 1945
		struct usb_interface *iface = usb_ifnum_to_if(udev,
				cur_alt->desc.bInterfaceNumber);

1946 1947
		if (!iface)
			return -EINVAL;
1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
		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];
		}

1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
		/* 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;
		}
	}
1978 1979 1980 1981 1982 1983 1984
	ret = hcd->driver->check_bandwidth(hcd, udev);
reset:
	if (ret < 0)
		hcd->driver->reset_bandwidth(hcd, udev);
	return ret;
}

1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003
/* 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);
}

2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029
/**
 * 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);
	}
}

2030 2031 2032 2033 2034 2035 2036 2037
/**
 * 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.
 *
2038
 * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
2039 2040
 * Drivers may queue multiple transfers to different stream IDs, which may
 * complete in a different order than they were queued.
2041 2042 2043
 *
 * Return: On success, the number of allocated streams. On failure, a negative
 * error code.
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078
 */
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;
	int i;

	dev = interface_to_usbdev(interface);
	hcd = bus_to_hcd(dev->bus);
	if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
		return -EINVAL;
	if (dev->speed != USB_SPEED_SUPER)
		return -EINVAL;

	/* Streams only apply to bulk endpoints. */
	for (i = 0; i < num_eps; i++)
		if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
			return -EINVAL;

	return hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
			num_streams, mem_flags);
}
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.
2079 2080 2081
 *
 * Return: On success, the number of allocated streams. On failure, a negative
 * error code.
2082
 */
2083
int usb_free_streams(struct usb_interface *interface,
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093
		struct usb_host_endpoint **eps, unsigned int num_eps,
		gfp_t mem_flags)
{
	struct usb_hcd *hcd;
	struct usb_device *dev;
	int i;

	dev = interface_to_usbdev(interface);
	hcd = bus_to_hcd(dev->bus);
	if (dev->speed != USB_SPEED_SUPER)
2094
		return -EINVAL;
2095 2096 2097

	/* Streams only apply to bulk endpoints. */
	for (i = 0; i < num_eps; i++)
2098
		if (!eps[i] || !usb_endpoint_xfer_bulk(&eps[i]->desc))
2099
			return -EINVAL;
2100

2101
	return hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2102 2103 2104
}
EXPORT_SYMBOL_GPL(usb_free_streams);

2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
/* 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 已提交
2116 2117
/*-------------------------------------------------------------------------*/

A
Alan Stern 已提交
2118 2119 2120 2121 2122
/* called in any context */
int usb_hcd_get_frame_number (struct usb_device *udev)
{
	struct usb_hcd	*hcd = bus_to_hcd(udev->bus);

2123
	if (!HCD_RH_RUNNING(hcd))
A
Alan Stern 已提交
2124 2125 2126 2127 2128 2129
		return -ESHUTDOWN;
	return hcd->driver->get_frame_number (hcd);
}

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

2130
#ifdef	CONFIG_PM
L
Linus Torvalds 已提交
2131

A
Alan Stern 已提交
2132
int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
L
Linus Torvalds 已提交
2133
{
2134 2135 2136
	struct usb_hcd	*hcd = container_of(rhdev->bus, struct usb_hcd, self);
	int		status;
	int		old_state = hcd->state;
L
Linus Torvalds 已提交
2137

2138 2139 2140
	dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
			(PMSG_IS_AUTO(msg) ? "auto-" : ""),
			rhdev->do_remote_wakeup);
2141 2142 2143 2144 2145
	if (HCD_DEAD(hcd)) {
		dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
		return 0;
	}

2146 2147 2148
	if (!hcd->driver->bus_suspend) {
		status = -ENOENT;
	} else {
2149
		clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2150 2151 2152 2153 2154
		hcd->state = HC_STATE_QUIESCING;
		status = hcd->driver->bus_suspend(hcd);
	}
	if (status == 0) {
		usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
2155
		hcd->state = HC_STATE_SUSPENDED;
2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167

		/* 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;
			}
		}
2168
	} else {
2169 2170 2171 2172 2173 2174
		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);
2175
		dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2176
				"suspend", status);
2177
	}
2178
	return status;
L
Linus Torvalds 已提交
2179 2180
}

A
Alan Stern 已提交
2181
int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
L
Linus Torvalds 已提交
2182
{
2183 2184
	struct usb_hcd	*hcd = container_of(rhdev->bus, struct usb_hcd, self);
	int		status;
2185
	int		old_state = hcd->state;
L
Linus Torvalds 已提交
2186

2187 2188
	dev_dbg(&rhdev->dev, "usb %sresume\n",
			(PMSG_IS_AUTO(msg) ? "auto-" : ""));
2189 2190 2191 2192
	if (HCD_DEAD(hcd)) {
		dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
		return 0;
	}
2193
	if (!hcd->driver->bus_resume)
2194
		return -ENOENT;
2195
	if (HCD_RH_RUNNING(hcd))
2196
		return 0;
2197

2198
	hcd->state = HC_STATE_RESUMING;
2199
	status = hcd->driver->bus_resume(hcd);
2200
	clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2201
	if (status == 0) {
A
Alan Stern 已提交
2202 2203 2204
		struct usb_device *udev;
		int port1;

2205 2206 2207 2208 2209 2210 2211 2212 2213
		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 已提交
2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227

		/*
		 * 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;
			}
		}
2228
	} else {
2229
		hcd->state = old_state;
2230
		dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
2231
				"resume", status);
2232 2233
		if (status != -ESHUTDOWN)
			usb_hc_died(hcd);
2234 2235
	}
	return status;
L
Linus Torvalds 已提交
2236 2237
}

2238 2239
#endif	/* CONFIG_PM */

2240
#ifdef	CONFIG_PM_RUNTIME
2241

2242 2243 2244 2245 2246 2247 2248
/* 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;

	usb_lock_device(udev);
2249
	usb_remote_wakeup(udev);
2250 2251 2252
	usb_unlock_device(udev);
}

L
Linus Torvalds 已提交
2253
/**
2254
 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
L
Linus Torvalds 已提交
2255 2256 2257 2258
 * @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
2259 2260
 * 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 已提交
2261 2262 2263 2264 2265 2266
 */
void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
{
	unsigned long flags;

	spin_lock_irqsave (&hcd_root_hub_lock, flags);
2267 2268
	if (hcd->rh_registered) {
		set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2269
		queue_work(pm_wq, &hcd->wakeup_work);
2270
	}
L
Linus Torvalds 已提交
2271 2272
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
}
2273
EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
L
Linus Torvalds 已提交
2274

2275
#endif	/* CONFIG_PM_RUNTIME */
L
Linus Torvalds 已提交
2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290

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

#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
 * khubd identifying and possibly configuring the device.
 * This is needed by OTG controller drivers, where it helps meet
 * HNP protocol timing requirements for starting a port reset.
2291 2292
 *
 * Return: 0 if successful.
L
Linus Torvalds 已提交
2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313
 */
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...
	 */
	hcd = container_of (bus, struct usb_hcd, self);
	if (port_num && hcd->driver->start_port_reset)
		status = hcd->driver->start_port_reset(hcd, port_num);

	/* run khubd shortly after (first) root port reset finishes;
	 * 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;
}
2314
EXPORT_SYMBOL_GPL(usb_bus_start_enum);
L
Linus Torvalds 已提交
2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326

#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.
2327 2328
 *
 * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
L
Linus Torvalds 已提交
2329
 */
2330
irqreturn_t usb_hcd_irq (int irq, void *__hcd)
L
Linus Torvalds 已提交
2331 2332
{
	struct usb_hcd		*hcd = __hcd;
2333
	unsigned long		flags;
2334
	irqreturn_t		rc;
L
Linus Torvalds 已提交
2335

2336 2337 2338 2339 2340 2341
	/* IRQF_DISABLED doesn't work correctly with shared IRQs
	 * when the first handler doesn't use it.  So let's just
	 * assume it's never used.
	 */
	local_irq_save(flags);

A
Alan Stern 已提交
2342
	if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
2343
		rc = IRQ_NONE;
A
Alan Stern 已提交
2344
	else if (hcd->driver->irq(hcd) == IRQ_NONE)
2345
		rc = IRQ_NONE;
A
Alan Stern 已提交
2346
	else
2347 2348
		rc = IRQ_HANDLED;

2349
	local_irq_restore(flags);
2350
	return rc;
L
Linus Torvalds 已提交
2351
}
D
Dong Nguyen 已提交
2352
EXPORT_SYMBOL_GPL(usb_hcd_irq);
L
Linus Torvalds 已提交
2353 2354 2355 2356 2357 2358 2359 2360 2361

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

/**
 * 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
2362 2363 2364
 * 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 已提交
2365 2366 2367 2368 2369 2370 2371 2372
 */
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);
2373 2374
	clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
	set_bit(HCD_FLAG_DEAD, &hcd->flags);
L
Linus Torvalds 已提交
2375
	if (hcd->rh_registered) {
2376
		clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
L
Linus Torvalds 已提交
2377 2378 2379 2380 2381 2382

		/* make khubd clean up old urbs and devices */
		usb_set_device_state (hcd->self.root_hub,
				USB_STATE_NOTATTACHED);
		usb_kick_khubd (hcd->self.root_hub);
	}
2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393
	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);

			/* make khubd clean up old urbs and devices */
			usb_set_device_state(hcd->self.root_hub,
					USB_STATE_NOTATTACHED);
			usb_kick_khubd(hcd->self.root_hub);
		}
	}
L
Linus Torvalds 已提交
2394
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2395
	/* Make sure that the other roothub is also deallocated. */
L
Linus Torvalds 已提交
2396 2397 2398 2399 2400
}
EXPORT_SYMBOL_GPL (usb_hc_died);

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

2401 2402 2403 2404 2405 2406 2407 2408
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 已提交
2409
/**
2410
 * usb_create_shared_hcd - create and initialize an HCD structure
L
Linus Torvalds 已提交
2411 2412 2413
 * @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
2414 2415
 * @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 已提交
2416 2417 2418 2419 2420 2421
 * 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.
 *
2422 2423
 * Return: On success, a pointer to the created and initialized HCD structure.
 * On failure (e.g. if memory is unavailable), %NULL.
L
Linus Torvalds 已提交
2424
 */
2425 2426 2427
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 已提交
2428 2429 2430
{
	struct usb_hcd *hcd;

2431
	hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
L
Linus Torvalds 已提交
2432 2433 2434 2435
	if (!hcd) {
		dev_dbg (dev, "hcd alloc failed\n");
		return NULL;
	}
2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451
	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 {
		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;
2452 2453
	}

2454
	kref_init(&hcd->kref);
L
Linus Torvalds 已提交
2455 2456 2457 2458

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

	init_timer(&hcd->rh_timer);
2462 2463
	hcd->rh_timer.function = rh_timer_func;
	hcd->rh_timer.data = (unsigned long) hcd;
2464
#ifdef CONFIG_PM_RUNTIME
2465 2466
	INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
#endif
L
Linus Torvalds 已提交
2467 2468

	hcd->driver = driver;
2469
	hcd->speed = driver->flags & HCD_MASK;
L
Linus Torvalds 已提交
2470 2471 2472 2473
	hcd->product_desc = (driver->product_desc) ? driver->product_desc :
			"USB Host Controller";
	return hcd;
}
2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486
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.
 *
2487 2488
 * Return: On success, a pointer to the created and initialized HCD
 * structure. On failure (e.g. if memory is unavailable), %NULL.
2489 2490 2491 2492 2493 2494
 */
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);
}
2495
EXPORT_SYMBOL_GPL(usb_create_hcd);
L
Linus Torvalds 已提交
2496

2497 2498 2499 2500 2501 2502 2503 2504 2505 2506
/*
 * 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
 * freed.  When hcd_release() is called for the non-primary HCD, set the
 * primary_hcd's shared_hcd pointer to null (since the non-primary HCD will be
 * freed shortly).
 */
2507 2508 2509 2510
static void hcd_release (struct kref *kref)
{
	struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);

2511 2512 2513 2514
	if (usb_hcd_is_primary_hcd(hcd))
		kfree(hcd->bandwidth_mutex);
	else
		hcd->shared_hcd->shared_hcd = NULL;
2515 2516 2517 2518 2519 2520 2521 2522 2523
	kfree(hcd);
}

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

L
Linus Torvalds 已提交
2526 2527
void usb_put_hcd (struct usb_hcd *hcd)
{
2528 2529
	if (hcd)
		kref_put (&hcd->kref, hcd_release);
L
Linus Torvalds 已提交
2530
}
2531
EXPORT_SYMBOL_GPL(usb_put_hcd);
L
Linus Torvalds 已提交
2532

2533 2534 2535 2536 2537 2538 2539 2540
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);

2541 2542 2543 2544 2545 2546 2547 2548
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);
}

2549 2550 2551 2552 2553 2554
static int usb_hcd_request_irqs(struct usb_hcd *hcd,
		unsigned int irqnum, unsigned long irqflags)
{
	int retval;

	if (hcd->driver->irq) {
2555 2556 2557 2558 2559 2560 2561 2562

		/* IRQF_DISABLED doesn't work as advertised when used together
		 * with IRQF_SHARED. As usb_hcd_irq() will always disable
		 * interrupts we can remove it here.
		 */
		if (irqflags & IRQF_SHARED)
			irqflags &= ~IRQF_DISABLED;

2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578
		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 {
2579
		hcd->irq = 0;
2580 2581 2582 2583 2584 2585 2586 2587 2588
		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;
}

L
Linus Torvalds 已提交
2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601
/**
 * 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)
{
2602 2603
	int retval;
	struct usb_device *rhdev;
L
Linus Torvalds 已提交
2604 2605 2606

	dev_info(hcd->self.controller, "%s\n", hcd->product_desc);

2607 2608
	/* Keep old behaviour if authorized_default is not in [0, 1]. */
	if (authorized_default < 0 || authorized_default > 1)
2609
		hcd->authorized_default = hcd->wireless ? 0 : 1;
2610 2611
	else
		hcd->authorized_default = authorized_default;
2612 2613
	set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);

2614 2615 2616 2617
	/* HC is in reset state, but accessible.  Now do the one-time init,
	 * bottom up so that hcds can customize the root hubs before khubd
	 * starts talking to them.  (Note, bus id is assigned early too.)
	 */
L
Linus Torvalds 已提交
2618 2619 2620 2621 2622 2623
	if ((retval = hcd_buffer_create(hcd)) != 0) {
		dev_dbg(hcd->self.controller, "pool alloc failed\n");
		return retval;
	}

	if ((retval = usb_register_bus(&hcd->self)) < 0)
2624
		goto err_register_bus;
L
Linus Torvalds 已提交
2625

2626 2627 2628 2629 2630
	if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
		dev_err(hcd->self.controller, "unable to allocate root hub\n");
		retval = -ENOMEM;
		goto err_allocate_root_hub;
	}
2631
	hcd->self.root_hub = rhdev;
2632

2633
	switch (hcd->speed) {
2634 2635 2636 2637 2638 2639
	case HCD_USB11:
		rhdev->speed = USB_SPEED_FULL;
		break;
	case HCD_USB2:
		rhdev->speed = USB_SPEED_HIGH;
		break;
2640 2641 2642
	case HCD_USB25:
		rhdev->speed = USB_SPEED_WIRELESS;
		break;
2643 2644 2645 2646
	case HCD_USB3:
		rhdev->speed = USB_SPEED_SUPER;
		break;
	default:
2647
		retval = -EINVAL;
2648
		goto err_set_rh_speed;
2649
	}
2650

2651 2652 2653 2654
	/* 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.
	 */
2655
	device_set_wakeup_capable(&rhdev->dev, 1);
2656

2657 2658 2659 2660 2661 2662
	/* 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);

2663 2664 2665 2666
	/* "reset" is misnamed; its role is now one-time init. the controller
	 * should already have been reset (and boot firmware kicked off etc).
	 */
	if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
2667
		dev_err(hcd->self.controller, "can't setup: %d\n", retval);
2668 2669
		goto err_hcd_driver_setup;
	}
2670
	hcd->rh_pollable = 1;
2671

2672 2673 2674
	/* 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))
2675 2676
		dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");

2677 2678 2679 2680
	/* initialize tasklets */
	init_giveback_urb_bh(&hcd->high_prio_bh);
	init_giveback_urb_bh(&hcd->low_prio_bh);

2681 2682 2683 2684
	/* enable irqs just before we start the controller,
	 * if the BIOS provides legacy PCI irqs.
	 */
	if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
2685 2686 2687 2688
		retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
		if (retval)
			goto err_request_irq;
	}
L
Linus Torvalds 已提交
2689

2690
	hcd->state = HC_STATE_RUNNING;
2691 2692
	retval = hcd->driver->start(hcd);
	if (retval < 0) {
L
Linus Torvalds 已提交
2693
		dev_err(hcd->self.controller, "startup error %d\n", retval);
2694
		goto err_hcd_driver_start;
L
Linus Torvalds 已提交
2695 2696
	}

2697 2698
	/* starting here, usbcore will pay attention to this root hub */
	if ((retval = register_root_hub(hcd)) != 0)
2699 2700
		goto err_register_root_hub;

2701 2702 2703 2704 2705 2706
	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;
	}
2707
	if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2708
		usb_hcd_poll_rh_status(hcd);
2709 2710 2711 2712 2713 2714 2715

	/*
	 * Host controllers don't generate their own wakeup requests;
	 * they only forward requests from the root hub.  Therefore
	 * controllers should always be enabled for remote wakeup.
	 */
	device_wakeup_enable(hcd->self.controller);
L
Linus Torvalds 已提交
2716 2717
	return retval;

2718
error_create_attr_group:
2719
	clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2720 2721 2722 2723 2724 2725
	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);

2726
#ifdef CONFIG_PM_RUNTIME
2727 2728
	cancel_work_sync(&hcd->wakeup_work);
#endif
2729
	mutex_lock(&usb_bus_list_lock);
2730
	usb_disconnect(&rhdev);		/* Sets rhdev to NULL */
2731
	mutex_unlock(&usb_bus_list_lock);
2732
err_register_root_hub:
2733
	hcd->rh_pollable = 0;
2734
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2735
	del_timer_sync(&hcd->rh_timer);
2736
	hcd->driver->stop(hcd);
2737
	hcd->state = HC_STATE_HALT;
2738
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2739
	del_timer_sync(&hcd->rh_timer);
2740
err_hcd_driver_start:
2741
	if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
L
Linus Torvalds 已提交
2742
		free_irq(irqnum, hcd);
2743 2744
err_request_irq:
err_hcd_driver_setup:
2745
err_set_rh_speed:
2746
	usb_put_dev(hcd->self.root_hub);
2747
err_allocate_root_hub:
L
Linus Torvalds 已提交
2748
	usb_deregister_bus(&hcd->self);
2749
err_register_bus:
L
Linus Torvalds 已提交
2750 2751
	hcd_buffer_destroy(hcd);
	return retval;
2752
}
2753
EXPORT_SYMBOL_GPL(usb_add_hcd);
L
Linus Torvalds 已提交
2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764

/**
 * 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)
{
2765 2766
	struct usb_device *rhdev = hcd->self.root_hub;

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

2769 2770
	usb_get_dev(rhdev);
	sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2771

2772
	clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
L
Linus Torvalds 已提交
2773 2774 2775 2776 2777 2778 2779
	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);
2780

2781
#ifdef CONFIG_PM_RUNTIME
2782
	cancel_work_sync(&hcd->wakeup_work);
2783 2784
#endif

2785
	mutex_lock(&usb_bus_list_lock);
2786
	usb_disconnect(&rhdev);		/* Sets rhdev to NULL */
2787
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
2788

2789 2790 2791 2792 2793 2794 2795 2796 2797 2798
	/*
	 * 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
	 */

2799 2800 2801 2802 2803 2804
	/* 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;
2805
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2806 2807
	del_timer_sync(&hcd->rh_timer);

L
Linus Torvalds 已提交
2808 2809 2810
	hcd->driver->stop(hcd);
	hcd->state = HC_STATE_HALT;

2811
	/* In case the HCD restarted the timer, stop it again. */
2812
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
A
Alan Stern 已提交
2813 2814
	del_timer_sync(&hcd->rh_timer);

2815
	if (usb_hcd_is_primary_hcd(hcd)) {
2816
		if (hcd->irq > 0)
2817 2818
			free_irq(hcd->irq, hcd);
	}
2819 2820

	usb_put_dev(hcd->self.root_hub);
L
Linus Torvalds 已提交
2821 2822 2823
	usb_deregister_bus(&hcd->self);
	hcd_buffer_destroy(hcd);
}
2824
EXPORT_SYMBOL_GPL(usb_remove_hcd);
L
Linus Torvalds 已提交
2825

2826
void
2827
usb_hcd_platform_shutdown(struct platform_device *dev)
2828 2829 2830 2831 2832 2833
{
	struct usb_hcd *hcd = platform_get_drvdata(dev);

	if (hcd->driver->shutdown)
		hcd->driver->shutdown(hcd);
}
2834
EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
2835

L
Linus Torvalds 已提交
2836 2837
/*-------------------------------------------------------------------------*/

2838
#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
L
Linus Torvalds 已提交
2839 2840 2841 2842 2843 2844 2845 2846 2847 2848

struct usb_mon_operations *mon_ops;

/*
 * 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.
 */
2849

L
Linus Torvalds 已提交
2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873
int usb_mon_register (struct usb_mon_operations *ops)
{

	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);

2874
#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */