blob: e8ba4c44223a5c360ec552cbbb4137ca2b4ca3b2 [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
David Brownell9776afc2008-02-01 11:42:05 -080074#undef VERBOSE_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -070075#undef EHCI_URB_TRACE
76
Linus Torvalds1da177e2005-04-16 15:20:36 -070077/* magic numbers that can affect system performance */
78#define EHCI_TUNE_CERR 3 /* 0-3 qtd retries; 0 == don't stop */
79#define EHCI_TUNE_RL_HS 4 /* nak throttle; see 4.9 */
80#define EHCI_TUNE_RL_TT 0
81#define EHCI_TUNE_MULT_HS 1 /* 1-3 transactions/uframe; 4.10.3 */
82#define EHCI_TUNE_MULT_TT 1
Alan Sternffda0802010-07-14 11:03:46 -040083/*
84 * Some drivers think it's safe to schedule isochronous transfers more than
85 * 256 ms into the future (partly as a result of an old bug in the scheduling
86 * code). In an attempt to avoid trouble, we will use a minimum scheduling
87 * length of 512 frames instead of 256.
88 */
89#define EHCI_TUNE_FLS 1 /* (medium) 512-frame schedule */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Linus Torvalds1da177e2005-04-16 15:20:36 -070091/* Initial IRQ latency: faster than hw default */
92static int log2_irq_thresh = 0; // 0 to 6
93module_param (log2_irq_thresh, int, S_IRUGO);
94MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
95
96/* initial park setting: slower than hw default */
97static unsigned park = 0;
98module_param (park, uint, S_IRUGO);
99MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
100
David Brownell93f1a472006-11-16 23:34:58 -0800101/* for flakey hardware, ignore overcurrent indicators */
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030102static bool ignore_oc = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800103module_param (ignore_oc, bool, S_IRUGO);
104MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications");
105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106#define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
107
108/*-------------------------------------------------------------------------*/
109
110#include "ehci.h"
Andiry Xuad935622011-03-01 14:57:05 +0800111#include "pci-quirks.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
Alan Sternb35c5002013-10-11 22:16:21 -0400113static void compute_tt_budget(u8 budget_table[EHCI_BANDWIDTH_SIZE],
114 struct ehci_tt *tt);
115
Alan Sternacc08502012-10-10 15:07:39 -0400116/*
117 * The MosChip MCS9990 controller updates its microframe counter
118 * a little before the frame counter, and occasionally we will read
119 * the invalid intermediate value. Avoid problems by checking the
120 * microframe number (the low-order 3 bits); if they are 0 then
121 * re-read the register to get the correct value.
122 */
123static unsigned ehci_moschip_read_frame_index(struct ehci_hcd *ehci)
124{
125 unsigned uf;
126
127 uf = ehci_readl(ehci, &ehci->regs->frame_index);
128 if (unlikely((uf & 7) == 0))
129 uf = ehci_readl(ehci, &ehci->regs->frame_index);
130 return uf;
131}
132
133static inline unsigned ehci_read_frame_index(struct ehci_hcd *ehci)
134{
135 if (ehci->frame_index_bug)
136 return ehci_moschip_read_frame_index(ehci);
137 return ehci_readl(ehci, &ehci->regs->frame_index);
138}
139
140#include "ehci-dbg.c"
141
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142/*-------------------------------------------------------------------------*/
143
144/*
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600145 * ehci_handshake - spin reading hc until handshake completes or fails
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 * @ptr: address of hc register to be read
147 * @mask: bits to look at in result of read
148 * @done: value of those bits when handshake succeeds
149 * @usec: timeout in microseconds
150 *
151 * Returns negative errno, or zero on success
152 *
153 * Success happens when the "mask" bits have the specified value (hardware
154 * handshake done). There are two failure modes: "usec" have passed (major
155 * hardware flakeout), or the register reads as all-ones (hardware removed).
156 *
157 * That last failure should_only happen in cases like physical cardbus eject
158 * before driver shutdown. But it also seems to be caused by bugs in cardbus
159 * bridge shutdown: shutting down the bridge before the devices using it.
160 */
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600161int ehci_handshake(struct ehci_hcd *ehci, void __iomem *ptr,
162 u32 mask, u32 done, int usec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
164 u32 result;
165
166 do {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100167 result = ehci_readl(ehci, ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 if (result == ~(u32)0) /* card removed */
169 return -ENODEV;
170 result &= mask;
171 if (result == done)
172 return 0;
173 udelay (1);
174 usec--;
175 } while (usec > 0);
176 return -ETIMEDOUT;
177}
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600178EXPORT_SYMBOL_GPL(ehci_handshake);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
Matthieu CASTET65fd4272010-09-06 18:26:56 +0200180/* check TDI/ARC silicon is in host mode */
181static int tdi_in_host_mode (struct ehci_hcd *ehci)
182{
Matthieu CASTET65fd4272010-09-06 18:26:56 +0200183 u32 tmp;
184
Alan Sterna46af4e2012-06-25 12:19:03 -0400185 tmp = ehci_readl(ehci, &ehci->regs->usbmode);
Matthieu CASTET65fd4272010-09-06 18:26:56 +0200186 return (tmp & 3) == USBMODE_CM_HC;
187}
188
Alan Sternc4f34762012-07-11 11:23:10 -0400189/*
190 * Force HC to halt state from unknown (EHCI spec section 2.3).
191 * Must be called with interrupts enabled and the lock not held.
192 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193static int ehci_halt (struct ehci_hcd *ehci)
194{
Alan Sternc4f34762012-07-11 11:23:10 -0400195 u32 temp;
196
197 spin_lock_irq(&ehci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
David Brownell72f30b62005-09-27 10:19:39 -0700199 /* disable any irqs left enabled by previous code */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100200 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
David Brownell72f30b62005-09-27 10:19:39 -0700201
Alan Sternc4f34762012-07-11 11:23:10 -0400202 if (ehci_is_TDI(ehci) && !tdi_in_host_mode(ehci)) {
203 spin_unlock_irq(&ehci->lock);
Matthieu CASTET65fd4272010-09-06 18:26:56 +0200204 return 0;
205 }
206
Alan Stern3d9545c2012-04-23 13:54:36 -0400207 /*
208 * This routine gets called during probe before ehci->command
209 * has been initialized, so we can't rely on its value.
210 */
211 ehci->command &= ~CMD_RUN;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100212 temp = ehci_readl(ehci, &ehci->regs->command);
Alan Stern3d9545c2012-04-23 13:54:36 -0400213 temp &= ~(CMD_RUN | CMD_IAAD);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100214 ehci_writel(ehci, temp, &ehci->regs->command);
Alan Sternc4f34762012-07-11 11:23:10 -0400215
216 spin_unlock_irq(&ehci->lock);
217 synchronize_irq(ehci_to_hcd(ehci)->irq);
218
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600219 return ehci_handshake(ehci, &ehci->regs->status,
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100220 STS_HALT, STS_HALT, 16 * 125);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221}
222
223/* put TDI/ARC silicon into EHCI mode */
224static void tdi_reset (struct ehci_hcd *ehci)
225{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 u32 tmp;
227
Alan Sterna46af4e2012-06-25 12:19:03 -0400228 tmp = ehci_readl(ehci, &ehci->regs->usbmode);
Vladimir Barinovd23a1372007-05-23 20:07:48 +0400229 tmp |= USBMODE_CM_HC;
230 /* The default byte access to MMR space is LE after
231 * controller reset. Set the required endian mode
232 * for transfer buffers to match the host microprocessor
233 */
234 if (ehci_big_endian_mmio(ehci))
235 tmp |= USBMODE_BE;
Alan Sterna46af4e2012-06-25 12:19:03 -0400236 ehci_writel(ehci, tmp, &ehci->regs->usbmode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237}
238
Alan Sternc4f34762012-07-11 11:23:10 -0400239/*
240 * Reset a non-running (STS_HALT == 1) controller.
241 * Must be called with interrupts enabled and the lock not held.
242 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243static int ehci_reset (struct ehci_hcd *ehci)
244{
245 int retval;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100246 u32 command = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Jason Wessel8d053c72009-08-20 15:39:54 -0500248 /* If the EHCI debug controller is active, special care must be
249 * taken before and after a host controller reset */
Jan Beulich9fa57802012-09-18 12:23:02 +0100250 if (ehci->debug && !dbgp_reset_prep(ehci_to_hcd(ehci)))
Jason Wessel8d053c72009-08-20 15:39:54 -0500251 ehci->debug = NULL;
252
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 command |= CMD_RESET;
254 dbg_cmd (ehci, "reset", command);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100255 ehci_writel(ehci, command, &ehci->regs->command);
Alan Sterne8799902011-08-18 16:31:30 -0400256 ehci->rh_state = EHCI_RH_HALTED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 ehci->next_statechange = jiffies;
Manjunath Goudar2f3a6b82013-06-13 11:24:09 -0600258 retval = ehci_handshake(ehci, &ehci->regs->command,
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100259 CMD_RESET, 0, 250 * 1000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
Alek Du331ac6b2009-07-13 12:41:20 +0800261 if (ehci->has_hostpc) {
262 ehci_writel(ehci, USBMODE_EX_HC | USBMODE_EX_VBPS,
Alan Sterna46af4e2012-06-25 12:19:03 -0400263 &ehci->regs->usbmode_ex);
264 ehci_writel(ehci, TXFIFO_DEFAULT, &ehci->regs->txfill_tuning);
Alek Du331ac6b2009-07-13 12:41:20 +0800265 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 if (retval)
267 return retval;
268
269 if (ehci_is_TDI(ehci))
270 tdi_reset (ehci);
271
Jason Wessel8d053c72009-08-20 15:39:54 -0500272 if (ehci->debug)
Jan Beulich9fa57802012-09-18 12:23:02 +0100273 dbgp_external_startup(ehci_to_hcd(ehci));
Jason Wessel8d053c72009-08-20 15:39:54 -0500274
Alan Sterna448e4d2012-04-03 15:24:30 -0400275 ehci->port_c_suspend = ehci->suspended_ports =
276 ehci->resuming_ports = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 return retval;
278}
279
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 Stern07d29b62007-12-11 16:05:30 -0500309static void end_unlink_async(struct ehci_hcd *ehci);
Alan Stern32830f22012-07-11 11:22:53 -0400310static void unlink_empty_async(struct ehci_hcd *ehci);
Alan Stern2a40f322013-03-15 14:40:26 -0400311static void unlink_empty_async_suspended(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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Alan Sternd58b4bc2012-07-11 11:21:54 -0400316#include "ehci-timer.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317#include "ehci-hub.c"
318#include "ehci-mem.c"
319#include "ehci-q.c"
320#include "ehci-sched.c"
Kirill Smelkov4c670452011-07-03 20:36:56 +0400321#include "ehci-sysfs.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323/*-------------------------------------------------------------------------*/
324
Alan Stern89037952007-02-13 14:55:27 -0500325/* On some systems, leaving remote wakeup enabled prevents system shutdown.
326 * The firmware seems to think that powering off is a wakeup event!
327 * This routine turns off remote wakeup and everything else, on all ports.
328 */
329static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
330{
331 int port = HCS_N_PORTS(ehci->hcs_params);
332
333 while (port--)
334 ehci_writel(ehci, PORT_RWC_BITS,
335 &ehci->regs->port_status[port]);
336}
337
Sarah Sharp21da84a2008-04-08 14:30:18 -0700338/*
339 * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
Alan Sternc4f34762012-07-11 11:23:10 -0400340 * Must be called with interrupts enabled and the lock not held.
David Brownell72f30b62005-09-27 10:19:39 -0700341 */
Sarah Sharp21da84a2008-04-08 14:30:18 -0700342static void ehci_silence_controller(struct ehci_hcd *ehci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343{
Sarah Sharp21da84a2008-04-08 14:30:18 -0700344 ehci_halt(ehci);
Alan Sternc4f34762012-07-11 11:23:10 -0400345
346 spin_lock_irq(&ehci->lock);
347 ehci->rh_state = EHCI_RH_HALTED;
Alan Stern89037952007-02-13 14:55:27 -0500348 ehci_turn_off_all_ports(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
350 /* make BIOS/etc use companion controller during reboot */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100351 ehci_writel(ehci, 0, &ehci->regs->configured_flag);
Alan Stern89037952007-02-13 14:55:27 -0500352
353 /* unblock posted writes */
354 ehci_readl(ehci, &ehci->regs->configured_flag);
Alan Sternc4f34762012-07-11 11:23:10 -0400355 spin_unlock_irq(&ehci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356}
357
Sarah Sharp21da84a2008-04-08 14:30:18 -0700358/* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
359 * This forcibly disables dma and IRQs, helping kexec and other cases
360 * where the next system software may expect clean state.
361 */
362static void ehci_shutdown(struct usb_hcd *hcd)
363{
364 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
365
Sarah Sharp21da84a2008-04-08 14:30:18 -0700366 spin_lock_irq(&ehci->lock);
Alan Stern43fe3a92012-07-11 11:23:16 -0400367 ehci->shutdown = true;
Alan Sternc0c53db2012-07-11 11:21:48 -0400368 ehci->rh_state = EHCI_RH_STOPPING;
Alan Sternd58b4bc2012-07-11 11:21:54 -0400369 ehci->enabled_hrtimer_events = 0;
Sarah Sharp21da84a2008-04-08 14:30:18 -0700370 spin_unlock_irq(&ehci->lock);
Alan Sternd58b4bc2012-07-11 11:21:54 -0400371
Alan Sternc4f34762012-07-11 11:23:10 -0400372 ehci_silence_controller(ehci);
373
Alan Sternd58b4bc2012-07-11 11:21:54 -0400374 hrtimer_cancel(&ehci->hrtimer);
Sarah Sharp21da84a2008-04-08 14:30:18 -0700375}
376
Matt Porter7ff71d62005-09-22 22:31:15 -0700377/*-------------------------------------------------------------------------*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
Matt Porter7ff71d62005-09-22 22:31:15 -0700379/*
380 * ehci_work is called from some interrupts, timers, and so on.
381 * it calls driver completion functions, after dropping ehci->lock.
382 */
David Howells7d12e782006-10-05 14:55:46 +0100383static void ehci_work (struct ehci_hcd *ehci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384{
Matt Porter7ff71d62005-09-22 22:31:15 -0700385 /* another CPU may drop ehci->lock during a schedule scan while
386 * it reports urb completions. this flag guards against bogus
387 * attempts at re-entrant schedule scanning.
388 */
Alan Stern361aabf2012-07-11 11:22:57 -0400389 if (ehci->scanning) {
390 ehci->need_rescan = true;
Matt Porter7ff71d62005-09-22 22:31:15 -0700391 return;
Alan Stern361aabf2012-07-11 11:22:57 -0400392 }
393 ehci->scanning = true;
394
395 rescan:
396 ehci->need_rescan = false;
Alan Stern31446612012-07-11 11:22:21 -0400397 if (ehci->async_count)
398 scan_async(ehci);
Alan Stern569b3942012-07-11 11:23:00 -0400399 if (ehci->intr_count > 0)
400 scan_intr(ehci);
401 if (ehci->isoc_count > 0)
402 scan_isoc(ehci);
Alan Stern361aabf2012-07-11 11:22:57 -0400403 if (ehci->need_rescan)
404 goto rescan;
405 ehci->scanning = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Matt Porter7ff71d62005-09-22 22:31:15 -0700407 /* the IO watchdog guards against hardware or driver bugs that
408 * misplace IRQs, and should let us run completely without IRQs.
409 * such lossage has been observed on both VT6202 and VT8235.
410 */
Alan Stern18aafe62012-07-11 11:23:04 -0400411 turn_on_io_watchdog(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412}
413
Sarah Sharp21da84a2008-04-08 14:30:18 -0700414/*
415 * Called when the ehci_hcd module is removed.
416 */
Matt Porter7ff71d62005-09-22 22:31:15 -0700417static void ehci_stop (struct usb_hcd *hcd)
418{
419 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
420
421 ehci_dbg (ehci, "stop\n");
422
Matt Porter7ff71d62005-09-22 22:31:15 -0700423 /* no more interrupts ... */
Matt Porter7ff71d62005-09-22 22:31:15 -0700424
425 spin_lock_irq(&ehci->lock);
Alan Sternd58b4bc2012-07-11 11:21:54 -0400426 ehci->enabled_hrtimer_events = 0;
Matt Porter7ff71d62005-09-22 22:31:15 -0700427 spin_unlock_irq(&ehci->lock);
428
Alan Sternc4f34762012-07-11 11:23:10 -0400429 ehci_quiesce(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700430 ehci_silence_controller(ehci);
431 ehci_reset (ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700432
Alan Sternd58b4bc2012-07-11 11:21:54 -0400433 hrtimer_cancel(&ehci->hrtimer);
Kirill Smelkov4c670452011-07-03 20:36:56 +0400434 remove_sysfs_files(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700435 remove_debug_files (ehci);
436
437 /* root hub is shut down separately (first, when possible) */
438 spin_lock_irq (&ehci->lock);
Alan Stern55934eb2012-07-11 11:22:35 -0400439 end_free_itds(ehci);
Matt Porter7ff71d62005-09-22 22:31:15 -0700440 spin_unlock_irq (&ehci->lock);
441 ehci_mem_cleanup (ehci);
442
Andiry Xuad935622011-03-01 14:57:05 +0800443 if (ehci->amd_pll_fix == 1)
444 usb_amd_dev_put();
Alex He05570292010-12-07 10:10:08 +0800445
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100446 dbg_status (ehci, "ehci_stop completed",
447 ehci_readl(ehci, &ehci->regs->status));
Matt Porter7ff71d62005-09-22 22:31:15 -0700448}
449
David Brownell18807522005-11-23 15:45:37 -0800450/* one-time init, only for memory state */
451static int ehci_init(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452{
David Brownell18807522005-11-23 15:45:37 -0800453 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 u32 temp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 int retval;
456 u32 hcc_params;
Alek Du3807e262009-07-14 07:23:29 +0800457 struct ehci_qh_hw *hw;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
David Brownell18807522005-11-23 15:45:37 -0800459 spin_lock_init(&ehci->lock);
460
Alek Du403dbd32009-07-13 17:30:41 +0800461 /*
462 * keep io watchdog by default, those good HCDs could turn off it later
463 */
464 ehci->need_io_watchdog = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
Alan Sternd58b4bc2012-07-11 11:21:54 -0400466 hrtimer_init(&ehci->hrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
467 ehci->hrtimer.function = ehci_hrtimer_func;
468 ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
Alan Stern07d29b62007-12-11 16:05:30 -0500469
Alan Sternf75593c2011-01-06 10:17:09 -0500470 hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 /*
Kirill Smelkovcc62a7e2011-07-03 20:36:57 +0400473 * by default set standard 80% (== 100 usec/uframe) max periodic
474 * bandwidth as required by USB 2.0
475 */
476 ehci->uframe_periodic_max = 100;
477
478 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 * hw default: 1K periodic list heads, one per frame.
480 * periodic_size can shrink by USBCMD update if hcc_params allows.
481 */
482 ehci->periodic_size = DEFAULT_I_TDPS;
Alan Stern6e018752013-03-22 13:31:45 -0400483 INIT_LIST_HEAD(&ehci->async_unlink);
Alan Stern214ac7a2013-03-22 13:31:58 -0400484 INIT_LIST_HEAD(&ehci->async_idle);
Ming Lei9118f9e2013-07-03 22:53:10 +0800485 INIT_LIST_HEAD(&ehci->intr_unlink_wait);
Alan Stern6e018752013-03-22 13:31:45 -0400486 INIT_LIST_HEAD(&ehci->intr_unlink);
Alan Stern569b3942012-07-11 11:23:00 -0400487 INIT_LIST_HEAD(&ehci->intr_qh_list);
Karsten Wiese9aa09d22009-02-08 16:07:58 -0800488 INIT_LIST_HEAD(&ehci->cached_itd_list);
Alan Stern0e5f2312010-04-08 16:56:37 -0400489 INIT_LIST_HEAD(&ehci->cached_sitd_list);
Alan Sternb35c5002013-10-11 22:16:21 -0400490 INIT_LIST_HEAD(&ehci->tt_list);
Alan Sternf75593c2011-01-06 10:17:09 -0500491
Greg Kroah-Hartman8e192912012-05-21 08:54:43 -0700492 if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
Alan Sternf75593c2011-01-06 10:17:09 -0500493 /* periodic schedule size can be smaller than default */
494 switch (EHCI_TUNE_FLS) {
495 case 0: ehci->periodic_size = 1024; break;
496 case 1: ehci->periodic_size = 512; break;
497 case 2: ehci->periodic_size = 256; break;
498 default: BUG();
499 }
500 }
David Brownell18807522005-11-23 15:45:37 -0800501 if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 return retval;
503
504 /* controllers may cache some of the periodic schedule ... */
David Brownell53bd6a62006-08-30 14:50:06 -0700505 if (HCC_ISOC_CACHE(hcc_params)) // full frame cache
Alan Stern98cae422012-09-28 16:01:34 -0400506 ehci->i_thresh = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 else // N microframes cached
David Brownell18807522005-11-23 15:45:37 -0800508 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 /*
511 * dedicate a qh for the async ring head, since we couldn't unlink
512 * a 'real' qh without stopping the async schedule [4.8]. use it
513 * as the 'reclamation list head' too.
514 * its dummy is used in hw_alt_next of many tds, to prevent the qh
515 * from automatically advancing to the next td after short reads.
516 */
David Brownell18807522005-11-23 15:45:37 -0800517 ehci->async->qh_next.qh = NULL;
Alek Du3807e262009-07-14 07:23:29 +0800518 hw = ehci->async->hw;
519 hw->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
520 hw->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
Ricardo Martins4f7a67e2012-05-22 18:02:03 +0100521#if defined(CONFIG_PPC_PS3)
Alan Stern4c53de72012-07-11 11:21:32 -0400522 hw->hw_info1 |= cpu_to_hc32(ehci, QH_INACTIVATE);
Ricardo Martins4f7a67e2012-05-22 18:02:03 +0100523#endif
Alek Du3807e262009-07-14 07:23:29 +0800524 hw->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
525 hw->hw_qtd_next = EHCI_LIST_END(ehci);
David Brownell18807522005-11-23 15:45:37 -0800526 ehci->async->qh_state = QH_STATE_LINKED;
Alek Du3807e262009-07-14 07:23:29 +0800527 hw->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529 /* clear interrupt enables, set irq latency */
530 if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
531 log2_irq_thresh = 0;
532 temp = 1 << (16 + log2_irq_thresh);
Alek Du5a9cdf32010-06-04 15:47:56 +0800533 if (HCC_PER_PORT_CHANGE_EVENT(hcc_params)) {
534 ehci->has_ppcd = 1;
535 ehci_dbg(ehci, "enable per-port change event\n");
536 temp |= CMD_PPCEE;
537 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 if (HCC_CANPARK(hcc_params)) {
539 /* HW default park == 3, on hardware that supports it (like
540 * NVidia and ALI silicon), maximizes throughput on the async
541 * schedule by avoiding QH fetches between transfers.
542 *
543 * With fast usb storage devices and NForce2, "park" seems to
544 * make problems: throughput reduction (!), data errors...
545 */
546 if (park) {
David Brownell18807522005-11-23 15:45:37 -0800547 park = min(park, (unsigned) 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 temp |= CMD_PARK;
549 temp |= park << 8;
550 }
David Brownell18807522005-11-23 15:45:37 -0800551 ehci_dbg(ehci, "park %d\n", park);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 }
David Brownell18807522005-11-23 15:45:37 -0800553 if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 /* periodic schedule size can be smaller than default */
555 temp &= ~(3 << 2);
556 temp |= (EHCI_TUNE_FLS << 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 }
David Brownell18807522005-11-23 15:45:37 -0800558 ehci->command = temp;
559
Alan Stern40f8db82009-11-06 12:29:40 -0500560 /* Accept arbitrarily long scatter-gather lists */
Andrea Righi4307a282010-06-28 16:56:45 +0200561 if (!(hcd->driver->flags & HCD_LOCAL_MEM))
562 hcd->self.sg_tablesize = ~0;
David Brownell18807522005-11-23 15:45:37 -0800563 return 0;
564}
565
566/* start HC running; it's halted, ehci_init() has been run (once) */
567static int ehci_run (struct usb_hcd *hcd)
568{
569 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
David Brownell18807522005-11-23 15:45:37 -0800570 u32 temp;
571 u32 hcc_params;
572
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200573 hcd->uses_new_polling = 1;
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200574
David Brownell18807522005-11-23 15:45:37 -0800575 /* EHCI spec section 4.1 */
Geoff Levand876e0df2011-11-22 18:04:45 -0800576
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100577 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
578 ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
David Brownell18807522005-11-23 15:45:37 -0800579
580 /*
581 * hcc_params controls whether ehci->regs->segment must (!!!)
582 * be used; it constrains QH/ITD/SITD and QTD locations.
583 * pci_pool consistent memory always uses segment zero.
584 * streaming mappings for I/O buffers, like pci_map_single(),
585 * can return segments above 4GB, if the device allows.
586 *
587 * NOTE: the dma mask is visible through dma_supported(), so
588 * drivers can pass this info along ... like NETIF_F_HIGHDMA,
589 * Scsi_Host.highmem_io, and so forth. It's readonly to all
590 * host side drivers though.
591 */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100592 hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
David Brownell18807522005-11-23 15:45:37 -0800593 if (HCC_64BIT_ADDR(hcc_params)) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100594 ehci_writel(ehci, 0, &ehci->regs->segment);
David Brownell18807522005-11-23 15:45:37 -0800595#if 0
596// this is deeply broken on almost all architectures
Yang Hongyang6a355282009-04-06 19:01:13 -0700597 if (!dma_set_mask(hcd->self.controller, DMA_BIT_MASK(64)))
David Brownell18807522005-11-23 15:45:37 -0800598 ehci_info(ehci, "enabled 64bit DMA\n");
599#endif
600 }
601
602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 // Philips, Intel, and maybe others need CMD_RUN before the
604 // root hub will detect new devices (why?); NEC doesn't
David Brownell18807522005-11-23 15:45:37 -0800605 ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
606 ehci->command |= CMD_RUN;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100607 ehci_writel(ehci, ehci->command, &ehci->regs->command);
David Brownell18807522005-11-23 15:45:37 -0800608 dbg_cmd (ehci, "init", ehci->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 /*
611 * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
612 * are explicitly handed to companion controller(s), so no TT is
613 * involved with the root hub. (Except where one is integrated,
614 * and there's no companion controller unless maybe for USB OTG.)
Alan Stern32fe0192007-10-10 16:27:07 -0400615 *
616 * Turning on the CF flag will transfer ownership of all ports
617 * from the companions to the EHCI controller. If any of the
618 * companions are in the middle of a port reset at the time, it
619 * could cause trouble. Write-locking ehci_cf_port_reset_rwsem
David Brownell1cb52652007-11-13 16:22:30 -0800620 * guarantees that no resets are in progress. After we set CF,
621 * a short delay lets the hardware catch up; new resets shouldn't
622 * be started before the port switching actions could complete.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 */
Alan Stern32fe0192007-10-10 16:27:07 -0400624 down_write(&ehci_cf_port_reset_rwsem);
Alan Sterne8799902011-08-18 16:31:30 -0400625 ehci->rh_state = EHCI_RH_RUNNING;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100626 ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
627 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
David Brownell1cb52652007-11-13 16:22:30 -0800628 msleep(5);
Alan Stern32fe0192007-10-10 16:27:07 -0400629 up_write(&ehci_cf_port_reset_rwsem);
Oliver Neukumee4ecb82009-11-27 15:17:59 +0100630 ehci->last_periodic_enable = ktime_get_real();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Jan Anderssonc4301312011-05-03 20:11:57 +0200632 temp = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 ehci_info (ehci,
Alan Stern2b70f072008-10-02 11:47:15 -0400634 "USB %x.%x started, EHCI %x.%02x%s\n",
Matt Porter7ff71d62005-09-22 22:31:15 -0700635 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
Alan Stern2b70f072008-10-02 11:47:15 -0400636 temp >> 8, temp & 0xff,
David Brownell93f1a472006-11-16 23:34:58 -0800637 ignore_oc ? ", overcurrent ignored" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100639 ehci_writel(ehci, INTR_MASK,
640 &ehci->regs->intr_enable); /* Turn On Interrupts */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
David Brownell18807522005-11-23 15:45:37 -0800642 /* GRR this is run-once init(), being done every time the HC starts.
643 * So long as they're part of class devices, we can't do it init()
644 * since the class device isn't created that early.
645 */
646 create_debug_files(ehci);
Kirill Smelkov4c670452011-07-03 20:36:56 +0400647 create_sysfs_files(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
649 return 0;
650}
651
Alan Stern3e023202012-11-01 11:12:58 -0400652int ehci_setup(struct usb_hcd *hcd)
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200653{
654 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
655 int retval;
656
657 ehci->regs = (void __iomem *)ehci->caps +
658 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
659 dbg_hcs_params(ehci, "reset");
660 dbg_hcc_params(ehci, "reset");
661
662 /* cache this readonly data; minimize chip reads */
663 ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
664
665 ehci->sbrn = HCD_USB2;
666
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200667 /* data structure init */
668 retval = ehci_init(hcd);
669 if (retval)
670 return retval;
671
Alan Stern631fe9d2012-07-11 11:21:09 -0400672 retval = ehci_halt(ehci);
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200673 if (retval)
674 return retval;
675
676 ehci_reset(ehci);
677
678 return 0;
679}
Alan Stern3e023202012-11-01 11:12:58 -0400680EXPORT_SYMBOL_GPL(ehci_setup);
Matthieu CASTET2093c6b2011-07-02 19:47:33 +0200681
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682/*-------------------------------------------------------------------------*/
683
David Howells7d12e782006-10-05 14:55:46 +0100684static irqreturn_t ehci_irq (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685{
686 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
Alan Stern67b2e022008-11-12 17:04:53 -0500687 u32 status, masked_status, pcd_status = 0, cmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 int bh;
689
690 spin_lock (&ehci->lock);
691
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100692 status = ehci_readl(ehci, &ehci->regs->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
694 /* e.g. cardbus physical eject */
695 if (status == ~(u32) 0) {
696 ehci_dbg (ehci, "device removed\n");
697 goto dead;
698 }
699
Alan Stern2fbe2bf2012-04-18 11:33:00 -0400700 /*
701 * We don't use STS_FLR, but some controllers don't like it to
702 * remain on, so mask it out along with the other status bits.
703 */
704 masked_status = status & (INTR_MASK | STS_FLR);
705
Alan Stern69fff592011-05-17 17:27:12 -0400706 /* Shared IRQ? */
Alan Sterne8799902011-08-18 16:31:30 -0400707 if (!masked_status || unlikely(ehci->rh_state == EHCI_RH_HALTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 spin_unlock(&ehci->lock);
709 return IRQ_NONE;
710 }
711
712 /* clear (just) interrupts */
Alan Stern67b2e022008-11-12 17:04:53 -0500713 ehci_writel(ehci, masked_status, &ehci->regs->status);
David Brownelle82cc122008-03-07 13:49:42 -0800714 cmd = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 bh = 0;
716
David Brownell9776afc2008-02-01 11:42:05 -0800717#ifdef VERBOSE_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 /* unrequested/ignored: Frame List Rollover */
719 dbg_status (ehci, "irq", status);
720#endif
721
722 /* INT, ERR, and IAA interrupt rates can be throttled */
723
724 /* normal [4.15.1.2] or error [4.15.1.1] completion */
725 if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
726 if (likely ((status & STS_ERR) == 0))
727 COUNT (ehci->stats.normal);
728 else
729 COUNT (ehci->stats.error);
730 bh = 1;
731 }
732
733 /* complete the unlinking of some qh [4.15.2.3] */
734 if (status & STS_IAA) {
Alan Stern9d938742012-07-11 11:22:44 -0400735
736 /* Turn off the IAA watchdog */
737 ehci->enabled_hrtimer_events &= ~BIT(EHCI_HRTIMER_IAA_WATCHDOG);
738
739 /*
740 * Mild optimization: Allow another IAAD to reset the
741 * hrtimer, if one occurs before the next expiration.
742 * In theory we could always cancel the hrtimer, but
743 * tests show that about half the time it will be reset
744 * for some other event anyway.
745 */
746 if (ehci->next_hrtimer_event == EHCI_HRTIMER_IAA_WATCHDOG)
747 ++ehci->next_hrtimer_event;
748
David Brownelle82cc122008-03-07 13:49:42 -0800749 /* guard against (alleged) silicon errata */
Alan Stern6feff1b2012-04-17 15:23:25 -0400750 if (cmd & CMD_IAAD)
David Brownelle82cc122008-03-07 13:49:42 -0800751 ehci_dbg(ehci, "IAA with IAAD still set?\n");
Alan Stern214ac7a2013-03-22 13:31:58 -0400752 if (ehci->iaa_in_progress)
Alan Stern99ac5b12012-07-11 11:21:38 -0400753 COUNT(ehci->stats.iaa);
Alan Stern6402c792013-03-01 10:50:08 -0500754 end_unlink_async(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 }
756
757 /* remote wakeup [4.3.1] */
David Brownelld97cc2f2005-12-22 17:05:18 -0800758 if (status & STS_PCD) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 unsigned i = HCS_N_PORTS (ehci->hcs_params);
Alan Stern4dd405a2013-03-18 12:05:08 -0400760 u32 ppcd = ~0;
David Brownelld1b18422008-03-05 23:37:52 -0800761
762 /* kick root hub later */
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200763 pcd_status = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
765 /* resume root hub? */
Alan Sterndc75ce92012-04-17 15:24:15 -0400766 if (ehci->rh_state == EHCI_RH_SUSPENDED)
Alan Stern8c033562006-11-09 14:42:16 -0500767 usb_hcd_resume_root_hub(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
Alek Du5a9cdf32010-06-04 15:47:56 +0800769 /* get per-port change detect bits */
770 if (ehci->has_ppcd)
771 ppcd = status >> 16;
772
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 while (i--) {
Alek Du5a9cdf32010-06-04 15:47:56 +0800774 int pstatus;
775
776 /* leverage per-port change bits feature */
Alan Stern4dd405a2013-03-18 12:05:08 -0400777 if (!(ppcd & (1 << i)))
Alek Du5a9cdf32010-06-04 15:47:56 +0800778 continue;
779 pstatus = ehci_readl(ehci,
780 &ehci->regs->port_status[i]);
David Brownellb972b682006-06-30 02:34:42 -0700781
782 if (pstatus & PORT_OWNER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 continue;
Alan Sterneafe5b92008-10-06 11:25:53 -0400784 if (!(test_bit(i, &ehci->suspended_ports) &&
785 ((pstatus & PORT_RESUME) ||
786 !(pstatus & PORT_SUSPEND)) &&
787 (pstatus & PORT_PE) &&
788 ehci->reset_done[i] == 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 continue;
790
791 /* start 20 msec resume signaling from this port,
792 * and make khubd collect PORT_STAT_C_SUSPEND to
Alan Stern49d0f072010-01-08 11:18:38 -0500793 * stop that signaling. Use 5 ms extra for safety,
794 * like usb_port_resume() does.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 */
Alan Stern49d0f072010-01-08 11:18:38 -0500796 ehci->reset_done[i] = jiffies + msecs_to_jiffies(25);
Alan Sterna448e4d2012-04-03 15:24:30 -0400797 set_bit(i, &ehci->resuming_ports);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
Alan Sternf292e7f2013-01-25 17:09:49 -0500799 usb_hcd_start_port_resume(&hcd->self, i);
Alan Stern61e8b852007-04-09 11:52:31 -0400800 mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 }
802 }
803
804 /* PCI errors [4.15.2.4] */
805 if (unlikely ((status & STS_FATAL) != 0)) {
Alan Stern67b2e022008-11-12 17:04:53 -0500806 ehci_err(ehci, "fatal error\n");
Alan Sterneafe5b92008-10-06 11:25:53 -0400807 dbg_cmd(ehci, "fatal", cmd);
808 dbg_status(ehci, "fatal", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809dead:
Alan Stern69fff592011-05-17 17:27:12 -0400810 usb_hc_died(hcd);
Alan Sternbf6387b2012-07-11 11:22:31 -0400811
812 /* Don't let the controller do anything more */
Alan Stern43fe3a92012-07-11 11:23:16 -0400813 ehci->shutdown = true;
Alan Sternbf6387b2012-07-11 11:22:31 -0400814 ehci->rh_state = EHCI_RH_STOPPING;
815 ehci->command &= ~(CMD_RUN | CMD_ASE | CMD_PSE);
816 ehci_writel(ehci, ehci->command, &ehci->regs->command);
817 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
818 ehci_handle_controller_death(ehci);
819
820 /* Handle completions when the controller stops */
821 bh = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 }
823
824 if (bh)
David Howells7d12e782006-10-05 14:55:46 +0100825 ehci_work (ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 spin_unlock (&ehci->lock);
David Brownelld1b18422008-03-05 23:37:52 -0800827 if (pcd_status)
Marcelo Tosatti1d619f12007-01-21 19:45:59 -0200828 usb_hcd_poll_rh_status(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 return IRQ_HANDLED;
830}
831
832/*-------------------------------------------------------------------------*/
833
834/*
835 * non-error returns are a promise to giveback() the urb later
836 * we drop ownership so next owner (or urb unlink) can get it
837 *
838 * urb + dev is in hcd.self.controller.urb_list
839 * we're queueing TDs onto software and hardware lists
840 *
841 * hcd-specific init for hcpriv hasn't been done yet
842 *
843 * NOTE: control, bulk, and interrupt share the same code to append TDs
844 * to a (possibly active) QH, and the same QH scanning code.
845 */
846static int ehci_urb_enqueue (
847 struct usb_hcd *hcd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 struct urb *urb,
Al Viro55016f12005-10-21 03:21:58 -0400849 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850) {
851 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
852 struct list_head qtd_list;
853
854 INIT_LIST_HEAD (&qtd_list);
855
856 switch (usb_pipetype (urb->pipe)) {
David Brownell25b70a82008-03-04 15:11:07 -0800857 case PIPE_CONTROL:
858 /* qh_completions() code doesn't handle all the fault cases
859 * in multi-TD control transfers. Even 1KB is rare anyway.
860 */
861 if (urb->transfer_buffer_length > (16 * 1024))
862 return -EMSGSIZE;
863 /* FALLTHROUGH */
864 /* case PIPE_BULK: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 default:
866 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
867 return -ENOMEM;
Alan Sterne9df41c2007-08-08 11:48:02 -0400868 return submit_async(ehci, urb, &qtd_list, mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
870 case PIPE_INTERRUPT:
871 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
872 return -ENOMEM;
Alan Sterne9df41c2007-08-08 11:48:02 -0400873 return intr_submit(ehci, urb, &qtd_list, mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
875 case PIPE_ISOCHRONOUS:
876 if (urb->dev->speed == USB_SPEED_HIGH)
877 return itd_submit (ehci, urb, mem_flags);
878 else
879 return sitd_submit (ehci, urb, mem_flags);
880 }
881}
882
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883/* remove from hardware lists
884 * completions normally happen asynchronously
885 */
886
Alan Sterne9df41c2007-08-08 11:48:02 -0400887static int ehci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888{
889 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
890 struct ehci_qh *qh;
891 unsigned long flags;
Alan Sterne9df41c2007-08-08 11:48:02 -0400892 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893
894 spin_lock_irqsave (&ehci->lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400895 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
896 if (rc)
897 goto done;
898
Alan Stern7655e312013-03-22 13:31:29 -0400899 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
900 /*
901 * We don't expedite dequeue for isochronous URBs.
902 * Just wait until they complete normally or their
903 * time slot expires.
904 */
905 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 qh = (struct ehci_qh *) urb->hcpriv;
Alan Stern7bc782d2013-03-22 13:31:11 -0400907 qh->exception = 1;
Alan Stern07d29b62007-12-11 16:05:30 -0500908 switch (qh->qh_state) {
909 case QH_STATE_LINKED:
Alan Stern7655e312013-03-22 13:31:29 -0400910 if (usb_pipetype(urb->pipe) == PIPE_INTERRUPT)
911 start_unlink_intr(ehci, qh);
912 else
913 start_unlink_async(ehci, qh);
Alan Stern07d29b62007-12-11 16:05:30 -0500914 break;
Alan Stern7bc782d2013-03-22 13:31:11 -0400915 case QH_STATE_COMPLETING:
916 qh->dequeue_during_giveback = 1;
917 break;
Alan Stern07d29b62007-12-11 16:05:30 -0500918 case QH_STATE_UNLINK:
919 case QH_STATE_UNLINK_WAIT:
920 /* already started */
921 break;
922 case QH_STATE_IDLE:
Alan Stern7a0f0d92009-07-31 10:40:22 -0400923 /* QH might be waiting for a Clear-TT-Buffer */
924 qh_completions(ehci, qh);
Alan Stern07d29b62007-12-11 16:05:30 -0500925 break;
926 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 }
928done:
929 spin_unlock_irqrestore (&ehci->lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400930 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931}
932
933/*-------------------------------------------------------------------------*/
934
935// bulk qh holds the data toggle
936
937static void
938ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
939{
940 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
941 unsigned long flags;
Ming Lei35371e42013-07-03 22:53:09 +0800942 struct ehci_qh *qh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
944 /* ASSERT: any requests/urbs are being unlinked */
945 /* ASSERT: nobody can be submitting urbs for this any more */
946
947rescan:
948 spin_lock_irqsave (&ehci->lock, flags);
949 qh = ep->hcpriv;
950 if (!qh)
951 goto done;
952
953 /* endpoints can be iso streams. for now, we don't
954 * accelerate iso completions ... so spin a while.
955 */
Clemens Ladisch1082f572010-03-01 17:18:56 +0100956 if (qh->hw == NULL) {
Alan Stern8c5bf7b2012-07-11 11:22:39 -0400957 struct ehci_iso_stream *stream = ep->hcpriv;
958
959 if (!list_empty(&stream->td_list))
960 goto idle_timeout;
961
962 /* BUG_ON(!list_empty(&stream->free_list)); */
Alan Sternd0ce5c62013-10-11 11:29:13 -0400963 reserve_release_iso_bandwidth(ehci, stream, -1);
Alan Stern8c5bf7b2012-07-11 11:22:39 -0400964 kfree(stream);
965 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 }
967
Alan Stern7bc782d2013-03-22 13:31:11 -0400968 qh->exception = 1;
Alan Sternc0c53db2012-07-11 11:21:48 -0400969 if (ehci->rh_state < EHCI_RH_RUNNING)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 qh->qh_state = QH_STATE_IDLE;
971 switch (qh->qh_state) {
972 case QH_STATE_LINKED:
Ming Lei35371e42013-07-03 22:53:09 +0800973 WARN_ON(!list_empty(&qh->qtd_list));
974 if (usb_endpoint_type(&ep->desc) != USB_ENDPOINT_XFER_INT)
Alan Stern3c273a02012-07-11 11:22:49 -0400975 start_unlink_async(ehci, qh);
Ming Lei35371e42013-07-03 22:53:09 +0800976 else
977 start_unlink_intr(ehci, qh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 /* FALL THROUGH */
Ming Lei35371e42013-07-03 22:53:09 +0800979 case QH_STATE_COMPLETING: /* already in unlinking */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 case QH_STATE_UNLINK: /* wait for hw to finish? */
Alan Stern07d29b62007-12-11 16:05:30 -0500981 case QH_STATE_UNLINK_WAIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982idle_timeout:
983 spin_unlock_irqrestore (&ehci->lock, flags);
Nishanth Aravamudan22c43862005-08-15 11:30:11 -0700984 schedule_timeout_uninterruptible(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 goto rescan;
986 case QH_STATE_IDLE: /* fully unlinked */
Alan Stern914b7012009-06-29 10:47:30 -0400987 if (qh->clearing_tt)
988 goto idle_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 if (list_empty (&qh->qtd_list)) {
Alan Sternd0ce5c62013-10-11 11:29:13 -0400990 if (qh->ps.bw_uperiod)
991 reserve_release_intr_bandwidth(ehci, qh, -1);
Alan Sternc83e1a92012-07-11 11:21:25 -0400992 qh_destroy(ehci, qh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 break;
994 }
995 /* else FALL THROUGH */
996 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 /* caller was supposed to have unlinked any requests;
998 * that's not our job. just leak this memory.
999 */
1000 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1001 qh, ep->desc.bEndpointAddress, qh->qh_state,
1002 list_empty (&qh->qtd_list) ? "" : "(has tds)");
1003 break;
1004 }
Alan Stern8c5bf7b2012-07-11 11:22:39 -04001005 done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 ep->hcpriv = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 spin_unlock_irqrestore (&ehci->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008}
1009
Alan Sternb18ffd42009-05-27 18:21:56 -04001010static void
1011ehci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1012{
1013 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1014 struct ehci_qh *qh;
1015 int eptype = usb_endpoint_type(&ep->desc);
Alan Sterna455212d2009-06-11 14:56:22 -04001016 int epnum = usb_endpoint_num(&ep->desc);
1017 int is_out = usb_endpoint_dir_out(&ep->desc);
1018 unsigned long flags;
Alan Sternb18ffd42009-05-27 18:21:56 -04001019
1020 if (eptype != USB_ENDPOINT_XFER_BULK && eptype != USB_ENDPOINT_XFER_INT)
1021 return;
1022
Alan Sterna455212d2009-06-11 14:56:22 -04001023 spin_lock_irqsave(&ehci->lock, flags);
Alan Sternb18ffd42009-05-27 18:21:56 -04001024 qh = ep->hcpriv;
1025
1026 /* For Bulk and Interrupt endpoints we maintain the toggle state
1027 * in the hardware; the toggle bits in udev aren't used at all.
1028 * When an endpoint is reset by usb_clear_halt() we must reset
1029 * the toggle bit in the QH.
1030 */
1031 if (qh) {
1032 if (!list_empty(&qh->qtd_list)) {
1033 WARN_ONCE(1, "clear_halt for a busy endpoint\n");
Alan Stern7bc782d2013-03-22 13:31:11 -04001034 } else {
Alan Sterna455212d2009-06-11 14:56:22 -04001035 /* The toggle value in the QH can't be updated
1036 * while the QH is active. Unlink it now;
1037 * re-linking will call qh_refresh().
Alan Sternb18ffd42009-05-27 18:21:56 -04001038 */
Alan Sternffa02482013-10-11 11:29:03 -04001039 usb_settoggle(qh->ps.udev, epnum, is_out, 0);
Alan Stern7bc782d2013-03-22 13:31:11 -04001040 qh->exception = 1;
Alan Sterna448c9d2009-08-19 12:22:44 -04001041 if (eptype == USB_ENDPOINT_XFER_BULK)
Alan Stern3c273a02012-07-11 11:22:49 -04001042 start_unlink_async(ehci, qh);
Alan Sterna448c9d2009-08-19 12:22:44 -04001043 else
Alan Sterndf202252012-07-11 11:22:26 -04001044 start_unlink_intr(ehci, qh);
Alan Sternb18ffd42009-05-27 18:21:56 -04001045 }
1046 }
Alan Sterna455212d2009-06-11 14:56:22 -04001047 spin_unlock_irqrestore(&ehci->lock, flags);
Alan Sternb18ffd42009-05-27 18:21:56 -04001048}
1049
Matt Porter7ff71d62005-09-22 22:31:15 -07001050static int ehci_get_frame (struct usb_hcd *hcd)
1051{
1052 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
Alan Stern68aa95d2011-10-12 10:39:14 -04001053 return (ehci_read_frame_index(ehci) >> 3) % ehci->periodic_size;
Matt Porter7ff71d62005-09-22 22:31:15 -07001054}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055
1056/*-------------------------------------------------------------------------*/
Alan Sternc5cf9212012-06-28 11:19:02 -04001057
Alan Sternb35c5002013-10-11 22:16:21 -04001058/* Device addition and removal */
1059
1060static void ehci_remove_device(struct usb_hcd *hcd, struct usb_device *udev)
1061{
1062 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1063
1064 spin_lock_irq(&ehci->lock);
1065 drop_tt(udev);
1066 spin_unlock_irq(&ehci->lock);
1067}
1068
1069/*-------------------------------------------------------------------------*/
1070
Alan Sternc5cf9212012-06-28 11:19:02 -04001071#ifdef CONFIG_PM
1072
1073/* suspend/resume, section 4.3 */
1074
1075/* These routines handle the generic parts of controller suspend/resume */
1076
Alan Stern3e023202012-11-01 11:12:58 -04001077int ehci_suspend(struct usb_hcd *hcd, bool do_wakeup)
Alan Sternc5cf9212012-06-28 11:19:02 -04001078{
1079 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1080
1081 if (time_before(jiffies, ehci->next_statechange))
1082 msleep(10);
1083
1084 /*
1085 * Root hub was already suspended. Disable IRQ emission and
1086 * mark HW unaccessible. The PM and USB cores make sure that
1087 * the root hub is either suspended or stopped.
1088 */
1089 ehci_prepare_ports_for_controller_suspend(ehci, do_wakeup);
1090
1091 spin_lock_irq(&ehci->lock);
1092 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
1093 (void) ehci_readl(ehci, &ehci->regs->intr_enable);
1094
1095 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1096 spin_unlock_irq(&ehci->lock);
1097
Alan Sternb8efdaf2013-10-18 11:18:21 -04001098 synchronize_irq(hcd->irq);
1099
1100 /* Check for race with a wakeup request */
1101 if (do_wakeup && HCD_WAKEUP_PENDING(hcd)) {
1102 ehci_resume(hcd, false);
1103 return -EBUSY;
1104 }
1105
Alan Sternc5cf9212012-06-28 11:19:02 -04001106 return 0;
1107}
Alan Stern3e023202012-11-01 11:12:58 -04001108EXPORT_SYMBOL_GPL(ehci_suspend);
Alan Sternc5cf9212012-06-28 11:19:02 -04001109
1110/* Returns 0 if power was preserved, 1 if power was lost */
Alan Stern3e023202012-11-01 11:12:58 -04001111int ehci_resume(struct usb_hcd *hcd, bool hibernated)
Alan Sternc5cf9212012-06-28 11:19:02 -04001112{
1113 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1114
1115 if (time_before(jiffies, ehci->next_statechange))
1116 msleep(100);
1117
1118 /* Mark hardware accessible again as we are back to full power by now */
1119 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1120
Alan Stern43fe3a92012-07-11 11:23:16 -04001121 if (ehci->shutdown)
1122 return 0; /* Controller is dead */
1123
Alan Sternc5cf9212012-06-28 11:19:02 -04001124 /*
1125 * If CF is still set and we aren't resuming from hibernation
1126 * then we maintained suspend power.
1127 * Just undo the effect of ehci_suspend().
1128 */
1129 if (ehci_readl(ehci, &ehci->regs->configured_flag) == FLAG_CF &&
1130 !hibernated) {
1131 int mask = INTR_MASK;
1132
1133 ehci_prepare_ports_for_controller_resume(ehci);
Alan Stern43fe3a92012-07-11 11:23:16 -04001134
1135 spin_lock_irq(&ehci->lock);
1136 if (ehci->shutdown)
1137 goto skip;
1138
Alan Sternc5cf9212012-06-28 11:19:02 -04001139 if (!hcd->self.root_hub->do_remote_wakeup)
1140 mask &= ~STS_PCD;
1141 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
1142 ehci_readl(ehci, &ehci->regs->intr_enable);
Alan Stern43fe3a92012-07-11 11:23:16 -04001143 skip:
1144 spin_unlock_irq(&ehci->lock);
Alan Sternc5cf9212012-06-28 11:19:02 -04001145 return 0;
1146 }
1147
1148 /*
1149 * Else reset, to cope with power loss or resume from hibernation
1150 * having let the firmware kick in during reboot.
1151 */
1152 usb_root_hub_lost_power(hcd->self.root_hub);
1153 (void) ehci_halt(ehci);
1154 (void) ehci_reset(ehci);
1155
Alan Stern43fe3a92012-07-11 11:23:16 -04001156 spin_lock_irq(&ehci->lock);
1157 if (ehci->shutdown)
1158 goto skip;
1159
Alan Sternc5cf9212012-06-28 11:19:02 -04001160 ehci_writel(ehci, ehci->command, &ehci->regs->command);
1161 ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
1162 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1163
Alan Stern43fe3a92012-07-11 11:23:16 -04001164 ehci->rh_state = EHCI_RH_SUSPENDED;
1165 spin_unlock_irq(&ehci->lock);
1166
Alan Sternc5cf9212012-06-28 11:19:02 -04001167 return 1;
1168}
Alan Stern3e023202012-11-01 11:12:58 -04001169EXPORT_SYMBOL_GPL(ehci_resume);
Alan Sternc5cf9212012-06-28 11:19:02 -04001170
1171#endif
1172
1173/*-------------------------------------------------------------------------*/
1174
Alexander Shishkineb70e5a2012-05-11 17:25:54 +03001175/*
Alan Stern3e023202012-11-01 11:12:58 -04001176 * Generic structure: This gets copied for platform drivers so that
1177 * individual entries can be overridden as needed.
1178 */
1179
1180static const struct hc_driver ehci_hc_driver = {
1181 .description = hcd_name,
1182 .product_desc = "EHCI Host Controller",
1183 .hcd_priv_size = sizeof(struct ehci_hcd),
1184
1185 /*
1186 * generic hardware linkage
1187 */
1188 .irq = ehci_irq,
Greg Kroah-Hartmanc04ee4b2013-09-23 13:32:51 -07001189 .flags = HCD_MEMORY | HCD_USB2 | HCD_BH,
Alan Stern3e023202012-11-01 11:12:58 -04001190
1191 /*
1192 * basic lifecycle operations
1193 */
1194 .reset = ehci_setup,
1195 .start = ehci_run,
1196 .stop = ehci_stop,
1197 .shutdown = ehci_shutdown,
1198
1199 /*
1200 * managing i/o requests and associated device resources
1201 */
1202 .urb_enqueue = ehci_urb_enqueue,
1203 .urb_dequeue = ehci_urb_dequeue,
1204 .endpoint_disable = ehci_endpoint_disable,
1205 .endpoint_reset = ehci_endpoint_reset,
1206 .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
1207
1208 /*
1209 * scheduling support
1210 */
1211 .get_frame_number = ehci_get_frame,
1212
1213 /*
1214 * root hub support
1215 */
1216 .hub_status_data = ehci_hub_status_data,
1217 .hub_control = ehci_hub_control,
1218 .bus_suspend = ehci_bus_suspend,
1219 .bus_resume = ehci_bus_resume,
1220 .relinquish_port = ehci_relinquish_port,
1221 .port_handed_over = ehci_port_handed_over,
Alan Sternb35c5002013-10-11 22:16:21 -04001222
1223 /*
1224 * device support
1225 */
1226 .free_dev = ehci_remove_device,
Alan Stern3e023202012-11-01 11:12:58 -04001227};
1228
1229void ehci_init_driver(struct hc_driver *drv,
1230 const struct ehci_driver_overrides *over)
1231{
1232 /* Copy the generic table to drv and then apply the overrides */
1233 *drv = ehci_hc_driver;
1234
Alan Stern1b368102012-11-07 16:12:47 -05001235 if (over) {
1236 drv->hcd_priv_size += over->extra_priv_size;
1237 if (over->reset)
1238 drv->reset = over->reset;
1239 }
Alan Stern3e023202012-11-01 11:12:58 -04001240}
1241EXPORT_SYMBOL_GPL(ehci_init_driver);
1242
1243/*-------------------------------------------------------------------------*/
1244
Alan Stern2b70f072008-10-02 11:47:15 -04001245MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246MODULE_AUTHOR (DRIVER_AUTHOR);
1247MODULE_LICENSE ("GPL");
1248
Li Yangba029782007-05-11 17:09:55 +08001249#ifdef CONFIG_USB_EHCI_FSL
Randy Vinson80cb9ae2006-01-20 13:53:38 -08001250#include "ehci-fsl.c"
Kumar Gala01cced22006-04-11 10:07:16 -05001251#define PLATFORM_DRIVER ehci_fsl_driver
Randy Vinson80cb9ae2006-01-20 13:53:38 -08001252#endif
1253
Yoshihiro Shimoda60b0bf02011-03-01 16:58:37 +09001254#ifdef CONFIG_USB_EHCI_SH
Paul Mundt63c84552010-11-01 17:03:27 -04001255#include "ehci-sh.c"
1256#define PLATFORM_DRIVER ehci_hcd_sh_driver
1257#endif
1258
Geoff Levandad75a412007-01-15 20:11:47 -08001259#ifdef CONFIG_PPC_PS3
1260#include "ehci-ps3.c"
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001261#define PS3_SYSTEM_BUS_DRIVER ps3_ehci_driver
Geoff Levandad75a412007-01-15 20:11:47 -08001262#endif
1263
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001264#ifdef CONFIG_USB_EHCI_HCD_PPC_OF
1265#include "ehci-ppc-of.c"
1266#define OF_PLATFORM_DRIVER ehci_hcd_ppc_of_driver
1267#endif
1268
Julie Zhu08d3c182009-09-21 16:08:19 -06001269#ifdef CONFIG_XPS_USB_HCD_XILINX
1270#include "ehci-xilinx-of.c"
Grant Likely1f23b2d2010-06-02 13:53:17 -06001271#define XILINX_OF_PLATFORM_DRIVER ehci_hcd_xilinx_of_driver
Julie Zhu08d3c182009-09-21 16:08:19 -06001272#endif
1273
David Daney1643acc2010-10-08 14:47:52 -07001274#ifdef CONFIG_USB_OCTEON_EHCI
1275#include "ehci-octeon.c"
1276#define PLATFORM_DRIVER ehci_octeon_driver
1277#endif
1278
Chris Metcalf47fc28b2012-05-09 13:58:14 -04001279#ifdef CONFIG_TILE_USB
1280#include "ehci-tilegx.c"
1281#define PLATFORM_DRIVER ehci_hcd_tilegx_driver
1282#endif
1283
Anoop22ced6872011-02-24 19:26:28 +05301284#ifdef CONFIG_USB_EHCI_HCD_PMC_MSP
1285#include "ehci-pmcmsp.c"
1286#define PLATFORM_DRIVER ehci_hcd_msp_driver
1287#endif
1288
Jan Andersson9be03922011-05-03 20:11:58 +02001289#ifdef CONFIG_SPARC_LEON
1290#include "ehci-grlib.c"
1291#define PLATFORM_DRIVER ehci_grlib_driver
1292#endif
1293
Neil Zhang3a082ec2011-12-20 13:20:23 +08001294#ifdef CONFIG_USB_EHCI_MV
1295#include "ehci-mv.c"
1296#define PLATFORM_DRIVER ehci_mv_driver
1297#endif
1298
Steven J. Hillc2566672012-04-19 12:57:31 -05001299#ifdef CONFIG_MIPS_SEAD3
1300#include "ehci-sead3.c"
1301#define PLATFORM_DRIVER ehci_hcd_sead3_driver
1302#endif
1303
Kumar Gala01cced22006-04-11 10:07:16 -05001304static int __init ehci_hcd_init(void)
1305{
1306 int retval = 0;
1307
Alan Stern2b70f072008-10-02 11:47:15 -04001308 if (usb_disabled())
1309 return -ENODEV;
1310
1311 printk(KERN_INFO "%s: " DRIVER_DESC "\n", hcd_name);
Alan Stern9beeee62008-10-02 11:48:13 -04001312 set_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1313 if (test_bit(USB_UHCI_LOADED, &usb_hcds_loaded) ||
1314 test_bit(USB_OHCI_LOADED, &usb_hcds_loaded))
1315 printk(KERN_WARNING "Warning! ehci_hcd should always be loaded"
1316 " before uhci_hcd and ohci_hcd, not after\n");
1317
Kumar Gala01cced22006-04-11 10:07:16 -05001318 pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1319 hcd_name,
1320 sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
1321 sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
1322
Xenia Ragiadakou1512c912013-08-29 11:45:13 +03001323#if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
Greg Kroah-Hartman08f4e582009-04-24 15:13:18 -07001324 ehci_debug_root = debugfs_create_dir("ehci", usb_debug_root);
Alan Stern9beeee62008-10-02 11:48:13 -04001325 if (!ehci_debug_root) {
1326 retval = -ENOENT;
1327 goto err_debug;
1328 }
Tony Jones694cc202007-09-11 14:07:31 -07001329#endif
1330
Kumar Gala01cced22006-04-11 10:07:16 -05001331#ifdef PLATFORM_DRIVER
1332 retval = platform_driver_register(&PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001333 if (retval < 0)
1334 goto clean0;
Kumar Gala01cced22006-04-11 10:07:16 -05001335#endif
1336
Geoff Levandad75a412007-01-15 20:11:47 -08001337#ifdef PS3_SYSTEM_BUS_DRIVER
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001338 retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001339 if (retval < 0)
1340 goto clean2;
Kumar Gala01cced22006-04-11 10:07:16 -05001341#endif
1342
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001343#ifdef OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001344 retval = platform_driver_register(&OF_PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001345 if (retval < 0)
1346 goto clean3;
1347#endif
Grant Likely1f23b2d2010-06-02 13:53:17 -06001348
1349#ifdef XILINX_OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001350 retval = platform_driver_register(&XILINX_OF_PLATFORM_DRIVER);
Grant Likely1f23b2d2010-06-02 13:53:17 -06001351 if (retval < 0)
1352 goto clean4;
1353#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001354 return retval;
1355
Grant Likely1f23b2d2010-06-02 13:53:17 -06001356#ifdef XILINX_OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001357 /* platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER); */
Grant Likely1f23b2d2010-06-02 13:53:17 -06001358clean4:
1359#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001360#ifdef OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001361 platform_driver_unregister(&OF_PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001362clean3:
1363#endif
1364#ifdef PS3_SYSTEM_BUS_DRIVER
1365 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1366clean2:
1367#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001368#ifdef PLATFORM_DRIVER
1369 platform_driver_unregister(&PLATFORM_DRIVER);
1370clean0:
1371#endif
Xenia Ragiadakou1512c912013-08-29 11:45:13 +03001372#if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001373 debugfs_remove(ehci_debug_root);
1374 ehci_debug_root = NULL;
Alan Stern9beeee62008-10-02 11:48:13 -04001375err_debug:
Linus Torvaldsa9b61482008-10-20 14:23:29 -07001376#endif
Alan Stern9beeee62008-10-02 11:48:13 -04001377 clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
Kumar Gala01cced22006-04-11 10:07:16 -05001378 return retval;
1379}
1380module_init(ehci_hcd_init);
1381
1382static void __exit ehci_hcd_cleanup(void)
1383{
Grant Likely1f23b2d2010-06-02 13:53:17 -06001384#ifdef XILINX_OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001385 platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER);
Grant Likely1f23b2d2010-06-02 13:53:17 -06001386#endif
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001387#ifdef OF_PLATFORM_DRIVER
Grant Likelyd35fb642011-02-22 21:08:34 -07001388 platform_driver_unregister(&OF_PLATFORM_DRIVER);
Valentine Barshakda0e8fb2007-12-30 15:28:50 -08001389#endif
Kumar Gala01cced22006-04-11 10:07:16 -05001390#ifdef PLATFORM_DRIVER
1391 platform_driver_unregister(&PLATFORM_DRIVER);
1392#endif
Geoff Levandad75a412007-01-15 20:11:47 -08001393#ifdef PS3_SYSTEM_BUS_DRIVER
Geoff Levand7a4eb7f2007-06-05 20:04:35 -07001394 ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
Geoff Levandad75a412007-01-15 20:11:47 -08001395#endif
Xenia Ragiadakou1512c912013-08-29 11:45:13 +03001396#if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
Tony Jones694cc202007-09-11 14:07:31 -07001397 debugfs_remove(ehci_debug_root);
1398#endif
Alan Stern9beeee62008-10-02 11:48:13 -04001399 clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
Kumar Gala01cced22006-04-11 10:07:16 -05001400}
1401module_exit(ehci_hcd_cleanup);