blob: e300509faa61119cc59b17daf46a3ceea95a8ec4 [file] [log] [blame]
David Brownell75862692005-09-23 17:14:37 -07001/*
2 * This file contains code to reset and initialize USB host controllers.
3 * Some of it includes work-arounds for PCI hardware and BIOS quirks.
4 * It may need to run early during booting -- before USB would normally
5 * initialize -- to ensure that Linux doesn't use any legacy modes.
6 *
7 * Copyright (c) 1999 Martin Mares <mj@ucw.cz>
8 * (and others)
9 */
10
David Brownell75862692005-09-23 17:14:37 -070011#include <linux/types.h>
12#include <linux/kernel.h>
13#include <linux/pci.h>
14#include <linux/init.h>
15#include <linux/delay.h>
16#include <linux/acpi.h>
Adrian Bunk75e2df62006-03-25 18:01:53 +010017#include "pci-quirks.h"
Sarah Sharp66d4ead2009-04-27 19:52:28 -070018#include "xhci-ext-caps.h"
David Brownell75862692005-09-23 17:14:37 -070019
20
David Brownell75862692005-09-23 17:14:37 -070021#define UHCI_USBLEGSUP 0xc0 /* legacy support */
22#define UHCI_USBCMD 0 /* command register */
David Brownell75862692005-09-23 17:14:37 -070023#define UHCI_USBINTR 4 /* interrupt register */
Alan Sternbb200f62005-10-03 16:36:29 -040024#define UHCI_USBLEGSUP_RWC 0x8f00 /* the R/WC bits */
25#define UHCI_USBLEGSUP_RO 0x5040 /* R/O and reserved bits */
26#define UHCI_USBCMD_RUN 0x0001 /* RUN/STOP bit */
27#define UHCI_USBCMD_HCRESET 0x0002 /* Host Controller reset */
28#define UHCI_USBCMD_EGSM 0x0008 /* Global Suspend Mode */
29#define UHCI_USBCMD_CONFIGURE 0x0040 /* Config Flag */
30#define UHCI_USBINTR_RESUME 0x0002 /* Resume interrupt enable */
David Brownell75862692005-09-23 17:14:37 -070031
32#define OHCI_CONTROL 0x04
33#define OHCI_CMDSTATUS 0x08
34#define OHCI_INTRSTATUS 0x0c
35#define OHCI_INTRENABLE 0x10
36#define OHCI_INTRDISABLE 0x14
37#define OHCI_OCR (1 << 3) /* ownership change request */
David Brownellf2cb36c2005-09-22 22:43:30 -070038#define OHCI_CTRL_RWC (1 << 9) /* remote wakeup connected */
David Brownell75862692005-09-23 17:14:37 -070039#define OHCI_CTRL_IR (1 << 8) /* interrupt routing */
40#define OHCI_INTR_OC (1 << 30) /* ownership change */
41
42#define EHCI_HCC_PARAMS 0x08 /* extended capabilities */
43#define EHCI_USBCMD 0 /* command register */
44#define EHCI_USBCMD_RUN (1 << 0) /* RUN/STOP bit */
45#define EHCI_USBSTS 4 /* status register */
46#define EHCI_USBSTS_HALTED (1 << 12) /* HCHalted bit */
47#define EHCI_USBINTR 8 /* interrupt register */
Alan Stern4fe53542007-04-05 16:06:53 -040048#define EHCI_CONFIGFLAG 0x40 /* configured flag register */
David Brownell75862692005-09-23 17:14:37 -070049#define EHCI_USBLEGSUP 0 /* legacy support register */
50#define EHCI_USBLEGSUP_BIOS (1 << 16) /* BIOS semaphore */
51#define EHCI_USBLEGSUP_OS (1 << 24) /* OS semaphore */
52#define EHCI_USBLEGCTLSTS 4 /* legacy control/status */
53#define EHCI_USBLEGCTLSTS_SOOE (1 << 13) /* SMI on ownership change */
54
Andiry Xuad935622011-03-01 14:57:05 +080055/* AMD quirk use */
56#define AB_REG_BAR_LOW 0xe0
57#define AB_REG_BAR_HIGH 0xe1
58#define AB_REG_BAR_SB700 0xf0
59#define AB_INDX(addr) ((addr) + 0x00)
60#define AB_DATA(addr) ((addr) + 0x04)
61#define AX_INDXC 0x30
62#define AX_DATAC 0x34
63
64#define NB_PCIE_INDX_ADDR 0xe0
65#define NB_PCIE_INDX_DATA 0xe4
66#define PCIE_P_CNTL 0x10040
67#define BIF_NB 0x10002
68#define NB_PIF0_PWRDOWN_0 0x01100012
69#define NB_PIF0_PWRDOWN_1 0x01100013
70
71static struct amd_chipset_info {
72 struct pci_dev *nb_dev;
73 struct pci_dev *smbus_dev;
74 int nb_type;
75 int sb_type;
76 int isoc_reqs;
77 int probe_count;
78 int probe_result;
79} amd_chipset;
80
81static DEFINE_SPINLOCK(amd_lock);
82
83int usb_amd_find_chipset_info(void)
84{
85 u8 rev = 0;
86 unsigned long flags;
Joerg Roedel9ab79272011-04-13 08:38:16 +020087 struct amd_chipset_info info;
88 int ret;
Andiry Xuad935622011-03-01 14:57:05 +080089
90 spin_lock_irqsave(&amd_lock, flags);
91
Andiry Xuad935622011-03-01 14:57:05 +080092 /* probe only once */
Joerg Roedel9ab79272011-04-13 08:38:16 +020093 if (amd_chipset.probe_count > 0) {
94 amd_chipset.probe_count++;
Andiry Xuad935622011-03-01 14:57:05 +080095 spin_unlock_irqrestore(&amd_lock, flags);
96 return amd_chipset.probe_result;
97 }
Joerg Roedel9ab79272011-04-13 08:38:16 +020098 memset(&info, 0, sizeof(info));
99 spin_unlock_irqrestore(&amd_lock, flags);
Andiry Xuad935622011-03-01 14:57:05 +0800100
Joerg Roedel9ab79272011-04-13 08:38:16 +0200101 info.smbus_dev = pci_get_device(PCI_VENDOR_ID_ATI, 0x4385, NULL);
102 if (info.smbus_dev) {
103 rev = info.smbus_dev->revision;
Andiry Xuad935622011-03-01 14:57:05 +0800104 if (rev >= 0x40)
Joerg Roedel9ab79272011-04-13 08:38:16 +0200105 info.sb_type = 1;
Andiry Xuad935622011-03-01 14:57:05 +0800106 else if (rev >= 0x30 && rev <= 0x3b)
Joerg Roedel9ab79272011-04-13 08:38:16 +0200107 info.sb_type = 3;
Andiry Xuad935622011-03-01 14:57:05 +0800108 } else {
Joerg Roedel9ab79272011-04-13 08:38:16 +0200109 info.smbus_dev = pci_get_device(PCI_VENDOR_ID_AMD,
110 0x780b, NULL);
111 if (!info.smbus_dev) {
112 ret = 0;
113 goto commit;
Andiry Xuad935622011-03-01 14:57:05 +0800114 }
Joerg Roedel9ab79272011-04-13 08:38:16 +0200115
116 rev = info.smbus_dev->revision;
Andiry Xuad935622011-03-01 14:57:05 +0800117 if (rev >= 0x11 && rev <= 0x18)
Joerg Roedel9ab79272011-04-13 08:38:16 +0200118 info.sb_type = 2;
Andiry Xuad935622011-03-01 14:57:05 +0800119 }
120
Joerg Roedel9ab79272011-04-13 08:38:16 +0200121 if (info.sb_type == 0) {
122 if (info.smbus_dev) {
123 pci_dev_put(info.smbus_dev);
124 info.smbus_dev = NULL;
Andiry Xuad935622011-03-01 14:57:05 +0800125 }
Joerg Roedel9ab79272011-04-13 08:38:16 +0200126 ret = 0;
127 goto commit;
Andiry Xuad935622011-03-01 14:57:05 +0800128 }
129
Joerg Roedel9ab79272011-04-13 08:38:16 +0200130 info.nb_dev = pci_get_device(PCI_VENDOR_ID_AMD, 0x9601, NULL);
131 if (info.nb_dev) {
132 info.nb_type = 1;
Andiry Xuad935622011-03-01 14:57:05 +0800133 } else {
Joerg Roedel9ab79272011-04-13 08:38:16 +0200134 info.nb_dev = pci_get_device(PCI_VENDOR_ID_AMD, 0x1510, NULL);
135 if (info.nb_dev) {
136 info.nb_type = 2;
137 } else {
138 info.nb_dev = pci_get_device(PCI_VENDOR_ID_AMD,
139 0x9600, NULL);
140 if (info.nb_dev)
141 info.nb_type = 3;
Andiry Xuad935622011-03-01 14:57:05 +0800142 }
143 }
144
Joerg Roedel9ab79272011-04-13 08:38:16 +0200145 ret = info.probe_result = 1;
Andiry Xuad935622011-03-01 14:57:05 +0800146 printk(KERN_DEBUG "QUIRK: Enable AMD PLL fix\n");
147
Joerg Roedel9ab79272011-04-13 08:38:16 +0200148commit:
149
150 spin_lock_irqsave(&amd_lock, flags);
151 if (amd_chipset.probe_count > 0) {
152 /* race - someone else was faster - drop devices */
153
154 /* Mark that we where here */
155 amd_chipset.probe_count++;
156 ret = amd_chipset.probe_result;
157
158 spin_unlock_irqrestore(&amd_lock, flags);
159
160 if (info.nb_dev)
161 pci_dev_put(info.nb_dev);
162 if (info.smbus_dev)
163 pci_dev_put(info.smbus_dev);
164
165 } else {
166 /* no race - commit the result */
167 info.probe_count++;
168 amd_chipset = info;
169 spin_unlock_irqrestore(&amd_lock, flags);
170 }
171
172 return ret;
Andiry Xuad935622011-03-01 14:57:05 +0800173}
174EXPORT_SYMBOL_GPL(usb_amd_find_chipset_info);
175
176/*
177 * The hardware normally enables the A-link power management feature, which
178 * lets the system lower the power consumption in idle states.
179 *
180 * This USB quirk prevents the link going into that lower power state
181 * during isochronous transfers.
182 *
183 * Without this quirk, isochronous stream on OHCI/EHCI/xHCI controllers of
184 * some AMD platforms may stutter or have breaks occasionally.
185 */
186static void usb_amd_quirk_pll(int disable)
187{
188 u32 addr, addr_low, addr_high, val;
189 u32 bit = disable ? 0 : 1;
190 unsigned long flags;
191
192 spin_lock_irqsave(&amd_lock, flags);
193
194 if (disable) {
195 amd_chipset.isoc_reqs++;
196 if (amd_chipset.isoc_reqs > 1) {
197 spin_unlock_irqrestore(&amd_lock, flags);
198 return;
199 }
200 } else {
201 amd_chipset.isoc_reqs--;
202 if (amd_chipset.isoc_reqs > 0) {
203 spin_unlock_irqrestore(&amd_lock, flags);
204 return;
205 }
206 }
207
208 if (amd_chipset.sb_type == 1 || amd_chipset.sb_type == 2) {
209 outb_p(AB_REG_BAR_LOW, 0xcd6);
210 addr_low = inb_p(0xcd7);
211 outb_p(AB_REG_BAR_HIGH, 0xcd6);
212 addr_high = inb_p(0xcd7);
213 addr = addr_high << 8 | addr_low;
214
215 outl_p(0x30, AB_INDX(addr));
216 outl_p(0x40, AB_DATA(addr));
217 outl_p(0x34, AB_INDX(addr));
218 val = inl_p(AB_DATA(addr));
219 } else if (amd_chipset.sb_type == 3) {
220 pci_read_config_dword(amd_chipset.smbus_dev,
221 AB_REG_BAR_SB700, &addr);
222 outl(AX_INDXC, AB_INDX(addr));
223 outl(0x40, AB_DATA(addr));
224 outl(AX_DATAC, AB_INDX(addr));
225 val = inl(AB_DATA(addr));
226 } else {
227 spin_unlock_irqrestore(&amd_lock, flags);
228 return;
229 }
230
231 if (disable) {
232 val &= ~0x08;
233 val |= (1 << 4) | (1 << 9);
234 } else {
235 val |= 0x08;
236 val &= ~((1 << 4) | (1 << 9));
237 }
238 outl_p(val, AB_DATA(addr));
239
240 if (!amd_chipset.nb_dev) {
241 spin_unlock_irqrestore(&amd_lock, flags);
242 return;
243 }
244
245 if (amd_chipset.nb_type == 1 || amd_chipset.nb_type == 3) {
246 addr = PCIE_P_CNTL;
247 pci_write_config_dword(amd_chipset.nb_dev,
248 NB_PCIE_INDX_ADDR, addr);
249 pci_read_config_dword(amd_chipset.nb_dev,
250 NB_PCIE_INDX_DATA, &val);
251
252 val &= ~(1 | (1 << 3) | (1 << 4) | (1 << 9) | (1 << 12));
253 val |= bit | (bit << 3) | (bit << 12);
254 val |= ((!bit) << 4) | ((!bit) << 9);
255 pci_write_config_dword(amd_chipset.nb_dev,
256 NB_PCIE_INDX_DATA, val);
257
258 addr = BIF_NB;
259 pci_write_config_dword(amd_chipset.nb_dev,
260 NB_PCIE_INDX_ADDR, addr);
261 pci_read_config_dword(amd_chipset.nb_dev,
262 NB_PCIE_INDX_DATA, &val);
263 val &= ~(1 << 8);
264 val |= bit << 8;
265
266 pci_write_config_dword(amd_chipset.nb_dev,
267 NB_PCIE_INDX_DATA, val);
268 } else if (amd_chipset.nb_type == 2) {
269 addr = NB_PIF0_PWRDOWN_0;
270 pci_write_config_dword(amd_chipset.nb_dev,
271 NB_PCIE_INDX_ADDR, addr);
272 pci_read_config_dword(amd_chipset.nb_dev,
273 NB_PCIE_INDX_DATA, &val);
274 if (disable)
275 val &= ~(0x3f << 7);
276 else
277 val |= 0x3f << 7;
278
279 pci_write_config_dword(amd_chipset.nb_dev,
280 NB_PCIE_INDX_DATA, val);
281
282 addr = NB_PIF0_PWRDOWN_1;
283 pci_write_config_dword(amd_chipset.nb_dev,
284 NB_PCIE_INDX_ADDR, addr);
285 pci_read_config_dword(amd_chipset.nb_dev,
286 NB_PCIE_INDX_DATA, &val);
287 if (disable)
288 val &= ~(0x3f << 7);
289 else
290 val |= 0x3f << 7;
291
292 pci_write_config_dword(amd_chipset.nb_dev,
293 NB_PCIE_INDX_DATA, val);
294 }
295
296 spin_unlock_irqrestore(&amd_lock, flags);
297 return;
298}
299
300void usb_amd_quirk_pll_disable(void)
301{
302 usb_amd_quirk_pll(1);
303}
304EXPORT_SYMBOL_GPL(usb_amd_quirk_pll_disable);
305
306void usb_amd_quirk_pll_enable(void)
307{
308 usb_amd_quirk_pll(0);
309}
310EXPORT_SYMBOL_GPL(usb_amd_quirk_pll_enable);
311
312void usb_amd_dev_put(void)
313{
Joerg Roedel9ab79272011-04-13 08:38:16 +0200314 struct pci_dev *nb, *smbus;
Andiry Xuad935622011-03-01 14:57:05 +0800315 unsigned long flags;
316
317 spin_lock_irqsave(&amd_lock, flags);
318
319 amd_chipset.probe_count--;
320 if (amd_chipset.probe_count > 0) {
321 spin_unlock_irqrestore(&amd_lock, flags);
322 return;
323 }
324
Joerg Roedel9ab79272011-04-13 08:38:16 +0200325 /* save them to pci_dev_put outside of spinlock */
326 nb = amd_chipset.nb_dev;
327 smbus = amd_chipset.smbus_dev;
328
329 amd_chipset.nb_dev = NULL;
330 amd_chipset.smbus_dev = NULL;
Andiry Xuad935622011-03-01 14:57:05 +0800331 amd_chipset.nb_type = 0;
332 amd_chipset.sb_type = 0;
333 amd_chipset.isoc_reqs = 0;
334 amd_chipset.probe_result = 0;
335
336 spin_unlock_irqrestore(&amd_lock, flags);
Joerg Roedel9ab79272011-04-13 08:38:16 +0200337
338 if (nb)
339 pci_dev_put(nb);
340 if (smbus)
341 pci_dev_put(smbus);
Andiry Xuad935622011-03-01 14:57:05 +0800342}
343EXPORT_SYMBOL_GPL(usb_amd_dev_put);
David Brownell75862692005-09-23 17:14:37 -0700344
Alan Sternbb200f62005-10-03 16:36:29 -0400345/*
346 * Make sure the controller is completely inactive, unable to
347 * generate interrupts or do DMA.
348 */
349void uhci_reset_hc(struct pci_dev *pdev, unsigned long base)
350{
351 /* Turn off PIRQ enable and SMI enable. (This also turns off the
352 * BIOS's USB Legacy Support.) Turn off all the R/WC bits too.
353 */
354 pci_write_config_word(pdev, UHCI_USBLEGSUP, UHCI_USBLEGSUP_RWC);
355
356 /* Reset the HC - this will force us to get a
357 * new notification of any already connected
358 * ports due to the virtual disconnect that it
359 * implies.
360 */
361 outw(UHCI_USBCMD_HCRESET, base + UHCI_USBCMD);
362 mb();
363 udelay(5);
364 if (inw(base + UHCI_USBCMD) & UHCI_USBCMD_HCRESET)
365 dev_warn(&pdev->dev, "HCRESET not completed yet!\n");
366
367 /* Just to be safe, disable interrupt requests and
368 * make sure the controller is stopped.
369 */
370 outw(0, base + UHCI_USBINTR);
371 outw(0, base + UHCI_USBCMD);
372}
373EXPORT_SYMBOL_GPL(uhci_reset_hc);
374
375/*
376 * Initialize a controller that was newly discovered or has just been
377 * resumed. In either case we can't be sure of its previous state.
378 *
379 * Returns: 1 if the controller was reset, 0 otherwise.
380 */
381int uhci_check_and_reset_hc(struct pci_dev *pdev, unsigned long base)
382{
383 u16 legsup;
384 unsigned int cmd, intr;
385
386 /*
387 * When restarting a suspended controller, we expect all the
388 * settings to be the same as we left them:
389 *
390 * PIRQ and SMI disabled, no R/W bits set in USBLEGSUP;
391 * Controller is stopped and configured with EGSM set;
392 * No interrupts enabled except possibly Resume Detect.
393 *
394 * If any of these conditions are violated we do a complete reset.
395 */
396 pci_read_config_word(pdev, UHCI_USBLEGSUP, &legsup);
397 if (legsup & ~(UHCI_USBLEGSUP_RO | UHCI_USBLEGSUP_RWC)) {
398 dev_dbg(&pdev->dev, "%s: legsup = 0x%04x\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800399 __func__, legsup);
Alan Sternbb200f62005-10-03 16:36:29 -0400400 goto reset_needed;
401 }
402
403 cmd = inw(base + UHCI_USBCMD);
404 if ((cmd & UHCI_USBCMD_RUN) || !(cmd & UHCI_USBCMD_CONFIGURE) ||
405 !(cmd & UHCI_USBCMD_EGSM)) {
406 dev_dbg(&pdev->dev, "%s: cmd = 0x%04x\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800407 __func__, cmd);
Alan Sternbb200f62005-10-03 16:36:29 -0400408 goto reset_needed;
409 }
410
411 intr = inw(base + UHCI_USBINTR);
412 if (intr & (~UHCI_USBINTR_RESUME)) {
413 dev_dbg(&pdev->dev, "%s: intr = 0x%04x\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800414 __func__, intr);
Alan Sternbb200f62005-10-03 16:36:29 -0400415 goto reset_needed;
416 }
417 return 0;
418
419reset_needed:
420 dev_dbg(&pdev->dev, "Performing full reset\n");
421 uhci_reset_hc(pdev, base);
422 return 1;
423}
424EXPORT_SYMBOL_GPL(uhci_check_and_reset_hc);
425
Linus Torvalds541ab4a2005-10-31 21:12:40 -0800426static inline int io_type_enabled(struct pci_dev *pdev, unsigned int mask)
427{
428 u16 cmd;
429 return !pci_read_config_word(pdev, PCI_COMMAND, &cmd) && (cmd & mask);
430}
431
432#define pio_enabled(dev) io_type_enabled(dev, PCI_COMMAND_IO)
433#define mmio_enabled(dev) io_type_enabled(dev, PCI_COMMAND_MEMORY)
434
David Brownell75862692005-09-23 17:14:37 -0700435static void __devinit quirk_usb_handoff_uhci(struct pci_dev *pdev)
436{
437 unsigned long base = 0;
David Brownell75862692005-09-23 17:14:37 -0700438 int i;
439
Linus Torvalds541ab4a2005-10-31 21:12:40 -0800440 if (!pio_enabled(pdev))
441 return;
442
David Brownell75862692005-09-23 17:14:37 -0700443 for (i = 0; i < PCI_ROM_RESOURCE; i++)
444 if ((pci_resource_flags(pdev, i) & IORESOURCE_IO)) {
445 base = pci_resource_start(pdev, i);
446 break;
447 }
448
Alan Sternbb200f62005-10-03 16:36:29 -0400449 if (base)
450 uhci_check_and_reset_hc(pdev, base);
David Brownell75862692005-09-23 17:14:37 -0700451}
452
Linus Torvalds541ab4a2005-10-31 21:12:40 -0800453static int __devinit mmio_resource_enabled(struct pci_dev *pdev, int idx)
454{
455 return pci_resource_start(pdev, idx) && mmio_enabled(pdev);
456}
457
David Brownell75862692005-09-23 17:14:37 -0700458static void __devinit quirk_usb_handoff_ohci(struct pci_dev *pdev)
459{
460 void __iomem *base;
Alan Stern3df71692010-09-10 16:37:05 -0400461 u32 control;
David Brownell75862692005-09-23 17:14:37 -0700462
Linus Torvalds541ab4a2005-10-31 21:12:40 -0800463 if (!mmio_resource_enabled(pdev, 0))
464 return;
465
Arjan van de Ven8e8ce4b2008-10-20 21:46:01 -0700466 base = pci_ioremap_bar(pdev, 0);
467 if (base == NULL)
468 return;
David Brownell75862692005-09-23 17:14:37 -0700469
Alan Stern3df71692010-09-10 16:37:05 -0400470 control = readl(base + OHCI_CONTROL);
471
David Brownellf2cb36c2005-09-22 22:43:30 -0700472/* On PA-RISC, PDC can leave IR set incorrectly; ignore it there. */
Alan Stern3df71692010-09-10 16:37:05 -0400473#ifdef __hppa__
474#define OHCI_CTRL_MASK (OHCI_CTRL_RWC | OHCI_CTRL_IR)
475#else
476#define OHCI_CTRL_MASK OHCI_CTRL_RWC
477
David Brownellf2cb36c2005-09-22 22:43:30 -0700478 if (control & OHCI_CTRL_IR) {
Kyle McMartinc1b45f22006-06-25 18:45:29 -0400479 int wait_time = 500; /* arbitrary; 5 seconds */
David Brownell75862692005-09-23 17:14:37 -0700480 writel(OHCI_INTR_OC, base + OHCI_INTRENABLE);
481 writel(OHCI_OCR, base + OHCI_CMDSTATUS);
482 while (wait_time > 0 &&
483 readl(base + OHCI_CONTROL) & OHCI_CTRL_IR) {
484 wait_time -= 10;
485 msleep(10);
486 }
David Brownellf2cb36c2005-09-22 22:43:30 -0700487 if (wait_time <= 0)
bjorn.helgaas@hp.comf0fda802007-12-17 14:09:39 -0700488 dev_warn(&pdev->dev, "OHCI: BIOS handoff failed"
489 " (BIOS bug?) %08x\n",
David Brownella38408c2006-02-09 16:35:31 -0500490 readl(base + OHCI_CONTROL));
David Brownell75862692005-09-23 17:14:37 -0700491 }
David Brownellf2cb36c2005-09-22 22:43:30 -0700492#endif
David Brownell75862692005-09-23 17:14:37 -0700493
Alan Stern3df71692010-09-10 16:37:05 -0400494 /* reset controller, preserving RWC (and possibly IR) */
495 writel(control & OHCI_CTRL_MASK, base + OHCI_CONTROL);
496
David Brownell75862692005-09-23 17:14:37 -0700497 /*
498 * disable interrupts
499 */
500 writel(~(u32)0, base + OHCI_INTRDISABLE);
501 writel(~(u32)0, base + OHCI_INTRSTATUS);
502
503 iounmap(base);
504}
505
Andy Ross5c853012011-05-11 15:15:51 -0700506static void __devinit ehci_bios_handoff(struct pci_dev *pdev,
507 void __iomem *op_reg_base,
508 u32 cap, u8 offset)
509{
510 int msec, tried_handoff = 0;
511
512 if (cap & EHCI_USBLEGSUP_BIOS) {
513 dev_dbg(&pdev->dev, "EHCI: BIOS handoff\n");
514
515#if 0
516/* aleksey_gorelov@phoenix.com reports that some systems need SMI forced on,
517 * but that seems dubious in general (the BIOS left it off intentionally)
518 * and is known to prevent some systems from booting. so we won't do this
519 * unless maybe we can determine when we're on a system that needs SMI forced.
520 */
521 /* BIOS workaround (?): be sure the pre-Linux code
522 * receives the SMI
523 */
524 pci_read_config_dword(pdev, offset + EHCI_USBLEGCTLSTS, &val);
525 pci_write_config_dword(pdev, offset + EHCI_USBLEGCTLSTS,
526 val | EHCI_USBLEGCTLSTS_SOOE);
527#endif
528
529 /* some systems get upset if this semaphore is
530 * set for any other reason than forcing a BIOS
531 * handoff..
532 */
533 pci_write_config_byte(pdev, offset + 3, 1);
534 }
535
536 /* if boot firmware now owns EHCI, spin till it hands it over. */
537 msec = 1000;
538 while ((cap & EHCI_USBLEGSUP_BIOS) && (msec > 0)) {
539 tried_handoff = 1;
540 msleep(10);
541 msec -= 10;
542 pci_read_config_dword(pdev, offset, &cap);
543 }
544
545 if (cap & EHCI_USBLEGSUP_BIOS) {
546 /* well, possibly buggy BIOS... try to shut it down,
547 * and hope nothing goes too wrong
548 */
549 dev_warn(&pdev->dev, "EHCI: BIOS handoff failed"
550 " (BIOS bug?) %08x\n", cap);
551 pci_write_config_byte(pdev, offset + 2, 0);
552 }
553
554 /* just in case, always disable EHCI SMIs */
555 pci_write_config_dword(pdev, offset + EHCI_USBLEGCTLSTS, 0);
556
557 /* If the BIOS ever owned the controller then we can't expect
558 * any power sessions to remain intact.
559 */
560 if (tried_handoff)
561 writel(0, op_reg_base + EHCI_CONFIGFLAG);
562}
563
David Brownell75862692005-09-23 17:14:37 -0700564static void __devinit quirk_usb_disable_ehci(struct pci_dev *pdev)
565{
David Brownell75862692005-09-23 17:14:37 -0700566 void __iomem *base, *op_reg_base;
Andy Ross5c853012011-05-11 15:15:51 -0700567 u32 hcc_params, cap, val;
David Brownell401feaf2006-01-24 07:15:30 -0800568 u8 offset, cap_length;
Andy Ross5c853012011-05-11 15:15:51 -0700569 int wait_time, delta, count = 256/4;
David Brownell75862692005-09-23 17:14:37 -0700570
Linus Torvalds541ab4a2005-10-31 21:12:40 -0800571 if (!mmio_resource_enabled(pdev, 0))
572 return;
573
Arjan van de Ven8e8ce4b2008-10-20 21:46:01 -0700574 base = pci_ioremap_bar(pdev, 0);
575 if (base == NULL)
576 return;
David Brownell75862692005-09-23 17:14:37 -0700577
578 cap_length = readb(base);
579 op_reg_base = base + cap_length;
David Brownell75862692005-09-23 17:14:37 -0700580
David Brownell401feaf2006-01-24 07:15:30 -0800581 /* EHCI 0.96 and later may have "extended capabilities"
582 * spec section 5.1 explains the bios handoff, e.g. for
583 * booting from USB disk or using a usb keyboard
584 */
585 hcc_params = readl(base + EHCI_HCC_PARAMS);
586 offset = (hcc_params >> 8) & 0xff;
Roel Kluin6e14bda2009-01-31 12:37:04 +0100587 while (offset && --count) {
David Brownell401feaf2006-01-24 07:15:30 -0800588 pci_read_config_dword(pdev, offset, &cap);
Andy Ross5c853012011-05-11 15:15:51 -0700589
David Brownell401feaf2006-01-24 07:15:30 -0800590 switch (cap & 0xff) {
Andy Ross5c853012011-05-11 15:15:51 -0700591 case 1:
592 ehci_bios_handoff(pdev, op_reg_base, cap, offset);
David Brownell401feaf2006-01-24 07:15:30 -0800593 break;
Andy Ross5c853012011-05-11 15:15:51 -0700594 case 0: /* Illegal reserved cap, set cap=0 so we exit */
595 cap = 0; /* then fallthrough... */
David Brownell401feaf2006-01-24 07:15:30 -0800596 default:
bjorn.helgaas@hp.comf0fda802007-12-17 14:09:39 -0700597 dev_warn(&pdev->dev, "EHCI: unrecognized capability "
Andy Ross5c853012011-05-11 15:15:51 -0700598 "%02x\n", cap & 0xff);
David Brownell75862692005-09-23 17:14:37 -0700599 }
David Brownell401feaf2006-01-24 07:15:30 -0800600 offset = (cap >> 8) & 0xff;
David Brownell75862692005-09-23 17:14:37 -0700601 }
David Brownell401feaf2006-01-24 07:15:30 -0800602 if (!count)
bjorn.helgaas@hp.comf0fda802007-12-17 14:09:39 -0700603 dev_printk(KERN_DEBUG, &pdev->dev, "EHCI: capability loop?\n");
David Brownell75862692005-09-23 17:14:37 -0700604
605 /*
606 * halt EHCI & disable its interrupts in any case
607 */
608 val = readl(op_reg_base + EHCI_USBSTS);
609 if ((val & EHCI_USBSTS_HALTED) == 0) {
610 val = readl(op_reg_base + EHCI_USBCMD);
611 val &= ~EHCI_USBCMD_RUN;
612 writel(val, op_reg_base + EHCI_USBCMD);
613
614 wait_time = 2000;
615 delta = 100;
616 do {
617 writel(0x3f, op_reg_base + EHCI_USBSTS);
618 udelay(delta);
619 wait_time -= delta;
620 val = readl(op_reg_base + EHCI_USBSTS);
621 if ((val == ~(u32)0) || (val & EHCI_USBSTS_HALTED)) {
622 break;
623 }
624 } while (wait_time > 0);
625 }
626 writel(0, op_reg_base + EHCI_USBINTR);
627 writel(0x3f, op_reg_base + EHCI_USBSTS);
628
629 iounmap(base);
David Brownell75862692005-09-23 17:14:37 -0700630}
631
Sarah Sharp66d4ead2009-04-27 19:52:28 -0700632/*
633 * handshake - spin reading a register until handshake completes
634 * @ptr: address of hc register to be read
635 * @mask: bits to look at in result of read
636 * @done: value of those bits when handshake succeeds
637 * @wait_usec: timeout in microseconds
638 * @delay_usec: delay in microseconds to wait between polling
639 *
640 * Polls a register every delay_usec microseconds.
641 * Returns 0 when the mask bits have the value done.
642 * Returns -ETIMEDOUT if this condition is not true after
643 * wait_usec microseconds have passed.
644 */
645static int handshake(void __iomem *ptr, u32 mask, u32 done,
646 int wait_usec, int delay_usec)
647{
648 u32 result;
David Brownell75862692005-09-23 17:14:37 -0700649
Sarah Sharp66d4ead2009-04-27 19:52:28 -0700650 do {
651 result = readl(ptr);
652 result &= mask;
653 if (result == done)
654 return 0;
655 udelay(delay_usec);
656 wait_usec -= delay_usec;
657 } while (wait_usec > 0);
658 return -ETIMEDOUT;
659}
660
661/**
662 * PCI Quirks for xHCI.
663 *
664 * Takes care of the handoff between the Pre-OS (i.e. BIOS) and the OS.
665 * It signals to the BIOS that the OS wants control of the host controller,
666 * and then waits 5 seconds for the BIOS to hand over control.
667 * If we timeout, assume the BIOS is broken and take control anyway.
668 */
669static void __devinit quirk_usb_handoff_xhci(struct pci_dev *pdev)
670{
671 void __iomem *base;
672 int ext_cap_offset;
673 void __iomem *op_reg_base;
674 u32 val;
675 int timeout;
676
677 if (!mmio_resource_enabled(pdev, 0))
678 return;
679
680 base = ioremap_nocache(pci_resource_start(pdev, 0),
681 pci_resource_len(pdev, 0));
682 if (base == NULL)
683 return;
684
685 /*
686 * Find the Legacy Support Capability register -
687 * this is optional for xHCI host controllers.
688 */
689 ext_cap_offset = xhci_find_next_cap_offset(base, XHCI_HCC_PARAMS_OFFSET);
690 do {
691 if (!ext_cap_offset)
692 /* We've reached the end of the extended capabilities */
693 goto hc_init;
694 val = readl(base + ext_cap_offset);
695 if (XHCI_EXT_CAPS_ID(val) == XHCI_EXT_CAPS_LEGACY)
696 break;
697 ext_cap_offset = xhci_find_next_cap_offset(base, ext_cap_offset);
698 } while (1);
699
700 /* If the BIOS owns the HC, signal that the OS wants it, and wait */
701 if (val & XHCI_HC_BIOS_OWNED) {
702 writel(val & XHCI_HC_OS_OWNED, base + ext_cap_offset);
703
704 /* Wait for 5 seconds with 10 microsecond polling interval */
705 timeout = handshake(base + ext_cap_offset, XHCI_HC_BIOS_OWNED,
706 0, 5000, 10);
707
708 /* Assume a buggy BIOS and take HC ownership anyway */
709 if (timeout) {
710 dev_warn(&pdev->dev, "xHCI BIOS handoff failed"
711 " (BIOS bug ?) %08x\n", val);
712 writel(val & ~XHCI_HC_BIOS_OWNED, base + ext_cap_offset);
713 }
714 }
715
716 /* Disable any BIOS SMIs */
717 writel(XHCI_LEGACY_DISABLE_SMI,
718 base + ext_cap_offset + XHCI_LEGACY_CONTROL_OFFSET);
719
720hc_init:
721 op_reg_base = base + XHCI_HC_LENGTH(readl(base));
722
723 /* Wait for the host controller to be ready before writing any
724 * operational or runtime registers. Wait 5 seconds and no more.
725 */
726 timeout = handshake(op_reg_base + XHCI_STS_OFFSET, XHCI_STS_CNR, 0,
727 5000, 10);
728 /* Assume a buggy HC and start HC initialization anyway */
729 if (timeout) {
730 val = readl(op_reg_base + XHCI_STS_OFFSET);
731 dev_warn(&pdev->dev,
732 "xHCI HW not ready after 5 sec (HC bug?) "
733 "status = 0x%x\n", val);
734 }
735
736 /* Send the halt and disable interrupts command */
737 val = readl(op_reg_base + XHCI_CMD_OFFSET);
738 val &= ~(XHCI_CMD_RUN | XHCI_IRQS);
739 writel(val, op_reg_base + XHCI_CMD_OFFSET);
740
741 /* Wait for the HC to halt - poll every 125 usec (one microframe). */
742 timeout = handshake(op_reg_base + XHCI_STS_OFFSET, XHCI_STS_HALT, 1,
743 XHCI_MAX_HALT_USEC, 125);
744 if (timeout) {
745 val = readl(op_reg_base + XHCI_STS_OFFSET);
746 dev_warn(&pdev->dev,
747 "xHCI HW did not halt within %d usec "
748 "status = 0x%x\n", XHCI_MAX_HALT_USEC, val);
749 }
750
751 iounmap(base);
752}
David Brownell75862692005-09-23 17:14:37 -0700753
754static void __devinit quirk_usb_early_handoff(struct pci_dev *pdev)
755{
Alan Stern478a3ba2005-10-19 12:52:02 -0400756 if (pdev->class == PCI_CLASS_SERIAL_USB_UHCI)
David Brownell75862692005-09-23 17:14:37 -0700757 quirk_usb_handoff_uhci(pdev);
Alan Stern478a3ba2005-10-19 12:52:02 -0400758 else if (pdev->class == PCI_CLASS_SERIAL_USB_OHCI)
David Brownell75862692005-09-23 17:14:37 -0700759 quirk_usb_handoff_ohci(pdev);
Alan Stern478a3ba2005-10-19 12:52:02 -0400760 else if (pdev->class == PCI_CLASS_SERIAL_USB_EHCI)
David Brownell75862692005-09-23 17:14:37 -0700761 quirk_usb_disable_ehci(pdev);
Sarah Sharp66d4ead2009-04-27 19:52:28 -0700762 else if (pdev->class == PCI_CLASS_SERIAL_USB_XHCI)
763 quirk_usb_handoff_xhci(pdev);
David Brownell75862692005-09-23 17:14:37 -0700764}
Linus Torvaldsd93a8f82009-10-11 15:57:57 -0700765DECLARE_PCI_FIXUP_FINAL(PCI_ANY_ID, PCI_ANY_ID, quirk_usb_early_handoff);