[deliverable/linux.git] / drivers / usb / host / ehci-pci.c

/*
 * EHCI HCD (Host Controller Driver) PCI Bus Glue.
 *
 * Copyright (c) 2000-2004 by David Brownell
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * 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/kernel.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/usb.h>
#include <linux/usb/hcd.h>

#include "ehci.h"
#include "pci-quirks.h"

#define DRIVER_DESC "EHCI PCI platform driver"

static const char hcd_name[] = "ehci-pci";

/* defined here to avoid adding to pci_ids.h for single instance use */
#define PCI_DEVICE_ID_INTEL_CE4100_USB	0x2e70

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

/* called after powerup, by probe or system-pm "wakeup" */
static int ehci_pci_reinit(struct ehci_hcd *ehci, struct pci_dev *pdev)
{
	int			retval;

	/* we expect static quirk code to handle the "extended capabilities"
	 * (currently just BIOS handoff) allowed starting with EHCI 0.96
	 */

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

	return 0;
}

/* called during probe() after chip reset completes */
static int ehci_pci_setup(struct usb_hcd *hcd)
{
	struct ehci_hcd		*ehci = hcd_to_ehci(hcd);
	struct pci_dev		*pdev = to_pci_dev(hcd->self.controller);
	struct pci_dev		*p_smbus;
	u8			rev;
	u32			temp;
	int			retval;

	ehci->caps = hcd->regs;

	/*
	 * ehci_init() causes memory for DMA transfers to be
	 * allocated.  Thus, any vendor-specific workarounds based on
	 * limiting the type of memory used for DMA transfers must
	 * happen before ehci_setup() is called.
	 *
	 * Most other workarounds can be done either before or after
	 * init and reset; they are located here too.
	 */
	switch (pdev->vendor) {
	case PCI_VENDOR_ID_TOSHIBA_2:
		/* celleb's companion chip */
		if (pdev->device == 0x01b5) {
#ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
			ehci->big_endian_mmio = 1;
#else
			ehci_warn(ehci,
				  "unsupported big endian Toshiba quirk\n");
#endif
		}
		break;
	case PCI_VENDOR_ID_NVIDIA:
		/* NVidia reports that certain chips don't handle
		 * QH, ITD, or SITD addresses above 2GB.  (But TD,
		 * data buffer, and periodic schedule are normal.)
		 */
		switch (pdev->device) {
		case 0x003c:	/* MCP04 */
		case 0x005b:	/* CK804 */
		case 0x00d8:	/* CK8 */
		case 0x00e8:	/* CK8S */
			if (pci_set_consistent_dma_mask(pdev,
						DMA_BIT_MASK(31)) < 0)
				ehci_warn(ehci, "can't enable NVidia "
					"workaround for >2GB RAM\n");
			break;

		/* Some NForce2 chips have problems with selective suspend;
		 * fixed in newer silicon.
		 */
		case 0x0068:
			if (pdev->revision < 0xa4)
				ehci->no_selective_suspend = 1;
			break;
		}
		break;
	case PCI_VENDOR_ID_INTEL:
		if (pdev->device == PCI_DEVICE_ID_INTEL_CE4100_USB)
			hcd->has_tt = 1;
		break;
	case PCI_VENDOR_ID_TDI:
		if (pdev->device == PCI_DEVICE_ID_TDI_EHCI)
			hcd->has_tt = 1;
		break;
	case PCI_VENDOR_ID_AMD:
		/* AMD PLL quirk */
		if (usb_amd_find_chipset_info())
			ehci->amd_pll_fix = 1;
		/* AMD8111 EHCI doesn't work, according to AMD errata */
		if (pdev->device == 0x7463) {
			ehci_info(ehci, "ignoring AMD8111 (errata)\n");
			retval = -EIO;
			goto done;
		}

		/*
		 * EHCI controller on AMD SB700/SB800/Hudson-2/3 platforms may
		 * read/write memory space which does not belong to it when
		 * there is NULL pointer with T-bit set to 1 in the frame list
		 * table. To avoid the issue, the frame list link pointer
		 * should always contain a valid pointer to a inactive qh.
		 */
		if (pdev->device == 0x7808) {
			ehci->use_dummy_qh = 1;
			ehci_info(ehci, "applying AMD SB700/SB800/Hudson-2/3 EHCI dummy qh workaround\n");
		}
		break;
	case PCI_VENDOR_ID_VIA:
		if (pdev->device == 0x3104 && (pdev->revision & 0xf0) == 0x60) {
			u8 tmp;

			/* The VT6212 defaults to a 1 usec EHCI sleep time which
			 * hogs the PCI bus *badly*. Setting bit 5 of 0x4B makes
			 * that sleep time use the conventional 10 usec.
			 */
			pci_read_config_byte(pdev, 0x4b, &tmp);
			if (tmp & 0x20)
				break;
			pci_write_config_byte(pdev, 0x4b, tmp | 0x20);
		}
		break;
	case PCI_VENDOR_ID_ATI:
		/* AMD PLL quirk */
		if (usb_amd_find_chipset_info())
			ehci->amd_pll_fix = 1;

		/*
		 * EHCI controller on AMD SB700/SB800/Hudson-2/3 platforms may
		 * read/write memory space which does not belong to it when
		 * there is NULL pointer with T-bit set to 1 in the frame list
		 * table. To avoid the issue, the frame list link pointer
		 * should always contain a valid pointer to a inactive qh.
		 */
		if (pdev->device == 0x4396) {
			ehci->use_dummy_qh = 1;
			ehci_info(ehci, "applying AMD SB700/SB800/Hudson-2/3 EHCI dummy qh workaround\n");
		}
		/* SB600 and old version of SB700 have a bug in EHCI controller,
		 * which causes usb devices lose response in some cases.
		 */
		if ((pdev->device == 0x4386) || (pdev->device == 0x4396)) {
			p_smbus = pci_get_device(PCI_VENDOR_ID_ATI,
						 PCI_DEVICE_ID_ATI_SBX00_SMBUS,
						 NULL);
			if (!p_smbus)
				break;
			rev = p_smbus->revision;
			if ((pdev->device == 0x4386) || (rev == 0x3a)
			    || (rev == 0x3b)) {
				u8 tmp;
				ehci_info(ehci, "applying AMD SB600/SB700 USB "
					"freeze workaround\n");
				pci_read_config_byte(pdev, 0x53, &tmp);
				pci_write_config_byte(pdev, 0x53, tmp | (1<<3));
			}
			pci_dev_put(p_smbus);
		}
		break;
	case PCI_VENDOR_ID_NETMOS:
		/* MosChip frame-index-register bug */
		ehci_info(ehci, "applying MosChip frame-index workaround\n");
		ehci->frame_index_bug = 1;
		break;
	}

	/* optional debug port, normally in the first BAR */
	temp = pci_find_capability(pdev, PCI_CAP_ID_DBG);
	if (temp) {
		pci_read_config_dword(pdev, temp, &temp);
		temp >>= 16;
		if (((temp >> 13) & 7) == 1) {
			u32 hcs_params = ehci_readl(ehci,
						    &ehci->caps->hcs_params);

			temp &= 0x1fff;
			ehci->debug = hcd->regs + temp;
			temp = ehci_readl(ehci, &ehci->debug->control);
			ehci_info(ehci, "debug port %d%s\n",
				  HCS_DEBUG_PORT(hcs_params),
				  (temp & DBGP_ENABLED) ? " IN USE" : "");
			if (!(temp & DBGP_ENABLED))
				ehci->debug = NULL;
		}
	}

	retval = ehci_setup(hcd);
	if (retval)
		return retval;

	/* These workarounds need to be applied after ehci_setup() */
	switch (pdev->vendor) {
	case PCI_VENDOR_ID_NEC:
		ehci->need_io_watchdog = 0;
		break;
	case PCI_VENDOR_ID_INTEL:
		ehci->need_io_watchdog = 0;
		break;
	case PCI_VENDOR_ID_NVIDIA:
		switch (pdev->device) {
		/* MCP89 chips on the MacBookAir3,1 give EPROTO when
		 * fetching device descriptors unless LPM is disabled.
		 * There are also intermittent problems enumerating
		 * devices with PPCD enabled.
		 */
		case 0x0d9d:
			ehci_info(ehci, "disable ppcd for nvidia mcp89\n");
			ehci->has_ppcd = 0;
			ehci->command &= ~CMD_PPCEE;
			break;
		}
		break;
	}

	/* at least the Genesys GL880S needs fixup here */
	temp = HCS_N_CC(ehci->hcs_params) * HCS_N_PCC(ehci->hcs_params);
	temp &= 0x0f;
	if (temp && HCS_N_PORTS(ehci->hcs_params) > temp) {
		ehci_dbg(ehci, "bogus port configuration: "
			"cc=%d x pcc=%d < ports=%d\n",
			HCS_N_CC(ehci->hcs_params),
			HCS_N_PCC(ehci->hcs_params),
			HCS_N_PORTS(ehci->hcs_params));

		switch (pdev->vendor) {
		case 0x17a0:		/* GENESYS */
			/* GL880S: should be PORTS=2 */
			temp |= (ehci->hcs_params & ~0xf);
			ehci->hcs_params = temp;
			break;
		case PCI_VENDOR_ID_NVIDIA:
			/* NF4: should be PCC=10 */
			break;
		}
	}

	/* Serial Bus Release Number is at PCI 0x60 offset */
	if (pdev->vendor == PCI_VENDOR_ID_STMICRO
	    && pdev->device == PCI_DEVICE_ID_STMICRO_USB_HOST)
		;	/* ConneXT has no sbrn register */
	else
		pci_read_config_byte(pdev, 0x60, &ehci->sbrn);

	/* Keep this around for a while just in case some EHCI
	 * implementation uses legacy PCI PM support.  This test
	 * can be removed on 17 Dec 2009 if the dev_warn() hasn't
	 * been triggered by then.
	 */
	if (!device_can_wakeup(&pdev->dev)) {
		u16	port_wake;

		pci_read_config_word(pdev, 0x62, &port_wake);
		if (port_wake & 0x0001) {
			dev_warn(&pdev->dev, "Enabling legacy PCI PM\n");
			device_set_wakeup_capable(&pdev->dev, 1);
		}
	}

#ifdef	CONFIG_USB_SUSPEND
	/* REVISIT: the controller works fine for wakeup iff the root hub
	 * itself is "globally" suspended, but usbcore currently doesn't
	 * understand such things.
	 *
	 * System suspend currently expects to be able to suspend the entire
	 * device tree, device-at-a-time.  If we failed selective suspend
	 * reports, system suspend would fail; so the root hub code must claim
	 * success.  That's lying to usbcore, and it matters for runtime
	 * PM scenarios with selective suspend and remote wakeup...
	 */
	if (ehci->no_selective_suspend && device_can_wakeup(&pdev->dev))
		ehci_warn(ehci, "selective suspend/wakeup unavailable\n");
#endif

	retval = ehci_pci_reinit(ehci, pdev);
done:
	return retval;
}

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

#ifdef	CONFIG_PM

/* suspend/resume, section 4.3 */

/* These routines rely on the PCI bus glue
 * to handle powerdown and wakeup, and currently also on
 * transceivers that don't need any software attention to set up
 * the right sort of wakeup.
 * Also they depend on separate root hub suspend/resume.
 */

static bool usb_is_intel_switchable_ehci(struct pci_dev *pdev)
{
	return pdev->class == PCI_CLASS_SERIAL_USB_EHCI &&
		pdev->vendor == PCI_VENDOR_ID_INTEL &&
		(pdev->device == 0x1E26 ||
		 pdev->device == 0x8C2D ||
		 pdev->device == 0x8C26 ||
		 pdev->device == 0x9C26);
}

static void ehci_enable_xhci_companion(void)
{
	struct pci_dev		*companion = NULL;

	/* The xHCI and EHCI controllers are not on the same PCI slot */
	for_each_pci_dev(companion) {
		if (!usb_is_intel_switchable_xhci(companion))
			continue;
		usb_enable_xhci_ports(companion);
		return;
	}
}

static int ehci_pci_resume(struct usb_hcd *hcd, bool hibernated)
{
	struct ehci_hcd		*ehci = hcd_to_ehci(hcd);
	struct pci_dev		*pdev = to_pci_dev(hcd->self.controller);

	/* 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.
	 * We can't tell whether the EHCI or xHCI controller will be resumed
	 * first, so we have to do the port switchover in both drivers.  Writing
	 * a '1' to the port switchover registers should have no effect if the
	 * port was already switched over.
	 */
	if (usb_is_intel_switchable_ehci(pdev))
		ehci_enable_xhci_companion();

	if (ehci_resume(hcd, hibernated) != 0)
		(void) ehci_pci_reinit(ehci, pdev);
	return 0;
}

#else

#define ehci_suspend		NULL
#define ehci_pci_resume		NULL
#endif	/* CONFIG_PM */

static struct hc_driver __read_mostly ehci_pci_hc_driver;

static const struct ehci_driver_overrides pci_overrides __initdata = {
	.reset =		ehci_pci_setup,
};

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

/* PCI driver selection metadata; PCI hotplugging uses this */
static const struct pci_device_id pci_ids [] = { {
	/* handle any USB 2.0 EHCI controller */
	PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_EHCI, ~0),
	.driver_data =	(unsigned long) &ehci_pci_hc_driver,
	}, {
	PCI_VDEVICE(STMICRO, PCI_DEVICE_ID_STMICRO_USB_HOST),
	.driver_data = (unsigned long) &ehci_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 ehci_pci_driver = {
	.name =		(char *) hcd_name,
	.id_table =	pci_ids,

	.probe =	usb_hcd_pci_probe,
	.remove =	usb_hcd_pci_remove,
	.shutdown = 	usb_hcd_pci_shutdown,

#ifdef CONFIG_PM_SLEEP
	.driver =	{
		.pm =	&usb_hcd_pci_pm_ops
	},
#endif
};

static int __init ehci_pci_init(void)
{
	if (usb_disabled())
		return -ENODEV;

	pr_info("%s: " DRIVER_DESC "\n", hcd_name);

	ehci_init_driver(&ehci_pci_hc_driver, &pci_overrides);

	/* Entries for the PCI suspend/resume callbacks are special */
	ehci_pci_hc_driver.pci_suspend = ehci_suspend;
	ehci_pci_hc_driver.pci_resume = ehci_pci_resume;

	return pci_register_driver(&ehci_pci_driver);
}
module_init(ehci_pci_init);

static void __exit ehci_pci_cleanup(void)
{
	pci_unregister_driver(&ehci_pci_driver);
}
module_exit(ehci_pci_cleanup);

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_AUTHOR("David Brownell");
MODULE_AUTHOR("Alan Stern");
MODULE_LICENSE("GPL");
Commit	Line	Data
7ff71d6a MP	1	/*
	2	* EHCI HCD (Host Controller Driver) PCI Bus Glue.
	3	*
	4	* Copyright (c) 2000-2004 by David Brownell
	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the
	8	* Free Software Foundation; either version 2 of the License, or (at your
	9	* option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful, but
	12	* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
	13	* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	14	* for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software Foundation,
	18	* Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	19	*/
	20
adfa79d1 AS	21	#include <linux/kernel.h>
	22	#include <linux/module.h>
	23	#include <linux/pci.h>
	24	#include <linux/usb.h>
	25	#include <linux/usb/hcd.h>
	26
	27	#include "ehci.h"
	28	#include "pci-quirks.h"
	29
	30	#define DRIVER_DESC "EHCI PCI platform driver"
	31
	32	static const char hcd_name[] = "ehci-pci";
7ff71d6a	33
4f683843 DB	34	/* defined here to avoid adding to pci_ids.h for single instance use */
	35	#define PCI_DEVICE_ID_INTEL_CE4100_USB 0x2e70
	36
7ff71d6a MP	37	/-------------------------------------------------------------------------/
7ff71d6a MP	38
18807521 DB	39	/* called after powerup, by probe or system-pm "wakeup" */
	40	static int ehci_pci_reinit(struct ehci_hcd ehci, struct pci_dev pdev)
	41	{
18807521	42	int retval;
18807521	43
401feafa DB	44	/* we expect static quirk code to handle the "extended capabilities"
	45	* (currently just BIOS handoff) allowed starting with EHCI 0.96
	46	*/
18807521 DB	47
	48	/* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
	49	retval = pci_set_mwi(pdev);
	50	if (!retval)
	51	ehci_dbg(ehci, "MWI active\n");
	52
18807521 DB	53	return 0;
	54	}
	55
8926bfa7 DB	56	/* called during probe() after chip reset completes */
8926bfa7 DB	57	static int ehci_pci_setup(struct usb_hcd *hcd)
7ff71d6a	58	{
abcc9448 DB	59	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
abcc9448 DB	60	struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
b09bc6cb AX	61	struct pci_dev *p_smbus;
b09bc6cb AX	62	u8 rev;
7ff71d6a	63	u32 temp;
18807521	64	int retval;
7ff71d6a	65
1a49e2ac AS	66	ehci->caps = hcd->regs;
	67
	68	/*
	69	* ehci_init() causes memory for DMA transfers to be
	70	* allocated. Thus, any vendor-specific workarounds based on
	71	* limiting the type of memory used for DMA transfers must
	72	* happen before ehci_setup() is called.
	73	*
	74	* Most other workarounds can be done either before or after
	75	* init and reset; they are located here too.
	76	*/
083522d7 BH	77	switch (pdev->vendor) {
	78	case PCI_VENDOR_ID_TOSHIBA_2:
	79	/* celleb's companion chip */
	80	if (pdev->device == 0x01b5) {
	81	#ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
	82	ehci->big_endian_mmio = 1;
	83	#else
	84	ehci_warn(ehci,
	85	"unsupported big endian Toshiba quirk\n");
	86	#endif
	87	}
	88	break;
c32ba30f PS	89	case PCI_VENDOR_ID_NVIDIA:
	90	/* NVidia reports that certain chips don't handle
	91	* QH, ITD, or SITD addresses above 2GB. (But TD,
	92	* data buffer, and periodic schedule are normal.)
	93	*/
	94	switch (pdev->device) {
	95	case 0x003c: /* MCP04 */
	96	case 0x005b: /* CK804 */
	97	case 0x00d8: /* CK8 */
	98	case 0x00e8: /* CK8S */
	99	if (pci_set_consistent_dma_mask(pdev,
929a22a5	100	DMA_BIT_MASK(31)) < 0)
c32ba30f PS	101	ehci_warn(ehci, "can't enable NVidia "
	102	"workaround for >2GB RAM\n");
	103	break;
7ff71d6a	104
1a49e2ac AS	105	/* Some NForce2 chips have problems with selective suspend;
1a49e2ac AS	106	* fixed in newer silicon.
3d091a6f	107	*/
1a49e2ac AS	108	case 0x0068:
	109	if (pdev->revision < 0xa4)
	110	ehci->no_selective_suspend = 1;
	111	break;
	112	}
3681d8f3	113	break;
403dbd36	114	case PCI_VENDOR_ID_INTEL:
1a49e2ac	115	if (pdev->device == PCI_DEVICE_ID_INTEL_CE4100_USB)
4f683843	116	hcd->has_tt = 1;
403dbd36	117	break;
abcc9448	118	case PCI_VENDOR_ID_TDI:
1a49e2ac	119	if (pdev->device == PCI_DEVICE_ID_TDI_EHCI)
7329e211	120	hcd->has_tt = 1;
abcc9448 DB	121	break;
abcc9448 DB	122	case PCI_VENDOR_ID_AMD:
ad93562b AX	123	/* AMD PLL quirk */
	124	if (usb_amd_find_chipset_info())
	125	ehci->amd_pll_fix = 1;
abcc9448 DB	126	/* AMD8111 EHCI doesn't work, according to AMD errata */
	127	if (pdev->device == 0x7463) {
	128	ehci_info(ehci, "ignoring AMD8111 (errata)\n");
8926bfa7 DB	129	retval = -EIO;
8926bfa7 DB	130	goto done;
abcc9448	131	}
a85b4e7f	132
1a49e2ac AS	133	/*
	134	* EHCI controller on AMD SB700/SB800/Hudson-2/3 platforms may
	135	* read/write memory space which does not belong to it when
	136	* there is NULL pointer with T-bit set to 1 in the frame list
	137	* table. To avoid the issue, the frame list link pointer
	138	* should always contain a valid pointer to a inactive qh.
a85b4e7f	139	*/
1a49e2ac AS	140	if (pdev->device == 0x7808) {
	141	ehci->use_dummy_qh = 1;
	142	ehci_info(ehci, "applying AMD SB700/SB800/Hudson-2/3 EHCI dummy qh workaround\n");
7ff71d6a	143	}
abcc9448	144	break;
055b93c9 RH	145	case PCI_VENDOR_ID_VIA:
	146	if (pdev->device == 0x3104 && (pdev->revision & 0xf0) == 0x60) {
	147	u8 tmp;
	148
	149	/* The VT6212 defaults to a 1 usec EHCI sleep time which
	150	* hogs the PCI bus badly. Setting bit 5 of 0x4B makes
	151	* that sleep time use the conventional 10 usec.
	152	*/
	153	pci_read_config_byte(pdev, 0x4b, &tmp);
	154	if (tmp & 0x20)
	155	break;
	156	pci_write_config_byte(pdev, 0x4b, tmp \| 0x20);
	157	}
	158	break;
b09bc6cb	159	case PCI_VENDOR_ID_ATI:
ad93562b AX	160	/* AMD PLL quirk */
	161	if (usb_amd_find_chipset_info())
	162	ehci->amd_pll_fix = 1;
1a49e2ac AS	163
	164	/*
	165	* EHCI controller on AMD SB700/SB800/Hudson-2/3 platforms may
	166	* read/write memory space which does not belong to it when
	167	* there is NULL pointer with T-bit set to 1 in the frame list
	168	* table. To avoid the issue, the frame list link pointer
	169	* should always contain a valid pointer to a inactive qh.
	170	*/
	171	if (pdev->device == 0x4396) {
	172	ehci->use_dummy_qh = 1;
	173	ehci_info(ehci, "applying AMD SB700/SB800/Hudson-2/3 EHCI dummy qh workaround\n");
	174	}
0a99e8ac	175	/* SB600 and old version of SB700 have a bug in EHCI controller,
b09bc6cb AX	176	* which causes usb devices lose response in some cases.
b09bc6cb AX	177	*/
0a99e8ac	178	if ((pdev->device == 0x4386) \|\| (pdev->device == 0x4396)) {
b09bc6cb AX	179	p_smbus = pci_get_device(PCI_VENDOR_ID_ATI,
	180	PCI_DEVICE_ID_ATI_SBX00_SMBUS,
	181	NULL);
	182	if (!p_smbus)
	183	break;
	184	rev = p_smbus->revision;
0a99e8ac SH	185	if ((pdev->device == 0x4386) \|\| (rev == 0x3a)
0a99e8ac SH	186	\|\| (rev == 0x3b)) {
b09bc6cb	187	u8 tmp;
0a99e8ac SH	188	ehci_info(ehci, "applying AMD SB600/SB700 USB "
0a99e8ac SH	189	"freeze workaround\n");
b09bc6cb AX	190	pci_read_config_byte(pdev, 0x53, &tmp);
	191	pci_write_config_byte(pdev, 0x53, tmp \| (1<<3));
	192	}
	193	pci_dev_put(p_smbus);
	194	}
	195	break;
68aa95d5 AS	196	case PCI_VENDOR_ID_NETMOS:
	197	/* MosChip frame-index-register bug */
	198	ehci_info(ehci, "applying MosChip frame-index workaround\n");
	199	ehci->frame_index_bug = 1;
	200	break;
abcc9448	201	}
7ff71d6a	202
75e1a2ae JB	203	/* optional debug port, normally in the first BAR */
	204	temp = pci_find_capability(pdev, PCI_CAP_ID_DBG);
	205	if (temp) {
	206	pci_read_config_dword(pdev, temp, &temp);
	207	temp >>= 16;
	208	if (((temp >> 13) & 7) == 1) {
	209	u32 hcs_params = ehci_readl(ehci,
	210	&ehci->caps->hcs_params);
	211
	212	temp &= 0x1fff;
	213	ehci->debug = hcd->regs + temp;
	214	temp = ehci_readl(ehci, &ehci->debug->control);
	215	ehci_info(ehci, "debug port %d%s\n",
	216	HCS_DEBUG_PORT(hcs_params),
	217	(temp & DBGP_ENABLED) ? " IN USE" : "");
	218	if (!(temp & DBGP_ENABLED))
	219	ehci->debug = NULL;
	220	}
	221	}
	222
1a49e2ac AS	223	retval = ehci_setup(hcd);
	224	if (retval)
	225	return retval;
	226
	227	/* These workarounds need to be applied after ehci_setup() */
	228	switch (pdev->vendor) {
	229	case PCI_VENDOR_ID_NEC:
	230	ehci->need_io_watchdog = 0;
	231	break;
	232	case PCI_VENDOR_ID_INTEL:
	233	ehci->need_io_watchdog = 0;
1a49e2ac AS	234	break;
	235	case PCI_VENDOR_ID_NVIDIA:
	236	switch (pdev->device) {
	237	/* MCP89 chips on the MacBookAir3,1 give EPROTO when
	238	* fetching device descriptors unless LPM is disabled.
	239	* There are also intermittent problems enumerating
	240	* devices with PPCD enabled.
	241	*/
	242	case 0x0d9d:
4968f951	243	ehci_info(ehci, "disable ppcd for nvidia mcp89\n");
1a49e2ac AS	244	ehci->has_ppcd = 0;
	245	ehci->command &= ~CMD_PPCEE;
	246	break;
	247	}
	248	break;
	249	}
	250
7ff71d6a MP	251	/* at least the Genesys GL880S needs fixup here */
	252	temp = HCS_N_CC(ehci->hcs_params) * HCS_N_PCC(ehci->hcs_params);
	253	temp &= 0x0f;
	254	if (temp && HCS_N_PORTS(ehci->hcs_params) > temp) {
abcc9448	255	ehci_dbg(ehci, "bogus port configuration: "
7ff71d6a MP	256	"cc=%d x pcc=%d < ports=%d\n",
	257	HCS_N_CC(ehci->hcs_params),
	258	HCS_N_PCC(ehci->hcs_params),
	259	HCS_N_PORTS(ehci->hcs_params));
	260
abcc9448 DB	261	switch (pdev->vendor) {
	262	case 0x17a0: /* GENESYS */
	263	/* GL880S: should be PORTS=2 */
	264	temp \|= (ehci->hcs_params & ~0xf);
	265	ehci->hcs_params = temp;
	266	break;
	267	case PCI_VENDOR_ID_NVIDIA:
	268	/* NF4: should be PCC=10 */
	269	break;
7ff71d6a MP	270	}
	271	}
	272
abcc9448	273	/* Serial Bus Release Number is at PCI 0x60 offset */
3a0bac06 AR	274	if (pdev->vendor == PCI_VENDOR_ID_STMICRO
3a0bac06 AR	275	&& pdev->device == PCI_DEVICE_ID_STMICRO_USB_HOST)
1a49e2ac AS	276	; /* ConneXT has no sbrn register */
	277	else
	278	pci_read_config_byte(pdev, 0x60, &ehci->sbrn);
7ff71d6a	279
6fd9086a AS	280	/* Keep this around for a while just in case some EHCI
	281	* implementation uses legacy PCI PM support. This test
	282	* can be removed on 17 Dec 2009 if the dev_warn() hasn't
	283	* been triggered by then.
2c1c3c4c DB	284	*/
	285	if (!device_can_wakeup(&pdev->dev)) {
	286	u16 port_wake;
	287
	288	pci_read_config_word(pdev, 0x62, &port_wake);
6fd9086a AS	289	if (port_wake & 0x0001) {
6fd9086a AS	290	dev_warn(&pdev->dev, "Enabling legacy PCI PM\n");
bcca06ef	291	device_set_wakeup_capable(&pdev->dev, 1);
6fd9086a	292	}
2c1c3c4c	293	}
7ff71d6a	294
f8aeb3bb DB	295	#ifdef CONFIG_USB_SUSPEND
	296	/* REVISIT: the controller works fine for wakeup iff the root hub
	297	* itself is "globally" suspended, but usbcore currently doesn't
	298	* understand such things.
	299	*
	300	* System suspend currently expects to be able to suspend the entire
	301	* device tree, device-at-a-time. If we failed selective suspend
	302	* reports, system suspend would fail; so the root hub code must claim
411c9403	303	* success. That's lying to usbcore, and it matters for runtime
f8aeb3bb DB	304	* PM scenarios with selective suspend and remote wakeup...
	305	*/
	306	if (ehci->no_selective_suspend && device_can_wakeup(&pdev->dev))
	307	ehci_warn(ehci, "selective suspend/wakeup unavailable\n");
	308	#endif
	309
18807521	310	retval = ehci_pci_reinit(ehci, pdev);
8926bfa7 DB	311	done:
8926bfa7 DB	312	return retval;
7ff71d6a MP	313	}
	314
	315	/-------------------------------------------------------------------------/
	316
	317	#ifdef CONFIG_PM
	318
	319	/* suspend/resume, section 4.3 */
	320
f03c17fc	321	/* These routines rely on the PCI bus glue
7ff71d6a MP	322	* to handle powerdown and wakeup, and currently also on
	323	* transceivers that don't need any software attention to set up
	324	* the right sort of wakeup.
f03c17fc	325	* Also they depend on separate root hub suspend/resume.
7ff71d6a MP	326	*/
7ff71d6a MP	327
69e848c2 SS	328	static bool usb_is_intel_switchable_ehci(struct pci_dev *pdev)
	329	{
	330	return pdev->class == PCI_CLASS_SERIAL_USB_EHCI &&
	331	pdev->vendor == PCI_VENDOR_ID_INTEL &&
1c12443a SS	332	(pdev->device == 0x1E26 \|\|
1c12443a SS	333	pdev->device == 0x8C2D \|\|
bb1e5dd7 RW	334	pdev->device == 0x8C26 \|\|
bb1e5dd7 RW	335	pdev->device == 0x9C26);
69e848c2 SS	336	}
	337
	338	static void ehci_enable_xhci_companion(void)
	339	{
	340	struct pci_dev *companion = NULL;
	341
	342	/* The xHCI and EHCI controllers are not on the same PCI slot */
	343	for_each_pci_dev(companion) {
	344	if (!usb_is_intel_switchable_xhci(companion))
	345	continue;
	346	usb_enable_xhci_ports(companion);
	347	return;
	348	}
	349	}
	350
6ec4beb5	351	static int ehci_pci_resume(struct usb_hcd *hcd, bool hibernated)
7ff71d6a	352	{
abcc9448	353	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
18807521	354	struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
7ff71d6a	355
69e848c2 SS	356	/* The BIOS on systems with the Intel Panther Point chipset may or may
	357	* not support xHCI natively. That means that during system resume, it
	358	* may switch the ports back to EHCI so that users can use their
	359	* keyboard to select a kernel from GRUB after resume from hibernate.
	360	*
	361	* The BIOS is supposed to remember whether the OS had xHCI ports
	362	* enabled before resume, and switch the ports back to xHCI when the
	363	* BIOS/OS semaphore is written, but we all know we can't trust BIOS
	364	* writers.
	365	*
	366	* Unconditionally switch the ports back to xHCI after a system resume.
	367	* We can't tell whether the EHCI or xHCI controller will be resumed
	368	* first, so we have to do the port switchover in both drivers. Writing
	369	* a '1' to the port switchover registers should have no effect if the
	370	* port was already switched over.
	371	*/
	372	if (usb_is_intel_switchable_ehci(pdev))
	373	ehci_enable_xhci_companion();
	374
c5cf9212 AS	375	if (ehci_resume(hcd, hibernated) != 0)
c5cf9212 AS	376	(void) ehci_pci_reinit(ehci, pdev);
8c03356a	377	return 0;
7ff71d6a	378	}
7ff71d6a	379
adfa79d1	380	#else
7ff71d6a	381
adfa79d1 AS	382	#define ehci_suspend NULL
	383	#define ehci_pci_resume NULL
	384	#endif /* CONFIG_PM */
7ff71d6a	385
adfa79d1	386	static struct hc_driver __read_mostly ehci_pci_hc_driver;
7ff71d6a	387
1b36810e	388	static const struct ehci_driver_overrides pci_overrides __initdata = {
adfa79d1	389	.reset = ehci_pci_setup,
7ff71d6a MP	390	};
	391
	392	/-------------------------------------------------------------------------/
	393
	394	/* PCI driver selection metadata; PCI hotplugging uses this */
	395	static const struct pci_device_id pci_ids [] = { {
	396	/* handle any USB 2.0 EHCI controller */
c67808ee	397	PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_EHCI, ~0),
7ff71d6a	398	.driver_data = (unsigned long) &ehci_pci_hc_driver,
3a0bac06 AR	399	}, {
	400	PCI_VDEVICE(STMICRO, PCI_DEVICE_ID_STMICRO_USB_HOST),
	401	.driver_data = (unsigned long) &ehci_pci_hc_driver,
7ff71d6a MP	402	},
	403	{ /* end: all zeroes */ }
	404	};
abcc9448	405	MODULE_DEVICE_TABLE(pci, pci_ids);
7ff71d6a MP	406
	407	/* pci driver glue; this is a "new style" PCI driver module */
	408	static struct pci_driver ehci_pci_driver = {
	409	.name = (char *) hcd_name,
	410	.id_table = pci_ids,
	411
	412	.probe = usb_hcd_pci_probe,
	413	.remove = usb_hcd_pci_remove,
abb30641	414	.shutdown = usb_hcd_pci_shutdown,
7ff71d6a	415
abb30641 AS	416	#ifdef CONFIG_PM_SLEEP
	417	.driver = {
	418	.pm = &usb_hcd_pci_pm_ops
	419	},
7ff71d6a MP	420	#endif
7ff71d6a MP	421	};
adfa79d1 AS	422
	423	static int __init ehci_pci_init(void)
	424	{
	425	if (usb_disabled())
	426	return -ENODEV;
	427
	428	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
	429
1b36810e	430	ehci_init_driver(&ehci_pci_hc_driver, &pci_overrides);
adfa79d1 AS	431
	432	/* Entries for the PCI suspend/resume callbacks are special */
	433	ehci_pci_hc_driver.pci_suspend = ehci_suspend;
	434	ehci_pci_hc_driver.pci_resume = ehci_pci_resume;
	435
	436	return pci_register_driver(&ehci_pci_driver);
	437	}
	438	module_init(ehci_pci_init);
	439
	440	static void __exit ehci_pci_cleanup(void)
	441	{
	442	pci_unregister_driver(&ehci_pci_driver);
	443	}
	444	module_exit(ehci_pci_cleanup);
	445
	446	MODULE_DESCRIPTION(DRIVER_DESC);
	447	MODULE_AUTHOR("David Brownell");
	448	MODULE_AUTHOR("Alan Stern");
	449	MODULE_LICENSE("GPL");