[deliverable/linux.git] / drivers / usb / core / hcd-pci.c

/*
 * (C) Copyright David Brownell 2000-2002
 *
 * 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 <asm/io.h>
#include <asm/irq.h>

#ifdef CONFIG_PPC_PMAC
#include <asm/machdep.h>
#include <asm/pmac_feature.h>
#include <asm/pci-bridge.h>
#include <asm/prom.h>
#endif

#include "usb.h"


/* PCI-based HCs are common, but plenty of non-PCI HCs are used too */

#ifdef CONFIG_PM_SLEEP

/* Coordinate handoffs between EHCI and companion controllers
 * during system resume
 */

static DEFINE_MUTEX(companions_mutex);

#define CL_UHCI		PCI_CLASS_SERIAL_USB_UHCI
#define CL_OHCI		PCI_CLASS_SERIAL_USB_OHCI
#define CL_EHCI		PCI_CLASS_SERIAL_USB_EHCI

enum companion_action {
	SET_HS_COMPANION, CLEAR_HS_COMPANION, WAIT_FOR_COMPANIONS
};

static void companion_common(struct pci_dev *pdev, struct usb_hcd *hcd,
		enum companion_action action)
{
	struct pci_dev		*companion;
	struct usb_hcd		*companion_hcd;
	unsigned int		slot = PCI_SLOT(pdev->devfn);

	/* Iterate through other PCI functions in the same slot.
	 * If pdev is OHCI or UHCI then we are looking for EHCI, and
	 * vice versa.
	 */
	companion = NULL;
	for_each_pci_dev(companion) {
		if (companion->bus != pdev->bus ||
				PCI_SLOT(companion->devfn) != slot)
			continue;

		companion_hcd = pci_get_drvdata(companion);
		if (!companion_hcd)
			continue;

		/* For SET_HS_COMPANION, store a pointer to the EHCI bus in
		 * the OHCI/UHCI companion bus structure.
		 * For CLEAR_HS_COMPANION, clear the pointer to the EHCI bus
		 * in the OHCI/UHCI companion bus structure.
		 * For WAIT_FOR_COMPANIONS, wait until the OHCI/UHCI
		 * companion controllers have fully resumed.
		 */

		if ((pdev->class == CL_OHCI || pdev->class == CL_UHCI) &&
				companion->class == CL_EHCI) {
			/* action must be SET_HS_COMPANION */
			dev_dbg(&companion->dev, "HS companion for %s\n",
					dev_name(&pdev->dev));
			hcd->self.hs_companion = &companion_hcd->self;

		} else if (pdev->class == CL_EHCI &&
				(companion->class == CL_OHCI ||
				companion->class == CL_UHCI)) {
			switch (action) {
			case SET_HS_COMPANION:
				dev_dbg(&pdev->dev, "HS companion for %s\n",
						dev_name(&companion->dev));
				companion_hcd->self.hs_companion = &hcd->self;
				break;
			case CLEAR_HS_COMPANION:
				companion_hcd->self.hs_companion = NULL;
				break;
			case WAIT_FOR_COMPANIONS:
				device_pm_wait_for_dev(&pdev->dev,
						&companion->dev);
				break;
			}
		}
	}
}

static void set_hs_companion(struct pci_dev *pdev, struct usb_hcd *hcd)
{
	mutex_lock(&companions_mutex);
	dev_set_drvdata(&pdev->dev, hcd);
	companion_common(pdev, hcd, SET_HS_COMPANION);
	mutex_unlock(&companions_mutex);
}

static void clear_hs_companion(struct pci_dev *pdev, struct usb_hcd *hcd)
{
	mutex_lock(&companions_mutex);
	dev_set_drvdata(&pdev->dev, NULL);

	/* If pdev is OHCI or UHCI, just clear its hs_companion pointer */
	if (pdev->class == CL_OHCI || pdev->class == CL_UHCI)
		hcd->self.hs_companion = NULL;

	/* Otherwise search for companion buses and clear their pointers */
	else
		companion_common(pdev, hcd, CLEAR_HS_COMPANION);
	mutex_unlock(&companions_mutex);
}

static void wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd)
{
	/* Only EHCI controllers need to wait.
	 * No locking is needed because a controller cannot be resumed
	 * while one of its companions is getting unbound.
	 */
	if (pdev->class == CL_EHCI)
		companion_common(pdev, hcd, WAIT_FOR_COMPANIONS);
}

#else /* !CONFIG_PM_SLEEP */

static inline void set_hs_companion(struct pci_dev *d, struct usb_hcd *h) {}
static inline void clear_hs_companion(struct pci_dev *d, struct usb_hcd *h) {}
static inline void wait_for_companions(struct pci_dev *d, struct usb_hcd *h) {}

#endif /* !CONFIG_PM_SLEEP */

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

/* configure so an HC device and id are always provided */
/* always called with process context; sleeping is OK */

/**
 * usb_hcd_pci_probe - initialize PCI-based HCDs
 * @dev: USB Host Controller being probed
 * @id: pci hotplug id connecting controller to HCD framework
 * Context: !in_interrupt()
 *
 * Allocates basic PCI resources for this USB host controller, and
 * then invokes the start() method for the HCD associated with it
 * through the hotplug entry's driver_data.
 *
 * Store this function in the HCD's struct pci_driver as probe().
 */
int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
{
	struct hc_driver	*driver;
	struct usb_hcd		*hcd;
	int			retval;

	if (usb_disabled())
		return -ENODEV;

	if (!id)
		return -EINVAL;
	driver = (struct hc_driver *)id->driver_data;
	if (!driver)
		return -EINVAL;

	if (pci_enable_device(dev) < 0)
		return -ENODEV;
	dev->current_state = PCI_D0;

	if (!dev->irq) {
		dev_err(&dev->dev,
			"Found HC with no IRQ.  Check BIOS/PCI %s setup!\n",
			pci_name(dev));
		retval = -ENODEV;
		goto err1;
	}

	hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
	if (!hcd) {
		retval = -ENOMEM;
		goto err1;
	}

	if (driver->flags & HCD_MEMORY) {
		/* EHCI, OHCI */
		hcd->rsrc_start = pci_resource_start(dev, 0);
		hcd->rsrc_len = pci_resource_len(dev, 0);
		if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
				driver->description)) {
			dev_dbg(&dev->dev, "controller already in use\n");
			retval = -EBUSY;
			goto err2;
		}
		hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
		if (hcd->regs == NULL) {
			dev_dbg(&dev->dev, "error mapping memory\n");
			retval = -EFAULT;
			goto err3;
		}

	} else {
		/* UHCI */
		int	region;

		for (region = 0; region < PCI_ROM_RESOURCE; region++) {
			if (!(pci_resource_flags(dev, region) &
					IORESOURCE_IO))
				continue;

			hcd->rsrc_start = pci_resource_start(dev, region);
			hcd->rsrc_len = pci_resource_len(dev, region);
			if (request_region(hcd->rsrc_start, hcd->rsrc_len,
					driver->description))
				break;
		}
		if (region == PCI_ROM_RESOURCE) {
			dev_dbg(&dev->dev, "no i/o regions available\n");
			retval = -EBUSY;
			goto err2;
		}
	}

	pci_set_master(dev);

	retval = usb_add_hcd(hcd, dev->irq, IRQF_DISABLED | IRQF_SHARED);
	if (retval != 0)
		goto err4;
	set_hs_companion(dev, hcd);

	if (pci_dev_run_wake(dev))
		pm_runtime_put_noidle(&dev->dev);
	return retval;

 err4:
	if (driver->flags & HCD_MEMORY) {
		iounmap(hcd->regs);
 err3:
		release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	} else
		release_region(hcd->rsrc_start, hcd->rsrc_len);
 err2:
	clear_hs_companion(dev, hcd);
	usb_put_hcd(hcd);
 err1:
	pci_disable_device(dev);
	dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
	return retval;
}
EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);


/* may be called without controller electrically present */
/* may be called with controller, bus, and devices active */

/**
 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
 * @dev: USB Host Controller being removed
 * Context: !in_interrupt()
 *
 * Reverses the effect of usb_hcd_pci_probe(), first invoking
 * the HCD's stop() method.  It is always called from a thread
 * context, normally "rmmod", "apmd", or something similar.
 *
 * Store this function in the HCD's struct pci_driver as remove().
 */
void usb_hcd_pci_remove(struct pci_dev *dev)
{
	struct usb_hcd		*hcd;

	hcd = pci_get_drvdata(dev);
	if (!hcd)
		return;

	if (pci_dev_run_wake(dev))
		pm_runtime_get_noresume(&dev->dev);

	/* Fake an interrupt request in order to give the driver a chance
	 * to test whether the controller hardware has been removed (e.g.,
	 * cardbus physical eject).
	 */
	local_irq_disable();
	usb_hcd_irq(0, hcd);
	local_irq_enable();

	usb_remove_hcd(hcd);
	if (hcd->driver->flags & HCD_MEMORY) {
		iounmap(hcd->regs);
		release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	} else {
		release_region(hcd->rsrc_start, hcd->rsrc_len);
	}
	clear_hs_companion(dev, hcd);
	usb_put_hcd(hcd);
	pci_disable_device(dev);
}
EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);

/**
 * usb_hcd_pci_shutdown - shutdown host controller
 * @dev: USB Host Controller being shutdown
 */
void usb_hcd_pci_shutdown(struct pci_dev *dev)
{
	struct usb_hcd		*hcd;

	hcd = pci_get_drvdata(dev);
	if (!hcd)
		return;

	if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
			hcd->driver->shutdown) {
		hcd->driver->shutdown(hcd);
		pci_disable_device(dev);
	}
}
EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);

#ifdef	CONFIG_PM_OPS

#ifdef	CONFIG_PPC_PMAC
static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
{
	/* Enanble or disable ASIC clocks for USB */
	if (machine_is(powermac)) {
		struct device_node	*of_node;

		of_node = pci_device_to_OF_node(pci_dev);
		if (of_node)
			pmac_call_feature(PMAC_FTR_USB_ENABLE,
					of_node, 0, enable);
	}
}

#else

static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
{}

#endif	/* CONFIG_PPC_PMAC */

static int check_root_hub_suspended(struct device *dev)
{
	struct pci_dev		*pci_dev = to_pci_dev(dev);
	struct usb_hcd		*hcd = pci_get_drvdata(pci_dev);

	if (!(hcd->state == HC_STATE_SUSPENDED ||
			hcd->state == HC_STATE_HALT)) {
		dev_warn(dev, "Root hub is not suspended\n");
		return -EBUSY;
	}
	return 0;
}

static int suspend_common(struct device *dev, bool do_wakeup)
{
	struct pci_dev		*pci_dev = to_pci_dev(dev);
	struct usb_hcd		*hcd = pci_get_drvdata(pci_dev);
	int			retval;

	/* Root hub suspend should have stopped all downstream traffic,
	 * and all bus master traffic.  And done so for both the interface
	 * and the stub usb_device (which we check here).  But maybe it
	 * didn't; writing sysfs power/state files ignores such rules...
	 */
	retval = check_root_hub_suspended(dev);
	if (retval)
		return retval;

	if (hcd->driver->pci_suspend) {
		/* Optimization: Don't suspend if a root-hub wakeup is
		 * pending and it would cause the HCD to wake up anyway.
		 */
		if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
			return -EBUSY;
		retval = hcd->driver->pci_suspend(hcd, do_wakeup);
		suspend_report_result(hcd->driver->pci_suspend, retval);

		/* Check again in case wakeup raced with pci_suspend */
		if (retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) {
			if (hcd->driver->pci_resume)
				hcd->driver->pci_resume(hcd, false);
			retval = -EBUSY;
		}
		if (retval)
			return retval;
	}

	/* If MSI-X is enabled, the driver will have synchronized all vectors
	 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
	 * synchronized here.
	 */
	if (!hcd->msix_enabled)
		synchronize_irq(pci_dev->irq);

	/* Downstream ports from this root hub should already be quiesced, so
	 * there will be no DMA activity.  Now we can shut down the upstream
	 * link (except maybe for PME# resume signaling).  We'll enter a
	 * low power state during suspend_noirq, if the hardware allows.
	 */
	pci_disable_device(pci_dev);
	return retval;
}

static int resume_common(struct device *dev, int event)
{
	struct pci_dev		*pci_dev = to_pci_dev(dev);
	struct usb_hcd		*hcd = pci_get_drvdata(pci_dev);
	int			retval;

	if (hcd->state != HC_STATE_SUSPENDED) {
		dev_dbg(dev, "can't resume, not suspended!\n");
		return 0;
	}

	retval = pci_enable_device(pci_dev);
	if (retval < 0) {
		dev_err(dev, "can't re-enable after resume, %d!\n", retval);
		return retval;
	}

	pci_set_master(pci_dev);

	clear_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);

	if (hcd->driver->pci_resume) {
		if (event != PM_EVENT_AUTO_RESUME)
			wait_for_companions(pci_dev, hcd);

		retval = hcd->driver->pci_resume(hcd,
				event == PM_EVENT_RESTORE);
		if (retval) {
			dev_err(dev, "PCI post-resume error %d!\n", retval);
			usb_hc_died(hcd);
		}
	}
	return retval;
}

#ifdef	CONFIG_PM_SLEEP

static int hcd_pci_suspend(struct device *dev)
{
	return suspend_common(dev, device_may_wakeup(dev));
}

static int hcd_pci_suspend_noirq(struct device *dev)
{
	struct pci_dev		*pci_dev = to_pci_dev(dev);
	struct usb_hcd		*hcd = pci_get_drvdata(pci_dev);
	int			retval;

	retval = check_root_hub_suspended(dev);
	if (retval)
		return retval;

	pci_save_state(pci_dev);

	/* If the root hub is HALTed rather than SUSPENDed,
	 * disallow remote wakeup.
	 */
	if (hcd->state == HC_STATE_HALT)
		device_set_wakeup_enable(dev, 0);
	dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));

	/* Possibly enable remote wakeup,
	 * choose the appropriate low-power state, and go to that state.
	 */
	retval = pci_prepare_to_sleep(pci_dev);
	if (retval == -EIO) {		/* Low-power not supported */
		dev_dbg(dev, "--> PCI D0 legacy\n");
		retval = 0;
	} else if (retval == 0) {
		dev_dbg(dev, "--> PCI %s\n",
				pci_power_name(pci_dev->current_state));
	} else {
		suspend_report_result(pci_prepare_to_sleep, retval);
		return retval;
	}

	powermac_set_asic(pci_dev, 0);
	return retval;
}

static int hcd_pci_resume_noirq(struct device *dev)
{
	struct pci_dev		*pci_dev = to_pci_dev(dev);

	powermac_set_asic(pci_dev, 1);

	/* Go back to D0 and disable remote wakeup */
	pci_back_from_sleep(pci_dev);
	return 0;
}

static int hcd_pci_resume(struct device *dev)
{
	return resume_common(dev, PM_EVENT_RESUME);
}

static int hcd_pci_restore(struct device *dev)
{
	return resume_common(dev, PM_EVENT_RESTORE);
}

#else

#define hcd_pci_suspend		NULL
#define hcd_pci_suspend_noirq	NULL
#define hcd_pci_resume_noirq	NULL
#define hcd_pci_resume		NULL
#define hcd_pci_restore		NULL

#endif	/* CONFIG_PM_SLEEP */

#ifdef	CONFIG_PM_RUNTIME

static int hcd_pci_runtime_suspend(struct device *dev)
{
	int	retval;

	retval = suspend_common(dev, true);
	if (retval == 0)
		powermac_set_asic(to_pci_dev(dev), 0);
	dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
	return retval;
}

static int hcd_pci_runtime_resume(struct device *dev)
{
	int	retval;

	powermac_set_asic(to_pci_dev(dev), 1);
	retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
	dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
	return retval;
}

#else

#define hcd_pci_runtime_suspend	NULL
#define hcd_pci_runtime_resume	NULL

#endif	/* CONFIG_PM_RUNTIME */

const struct dev_pm_ops usb_hcd_pci_pm_ops = {
	.suspend	= hcd_pci_suspend,
	.suspend_noirq	= hcd_pci_suspend_noirq,
	.resume_noirq	= hcd_pci_resume_noirq,
	.resume		= hcd_pci_resume,
	.freeze		= check_root_hub_suspended,
	.freeze_noirq	= check_root_hub_suspended,
	.thaw_noirq	= NULL,
	.thaw		= NULL,
	.poweroff	= hcd_pci_suspend,
	.poweroff_noirq	= hcd_pci_suspend_noirq,
	.restore_noirq	= hcd_pci_resume_noirq,
	.restore	= hcd_pci_restore,
	.runtime_suspend = hcd_pci_runtime_suspend,
	.runtime_resume	= hcd_pci_runtime_resume,
};
EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);

#endif	/* CONFIG_PM_OPS */
Commit	Line	Data
1da177e4 LT	1	/*
1da177e4 LT	2	* (C) Copyright David Brownell 2000-2002
34bbe4c1	3	*
1da177e4 LT	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU General Public License as published by the
	6	* Free Software Foundation; either version 2 of the License, or (at your
	7	* option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful, but
	10	* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
	11	* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	12	* for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software Foundation,
	16	* Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	17	*/
	18
1da177e4 LT	19	#include <linux/kernel.h>
	20	#include <linux/module.h>
	21	#include <linux/pci.h>
21b1861f	22	#include <linux/usb.h>
27729aad	23	#include <linux/usb/hcd.h>
21b1861f	24
1da177e4 LT	25	#include <asm/io.h>
1da177e4 LT	26	#include <asm/irq.h>
21b1861f DB	27
	28	#ifdef CONFIG_PPC_PMAC
	29	#include <asm/machdep.h>
	30	#include <asm/pmac_feature.h>
	31	#include <asm/pci-bridge.h>
	32	#include <asm/prom.h>
	33	#endif
5f827ea3 DB	34
5f827ea3 DB	35	#include "usb.h"
1da177e4 LT	36
1da177e4 LT	37
c6053ecf	38	/* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
1da177e4	39
6d19c009 AS	40	#ifdef CONFIG_PM_SLEEP
	41
	42	/* Coordinate handoffs between EHCI and companion controllers
	43	* during system resume
	44	*/
	45
	46	static DEFINE_MUTEX(companions_mutex);
	47
	48	#define CL_UHCI PCI_CLASS_SERIAL_USB_UHCI
	49	#define CL_OHCI PCI_CLASS_SERIAL_USB_OHCI
	50	#define CL_EHCI PCI_CLASS_SERIAL_USB_EHCI
	51
	52	enum companion_action {
	53	SET_HS_COMPANION, CLEAR_HS_COMPANION, WAIT_FOR_COMPANIONS
	54	};
	55
	56	static void companion_common(struct pci_dev pdev, struct usb_hcd hcd,
	57	enum companion_action action)
	58	{
	59	struct pci_dev *companion;
	60	struct usb_hcd *companion_hcd;
	61	unsigned int slot = PCI_SLOT(pdev->devfn);
	62
	63	/* Iterate through other PCI functions in the same slot.
	64	* If pdev is OHCI or UHCI then we are looking for EHCI, and
	65	* vice versa.
	66	*/
	67	companion = NULL;
402e8dd6	68	for_each_pci_dev(companion) {
6d19c009 AS	69	if (companion->bus != pdev->bus \|\|
	70	PCI_SLOT(companion->devfn) != slot)
	71	continue;
	72
	73	companion_hcd = pci_get_drvdata(companion);
	74	if (!companion_hcd)
	75	continue;
	76
	77	/* For SET_HS_COMPANION, store a pointer to the EHCI bus in
	78	* the OHCI/UHCI companion bus structure.
	79	* For CLEAR_HS_COMPANION, clear the pointer to the EHCI bus
	80	* in the OHCI/UHCI companion bus structure.
	81	* For WAIT_FOR_COMPANIONS, wait until the OHCI/UHCI
	82	* companion controllers have fully resumed.
	83	*/
	84
	85	if ((pdev->class == CL_OHCI \|\| pdev->class == CL_UHCI) &&
	86	companion->class == CL_EHCI) {
	87	/* action must be SET_HS_COMPANION */
	88	dev_dbg(&companion->dev, "HS companion for %s\n",
	89	dev_name(&pdev->dev));
	90	hcd->self.hs_companion = &companion_hcd->self;
	91
	92	} else if (pdev->class == CL_EHCI &&
	93	(companion->class == CL_OHCI \|\|
	94	companion->class == CL_UHCI)) {
	95	switch (action) {
	96	case SET_HS_COMPANION:
	97	dev_dbg(&pdev->dev, "HS companion for %s\n",
	98	dev_name(&companion->dev));
	99	companion_hcd->self.hs_companion = &hcd->self;
	100	break;
	101	case CLEAR_HS_COMPANION:
	102	companion_hcd->self.hs_companion = NULL;
	103	break;
	104	case WAIT_FOR_COMPANIONS:
	105	device_pm_wait_for_dev(&pdev->dev,
	106	&companion->dev);
	107	break;
	108	}
	109	}
	110	}
	111	}
	112
	113	static void set_hs_companion(struct pci_dev pdev, struct usb_hcd hcd)
	114	{
	115	mutex_lock(&companions_mutex);
	116	dev_set_drvdata(&pdev->dev, hcd);
	117	companion_common(pdev, hcd, SET_HS_COMPANION);
	118	mutex_unlock(&companions_mutex);
	119	}
	120
	121	static void clear_hs_companion(struct pci_dev pdev, struct usb_hcd hcd)
	122	{
	123	mutex_lock(&companions_mutex);
	124	dev_set_drvdata(&pdev->dev, NULL);
	125
	126	/* If pdev is OHCI or UHCI, just clear its hs_companion pointer */
	127	if (pdev->class == CL_OHCI \|\| pdev->class == CL_UHCI)
	128	hcd->self.hs_companion = NULL;
	129
	130	/* Otherwise search for companion buses and clear their pointers */
	131	else
	132	companion_common(pdev, hcd, CLEAR_HS_COMPANION);
133	mutex_unlock(&companions_mutex);
134	}
135
136	static void wait_for_companions(struct pci_dev pdev, struct usb_hcd hcd)
137	{
138	/* Only EHCI controllers need to wait.
139	* No locking is needed because a controller cannot be resumed
140	* while one of its companions is getting unbound.
141	*/
142	if (pdev->class == CL_EHCI)
143	companion_common(pdev, hcd, WAIT_FOR_COMPANIONS);
144	}
145
146	#else /* !CONFIG_PM_SLEEP */
147
148	static inline void set_hs_companion(struct pci_dev d, struct usb_hcd h) {}
149	static inline void clear_hs_companion(struct pci_dev d, struct usb_hcd h) {}
150	static inline void wait_for_companions(struct pci_dev d, struct usb_hcd h) {}
151
152	#endif /* !CONFIG_PM_SLEEP */
1da177e4 LT	153
	154	/-------------------------------------------------------------------------/
	155
	156	/* configure so an HC device and id are always provided */
	157	/* always called with process context; sleeping is OK */
	158
	159	/**
	160	* usb_hcd_pci_probe - initialize PCI-based HCDs
	161	* @dev: USB Host Controller being probed
	162	* @id: pci hotplug id connecting controller to HCD framework
	163	* Context: !in_interrupt()
	164	*
	165	* Allocates basic PCI resources for this USB host controller, and
	166	* then invokes the start() method for the HCD associated with it
	167	* through the hotplug entry's driver_data.
	168	*
	169	* Store this function in the HCD's struct pci_driver as probe().
	170	*/
34bbe4c1	171	int usb_hcd_pci_probe(struct pci_dev dev, const struct pci_device_id id)
1da177e4 LT	172	{
	173	struct hc_driver *driver;
	174	struct usb_hcd *hcd;
	175	int retval;
	176
	177	if (usb_disabled())
	178	return -ENODEV;
	179
34bbe4c1 GKH	180	if (!id)
	181	return -EINVAL;
	182	driver = (struct hc_driver *)id->driver_data;
	183	if (!driver)
1da177e4 LT	184	return -EINVAL;
1da177e4 LT	185
34bbe4c1	186	if (pci_enable_device(dev) < 0)
1da177e4	187	return -ENODEV;
c6053ecf	188	dev->current_state = PCI_D0;
34bbe4c1 GKH	189
	190	if (!dev->irq) {
	191	dev_err(&dev->dev,
1da177e4 LT	192	"Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
1da177e4 LT	193	pci_name(dev));
34bbe4c1	194	retval = -ENODEV;
1da177e4	195	goto err1;
34bbe4c1	196	}
1da177e4	197
34bbe4c1	198	hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
1da177e4 LT	199	if (!hcd) {
	200	retval = -ENOMEM;
	201	goto err1;
	202	}
	203
34bbe4c1 GKH	204	if (driver->flags & HCD_MEMORY) {
	205	/* EHCI, OHCI */
	206	hcd->rsrc_start = pci_resource_start(dev, 0);
	207	hcd->rsrc_len = pci_resource_len(dev, 0);
	208	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
1da177e4	209	driver->description)) {
34bbe4c1	210	dev_dbg(&dev->dev, "controller already in use\n");
1da177e4 LT	211	retval = -EBUSY;
	212	goto err2;
	213	}
34bbe4c1	214	hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
1da177e4	215	if (hcd->regs == NULL) {
34bbe4c1	216	dev_dbg(&dev->dev, "error mapping memory\n");
1da177e4 LT	217	retval = -EFAULT;
	218	goto err3;
	219	}
	220
34bbe4c1 GKH	221	} else {
34bbe4c1 GKH	222	/* UHCI */
1da177e4 LT	223	int region;
	224
	225	for (region = 0; region < PCI_ROM_RESOURCE; region++) {
34bbe4c1	226	if (!(pci_resource_flags(dev, region) &
1da177e4 LT	227	IORESOURCE_IO))
	228	continue;
	229
34bbe4c1 GKH	230	hcd->rsrc_start = pci_resource_start(dev, region);
	231	hcd->rsrc_len = pci_resource_len(dev, region);
	232	if (request_region(hcd->rsrc_start, hcd->rsrc_len,
1da177e4 LT	233	driver->description))
	234	break;
	235	}
	236	if (region == PCI_ROM_RESOURCE) {
34bbe4c1	237	dev_dbg(&dev->dev, "no i/o regions available\n");
1da177e4	238	retval = -EBUSY;
6d19c009	239	goto err2;
1da177e4 LT	240	}
	241	}
	242
34bbe4c1	243	pci_set_master(dev);
1da177e4	244
442258e2	245	retval = usb_add_hcd(hcd, dev->irq, IRQF_DISABLED \| IRQF_SHARED);
1da177e4 LT	246	if (retval != 0)
1da177e4 LT	247	goto err4;
6d19c009	248	set_hs_companion(dev, hcd);
3da7cff4 AS	249
	250	if (pci_dev_run_wake(dev))
	251	pm_runtime_put_noidle(&dev->dev);
1da177e4 LT	252	return retval;
	253
	254	err4:
	255	if (driver->flags & HCD_MEMORY) {
34bbe4c1	256	iounmap(hcd->regs);
1da177e4	257	err3:
34bbe4c1	258	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
1da177e4	259	} else
34bbe4c1	260	release_region(hcd->rsrc_start, hcd->rsrc_len);
1da177e4	261	err2:
6d19c009	262	clear_hs_companion(dev, hcd);
34bbe4c1	263	usb_put_hcd(hcd);
1da177e4	264	err1:
34bbe4c1 GKH	265	pci_disable_device(dev);
34bbe4c1 GKH	266	dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
1da177e4	267	return retval;
34bbe4c1	268	}
782e70c6	269	EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
1da177e4 LT	270
	271
	272	/* may be called without controller electrically present */
	273	/* may be called with controller, bus, and devices active */
	274
	275	/**
	276	* usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
	277	* @dev: USB Host Controller being removed
	278	* Context: !in_interrupt()
	279	*
	280	* Reverses the effect of usb_hcd_pci_probe(), first invoking
	281	* the HCD's stop() method. It is always called from a thread
	282	* context, normally "rmmod", "apmd", or something similar.
	283	*
	284	* Store this function in the HCD's struct pci_driver as remove().
	285	*/
34bbe4c1	286	void usb_hcd_pci_remove(struct pci_dev *dev)
1da177e4 LT	287	{
	288	struct usb_hcd *hcd;
	289
	290	hcd = pci_get_drvdata(dev);
	291	if (!hcd)
	292	return;
	293
3da7cff4 AS	294	if (pci_dev_run_wake(dev))
	295	pm_runtime_get_noresume(&dev->dev);
	296
c548795a AS	297	/* Fake an interrupt request in order to give the driver a chance
	298	* to test whether the controller hardware has been removed (e.g.,
	299	* cardbus physical eject).
	300	*/
	301	local_irq_disable();
	302	usb_hcd_irq(0, hcd);
	303	local_irq_enable();
	304
34bbe4c1	305	usb_remove_hcd(hcd);
1da177e4	306	if (hcd->driver->flags & HCD_MEMORY) {
34bbe4c1 GKH	307	iounmap(hcd->regs);
34bbe4c1 GKH	308	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
1da177e4	309	} else {
34bbe4c1	310	release_region(hcd->rsrc_start, hcd->rsrc_len);
1da177e4	311	}
6d19c009	312	clear_hs_companion(dev, hcd);
34bbe4c1	313	usb_put_hcd(hcd);
1da177e4 LT	314	pci_disable_device(dev);
1da177e4 LT	315	}
782e70c6	316	EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
1da177e4	317
1da177e4	318	/**
abb30641 AS	319	* usb_hcd_pci_shutdown - shutdown host controller
abb30641 AS	320	* @dev: USB Host Controller being shutdown
1da177e4	321	*/
abb30641 AS	322	void usb_hcd_pci_shutdown(struct pci_dev *dev)
	323	{
	324	struct usb_hcd *hcd;
	325
	326	hcd = pci_get_drvdata(dev);
	327	if (!hcd)
	328	return;
	329
3da7cff4	330	if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
3df7169e	331	hcd->driver->shutdown) {
abb30641	332	hcd->driver->shutdown(hcd);
3df7169e AS	333	pci_disable_device(dev);
3df7169e AS	334	}
abb30641 AS	335	}
	336	EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
	337
3da7cff4	338	#ifdef CONFIG_PM_OPS
abb30641	339
2138a1f1 AS	340	#ifdef CONFIG_PPC_PMAC
	341	static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
	342	{
	343	/* Enanble or disable ASIC clocks for USB */
	344	if (machine_is(powermac)) {
	345	struct device_node *of_node;
	346
	347	of_node = pci_device_to_OF_node(pci_dev);
	348	if (of_node)
	349	pmac_call_feature(PMAC_FTR_USB_ENABLE,
	350	of_node, 0, enable);
	351	}
	352	}
	353
	354	#else
	355
	356	static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
	357	{}
	358
	359	#endif /* CONFIG_PPC_PMAC */
	360
abb30641 AS	361	static int check_root_hub_suspended(struct device *dev)
	362	{
	363	struct pci_dev *pci_dev = to_pci_dev(dev);
	364	struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
	365
	366	if (!(hcd->state == HC_STATE_SUSPENDED \|\|
	367	hcd->state == HC_STATE_HALT)) {
	368	dev_warn(dev, "Root hub is not suspended\n");
	369	return -EBUSY;
	370	}
	371	return 0;
	372	}
	373
3da7cff4	374	static int suspend_common(struct device *dev, bool do_wakeup)
1da177e4	375	{
abb30641 AS	376	struct pci_dev *pci_dev = to_pci_dev(dev);
	377	struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
	378	int retval;
1da177e4	379
5f827ea3 DB	380	/* Root hub suspend should have stopped all downstream traffic,
	381	* and all bus master traffic. And done so for both the interface
	382	* and the stub usb_device (which we check here). But maybe it
	383	* didn't; writing sysfs power/state files ignores such rules...
5f827ea3	384	*/
abb30641 AS	385	retval = check_root_hub_suspended(dev);
	386	if (retval)
	387	return retval;
a0d4922d	388
7be7d741	389	if (hcd->driver->pci_suspend) {
ff2f0787 AS	390	/* Optimization: Don't suspend if a root-hub wakeup is
	391	* pending and it would cause the HCD to wake up anyway.
	392	*/
	393	if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
	394	return -EBUSY;
4147200d	395	retval = hcd->driver->pci_suspend(hcd, do_wakeup);
7be7d741	396	suspend_report_result(hcd->driver->pci_suspend, retval);
ff2f0787 AS	397
	398	/* Check again in case wakeup raced with pci_suspend */
	399	if (retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) {
	400	if (hcd->driver->pci_resume)
	401	hcd->driver->pci_resume(hcd, false);
	402	retval = -EBUSY;
	403	}
02669492	404	if (retval)
abb30641	405	return retval;
5f827ea3 DB	406	}
5f827ea3 DB	407
0029227f AX	408	/* If MSI-X is enabled, the driver will have synchronized all vectors
	409	* in pci_suspend(). If MSI or legacy PCI is enabled, that will be
	410	* synchronized here.
	411	*/
	412	if (!hcd->msix_enabled)
	413	synchronize_irq(pci_dev->irq);
c6053ecf	414
a15d95a0 RW	415	/* Downstream ports from this root hub should already be quiesced, so
a15d95a0 RW	416	* there will be no DMA activity. Now we can shut down the upstream
abb30641 AS	417	* link (except maybe for PME# resume signaling). We'll enter a
abb30641 AS	418	* low power state during suspend_noirq, if the hardware allows.
a15d95a0	419	*/
abb30641 AS	420	pci_disable_device(pci_dev);
	421	return retval;
	422	}
	423
057c58bf AS	424	static int resume_common(struct device *dev, int event)
	425	{
	426	struct pci_dev *pci_dev = to_pci_dev(dev);
	427	struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
	428	int retval;
	429
	430	if (hcd->state != HC_STATE_SUSPENDED) {
	431	dev_dbg(dev, "can't resume, not suspended!\n");
	432	return 0;
	433	}
	434
	435	retval = pci_enable_device(pci_dev);
	436	if (retval < 0) {
	437	dev_err(dev, "can't re-enable after resume, %d!\n", retval);
	438	return retval;
	439	}
	440
	441	pci_set_master(pci_dev);
	442
	443	clear_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
	444
	445	if (hcd->driver->pci_resume) {
3da7cff4 AS	446	if (event != PM_EVENT_AUTO_RESUME)
3da7cff4 AS	447	wait_for_companions(pci_dev, hcd);
057c58bf AS	448
	449	retval = hcd->driver->pci_resume(hcd,
	450	event == PM_EVENT_RESTORE);
	451	if (retval) {
	452	dev_err(dev, "PCI post-resume error %d!\n", retval);
	453	usb_hc_died(hcd);
	454	}
	455	}
	456	return retval;
	457	}
	458
3da7cff4 AS	459	#ifdef CONFIG_PM_SLEEP
	460
	461	static int hcd_pci_suspend(struct device *dev)
	462	{
	463	return suspend_common(dev, device_may_wakeup(dev));
	464	}
	465
abb30641 AS	466	static int hcd_pci_suspend_noirq(struct device *dev)
	467	{
	468	struct pci_dev *pci_dev = to_pci_dev(dev);
	469	struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
	470	int retval;
	471
	472	retval = check_root_hub_suspended(dev);
	473	if (retval)
	474	return retval;
a15d95a0	475
abb30641	476	pci_save_state(pci_dev);
a15d95a0	477
abb30641 AS	478	/* If the root hub is HALTed rather than SUSPENDed,
abb30641 AS	479	* disallow remote wakeup.
1da177e4	480	*/
abb30641 AS	481	if (hcd->state == HC_STATE_HALT)
	482	device_set_wakeup_enable(dev, 0);
	483	dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
a0d4922d	484
abb30641 AS	485	/* Possibly enable remote wakeup,
	486	* choose the appropriate low-power state, and go to that state.
	487	*/
	488	retval = pci_prepare_to_sleep(pci_dev);
	489	if (retval == -EIO) { /* Low-power not supported */
	490	dev_dbg(dev, "--> PCI D0 legacy\n");
	491	retval = 0;
	492	} else if (retval == 0) {
	493	dev_dbg(dev, "--> PCI %s\n",
	494	pci_power_name(pci_dev->current_state));
a0d4922d	495	} else {
abb30641 AS	496	suspend_report_result(pci_prepare_to_sleep, retval);
abb30641 AS	497	return retval;
1da177e4 LT	498	}
1da177e4 LT	499
2138a1f1	500	powermac_set_asic(pci_dev, 0);
1da177e4 LT	501	return retval;
1da177e4 LT	502	}
1da177e4	503
abb30641	504	static int hcd_pci_resume_noirq(struct device *dev)
a0d4922d	505	{
abb30641	506	struct pci_dev *pci_dev = to_pci_dev(dev);
a0d4922d	507
2138a1f1	508	powermac_set_asic(pci_dev, 1);
a15d95a0	509
abb30641 AS	510	/* Go back to D0 and disable remote wakeup */
	511	pci_back_from_sleep(pci_dev);
	512	return 0;
	513	}
	514
abb30641	515	static int hcd_pci_resume(struct device *dev)
64a21d02	516	{
057c58bf	517	return resume_common(dev, PM_EVENT_RESUME);
abb30641	518	}
64a21d02	519
abb30641 AS	520	static int hcd_pci_restore(struct device *dev)
abb30641 AS	521	{
057c58bf	522	return resume_common(dev, PM_EVENT_RESTORE);
64a21d02	523	}
1da177e4	524
3da7cff4 AS	525	#else
	526
	527	#define hcd_pci_suspend NULL
	528	#define hcd_pci_suspend_noirq NULL
	529	#define hcd_pci_resume_noirq NULL
	530	#define hcd_pci_resume NULL
	531	#define hcd_pci_restore NULL
	532
	533	#endif /* CONFIG_PM_SLEEP */
	534
	535	#ifdef CONFIG_PM_RUNTIME
	536
	537	static int hcd_pci_runtime_suspend(struct device *dev)
	538	{
	539	int retval;
	540
	541	retval = suspend_common(dev, true);
	542	if (retval == 0)
	543	powermac_set_asic(to_pci_dev(dev), 0);
	544	dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
	545	return retval;
	546	}
	547
	548	static int hcd_pci_runtime_resume(struct device *dev)
	549	{
	550	int retval;
	551
	552	powermac_set_asic(to_pci_dev(dev), 1);
	553	retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
	554	dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
	555	return retval;
	556	}
	557
	558	#else
	559
	560	#define hcd_pci_runtime_suspend NULL
	561	#define hcd_pci_runtime_resume NULL
	562
	563	#endif /* CONFIG_PM_RUNTIME */
	564
47145210	565	const struct dev_pm_ops usb_hcd_pci_pm_ops = {
abb30641 AS	566	.suspend = hcd_pci_suspend,
	567	.suspend_noirq = hcd_pci_suspend_noirq,
	568	.resume_noirq = hcd_pci_resume_noirq,
	569	.resume = hcd_pci_resume,
	570	.freeze = check_root_hub_suspended,
	571	.freeze_noirq = check_root_hub_suspended,
	572	.thaw_noirq = NULL,
	573	.thaw = NULL,
	574	.poweroff = hcd_pci_suspend,
	575	.poweroff_noirq = hcd_pci_suspend_noirq,
	576	.restore_noirq = hcd_pci_resume_noirq,
	577	.restore = hcd_pci_restore,
3da7cff4 AS	578	.runtime_suspend = hcd_pci_runtime_suspend,
3da7cff4 AS	579	.runtime_resume = hcd_pci_runtime_resume,
abb30641 AS	580	};
	581	EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
	582
3da7cff4	583	#endif /* CONFIG_PM_OPS */