hcd.c 58.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>
L
Linus Torvalds 已提交
41 42 43 44 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 <linux/usb.h>

#include "usb.h"
#include "hcd.h"
#include "hub.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 131 132 133 134 135 136 137 138
/*-------------------------------------------------------------------------*/

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

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

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

/* 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; */
139
	0x00,       /*  __u8  bDeviceProtocol; [ usb 2.0 no TT ] */
140
	0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
L
Linus Torvalds 已提交
141

142 143
	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation */
	0x02, 0x00, /*  __le16 idProduct; device 0x0002 */
L
Linus Torvalds 已提交
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
	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 ] */
163
	0x40,       /*  __u8  bMaxPacketSize0; 64 Bytes */
L
Linus Torvalds 已提交
164

165 166
	0x6b, 0x1d, /*  __le16 idVendor; Linux Foundation */
	0x01, 0x00, /*  __le16 idProduct; device 0x0001 */
L
Linus Torvalds 已提交
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 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
	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 */
270 271 272
		    /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
		     * see hub.c:hub_configure() for details. */
	(USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
L
Linus Torvalds 已提交
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 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
	0x0c        /*  __u8  ep_bInterval; (256ms -- usb 2.0 spec) */
};

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

/*
 * helper routine for returning string descriptors in UTF-16LE
 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
 */
static int ascii2utf (char *s, u8 *utf, int utfmax)
{
	int retval;

	for (retval = 0; *s && utfmax > 1; utfmax -= 2, retval += 2) {
		*utf++ = *s++;
		*utf++ = 0;
	}
	if (utfmax > 0) {
		*utf = *s;
		++retval;
	}
	return retval;
}

/*
 * rh_string - provides manufacturer, product and serial strings for root hub
 * @id: the string ID number (1: serial number, 2: product, 3: vendor)
 * @hcd: the host controller for this root hub
 * @data: return packet in UTF-16 LE
 * @len: length of the return packet
 *
 * Produces either a manufacturer, product or serial number string for the
 * virtual root hub device.
 */
static int rh_string (
	int		id,
	struct usb_hcd	*hcd,
	u8		*data,
	int		len
) {
	char buf [100];

	// language ids
	if (id == 0) {
		buf[0] = 4;    buf[1] = 3;	/* 4 bytes string data */
		buf[2] = 0x09; buf[3] = 0x04;	/* MSFT-speak for "en-us" */
		len = min (len, 4);
		memcpy (data, buf, len);
		return len;

	// serial number
	} else if (id == 1) {
		strlcpy (buf, hcd->self.bus_name, sizeof buf);

	// product description
	} else if (id == 2) {
		strlcpy (buf, hcd->product_desc, sizeof buf);

 	// id 3 == vendor description
	} else if (id == 3) {
333 334
		snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
			init_utsname()->release, hcd->driver->description);
L
Linus Torvalds 已提交
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

	// unsupported IDs --> "protocol stall"
	} else
		return -EPIPE;

	switch (len) {		/* All cases fall through */
	default:
		len = 2 + ascii2utf (buf, data + 2, len - 2);
	case 2:
		data [1] = 3;	/* type == string */
	case 1:
		data [0] = 2 * (strlen (buf) + 1);
	case 0:
		;		/* Compiler wants a statement here */
	}
	return len;
}


/* 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;
360 361
	u8		tbuf [sizeof (struct usb_hub_descriptor)]
		__attribute__((aligned(4)));
L
Linus Torvalds 已提交
362 363
	const u8	*bufp = tbuf;
	int		len = 0;
364
	int		status;
L
Linus Torvalds 已提交
365
	int		n;
366 367
	u8		patch_wakeup = 0;
	u8		patch_protocol = 0;
L
Linus Torvalds 已提交
368

369 370
	might_sleep();

371 372 373 374 375
	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 已提交
376
	urb->hcpriv = hcd;	/* Indicate it's queued */
377

L
Linus Torvalds 已提交
378 379 380 381 382 383 384 385 386 387 388 389 390 391
	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 */

392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
	/* 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 已提交
408
	case DeviceRequest | USB_REQ_GET_STATUS:
409 410
		tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
					<< USB_DEVICE_REMOTE_WAKEUP)
L
Linus Torvalds 已提交
411 412 413 414 415 416
				| (1 << USB_DEVICE_SELF_POWERED);
		tbuf [1] = 0;
		len = 2;
		break;
	case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
		if (wValue == USB_DEVICE_REMOTE_WAKEUP)
417
			device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
L
Linus Torvalds 已提交
418 419 420 421
		else
			goto error;
		break;
	case DeviceOutRequest | USB_REQ_SET_FEATURE:
422 423 424
		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 已提交
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
		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:
			if (hcd->driver->flags & HCD_USB2)
				bufp = usb2_rh_dev_descriptor;
			else if (hcd->driver->flags & HCD_USB11)
				bufp = usb11_rh_dev_descriptor;
			else
				goto error;
			len = 18;
444 445
			if (hcd->has_tt)
				patch_protocol = 1;
L
Linus Torvalds 已提交
446 447 448 449 450 451 452 453 454
			break;
		case USB_DT_CONFIG << 8:
			if (hcd->driver->flags & HCD_USB2) {
				bufp = hs_rh_config_descriptor;
				len = sizeof hs_rh_config_descriptor;
			} else {
				bufp = fs_rh_config_descriptor;
				len = sizeof fs_rh_config_descriptor;
			}
455
			if (device_can_wakeup(&hcd->self.root_hub->dev))
L
Linus Torvalds 已提交
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
				patch_wakeup = 1;
			break;
		case USB_DT_STRING << 8:
			n = rh_string (wValue & 0xff, hcd, ubuf, wLength);
			if (n < 0)
				goto error;
			urb->actual_length = n;
			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 */
499 500 501 502 503 504 505 506
		switch (typeReq) {
		case GetHubStatus:
		case GetPortStatus:
			len = 4;
			break;
		case GetHubDescriptor:
			len = sizeof (struct usb_hub_descriptor);
			break;
L
Linus Torvalds 已提交
507
		}
508 509 510
		status = hcd->driver->hub_control (hcd,
			typeReq, wValue, wIndex,
			tbuf, wLength);
L
Linus Torvalds 已提交
511 512 513 514 515 516 517 518 519 520 521 522 523
		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,
524
				wLength, status);
L
Linus Torvalds 已提交
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
		}
	}
	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;
540 541 542 543 544 545 546

		/* 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 已提交
547 548 549
	}

	/* any errors get returned through the urb completion */
550
	spin_lock_irq(&hcd_root_hub_lock);
551
	usb_hcd_unlink_urb_from_ep(hcd, urb);
552 553 554 555 556 557

	/* 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 已提交
558
	usb_hcd_giveback_urb(hcd, urb, status);
559 560 561
	spin_lock(&hcd_root_hub_lock);

	spin_unlock_irq(&hcd_root_hub_lock);
L
Linus Torvalds 已提交
562 563 564 565 566 567
	return 0;
}

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

/*
568 569 570
 * 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 已提交
571
 *
572 573
 * Completions are called in_interrupt(), but they may or may not
 * be in_irq().
L
Linus Torvalds 已提交
574
 */
575 576 577 578 579 580
void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
{
	struct urb	*urb;
	int		length;
	unsigned long	flags;
	char		buffer[4];	/* Any root hubs with > 31 ports? */
L
Linus Torvalds 已提交
581

A
Alan Stern 已提交
582 583
	if (unlikely(!hcd->rh_registered))
		return;
584 585
	if (!hcd->uses_new_polling && !hcd->status_urb)
		return;
L
Linus Torvalds 已提交
586

587 588
	length = hcd->driver->hub_status_data(hcd, buffer);
	if (length > 0) {
L
Linus Torvalds 已提交
589

590
		/* try to complete the status urb */
591
		spin_lock_irqsave(&hcd_root_hub_lock, flags);
592 593
		urb = hcd->status_urb;
		if (urb) {
594 595 596 597
			hcd->poll_pending = 0;
			hcd->status_urb = NULL;
			urb->actual_length = length;
			memcpy(urb->transfer_buffer, buffer, length);
598

599
			usb_hcd_unlink_urb_from_ep(hcd, urb);
600
			spin_unlock(&hcd_root_hub_lock);
A
Alan Stern 已提交
601
			usb_hcd_giveback_urb(hcd, urb, 0);
602
			spin_lock(&hcd_root_hub_lock);
603
		} else {
604 605
			length = 0;
			hcd->poll_pending = 1;
606
		}
607
		spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
L
Linus Torvalds 已提交
608 609
	}

610
	/* The USB 2.0 spec says 256 ms.  This is close enough and won't
611 612 613
	 * 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 */
614 615
	if (hcd->uses_new_polling ? hcd->poll_rh :
			(length == 0 && hcd->status_urb != NULL))
616
		mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
L
Linus Torvalds 已提交
617
}
618
EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
L
Linus Torvalds 已提交
619 620

/* timer callback */
621 622 623 624 625 626
static void rh_timer_func (unsigned long _hcd)
{
	usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
}

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

628
static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
L
Linus Torvalds 已提交
629
{
630
	int		retval;
L
Linus Torvalds 已提交
631
	unsigned long	flags;
632
	int		len = 1 + (urb->dev->maxchild / 8);
L
Linus Torvalds 已提交
633

634
	spin_lock_irqsave (&hcd_root_hub_lock, flags);
635
	if (hcd->status_urb || urb->transfer_buffer_length < len) {
636 637
		dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
		retval = -EINVAL;
638 639
		goto done;
	}
L
Linus Torvalds 已提交
640

641 642 643
	retval = usb_hcd_link_urb_to_ep(hcd, urb);
	if (retval)
		goto done;
L
Linus Torvalds 已提交
644

645 646 647 648 649 650 651 652 653 654
	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 */
	else if (hcd->poll_pending)
		mod_timer(&hcd->rh_timer, jiffies);
	retval = 0;
 done:
655 656
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
	return retval;
L
Linus Torvalds 已提交
657 658 659 660
}

static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
{
A
Alan Stern 已提交
661
	if (usb_endpoint_xfer_int(&urb->ep->desc))
662
		return rh_queue_status (hcd, urb);
A
Alan Stern 已提交
663
	if (usb_endpoint_xfer_control(&urb->ep->desc))
L
Linus Torvalds 已提交
664
		return rh_call_control (hcd, urb);
665
	return -EINVAL;
L
Linus Torvalds 已提交
666 667 668 669
}

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

670 671
/* Unlinks of root-hub control URBs are legal, but they don't do anything
 * since these URBs always execute synchronously.
672
 */
673
static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
L
Linus Torvalds 已提交
674
{
675
	unsigned long	flags;
676
	int		rc;
L
Linus Torvalds 已提交
677

678
	spin_lock_irqsave(&hcd_root_hub_lock, flags);
679 680 681 682
	rc = usb_hcd_check_unlink_urb(hcd, urb, status);
	if (rc)
		goto done;

A
Alan Stern 已提交
683
	if (usb_endpoint_num(&urb->ep->desc) == 0) {	/* Control URB */
684
		;	/* Do nothing */
685 686 687

	} else {				/* Status URB */
		if (!hcd->uses_new_polling)
688
			del_timer (&hcd->rh_timer);
689 690
		if (urb == hcd->status_urb) {
			hcd->status_urb = NULL;
691
			usb_hcd_unlink_urb_from_ep(hcd, urb);
L
Linus Torvalds 已提交
692

693
			spin_unlock(&hcd_root_hub_lock);
A
Alan Stern 已提交
694
			usb_hcd_giveback_urb(hcd, urb, status);
695 696 697
			spin_lock(&hcd_root_hub_lock);
		}
	}
698
 done:
699
	spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
700
	return rc;
L
Linus Torvalds 已提交
701 702
}

703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762


/*
 * 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 已提交
763 764
/*-------------------------------------------------------------------------*/

765
static struct class *usb_host_class;
L
Linus Torvalds 已提交
766 767 768

int usb_host_init(void)
{
769 770 771 772 773 774
	int retval = 0;

	usb_host_class = class_create(THIS_MODULE, "usb_host");
	if (IS_ERR(usb_host_class))
		retval = PTR_ERR(usb_host_class);
	return retval;
L
Linus Torvalds 已提交
775 776 777 778
}

void usb_host_cleanup(void)
{
779
	class_destroy(usb_host_class);
L
Linus Torvalds 已提交
780 781 782 783 784 785 786 787 788 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
}

/**
 * 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)
{
816
	int result = -E2BIG;
L
Linus Torvalds 已提交
817 818
	int busnum;

819
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
820
	busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
821
	if (busnum >= USB_MAXBUS) {
L
Linus Torvalds 已提交
822
		printk (KERN_ERR "%s: too many buses\n", usbcore_name);
823
		goto error_find_busnum;
L
Linus Torvalds 已提交
824
	}
825 826
	set_bit (busnum, busmap.busmap);
	bus->busnum = busnum;
827

828 829
	bus->dev = device_create(usb_host_class, bus->controller, MKDEV(0, 0),
				 bus, "usb_host%d", busnum);
830 831
	result = PTR_ERR(bus->dev);
	if (IS_ERR(bus->dev))
832
		goto error_create_class_dev;
833

L
Linus Torvalds 已提交
834 835
	/* Add it to the local list of buses */
	list_add (&bus->bus_list, &usb_bus_list);
836
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
837

838
	usb_notify_add_bus(bus);
L
Linus Torvalds 已提交
839

840 841
	dev_info (bus->controller, "new USB bus registered, assigned bus "
		  "number %d\n", bus->busnum);
L
Linus Torvalds 已提交
842
	return 0;
843 844 845 846 847 848

error_create_class_dev:
	clear_bit(busnum, busmap.busmap);
error_find_busnum:
	mutex_unlock(&usb_bus_list_lock);
	return result;
L
Linus Torvalds 已提交
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
}

/**
 * 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
	 */
868
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
869
	list_del (&bus->bus_list);
870
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
871

872
	usb_notify_remove_bus(bus);
L
Linus Torvalds 已提交
873 874 875

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

876
	device_unregister(bus->dev);
L
Linus Torvalds 已提交
877 878 879
}

/**
880
 * register_root_hub - called by usb_add_hcd() to register a root hub
L
Linus Torvalds 已提交
881 882
 * @hcd: host controller for this root hub
 *
883
 * This function registers the root hub with the USB subsystem.  It sets up
884 885 886
 * 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 已提交
887
 */
888
static int register_root_hub(struct usb_hcd *hcd)
L
Linus Torvalds 已提交
889 890
{
	struct device *parent_dev = hcd->self.controller;
891
	struct usb_device *usb_dev = hcd->self.root_hub;
L
Linus Torvalds 已提交
892 893 894 895 896 897 898 899 900 901
	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);

902
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
903 904 905 906

	usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
	retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
	if (retval != sizeof usb_dev->descriptor) {
907
		mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
908
		dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
909
				dev_name(&usb_dev->dev), retval);
L
Linus Torvalds 已提交
910 911 912 913 914 915
		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",
916
				dev_name(&usb_dev->dev), retval);
L
Linus Torvalds 已提交
917
	}
918
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970

	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)
971
			tmp = HS_NSECS_ISO (bytecount);
L
Linus Torvalds 已提交
972
		else
973
			tmp = HS_NSECS (bytecount);
L
Linus Torvalds 已提交
974 975 976 977 978 979
		return tmp;
	default:
		pr_debug ("%s: bogus device speed!\n", usbcore_name);
		return -1;
	}
}
980
EXPORT_SYMBOL_GPL(usb_calc_bus_time);
L
Linus Torvalds 已提交
981 982 983 984 985 986 987 988 989 990


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

/*
 * Generic HC operations.
 */

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

991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
/**
 * 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 已提交
1007
{
1008
	int		rc = 0;
L
Linus Torvalds 已提交
1009

1010
	spin_lock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1011

1012 1013 1014 1015
	/* Check that the URB isn't being killed */
	if (unlikely(urb->reject)) {
		rc = -EPERM;
		goto done;
1016
	}
L
Linus Torvalds 已提交
1017

1018 1019 1020 1021
	if (unlikely(!urb->ep->enabled)) {
		rc = -ENOENT;
		goto done;
	}
L
Linus Torvalds 已提交
1022

1023 1024 1025 1026 1027
	if (unlikely(!urb->dev->can_submit)) {
		rc = -EHOSTUNREACH;
		goto done;
	}

L
Linus Torvalds 已提交
1028
	/*
1029 1030
	 * Check the host controller's state and add the URB to the
	 * endpoint's queue.
L
Linus Torvalds 已提交
1031
	 */
1032
	switch (hcd->state) {
L
Linus Torvalds 已提交
1033 1034
	case HC_STATE_RUNNING:
	case HC_STATE_RESUMING:
A
Alan Stern 已提交
1035
		urb->unlinked = 0;
1036
		list_add_tail(&urb->urb_list, &urb->ep->urb_list);
L
Linus Torvalds 已提交
1037 1038
		break;
	default:
1039 1040
		rc = -ESHUTDOWN;
		goto done;
L
Linus Torvalds 已提交
1041
	}
1042
 done:
1043
	spin_unlock(&hcd_urb_list_lock);
1044 1045
	return rc;
}
1046
EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
1047

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
/**
 * 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,
1068 1069 1070 1071 1072 1073 1074 1075 1076
		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;
	}
1077 1078
	if (tmp != &urb->urb_list)
		return -EIDRM;
L
Linus Torvalds 已提交
1079

1080 1081
	/* 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 已提交
1082
	 */
A
Alan Stern 已提交
1083
	if (urb->unlinked)
1084
		return -EBUSY;
A
Alan Stern 已提交
1085
	urb->unlinked = status;
L
Linus Torvalds 已提交
1086

1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
	/* 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.
	 */
	if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags) &&
			!is_root_hub(urb->dev)) {
		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);
	}

1099
	return 0;
1100
}
1101
EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
1102

1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
/**
 * 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)
1114 1115
{
	/* clear all state linking urb to this dev (and hcd) */
1116
	spin_lock(&hcd_urb_list_lock);
1117
	list_del_init(&urb->urb_list);
1118
	spin_unlock(&hcd_urb_list_lock);
1119
}
1120
EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
1121

M
Magnus Damm 已提交
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
/*
 * 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;

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

static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
			   gfp_t mem_flags)
1203
{
M
Magnus Damm 已提交
1204 1205 1206
	enum dma_data_direction dir;
	int ret = 0;

1207 1208
	/* Map the URB's buffers for DMA access.
	 * Lower level HCD code should use *_dma exclusively,
L
Linus Torvalds 已提交
1209 1210
	 * unless it uses pio or talks to another transport.
	 */
M
Magnus Damm 已提交
1211 1212 1213 1214 1215 1216 1217
	if (is_root_hub(urb->dev))
		return 0;

	if (usb_endpoint_xfer_control(&urb->ep->desc)
	    && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP)) {
		if (hcd->self.uses_dma)
			urb->setup_dma = dma_map_single(
L
Linus Torvalds 已提交
1218 1219
					hcd->self.controller,
					urb->setup_packet,
M
Magnus Damm 已提交
1220
					sizeof(struct usb_ctrlrequest),
L
Linus Torvalds 已提交
1221
					DMA_TO_DEVICE);
M
Magnus Damm 已提交
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
		else if (hcd->driver->flags & HCD_LOCAL_MEM)
			ret = hcd_alloc_coherent(
					urb->dev->bus, mem_flags,
					&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 (ret == 0 && urb->transfer_buffer_length != 0
	    && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
		if (hcd->self.uses_dma)
L
Linus Torvalds 已提交
1235 1236 1237 1238
			urb->transfer_dma = dma_map_single (
					hcd->self.controller,
					urb->transfer_buffer,
					urb->transfer_buffer_length,
M
Magnus Damm 已提交
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
					dir);
		else if (hcd->driver->flags & HCD_LOCAL_MEM) {
			ret = hcd_alloc_coherent(
					urb->dev->bus, mem_flags,
					&urb->transfer_dma,
					&urb->transfer_buffer,
					urb->transfer_buffer_length,
					dir);

			if (ret && usb_endpoint_xfer_control(&urb->ep->desc)
			    && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP))
				hcd_free_coherent(urb->dev->bus,
					&urb->setup_dma,
					(void **)&urb->setup_packet,
					sizeof(struct usb_ctrlrequest),
					DMA_TO_DEVICE);
		}
L
Linus Torvalds 已提交
1256
	}
M
Magnus Damm 已提交
1257
	return ret;
1258
}
L
Linus Torvalds 已提交
1259

1260 1261
static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
{
M
Magnus Damm 已提交
1262 1263 1264 1265 1266 1267 1268 1269
	enum dma_data_direction dir;

	if (is_root_hub(urb->dev))
		return;

	if (usb_endpoint_xfer_control(&urb->ep->desc)
	    && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP)) {
		if (hcd->self.uses_dma)
1270 1271 1272
			dma_unmap_single(hcd->self.controller, urb->setup_dma,
					sizeof(struct usb_ctrlrequest),
					DMA_TO_DEVICE);
M
Magnus Damm 已提交
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
		else if (hcd->driver->flags & HCD_LOCAL_MEM)
			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_buffer_length != 0
	    && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
		if (hcd->self.uses_dma)
1284 1285 1286
			dma_unmap_single(hcd->self.controller,
					urb->transfer_dma,
					urb->transfer_buffer_length,
M
Magnus Damm 已提交
1287 1288 1289 1290 1291 1292
					dir);
		else if (hcd->driver->flags & HCD_LOCAL_MEM)
			hcd_free_coherent(urb->dev->bus, &urb->transfer_dma,
					&urb->transfer_buffer,
					urb->transfer_buffer_length,
					dir);
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
	}
}

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

/* 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);
1314
	atomic_inc(&urb->dev->urbnum);
1315 1316 1317 1318 1319 1320 1321 1322 1323
	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 已提交
1324 1325 1326 1327 1328 1329
	status = map_urb_for_dma(hcd, urb, mem_flags);
	if (unlikely(status)) {
		usbmon_urb_submit_error(&hcd->self, urb, status);
		goto error;
	}

1330 1331 1332 1333
	if (is_root_hub(urb->dev))
		status = rh_urb_enqueue(hcd, urb);
	else
		status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1334 1335

	if (unlikely(status)) {
L
Linus Torvalds 已提交
1336
		usbmon_urb_submit_error(&hcd->self, urb, status);
1337
		unmap_urb_for_dma(hcd, urb);
M
Magnus Damm 已提交
1338
 error:
A
Alan Stern 已提交
1339
		urb->hcpriv = NULL;
1340 1341
		INIT_LIST_HEAD(&urb->urb_list);
		atomic_dec(&urb->use_count);
1342
		atomic_dec(&urb->dev->urbnum);
1343 1344 1345
		if (urb->reject)
			wake_up(&usb_kill_urb_queue);
		usb_put_urb(urb);
L
Linus Torvalds 已提交
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
	}
	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.
 */
1357
static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
L
Linus Torvalds 已提交
1358 1359 1360
{
	int		value;

1361
	if (is_root_hub(urb->dev))
1362
		value = usb_rh_urb_dequeue(hcd, urb, status);
L
Linus Torvalds 已提交
1363 1364 1365 1366 1367
	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. */
1368
		value = hcd->driver->urb_dequeue(hcd, urb, status);
L
Linus Torvalds 已提交
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
	}
	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 已提交
1379
int usb_hcd_unlink_urb (struct urb *urb, int status)
L
Linus Torvalds 已提交
1380
{
1381
	struct usb_hcd		*hcd;
1382 1383
	int			retval = -EIDRM;
	unsigned long		flags;
L
Linus Torvalds 已提交
1384

1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
	/* 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 已提交
1401 1402 1403

	if (retval == 0)
		retval = -EINPROGRESS;
1404
	else if (retval != -EIDRM && retval != -EBUSY)
1405 1406
		dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
				urb, retval);
L
Linus Torvalds 已提交
1407 1408 1409 1410 1411
	return retval;
}

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

A
Alan Stern 已提交
1412 1413 1414 1415
/**
 * 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 已提交
1416
 * @status: completion status code for the URB.
A
Alan Stern 已提交
1417 1418 1419 1420 1421 1422 1423
 * 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 已提交
1424
 *
A
Alan Stern 已提交
1425
 * If @urb was unlinked, the value of @status will be overridden by
A
Alan Stern 已提交
1426 1427
 * @urb->unlinked.  Erroneous short transfers are detected in case
 * the HCD hasn't checked for them.
A
Alan Stern 已提交
1428
 */
A
Alan Stern 已提交
1429
void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
A
Alan Stern 已提交
1430
{
A
Alan Stern 已提交
1431
	urb->hcpriv = NULL;
A
Alan Stern 已提交
1432
	if (unlikely(urb->unlinked))
A
Alan Stern 已提交
1433
		status = urb->unlinked;
A
Alan Stern 已提交
1434
	else if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
A
Alan Stern 已提交
1435
			urb->actual_length < urb->transfer_buffer_length &&
A
Alan Stern 已提交
1436 1437
			!status))
		status = -EREMOTEIO;
A
Alan Stern 已提交
1438

1439
	unmap_urb_for_dma(hcd, urb);
A
Alan Stern 已提交
1440
	usbmon_urb_complete(&hcd->self, urb, status);
1441 1442
	usb_unanchor_urb(urb);

A
Alan Stern 已提交
1443
	/* pass ownership to the completion handler */
A
Alan Stern 已提交
1444
	urb->status = status;
A
Alan Stern 已提交
1445 1446 1447 1448 1449 1450
	urb->complete (urb);
	atomic_dec (&urb->use_count);
	if (unlikely (urb->reject))
		wake_up (&usb_kill_urb_queue);
	usb_put_urb (urb);
}
1451
EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
A
Alan Stern 已提交
1452 1453 1454

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

1455 1456 1457
/* 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 已提交
1458
 */
1459
void usb_hcd_flush_endpoint(struct usb_device *udev,
A
Alan Stern 已提交
1460
		struct usb_host_endpoint *ep)
L
Linus Torvalds 已提交
1461 1462 1463 1464
{
	struct usb_hcd		*hcd;
	struct urb		*urb;

1465 1466
	if (!ep)
		return;
1467
	might_sleep();
1468
	hcd = bus_to_hcd(udev->bus);
L
Linus Torvalds 已提交
1469

1470
	/* No more submits can occur */
1471
	spin_lock_irq(&hcd_urb_list_lock);
1472
rescan:
L
Linus Torvalds 已提交
1473
	list_for_each_entry (urb, &ep->urb_list, urb_list) {
A
Alan Stern 已提交
1474
		int	is_in;
L
Linus Torvalds 已提交
1475

A
Alan Stern 已提交
1476
		if (urb->unlinked)
L
Linus Torvalds 已提交
1477 1478
			continue;
		usb_get_urb (urb);
A
Alan Stern 已提交
1479
		is_in = usb_urb_dir_in(urb);
1480
		spin_unlock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1481

1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
		/* 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 已提交
1502 1503 1504
		usb_put_urb (urb);

		/* list contents may have changed */
1505
		spin_lock(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1506 1507
		goto rescan;
	}
1508
	spin_unlock_irq(&hcd_urb_list_lock);
L
Linus Torvalds 已提交
1509

1510
	/* Wait until the endpoint queue is completely empty */
1511
	while (!list_empty (&ep->urb_list)) {
1512
		spin_lock_irq(&hcd_urb_list_lock);
1513 1514 1515 1516 1517 1518 1519 1520

		/* 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);
		}
1521
		spin_unlock_irq(&hcd_urb_list_lock);
1522 1523 1524 1525 1526 1527

		if (urb) {
			usb_kill_urb (urb);
			usb_put_urb (urb);
		}
	}
L
Linus Torvalds 已提交
1528 1529
}

1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548
/* 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);
}

1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
/* 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 已提交
1560 1561
/*-------------------------------------------------------------------------*/

A
Alan Stern 已提交
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
/* 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);
}

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

1574
#ifdef	CONFIG_PM
L
Linus Torvalds 已提交
1575

1576
int hcd_bus_suspend(struct usb_device *rhdev)
L
Linus Torvalds 已提交
1577
{
1578 1579 1580
	struct usb_hcd	*hcd = container_of(rhdev->bus, struct usb_hcd, self);
	int		status;
	int		old_state = hcd->state;
L
Linus Torvalds 已提交
1581

1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
	dev_dbg(&rhdev->dev, "bus %s%s\n",
			rhdev->auto_pm ? "auto-" : "", "suspend");
	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);
1592
		hcd->state = HC_STATE_SUSPENDED;
1593 1594 1595
	} else {
		hcd->state = old_state;
		dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1596
				"suspend", status);
1597
	}
1598
	return status;
L
Linus Torvalds 已提交
1599 1600
}

1601
int hcd_bus_resume(struct usb_device *rhdev)
L
Linus Torvalds 已提交
1602
{
1603 1604
	struct usb_hcd	*hcd = container_of(rhdev->bus, struct usb_hcd, self);
	int		status;
1605
	int		old_state = hcd->state;
L
Linus Torvalds 已提交
1606

1607 1608
	dev_dbg(&rhdev->dev, "usb %s%s\n",
			rhdev->auto_pm ? "auto-" : "", "resume");
1609
	if (!hcd->driver->bus_resume)
1610
		return -ENOENT;
1611 1612
	if (hcd->state == HC_STATE_RUNNING)
		return 0;
1613

1614
	hcd->state = HC_STATE_RESUMING;
1615 1616 1617 1618 1619 1620 1621
	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);
1622
		hcd->state = HC_STATE_RUNNING;
1623
	} else {
1624
		hcd->state = old_state;
1625
		dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
1626
				"resume", status);
1627 1628
		if (status != -ESHUTDOWN)
			usb_hc_died(hcd);
1629 1630
	}
	return status;
L
Linus Torvalds 已提交
1631 1632
}

1633 1634 1635 1636 1637 1638 1639
/* 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);
1640
	usb_mark_last_busy(udev);
1641 1642 1643 1644
	usb_external_resume_device(udev);
	usb_unlock_device(udev);
}

L
Linus Torvalds 已提交
1645 1646 1647 1648 1649 1650
/**
 * 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
1651 1652
 * 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 已提交
1653 1654 1655 1656 1657 1658 1659
 */
void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
{
	unsigned long flags;

	spin_lock_irqsave (&hcd_root_hub_lock, flags);
	if (hcd->rh_registered)
1660
		queue_work(ksuspend_usb_wq, &hcd->wakeup_work);
L
Linus Torvalds 已提交
1661 1662
	spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
}
1663
EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
L
Linus Torvalds 已提交
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

#endif

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

#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;
}
1702
EXPORT_SYMBOL_GPL(usb_bus_start_enum);
L
Linus Torvalds 已提交
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715

#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.
 */
1716
irqreturn_t usb_hcd_irq (int irq, void *__hcd)
L
Linus Torvalds 已提交
1717 1718
{
	struct usb_hcd		*hcd = __hcd;
1719 1720
	unsigned long		flags;
	irqreturn_t		rc;
L
Linus Torvalds 已提交
1721

1722 1723 1724 1725 1726
	/* 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 已提交
1727

1728 1729 1730 1731 1732 1733 1734
	if (unlikely(hcd->state == HC_STATE_HALT ||
		     !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))) {
		rc = IRQ_NONE;
	} else if (hcd->driver->irq(hcd) == IRQ_NONE) {
		rc = IRQ_NONE;
	} else {
		set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1735

1736 1737 1738 1739 1740 1741 1742
		if (unlikely(hcd->state == HC_STATE_HALT))
			usb_hc_died(hcd);
		rc = IRQ_HANDLED;
	}

	local_irq_restore(flags);
	return rc;
L
Linus Torvalds 已提交
1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
}

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

/**
 * 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) {
1763
		hcd->poll_rh = 0;
L
Linus Torvalds 已提交
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789

		/* 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,
1790
		struct device *dev, const char *bus_name)
L
Linus Torvalds 已提交
1791 1792 1793
{
	struct usb_hcd *hcd;

1794
	hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
L
Linus Torvalds 已提交
1795 1796 1797 1798 1799
	if (!hcd) {
		dev_dbg (dev, "hcd alloc failed\n");
		return NULL;
	}
	dev_set_drvdata(dev, hcd);
1800
	kref_init(&hcd->kref);
L
Linus Torvalds 已提交
1801 1802 1803 1804

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

	init_timer(&hcd->rh_timer);
1808 1809
	hcd->rh_timer.function = rh_timer_func;
	hcd->rh_timer.data = (unsigned long) hcd;
1810 1811 1812
#ifdef CONFIG_PM
	INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
#endif
L
Linus Torvalds 已提交
1813 1814 1815 1816 1817 1818

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

1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
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;
}
1834
EXPORT_SYMBOL_GPL(usb_get_hcd);
1835

L
Linus Torvalds 已提交
1836 1837
void usb_put_hcd (struct usb_hcd *hcd)
{
1838 1839
	if (hcd)
		kref_put (&hcd->kref, hcd_release);
L
Linus Torvalds 已提交
1840
}
1841
EXPORT_SYMBOL_GPL(usb_put_hcd);
L
Linus Torvalds 已提交
1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855

/**
 * 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)
{
1856 1857
	int retval;
	struct usb_device *rhdev;
L
Linus Torvalds 已提交
1858 1859 1860

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

1861
	hcd->authorized_default = hcd->wireless? 0 : 1;
1862 1863
	set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);

1864 1865 1866 1867
	/* 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 已提交
1868 1869 1870 1871 1872 1873
	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)
1874
		goto err_register_bus;
L
Linus Torvalds 已提交
1875

1876 1877 1878 1879 1880 1881 1882 1883 1884
	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;
	}
	rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH :
			USB_SPEED_FULL;
	hcd->self.root_hub = rhdev;

1885 1886 1887 1888 1889 1890
	/* 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);

1891 1892 1893 1894 1895 1896 1897 1898
	/* "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;
	}

1899 1900 1901
	/* 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))
1902 1903 1904
		dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");

	/* enable irqs just before we start the controller */
L
Linus Torvalds 已提交
1905
	if (hcd->driver->irq) {
1906 1907 1908 1909 1910

		/* 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 已提交
1911 1912
		if (irqflags & IRQF_SHARED)
			irqflags &= ~IRQF_DISABLED;
1913

L
Linus Torvalds 已提交
1914 1915 1916 1917 1918
		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 已提交
1919
					"request interrupt %d failed\n", irqnum);
1920
			goto err_request_irq;
L
Linus Torvalds 已提交
1921 1922
		}
		hcd->irq = irqnum;
D
David S. Miller 已提交
1923
		dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
L
Linus Torvalds 已提交
1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937
				(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);
1938
		goto err_hcd_driver_start;
L
Linus Torvalds 已提交
1939 1940
	}

1941
	/* starting here, usbcore will pay attention to this root hub */
1942
	rhdev->bus_mA = min(500u, hcd->power_budget);
1943
	if ((retval = register_root_hub(hcd)) != 0)
1944 1945
		goto err_register_root_hub;

1946 1947 1948 1949 1950 1951
	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;
	}
1952 1953
	if (hcd->uses_new_polling && hcd->poll_rh)
		usb_hcd_poll_rh_status(hcd);
L
Linus Torvalds 已提交
1954 1955
	return retval;

1956 1957 1958 1959
error_create_attr_group:
	mutex_lock(&usb_bus_list_lock);
	usb_disconnect(&hcd->self.root_hub);
	mutex_unlock(&usb_bus_list_lock);
1960
err_register_root_hub:
1961
	hcd->driver->stop(hcd);
1962
err_hcd_driver_start:
L
Linus Torvalds 已提交
1963 1964
	if (hcd->irq >= 0)
		free_irq(irqnum, hcd);
1965 1966 1967 1968 1969
err_request_irq:
err_hcd_driver_setup:
	hcd->self.root_hub = NULL;
	usb_put_dev(rhdev);
err_allocate_root_hub:
L
Linus Torvalds 已提交
1970
	usb_deregister_bus(&hcd->self);
1971
err_register_bus:
L
Linus Torvalds 已提交
1972 1973 1974
	hcd_buffer_destroy(hcd);
	return retval;
} 
1975
EXPORT_SYMBOL_GPL(usb_add_hcd);
L
Linus Torvalds 已提交
1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995

/**
 * 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)
{
	dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);

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

1997
#ifdef CONFIG_PM
1998
	cancel_work_sync(&hcd->wakeup_work);
1999 2000
#endif

2001
	sysfs_remove_group(&hcd->self.root_hub->dev.kobj, &usb_bus_attr_group);
2002
	mutex_lock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
2003
	usb_disconnect(&hcd->self.root_hub);
2004
	mutex_unlock(&usb_bus_list_lock);
L
Linus Torvalds 已提交
2005 2006 2007 2008

	hcd->driver->stop(hcd);
	hcd->state = HC_STATE_HALT;

A
Alan Stern 已提交
2009 2010 2011
	hcd->poll_rh = 0;
	del_timer_sync(&hcd->rh_timer);

L
Linus Torvalds 已提交
2012 2013 2014 2015 2016
	if (hcd->irq >= 0)
		free_irq(hcd->irq, hcd);
	usb_deregister_bus(&hcd->self);
	hcd_buffer_destroy(hcd);
}
2017
EXPORT_SYMBOL_GPL(usb_remove_hcd);
L
Linus Torvalds 已提交
2018

2019 2020 2021 2022 2023 2024 2025 2026
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);
}
2027
EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
2028

L
Linus Torvalds 已提交
2029 2030
/*-------------------------------------------------------------------------*/

2031
#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
L
Linus Torvalds 已提交
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066

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

2067
#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */