[mirror_ubuntu-bionic-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_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

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_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)) {
		xhci->quirks |= XHCI_PME_STUCK_QUIRK;
	}
	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));
	if (xhci->shared_hcd) {
		usb_remove_hcd(xhci->shared_hcd);
		usb_put_hcd(xhci->shared_hcd);
	}
	usb_hcd_pci_remove(dev);

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

#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.
 * 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, bool suspend)
{
	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
	struct pci_dev		*pdev = to_pci_dev(hcd->self.controller);
	u32 val;
	void __iomem *reg;
	int i;

	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
		 pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI) {

		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);
		}
	}

	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);

	/*
	 * 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)
		pdev->no_d3cold = true;

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

	return xhci_suspend(xhci, do_wakeup);
}

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_PME_STUCK_QUIRK)
		xhci_pme_quirk(hcd, false);

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