blob: f52d04db28f47f2e0b360ac90a87dd14d39ce7db [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Universal Host Controller Interface driver for USB.
3 *
4 * Maintainer: Alan Stern <stern@rowland.harvard.edu>
5 *
6 * (C) Copyright 1999 Linus Torvalds
7 * (C) Copyright 1999-2002 Johannes Erdfelt, johannes@erdfelt.com
8 * (C) Copyright 1999 Randy Dunlap
9 * (C) Copyright 1999 Georg Acher, acher@in.tum.de
10 * (C) Copyright 1999 Deti Fliegl, deti@fliegl.de
11 * (C) Copyright 1999 Thomas Sailer, sailer@ife.ee.ethz.ch
12 * (C) Copyright 1999 Roman Weissgaerber, weissg@vienna.at
13 * (C) Copyright 2000 Yggdrasil Computing, Inc. (port of new PCI interface
14 * support from usb-ohci.c by Adam Richter, adam@yggdrasil.com).
15 * (C) Copyright 1999 Gregory P. Smith (from usb-ohci.c)
Alan Stern17230ac2007-02-19 15:52:45 -050016 * (C) Copyright 2004-2007 Alan Stern, stern@rowland.harvard.edu
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 *
18 * Intel documents this fairly well, and as far as I know there
19 * are no royalties or anything like that, but even so there are
20 * people who decided that they want to do the same thing in a
21 * completely different way.
22 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 */
24
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/module.h>
26#include <linux/pci.h>
27#include <linux/kernel.h>
28#include <linux/init.h>
29#include <linux/delay.h>
30#include <linux/ioport.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/errno.h>
33#include <linux/unistd.h>
34#include <linux/interrupt.h>
35#include <linux/spinlock.h>
36#include <linux/debugfs.h>
37#include <linux/pm.h>
38#include <linux/dmapool.h>
39#include <linux/dma-mapping.h>
40#include <linux/usb.h>
Eric Lescouet27729aa2010-04-24 23:21:52 +020041#include <linux/usb/hcd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#include <linux/bitops.h>
Alan Sternb62df452006-10-10 10:54:00 -040043#include <linux/dmi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45#include <asm/uaccess.h>
46#include <asm/io.h>
47#include <asm/irq.h>
48#include <asm/system.h>
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#include "uhci-hcd.h"
Adrian Bunk75e2df62006-03-25 18:01:53 +010051#include "pci-quirks.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53/*
54 * Version Information
55 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#define DRIVER_AUTHOR "Linus 'Frodo Rabbit' Torvalds, Johannes Erdfelt, \
57Randy Dunlap, Georg Acher, Deti Fliegl, Thomas Sailer, Roman Weissgaerber, \
58Alan Stern"
59#define DRIVER_DESC "USB Universal Host Controller Interface driver"
60
Alan Stern5f8364b2006-12-05 16:29:55 -050061/* for flakey hardware, ignore overcurrent indicators */
62static int ignore_oc;
63module_param(ignore_oc, bool, S_IRUGO);
64MODULE_PARM_DESC(ignore_oc, "ignore hardware overcurrent indications");
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066/*
67 * debug = 0, no debugging messages
Alan Stern687f5f32005-11-30 17:16:19 -050068 * debug = 1, dump failed URBs except for stalls
69 * debug = 2, dump all failed URBs (including stalls)
GeunSik Lim837cbb02009-09-07 21:39:05 +090070 * show all queues in /sys/kernel/debug/uhci/[pci_addr]
Alan Stern687f5f32005-11-30 17:16:19 -050071 * debug = 3, show all TDs in URBs when dumping
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 */
73#ifdef DEBUG
Alan Stern8d402e12005-12-17 18:03:37 -050074#define DEBUG_CONFIGURED 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070075static int debug = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076module_param(debug, int, S_IRUGO | S_IWUSR);
77MODULE_PARM_DESC(debug, "Debug level");
Alan Stern8d402e12005-12-17 18:03:37 -050078
79#else
80#define DEBUG_CONFIGURED 0
81#define debug 0
82#endif
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084static char *errbuf;
85#define ERRBUF_LEN (32 * 1024)
86
Christoph Lametere18b8902006-12-06 20:33:20 -080087static struct kmem_cache *uhci_up_cachep; /* urb_priv */
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Alan Stern6c1b4452005-04-21 16:04:58 -040089static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state);
90static void wakeup_rh(struct uhci_hcd *uhci);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091static void uhci_get_current_frame_number(struct uhci_hcd *uhci);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Alan Sternf3fe239b2007-01-08 12:00:28 -050093/*
94 * Calculate the link pointer DMA value for the first Skeleton QH in a frame.
95 */
96static __le32 uhci_frame_skel_link(struct uhci_hcd *uhci, int frame)
97{
98 int skelnum;
99
100 /*
101 * The interrupt queues will be interleaved as evenly as possible.
102 * There's not much to be done about period-1 interrupts; they have
103 * to occur in every frame. But we can schedule period-2 interrupts
104 * in odd-numbered frames, period-4 interrupts in frames congruent
105 * to 2 (mod 4), and so on. This way each frame only has two
106 * interrupt QHs, which will help spread out bandwidth utilization.
107 *
108 * ffs (Find First bit Set) does exactly what we need:
Alan Stern17230ac2007-02-19 15:52:45 -0500109 * 1,3,5,... => ffs = 0 => use period-2 QH = skelqh[8],
110 * 2,6,10,... => ffs = 1 => use period-4 QH = skelqh[7], etc.
Alan Sternf3fe239b2007-01-08 12:00:28 -0500111 * ffs >= 7 => not on any high-period queue, so use
Alan Stern17230ac2007-02-19 15:52:45 -0500112 * period-1 QH = skelqh[9].
Alan Sternf3fe239b2007-01-08 12:00:28 -0500113 * Add in UHCI_NUMFRAMES to insure at least one bit is set.
114 */
115 skelnum = 8 - (int) __ffs(frame | UHCI_NUMFRAMES);
116 if (skelnum <= 1)
117 skelnum = 9;
Alan Stern28b93252007-02-19 15:51:51 -0500118 return LINK_TO_QH(uhci->skelqh[skelnum]);
Alan Sternf3fe239b2007-01-08 12:00:28 -0500119}
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121#include "uhci-debug.c"
122#include "uhci-q.c"
Alan Stern1f09df82005-09-05 13:59:51 -0400123#include "uhci-hub.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Alan Sterna8bed8b2005-04-09 17:29:00 -0400125/*
Alan Sternbb200f62005-10-03 16:36:29 -0400126 * Finish up a host controller reset and update the recorded state.
Alan Sterna8bed8b2005-04-09 17:29:00 -0400127 */
Alan Sternbb200f62005-10-03 16:36:29 -0400128static void finish_reset(struct uhci_hcd *uhci)
Alan Stern014e73c2005-04-09 17:24:42 -0400129{
Alan Sternc074b412005-04-22 14:39:12 -0400130 int port;
131
Alan Sternc074b412005-04-22 14:39:12 -0400132 /* HCRESET doesn't affect the Suspend, Reset, and Resume Detect
133 * bits in the port status and control registers.
134 * We have to clear them by hand.
135 */
136 for (port = 0; port < uhci->rh_numports; ++port)
137 outw(0, uhci->io_addr + USBPORTSC1 + (port * 2));
138
Alan Stern8e326402006-04-04 14:47:44 -0400139 uhci->port_c_suspend = uhci->resuming_ports = 0;
Alan Sternc8f4fe42005-04-09 17:27:32 -0400140 uhci->rh_state = UHCI_RH_RESET;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400141 uhci->is_stopped = UHCI_IS_STOPPED;
142 uhci_to_hcd(uhci)->state = HC_STATE_HALT;
Alan Stern541c7d42010-06-22 16:39:10 -0400143 clear_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
Alan Sterne323de462006-06-05 12:21:30 -0400144
145 uhci->dead = 0; /* Full reset resurrects the controller */
Alan Stern014e73c2005-04-09 17:24:42 -0400146}
147
Alan Sterna8bed8b2005-04-09 17:29:00 -0400148/*
Alan Stern4daaa872005-04-09 17:30:08 -0400149 * Last rites for a defunct/nonfunctional controller
Alan Stern02597d22005-04-28 14:51:27 -0400150 * or one we don't want to use any more.
Alan Stern4daaa872005-04-09 17:30:08 -0400151 */
Alan Sterne323de462006-06-05 12:21:30 -0400152static void uhci_hc_died(struct uhci_hcd *uhci)
Alan Stern4daaa872005-04-09 17:30:08 -0400153{
Alan Sterne323de462006-06-05 12:21:30 -0400154 uhci_get_current_frame_number(uhci);
Alan Sternbb200f62005-10-03 16:36:29 -0400155 uhci_reset_hc(to_pci_dev(uhci_dev(uhci)), uhci->io_addr);
156 finish_reset(uhci);
Alan Sterne323de462006-06-05 12:21:30 -0400157 uhci->dead = 1;
158
159 /* The current frame may already be partway finished */
160 ++uhci->frame_number;
Alan Stern4daaa872005-04-09 17:30:08 -0400161}
162
163/*
David Brownellbe3cbc52006-06-05 12:16:39 -0400164 * Initialize a controller that was newly discovered or has lost power
165 * or otherwise been reset while it was suspended. In none of these cases
166 * can we be sure of its previous state.
Alan Sterna8bed8b2005-04-09 17:29:00 -0400167 */
168static void check_and_reset_hc(struct uhci_hcd *uhci)
169{
Alan Sternbb200f62005-10-03 16:36:29 -0400170 if (uhci_check_and_reset_hc(to_pci_dev(uhci_dev(uhci)), uhci->io_addr))
171 finish_reset(uhci);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400172}
173
174/*
175 * Store the basic register settings needed by the controller.
176 */
177static void configure_hc(struct uhci_hcd *uhci)
178{
Alan Stern0d436b42010-06-25 14:02:49 -0400179 struct pci_dev *pdev = to_pci_dev(uhci_dev(uhci));
180
Alan Sterna8bed8b2005-04-09 17:29:00 -0400181 /* Set the frame length to the default: 1 ms exactly */
182 outb(USBSOF_DEFAULT, uhci->io_addr + USBSOF);
183
184 /* Store the frame list base address */
Alan Sterna1d59ce2005-09-16 14:22:51 -0400185 outl(uhci->frame_dma_handle, uhci->io_addr + USBFLBASEADD);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400186
187 /* Set the current frame number */
Alan Sternc4334722006-05-19 16:34:57 -0400188 outw(uhci->frame_number & UHCI_MAX_SOF_NUMBER,
189 uhci->io_addr + USBFRNUM);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400190
Alan Sternf37be9b2005-10-17 10:42:06 -0400191 /* Mark controller as not halted before we enable interrupts */
192 uhci_to_hcd(uhci)->state = HC_STATE_SUSPENDED;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400193 mb();
194
195 /* Enable PIRQ */
Alan Stern0d436b42010-06-25 14:02:49 -0400196 pci_write_config_word(pdev, USBLEGSUP, USBLEGSUP_DEFAULT);
197
198 /* Disable platform-specific non-PME# wakeup */
199 if (pdev->vendor == PCI_VENDOR_ID_INTEL)
200 pci_write_config_byte(pdev, USBRES_INTEL, 0);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400201}
202
203
Alan Sternc8f4fe42005-04-09 17:27:32 -0400204static int resume_detect_interrupts_are_broken(struct uhci_hcd *uhci)
Alan Stern014e73c2005-04-09 17:24:42 -0400205{
Alan Sternc8f4fe42005-04-09 17:27:32 -0400206 int port;
Alan Stern014e73c2005-04-09 17:24:42 -0400207
Alan Stern5f8364b2006-12-05 16:29:55 -0500208 /* If we have to ignore overcurrent events then almost by definition
209 * we can't depend on resume-detect interrupts. */
210 if (ignore_oc)
211 return 1;
212
Alan Sternc8f4fe42005-04-09 17:27:32 -0400213 switch (to_pci_dev(uhci_dev(uhci))->vendor) {
214 default:
215 break;
Alan Stern014e73c2005-04-09 17:24:42 -0400216
Alan Sternc8f4fe42005-04-09 17:27:32 -0400217 case PCI_VENDOR_ID_GENESYS:
218 /* Genesys Logic's GL880S controllers don't generate
219 * resume-detect interrupts.
220 */
221 return 1;
222
223 case PCI_VENDOR_ID_INTEL:
224 /* Some of Intel's USB controllers have a bug that causes
225 * resume-detect interrupts if any port has an over-current
226 * condition. To make matters worse, some motherboards
227 * hardwire unused USB ports' over-current inputs active!
228 * To prevent problems, we will not enable resume-detect
229 * interrupts if any ports are OC.
230 */
231 for (port = 0; port < uhci->rh_numports; ++port) {
232 if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
233 USBPORTSC_OC)
234 return 1;
235 }
236 break;
237 }
238 return 0;
239}
240
Alan Sternd8f12ab2008-04-22 10:49:15 -0400241static int global_suspend_mode_is_broken(struct uhci_hcd *uhci)
Alan Sternb62df452006-10-10 10:54:00 -0400242{
Alan Sternb62df452006-10-10 10:54:00 -0400243 int port;
Jeff Garzik18552562007-10-03 15:15:40 -0400244 const char *sys_info;
Alan Sternc80a70d2006-12-15 16:06:25 -0500245 static char bad_Asus_board[] = "A7V8X";
Alan Sternb62df452006-10-10 10:54:00 -0400246
247 /* One of Asus's motherboards has a bug which causes it to
248 * wake up immediately from suspend-to-RAM if any of the ports
249 * are connected. In such cases we will not set EGSM.
250 */
Alan Sternc80a70d2006-12-15 16:06:25 -0500251 sys_info = dmi_get_system_info(DMI_BOARD_NAME);
252 if (sys_info && !strcmp(sys_info, bad_Asus_board)) {
Alan Sternb62df452006-10-10 10:54:00 -0400253 for (port = 0; port < uhci->rh_numports; ++port) {
254 if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
255 USBPORTSC_CCS)
256 return 1;
257 }
258 }
259
260 return 0;
261}
262
Alan Sterna8bed8b2005-04-09 17:29:00 -0400263static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state)
Alan Sternc8f4fe42005-04-09 17:27:32 -0400264__releases(uhci->lock)
265__acquires(uhci->lock)
266{
267 int auto_stop;
Alan Sternd8f12ab2008-04-22 10:49:15 -0400268 int int_enable, egsm_enable, wakeup_enable;
Alan Stern58a97ff2008-04-14 12:17:10 -0400269 struct usb_device *rhdev = uhci_to_hcd(uhci)->self.root_hub;
Alan Sternc8f4fe42005-04-09 17:27:32 -0400270
271 auto_stop = (new_state == UHCI_RH_AUTO_STOPPED);
Alan Stern58a97ff2008-04-14 12:17:10 -0400272 dev_dbg(&rhdev->dev, "%s%s\n", __func__,
Alan Sternc8f4fe42005-04-09 17:27:32 -0400273 (auto_stop ? " (auto-stop)" : ""));
274
Alan Sternd8f12ab2008-04-22 10:49:15 -0400275 /* Start off by assuming Resume-Detect interrupts and EGSM work
276 * and that remote wakeups should be enabled.
Alan Sternc8f4fe42005-04-09 17:27:32 -0400277 */
Alan Sternb62df452006-10-10 10:54:00 -0400278 egsm_enable = USBCMD_EGSM;
Alan Sternd8f12ab2008-04-22 10:49:15 -0400279 uhci->RD_enable = 1;
Alan Stern1f09df82005-09-05 13:59:51 -0400280 int_enable = USBINTR_RESUME;
Alan Sternd8f12ab2008-04-22 10:49:15 -0400281 wakeup_enable = 1;
282
283 /* In auto-stop mode wakeups must always be detected, but
284 * Resume-Detect interrupts may be prohibited. (In the absence
285 * of CONFIG_PM, they are always disallowed.)
286 */
287 if (auto_stop) {
288 if (!device_may_wakeup(&rhdev->dev))
289 int_enable = 0;
290
291 /* In bus-suspend mode wakeups may be disabled, but if they are
292 * allowed then so are Resume-Detect interrupts.
293 */
294 } else {
Alan Stern58a97ff2008-04-14 12:17:10 -0400295#ifdef CONFIG_PM
Alan Sternd8f12ab2008-04-22 10:49:15 -0400296 if (!rhdev->do_remote_wakeup)
297 wakeup_enable = 0;
Alan Stern58a97ff2008-04-14 12:17:10 -0400298#endif
Alan Sternd8f12ab2008-04-22 10:49:15 -0400299 }
300
301 /* EGSM causes the root hub to echo a 'K' signal (resume) out any
302 * port which requests a remote wakeup. According to the USB spec,
303 * every hub is supposed to do this. But if we are ignoring
304 * remote-wakeup requests anyway then there's no point to it.
305 * We also shouldn't enable EGSM if it's broken.
306 */
307 if (!wakeup_enable || global_suspend_mode_is_broken(uhci))
308 egsm_enable = 0;
309
310 /* If we're ignoring wakeup events then there's no reason to
311 * enable Resume-Detect interrupts. We also shouldn't enable
312 * them if they are broken or disallowed.
313 *
314 * This logic may lead us to enabling RD but not EGSM. The UHCI
315 * spec foolishly says that RD works only when EGSM is on, but
316 * there's no harm in enabling it anyway -- perhaps some chips
317 * will implement it!
318 */
319 if (!wakeup_enable || resume_detect_interrupts_are_broken(uhci) ||
320 !int_enable)
321 uhci->RD_enable = int_enable = 0;
Alan Sternb62df452006-10-10 10:54:00 -0400322
Alan Sternc8f4fe42005-04-09 17:27:32 -0400323 outw(int_enable, uhci->io_addr + USBINTR);
Alan Sternb62df452006-10-10 10:54:00 -0400324 outw(egsm_enable | USBCMD_CF, uhci->io_addr + USBCMD);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400325 mb();
Alan Sternc8f4fe42005-04-09 17:27:32 -0400326 udelay(5);
327
328 /* If we're auto-stopping then no devices have been attached
329 * for a while, so there shouldn't be any active URBs and the
330 * controller should stop after a few microseconds. Otherwise
331 * we will give the controller one frame to stop.
332 */
333 if (!auto_stop && !(inw(uhci->io_addr + USBSTS) & USBSTS_HCH)) {
334 uhci->rh_state = UHCI_RH_SUSPENDING;
335 spin_unlock_irq(&uhci->lock);
336 msleep(1);
337 spin_lock_irq(&uhci->lock);
Alan Sterne323de462006-06-05 12:21:30 -0400338 if (uhci->dead)
Alan Stern4daaa872005-04-09 17:30:08 -0400339 return;
Alan Sternc8f4fe42005-04-09 17:27:32 -0400340 }
341 if (!(inw(uhci->io_addr + USBSTS) & USBSTS_HCH))
Alan Stern58a97ff2008-04-14 12:17:10 -0400342 dev_warn(uhci_dev(uhci), "Controller not stopped yet!\n");
Alan Sternc8f4fe42005-04-09 17:27:32 -0400343
Alan Stern014e73c2005-04-09 17:24:42 -0400344 uhci_get_current_frame_number(uhci);
Alan Sternc8f4fe42005-04-09 17:27:32 -0400345
346 uhci->rh_state = new_state;
Alan Stern014e73c2005-04-09 17:24:42 -0400347 uhci->is_stopped = UHCI_IS_STOPPED;
Alan Sternd8f12ab2008-04-22 10:49:15 -0400348
349 /* If interrupts don't work and remote wakeup is enabled then
350 * the suspended root hub needs to be polled.
351 */
Alan Stern541c7d42010-06-22 16:39:10 -0400352 if (!int_enable && wakeup_enable)
353 set_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
354 else
355 clear_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
Alan Stern014e73c2005-04-09 17:24:42 -0400356
David Howells7d12e782006-10-05 14:55:46 +0100357 uhci_scan_schedule(uhci);
Alan Stern84afddd2006-05-12 11:35:45 -0400358 uhci_fsbr_off(uhci);
Alan Stern014e73c2005-04-09 17:24:42 -0400359}
360
Alan Sterna8bed8b2005-04-09 17:29:00 -0400361static void start_rh(struct uhci_hcd *uhci)
362{
Alan Sternf37be9b2005-10-17 10:42:06 -0400363 uhci_to_hcd(uhci)->state = HC_STATE_RUNNING;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400364 uhci->is_stopped = 0;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400365
366 /* Mark it configured and running with a 64-byte max packet.
367 * All interrupts are enabled, even though RESUME won't do anything.
368 */
369 outw(USBCMD_RS | USBCMD_CF | USBCMD_MAXP, uhci->io_addr + USBCMD);
370 outw(USBINTR_TIMEOUT | USBINTR_RESUME | USBINTR_IOC | USBINTR_SP,
371 uhci->io_addr + USBINTR);
372 mb();
Alan Stern6c1b4452005-04-21 16:04:58 -0400373 uhci->rh_state = UHCI_RH_RUNNING;
Alan Stern541c7d42010-06-22 16:39:10 -0400374 set_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400375}
376
377static void wakeup_rh(struct uhci_hcd *uhci)
Alan Sternc8f4fe42005-04-09 17:27:32 -0400378__releases(uhci->lock)
379__acquires(uhci->lock)
Alan Stern014e73c2005-04-09 17:24:42 -0400380{
David Brownellbe3cbc52006-06-05 12:16:39 -0400381 dev_dbg(&uhci_to_hcd(uhci)->self.root_hub->dev,
Harvey Harrison441b62c2008-03-03 16:08:34 -0800382 "%s%s\n", __func__,
Alan Sternc8f4fe42005-04-09 17:27:32 -0400383 uhci->rh_state == UHCI_RH_AUTO_STOPPED ?
384 " (auto-start)" : "");
Alan Stern014e73c2005-04-09 17:24:42 -0400385
Alan Sternc8f4fe42005-04-09 17:27:32 -0400386 /* If we are auto-stopped then no devices are attached so there's
387 * no need for wakeup signals. Otherwise we send Global Resume
388 * for 20 ms.
389 */
390 if (uhci->rh_state == UHCI_RH_SUSPENDED) {
Alan Sternd8f12ab2008-04-22 10:49:15 -0400391 unsigned egsm;
392
393 /* Keep EGSM on if it was set before */
394 egsm = inw(uhci->io_addr + USBCMD) & USBCMD_EGSM;
Alan Sternc8f4fe42005-04-09 17:27:32 -0400395 uhci->rh_state = UHCI_RH_RESUMING;
Alan Sternd8f12ab2008-04-22 10:49:15 -0400396 outw(USBCMD_FGR | USBCMD_CF | egsm, uhci->io_addr + USBCMD);
Alan Sternc8f4fe42005-04-09 17:27:32 -0400397 spin_unlock_irq(&uhci->lock);
398 msleep(20);
399 spin_lock_irq(&uhci->lock);
Alan Sterne323de462006-06-05 12:21:30 -0400400 if (uhci->dead)
Alan Stern4daaa872005-04-09 17:30:08 -0400401 return;
Alan Stern014e73c2005-04-09 17:24:42 -0400402
Alan Sternc8f4fe42005-04-09 17:27:32 -0400403 /* End Global Resume and wait for EOP to be sent */
404 outw(USBCMD_CF, uhci->io_addr + USBCMD);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400405 mb();
Alan Sternc8f4fe42005-04-09 17:27:32 -0400406 udelay(4);
407 if (inw(uhci->io_addr + USBCMD) & USBCMD_FGR)
408 dev_warn(uhci_dev(uhci), "FGR not stopped yet!\n");
Alan Stern014e73c2005-04-09 17:24:42 -0400409 }
Alan Sternc8f4fe42005-04-09 17:27:32 -0400410
Alan Sterna8bed8b2005-04-09 17:29:00 -0400411 start_rh(uhci);
Alan Stern014e73c2005-04-09 17:24:42 -0400412
Alan Stern6c1b4452005-04-21 16:04:58 -0400413 /* Restart root hub polling */
414 mod_timer(&uhci_to_hcd(uhci)->rh_timer, jiffies);
Alan Stern014e73c2005-04-09 17:24:42 -0400415}
416
David Howells7d12e782006-10-05 14:55:46 +0100417static irqreturn_t uhci_irq(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
419 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 unsigned short status;
421
422 /*
423 * Read the interrupt status, and write it back to clear the
424 * interrupt cause. Contrary to the UHCI specification, the
425 * "HC Halted" status bit is persistent: it is RO, not R/WC.
426 */
Alan Sterna8bed8b2005-04-09 17:29:00 -0400427 status = inw(uhci->io_addr + USBSTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 if (!(status & ~USBSTS_HCH)) /* shared interrupt, not mine */
429 return IRQ_NONE;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400430 outw(status, uhci->io_addr + USBSTS); /* Clear it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432 if (status & ~(USBSTS_USBINT | USBSTS_ERROR | USBSTS_RD)) {
433 if (status & USBSTS_HSE)
434 dev_err(uhci_dev(uhci), "host system error, "
435 "PCI problems?\n");
436 if (status & USBSTS_HCPE)
437 dev_err(uhci_dev(uhci), "host controller process "
438 "error, something bad happened!\n");
Alan Stern4daaa872005-04-09 17:30:08 -0400439 if (status & USBSTS_HCH) {
Alan Stern442258e2007-12-06 14:47:08 -0500440 spin_lock(&uhci->lock);
Alan Stern4daaa872005-04-09 17:30:08 -0400441 if (uhci->rh_state >= UHCI_RH_RUNNING) {
442 dev_err(uhci_dev(uhci),
443 "host controller halted, "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 "very bad!\n");
Alan Stern8d402e12005-12-17 18:03:37 -0500445 if (debug > 1 && errbuf) {
446 /* Print the schedule for debugging */
447 uhci_sprint_schedule(uhci,
448 errbuf, ERRBUF_LEN);
449 lprintk(errbuf);
450 }
Alan Sterne323de462006-06-05 12:21:30 -0400451 uhci_hc_died(uhci);
Alan Stern1f09df82005-09-05 13:59:51 -0400452
453 /* Force a callback in case there are
454 * pending unlinks */
455 mod_timer(&hcd->rh_timer, jiffies);
Alan Stern4daaa872005-04-09 17:30:08 -0400456 }
Alan Stern442258e2007-12-06 14:47:08 -0500457 spin_unlock(&uhci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 }
459 }
460
461 if (status & USBSTS_RD)
Alan Stern6c1b4452005-04-21 16:04:58 -0400462 usb_hcd_poll_rh_status(hcd);
Alan Stern1f09df82005-09-05 13:59:51 -0400463 else {
Alan Stern442258e2007-12-06 14:47:08 -0500464 spin_lock(&uhci->lock);
David Howells7d12e782006-10-05 14:55:46 +0100465 uhci_scan_schedule(uhci);
Alan Stern442258e2007-12-06 14:47:08 -0500466 spin_unlock(&uhci->lock);
Alan Stern1f09df82005-09-05 13:59:51 -0400467 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
469 return IRQ_HANDLED;
470}
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472/*
473 * Store the current frame number in uhci->frame_number if the controller
Alan Sternc4334722006-05-19 16:34:57 -0400474 * is runnning. Expand from 11 bits (of which we use only 10) to a
475 * full-sized integer.
476 *
477 * Like many other parts of the driver, this code relies on being polled
478 * more than once per second as long as the controller is running.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 */
480static void uhci_get_current_frame_number(struct uhci_hcd *uhci)
481{
Alan Sternc4334722006-05-19 16:34:57 -0400482 if (!uhci->is_stopped) {
483 unsigned delta;
484
485 delta = (inw(uhci->io_addr + USBFRNUM) - uhci->frame_number) &
486 (UHCI_NUMFRAMES - 1);
487 uhci->frame_number += delta;
488 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489}
490
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491/*
492 * De-allocate all resources
493 */
494static void release_uhci(struct uhci_hcd *uhci)
495{
496 int i;
497
Alan Stern8d402e12005-12-17 18:03:37 -0500498 if (DEBUG_CONFIGURED) {
499 spin_lock_irq(&uhci->lock);
500 uhci->is_initialized = 0;
501 spin_unlock_irq(&uhci->lock);
502
503 debugfs_remove(uhci->dentry);
504 }
505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 for (i = 0; i < UHCI_NUM_SKELQH; i++)
Alan Stern8b4cd422005-09-16 14:17:45 -0400507 uhci_free_qh(uhci, uhci->skelqh[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Alan Stern8b4cd422005-09-16 14:17:45 -0400509 uhci_free_td(uhci, uhci->term_td);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Alan Stern8b4cd422005-09-16 14:17:45 -0400511 dma_pool_destroy(uhci->qh_pool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Alan Stern8b4cd422005-09-16 14:17:45 -0400513 dma_pool_destroy(uhci->td_pool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Alan Sterna1d59ce2005-09-16 14:22:51 -0400515 kfree(uhci->frame_cpu);
516
517 dma_free_coherent(uhci_dev(uhci),
518 UHCI_NUMFRAMES * sizeof(*uhci->frame),
519 uhci->frame, uhci->frame_dma_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520}
521
David Brownellbe3cbc52006-06-05 12:16:39 -0400522static int uhci_init(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523{
524 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Alan Sternc074b412005-04-22 14:39:12 -0400525 unsigned io_size = (unsigned) hcd->rsrc_len;
526 int port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
528 uhci->io_addr = (unsigned long) hcd->rsrc_start;
529
Alan Sternc074b412005-04-22 14:39:12 -0400530 /* The UHCI spec says devices must have 2 ports, and goes on to say
531 * they may have more but gives no way to determine how many there
Alan Sterne07fefa2005-05-31 16:33:21 -0400532 * are. However according to the UHCI spec, Bit 7 of the port
Alan Sternc074b412005-04-22 14:39:12 -0400533 * status and control register is always set to 1. So we try to
Alan Sterne07fefa2005-05-31 16:33:21 -0400534 * use this to our advantage. Another common failure mode when
535 * a nonexistent register is addressed is to return all ones, so
536 * we test for that also.
Alan Sternc074b412005-04-22 14:39:12 -0400537 */
538 for (port = 0; port < (io_size - USBPORTSC1) / 2; port++) {
539 unsigned int portstatus;
540
541 portstatus = inw(uhci->io_addr + USBPORTSC1 + (port * 2));
Alan Sterne07fefa2005-05-31 16:33:21 -0400542 if (!(portstatus & 0x0080) || portstatus == 0xffff)
Alan Sternc074b412005-04-22 14:39:12 -0400543 break;
544 }
545 if (debug)
546 dev_info(uhci_dev(uhci), "detected %d ports\n", port);
547
Alan Sterne07fefa2005-05-31 16:33:21 -0400548 /* Anything greater than 7 is weird so we'll ignore it. */
549 if (port > UHCI_RH_MAXCHILD) {
Alan Sternc074b412005-04-22 14:39:12 -0400550 dev_info(uhci_dev(uhci), "port count misdetected? "
551 "forcing to 2 ports\n");
552 port = 2;
553 }
554 uhci->rh_numports = port;
555
Alan Sterna8bed8b2005-04-09 17:29:00 -0400556 /* Kick BIOS off this hardware and reset if the controller
557 * isn't already safely quiescent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 */
Alan Sterna8bed8b2005-04-09 17:29:00 -0400559 check_and_reset_hc(uhci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 return 0;
561}
562
Alan Stern02597d22005-04-28 14:51:27 -0400563/* Make sure the controller is quiescent and that we're not using it
564 * any more. This is mainly for the benefit of programs which, like kexec,
565 * expect the hardware to be idle: not doing DMA or generating IRQs.
566 *
567 * This routine may be called in a damaged or failing kernel. Hence we
568 * do not acquire the spinlock before shutting down the controller.
569 */
570static void uhci_shutdown(struct pci_dev *pdev)
571{
572 struct usb_hcd *hcd = (struct usb_hcd *) pci_get_drvdata(pdev);
573
Alan Sterne323de462006-06-05 12:21:30 -0400574 uhci_hc_died(hcd_to_uhci(hcd));
Alan Stern02597d22005-04-28 14:51:27 -0400575}
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577/*
578 * Allocate a frame list, and then setup the skeleton
579 *
580 * The hardware doesn't really know any difference
581 * in the queues, but the order does matter for the
Alan Stern17230ac2007-02-19 15:52:45 -0500582 * protocols higher up. The order in which the queues
583 * are encountered by the hardware is:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 *
Alan Stern17230ac2007-02-19 15:52:45 -0500585 * - All isochronous events are handled before any
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 * of the queues. We don't do that here, because
587 * we'll create the actual TD entries on demand.
Alan Stern17230ac2007-02-19 15:52:45 -0500588 * - The first queue is the high-period interrupt queue.
589 * - The second queue is the period-1 interrupt and async
590 * (low-speed control, full-speed control, then bulk) queue.
591 * - The third queue is the terminating bandwidth reclamation queue,
592 * which contains no members, loops back to itself, and is present
593 * only when FSBR is on and there are no full-speed control or bulk QHs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 */
595static int uhci_start(struct usb_hcd *hcd)
596{
597 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
598 int retval = -EBUSY;
Alan Sternc074b412005-04-22 14:39:12 -0400599 int i;
Alan Sternb4092142010-08-05 13:12:14 -0400600 struct dentry __maybe_unused *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Alan Stern6c1b4452005-04-21 16:04:58 -0400602 hcd->uses_new_polling = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 spin_lock_init(&uhci->lock);
Alan Sternc5e3b742006-06-05 12:28:57 -0400605 setup_timer(&uhci->fsbr_timer, uhci_fsbr_timeout,
606 (unsigned long) uhci);
Alan Sterndccf4a42005-12-17 17:58:46 -0500607 INIT_LIST_HEAD(&uhci->idle_qh_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 init_waitqueue_head(&uhci->waitqh);
609
Alan Sternb4092142010-08-05 13:12:14 -0400610#ifdef UHCI_DEBUG_OPS
611 dentry = debugfs_create_file(hcd->self.bus_name,
612 S_IFREG|S_IRUGO|S_IWUSR, uhci_debugfs_root,
613 uhci, &uhci_debug_operations);
614 if (!dentry) {
615 dev_err(uhci_dev(uhci), "couldn't create uhci debugfs entry\n");
616 return -ENOMEM;
Alan Stern8d402e12005-12-17 18:03:37 -0500617 }
Alan Sternb4092142010-08-05 13:12:14 -0400618 uhci->dentry = dentry;
619#endif
Alan Stern8d402e12005-12-17 18:03:37 -0500620
Alan Sterna1d59ce2005-09-16 14:22:51 -0400621 uhci->frame = dma_alloc_coherent(uhci_dev(uhci),
622 UHCI_NUMFRAMES * sizeof(*uhci->frame),
623 &uhci->frame_dma_handle, 0);
624 if (!uhci->frame) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 dev_err(uhci_dev(uhci), "unable to allocate "
626 "consistent memory for frame list\n");
Alan Sterna1d59ce2005-09-16 14:22:51 -0400627 goto err_alloc_frame;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 }
Alan Sterna1d59ce2005-09-16 14:22:51 -0400629 memset(uhci->frame, 0, UHCI_NUMFRAMES * sizeof(*uhci->frame));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Alan Sterna1d59ce2005-09-16 14:22:51 -0400631 uhci->frame_cpu = kcalloc(UHCI_NUMFRAMES, sizeof(*uhci->frame_cpu),
632 GFP_KERNEL);
633 if (!uhci->frame_cpu) {
634 dev_err(uhci_dev(uhci), "unable to allocate "
635 "memory for frame pointers\n");
636 goto err_alloc_frame_cpu;
637 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
639 uhci->td_pool = dma_pool_create("uhci_td", uhci_dev(uhci),
640 sizeof(struct uhci_td), 16, 0);
641 if (!uhci->td_pool) {
642 dev_err(uhci_dev(uhci), "unable to create td dma_pool\n");
643 goto err_create_td_pool;
644 }
645
646 uhci->qh_pool = dma_pool_create("uhci_qh", uhci_dev(uhci),
647 sizeof(struct uhci_qh), 16, 0);
648 if (!uhci->qh_pool) {
649 dev_err(uhci_dev(uhci), "unable to create qh dma_pool\n");
650 goto err_create_qh_pool;
651 }
652
Alan Stern25321782005-04-25 11:14:31 -0400653 uhci->term_td = uhci_alloc_td(uhci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 if (!uhci->term_td) {
655 dev_err(uhci_dev(uhci), "unable to allocate terminating TD\n");
656 goto err_alloc_term_td;
657 }
658
659 for (i = 0; i < UHCI_NUM_SKELQH; i++) {
Alan Sterndccf4a42005-12-17 17:58:46 -0500660 uhci->skelqh[i] = uhci_alloc_qh(uhci, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 if (!uhci->skelqh[i]) {
662 dev_err(uhci_dev(uhci), "unable to allocate QH\n");
663 goto err_alloc_skelqh;
664 }
665 }
666
667 /*
Alan Stern17230ac2007-02-19 15:52:45 -0500668 * 8 Interrupt queues; link all higher int queues to int1 = async
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 */
Alan Stern17230ac2007-02-19 15:52:45 -0500670 for (i = SKEL_ISO + 1; i < SKEL_ASYNC; ++i)
671 uhci->skelqh[i]->link = LINK_TO_QH(uhci->skel_async_qh);
Alan Sterne009f1b2007-03-19 15:31:42 -0400672 uhci->skel_async_qh->link = UHCI_PTR_TERM;
673 uhci->skel_term_qh->link = LINK_TO_QH(uhci->skel_term_qh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
675 /* This dummy TD is to work around a bug in Intel PIIX controllers */
Alan Sternfa346562005-11-30 11:57:51 -0500676 uhci_fill_td(uhci->term_td, 0, uhci_explen(0) |
Alan Stern17230ac2007-02-19 15:52:45 -0500677 (0x7f << TD_TOKEN_DEVADDR_SHIFT) | USB_PID_IN, 0);
678 uhci->term_td->link = UHCI_PTR_TERM;
679 uhci->skel_async_qh->element = uhci->skel_term_qh->element =
680 LINK_TO_TD(uhci->term_td);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
682 /*
683 * Fill the frame list: make all entries point to the proper
684 * interrupt queue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 */
686 for (i = 0; i < UHCI_NUMFRAMES; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
688 /* Only place we don't use the frame list routines */
Alan Sternf3fe239b2007-01-08 12:00:28 -0500689 uhci->frame[i] = uhci_frame_skel_link(uhci, i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 }
691
692 /*
693 * Some architectures require a full mb() to enforce completion of
Alan Sterna8bed8b2005-04-09 17:29:00 -0400694 * the memory writes above before the I/O transfers in configure_hc().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 */
696 mb();
Alan Sterna8bed8b2005-04-09 17:29:00 -0400697
698 configure_hc(uhci);
Alan Stern8d402e12005-12-17 18:03:37 -0500699 uhci->is_initialized = 1;
Alan Sternba297ed2010-06-09 17:34:39 -0400700 spin_lock_irq(&uhci->lock);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400701 start_rh(uhci);
Alan Sternba297ed2010-06-09 17:34:39 -0400702 spin_unlock_irq(&uhci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 return 0;
704
705/*
706 * error exits:
707 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708err_alloc_skelqh:
Alan Stern8b4cd422005-09-16 14:17:45 -0400709 for (i = 0; i < UHCI_NUM_SKELQH; i++) {
710 if (uhci->skelqh[i])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 uhci_free_qh(uhci, uhci->skelqh[i]);
Alan Stern8b4cd422005-09-16 14:17:45 -0400712 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714 uhci_free_td(uhci, uhci->term_td);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
716err_alloc_term_td:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 dma_pool_destroy(uhci->qh_pool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
719err_create_qh_pool:
720 dma_pool_destroy(uhci->td_pool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
722err_create_td_pool:
Alan Sterna1d59ce2005-09-16 14:22:51 -0400723 kfree(uhci->frame_cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Alan Sterna1d59ce2005-09-16 14:22:51 -0400725err_alloc_frame_cpu:
726 dma_free_coherent(uhci_dev(uhci),
727 UHCI_NUMFRAMES * sizeof(*uhci->frame),
728 uhci->frame, uhci->frame_dma_handle);
729
730err_alloc_frame:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 debugfs_remove(uhci->dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 return retval;
734}
735
736static void uhci_stop(struct usb_hcd *hcd)
737{
738 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
739
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 spin_lock_irq(&uhci->lock);
Alan Stern541c7d42010-06-22 16:39:10 -0400741 if (HCD_HW_ACCESSIBLE(hcd) && !uhci->dead)
Alan Sterne323de462006-06-05 12:21:30 -0400742 uhci_hc_died(uhci);
David Howells7d12e782006-10-05 14:55:46 +0100743 uhci_scan_schedule(uhci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 spin_unlock_irq(&uhci->lock);
Pete Zaitcevd23356da2010-01-08 15:39:22 -0700745 synchronize_irq(hcd->irq);
Alan Stern6c1b4452005-04-21 16:04:58 -0400746
Alan Sternc5e3b742006-06-05 12:28:57 -0400747 del_timer_sync(&uhci->fsbr_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 release_uhci(uhci);
749}
750
751#ifdef CONFIG_PM
Alan Sterna8bed8b2005-04-09 17:29:00 -0400752static int uhci_rh_suspend(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753{
754 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
David Brownellbe3cbc52006-06-05 12:16:39 -0400755 int rc = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
757 spin_lock_irq(&uhci->lock);
Alan Stern541c7d42010-06-22 16:39:10 -0400758 if (!HCD_HW_ACCESSIBLE(hcd))
David Brownellbe3cbc52006-06-05 12:16:39 -0400759 rc = -ESHUTDOWN;
Alan Sterncec3a532010-01-08 11:18:20 -0500760 else if (uhci->dead)
761 ; /* Dead controllers tell no tales */
762
763 /* Once the controller is stopped, port resumes that are already
764 * in progress won't complete. Hence if remote wakeup is enabled
765 * for the root hub and any ports are in the middle of a resume or
766 * remote wakeup, we must fail the suspend.
767 */
768 else if (hcd->self.root_hub->do_remote_wakeup &&
769 uhci->resuming_ports) {
770 dev_dbg(uhci_dev(uhci), "suspend failed because a port "
771 "is resuming\n");
772 rc = -EBUSY;
773 } else
Alan Stern4daaa872005-04-09 17:30:08 -0400774 suspend_rh(uhci, UHCI_RH_SUSPENDED);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400775 spin_unlock_irq(&uhci->lock);
David Brownellbe3cbc52006-06-05 12:16:39 -0400776 return rc;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400777}
778
779static int uhci_rh_resume(struct usb_hcd *hcd)
780{
781 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Alan Stern4daaa872005-04-09 17:30:08 -0400782 int rc = 0;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400783
784 spin_lock_irq(&uhci->lock);
Alan Stern541c7d42010-06-22 16:39:10 -0400785 if (!HCD_HW_ACCESSIBLE(hcd))
David Brownellbe3cbc52006-06-05 12:16:39 -0400786 rc = -ESHUTDOWN;
Alan Sterncfa59da2007-06-21 16:25:35 -0400787 else if (!uhci->dead)
Alan Stern4daaa872005-04-09 17:30:08 -0400788 wakeup_rh(uhci);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400789 spin_unlock_irq(&uhci->lock);
Alan Stern4daaa872005-04-09 17:30:08 -0400790 return rc;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400791}
792
Alan Stern41472002010-06-25 14:02:14 -0400793static int uhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
Alan Sterna8bed8b2005-04-09 17:29:00 -0400794{
795 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Alan Stern0d436b42010-06-25 14:02:49 -0400796 struct pci_dev *pdev = to_pci_dev(uhci_dev(uhci));
Alan Stern4daaa872005-04-09 17:30:08 -0400797 int rc = 0;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400798
Harvey Harrison441b62c2008-03-03 16:08:34 -0800799 dev_dbg(uhci_dev(uhci), "%s\n", __func__);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400800
801 spin_lock_irq(&uhci->lock);
Alan Stern541c7d42010-06-22 16:39:10 -0400802 if (!HCD_HW_ACCESSIBLE(hcd) || uhci->dead)
Alan Sterne323de462006-06-05 12:21:30 -0400803 goto done_okay; /* Already suspended or dead */
Alan Sterna8bed8b2005-04-09 17:29:00 -0400804
Alan Stern4daaa872005-04-09 17:30:08 -0400805 if (uhci->rh_state > UHCI_RH_SUSPENDED) {
806 dev_warn(uhci_dev(uhci), "Root hub isn't suspended!\n");
Alan Stern4daaa872005-04-09 17:30:08 -0400807 rc = -EBUSY;
808 goto done;
809 };
810
Alan Sterna8bed8b2005-04-09 17:29:00 -0400811 /* All PCI host controllers are required to disable IRQ generation
812 * at the source, so we must turn off PIRQ.
813 */
Alan Stern0d436b42010-06-25 14:02:49 -0400814 pci_write_config_word(pdev, USBLEGSUP, 0);
Alan Stern541c7d42010-06-22 16:39:10 -0400815 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400816
Alan Stern0d436b42010-06-25 14:02:49 -0400817 /* Enable platform-specific non-PME# wakeup */
818 if (do_wakeup) {
819 if (pdev->vendor == PCI_VENDOR_ID_INTEL)
820 pci_write_config_byte(pdev, USBRES_INTEL,
821 USBPORT1EN | USBPORT2EN);
822 }
Alan Sterna8bed8b2005-04-09 17:29:00 -0400823
Alan Sterne323de462006-06-05 12:21:30 -0400824done_okay:
825 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
Alan Stern4daaa872005-04-09 17:30:08 -0400826done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 spin_unlock_irq(&uhci->lock);
Alan Stern4daaa872005-04-09 17:30:08 -0400828 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829}
830
Alan Stern6ec4beb2009-04-27 13:33:41 -0400831static int uhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832{
833 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Harvey Harrison441b62c2008-03-03 16:08:34 -0800835 dev_dbg(uhci_dev(uhci), "%s\n", __func__);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400836
Alan Stern687f5f32005-11-30 17:16:19 -0500837 /* Since we aren't in D3 any more, it's safe to set this flag
Alan Sterne323de462006-06-05 12:21:30 -0400838 * even if the controller was dead.
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100839 */
840 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
841
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 spin_lock_irq(&uhci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
Alan Stern6ec4beb2009-04-27 13:33:41 -0400844 /* Make sure resume from hibernation re-enumerates everything */
845 if (hibernated)
846 uhci_hc_died(uhci);
847
Alan Sterne323de462006-06-05 12:21:30 -0400848 /* The firmware or a boot kernel may have changed the controller
849 * settings during a system wakeup. Check it and reconfigure
850 * to avoid problems.
Alan Sterna8bed8b2005-04-09 17:29:00 -0400851 */
852 check_and_reset_hc(uhci);
Alan Sterne323de462006-06-05 12:21:30 -0400853
854 /* If the controller was dead before, it's back alive now */
Alan Sterna8bed8b2005-04-09 17:29:00 -0400855 configure_hc(uhci);
856
Alan Stern0d436b42010-06-25 14:02:49 -0400857 /* Tell the core if the controller had to be reset */
858 if (uhci->rh_state == UHCI_RH_RESET)
Alan Stern1c50c312005-11-14 11:45:38 -0500859 usb_root_hub_lost_power(hcd->self.root_hub);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400860
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 spin_unlock_irq(&uhci->lock);
Alan Stern6c1b4452005-04-21 16:04:58 -0400862
Alan Sternd8f12ab2008-04-22 10:49:15 -0400863 /* If interrupts don't work and remote wakeup is enabled then
864 * the suspended root hub needs to be polled.
865 */
Alan Sternee0b9be2010-06-25 14:02:24 -0400866 if (!uhci->RD_enable && hcd->self.root_hub->do_remote_wakeup)
Alan Stern541c7d42010-06-22 16:39:10 -0400867 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Alan Sternee0b9be2010-06-25 14:02:24 -0400868
869 /* Does the root hub have a port wakeup pending? */
870 usb_hcd_poll_rh_status(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 return 0;
872}
873#endif
874
Alan Sterndccf4a42005-12-17 17:58:46 -0500875/* Wait until a particular device/endpoint's QH is idle, and free it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876static void uhci_hcd_endpoint_disable(struct usb_hcd *hcd,
Alan Sterndccf4a42005-12-17 17:58:46 -0500877 struct usb_host_endpoint *hep)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878{
879 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Alan Sterndccf4a42005-12-17 17:58:46 -0500880 struct uhci_qh *qh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
Alan Sterndccf4a42005-12-17 17:58:46 -0500882 spin_lock_irq(&uhci->lock);
883 qh = (struct uhci_qh *) hep->hcpriv;
884 if (qh == NULL)
885 goto done;
886
887 while (qh->state != QH_STATE_IDLE) {
888 ++uhci->num_waiting;
889 spin_unlock_irq(&uhci->lock);
890 wait_event_interruptible(uhci->waitqh,
891 qh->state == QH_STATE_IDLE);
892 spin_lock_irq(&uhci->lock);
893 --uhci->num_waiting;
894 }
895
896 uhci_free_qh(uhci, qh);
897done:
898 spin_unlock_irq(&uhci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899}
900
901static int uhci_hcd_get_frame_number(struct usb_hcd *hcd)
902{
903 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Alan Sternc4334722006-05-19 16:34:57 -0400904 unsigned frame_number;
905 unsigned delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
907 /* Minimize latency by avoiding the spinlock */
Alan Sternc4334722006-05-19 16:34:57 -0400908 frame_number = uhci->frame_number;
909 barrier();
910 delta = (inw(uhci->io_addr + USBFRNUM) - frame_number) &
911 (UHCI_NUMFRAMES - 1);
912 return frame_number + delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913}
914
915static const char hcd_name[] = "uhci_hcd";
916
917static const struct hc_driver uhci_driver = {
918 .description = hcd_name,
919 .product_desc = "UHCI Host Controller",
920 .hcd_priv_size = sizeof(struct uhci_hcd),
921
922 /* Generic hardware linkage */
923 .irq = uhci_irq,
924 .flags = HCD_USB11,
925
926 /* Basic lifecycle operations */
David Brownellbe3cbc52006-06-05 12:16:39 -0400927 .reset = uhci_init,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 .start = uhci_start,
929#ifdef CONFIG_PM
Alan Stern7be7d742008-04-03 18:03:06 -0400930 .pci_suspend = uhci_pci_suspend,
931 .pci_resume = uhci_pci_resume,
Alan Stern0c0382e2005-10-13 17:08:02 -0400932 .bus_suspend = uhci_rh_suspend,
933 .bus_resume = uhci_rh_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934#endif
935 .stop = uhci_stop,
936
937 .urb_enqueue = uhci_urb_enqueue,
938 .urb_dequeue = uhci_urb_dequeue,
939
940 .endpoint_disable = uhci_hcd_endpoint_disable,
941 .get_frame_number = uhci_hcd_get_frame_number,
942
943 .hub_status_data = uhci_hub_status_data,
944 .hub_control = uhci_hub_control,
945};
946
947static const struct pci_device_id uhci_pci_ids[] = { {
948 /* handle any USB UHCI controller */
Jean Delvarec67808e2006-04-09 20:07:35 +0200949 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_UHCI, ~0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 .driver_data = (unsigned long) &uhci_driver,
951 }, { /* end: all zeroes */ }
952};
953
954MODULE_DEVICE_TABLE(pci, uhci_pci_ids);
955
956static struct pci_driver uhci_pci_driver = {
957 .name = (char *)hcd_name,
958 .id_table = uhci_pci_ids,
959
960 .probe = usb_hcd_pci_probe,
961 .remove = usb_hcd_pci_remove,
Alan Stern02597d22005-04-28 14:51:27 -0400962 .shutdown = uhci_shutdown,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963
Alan Sternabb30642009-04-27 13:33:24 -0400964#ifdef CONFIG_PM_SLEEP
965 .driver = {
966 .pm = &usb_hcd_pci_pm_ops
967 },
968#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969};
970
971static int __init uhci_hcd_init(void)
972{
973 int retval = -ENOMEM;
974
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 if (usb_disabled())
976 return -ENODEV;
977
Alan Stern2b70f072008-10-02 11:47:15 -0400978 printk(KERN_INFO "uhci_hcd: " DRIVER_DESC "%s\n",
979 ignore_oc ? ", overcurrent ignored" : "");
Alan Stern9beeee62008-10-02 11:48:13 -0400980 set_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
Alan Stern2b70f072008-10-02 11:47:15 -0400981
Alan Stern8d402e12005-12-17 18:03:37 -0500982 if (DEBUG_CONFIGURED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 errbuf = kmalloc(ERRBUF_LEN, GFP_KERNEL);
984 if (!errbuf)
985 goto errbuf_failed;
Greg Kroah-Hartmanec20df22009-04-24 15:15:00 -0700986 uhci_debugfs_root = debugfs_create_dir("uhci", usb_debug_root);
Alan Stern8d402e12005-12-17 18:03:37 -0500987 if (!uhci_debugfs_root)
988 goto debug_failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 }
990
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 uhci_up_cachep = kmem_cache_create("uhci_urb_priv",
Paul Mundt20c2df82007-07-20 10:11:58 +0900992 sizeof(struct urb_priv), 0, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 if (!uhci_up_cachep)
994 goto up_failed;
995
996 retval = pci_register_driver(&uhci_pci_driver);
997 if (retval)
998 goto init_failed;
999
1000 return 0;
1001
1002init_failed:
Alexey Dobriyan1a1d92c2006-09-27 01:49:40 -07001003 kmem_cache_destroy(uhci_up_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004
1005up_failed:
1006 debugfs_remove(uhci_debugfs_root);
1007
1008debug_failed:
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001009 kfree(errbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
1011errbuf_failed:
1012
Alan Stern9beeee62008-10-02 11:48:13 -04001013 clear_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 return retval;
1015}
1016
1017static void __exit uhci_hcd_cleanup(void)
1018{
1019 pci_unregister_driver(&uhci_pci_driver);
Alexey Dobriyan1a1d92c2006-09-27 01:49:40 -07001020 kmem_cache_destroy(uhci_up_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 debugfs_remove(uhci_debugfs_root);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001022 kfree(errbuf);
Alan Stern9beeee62008-10-02 11:48:13 -04001023 clear_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024}
1025
1026module_init(uhci_hcd_init);
1027module_exit(uhci_hcd_cleanup);
1028
1029MODULE_AUTHOR(DRIVER_AUTHOR);
1030MODULE_DESCRIPTION(DRIVER_DESC);
1031MODULE_LICENSE("GPL");