blob: cf5e4cf7ea425828ca099af27dc6d2639ded8f9a [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>
41#include <linux/bitops.h>
Alan Sternb62df452006-10-10 10:54:00 -040042#include <linux/dmi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44#include <asm/uaccess.h>
45#include <asm/io.h>
46#include <asm/irq.h>
47#include <asm/system.h>
48
49#include "../core/hcd.h"
50#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 * show all queues in /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 Sternf3fe2392007-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 Sternf3fe2392007-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 Sternf3fe2392007-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 Sternf3fe2392007-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 Stern6c1b4452005-04-21 16:04:58 -0400143 uhci_to_hcd(uhci)->poll_rh = 0;
Alan Sterne323de42006-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 Sterne323de42006-06-05 12:21:30 -0400152static void uhci_hc_died(struct uhci_hcd *uhci)
Alan Stern4daaa872005-04-09 17:30:08 -0400153{
Alan Sterne323de42006-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 Sterne323de42006-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{
179 /* Set the frame length to the default: 1 ms exactly */
180 outb(USBSOF_DEFAULT, uhci->io_addr + USBSOF);
181
182 /* Store the frame list base address */
Alan Sterna1d59ce2005-09-16 14:22:51 -0400183 outl(uhci->frame_dma_handle, uhci->io_addr + USBFLBASEADD);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400184
185 /* Set the current frame number */
Alan Sternc4334722006-05-19 16:34:57 -0400186 outw(uhci->frame_number & UHCI_MAX_SOF_NUMBER,
187 uhci->io_addr + USBFRNUM);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400188
Alan Sternf37be9b2005-10-17 10:42:06 -0400189 /* Mark controller as not halted before we enable interrupts */
190 uhci_to_hcd(uhci)->state = HC_STATE_SUSPENDED;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400191 mb();
192
193 /* Enable PIRQ */
194 pci_write_config_word(to_pci_dev(uhci_dev(uhci)), USBLEGSUP,
195 USBLEGSUP_DEFAULT);
196}
197
198
Alan Sternc8f4fe42005-04-09 17:27:32 -0400199static int resume_detect_interrupts_are_broken(struct uhci_hcd *uhci)
Alan Stern014e73c2005-04-09 17:24:42 -0400200{
Alan Sternc8f4fe42005-04-09 17:27:32 -0400201 int port;
Alan Stern014e73c2005-04-09 17:24:42 -0400202
Alan Stern5f8364b2006-12-05 16:29:55 -0500203 /* If we have to ignore overcurrent events then almost by definition
204 * we can't depend on resume-detect interrupts. */
205 if (ignore_oc)
206 return 1;
207
Alan Sternc8f4fe42005-04-09 17:27:32 -0400208 switch (to_pci_dev(uhci_dev(uhci))->vendor) {
209 default:
210 break;
Alan Stern014e73c2005-04-09 17:24:42 -0400211
Alan Sternc8f4fe42005-04-09 17:27:32 -0400212 case PCI_VENDOR_ID_GENESYS:
213 /* Genesys Logic's GL880S controllers don't generate
214 * resume-detect interrupts.
215 */
216 return 1;
217
218 case PCI_VENDOR_ID_INTEL:
219 /* Some of Intel's USB controllers have a bug that causes
220 * resume-detect interrupts if any port has an over-current
221 * condition. To make matters worse, some motherboards
222 * hardwire unused USB ports' over-current inputs active!
223 * To prevent problems, we will not enable resume-detect
224 * interrupts if any ports are OC.
225 */
226 for (port = 0; port < uhci->rh_numports; ++port) {
227 if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
228 USBPORTSC_OC)
229 return 1;
230 }
231 break;
232 }
233 return 0;
234}
235
Alan Sternd8f12ab2008-04-22 10:49:15 -0400236static int global_suspend_mode_is_broken(struct uhci_hcd *uhci)
Alan Sternb62df452006-10-10 10:54:00 -0400237{
Alan Sternb62df452006-10-10 10:54:00 -0400238 int port;
Jeff Garzik18552562007-10-03 15:15:40 -0400239 const char *sys_info;
Alan Sternc80a70d2006-12-15 16:06:25 -0500240 static char bad_Asus_board[] = "A7V8X";
Alan Sternb62df452006-10-10 10:54:00 -0400241
242 /* One of Asus's motherboards has a bug which causes it to
243 * wake up immediately from suspend-to-RAM if any of the ports
244 * are connected. In such cases we will not set EGSM.
245 */
Alan Sternc80a70d2006-12-15 16:06:25 -0500246 sys_info = dmi_get_system_info(DMI_BOARD_NAME);
247 if (sys_info && !strcmp(sys_info, bad_Asus_board)) {
Alan Sternb62df452006-10-10 10:54:00 -0400248 for (port = 0; port < uhci->rh_numports; ++port) {
249 if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
250 USBPORTSC_CCS)
251 return 1;
252 }
253 }
254
255 return 0;
256}
257
Alan Sterna8bed8b2005-04-09 17:29:00 -0400258static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state)
Alan Sternc8f4fe42005-04-09 17:27:32 -0400259__releases(uhci->lock)
260__acquires(uhci->lock)
261{
262 int auto_stop;
Alan Sternd8f12ab2008-04-22 10:49:15 -0400263 int int_enable, egsm_enable, wakeup_enable;
Alan Stern58a97ff2008-04-14 12:17:10 -0400264 struct usb_device *rhdev = uhci_to_hcd(uhci)->self.root_hub;
Alan Sternc8f4fe42005-04-09 17:27:32 -0400265
266 auto_stop = (new_state == UHCI_RH_AUTO_STOPPED);
Alan Stern58a97ff2008-04-14 12:17:10 -0400267 dev_dbg(&rhdev->dev, "%s%s\n", __func__,
Alan Sternc8f4fe42005-04-09 17:27:32 -0400268 (auto_stop ? " (auto-stop)" : ""));
269
Alan Sternd8f12ab2008-04-22 10:49:15 -0400270 /* Start off by assuming Resume-Detect interrupts and EGSM work
271 * and that remote wakeups should be enabled.
Alan Sternc8f4fe42005-04-09 17:27:32 -0400272 */
Alan Sternb62df452006-10-10 10:54:00 -0400273 egsm_enable = USBCMD_EGSM;
Alan Sternd8f12ab2008-04-22 10:49:15 -0400274 uhci->RD_enable = 1;
Alan Stern1f09df82005-09-05 13:59:51 -0400275 int_enable = USBINTR_RESUME;
Alan Sternd8f12ab2008-04-22 10:49:15 -0400276 wakeup_enable = 1;
277
278 /* In auto-stop mode wakeups must always be detected, but
279 * Resume-Detect interrupts may be prohibited. (In the absence
280 * of CONFIG_PM, they are always disallowed.)
281 */
282 if (auto_stop) {
283 if (!device_may_wakeup(&rhdev->dev))
284 int_enable = 0;
285
286 /* In bus-suspend mode wakeups may be disabled, but if they are
287 * allowed then so are Resume-Detect interrupts.
288 */
289 } else {
Alan Stern58a97ff2008-04-14 12:17:10 -0400290#ifdef CONFIG_PM
Alan Sternd8f12ab2008-04-22 10:49:15 -0400291 if (!rhdev->do_remote_wakeup)
292 wakeup_enable = 0;
Alan Stern58a97ff2008-04-14 12:17:10 -0400293#endif
Alan Sternd8f12ab2008-04-22 10:49:15 -0400294 }
295
296 /* EGSM causes the root hub to echo a 'K' signal (resume) out any
297 * port which requests a remote wakeup. According to the USB spec,
298 * every hub is supposed to do this. But if we are ignoring
299 * remote-wakeup requests anyway then there's no point to it.
300 * We also shouldn't enable EGSM if it's broken.
301 */
302 if (!wakeup_enable || global_suspend_mode_is_broken(uhci))
303 egsm_enable = 0;
304
305 /* If we're ignoring wakeup events then there's no reason to
306 * enable Resume-Detect interrupts. We also shouldn't enable
307 * them if they are broken or disallowed.
308 *
309 * This logic may lead us to enabling RD but not EGSM. The UHCI
310 * spec foolishly says that RD works only when EGSM is on, but
311 * there's no harm in enabling it anyway -- perhaps some chips
312 * will implement it!
313 */
314 if (!wakeup_enable || resume_detect_interrupts_are_broken(uhci) ||
315 !int_enable)
316 uhci->RD_enable = int_enable = 0;
Alan Sternb62df452006-10-10 10:54:00 -0400317
Alan Sternc8f4fe42005-04-09 17:27:32 -0400318 outw(int_enable, uhci->io_addr + USBINTR);
Alan Sternb62df452006-10-10 10:54:00 -0400319 outw(egsm_enable | USBCMD_CF, uhci->io_addr + USBCMD);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400320 mb();
Alan Sternc8f4fe42005-04-09 17:27:32 -0400321 udelay(5);
322
323 /* If we're auto-stopping then no devices have been attached
324 * for a while, so there shouldn't be any active URBs and the
325 * controller should stop after a few microseconds. Otherwise
326 * we will give the controller one frame to stop.
327 */
328 if (!auto_stop && !(inw(uhci->io_addr + USBSTS) & USBSTS_HCH)) {
329 uhci->rh_state = UHCI_RH_SUSPENDING;
330 spin_unlock_irq(&uhci->lock);
331 msleep(1);
332 spin_lock_irq(&uhci->lock);
Alan Sterne323de42006-06-05 12:21:30 -0400333 if (uhci->dead)
Alan Stern4daaa872005-04-09 17:30:08 -0400334 return;
Alan Sternc8f4fe42005-04-09 17:27:32 -0400335 }
336 if (!(inw(uhci->io_addr + USBSTS) & USBSTS_HCH))
Alan Stern58a97ff2008-04-14 12:17:10 -0400337 dev_warn(uhci_dev(uhci), "Controller not stopped yet!\n");
Alan Sternc8f4fe42005-04-09 17:27:32 -0400338
Alan Stern014e73c2005-04-09 17:24:42 -0400339 uhci_get_current_frame_number(uhci);
Alan Sternc8f4fe42005-04-09 17:27:32 -0400340
341 uhci->rh_state = new_state;
Alan Stern014e73c2005-04-09 17:24:42 -0400342 uhci->is_stopped = UHCI_IS_STOPPED;
Alan Sternd8f12ab2008-04-22 10:49:15 -0400343
344 /* If interrupts don't work and remote wakeup is enabled then
345 * the suspended root hub needs to be polled.
346 */
347 uhci_to_hcd(uhci)->poll_rh = (!int_enable && wakeup_enable);
Alan Stern014e73c2005-04-09 17:24:42 -0400348
David Howells7d12e782006-10-05 14:55:46 +0100349 uhci_scan_schedule(uhci);
Alan Stern84afddd2006-05-12 11:35:45 -0400350 uhci_fsbr_off(uhci);
Alan Stern014e73c2005-04-09 17:24:42 -0400351}
352
Alan Sterna8bed8b2005-04-09 17:29:00 -0400353static void start_rh(struct uhci_hcd *uhci)
354{
Alan Sternf37be9b2005-10-17 10:42:06 -0400355 uhci_to_hcd(uhci)->state = HC_STATE_RUNNING;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400356 uhci->is_stopped = 0;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400357
358 /* Mark it configured and running with a 64-byte max packet.
359 * All interrupts are enabled, even though RESUME won't do anything.
360 */
361 outw(USBCMD_RS | USBCMD_CF | USBCMD_MAXP, uhci->io_addr + USBCMD);
362 outw(USBINTR_TIMEOUT | USBINTR_RESUME | USBINTR_IOC | USBINTR_SP,
363 uhci->io_addr + USBINTR);
364 mb();
Alan Stern6c1b4452005-04-21 16:04:58 -0400365 uhci->rh_state = UHCI_RH_RUNNING;
366 uhci_to_hcd(uhci)->poll_rh = 1;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400367}
368
369static void wakeup_rh(struct uhci_hcd *uhci)
Alan Sternc8f4fe42005-04-09 17:27:32 -0400370__releases(uhci->lock)
371__acquires(uhci->lock)
Alan Stern014e73c2005-04-09 17:24:42 -0400372{
David Brownellbe3cbc52006-06-05 12:16:39 -0400373 dev_dbg(&uhci_to_hcd(uhci)->self.root_hub->dev,
Harvey Harrison441b62c2008-03-03 16:08:34 -0800374 "%s%s\n", __func__,
Alan Sternc8f4fe42005-04-09 17:27:32 -0400375 uhci->rh_state == UHCI_RH_AUTO_STOPPED ?
376 " (auto-start)" : "");
Alan Stern014e73c2005-04-09 17:24:42 -0400377
Alan Sternc8f4fe42005-04-09 17:27:32 -0400378 /* If we are auto-stopped then no devices are attached so there's
379 * no need for wakeup signals. Otherwise we send Global Resume
380 * for 20 ms.
381 */
382 if (uhci->rh_state == UHCI_RH_SUSPENDED) {
Alan Sternd8f12ab2008-04-22 10:49:15 -0400383 unsigned egsm;
384
385 /* Keep EGSM on if it was set before */
386 egsm = inw(uhci->io_addr + USBCMD) & USBCMD_EGSM;
Alan Sternc8f4fe42005-04-09 17:27:32 -0400387 uhci->rh_state = UHCI_RH_RESUMING;
Alan Sternd8f12ab2008-04-22 10:49:15 -0400388 outw(USBCMD_FGR | USBCMD_CF | egsm, uhci->io_addr + USBCMD);
Alan Sternc8f4fe42005-04-09 17:27:32 -0400389 spin_unlock_irq(&uhci->lock);
390 msleep(20);
391 spin_lock_irq(&uhci->lock);
Alan Sterne323de42006-06-05 12:21:30 -0400392 if (uhci->dead)
Alan Stern4daaa872005-04-09 17:30:08 -0400393 return;
Alan Stern014e73c2005-04-09 17:24:42 -0400394
Alan Sternc8f4fe42005-04-09 17:27:32 -0400395 /* End Global Resume and wait for EOP to be sent */
396 outw(USBCMD_CF, uhci->io_addr + USBCMD);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400397 mb();
Alan Sternc8f4fe42005-04-09 17:27:32 -0400398 udelay(4);
399 if (inw(uhci->io_addr + USBCMD) & USBCMD_FGR)
400 dev_warn(uhci_dev(uhci), "FGR not stopped yet!\n");
Alan Stern014e73c2005-04-09 17:24:42 -0400401 }
Alan Sternc8f4fe42005-04-09 17:27:32 -0400402
Alan Sterna8bed8b2005-04-09 17:29:00 -0400403 start_rh(uhci);
Alan Stern014e73c2005-04-09 17:24:42 -0400404
Alan Stern6c1b4452005-04-21 16:04:58 -0400405 /* Restart root hub polling */
406 mod_timer(&uhci_to_hcd(uhci)->rh_timer, jiffies);
Alan Stern014e73c2005-04-09 17:24:42 -0400407}
408
David Howells7d12e782006-10-05 14:55:46 +0100409static irqreturn_t uhci_irq(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410{
411 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 unsigned short status;
413
414 /*
415 * Read the interrupt status, and write it back to clear the
416 * interrupt cause. Contrary to the UHCI specification, the
417 * "HC Halted" status bit is persistent: it is RO, not R/WC.
418 */
Alan Sterna8bed8b2005-04-09 17:29:00 -0400419 status = inw(uhci->io_addr + USBSTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 if (!(status & ~USBSTS_HCH)) /* shared interrupt, not mine */
421 return IRQ_NONE;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400422 outw(status, uhci->io_addr + USBSTS); /* Clear it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
424 if (status & ~(USBSTS_USBINT | USBSTS_ERROR | USBSTS_RD)) {
425 if (status & USBSTS_HSE)
426 dev_err(uhci_dev(uhci), "host system error, "
427 "PCI problems?\n");
428 if (status & USBSTS_HCPE)
429 dev_err(uhci_dev(uhci), "host controller process "
430 "error, something bad happened!\n");
Alan Stern4daaa872005-04-09 17:30:08 -0400431 if (status & USBSTS_HCH) {
Alan Stern442258e2007-12-06 14:47:08 -0500432 spin_lock(&uhci->lock);
Alan Stern4daaa872005-04-09 17:30:08 -0400433 if (uhci->rh_state >= UHCI_RH_RUNNING) {
434 dev_err(uhci_dev(uhci),
435 "host controller halted, "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 "very bad!\n");
Alan Stern8d402e12005-12-17 18:03:37 -0500437 if (debug > 1 && errbuf) {
438 /* Print the schedule for debugging */
439 uhci_sprint_schedule(uhci,
440 errbuf, ERRBUF_LEN);
441 lprintk(errbuf);
442 }
Alan Sterne323de42006-06-05 12:21:30 -0400443 uhci_hc_died(uhci);
Alan Stern1f09df82005-09-05 13:59:51 -0400444
445 /* Force a callback in case there are
446 * pending unlinks */
447 mod_timer(&hcd->rh_timer, jiffies);
Alan Stern4daaa872005-04-09 17:30:08 -0400448 }
Alan Stern442258e2007-12-06 14:47:08 -0500449 spin_unlock(&uhci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 }
451 }
452
453 if (status & USBSTS_RD)
Alan Stern6c1b4452005-04-21 16:04:58 -0400454 usb_hcd_poll_rh_status(hcd);
Alan Stern1f09df82005-09-05 13:59:51 -0400455 else {
Alan Stern442258e2007-12-06 14:47:08 -0500456 spin_lock(&uhci->lock);
David Howells7d12e782006-10-05 14:55:46 +0100457 uhci_scan_schedule(uhci);
Alan Stern442258e2007-12-06 14:47:08 -0500458 spin_unlock(&uhci->lock);
Alan Stern1f09df82005-09-05 13:59:51 -0400459 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
461 return IRQ_HANDLED;
462}
463
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464/*
465 * Store the current frame number in uhci->frame_number if the controller
Alan Sternc4334722006-05-19 16:34:57 -0400466 * is runnning. Expand from 11 bits (of which we use only 10) to a
467 * full-sized integer.
468 *
469 * Like many other parts of the driver, this code relies on being polled
470 * more than once per second as long as the controller is running.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 */
472static void uhci_get_current_frame_number(struct uhci_hcd *uhci)
473{
Alan Sternc4334722006-05-19 16:34:57 -0400474 if (!uhci->is_stopped) {
475 unsigned delta;
476
477 delta = (inw(uhci->io_addr + USBFRNUM) - uhci->frame_number) &
478 (UHCI_NUMFRAMES - 1);
479 uhci->frame_number += delta;
480 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481}
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483/*
484 * De-allocate all resources
485 */
486static void release_uhci(struct uhci_hcd *uhci)
487{
488 int i;
489
Alan Stern8d402e12005-12-17 18:03:37 -0500490 if (DEBUG_CONFIGURED) {
491 spin_lock_irq(&uhci->lock);
492 uhci->is_initialized = 0;
493 spin_unlock_irq(&uhci->lock);
494
495 debugfs_remove(uhci->dentry);
496 }
497
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 for (i = 0; i < UHCI_NUM_SKELQH; i++)
Alan Stern8b4cd422005-09-16 14:17:45 -0400499 uhci_free_qh(uhci, uhci->skelqh[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
Alan Stern8b4cd422005-09-16 14:17:45 -0400501 uhci_free_td(uhci, uhci->term_td);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Alan Stern8b4cd422005-09-16 14:17:45 -0400503 dma_pool_destroy(uhci->qh_pool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
Alan Stern8b4cd422005-09-16 14:17:45 -0400505 dma_pool_destroy(uhci->td_pool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Alan Sterna1d59ce2005-09-16 14:22:51 -0400507 kfree(uhci->frame_cpu);
508
509 dma_free_coherent(uhci_dev(uhci),
510 UHCI_NUMFRAMES * sizeof(*uhci->frame),
511 uhci->frame, uhci->frame_dma_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512}
513
David Brownellbe3cbc52006-06-05 12:16:39 -0400514static int uhci_init(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515{
516 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Alan Sternc074b412005-04-22 14:39:12 -0400517 unsigned io_size = (unsigned) hcd->rsrc_len;
518 int port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
520 uhci->io_addr = (unsigned long) hcd->rsrc_start;
521
Alan Sternc074b412005-04-22 14:39:12 -0400522 /* The UHCI spec says devices must have 2 ports, and goes on to say
523 * they may have more but gives no way to determine how many there
Alan Sterne07fefa2005-05-31 16:33:21 -0400524 * are. However according to the UHCI spec, Bit 7 of the port
Alan Sternc074b412005-04-22 14:39:12 -0400525 * status and control register is always set to 1. So we try to
Alan Sterne07fefa2005-05-31 16:33:21 -0400526 * use this to our advantage. Another common failure mode when
527 * a nonexistent register is addressed is to return all ones, so
528 * we test for that also.
Alan Sternc074b412005-04-22 14:39:12 -0400529 */
530 for (port = 0; port < (io_size - USBPORTSC1) / 2; port++) {
531 unsigned int portstatus;
532
533 portstatus = inw(uhci->io_addr + USBPORTSC1 + (port * 2));
Alan Sterne07fefa2005-05-31 16:33:21 -0400534 if (!(portstatus & 0x0080) || portstatus == 0xffff)
Alan Sternc074b412005-04-22 14:39:12 -0400535 break;
536 }
537 if (debug)
538 dev_info(uhci_dev(uhci), "detected %d ports\n", port);
539
Alan Sterne07fefa2005-05-31 16:33:21 -0400540 /* Anything greater than 7 is weird so we'll ignore it. */
541 if (port > UHCI_RH_MAXCHILD) {
Alan Sternc074b412005-04-22 14:39:12 -0400542 dev_info(uhci_dev(uhci), "port count misdetected? "
543 "forcing to 2 ports\n");
544 port = 2;
545 }
546 uhci->rh_numports = port;
547
Alan Sterna8bed8b2005-04-09 17:29:00 -0400548 /* Kick BIOS off this hardware and reset if the controller
549 * isn't already safely quiescent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 */
Alan Sterna8bed8b2005-04-09 17:29:00 -0400551 check_and_reset_hc(uhci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 return 0;
553}
554
Alan Stern02597d22005-04-28 14:51:27 -0400555/* Make sure the controller is quiescent and that we're not using it
556 * any more. This is mainly for the benefit of programs which, like kexec,
557 * expect the hardware to be idle: not doing DMA or generating IRQs.
558 *
559 * This routine may be called in a damaged or failing kernel. Hence we
560 * do not acquire the spinlock before shutting down the controller.
561 */
562static void uhci_shutdown(struct pci_dev *pdev)
563{
564 struct usb_hcd *hcd = (struct usb_hcd *) pci_get_drvdata(pdev);
565
Alan Sterne323de42006-06-05 12:21:30 -0400566 uhci_hc_died(hcd_to_uhci(hcd));
Alan Stern02597d22005-04-28 14:51:27 -0400567}
568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569/*
570 * Allocate a frame list, and then setup the skeleton
571 *
572 * The hardware doesn't really know any difference
573 * in the queues, but the order does matter for the
Alan Stern17230ac2007-02-19 15:52:45 -0500574 * protocols higher up. The order in which the queues
575 * are encountered by the hardware is:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 *
Alan Stern17230ac2007-02-19 15:52:45 -0500577 * - All isochronous events are handled before any
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 * of the queues. We don't do that here, because
579 * we'll create the actual TD entries on demand.
Alan Stern17230ac2007-02-19 15:52:45 -0500580 * - The first queue is the high-period interrupt queue.
581 * - The second queue is the period-1 interrupt and async
582 * (low-speed control, full-speed control, then bulk) queue.
583 * - The third queue is the terminating bandwidth reclamation queue,
584 * which contains no members, loops back to itself, and is present
585 * only when FSBR is on and there are no full-speed control or bulk QHs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 */
587static int uhci_start(struct usb_hcd *hcd)
588{
589 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
590 int retval = -EBUSY;
Alan Sternc074b412005-04-22 14:39:12 -0400591 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 struct dentry *dentry;
593
Alan Stern6c1b4452005-04-21 16:04:58 -0400594 hcd->uses_new_polling = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 spin_lock_init(&uhci->lock);
Alan Sternc5e3b742006-06-05 12:28:57 -0400597 setup_timer(&uhci->fsbr_timer, uhci_fsbr_timeout,
598 (unsigned long) uhci);
Alan Sterndccf4a42005-12-17 17:58:46 -0500599 INIT_LIST_HEAD(&uhci->idle_qh_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 init_waitqueue_head(&uhci->waitqh);
601
Alan Stern8d402e12005-12-17 18:03:37 -0500602 if (DEBUG_CONFIGURED) {
603 dentry = debugfs_create_file(hcd->self.bus_name,
604 S_IFREG|S_IRUGO|S_IWUSR, uhci_debugfs_root,
605 uhci, &uhci_debug_operations);
606 if (!dentry) {
607 dev_err(uhci_dev(uhci), "couldn't create uhci "
608 "debugfs entry\n");
609 retval = -ENOMEM;
610 goto err_create_debug_entry;
611 }
612 uhci->dentry = dentry;
613 }
614
Alan Sterna1d59ce2005-09-16 14:22:51 -0400615 uhci->frame = dma_alloc_coherent(uhci_dev(uhci),
616 UHCI_NUMFRAMES * sizeof(*uhci->frame),
617 &uhci->frame_dma_handle, 0);
618 if (!uhci->frame) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 dev_err(uhci_dev(uhci), "unable to allocate "
620 "consistent memory for frame list\n");
Alan Sterna1d59ce2005-09-16 14:22:51 -0400621 goto err_alloc_frame;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 }
Alan Sterna1d59ce2005-09-16 14:22:51 -0400623 memset(uhci->frame, 0, UHCI_NUMFRAMES * sizeof(*uhci->frame));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
Alan Sterna1d59ce2005-09-16 14:22:51 -0400625 uhci->frame_cpu = kcalloc(UHCI_NUMFRAMES, sizeof(*uhci->frame_cpu),
626 GFP_KERNEL);
627 if (!uhci->frame_cpu) {
628 dev_err(uhci_dev(uhci), "unable to allocate "
629 "memory for frame pointers\n");
630 goto err_alloc_frame_cpu;
631 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633 uhci->td_pool = dma_pool_create("uhci_td", uhci_dev(uhci),
634 sizeof(struct uhci_td), 16, 0);
635 if (!uhci->td_pool) {
636 dev_err(uhci_dev(uhci), "unable to create td dma_pool\n");
637 goto err_create_td_pool;
638 }
639
640 uhci->qh_pool = dma_pool_create("uhci_qh", uhci_dev(uhci),
641 sizeof(struct uhci_qh), 16, 0);
642 if (!uhci->qh_pool) {
643 dev_err(uhci_dev(uhci), "unable to create qh dma_pool\n");
644 goto err_create_qh_pool;
645 }
646
Alan Stern25321782005-04-25 11:14:31 -0400647 uhci->term_td = uhci_alloc_td(uhci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 if (!uhci->term_td) {
649 dev_err(uhci_dev(uhci), "unable to allocate terminating TD\n");
650 goto err_alloc_term_td;
651 }
652
653 for (i = 0; i < UHCI_NUM_SKELQH; i++) {
Alan Sterndccf4a42005-12-17 17:58:46 -0500654 uhci->skelqh[i] = uhci_alloc_qh(uhci, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 if (!uhci->skelqh[i]) {
656 dev_err(uhci_dev(uhci), "unable to allocate QH\n");
657 goto err_alloc_skelqh;
658 }
659 }
660
661 /*
Alan Stern17230ac2007-02-19 15:52:45 -0500662 * 8 Interrupt queues; link all higher int queues to int1 = async
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 */
Alan Stern17230ac2007-02-19 15:52:45 -0500664 for (i = SKEL_ISO + 1; i < SKEL_ASYNC; ++i)
665 uhci->skelqh[i]->link = LINK_TO_QH(uhci->skel_async_qh);
Alan Sterne009f1b2007-03-19 15:31:42 -0400666 uhci->skel_async_qh->link = UHCI_PTR_TERM;
667 uhci->skel_term_qh->link = LINK_TO_QH(uhci->skel_term_qh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
669 /* This dummy TD is to work around a bug in Intel PIIX controllers */
Alan Sternfa346562005-11-30 11:57:51 -0500670 uhci_fill_td(uhci->term_td, 0, uhci_explen(0) |
Alan Stern17230ac2007-02-19 15:52:45 -0500671 (0x7f << TD_TOKEN_DEVADDR_SHIFT) | USB_PID_IN, 0);
672 uhci->term_td->link = UHCI_PTR_TERM;
673 uhci->skel_async_qh->element = uhci->skel_term_qh->element =
674 LINK_TO_TD(uhci->term_td);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
676 /*
677 * Fill the frame list: make all entries point to the proper
678 * interrupt queue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 */
680 for (i = 0; i < UHCI_NUMFRAMES; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
682 /* Only place we don't use the frame list routines */
Alan Sternf3fe2392007-01-08 12:00:28 -0500683 uhci->frame[i] = uhci_frame_skel_link(uhci, i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 }
685
686 /*
687 * Some architectures require a full mb() to enforce completion of
Alan Sterna8bed8b2005-04-09 17:29:00 -0400688 * the memory writes above before the I/O transfers in configure_hc().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 */
690 mb();
Alan Sterna8bed8b2005-04-09 17:29:00 -0400691
692 configure_hc(uhci);
Alan Stern8d402e12005-12-17 18:03:37 -0500693 uhci->is_initialized = 1;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400694 start_rh(uhci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 return 0;
696
697/*
698 * error exits:
699 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700err_alloc_skelqh:
Alan Stern8b4cd422005-09-16 14:17:45 -0400701 for (i = 0; i < UHCI_NUM_SKELQH; i++) {
702 if (uhci->skelqh[i])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 uhci_free_qh(uhci, uhci->skelqh[i]);
Alan Stern8b4cd422005-09-16 14:17:45 -0400704 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
706 uhci_free_td(uhci, uhci->term_td);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
708err_alloc_term_td:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 dma_pool_destroy(uhci->qh_pool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
711err_create_qh_pool:
712 dma_pool_destroy(uhci->td_pool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714err_create_td_pool:
Alan Sterna1d59ce2005-09-16 14:22:51 -0400715 kfree(uhci->frame_cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
Alan Sterna1d59ce2005-09-16 14:22:51 -0400717err_alloc_frame_cpu:
718 dma_free_coherent(uhci_dev(uhci),
719 UHCI_NUMFRAMES * sizeof(*uhci->frame),
720 uhci->frame, uhci->frame_dma_handle);
721
722err_alloc_frame:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 debugfs_remove(uhci->dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
725err_create_debug_entry:
726 return retval;
727}
728
729static void uhci_stop(struct usb_hcd *hcd)
730{
731 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
732
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 spin_lock_irq(&uhci->lock);
Alan Sterne323de42006-06-05 12:21:30 -0400734 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) && !uhci->dead)
735 uhci_hc_died(uhci);
David Howells7d12e782006-10-05 14:55:46 +0100736 uhci_scan_schedule(uhci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 spin_unlock_irq(&uhci->lock);
Alan Stern6c1b4452005-04-21 16:04:58 -0400738
Alan Sternc5e3b742006-06-05 12:28:57 -0400739 del_timer_sync(&uhci->fsbr_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 release_uhci(uhci);
741}
742
743#ifdef CONFIG_PM
Alan Sterna8bed8b2005-04-09 17:29:00 -0400744static int uhci_rh_suspend(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745{
746 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
David Brownellbe3cbc52006-06-05 12:16:39 -0400747 int rc = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
749 spin_lock_irq(&uhci->lock);
David Brownellbe3cbc52006-06-05 12:16:39 -0400750 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
751 rc = -ESHUTDOWN;
Alan Sterne323de42006-06-05 12:21:30 -0400752 else if (!uhci->dead)
Alan Stern4daaa872005-04-09 17:30:08 -0400753 suspend_rh(uhci, UHCI_RH_SUSPENDED);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400754 spin_unlock_irq(&uhci->lock);
David Brownellbe3cbc52006-06-05 12:16:39 -0400755 return rc;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400756}
757
758static int uhci_rh_resume(struct usb_hcd *hcd)
759{
760 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Alan Stern4daaa872005-04-09 17:30:08 -0400761 int rc = 0;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400762
763 spin_lock_irq(&uhci->lock);
Alan Sterncfa59da2007-06-21 16:25:35 -0400764 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
David Brownellbe3cbc52006-06-05 12:16:39 -0400765 rc = -ESHUTDOWN;
Alan Sterncfa59da2007-06-21 16:25:35 -0400766 else if (!uhci->dead)
Alan Stern4daaa872005-04-09 17:30:08 -0400767 wakeup_rh(uhci);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400768 spin_unlock_irq(&uhci->lock);
Alan Stern4daaa872005-04-09 17:30:08 -0400769 return rc;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400770}
771
Alan Stern7be7d742008-04-03 18:03:06 -0400772static int uhci_pci_suspend(struct usb_hcd *hcd, pm_message_t message)
Alan Sterna8bed8b2005-04-09 17:29:00 -0400773{
774 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Alan Stern4daaa872005-04-09 17:30:08 -0400775 int rc = 0;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400776
Harvey Harrison441b62c2008-03-03 16:08:34 -0800777 dev_dbg(uhci_dev(uhci), "%s\n", __func__);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400778
779 spin_lock_irq(&uhci->lock);
Alan Sterne323de42006-06-05 12:21:30 -0400780 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) || uhci->dead)
781 goto done_okay; /* Already suspended or dead */
Alan Sterna8bed8b2005-04-09 17:29:00 -0400782
Alan Stern4daaa872005-04-09 17:30:08 -0400783 if (uhci->rh_state > UHCI_RH_SUSPENDED) {
784 dev_warn(uhci_dev(uhci), "Root hub isn't suspended!\n");
Alan Stern4daaa872005-04-09 17:30:08 -0400785 rc = -EBUSY;
786 goto done;
787 };
788
Alan Sterna8bed8b2005-04-09 17:29:00 -0400789 /* All PCI host controllers are required to disable IRQ generation
790 * at the source, so we must turn off PIRQ.
791 */
792 pci_write_config_word(to_pci_dev(uhci_dev(uhci)), USBLEGSUP, 0);
Alan Stern42245e62005-12-16 11:09:01 -0800793 mb();
Alan Stern1f09df82005-09-05 13:59:51 -0400794 hcd->poll_rh = 0;
Alan Sterna8bed8b2005-04-09 17:29:00 -0400795
796 /* FIXME: Enable non-PME# remote wakeup? */
797
David Brownell18584992006-08-14 23:11:06 -0700798 /* make sure snapshot being resumed re-enumerates everything */
799 if (message.event == PM_EVENT_PRETHAW)
800 uhci_hc_died(uhci);
801
Alan Sterne323de42006-06-05 12:21:30 -0400802done_okay:
803 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
Alan Stern4daaa872005-04-09 17:30:08 -0400804done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 spin_unlock_irq(&uhci->lock);
Alan Stern4daaa872005-04-09 17:30:08 -0400806 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807}
808
Alan Stern7be7d742008-04-03 18:03:06 -0400809static int uhci_pci_resume(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810{
811 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
Harvey Harrison441b62c2008-03-03 16:08:34 -0800813 dev_dbg(uhci_dev(uhci), "%s\n", __func__);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400814
Alan Stern687f5f32005-11-30 17:16:19 -0500815 /* Since we aren't in D3 any more, it's safe to set this flag
Alan Sterne323de42006-06-05 12:21:30 -0400816 * even if the controller was dead.
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100817 */
818 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
Alan Stern42245e62005-12-16 11:09:01 -0800819 mb();
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100820
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 spin_lock_irq(&uhci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Alan Sterna8bed8b2005-04-09 17:29:00 -0400823 /* FIXME: Disable non-PME# remote wakeup? */
824
Alan Sterne323de42006-06-05 12:21:30 -0400825 /* The firmware or a boot kernel may have changed the controller
826 * settings during a system wakeup. Check it and reconfigure
827 * to avoid problems.
Alan Sterna8bed8b2005-04-09 17:29:00 -0400828 */
829 check_and_reset_hc(uhci);
Alan Sterne323de42006-06-05 12:21:30 -0400830
831 /* If the controller was dead before, it's back alive now */
Alan Sterna8bed8b2005-04-09 17:29:00 -0400832 configure_hc(uhci);
833
Alan Stern1c50c312005-11-14 11:45:38 -0500834 if (uhci->rh_state == UHCI_RH_RESET) {
835
836 /* The controller had to be reset */
837 usb_root_hub_lost_power(hcd->self.root_hub);
Alan Sterna8bed8b2005-04-09 17:29:00 -0400838 suspend_rh(uhci, UHCI_RH_SUSPENDED);
Alan Stern1c50c312005-11-14 11:45:38 -0500839 }
Alan Sterna8bed8b2005-04-09 17:29:00 -0400840
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 spin_unlock_irq(&uhci->lock);
Alan Stern6c1b4452005-04-21 16:04:58 -0400842
Alan Sternd8f12ab2008-04-22 10:49:15 -0400843 /* If interrupts don't work and remote wakeup is enabled then
844 * the suspended root hub needs to be polled.
845 */
846 if (!uhci->RD_enable && hcd->self.root_hub->do_remote_wakeup) {
Alan Stern1f09df82005-09-05 13:59:51 -0400847 hcd->poll_rh = 1;
Alan Stern6c1b4452005-04-21 16:04:58 -0400848 usb_hcd_poll_rh_status(hcd);
Alan Stern1f09df82005-09-05 13:59:51 -0400849 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 return 0;
851}
852#endif
853
Alan Sterndccf4a42005-12-17 17:58:46 -0500854/* Wait until a particular device/endpoint's QH is idle, and free it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855static void uhci_hcd_endpoint_disable(struct usb_hcd *hcd,
Alan Sterndccf4a42005-12-17 17:58:46 -0500856 struct usb_host_endpoint *hep)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857{
858 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Alan Sterndccf4a42005-12-17 17:58:46 -0500859 struct uhci_qh *qh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860
Alan Sterndccf4a42005-12-17 17:58:46 -0500861 spin_lock_irq(&uhci->lock);
862 qh = (struct uhci_qh *) hep->hcpriv;
863 if (qh == NULL)
864 goto done;
865
866 while (qh->state != QH_STATE_IDLE) {
867 ++uhci->num_waiting;
868 spin_unlock_irq(&uhci->lock);
869 wait_event_interruptible(uhci->waitqh,
870 qh->state == QH_STATE_IDLE);
871 spin_lock_irq(&uhci->lock);
872 --uhci->num_waiting;
873 }
874
875 uhci_free_qh(uhci, qh);
876done:
877 spin_unlock_irq(&uhci->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878}
879
880static int uhci_hcd_get_frame_number(struct usb_hcd *hcd)
881{
882 struct uhci_hcd *uhci = hcd_to_uhci(hcd);
Alan Sternc4334722006-05-19 16:34:57 -0400883 unsigned frame_number;
884 unsigned delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
886 /* Minimize latency by avoiding the spinlock */
Alan Sternc4334722006-05-19 16:34:57 -0400887 frame_number = uhci->frame_number;
888 barrier();
889 delta = (inw(uhci->io_addr + USBFRNUM) - frame_number) &
890 (UHCI_NUMFRAMES - 1);
891 return frame_number + delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892}
893
894static const char hcd_name[] = "uhci_hcd";
895
896static const struct hc_driver uhci_driver = {
897 .description = hcd_name,
898 .product_desc = "UHCI Host Controller",
899 .hcd_priv_size = sizeof(struct uhci_hcd),
900
901 /* Generic hardware linkage */
902 .irq = uhci_irq,
903 .flags = HCD_USB11,
904
905 /* Basic lifecycle operations */
David Brownellbe3cbc52006-06-05 12:16:39 -0400906 .reset = uhci_init,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 .start = uhci_start,
908#ifdef CONFIG_PM
Alan Stern7be7d742008-04-03 18:03:06 -0400909 .pci_suspend = uhci_pci_suspend,
910 .pci_resume = uhci_pci_resume,
Alan Stern0c0382e2005-10-13 17:08:02 -0400911 .bus_suspend = uhci_rh_suspend,
912 .bus_resume = uhci_rh_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913#endif
914 .stop = uhci_stop,
915
916 .urb_enqueue = uhci_urb_enqueue,
917 .urb_dequeue = uhci_urb_dequeue,
918
919 .endpoint_disable = uhci_hcd_endpoint_disable,
920 .get_frame_number = uhci_hcd_get_frame_number,
921
922 .hub_status_data = uhci_hub_status_data,
923 .hub_control = uhci_hub_control,
924};
925
926static const struct pci_device_id uhci_pci_ids[] = { {
927 /* handle any USB UHCI controller */
Jean Delvarec67808e2006-04-09 20:07:35 +0200928 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_UHCI, ~0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 .driver_data = (unsigned long) &uhci_driver,
930 }, { /* end: all zeroes */ }
931};
932
933MODULE_DEVICE_TABLE(pci, uhci_pci_ids);
934
935static struct pci_driver uhci_pci_driver = {
936 .name = (char *)hcd_name,
937 .id_table = uhci_pci_ids,
938
939 .probe = usb_hcd_pci_probe,
940 .remove = usb_hcd_pci_remove,
Alan Stern02597d22005-04-28 14:51:27 -0400941 .shutdown = uhci_shutdown,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942
943#ifdef CONFIG_PM
944 .suspend = usb_hcd_pci_suspend,
945 .resume = usb_hcd_pci_resume,
946#endif /* PM */
947};
948
949static int __init uhci_hcd_init(void)
950{
951 int retval = -ENOMEM;
952
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 if (usb_disabled())
954 return -ENODEV;
955
Alan Stern2b70f072008-10-02 11:47:15 -0400956 printk(KERN_INFO "uhci_hcd: " DRIVER_DESC "%s\n",
957 ignore_oc ? ", overcurrent ignored" : "");
Alan Stern9beeee62008-10-02 11:48:13 -0400958 set_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
Alan Stern2b70f072008-10-02 11:47:15 -0400959
Alan Stern8d402e12005-12-17 18:03:37 -0500960 if (DEBUG_CONFIGURED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 errbuf = kmalloc(ERRBUF_LEN, GFP_KERNEL);
962 if (!errbuf)
963 goto errbuf_failed;
Alan Stern8d402e12005-12-17 18:03:37 -0500964 uhci_debugfs_root = debugfs_create_dir("uhci", NULL);
965 if (!uhci_debugfs_root)
966 goto debug_failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 }
968
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 uhci_up_cachep = kmem_cache_create("uhci_urb_priv",
Paul Mundt20c2df82007-07-20 10:11:58 +0900970 sizeof(struct urb_priv), 0, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 if (!uhci_up_cachep)
972 goto up_failed;
973
974 retval = pci_register_driver(&uhci_pci_driver);
975 if (retval)
976 goto init_failed;
977
978 return 0;
979
980init_failed:
Alexey Dobriyan1a1d92c2006-09-27 01:49:40 -0700981 kmem_cache_destroy(uhci_up_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
983up_failed:
984 debugfs_remove(uhci_debugfs_root);
985
986debug_failed:
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700987 kfree(errbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
989errbuf_failed:
990
Alan Stern9beeee62008-10-02 11:48:13 -0400991 clear_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 return retval;
993}
994
995static void __exit uhci_hcd_cleanup(void)
996{
997 pci_unregister_driver(&uhci_pci_driver);
Alexey Dobriyan1a1d92c2006-09-27 01:49:40 -0700998 kmem_cache_destroy(uhci_up_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 debugfs_remove(uhci_debugfs_root);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001000 kfree(errbuf);
Alan Stern9beeee62008-10-02 11:48:13 -04001001 clear_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002}
1003
1004module_init(uhci_hcd_init);
1005module_exit(uhci_hcd_cleanup);
1006
1007MODULE_AUTHOR(DRIVER_AUTHOR);
1008MODULE_DESCRIPTION(DRIVER_DESC);
1009MODULE_LICENSE("GPL");