Linux Audio

Check our new training course

Loading...
v3.1
  1/*
  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
 11#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>
 17#include <linux/dmi.h>
 18#include "pci-quirks.h"
 19#include "xhci-ext-caps.h"
 20
 21
 22#define UHCI_USBLEGSUP		0xc0		/* legacy support */
 23#define UHCI_USBCMD		0		/* command register */
 24#define UHCI_USBINTR		4		/* interrupt register */
 25#define UHCI_USBLEGSUP_RWC	0x8f00		/* the R/WC bits */
 26#define UHCI_USBLEGSUP_RO	0x5040		/* R/O and reserved bits */
 27#define UHCI_USBCMD_RUN		0x0001		/* RUN/STOP bit */
 28#define UHCI_USBCMD_HCRESET	0x0002		/* Host Controller reset */
 29#define UHCI_USBCMD_EGSM	0x0008		/* Global Suspend Mode */
 30#define UHCI_USBCMD_CONFIGURE	0x0040		/* Config Flag */
 31#define UHCI_USBINTR_RESUME	0x0002		/* Resume interrupt enable */
 32
 33#define OHCI_CONTROL		0x04
 34#define OHCI_CMDSTATUS		0x08
 35#define OHCI_INTRSTATUS		0x0c
 36#define OHCI_INTRENABLE		0x10
 37#define OHCI_INTRDISABLE	0x14
 38#define OHCI_FMINTERVAL		0x34
 
 39#define OHCI_HCR		(1 << 0)	/* host controller reset */
 40#define OHCI_OCR		(1 << 3)	/* ownership change request */
 41#define OHCI_CTRL_RWC		(1 << 9)	/* remote wakeup connected */
 42#define OHCI_CTRL_IR		(1 << 8)	/* interrupt routing */
 43#define OHCI_INTR_OC		(1 << 30)	/* ownership change */
 44
 45#define EHCI_HCC_PARAMS		0x08		/* extended capabilities */
 46#define EHCI_USBCMD		0		/* command register */
 47#define EHCI_USBCMD_RUN		(1 << 0)	/* RUN/STOP bit */
 48#define EHCI_USBSTS		4		/* status register */
 49#define EHCI_USBSTS_HALTED	(1 << 12)	/* HCHalted bit */
 50#define EHCI_USBINTR		8		/* interrupt register */
 51#define EHCI_CONFIGFLAG		0x40		/* configured flag register */
 52#define EHCI_USBLEGSUP		0		/* legacy support register */
 53#define EHCI_USBLEGSUP_BIOS	(1 << 16)	/* BIOS semaphore */
 54#define EHCI_USBLEGSUP_OS	(1 << 24)	/* OS semaphore */
 55#define EHCI_USBLEGCTLSTS	4		/* legacy control/status */
 56#define EHCI_USBLEGCTLSTS_SOOE	(1 << 13)	/* SMI on ownership change */
 57
 58/* AMD quirk use */
 59#define	AB_REG_BAR_LOW		0xe0
 60#define	AB_REG_BAR_HIGH		0xe1
 61#define	AB_REG_BAR_SB700	0xf0
 62#define	AB_INDX(addr)		((addr) + 0x00)
 63#define	AB_DATA(addr)		((addr) + 0x04)
 64#define	AX_INDXC		0x30
 65#define	AX_DATAC		0x34
 66
 67#define	NB_PCIE_INDX_ADDR	0xe0
 68#define	NB_PCIE_INDX_DATA	0xe4
 69#define	PCIE_P_CNTL		0x10040
 70#define	BIF_NB			0x10002
 71#define	NB_PIF0_PWRDOWN_0	0x01100012
 72#define	NB_PIF0_PWRDOWN_1	0x01100013
 73
 74#define USB_INTEL_XUSB2PR      0xD0
 
 75#define USB_INTEL_USB3_PSSEN   0xD8
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 76
 77static struct amd_chipset_info {
 78	struct pci_dev	*nb_dev;
 79	struct pci_dev	*smbus_dev;
 80	int nb_type;
 81	int sb_type;
 82	int isoc_reqs;
 83	int probe_count;
 84	int probe_result;
 85} amd_chipset;
 86
 87static DEFINE_SPINLOCK(amd_lock);
 88
 89int usb_amd_find_chipset_info(void)
 
 
 
 
 
 
 
 
 90{
 91	u8 rev = 0;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 92	unsigned long flags;
 93	struct amd_chipset_info info;
 94	int ret;
 95
 96	spin_lock_irqsave(&amd_lock, flags);
 97
 98	/* probe only once */
 99	if (amd_chipset.probe_count > 0) {
100		amd_chipset.probe_count++;
101		spin_unlock_irqrestore(&amd_lock, flags);
102		return amd_chipset.probe_result;
103	}
104	memset(&info, 0, sizeof(info));
105	spin_unlock_irqrestore(&amd_lock, flags);
106
107	info.smbus_dev = pci_get_device(PCI_VENDOR_ID_ATI, 0x4385, NULL);
108	if (info.smbus_dev) {
109		rev = info.smbus_dev->revision;
110		if (rev >= 0x40)
111			info.sb_type = 1;
112		else if (rev >= 0x30 && rev <= 0x3b)
113			info.sb_type = 3;
114	} else {
115		info.smbus_dev = pci_get_device(PCI_VENDOR_ID_AMD,
116						0x780b, NULL);
117		if (!info.smbus_dev) {
118			ret = 0;
119			goto commit;
120		}
121
122		rev = info.smbus_dev->revision;
123		if (rev >= 0x11 && rev <= 0x18)
124			info.sb_type = 2;
125	}
126
127	if (info.sb_type == 0) {
 
 
 
 
 
128		if (info.smbus_dev) {
129			pci_dev_put(info.smbus_dev);
130			info.smbus_dev = NULL;
131		}
132		ret = 0;
133		goto commit;
134	}
135
136	info.nb_dev = pci_get_device(PCI_VENDOR_ID_AMD, 0x9601, NULL);
137	if (info.nb_dev) {
138		info.nb_type = 1;
139	} else {
140		info.nb_dev = pci_get_device(PCI_VENDOR_ID_AMD, 0x1510, NULL);
141		if (info.nb_dev) {
142			info.nb_type = 2;
143		} else {
144			info.nb_dev = pci_get_device(PCI_VENDOR_ID_AMD,
145						     0x9600, NULL);
146			if (info.nb_dev)
147				info.nb_type = 3;
148		}
149	}
150
151	ret = info.probe_result = 1;
152	printk(KERN_DEBUG "QUIRK: Enable AMD PLL fix\n");
153
154commit:
155
156	spin_lock_irqsave(&amd_lock, flags);
157	if (amd_chipset.probe_count > 0) {
158		/* race - someone else was faster - drop devices */
159
160		/* Mark that we where here */
161		amd_chipset.probe_count++;
162		ret = amd_chipset.probe_result;
163
164		spin_unlock_irqrestore(&amd_lock, flags);
165
166		if (info.nb_dev)
167			pci_dev_put(info.nb_dev);
168		if (info.smbus_dev)
169			pci_dev_put(info.smbus_dev);
170
171	} else {
172		/* no race - commit the result */
173		info.probe_count++;
174		amd_chipset = info;
175		spin_unlock_irqrestore(&amd_lock, flags);
176	}
177
178	return ret;
179}
180EXPORT_SYMBOL_GPL(usb_amd_find_chipset_info);
181
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
182/*
183 * The hardware normally enables the A-link power management feature, which
184 * lets the system lower the power consumption in idle states.
185 *
186 * This USB quirk prevents the link going into that lower power state
187 * during isochronous transfers.
188 *
189 * Without this quirk, isochronous stream on OHCI/EHCI/xHCI controllers of
190 * some AMD platforms may stutter or have breaks occasionally.
191 */
192static void usb_amd_quirk_pll(int disable)
193{
194	u32 addr, addr_low, addr_high, val;
195	u32 bit = disable ? 0 : 1;
196	unsigned long flags;
197
198	spin_lock_irqsave(&amd_lock, flags);
199
200	if (disable) {
201		amd_chipset.isoc_reqs++;
202		if (amd_chipset.isoc_reqs > 1) {
203			spin_unlock_irqrestore(&amd_lock, flags);
204			return;
205		}
206	} else {
207		amd_chipset.isoc_reqs--;
208		if (amd_chipset.isoc_reqs > 0) {
209			spin_unlock_irqrestore(&amd_lock, flags);
210			return;
211		}
212	}
213
214	if (amd_chipset.sb_type == 1 || amd_chipset.sb_type == 2) {
 
 
215		outb_p(AB_REG_BAR_LOW, 0xcd6);
216		addr_low = inb_p(0xcd7);
217		outb_p(AB_REG_BAR_HIGH, 0xcd6);
218		addr_high = inb_p(0xcd7);
219		addr = addr_high << 8 | addr_low;
220
221		outl_p(0x30, AB_INDX(addr));
222		outl_p(0x40, AB_DATA(addr));
223		outl_p(0x34, AB_INDX(addr));
224		val = inl_p(AB_DATA(addr));
225	} else if (amd_chipset.sb_type == 3) {
 
226		pci_read_config_dword(amd_chipset.smbus_dev,
227					AB_REG_BAR_SB700, &addr);
228		outl(AX_INDXC, AB_INDX(addr));
229		outl(0x40, AB_DATA(addr));
230		outl(AX_DATAC, AB_INDX(addr));
231		val = inl(AB_DATA(addr));
232	} else {
233		spin_unlock_irqrestore(&amd_lock, flags);
234		return;
235	}
236
237	if (disable) {
238		val &= ~0x08;
239		val |= (1 << 4) | (1 << 9);
240	} else {
241		val |= 0x08;
242		val &= ~((1 << 4) | (1 << 9));
243	}
244	outl_p(val, AB_DATA(addr));
245
246	if (!amd_chipset.nb_dev) {
247		spin_unlock_irqrestore(&amd_lock, flags);
248		return;
249	}
250
251	if (amd_chipset.nb_type == 1 || amd_chipset.nb_type == 3) {
252		addr = PCIE_P_CNTL;
253		pci_write_config_dword(amd_chipset.nb_dev,
254					NB_PCIE_INDX_ADDR, addr);
255		pci_read_config_dword(amd_chipset.nb_dev,
256					NB_PCIE_INDX_DATA, &val);
257
258		val &= ~(1 | (1 << 3) | (1 << 4) | (1 << 9) | (1 << 12));
259		val |= bit | (bit << 3) | (bit << 12);
260		val |= ((!bit) << 4) | ((!bit) << 9);
261		pci_write_config_dword(amd_chipset.nb_dev,
262					NB_PCIE_INDX_DATA, val);
263
264		addr = BIF_NB;
265		pci_write_config_dword(amd_chipset.nb_dev,
266					NB_PCIE_INDX_ADDR, addr);
267		pci_read_config_dword(amd_chipset.nb_dev,
268					NB_PCIE_INDX_DATA, &val);
269		val &= ~(1 << 8);
270		val |= bit << 8;
271
272		pci_write_config_dword(amd_chipset.nb_dev,
273					NB_PCIE_INDX_DATA, val);
274	} else if (amd_chipset.nb_type == 2) {
275		addr = NB_PIF0_PWRDOWN_0;
276		pci_write_config_dword(amd_chipset.nb_dev,
277					NB_PCIE_INDX_ADDR, addr);
278		pci_read_config_dword(amd_chipset.nb_dev,
279					NB_PCIE_INDX_DATA, &val);
280		if (disable)
281			val &= ~(0x3f << 7);
282		else
283			val |= 0x3f << 7;
284
285		pci_write_config_dword(amd_chipset.nb_dev,
286					NB_PCIE_INDX_DATA, val);
287
288		addr = NB_PIF0_PWRDOWN_1;
289		pci_write_config_dword(amd_chipset.nb_dev,
290					NB_PCIE_INDX_ADDR, addr);
291		pci_read_config_dword(amd_chipset.nb_dev,
292					NB_PCIE_INDX_DATA, &val);
293		if (disable)
294			val &= ~(0x3f << 7);
295		else
296			val |= 0x3f << 7;
297
298		pci_write_config_dword(amd_chipset.nb_dev,
299					NB_PCIE_INDX_DATA, val);
300	}
301
302	spin_unlock_irqrestore(&amd_lock, flags);
303	return;
304}
305
306void usb_amd_quirk_pll_disable(void)
307{
308	usb_amd_quirk_pll(1);
309}
310EXPORT_SYMBOL_GPL(usb_amd_quirk_pll_disable);
311
312void usb_amd_quirk_pll_enable(void)
313{
314	usb_amd_quirk_pll(0);
315}
316EXPORT_SYMBOL_GPL(usb_amd_quirk_pll_enable);
317
318void usb_amd_dev_put(void)
319{
320	struct pci_dev *nb, *smbus;
321	unsigned long flags;
322
323	spin_lock_irqsave(&amd_lock, flags);
324
325	amd_chipset.probe_count--;
326	if (amd_chipset.probe_count > 0) {
327		spin_unlock_irqrestore(&amd_lock, flags);
328		return;
329	}
330
331	/* save them to pci_dev_put outside of spinlock */
332	nb    = amd_chipset.nb_dev;
333	smbus = amd_chipset.smbus_dev;
334
335	amd_chipset.nb_dev = NULL;
336	amd_chipset.smbus_dev = NULL;
337	amd_chipset.nb_type = 0;
338	amd_chipset.sb_type = 0;
339	amd_chipset.isoc_reqs = 0;
340	amd_chipset.probe_result = 0;
341
342	spin_unlock_irqrestore(&amd_lock, flags);
343
344	if (nb)
345		pci_dev_put(nb);
346	if (smbus)
347		pci_dev_put(smbus);
348}
349EXPORT_SYMBOL_GPL(usb_amd_dev_put);
350
351/*
352 * Make sure the controller is completely inactive, unable to
353 * generate interrupts or do DMA.
354 */
355void uhci_reset_hc(struct pci_dev *pdev, unsigned long base)
356{
357	/* Turn off PIRQ enable and SMI enable.  (This also turns off the
358	 * BIOS's USB Legacy Support.)  Turn off all the R/WC bits too.
359	 */
360	pci_write_config_word(pdev, UHCI_USBLEGSUP, UHCI_USBLEGSUP_RWC);
361
362	/* Reset the HC - this will force us to get a
363	 * new notification of any already connected
364	 * ports due to the virtual disconnect that it
365	 * implies.
366	 */
367	outw(UHCI_USBCMD_HCRESET, base + UHCI_USBCMD);
368	mb();
369	udelay(5);
370	if (inw(base + UHCI_USBCMD) & UHCI_USBCMD_HCRESET)
371		dev_warn(&pdev->dev, "HCRESET not completed yet!\n");
372
373	/* Just to be safe, disable interrupt requests and
374	 * make sure the controller is stopped.
375	 */
376	outw(0, base + UHCI_USBINTR);
377	outw(0, base + UHCI_USBCMD);
378}
379EXPORT_SYMBOL_GPL(uhci_reset_hc);
380
381/*
382 * Initialize a controller that was newly discovered or has just been
383 * resumed.  In either case we can't be sure of its previous state.
384 *
385 * Returns: 1 if the controller was reset, 0 otherwise.
386 */
387int uhci_check_and_reset_hc(struct pci_dev *pdev, unsigned long base)
388{
389	u16 legsup;
390	unsigned int cmd, intr;
391
392	/*
393	 * When restarting a suspended controller, we expect all the
394	 * settings to be the same as we left them:
395	 *
396	 *	PIRQ and SMI disabled, no R/W bits set in USBLEGSUP;
397	 *	Controller is stopped and configured with EGSM set;
398	 *	No interrupts enabled except possibly Resume Detect.
399	 *
400	 * If any of these conditions are violated we do a complete reset.
401	 */
402	pci_read_config_word(pdev, UHCI_USBLEGSUP, &legsup);
403	if (legsup & ~(UHCI_USBLEGSUP_RO | UHCI_USBLEGSUP_RWC)) {
404		dev_dbg(&pdev->dev, "%s: legsup = 0x%04x\n",
405				__func__, legsup);
406		goto reset_needed;
407	}
408
409	cmd = inw(base + UHCI_USBCMD);
410	if ((cmd & UHCI_USBCMD_RUN) || !(cmd & UHCI_USBCMD_CONFIGURE) ||
411			!(cmd & UHCI_USBCMD_EGSM)) {
412		dev_dbg(&pdev->dev, "%s: cmd = 0x%04x\n",
413				__func__, cmd);
414		goto reset_needed;
415	}
416
417	intr = inw(base + UHCI_USBINTR);
418	if (intr & (~UHCI_USBINTR_RESUME)) {
419		dev_dbg(&pdev->dev, "%s: intr = 0x%04x\n",
420				__func__, intr);
421		goto reset_needed;
422	}
423	return 0;
424
425reset_needed:
426	dev_dbg(&pdev->dev, "Performing full reset\n");
427	uhci_reset_hc(pdev, base);
428	return 1;
429}
430EXPORT_SYMBOL_GPL(uhci_check_and_reset_hc);
431
432static inline int io_type_enabled(struct pci_dev *pdev, unsigned int mask)
433{
434	u16 cmd;
435	return !pci_read_config_word(pdev, PCI_COMMAND, &cmd) && (cmd & mask);
436}
437
438#define pio_enabled(dev) io_type_enabled(dev, PCI_COMMAND_IO)
439#define mmio_enabled(dev) io_type_enabled(dev, PCI_COMMAND_MEMORY)
440
441static void __devinit quirk_usb_handoff_uhci(struct pci_dev *pdev)
442{
443	unsigned long base = 0;
444	int i;
445
446	if (!pio_enabled(pdev))
447		return;
448
449	for (i = 0; i < PCI_ROM_RESOURCE; i++)
450		if ((pci_resource_flags(pdev, i) & IORESOURCE_IO)) {
451			base = pci_resource_start(pdev, i);
452			break;
453		}
454
455	if (base)
456		uhci_check_and_reset_hc(pdev, base);
457}
458
459static int __devinit mmio_resource_enabled(struct pci_dev *pdev, int idx)
460{
461	return pci_resource_start(pdev, idx) && mmio_enabled(pdev);
462}
463
464static void __devinit quirk_usb_handoff_ohci(struct pci_dev *pdev)
465{
466	void __iomem *base;
467	u32 control;
 
 
468
469	if (!mmio_resource_enabled(pdev, 0))
470		return;
471
472	base = pci_ioremap_bar(pdev, 0);
473	if (base == NULL)
474		return;
475
476	control = readl(base + OHCI_CONTROL);
477
478/* On PA-RISC, PDC can leave IR set incorrectly; ignore it there. */
479#ifdef __hppa__
480#define	OHCI_CTRL_MASK		(OHCI_CTRL_RWC | OHCI_CTRL_IR)
481#else
482#define	OHCI_CTRL_MASK		OHCI_CTRL_RWC
483
484	if (control & OHCI_CTRL_IR) {
485		int wait_time = 500; /* arbitrary; 5 seconds */
486		writel(OHCI_INTR_OC, base + OHCI_INTRENABLE);
487		writel(OHCI_OCR, base + OHCI_CMDSTATUS);
488		while (wait_time > 0 &&
489				readl(base + OHCI_CONTROL) & OHCI_CTRL_IR) {
490			wait_time -= 10;
491			msleep(10);
492		}
493		if (wait_time <= 0)
494			dev_warn(&pdev->dev, "OHCI: BIOS handoff failed"
495					" (BIOS bug?) %08x\n",
496					readl(base + OHCI_CONTROL));
497	}
498#endif
499
500	/* reset controller, preserving RWC (and possibly IR) */
501	writel(control & OHCI_CTRL_MASK, base + OHCI_CONTROL);
502	readl(base + OHCI_CONTROL);
503
504	/* Some NVIDIA controllers stop working if kept in RESET for too long */
505	if (pdev->vendor == PCI_VENDOR_ID_NVIDIA) {
506		u32 fminterval;
507		int cnt;
508
509		/* drive reset for at least 50 ms (7.1.7.5) */
510		msleep(50);
511
512		/* software reset of the controller, preserving HcFmInterval */
513		fminterval = readl(base + OHCI_FMINTERVAL);
514		writel(OHCI_HCR, base + OHCI_CMDSTATUS);
515
516		/* reset requires max 10 us delay */
517		for (cnt = 30; cnt > 0; --cnt) {	/* ... allow extra time */
518			if ((readl(base + OHCI_CMDSTATUS) & OHCI_HCR) == 0)
519				break;
520			udelay(1);
521		}
522		writel(fminterval, base + OHCI_FMINTERVAL);
523
524		/* Now we're in the SUSPEND state with all devices reset
525		 * and wakeups and interrupts disabled
526		 */
527	}
528
529	/*
530	 * disable interrupts
531	 */
532	writel(~(u32)0, base + OHCI_INTRDISABLE);
533	writel(~(u32)0, base + OHCI_INTRSTATUS);
 
 
 
 
 
 
534
 
535	iounmap(base);
536}
537
538static const struct dmi_system_id __devinitconst ehci_dmi_nohandoff_table[] = {
539	{
540		/*  Pegatron Lucid (ExoPC) */
541		.matches = {
542			DMI_MATCH(DMI_BOARD_NAME, "EXOPG06411"),
543			DMI_MATCH(DMI_BIOS_VERSION, "Lucid-CE-133"),
544		},
545	},
546	{
547		/*  Pegatron Lucid (Ordissimo AIRIS) */
548		.matches = {
549			DMI_MATCH(DMI_BOARD_NAME, "M11JB"),
550			DMI_MATCH(DMI_BIOS_VERSION, "Lucid-GE-133"),
 
 
 
 
 
 
 
551		},
552	},
553	{ }
554};
555
556static void __devinit ehci_bios_handoff(struct pci_dev *pdev,
557					void __iomem *op_reg_base,
558					u32 cap, u8 offset)
559{
560	int try_handoff = 1, tried_handoff = 0;
561
562	/* The Pegatron Lucid tablet sporadically waits for 98 seconds trying
563	 * the handoff on its unused controller.  Skip it. */
564	if (pdev->vendor == 0x8086 && pdev->device == 0x283a) {
565		if (dmi_check_system(ehci_dmi_nohandoff_table))
566			try_handoff = 0;
567	}
568
569	if (try_handoff && (cap & EHCI_USBLEGSUP_BIOS)) {
570		dev_dbg(&pdev->dev, "EHCI: BIOS handoff\n");
571
572#if 0
573/* aleksey_gorelov@phoenix.com reports that some systems need SMI forced on,
574 * but that seems dubious in general (the BIOS left it off intentionally)
575 * and is known to prevent some systems from booting.  so we won't do this
576 * unless maybe we can determine when we're on a system that needs SMI forced.
577 */
578		/* BIOS workaround (?): be sure the pre-Linux code
579		 * receives the SMI
580		 */
581		pci_read_config_dword(pdev, offset + EHCI_USBLEGCTLSTS, &val);
582		pci_write_config_dword(pdev, offset + EHCI_USBLEGCTLSTS,
583				       val | EHCI_USBLEGCTLSTS_SOOE);
584#endif
585
586		/* some systems get upset if this semaphore is
587		 * set for any other reason than forcing a BIOS
588		 * handoff..
589		 */
590		pci_write_config_byte(pdev, offset + 3, 1);
591	}
592
593	/* if boot firmware now owns EHCI, spin till it hands it over. */
594	if (try_handoff) {
595		int msec = 1000;
596		while ((cap & EHCI_USBLEGSUP_BIOS) && (msec > 0)) {
597			tried_handoff = 1;
598			msleep(10);
599			msec -= 10;
600			pci_read_config_dword(pdev, offset, &cap);
601		}
602	}
603
604	if (cap & EHCI_USBLEGSUP_BIOS) {
605		/* well, possibly buggy BIOS... try to shut it down,
606		 * and hope nothing goes too wrong
607		 */
608		if (try_handoff)
609			dev_warn(&pdev->dev, "EHCI: BIOS handoff failed"
610				 " (BIOS bug?) %08x\n", cap);
611		pci_write_config_byte(pdev, offset + 2, 0);
612	}
613
614	/* just in case, always disable EHCI SMIs */
615	pci_write_config_dword(pdev, offset + EHCI_USBLEGCTLSTS, 0);
616
617	/* If the BIOS ever owned the controller then we can't expect
618	 * any power sessions to remain intact.
619	 */
620	if (tried_handoff)
621		writel(0, op_reg_base + EHCI_CONFIGFLAG);
622}
623
624static void __devinit quirk_usb_disable_ehci(struct pci_dev *pdev)
625{
626	void __iomem *base, *op_reg_base;
627	u32	hcc_params, cap, val;
628	u8	offset, cap_length;
629	int	wait_time, delta, count = 256/4;
630
631	if (!mmio_resource_enabled(pdev, 0))
632		return;
633
634	base = pci_ioremap_bar(pdev, 0);
635	if (base == NULL)
636		return;
637
638	cap_length = readb(base);
639	op_reg_base = base + cap_length;
640
641	/* EHCI 0.96 and later may have "extended capabilities"
642	 * spec section 5.1 explains the bios handoff, e.g. for
643	 * booting from USB disk or using a usb keyboard
644	 */
645	hcc_params = readl(base + EHCI_HCC_PARAMS);
646	offset = (hcc_params >> 8) & 0xff;
647	while (offset && --count) {
648		pci_read_config_dword(pdev, offset, &cap);
649
650		switch (cap & 0xff) {
651		case 1:
652			ehci_bios_handoff(pdev, op_reg_base, cap, offset);
653			break;
654		case 0: /* Illegal reserved cap, set cap=0 so we exit */
655			cap = 0; /* then fallthrough... */
656		default:
657			dev_warn(&pdev->dev, "EHCI: unrecognized capability "
658				 "%02x\n", cap & 0xff);
659		}
660		offset = (cap >> 8) & 0xff;
661	}
662	if (!count)
663		dev_printk(KERN_DEBUG, &pdev->dev, "EHCI: capability loop?\n");
664
665	/*
666	 * halt EHCI & disable its interrupts in any case
667	 */
668	val = readl(op_reg_base + EHCI_USBSTS);
669	if ((val & EHCI_USBSTS_HALTED) == 0) {
670		val = readl(op_reg_base + EHCI_USBCMD);
671		val &= ~EHCI_USBCMD_RUN;
672		writel(val, op_reg_base + EHCI_USBCMD);
673
674		wait_time = 2000;
675		delta = 100;
676		do {
677			writel(0x3f, op_reg_base + EHCI_USBSTS);
678			udelay(delta);
679			wait_time -= delta;
680			val = readl(op_reg_base + EHCI_USBSTS);
681			if ((val == ~(u32)0) || (val & EHCI_USBSTS_HALTED)) {
682				break;
683			}
684		} while (wait_time > 0);
685	}
686	writel(0, op_reg_base + EHCI_USBINTR);
687	writel(0x3f, op_reg_base + EHCI_USBSTS);
688
689	iounmap(base);
690}
691
692/*
693 * handshake - spin reading a register until handshake completes
694 * @ptr: address of hc register to be read
695 * @mask: bits to look at in result of read
696 * @done: value of those bits when handshake succeeds
697 * @wait_usec: timeout in microseconds
698 * @delay_usec: delay in microseconds to wait between polling
699 *
700 * Polls a register every delay_usec microseconds.
701 * Returns 0 when the mask bits have the value done.
702 * Returns -ETIMEDOUT if this condition is not true after
703 * wait_usec microseconds have passed.
704 */
705static int handshake(void __iomem *ptr, u32 mask, u32 done,
706		int wait_usec, int delay_usec)
707{
708	u32	result;
709
710	do {
711		result = readl(ptr);
712		result &= mask;
713		if (result == done)
714			return 0;
715		udelay(delay_usec);
716		wait_usec -= delay_usec;
717	} while (wait_usec > 0);
718	return -ETIMEDOUT;
719}
720
721bool usb_is_intel_switchable_xhci(struct pci_dev *pdev)
722{
723	return pdev->class == PCI_CLASS_SERIAL_USB_XHCI &&
724		pdev->vendor == PCI_VENDOR_ID_INTEL &&
725		pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI;
726}
727EXPORT_SYMBOL_GPL(usb_is_intel_switchable_xhci);
728
729/*
730 * Intel's Panther Point chipset has two host controllers (EHCI and xHCI) that
731 * share some number of ports.  These ports can be switched between either
732 * controller.  Not all of the ports under the EHCI host controller may be
733 * switchable.
734 *
735 * The ports should be switched over to xHCI before PCI probes for any device
736 * start.  This avoids active devices under EHCI being disconnected during the
737 * port switchover, which could cause loss of data on USB storage devices, or
738 * failed boot when the root file system is on a USB mass storage device and is
739 * enumerated under EHCI first.
740 *
741 * We write into the xHC's PCI configuration space in some Intel-specific
742 * registers to switch the ports over.  The USB 3.0 terminations and the USB
743 * 2.0 data wires are switched separately.  We want to enable the SuperSpeed
744 * terminations before switching the USB 2.0 wires over, so that USB 3.0
745 * devices connect at SuperSpeed, rather than at USB 2.0 speeds.
746 */
747void usb_enable_xhci_ports(struct pci_dev *xhci_pdev)
748{
749	u32		ports_available;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
750
751	ports_available = 0xffffffff;
752	/* Write USB3_PSSEN, the USB 3.0 Port SuperSpeed Enable
753	 * Register, to turn on SuperSpeed terminations for all
754	 * available ports.
755	 */
756	pci_write_config_dword(xhci_pdev, USB_INTEL_USB3_PSSEN,
757			cpu_to_le32(ports_available));
758
759	pci_read_config_dword(xhci_pdev, USB_INTEL_USB3_PSSEN,
760			&ports_available);
761	dev_dbg(&xhci_pdev->dev, "USB 3.0 ports that are now enabled "
762			"under xHCI: 0x%x\n", ports_available);
763
764	ports_available = 0xffffffff;
 
 
 
 
 
 
 
 
 
765	/* Write XUSB2PR, the xHC USB 2.0 Port Routing Register, to
766	 * switch the USB 2.0 power and data lines over to the xHCI
767	 * host.
768	 */
769	pci_write_config_dword(xhci_pdev, USB_INTEL_XUSB2PR,
770			cpu_to_le32(ports_available));
771
772	pci_read_config_dword(xhci_pdev, USB_INTEL_XUSB2PR,
773			&ports_available);
774	dev_dbg(&xhci_pdev->dev, "USB 2.0 ports that are now switched over "
775			"to xHCI: 0x%x\n", ports_available);
776}
777EXPORT_SYMBOL_GPL(usb_enable_xhci_ports);
 
 
 
 
 
 
 
778
779/**
780 * PCI Quirks for xHCI.
781 *
782 * Takes care of the handoff between the Pre-OS (i.e. BIOS) and the OS.
783 * It signals to the BIOS that the OS wants control of the host controller,
784 * and then waits 5 seconds for the BIOS to hand over control.
785 * If we timeout, assume the BIOS is broken and take control anyway.
786 */
787static void __devinit quirk_usb_handoff_xhci(struct pci_dev *pdev)
788{
789	void __iomem *base;
790	int ext_cap_offset;
791	void __iomem *op_reg_base;
792	u32 val;
793	int timeout;
 
794
795	if (!mmio_resource_enabled(pdev, 0))
796		return;
797
798	base = ioremap_nocache(pci_resource_start(pdev, 0),
799				pci_resource_len(pdev, 0));
800	if (base == NULL)
801		return;
802
803	/*
804	 * Find the Legacy Support Capability register -
805	 * this is optional for xHCI host controllers.
806	 */
807	ext_cap_offset = xhci_find_next_cap_offset(base, XHCI_HCC_PARAMS_OFFSET);
808	do {
 
 
 
 
 
 
 
809		if (!ext_cap_offset)
810			/* We've reached the end of the extended capabilities */
811			goto hc_init;
 
812		val = readl(base + ext_cap_offset);
813		if (XHCI_EXT_CAPS_ID(val) == XHCI_EXT_CAPS_LEGACY)
814			break;
815		ext_cap_offset = xhci_find_next_cap_offset(base, ext_cap_offset);
816	} while (1);
817
818	/* If the BIOS owns the HC, signal that the OS wants it, and wait */
819	if (val & XHCI_HC_BIOS_OWNED) {
820		writel(val | XHCI_HC_OS_OWNED, base + ext_cap_offset);
821
822		/* Wait for 5 seconds with 10 microsecond polling interval */
823		timeout = handshake(base + ext_cap_offset, XHCI_HC_BIOS_OWNED,
824				0, 5000, 10);
825
826		/* Assume a buggy BIOS and take HC ownership anyway */
827		if (timeout) {
828			dev_warn(&pdev->dev, "xHCI BIOS handoff failed"
829					" (BIOS bug ?) %08x\n", val);
830			writel(val & ~XHCI_HC_BIOS_OWNED, base + ext_cap_offset);
831		}
832	}
833
834	/* Disable any BIOS SMIs */
835	writel(XHCI_LEGACY_DISABLE_SMI,
836			base + ext_cap_offset + XHCI_LEGACY_CONTROL_OFFSET);
 
 
 
 
837
838	if (usb_is_intel_switchable_xhci(pdev))
839		usb_enable_xhci_ports(pdev);
840hc_init:
 
 
 
841	op_reg_base = base + XHCI_HC_LENGTH(readl(base));
842
843	/* Wait for the host controller to be ready before writing any
844	 * operational or runtime registers.  Wait 5 seconds and no more.
845	 */
846	timeout = handshake(op_reg_base + XHCI_STS_OFFSET, XHCI_STS_CNR, 0,
847			5000, 10);
848	/* Assume a buggy HC and start HC initialization anyway */
849	if (timeout) {
850		val = readl(op_reg_base + XHCI_STS_OFFSET);
851		dev_warn(&pdev->dev,
852				"xHCI HW not ready after 5 sec (HC bug?) "
853				"status = 0x%x\n", val);
854	}
855
856	/* Send the halt and disable interrupts command */
857	val = readl(op_reg_base + XHCI_CMD_OFFSET);
858	val &= ~(XHCI_CMD_RUN | XHCI_IRQS);
859	writel(val, op_reg_base + XHCI_CMD_OFFSET);
860
861	/* Wait for the HC to halt - poll every 125 usec (one microframe). */
862	timeout = handshake(op_reg_base + XHCI_STS_OFFSET, XHCI_STS_HALT, 1,
863			XHCI_MAX_HALT_USEC, 125);
864	if (timeout) {
865		val = readl(op_reg_base + XHCI_STS_OFFSET);
866		dev_warn(&pdev->dev,
867				"xHCI HW did not halt within %d usec "
868				"status = 0x%x\n", XHCI_MAX_HALT_USEC, val);
869	}
870
871	iounmap(base);
872}
873
874static void __devinit quirk_usb_early_handoff(struct pci_dev *pdev)
875{
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
876	if (pdev->class == PCI_CLASS_SERIAL_USB_UHCI)
877		quirk_usb_handoff_uhci(pdev);
878	else if (pdev->class == PCI_CLASS_SERIAL_USB_OHCI)
879		quirk_usb_handoff_ohci(pdev);
880	else if (pdev->class == PCI_CLASS_SERIAL_USB_EHCI)
881		quirk_usb_disable_ehci(pdev);
882	else if (pdev->class == PCI_CLASS_SERIAL_USB_XHCI)
883		quirk_usb_handoff_xhci(pdev);
 
884}
885DECLARE_PCI_FIXUP_FINAL(PCI_ANY_ID, PCI_ANY_ID, quirk_usb_early_handoff);
 
v3.15
   1/*
   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
  11#include <linux/types.h>
  12#include <linux/kconfig.h>
  13#include <linux/kernel.h>
  14#include <linux/pci.h>
 
  15#include <linux/delay.h>
  16#include <linux/export.h>
  17#include <linux/acpi.h>
  18#include <linux/dmi.h>
  19#include "pci-quirks.h"
  20#include "xhci-ext-caps.h"
  21
  22
  23#define UHCI_USBLEGSUP		0xc0		/* legacy support */
  24#define UHCI_USBCMD		0		/* command register */
  25#define UHCI_USBINTR		4		/* interrupt register */
  26#define UHCI_USBLEGSUP_RWC	0x8f00		/* the R/WC bits */
  27#define UHCI_USBLEGSUP_RO	0x5040		/* R/O and reserved bits */
  28#define UHCI_USBCMD_RUN		0x0001		/* RUN/STOP bit */
  29#define UHCI_USBCMD_HCRESET	0x0002		/* Host Controller reset */
  30#define UHCI_USBCMD_EGSM	0x0008		/* Global Suspend Mode */
  31#define UHCI_USBCMD_CONFIGURE	0x0040		/* Config Flag */
  32#define UHCI_USBINTR_RESUME	0x0002		/* Resume interrupt enable */
  33
  34#define OHCI_CONTROL		0x04
  35#define OHCI_CMDSTATUS		0x08
  36#define OHCI_INTRSTATUS		0x0c
  37#define OHCI_INTRENABLE		0x10
  38#define OHCI_INTRDISABLE	0x14
  39#define OHCI_FMINTERVAL		0x34
  40#define OHCI_HCFS		(3 << 6)	/* hc functional state */
  41#define OHCI_HCR		(1 << 0)	/* host controller reset */
  42#define OHCI_OCR		(1 << 3)	/* ownership change request */
  43#define OHCI_CTRL_RWC		(1 << 9)	/* remote wakeup connected */
  44#define OHCI_CTRL_IR		(1 << 8)	/* interrupt routing */
  45#define OHCI_INTR_OC		(1 << 30)	/* ownership change */
  46
  47#define EHCI_HCC_PARAMS		0x08		/* extended capabilities */
  48#define EHCI_USBCMD		0		/* command register */
  49#define EHCI_USBCMD_RUN		(1 << 0)	/* RUN/STOP bit */
  50#define EHCI_USBSTS		4		/* status register */
  51#define EHCI_USBSTS_HALTED	(1 << 12)	/* HCHalted bit */
  52#define EHCI_USBINTR		8		/* interrupt register */
  53#define EHCI_CONFIGFLAG		0x40		/* configured flag register */
  54#define EHCI_USBLEGSUP		0		/* legacy support register */
  55#define EHCI_USBLEGSUP_BIOS	(1 << 16)	/* BIOS semaphore */
  56#define EHCI_USBLEGSUP_OS	(1 << 24)	/* OS semaphore */
  57#define EHCI_USBLEGCTLSTS	4		/* legacy control/status */
  58#define EHCI_USBLEGCTLSTS_SOOE	(1 << 13)	/* SMI on ownership change */
  59
  60/* AMD quirk use */
  61#define	AB_REG_BAR_LOW		0xe0
  62#define	AB_REG_BAR_HIGH		0xe1
  63#define	AB_REG_BAR_SB700	0xf0
  64#define	AB_INDX(addr)		((addr) + 0x00)
  65#define	AB_DATA(addr)		((addr) + 0x04)
  66#define	AX_INDXC		0x30
  67#define	AX_DATAC		0x34
  68
  69#define	NB_PCIE_INDX_ADDR	0xe0
  70#define	NB_PCIE_INDX_DATA	0xe4
  71#define	PCIE_P_CNTL		0x10040
  72#define	BIF_NB			0x10002
  73#define	NB_PIF0_PWRDOWN_0	0x01100012
  74#define	NB_PIF0_PWRDOWN_1	0x01100013
  75
  76#define USB_INTEL_XUSB2PR      0xD0
  77#define USB_INTEL_USB2PRM      0xD4
  78#define USB_INTEL_USB3_PSSEN   0xD8
  79#define USB_INTEL_USB3PRM      0xDC
  80
  81/*
  82 * amd_chipset_gen values represent AMD different chipset generations
  83 */
  84enum amd_chipset_gen {
  85	NOT_AMD_CHIPSET = 0,
  86	AMD_CHIPSET_SB600,
  87	AMD_CHIPSET_SB700,
  88	AMD_CHIPSET_SB800,
  89	AMD_CHIPSET_HUDSON2,
  90	AMD_CHIPSET_BOLTON,
  91	AMD_CHIPSET_YANGTZE,
  92	AMD_CHIPSET_UNKNOWN,
  93};
  94
  95struct amd_chipset_type {
  96	enum amd_chipset_gen gen;
  97	u8 rev;
  98};
  99
 100static struct amd_chipset_info {
 101	struct pci_dev	*nb_dev;
 102	struct pci_dev	*smbus_dev;
 103	int nb_type;
 104	struct amd_chipset_type sb_type;
 105	int isoc_reqs;
 106	int probe_count;
 107	int probe_result;
 108} amd_chipset;
 109
 110static DEFINE_SPINLOCK(amd_lock);
 111
 112/*
 113 * amd_chipset_sb_type_init - initialize amd chipset southbridge type
 114 *
 115 * AMD FCH/SB generation and revision is identified by SMBus controller
 116 * vendor, device and revision IDs.
 117 *
 118 * Returns: 1 if it is an AMD chipset, 0 otherwise.
 119 */
 120static int amd_chipset_sb_type_init(struct amd_chipset_info *pinfo)
 121{
 122	u8 rev = 0;
 123	pinfo->sb_type.gen = AMD_CHIPSET_UNKNOWN;
 124
 125	pinfo->smbus_dev = pci_get_device(PCI_VENDOR_ID_ATI,
 126			PCI_DEVICE_ID_ATI_SBX00_SMBUS, NULL);
 127	if (pinfo->smbus_dev) {
 128		rev = pinfo->smbus_dev->revision;
 129		if (rev >= 0x10 && rev <= 0x1f)
 130			pinfo->sb_type.gen = AMD_CHIPSET_SB600;
 131		else if (rev >= 0x30 && rev <= 0x3f)
 132			pinfo->sb_type.gen = AMD_CHIPSET_SB700;
 133		else if (rev >= 0x40 && rev <= 0x4f)
 134			pinfo->sb_type.gen = AMD_CHIPSET_SB800;
 135	} else {
 136		pinfo->smbus_dev = pci_get_device(PCI_VENDOR_ID_AMD,
 137				PCI_DEVICE_ID_AMD_HUDSON2_SMBUS, NULL);
 138
 139		if (!pinfo->smbus_dev) {
 140			pinfo->sb_type.gen = NOT_AMD_CHIPSET;
 141			return 0;
 142		}
 143
 144		rev = pinfo->smbus_dev->revision;
 145		if (rev >= 0x11 && rev <= 0x14)
 146			pinfo->sb_type.gen = AMD_CHIPSET_HUDSON2;
 147		else if (rev >= 0x15 && rev <= 0x18)
 148			pinfo->sb_type.gen = AMD_CHIPSET_BOLTON;
 149		else if (rev >= 0x39 && rev <= 0x3a)
 150			pinfo->sb_type.gen = AMD_CHIPSET_YANGTZE;
 151	}
 152
 153	pinfo->sb_type.rev = rev;
 154	return 1;
 155}
 156
 157void sb800_prefetch(struct device *dev, int on)
 158{
 159	u16 misc;
 160	struct pci_dev *pdev = to_pci_dev(dev);
 161
 162	pci_read_config_word(pdev, 0x50, &misc);
 163	if (on == 0)
 164		pci_write_config_word(pdev, 0x50, misc & 0xfcff);
 165	else
 166		pci_write_config_word(pdev, 0x50, misc | 0x0300);
 167}
 168EXPORT_SYMBOL_GPL(sb800_prefetch);
 169
 170int usb_amd_find_chipset_info(void)
 171{
 172	unsigned long flags;
 173	struct amd_chipset_info info;
 174	int ret;
 175
 176	spin_lock_irqsave(&amd_lock, flags);
 177
 178	/* probe only once */
 179	if (amd_chipset.probe_count > 0) {
 180		amd_chipset.probe_count++;
 181		spin_unlock_irqrestore(&amd_lock, flags);
 182		return amd_chipset.probe_result;
 183	}
 184	memset(&info, 0, sizeof(info));
 185	spin_unlock_irqrestore(&amd_lock, flags);
 186
 187	if (!amd_chipset_sb_type_init(&info)) {
 188		ret = 0;
 189		goto commit;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 190	}
 191
 192	/* Below chipset generations needn't enable AMD PLL quirk */
 193	if (info.sb_type.gen == AMD_CHIPSET_UNKNOWN ||
 194			info.sb_type.gen == AMD_CHIPSET_SB600 ||
 195			info.sb_type.gen == AMD_CHIPSET_YANGTZE ||
 196			(info.sb_type.gen == AMD_CHIPSET_SB700 &&
 197			info.sb_type.rev > 0x3b)) {
 198		if (info.smbus_dev) {
 199			pci_dev_put(info.smbus_dev);
 200			info.smbus_dev = NULL;
 201		}
 202		ret = 0;
 203		goto commit;
 204	}
 205
 206	info.nb_dev = pci_get_device(PCI_VENDOR_ID_AMD, 0x9601, NULL);
 207	if (info.nb_dev) {
 208		info.nb_type = 1;
 209	} else {
 210		info.nb_dev = pci_get_device(PCI_VENDOR_ID_AMD, 0x1510, NULL);
 211		if (info.nb_dev) {
 212			info.nb_type = 2;
 213		} else {
 214			info.nb_dev = pci_get_device(PCI_VENDOR_ID_AMD,
 215						     0x9600, NULL);
 216			if (info.nb_dev)
 217				info.nb_type = 3;
 218		}
 219	}
 220
 221	ret = info.probe_result = 1;
 222	printk(KERN_DEBUG "QUIRK: Enable AMD PLL fix\n");
 223
 224commit:
 225
 226	spin_lock_irqsave(&amd_lock, flags);
 227	if (amd_chipset.probe_count > 0) {
 228		/* race - someone else was faster - drop devices */
 229
 230		/* Mark that we where here */
 231		amd_chipset.probe_count++;
 232		ret = amd_chipset.probe_result;
 233
 234		spin_unlock_irqrestore(&amd_lock, flags);
 235
 236		if (info.nb_dev)
 237			pci_dev_put(info.nb_dev);
 238		if (info.smbus_dev)
 239			pci_dev_put(info.smbus_dev);
 240
 241	} else {
 242		/* no race - commit the result */
 243		info.probe_count++;
 244		amd_chipset = info;
 245		spin_unlock_irqrestore(&amd_lock, flags);
 246	}
 247
 248	return ret;
 249}
 250EXPORT_SYMBOL_GPL(usb_amd_find_chipset_info);
 251
 252int usb_hcd_amd_remote_wakeup_quirk(struct pci_dev *pdev)
 253{
 254	/* Make sure amd chipset type has already been initialized */
 255	usb_amd_find_chipset_info();
 256	if (amd_chipset.sb_type.gen != AMD_CHIPSET_YANGTZE)
 257		return 0;
 258
 259	dev_dbg(&pdev->dev, "QUIRK: Enable AMD remote wakeup fix\n");
 260	return 1;
 261}
 262EXPORT_SYMBOL_GPL(usb_hcd_amd_remote_wakeup_quirk);
 263
 264bool usb_amd_hang_symptom_quirk(void)
 265{
 266	u8 rev;
 267
 268	usb_amd_find_chipset_info();
 269	rev = amd_chipset.sb_type.rev;
 270	/* SB600 and old version of SB700 have hang symptom bug */
 271	return amd_chipset.sb_type.gen == AMD_CHIPSET_SB600 ||
 272			(amd_chipset.sb_type.gen == AMD_CHIPSET_SB700 &&
 273			 rev >= 0x3a && rev <= 0x3b);
 274}
 275EXPORT_SYMBOL_GPL(usb_amd_hang_symptom_quirk);
 276
 277bool usb_amd_prefetch_quirk(void)
 278{
 279	usb_amd_find_chipset_info();
 280	/* SB800 needs pre-fetch fix */
 281	return amd_chipset.sb_type.gen == AMD_CHIPSET_SB800;
 282}
 283EXPORT_SYMBOL_GPL(usb_amd_prefetch_quirk);
 284
 285/*
 286 * The hardware normally enables the A-link power management feature, which
 287 * lets the system lower the power consumption in idle states.
 288 *
 289 * This USB quirk prevents the link going into that lower power state
 290 * during isochronous transfers.
 291 *
 292 * Without this quirk, isochronous stream on OHCI/EHCI/xHCI controllers of
 293 * some AMD platforms may stutter or have breaks occasionally.
 294 */
 295static void usb_amd_quirk_pll(int disable)
 296{
 297	u32 addr, addr_low, addr_high, val;
 298	u32 bit = disable ? 0 : 1;
 299	unsigned long flags;
 300
 301	spin_lock_irqsave(&amd_lock, flags);
 302
 303	if (disable) {
 304		amd_chipset.isoc_reqs++;
 305		if (amd_chipset.isoc_reqs > 1) {
 306			spin_unlock_irqrestore(&amd_lock, flags);
 307			return;
 308		}
 309	} else {
 310		amd_chipset.isoc_reqs--;
 311		if (amd_chipset.isoc_reqs > 0) {
 312			spin_unlock_irqrestore(&amd_lock, flags);
 313			return;
 314		}
 315	}
 316
 317	if (amd_chipset.sb_type.gen == AMD_CHIPSET_SB800 ||
 318			amd_chipset.sb_type.gen == AMD_CHIPSET_HUDSON2 ||
 319			amd_chipset.sb_type.gen == AMD_CHIPSET_BOLTON) {
 320		outb_p(AB_REG_BAR_LOW, 0xcd6);
 321		addr_low = inb_p(0xcd7);
 322		outb_p(AB_REG_BAR_HIGH, 0xcd6);
 323		addr_high = inb_p(0xcd7);
 324		addr = addr_high << 8 | addr_low;
 325
 326		outl_p(0x30, AB_INDX(addr));
 327		outl_p(0x40, AB_DATA(addr));
 328		outl_p(0x34, AB_INDX(addr));
 329		val = inl_p(AB_DATA(addr));
 330	} else if (amd_chipset.sb_type.gen == AMD_CHIPSET_SB700 &&
 331			amd_chipset.sb_type.rev <= 0x3b) {
 332		pci_read_config_dword(amd_chipset.smbus_dev,
 333					AB_REG_BAR_SB700, &addr);
 334		outl(AX_INDXC, AB_INDX(addr));
 335		outl(0x40, AB_DATA(addr));
 336		outl(AX_DATAC, AB_INDX(addr));
 337		val = inl(AB_DATA(addr));
 338	} else {
 339		spin_unlock_irqrestore(&amd_lock, flags);
 340		return;
 341	}
 342
 343	if (disable) {
 344		val &= ~0x08;
 345		val |= (1 << 4) | (1 << 9);
 346	} else {
 347		val |= 0x08;
 348		val &= ~((1 << 4) | (1 << 9));
 349	}
 350	outl_p(val, AB_DATA(addr));
 351
 352	if (!amd_chipset.nb_dev) {
 353		spin_unlock_irqrestore(&amd_lock, flags);
 354		return;
 355	}
 356
 357	if (amd_chipset.nb_type == 1 || amd_chipset.nb_type == 3) {
 358		addr = PCIE_P_CNTL;
 359		pci_write_config_dword(amd_chipset.nb_dev,
 360					NB_PCIE_INDX_ADDR, addr);
 361		pci_read_config_dword(amd_chipset.nb_dev,
 362					NB_PCIE_INDX_DATA, &val);
 363
 364		val &= ~(1 | (1 << 3) | (1 << 4) | (1 << 9) | (1 << 12));
 365		val |= bit | (bit << 3) | (bit << 12);
 366		val |= ((!bit) << 4) | ((!bit) << 9);
 367		pci_write_config_dword(amd_chipset.nb_dev,
 368					NB_PCIE_INDX_DATA, val);
 369
 370		addr = BIF_NB;
 371		pci_write_config_dword(amd_chipset.nb_dev,
 372					NB_PCIE_INDX_ADDR, addr);
 373		pci_read_config_dword(amd_chipset.nb_dev,
 374					NB_PCIE_INDX_DATA, &val);
 375		val &= ~(1 << 8);
 376		val |= bit << 8;
 377
 378		pci_write_config_dword(amd_chipset.nb_dev,
 379					NB_PCIE_INDX_DATA, val);
 380	} else if (amd_chipset.nb_type == 2) {
 381		addr = NB_PIF0_PWRDOWN_0;
 382		pci_write_config_dword(amd_chipset.nb_dev,
 383					NB_PCIE_INDX_ADDR, addr);
 384		pci_read_config_dword(amd_chipset.nb_dev,
 385					NB_PCIE_INDX_DATA, &val);
 386		if (disable)
 387			val &= ~(0x3f << 7);
 388		else
 389			val |= 0x3f << 7;
 390
 391		pci_write_config_dword(amd_chipset.nb_dev,
 392					NB_PCIE_INDX_DATA, val);
 393
 394		addr = NB_PIF0_PWRDOWN_1;
 395		pci_write_config_dword(amd_chipset.nb_dev,
 396					NB_PCIE_INDX_ADDR, addr);
 397		pci_read_config_dword(amd_chipset.nb_dev,
 398					NB_PCIE_INDX_DATA, &val);
 399		if (disable)
 400			val &= ~(0x3f << 7);
 401		else
 402			val |= 0x3f << 7;
 403
 404		pci_write_config_dword(amd_chipset.nb_dev,
 405					NB_PCIE_INDX_DATA, val);
 406	}
 407
 408	spin_unlock_irqrestore(&amd_lock, flags);
 409	return;
 410}
 411
 412void usb_amd_quirk_pll_disable(void)
 413{
 414	usb_amd_quirk_pll(1);
 415}
 416EXPORT_SYMBOL_GPL(usb_amd_quirk_pll_disable);
 417
 418void usb_amd_quirk_pll_enable(void)
 419{
 420	usb_amd_quirk_pll(0);
 421}
 422EXPORT_SYMBOL_GPL(usb_amd_quirk_pll_enable);
 423
 424void usb_amd_dev_put(void)
 425{
 426	struct pci_dev *nb, *smbus;
 427	unsigned long flags;
 428
 429	spin_lock_irqsave(&amd_lock, flags);
 430
 431	amd_chipset.probe_count--;
 432	if (amd_chipset.probe_count > 0) {
 433		spin_unlock_irqrestore(&amd_lock, flags);
 434		return;
 435	}
 436
 437	/* save them to pci_dev_put outside of spinlock */
 438	nb    = amd_chipset.nb_dev;
 439	smbus = amd_chipset.smbus_dev;
 440
 441	amd_chipset.nb_dev = NULL;
 442	amd_chipset.smbus_dev = NULL;
 443	amd_chipset.nb_type = 0;
 444	memset(&amd_chipset.sb_type, 0, sizeof(amd_chipset.sb_type));
 445	amd_chipset.isoc_reqs = 0;
 446	amd_chipset.probe_result = 0;
 447
 448	spin_unlock_irqrestore(&amd_lock, flags);
 449
 450	if (nb)
 451		pci_dev_put(nb);
 452	if (smbus)
 453		pci_dev_put(smbus);
 454}
 455EXPORT_SYMBOL_GPL(usb_amd_dev_put);
 456
 457/*
 458 * Make sure the controller is completely inactive, unable to
 459 * generate interrupts or do DMA.
 460 */
 461void uhci_reset_hc(struct pci_dev *pdev, unsigned long base)
 462{
 463	/* Turn off PIRQ enable and SMI enable.  (This also turns off the
 464	 * BIOS's USB Legacy Support.)  Turn off all the R/WC bits too.
 465	 */
 466	pci_write_config_word(pdev, UHCI_USBLEGSUP, UHCI_USBLEGSUP_RWC);
 467
 468	/* Reset the HC - this will force us to get a
 469	 * new notification of any already connected
 470	 * ports due to the virtual disconnect that it
 471	 * implies.
 472	 */
 473	outw(UHCI_USBCMD_HCRESET, base + UHCI_USBCMD);
 474	mb();
 475	udelay(5);
 476	if (inw(base + UHCI_USBCMD) & UHCI_USBCMD_HCRESET)
 477		dev_warn(&pdev->dev, "HCRESET not completed yet!\n");
 478
 479	/* Just to be safe, disable interrupt requests and
 480	 * make sure the controller is stopped.
 481	 */
 482	outw(0, base + UHCI_USBINTR);
 483	outw(0, base + UHCI_USBCMD);
 484}
 485EXPORT_SYMBOL_GPL(uhci_reset_hc);
 486
 487/*
 488 * Initialize a controller that was newly discovered or has just been
 489 * resumed.  In either case we can't be sure of its previous state.
 490 *
 491 * Returns: 1 if the controller was reset, 0 otherwise.
 492 */
 493int uhci_check_and_reset_hc(struct pci_dev *pdev, unsigned long base)
 494{
 495	u16 legsup;
 496	unsigned int cmd, intr;
 497
 498	/*
 499	 * When restarting a suspended controller, we expect all the
 500	 * settings to be the same as we left them:
 501	 *
 502	 *	PIRQ and SMI disabled, no R/W bits set in USBLEGSUP;
 503	 *	Controller is stopped and configured with EGSM set;
 504	 *	No interrupts enabled except possibly Resume Detect.
 505	 *
 506	 * If any of these conditions are violated we do a complete reset.
 507	 */
 508	pci_read_config_word(pdev, UHCI_USBLEGSUP, &legsup);
 509	if (legsup & ~(UHCI_USBLEGSUP_RO | UHCI_USBLEGSUP_RWC)) {
 510		dev_dbg(&pdev->dev, "%s: legsup = 0x%04x\n",
 511				__func__, legsup);
 512		goto reset_needed;
 513	}
 514
 515	cmd = inw(base + UHCI_USBCMD);
 516	if ((cmd & UHCI_USBCMD_RUN) || !(cmd & UHCI_USBCMD_CONFIGURE) ||
 517			!(cmd & UHCI_USBCMD_EGSM)) {
 518		dev_dbg(&pdev->dev, "%s: cmd = 0x%04x\n",
 519				__func__, cmd);
 520		goto reset_needed;
 521	}
 522
 523	intr = inw(base + UHCI_USBINTR);
 524	if (intr & (~UHCI_USBINTR_RESUME)) {
 525		dev_dbg(&pdev->dev, "%s: intr = 0x%04x\n",
 526				__func__, intr);
 527		goto reset_needed;
 528	}
 529	return 0;
 530
 531reset_needed:
 532	dev_dbg(&pdev->dev, "Performing full reset\n");
 533	uhci_reset_hc(pdev, base);
 534	return 1;
 535}
 536EXPORT_SYMBOL_GPL(uhci_check_and_reset_hc);
 537
 538static inline int io_type_enabled(struct pci_dev *pdev, unsigned int mask)
 539{
 540	u16 cmd;
 541	return !pci_read_config_word(pdev, PCI_COMMAND, &cmd) && (cmd & mask);
 542}
 543
 544#define pio_enabled(dev) io_type_enabled(dev, PCI_COMMAND_IO)
 545#define mmio_enabled(dev) io_type_enabled(dev, PCI_COMMAND_MEMORY)
 546
 547static void quirk_usb_handoff_uhci(struct pci_dev *pdev)
 548{
 549	unsigned long base = 0;
 550	int i;
 551
 552	if (!pio_enabled(pdev))
 553		return;
 554
 555	for (i = 0; i < PCI_ROM_RESOURCE; i++)
 556		if ((pci_resource_flags(pdev, i) & IORESOURCE_IO)) {
 557			base = pci_resource_start(pdev, i);
 558			break;
 559		}
 560
 561	if (base)
 562		uhci_check_and_reset_hc(pdev, base);
 563}
 564
 565static int mmio_resource_enabled(struct pci_dev *pdev, int idx)
 566{
 567	return pci_resource_start(pdev, idx) && mmio_enabled(pdev);
 568}
 569
 570static void quirk_usb_handoff_ohci(struct pci_dev *pdev)
 571{
 572	void __iomem *base;
 573	u32 control;
 574	u32 fminterval;
 575	int cnt;
 576
 577	if (!mmio_resource_enabled(pdev, 0))
 578		return;
 579
 580	base = pci_ioremap_bar(pdev, 0);
 581	if (base == NULL)
 582		return;
 583
 584	control = readl(base + OHCI_CONTROL);
 585
 586/* On PA-RISC, PDC can leave IR set incorrectly; ignore it there. */
 587#ifdef __hppa__
 588#define	OHCI_CTRL_MASK		(OHCI_CTRL_RWC | OHCI_CTRL_IR)
 589#else
 590#define	OHCI_CTRL_MASK		OHCI_CTRL_RWC
 591
 592	if (control & OHCI_CTRL_IR) {
 593		int wait_time = 500; /* arbitrary; 5 seconds */
 594		writel(OHCI_INTR_OC, base + OHCI_INTRENABLE);
 595		writel(OHCI_OCR, base + OHCI_CMDSTATUS);
 596		while (wait_time > 0 &&
 597				readl(base + OHCI_CONTROL) & OHCI_CTRL_IR) {
 598			wait_time -= 10;
 599			msleep(10);
 600		}
 601		if (wait_time <= 0)
 602			dev_warn(&pdev->dev, "OHCI: BIOS handoff failed"
 603					" (BIOS bug?) %08x\n",
 604					readl(base + OHCI_CONTROL));
 605	}
 606#endif
 607
 608	/* disable interrupts */
 609	writel((u32) ~0, base + OHCI_INTRDISABLE);
 
 
 
 
 
 
 
 
 
 610
 611	/* Reset the USB bus, if the controller isn't already in RESET */
 612	if (control & OHCI_HCFS) {
 613		/* Go into RESET, preserving RWC (and possibly IR) */
 614		writel(control & OHCI_CTRL_MASK, base + OHCI_CONTROL);
 615		readl(base + OHCI_CONTROL);
 
 
 
 
 
 
 616
 617		/* drive bus reset for at least 50 ms (7.1.7.5) */
 618		msleep(50);
 
 619	}
 620
 621	/* software reset of the controller, preserving HcFmInterval */
 622	fminterval = readl(base + OHCI_FMINTERVAL);
 623	writel(OHCI_HCR, base + OHCI_CMDSTATUS);
 624
 625	/* reset requires max 10 us delay */
 626	for (cnt = 30; cnt > 0; --cnt) {	/* ... allow extra time */
 627		if ((readl(base + OHCI_CMDSTATUS) & OHCI_HCR) == 0)
 628			break;
 629		udelay(1);
 630	}
 631	writel(fminterval, base + OHCI_FMINTERVAL);
 632
 633	/* Now the controller is safely in SUSPEND and nothing can wake it up */
 634	iounmap(base);
 635}
 636
 637static const struct dmi_system_id ehci_dmi_nohandoff_table[] = {
 638	{
 639		/*  Pegatron Lucid (ExoPC) */
 640		.matches = {
 641			DMI_MATCH(DMI_BOARD_NAME, "EXOPG06411"),
 642			DMI_MATCH(DMI_BIOS_VERSION, "Lucid-CE-133"),
 643		},
 644	},
 645	{
 646		/*  Pegatron Lucid (Ordissimo AIRIS) */
 647		.matches = {
 648			DMI_MATCH(DMI_BOARD_NAME, "M11JB"),
 649			DMI_MATCH(DMI_BIOS_VERSION, "Lucid-"),
 650		},
 651	},
 652	{
 653		/*  Pegatron Lucid (Ordissimo) */
 654		.matches = {
 655			DMI_MATCH(DMI_BOARD_NAME, "Ordissimo"),
 656			DMI_MATCH(DMI_BIOS_VERSION, "Lucid-"),
 657		},
 658	},
 659	{ }
 660};
 661
 662static void ehci_bios_handoff(struct pci_dev *pdev,
 663					void __iomem *op_reg_base,
 664					u32 cap, u8 offset)
 665{
 666	int try_handoff = 1, tried_handoff = 0;
 667
 668	/* The Pegatron Lucid tablet sporadically waits for 98 seconds trying
 669	 * the handoff on its unused controller.  Skip it. */
 670	if (pdev->vendor == 0x8086 && pdev->device == 0x283a) {
 671		if (dmi_check_system(ehci_dmi_nohandoff_table))
 672			try_handoff = 0;
 673	}
 674
 675	if (try_handoff && (cap & EHCI_USBLEGSUP_BIOS)) {
 676		dev_dbg(&pdev->dev, "EHCI: BIOS handoff\n");
 677
 678#if 0
 679/* aleksey_gorelov@phoenix.com reports that some systems need SMI forced on,
 680 * but that seems dubious in general (the BIOS left it off intentionally)
 681 * and is known to prevent some systems from booting.  so we won't do this
 682 * unless maybe we can determine when we're on a system that needs SMI forced.
 683 */
 684		/* BIOS workaround (?): be sure the pre-Linux code
 685		 * receives the SMI
 686		 */
 687		pci_read_config_dword(pdev, offset + EHCI_USBLEGCTLSTS, &val);
 688		pci_write_config_dword(pdev, offset + EHCI_USBLEGCTLSTS,
 689				       val | EHCI_USBLEGCTLSTS_SOOE);
 690#endif
 691
 692		/* some systems get upset if this semaphore is
 693		 * set for any other reason than forcing a BIOS
 694		 * handoff..
 695		 */
 696		pci_write_config_byte(pdev, offset + 3, 1);
 697	}
 698
 699	/* if boot firmware now owns EHCI, spin till it hands it over. */
 700	if (try_handoff) {
 701		int msec = 1000;
 702		while ((cap & EHCI_USBLEGSUP_BIOS) && (msec > 0)) {
 703			tried_handoff = 1;
 704			msleep(10);
 705			msec -= 10;
 706			pci_read_config_dword(pdev, offset, &cap);
 707		}
 708	}
 709
 710	if (cap & EHCI_USBLEGSUP_BIOS) {
 711		/* well, possibly buggy BIOS... try to shut it down,
 712		 * and hope nothing goes too wrong
 713		 */
 714		if (try_handoff)
 715			dev_warn(&pdev->dev, "EHCI: BIOS handoff failed"
 716				 " (BIOS bug?) %08x\n", cap);
 717		pci_write_config_byte(pdev, offset + 2, 0);
 718	}
 719
 720	/* just in case, always disable EHCI SMIs */
 721	pci_write_config_dword(pdev, offset + EHCI_USBLEGCTLSTS, 0);
 722
 723	/* If the BIOS ever owned the controller then we can't expect
 724	 * any power sessions to remain intact.
 725	 */
 726	if (tried_handoff)
 727		writel(0, op_reg_base + EHCI_CONFIGFLAG);
 728}
 729
 730static void quirk_usb_disable_ehci(struct pci_dev *pdev)
 731{
 732	void __iomem *base, *op_reg_base;
 733	u32	hcc_params, cap, val;
 734	u8	offset, cap_length;
 735	int	wait_time, count = 256/4;
 736
 737	if (!mmio_resource_enabled(pdev, 0))
 738		return;
 739
 740	base = pci_ioremap_bar(pdev, 0);
 741	if (base == NULL)
 742		return;
 743
 744	cap_length = readb(base);
 745	op_reg_base = base + cap_length;
 746
 747	/* EHCI 0.96 and later may have "extended capabilities"
 748	 * spec section 5.1 explains the bios handoff, e.g. for
 749	 * booting from USB disk or using a usb keyboard
 750	 */
 751	hcc_params = readl(base + EHCI_HCC_PARAMS);
 752	offset = (hcc_params >> 8) & 0xff;
 753	while (offset && --count) {
 754		pci_read_config_dword(pdev, offset, &cap);
 755
 756		switch (cap & 0xff) {
 757		case 1:
 758			ehci_bios_handoff(pdev, op_reg_base, cap, offset);
 759			break;
 760		case 0: /* Illegal reserved cap, set cap=0 so we exit */
 761			cap = 0; /* then fallthrough... */
 762		default:
 763			dev_warn(&pdev->dev, "EHCI: unrecognized capability "
 764				 "%02x\n", cap & 0xff);
 765		}
 766		offset = (cap >> 8) & 0xff;
 767	}
 768	if (!count)
 769		dev_printk(KERN_DEBUG, &pdev->dev, "EHCI: capability loop?\n");
 770
 771	/*
 772	 * halt EHCI & disable its interrupts in any case
 773	 */
 774	val = readl(op_reg_base + EHCI_USBSTS);
 775	if ((val & EHCI_USBSTS_HALTED) == 0) {
 776		val = readl(op_reg_base + EHCI_USBCMD);
 777		val &= ~EHCI_USBCMD_RUN;
 778		writel(val, op_reg_base + EHCI_USBCMD);
 779
 780		wait_time = 2000;
 
 781		do {
 782			writel(0x3f, op_reg_base + EHCI_USBSTS);
 783			udelay(100);
 784			wait_time -= 100;
 785			val = readl(op_reg_base + EHCI_USBSTS);
 786			if ((val == ~(u32)0) || (val & EHCI_USBSTS_HALTED)) {
 787				break;
 788			}
 789		} while (wait_time > 0);
 790	}
 791	writel(0, op_reg_base + EHCI_USBINTR);
 792	writel(0x3f, op_reg_base + EHCI_USBSTS);
 793
 794	iounmap(base);
 795}
 796
 797/*
 798 * handshake - spin reading a register until handshake completes
 799 * @ptr: address of hc register to be read
 800 * @mask: bits to look at in result of read
 801 * @done: value of those bits when handshake succeeds
 802 * @wait_usec: timeout in microseconds
 803 * @delay_usec: delay in microseconds to wait between polling
 804 *
 805 * Polls a register every delay_usec microseconds.
 806 * Returns 0 when the mask bits have the value done.
 807 * Returns -ETIMEDOUT if this condition is not true after
 808 * wait_usec microseconds have passed.
 809 */
 810static int handshake(void __iomem *ptr, u32 mask, u32 done,
 811		int wait_usec, int delay_usec)
 812{
 813	u32	result;
 814
 815	do {
 816		result = readl(ptr);
 817		result &= mask;
 818		if (result == done)
 819			return 0;
 820		udelay(delay_usec);
 821		wait_usec -= delay_usec;
 822	} while (wait_usec > 0);
 823	return -ETIMEDOUT;
 824}
 825
 
 
 
 
 
 
 
 
 826/*
 827 * Intel's Panther Point chipset has two host controllers (EHCI and xHCI) that
 828 * share some number of ports.  These ports can be switched between either
 829 * controller.  Not all of the ports under the EHCI host controller may be
 830 * switchable.
 831 *
 832 * The ports should be switched over to xHCI before PCI probes for any device
 833 * start.  This avoids active devices under EHCI being disconnected during the
 834 * port switchover, which could cause loss of data on USB storage devices, or
 835 * failed boot when the root file system is on a USB mass storage device and is
 836 * enumerated under EHCI first.
 837 *
 838 * We write into the xHC's PCI configuration space in some Intel-specific
 839 * registers to switch the ports over.  The USB 3.0 terminations and the USB
 840 * 2.0 data wires are switched separately.  We want to enable the SuperSpeed
 841 * terminations before switching the USB 2.0 wires over, so that USB 3.0
 842 * devices connect at SuperSpeed, rather than at USB 2.0 speeds.
 843 */
 844void usb_enable_intel_xhci_ports(struct pci_dev *xhci_pdev)
 845{
 846	u32		ports_available;
 847	bool		ehci_found = false;
 848	struct pci_dev	*companion = NULL;
 849
 850	/* Sony VAIO t-series with subsystem device ID 90a8 is not capable of
 851	 * switching ports from EHCI to xHCI
 852	 */
 853	if (xhci_pdev->subsystem_vendor == PCI_VENDOR_ID_SONY &&
 854	    xhci_pdev->subsystem_device == 0x90a8)
 855		return;
 856
 857	/* make sure an intel EHCI controller exists */
 858	for_each_pci_dev(companion) {
 859		if (companion->class == PCI_CLASS_SERIAL_USB_EHCI &&
 860		    companion->vendor == PCI_VENDOR_ID_INTEL) {
 861			ehci_found = true;
 862			break;
 863		}
 864	}
 865
 866	if (!ehci_found)
 867		return;
 868
 869	/* Don't switchover the ports if the user hasn't compiled the xHCI
 870	 * driver.  Otherwise they will see "dead" USB ports that don't power
 871	 * the devices.
 872	 */
 873	if (!IS_ENABLED(CONFIG_USB_XHCI_HCD)) {
 874		dev_warn(&xhci_pdev->dev,
 875				"CONFIG_USB_XHCI_HCD is turned off, "
 876				"defaulting to EHCI.\n");
 877		dev_warn(&xhci_pdev->dev,
 878				"USB 3.0 devices will work at USB 2.0 speeds.\n");
 879		usb_disable_xhci_ports(xhci_pdev);
 880		return;
 881	}
 882
 883	/* Read USB3PRM, the USB 3.0 Port Routing Mask Register
 884	 * Indicate the ports that can be changed from OS.
 885	 */
 886	pci_read_config_dword(xhci_pdev, USB_INTEL_USB3PRM,
 887			&ports_available);
 888
 889	dev_dbg(&xhci_pdev->dev, "Configurable ports to enable SuperSpeed: 0x%x\n",
 890			ports_available);
 891
 
 892	/* Write USB3_PSSEN, the USB 3.0 Port SuperSpeed Enable
 893	 * Register, to turn on SuperSpeed terminations for the
 894	 * switchable ports.
 895	 */
 896	pci_write_config_dword(xhci_pdev, USB_INTEL_USB3_PSSEN,
 897			ports_available);
 898
 899	pci_read_config_dword(xhci_pdev, USB_INTEL_USB3_PSSEN,
 900			&ports_available);
 901	dev_dbg(&xhci_pdev->dev, "USB 3.0 ports that are now enabled "
 902			"under xHCI: 0x%x\n", ports_available);
 903
 904	/* Read XUSB2PRM, xHCI USB 2.0 Port Routing Mask Register
 905	 * Indicate the USB 2.0 ports to be controlled by the xHCI host.
 906	 */
 907
 908	pci_read_config_dword(xhci_pdev, USB_INTEL_USB2PRM,
 909			&ports_available);
 910
 911	dev_dbg(&xhci_pdev->dev, "Configurable USB 2.0 ports to hand over to xCHI: 0x%x\n",
 912			ports_available);
 913
 914	/* Write XUSB2PR, the xHC USB 2.0 Port Routing Register, to
 915	 * switch the USB 2.0 power and data lines over to the xHCI
 916	 * host.
 917	 */
 918	pci_write_config_dword(xhci_pdev, USB_INTEL_XUSB2PR,
 919			ports_available);
 920
 921	pci_read_config_dword(xhci_pdev, USB_INTEL_XUSB2PR,
 922			&ports_available);
 923	dev_dbg(&xhci_pdev->dev, "USB 2.0 ports that are now switched over "
 924			"to xHCI: 0x%x\n", ports_available);
 925}
 926EXPORT_SYMBOL_GPL(usb_enable_intel_xhci_ports);
 927
 928void usb_disable_xhci_ports(struct pci_dev *xhci_pdev)
 929{
 930	pci_write_config_dword(xhci_pdev, USB_INTEL_USB3_PSSEN, 0x0);
 931	pci_write_config_dword(xhci_pdev, USB_INTEL_XUSB2PR, 0x0);
 932}
 933EXPORT_SYMBOL_GPL(usb_disable_xhci_ports);
 934
 935/**
 936 * PCI Quirks for xHCI.
 937 *
 938 * Takes care of the handoff between the Pre-OS (i.e. BIOS) and the OS.
 939 * It signals to the BIOS that the OS wants control of the host controller,
 940 * and then waits 5 seconds for the BIOS to hand over control.
 941 * If we timeout, assume the BIOS is broken and take control anyway.
 942 */
 943static void quirk_usb_handoff_xhci(struct pci_dev *pdev)
 944{
 945	void __iomem *base;
 946	int ext_cap_offset;
 947	void __iomem *op_reg_base;
 948	u32 val;
 949	int timeout;
 950	int len = pci_resource_len(pdev, 0);
 951
 952	if (!mmio_resource_enabled(pdev, 0))
 953		return;
 954
 955	base = ioremap_nocache(pci_resource_start(pdev, 0), len);
 
 956	if (base == NULL)
 957		return;
 958
 959	/*
 960	 * Find the Legacy Support Capability register -
 961	 * this is optional for xHCI host controllers.
 962	 */
 963	ext_cap_offset = xhci_find_next_cap_offset(base, XHCI_HCC_PARAMS_OFFSET);
 964	do {
 965		if ((ext_cap_offset + sizeof(val)) > len) {
 966			/* We're reading garbage from the controller */
 967			dev_warn(&pdev->dev,
 968				 "xHCI controller failing to respond");
 969			return;
 970		}
 971
 972		if (!ext_cap_offset)
 973			/* We've reached the end of the extended capabilities */
 974			goto hc_init;
 975
 976		val = readl(base + ext_cap_offset);
 977		if (XHCI_EXT_CAPS_ID(val) == XHCI_EXT_CAPS_LEGACY)
 978			break;
 979		ext_cap_offset = xhci_find_next_cap_offset(base, ext_cap_offset);
 980	} while (1);
 981
 982	/* If the BIOS owns the HC, signal that the OS wants it, and wait */
 983	if (val & XHCI_HC_BIOS_OWNED) {
 984		writel(val | XHCI_HC_OS_OWNED, base + ext_cap_offset);
 985
 986		/* Wait for 5 seconds with 10 microsecond polling interval */
 987		timeout = handshake(base + ext_cap_offset, XHCI_HC_BIOS_OWNED,
 988				0, 5000, 10);
 989
 990		/* Assume a buggy BIOS and take HC ownership anyway */
 991		if (timeout) {
 992			dev_warn(&pdev->dev, "xHCI BIOS handoff failed"
 993					" (BIOS bug ?) %08x\n", val);
 994			writel(val & ~XHCI_HC_BIOS_OWNED, base + ext_cap_offset);
 995		}
 996	}
 997
 998	val = readl(base + ext_cap_offset + XHCI_LEGACY_CONTROL_OFFSET);
 999	/* Mask off (turn off) any enabled SMIs */
1000	val &= XHCI_LEGACY_DISABLE_SMI;
1001	/* Mask all SMI events bits, RW1C */
1002	val |= XHCI_LEGACY_SMI_EVENTS;
1003	/* Disable any BIOS SMIs and clear all SMI events*/
1004	writel(val, base + ext_cap_offset + XHCI_LEGACY_CONTROL_OFFSET);
1005
 
 
1006hc_init:
1007	if (pdev->vendor == PCI_VENDOR_ID_INTEL)
1008		usb_enable_intel_xhci_ports(pdev);
1009
1010	op_reg_base = base + XHCI_HC_LENGTH(readl(base));
1011
1012	/* Wait for the host controller to be ready before writing any
1013	 * operational or runtime registers.  Wait 5 seconds and no more.
1014	 */
1015	timeout = handshake(op_reg_base + XHCI_STS_OFFSET, XHCI_STS_CNR, 0,
1016			5000, 10);
1017	/* Assume a buggy HC and start HC initialization anyway */
1018	if (timeout) {
1019		val = readl(op_reg_base + XHCI_STS_OFFSET);
1020		dev_warn(&pdev->dev,
1021				"xHCI HW not ready after 5 sec (HC bug?) "
1022				"status = 0x%x\n", val);
1023	}
1024
1025	/* Send the halt and disable interrupts command */
1026	val = readl(op_reg_base + XHCI_CMD_OFFSET);
1027	val &= ~(XHCI_CMD_RUN | XHCI_IRQS);
1028	writel(val, op_reg_base + XHCI_CMD_OFFSET);
1029
1030	/* Wait for the HC to halt - poll every 125 usec (one microframe). */
1031	timeout = handshake(op_reg_base + XHCI_STS_OFFSET, XHCI_STS_HALT, 1,
1032			XHCI_MAX_HALT_USEC, 125);
1033	if (timeout) {
1034		val = readl(op_reg_base + XHCI_STS_OFFSET);
1035		dev_warn(&pdev->dev,
1036				"xHCI HW did not halt within %d usec "
1037				"status = 0x%x\n", XHCI_MAX_HALT_USEC, val);
1038	}
1039
1040	iounmap(base);
1041}
1042
1043static void quirk_usb_early_handoff(struct pci_dev *pdev)
1044{
1045	/* Skip Netlogic mips SoC's internal PCI USB controller.
1046	 * This device does not need/support EHCI/OHCI handoff
1047	 */
1048	if (pdev->vendor == 0x184e)	/* vendor Netlogic */
1049		return;
1050	if (pdev->class != PCI_CLASS_SERIAL_USB_UHCI &&
1051			pdev->class != PCI_CLASS_SERIAL_USB_OHCI &&
1052			pdev->class != PCI_CLASS_SERIAL_USB_EHCI &&
1053			pdev->class != PCI_CLASS_SERIAL_USB_XHCI)
1054		return;
1055
1056	if (pci_enable_device(pdev) < 0) {
1057		dev_warn(&pdev->dev, "Can't enable PCI device, "
1058				"BIOS handoff failed.\n");
1059		return;
1060	}
1061	if (pdev->class == PCI_CLASS_SERIAL_USB_UHCI)
1062		quirk_usb_handoff_uhci(pdev);
1063	else if (pdev->class == PCI_CLASS_SERIAL_USB_OHCI)
1064		quirk_usb_handoff_ohci(pdev);
1065	else if (pdev->class == PCI_CLASS_SERIAL_USB_EHCI)
1066		quirk_usb_disable_ehci(pdev);
1067	else if (pdev->class == PCI_CLASS_SERIAL_USB_XHCI)
1068		quirk_usb_handoff_xhci(pdev);
1069	pci_disable_device(pdev);
1070}
1071DECLARE_PCI_FIXUP_CLASS_FINAL(PCI_ANY_ID, PCI_ANY_ID,
1072			PCI_CLASS_SERIAL_USB, 8, quirk_usb_early_handoff);