hcd.c 70.8 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
/*
 * (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
 * 
 * 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.
 */

#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>
35
#include <linux/mutex.h>
L
Linus Torvalds 已提交
36 37
#include <asm/irq.h>
#include <asm/byteorder.h>
M
Magnus Damm 已提交
38
#include <asm/unaligned.h>
39
#include <linux/platform_device.h>
40
#include <linux/workqueue.h>
41
#include <linux/pm_runtime.h>
L
Linus Torvalds 已提交
42 43

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

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

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

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

L
Linus Torvalds 已提交
88 89 90 91 92 93 94 95 96 97 98 99
/* 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 {
	unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
};
static struct usb_busmap busmap;

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

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

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

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

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

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

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

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

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

#define KERNEL_REL	((LINUX_VERSION_CODE >> 16) & 0x0ff)
#define KERNEL_VER	((LINUX_VERSION_CODE >> 8) & 0x0ff)

131 132 133 134 135 136 137 138 139 140 141 142
/* 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 */

	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation */
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; */
};

L
Linus Torvalds 已提交
152 153 154 155 156 157 158 159
/* usb 2.0 root hub device descriptor */
static const u8 usb2_rh_dev_descriptor [18] = {
	0x12,       /*  __u8  bLength; */
	0x01,       /*  __u8  bDescriptorType; Device */
	0x00, 0x02, /*  __le16 bcdUSB; v2.0 */

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

163 164
	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation */
	0x02, 0x00, /*  __le16 idProduct; device 0x0002 */
L
Linus Torvalds 已提交
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
	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 */
static const u8 usb11_rh_dev_descriptor [18] = {
	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 ] */
184
	0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
L
Linus Torvalds 已提交
185

186 187
	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation */
	0x01, 0x00, /*  __le16 idProduct; device 0x0001 */
L
Linus Torvalds 已提交
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
	KERNEL_VER, KERNEL_REL, /*  __le16 bcdDevice */

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


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

/* Configuration descriptors for our root hubs */

static const u8 fs_rh_config_descriptor [] = {

	/* one configuration */
	0x09,       /*  __u8  bLength; */
	0x02,       /*  __u8  bDescriptorType; Configuration */
	0x19, 0x00, /*  __le16 wTotalLength; */
	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; */
      
	/* 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; */
     
	/* 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 */
 	0x02, 0x00, /*  __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
	0xff        /*  __u8  ep_bInterval; (255ms -- usb 2.0 spec) */
};

static const u8 hs_rh_config_descriptor [] = {

	/* one configuration */
	0x09,       /*  __u8  bLength; */
	0x02,       /*  __u8  bDescriptorType; Configuration */
	0x19, 0x00, /*  __le16 wTotalLength; */
	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; */
      
	/* 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; */
     
	/* 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 */
291 292 293
		    /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
		     * see hub.c:hub_configure() for details. */
	(USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
L
Linus Torvalds 已提交
294 295 296
	0x0c        /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */
};

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
static const u8 ss_rh_config_descriptor[] = {
	/* one configuration */
	0x09,       /*  __u8  bLength; */
	0x02,       /*  __u8  bDescriptorType; Configuration */
	0x19, 0x00, /*  __le16 wTotalLength; FIXME */
	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,
	0x0c        /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */
	/*
	 * All 3.0 hubs should have an endpoint companion descriptor,
	 * but we're ignoring that for now.  FIXME?
	 */
};

L
Linus Torvalds 已提交
338 339
/*-------------------------------------------------------------------------*/

340 341 342 343 344 345 346 347 348 349 350
/**
 * 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.
 *
 * The return value is the number of bytes filled in: 2 + 2*strlen(s) or
 * buflen, whichever is less.
 *
 * USB String descriptors can contain at most 126 characters; input
 * strings longer than that are truncated.
L
Linus Torvalds 已提交
351
 */
352 353
static unsigned
ascii2desc(char const *s, u8 *buf, unsigned len)
L
Linus Torvalds 已提交
354
{
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
	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 已提交
371
	}
372
	return len;
L
Linus Torvalds 已提交
373 374
}

375 376 377
/**
 * rh_string() - provides string descriptors for root hub
 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
L
Linus Torvalds 已提交
378
 * @hcd: the host controller for this root hub
379 380
 * @data: buffer for output packet
 * @len: length of the provided buffer
L
Linus Torvalds 已提交
381 382 383
 *
 * Produces either a manufacturer, product or serial number string for the
 * virtual root hub device.
384 385
 * Returns the number of bytes filled in: the length of the descriptor or
 * of the provided buffer, whichever is less.
L
Linus Torvalds 已提交
386
 */
387 388
static unsigned
rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
389
{
390 391 392
	char buf[100];
	char const *s;
	static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
L
Linus Torvalds 已提交
393 394

	// language ids
395 396 397 398 399 400 401
	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 已提交
402
		return len;
403 404 405 406 407 408 409 410 411 412
	case 1:
		/* Serial number */
		s = hcd->self.bus_name;
		break;
	case 2:
		/* Product name */
		s = hcd->product_desc;
		break;
	case 3:
		/* Manufacturer */
413 414
		snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
			init_utsname()->release, hcd->driver->description);
415 416
		s = buf;
		break;
L
Linus Torvalds 已提交
417
	default:
418 419
		/* Can't happen; caller guarantees it */
		return 0;
L
Linus Torvalds 已提交
420
	}
421 422

	return ascii2desc(s, data, len);
L
Linus Torvalds 已提交
423 424 425 426 427 428 429 430 431
}


/* Root hub control transfers execute synchronously */
static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
{
	struct usb_ctrlrequest *cmd;
 	u16		typeReq, wValue, wIndex, wLength;
	u8		*ubuf = urb->transfer_buffer;
432 433
	u8		tbuf [sizeof (struct usb_hub_descriptor)]
		__attribute__((aligned(4)));
L
Linus Torvalds 已提交
434
	const u8	*bufp = tbuf;
435
	unsigned	len = 0;
436
	int		status;
437 438
	u8		patch_wakeup = 0;
	u8		patch_protocol = 0;
L
Linus Torvalds 已提交
439

440 441
	might_sleep();

442 443 444 445 446
	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 已提交
447
	urb->hcpriv = hcd;	/* Indicate it's queued */
448

L
Linus Torvalds 已提交
449 450 451 452 453 454 455 456 457 458 459 460 461 462
	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;

	urb->actual_length = 0;
	switch (typeReq) {

	/* DEVICE REQUESTS */

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
	/* 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 已提交
479
	case DeviceRequest | USB_REQ_GET_STATUS:
480 481
		tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
					<< USB_DEVICE_REMOTE_WAKEUP)
L
Linus Torvalds 已提交
482 483 484 485 486 487
				| (1 << USB_DEVICE_SELF_POWERED);
		tbuf [1] = 0;
		len = 2;
		break;
	case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
		if (wValue == USB_DEVICE_REMOTE_WAKEUP)
488
			device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
L
Linus Torvalds 已提交
489 490 491 492
		else
			goto error;
		break;
	case DeviceOutRequest | USB_REQ_SET_FEATURE:
493 494 495
		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 已提交
496 497 498 499 500 501 502 503 504 505 506 507
		else
			goto error;
		break;
	case DeviceRequest | USB_REQ_GET_CONFIGURATION:
		tbuf [0] = 1;
		len = 1;
			/* FALLTHROUGH */
	case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
		break;
	case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
		switch (wValue & 0xff00) {
		case USB_DT_DEVICE << 8:
508 509
			switch (hcd->driver->flags & HCD_MASK) {
			case HCD_USB3:
510
				bufp = usb3_rh_dev_descriptor;
511 512
				break;
			case HCD_USB2:
L
Linus Torvalds 已提交
513
				bufp = usb2_rh_dev_descriptor;
514 515
				break;
			case HCD_USB11:
L
Linus Torvalds 已提交
516
				bufp = usb11_rh_dev_descriptor;
517 518
				break;
			default:
L
Linus Torvalds 已提交
519
				goto error;
520
			}
L
Linus Torvalds 已提交
521
			len = 18;
522 523
			if (hcd->has_tt)
				patch_protocol = 1;
L
Linus Torvalds 已提交
524 525
			break;
		case USB_DT_CONFIG << 8:
526 527
			switch (hcd->driver->flags & HCD_MASK) {
			case HCD_USB3:
528 529
				bufp = ss_rh_config_descriptor;
				len = sizeof ss_rh_config_descriptor;
530 531
				break;
			case HCD_USB2:
L
Linus Torvalds 已提交
532 533
				bufp = hs_rh_config_descriptor;
				len = sizeof hs_rh_config_descriptor;
534 535
				break;
			case HCD_USB11:
L
Linus Torvalds 已提交
536 537
				bufp = fs_rh_config_descriptor;
				len = sizeof fs_rh_config_descriptor;
538 539 540
				break;
			default:
				goto error;
L
Linus Torvalds 已提交
541
			}
542
			if (device_can_wakeup(&hcd->self.root_hub->dev))
L
Linus Torvalds 已提交
543 544 545
				patch_wakeup = 1;
			break;
		case USB_DT_STRING << 8:
546 547 548 549
			if ((wValue & 0xff) < 4)
				urb->actual_length = rh_string(wValue & 0xff,
						hcd, ubuf, wLength);
			else /* unsupported IDs --> "protocol stall" */
L
Linus Torvalds 已提交
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
				goto error;
			break;
		default:
			goto error;
		}
		break;
	case DeviceRequest | USB_REQ_GET_INTERFACE:
		tbuf [0] = 0;
		len = 1;
			/* FALLTHROUGH */
	case DeviceOutRequest | USB_REQ_SET_INTERFACE:
		break;
	case DeviceOutRequest | USB_REQ_SET_ADDRESS:
		// wValue == urb->dev->devaddr
		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:
		// ENDPOINT_HALT flag
		tbuf [0] = 0;
		tbuf [1] = 0;
		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:
		/* non-generic request */
587 588 589 590 591 592 593 594
		switch (typeReq) {
		case GetHubStatus:
		case GetPortStatus:
			len = 4;
			break;
		case GetHubDescriptor:
			len = sizeof (struct usb_hub_descriptor);
			break;
L
Linus Torvalds 已提交
595
		}
596 597 598
		status = hcd->driver->hub_control (hcd,
			typeReq, wValue, wIndex,
			tbuf, wLength);
L
Linus Torvalds 已提交
599 600 601 602 603 604 605 606 607 608 609 610 611
		break;
error:
		/* "protocol stall" on error */
		status = -EPIPE;
	}

	if (status) {
		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,
612
				wLength, status);
L
Linus Torvalds 已提交
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
		}
	}
	if (len) {
		if (urb->transfer_buffer_length < len)
			len = urb->transfer_buffer_length;
		urb->actual_length = len;
		// always USB_DIR_IN, toward host
		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;
628 629 630 631 632 633 634

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

	/* any errors get returned through the urb completion */
638
	spin_lock_irq(&hcd_root_hub_lock);
639
	usb_hcd_unlink_urb_from_ep(hcd, urb);
640 641 642 643 644 645

	/* This peculiar use of spinlocks echoes what real HC drivers do.
	 * Avoiding calls to local_irq_disable/enable makes the code
	 * RT-friendly.
	 */
	spin_unlock(&hcd_root_hub_lock);
A
Alan Stern 已提交
646
	usb_hcd_giveback_urb(hcd, urb, status);
647 648 649
	spin_lock(&hcd_root_hub_lock);

	spin_unlock_irq(&hcd_root_hub_lock);
L
Linus Torvalds 已提交
650 651 652 653 654 655
	return 0;
}

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

/*
656 657 658
 * 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 已提交
659
 *
660 661
 * Completions are called in_interrupt(), but they may or may not
 * be in_irq().
L
Linus Torvalds 已提交
662
 */
663 664 665 666 667
void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
{
	struct urb	*urb;
	int		length;
	unsigned long	flags;
668
	char		buffer[6];	/* Any root hubs with > 31 ports? */
L
Linus Torvalds 已提交
669

670
	if (unlikely(!hcd->rh_pollable))
A
Alan Stern 已提交
671
		return;
672 673
	if (!hcd->uses_new_polling && !hcd->status_urb)
		return;
L
Linus Torvalds 已提交
674

675 676
	length = hcd->driver->hub_status_data(hcd, buffer);
	if (length > 0) {
L
Linus Torvalds 已提交
677

678
		/* try to complete the status urb */
679
		spin_lock_irqsave(&hcd_root_hub_lock, flags);
680 681
		urb = hcd->status_urb;
		if (urb) {
682
			clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
683 684 685
			hcd->status_urb = NULL;
			urb->actual_length = length;
			memcpy(urb->transfer_buffer, buffer, length);
686

687
			usb_hcd_unlink_urb_from_ep(hcd, urb);
688
			spin_unlock(&hcd_root_hub_lock);
A
Alan Stern 已提交
689
			usb_hcd_giveback_urb(hcd, urb, 0);
690
			spin_lock(&hcd_root_hub_lock);
691
		} else {
692
			length = 0;
693
			set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
694
		}
695
		spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
L
Linus Torvalds 已提交
696 697
	}

698
	/* The USB 2.0 spec says 256 ms.  This is close enough and won't
699 700 701
	 * 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
	 * fire at the same time to give the CPU a break inbetween */
702
	if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
703
			(length == 0 && hcd->status_urb != NULL))
704
		mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
L
Linus Torvalds 已提交
705
}
706
EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
L
Linus Torvalds 已提交
707 708

/* timer callback */
709 710 711 712 713 714
static void rh_timer_func (unsigned long _hcd)
{
	usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
}

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

716
static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
L
Linus Torvalds 已提交
717
{
718
	int		retval;
L
Linus Torvalds 已提交
719
	unsigned long	flags;
720
	unsigned	len = 1 + (urb->dev->maxchild / 8);
L
Linus Torvalds 已提交
721

722
	spin_lock_irqsave (&hcd_root_hub_lock, flags);
723
	if (hcd->status_urb || urb->transfer_buffer_length < len) {
724 725
		dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
		retval = -EINVAL;
726 727
		goto done;
	}
L
Linus Torvalds 已提交
728

729 730 731
	retval = usb_hcd_link_urb_to_ep(hcd, urb);
	if (retval)
		goto done;
L
Linus Torvalds 已提交
732

733 734 735 736 737 738
	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 */
739
	else if (HCD_POLL_PENDING(hcd))
740 741 742
		mod_timer(&hcd->rh_timer, jiffies);
	retval = 0;
 done:
743 744
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
	return retval;
L
Linus Torvalds 已提交
745 746 747 748
}

static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
{
A
Alan Stern 已提交
749
	if (usb_endpoint_xfer_int(&urb->ep->desc))
750
		return rh_queue_status (hcd, urb);
A
Alan Stern 已提交
751
	if (usb_endpoint_xfer_control(&urb->ep->desc))
L
Linus Torvalds 已提交
752
		return rh_call_control (hcd, urb);
753
	return -EINVAL;
L
Linus Torvalds 已提交
754 755 756 757
}

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

758 759
/* Unlinks of root-hub control URBs are legal, but they don't do anything
 * since these URBs always execute synchronously.
760
 */
761
static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
L
Linus Torvalds 已提交
762
{
763
	unsigned long	flags;
764
	int		rc;
L
Linus Torvalds 已提交
765

766
	spin_lock_irqsave(&hcd_root_hub_lock, flags);
767 768 769 770
	rc = usb_hcd_check_unlink_urb(hcd, urb, status);
	if (rc)
		goto done;

A
Alan Stern 已提交
771
	if (usb_endpoint_num(&urb->ep->desc) == 0) {	/* Control URB */
772
		;	/* Do nothing */
773 774 775

	} else {				/* Status URB */
		if (!hcd->uses_new_polling)
776
			del_timer (&hcd->rh_timer);
777 778
		if (urb == hcd->status_urb) {
			hcd->status_urb = NULL;
779
			usb_hcd_unlink_urb_from_ep(hcd, urb);
L
Linus Torvalds 已提交
780

781
			spin_unlock(&hcd_root_hub_lock);
A
Alan Stern 已提交
782
			usb_hcd_giveback_urb(hcd, urb, status);
783 784 785
			spin_lock(&hcd_root_hub_lock);
		}
	}
786
 done:
787
	spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
788
	return rc;
L
Linus Torvalds 已提交
789 790
}

791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850


/*
 * Show & store the current value of authorized_default
 */
static ssize_t usb_host_authorized_default_show(struct device *dev,
						struct device_attribute *attr,
						char *buf)
{
	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);
}

static ssize_t usb_host_authorized_default_store(struct device *dev,
						 struct device_attribute *attr,
						 const char *buf, size_t size)
{
	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) {
		usb_hcd->authorized_default = val? 1 : 0;
		result = size;
	}
	else
		result = -EINVAL;
	return result;
}

static DEVICE_ATTR(authorized_default, 0644,
	    usb_host_authorized_default_show,
	    usb_host_authorized_default_store);


/* 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 已提交
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
/*-------------------------------------------------------------------------*/

/**
 * 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.
 */
static int usb_register_bus(struct usb_bus *bus)
{
887
	int result = -E2BIG;
L
Linus Torvalds 已提交
888 889
	int busnum;

890
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
891
	busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
892
	if (busnum >= USB_MAXBUS) {
L
Linus Torvalds 已提交
893
		printk (KERN_ERR "%s: too many buses\n", usbcore_name);
894
		goto error_find_busnum;
L
Linus Torvalds 已提交
895
	}
896 897
	set_bit (busnum, busmap.busmap);
	bus->busnum = busnum;
898

L
Linus Torvalds 已提交
899 900
	/* Add it to the local list of buses */
	list_add (&bus->bus_list, &usb_bus_list);
901
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
902

903
	usb_notify_add_bus(bus);
L
Linus Torvalds 已提交
904

905 906
	dev_info (bus->controller, "new USB bus registered, assigned bus "
		  "number %d\n", bus->busnum);
L
Linus Torvalds 已提交
907
	return 0;
908 909 910 911

error_find_busnum:
	mutex_unlock(&usb_bus_list_lock);
	return result;
L
Linus Torvalds 已提交
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
}

/**
 * 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
	 */
931
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
932
	list_del (&bus->bus_list);
933
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
934

935
	usb_notify_remove_bus(bus);
L
Linus Torvalds 已提交
936 937 938 939 940

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

/**
941
 * register_root_hub - called by usb_add_hcd() to register a root hub
L
Linus Torvalds 已提交
942 943
 * @hcd: host controller for this root hub
 *
944
 * This function registers the root hub with the USB subsystem.  It sets up
945 946 947
 * 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).
L
Linus Torvalds 已提交
948
 */
949
static int register_root_hub(struct usb_hcd *hcd)
L
Linus Torvalds 已提交
950 951
{
	struct device *parent_dev = hcd->self.controller;
952
	struct usb_device *usb_dev = hcd->self.root_hub;
L
Linus Torvalds 已提交
953 954 955 956 957 958 959 960 961 962
	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);

963
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
964

965
	usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
L
Linus Torvalds 已提交
966 967
	retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
	if (retval != sizeof usb_dev->descriptor) {
968
		mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
969
		dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
970
				dev_name(&usb_dev->dev), retval);
L
Linus Torvalds 已提交
971 972 973 974 975 976
		return (retval < 0) ? retval : -EMSGSIZE;
	}

	retval = usb_new_device (usb_dev);
	if (retval) {
		dev_err (parent_dev, "can't register root hub for %s, %d\n",
977
				dev_name(&usb_dev->dev), retval);
L
Linus Torvalds 已提交
978
	}
979
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031

	if (retval == 0) {
		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? */
		if (hcd->state == HC_STATE_HALT)
			usb_hc_died (hcd);	/* This time clean up */
	}

	return retval;
}


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

/**
 * 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.
 *
 * Returns approximate bus time in nanoseconds for a periodic transaction.
 * 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;
			return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
		} else {
			tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
			return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
		}
	case USB_SPEED_FULL:	/* ISOC or INTR */
		if (isoc) {
			tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
			return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
		} else {
			tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
			return (9107L + BW_HOST_DELAY + tmp);
		}
	case USB_SPEED_HIGH:	/* ISOC or INTR */
		// FIXME adjust for input vs output
		if (isoc)
1032
			tmp = HS_NSECS_ISO (bytecount);
L
Linus Torvalds 已提交
1033
		else
1034
			tmp = HS_NSECS (bytecount);
L
Linus Torvalds 已提交
1035 1036 1037 1038 1039 1040
		return tmp;
	default:
		pr_debug ("%s: bogus device speed!\n", usbcore_name);
		return -1;
	}
}
1041
EXPORT_SYMBOL_GPL(usb_calc_bus_time);
L
Linus Torvalds 已提交
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051


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

/*
 * Generic HC operations.
 */

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

1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
/**
 * 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.
 *
 * Returns 0 for no error, otherwise a negative error code (in which case
 * 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 已提交
1068
{
1069
	int		rc = 0;
L
Linus Torvalds 已提交
1070

1071
	spin_lock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1072

1073
	/* Check that the URB isn't being killed */
1074
	if (unlikely(atomic_read(&urb->reject))) {
1075 1076
		rc = -EPERM;
		goto done;
1077
	}
L
Linus Torvalds 已提交
1078

1079 1080 1081 1082
	if (unlikely(!urb->ep->enabled)) {
		rc = -ENOENT;
		goto done;
	}
L
Linus Torvalds 已提交
1083

1084 1085 1086 1087 1088
	if (unlikely(!urb->dev->can_submit)) {
		rc = -EHOSTUNREACH;
		goto done;
	}

L
Linus Torvalds 已提交
1089
	/*
1090 1091
	 * Check the host controller's state and add the URB to the
	 * endpoint's queue.
L
Linus Torvalds 已提交
1092
	 */
1093
	switch (hcd->state) {
L
Linus Torvalds 已提交
1094 1095
	case HC_STATE_RUNNING:
	case HC_STATE_RESUMING:
A
Alan Stern 已提交
1096
		urb->unlinked = 0;
1097
		list_add_tail(&urb->urb_list, &urb->ep->urb_list);
L
Linus Torvalds 已提交
1098 1099
		break;
	default:
1100 1101
		rc = -ESHUTDOWN;
		goto done;
L
Linus Torvalds 已提交
1102
	}
1103
 done:
1104
	spin_unlock(&hcd_urb_list_lock);
1105 1106
	return rc;
}
1107
EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1108

1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
/**
 * 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.
 *
 * Returns 0 for no error, otherwise a negative error code (in which case
 * 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,
1129 1130 1131 1132 1133 1134 1135 1136 1137
		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;
	}
1138 1139
	if (tmp != &urb->urb_list)
		return -EIDRM;
L
Linus Torvalds 已提交
1140

1141 1142
	/* 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 已提交
1143
	 */
A
Alan Stern 已提交
1144
	if (urb->unlinked)
1145
		return -EBUSY;
A
Alan Stern 已提交
1146
	urb->unlinked = status;
L
Linus Torvalds 已提交
1147

1148 1149 1150 1151 1152
	/* IRQ setup can easily be broken so that USB controllers
	 * never get completion IRQs ... maybe even the ones we need to
	 * finish unlinking the initial failed usb_set_address()
	 * or device descriptor fetch.
	 */
1153
	if (!HCD_SAW_IRQ(hcd) && !is_root_hub(urb->dev)) {
1154 1155 1156 1157 1158
		dev_warn(hcd->self.controller, "Unlink after no-IRQ?  "
			"Controller is probably using the wrong IRQ.\n");
		set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
	}

1159
	return 0;
1160
}
1161
EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1162

1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
/**
 * 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)
1174 1175
{
	/* clear all state linking urb to this dev (and hcd) */
1176
	spin_lock(&hcd_urb_list_lock);
1177
	list_del_init(&urb->urb_list);
1178
	spin_unlock(&hcd_urb_list_lock);
1179
}
1180
EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1181

M
Magnus Damm 已提交
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
/*
 * 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;

1221 1222 1223 1224 1225
	if (*vaddr_handle == NULL) {
		WARN_ON_ONCE(1);
		return -EFAULT;
	}

M
Magnus Damm 已提交
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
	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;
}

1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
{
	enum dma_data_direction dir;

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

	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,
1285
				urb->sg,
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
				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 */
	urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL |
			URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
			URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
}

M
Magnus Damm 已提交
1311 1312
static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
			   gfp_t mem_flags)
1313
{
M
Magnus Damm 已提交
1314 1315 1316
	enum dma_data_direction dir;
	int ret = 0;

1317 1318
	/* Map the URB's buffers for DMA access.
	 * Lower level HCD code should use *_dma exclusively,
1319 1320
	 * unless it uses pio or talks to another transport,
	 * or uses the provided scatter gather list for bulk.
L
Linus Torvalds 已提交
1321
	 */
M
Magnus Damm 已提交
1322

A
Alan Stern 已提交
1323
	if (usb_endpoint_xfer_control(&urb->ep->desc)) {
1324
		if (hcd->self.uses_dma) {
M
Magnus Damm 已提交
1325
			urb->setup_dma = dma_map_single(
L
Linus Torvalds 已提交
1326 1327
					hcd->self.controller,
					urb->setup_packet,
M
Magnus Damm 已提交
1328
					sizeof(struct usb_ctrlrequest),
L
Linus Torvalds 已提交
1329
					DMA_TO_DEVICE);
1330 1331 1332
			if (dma_mapping_error(hcd->self.controller,
						urb->setup_dma))
				return -EAGAIN;
1333
			urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
1334
		} else if (hcd->driver->flags & HCD_LOCAL_MEM) {
M
Magnus Damm 已提交
1335 1336 1337 1338 1339 1340
			ret = hcd_alloc_coherent(
					urb->dev->bus, mem_flags,
					&urb->setup_dma,
					(void **)&urb->setup_packet,
					sizeof(struct usb_ctrlrequest),
					DMA_TO_DEVICE);
1341 1342 1343
			if (ret)
				return ret;
			urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
1344
		}
M
Magnus Damm 已提交
1345 1346 1347
	}

	dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1348
	if (urb->transfer_buffer_length != 0
M
Magnus Damm 已提交
1349
	    && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
1350
		if (hcd->self.uses_dma) {
1351 1352 1353
			if (urb->num_sgs) {
				int n = dma_map_sg(
						hcd->self.controller,
1354
						urb->sg,
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
						urb->num_sgs,
						dir);
				if (n <= 0)
					ret = -EAGAIN;
				else
					urb->transfer_flags |= URB_DMA_MAP_SG;
				if (n != urb->num_sgs) {
					urb->num_sgs = n;
					urb->transfer_flags |=
							URB_DMA_SG_COMBINED;
				}
			} else if (urb->sg) {
1367
				struct scatterlist *sg = urb->sg;
1368 1369 1370 1371 1372 1373 1374
				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,
1375
						urb->transfer_dma))
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
					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;
			}
1391
		} else if (hcd->driver->flags & HCD_LOCAL_MEM) {
M
Magnus Damm 已提交
1392 1393 1394 1395 1396 1397
			ret = hcd_alloc_coherent(
					urb->dev->bus, mem_flags,
					&urb->transfer_dma,
					&urb->transfer_buffer,
					urb->transfer_buffer_length,
					dir);
1398 1399
			if (ret == 0)
				urb->transfer_flags |= URB_MAP_LOCAL;
M
Magnus Damm 已提交
1400
		}
1401 1402 1403
		if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
				URB_SETUP_MAP_LOCAL)))
			unmap_urb_for_dma(hcd, urb);
L
Linus Torvalds 已提交
1404
	}
M
Magnus Damm 已提交
1405
	return ret;
1406
}
L
Linus Torvalds 已提交
1407

1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
/*-------------------------------------------------------------------------*/

/* 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);
1426
	atomic_inc(&urb->dev->urbnum);
1427 1428 1429 1430 1431 1432 1433 1434 1435
	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 已提交
1436

1437
	if (is_root_hub(urb->dev)) {
1438
		status = rh_urb_enqueue(hcd, urb);
1439 1440 1441 1442 1443 1444 1445 1446
	} 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))
				unmap_urb_for_dma(hcd, urb);
		}
	}
1447 1448

	if (unlikely(status)) {
L
Linus Torvalds 已提交
1449
		usbmon_urb_submit_error(&hcd->self, urb, status);
A
Alan Stern 已提交
1450
		urb->hcpriv = NULL;
1451 1452
		INIT_LIST_HEAD(&urb->urb_list);
		atomic_dec(&urb->use_count);
1453
		atomic_dec(&urb->dev->urbnum);
1454
		if (atomic_read(&urb->reject))
1455 1456
			wake_up(&usb_kill_urb_queue);
		usb_put_urb(urb);
L
Linus Torvalds 已提交
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
	}
	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.
 */
1468
static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
L
Linus Torvalds 已提交
1469 1470 1471
{
	int		value;

1472
	if (is_root_hub(urb->dev))
1473
		value = usb_rh_urb_dequeue(hcd, urb, status);
L
Linus Torvalds 已提交
1474 1475 1476 1477 1478
	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. */
1479
		value = hcd->driver->urb_dequeue(hcd, urb, status);
L
Linus Torvalds 已提交
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
	}
	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 已提交
1490
int usb_hcd_unlink_urb (struct urb *urb, int status)
L
Linus Torvalds 已提交
1491
{
1492
	struct usb_hcd		*hcd;
1493 1494
	int			retval = -EIDRM;
	unsigned long		flags;
L
Linus Torvalds 已提交
1495

1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
	/* 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 已提交
1512 1513 1514

	if (retval == 0)
		retval = -EINPROGRESS;
1515
	else if (retval != -EIDRM && retval != -EBUSY)
1516 1517
		dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
				urb, retval);
L
Linus Torvalds 已提交
1518 1519 1520 1521 1522
	return retval;
}

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

A
Alan Stern 已提交
1523 1524 1525 1526
/**
 * 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 已提交
1527
 * @status: completion status code for the URB.
A
Alan Stern 已提交
1528 1529 1530 1531 1532 1533 1534
 * 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 已提交
1535
 *
A
Alan Stern 已提交
1536
 * If @urb was unlinked, the value of @status will be overridden by
A
Alan Stern 已提交
1537 1538
 * @urb->unlinked.  Erroneous short transfers are detected in case
 * the HCD hasn't checked for them.
A
Alan Stern 已提交
1539
 */
A
Alan Stern 已提交
1540
void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
A
Alan Stern 已提交
1541
{
A
Alan Stern 已提交
1542
	urb->hcpriv = NULL;
A
Alan Stern 已提交
1543
	if (unlikely(urb->unlinked))
A
Alan Stern 已提交
1544
		status = urb->unlinked;
A
Alan Stern 已提交
1545
	else if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
A
Alan Stern 已提交
1546
			urb->actual_length < urb->transfer_buffer_length &&
A
Alan Stern 已提交
1547 1548
			!status))
		status = -EREMOTEIO;
A
Alan Stern 已提交
1549

1550
	unmap_urb_for_dma(hcd, urb);
A
Alan Stern 已提交
1551
	usbmon_urb_complete(&hcd->self, urb, status);
1552 1553
	usb_unanchor_urb(urb);

A
Alan Stern 已提交
1554
	/* pass ownership to the completion handler */
A
Alan Stern 已提交
1555
	urb->status = status;
A
Alan Stern 已提交
1556 1557
	urb->complete (urb);
	atomic_dec (&urb->use_count);
1558
	if (unlikely(atomic_read(&urb->reject)))
A
Alan Stern 已提交
1559 1560 1561
		wake_up (&usb_kill_urb_queue);
	usb_put_urb (urb);
}
1562
EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
A
Alan Stern 已提交
1563 1564 1565

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

1566 1567 1568
/* 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 已提交
1569
 */
1570
void usb_hcd_flush_endpoint(struct usb_device *udev,
A
Alan Stern 已提交
1571
		struct usb_host_endpoint *ep)
L
Linus Torvalds 已提交
1572 1573 1574 1575
{
	struct usb_hcd		*hcd;
	struct urb		*urb;

1576 1577
	if (!ep)
		return;
1578
	might_sleep();
1579
	hcd = bus_to_hcd(udev->bus);
L
Linus Torvalds 已提交
1580

1581
	/* No more submits can occur */
1582
	spin_lock_irq(&hcd_urb_list_lock);
1583
rescan:
L
Linus Torvalds 已提交
1584
	list_for_each_entry (urb, &ep->urb_list, urb_list) {
A
Alan Stern 已提交
1585
		int	is_in;
L
Linus Torvalds 已提交
1586

A
Alan Stern 已提交
1587
		if (urb->unlinked)
L
Linus Torvalds 已提交
1588 1589
			continue;
		usb_get_urb (urb);
A
Alan Stern 已提交
1590
		is_in = usb_urb_dir_in(urb);
1591
		spin_unlock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1592

1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
		/* 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:
			 		s = "-iso"; break;
				};
				s;
			}));
L
Linus Torvalds 已提交
1613 1614 1615
		usb_put_urb (urb);

		/* list contents may have changed */
1616
		spin_lock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1617 1618
		goto rescan;
	}
1619
	spin_unlock_irq(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1620

1621
	/* Wait until the endpoint queue is completely empty */
1622
	while (!list_empty (&ep->urb_list)) {
1623
		spin_lock_irq(&hcd_urb_list_lock);
1624 1625 1626 1627 1628 1629 1630 1631

		/* 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);
		}
1632
		spin_unlock_irq(&hcd_urb_list_lock);
1633 1634 1635 1636 1637 1638

		if (urb) {
			usb_kill_urb (urb);
			usb_put_urb (urb);
		}
	}
L
Linus Torvalds 已提交
1639 1640
}

1641
/**
1642 1643 1644
 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
 *				the bus bandwidth
 * @udev: target &usb_device
1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
 * @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.
 *
 * Returns an error if the requested bandwidth change exceeds the
 * bus bandwidth or host controller internal resources.
1661
 */
1662
int usb_hcd_alloc_bandwidth(struct usb_device *udev,
1663
		struct usb_host_config *new_config,
1664 1665
		struct usb_host_interface *cur_alt,
		struct usb_host_interface *new_alt)
1666 1667
{
	int num_intfs, i, j;
1668
	struct usb_host_interface *alt = NULL;
1669 1670 1671 1672 1673 1674 1675 1676 1677
	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 */
1678
	if (!new_config && !cur_alt) {
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 1707 1708 1709 1710 1711 1712 1713 1714
		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) {
1715 1716 1717 1718 1719
			struct usb_host_interface *first_alt;
			int iface_num;

			first_alt = &new_config->intf_cache[i]->altsetting[0];
			iface_num = first_alt->desc.bInterfaceNumber;
1720
			/* Set up endpoints for alternate interface setting 0 */
1721
			alt = usb_find_alt_setting(new_config, iface_num, 0);
1722 1723
			if (!alt)
				/* No alt setting 0? Pick the first setting. */
1724
				alt = first_alt;
1725

1726 1727 1728 1729 1730 1731 1732
			for (j = 0; j < alt->desc.bNumEndpoints; j++) {
				ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
				if (ret < 0)
					goto reset;
			}
		}
	}
1733
	if (cur_alt && new_alt) {
1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
		struct usb_interface *iface = usb_ifnum_to_if(udev,
				cur_alt->desc.bInterfaceNumber);

		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];
		}

1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
		/* 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;
		}
	}
1767 1768 1769 1770 1771 1772 1773
	ret = hcd->driver->check_bandwidth(hcd, udev);
reset:
	if (ret < 0)
		hcd->driver->reset_bandwidth(hcd, udev);
	return ret;
}

1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
/* 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);
}

1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818
/**
 * 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);
	}
}

1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
/**
 * 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.
 *
 * Sets up a group of bulk endpoints to have num_streams stream IDs available.
 * Drivers may queue multiple transfers to different stream IDs, which may
 * complete in a different order than they were queued.
 */
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.
 */
void usb_free_streams(struct usb_interface *interface,
		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)
		return;

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

	hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
}
EXPORT_SYMBOL_GPL(usb_free_streams);

1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
/* 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 已提交
1899 1900
/*-------------------------------------------------------------------------*/

A
Alan Stern 已提交
1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
/* called in any context */
int usb_hcd_get_frame_number (struct usb_device *udev)
{
	struct usb_hcd	*hcd = bus_to_hcd(udev->bus);

	if (!HC_IS_RUNNING (hcd->state))
		return -ESHUTDOWN;
	return hcd->driver->get_frame_number (hcd);
}

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

1913
#ifdef	CONFIG_PM
L
Linus Torvalds 已提交
1914

A
Alan Stern 已提交
1915
int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
L
Linus Torvalds 已提交
1916
{
1917 1918 1919
	struct usb_hcd	*hcd = container_of(rhdev->bus, struct usb_hcd, self);
	int		status;
	int		old_state = hcd->state;
L
Linus Torvalds 已提交
1920

1921
	dev_dbg(&rhdev->dev, "bus %s%s\n",
A
Alan Stern 已提交
1922
			(msg.event & PM_EVENT_AUTO ? "auto-" : ""), "suspend");
1923 1924 1925 1926 1927 1928 1929 1930
	if (!hcd->driver->bus_suspend) {
		status = -ENOENT;
	} else {
		hcd->state = HC_STATE_QUIESCING;
		status = hcd->driver->bus_suspend(hcd);
	}
	if (status == 0) {
		usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
1931
		hcd->state = HC_STATE_SUSPENDED;
1932 1933 1934
	} else {
		hcd->state = old_state;
		dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1935
				"suspend", status);
1936
	}
1937
	return status;
L
Linus Torvalds 已提交
1938 1939
}

A
Alan Stern 已提交
1940
int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
L
Linus Torvalds 已提交
1941
{
1942 1943
	struct usb_hcd	*hcd = container_of(rhdev->bus, struct usb_hcd, self);
	int		status;
1944
	int		old_state = hcd->state;
L
Linus Torvalds 已提交
1945

1946
	dev_dbg(&rhdev->dev, "usb %s%s\n",
A
Alan Stern 已提交
1947
			(msg.event & PM_EVENT_AUTO ? "auto-" : ""), "resume");
1948
	clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
1949
	if (!hcd->driver->bus_resume)
1950
		return -ENOENT;
1951 1952
	if (hcd->state == HC_STATE_RUNNING)
		return 0;
1953

1954
	hcd->state = HC_STATE_RESUMING;
1955 1956 1957 1958 1959 1960 1961
	status = hcd->driver->bus_resume(hcd);
	if (status == 0) {
		/* TRSMRCY = 10 msec */
		msleep(10);
		usb_set_device_state(rhdev, rhdev->actconfig
				? USB_STATE_CONFIGURED
				: USB_STATE_ADDRESS);
1962
		hcd->state = HC_STATE_RUNNING;
1963
	} else {
1964
		hcd->state = old_state;
1965
		dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1966
				"resume", status);
1967 1968
		if (status != -ESHUTDOWN)
			usb_hc_died(hcd);
1969 1970
	}
	return status;
L
Linus Torvalds 已提交
1971 1972
}

1973 1974 1975 1976
#endif	/* CONFIG_PM */

#ifdef	CONFIG_USB_SUSPEND

1977 1978 1979 1980 1981 1982 1983
/* 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);
1984
	usb_remote_wakeup(udev);
1985 1986 1987
	usb_unlock_device(udev);
}

L
Linus Torvalds 已提交
1988 1989 1990 1991 1992 1993
/**
 * usb_hcd_resume_root_hub - called by HCD to resume its root hub 
 * @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
1994 1995
 * 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 已提交
1996 1997 1998 1999 2000 2001
 */
void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
{
	unsigned long flags;

	spin_lock_irqsave (&hcd_root_hub_lock, flags);
2002 2003
	if (hcd->rh_registered) {
		set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
2004
		queue_work(pm_wq, &hcd->wakeup_work);
2005
	}
L
Linus Torvalds 已提交
2006 2007
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
}
2008
EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
L
Linus Torvalds 已提交
2009

2010
#endif	/* CONFIG_USB_SUSPEND */
L
Linus Torvalds 已提交
2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046

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

#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.
 */
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;
}
2047
EXPORT_SYMBOL_GPL(usb_bus_start_enum);
L
Linus Torvalds 已提交
2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060

#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.
 */
2061
irqreturn_t usb_hcd_irq (int irq, void *__hcd)
L
Linus Torvalds 已提交
2062 2063
{
	struct usb_hcd		*hcd = __hcd;
2064 2065
	unsigned long		flags;
	irqreturn_t		rc;
L
Linus Torvalds 已提交
2066

2067 2068 2069 2070 2071
	/* 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);
L
Linus Torvalds 已提交
2072

2073
	if (unlikely(hcd->state == HC_STATE_HALT || !HCD_HW_ACCESSIBLE(hcd))) {
2074 2075 2076 2077 2078
		rc = IRQ_NONE;
	} else if (hcd->driver->irq(hcd) == IRQ_NONE) {
		rc = IRQ_NONE;
	} else {
		set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
2079

2080 2081 2082 2083 2084 2085 2086
		if (unlikely(hcd->state == HC_STATE_HALT))
			usb_hc_died(hcd);
		rc = IRQ_HANDLED;
	}

	local_irq_restore(flags);
	return rc;
L
Linus Torvalds 已提交
2087
}
D
Dong Nguyen 已提交
2088
EXPORT_SYMBOL_GPL(usb_hcd_irq);
L
Linus Torvalds 已提交
2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107

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

/**
 * 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
 * by the PCI glue, so only glue for non-PCI busses should need to call it. 
 */
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);
	if (hcd->rh_registered) {
2108
		clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
L
Linus Torvalds 已提交
2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134

		/* 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);
	}
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
}
EXPORT_SYMBOL_GPL (usb_hc_died);

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

/**
 * 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.
 *
 * If memory is unavailable, returns NULL.
 */
struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
2135
		struct device *dev, const char *bus_name)
L
Linus Torvalds 已提交
2136 2137 2138
{
	struct usb_hcd *hcd;

2139
	hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
L
Linus Torvalds 已提交
2140 2141 2142 2143 2144
	if (!hcd) {
		dev_dbg (dev, "hcd alloc failed\n");
		return NULL;
	}
	dev_set_drvdata(dev, hcd);
2145
	kref_init(&hcd->kref);
L
Linus Torvalds 已提交
2146 2147 2148 2149

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

	init_timer(&hcd->rh_timer);
2153 2154
	hcd->rh_timer.function = rh_timer_func;
	hcd->rh_timer.data = (unsigned long) hcd;
2155
#ifdef CONFIG_USB_SUSPEND
2156 2157
	INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
#endif
2158
	mutex_init(&hcd->bandwidth_mutex);
L
Linus Torvalds 已提交
2159 2160 2161 2162 2163 2164

	hcd->driver = driver;
	hcd->product_desc = (driver->product_desc) ? driver->product_desc :
			"USB Host Controller";
	return hcd;
}
2165
EXPORT_SYMBOL_GPL(usb_create_hcd);
L
Linus Torvalds 已提交
2166

2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179
static void hcd_release (struct kref *kref)
{
	struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);

	kfree(hcd);
}

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

L
Linus Torvalds 已提交
2182 2183
void usb_put_hcd (struct usb_hcd *hcd)
{
2184 2185
	if (hcd)
		kref_put (&hcd->kref, hcd_release);
L
Linus Torvalds 已提交
2186
}
2187
EXPORT_SYMBOL_GPL(usb_put_hcd);
L
Linus Torvalds 已提交
2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201

/**
 * 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)
{
2202 2203
	int retval;
	struct usb_device *rhdev;
L
Linus Torvalds 已提交
2204 2205 2206

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

2207
	hcd->authorized_default = hcd->wireless? 0 : 1;
2208 2209
	set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);

2210 2211 2212 2213
	/* 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 已提交
2214 2215 2216 2217 2218 2219
	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)
2220
		goto err_register_bus;
L
Linus Torvalds 已提交
2221

2222 2223 2224 2225 2226
	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;
	}
2227
	hcd->self.root_hub = rhdev;
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239

	switch (hcd->driver->flags & HCD_MASK) {
	case HCD_USB11:
		rhdev->speed = USB_SPEED_FULL;
		break;
	case HCD_USB2:
		rhdev->speed = USB_SPEED_HIGH;
		break;
	case HCD_USB3:
		rhdev->speed = USB_SPEED_SUPER;
		break;
	default:
2240
		goto err_set_rh_speed;
2241
	}
2242

2243 2244 2245 2246 2247 2248
	/* 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.
	 */
	device_init_wakeup(&rhdev->dev, 1);

2249 2250 2251 2252 2253 2254 2255
	/* "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) {
		dev_err(hcd->self.controller, "can't setup\n");
		goto err_hcd_driver_setup;
	}
2256
	hcd->rh_pollable = 1;
2257

2258 2259 2260
	/* 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))
2261 2262 2263
		dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");

	/* enable irqs just before we start the controller */
L
Linus Torvalds 已提交
2264
	if (hcd->driver->irq) {
2265 2266 2267 2268 2269

		/* 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.
		 */
G
Geoff Levand 已提交
2270 2271
		if (irqflags & IRQF_SHARED)
			irqflags &= ~IRQF_DISABLED;
2272

L
Linus Torvalds 已提交
2273 2274 2275 2276 2277
		snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
				hcd->driver->description, hcd->self.busnum);
		if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
				hcd->irq_descr, hcd)) != 0) {
			dev_err(hcd->self.controller,
D
David S. Miller 已提交
2278
					"request interrupt %d failed\n", irqnum);
2279
			goto err_request_irq;
L
Linus Torvalds 已提交
2280 2281
		}
		hcd->irq = irqnum;
D
David S. Miller 已提交
2282
		dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
L
Linus Torvalds 已提交
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296
				(hcd->driver->flags & HCD_MEMORY) ?
					"io mem" : "io base",
					(unsigned long long)hcd->rsrc_start);
	} else {
		hcd->irq = -1;
		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);
	}

	if ((retval = hcd->driver->start(hcd)) < 0) {
		dev_err(hcd->self.controller, "startup error %d\n", retval);
2297
		goto err_hcd_driver_start;
L
Linus Torvalds 已提交
2298 2299
	}

2300
	/* starting here, usbcore will pay attention to this root hub */
2301
	rhdev->bus_mA = min(500u, hcd->power_budget);
2302
	if ((retval = register_root_hub(hcd)) != 0)
2303 2304
		goto err_register_root_hub;

2305 2306 2307 2308 2309 2310
	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;
	}
2311
	if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
2312
		usb_hcd_poll_rh_status(hcd);
L
Linus Torvalds 已提交
2313 2314
	return retval;

2315
error_create_attr_group:
2316 2317 2318 2319 2320 2321 2322 2323 2324
	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);

#ifdef CONFIG_USB_SUSPEND
	cancel_work_sync(&hcd->wakeup_work);
#endif
2325
	mutex_lock(&usb_bus_list_lock);
2326
	usb_disconnect(&rhdev);		/* Sets rhdev to NULL */
2327
	mutex_unlock(&usb_bus_list_lock);
2328
err_register_root_hub:
2329
	hcd->rh_pollable = 0;
2330
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2331
	del_timer_sync(&hcd->rh_timer);
2332
	hcd->driver->stop(hcd);
2333
	hcd->state = HC_STATE_HALT;
2334
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2335
	del_timer_sync(&hcd->rh_timer);
2336
err_hcd_driver_start:
L
Linus Torvalds 已提交
2337 2338
	if (hcd->irq >= 0)
		free_irq(irqnum, hcd);
2339 2340
err_request_irq:
err_hcd_driver_setup:
2341
err_set_rh_speed:
2342
	usb_put_dev(hcd->self.root_hub);
2343
err_allocate_root_hub:
L
Linus Torvalds 已提交
2344
	usb_deregister_bus(&hcd->self);
2345
err_register_bus:
L
Linus Torvalds 已提交
2346 2347 2348
	hcd_buffer_destroy(hcd);
	return retval;
} 
2349
EXPORT_SYMBOL_GPL(usb_add_hcd);
L
Linus Torvalds 已提交
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360

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

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

2365 2366
	usb_get_dev(rhdev);
	sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2367

L
Linus Torvalds 已提交
2368 2369 2370 2371 2372 2373 2374
	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);
2375

2376
#ifdef CONFIG_USB_SUSPEND
2377
	cancel_work_sync(&hcd->wakeup_work);
2378 2379
#endif

2380
	mutex_lock(&usb_bus_list_lock);
2381
	usb_disconnect(&rhdev);		/* Sets rhdev to NULL */
2382
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
2383

2384 2385 2386 2387 2388 2389
	/* 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;
2390
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2391 2392
	del_timer_sync(&hcd->rh_timer);

L
Linus Torvalds 已提交
2393 2394 2395
	hcd->driver->stop(hcd);
	hcd->state = HC_STATE_HALT;

2396
	/* In case the HCD restarted the timer, stop it again. */
2397
	clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
A
Alan Stern 已提交
2398 2399
	del_timer_sync(&hcd->rh_timer);

L
Linus Torvalds 已提交
2400 2401
	if (hcd->irq >= 0)
		free_irq(hcd->irq, hcd);
2402 2403

	usb_put_dev(hcd->self.root_hub);
L
Linus Torvalds 已提交
2404 2405 2406
	usb_deregister_bus(&hcd->self);
	hcd_buffer_destroy(hcd);
}
2407
EXPORT_SYMBOL_GPL(usb_remove_hcd);
L
Linus Torvalds 已提交
2408

2409 2410 2411 2412 2413 2414 2415 2416
void
usb_hcd_platform_shutdown(struct platform_device* dev)
{
	struct usb_hcd *hcd = platform_get_drvdata(dev);

	if (hcd->driver->shutdown)
		hcd->driver->shutdown(hcd);
}
2417
EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
2418

L
Linus Torvalds 已提交
2419 2420
/*-------------------------------------------------------------------------*/

2421
#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
L
Linus Torvalds 已提交
2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456

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

2457
#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */