[mirror_ubuntu-eoan-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 "xhci.h"
#include "xhci-trace.h"

/* 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

static const char hcd_name[] = "xhci_hcd";

/* 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);
		}
		/* 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;
	}
	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;
		xhci->quirks |= XHCI_AVOID_BEI;
	}
	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
	    (pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI ||
	     pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI)) {
		/* Workaround for occasional spurious wakeups from S5 (or
		 * any other sleep) on Haswell machines with LPT and LPT-LP
		 * with the new Intel BIOS
		 */
		/* Limit the quirk to only known vendors, as this triggers
		 * yet another BIOS bug on some other machines
		 * https://bugzilla.kernel.org/show_bug.cgi?id=66171
		 */
		if (pdev->subsystem_vendor == PCI_VENDOR_ID_HP)
			xhci->quirks |= XHCI_SPURIOUS_WAKEUP;
	}
	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
		pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI) {
		xhci->quirks |= XHCI_SPURIOUS_REBOOT;
	}
	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 (xhci->quirks & XHCI_RESET_ON_RESUME)
		xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
				"QUIRK: Resetting on resume");
}

/* 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;

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

	xhci = hcd_to_xhci(hcd);
	if (!usb_hcd_is_primary_hcd(hcd))
		return 0;

	pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
	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;

	kfree(xhci);
	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;
	}

	/* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
	 * is called by usb_add_hcd().
	 */
	*((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;

	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;

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

	kfree(xhci);
}

#ifdef CONFIG_PM
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_compliance_mode_recovery_timer_quirk_check())
		pdev->no_d3cold = true;

	return xhci_suspend(xhci);
}

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

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

static const struct hc_driver xhci_pci_hc_driver = {
	.description =		hcd_name,
	.product_desc =		"xHCI Host Controller",
	.hcd_priv_size =	sizeof(struct xhci_hcd *),

	/*
	 * generic hardware linkage
	 */
	.irq =			xhci_irq,
	.flags =		HCD_MEMORY | HCD_USB3 | HCD_SHARED,

	/*
	 * basic lifecycle operations
	 */
	.reset =		xhci_pci_setup,
	.start =		xhci_run,
#ifdef CONFIG_PM
	.pci_suspend =          xhci_pci_suspend,
	.pci_resume =           xhci_pci_resume,
#endif
	.stop =			xhci_stop,
	.shutdown =		xhci_shutdown,

	/*
	 * managing i/o requests and associated device resources
	 */
	.urb_enqueue =		xhci_urb_enqueue,
	.urb_dequeue =		xhci_urb_dequeue,
	.alloc_dev =		xhci_alloc_dev,
	.free_dev =		xhci_free_dev,
	.alloc_streams =	xhci_alloc_streams,
	.free_streams =		xhci_free_streams,
	.add_endpoint =		xhci_add_endpoint,
	.drop_endpoint =	xhci_drop_endpoint,
	.endpoint_reset =	xhci_endpoint_reset,
	.check_bandwidth =	xhci_check_bandwidth,
	.reset_bandwidth =	xhci_reset_bandwidth,
	.address_device =	xhci_address_device,
	.enable_device =	xhci_enable_device,
	.update_hub_device =	xhci_update_hub_device,
	.reset_device =		xhci_discover_or_reset_device,

	/*
	 * scheduling support
	 */
	.get_frame_number =	xhci_get_frame,

	/* Root hub support */
	.hub_control =		xhci_hub_control,
	.hub_status_data =	xhci_hub_status_data,
	.bus_suspend =		xhci_bus_suspend,
	.bus_resume =		xhci_bus_resume,
	/*
	 * call back when device connected and addressed
	 */
	.update_device =        xhci_update_device,
	.set_usb2_hw_lpm =	xhci_set_usb2_hardware_lpm,
	.enable_usb3_lpm_timeout =	xhci_enable_usb3_lpm_timeout,
	.disable_usb3_lpm_timeout =	xhci_disable_usb3_lpm_timeout,
	.find_raw_port_number =	xhci_find_raw_port_number,
};

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

/* 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
};

int __init xhci_register_pci(void)
{
	return pci_register_driver(&xhci_pci_driver);
}

void xhci_unregister_pci(void)
{
	pci_unregister_driver(&xhci_pci_driver);
}
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>
66d4eadd SS	26
66d4eadd SS	27	#include "xhci.h"
4bdfe4c3	28	#include "xhci-trace.h"
66d4eadd	29
ac9d8fe7 SS	30	/* Device for a quirk */
	31	#define PCI_VENDOR_ID_FRESCO_LOGIC 0x1b73
	32	#define PCI_DEVICE_ID_FRESCO_LOGIC_PDK 0x1000
bba18e33	33	#define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400 0x1400
ac9d8fe7	34
c877b3b2	35	#define PCI_VENDOR_ID_ETRON 0x1b6f
170625e9	36	#define PCI_DEVICE_ID_EJ168 0x7023
c877b3b2	37
638298dc TI	38	#define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI 0x8c31
	39	#define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI 0x9c31
	40
66d4eadd SS	41	static const char hcd_name[] = "xhci_hcd";
	42
	43	/* called after powerup, by probe or system-pm "wakeup" */
	44	static int xhci_pci_reinit(struct xhci_hcd xhci, struct pci_dev pdev)
	45	{
	46	/*
	47	* TODO: Implement finding debug ports later.
	48	* TODO: see if there are any quirks that need to be added to handle
	49	* new extended capabilities.
	50	*/
	51
	52	/* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
	53	if (!pci_set_mwi(pdev))
	54	xhci_dbg(xhci, "MWI active\n");
	55
	56	xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
	57	return 0;
	58	}
	59
da3c9c4f SAS	60	static void xhci_pci_quirks(struct device dev, struct xhci_hcd xhci)
	61	{
	62	struct pci_dev *pdev = to_pci_dev(dev);
	63
ac9d8fe7 SS	64	/* Look for vendor-specific quirks */
ac9d8fe7 SS	65	if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
bba18e33 SS	66	(pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK \|\|
	67	pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
	68	if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
	69	pdev->revision == 0x0) {
ac9d8fe7	70	xhci->quirks \|= XHCI_RESET_EP_QUIRK;
4bdfe4c3 XR	71	xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
	72	"QUIRK: Fresco Logic xHC needs configure"
	73	" endpoint cmd after reset endpoint");
f5182b41	74	}
455f5892 ON	75	if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
	76	pdev->revision == 0x4) {
	77	xhci->quirks \|= XHCI_SLOW_SUSPEND;
	78	xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
	79	"QUIRK: Fresco Logic xHC revision %u"
	80	"must be suspended extra slowly",
	81	pdev->revision);
	82	}
f5182b41 SS	83	/* Fresco Logic confirms: all revisions of this chip do not
	84	* support MSI, even though some of them claim to in their PCI
	85	* capabilities.
	86	*/
	87	xhci->quirks \|= XHCI_BROKEN_MSI;
4bdfe4c3 XR	88	xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
	89	"QUIRK: Fresco Logic revision %u "
	90	"has broken MSI implementation",
f5182b41	91	pdev->revision);
1530bbc6	92	xhci->quirks \|= XHCI_TRUST_TX_LENGTH;
ac9d8fe7	93	}
f5182b41	94
0238634d SS	95	if (pdev->vendor == PCI_VENDOR_ID_NEC)
0238634d SS	96	xhci->quirks \|= XHCI_NEC_HOST;
ac9d8fe7	97
7e393a83 AX	98	if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
	99	xhci->quirks \|= XHCI_AMD_0x96_HOST;
	100
c41136b0 AX	101	/* AMD PLL quirk */
	102	if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
	103	xhci->quirks \|= XHCI_AMD_PLL_FIX;
2597fe99 HR	104
	105	if (pdev->vendor == PCI_VENDOR_ID_AMD)
	106	xhci->quirks \|= XHCI_TRUST_TX_LENGTH;
	107
e3567d2c SS	108	if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
	109	xhci->quirks \|= XHCI_LPM_SUPPORT;
	110	xhci->quirks \|= XHCI_INTEL_HOST;
	111	}
ad808333 SS	112	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
ad808333 SS	113	pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
2cf95c18 SS	114	xhci->quirks \|= XHCI_EP_LIMIT_QUIRK;
2cf95c18 SS	115	xhci->limit_active_eps = 64;
86cc558e	116	xhci->quirks \|= XHCI_SW_BW_CHECKING;
e95829f4 SS	117	/*
	118	* PPT desktop boards DH77EB and DH77DF will power back on after
	119	* a few seconds of being shutdown. The fix for this is to
	120	* switch the ports from xHCI to EHCI on shutdown. We can't use
	121	* DMI information to find those particular boards (since each
	122	* vendor will change the board name), so we have to key off all
	123	* PPT chipsets.
	124	*/
	125	xhci->quirks \|= XHCI_SPURIOUS_REBOOT;
80fab3b2	126	xhci->quirks \|= XHCI_AVOID_BEI;
ad808333	127	}
638298dc TI	128	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
	129	(pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI \|\|
	130	pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI)) {
	131	/* Workaround for occasional spurious wakeups from S5 (or
	132	* any other sleep) on Haswell machines with LPT and LPT-LP
	133	* with the new Intel BIOS
	134	*/
6962d914 TI	135	/* Limit the quirk to only known vendors, as this triggers
	136	* yet another BIOS bug on some other machines
	137	* https://bugzilla.kernel.org/show_bug.cgi?id=66171
	138	*/
	139	if (pdev->subsystem_vendor == PCI_VENDOR_ID_HP)
	140	xhci->quirks \|= XHCI_SPURIOUS_WAKEUP;
0a939993 DT	141	}
	142	if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
	143	pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI) {
c09ec25d	144	xhci->quirks \|= XHCI_SPURIOUS_REBOOT;
638298dc	145	}
c877b3b2	146	if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
170625e9	147	pdev->device == PCI_DEVICE_ID_EJ168) {
c877b3b2	148	xhci->quirks \|= XHCI_RESET_ON_RESUME;
5cb7df2b	149	xhci->quirks \|= XHCI_TRUST_TX_LENGTH;
8f873c1f	150	xhci->quirks \|= XHCI_BROKEN_STREAMS;
c877b3b2	151	}
1aa9578c	152	if (pdev->vendor == PCI_VENDOR_ID_RENESAS &&
6db249eb	153	pdev->device == 0x0015)
1aa9578c	154	xhci->quirks \|= XHCI_RESET_ON_RESUME;
457a4f61 EF	155	if (pdev->vendor == PCI_VENDOR_ID_VIA)
457a4f61 EF	156	xhci->quirks \|= XHCI_RESET_ON_RESUME;
85f4e45b	157
e21eba05 HG	158	/* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */
	159	if (pdev->vendor == PCI_VENDOR_ID_VIA &&
	160	pdev->device == 0x3432)
	161	xhci->quirks \|= XHCI_BROKEN_STREAMS;
	162
85f4e45b ON	163	if (xhci->quirks & XHCI_RESET_ON_RESUME)
	164	xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
	165	"QUIRK: Resetting on resume");
da3c9c4f	166	}
c41136b0	167
da3c9c4f SAS	168	/* called during probe() after chip reset completes */
	169	static int xhci_pci_setup(struct usb_hcd *hcd)
	170	{
	171	struct xhci_hcd *xhci;
	172	struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
	173	int retval;
66d4eadd	174
da3c9c4f	175	retval = xhci_gen_setup(hcd, xhci_pci_quirks);
66d4eadd	176	if (retval)
da3c9c4f	177	return retval;
006d5820	178
da3c9c4f SAS	179	xhci = hcd_to_xhci(hcd);
	180	if (!usb_hcd_is_primary_hcd(hcd))
	181	return 0;
66d4eadd SS	182
	183	pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
	184	xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
	185
	186	/* Find any debug ports */
b02d0ed6 SS	187	retval = xhci_pci_reinit(xhci, pdev);
	188	if (!retval)
	189	return retval;
	190
b02d0ed6 SS	191	kfree(xhci);
	192	return retval;
	193	}
	194
f6ff0ac8 SS	195	/*
	196	* We need to register our own PCI probe function (instead of the USB core's
	197	* function) in order to create a second roothub under xHCI.
	198	*/
	199	static int xhci_pci_probe(struct pci_dev dev, const struct pci_device_id id)
	200	{
	201	int retval;
	202	struct xhci_hcd *xhci;
	203	struct hc_driver *driver;
	204	struct usb_hcd *hcd;
	205
	206	driver = (struct hc_driver *)id->driver_data;
bcffae77 MN	207
	208	/* Prevent runtime suspending between USB-2 and USB-3 initialization */
	209	pm_runtime_get_noresume(&dev->dev);
	210
f6ff0ac8 SS	211	/* Register the USB 2.0 roothub.
	212	* FIXME: USB core must know to register the USB 2.0 roothub first.
	213	* This is sort of silly, because we could just set the HCD driver flags
	214	* to say USB 2.0, but I'm not sure what the implications would be in
	215	* the other parts of the HCD code.
	216	*/
	217	retval = usb_hcd_pci_probe(dev, id);
	218
	219	if (retval)
bcffae77	220	goto put_runtime_pm;
f6ff0ac8 SS	221
	222	/* USB 2.0 roothub is stored in the PCI device now. */
	223	hcd = dev_get_drvdata(&dev->dev);
	224	xhci = hcd_to_xhci(hcd);
	225	xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
	226	pci_name(dev), hcd);
	227	if (!xhci->shared_hcd) {
	228	retval = -ENOMEM;
	229	goto dealloc_usb2_hcd;
	230	}
	231
	232	/* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
	233	* is called by usb_add_hcd().
	234	*/
	235	((struct xhci_hcd *) xhci->shared_hcd->hcd_priv) = xhci;
	236
	237	retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
b5dd18d8	238	IRQF_SHARED);
f6ff0ac8 SS	239	if (retval)
	240	goto put_usb3_hcd;
	241	/* Roothub already marked as USB 3.0 speed */
3b3db026	242
8f873c1f HG	243	if (!(xhci->quirks & XHCI_BROKEN_STREAMS) &&
8f873c1f HG	244	HCC_MAX_PSA(xhci->hcc_params) >= 4)
14aec589 ON	245	xhci->shared_hcd->can_do_streams = 1;
14aec589 ON	246
bcffae77 MN	247	/* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
	248	pm_runtime_put_noidle(&dev->dev);
	249
f6ff0ac8 SS	250	return 0;
	251
	252	put_usb3_hcd:
	253	usb_put_hcd(xhci->shared_hcd);
	254	dealloc_usb2_hcd:
	255	usb_hcd_pci_remove(dev);
bcffae77 MN	256	put_runtime_pm:
bcffae77 MN	257	pm_runtime_put_noidle(&dev->dev);
f6ff0ac8 SS	258	return retval;
	259	}
	260
b02d0ed6 SS	261	static void xhci_pci_remove(struct pci_dev *dev)
	262	{
	263	struct xhci_hcd *xhci;
	264
	265	xhci = hcd_to_xhci(pci_get_drvdata(dev));
f6ff0ac8 SS	266	if (xhci->shared_hcd) {
	267	usb_remove_hcd(xhci->shared_hcd);
	268	usb_put_hcd(xhci->shared_hcd);
	269	}
b02d0ed6	270	usb_hcd_pci_remove(dev);
638298dc TI	271
	272	/* Workaround for spurious wakeups at shutdown with HSW */
	273	if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
	274	pci_set_power_state(dev, PCI_D3hot);
	275
b02d0ed6	276	kfree(xhci);
66d4eadd SS	277	}
66d4eadd SS	278
5535b1d5 AX	279	#ifdef CONFIG_PM
	280	static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
	281	{
	282	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
c3897aa5 SS	283	struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
	284
	285	/*
	286	* Systems with the TI redriver that loses port status change events
	287	* need to have the registers polled during D3, so avoid D3cold.
	288	*/
	289	if (xhci_compliance_mode_recovery_timer_quirk_check())
	290	pdev->no_d3cold = true;
5535b1d5	291
77b84767	292	return xhci_suspend(xhci);
5535b1d5 AX	293	}
	294
	295	static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
	296	{
	297	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
69e848c2	298	struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
5535b1d5 AX	299	int retval = 0;
5535b1d5 AX	300
69e848c2 SS	301	/* The BIOS on systems with the Intel Panther Point chipset may or may
	302	* not support xHCI natively. That means that during system resume, it
	303	* may switch the ports back to EHCI so that users can use their
	304	* keyboard to select a kernel from GRUB after resume from hibernate.
	305	*
	306	* The BIOS is supposed to remember whether the OS had xHCI ports
	307	* enabled before resume, and switch the ports back to xHCI when the
	308	* BIOS/OS semaphore is written, but we all know we can't trust BIOS
	309	* writers.
	310	*
	311	* Unconditionally switch the ports back to xHCI after a system resume.
26b76798 MN	312	* It should not matter whether the EHCI or xHCI controller is
	313	* resumed first. It's enough to do the switchover in xHCI because
	314	* USB core won't notice anything as the hub driver doesn't start
	315	* running again until after all the devices (including both EHCI and
	316	* xHCI host controllers) have been resumed.
69e848c2	317	*/
26b76798 MN	318
	319	if (pdev->vendor == PCI_VENDOR_ID_INTEL)
	320	usb_enable_intel_xhci_ports(pdev);
69e848c2	321
5535b1d5 AX	322	retval = xhci_resume(xhci, hibernated);
	323	return retval;
	324	}
	325	#endif /* CONFIG_PM */
	326
66d4eadd SS	327	static const struct hc_driver xhci_pci_hc_driver = {
	328	.description = hcd_name,
	329	.product_desc = "xHCI Host Controller",
b02d0ed6	330	.hcd_priv_size = sizeof(struct xhci_hcd *),
66d4eadd SS	331
	332	/*
	333	* generic hardware linkage
	334	*/
7f84eef0	335	.irq = xhci_irq,
f6ff0ac8	336	.flags = HCD_MEMORY \| HCD_USB3 \| HCD_SHARED,
66d4eadd SS	337
	338	/*
	339	* basic lifecycle operations
	340	*/
	341	.reset = xhci_pci_setup,
	342	.start = xhci_run,
5535b1d5 AX	343	#ifdef CONFIG_PM
	344	.pci_suspend = xhci_pci_suspend,
	345	.pci_resume = xhci_pci_resume,
	346	#endif
66d4eadd SS	347	.stop = xhci_stop,
	348	.shutdown = xhci_shutdown,
	349
3ffbba95 SS	350	/*
	351	* managing i/o requests and associated device resources
	352	*/
d0e96f5a SS	353	.urb_enqueue = xhci_urb_enqueue,
d0e96f5a SS	354	.urb_dequeue = xhci_urb_dequeue,
3ffbba95 SS	355	.alloc_dev = xhci_alloc_dev,
3ffbba95 SS	356	.free_dev = xhci_free_dev,
eab1cafc SS	357	.alloc_streams = xhci_alloc_streams,
eab1cafc SS	358	.free_streams = xhci_free_streams,
f94e0186 SS	359	.add_endpoint = xhci_add_endpoint,
f94e0186 SS	360	.drop_endpoint = xhci_drop_endpoint,
a1587d97	361	.endpoint_reset = xhci_endpoint_reset,
f94e0186 SS	362	.check_bandwidth = xhci_check_bandwidth,
f94e0186 SS	363	.reset_bandwidth = xhci_reset_bandwidth,
3ffbba95	364	.address_device = xhci_address_device,
48fc7dbd	365	.enable_device = xhci_enable_device,
b356b7c7	366	.update_hub_device = xhci_update_hub_device,
f0615c45	367	.reset_device = xhci_discover_or_reset_device,
3ffbba95	368
66d4eadd SS	369	/*
	370	* scheduling support
	371	*/
	372	.get_frame_number = xhci_get_frame,
	373
0f2a7930 SS	374	/* Root hub support */
	375	.hub_control = xhci_hub_control,
	376	.hub_status_data = xhci_hub_status_data,
9777e3ce AX	377	.bus_suspend = xhci_bus_suspend,
9777e3ce AX	378	.bus_resume = xhci_bus_resume,
9574323c AX	379	/*
	380	* call back when device connected and addressed
	381	*/
	382	.update_device = xhci_update_device,
65580b43	383	.set_usb2_hw_lpm = xhci_set_usb2_hardware_lpm,
3b3db026 SS	384	.enable_usb3_lpm_timeout = xhci_enable_usb3_lpm_timeout,
3b3db026 SS	385	.disable_usb3_lpm_timeout = xhci_disable_usb3_lpm_timeout,
3f5eb141	386	.find_raw_port_number = xhci_find_raw_port_number,
66d4eadd SS	387	};
	388
	389	/-------------------------------------------------------------------------/
	390
	391	/* PCI driver selection metadata; PCI hotplugging uses this */
	392	static const struct pci_device_id pci_ids[] = { {
	393	/* handle any USB 3.0 xHCI controller */
	394	PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
	395	.driver_data = (unsigned long) &xhci_pci_hc_driver,
	396	},
	397	{ /* end: all zeroes */ }
	398	};
	399	MODULE_DEVICE_TABLE(pci, pci_ids);
	400
	401	/* pci driver glue; this is a "new style" PCI driver module */
	402	static struct pci_driver xhci_pci_driver = {
	403	.name = (char *) hcd_name,
	404	.id_table = pci_ids,
	405
f6ff0ac8	406	.probe = xhci_pci_probe,
b02d0ed6	407	.remove = xhci_pci_remove,
66d4eadd SS	408	/* suspend and resume implemented later */
	409
	410	.shutdown = usb_hcd_pci_shutdown,
f875fdbf	411	#ifdef CONFIG_PM
5535b1d5 AX	412	.driver = {
	413	.pm = &usb_hcd_pci_pm_ops
	414	},
	415	#endif
66d4eadd SS	416	};
66d4eadd SS	417
0cc47d54	418	int __init xhci_register_pci(void)
66d4eadd SS	419	{
	420	return pci_register_driver(&xhci_pci_driver);
	421	}
	422
a46c46a1	423	void xhci_unregister_pci(void)
66d4eadd SS	424	{
	425	pci_unregister_driver(&xhci_pci_driver);
	426	}