[mirror_ubuntu-zesty-kernel.git] / drivers / usb / host / xhci-pci.c

/*
 * xHCI host controller driver PCI Bus Glue.
 *
 * Copyright (C) 2008 Intel Corp.
 *
 * Author: Sarah Sharp
 * Some code borrowed from the Linux EHCI driver.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <linux/pci.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/acpi.h>

#include "xhci.h"
#include "xhci-trace.h"

#define SSIC_PORT_NUM		2
#define SSIC_PORT_CFG2		0x880c
#define SSIC_PORT_CFG2_OFFSET	0x30
#define PROG_DONE		(1 << 30)
#define SSIC_PORT_UNUSED	(1 << 31)

/* Device for a quirk */
#define PCI_VENDOR_ID_FRESCO_LOGIC	0x1b73
#define PCI_DEVICE_ID_FRESCO_LOGIC_PDK	0x1000
#define PCI_DEVICE_ID_FRESCO_LOGIC_FL1009	0x1009
#define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400	0x1400

#define PCI_VENDOR_ID_ETRON		0x1b6f
#define PCI_DEVICE_ID_EJ168		0x7023

#define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI	0x8c31
#define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI	0x9c31
#define PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI		0x22b5
#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI		0xa12f
#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI	0x9d2f
#define PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI		0x0aa8
#define PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI		0x1aa8

static const char hcd_name[] = "xhci_hcd";

static struct hc_driver __read_mostly xhci_pci_hc_driver;

static int xhci_pci_setup(struct usb_hcd *hcd);

static const struct xhci_driver_overrides xhci_pci_overrides __initconst = {
	.reset = xhci_pci_setup,
};

/* called after powerup, by probe or system-pm "wakeup" */
static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
{
	/*
	 * TODO: Implement finding debug ports later.
	 * TODO: see if there are any quirks that need to be added to handle
	 * new extended capabilities.
	 */

	/* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
	if (!pci_set_mwi(pdev))
		xhci_dbg(xhci, "MWI active\n");

	xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
	return 0;
}

static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
{
	struct pci_dev		*pdev = to_pci_dev(dev);

	/* Look for vendor-specific quirks */
	if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
			(pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK ||
			 pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
		if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
				pdev->revision == 0x0) {
			xhci->quirks |= XHCI_RESET_EP_QUIRK;
			xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
				"QUIRK: Fresco Logic xHC needs configure"
				" endpoint cmd after reset endpoint");
		}
		if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
				pdev->revision == 0x4) {
			xhci->quirks |= XHCI_SLOW_SUSPEND;
			xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
				"QUIRK: Fresco Logic xHC revision %u"
				"must be suspended extra slowly",
				pdev->revision);
		}
		if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK)
			xhci->quirks |= XHCI_BROKEN_STREAMS;
		/* Fresco Logic confirms: all revisions of this chip do not
		 * support MSI, even though some of them claim to in their PCI
		 * capabilities.
		 */
		xhci->quirks |= XHCI_BROKEN_MSI;
		xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
				"QUIRK: Fresco Logic revision %u "
				"has broken MSI implementation",
				pdev->revision);
		xhci->quirks |= XHCI_TRUST_TX_LENGTH;
	}

	if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
			pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1009)
		xhci->quirks |= XHCI_BROKEN_STREAMS;

	if (pdev->vendor == PCI_VENDOR_ID_NEC)
		xhci->quirks |= XHCI_NEC_HOST;

	if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
		xhci->quirks |= XHCI_AMD_0x96_HOST;

	/* AMD PLL quirk */
	if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
		xhci->quirks |= XHCI_AMD_PLL_FIX;

	if (pdev->vendor == PCI_VENDOR_ID_AMD)
		xhci->quirks |= XHCI_TRUST_TX_LENGTH;

	if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
		xhci->quirks |= XHCI_LPM_SUPPORT;
		xhci->quirks |= XHCI_INTEL_HOST;
		xhci->quirks |= XHCI_AVOID_BEI;
	}
	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
			pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
		xhci->quirks |= XHCI_EP_LIMIT_QUIRK;
		xhci->limit_active_eps = 64;
		xhci->quirks |= XHCI_SW_BW_CHECKING;
		/*
		 * PPT desktop boards DH77EB and DH77DF will power back on after
		 * a few seconds of being shutdown.  The fix for this is to
		 * switch the ports from xHCI to EHCI on shutdown.  We can't use
		 * DMI information to find those particular boards (since each
		 * vendor will change the board name), so we have to key off all
		 * PPT chipsets.
		 */
		xhci->quirks |= XHCI_SPURIOUS_REBOOT;
	}
	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
		pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI) {
		xhci->quirks |= XHCI_SPURIOUS_REBOOT;
		xhci->quirks |= XHCI_SPURIOUS_WAKEUP;
	}
	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
		(pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI ||
		 pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI ||
		 pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI ||
		 pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI ||
		 pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI)) {
		xhci->quirks |= XHCI_PME_STUCK_QUIRK;
	}
	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
		 pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI) {
		xhci->quirks |= XHCI_SSIC_PORT_UNUSED;
	}
	if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
			pdev->device == PCI_DEVICE_ID_EJ168) {
		xhci->quirks |= XHCI_RESET_ON_RESUME;
		xhci->quirks |= XHCI_TRUST_TX_LENGTH;
		xhci->quirks |= XHCI_BROKEN_STREAMS;
	}
	if (pdev->vendor == PCI_VENDOR_ID_RENESAS &&
			pdev->device == 0x0015)
		xhci->quirks |= XHCI_RESET_ON_RESUME;
	if (pdev->vendor == PCI_VENDOR_ID_VIA)
		xhci->quirks |= XHCI_RESET_ON_RESUME;

	/* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */
	if (pdev->vendor == PCI_VENDOR_ID_VIA &&
			pdev->device == 0x3432)
		xhci->quirks |= XHCI_BROKEN_STREAMS;

	if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
			pdev->device == 0x1042)
		xhci->quirks |= XHCI_BROKEN_STREAMS;

	if (xhci->quirks & XHCI_RESET_ON_RESUME)
		xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
				"QUIRK: Resetting on resume");
}

#ifdef CONFIG_ACPI
static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev)
{
	static const u8 intel_dsm_uuid[] = {
		0xb7, 0x0c, 0x34, 0xac,	0x01, 0xe9, 0xbf, 0x45,
		0xb7, 0xe6, 0x2b, 0x34, 0xec, 0x93, 0x1e, 0x23,
	};
	union acpi_object *obj;

	obj = acpi_evaluate_dsm(ACPI_HANDLE(&dev->dev), intel_dsm_uuid, 3, 1,
				NULL);
	ACPI_FREE(obj);
}
#else
static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev) { }
#endif /* CONFIG_ACPI */

/* called during probe() after chip reset completes */
static int xhci_pci_setup(struct usb_hcd *hcd)
{
	struct xhci_hcd		*xhci;
	struct pci_dev		*pdev = to_pci_dev(hcd->self.controller);
	int			retval;

	xhci = hcd_to_xhci(hcd);
	if (!xhci->sbrn)
		pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);

	retval = xhci_gen_setup(hcd, xhci_pci_quirks);
	if (retval)
		return retval;

	if (!usb_hcd_is_primary_hcd(hcd))
		return 0;

	xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);

	/* Find any debug ports */
	retval = xhci_pci_reinit(xhci, pdev);
	if (!retval)
		return retval;

	return retval;
}

/*
 * We need to register our own PCI probe function (instead of the USB core's
 * function) in order to create a second roothub under xHCI.
 */
static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
{
	int retval;
	struct xhci_hcd *xhci;
	struct hc_driver *driver;
	struct usb_hcd *hcd;

	driver = (struct hc_driver *)id->driver_data;

	/* Prevent runtime suspending between USB-2 and USB-3 initialization */
	pm_runtime_get_noresume(&dev->dev);

	/* Register the USB 2.0 roothub.
	 * FIXME: USB core must know to register the USB 2.0 roothub first.
	 * This is sort of silly, because we could just set the HCD driver flags
	 * to say USB 2.0, but I'm not sure what the implications would be in
	 * the other parts of the HCD code.
	 */
	retval = usb_hcd_pci_probe(dev, id);

	if (retval)
		goto put_runtime_pm;

	/* USB 2.0 roothub is stored in the PCI device now. */
	hcd = dev_get_drvdata(&dev->dev);
	xhci = hcd_to_xhci(hcd);
	xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
				pci_name(dev), hcd);
	if (!xhci->shared_hcd) {
		retval = -ENOMEM;
		goto dealloc_usb2_hcd;
	}

	retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
			IRQF_SHARED);
	if (retval)
		goto put_usb3_hcd;
	/* Roothub already marked as USB 3.0 speed */

	if (!(xhci->quirks & XHCI_BROKEN_STREAMS) &&
			HCC_MAX_PSA(xhci->hcc_params) >= 4)
		xhci->shared_hcd->can_do_streams = 1;

	if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
		xhci_pme_acpi_rtd3_enable(dev);

	/* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
	pm_runtime_put_noidle(&dev->dev);

	return 0;

put_usb3_hcd:
	usb_put_hcd(xhci->shared_hcd);
dealloc_usb2_hcd:
	usb_hcd_pci_remove(dev);
put_runtime_pm:
	pm_runtime_put_noidle(&dev->dev);
	return retval;
}

static void xhci_pci_remove(struct pci_dev *dev)
{
	struct xhci_hcd *xhci;

	xhci = hcd_to_xhci(pci_get_drvdata(dev));
	xhci->xhc_state |= XHCI_STATE_REMOVING;
	if (xhci->shared_hcd) {
		usb_remove_hcd(xhci->shared_hcd);
		usb_put_hcd(xhci->shared_hcd);
	}

	/* Workaround for spurious wakeups at shutdown with HSW */
	if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
		pci_set_power_state(dev, PCI_D3hot);

	usb_hcd_pci_remove(dev);
}

#ifdef CONFIG_PM
/*
 * In some Intel xHCI controllers, in order to get D3 working,
 * through a vendor specific SSIC CONFIG register at offset 0x883c,
 * SSIC PORT need to be marked as "unused" before putting xHCI
 * into D3. After D3 exit, the SSIC port need to be marked as "used".
 * Without this change, xHCI might not enter D3 state.
 */
static void xhci_ssic_port_unused_quirk(struct usb_hcd *hcd, bool suspend)
{
	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
	u32 val;
	void __iomem *reg;
	int i;

	for (i = 0; i < SSIC_PORT_NUM; i++) {
		reg = (void __iomem *) xhci->cap_regs +
				SSIC_PORT_CFG2 +
				i * SSIC_PORT_CFG2_OFFSET;

		/* Notify SSIC that SSIC profile programming is not done. */
		val = readl(reg) & ~PROG_DONE;
		writel(val, reg);

		/* Mark SSIC port as unused(suspend) or used(resume) */
		val = readl(reg);
		if (suspend)
			val |= SSIC_PORT_UNUSED;
		else
			val &= ~SSIC_PORT_UNUSED;
		writel(val, reg);

		/* Notify SSIC that SSIC profile programming is done */
		val = readl(reg) | PROG_DONE;
		writel(val, reg);
		readl(reg);
	}
}

/*
 * Make sure PME works on some Intel xHCI controllers by writing 1 to clear
 * the Internal PME flag bit in vendor specific PMCTRL register at offset 0x80a4
 */
static void xhci_pme_quirk(struct usb_hcd *hcd)
{
	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
	void __iomem *reg;
	u32 val;

	reg = (void __iomem *) xhci->cap_regs + 0x80a4;
	val = readl(reg);
	writel(val | BIT(28), reg);
	readl(reg);
}

static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
{
	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
	struct pci_dev		*pdev = to_pci_dev(hcd->self.controller);
	int			ret;

	/*
	 * Systems with the TI redriver that loses port status change events
	 * need to have the registers polled during D3, so avoid D3cold.
	 */
	if (xhci->quirks & XHCI_COMP_MODE_QUIRK)
		pci_d3cold_disable(pdev);

	if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
		xhci_pme_quirk(hcd);

	if (xhci->quirks & XHCI_SSIC_PORT_UNUSED)
		xhci_ssic_port_unused_quirk(hcd, true);

	ret = xhci_suspend(xhci, do_wakeup);
	if (ret && (xhci->quirks & XHCI_SSIC_PORT_UNUSED))
		xhci_ssic_port_unused_quirk(hcd, false);

	return ret;
}

static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
{
	struct xhci_hcd		*xhci = hcd_to_xhci(hcd);
	struct pci_dev		*pdev = to_pci_dev(hcd->self.controller);
	int			retval = 0;

	/* The BIOS on systems with the Intel Panther Point chipset may or may
	 * not support xHCI natively.  That means that during system resume, it
	 * may switch the ports back to EHCI so that users can use their
	 * keyboard to select a kernel from GRUB after resume from hibernate.
	 *
	 * The BIOS is supposed to remember whether the OS had xHCI ports
	 * enabled before resume, and switch the ports back to xHCI when the
	 * BIOS/OS semaphore is written, but we all know we can't trust BIOS
	 * writers.
	 *
	 * Unconditionally switch the ports back to xHCI after a system resume.
	 * It should not matter whether the EHCI or xHCI controller is
	 * resumed first. It's enough to do the switchover in xHCI because
	 * USB core won't notice anything as the hub driver doesn't start
	 * running again until after all the devices (including both EHCI and
	 * xHCI host controllers) have been resumed.
	 */

	if (pdev->vendor == PCI_VENDOR_ID_INTEL)
		usb_enable_intel_xhci_ports(pdev);

	if (xhci->quirks & XHCI_SSIC_PORT_UNUSED)
		xhci_ssic_port_unused_quirk(hcd, false);

	if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
		xhci_pme_quirk(hcd);

	retval = xhci_resume(xhci, hibernated);
	return retval;
}
#endif /* CONFIG_PM */

/*-------------------------------------------------------------------------*/

/* PCI driver selection metadata; PCI hotplugging uses this */
static const struct pci_device_id pci_ids[] = { {
	/* handle any USB 3.0 xHCI controller */
	PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
	.driver_data =	(unsigned long) &xhci_pci_hc_driver,
	},
	{ /* end: all zeroes */ }
};
MODULE_DEVICE_TABLE(pci, pci_ids);

/* pci driver glue; this is a "new style" PCI driver module */
static struct pci_driver xhci_pci_driver = {
	.name =		(char *) hcd_name,
	.id_table =	pci_ids,

	.probe =	xhci_pci_probe,
	.remove =	xhci_pci_remove,
	/* suspend and resume implemented later */

	.shutdown = 	usb_hcd_pci_shutdown,
#ifdef CONFIG_PM
	.driver = {
		.pm = &usb_hcd_pci_pm_ops
	},
#endif
};

static int __init xhci_pci_init(void)
{
	xhci_init_driver(&xhci_pci_hc_driver, &xhci_pci_overrides);
#ifdef CONFIG_PM
	xhci_pci_hc_driver.pci_suspend = xhci_pci_suspend;
	xhci_pci_hc_driver.pci_resume = xhci_pci_resume;
#endif
	return pci_register_driver(&xhci_pci_driver);
}
module_init(xhci_pci_init);

static void __exit xhci_pci_exit(void)
{
	pci_unregister_driver(&xhci_pci_driver);
}
module_exit(xhci_pci_exit);

MODULE_DESCRIPTION("xHCI PCI Host Controller Driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
66d4eadd SS	1	/*
	2	* xHCI host controller driver PCI Bus Glue.
	3	*
	4	* Copyright (C) 2008 Intel Corp.
	5	*
	6	* Author: Sarah Sharp
	7	* Some code borrowed from the Linux EHCI driver.
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License version 2 as
	11	* published by the Free Software Foundation.
	12	*
	13	* This program is distributed in the hope that it will be useful, but
	14	* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
	15	* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	16	* for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software Foundation,
	20	* Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	21	*/
	22
	23	#include <linux/pci.h>
7fc2a616	24	#include <linux/slab.h>
6eb0de82	25	#include <linux/module.h>
c3c5819a	26	#include <linux/acpi.h>
66d4eadd SS	27
66d4eadd SS	28	#include "xhci.h"
4bdfe4c3	29	#include "xhci-trace.h"
66d4eadd	30
fa895377 LB	31	#define SSIC_PORT_NUM 2
	32	#define SSIC_PORT_CFG2 0x880c
	33	#define SSIC_PORT_CFG2_OFFSET 0x30
abce329c RM	34	#define PROG_DONE (1 << 30)
	35	#define SSIC_PORT_UNUSED (1 << 31)
	36
ac9d8fe7 SS	37	/* Device for a quirk */
	38	#define PCI_VENDOR_ID_FRESCO_LOGIC 0x1b73
	39	#define PCI_DEVICE_ID_FRESCO_LOGIC_PDK 0x1000
d95815ba	40	#define PCI_DEVICE_ID_FRESCO_LOGIC_FL1009 0x1009
bba18e33	41	#define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400 0x1400
ac9d8fe7	42
c877b3b2	43	#define PCI_VENDOR_ID_ETRON 0x1b6f
170625e9	44	#define PCI_DEVICE_ID_EJ168 0x7023
c877b3b2	45
638298dc TI	46	#define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI 0x8c31
638298dc TI	47	#define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI 0x9c31
b8cb91e0 MN	48	#define PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI 0x22b5
	49	#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI 0xa12f
	50	#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI 0x9d2f
ccc04afb	51	#define PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI 0x0aa8
0d46faca	52	#define PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI 0x1aa8
638298dc	53
66d4eadd SS	54	static const char hcd_name[] = "xhci_hcd";
66d4eadd SS	55
1885d9a3 AB	56	static struct hc_driver __read_mostly xhci_pci_hc_driver;
1885d9a3 AB	57
cd33a321 RQ	58	static int xhci_pci_setup(struct usb_hcd *hcd);
	59
	60	static const struct xhci_driver_overrides xhci_pci_overrides __initconst = {
cd33a321 RQ	61	.reset = xhci_pci_setup,
	62	};
	63
66d4eadd SS	64	/* called after powerup, by probe or system-pm "wakeup" */
	65	static int xhci_pci_reinit(struct xhci_hcd xhci, struct pci_dev pdev)
	66	{
	67	/*
	68	* TODO: Implement finding debug ports later.
	69	* TODO: see if there are any quirks that need to be added to handle
	70	* new extended capabilities.
	71	*/
	72
	73	/* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
	74	if (!pci_set_mwi(pdev))
	75	xhci_dbg(xhci, "MWI active\n");
	76
	77	xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
	78	return 0;
	79	}
	80
da3c9c4f SAS	81	static void xhci_pci_quirks(struct device dev, struct xhci_hcd xhci)
	82	{
	83	struct pci_dev *pdev = to_pci_dev(dev);
	84
ac9d8fe7 SS	85	/* Look for vendor-specific quirks */
ac9d8fe7 SS	86	if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
bba18e33 SS	87	(pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK \|\|
	88	pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
	89	if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
	90	pdev->revision == 0x0) {
ac9d8fe7	91	xhci->quirks \|= XHCI_RESET_EP_QUIRK;
4bdfe4c3 XR	92	xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
	93	"QUIRK: Fresco Logic xHC needs configure"
	94	" endpoint cmd after reset endpoint");
f5182b41	95	}
455f5892 ON	96	if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
	97	pdev->revision == 0x4) {
	98	xhci->quirks \|= XHCI_SLOW_SUSPEND;
	99	xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
	100	"QUIRK: Fresco Logic xHC revision %u"
	101	"must be suspended extra slowly",
	102	pdev->revision);
	103	}
7f5c4d63 HG	104	if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK)
7f5c4d63 HG	105	xhci->quirks \|= XHCI_BROKEN_STREAMS;
f5182b41 SS	106	/* Fresco Logic confirms: all revisions of this chip do not
	107	* support MSI, even though some of them claim to in their PCI
	108	* capabilities.
	109	*/
	110	xhci->quirks \|= XHCI_BROKEN_MSI;
4bdfe4c3 XR	111	xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
	112	"QUIRK: Fresco Logic revision %u "
	113	"has broken MSI implementation",
f5182b41	114	pdev->revision);
1530bbc6	115	xhci->quirks \|= XHCI_TRUST_TX_LENGTH;
ac9d8fe7	116	}
f5182b41	117
d95815ba HG	118	if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
	119	pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1009)
	120	xhci->quirks \|= XHCI_BROKEN_STREAMS;
	121
0238634d SS	122	if (pdev->vendor == PCI_VENDOR_ID_NEC)
0238634d SS	123	xhci->quirks \|= XHCI_NEC_HOST;
ac9d8fe7	124
7e393a83 AX	125	if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
	126	xhci->quirks \|= XHCI_AMD_0x96_HOST;
	127
c41136b0 AX	128	/* AMD PLL quirk */
	129	if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
	130	xhci->quirks \|= XHCI_AMD_PLL_FIX;
2597fe99 HR	131
	132	if (pdev->vendor == PCI_VENDOR_ID_AMD)
	133	xhci->quirks \|= XHCI_TRUST_TX_LENGTH;
	134
e3567d2c SS	135	if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
	136	xhci->quirks \|= XHCI_LPM_SUPPORT;
	137	xhci->quirks \|= XHCI_INTEL_HOST;
227a4fd8	138	xhci->quirks \|= XHCI_AVOID_BEI;
e3567d2c	139	}
ad808333 SS	140	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
ad808333 SS	141	pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
2cf95c18 SS	142	xhci->quirks \|= XHCI_EP_LIMIT_QUIRK;
2cf95c18 SS	143	xhci->limit_active_eps = 64;
86cc558e	144	xhci->quirks \|= XHCI_SW_BW_CHECKING;
e95829f4 SS	145	/*
	146	* PPT desktop boards DH77EB and DH77DF will power back on after
	147	* a few seconds of being shutdown. The fix for this is to
	148	* switch the ports from xHCI to EHCI on shutdown. We can't use
	149	* DMI information to find those particular boards (since each
	150	* vendor will change the board name), so we have to key off all
	151	* PPT chipsets.
	152	*/
	153	xhci->quirks \|= XHCI_SPURIOUS_REBOOT;
ad808333	154	}
0a939993 DT	155	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
0a939993 DT	156	pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI) {
c09ec25d	157	xhci->quirks \|= XHCI_SPURIOUS_REBOOT;
fd7cd061	158	xhci->quirks \|= XHCI_SPURIOUS_WAKEUP;
638298dc	159	}
b8cb91e0 MN	160	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
	161	(pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI \|\|
	162	pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI \|\|
ccc04afb	163	pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI \|\|
0d46faca RR	164	pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI \|\|
0d46faca RR	165	pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI)) {
b8cb91e0 MN	166	xhci->quirks \|= XHCI_PME_STUCK_QUIRK;
b8cb91e0 MN	167	}
7e70cbff LB	168	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
	169	pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI) {
	170	xhci->quirks \|= XHCI_SSIC_PORT_UNUSED;
	171	}
c877b3b2	172	if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
170625e9	173	pdev->device == PCI_DEVICE_ID_EJ168) {
c877b3b2	174	xhci->quirks \|= XHCI_RESET_ON_RESUME;
5cb7df2b	175	xhci->quirks \|= XHCI_TRUST_TX_LENGTH;
8f873c1f	176	xhci->quirks \|= XHCI_BROKEN_STREAMS;
c877b3b2	177	}
1aa9578c	178	if (pdev->vendor == PCI_VENDOR_ID_RENESAS &&
6db249eb	179	pdev->device == 0x0015)
1aa9578c	180	xhci->quirks \|= XHCI_RESET_ON_RESUME;
457a4f61 EF	181	if (pdev->vendor == PCI_VENDOR_ID_VIA)
457a4f61 EF	182	xhci->quirks \|= XHCI_RESET_ON_RESUME;
85f4e45b	183
e21eba05 HG	184	/* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */
	185	if (pdev->vendor == PCI_VENDOR_ID_VIA &&
	186	pdev->device == 0x3432)
	187	xhci->quirks \|= XHCI_BROKEN_STREAMS;
	188
2391eacb HG	189	if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
	190	pdev->device == 0x1042)
	191	xhci->quirks \|= XHCI_BROKEN_STREAMS;
	192
85f4e45b ON	193	if (xhci->quirks & XHCI_RESET_ON_RESUME)
	194	xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
	195	"QUIRK: Resetting on resume");
da3c9c4f	196	}
c41136b0	197
c3c5819a MN	198	#ifdef CONFIG_ACPI
	199	static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev)
	200	{
	201	static const u8 intel_dsm_uuid[] = {
	202	0xb7, 0x0c, 0x34, 0xac, 0x01, 0xe9, 0xbf, 0x45,
	203	0xb7, 0xe6, 0x2b, 0x34, 0xec, 0x93, 0x1e, 0x23,
	204	};
84ed9152 MW	205	union acpi_object *obj;
	206
	207	obj = acpi_evaluate_dsm(ACPI_HANDLE(&dev->dev), intel_dsm_uuid, 3, 1,
	208	NULL);
	209	ACPI_FREE(obj);
c3c5819a MN	210	}
c3c5819a MN	211	#else
84ed9152	212	static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev) { }
c3c5819a MN	213	#endif /* CONFIG_ACPI */
c3c5819a MN	214
da3c9c4f SAS	215	/* called during probe() after chip reset completes */
	216	static int xhci_pci_setup(struct usb_hcd *hcd)
	217	{
	218	struct xhci_hcd *xhci;
	219	struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
	220	int retval;
66d4eadd	221
b50107bb MN	222	xhci = hcd_to_xhci(hcd);
	223	if (!xhci->sbrn)
	224	pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
	225
da3c9c4f	226	retval = xhci_gen_setup(hcd, xhci_pci_quirks);
66d4eadd	227	if (retval)
da3c9c4f	228	return retval;
006d5820	229
da3c9c4f SAS	230	if (!usb_hcd_is_primary_hcd(hcd))
da3c9c4f SAS	231	return 0;
66d4eadd	232
66d4eadd SS	233	xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
	234
	235	/* Find any debug ports */
b02d0ed6 SS	236	retval = xhci_pci_reinit(xhci, pdev);
	237	if (!retval)
	238	return retval;
	239
b02d0ed6 SS	240	return retval;
	241	}
	242
f6ff0ac8 SS	243	/*
	244	* We need to register our own PCI probe function (instead of the USB core's
	245	* function) in order to create a second roothub under xHCI.
	246	*/
	247	static int xhci_pci_probe(struct pci_dev dev, const struct pci_device_id id)
	248	{
	249	int retval;
	250	struct xhci_hcd *xhci;
	251	struct hc_driver *driver;
	252	struct usb_hcd *hcd;
	253
	254	driver = (struct hc_driver *)id->driver_data;
bcffae77 MN	255
	256	/* Prevent runtime suspending between USB-2 and USB-3 initialization */
	257	pm_runtime_get_noresume(&dev->dev);
	258
f6ff0ac8 SS	259	/* Register the USB 2.0 roothub.
	260	* FIXME: USB core must know to register the USB 2.0 roothub first.
	261	* This is sort of silly, because we could just set the HCD driver flags
	262	* to say USB 2.0, but I'm not sure what the implications would be in
	263	* the other parts of the HCD code.
	264	*/
	265	retval = usb_hcd_pci_probe(dev, id);
	266
	267	if (retval)
bcffae77	268	goto put_runtime_pm;
f6ff0ac8 SS	269
	270	/* USB 2.0 roothub is stored in the PCI device now. */
	271	hcd = dev_get_drvdata(&dev->dev);
	272	xhci = hcd_to_xhci(hcd);
	273	xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
	274	pci_name(dev), hcd);
	275	if (!xhci->shared_hcd) {
	276	retval = -ENOMEM;
	277	goto dealloc_usb2_hcd;
	278	}
	279
f6ff0ac8	280	retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
b5dd18d8	281	IRQF_SHARED);
f6ff0ac8 SS	282	if (retval)
	283	goto put_usb3_hcd;
	284	/* Roothub already marked as USB 3.0 speed */
3b3db026	285
8f873c1f HG	286	if (!(xhci->quirks & XHCI_BROKEN_STREAMS) &&
8f873c1f HG	287	HCC_MAX_PSA(xhci->hcc_params) >= 4)
14aec589 ON	288	xhci->shared_hcd->can_do_streams = 1;
14aec589 ON	289
c3c5819a MN	290	if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
	291	xhci_pme_acpi_rtd3_enable(dev);
	292
bcffae77 MN	293	/* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
	294	pm_runtime_put_noidle(&dev->dev);
	295
f6ff0ac8 SS	296	return 0;
	297
	298	put_usb3_hcd:
	299	usb_put_hcd(xhci->shared_hcd);
	300	dealloc_usb2_hcd:
	301	usb_hcd_pci_remove(dev);
bcffae77 MN	302	put_runtime_pm:
bcffae77 MN	303	pm_runtime_put_noidle(&dev->dev);
f6ff0ac8 SS	304	return retval;
	305	}
	306
b02d0ed6 SS	307	static void xhci_pci_remove(struct pci_dev *dev)
	308	{
	309	struct xhci_hcd *xhci;
	310
	311	xhci = hcd_to_xhci(pci_get_drvdata(dev));
98d74f9c	312	xhci->xhc_state \|= XHCI_STATE_REMOVING;
f6ff0ac8 SS	313	if (xhci->shared_hcd) {
	314	usb_remove_hcd(xhci->shared_hcd);
	315	usb_put_hcd(xhci->shared_hcd);
	316	}
638298dc TI	317
	318	/* Workaround for spurious wakeups at shutdown with HSW */
	319	if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
	320	pci_set_power_state(dev, PCI_D3hot);
f1f6d9a8 MN	321
f1f6d9a8 MN	322	usb_hcd_pci_remove(dev);
66d4eadd SS	323	}
66d4eadd SS	324
5535b1d5	325	#ifdef CONFIG_PM
2b7627b7 TB	326	/*
	327	* In some Intel xHCI controllers, in order to get D3 working,
	328	* through a vendor specific SSIC CONFIG register at offset 0x883c,
	329	* SSIC PORT need to be marked as "unused" before putting xHCI
	330	* into D3. After D3 exit, the SSIC port need to be marked as "used".
	331	* Without this change, xHCI might not enter D3 state.
2b7627b7	332	*/
7e70cbff	333	static void xhci_ssic_port_unused_quirk(struct usb_hcd *hcd, bool suspend)
2b7627b7 TB	334	{
2b7627b7 TB	335	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
2b7627b7 TB	336	u32 val;
2b7627b7 TB	337	void __iomem *reg;
fa895377	338	int i;
2b7627b7	339
7e70cbff LB	340	for (i = 0; i < SSIC_PORT_NUM; i++) {
	341	reg = (void __iomem *) xhci->cap_regs +
	342	SSIC_PORT_CFG2 +
	343	i * SSIC_PORT_CFG2_OFFSET;
	344
	345	/* Notify SSIC that SSIC profile programming is not done. */
	346	val = readl(reg) & ~PROG_DONE;
	347	writel(val, reg);
	348
	349	/* Mark SSIC port as unused(suspend) or used(resume) */
	350	val = readl(reg);
	351	if (suspend)
	352	val \|= SSIC_PORT_UNUSED;
	353	else
	354	val &= ~SSIC_PORT_UNUSED;
	355	writel(val, reg);
	356
	357	/* Notify SSIC that SSIC profile programming is done */
	358	val = readl(reg) \| PROG_DONE;
	359	writel(val, reg);
	360	readl(reg);
2b7627b7	361	}
7e70cbff LB	362	}
	363
	364	/*
	365	* Make sure PME works on some Intel xHCI controllers by writing 1 to clear
	366	* the Internal PME flag bit in vendor specific PMCTRL register at offset 0x80a4
	367	*/
	368	static void xhci_pme_quirk(struct usb_hcd *hcd)
	369	{
	370	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
	371	void __iomem *reg;
	372	u32 val;
2b7627b7 TB	373
	374	reg = (void __iomem *) xhci->cap_regs + 0x80a4;
	375	val = readl(reg);
	376	writel(val \| BIT(28), reg);
	377	readl(reg);
	378	}
	379
5535b1d5 AX	380	static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
	381	{
	382	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
c3897aa5	383	struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
92149c93	384	int ret;
c3897aa5 SS	385
	386	/*
	387	* Systems with the TI redriver that loses port status change events
	388	* need to have the registers polled during D3, so avoid D3cold.
	389	*/
e1cd9727	390	if (xhci->quirks & XHCI_COMP_MODE_QUIRK)
9d26d3a8	391	pci_d3cold_disable(pdev);
5535b1d5	392
b8cb91e0	393	if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
7e70cbff LB	394	xhci_pme_quirk(hcd);
	395
	396	if (xhci->quirks & XHCI_SSIC_PORT_UNUSED)
	397	xhci_ssic_port_unused_quirk(hcd, true);
b8cb91e0	398
92149c93 LB	399	ret = xhci_suspend(xhci, do_wakeup);
	400	if (ret && (xhci->quirks & XHCI_SSIC_PORT_UNUSED))
	401	xhci_ssic_port_unused_quirk(hcd, false);
	402
	403	return ret;
5535b1d5 AX	404	}
	405
	406	static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
	407	{
	408	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
69e848c2	409	struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
5535b1d5 AX	410	int retval = 0;
5535b1d5 AX	411
69e848c2 SS	412	/* The BIOS on systems with the Intel Panther Point chipset may or may
	413	* not support xHCI natively. That means that during system resume, it
	414	* may switch the ports back to EHCI so that users can use their
	415	* keyboard to select a kernel from GRUB after resume from hibernate.
	416	*
	417	* The BIOS is supposed to remember whether the OS had xHCI ports
	418	* enabled before resume, and switch the ports back to xHCI when the
	419	* BIOS/OS semaphore is written, but we all know we can't trust BIOS
	420	* writers.
	421	*
	422	* Unconditionally switch the ports back to xHCI after a system resume.
26b76798 MN	423	* It should not matter whether the EHCI or xHCI controller is
	424	* resumed first. It's enough to do the switchover in xHCI because
	425	* USB core won't notice anything as the hub driver doesn't start
	426	* running again until after all the devices (including both EHCI and
	427	* xHCI host controllers) have been resumed.
69e848c2	428	*/
26b76798 MN	429
	430	if (pdev->vendor == PCI_VENDOR_ID_INTEL)
	431	usb_enable_intel_xhci_ports(pdev);
69e848c2	432
7e70cbff LB	433	if (xhci->quirks & XHCI_SSIC_PORT_UNUSED)
	434	xhci_ssic_port_unused_quirk(hcd, false);
	435
b8cb91e0	436	if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
7e70cbff	437	xhci_pme_quirk(hcd);
b8cb91e0	438
5535b1d5 AX	439	retval = xhci_resume(xhci, hibernated);
	440	return retval;
	441	}
	442	#endif /* CONFIG_PM */
	443
66d4eadd SS	444	/-------------------------------------------------------------------------/
	445
	446	/* PCI driver selection metadata; PCI hotplugging uses this */
	447	static const struct pci_device_id pci_ids[] = { {
	448	/* handle any USB 3.0 xHCI controller */
	449	PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
	450	.driver_data = (unsigned long) &xhci_pci_hc_driver,
	451	},
	452	{ /* end: all zeroes */ }
	453	};
	454	MODULE_DEVICE_TABLE(pci, pci_ids);
	455
	456	/* pci driver glue; this is a "new style" PCI driver module */
	457	static struct pci_driver xhci_pci_driver = {
	458	.name = (char *) hcd_name,
	459	.id_table = pci_ids,
	460
f6ff0ac8	461	.probe = xhci_pci_probe,
b02d0ed6	462	.remove = xhci_pci_remove,
66d4eadd SS	463	/* suspend and resume implemented later */
	464
	465	.shutdown = usb_hcd_pci_shutdown,
f875fdbf	466	#ifdef CONFIG_PM
5535b1d5 AX	467	.driver = {
	468	.pm = &usb_hcd_pci_pm_ops
	469	},
	470	#endif
66d4eadd SS	471	};
66d4eadd SS	472
29e409f0	473	static int __init xhci_pci_init(void)
66d4eadd	474	{
cd33a321	475	xhci_init_driver(&xhci_pci_hc_driver, &xhci_pci_overrides);
1885d9a3 AB	476	#ifdef CONFIG_PM
	477	xhci_pci_hc_driver.pci_suspend = xhci_pci_suspend;
	478	xhci_pci_hc_driver.pci_resume = xhci_pci_resume;
	479	#endif
66d4eadd SS	480	return pci_register_driver(&xhci_pci_driver);
66d4eadd SS	481	}
29e409f0	482	module_init(xhci_pci_init);
66d4eadd	483
29e409f0	484	static void __exit xhci_pci_exit(void)
66d4eadd SS	485	{
	486	pci_unregister_driver(&xhci_pci_driver);
	487	}
29e409f0 AB	488	module_exit(xhci_pci_exit);
	489
	490	MODULE_DESCRIPTION("xHCI PCI Host Controller Driver");
	491	MODULE_LICENSE("GPL");