blob: 81cda09b47e3127772e51cbc5c57eab7761c4a52 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Alan Stern578333a2011-06-15 16:32:46 -04002 * Enhanced Host Controller Interface (EHCI) driver for USB.
3 *
4 * Maintainer: Alan Stern <stern@rowland.harvard.edu>
5 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Copyright (c) 2000-2004 by David Brownell
David Brownell53bd6a62006-08-30 14:50:06 -07007 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/module.h>
24#include <linux/pci.h>
25#include <linux/dmapool.h>
26#include <linux/kernel.h>
27#include <linux/delay.h>
28#include <linux/ioport.h>
29#include <linux/sched.h>
Ming Lei3c04e202008-09-18 23:06:21 +080030#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/errno.h>
32#include <linux/init.h>
Alan Sternd58b4bc2012-07-11 11:21:54 -040033#include <linux/hrtimer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/list.h>
35#include <linux/interrupt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/usb.h>
Eric Lescouet27729aa2010-04-24 23:21:52 +020037#include <linux/usb/hcd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/moduleparam.h>
39#include <linux/dma-mapping.h>
Tony Jones694cc202007-09-11 14:07:31 -070040#include <linux/debugfs.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090041#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#include <asm/byteorder.h>
44#include <asm/io.h>
45#include <asm/irq.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Geoff Levanddf7c1ca2011-11-30 16:40:57 -080048#if defined(CONFIG_PPC_PS3)
49#include <asm/firmware.h>
50#endif
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*-------------------------------------------------------------------------*/
53
54/*
55 * EHCI hc_driver implementation ... experimental, incomplete.
56 * Based on the final 1.0 register interface specification.
57 *
58 * USB 2.0 shows up in upcoming www.pcmcia.org technology.
59 * First was PCMCIA, like ISA; then CardBus, which is PCI.
60 * Next comes "CardBay", using USB 2.0 signals.
61 *
62 * Contains additional contributions by Brad Hards, Rory Bolt, and others.
63 * Special thanks to Intel and VIA for providing host controllers to
64 * test this driver on, and Cypress (including In-System Design) for
65 * providing early devices for those host controllers to talk to!
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 */
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#define DRIVER_AUTHOR "David Brownell"
69#define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
70
71static const char hcd_name [] = "ehci_hcd";
72
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074#undef EHCI_URB_TRACE
75
Linus Torvalds1da177e2005-04-16 15:20:36 -070076/* magic numbers that can affect system performance */
77#define EHCI_TUNE_CERR 3 /* 0-3 qtd retries; 0 == don't stop */
78#define EHCI_TUNE_RL_HS 4 /* nak throttle; see 4.9 */
79#define EHCI_TUNE_RL_TT 0
80#define EHCI_TUNE_MULT_HS 1 /* 1-3 transactions/uframe; 4.10.3 */
81#define EHCI_TUNE_MULT_TT 1
Alan Sternffda0802010-07-14 11:03:46 -040082/*
83 * Some drivers think it's safe to schedule isochronous transfers more than
84 * 256 ms into the future (partly as a result of an old bug in the scheduling
85 * code). In an attempt to avoid trouble, we will use a minimum scheduling
86 * length of 512 frames instead of 256.
87 */
88#define EHCI_TUNE_FLS 1 /* (medium) 512-frame schedule */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Linus Torvalds1da177e2005-04-16 15:20:36 -070090/* Initial IRQ latency: faster than hw default */
91static int log2_irq_thresh = 0; // 0 to 6
92module_param (log2_irq_thresh, int, S_IRUGO);
93MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
94
95/* initial park setting: slower than hw default */
96static unsigned park = 0;
97module_param (park, uint, S_IRUGO);
98MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
99
David Brownell93f1a472006-11-16 23:34:58 -0800100/* for flakey hardware, ignore overcurrent indicators */
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030101static bool ignore_oc = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800102module_param (ignore_oc, bool, S_IRUGO);
103MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications");
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105#define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
106
107/*-------------------------------------------------------------------------*/
108
109#include "ehci.h"
Andiry Xuad935622011-03-01 14:57:05 +0800110#include "pci-quirks.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Alan Sternb35c5002013-10-11 22:16:21 -0400112static void compute_tt_budget(u8 budget_table[EHCI_BANDWIDTH_SIZE],
113 struct ehci_tt *tt);
114
Alan Sternacc08502012-10-10 15:07:39 -0400115/*
116 * The MosChip MCS9990 controller updates its microframe counter
117 * a little before the frame counter, and occasionally we will read
118 * the invalid intermediate value. Avoid problems by checking the
119 * microframe number (the low-order 3 bits); if they are 0 then
120 * re-read the register to get the correct value.
121 */
122static unsigned ehci_moschip_read_frame_index(struct ehci_hcd *ehci)
123{
124 unsigned uf;
125
126 uf = ehci_readl(ehci, &ehci->regs->frame_index);
127 if (unlikely((uf & 7) == 0))
128 uf = ehci_readl(ehci, &ehci->regs->frame_index);
129 return uf;
130}
131
132static inline unsigned ehci_read_frame_index(struct ehci_hcd *ehci)
133{
134 if (ehci->frame_index_bug)
135 return ehci_moschip_read_frame_index(ehci);
136 return ehci_readl(ehci, &ehci->regs->frame_index);
137}
138
139#include "ehci-dbg.c"
140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141/*-------------------------------------------------------------------------*/
142
143/*
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600144 * ehci_handshake - spin reading hc until handshake completes or fails
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 * @ptr: address of hc register to be read
146 * @mask: bits to look at in result of read
147 * @done: value of those bits when handshake succeeds
148 * @usec: timeout in microseconds
149 *
150 * Returns negative errno, or zero on success
151 *
152 * Success happens when the "mask" bits have the specified value (hardware
153 * handshake done). There are two failure modes: "usec" have passed (major
154 * hardware flakeout), or the register reads as all-ones (hardware removed).
155 *
156 * That last failure should_only happen in cases like physical cardbus eject
157 * before driver shutdown. But it also seems to be caused by bugs in cardbus
158 * bridge shutdown: shutting down the bridge before the devices using it.
159 */
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600160int ehci_handshake(struct ehci_hcd *ehci, void __iomem *ptr,
161 u32 mask, u32 done, int usec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162{
163 u32 result;
164
165 do {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100166 result = ehci_readl(ehci, ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 if (result == ~(u32)0) /* card removed */
168 return -ENODEV;
169 result &= mask;
170 if (result == done)
171 return 0;
172 udelay (1);
173 usec--;
174 } while (usec > 0);
175 return -ETIMEDOUT;
176}
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600177EXPORT_SYMBOL_GPL(ehci_handshake);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Matthieu CASTET65fd4272010-09-06 18:26:56 +0200179/* check TDI/ARC silicon is in host mode */
180static int tdi_in_host_mode (struct ehci_hcd *ehci)
181{
Matthieu CASTET65fd4272010-09-06 18:26:56 +0200182 u32 tmp;
183
Alan Sterna46af4e2012-06-25 12:19:03 -0400184 tmp = ehci_readl(ehci, &ehci->regs->usbmode);
Matthieu CASTET65fd4272010-09-06 18:26:56 +0200185 return (tmp & 3) == USBMODE_CM_HC;
186}
187
Alan Sternc4f34762012-07-11 11:23:10 -0400188/*
189 * Force HC to halt state from unknown (EHCI spec section 2.3).
190 * Must be called with interrupts enabled and the lock not held.
191 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192static int ehci_halt (struct ehci_hcd *ehci)
193{
Alan Sternc4f34762012-07-11 11:23:10 -0400194 u32 temp;
195
196 spin_lock_irq(&ehci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
David Brownell72f30b62005-09-27 10:19:39 -0700198 /* disable any irqs left enabled by previous code */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100199 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
David Brownell72f30b62005-09-27 10:19:39 -0700200
Alan Sternc4f34762012-07-11 11:23:10 -0400201 if (ehci_is_TDI(ehci) && !tdi_in_host_mode(ehci)) {
202 spin_unlock_irq(&ehci->lock);
Matthieu CASTET65fd4272010-09-06 18:26:56 +0200203 return 0;
204 }
205
Alan Stern3d9545c2012-04-23 13:54:36 -0400206 /*
207 * This routine gets called during probe before ehci->command
208 * has been initialized, so we can't rely on its value.
209 */
210 ehci->command &= ~CMD_RUN;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100211 temp = ehci_readl(ehci, &ehci->regs->command);
Alan Stern3d9545c2012-04-23 13:54:36 -0400212 temp &= ~(CMD_RUN | CMD_IAAD);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100213 ehci_writel(ehci, temp, &ehci->regs->command);
Alan Sternc4f34762012-07-11 11:23:10 -0400214
215 spin_unlock_irq(&ehci->lock);
216 synchronize_irq(ehci_to_hcd(ehci)->irq);
217
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600218 return ehci_handshake(ehci, &ehci->regs->status,
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100219 STS_HALT, STS_HALT, 16 * 125);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220}
221
222/* put TDI/ARC silicon into EHCI mode */
223static void tdi_reset (struct ehci_hcd *ehci)
224{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 u32 tmp;
226
Alan Sterna46af4e2012-06-25 12:19:03 -0400227 tmp = ehci_readl(ehci, &ehci->regs->usbmode);
Vladimir Barinovd23a1372007-05-23 20:07:48 +0400228 tmp |= USBMODE_CM_HC;
229 /* The default byte access to MMR space is LE after
230 * controller reset. Set the required endian mode
231 * for transfer buffers to match the host microprocessor
232 */
233 if (ehci_big_endian_mmio(ehci))
234 tmp |= USBMODE_BE;
Alan Sterna46af4e2012-06-25 12:19:03 -0400235 ehci_writel(ehci, tmp, &ehci->regs->usbmode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236}
237
Alan Sternc4f34762012-07-11 11:23:10 -0400238/*
239 * Reset a non-running (STS_HALT == 1) controller.
240 * Must be called with interrupts enabled and the lock not held.
241 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242static int ehci_reset (struct ehci_hcd *ehci)
243{
244 int retval;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100245 u32 command = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Jason Wessel8d053c72009-08-20 15:39:54 -0500247 /* If the EHCI debug controller is active, special care must be
248 * taken before and after a host controller reset */
Jan Beulich9fa57802012-09-18 12:23:02 +0100249 if (ehci->debug && !dbgp_reset_prep(ehci_to_hcd(ehci)))
Jason Wessel8d053c72009-08-20 15:39:54 -0500250 ehci->debug = NULL;
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 command |= CMD_RESET;
253 dbg_cmd (ehci, "reset", command);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100254 ehci_writel(ehci, command, &ehci->regs->command);
Alan Sterne8799902011-08-18 16:31:30 -0400255 ehci->rh_state = EHCI_RH_HALTED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 ehci->next_statechange = jiffies;
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600257 retval = ehci_handshake(ehci, &ehci->regs->command,
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100258 CMD_RESET, 0, 250 * 1000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
Alek Du331ac6b2009-07-13 12:41:20 +0800260 if (ehci->has_hostpc) {
261 ehci_writel(ehci, USBMODE_EX_HC | USBMODE_EX_VBPS,
Alan Sterna46af4e2012-06-25 12:19:03 -0400262 &ehci->regs->usbmode_ex);
263 ehci_writel(ehci, TXFIFO_DEFAULT, &ehci->regs->txfill_tuning);
Alek Du331ac6b2009-07-13 12:41:20 +0800264 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 if (retval)
266 return retval;
267
268 if (ehci_is_TDI(ehci))
269 tdi_reset (ehci);
270
Jason Wessel8d053c72009-08-20 15:39:54 -0500271 if (ehci->debug)
Jan Beulich9fa57802012-09-18 12:23:02 +0100272 dbgp_external_startup(ehci_to_hcd(ehci));
Jason Wessel8d053c72009-08-20 15:39:54 -0500273
Alan Sterna448e4d2012-04-03 15:24:30 -0400274 ehci->port_c_suspend = ehci->suspended_ports =
275 ehci->resuming_ports = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 return retval;
277}
278
Alan Sternc4f34762012-07-11 11:23:10 -0400279/*
280 * Idle the controller (turn off the schedules).
281 * Must be called with interrupts enabled and the lock not held.
282 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283static void ehci_quiesce (struct ehci_hcd *ehci)
284{
285 u32 temp;
286
Alan Sterne8799902011-08-18 16:31:30 -0400287 if (ehci->rh_state != EHCI_RH_RUNNING)
Alan Sternc0c53db2012-07-11 11:21:48 -0400288 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
290 /* wait for any schedule enables/disables to take effect */
Alan Stern3d9545c2012-04-23 13:54:36 -0400291 temp = (ehci->command << 10) & (STS_ASS | STS_PSS);
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600292 ehci_handshake(ehci, &ehci->regs->status, STS_ASS | STS_PSS, temp,
293 16 * 125);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
295 /* then disable anything that's still active */
Alan Sternc4f34762012-07-11 11:23:10 -0400296 spin_lock_irq(&ehci->lock);
Alan Stern3d9545c2012-04-23 13:54:36 -0400297 ehci->command &= ~(CMD_ASE | CMD_PSE);
298 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Alan Sternc4f34762012-07-11 11:23:10 -0400299 spin_unlock_irq(&ehci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301 /* hardware can take 16 microframes to turn off ... */
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600302 ehci_handshake(ehci, &ehci->regs->status, STS_ASS | STS_PSS, 0,
303 16 * 125);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304}
305
306/*-------------------------------------------------------------------------*/
307
Alan Stern07d29b62007-12-11 16:05:30 -0500308static void end_unlink_async(struct ehci_hcd *ehci);
Alan Stern32830f22012-07-11 11:22:53 -0400309static void unlink_empty_async(struct ehci_hcd *ehci);
Alan Stern2a40f322013-03-15 14:40:26 -0400310static void unlink_empty_async_suspended(struct ehci_hcd *ehci);
David Howells7d12e782006-10-05 14:55:46 +0100311static void ehci_work(struct ehci_hcd *ehci);
Alan Sterndf202252012-07-11 11:22:26 -0400312static void start_unlink_intr(struct ehci_hcd *ehci, struct ehci_qh *qh);
313static void end_unlink_intr(struct ehci_hcd *ehci, struct ehci_qh *qh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Alan Sternd58b4bc2012-07-11 11:21:54 -0400315#include "ehci-timer.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316#include "ehci-hub.c"
317#include "ehci-mem.c"
318#include "ehci-q.c"
319#include "ehci-sched.c"
Kirill Smelkov4c670452011-07-03 20:36:56 +0400320#include "ehci-sysfs.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322/*-------------------------------------------------------------------------*/
323
Alan Stern89037952007-02-13 14:55:27 -0500324/* On some systems, leaving remote wakeup enabled prevents system shutdown.
325 * The firmware seems to think that powering off is a wakeup event!
326 * This routine turns off remote wakeup and everything else, on all ports.
327 */
328static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
329{
330 int port = HCS_N_PORTS(ehci->hcs_params);
331
332 while (port--)
333 ehci_writel(ehci, PORT_RWC_BITS,
334 &ehci->regs->port_status[port]);
335}
336
Sarah Sharp21da84a2008-04-08 14:30:18 -0700337/*
338 * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
Alan Sternc4f34762012-07-11 11:23:10 -0400339 * Must be called with interrupts enabled and the lock not held.
David Brownell72f30b62005-09-27 10:19:39 -0700340 */
Sarah Sharp21da84a2008-04-08 14:30:18 -0700341static void ehci_silence_controller(struct ehci_hcd *ehci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342{
Sarah Sharp21da84a2008-04-08 14:30:18 -0700343 ehci_halt(ehci);
Alan Sternc4f34762012-07-11 11:23:10 -0400344
345 spin_lock_irq(&ehci->lock);
346 ehci->rh_state = EHCI_RH_HALTED;
Alan Stern89037952007-02-13 14:55:27 -0500347 ehci_turn_off_all_ports(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 /* make BIOS/etc use companion controller during reboot */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100350 ehci_writel(ehci, 0, &ehci->regs->configured_flag);
Alan Stern89037952007-02-13 14:55:27 -0500351
352 /* unblock posted writes */
353 ehci_readl(ehci, &ehci->regs->configured_flag);
Alan Sternc4f34762012-07-11 11:23:10 -0400354 spin_unlock_irq(&ehci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355}
356
Sarah Sharp21da84a2008-04-08 14:30:18 -0700357/* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
358 * This forcibly disables dma and IRQs, helping kexec and other cases
359 * where the next system software may expect clean state.
360 */
361static void ehci_shutdown(struct usb_hcd *hcd)
362{
363 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
364
Sarah Sharp21da84a2008-04-08 14:30:18 -0700365 spin_lock_irq(&ehci->lock);
Alan Stern43fe3a92012-07-11 11:23:16 -0400366 ehci->shutdown = true;
Alan Sternc0c53db2012-07-11 11:21:48 -0400367 ehci->rh_state = EHCI_RH_STOPPING;
Alan Sternd58b4bc2012-07-11 11:21:54 -0400368 ehci->enabled_hrtimer_events = 0;
Sarah Sharp21da84a2008-04-08 14:30:18 -0700369 spin_unlock_irq(&ehci->lock);
Alan Sternd58b4bc2012-07-11 11:21:54 -0400370
Alan Sternc4f34762012-07-11 11:23:10 -0400371 ehci_silence_controller(ehci);
372
Alan Sternd58b4bc2012-07-11 11:21:54 -0400373 hrtimer_cancel(&ehci->hrtimer);
Sarah Sharp21da84a2008-04-08 14:30:18 -0700374}
375
Matt Porter7ff71d62005-09-22 22:31:15 -0700376/*-------------------------------------------------------------------------*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
Matt Porter7ff71d62005-09-22 22:31:15 -0700378/*
379 * ehci_work is called from some interrupts, timers, and so on.
380 * it calls driver completion functions, after dropping ehci->lock.
381 */
David Howells7d12e782006-10-05 14:55:46 +0100382static void ehci_work (struct ehci_hcd *ehci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
Matt Porter7ff71d62005-09-22 22:31:15 -0700384 /* another CPU may drop ehci->lock during a schedule scan while
385 * it reports urb completions. this flag guards against bogus
386 * attempts at re-entrant schedule scanning.
387 */
Alan Stern361aabf2012-07-11 11:22:57 -0400388 if (ehci->scanning) {
389 ehci->need_rescan = true;
Matt Porter7ff71d62005-09-22 22:31:15 -0700390 return;
Alan Stern361aabf2012-07-11 11:22:57 -0400391 }
392 ehci->scanning = true;
393
394 rescan:
395 ehci->need_rescan = false;
Alan Stern31446612012-07-11 11:22:21 -0400396 if (ehci->async_count)
397 scan_async(ehci);
Alan Stern569b3942012-07-11 11:23:00 -0400398 if (ehci->intr_count > 0)
399 scan_intr(ehci);
400 if (ehci->isoc_count > 0)
401 scan_isoc(ehci);
Alan Stern361aabf2012-07-11 11:22:57 -0400402 if (ehci->need_rescan)
403 goto rescan;
404 ehci->scanning = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
Matt Porter7ff71d62005-09-22 22:31:15 -0700406 /* the IO watchdog guards against hardware or driver bugs that
407 * misplace IRQs, and should let us run completely without IRQs.
408 * such lossage has been observed on both VT6202 and VT8235.
409 */
Alan Stern18aafe62012-07-11 11:23:04 -0400410 turn_on_io_watchdog(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411}
412
Sarah Sharp21da84a2008-04-08 14:30:18 -0700413/*
414 * Called when the ehci_hcd module is removed.
415 */
Matt Porter7ff71d62005-09-22 22:31:15 -0700416static void ehci_stop (struct usb_hcd *hcd)
417{
418 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
419
420 ehci_dbg (ehci, "stop\n");
421
Matt Porter7ff71d62005-09-22 22:31:15 -0700422 /* no more interrupts ... */
Matt Porter7ff71d62005-09-22 22:31:15 -0700423
424 spin_lock_irq(&ehci->lock);
Alan Sternd58b4bc2012-07-11 11:21:54 -0400425 ehci->enabled_hrtimer_events = 0;
Matt Porter7ff71d62005-09-22 22:31:15 -0700426 spin_unlock_irq(&ehci->lock);
427
Alan Sternc4f34762012-07-11 11:23:10 -0400428 ehci_quiesce(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700429 ehci_silence_controller(ehci);
430 ehci_reset (ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700431
Alan Sternd58b4bc2012-07-11 11:21:54 -0400432 hrtimer_cancel(&ehci->hrtimer);
Kirill Smelkov4c670452011-07-03 20:36:56 +0400433 remove_sysfs_files(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700434 remove_debug_files (ehci);
435
436 /* root hub is shut down separately (first, when possible) */
437 spin_lock_irq (&ehci->lock);
Alan Stern55934eb2012-07-11 11:22:35 -0400438 end_free_itds(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700439 spin_unlock_irq (&ehci->lock);
440 ehci_mem_cleanup (ehci);
441
Andiry Xuad935622011-03-01 14:57:05 +0800442 if (ehci->amd_pll_fix == 1)
443 usb_amd_dev_put();
Alex He05570292010-12-07 10:10:08 +0800444
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100445 dbg_status (ehci, "ehci_stop completed",
446 ehci_readl(ehci, &ehci->regs->status));
Matt Porter7ff71d62005-09-22 22:31:15 -0700447}
448
David Brownell18807522005-11-23 15:45:37 -0800449/* one-time init, only for memory state */
450static int ehci_init(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451{
David Brownell18807522005-11-23 15:45:37 -0800452 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 u32 temp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 int retval;
455 u32 hcc_params;
Alek Du3807e262009-07-14 07:23:29 +0800456 struct ehci_qh_hw *hw;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
David Brownell18807522005-11-23 15:45:37 -0800458 spin_lock_init(&ehci->lock);
459
Alek Du403dbd32009-07-13 17:30:41 +0800460 /*
461 * keep io watchdog by default, those good HCDs could turn off it later
462 */
463 ehci->need_io_watchdog = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Alan Sternd58b4bc2012-07-11 11:21:54 -0400465 hrtimer_init(&ehci->hrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
466 ehci->hrtimer.function = ehci_hrtimer_func;
467 ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
Alan Stern07d29b62007-12-11 16:05:30 -0500468
Alan Sternf75593c2011-01-06 10:17:09 -0500469 hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 /*
Kirill Smelkovcc62a7e2011-07-03 20:36:57 +0400472 * by default set standard 80% (== 100 usec/uframe) max periodic
473 * bandwidth as required by USB 2.0
474 */
475 ehci->uframe_periodic_max = 100;
476
477 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 * hw default: 1K periodic list heads, one per frame.
479 * periodic_size can shrink by USBCMD update if hcc_params allows.
480 */
481 ehci->periodic_size = DEFAULT_I_TDPS;
Alan Stern6e018752013-03-22 13:31:45 -0400482 INIT_LIST_HEAD(&ehci->async_unlink);
Alan Stern214ac7a2013-03-22 13:31:58 -0400483 INIT_LIST_HEAD(&ehci->async_idle);
Ming Lei9118f9e2013-07-03 22:53:10 +0800484 INIT_LIST_HEAD(&ehci->intr_unlink_wait);
Alan Stern6e018752013-03-22 13:31:45 -0400485 INIT_LIST_HEAD(&ehci->intr_unlink);
Alan Stern569b3942012-07-11 11:23:00 -0400486 INIT_LIST_HEAD(&ehci->intr_qh_list);
Karsten Wiese9aa09d22009-02-08 16:07:58 -0800487 INIT_LIST_HEAD(&ehci->cached_itd_list);
Alan Stern0e5f2312010-04-08 16:56:37 -0400488 INIT_LIST_HEAD(&ehci->cached_sitd_list);
Alan Sternb35c5002013-10-11 22:16:21 -0400489 INIT_LIST_HEAD(&ehci->tt_list);
Alan Sternf75593c2011-01-06 10:17:09 -0500490
Greg Kroah-Hartman8e192912012-05-21 08:54:43 -0700491 if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
Alan Sternf75593c2011-01-06 10:17:09 -0500492 /* periodic schedule size can be smaller than default */
493 switch (EHCI_TUNE_FLS) {
494 case 0: ehci->periodic_size = 1024; break;
495 case 1: ehci->periodic_size = 512; break;
496 case 2: ehci->periodic_size = 256; break;
497 default: BUG();
498 }
499 }
David Brownell18807522005-11-23 15:45:37 -0800500 if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 return retval;
502
503 /* controllers may cache some of the periodic schedule ... */
David Brownell53bd6a62006-08-30 14:50:06 -0700504 if (HCC_ISOC_CACHE(hcc_params)) // full frame cache
Alan Stern98cae422012-09-28 16:01:34 -0400505 ehci->i_thresh = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 else // N microframes cached
David Brownell18807522005-11-23 15:45:37 -0800507 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 /*
510 * dedicate a qh for the async ring head, since we couldn't unlink
511 * a 'real' qh without stopping the async schedule [4.8]. use it
512 * as the 'reclamation list head' too.
513 * its dummy is used in hw_alt_next of many tds, to prevent the qh
514 * from automatically advancing to the next td after short reads.
515 */
David Brownell18807522005-11-23 15:45:37 -0800516 ehci->async->qh_next.qh = NULL;
Alek Du3807e262009-07-14 07:23:29 +0800517 hw = ehci->async->hw;
518 hw->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
519 hw->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
Ricardo Martins4f7a67e2012-05-22 18:02:03 +0100520#if defined(CONFIG_PPC_PS3)
Alan Stern4c53de72012-07-11 11:21:32 -0400521 hw->hw_info1 |= cpu_to_hc32(ehci, QH_INACTIVATE);
Ricardo Martins4f7a67e2012-05-22 18:02:03 +0100522#endif
Alek Du3807e262009-07-14 07:23:29 +0800523 hw->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
524 hw->hw_qtd_next = EHCI_LIST_END(ehci);
David Brownell18807522005-11-23 15:45:37 -0800525 ehci->async->qh_state = QH_STATE_LINKED;
Alek Du3807e262009-07-14 07:23:29 +0800526 hw->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
528 /* clear interrupt enables, set irq latency */
529 if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
530 log2_irq_thresh = 0;
531 temp = 1 << (16 + log2_irq_thresh);
Alek Du5a9cdf32010-06-04 15:47:56 +0800532 if (HCC_PER_PORT_CHANGE_EVENT(hcc_params)) {
533 ehci->has_ppcd = 1;
534 ehci_dbg(ehci, "enable per-port change event\n");
535 temp |= CMD_PPCEE;
536 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 if (HCC_CANPARK(hcc_params)) {
538 /* HW default park == 3, on hardware that supports it (like
539 * NVidia and ALI silicon), maximizes throughput on the async
540 * schedule by avoiding QH fetches between transfers.
541 *
542 * With fast usb storage devices and NForce2, "park" seems to
543 * make problems: throughput reduction (!), data errors...
544 */
545 if (park) {
David Brownell18807522005-11-23 15:45:37 -0800546 park = min(park, (unsigned) 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 temp |= CMD_PARK;
548 temp |= park << 8;
549 }
David Brownell18807522005-11-23 15:45:37 -0800550 ehci_dbg(ehci, "park %d\n", park);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
David Brownell18807522005-11-23 15:45:37 -0800552 if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 /* periodic schedule size can be smaller than default */
554 temp &= ~(3 << 2);
555 temp |= (EHCI_TUNE_FLS << 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 }
David Brownell18807522005-11-23 15:45:37 -0800557 ehci->command = temp;
558
Alan Stern40f8db82009-11-06 12:29:40 -0500559 /* Accept arbitrarily long scatter-gather lists */
Andrea Righi4307a282010-06-28 16:56:45 +0200560 if (!(hcd->driver->flags & HCD_LOCAL_MEM))
561 hcd->self.sg_tablesize = ~0;
David Brownell18807522005-11-23 15:45:37 -0800562 return 0;
563}
564
565/* start HC running; it's halted, ehci_init() has been run (once) */
566static int ehci_run (struct usb_hcd *hcd)
567{
568 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
David Brownell18807522005-11-23 15:45:37 -0800569 u32 temp;
570 u32 hcc_params;
571
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200572 hcd->uses_new_polling = 1;
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200573
David Brownell18807522005-11-23 15:45:37 -0800574 /* EHCI spec section 4.1 */
Geoff Levand876e0df2011-11-22 18:04:45 -0800575
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100576 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
577 ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
David Brownell18807522005-11-23 15:45:37 -0800578
579 /*
580 * hcc_params controls whether ehci->regs->segment must (!!!)
581 * be used; it constrains QH/ITD/SITD and QTD locations.
582 * pci_pool consistent memory always uses segment zero.
583 * streaming mappings for I/O buffers, like pci_map_single(),
584 * can return segments above 4GB, if the device allows.
585 *
586 * NOTE: the dma mask is visible through dma_supported(), so
587 * drivers can pass this info along ... like NETIF_F_HIGHDMA,
588 * Scsi_Host.highmem_io, and so forth. It's readonly to all
589 * host side drivers though.
590 */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100591 hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
David Brownell18807522005-11-23 15:45:37 -0800592 if (HCC_64BIT_ADDR(hcc_params)) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100593 ehci_writel(ehci, 0, &ehci->regs->segment);
David Brownell18807522005-11-23 15:45:37 -0800594#if 0
595// this is deeply broken on almost all architectures
Yang Hongyang6a355282009-04-06 19:01:13 -0700596 if (!dma_set_mask(hcd->self.controller, DMA_BIT_MASK(64)))
David Brownell18807522005-11-23 15:45:37 -0800597 ehci_info(ehci, "enabled 64bit DMA\n");
598#endif
599 }
600
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 // Philips, Intel, and maybe others need CMD_RUN before the
603 // root hub will detect new devices (why?); NEC doesn't
David Brownell18807522005-11-23 15:45:37 -0800604 ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
605 ehci->command |= CMD_RUN;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100606 ehci_writel(ehci, ehci->command, &ehci->regs->command);
David Brownell18807522005-11-23 15:45:37 -0800607 dbg_cmd (ehci, "init", ehci->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 /*
610 * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
611 * are explicitly handed to companion controller(s), so no TT is
612 * involved with the root hub. (Except where one is integrated,
613 * and there's no companion controller unless maybe for USB OTG.)
Alan Stern32fe0192007-10-10 16:27:07 -0400614 *
615 * Turning on the CF flag will transfer ownership of all ports
616 * from the companions to the EHCI controller. If any of the
617 * companions are in the middle of a port reset at the time, it
618 * could cause trouble. Write-locking ehci_cf_port_reset_rwsem
David Brownell1cb52652007-11-13 16:22:30 -0800619 * guarantees that no resets are in progress. After we set CF,
620 * a short delay lets the hardware catch up; new resets shouldn't
621 * be started before the port switching actions could complete.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 */
Alan Stern32fe0192007-10-10 16:27:07 -0400623 down_write(&ehci_cf_port_reset_rwsem);
Alan Sterne8799902011-08-18 16:31:30 -0400624 ehci->rh_state = EHCI_RH_RUNNING;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100625 ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
626 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
David Brownell1cb52652007-11-13 16:22:30 -0800627 msleep(5);
Alan Stern32fe0192007-10-10 16:27:07 -0400628 up_write(&ehci_cf_port_reset_rwsem);
Oliver Neukumee4ecb82009-11-27 15:17:59 +0100629 ehci->last_periodic_enable = ktime_get_real();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Jan Anderssonc4301312011-05-03 20:11:57 +0200631 temp = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 ehci_info (ehci,
Alan Stern2b70f072008-10-02 11:47:15 -0400633 "USB %x.%x started, EHCI %x.%02x%s\n",
Matt Porter7ff71d62005-09-22 22:31:15 -0700634 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
Alan Stern2b70f072008-10-02 11:47:15 -0400635 temp >> 8, temp & 0xff,
David Brownell93f1a472006-11-16 23:34:58 -0800636 ignore_oc ? ", overcurrent ignored" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100638 ehci_writel(ehci, INTR_MASK,
639 &ehci->regs->intr_enable); /* Turn On Interrupts */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
David Brownell18807522005-11-23 15:45:37 -0800641 /* GRR this is run-once init(), being done every time the HC starts.
642 * So long as they're part of class devices, we can't do it init()
643 * since the class device isn't created that early.
644 */
645 create_debug_files(ehci);
Kirill Smelkov4c670452011-07-03 20:36:56 +0400646 create_sysfs_files(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
648 return 0;
649}
650
Alan Stern3e023202012-11-01 11:12:58 -0400651int ehci_setup(struct usb_hcd *hcd)
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200652{
653 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
654 int retval;
655
656 ehci->regs = (void __iomem *)ehci->caps +
657 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
658 dbg_hcs_params(ehci, "reset");
659 dbg_hcc_params(ehci, "reset");
660
661 /* cache this readonly data; minimize chip reads */
662 ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
663
664 ehci->sbrn = HCD_USB2;
665
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200666 /* data structure init */
667 retval = ehci_init(hcd);
668 if (retval)
669 return retval;
670
Alan Stern631fe9d2012-07-11 11:21:09 -0400671 retval = ehci_halt(ehci);
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200672 if (retval)
673 return retval;
674
675 ehci_reset(ehci);
676
677 return 0;
678}
Alan Stern3e023202012-11-01 11:12:58 -0400679EXPORT_SYMBOL_GPL(ehci_setup);
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681/*-------------------------------------------------------------------------*/
682
David Howells7d12e782006-10-05 14:55:46 +0100683static irqreturn_t ehci_irq (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684{
685 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
Alan Stern67b2e022008-11-12 17:04:53 -0500686 u32 status, masked_status, pcd_status = 0, cmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 int bh;
Stanislaw Gruszkaa1227f32014-02-19 10:29:01 +0100688 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
Stanislaw Gruszkaa1227f32014-02-19 10:29:01 +0100690 /*
691 * For threadirqs option we use spin_lock_irqsave() variant to prevent
692 * deadlock with ehci hrtimer callback, because hrtimer callbacks run
693 * in interrupt context even when threadirqs is specified. We can go
694 * back to spin_lock() variant when hrtimer callbacks become threaded.
695 */
696 spin_lock_irqsave(&ehci->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100698 status = ehci_readl(ehci, &ehci->regs->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699
700 /* e.g. cardbus physical eject */
701 if (status == ~(u32) 0) {
702 ehci_dbg (ehci, "device removed\n");
703 goto dead;
704 }
705
Alan Stern2fbe2bf2012-04-18 11:33:00 -0400706 /*
707 * We don't use STS_FLR, but some controllers don't like it to
708 * remain on, so mask it out along with the other status bits.
709 */
710 masked_status = status & (INTR_MASK | STS_FLR);
711
Alan Stern69fff592011-05-17 17:27:12 -0400712 /* Shared IRQ? */
Alan Sterne8799902011-08-18 16:31:30 -0400713 if (!masked_status || unlikely(ehci->rh_state == EHCI_RH_HALTED)) {
Stanislaw Gruszkaa1227f32014-02-19 10:29:01 +0100714 spin_unlock_irqrestore(&ehci->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 return IRQ_NONE;
716 }
717
718 /* clear (just) interrupts */
Alan Stern67b2e022008-11-12 17:04:53 -0500719 ehci_writel(ehci, masked_status, &ehci->regs->status);
David Brownelle82cc122008-03-07 13:49:42 -0800720 cmd = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 bh = 0;
722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 /* normal [4.15.1.2] or error [4.15.1.1] completion */
724 if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
725 if (likely ((status & STS_ERR) == 0))
726 COUNT (ehci->stats.normal);
727 else
728 COUNT (ehci->stats.error);
729 bh = 1;
730 }
731
732 /* complete the unlinking of some qh [4.15.2.3] */
733 if (status & STS_IAA) {
Alan Stern9d938742012-07-11 11:22:44 -0400734
735 /* Turn off the IAA watchdog */
736 ehci->enabled_hrtimer_events &= ~BIT(EHCI_HRTIMER_IAA_WATCHDOG);
737
738 /*
739 * Mild optimization: Allow another IAAD to reset the
740 * hrtimer, if one occurs before the next expiration.
741 * In theory we could always cancel the hrtimer, but
742 * tests show that about half the time it will be reset
743 * for some other event anyway.
744 */
745 if (ehci->next_hrtimer_event == EHCI_HRTIMER_IAA_WATCHDOG)
746 ++ehci->next_hrtimer_event;
747
David Brownelle82cc122008-03-07 13:49:42 -0800748 /* guard against (alleged) silicon errata */
Alan Stern6feff1b2012-04-17 15:23:25 -0400749 if (cmd & CMD_IAAD)
David Brownelle82cc122008-03-07 13:49:42 -0800750 ehci_dbg(ehci, "IAA with IAAD still set?\n");
Alan Stern214ac7a2013-03-22 13:31:58 -0400751 if (ehci->iaa_in_progress)
Alan Stern99ac5b12012-07-11 11:21:38 -0400752 COUNT(ehci->stats.iaa);
Alan Stern6402c792013-03-01 10:50:08 -0500753 end_unlink_async(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 }
755
756 /* remote wakeup [4.3.1] */
David Brownelld97cc2f2005-12-22 17:05:18 -0800757 if (status & STS_PCD) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 unsigned i = HCS_N_PORTS (ehci->hcs_params);
Alan Stern4dd405a2013-03-18 12:05:08 -0400759 u32 ppcd = ~0;
David Brownelld1b18422008-03-05 23:37:52 -0800760
761 /* kick root hub later */
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200762 pcd_status = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763
764 /* resume root hub? */
Alan Sterndc75ce92012-04-17 15:24:15 -0400765 if (ehci->rh_state == EHCI_RH_SUSPENDED)
Alan Stern8c033562006-11-09 14:42:16 -0500766 usb_hcd_resume_root_hub(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
Alek Du5a9cdf32010-06-04 15:47:56 +0800768 /* get per-port change detect bits */
769 if (ehci->has_ppcd)
770 ppcd = status >> 16;
771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 while (i--) {
Alek Du5a9cdf32010-06-04 15:47:56 +0800773 int pstatus;
774
775 /* leverage per-port change bits feature */
Alan Stern4dd405a2013-03-18 12:05:08 -0400776 if (!(ppcd & (1 << i)))
Alek Du5a9cdf32010-06-04 15:47:56 +0800777 continue;
778 pstatus = ehci_readl(ehci,
779 &ehci->regs->port_status[i]);
David Brownellb972b682006-06-30 02:34:42 -0700780
781 if (pstatus & PORT_OWNER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 continue;
Alan Sterneafe5b92008-10-06 11:25:53 -0400783 if (!(test_bit(i, &ehci->suspended_ports) &&
784 ((pstatus & PORT_RESUME) ||
785 !(pstatus & PORT_SUSPEND)) &&
786 (pstatus & PORT_PE) &&
787 ehci->reset_done[i] == 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 continue;
789
790 /* start 20 msec resume signaling from this port,
791 * and make khubd collect PORT_STAT_C_SUSPEND to
Alan Stern49d0f072010-01-08 11:18:38 -0500792 * stop that signaling. Use 5 ms extra for safety,
793 * like usb_port_resume() does.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 */
Alan Stern49d0f072010-01-08 11:18:38 -0500795 ehci->reset_done[i] = jiffies + msecs_to_jiffies(25);
Alan Sterna448e4d2012-04-03 15:24:30 -0400796 set_bit(i, &ehci->resuming_ports);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
Alan Sternf292e7f2013-01-25 17:09:49 -0500798 usb_hcd_start_port_resume(&hcd->self, i);
Alan Stern61e8b852007-04-09 11:52:31 -0400799 mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 }
801 }
802
803 /* PCI errors [4.15.2.4] */
804 if (unlikely ((status & STS_FATAL) != 0)) {
Alan Stern67b2e022008-11-12 17:04:53 -0500805 ehci_err(ehci, "fatal error\n");
Alan Sterneafe5b92008-10-06 11:25:53 -0400806 dbg_cmd(ehci, "fatal", cmd);
807 dbg_status(ehci, "fatal", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808dead:
Alan Stern69fff592011-05-17 17:27:12 -0400809 usb_hc_died(hcd);
Alan Sternbf6387b2012-07-11 11:22:31 -0400810
811 /* Don't let the controller do anything more */
Alan Stern43fe3a92012-07-11 11:23:16 -0400812 ehci->shutdown = true;
Alan Sternbf6387b2012-07-11 11:22:31 -0400813 ehci->rh_state = EHCI_RH_STOPPING;
814 ehci->command &= ~(CMD_RUN | CMD_ASE | CMD_PSE);
815 ehci_writel(ehci, ehci->command, &ehci->regs->command);
816 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
817 ehci_handle_controller_death(ehci);
818
819 /* Handle completions when the controller stops */
820 bh = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 }
822
823 if (bh)
David Howells7d12e782006-10-05 14:55:46 +0100824 ehci_work (ehci);
Stanislaw Gruszkaa1227f32014-02-19 10:29:01 +0100825 spin_unlock_irqrestore(&ehci->lock, flags);
David Brownelld1b18422008-03-05 23:37:52 -0800826 if (pcd_status)
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200827 usb_hcd_poll_rh_status(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 return IRQ_HANDLED;
829}
830
831/*-------------------------------------------------------------------------*/
832
833/*
834 * non-error returns are a promise to giveback() the urb later
835 * we drop ownership so next owner (or urb unlink) can get it
836 *
837 * urb + dev is in hcd.self.controller.urb_list
838 * we're queueing TDs onto software and hardware lists
839 *
840 * hcd-specific init for hcpriv hasn't been done yet
841 *
842 * NOTE: control, bulk, and interrupt share the same code to append TDs
843 * to a (possibly active) QH, and the same QH scanning code.
844 */
845static int ehci_urb_enqueue (
846 struct usb_hcd *hcd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 struct urb *urb,
Al Viro55016f12005-10-21 03:21:58 -0400848 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849) {
850 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
851 struct list_head qtd_list;
852
853 INIT_LIST_HEAD (&qtd_list);
854
855 switch (usb_pipetype (urb->pipe)) {
David Brownell25b70a82008-03-04 15:11:07 -0800856 case PIPE_CONTROL:
857 /* qh_completions() code doesn't handle all the fault cases
858 * in multi-TD control transfers. Even 1KB is rare anyway.
859 */
860 if (urb->transfer_buffer_length > (16 * 1024))
861 return -EMSGSIZE;
862 /* FALLTHROUGH */
863 /* case PIPE_BULK: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 default:
865 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
866 return -ENOMEM;
Alan Sterne9df41c2007-08-08 11:48:02 -0400867 return submit_async(ehci, urb, &qtd_list, mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
869 case PIPE_INTERRUPT:
870 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
871 return -ENOMEM;
Alan Sterne9df41c2007-08-08 11:48:02 -0400872 return intr_submit(ehci, urb, &qtd_list, mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
874 case PIPE_ISOCHRONOUS:
875 if (urb->dev->speed == USB_SPEED_HIGH)
876 return itd_submit (ehci, urb, mem_flags);
877 else
878 return sitd_submit (ehci, urb, mem_flags);
879 }
880}
881
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882/* remove from hardware lists
883 * completions normally happen asynchronously
884 */
885
Alan Sterne9df41c2007-08-08 11:48:02 -0400886static int ehci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887{
888 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
889 struct ehci_qh *qh;
890 unsigned long flags;
Alan Sterne9df41c2007-08-08 11:48:02 -0400891 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
893 spin_lock_irqsave (&ehci->lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400894 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
895 if (rc)
896 goto done;
897
Alan Stern7655e312013-03-22 13:31:29 -0400898 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
899 /*
900 * We don't expedite dequeue for isochronous URBs.
901 * Just wait until they complete normally or their
902 * time slot expires.
903 */
904 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 qh = (struct ehci_qh *) urb->hcpriv;
Alan Stern7bc782d2013-03-22 13:31:11 -0400906 qh->exception = 1;
Alan Stern07d29b62007-12-11 16:05:30 -0500907 switch (qh->qh_state) {
908 case QH_STATE_LINKED:
Alan Stern7655e312013-03-22 13:31:29 -0400909 if (usb_pipetype(urb->pipe) == PIPE_INTERRUPT)
910 start_unlink_intr(ehci, qh);
911 else
912 start_unlink_async(ehci, qh);
Alan Stern07d29b62007-12-11 16:05:30 -0500913 break;
Alan Stern7bc782d2013-03-22 13:31:11 -0400914 case QH_STATE_COMPLETING:
915 qh->dequeue_during_giveback = 1;
916 break;
Alan Stern07d29b62007-12-11 16:05:30 -0500917 case QH_STATE_UNLINK:
918 case QH_STATE_UNLINK_WAIT:
919 /* already started */
920 break;
921 case QH_STATE_IDLE:
Alan Stern7a0f0d92009-07-31 10:40:22 -0400922 /* QH might be waiting for a Clear-TT-Buffer */
923 qh_completions(ehci, qh);
Alan Stern07d29b62007-12-11 16:05:30 -0500924 break;
925 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 }
927done:
928 spin_unlock_irqrestore (&ehci->lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400929 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930}
931
932/*-------------------------------------------------------------------------*/
933
934// bulk qh holds the data toggle
935
936static void
937ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
938{
939 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
940 unsigned long flags;
Ming Lei35371e42013-07-03 22:53:09 +0800941 struct ehci_qh *qh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942
943 /* ASSERT: any requests/urbs are being unlinked */
944 /* ASSERT: nobody can be submitting urbs for this any more */
945
946rescan:
947 spin_lock_irqsave (&ehci->lock, flags);
948 qh = ep->hcpriv;
949 if (!qh)
950 goto done;
951
952 /* endpoints can be iso streams. for now, we don't
953 * accelerate iso completions ... so spin a while.
954 */
Clemens Ladisch1082f572010-03-01 17:18:56 +0100955 if (qh->hw == NULL) {
Alan Stern8c5bf7b2012-07-11 11:22:39 -0400956 struct ehci_iso_stream *stream = ep->hcpriv;
957
958 if (!list_empty(&stream->td_list))
959 goto idle_timeout;
960
961 /* BUG_ON(!list_empty(&stream->free_list)); */
Alan Sternd0ce5c62013-10-11 11:29:13 -0400962 reserve_release_iso_bandwidth(ehci, stream, -1);
Alan Stern8c5bf7b2012-07-11 11:22:39 -0400963 kfree(stream);
964 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 }
966
Alan Stern7bc782d2013-03-22 13:31:11 -0400967 qh->exception = 1;
Alan Sternc0c53db2012-07-11 11:21:48 -0400968 if (ehci->rh_state < EHCI_RH_RUNNING)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 qh->qh_state = QH_STATE_IDLE;
970 switch (qh->qh_state) {
971 case QH_STATE_LINKED:
Ming Lei35371e42013-07-03 22:53:09 +0800972 WARN_ON(!list_empty(&qh->qtd_list));
973 if (usb_endpoint_type(&ep->desc) != USB_ENDPOINT_XFER_INT)
Alan Stern3c273a02012-07-11 11:22:49 -0400974 start_unlink_async(ehci, qh);
Ming Lei35371e42013-07-03 22:53:09 +0800975 else
976 start_unlink_intr(ehci, qh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 /* FALL THROUGH */
Ming Lei35371e42013-07-03 22:53:09 +0800978 case QH_STATE_COMPLETING: /* already in unlinking */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 case QH_STATE_UNLINK: /* wait for hw to finish? */
Alan Stern07d29b62007-12-11 16:05:30 -0500980 case QH_STATE_UNLINK_WAIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981idle_timeout:
982 spin_unlock_irqrestore (&ehci->lock, flags);
Nishanth Aravamudan22c43862005-08-15 11:30:11 -0700983 schedule_timeout_uninterruptible(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 goto rescan;
985 case QH_STATE_IDLE: /* fully unlinked */
Alan Stern914b7012009-06-29 10:47:30 -0400986 if (qh->clearing_tt)
987 goto idle_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 if (list_empty (&qh->qtd_list)) {
Alan Sternd0ce5c62013-10-11 11:29:13 -0400989 if (qh->ps.bw_uperiod)
990 reserve_release_intr_bandwidth(ehci, qh, -1);
Alan Sternc83e1a92012-07-11 11:21:25 -0400991 qh_destroy(ehci, qh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 break;
993 }
994 /* else FALL THROUGH */
995 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 /* caller was supposed to have unlinked any requests;
997 * that's not our job. just leak this memory.
998 */
999 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1000 qh, ep->desc.bEndpointAddress, qh->qh_state,
1001 list_empty (&qh->qtd_list) ? "" : "(has tds)");
1002 break;
1003 }
Alan Stern8c5bf7b2012-07-11 11:22:39 -04001004 done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 ep->hcpriv = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 spin_unlock_irqrestore (&ehci->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007}
1008
Alan Sternb18ffd42009-05-27 18:21:56 -04001009static void
1010ehci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1011{
1012 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1013 struct ehci_qh *qh;
1014 int eptype = usb_endpoint_type(&ep->desc);
Alan Sterna455212d2009-06-11 14:56:22 -04001015 int epnum = usb_endpoint_num(&ep->desc);
1016 int is_out = usb_endpoint_dir_out(&ep->desc);
1017 unsigned long flags;
Alan Sternb18ffd42009-05-27 18:21:56 -04001018
1019 if (eptype != USB_ENDPOINT_XFER_BULK && eptype != USB_ENDPOINT_XFER_INT)
1020 return;
1021
Alan Sterna455212d2009-06-11 14:56:22 -04001022 spin_lock_irqsave(&ehci->lock, flags);
Alan Sternb18ffd42009-05-27 18:21:56 -04001023 qh = ep->hcpriv;
1024
1025 /* For Bulk and Interrupt endpoints we maintain the toggle state
1026 * in the hardware; the toggle bits in udev aren't used at all.
1027 * When an endpoint is reset by usb_clear_halt() we must reset
1028 * the toggle bit in the QH.
1029 */
1030 if (qh) {
1031 if (!list_empty(&qh->qtd_list)) {
1032 WARN_ONCE(1, "clear_halt for a busy endpoint\n");
Alan Stern7bc782d2013-03-22 13:31:11 -04001033 } else {
Alan Sterna455212d2009-06-11 14:56:22 -04001034 /* The toggle value in the QH can't be updated
1035 * while the QH is active. Unlink it now;
1036 * re-linking will call qh_refresh().
Alan Sternb18ffd42009-05-27 18:21:56 -04001037 */
Alan Sternffa02482013-10-11 11:29:03 -04001038 usb_settoggle(qh->ps.udev, epnum, is_out, 0);
Alan Stern7bc782d2013-03-22 13:31:11 -04001039 qh->exception = 1;
Alan Sterna448c9d2009-08-19 12:22:44 -04001040 if (eptype == USB_ENDPOINT_XFER_BULK)
Alan Stern3c273a02012-07-11 11:22:49 -04001041 start_unlink_async(ehci, qh);
Alan Sterna448c9d2009-08-19 12:22:44 -04001042 else
Alan Sterndf202252012-07-11 11:22:26 -04001043 start_unlink_intr(ehci, qh);
Alan Sternb18ffd42009-05-27 18:21:56 -04001044 }
1045 }
Alan Sterna455212d2009-06-11 14:56:22 -04001046 spin_unlock_irqrestore(&ehci->lock, flags);
Alan Sternb18ffd42009-05-27 18:21:56 -04001047}
1048
Matt Porter7ff71d62005-09-22 22:31:15 -07001049static int ehci_get_frame (struct usb_hcd *hcd)
1050{
1051 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
Alan Stern68aa95d2011-10-12 10:39:14 -04001052 return (ehci_read_frame_index(ehci) >> 3) % ehci->periodic_size;
Matt Porter7ff71d62005-09-22 22:31:15 -07001053}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054
1055/*-------------------------------------------------------------------------*/
Alan Sternc5cf9212012-06-28 11:19:02 -04001056
Alan Sternb35c5002013-10-11 22:16:21 -04001057/* Device addition and removal */
1058
1059static void ehci_remove_device(struct usb_hcd *hcd, struct usb_device *udev)
1060{
1061 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1062
1063 spin_lock_irq(&ehci->lock);
1064 drop_tt(udev);
1065 spin_unlock_irq(&ehci->lock);
1066}
1067
1068/*-------------------------------------------------------------------------*/
1069
Alan Sternc5cf9212012-06-28 11:19:02 -04001070#ifdef CONFIG_PM
1071
1072/* suspend/resume, section 4.3 */
1073
1074/* These routines handle the generic parts of controller suspend/resume */
1075
Alan Stern3e023202012-11-01 11:12:58 -04001076int ehci_suspend(struct usb_hcd *hcd, bool do_wakeup)
Alan Sternc5cf9212012-06-28 11:19:02 -04001077{
1078 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1079
1080 if (time_before(jiffies, ehci->next_statechange))
1081 msleep(10);
1082
1083 /*
1084 * Root hub was already suspended. Disable IRQ emission and
1085 * mark HW unaccessible. The PM and USB cores make sure that
1086 * the root hub is either suspended or stopped.
1087 */
1088 ehci_prepare_ports_for_controller_suspend(ehci, do_wakeup);
1089
1090 spin_lock_irq(&ehci->lock);
1091 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
1092 (void) ehci_readl(ehci, &ehci->regs->intr_enable);
1093
1094 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1095 spin_unlock_irq(&ehci->lock);
1096
Alan Sternb8efdaf2013-10-18 11:18:21 -04001097 synchronize_irq(hcd->irq);
1098
1099 /* Check for race with a wakeup request */
1100 if (do_wakeup && HCD_WAKEUP_PENDING(hcd)) {
1101 ehci_resume(hcd, false);
1102 return -EBUSY;
1103 }
1104
Alan Sternc5cf9212012-06-28 11:19:02 -04001105 return 0;
1106}
Alan Stern3e023202012-11-01 11:12:58 -04001107EXPORT_SYMBOL_GPL(ehci_suspend);
Alan Sternc5cf9212012-06-28 11:19:02 -04001108
1109/* Returns 0 if power was preserved, 1 if power was lost */
Alan Stern3e023202012-11-01 11:12:58 -04001110int ehci_resume(struct usb_hcd *hcd, bool hibernated)
Alan Sternc5cf9212012-06-28 11:19:02 -04001111{
1112 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1113
1114 if (time_before(jiffies, ehci->next_statechange))
1115 msleep(100);
1116
1117 /* Mark hardware accessible again as we are back to full power by now */
1118 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1119
Alan Stern43fe3a92012-07-11 11:23:16 -04001120 if (ehci->shutdown)
1121 return 0; /* Controller is dead */
1122
Alan Sternc5cf9212012-06-28 11:19:02 -04001123 /*
1124 * If CF is still set and we aren't resuming from hibernation
1125 * then we maintained suspend power.
1126 * Just undo the effect of ehci_suspend().
1127 */
1128 if (ehci_readl(ehci, &ehci->regs->configured_flag) == FLAG_CF &&
1129 !hibernated) {
1130 int mask = INTR_MASK;
1131
1132 ehci_prepare_ports_for_controller_resume(ehci);
Alan Stern43fe3a92012-07-11 11:23:16 -04001133
1134 spin_lock_irq(&ehci->lock);
1135 if (ehci->shutdown)
1136 goto skip;
1137
Alan Sternc5cf9212012-06-28 11:19:02 -04001138 if (!hcd->self.root_hub->do_remote_wakeup)
1139 mask &= ~STS_PCD;
1140 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
1141 ehci_readl(ehci, &ehci->regs->intr_enable);
Alan Stern43fe3a92012-07-11 11:23:16 -04001142 skip:
1143 spin_unlock_irq(&ehci->lock);
Alan Sternc5cf9212012-06-28 11:19:02 -04001144 return 0;
1145 }
1146
1147 /*
1148 * Else reset, to cope with power loss or resume from hibernation
1149 * having let the firmware kick in during reboot.
1150 */
1151 usb_root_hub_lost_power(hcd->self.root_hub);
1152 (void) ehci_halt(ehci);
1153 (void) ehci_reset(ehci);
1154
Alan Stern43fe3a92012-07-11 11:23:16 -04001155 spin_lock_irq(&ehci->lock);
1156 if (ehci->shutdown)
1157 goto skip;
1158
Alan Sternc5cf9212012-06-28 11:19:02 -04001159 ehci_writel(ehci, ehci->command, &ehci->regs->command);
1160 ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
1161 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1162
Alan Stern43fe3a92012-07-11 11:23:16 -04001163 ehci->rh_state = EHCI_RH_SUSPENDED;
1164 spin_unlock_irq(&ehci->lock);
1165
Alan Sternc5cf9212012-06-28 11:19:02 -04001166 return 1;
1167}
Alan Stern3e023202012-11-01 11:12:58 -04001168EXPORT_SYMBOL_GPL(ehci_resume);
Alan Sternc5cf9212012-06-28 11:19:02 -04001169
1170#endif
1171
1172/*-------------------------------------------------------------------------*/
1173
Alexander Shishkineb70e5a2012-05-11 17:25:54 +03001174/*
Alan Stern3e023202012-11-01 11:12:58 -04001175 * Generic structure: This gets copied for platform drivers so that
1176 * individual entries can be overridden as needed.
1177 */
1178
1179static const struct hc_driver ehci_hc_driver = {
1180 .description = hcd_name,
1181 .product_desc = "EHCI Host Controller",
1182 .hcd_priv_size = sizeof(struct ehci_hcd),
1183
1184 /*
1185 * generic hardware linkage
1186 */
1187 .irq = ehci_irq,
Greg Kroah-Hartmanc04ee4b2013-09-23 13:32:51 -07001188 .flags = HCD_MEMORY | HCD_USB2 | HCD_BH,
Alan Stern3e023202012-11-01 11:12:58 -04001189
1190 /*
1191 * basic lifecycle operations
1192 */
1193 .reset = ehci_setup,
1194 .start = ehci_run,
1195 .stop = ehci_stop,
1196 .shutdown = ehci_shutdown,
1197
1198 /*
1199 * managing i/o requests and associated device resources
1200 */
1201 .urb_enqueue = ehci_urb_enqueue,
1202 .urb_dequeue = ehci_urb_dequeue,
1203 .endpoint_disable = ehci_endpoint_disable,
1204 .endpoint_reset = ehci_endpoint_reset,
1205 .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
1206
1207 /*
1208 * scheduling support
1209 */
1210 .get_frame_number = ehci_get_frame,
1211
1212 /*
1213 * root hub support
1214 */
1215 .hub_status_data = ehci_hub_status_data,
1216 .hub_control = ehci_hub_control,
1217 .bus_suspend = ehci_bus_suspend,
1218 .bus_resume = ehci_bus_resume,
1219 .relinquish_port = ehci_relinquish_port,
1220 .port_handed_over = ehci_port_handed_over,
Alan Sternb35c5002013-10-11 22:16:21 -04001221
1222 /*
1223 * device support
1224 */
1225 .free_dev = ehci_remove_device,
Alan Stern3e023202012-11-01 11:12:58 -04001226};
1227
1228void ehci_init_driver(struct hc_driver *drv,
1229 const struct ehci_driver_overrides *over)
1230{
1231 /* Copy the generic table to drv and then apply the overrides */
1232 *drv = ehci_hc_driver;
1233
Alan Stern1b368102012-11-07 16:12:47 -05001234 if (over) {
1235 drv->hcd_priv_size += over->extra_priv_size;
1236 if (over->reset)
1237 drv->reset = over->reset;
1238 }
Alan Stern3e023202012-11-01 11:12:58 -04001239}
1240EXPORT_SYMBOL_GPL(ehci_init_driver);
1241
1242/*-------------------------------------------------------------------------*/
1243
Alan Stern2b70f072008-10-02 11:47:15 -04001244MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245MODULE_AUTHOR (DRIVER_AUTHOR);
1246MODULE_LICENSE ("GPL");
1247
Li Yangba029782007-05-11 17:09:55 +08001248#ifdef CONFIG_USB_EHCI_FSL
Randy Vinson80cb9ae2006-01-20 13:53:38 -08001249#include "ehci-fsl.c"
Kumar Gala01cced22006-04-11 10:07:16 -05001250#define PLATFORM_DRIVER ehci_fsl_driver
Randy Vinson80cb9ae2006-01-20 13:53:38 -08001251#endif
1252
Yoshihiro Shimoda60b0bf02011-03-01 16:58:37 +09001253#ifdef CONFIG_USB_EHCI_SH
Paul Mundt63c84552010-11-01 17:03:27 -04001254#include "ehci-sh.c"
1255#define PLATFORM_DRIVER ehci_hcd_sh_driver
1256#endif
1257
Geoff Levandad75a412007-01-15 20:11:47 -08001258#ifdef CONFIG_PPC_PS3
1259#include "ehci-ps3.c"
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001260#define PS3_SYSTEM_BUS_DRIVER ps3_ehci_driver
Geoff Levandad75a412007-01-15 20:11:47 -08001261#endif
1262
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001263#ifdef CONFIG_USB_EHCI_HCD_PPC_OF
1264#include "ehci-ppc-of.c"
1265#define OF_PLATFORM_DRIVER ehci_hcd_ppc_of_driver
1266#endif
1267
Julie Zhu08d3c182009-09-21 16:08:19 -06001268#ifdef CONFIG_XPS_USB_HCD_XILINX
1269#include "ehci-xilinx-of.c"
Grant Likely1f23b2d2010-06-02 13:53:17 -06001270#define XILINX_OF_PLATFORM_DRIVER ehci_hcd_xilinx_of_driver
Julie Zhu08d3c182009-09-21 16:08:19 -06001271#endif
1272
David Daney1643acc2010-10-08 14:47:52 -07001273#ifdef CONFIG_USB_OCTEON_EHCI
1274#include "ehci-octeon.c"
1275#define PLATFORM_DRIVER ehci_octeon_driver
1276#endif
1277
Chris Metcalf47fc28b2012-05-09 13:58:14 -04001278#ifdef CONFIG_TILE_USB
1279#include "ehci-tilegx.c"
1280#define PLATFORM_DRIVER ehci_hcd_tilegx_driver
1281#endif
1282
Anoop22ced6872011-02-24 19:26:28 +05301283#ifdef CONFIG_USB_EHCI_HCD_PMC_MSP
1284#include "ehci-pmcmsp.c"
1285#define PLATFORM_DRIVER ehci_hcd_msp_driver
1286#endif
1287
Jan Andersson9be03922011-05-03 20:11:58 +02001288#ifdef CONFIG_SPARC_LEON
1289#include "ehci-grlib.c"
1290#define PLATFORM_DRIVER ehci_grlib_driver
1291#endif
1292
Neil Zhang3a082ec2011-12-20 13:20:23 +08001293#ifdef CONFIG_USB_EHCI_MV
1294#include "ehci-mv.c"
1295#define PLATFORM_DRIVER ehci_mv_driver
1296#endif
1297
Steven J. Hillc2566672012-04-19 12:57:31 -05001298#ifdef CONFIG_MIPS_SEAD3
1299#include "ehci-sead3.c"
1300#define PLATFORM_DRIVER ehci_hcd_sead3_driver
1301#endif
1302
Kumar Gala01cced22006-04-11 10:07:16 -05001303static int __init ehci_hcd_init(void)
1304{
1305 int retval = 0;
1306
Alan Stern2b70f072008-10-02 11:47:15 -04001307 if (usb_disabled())
1308 return -ENODEV;
1309
1310 printk(KERN_INFO "%s: " DRIVER_DESC "\n", hcd_name);
Alan Stern9beeee62008-10-02 11:48:13 -04001311 set_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1312 if (test_bit(USB_UHCI_LOADED, &usb_hcds_loaded) ||
1313 test_bit(USB_OHCI_LOADED, &usb_hcds_loaded))
1314 printk(KERN_WARNING "Warning! ehci_hcd should always be loaded"
1315 " before uhci_hcd and ohci_hcd, not after\n");
1316
Kumar Gala01cced22006-04-11 10:07:16 -05001317 pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1318 hcd_name,
1319 sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
1320 sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
1321
Oliver Neukum1c201632013-11-18 13:23:16 +01001322#ifdef CONFIG_DYNAMIC_DEBUG
Greg Kroah-Hartman08f4e582009-04-24 15:13:18 -07001323 ehci_debug_root = debugfs_create_dir("ehci", usb_debug_root);
Alan Stern9beeee62008-10-02 11:48:13 -04001324 if (!ehci_debug_root) {
1325 retval = -ENOENT;
1326 goto err_debug;
1327 }
Tony Jones694cc202007-09-11 14:07:31 -07001328#endif
1329
Kumar Gala01cced22006-04-11 10:07:16 -05001330#ifdef PLATFORM_DRIVER
1331 retval = platform_driver_register(&PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001332 if (retval < 0)
1333 goto clean0;
Kumar Gala01cced22006-04-11 10:07:16 -05001334#endif
1335
Geoff Levandad75a412007-01-15 20:11:47 -08001336#ifdef PS3_SYSTEM_BUS_DRIVER
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001337 retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001338 if (retval < 0)
1339 goto clean2;
Kumar Gala01cced22006-04-11 10:07:16 -05001340#endif
1341
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001342#ifdef OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001343 retval = platform_driver_register(&OF_PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001344 if (retval < 0)
1345 goto clean3;
1346#endif
Grant Likely1f23b2d2010-06-02 13:53:17 -06001347
1348#ifdef XILINX_OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001349 retval = platform_driver_register(&XILINX_OF_PLATFORM_DRIVER);
Grant Likely1f23b2d2010-06-02 13:53:17 -06001350 if (retval < 0)
1351 goto clean4;
1352#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001353 return retval;
1354
Grant Likely1f23b2d2010-06-02 13:53:17 -06001355#ifdef XILINX_OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001356 /* platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER); */
Grant Likely1f23b2d2010-06-02 13:53:17 -06001357clean4:
1358#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001359#ifdef OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001360 platform_driver_unregister(&OF_PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001361clean3:
1362#endif
1363#ifdef PS3_SYSTEM_BUS_DRIVER
1364 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1365clean2:
1366#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001367#ifdef PLATFORM_DRIVER
1368 platform_driver_unregister(&PLATFORM_DRIVER);
1369clean0:
1370#endif
Oliver Neukum1c201632013-11-18 13:23:16 +01001371#ifdef CONFIG_DYNAMIC_DEBUG
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001372 debugfs_remove(ehci_debug_root);
1373 ehci_debug_root = NULL;
Alan Stern9beeee62008-10-02 11:48:13 -04001374err_debug:
Linus Torvaldsa9b61482008-10-20 14:23:29 -07001375#endif
Alan Stern9beeee62008-10-02 11:48:13 -04001376 clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
Kumar Gala01cced22006-04-11 10:07:16 -05001377 return retval;
1378}
1379module_init(ehci_hcd_init);
1380
1381static void __exit ehci_hcd_cleanup(void)
1382{
Grant Likely1f23b2d2010-06-02 13:53:17 -06001383#ifdef XILINX_OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001384 platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER);
Grant Likely1f23b2d2010-06-02 13:53:17 -06001385#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001386#ifdef OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001387 platform_driver_unregister(&OF_PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001388#endif
Kumar Gala01cced22006-04-11 10:07:16 -05001389#ifdef PLATFORM_DRIVER
1390 platform_driver_unregister(&PLATFORM_DRIVER);
1391#endif
Geoff Levandad75a412007-01-15 20:11:47 -08001392#ifdef PS3_SYSTEM_BUS_DRIVER
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001393 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
Geoff Levandad75a412007-01-15 20:11:47 -08001394#endif
Oliver Neukum1c201632013-11-18 13:23:16 +01001395#ifdef CONFIG_DYNAMIC_DEBUG
Tony Jones694cc202007-09-11 14:07:31 -07001396 debugfs_remove(ehci_debug_root);
1397#endif
Alan Stern9beeee62008-10-02 11:48:13 -04001398 clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
Kumar Gala01cced22006-04-11 10:07:16 -05001399}
1400module_exit(ehci_hcd_cleanup);