blob: 063064801ceb0e37a0f4a5b45101f02f7c1def83 [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 */
Geyslan G. Bem900937c2015-12-02 20:25:23 -0300101static bool ignore_oc;
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 */
Ramneek Mehresh74db22c2015-05-29 11:28:30 +0530242int ehci_reset(struct ehci_hcd *ehci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
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}
Ramneek Mehresh74db22c2015-05-29 11:28:30 +0530278EXPORT_SYMBOL_GPL(ehci_reset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
Alan Sternc4f34762012-07-11 11:23:10 -0400280/*
281 * Idle the controller (turn off the schedules).
282 * Must be called with interrupts enabled and the lock not held.
283 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284static void ehci_quiesce (struct ehci_hcd *ehci)
285{
286 u32 temp;
287
Alan Sterne8799902011-08-18 16:31:30 -0400288 if (ehci->rh_state != EHCI_RH_RUNNING)
Alan Sternc0c53db2012-07-11 11:21:48 -0400289 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
291 /* wait for any schedule enables/disables to take effect */
Alan Stern3d9545c2012-04-23 13:54:36 -0400292 temp = (ehci->command << 10) & (STS_ASS | STS_PSS);
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600293 ehci_handshake(ehci, &ehci->regs->status, STS_ASS | STS_PSS, temp,
294 16 * 125);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
296 /* then disable anything that's still active */
Alan Sternc4f34762012-07-11 11:23:10 -0400297 spin_lock_irq(&ehci->lock);
Alan Stern3d9545c2012-04-23 13:54:36 -0400298 ehci->command &= ~(CMD_ASE | CMD_PSE);
299 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Alan Sternc4f34762012-07-11 11:23:10 -0400300 spin_unlock_irq(&ehci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
302 /* hardware can take 16 microframes to turn off ... */
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600303 ehci_handshake(ehci, &ehci->regs->status, STS_ASS | STS_PSS, 0,
304 16 * 125);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305}
306
307/*-------------------------------------------------------------------------*/
308
Alan Sternf96fba02016-01-25 15:44:16 -0500309static void end_iaa_cycle(struct ehci_hcd *ehci);
Alan Stern07d29b62007-12-11 16:05:30 -0500310static void end_unlink_async(struct ehci_hcd *ehci);
Alan Stern32830f22012-07-11 11:22:53 -0400311static void unlink_empty_async(struct ehci_hcd *ehci);
David Howells7d12e782006-10-05 14:55:46 +0100312static void ehci_work(struct ehci_hcd *ehci);
Alan Sterndf202252012-07-11 11:22:26 -0400313static void start_unlink_intr(struct ehci_hcd *ehci, struct ehci_qh *qh);
314static void end_unlink_intr(struct ehci_hcd *ehci, struct ehci_qh *qh);
Michael Grzeschik11a7e592014-10-13 09:53:03 +0800315static int ehci_port_power(struct ehci_hcd *ehci, int portnum, bool enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Alan Sternd58b4bc2012-07-11 11:21:54 -0400317#include "ehci-timer.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318#include "ehci-hub.c"
319#include "ehci-mem.c"
320#include "ehci-q.c"
321#include "ehci-sched.c"
Kirill Smelkov4c670452011-07-03 20:36:56 +0400322#include "ehci-sysfs.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
324/*-------------------------------------------------------------------------*/
325
Alan Stern89037952007-02-13 14:55:27 -0500326/* On some systems, leaving remote wakeup enabled prevents system shutdown.
327 * The firmware seems to think that powering off is a wakeup event!
328 * This routine turns off remote wakeup and everything else, on all ports.
329 */
330static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
331{
332 int port = HCS_N_PORTS(ehci->hcs_params);
333
Michael Grzeschik11a7e592014-10-13 09:53:03 +0800334 while (port--) {
Michael Grzeschik11a7e592014-10-13 09:53:03 +0800335 spin_unlock_irq(&ehci->lock);
336 ehci_port_power(ehci, port, false);
337 spin_lock_irq(&ehci->lock);
Marc Ohlfbc337b52016-08-03 11:51:54 +0200338 ehci_writel(ehci, PORT_RWC_BITS,
339 &ehci->regs->port_status[port]);
Michael Grzeschik11a7e592014-10-13 09:53:03 +0800340 }
Alan Stern89037952007-02-13 14:55:27 -0500341}
342
Sarah Sharp21da84a2008-04-08 14:30:18 -0700343/*
344 * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
Alan Sternc4f34762012-07-11 11:23:10 -0400345 * Must be called with interrupts enabled and the lock not held.
David Brownell72f30b62005-09-27 10:19:39 -0700346 */
Sarah Sharp21da84a2008-04-08 14:30:18 -0700347static void ehci_silence_controller(struct ehci_hcd *ehci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348{
Sarah Sharp21da84a2008-04-08 14:30:18 -0700349 ehci_halt(ehci);
Alan Sternc4f34762012-07-11 11:23:10 -0400350
351 spin_lock_irq(&ehci->lock);
352 ehci->rh_state = EHCI_RH_HALTED;
Alan Stern89037952007-02-13 14:55:27 -0500353 ehci_turn_off_all_ports(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355 /* make BIOS/etc use companion controller during reboot */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100356 ehci_writel(ehci, 0, &ehci->regs->configured_flag);
Alan Stern89037952007-02-13 14:55:27 -0500357
358 /* unblock posted writes */
359 ehci_readl(ehci, &ehci->regs->configured_flag);
Alan Sternc4f34762012-07-11 11:23:10 -0400360 spin_unlock_irq(&ehci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361}
362
Sarah Sharp21da84a2008-04-08 14:30:18 -0700363/* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
364 * This forcibly disables dma and IRQs, helping kexec and other cases
365 * where the next system software may expect clean state.
366 */
367static void ehci_shutdown(struct usb_hcd *hcd)
368{
369 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
370
Srinivas Kandagatla11c011a2016-05-19 11:12:56 +0100371 /**
372 * Protect the system from crashing at system shutdown in cases where
373 * usb host is not added yet from OTG controller driver.
374 * As ehci_setup() not done yet, so stop accessing registers or
375 * variables initialized in ehci_setup()
376 */
377 if (!ehci->sbrn)
378 return;
379
Sarah Sharp21da84a2008-04-08 14:30:18 -0700380 spin_lock_irq(&ehci->lock);
Alan Stern43fe3a92012-07-11 11:23:16 -0400381 ehci->shutdown = true;
Alan Sternc0c53db2012-07-11 11:21:48 -0400382 ehci->rh_state = EHCI_RH_STOPPING;
Alan Sternd58b4bc2012-07-11 11:21:54 -0400383 ehci->enabled_hrtimer_events = 0;
Sarah Sharp21da84a2008-04-08 14:30:18 -0700384 spin_unlock_irq(&ehci->lock);
Alan Sternd58b4bc2012-07-11 11:21:54 -0400385
Alan Sternc4f34762012-07-11 11:23:10 -0400386 ehci_silence_controller(ehci);
387
Alan Sternd58b4bc2012-07-11 11:21:54 -0400388 hrtimer_cancel(&ehci->hrtimer);
Sarah Sharp21da84a2008-04-08 14:30:18 -0700389}
390
Matt Porter7ff71d62005-09-22 22:31:15 -0700391/*-------------------------------------------------------------------------*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Matt Porter7ff71d62005-09-22 22:31:15 -0700393/*
394 * ehci_work is called from some interrupts, timers, and so on.
395 * it calls driver completion functions, after dropping ehci->lock.
396 */
David Howells7d12e782006-10-05 14:55:46 +0100397static void ehci_work (struct ehci_hcd *ehci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
Matt Porter7ff71d62005-09-22 22:31:15 -0700399 /* another CPU may drop ehci->lock during a schedule scan while
400 * it reports urb completions. this flag guards against bogus
401 * attempts at re-entrant schedule scanning.
402 */
Alan Stern361aabf2012-07-11 11:22:57 -0400403 if (ehci->scanning) {
404 ehci->need_rescan = true;
Matt Porter7ff71d62005-09-22 22:31:15 -0700405 return;
Alan Stern361aabf2012-07-11 11:22:57 -0400406 }
407 ehci->scanning = true;
408
409 rescan:
410 ehci->need_rescan = false;
Alan Stern31446612012-07-11 11:22:21 -0400411 if (ehci->async_count)
412 scan_async(ehci);
Alan Stern569b3942012-07-11 11:23:00 -0400413 if (ehci->intr_count > 0)
414 scan_intr(ehci);
415 if (ehci->isoc_count > 0)
416 scan_isoc(ehci);
Alan Stern361aabf2012-07-11 11:22:57 -0400417 if (ehci->need_rescan)
418 goto rescan;
419 ehci->scanning = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
Matt Porter7ff71d62005-09-22 22:31:15 -0700421 /* the IO watchdog guards against hardware or driver bugs that
422 * misplace IRQs, and should let us run completely without IRQs.
423 * such lossage has been observed on both VT6202 and VT8235.
424 */
Alan Stern18aafe62012-07-11 11:23:04 -0400425 turn_on_io_watchdog(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426}
427
Sarah Sharp21da84a2008-04-08 14:30:18 -0700428/*
429 * Called when the ehci_hcd module is removed.
430 */
Matt Porter7ff71d62005-09-22 22:31:15 -0700431static void ehci_stop (struct usb_hcd *hcd)
432{
433 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
434
435 ehci_dbg (ehci, "stop\n");
436
Matt Porter7ff71d62005-09-22 22:31:15 -0700437 /* no more interrupts ... */
Matt Porter7ff71d62005-09-22 22:31:15 -0700438
439 spin_lock_irq(&ehci->lock);
Alan Sternd58b4bc2012-07-11 11:21:54 -0400440 ehci->enabled_hrtimer_events = 0;
Matt Porter7ff71d62005-09-22 22:31:15 -0700441 spin_unlock_irq(&ehci->lock);
442
Alan Sternc4f34762012-07-11 11:23:10 -0400443 ehci_quiesce(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700444 ehci_silence_controller(ehci);
445 ehci_reset (ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700446
Alan Sternd58b4bc2012-07-11 11:21:54 -0400447 hrtimer_cancel(&ehci->hrtimer);
Kirill Smelkov4c670452011-07-03 20:36:56 +0400448 remove_sysfs_files(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700449 remove_debug_files (ehci);
450
451 /* root hub is shut down separately (first, when possible) */
452 spin_lock_irq (&ehci->lock);
Alan Stern55934eb2012-07-11 11:22:35 -0400453 end_free_itds(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700454 spin_unlock_irq (&ehci->lock);
455 ehci_mem_cleanup (ehci);
456
Andiry Xuad935622011-03-01 14:57:05 +0800457 if (ehci->amd_pll_fix == 1)
458 usb_amd_dev_put();
Alex He05570292010-12-07 10:10:08 +0800459
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100460 dbg_status (ehci, "ehci_stop completed",
461 ehci_readl(ehci, &ehci->regs->status));
Matt Porter7ff71d62005-09-22 22:31:15 -0700462}
463
David Brownell18807522005-11-23 15:45:37 -0800464/* one-time init, only for memory state */
465static int ehci_init(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466{
David Brownell18807522005-11-23 15:45:37 -0800467 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 u32 temp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 int retval;
470 u32 hcc_params;
Alek Du3807e262009-07-14 07:23:29 +0800471 struct ehci_qh_hw *hw;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
David Brownell18807522005-11-23 15:45:37 -0800473 spin_lock_init(&ehci->lock);
474
Alek Du403dbd32009-07-13 17:30:41 +0800475 /*
476 * keep io watchdog by default, those good HCDs could turn off it later
477 */
478 ehci->need_io_watchdog = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
Alan Sternd58b4bc2012-07-11 11:21:54 -0400480 hrtimer_init(&ehci->hrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
481 ehci->hrtimer.function = ehci_hrtimer_func;
482 ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
Alan Stern07d29b62007-12-11 16:05:30 -0500483
Alan Sternf75593c2011-01-06 10:17:09 -0500484 hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 /*
Kirill Smelkovcc62a7e2011-07-03 20:36:57 +0400487 * by default set standard 80% (== 100 usec/uframe) max periodic
488 * bandwidth as required by USB 2.0
489 */
490 ehci->uframe_periodic_max = 100;
491
492 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 * hw default: 1K periodic list heads, one per frame.
494 * periodic_size can shrink by USBCMD update if hcc_params allows.
495 */
496 ehci->periodic_size = DEFAULT_I_TDPS;
Alan Stern6e018752013-03-22 13:31:45 -0400497 INIT_LIST_HEAD(&ehci->async_unlink);
Alan Stern214ac7a2013-03-22 13:31:58 -0400498 INIT_LIST_HEAD(&ehci->async_idle);
Ming Lei9118f9e2013-07-03 22:53:10 +0800499 INIT_LIST_HEAD(&ehci->intr_unlink_wait);
Alan Stern6e018752013-03-22 13:31:45 -0400500 INIT_LIST_HEAD(&ehci->intr_unlink);
Alan Stern569b3942012-07-11 11:23:00 -0400501 INIT_LIST_HEAD(&ehci->intr_qh_list);
Karsten Wiese9aa09d22009-02-08 16:07:58 -0800502 INIT_LIST_HEAD(&ehci->cached_itd_list);
Alan Stern0e5f2312010-04-08 16:56:37 -0400503 INIT_LIST_HEAD(&ehci->cached_sitd_list);
Alan Sternb35c5002013-10-11 22:16:21 -0400504 INIT_LIST_HEAD(&ehci->tt_list);
Alan Sternf75593c2011-01-06 10:17:09 -0500505
Greg Kroah-Hartman8e192912012-05-21 08:54:43 -0700506 if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
Alan Sternf75593c2011-01-06 10:17:09 -0500507 /* periodic schedule size can be smaller than default */
508 switch (EHCI_TUNE_FLS) {
509 case 0: ehci->periodic_size = 1024; break;
510 case 1: ehci->periodic_size = 512; break;
511 case 2: ehci->periodic_size = 256; break;
512 default: BUG();
513 }
514 }
David Brownell18807522005-11-23 15:45:37 -0800515 if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 return retval;
517
518 /* controllers may cache some of the periodic schedule ... */
David Brownell53bd6a62006-08-30 14:50:06 -0700519 if (HCC_ISOC_CACHE(hcc_params)) // full frame cache
Alan Stern98cae422012-09-28 16:01:34 -0400520 ehci->i_thresh = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 else // N microframes cached
David Brownell18807522005-11-23 15:45:37 -0800522 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 /*
525 * dedicate a qh for the async ring head, since we couldn't unlink
526 * a 'real' qh without stopping the async schedule [4.8]. use it
527 * as the 'reclamation list head' too.
528 * its dummy is used in hw_alt_next of many tds, to prevent the qh
529 * from automatically advancing to the next td after short reads.
530 */
David Brownell18807522005-11-23 15:45:37 -0800531 ehci->async->qh_next.qh = NULL;
Alek Du3807e262009-07-14 07:23:29 +0800532 hw = ehci->async->hw;
533 hw->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
534 hw->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
Ricardo Martins4f7a67e2012-05-22 18:02:03 +0100535#if defined(CONFIG_PPC_PS3)
Alan Stern4c53de72012-07-11 11:21:32 -0400536 hw->hw_info1 |= cpu_to_hc32(ehci, QH_INACTIVATE);
Ricardo Martins4f7a67e2012-05-22 18:02:03 +0100537#endif
Alek Du3807e262009-07-14 07:23:29 +0800538 hw->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
539 hw->hw_qtd_next = EHCI_LIST_END(ehci);
David Brownell18807522005-11-23 15:45:37 -0800540 ehci->async->qh_state = QH_STATE_LINKED;
Alek Du3807e262009-07-14 07:23:29 +0800541 hw->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
543 /* clear interrupt enables, set irq latency */
544 if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
545 log2_irq_thresh = 0;
546 temp = 1 << (16 + log2_irq_thresh);
Alek Du5a9cdf32010-06-04 15:47:56 +0800547 if (HCC_PER_PORT_CHANGE_EVENT(hcc_params)) {
548 ehci->has_ppcd = 1;
549 ehci_dbg(ehci, "enable per-port change event\n");
550 temp |= CMD_PPCEE;
551 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 if (HCC_CANPARK(hcc_params)) {
553 /* HW default park == 3, on hardware that supports it (like
554 * NVidia and ALI silicon), maximizes throughput on the async
555 * schedule by avoiding QH fetches between transfers.
556 *
557 * With fast usb storage devices and NForce2, "park" seems to
558 * make problems: throughput reduction (!), data errors...
559 */
560 if (park) {
David Brownell18807522005-11-23 15:45:37 -0800561 park = min(park, (unsigned) 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 temp |= CMD_PARK;
563 temp |= park << 8;
564 }
David Brownell18807522005-11-23 15:45:37 -0800565 ehci_dbg(ehci, "park %d\n", park);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 }
David Brownell18807522005-11-23 15:45:37 -0800567 if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 /* periodic schedule size can be smaller than default */
569 temp &= ~(3 << 2);
570 temp |= (EHCI_TUNE_FLS << 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 }
David Brownell18807522005-11-23 15:45:37 -0800572 ehci->command = temp;
573
Alan Stern40f8db82009-11-06 12:29:40 -0500574 /* Accept arbitrarily long scatter-gather lists */
Andrea Righi4307a282010-06-28 16:56:45 +0200575 if (!(hcd->driver->flags & HCD_LOCAL_MEM))
576 hcd->self.sg_tablesize = ~0;
Alan Stern87d61912016-01-25 15:45:25 -0500577
578 /* Prepare for unlinking active QHs */
579 ehci->old_current = ~0;
David Brownell18807522005-11-23 15:45:37 -0800580 return 0;
581}
582
583/* start HC running; it's halted, ehci_init() has been run (once) */
584static int ehci_run (struct usb_hcd *hcd)
585{
586 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
David Brownell18807522005-11-23 15:45:37 -0800587 u32 temp;
588 u32 hcc_params;
589
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200590 hcd->uses_new_polling = 1;
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200591
David Brownell18807522005-11-23 15:45:37 -0800592 /* EHCI spec section 4.1 */
Geoff Levand876e0df2011-11-22 18:04:45 -0800593
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100594 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
595 ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
David Brownell18807522005-11-23 15:45:37 -0800596
597 /*
598 * hcc_params controls whether ehci->regs->segment must (!!!)
599 * be used; it constrains QH/ITD/SITD and QTD locations.
600 * pci_pool consistent memory always uses segment zero.
601 * streaming mappings for I/O buffers, like pci_map_single(),
602 * can return segments above 4GB, if the device allows.
603 *
Christoph Hellwig0e77ace2015-11-09 14:58:18 -0800604 * NOTE: the dma mask is visible through dev->dma_mask, so
David Brownell18807522005-11-23 15:45:37 -0800605 * drivers can pass this info along ... like NETIF_F_HIGHDMA,
606 * Scsi_Host.highmem_io, and so forth. It's readonly to all
607 * host side drivers though.
608 */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100609 hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
David Brownell18807522005-11-23 15:45:37 -0800610 if (HCC_64BIT_ADDR(hcc_params)) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100611 ehci_writel(ehci, 0, &ehci->regs->segment);
David Brownell18807522005-11-23 15:45:37 -0800612#if 0
613// this is deeply broken on almost all architectures
Yang Hongyang6a355282009-04-06 19:01:13 -0700614 if (!dma_set_mask(hcd->self.controller, DMA_BIT_MASK(64)))
David Brownell18807522005-11-23 15:45:37 -0800615 ehci_info(ehci, "enabled 64bit DMA\n");
616#endif
617 }
618
619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 // Philips, Intel, and maybe others need CMD_RUN before the
621 // root hub will detect new devices (why?); NEC doesn't
David Brownell18807522005-11-23 15:45:37 -0800622 ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
623 ehci->command |= CMD_RUN;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100624 ehci_writel(ehci, ehci->command, &ehci->regs->command);
David Brownell18807522005-11-23 15:45:37 -0800625 dbg_cmd (ehci, "init", ehci->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 /*
628 * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
629 * are explicitly handed to companion controller(s), so no TT is
630 * involved with the root hub. (Except where one is integrated,
631 * and there's no companion controller unless maybe for USB OTG.)
Alan Stern32fe0192007-10-10 16:27:07 -0400632 *
633 * Turning on the CF flag will transfer ownership of all ports
634 * from the companions to the EHCI controller. If any of the
635 * companions are in the middle of a port reset at the time, it
636 * could cause trouble. Write-locking ehci_cf_port_reset_rwsem
David Brownell1cb52652007-11-13 16:22:30 -0800637 * guarantees that no resets are in progress. After we set CF,
638 * a short delay lets the hardware catch up; new resets shouldn't
639 * be started before the port switching actions could complete.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 */
Alan Stern32fe0192007-10-10 16:27:07 -0400641 down_write(&ehci_cf_port_reset_rwsem);
Alan Sterne8799902011-08-18 16:31:30 -0400642 ehci->rh_state = EHCI_RH_RUNNING;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100643 ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
644 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
David Brownell1cb52652007-11-13 16:22:30 -0800645 msleep(5);
Alan Stern32fe0192007-10-10 16:27:07 -0400646 up_write(&ehci_cf_port_reset_rwsem);
Oliver Neukumee4ecb82009-11-27 15:17:59 +0100647 ehci->last_periodic_enable = ktime_get_real();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Jan Anderssonc4301312011-05-03 20:11:57 +0200649 temp = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 ehci_info (ehci,
Alan Stern2b70f072008-10-02 11:47:15 -0400651 "USB %x.%x started, EHCI %x.%02x%s\n",
Matt Porter7ff71d62005-09-22 22:31:15 -0700652 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
Alan Stern2b70f072008-10-02 11:47:15 -0400653 temp >> 8, temp & 0xff,
David Brownell93f1a472006-11-16 23:34:58 -0800654 ignore_oc ? ", overcurrent ignored" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100656 ehci_writel(ehci, INTR_MASK,
657 &ehci->regs->intr_enable); /* Turn On Interrupts */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
David Brownell18807522005-11-23 15:45:37 -0800659 /* GRR this is run-once init(), being done every time the HC starts.
660 * So long as they're part of class devices, we can't do it init()
661 * since the class device isn't created that early.
662 */
663 create_debug_files(ehci);
Kirill Smelkov4c670452011-07-03 20:36:56 +0400664 create_sysfs_files(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
666 return 0;
667}
668
Alan Stern3e023202012-11-01 11:12:58 -0400669int ehci_setup(struct usb_hcd *hcd)
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200670{
671 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
672 int retval;
673
674 ehci->regs = (void __iomem *)ehci->caps +
675 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
676 dbg_hcs_params(ehci, "reset");
677 dbg_hcc_params(ehci, "reset");
678
679 /* cache this readonly data; minimize chip reads */
680 ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
681
682 ehci->sbrn = HCD_USB2;
683
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200684 /* data structure init */
685 retval = ehci_init(hcd);
686 if (retval)
687 return retval;
688
Alan Stern631fe9d2012-07-11 11:21:09 -0400689 retval = ehci_halt(ehci);
Jia-Ju Baid8ff4632016-01-04 16:14:43 +0800690 if (retval) {
691 ehci_mem_cleanup(ehci);
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200692 return retval;
Jia-Ju Baid8ff4632016-01-04 16:14:43 +0800693 }
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200694
695 ehci_reset(ehci);
696
697 return 0;
698}
Alan Stern3e023202012-11-01 11:12:58 -0400699EXPORT_SYMBOL_GPL(ehci_setup);
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200700
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701/*-------------------------------------------------------------------------*/
702
David Howells7d12e782006-10-05 14:55:46 +0100703static irqreturn_t ehci_irq (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
705 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
Alan Stern67b2e022008-11-12 17:04:53 -0500706 u32 status, masked_status, pcd_status = 0, cmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 int bh;
Stanislaw Gruszkaa1227f32014-02-19 10:29:01 +0100708 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
Stanislaw Gruszkaa1227f32014-02-19 10:29:01 +0100710 /*
711 * For threadirqs option we use spin_lock_irqsave() variant to prevent
712 * deadlock with ehci hrtimer callback, because hrtimer callbacks run
713 * in interrupt context even when threadirqs is specified. We can go
714 * back to spin_lock() variant when hrtimer callbacks become threaded.
715 */
716 spin_lock_irqsave(&ehci->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100718 status = ehci_readl(ehci, &ehci->regs->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
720 /* e.g. cardbus physical eject */
721 if (status == ~(u32) 0) {
722 ehci_dbg (ehci, "device removed\n");
723 goto dead;
724 }
725
Alan Stern2fbe2bf2012-04-18 11:33:00 -0400726 /*
727 * We don't use STS_FLR, but some controllers don't like it to
728 * remain on, so mask it out along with the other status bits.
729 */
730 masked_status = status & (INTR_MASK | STS_FLR);
731
Alan Stern69fff592011-05-17 17:27:12 -0400732 /* Shared IRQ? */
Alan Sterne8799902011-08-18 16:31:30 -0400733 if (!masked_status || unlikely(ehci->rh_state == EHCI_RH_HALTED)) {
Stanislaw Gruszkaa1227f32014-02-19 10:29:01 +0100734 spin_unlock_irqrestore(&ehci->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 return IRQ_NONE;
736 }
737
738 /* clear (just) interrupts */
Alan Stern67b2e022008-11-12 17:04:53 -0500739 ehci_writel(ehci, masked_status, &ehci->regs->status);
David Brownelle82cc122008-03-07 13:49:42 -0800740 cmd = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 bh = 0;
742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 /* normal [4.15.1.2] or error [4.15.1.1] completion */
744 if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
745 if (likely ((status & STS_ERR) == 0))
746 COUNT (ehci->stats.normal);
747 else
748 COUNT (ehci->stats.error);
749 bh = 1;
750 }
751
752 /* complete the unlinking of some qh [4.15.2.3] */
753 if (status & STS_IAA) {
Alan Stern9d938742012-07-11 11:22:44 -0400754
755 /* Turn off the IAA watchdog */
756 ehci->enabled_hrtimer_events &= ~BIT(EHCI_HRTIMER_IAA_WATCHDOG);
757
758 /*
759 * Mild optimization: Allow another IAAD to reset the
760 * hrtimer, if one occurs before the next expiration.
761 * In theory we could always cancel the hrtimer, but
762 * tests show that about half the time it will be reset
763 * for some other event anyway.
764 */
765 if (ehci->next_hrtimer_event == EHCI_HRTIMER_IAA_WATCHDOG)
766 ++ehci->next_hrtimer_event;
767
David Brownelle82cc122008-03-07 13:49:42 -0800768 /* guard against (alleged) silicon errata */
Alan Stern6feff1b2012-04-17 15:23:25 -0400769 if (cmd & CMD_IAAD)
David Brownelle82cc122008-03-07 13:49:42 -0800770 ehci_dbg(ehci, "IAA with IAAD still set?\n");
Alan Stern214ac7a2013-03-22 13:31:58 -0400771 if (ehci->iaa_in_progress)
Alan Stern99ac5b12012-07-11 11:21:38 -0400772 COUNT(ehci->stats.iaa);
Alan Sternf96fba02016-01-25 15:44:16 -0500773 end_iaa_cycle(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 }
775
776 /* remote wakeup [4.3.1] */
David Brownelld97cc2f2005-12-22 17:05:18 -0800777 if (status & STS_PCD) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 unsigned i = HCS_N_PORTS (ehci->hcs_params);
Alan Stern4dd405a2013-03-18 12:05:08 -0400779 u32 ppcd = ~0;
David Brownelld1b18422008-03-05 23:37:52 -0800780
781 /* kick root hub later */
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200782 pcd_status = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
784 /* resume root hub? */
Alan Sterndc75ce92012-04-17 15:24:15 -0400785 if (ehci->rh_state == EHCI_RH_SUSPENDED)
Alan Stern8c033562006-11-09 14:42:16 -0500786 usb_hcd_resume_root_hub(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
Alek Du5a9cdf32010-06-04 15:47:56 +0800788 /* get per-port change detect bits */
789 if (ehci->has_ppcd)
790 ppcd = status >> 16;
791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 while (i--) {
Alek Du5a9cdf32010-06-04 15:47:56 +0800793 int pstatus;
794
795 /* leverage per-port change bits feature */
Alan Stern4dd405a2013-03-18 12:05:08 -0400796 if (!(ppcd & (1 << i)))
Alek Du5a9cdf32010-06-04 15:47:56 +0800797 continue;
798 pstatus = ehci_readl(ehci,
799 &ehci->regs->port_status[i]);
David Brownellb972b682006-06-30 02:34:42 -0700800
801 if (pstatus & PORT_OWNER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 continue;
Alan Sterneafe5b92008-10-06 11:25:53 -0400803 if (!(test_bit(i, &ehci->suspended_ports) &&
804 ((pstatus & PORT_RESUME) ||
805 !(pstatus & PORT_SUSPEND)) &&
806 (pstatus & PORT_PE) &&
807 ehci->reset_done[i] == 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 continue;
809
Felipe Balbiea163282015-02-13 14:42:25 -0600810 /* start USB_RESUME_TIMEOUT msec resume signaling from
811 * this port, and make hub_wq collect
812 * PORT_STAT_C_SUSPEND to stop that signaling.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 */
Felipe Balbiea163282015-02-13 14:42:25 -0600814 ehci->reset_done[i] = jiffies +
815 msecs_to_jiffies(USB_RESUME_TIMEOUT);
Alan Sterna448e4d2012-04-03 15:24:30 -0400816 set_bit(i, &ehci->resuming_ports);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
Alan Sternf292e7f2013-01-25 17:09:49 -0500818 usb_hcd_start_port_resume(&hcd->self, i);
Alan Stern61e8b852007-04-09 11:52:31 -0400819 mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 }
821 }
822
823 /* PCI errors [4.15.2.4] */
824 if (unlikely ((status & STS_FATAL) != 0)) {
Alan Stern67b2e022008-11-12 17:04:53 -0500825 ehci_err(ehci, "fatal error\n");
Alan Sterneafe5b92008-10-06 11:25:53 -0400826 dbg_cmd(ehci, "fatal", cmd);
827 dbg_status(ehci, "fatal", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828dead:
Alan Stern69fff592011-05-17 17:27:12 -0400829 usb_hc_died(hcd);
Alan Sternbf6387b2012-07-11 11:22:31 -0400830
831 /* Don't let the controller do anything more */
Alan Stern43fe3a92012-07-11 11:23:16 -0400832 ehci->shutdown = true;
Alan Sternbf6387b2012-07-11 11:22:31 -0400833 ehci->rh_state = EHCI_RH_STOPPING;
834 ehci->command &= ~(CMD_RUN | CMD_ASE | CMD_PSE);
835 ehci_writel(ehci, ehci->command, &ehci->regs->command);
836 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
837 ehci_handle_controller_death(ehci);
838
839 /* Handle completions when the controller stops */
840 bh = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 }
842
843 if (bh)
David Howells7d12e782006-10-05 14:55:46 +0100844 ehci_work (ehci);
Stanislaw Gruszkaa1227f32014-02-19 10:29:01 +0100845 spin_unlock_irqrestore(&ehci->lock, flags);
David Brownelld1b18422008-03-05 23:37:52 -0800846 if (pcd_status)
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200847 usb_hcd_poll_rh_status(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 return IRQ_HANDLED;
849}
850
851/*-------------------------------------------------------------------------*/
852
853/*
854 * non-error returns are a promise to giveback() the urb later
855 * we drop ownership so next owner (or urb unlink) can get it
856 *
857 * urb + dev is in hcd.self.controller.urb_list
858 * we're queueing TDs onto software and hardware lists
859 *
860 * hcd-specific init for hcpriv hasn't been done yet
861 *
862 * NOTE: control, bulk, and interrupt share the same code to append TDs
863 * to a (possibly active) QH, and the same QH scanning code.
864 */
865static int ehci_urb_enqueue (
866 struct usb_hcd *hcd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 struct urb *urb,
Al Viro55016f12005-10-21 03:21:58 -0400868 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869) {
870 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
871 struct list_head qtd_list;
872
873 INIT_LIST_HEAD (&qtd_list);
874
875 switch (usb_pipetype (urb->pipe)) {
David Brownell25b70a82008-03-04 15:11:07 -0800876 case PIPE_CONTROL:
877 /* qh_completions() code doesn't handle all the fault cases
878 * in multi-TD control transfers. Even 1KB is rare anyway.
879 */
880 if (urb->transfer_buffer_length > (16 * 1024))
881 return -EMSGSIZE;
882 /* FALLTHROUGH */
883 /* case PIPE_BULK: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 default:
885 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
886 return -ENOMEM;
Alan Sterne9df41c2007-08-08 11:48:02 -0400887 return submit_async(ehci, urb, &qtd_list, mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
889 case PIPE_INTERRUPT:
890 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
891 return -ENOMEM;
Alan Sterne9df41c2007-08-08 11:48:02 -0400892 return intr_submit(ehci, urb, &qtd_list, mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893
894 case PIPE_ISOCHRONOUS:
895 if (urb->dev->speed == USB_SPEED_HIGH)
896 return itd_submit (ehci, urb, mem_flags);
897 else
898 return sitd_submit (ehci, urb, mem_flags);
899 }
900}
901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902/* remove from hardware lists
903 * completions normally happen asynchronously
904 */
905
Alan Sterne9df41c2007-08-08 11:48:02 -0400906static int ehci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907{
908 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
909 struct ehci_qh *qh;
910 unsigned long flags;
Alan Sterne9df41c2007-08-08 11:48:02 -0400911 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
913 spin_lock_irqsave (&ehci->lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400914 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
915 if (rc)
916 goto done;
917
Alan Stern7655e312013-03-22 13:31:29 -0400918 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
919 /*
920 * We don't expedite dequeue for isochronous URBs.
921 * Just wait until they complete normally or their
922 * time slot expires.
923 */
924 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 qh = (struct ehci_qh *) urb->hcpriv;
Alan Sternfcc51842016-01-25 15:42:04 -0500926 qh->unlink_reason |= QH_UNLINK_REQUESTED;
Alan Stern07d29b62007-12-11 16:05:30 -0500927 switch (qh->qh_state) {
928 case QH_STATE_LINKED:
Alan Stern7655e312013-03-22 13:31:29 -0400929 if (usb_pipetype(urb->pipe) == PIPE_INTERRUPT)
930 start_unlink_intr(ehci, qh);
931 else
932 start_unlink_async(ehci, qh);
Alan Stern07d29b62007-12-11 16:05:30 -0500933 break;
Alan Stern7bc782d2013-03-22 13:31:11 -0400934 case QH_STATE_COMPLETING:
935 qh->dequeue_during_giveback = 1;
936 break;
Alan Stern07d29b62007-12-11 16:05:30 -0500937 case QH_STATE_UNLINK:
938 case QH_STATE_UNLINK_WAIT:
939 /* already started */
940 break;
941 case QH_STATE_IDLE:
Alan Stern7a0f0d92009-07-31 10:40:22 -0400942 /* QH might be waiting for a Clear-TT-Buffer */
943 qh_completions(ehci, qh);
Alan Stern07d29b62007-12-11 16:05:30 -0500944 break;
945 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 }
947done:
948 spin_unlock_irqrestore (&ehci->lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400949 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950}
951
952/*-------------------------------------------------------------------------*/
953
954// bulk qh holds the data toggle
955
956static void
957ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
958{
959 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
960 unsigned long flags;
Ming Lei35371e42013-07-03 22:53:09 +0800961 struct ehci_qh *qh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
963 /* ASSERT: any requests/urbs are being unlinked */
964 /* ASSERT: nobody can be submitting urbs for this any more */
965
966rescan:
967 spin_lock_irqsave (&ehci->lock, flags);
968 qh = ep->hcpriv;
969 if (!qh)
970 goto done;
971
972 /* endpoints can be iso streams. for now, we don't
973 * accelerate iso completions ... so spin a while.
974 */
Clemens Ladisch1082f572010-03-01 17:18:56 +0100975 if (qh->hw == NULL) {
Alan Stern8c5bf7b2012-07-11 11:22:39 -0400976 struct ehci_iso_stream *stream = ep->hcpriv;
977
978 if (!list_empty(&stream->td_list))
979 goto idle_timeout;
980
981 /* BUG_ON(!list_empty(&stream->free_list)); */
Alan Sternd0ce5c62013-10-11 11:29:13 -0400982 reserve_release_iso_bandwidth(ehci, stream, -1);
Alan Stern8c5bf7b2012-07-11 11:22:39 -0400983 kfree(stream);
984 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 }
986
Alan Sternfcc51842016-01-25 15:42:04 -0500987 qh->unlink_reason |= QH_UNLINK_REQUESTED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 switch (qh->qh_state) {
989 case QH_STATE_LINKED:
Alan Sternfcc51842016-01-25 15:42:04 -0500990 if (list_empty(&qh->qtd_list))
991 qh->unlink_reason |= QH_UNLINK_QUEUE_EMPTY;
992 else
993 WARN_ON(1);
Ming Lei35371e42013-07-03 22:53:09 +0800994 if (usb_endpoint_type(&ep->desc) != USB_ENDPOINT_XFER_INT)
Alan Stern3c273a02012-07-11 11:22:49 -0400995 start_unlink_async(ehci, qh);
Ming Lei35371e42013-07-03 22:53:09 +0800996 else
997 start_unlink_intr(ehci, qh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 /* FALL THROUGH */
Ming Lei35371e42013-07-03 22:53:09 +0800999 case QH_STATE_COMPLETING: /* already in unlinking */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 case QH_STATE_UNLINK: /* wait for hw to finish? */
Alan Stern07d29b62007-12-11 16:05:30 -05001001 case QH_STATE_UNLINK_WAIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002idle_timeout:
1003 spin_unlock_irqrestore (&ehci->lock, flags);
Nishanth Aravamudan22c43862005-08-15 11:30:11 -07001004 schedule_timeout_uninterruptible(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 goto rescan;
1006 case QH_STATE_IDLE: /* fully unlinked */
Alan Stern914b7012009-06-29 10:47:30 -04001007 if (qh->clearing_tt)
1008 goto idle_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 if (list_empty (&qh->qtd_list)) {
Alan Sternd0ce5c62013-10-11 11:29:13 -04001010 if (qh->ps.bw_uperiod)
1011 reserve_release_intr_bandwidth(ehci, qh, -1);
Alan Sternc83e1a92012-07-11 11:21:25 -04001012 qh_destroy(ehci, qh);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 break;
1014 }
1015 /* else FALL THROUGH */
1016 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 /* caller was supposed to have unlinked any requests;
1018 * that's not our job. just leak this memory.
1019 */
1020 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1021 qh, ep->desc.bEndpointAddress, qh->qh_state,
1022 list_empty (&qh->qtd_list) ? "" : "(has tds)");
1023 break;
1024 }
Alan Stern8c5bf7b2012-07-11 11:22:39 -04001025 done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 ep->hcpriv = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 spin_unlock_irqrestore (&ehci->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028}
1029
Alan Sternb18ffd42009-05-27 18:21:56 -04001030static void
1031ehci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1032{
1033 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1034 struct ehci_qh *qh;
1035 int eptype = usb_endpoint_type(&ep->desc);
Alan Sterna455212d2009-06-11 14:56:22 -04001036 int epnum = usb_endpoint_num(&ep->desc);
1037 int is_out = usb_endpoint_dir_out(&ep->desc);
1038 unsigned long flags;
Alan Sternb18ffd42009-05-27 18:21:56 -04001039
1040 if (eptype != USB_ENDPOINT_XFER_BULK && eptype != USB_ENDPOINT_XFER_INT)
1041 return;
1042
Alan Sterna455212d2009-06-11 14:56:22 -04001043 spin_lock_irqsave(&ehci->lock, flags);
Alan Sternb18ffd42009-05-27 18:21:56 -04001044 qh = ep->hcpriv;
1045
1046 /* For Bulk and Interrupt endpoints we maintain the toggle state
1047 * in the hardware; the toggle bits in udev aren't used at all.
1048 * When an endpoint is reset by usb_clear_halt() we must reset
1049 * the toggle bit in the QH.
1050 */
1051 if (qh) {
1052 if (!list_empty(&qh->qtd_list)) {
1053 WARN_ONCE(1, "clear_halt for a busy endpoint\n");
Alan Stern7bc782d2013-03-22 13:31:11 -04001054 } else {
Alan Sterna455212d2009-06-11 14:56:22 -04001055 /* The toggle value in the QH can't be updated
1056 * while the QH is active. Unlink it now;
1057 * re-linking will call qh_refresh().
Alan Sternb18ffd42009-05-27 18:21:56 -04001058 */
Alan Sternffa02482013-10-11 11:29:03 -04001059 usb_settoggle(qh->ps.udev, epnum, is_out, 0);
Alan Sternfcc51842016-01-25 15:42:04 -05001060 qh->unlink_reason |= QH_UNLINK_REQUESTED;
Alan Sterna448c9d2009-08-19 12:22:44 -04001061 if (eptype == USB_ENDPOINT_XFER_BULK)
Alan Stern3c273a02012-07-11 11:22:49 -04001062 start_unlink_async(ehci, qh);
Alan Sterna448c9d2009-08-19 12:22:44 -04001063 else
Alan Sterndf202252012-07-11 11:22:26 -04001064 start_unlink_intr(ehci, qh);
Alan Sternb18ffd42009-05-27 18:21:56 -04001065 }
1066 }
Alan Sterna455212d2009-06-11 14:56:22 -04001067 spin_unlock_irqrestore(&ehci->lock, flags);
Alan Sternb18ffd42009-05-27 18:21:56 -04001068}
1069
Matt Porter7ff71d62005-09-22 22:31:15 -07001070static int ehci_get_frame (struct usb_hcd *hcd)
1071{
1072 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
Alan Stern68aa95d2011-10-12 10:39:14 -04001073 return (ehci_read_frame_index(ehci) >> 3) % ehci->periodic_size;
Matt Porter7ff71d62005-09-22 22:31:15 -07001074}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075
1076/*-------------------------------------------------------------------------*/
Alan Sternc5cf9212012-06-28 11:19:02 -04001077
Alan Sternb35c5002013-10-11 22:16:21 -04001078/* Device addition and removal */
1079
1080static void ehci_remove_device(struct usb_hcd *hcd, struct usb_device *udev)
1081{
1082 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1083
1084 spin_lock_irq(&ehci->lock);
1085 drop_tt(udev);
1086 spin_unlock_irq(&ehci->lock);
1087}
1088
1089/*-------------------------------------------------------------------------*/
1090
Alan Sternc5cf9212012-06-28 11:19:02 -04001091#ifdef CONFIG_PM
1092
1093/* suspend/resume, section 4.3 */
1094
1095/* These routines handle the generic parts of controller suspend/resume */
1096
Alan Stern3e023202012-11-01 11:12:58 -04001097int ehci_suspend(struct usb_hcd *hcd, bool do_wakeup)
Alan Sternc5cf9212012-06-28 11:19:02 -04001098{
1099 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1100
1101 if (time_before(jiffies, ehci->next_statechange))
1102 msleep(10);
1103
1104 /*
1105 * Root hub was already suspended. Disable IRQ emission and
1106 * mark HW unaccessible. The PM and USB cores make sure that
1107 * the root hub is either suspended or stopped.
1108 */
1109 ehci_prepare_ports_for_controller_suspend(ehci, do_wakeup);
1110
1111 spin_lock_irq(&ehci->lock);
1112 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
1113 (void) ehci_readl(ehci, &ehci->regs->intr_enable);
1114
1115 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1116 spin_unlock_irq(&ehci->lock);
1117
Alan Sternb8efdaf2013-10-18 11:18:21 -04001118 synchronize_irq(hcd->irq);
1119
1120 /* Check for race with a wakeup request */
1121 if (do_wakeup && HCD_WAKEUP_PENDING(hcd)) {
1122 ehci_resume(hcd, false);
1123 return -EBUSY;
1124 }
1125
Alan Sternc5cf9212012-06-28 11:19:02 -04001126 return 0;
1127}
Alan Stern3e023202012-11-01 11:12:58 -04001128EXPORT_SYMBOL_GPL(ehci_suspend);
Alan Sternc5cf9212012-06-28 11:19:02 -04001129
1130/* Returns 0 if power was preserved, 1 if power was lost */
Wu Liang feng314b41b2014-12-24 18:22:19 +08001131int ehci_resume(struct usb_hcd *hcd, bool force_reset)
Alan Sternc5cf9212012-06-28 11:19:02 -04001132{
1133 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1134
1135 if (time_before(jiffies, ehci->next_statechange))
1136 msleep(100);
1137
1138 /* Mark hardware accessible again as we are back to full power by now */
1139 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1140
Alan Stern43fe3a92012-07-11 11:23:16 -04001141 if (ehci->shutdown)
1142 return 0; /* Controller is dead */
1143
Alan Sternc5cf9212012-06-28 11:19:02 -04001144 /*
Wu Liang feng314b41b2014-12-24 18:22:19 +08001145 * If CF is still set and reset isn't forced
Alan Sternc5cf9212012-06-28 11:19:02 -04001146 * then we maintained suspend power.
1147 * Just undo the effect of ehci_suspend().
1148 */
1149 if (ehci_readl(ehci, &ehci->regs->configured_flag) == FLAG_CF &&
Wu Liang feng314b41b2014-12-24 18:22:19 +08001150 !force_reset) {
Alan Sternc5cf9212012-06-28 11:19:02 -04001151 int mask = INTR_MASK;
1152
1153 ehci_prepare_ports_for_controller_resume(ehci);
Alan Stern43fe3a92012-07-11 11:23:16 -04001154
1155 spin_lock_irq(&ehci->lock);
1156 if (ehci->shutdown)
1157 goto skip;
1158
Alan Sternc5cf9212012-06-28 11:19:02 -04001159 if (!hcd->self.root_hub->do_remote_wakeup)
1160 mask &= ~STS_PCD;
1161 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
1162 ehci_readl(ehci, &ehci->regs->intr_enable);
Alan Stern43fe3a92012-07-11 11:23:16 -04001163 skip:
1164 spin_unlock_irq(&ehci->lock);
Alan Sternc5cf9212012-06-28 11:19:02 -04001165 return 0;
1166 }
1167
1168 /*
1169 * Else reset, to cope with power loss or resume from hibernation
1170 * having let the firmware kick in during reboot.
1171 */
1172 usb_root_hub_lost_power(hcd->self.root_hub);
1173 (void) ehci_halt(ehci);
1174 (void) ehci_reset(ehci);
1175
Alan Stern43fe3a92012-07-11 11:23:16 -04001176 spin_lock_irq(&ehci->lock);
1177 if (ehci->shutdown)
1178 goto skip;
1179
Alan Sternc5cf9212012-06-28 11:19:02 -04001180 ehci_writel(ehci, ehci->command, &ehci->regs->command);
1181 ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
1182 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1183
Alan Stern43fe3a92012-07-11 11:23:16 -04001184 ehci->rh_state = EHCI_RH_SUSPENDED;
1185 spin_unlock_irq(&ehci->lock);
1186
Alan Sternc5cf9212012-06-28 11:19:02 -04001187 return 1;
1188}
Alan Stern3e023202012-11-01 11:12:58 -04001189EXPORT_SYMBOL_GPL(ehci_resume);
Alan Sternc5cf9212012-06-28 11:19:02 -04001190
1191#endif
1192
1193/*-------------------------------------------------------------------------*/
1194
Alexander Shishkineb70e5a2012-05-11 17:25:54 +03001195/*
Alan Stern3e023202012-11-01 11:12:58 -04001196 * Generic structure: This gets copied for platform drivers so that
1197 * individual entries can be overridden as needed.
1198 */
1199
1200static const struct hc_driver ehci_hc_driver = {
1201 .description = hcd_name,
1202 .product_desc = "EHCI Host Controller",
1203 .hcd_priv_size = sizeof(struct ehci_hcd),
1204
1205 /*
1206 * generic hardware linkage
1207 */
1208 .irq = ehci_irq,
Greg Kroah-Hartmanc04ee4b2013-09-23 13:32:51 -07001209 .flags = HCD_MEMORY | HCD_USB2 | HCD_BH,
Alan Stern3e023202012-11-01 11:12:58 -04001210
1211 /*
1212 * basic lifecycle operations
1213 */
1214 .reset = ehci_setup,
1215 .start = ehci_run,
1216 .stop = ehci_stop,
1217 .shutdown = ehci_shutdown,
1218
1219 /*
1220 * managing i/o requests and associated device resources
1221 */
1222 .urb_enqueue = ehci_urb_enqueue,
1223 .urb_dequeue = ehci_urb_dequeue,
1224 .endpoint_disable = ehci_endpoint_disable,
1225 .endpoint_reset = ehci_endpoint_reset,
1226 .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
1227
1228 /*
1229 * scheduling support
1230 */
1231 .get_frame_number = ehci_get_frame,
1232
1233 /*
1234 * root hub support
1235 */
1236 .hub_status_data = ehci_hub_status_data,
1237 .hub_control = ehci_hub_control,
1238 .bus_suspend = ehci_bus_suspend,
1239 .bus_resume = ehci_bus_resume,
1240 .relinquish_port = ehci_relinquish_port,
1241 .port_handed_over = ehci_port_handed_over,
Alan Sternb35c5002013-10-11 22:16:21 -04001242
1243 /*
1244 * device support
1245 */
1246 .free_dev = ehci_remove_device,
Alan Stern3e023202012-11-01 11:12:58 -04001247};
1248
1249void ehci_init_driver(struct hc_driver *drv,
1250 const struct ehci_driver_overrides *over)
1251{
1252 /* Copy the generic table to drv and then apply the overrides */
1253 *drv = ehci_hc_driver;
1254
Alan Stern1b368102012-11-07 16:12:47 -05001255 if (over) {
1256 drv->hcd_priv_size += over->extra_priv_size;
1257 if (over->reset)
1258 drv->reset = over->reset;
Michael Grzeschik11a7e592014-10-13 09:53:03 +08001259 if (over->port_power)
1260 drv->port_power = over->port_power;
Alan Stern1b368102012-11-07 16:12:47 -05001261 }
Alan Stern3e023202012-11-01 11:12:58 -04001262}
1263EXPORT_SYMBOL_GPL(ehci_init_driver);
1264
1265/*-------------------------------------------------------------------------*/
1266
Alan Stern2b70f072008-10-02 11:47:15 -04001267MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268MODULE_AUTHOR (DRIVER_AUTHOR);
1269MODULE_LICENSE ("GPL");
1270
Yoshihiro Shimoda60b0bf02011-03-01 16:58:37 +09001271#ifdef CONFIG_USB_EHCI_SH
Paul Mundt63c84552010-11-01 17:03:27 -04001272#include "ehci-sh.c"
1273#define PLATFORM_DRIVER ehci_hcd_sh_driver
1274#endif
1275
Geoff Levandad75a412007-01-15 20:11:47 -08001276#ifdef CONFIG_PPC_PS3
1277#include "ehci-ps3.c"
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001278#define PS3_SYSTEM_BUS_DRIVER ps3_ehci_driver
Geoff Levandad75a412007-01-15 20:11:47 -08001279#endif
1280
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001281#ifdef CONFIG_USB_EHCI_HCD_PPC_OF
1282#include "ehci-ppc-of.c"
1283#define OF_PLATFORM_DRIVER ehci_hcd_ppc_of_driver
1284#endif
1285
Julie Zhu08d3c182009-09-21 16:08:19 -06001286#ifdef CONFIG_XPS_USB_HCD_XILINX
1287#include "ehci-xilinx-of.c"
Grant Likely1f23b2d2010-06-02 13:53:17 -06001288#define XILINX_OF_PLATFORM_DRIVER ehci_hcd_xilinx_of_driver
Julie Zhu08d3c182009-09-21 16:08:19 -06001289#endif
1290
Chris Metcalf47fc28b2012-05-09 13:58:14 -04001291#ifdef CONFIG_TILE_USB
1292#include "ehci-tilegx.c"
1293#define PLATFORM_DRIVER ehci_hcd_tilegx_driver
1294#endif
1295
Anoop22ced6872011-02-24 19:26:28 +05301296#ifdef CONFIG_USB_EHCI_HCD_PMC_MSP
1297#include "ehci-pmcmsp.c"
1298#define PLATFORM_DRIVER ehci_hcd_msp_driver
1299#endif
1300
Jan Andersson9be03922011-05-03 20:11:58 +02001301#ifdef CONFIG_SPARC_LEON
1302#include "ehci-grlib.c"
1303#define PLATFORM_DRIVER ehci_grlib_driver
1304#endif
1305
Neil Zhang3a082ec2011-12-20 13:20:23 +08001306#ifdef CONFIG_USB_EHCI_MV
1307#include "ehci-mv.c"
1308#define PLATFORM_DRIVER ehci_mv_driver
1309#endif
1310
Kumar Gala01cced22006-04-11 10:07:16 -05001311static int __init ehci_hcd_init(void)
1312{
1313 int retval = 0;
1314
Alan Stern2b70f072008-10-02 11:47:15 -04001315 if (usb_disabled())
1316 return -ENODEV;
1317
1318 printk(KERN_INFO "%s: " DRIVER_DESC "\n", hcd_name);
Alan Stern9beeee62008-10-02 11:48:13 -04001319 set_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1320 if (test_bit(USB_UHCI_LOADED, &usb_hcds_loaded) ||
1321 test_bit(USB_OHCI_LOADED, &usb_hcds_loaded))
1322 printk(KERN_WARNING "Warning! ehci_hcd should always be loaded"
1323 " before uhci_hcd and ohci_hcd, not after\n");
1324
Kumar Gala01cced22006-04-11 10:07:16 -05001325 pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1326 hcd_name,
1327 sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
1328 sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
1329
Oliver Neukum1c201632013-11-18 13:23:16 +01001330#ifdef CONFIG_DYNAMIC_DEBUG
Greg Kroah-Hartman08f4e582009-04-24 15:13:18 -07001331 ehci_debug_root = debugfs_create_dir("ehci", usb_debug_root);
Alan Stern9beeee62008-10-02 11:48:13 -04001332 if (!ehci_debug_root) {
1333 retval = -ENOENT;
1334 goto err_debug;
1335 }
Tony Jones694cc202007-09-11 14:07:31 -07001336#endif
1337
Kumar Gala01cced22006-04-11 10:07:16 -05001338#ifdef PLATFORM_DRIVER
1339 retval = platform_driver_register(&PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001340 if (retval < 0)
1341 goto clean0;
Kumar Gala01cced22006-04-11 10:07:16 -05001342#endif
1343
Geoff Levandad75a412007-01-15 20:11:47 -08001344#ifdef PS3_SYSTEM_BUS_DRIVER
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001345 retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001346 if (retval < 0)
1347 goto clean2;
Kumar Gala01cced22006-04-11 10:07:16 -05001348#endif
1349
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001350#ifdef OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001351 retval = platform_driver_register(&OF_PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001352 if (retval < 0)
1353 goto clean3;
1354#endif
Grant Likely1f23b2d2010-06-02 13:53:17 -06001355
1356#ifdef XILINX_OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001357 retval = platform_driver_register(&XILINX_OF_PLATFORM_DRIVER);
Grant Likely1f23b2d2010-06-02 13:53:17 -06001358 if (retval < 0)
1359 goto clean4;
1360#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001361 return retval;
1362
Grant Likely1f23b2d2010-06-02 13:53:17 -06001363#ifdef XILINX_OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001364 /* platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER); */
Grant Likely1f23b2d2010-06-02 13:53:17 -06001365clean4:
1366#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001367#ifdef OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001368 platform_driver_unregister(&OF_PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001369clean3:
1370#endif
1371#ifdef PS3_SYSTEM_BUS_DRIVER
1372 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1373clean2:
1374#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001375#ifdef PLATFORM_DRIVER
1376 platform_driver_unregister(&PLATFORM_DRIVER);
1377clean0:
1378#endif
Oliver Neukum1c201632013-11-18 13:23:16 +01001379#ifdef CONFIG_DYNAMIC_DEBUG
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001380 debugfs_remove(ehci_debug_root);
1381 ehci_debug_root = NULL;
Alan Stern9beeee62008-10-02 11:48:13 -04001382err_debug:
Linus Torvaldsa9b61482008-10-20 14:23:29 -07001383#endif
Alan Stern9beeee62008-10-02 11:48:13 -04001384 clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
Kumar Gala01cced22006-04-11 10:07:16 -05001385 return retval;
1386}
1387module_init(ehci_hcd_init);
1388
1389static void __exit ehci_hcd_cleanup(void)
1390{
Grant Likely1f23b2d2010-06-02 13:53:17 -06001391#ifdef XILINX_OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001392 platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER);
Grant Likely1f23b2d2010-06-02 13:53:17 -06001393#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001394#ifdef OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001395 platform_driver_unregister(&OF_PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001396#endif
Kumar Gala01cced22006-04-11 10:07:16 -05001397#ifdef PLATFORM_DRIVER
1398 platform_driver_unregister(&PLATFORM_DRIVER);
1399#endif
Geoff Levandad75a412007-01-15 20:11:47 -08001400#ifdef PS3_SYSTEM_BUS_DRIVER
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001401 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
Geoff Levandad75a412007-01-15 20:11:47 -08001402#endif
Oliver Neukum1c201632013-11-18 13:23:16 +01001403#ifdef CONFIG_DYNAMIC_DEBUG
Tony Jones694cc202007-09-11 14:07:31 -07001404 debugfs_remove(ehci_debug_root);
1405#endif
Alan Stern9beeee62008-10-02 11:48:13 -04001406 clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
Kumar Gala01cced22006-04-11 10:07:16 -05001407}
1408module_exit(ehci_hcd_cleanup);