ehci-hcd.c 38.2 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>
42
#include <linux/uaccess.h>
L
Linus Torvalds 已提交
43 44 45 46 47 48

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

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

L
Linus Torvalds 已提交
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
/*-------------------------------------------------------------------------*/

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


D
David Brownell 已提交
75
#undef VERBOSE_DEBUG
L
Linus Torvalds 已提交
76 77 78 79 80 81 82 83 84 85 86 87
#undef EHCI_URB_TRACE

#ifdef DEBUG
#define EHCI_STATS
#endif

/* 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
88 89 90 91 92 93 94
/*
 * 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 已提交
95 96 97 98 99 100 101 102 103 104 105

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

106
/* for flakey hardware, ignore overcurrent indicators */
107
static bool ignore_oc = 0;
108 109 110
module_param (ignore_oc, bool, S_IRUGO);
MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications");

111 112 113
/* for link power management(LPM) feature */
static unsigned int hird;
module_param(hird, int, S_IRUGO);
114
MODULE_PARM_DESC(hird, "host initiated resume duration, +1 for each 75us");
115

L
Linus Torvalds 已提交
116 117 118 119 120 121
#define	INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)

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

#include "ehci.h"
#include "ehci-dbg.c"
122
#include "pci-quirks.h"
L
Linus Torvalds 已提交
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142

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

/*
 * handshake - spin reading hc until handshake completes or fails
 * @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.
 */
143 144
static int handshake (struct ehci_hcd *ehci, void __iomem *ptr,
		      u32 mask, u32 done, int usec)
L
Linus Torvalds 已提交
145 146 147 148
{
	u32	result;

	do {
149
		result = ehci_readl(ehci, ptr);
L
Linus Torvalds 已提交
150 151 152 153 154 155 156 157 158 159 160
		if (result == ~(u32)0)		/* card removed */
			return -ENODEV;
		result &= mask;
		if (result == done)
			return 0;
		udelay (1);
		usec--;
	} while (usec > 0);
	return -ETIMEDOUT;
}

161 162 163 164 165
/* check TDI/ARC silicon is in host mode */
static int tdi_in_host_mode (struct ehci_hcd *ehci)
{
	u32		tmp;

166
	tmp = ehci_readl(ehci, &ehci->regs->usbmode);
167 168 169
	return (tmp & 3) == USBMODE_CM_HC;
}

L
Linus Torvalds 已提交
170 171 172
/* force HC to halt state from unknown (EHCI spec section 2.3) */
static int ehci_halt (struct ehci_hcd *ehci)
{
173
	u32	temp = ehci_readl(ehci, &ehci->regs->status);
L
Linus Torvalds 已提交
174

175
	/* disable any irqs left enabled by previous code */
176
	ehci_writel(ehci, 0, &ehci->regs->intr_enable);
177

178 179 180 181
	if (ehci_is_TDI(ehci) && tdi_in_host_mode(ehci) == 0) {
		return 0;
	}

L
Linus Torvalds 已提交
182 183 184
	if ((temp & STS_HALT) != 0)
		return 0;

185 186 187 188 189
	/*
	 * This routine gets called during probe before ehci->command
	 * has been initialized, so we can't rely on its value.
	 */
	ehci->command &= ~CMD_RUN;
190
	temp = ehci_readl(ehci, &ehci->regs->command);
191
	temp &= ~(CMD_RUN | CMD_IAAD);
192 193 194
	ehci_writel(ehci, temp, &ehci->regs->command);
	return handshake (ehci, &ehci->regs->status,
			  STS_HALT, STS_HALT, 16 * 125);
L
Linus Torvalds 已提交
195 196 197 198 199 200 201
}

/* put TDI/ARC silicon into EHCI mode */
static void tdi_reset (struct ehci_hcd *ehci)
{
	u32		tmp;

202
	tmp = ehci_readl(ehci, &ehci->regs->usbmode);
203 204 205 206 207 208 209
	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;
210
	ehci_writel(ehci, tmp, &ehci->regs->usbmode);
L
Linus Torvalds 已提交
211 212 213 214 215 216
}

/* reset a non-running (STS_HALT == 1) controller */
static int ehci_reset (struct ehci_hcd *ehci)
{
	int	retval;
217
	u32	command = ehci_readl(ehci, &ehci->regs->command);
L
Linus Torvalds 已提交
218

219 220 221 222 223
	/* If the EHCI debug controller is active, special care must be
	 * taken before and after a host controller reset */
	if (ehci->debug && !dbgp_reset_prep())
		ehci->debug = NULL;

L
Linus Torvalds 已提交
224 225
	command |= CMD_RESET;
	dbg_cmd (ehci, "reset", command);
226
	ehci_writel(ehci, command, &ehci->regs->command);
227
	ehci->rh_state = EHCI_RH_HALTED;
L
Linus Torvalds 已提交
228
	ehci->next_statechange = jiffies;
229 230
	retval = handshake (ehci, &ehci->regs->command,
			    CMD_RESET, 0, 250 * 1000);
L
Linus Torvalds 已提交
231

232 233
	if (ehci->has_hostpc) {
		ehci_writel(ehci, USBMODE_EX_HC | USBMODE_EX_VBPS,
234 235
				&ehci->regs->usbmode_ex);
		ehci_writel(ehci, TXFIFO_DEFAULT, &ehci->regs->txfill_tuning);
236
	}
L
Linus Torvalds 已提交
237 238 239 240 241 242
	if (retval)
		return retval;

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

243 244 245
	if (ehci->debug)
		dbgp_external_startup();

246 247
	ehci->port_c_suspend = ehci->suspended_ports =
			ehci->resuming_ports = 0;
L
Linus Torvalds 已提交
248 249 250 251 252 253 254 255
	return retval;
}

/* idle the controller (from running) */
static void ehci_quiesce (struct ehci_hcd *ehci)
{
	u32	temp;

256
	if (ehci->rh_state != EHCI_RH_RUNNING)
257
		return;
L
Linus Torvalds 已提交
258 259

	/* wait for any schedule enables/disables to take effect */
260
	temp = (ehci->command << 10) & (STS_ASS | STS_PSS);
261
	handshake(ehci, &ehci->regs->status, STS_ASS | STS_PSS, temp, 16 * 125);
L
Linus Torvalds 已提交
262 263

	/* then disable anything that's still active */
264 265
	ehci->command &= ~(CMD_ASE | CMD_PSE);
	ehci_writel(ehci, ehci->command, &ehci->regs->command);
L
Linus Torvalds 已提交
266 267

	/* hardware can take 16 microframes to turn off ... */
268
	handshake(ehci, &ehci->regs->status, STS_ASS | STS_PSS, 0, 16 * 125);
L
Linus Torvalds 已提交
269 270 271 272
}

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

273
static void end_unlink_async(struct ehci_hcd *ehci);
274
static void unlink_empty_async(struct ehci_hcd *ehci);
275
static void ehci_work(struct ehci_hcd *ehci);
276 277
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);
L
Linus Torvalds 已提交
278

A
Alan Stern 已提交
279
#include "ehci-timer.c"
L
Linus Torvalds 已提交
280
#include "ehci-hub.c"
281
#include "ehci-lpm.c"
L
Linus Torvalds 已提交
282 283 284
#include "ehci-mem.c"
#include "ehci-q.c"
#include "ehci-sched.c"
285
#include "ehci-sysfs.c"
L
Linus Torvalds 已提交
286 287 288

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

289 290 291 292 293 294 295 296 297 298 299 300 301
/* 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);

	while (port--)
		ehci_writel(ehci, PORT_RWC_BITS,
				&ehci->regs->port_status[port]);
}

S
Sarah Sharp 已提交
302 303 304
/*
 * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
 * Should be called with ehci->lock held.
305
 */
S
Sarah Sharp 已提交
306
static void ehci_silence_controller(struct ehci_hcd *ehci)
L
Linus Torvalds 已提交
307
{
S
Sarah Sharp 已提交
308
	ehci_halt(ehci);
309
	ehci_turn_off_all_ports(ehci);
L
Linus Torvalds 已提交
310 311

	/* make BIOS/etc use companion controller during reboot */
312
	ehci_writel(ehci, 0, &ehci->regs->configured_flag);
313 314 315

	/* unblock posted writes */
	ehci_readl(ehci, &ehci->regs->configured_flag);
L
Linus Torvalds 已提交
316 317
}

S
Sarah Sharp 已提交
318 319 320 321 322 323 324 325 326
/* 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);
327
	ehci->rh_state = EHCI_RH_STOPPING;
S
Sarah Sharp 已提交
328
	ehci_silence_controller(ehci);
A
Alan Stern 已提交
329
	ehci->enabled_hrtimer_events = 0;
S
Sarah Sharp 已提交
330
	spin_unlock_irq(&ehci->lock);
A
Alan Stern 已提交
331 332

	hrtimer_cancel(&ehci->hrtimer);
S
Sarah Sharp 已提交
333 334
}

D
David Brownell 已提交
335 336 337 338 339 340 341 342 343 344 345 346 347
static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
{
	unsigned port;

	if (!HCS_PPC (ehci->hcs_params))
		return;

	ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
	for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
		(void) ehci_hub_control(ehci_to_hcd(ehci),
				is_on ? SetPortFeature : ClearPortFeature,
				USB_PORT_FEAT_POWER,
				port--, NULL, 0);
A
Alan Stern 已提交
348 349
	/* Flush those writes */
	ehci_readl(ehci, &ehci->regs->command);
D
David Brownell 已提交
350 351 352
	msleep(20);
}

M
Matt Porter 已提交
353
/*-------------------------------------------------------------------------*/
L
Linus Torvalds 已提交
354

M
Matt Porter 已提交
355 356 357 358
/*
 * ehci_work is called from some interrupts, timers, and so on.
 * it calls driver completion functions, after dropping ehci->lock.
 */
359
static void ehci_work (struct ehci_hcd *ehci)
M
Matt Porter 已提交
360 361 362 363 364
{
	/* 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.
	 */
365 366
	if (ehci->scanning) {
		ehci->need_rescan = true;
M
Matt Porter 已提交
367
		return;
368 369 370 371 372
	}
	ehci->scanning = true;

 rescan:
	ehci->need_rescan = false;
373 374
	if (ehci->async_count)
		scan_async(ehci);
375 376 377 378
	if (ehci->intr_count > 0)
		scan_intr(ehci);
	if (ehci->isoc_count > 0)
		scan_isoc(ehci);
379 380 381
	if (ehci->need_rescan)
		goto rescan;
	ehci->scanning = false;
M
Matt Porter 已提交
382 383 384 385 386

	/* 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.
	 */
387
	turn_on_io_watchdog(ehci);
M
Matt Porter 已提交
388
}
L
Linus Torvalds 已提交
389

S
Sarah Sharp 已提交
390 391 392
/*
 * Called when the ehci_hcd module is removed.
 */
M
Matt Porter 已提交
393
static void ehci_stop (struct usb_hcd *hcd)
L
Linus Torvalds 已提交
394 395 396
{
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);

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

M
Matt Porter 已提交
399
	/* no more interrupts ... */
D
David Brownell 已提交
400

M
Matt Porter 已提交
401
	spin_lock_irq(&ehci->lock);
A
Alan Stern 已提交
402
	ehci->enabled_hrtimer_events = 0;
403
	ehci_quiesce(ehci);
L
Linus Torvalds 已提交
404

S
Sarah Sharp 已提交
405
	ehci_silence_controller(ehci);
M
Matt Porter 已提交
406 407
	ehci_reset (ehci);
	spin_unlock_irq(&ehci->lock);
L
Linus Torvalds 已提交
408

A
Alan Stern 已提交
409
	hrtimer_cancel(&ehci->hrtimer);
410
	remove_sysfs_files(ehci);
M
Matt Porter 已提交
411
	remove_debug_files (ehci);
L
Linus Torvalds 已提交
412

M
Matt Porter 已提交
413 414 415
	/* root hub is shut down separately (first, when possible) */
	spin_lock_irq (&ehci->lock);
	if (ehci->async)
416
		ehci_work (ehci);
417
	end_free_itds(ehci);
M
Matt Porter 已提交
418 419
	spin_unlock_irq (&ehci->lock);
	ehci_mem_cleanup (ehci);
L
Linus Torvalds 已提交
420

421 422
	if (ehci->amd_pll_fix == 1)
		usb_amd_dev_put();
423

M
Matt Porter 已提交
424
#ifdef	EHCI_STATS
A
Alan Stern 已提交
425 426
	ehci_dbg(ehci, "irq normal %ld err %ld iaa %ld (lost %ld)\n",
		ehci->stats.normal, ehci->stats.error, ehci->stats.iaa,
M
Matt Porter 已提交
427 428 429
		ehci->stats.lost_iaa);
	ehci_dbg (ehci, "complete %ld unlink %ld\n",
		ehci->stats.complete, ehci->stats.unlink);
L
Linus Torvalds 已提交
430 431
#endif

432 433
	dbg_status (ehci, "ehci_stop completed",
		    ehci_readl(ehci, &ehci->regs->status));
L
Linus Torvalds 已提交
434 435
}

436 437
/* one-time init, only for memory state */
static int ehci_init(struct usb_hcd *hcd)
L
Linus Torvalds 已提交
438
{
439
	struct ehci_hcd		*ehci = hcd_to_ehci(hcd);
L
Linus Torvalds 已提交
440 441 442
	u32			temp;
	int			retval;
	u32			hcc_params;
443
	struct ehci_qh_hw	*hw;
444 445 446

	spin_lock_init(&ehci->lock);

447 448 449 450
	/*
	 * keep io watchdog by default, those good HCDs could turn off it later
	 */
	ehci->need_io_watchdog = 1;
L
Linus Torvalds 已提交
451

A
Alan Stern 已提交
452 453 454 455
	hrtimer_init(&ehci->hrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
	ehci->hrtimer.function = ehci_hrtimer_func;
	ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;

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

458 459 460 461 462 463
	/*
	 * 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 已提交
464 465 466 467 468
	/*
	 * 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;
469
	INIT_LIST_HEAD(&ehci->intr_qh_list);
K
Karsten Wiese 已提交
470
	INIT_LIST_HEAD(&ehci->cached_itd_list);
471
	INIT_LIST_HEAD(&ehci->cached_sitd_list);
A
Alan Stern 已提交
472

473
	if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
A
Alan Stern 已提交
474 475 476 477 478 479 480 481
		/* 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();
		}
	}
482
	if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
L
Linus Torvalds 已提交
483 484 485
		return retval;

	/* controllers may cache some of the periodic schedule ... */
486
	if (HCC_ISOC_CACHE(hcc_params))		// full frame cache
487
		ehci->i_thresh = 2 + 8;
L
Linus Torvalds 已提交
488
	else					// N microframes cached
489
		ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
L
Linus Torvalds 已提交
490 491 492 493 494 495 496 497

	/*
	 * 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.
	 */
498
	ehci->async->qh_next.qh = NULL;
499 500 501
	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 已提交
502
#if defined(CONFIG_PPC_PS3)
503
	hw->hw_info1 |= cpu_to_hc32(ehci, QH_INACTIVATE);
R
Ricardo Martins 已提交
504
#endif
505 506
	hw->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
	hw->hw_qtd_next = EHCI_LIST_END(ehci);
507
	ehci->async->qh_state = QH_STATE_LINKED;
508
	hw->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
L
Linus Torvalds 已提交
509 510 511 512 513

	/* 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);
514 515 516 517 518
	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 已提交
519 520 521 522 523 524 525 526 527
	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) {
528
			park = min(park, (unsigned) 3);
L
Linus Torvalds 已提交
529 530 531
			temp |= CMD_PARK;
			temp |= park << 8;
		}
532
		ehci_dbg(ehci, "park %d\n", park);
L
Linus Torvalds 已提交
533
	}
534
	if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
L
Linus Torvalds 已提交
535 536 537 538
		/* periodic schedule size can be smaller than default */
		temp &= ~(3 << 2);
		temp |= (EHCI_TUNE_FLS << 2);
	}
539 540 541 542 543 544 545 546 547 548 549
	if (HCC_LPM(hcc_params)) {
		/* support link power management EHCI 1.1 addendum */
		ehci_dbg(ehci, "support lpm\n");
		ehci->has_lpm = 1;
		if (hird > 0xf) {
			ehci_dbg(ehci, "hird %d invalid, use default 0",
			hird);
			hird = 0;
		}
		temp |= hird << 24;
	}
550 551
	ehci->command = temp;

552
	/* Accept arbitrarily long scatter-gather lists */
553 554
	if (!(hcd->driver->flags & HCD_LOCAL_MEM))
		hcd->self.sg_tablesize = ~0;
555 556 557 558 559 560 561 562 563 564
	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;

565 566
	hcd->uses_new_polling = 1;

567
	/* EHCI spec section 4.1 */
568

569 570
	ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
	ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
571 572 573 574 575 576 577 578 579 580 581 582 583

	/*
	 * 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.
	 *
	 * NOTE:  the dma mask is visible through dma_supported(), so
	 * 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.
	 */
584
	hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
585
	if (HCC_64BIT_ADDR(hcc_params)) {
586
		ehci_writel(ehci, 0, &ehci->regs->segment);
587 588
#if 0
// this is deeply broken on almost all architectures
589
		if (!dma_set_mask(hcd->self.controller, DMA_BIT_MASK(64)))
590 591 592 593 594
			ehci_info(ehci, "enabled 64bit DMA\n");
#endif
	}


L
Linus Torvalds 已提交
595 596
	// Philips, Intel, and maybe others need CMD_RUN before the
	// root hub will detect new devices (why?); NEC doesn't
597 598
	ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
	ehci->command |= CMD_RUN;
599
	ehci_writel(ehci, ehci->command, &ehci->regs->command);
600
	dbg_cmd (ehci, "init", ehci->command);
L
Linus Torvalds 已提交
601 602 603 604 605 606

	/*
	 * 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.)
607 608 609 610 611
	 *
	 * 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
612 613 614
	 * 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 已提交
615
	 */
616
	down_write(&ehci_cf_port_reset_rwsem);
617
	ehci->rh_state = EHCI_RH_RUNNING;
618 619
	ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
	ehci_readl(ehci, &ehci->regs->command);	/* unblock posted writes */
620
	msleep(5);
621
	up_write(&ehci_cf_port_reset_rwsem);
622
	ehci->last_periodic_enable = ktime_get_real();
L
Linus Torvalds 已提交
623

624
	temp = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
L
Linus Torvalds 已提交
625
	ehci_info (ehci,
626
		"USB %x.%x started, EHCI %x.%02x%s\n",
M
Matt Porter 已提交
627
		((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
628
		temp >> 8, temp & 0xff,
629
		ignore_oc ? ", overcurrent ignored" : "");
L
Linus Torvalds 已提交
630

631 632
	ehci_writel(ehci, INTR_MASK,
		    &ehci->regs->intr_enable); /* Turn On Interrupts */
L
Linus Torvalds 已提交
633

634 635 636 637 638
	/* 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);
639
	create_sysfs_files(ehci);
L
Linus Torvalds 已提交
640 641 642 643

	return 0;
}

644
static int ehci_setup(struct usb_hcd *hcd)
645 646 647 648 649 650 651 652 653 654 655 656 657 658
{
	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;

659 660
	/* data structure init */
	retval = ehci_init(hcd);
661 662 663
	if (retval)
		return retval;

664
	retval = ehci_halt(ehci);
665 666 667
	if (retval)
		return retval;

668 669 670
	if (ehci_is_TDI(ehci))
		tdi_reset(ehci);

671 672 673 674 675
	ehci_reset(ehci);

	return 0;
}

L
Linus Torvalds 已提交
676 677
/*-------------------------------------------------------------------------*/

678
static irqreturn_t ehci_irq (struct usb_hcd *hcd)
L
Linus Torvalds 已提交
679 680
{
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
681
	u32			status, masked_status, pcd_status = 0, cmd;
L
Linus Torvalds 已提交
682 683 684 685
	int			bh;

	spin_lock (&ehci->lock);

686
	status = ehci_readl(ehci, &ehci->regs->status);
L
Linus Torvalds 已提交
687 688 689 690 691 692 693

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

694 695 696 697 698 699
	/*
	 * 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);

700
	/* Shared IRQ? */
701
	if (!masked_status || unlikely(ehci->rh_state == EHCI_RH_HALTED)) {
L
Linus Torvalds 已提交
702 703 704 705 706
		spin_unlock(&ehci->lock);
		return IRQ_NONE;
	}

	/* clear (just) interrupts */
707
	ehci_writel(ehci, masked_status, &ehci->regs->status);
708
	cmd = ehci_readl(ehci, &ehci->regs->command);
L
Linus Torvalds 已提交
709 710
	bh = 0;

D
David Brownell 已提交
711
#ifdef	VERBOSE_DEBUG
L
Linus Torvalds 已提交
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
	/* unrequested/ignored: Frame List Rollover */
	dbg_status (ehci, "irq", status);
#endif

	/* INT, ERR, and IAA interrupt rates can be throttled */

	/* 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) {
729 730 731 732 733 734 735 736 737 738 739 740 741 742

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

743
		/* guard against (alleged) silicon errata */
744
		if (cmd & CMD_IAAD)
745
			ehci_dbg(ehci, "IAA with IAAD still set?\n");
746
		if (ehci->async_iaa) {
A
Alan Stern 已提交
747
			COUNT(ehci->stats.iaa);
748 749
			end_unlink_async(ehci);
		} else
A
Alan Stern 已提交
750
			ehci_dbg(ehci, "IAA with nothing unlinked?\n");
L
Linus Torvalds 已提交
751 752 753
	}

	/* remote wakeup [4.3.1] */
754
	if (status & STS_PCD) {
L
Linus Torvalds 已提交
755
		unsigned	i = HCS_N_PORTS (ehci->hcs_params);
756
		u32		ppcd = 0;
757 758

		/* kick root hub later */
759
		pcd_status = status;
L
Linus Torvalds 已提交
760 761

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

765 766 767 768
		/* get per-port change detect bits */
		if (ehci->has_ppcd)
			ppcd = status >> 16;

L
Linus Torvalds 已提交
769
		while (i--) {
770 771 772 773 774 775 776
			int pstatus;

			/* leverage per-port change bits feature */
			if (ehci->has_ppcd && !(ppcd & (1 << i)))
				continue;
			pstatus = ehci_readl(ehci,
					 &ehci->regs->port_status[i]);
777 778

			if (pstatus & PORT_OWNER)
L
Linus Torvalds 已提交
779
				continue;
780 781 782 783 784
			if (!(test_bit(i, &ehci->suspended_ports) &&
					((pstatus & PORT_RESUME) ||
						!(pstatus & PORT_SUSPEND)) &&
					(pstatus & PORT_PE) &&
					ehci->reset_done[i] == 0))
L
Linus Torvalds 已提交
785 786 787 788
				continue;

			/* start 20 msec resume signaling from this port,
			 * and make khubd collect PORT_STAT_C_SUSPEND to
789 790
			 * stop that signaling.  Use 5 ms extra for safety,
			 * like usb_port_resume() does.
L
Linus Torvalds 已提交
791
			 */
792
			ehci->reset_done[i] = jiffies + msecs_to_jiffies(25);
793
			set_bit(i, &ehci->resuming_ports);
L
Linus Torvalds 已提交
794
			ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
795
			mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
L
Linus Torvalds 已提交
796 797 798 799 800
		}
	}

	/* PCI errors [4.15.2.4] */
	if (unlikely ((status & STS_FATAL) != 0)) {
801
		ehci_err(ehci, "fatal error\n");
802 803
		dbg_cmd(ehci, "fatal", cmd);
		dbg_status(ehci, "fatal", status);
L
Linus Torvalds 已提交
804
dead:
805
		usb_hc_died(hcd);
806 807 808 809 810 811 812 813 814 815

		/* Don't let the controller do anything more */
		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 已提交
816 817 818
	}

	if (bh)
819
		ehci_work (ehci);
L
Linus Torvalds 已提交
820
	spin_unlock (&ehci->lock);
821
	if (pcd_status)
822
		usb_hcd_poll_rh_status(hcd);
L
Linus Torvalds 已提交
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
	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 已提交
843
	gfp_t		mem_flags
L
Linus Torvalds 已提交
844 845 846 847 848 849 850
) {
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
	struct list_head	qtd_list;

	INIT_LIST_HEAD (&qtd_list);

	switch (usb_pipetype (urb->pipe)) {
851 852 853 854 855 856 857 858
	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 已提交
859 860 861
	default:
		if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
			return -ENOMEM;
862
		return submit_async(ehci, urb, &qtd_list, mem_flags);
L
Linus Torvalds 已提交
863 864 865 866

	case PIPE_INTERRUPT:
		if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
			return -ENOMEM;
867
		return intr_submit(ehci, urb, &qtd_list, mem_flags);
L
Linus Torvalds 已提交
868 869 870 871 872 873 874 875 876 877 878 879 880

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

881
static int ehci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
L
Linus Torvalds 已提交
882 883 884 885
{
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
	struct ehci_qh		*qh;
	unsigned long		flags;
886
	int			rc;
L
Linus Torvalds 已提交
887 888

	spin_lock_irqsave (&ehci->lock, flags);
889 890 891 892
	rc = usb_hcd_check_unlink_urb(hcd, urb, status);
	if (rc)
		goto done;

L
Linus Torvalds 已提交
893 894 895 896 897 898 899
	switch (usb_pipetype (urb->pipe)) {
	// case PIPE_CONTROL:
	// case PIPE_BULK:
	default:
		qh = (struct ehci_qh *) urb->hcpriv;
		if (!qh)
			break;
900 901 902
		switch (qh->qh_state) {
		case QH_STATE_LINKED:
		case QH_STATE_COMPLETING:
903
			start_unlink_async(ehci, qh);
904 905 906 907 908 909
			break;
		case QH_STATE_UNLINK:
		case QH_STATE_UNLINK_WAIT:
			/* already started */
			break;
		case QH_STATE_IDLE:
910 911
			/* QH might be waiting for a Clear-TT-Buffer */
			qh_completions(ehci, qh);
912 913
			break;
		}
L
Linus Torvalds 已提交
914 915 916 917 918 919 920 921
		break;

	case PIPE_INTERRUPT:
		qh = (struct ehci_qh *) urb->hcpriv;
		if (!qh)
			break;
		switch (qh->qh_state) {
		case QH_STATE_LINKED:
922
		case QH_STATE_COMPLETING:
923
			start_unlink_intr(ehci, qh);
924
			break;
L
Linus Torvalds 已提交
925
		case QH_STATE_IDLE:
926
			qh_completions (ehci, qh);
L
Linus Torvalds 已提交
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
			break;
		default:
			ehci_dbg (ehci, "bogus qh %p state %d\n",
					qh, qh->qh_state);
			goto done;
		}
		break;

	case PIPE_ISOCHRONOUS:
		// itd or sitd ...

		// wait till next completion, do it then.
		// completion irqs can wait up to 1024 msec,
		break;
	}
done:
	spin_unlock_irqrestore (&ehci->lock, flags);
944
	return rc;
L
Linus Torvalds 已提交
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
}

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

// 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;
	struct ehci_qh		*qh, *tmp;

	/* 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.
	 */
970
	if (qh->hw == NULL) {
971 972 973 974 975 976 977 978
		struct ehci_iso_stream	*stream = ep->hcpriv;

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

		/* BUG_ON(!list_empty(&stream->free_list)); */
		kfree(stream);
		goto done;
L
Linus Torvalds 已提交
979 980
	}

981
	if (ehci->rh_state < EHCI_RH_RUNNING)
L
Linus Torvalds 已提交
982 983 984
		qh->qh_state = QH_STATE_IDLE;
	switch (qh->qh_state) {
	case QH_STATE_LINKED:
985
	case QH_STATE_COMPLETING:
L
Linus Torvalds 已提交
986 987 988 989
		for (tmp = ehci->async->qh_next.qh;
				tmp && tmp != qh;
				tmp = tmp->qh_next.qh)
			continue;
990 991 992 993
		/* periodic qh self-unlinks on empty, and a COMPLETING qh
		 * may already be unlinked.
		 */
		if (tmp)
994
			start_unlink_async(ehci, qh);
L
Linus Torvalds 已提交
995 996
		/* FALL THROUGH */
	case QH_STATE_UNLINK:		/* wait for hw to finish? */
997
	case QH_STATE_UNLINK_WAIT:
L
Linus Torvalds 已提交
998 999
idle_timeout:
		spin_unlock_irqrestore (&ehci->lock, flags);
1000
		schedule_timeout_uninterruptible(1);
L
Linus Torvalds 已提交
1001 1002
		goto rescan;
	case QH_STATE_IDLE:		/* fully unlinked */
1003 1004
		if (qh->clearing_tt)
			goto idle_timeout;
L
Linus Torvalds 已提交
1005
		if (list_empty (&qh->qtd_list)) {
A
Alan Stern 已提交
1006
			qh_destroy(ehci, qh);
L
Linus Torvalds 已提交
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
			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;
	}
1019
 done:
L
Linus Torvalds 已提交
1020 1021 1022 1023
	ep->hcpriv = NULL;
	spin_unlock_irqrestore (&ehci->lock, flags);
}

1024 1025 1026 1027 1028 1029
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);
1030 1031 1032
	int			epnum = usb_endpoint_num(&ep->desc);
	int			is_out = usb_endpoint_dir_out(&ep->desc);
	unsigned long		flags;
1033 1034 1035 1036

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

1037
	spin_lock_irqsave(&ehci->lock, flags);
1038 1039 1040 1041 1042 1043 1044 1045
	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) {
1046
		usb_settoggle(qh->dev, epnum, is_out, 0);
1047 1048
		if (!list_empty(&qh->qtd_list)) {
			WARN_ONCE(1, "clear_halt for a busy endpoint\n");
1049 1050
		} else if (qh->qh_state == QH_STATE_LINKED ||
				qh->qh_state == QH_STATE_COMPLETING) {
1051 1052 1053 1054

			/* The toggle value in the QH can't be updated
			 * while the QH is active.  Unlink it now;
			 * re-linking will call qh_refresh().
1055
			 */
1056
			if (eptype == USB_ENDPOINT_XFER_BULK)
1057
				start_unlink_async(ehci, qh);
1058
			else
1059
				start_unlink_intr(ehci, qh);
1060 1061
		}
	}
1062
	spin_unlock_irqrestore(&ehci->lock, flags);
1063 1064
}

M
Matt Porter 已提交
1065 1066 1067
static int ehci_get_frame (struct usb_hcd *hcd)
{
	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
1068
	return (ehci_read_frame_index(ehci) >> 3) % ehci->periodic_size;
M
Matt Porter 已提交
1069
}
L
Linus Torvalds 已提交
1070 1071

/*-------------------------------------------------------------------------*/
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 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

#ifdef	CONFIG_PM

/* suspend/resume, section 4.3 */

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

static int __maybe_unused ehci_suspend(struct usb_hcd *hcd, bool do_wakeup)
{
	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);

	return 0;
}

/* Returns 0 if power was preserved, 1 if power was lost */
static int __maybe_unused ehci_resume(struct usb_hcd *hcd, bool hibernated)
{
	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);

	/*
	 * If CF is still set and we aren't resuming from hibernation
	 * then we maintained suspend power.
	 * Just undo the effect of ehci_suspend().
	 */
	if (ehci_readl(ehci, &ehci->regs->configured_flag) == FLAG_CF &&
			!hibernated) {
		int	mask = INTR_MASK;

		ehci_prepare_ports_for_controller_resume(ehci);
		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);
		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);

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

	/* here we "know" root ports should always stay powered */
	ehci_port_power(ehci, 1);

	ehci->rh_state = EHCI_RH_SUSPENDED;
	return 1;
}

#endif

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

1154 1155 1156 1157 1158 1159 1160
/*
 * The EHCI in ChipIdea HDRC cannot be a separate module or device,
 * because its registers (and irq) are shared between host/gadget/otg
 * functions  and in order to facilitate role switching we cannot
 * give the ehci driver exclusive access to those.
 */
#ifndef CHIPIDEA_EHCI
L
Linus Torvalds 已提交
1161

1162
MODULE_DESCRIPTION(DRIVER_DESC);
L
Linus Torvalds 已提交
1163 1164 1165
MODULE_AUTHOR (DRIVER_AUTHOR);
MODULE_LICENSE ("GPL");

M
Matt Porter 已提交
1166 1167
#ifdef CONFIG_PCI
#include "ehci-pci.c"
1168
#define	PCI_DRIVER		ehci_pci_driver
M
Matt Porter 已提交
1169
#endif
L
Linus Torvalds 已提交
1170

1171
#ifdef CONFIG_USB_EHCI_FSL
1172
#include "ehci-fsl.c"
1173
#define	PLATFORM_DRIVER		ehci_fsl_driver
1174 1175
#endif

1176 1177 1178 1179 1180
#ifdef CONFIG_USB_EHCI_MXC
#include "ehci-mxc.c"
#define PLATFORM_DRIVER		ehci_mxc_driver
#endif

1181
#ifdef CONFIG_USB_EHCI_SH
1182 1183 1184 1185
#include "ehci-sh.c"
#define PLATFORM_DRIVER		ehci_hcd_sh_driver
#endif

1186
#ifdef CONFIG_MIPS_ALCHEMY
J
Jordan Crouse 已提交
1187
#include "ehci-au1xxx.c"
1188
#define	PLATFORM_DRIVER		ehci_hcd_au1xxx_driver
J
Jordan Crouse 已提交
1189 1190
#endif

1191
#ifdef CONFIG_USB_EHCI_HCD_OMAP
1192 1193 1194 1195
#include "ehci-omap.c"
#define        PLATFORM_DRIVER         ehci_hcd_omap_driver
#endif

G
Geoff Levand 已提交
1196 1197
#ifdef CONFIG_PPC_PS3
#include "ehci-ps3.c"
G
Geoff Levand 已提交
1198
#define	PS3_SYSTEM_BUS_DRIVER	ps3_ehci_driver
G
Geoff Levand 已提交
1199 1200
#endif

1201 1202 1203 1204 1205
#ifdef CONFIG_USB_EHCI_HCD_PPC_OF
#include "ehci-ppc-of.c"
#define OF_PLATFORM_DRIVER	ehci_hcd_ppc_of_driver
#endif

1206 1207
#ifdef CONFIG_XPS_USB_HCD_XILINX
#include "ehci-xilinx-of.c"
1208
#define XILINX_OF_PLATFORM_DRIVER	ehci_hcd_xilinx_of_driver
1209 1210
#endif

1211
#ifdef CONFIG_PLAT_ORION
1212 1213 1214 1215
#include "ehci-orion.c"
#define	PLATFORM_DRIVER		ehci_orion_driver
#endif

V
Vladimir Barinov 已提交
1216 1217 1218 1219 1220
#ifdef CONFIG_ARCH_IXP4XX
#include "ehci-ixp4xx.c"
#define	PLATFORM_DRIVER		ixp4xx_ehci_driver
#endif

1221 1222 1223 1224 1225
#ifdef CONFIG_USB_W90X900_EHCI
#include "ehci-w90x900.c"
#define	PLATFORM_DRIVER		ehci_hcd_w90x900_driver
#endif

1226 1227 1228 1229 1230
#ifdef CONFIG_ARCH_AT91
#include "ehci-atmel.c"
#define	PLATFORM_DRIVER		ehci_atmel_driver
#endif

1231 1232 1233 1234 1235
#ifdef CONFIG_USB_OCTEON_EHCI
#include "ehci-octeon.c"
#define PLATFORM_DRIVER		ehci_octeon_driver
#endif

1236 1237 1238 1239 1240
#ifdef CONFIG_USB_CNS3XXX_EHCI
#include "ehci-cns3xxx.c"
#define PLATFORM_DRIVER		cns3xxx_ehci_driver
#endif

1241 1242 1243 1244 1245
#ifdef CONFIG_ARCH_VT8500
#include "ehci-vt8500.c"
#define	PLATFORM_DRIVER		vt8500_ehci_driver
#endif

1246 1247 1248 1249 1250
#ifdef CONFIG_PLAT_SPEAR
#include "ehci-spear.c"
#define PLATFORM_DRIVER		spear_ehci_hcd_driver
#endif

1251 1252 1253 1254 1255
#ifdef CONFIG_USB_EHCI_MSM
#include "ehci-msm.c"
#define PLATFORM_DRIVER		ehci_msm_driver
#endif

1256 1257 1258 1259 1260
#ifdef CONFIG_USB_EHCI_HCD_PMC_MSP
#include "ehci-pmcmsp.c"
#define	PLATFORM_DRIVER		ehci_hcd_msp_driver
#endif

1261 1262 1263 1264 1265
#ifdef CONFIG_USB_EHCI_TEGRA
#include "ehci-tegra.c"
#define PLATFORM_DRIVER		tegra_ehci_driver
#endif

1266 1267 1268 1269 1270
#ifdef CONFIG_USB_EHCI_S5P
#include "ehci-s5p.c"
#define PLATFORM_DRIVER		s5p_ehci_driver
#endif

1271 1272 1273 1274 1275
#ifdef CONFIG_SPARC_LEON
#include "ehci-grlib.c"
#define PLATFORM_DRIVER		ehci_grlib_driver
#endif

1276
#ifdef CONFIG_CPU_XLR
1277 1278 1279 1280
#include "ehci-xls.c"
#define PLATFORM_DRIVER		ehci_xls_driver
#endif

1281 1282 1283 1284 1285
#ifdef CONFIG_USB_EHCI_MV
#include "ehci-mv.c"
#define        PLATFORM_DRIVER         ehci_mv_driver
#endif

1286 1287 1288 1289 1290
#ifdef CONFIG_MACH_LOONGSON1
#include "ehci-ls1x.c"
#define PLATFORM_DRIVER		ehci_ls1x_driver
#endif

1291 1292 1293 1294 1295
#ifdef CONFIG_MIPS_SEAD3
#include "ehci-sead3.c"
#define	PLATFORM_DRIVER		ehci_hcd_sead3_driver
#endif

1296 1297 1298 1299 1300
#ifdef CONFIG_USB_EHCI_HCD_PLATFORM
#include "ehci-platform.c"
#define PLATFORM_DRIVER		ehci_platform_driver
#endif

G
Geoff Levand 已提交
1301
#if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) && \
1302 1303
    !defined(PS3_SYSTEM_BUS_DRIVER) && !defined(OF_PLATFORM_DRIVER) && \
    !defined(XILINX_OF_PLATFORM_DRIVER)
M
Matt Porter 已提交
1304 1305
#error "missing bus glue for ehci-hcd"
#endif
1306 1307 1308 1309 1310

static int __init ehci_hcd_init(void)
{
	int retval = 0;

1311 1312 1313 1314
	if (usb_disabled())
		return -ENODEV;

	printk(KERN_INFO "%s: " DRIVER_DESC "\n", hcd_name);
1315 1316 1317 1318 1319 1320
	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");

1321 1322 1323 1324 1325
	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));

1326
#ifdef DEBUG
1327
	ehci_debug_root = debugfs_create_dir("ehci", usb_debug_root);
1328 1329 1330 1331
	if (!ehci_debug_root) {
		retval = -ENOENT;
		goto err_debug;
	}
1332 1333
#endif

1334 1335
#ifdef PLATFORM_DRIVER
	retval = platform_driver_register(&PLATFORM_DRIVER);
1336 1337
	if (retval < 0)
		goto clean0;
1338 1339 1340 1341
#endif

#ifdef PCI_DRIVER
	retval = pci_register_driver(&PCI_DRIVER);
1342 1343
	if (retval < 0)
		goto clean1;
G
Geoff Levand 已提交
1344 1345 1346
#endif

#ifdef PS3_SYSTEM_BUS_DRIVER
G
Geoff Levand 已提交
1347
	retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
1348 1349
	if (retval < 0)
		goto clean2;
1350
#endif
1351 1352

#ifdef OF_PLATFORM_DRIVER
1353
	retval = platform_driver_register(&OF_PLATFORM_DRIVER);
1354 1355 1356
	if (retval < 0)
		goto clean3;
#endif
1357 1358

#ifdef XILINX_OF_PLATFORM_DRIVER
1359
	retval = platform_driver_register(&XILINX_OF_PLATFORM_DRIVER);
1360 1361 1362
	if (retval < 0)
		goto clean4;
#endif
1363 1364
	return retval;

1365
#ifdef XILINX_OF_PLATFORM_DRIVER
1366
	/* platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER); */
1367 1368
clean4:
#endif
1369
#ifdef OF_PLATFORM_DRIVER
1370
	platform_driver_unregister(&OF_PLATFORM_DRIVER);
1371 1372 1373 1374 1375
clean3:
#endif
#ifdef PS3_SYSTEM_BUS_DRIVER
	ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
clean2:
G
Geoff Levand 已提交
1376 1377
#endif
#ifdef PCI_DRIVER
1378 1379
	pci_unregister_driver(&PCI_DRIVER);
clean1:
G
Geoff Levand 已提交
1380
#endif
1381 1382 1383 1384 1385 1386 1387
#ifdef PLATFORM_DRIVER
	platform_driver_unregister(&PLATFORM_DRIVER);
clean0:
#endif
#ifdef DEBUG
	debugfs_remove(ehci_debug_root);
	ehci_debug_root = NULL;
1388
err_debug:
1389
#endif
1390
	clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1391 1392 1393 1394 1395 1396
	return retval;
}
module_init(ehci_hcd_init);

static void __exit ehci_hcd_cleanup(void)
{
1397
#ifdef XILINX_OF_PLATFORM_DRIVER
1398
	platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER);
1399
#endif
1400
#ifdef OF_PLATFORM_DRIVER
1401
	platform_driver_unregister(&OF_PLATFORM_DRIVER);
1402
#endif
1403 1404 1405 1406 1407 1408
#ifdef PLATFORM_DRIVER
	platform_driver_unregister(&PLATFORM_DRIVER);
#endif
#ifdef PCI_DRIVER
	pci_unregister_driver(&PCI_DRIVER);
#endif
G
Geoff Levand 已提交
1409
#ifdef PS3_SYSTEM_BUS_DRIVER
G
Geoff Levand 已提交
1410
	ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
G
Geoff Levand 已提交
1411
#endif
1412 1413 1414
#ifdef DEBUG
	debugfs_remove(ehci_debug_root);
#endif
1415
	clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1416 1417 1418
}
module_exit(ehci_hcd_cleanup);

1419
#endif /* CHIPIDEA_EHCI */