ehci-hcd.c 38.5 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2 3 4 5
 * Enhanced Host Controller Interface (EHCI) driver for USB.
 *
 * Maintainer: Alan Stern <stern@rowland.harvard.edu>
 *
L
Linus Torvalds 已提交
6
 * Copyright (c) 2000-2004 by David Brownell
7
 *
L
Linus Torvalds 已提交
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 * 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/pci.h>
#include <linux/dmapool.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/ioport.h>
#include <linux/sched.h>
30
#include <linux/vmalloc.h>
L
Linus Torvalds 已提交
31 32
#include <linux/errno.h>
#include <linux/init.h>
A
Alan Stern 已提交
33
#include <linux/hrtimer.h>
L
Linus Torvalds 已提交
34 35 36
#include <linux/list.h>
#include <linux/interrupt.h>
#include <linux/usb.h>
37
#include <linux/usb/hcd.h>
L
Linus Torvalds 已提交
38 39
#include <linux/moduleparam.h>
#include <linux/dma-mapping.h>
40
#include <linux/debugfs.h>
41
#include <linux/slab.h>
L
Linus Torvalds 已提交
42 43 44 45 46 47

#include <asm/byteorder.h>
#include <asm/io.h>
#include <asm/irq.h>
#include <asm/unaligned.h>

G
Geoff Levand 已提交
48 49 50 51
#if defined(CONFIG_PPC_PS3)
#include <asm/firmware.h>
#endif

L
Linus Torvalds 已提交
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
/*-------------------------------------------------------------------------*/

/*
 * EHCI hc_driver implementation ... experimental, incomplete.
 * Based on the final 1.0 register interface specification.
 *
 * USB 2.0 shows up in upcoming www.pcmcia.org technology.
 * First was PCMCIA, like ISA; then CardBus, which is PCI.
 * Next comes "CardBay", using USB 2.0 signals.
 *
 * Contains additional contributions by Brad Hards, Rory Bolt, and others.
 * Special thanks to Intel and VIA for providing host controllers to
 * test this driver on, and Cypress (including In-System Design) for
 * providing early devices for those host controllers to talk to!
 */

#define DRIVER_AUTHOR "David Brownell"
#define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"

static const char	hcd_name [] = "ehci_hcd";


#undef EHCI_URB_TRACE

/* magic numbers that can affect system performance */
#define	EHCI_TUNE_CERR		3	/* 0-3 qtd retries; 0 == don't stop */
#define	EHCI_TUNE_RL_HS		4	/* nak throttle; see 4.9 */
#define	EHCI_TUNE_RL_TT		0
#define	EHCI_TUNE_MULT_HS	1	/* 1-3 transactions/uframe; 4.10.3 */
#define	EHCI_TUNE_MULT_TT	1
82 83 84 85 86 87 88
/*
 * Some drivers think it's safe to schedule isochronous transfers more than
 * 256 ms into the future (partly as a result of an old bug in the scheduling
 * code).  In an attempt to avoid trouble, we will use a minimum scheduling
 * length of 512 frames instead of 256.
 */
#define	EHCI_TUNE_FLS		1	/* (medium) 512-frame schedule */
L
Linus Torvalds 已提交
89 90 91 92 93 94 95 96 97 98 99

/* Initial IRQ latency:  faster than hw default */
static int log2_irq_thresh = 0;		// 0 to 6
module_param (log2_irq_thresh, int, S_IRUGO);
MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");

/* initial park setting:  slower than hw default */
static unsigned park = 0;
module_param (park, uint, S_IRUGO);
MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");

100
/* for flakey hardware, ignore overcurrent indicators */
101
static bool ignore_oc;
102 103 104
module_param (ignore_oc, bool, S_IRUGO);
MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications");

L
Linus Torvalds 已提交
105 106 107 108 109
#define	INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)

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

#include "ehci.h"
110
#include "pci-quirks.h"
L
Linus Torvalds 已提交
111

112 113 114
static void compute_tt_budget(u8 budget_table[EHCI_BANDWIDTH_SIZE],
		struct ehci_tt *tt);

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
/*
 * The MosChip MCS9990 controller updates its microframe counter
 * a little before the frame counter, and occasionally we will read
 * the invalid intermediate value.  Avoid problems by checking the
 * microframe number (the low-order 3 bits); if they are 0 then
 * re-read the register to get the correct value.
 */
static unsigned ehci_moschip_read_frame_index(struct ehci_hcd *ehci)
{
	unsigned uf;

	uf = ehci_readl(ehci, &ehci->regs->frame_index);
	if (unlikely((uf & 7) == 0))
		uf = ehci_readl(ehci, &ehci->regs->frame_index);
	return uf;
}

static inline unsigned ehci_read_frame_index(struct ehci_hcd *ehci)
{
	if (ehci->frame_index_bug)
		return ehci_moschip_read_frame_index(ehci);
	return ehci_readl(ehci, &ehci->regs->frame_index);
}

#include "ehci-dbg.c"

L
Linus Torvalds 已提交
141 142 143
/*-------------------------------------------------------------------------*/

/*
144
 * ehci_handshake - spin reading hc until handshake completes or fails
L
Linus Torvalds 已提交
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
 * @ptr: address of hc register to be read
 * @mask: bits to look at in result of read
 * @done: value of those bits when handshake succeeds
 * @usec: timeout in microseconds
 *
 * Returns negative errno, or zero on success
 *
 * Success happens when the "mask" bits have the specified value (hardware
 * handshake done).  There are two failure modes:  "usec" have passed (major
 * hardware flakeout), or the register reads as all-ones (hardware removed).
 *
 * That last failure should_only happen in cases like physical cardbus eject
 * before driver shutdown. But it also seems to be caused by bugs in cardbus
 * bridge shutdown:  shutting down the bridge before the devices using it.
 */
160 161
int ehci_handshake(struct ehci_hcd *ehci, void __iomem *ptr,
		   u32 mask, u32 done, int usec)
L
Linus Torvalds 已提交
162 163 164 165
{
	u32	result;

	do {
166
		result = ehci_readl(ehci, ptr);
L
Linus Torvalds 已提交
167 168 169 170 171 172 173 174 175 176
		if (result == ~(u32)0)		/* card removed */
			return -ENODEV;
		result &= mask;
		if (result == done)
			return 0;
		udelay (1);
		usec--;
	} while (usec > 0);
	return -ETIMEDOUT;
}
177
EXPORT_SYMBOL_GPL(ehci_handshake);
L
Linus Torvalds 已提交
178

179 180 181 182 183
/* check TDI/ARC silicon is in host mode */
static int tdi_in_host_mode (struct ehci_hcd *ehci)
{
	u32		tmp;

184
	tmp = ehci_readl(ehci, &ehci->regs->usbmode);
185 186 187
	return (tmp & 3) == USBMODE_CM_HC;
}

A
Alan Stern 已提交
188 189 190 191
/*
 * Force HC to halt state from unknown (EHCI spec section 2.3).
 * Must be called with interrupts enabled and the lock not held.
 */
L
Linus Torvalds 已提交
192 193
static int ehci_halt (struct ehci_hcd *ehci)
{
A
Alan Stern 已提交
194 195 196
	u32	temp;

	spin_lock_irq(&ehci->lock);
L
Linus Torvalds 已提交
197

198
	/* disable any irqs left enabled by previous code */
199
	ehci_writel(ehci, 0, &ehci->regs->intr_enable);
200

A
Alan Stern 已提交
201 202
	if (ehci_is_TDI(ehci) && !tdi_in_host_mode(ehci)) {
		spin_unlock_irq(&ehci->lock);
203 204 205
		return 0;
	}

206 207 208 209 210
	/*
	 * This routine gets called during probe before ehci->command
	 * has been initialized, so we can't rely on its value.
	 */
	ehci->command &= ~CMD_RUN;
211
	temp = ehci_readl(ehci, &ehci->regs->command);
212
	temp &= ~(CMD_RUN | CMD_IAAD);
213
	ehci_writel(ehci, temp, &ehci->regs->command);
G
Geoff Levand 已提交
214

A
Alan Stern 已提交
215 216
	spin_unlock_irq(&ehci->lock);
	synchronize_irq(ehci_to_hcd(ehci)->irq);
217

218
	return ehci_handshake(ehci, &ehci->regs->status,
219
			  STS_HALT, STS_HALT, 16 * 125);
220 221
}

L
Linus Torvalds 已提交
222 223 224 225 226
/* put TDI/ARC silicon into EHCI mode */
static void tdi_reset (struct ehci_hcd *ehci)
{
	u32		tmp;

227
	tmp = ehci_readl(ehci, &ehci->regs->usbmode);
228 229 230 231 232 233 234
	tmp |= USBMODE_CM_HC;
	/* The default byte access to MMR space is LE after
	 * controller reset. Set the required endian mode
	 * for transfer buffers to match the host microprocessor
	 */
	if (ehci_big_endian_mmio(ehci))
		tmp |= USBMODE_BE;
235
	ehci_writel(ehci, tmp, &ehci->regs->usbmode);
L
Linus Torvalds 已提交
236 237
}

A
Alan Stern 已提交
238 239 240 241
/*
 * Reset a non-running (STS_HALT == 1) controller.
 * Must be called with interrupts enabled and the lock not held.
 */
242
int ehci_reset(struct ehci_hcd *ehci)
L
Linus Torvalds 已提交
243 244
{
	int	retval;
245
	u32	command = ehci_readl(ehci, &ehci->regs->command);
L
Linus Torvalds 已提交
246

247 248
	/* If the EHCI debug controller is active, special care must be
	 * taken before and after a host controller reset */
249
	if (ehci->debug && !dbgp_reset_prep(ehci_to_hcd(ehci)))
250 251
		ehci->debug = NULL;

L
Linus Torvalds 已提交
252 253
	command |= CMD_RESET;
	dbg_cmd (ehci, "reset", command);
254
	ehci_writel(ehci, command, &ehci->regs->command);
255
	ehci->rh_state = EHCI_RH_HALTED;
L
Linus Torvalds 已提交
256
	ehci->next_statechange = jiffies;
257
	retval = ehci_handshake(ehci, &ehci->regs->command,
258
			    CMD_RESET, 0, 250 * 1000);
L
Linus Torvalds 已提交
259

260 261
	if (ehci->has_hostpc) {
		ehci_writel(ehci, USBMODE_EX_HC | USBMODE_EX_VBPS,
262 263
				&ehci->regs->usbmode_ex);
		ehci_writel(ehci, TXFIFO_DEFAULT, &ehci->regs->txfill_tuning);
264
	}
L
Linus Torvalds 已提交
265 266 267 268 269 270
	if (retval)
		return retval;

	if (ehci_is_TDI(ehci))
		tdi_reset (ehci);

271
	if (ehci->debug)
272
		dbgp_external_startup(ehci_to_hcd(ehci));
273

274 275
	ehci->port_c_suspend = ehci->suspended_ports =
			ehci->resuming_ports = 0;
L
Linus Torvalds 已提交
276 277
	return retval;
}
278
EXPORT_SYMBOL_GPL(ehci_reset);
L
Linus Torvalds 已提交
279

A
Alan Stern 已提交
280 281 282 283
/*
 * Idle the controller (turn off the schedules).
 * Must be called with interrupts enabled and the lock not held.
 */
L
Linus Torvalds 已提交
284 285 286 287
static void ehci_quiesce (struct ehci_hcd *ehci)
{
	u32	temp;

288
	if (ehci->rh_state != EHCI_RH_RUNNING)
289
		return;
L
Linus Torvalds 已提交
290 291

	/* wait for any schedule enables/disables to take effect */
292
	temp = (ehci->command << 10) & (STS_ASS | STS_PSS);
293 294
	ehci_handshake(ehci, &ehci->regs->status, STS_ASS | STS_PSS, temp,
			16 * 125);
L
Linus Torvalds 已提交
295 296

	/* then disable anything that's still active */
A
Alan Stern 已提交
297
	spin_lock_irq(&ehci->lock);
298 299
	ehci->command &= ~(CMD_ASE | CMD_PSE);
	ehci_writel(ehci, ehci->command, &ehci->regs->command);
A
Alan Stern 已提交
300
	spin_unlock_irq(&ehci->lock);
L
Linus Torvalds 已提交
301 302

	/* hardware can take 16 microframes to turn off ... */
303 304
	ehci_handshake(ehci, &ehci->regs->status, STS_ASS | STS_PSS, 0,
			16 * 125);
L
Linus Torvalds 已提交
305 306 307 308
}

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

309
static void end_unlink_async(struct ehci_hcd *ehci);
310
static void unlink_empty_async(struct ehci_hcd *ehci);
311
static void unlink_empty_async_suspended(struct ehci_hcd *ehci);
312
static void ehci_work(struct ehci_hcd *ehci);
313 314
static void start_unlink_intr(struct ehci_hcd *ehci, struct ehci_qh *qh);
static void end_unlink_intr(struct ehci_hcd *ehci, struct ehci_qh *qh);
315
static int ehci_port_power(struct ehci_hcd *ehci, int portnum, bool enable);
L
Linus Torvalds 已提交
316

A
Alan Stern 已提交
317
#include "ehci-timer.c"
L
Linus Torvalds 已提交
318 319 320 321
#include "ehci-hub.c"
#include "ehci-mem.c"
#include "ehci-q.c"
#include "ehci-sched.c"
322
#include "ehci-sysfs.c"
L
Linus Torvalds 已提交
323 324 325

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

326 327 328 329 330 331 332 333
/* On some systems, leaving remote wakeup enabled prevents system shutdown.
 * The firmware seems to think that powering off is a wakeup event!
 * This routine turns off remote wakeup and everything else, on all ports.
 */
static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
{
	int	port = HCS_N_PORTS(ehci->hcs_params);

334
	while (port--) {
335 336
		ehci_writel(ehci, PORT_RWC_BITS,
				&ehci->regs->port_status[port]);
337 338 339 340
		spin_unlock_irq(&ehci->lock);
		ehci_port_power(ehci, port, false);
		spin_lock_irq(&ehci->lock);
	}
341 342
}

S
Sarah Sharp 已提交
343 344
/*
 * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
A
Alan Stern 已提交
345
 * Must be called with interrupts enabled and the lock not held.
346
 */
S
Sarah Sharp 已提交
347
static void ehci_silence_controller(struct ehci_hcd *ehci)
L
Linus Torvalds 已提交
348
{
S
Sarah Sharp 已提交
349
	ehci_halt(ehci);
A
Alan Stern 已提交
350 351 352

	spin_lock_irq(&ehci->lock);
	ehci->rh_state = EHCI_RH_HALTED;
353
	ehci_turn_off_all_ports(ehci);
L
Linus Torvalds 已提交
354 355

	/* make BIOS/etc use companion controller during reboot */
356
	ehci_writel(ehci, 0, &ehci->regs->configured_flag);
357 358 359

	/* unblock posted writes */
	ehci_readl(ehci, &ehci->regs->configured_flag);
A
Alan Stern 已提交
360
	spin_unlock_irq(&ehci->lock);
L
Linus Torvalds 已提交
361 362
}

S
Sarah Sharp 已提交
363 364 365 366 367 368 369 370 371
/* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
 * This forcibly disables dma and IRQs, helping kexec and other cases
 * where the next system software may expect clean state.
 */
static void ehci_shutdown(struct usb_hcd *hcd)
{
	struct ehci_hcd	*ehci = hcd_to_ehci(hcd);

	spin_lock_irq(&ehci->lock);
372
	ehci->shutdown = true;
373
	ehci->rh_state = EHCI_RH_STOPPING;
A
Alan Stern 已提交
374
	ehci->enabled_hrtimer_events = 0;
S
Sarah Sharp 已提交
375
	spin_unlock_irq(&ehci->lock);
A
Alan Stern 已提交
376

A
Alan Stern 已提交
377 378
	ehci_silence_controller(ehci);

A
Alan Stern 已提交
379
	hrtimer_cancel(&ehci->hrtimer);
S
Sarah Sharp 已提交
380 381
}

M
Matt Porter 已提交
382
/*-------------------------------------------------------------------------*/
L
Linus Torvalds 已提交
383

M
Matt Porter 已提交
384 385 386 387
/*
 * ehci_work is called from some interrupts, timers, and so on.
 * it calls driver completion functions, after dropping ehci->lock.
 */
388
static void ehci_work (struct ehci_hcd *ehci)
M
Matt Porter 已提交
389 390 391 392 393
{
	/* another CPU may drop ehci->lock during a schedule scan while
	 * it reports urb completions.  this flag guards against bogus
	 * attempts at re-entrant schedule scanning.
	 */
394 395
	if (ehci->scanning) {
		ehci->need_rescan = true;
M
Matt Porter 已提交
396
		return;
397 398 399 400 401
	}
	ehci->scanning = true;

 rescan:
	ehci->need_rescan = false;
402 403
	if (ehci->async_count)
		scan_async(ehci);
404 405 406 407
	if (ehci->intr_count > 0)
		scan_intr(ehci);
	if (ehci->isoc_count > 0)
		scan_isoc(ehci);
408 409 410
	if (ehci->need_rescan)
		goto rescan;
	ehci->scanning = false;
M
Matt Porter 已提交
411 412 413 414 415

	/* the IO watchdog guards against hardware or driver bugs that
	 * misplace IRQs, and should let us run completely without IRQs.
	 * such lossage has been observed on both VT6202 and VT8235.
	 */
416
	turn_on_io_watchdog(ehci);
M
Matt Porter 已提交
417
}
L
Linus Torvalds 已提交
418

S
Sarah Sharp 已提交
419 420 421
/*
 * Called when the ehci_hcd module is removed.
 */
M
Matt Porter 已提交
422
static void ehci_stop (struct usb_hcd *hcd)
L
Linus Torvalds 已提交
423 424 425
{
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);

M
Matt Porter 已提交
426
	ehci_dbg (ehci, "stop\n");
L
Linus Torvalds 已提交
427

M
Matt Porter 已提交
428
	/* no more interrupts ... */
D
David Brownell 已提交
429

M
Matt Porter 已提交
430
	spin_lock_irq(&ehci->lock);
A
Alan Stern 已提交
431
	ehci->enabled_hrtimer_events = 0;
A
Alan Stern 已提交
432
	spin_unlock_irq(&ehci->lock);
L
Linus Torvalds 已提交
433

A
Alan Stern 已提交
434
	ehci_quiesce(ehci);
S
Sarah Sharp 已提交
435
	ehci_silence_controller(ehci);
M
Matt Porter 已提交
436
	ehci_reset (ehci);
L
Linus Torvalds 已提交
437

A
Alan Stern 已提交
438
	hrtimer_cancel(&ehci->hrtimer);
439
	remove_sysfs_files(ehci);
M
Matt Porter 已提交
440
	remove_debug_files (ehci);
L
Linus Torvalds 已提交
441

M
Matt Porter 已提交
442 443
	/* root hub is shut down separately (first, when possible) */
	spin_lock_irq (&ehci->lock);
444
	end_free_itds(ehci);
M
Matt Porter 已提交
445 446
	spin_unlock_irq (&ehci->lock);
	ehci_mem_cleanup (ehci);
L
Linus Torvalds 已提交
447

448 449
	if (ehci->amd_pll_fix == 1)
		usb_amd_dev_put();
450

451 452
	dbg_status (ehci, "ehci_stop completed",
		    ehci_readl(ehci, &ehci->regs->status));
L
Linus Torvalds 已提交
453 454
}

455 456
/* one-time init, only for memory state */
static int ehci_init(struct usb_hcd *hcd)
L
Linus Torvalds 已提交
457
{
458
	struct ehci_hcd		*ehci = hcd_to_ehci(hcd);
L
Linus Torvalds 已提交
459 460 461
	u32			temp;
	int			retval;
	u32			hcc_params;
462
	struct ehci_qh_hw	*hw;
463 464 465

	spin_lock_init(&ehci->lock);

466 467 468 469
	/*
	 * keep io watchdog by default, those good HCDs could turn off it later
	 */
	ehci->need_io_watchdog = 1;
L
Linus Torvalds 已提交
470

A
Alan Stern 已提交
471 472 473
	hrtimer_init(&ehci->hrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
	ehci->hrtimer.function = ehci_hrtimer_func;
	ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
474

A
Alan Stern 已提交
475 476
	hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);

477 478 479 480 481 482
	/*
	 * by default set standard 80% (== 100 usec/uframe) max periodic
	 * bandwidth as required by USB 2.0
	 */
	ehci->uframe_periodic_max = 100;

L
Linus Torvalds 已提交
483 484 485 486 487
	/*
	 * hw default: 1K periodic list heads, one per frame.
	 * periodic_size can shrink by USBCMD update if hcc_params allows.
	 */
	ehci->periodic_size = DEFAULT_I_TDPS;
488
	INIT_LIST_HEAD(&ehci->async_unlink);
489
	INIT_LIST_HEAD(&ehci->async_idle);
490
	INIT_LIST_HEAD(&ehci->intr_unlink_wait);
491
	INIT_LIST_HEAD(&ehci->intr_unlink);
492
	INIT_LIST_HEAD(&ehci->intr_qh_list);
K
Karsten Wiese 已提交
493
	INIT_LIST_HEAD(&ehci->cached_itd_list);
494
	INIT_LIST_HEAD(&ehci->cached_sitd_list);
495
	INIT_LIST_HEAD(&ehci->tt_list);
A
Alan Stern 已提交
496

497
	if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
A
Alan Stern 已提交
498 499 500 501 502 503 504 505
		/* periodic schedule size can be smaller than default */
		switch (EHCI_TUNE_FLS) {
		case 0: ehci->periodic_size = 1024; break;
		case 1: ehci->periodic_size = 512; break;
		case 2: ehci->periodic_size = 256; break;
		default:	BUG();
		}
	}
506
	if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
L
Linus Torvalds 已提交
507 508 509
		return retval;

	/* controllers may cache some of the periodic schedule ... */
510
	if (HCC_ISOC_CACHE(hcc_params))		// full frame cache
511
		ehci->i_thresh = 0;
L
Linus Torvalds 已提交
512
	else					// N microframes cached
513
		ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
L
Linus Torvalds 已提交
514 515 516 517 518 519 520 521

	/*
	 * dedicate a qh for the async ring head, since we couldn't unlink
	 * a 'real' qh without stopping the async schedule [4.8].  use it
	 * as the 'reclamation list head' too.
	 * its dummy is used in hw_alt_next of many tds, to prevent the qh
	 * from automatically advancing to the next td after short reads.
	 */
522
	ehci->async->qh_next.qh = NULL;
523 524 525
	hw = ehci->async->hw;
	hw->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
	hw->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
R
Ricardo Martins 已提交
526
#if defined(CONFIG_PPC_PS3)
527
	hw->hw_info1 |= cpu_to_hc32(ehci, QH_INACTIVATE);
R
Ricardo Martins 已提交
528
#endif
529 530
	hw->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
	hw->hw_qtd_next = EHCI_LIST_END(ehci);
531
	ehci->async->qh_state = QH_STATE_LINKED;
532
	hw->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
L
Linus Torvalds 已提交
533 534 535 536 537

	/* clear interrupt enables, set irq latency */
	if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
		log2_irq_thresh = 0;
	temp = 1 << (16 + log2_irq_thresh);
538 539 540 541 542
	if (HCC_PER_PORT_CHANGE_EVENT(hcc_params)) {
		ehci->has_ppcd = 1;
		ehci_dbg(ehci, "enable per-port change event\n");
		temp |= CMD_PPCEE;
	}
L
Linus Torvalds 已提交
543 544 545 546 547 548 549 550 551
	if (HCC_CANPARK(hcc_params)) {
		/* HW default park == 3, on hardware that supports it (like
		 * NVidia and ALI silicon), maximizes throughput on the async
		 * schedule by avoiding QH fetches between transfers.
		 *
		 * With fast usb storage devices and NForce2, "park" seems to
		 * make problems:  throughput reduction (!), data errors...
		 */
		if (park) {
552
			park = min(park, (unsigned) 3);
L
Linus Torvalds 已提交
553 554 555
			temp |= CMD_PARK;
			temp |= park << 8;
		}
556
		ehci_dbg(ehci, "park %d\n", park);
L
Linus Torvalds 已提交
557
	}
558
	if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
L
Linus Torvalds 已提交
559 560 561 562
		/* periodic schedule size can be smaller than default */
		temp &= ~(3 << 2);
		temp |= (EHCI_TUNE_FLS << 2);
	}
563 564
	ehci->command = temp;

565
	/* Accept arbitrarily long scatter-gather lists */
566 567
	if (!(hcd->driver->flags & HCD_LOCAL_MEM))
		hcd->self.sg_tablesize = ~0;
568 569 570 571 572 573 574 575 576 577
	return 0;
}

/* start HC running; it's halted, ehci_init() has been run (once) */
static int ehci_run (struct usb_hcd *hcd)
{
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
	u32			temp;
	u32			hcc_params;

578 579
	hcd->uses_new_polling = 1;

580
	/* EHCI spec section 4.1 */
581

582 583
	ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
	ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
584 585 586 587 588 589 590 591

	/*
	 * hcc_params controls whether ehci->regs->segment must (!!!)
	 * be used; it constrains QH/ITD/SITD and QTD locations.
	 * pci_pool consistent memory always uses segment zero.
	 * streaming mappings for I/O buffers, like pci_map_single(),
	 * can return segments above 4GB, if the device allows.
	 *
592
	 * NOTE:  the dma mask is visible through dev->dma_mask, so
593 594 595 596
	 * drivers can pass this info along ... like NETIF_F_HIGHDMA,
	 * Scsi_Host.highmem_io, and so forth.  It's readonly to all
	 * host side drivers though.
	 */
597
	hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
598
	if (HCC_64BIT_ADDR(hcc_params)) {
599
		ehci_writel(ehci, 0, &ehci->regs->segment);
600 601
#if 0
// this is deeply broken on almost all architectures
602
		if (!dma_set_mask(hcd->self.controller, DMA_BIT_MASK(64)))
603 604 605 606 607
			ehci_info(ehci, "enabled 64bit DMA\n");
#endif
	}


L
Linus Torvalds 已提交
608 609
	// Philips, Intel, and maybe others need CMD_RUN before the
	// root hub will detect new devices (why?); NEC doesn't
610 611
	ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
	ehci->command |= CMD_RUN;
612
	ehci_writel(ehci, ehci->command, &ehci->regs->command);
613
	dbg_cmd (ehci, "init", ehci->command);
L
Linus Torvalds 已提交
614 615 616 617 618 619

	/*
	 * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
	 * are explicitly handed to companion controller(s), so no TT is
	 * involved with the root hub.  (Except where one is integrated,
	 * and there's no companion controller unless maybe for USB OTG.)
620 621 622 623 624
	 *
	 * Turning on the CF flag will transfer ownership of all ports
	 * from the companions to the EHCI controller.  If any of the
	 * companions are in the middle of a port reset at the time, it
	 * could cause trouble.  Write-locking ehci_cf_port_reset_rwsem
625 626 627
	 * guarantees that no resets are in progress.  After we set CF,
	 * a short delay lets the hardware catch up; new resets shouldn't
	 * be started before the port switching actions could complete.
L
Linus Torvalds 已提交
628
	 */
629
	down_write(&ehci_cf_port_reset_rwsem);
630
	ehci->rh_state = EHCI_RH_RUNNING;
631 632
	ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
	ehci_readl(ehci, &ehci->regs->command);	/* unblock posted writes */
633
	msleep(5);
634
	up_write(&ehci_cf_port_reset_rwsem);
635
	ehci->last_periodic_enable = ktime_get_real();
L
Linus Torvalds 已提交
636

637
	temp = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
L
Linus Torvalds 已提交
638
	ehci_info (ehci,
639
		"USB %x.%x started, EHCI %x.%02x%s\n",
M
Matt Porter 已提交
640
		((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
641
		temp >> 8, temp & 0xff,
642
		ignore_oc ? ", overcurrent ignored" : "");
L
Linus Torvalds 已提交
643

644 645
	ehci_writel(ehci, INTR_MASK,
		    &ehci->regs->intr_enable); /* Turn On Interrupts */
L
Linus Torvalds 已提交
646

647 648 649 650 651
	/* GRR this is run-once init(), being done every time the HC starts.
	 * So long as they're part of class devices, we can't do it init()
	 * since the class device isn't created that early.
	 */
	create_debug_files(ehci);
652
	create_sysfs_files(ehci);
L
Linus Torvalds 已提交
653 654 655 656

	return 0;
}

657
int ehci_setup(struct usb_hcd *hcd)
658 659 660 661 662 663 664 665 666 667 668 669 670 671
{
	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	int retval;

	ehci->regs = (void __iomem *)ehci->caps +
	    HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
	dbg_hcs_params(ehci, "reset");
	dbg_hcc_params(ehci, "reset");

	/* cache this readonly data; minimize chip reads */
	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);

	ehci->sbrn = HCD_USB2;

672 673
	/* data structure init */
	retval = ehci_init(hcd);
674 675 676
	if (retval)
		return retval;

677
	retval = ehci_halt(ehci);
678 679
	if (retval) {
		ehci_mem_cleanup(ehci);
680
		return retval;
681
	}
682 683 684 685 686

	ehci_reset(ehci);

	return 0;
}
687
EXPORT_SYMBOL_GPL(ehci_setup);
688

L
Linus Torvalds 已提交
689 690
/*-------------------------------------------------------------------------*/

691
static irqreturn_t ehci_irq (struct usb_hcd *hcd)
L
Linus Torvalds 已提交
692 693
{
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
694
	u32			status, masked_status, pcd_status = 0, cmd;
L
Linus Torvalds 已提交
695
	int			bh;
696
	unsigned long		flags;
L
Linus Torvalds 已提交
697

698 699 700 701 702 703 704
	/*
	 * For threadirqs option we use spin_lock_irqsave() variant to prevent
	 * deadlock with ehci hrtimer callback, because hrtimer callbacks run
	 * in interrupt context even when threadirqs is specified. We can go
	 * back to spin_lock() variant when hrtimer callbacks become threaded.
	 */
	spin_lock_irqsave(&ehci->lock, flags);
L
Linus Torvalds 已提交
705

706
	status = ehci_readl(ehci, &ehci->regs->status);
L
Linus Torvalds 已提交
707 708 709 710 711 712 713

	/* e.g. cardbus physical eject */
	if (status == ~(u32) 0) {
		ehci_dbg (ehci, "device removed\n");
		goto dead;
	}

714 715 716 717 718 719
	/*
	 * We don't use STS_FLR, but some controllers don't like it to
	 * remain on, so mask it out along with the other status bits.
	 */
	masked_status = status & (INTR_MASK | STS_FLR);

720
	/* Shared IRQ? */
721
	if (!masked_status || unlikely(ehci->rh_state == EHCI_RH_HALTED)) {
722
		spin_unlock_irqrestore(&ehci->lock, flags);
L
Linus Torvalds 已提交
723 724 725 726
		return IRQ_NONE;
	}

	/* clear (just) interrupts */
727
	ehci_writel(ehci, masked_status, &ehci->regs->status);
728
	cmd = ehci_readl(ehci, &ehci->regs->command);
L
Linus Torvalds 已提交
729 730 731 732 733 734 735 736 737 738 739 740 741
	bh = 0;

	/* normal [4.15.1.2] or error [4.15.1.1] completion */
	if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
		if (likely ((status & STS_ERR) == 0))
			COUNT (ehci->stats.normal);
		else
			COUNT (ehci->stats.error);
		bh = 1;
	}

	/* complete the unlinking of some qh [4.15.2.3] */
	if (status & STS_IAA) {
742 743 744 745 746 747 748 749 750 751 752 753 754 755

		/* Turn off the IAA watchdog */
		ehci->enabled_hrtimer_events &= ~BIT(EHCI_HRTIMER_IAA_WATCHDOG);

		/*
		 * Mild optimization: Allow another IAAD to reset the
		 * hrtimer, if one occurs before the next expiration.
		 * In theory we could always cancel the hrtimer, but
		 * tests show that about half the time it will be reset
		 * for some other event anyway.
		 */
		if (ehci->next_hrtimer_event == EHCI_HRTIMER_IAA_WATCHDOG)
			++ehci->next_hrtimer_event;

756
		/* guard against (alleged) silicon errata */
757
		if (cmd & CMD_IAAD)
758
			ehci_dbg(ehci, "IAA with IAAD still set?\n");
759
		if (ehci->iaa_in_progress)
A
Alan Stern 已提交
760
			COUNT(ehci->stats.iaa);
761
		end_unlink_async(ehci);
L
Linus Torvalds 已提交
762 763 764
	}

	/* remote wakeup [4.3.1] */
765
	if (status & STS_PCD) {
L
Linus Torvalds 已提交
766
		unsigned	i = HCS_N_PORTS (ehci->hcs_params);
767
		u32		ppcd = ~0;
768 769

		/* kick root hub later */
770
		pcd_status = status;
L
Linus Torvalds 已提交
771 772

		/* resume root hub? */
773
		if (ehci->rh_state == EHCI_RH_SUSPENDED)
774
			usb_hcd_resume_root_hub(hcd);
L
Linus Torvalds 已提交
775

776 777 778 779
		/* get per-port change detect bits */
		if (ehci->has_ppcd)
			ppcd = status >> 16;

L
Linus Torvalds 已提交
780
		while (i--) {
781 782 783
			int pstatus;

			/* leverage per-port change bits feature */
784
			if (!(ppcd & (1 << i)))
785 786 787
				continue;
			pstatus = ehci_readl(ehci,
					 &ehci->regs->port_status[i]);
788 789

			if (pstatus & PORT_OWNER)
L
Linus Torvalds 已提交
790
				continue;
791 792 793 794 795
			if (!(test_bit(i, &ehci->suspended_ports) &&
					((pstatus & PORT_RESUME) ||
						!(pstatus & PORT_SUSPEND)) &&
					(pstatus & PORT_PE) &&
					ehci->reset_done[i] == 0))
L
Linus Torvalds 已提交
796 797
				continue;

798 799 800
			/* start USB_RESUME_TIMEOUT msec resume signaling from
			 * this port, and make hub_wq collect
			 * PORT_STAT_C_SUSPEND to stop that signaling.
L
Linus Torvalds 已提交
801
			 */
802 803
			ehci->reset_done[i] = jiffies +
				msecs_to_jiffies(USB_RESUME_TIMEOUT);
804
			set_bit(i, &ehci->resuming_ports);
L
Linus Torvalds 已提交
805
			ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
806
			usb_hcd_start_port_resume(&hcd->self, i);
807
			mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
L
Linus Torvalds 已提交
808 809 810 811 812
		}
	}

	/* PCI errors [4.15.2.4] */
	if (unlikely ((status & STS_FATAL) != 0)) {
813
		ehci_err(ehci, "fatal error\n");
814 815
		dbg_cmd(ehci, "fatal", cmd);
		dbg_status(ehci, "fatal", status);
L
Linus Torvalds 已提交
816
dead:
817
		usb_hc_died(hcd);
818 819

		/* Don't let the controller do anything more */
820
		ehci->shutdown = true;
821 822 823 824 825 826 827 828
		ehci->rh_state = EHCI_RH_STOPPING;
		ehci->command &= ~(CMD_RUN | CMD_ASE | CMD_PSE);
		ehci_writel(ehci, ehci->command, &ehci->regs->command);
		ehci_writel(ehci, 0, &ehci->regs->intr_enable);
		ehci_handle_controller_death(ehci);

		/* Handle completions when the controller stops */
		bh = 0;
L
Linus Torvalds 已提交
829 830 831
	}

	if (bh)
832
		ehci_work (ehci);
833
	spin_unlock_irqrestore(&ehci->lock, flags);
834
	if (pcd_status)
835
		usb_hcd_poll_rh_status(hcd);
L
Linus Torvalds 已提交
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
	return IRQ_HANDLED;
}

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

/*
 * non-error returns are a promise to giveback() the urb later
 * we drop ownership so next owner (or urb unlink) can get it
 *
 * urb + dev is in hcd.self.controller.urb_list
 * we're queueing TDs onto software and hardware lists
 *
 * hcd-specific init for hcpriv hasn't been done yet
 *
 * NOTE:  control, bulk, and interrupt share the same code to append TDs
 * to a (possibly active) QH, and the same QH scanning code.
 */
static int ehci_urb_enqueue (
	struct usb_hcd	*hcd,
	struct urb	*urb,
A
Al Viro 已提交
856
	gfp_t		mem_flags
L
Linus Torvalds 已提交
857 858 859 860 861 862 863
) {
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
	struct list_head	qtd_list;

	INIT_LIST_HEAD (&qtd_list);

	switch (usb_pipetype (urb->pipe)) {
864 865 866 867 868 869 870 871
	case PIPE_CONTROL:
		/* qh_completions() code doesn't handle all the fault cases
		 * in multi-TD control transfers.  Even 1KB is rare anyway.
		 */
		if (urb->transfer_buffer_length > (16 * 1024))
			return -EMSGSIZE;
		/* FALLTHROUGH */
	/* case PIPE_BULK: */
L
Linus Torvalds 已提交
872 873 874
	default:
		if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
			return -ENOMEM;
875
		return submit_async(ehci, urb, &qtd_list, mem_flags);
L
Linus Torvalds 已提交
876 877 878 879

	case PIPE_INTERRUPT:
		if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
			return -ENOMEM;
880
		return intr_submit(ehci, urb, &qtd_list, mem_flags);
L
Linus Torvalds 已提交
881 882 883 884 885 886 887 888 889 890 891 892 893

	case PIPE_ISOCHRONOUS:
		if (urb->dev->speed == USB_SPEED_HIGH)
			return itd_submit (ehci, urb, mem_flags);
		else
			return sitd_submit (ehci, urb, mem_flags);
	}
}

/* remove from hardware lists
 * completions normally happen asynchronously
 */

894
static int ehci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
L
Linus Torvalds 已提交
895 896 897 898
{
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
	struct ehci_qh		*qh;
	unsigned long		flags;
899
	int			rc;
L
Linus Torvalds 已提交
900 901

	spin_lock_irqsave (&ehci->lock, flags);
902 903 904 905
	rc = usb_hcd_check_unlink_urb(hcd, urb, status);
	if (rc)
		goto done;

906 907 908 909 910 911 912
	if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
		/*
		 * We don't expedite dequeue for isochronous URBs.
		 * Just wait until they complete normally or their
		 * time slot expires.
		 */
	} else {
L
Linus Torvalds 已提交
913
		qh = (struct ehci_qh *) urb->hcpriv;
914
		qh->unlink_reason |= QH_UNLINK_REQUESTED;
915 916
		switch (qh->qh_state) {
		case QH_STATE_LINKED:
917 918 919 920
			if (usb_pipetype(urb->pipe) == PIPE_INTERRUPT)
				start_unlink_intr(ehci, qh);
			else
				start_unlink_async(ehci, qh);
921
			break;
922 923 924
		case QH_STATE_COMPLETING:
			qh->dequeue_during_giveback = 1;
			break;
925 926 927 928 929
		case QH_STATE_UNLINK:
		case QH_STATE_UNLINK_WAIT:
			/* already started */
			break;
		case QH_STATE_IDLE:
930 931
			/* QH might be waiting for a Clear-TT-Buffer */
			qh_completions(ehci, qh);
932 933
			break;
		}
L
Linus Torvalds 已提交
934 935 936
	}
done:
	spin_unlock_irqrestore (&ehci->lock, flags);
937
	return rc;
L
Linus Torvalds 已提交
938 939 940 941 942 943 944 945 946 947 948
}

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

// bulk qh holds the data toggle

static void
ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
{
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
	unsigned long		flags;
949
	struct ehci_qh		*qh;
L
Linus Torvalds 已提交
950 951 952 953 954 955 956 957 958 959 960 961 962

	/* ASSERT:  any requests/urbs are being unlinked */
	/* ASSERT:  nobody can be submitting urbs for this any more */

rescan:
	spin_lock_irqsave (&ehci->lock, flags);
	qh = ep->hcpriv;
	if (!qh)
		goto done;

	/* endpoints can be iso streams.  for now, we don't
	 * accelerate iso completions ... so spin a while.
	 */
963
	if (qh->hw == NULL) {
964 965 966 967 968 969
		struct ehci_iso_stream	*stream = ep->hcpriv;

		if (!list_empty(&stream->td_list))
			goto idle_timeout;

		/* BUG_ON(!list_empty(&stream->free_list)); */
970
		reserve_release_iso_bandwidth(ehci, stream, -1);
971 972
		kfree(stream);
		goto done;
L
Linus Torvalds 已提交
973 974
	}

975
	qh->unlink_reason |= QH_UNLINK_REQUESTED;
L
Linus Torvalds 已提交
976 977
	switch (qh->qh_state) {
	case QH_STATE_LINKED:
978 979 980 981
		if (list_empty(&qh->qtd_list))
			qh->unlink_reason |= QH_UNLINK_QUEUE_EMPTY;
		else
			WARN_ON(1);
982
		if (usb_endpoint_type(&ep->desc) != USB_ENDPOINT_XFER_INT)
983
			start_unlink_async(ehci, qh);
984 985
		else
			start_unlink_intr(ehci, qh);
L
Linus Torvalds 已提交
986
		/* FALL THROUGH */
987
	case QH_STATE_COMPLETING:	/* already in unlinking */
L
Linus Torvalds 已提交
988
	case QH_STATE_UNLINK:		/* wait for hw to finish? */
989
	case QH_STATE_UNLINK_WAIT:
L
Linus Torvalds 已提交
990 991
idle_timeout:
		spin_unlock_irqrestore (&ehci->lock, flags);
992
		schedule_timeout_uninterruptible(1);
L
Linus Torvalds 已提交
993 994
		goto rescan;
	case QH_STATE_IDLE:		/* fully unlinked */
995 996
		if (qh->clearing_tt)
			goto idle_timeout;
L
Linus Torvalds 已提交
997
		if (list_empty (&qh->qtd_list)) {
998 999
			if (qh->ps.bw_uperiod)
				reserve_release_intr_bandwidth(ehci, qh, -1);
A
Alan Stern 已提交
1000
			qh_destroy(ehci, qh);
L
Linus Torvalds 已提交
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
			break;
		}
		/* else FALL THROUGH */
	default:
		/* caller was supposed to have unlinked any requests;
		 * that's not our job.  just leak this memory.
		 */
		ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
			qh, ep->desc.bEndpointAddress, qh->qh_state,
			list_empty (&qh->qtd_list) ? "" : "(has tds)");
		break;
	}
1013
 done:
L
Linus Torvalds 已提交
1014 1015 1016 1017
	ep->hcpriv = NULL;
	spin_unlock_irqrestore (&ehci->lock, flags);
}

1018 1019 1020 1021 1022 1023
static void
ehci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep)
{
	struct ehci_hcd		*ehci = hcd_to_ehci(hcd);
	struct ehci_qh		*qh;
	int			eptype = usb_endpoint_type(&ep->desc);
1024 1025 1026
	int			epnum = usb_endpoint_num(&ep->desc);
	int			is_out = usb_endpoint_dir_out(&ep->desc);
	unsigned long		flags;
1027 1028 1029 1030

	if (eptype != USB_ENDPOINT_XFER_BULK && eptype != USB_ENDPOINT_XFER_INT)
		return;

1031
	spin_lock_irqsave(&ehci->lock, flags);
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
	qh = ep->hcpriv;

	/* For Bulk and Interrupt endpoints we maintain the toggle state
	 * in the hardware; the toggle bits in udev aren't used at all.
	 * When an endpoint is reset by usb_clear_halt() we must reset
	 * the toggle bit in the QH.
	 */
	if (qh) {
		if (!list_empty(&qh->qtd_list)) {
			WARN_ONCE(1, "clear_halt for a busy endpoint\n");
1042
		} else {
1043 1044 1045
			/* The toggle value in the QH can't be updated
			 * while the QH is active.  Unlink it now;
			 * re-linking will call qh_refresh().
1046
			 */
1047
			usb_settoggle(qh->ps.udev, epnum, is_out, 0);
1048
			qh->unlink_reason |= QH_UNLINK_REQUESTED;
1049
			if (eptype == USB_ENDPOINT_XFER_BULK)
1050
				start_unlink_async(ehci, qh);
1051
			else
1052
				start_unlink_intr(ehci, qh);
1053 1054
		}
	}
1055
	spin_unlock_irqrestore(&ehci->lock, flags);
1056 1057
}

M
Matt Porter 已提交
1058 1059 1060
static int ehci_get_frame (struct usb_hcd *hcd)
{
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
1061
	return (ehci_read_frame_index(ehci) >> 3) % ehci->periodic_size;
M
Matt Porter 已提交
1062
}
L
Linus Torvalds 已提交
1063 1064

/*-------------------------------------------------------------------------*/
1065

1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
/* Device addition and removal */

static void ehci_remove_device(struct usb_hcd *hcd, struct usb_device *udev)
{
	struct ehci_hcd		*ehci = hcd_to_ehci(hcd);

	spin_lock_irq(&ehci->lock);
	drop_tt(udev);
	spin_unlock_irq(&ehci->lock);
}

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

1079 1080 1081 1082 1083 1084
#ifdef	CONFIG_PM

/* suspend/resume, section 4.3 */

/* These routines handle the generic parts of controller suspend/resume */

1085
int ehci_suspend(struct usb_hcd *hcd, bool do_wakeup)
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
{
	struct ehci_hcd		*ehci = hcd_to_ehci(hcd);

	if (time_before(jiffies, ehci->next_statechange))
		msleep(10);

	/*
	 * Root hub was already suspended.  Disable IRQ emission and
	 * mark HW unaccessible.  The PM and USB cores make sure that
	 * the root hub is either suspended or stopped.
	 */
	ehci_prepare_ports_for_controller_suspend(ehci, do_wakeup);

	spin_lock_irq(&ehci->lock);
	ehci_writel(ehci, 0, &ehci->regs->intr_enable);
	(void) ehci_readl(ehci, &ehci->regs->intr_enable);

	clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
	spin_unlock_irq(&ehci->lock);

1106 1107 1108 1109 1110 1111 1112 1113
	synchronize_irq(hcd->irq);

	/* Check for race with a wakeup request */
	if (do_wakeup && HCD_WAKEUP_PENDING(hcd)) {
		ehci_resume(hcd, false);
		return -EBUSY;
	}

1114 1115
	return 0;
}
1116
EXPORT_SYMBOL_GPL(ehci_suspend);
1117 1118

/* Returns 0 if power was preserved, 1 if power was lost */
1119
int ehci_resume(struct usb_hcd *hcd, bool force_reset)
1120 1121 1122 1123 1124 1125 1126 1127 1128
{
	struct ehci_hcd		*ehci = hcd_to_ehci(hcd);

	if (time_before(jiffies, ehci->next_statechange))
		msleep(100);

	/* Mark hardware accessible again as we are back to full power by now */
	set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);

1129 1130 1131
	if (ehci->shutdown)
		return 0;		/* Controller is dead */

1132
	/*
1133
	 * If CF is still set and reset isn't forced
1134 1135 1136 1137
	 * then we maintained suspend power.
	 * Just undo the effect of ehci_suspend().
	 */
	if (ehci_readl(ehci, &ehci->regs->configured_flag) == FLAG_CF &&
1138
			!force_reset) {
1139 1140 1141
		int	mask = INTR_MASK;

		ehci_prepare_ports_for_controller_resume(ehci);
1142 1143 1144 1145 1146

		spin_lock_irq(&ehci->lock);
		if (ehci->shutdown)
			goto skip;

1147 1148 1149 1150
		if (!hcd->self.root_hub->do_remote_wakeup)
			mask &= ~STS_PCD;
		ehci_writel(ehci, mask, &ehci->regs->intr_enable);
		ehci_readl(ehci, &ehci->regs->intr_enable);
1151 1152
 skip:
		spin_unlock_irq(&ehci->lock);
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
		return 0;
	}

	/*
	 * Else reset, to cope with power loss or resume from hibernation
	 * having let the firmware kick in during reboot.
	 */
	usb_root_hub_lost_power(hcd->self.root_hub);
	(void) ehci_halt(ehci);
	(void) ehci_reset(ehci);

1164 1165 1166 1167
	spin_lock_irq(&ehci->lock);
	if (ehci->shutdown)
		goto skip;

1168 1169 1170 1171
	ehci_writel(ehci, ehci->command, &ehci->regs->command);
	ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
	ehci_readl(ehci, &ehci->regs->command);	/* unblock posted writes */

1172 1173 1174
	ehci->rh_state = EHCI_RH_SUSPENDED;
	spin_unlock_irq(&ehci->lock);

1175 1176
	return 1;
}
1177
EXPORT_SYMBOL_GPL(ehci_resume);
1178 1179 1180 1181 1182

#endif

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

1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
/*
 * Generic structure: This gets copied for platform drivers so that
 * individual entries can be overridden as needed.
 */

static const struct hc_driver ehci_hc_driver = {
	.description =		hcd_name,
	.product_desc =		"EHCI Host Controller",
	.hcd_priv_size =	sizeof(struct ehci_hcd),

	/*
	 * generic hardware linkage
	 */
	.irq =			ehci_irq,
1197
	.flags =		HCD_MEMORY | HCD_USB2 | HCD_BH,
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229

	/*
	 * basic lifecycle operations
	 */
	.reset =		ehci_setup,
	.start =		ehci_run,
	.stop =			ehci_stop,
	.shutdown =		ehci_shutdown,

	/*
	 * managing i/o requests and associated device resources
	 */
	.urb_enqueue =		ehci_urb_enqueue,
	.urb_dequeue =		ehci_urb_dequeue,
	.endpoint_disable =	ehci_endpoint_disable,
	.endpoint_reset =	ehci_endpoint_reset,
	.clear_tt_buffer_complete =	ehci_clear_tt_buffer_complete,

	/*
	 * scheduling support
	 */
	.get_frame_number =	ehci_get_frame,

	/*
	 * root hub support
	 */
	.hub_status_data =	ehci_hub_status_data,
	.hub_control =		ehci_hub_control,
	.bus_suspend =		ehci_bus_suspend,
	.bus_resume =		ehci_bus_resume,
	.relinquish_port =	ehci_relinquish_port,
	.port_handed_over =	ehci_port_handed_over,
1230 1231 1232 1233 1234

	/*
	 * device support
	 */
	.free_dev =		ehci_remove_device,
1235 1236 1237 1238 1239 1240 1241 1242
};

void ehci_init_driver(struct hc_driver *drv,
		const struct ehci_driver_overrides *over)
{
	/* Copy the generic table to drv and then apply the overrides */
	*drv = ehci_hc_driver;

1243 1244 1245 1246
	if (over) {
		drv->hcd_priv_size += over->extra_priv_size;
		if (over->reset)
			drv->reset = over->reset;
1247 1248
		if (over->port_power)
			drv->port_power = over->port_power;
1249
	}
1250 1251 1252 1253 1254
}
EXPORT_SYMBOL_GPL(ehci_init_driver);

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

1255
MODULE_DESCRIPTION(DRIVER_DESC);
L
Linus Torvalds 已提交
1256 1257 1258
MODULE_AUTHOR (DRIVER_AUTHOR);
MODULE_LICENSE ("GPL");

1259
#ifdef CONFIG_USB_EHCI_SH
1260 1261 1262 1263
#include "ehci-sh.c"
#define PLATFORM_DRIVER		ehci_hcd_sh_driver
#endif

G
Geoff Levand 已提交
1264 1265
#ifdef CONFIG_PPC_PS3
#include "ehci-ps3.c"
G
Geoff Levand 已提交
1266
#define	PS3_SYSTEM_BUS_DRIVER	ps3_ehci_driver
G
Geoff Levand 已提交
1267 1268
#endif

1269 1270 1271 1272 1273
#ifdef CONFIG_USB_EHCI_HCD_PPC_OF
#include "ehci-ppc-of.c"
#define OF_PLATFORM_DRIVER	ehci_hcd_ppc_of_driver
#endif

1274 1275
#ifdef CONFIG_XPS_USB_HCD_XILINX
#include "ehci-xilinx-of.c"
1276
#define XILINX_OF_PLATFORM_DRIVER	ehci_hcd_xilinx_of_driver
1277 1278
#endif

1279 1280 1281 1282 1283
#ifdef CONFIG_TILE_USB
#include "ehci-tilegx.c"
#define	PLATFORM_DRIVER		ehci_hcd_tilegx_driver
#endif

1284 1285 1286 1287 1288
#ifdef CONFIG_USB_EHCI_HCD_PMC_MSP
#include "ehci-pmcmsp.c"
#define	PLATFORM_DRIVER		ehci_hcd_msp_driver
#endif

1289 1290 1291 1292 1293
#ifdef CONFIG_SPARC_LEON
#include "ehci-grlib.c"
#define PLATFORM_DRIVER		ehci_grlib_driver
#endif

1294 1295 1296 1297
#ifdef CONFIG_USB_EHCI_MV
#include "ehci-mv.c"
#define        PLATFORM_DRIVER         ehci_mv_driver
#endif
1298

1299 1300 1301 1302 1303
#ifdef CONFIG_MIPS_SEAD3
#include "ehci-sead3.c"
#define	PLATFORM_DRIVER		ehci_hcd_sead3_driver
#endif

1304 1305 1306 1307
static int __init ehci_hcd_init(void)
{
	int retval = 0;

1308 1309 1310 1311
	if (usb_disabled())
		return -ENODEV;

	printk(KERN_INFO "%s: " DRIVER_DESC "\n", hcd_name);
1312 1313 1314 1315 1316 1317
	set_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
	if (test_bit(USB_UHCI_LOADED, &usb_hcds_loaded) ||
			test_bit(USB_OHCI_LOADED, &usb_hcds_loaded))
		printk(KERN_WARNING "Warning! ehci_hcd should always be loaded"
				" before uhci_hcd and ohci_hcd, not after\n");

1318 1319 1320 1321 1322
	pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
		 hcd_name,
		 sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
		 sizeof(struct ehci_itd), sizeof(struct ehci_sitd));

O
Oliver Neukum 已提交
1323
#ifdef CONFIG_DYNAMIC_DEBUG
1324
	ehci_debug_root = debugfs_create_dir("ehci", usb_debug_root);
1325 1326 1327 1328
	if (!ehci_debug_root) {
		retval = -ENOENT;
		goto err_debug;
	}
1329 1330
#endif

1331 1332
#ifdef PLATFORM_DRIVER
	retval = platform_driver_register(&PLATFORM_DRIVER);
1333 1334
	if (retval < 0)
		goto clean0;
1335 1336
#endif

G
Geoff Levand 已提交
1337
#ifdef PS3_SYSTEM_BUS_DRIVER
G
Geoff Levand 已提交
1338
	retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
1339 1340
	if (retval < 0)
		goto clean2;
1341
#endif
1342 1343

#ifdef OF_PLATFORM_DRIVER
1344
	retval = platform_driver_register(&OF_PLATFORM_DRIVER);
1345 1346 1347
	if (retval < 0)
		goto clean3;
#endif
1348 1349

#ifdef XILINX_OF_PLATFORM_DRIVER
1350
	retval = platform_driver_register(&XILINX_OF_PLATFORM_DRIVER);
1351 1352 1353
	if (retval < 0)
		goto clean4;
#endif
1354 1355
	return retval;

1356
#ifdef XILINX_OF_PLATFORM_DRIVER
1357
	/* platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER); */
1358 1359
clean4:
#endif
1360
#ifdef OF_PLATFORM_DRIVER
1361
	platform_driver_unregister(&OF_PLATFORM_DRIVER);
1362 1363 1364 1365 1366
clean3:
#endif
#ifdef PS3_SYSTEM_BUS_DRIVER
	ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
clean2:
G
Geoff Levand 已提交
1367
#endif
1368 1369 1370 1371
#ifdef PLATFORM_DRIVER
	platform_driver_unregister(&PLATFORM_DRIVER);
clean0:
#endif
O
Oliver Neukum 已提交
1372
#ifdef CONFIG_DYNAMIC_DEBUG
1373 1374
	debugfs_remove(ehci_debug_root);
	ehci_debug_root = NULL;
1375
err_debug:
1376
#endif
1377
	clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1378 1379 1380 1381 1382 1383
	return retval;
}
module_init(ehci_hcd_init);

static void __exit ehci_hcd_cleanup(void)
{
1384
#ifdef XILINX_OF_PLATFORM_DRIVER
1385
	platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER);
1386
#endif
1387
#ifdef OF_PLATFORM_DRIVER
1388
	platform_driver_unregister(&OF_PLATFORM_DRIVER);
1389
#endif
1390 1391 1392
#ifdef PLATFORM_DRIVER
	platform_driver_unregister(&PLATFORM_DRIVER);
#endif
G
Geoff Levand 已提交
1393
#ifdef PS3_SYSTEM_BUS_DRIVER
G
Geoff Levand 已提交
1394
	ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
G
Geoff Levand 已提交
1395
#endif
O
Oliver Neukum 已提交
1396
#ifdef CONFIG_DYNAMIC_DEBUG
1397 1398
	debugfs_remove(ehci_debug_root);
#endif
1399
	clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1400 1401
}
module_exit(ehci_hcd_cleanup);