[mirror_ubuntu-zesty-kernel.git] / drivers / usb / host / ohci-at91.c

/*
 * OHCI HCD (Host Controller Driver) for USB.
 *
 *  Copyright (C) 2004 SAN People (Pty) Ltd.
 *  Copyright (C) 2005 Thibaut VARENE <varenet@parisc-linux.org>
 *
 * AT91 Bus Glue
 *
 * Based on fragments of 2.4 driver by Rick Bronson.
 * Based on ohci-omap.c
 *
 * This file is licenced under the GPL.
 */

#include <linux/clk.h>
#include <linux/platform_device.h>

#include <mach/hardware.h>
#include <asm/gpio.h>

#include <mach/board.h>
#include <mach/cpu.h>

#ifndef CONFIG_ARCH_AT91
#error "CONFIG_ARCH_AT91 must be defined."
#endif

/* interface and function clocks; sometimes also an AHB clock */
static struct clk *iclk, *fclk, *hclk;
static int clocked;

extern int usb_disabled(void);

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

static void at91_start_clock(void)
{
	clk_enable(hclk);
	clk_enable(iclk);
	clk_enable(fclk);
	clocked = 1;
}

static void at91_stop_clock(void)
{
	clk_disable(fclk);
	clk_disable(iclk);
	clk_disable(hclk);
	clocked = 0;
}

static void at91_start_hc(struct platform_device *pdev)
{
	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	struct ohci_regs __iomem *regs = hcd->regs;

	dev_dbg(&pdev->dev, "start\n");

	/*
	 * Start the USB clocks.
	 */
	at91_start_clock();

	/*
	 * The USB host controller must remain in reset.
	 */
	writel(0, &regs->control);
}

static void at91_stop_hc(struct platform_device *pdev)
{
	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	struct ohci_regs __iomem *regs = hcd->regs;

	dev_dbg(&pdev->dev, "stop\n");

	/*
	 * Put the USB host controller into reset.
	 */
	writel(0, &regs->control);

	/*
	 * Stop the USB clocks.
	 */
	at91_stop_clock();
}


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

static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);

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


/**
 * usb_hcd_at91_probe - initialize AT91-based HCDs
 * Context: !in_interrupt()
 *
 * Allocates basic 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.
 */
static int usb_hcd_at91_probe(const struct hc_driver *driver,
			struct platform_device *pdev)
{
	int retval;
	struct usb_hcd *hcd = NULL;

	if (pdev->num_resources != 2) {
		pr_debug("hcd probe: invalid num_resources");
		return -ENODEV;
	}

	if ((pdev->resource[0].flags != IORESOURCE_MEM)
			|| (pdev->resource[1].flags != IORESOURCE_IRQ)) {
		pr_debug("hcd probe: invalid resource type\n");
		return -ENODEV;
	}

	hcd = usb_create_hcd(driver, &pdev->dev, "at91");
	if (!hcd)
		return -ENOMEM;
	hcd->rsrc_start = pdev->resource[0].start;
	hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;

	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
		pr_debug("request_mem_region failed\n");
		retval = -EBUSY;
		goto err1;
	}

	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
	if (!hcd->regs) {
		pr_debug("ioremap failed\n");
		retval = -EIO;
		goto err2;
	}

	iclk = clk_get(&pdev->dev, "ohci_clk");
	if (IS_ERR(iclk)) {
		dev_err(&pdev->dev, "failed to get ohci_clk\n");
		retval = PTR_ERR(iclk);
		goto err3;
	}
	fclk = clk_get(&pdev->dev, "uhpck");
	if (IS_ERR(fclk)) {
		dev_err(&pdev->dev, "failed to get uhpck\n");
		retval = PTR_ERR(fclk);
		goto err4;
	}
	hclk = clk_get(&pdev->dev, "hclk");
	if (IS_ERR(hclk)) {
		dev_err(&pdev->dev, "failed to get hclk\n");
		retval = PTR_ERR(hclk);
		goto err5;
	}

	at91_start_hc(pdev);
	ohci_hcd_init(hcd_to_ohci(hcd));

	retval = usb_add_hcd(hcd, pdev->resource[1].start, IRQF_SHARED);
	if (retval == 0)
		return retval;

	/* Error handling */
	at91_stop_hc(pdev);

	clk_put(hclk);
 err5:
	clk_put(fclk);
 err4:
	clk_put(iclk);

 err3:
	iounmap(hcd->regs);

 err2:
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);

 err1:
	usb_put_hcd(hcd);
	return retval;
}


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

/**
 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
 * @dev: USB Host Controller being removed
 * Context: !in_interrupt()
 *
 * Reverses the effect of usb_hcd_at91_probe(), first invoking
 * the HCD's stop() method.  It is always called from a thread
 * context, "rmmod" or something similar.
 *
 */
static void usb_hcd_at91_remove(struct usb_hcd *hcd,
				struct platform_device *pdev)
{
	usb_remove_hcd(hcd);
	at91_stop_hc(pdev);
	iounmap(hcd->regs);
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	usb_put_hcd(hcd);

	clk_put(hclk);
	clk_put(fclk);
	clk_put(iclk);
	fclk = iclk = hclk = NULL;

	dev_set_drvdata(&pdev->dev, NULL);
}

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

static int __devinit
ohci_at91_start (struct usb_hcd *hcd)
{
	struct at91_usbh_data	*board = hcd->self.controller->platform_data;
	struct ohci_hcd		*ohci = hcd_to_ohci (hcd);
	int			ret;

	if ((ret = ohci_init(ohci)) < 0)
		return ret;

	ohci->num_ports = board->ports;

	if ((ret = ohci_run(ohci)) < 0) {
		err("can't start %s", hcd->self.bus_name);
		ohci_stop(hcd);
		return ret;
	}
	return 0;
}

static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
{
	if (port < 0 || port >= 2)
		return;

	if (!gpio_is_valid(pdata->vbus_pin[port]))
		return;

	gpio_set_value(pdata->vbus_pin[port],
		       !pdata->vbus_pin_active_low[port] ^ enable);
}

static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
{
	if (port < 0 || port >= 2)
		return -EINVAL;

	if (!gpio_is_valid(pdata->vbus_pin[port]))
		return -EINVAL;

	return gpio_get_value(pdata->vbus_pin[port]) ^
		!pdata->vbus_pin_active_low[port];
}

/*
 * Update the status data from the hub with the over-current indicator change.
 */
static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
{
	struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
	int length = ohci_hub_status_data(hcd, buf);
	int port;

	for (port = 0; port < ARRAY_SIZE(pdata->overcurrent_pin); port++) {
		if (pdata->overcurrent_changed[port]) {
			if (! length)
				length = 1;
			buf[0] |= 1 << (port + 1);
		}
	}

	return length;
}

/*
 * Look at the control requests to the root hub and see if we need to override.
 */
static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
				 u16 wIndex, char *buf, u16 wLength)
{
	struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
	struct usb_hub_descriptor *desc;
	int ret = -EINVAL;
	u32 *data = (u32 *)buf;

	dev_dbg(hcd->self.controller,
		"ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
		hcd, typeReq, wValue, wIndex, buf, wLength);

	switch (typeReq) {
	case SetPortFeature:
		if (wValue == USB_PORT_FEAT_POWER) {
			dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
			ohci_at91_usb_set_power(pdata, wIndex - 1, 1);
			goto out;
		}
		break;

	case ClearPortFeature:
		switch (wValue) {
		case USB_PORT_FEAT_C_OVER_CURRENT:
			dev_dbg(hcd->self.controller,
				"ClearPortFeature: C_OVER_CURRENT\n");

			if (wIndex == 1 || wIndex == 2) {
				pdata->overcurrent_changed[wIndex-1] = 0;
				pdata->overcurrent_status[wIndex-1] = 0;
			}

			goto out;

		case USB_PORT_FEAT_OVER_CURRENT:
			dev_dbg(hcd->self.controller,
				"ClearPortFeature: OVER_CURRENT\n");

			if (wIndex == 1 || wIndex == 2) {
				pdata->overcurrent_status[wIndex-1] = 0;
			}

			goto out;

		case USB_PORT_FEAT_POWER:
			dev_dbg(hcd->self.controller,
				"ClearPortFeature: POWER\n");

			if (wIndex == 1 || wIndex == 2) {
				ohci_at91_usb_set_power(pdata, wIndex - 1, 0);
				return 0;
			}
		}
		break;
	}

	ret = ohci_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
	if (ret)
		goto out;

	switch (typeReq) {
	case GetHubDescriptor:

		/* update the hub's descriptor */

		desc = (struct usb_hub_descriptor *)buf;

		dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
			desc->wHubCharacteristics);

		/* remove the old configurations for power-switching, and
		 * over-current protection, and insert our new configuration
		 */

		desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
		desc->wHubCharacteristics |= cpu_to_le16(0x0001);

		if (pdata->overcurrent_supported) {
			desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
			desc->wHubCharacteristics |=  cpu_to_le16(0x0008|0x0001);
		}

		dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
			desc->wHubCharacteristics);

		return ret;

	case GetPortStatus:
		/* check port status */

		dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);

		if (wIndex == 1 || wIndex == 2) {
			if (! ohci_at91_usb_get_power(pdata, wIndex-1)) {
				*data &= ~cpu_to_le32(RH_PS_PPS);
			}

			if (pdata->overcurrent_changed[wIndex-1]) {
				*data |= cpu_to_le32(RH_PS_OCIC);
			}

			if (pdata->overcurrent_status[wIndex-1]) {
				*data |= cpu_to_le32(RH_PS_POCI);
			}
		}
	}

 out:
	return ret;
}

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

static const struct hc_driver ohci_at91_hc_driver = {
	.description =		hcd_name,
	.product_desc =		"AT91 OHCI",
	.hcd_priv_size =	sizeof(struct ohci_hcd),

	/*
	 * generic hardware linkage
	 */
	.irq =			ohci_irq,
	.flags =		HCD_USB11 | HCD_MEMORY,

	/*
	 * basic lifecycle operations
	 */
	.start =		ohci_at91_start,
	.stop =			ohci_stop,
	.shutdown =		ohci_shutdown,

	/*
	 * managing i/o requests and associated device resources
	 */
	.urb_enqueue =		ohci_urb_enqueue,
	.urb_dequeue =		ohci_urb_dequeue,
	.endpoint_disable =	ohci_endpoint_disable,

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

	/*
	 * root hub support
	 */
	.hub_status_data =	ohci_at91_hub_status_data,
	.hub_control =		ohci_at91_hub_control,
#ifdef CONFIG_PM
	.bus_suspend =		ohci_bus_suspend,
	.bus_resume =		ohci_bus_resume,
#endif
	.start_port_reset =	ohci_start_port_reset,
};

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

static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
{
	struct platform_device *pdev = data;
	struct at91_usbh_data *pdata = pdev->dev.platform_data;
	int val, gpio, port;

	/* From the GPIO notifying the over-current situation, find
	 * out the corresponding port */
	gpio = irq_to_gpio(irq);
	for (port = 0; port < ARRAY_SIZE(pdata->overcurrent_pin); port++) {
		if (pdata->overcurrent_pin[port] == gpio)
			break;
	}

	if (port == ARRAY_SIZE(pdata->overcurrent_pin)) {
		dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
		return IRQ_HANDLED;
	}

	val = gpio_get_value(gpio);

	/* When notified of an over-current situation, disable power
	   on the corresponding port, and mark this port in
	   over-current. */
	if (! val) {
		ohci_at91_usb_set_power(pdata, port, 0);
		pdata->overcurrent_status[port]  = 1;
		pdata->overcurrent_changed[port] = 1;
	}

	dev_dbg(& pdev->dev, "overcurrent situation %s\n",
		val ? "exited" : "notified");

	return IRQ_HANDLED;
}

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

static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
{
	struct at91_usbh_data	*pdata = pdev->dev.platform_data;
	int			i;

	if (pdata) {
		for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
			if (!gpio_is_valid(pdata->vbus_pin[i]))
				continue;
			gpio_request(pdata->vbus_pin[i], "ohci_vbus");
			ohci_at91_usb_set_power(pdata, i, 1);
		}

		for (i = 0; i < ARRAY_SIZE(pdata->overcurrent_pin); i++) {
			int ret;

			if (!gpio_is_valid(pdata->overcurrent_pin[i]))
				continue;
			gpio_request(pdata->overcurrent_pin[i], "ohci_overcurrent");

			ret = request_irq(gpio_to_irq(pdata->overcurrent_pin[i]),
					  ohci_hcd_at91_overcurrent_irq,
					  IRQF_SHARED, "ohci_overcurrent", pdev);
			if (ret) {
				gpio_free(pdata->overcurrent_pin[i]);
				dev_warn(& pdev->dev, "cannot get GPIO IRQ for overcurrent\n");
			}
		}
	}

	device_init_wakeup(&pdev->dev, 1);
	return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
}

static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
{
	struct at91_usbh_data	*pdata = pdev->dev.platform_data;
	int			i;

	if (pdata) {
		for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
			if (!gpio_is_valid(pdata->vbus_pin[i]))
				continue;
			ohci_at91_usb_set_power(pdata, i, 0);
			gpio_free(pdata->vbus_pin[i]);
		}

		for (i = 0; i < ARRAY_SIZE(pdata->overcurrent_pin); i++) {
			if (!gpio_is_valid(pdata->overcurrent_pin[i]))
				continue;
			free_irq(gpio_to_irq(pdata->overcurrent_pin[i]), pdev);
			gpio_free(pdata->overcurrent_pin[i]);
		}
	}

	device_init_wakeup(&pdev->dev, 0);
	usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
	return 0;
}

#ifdef CONFIG_PM

static int
ohci_hcd_at91_drv_suspend(struct platform_device *pdev, pm_message_t mesg)
{
	struct usb_hcd	*hcd = platform_get_drvdata(pdev);
	struct ohci_hcd	*ohci = hcd_to_ohci(hcd);

	if (device_may_wakeup(&pdev->dev))
		enable_irq_wake(hcd->irq);

	/*
	 * The integrated transceivers seem unable to notice disconnect,
	 * reconnect, or wakeup without the 48 MHz clock active.  so for
	 * correctness, always discard connection state (using reset).
	 *
	 * REVISIT: some boards will be able to turn VBUS off...
	 */
	if (at91_suspend_entering_slow_clock()) {
		ohci_usb_reset (ohci);
		/* flush the writes */
		(void) ohci_readl (ohci, &ohci->regs->control);
		at91_stop_clock();
	}

	return 0;
}

static int ohci_hcd_at91_drv_resume(struct platform_device *pdev)
{
	struct usb_hcd	*hcd = platform_get_drvdata(pdev);

	if (device_may_wakeup(&pdev->dev))
		disable_irq_wake(hcd->irq);

	if (!clocked)
		at91_start_clock();

	ohci_finish_controller_resume(hcd);
	return 0;
}
#else
#define ohci_hcd_at91_drv_suspend NULL
#define ohci_hcd_at91_drv_resume  NULL
#endif

MODULE_ALIAS("platform:at91_ohci");

static struct platform_driver ohci_hcd_at91_driver = {
	.probe		= ohci_hcd_at91_drv_probe,
	.remove		= ohci_hcd_at91_drv_remove,
	.shutdown	= usb_hcd_platform_shutdown,
	.suspend	= ohci_hcd_at91_drv_suspend,
	.resume		= ohci_hcd_at91_drv_resume,
	.driver		= {
		.name	= "at91_ohci",
		.owner	= THIS_MODULE,
	},
};
Commit	Line	Data
39a269c0 AV	1	/*
	2	* OHCI HCD (Host Controller Driver) for USB.
	3	*
	4	* Copyright (C) 2004 SAN People (Pty) Ltd.
	5	* Copyright (C) 2005 Thibaut VARENE <varenet@parisc-linux.org>
	6	*
0365ee0a	7	* AT91 Bus Glue
39a269c0 AV	8	*
	9	* Based on fragments of 2.4 driver by Rick Bronson.
	10	* Based on ohci-omap.c
	11	*
	12	* This file is licenced under the GPL.
	13	*/
	14
	15	#include <linux/clk.h>
	16	#include <linux/platform_device.h>
	17
a09e64fb	18	#include <mach/hardware.h>
4bde4a4c DB	19	#include <asm/gpio.h>
4bde4a4c DB	20
a09e64fb RK	21	#include <mach/board.h>
a09e64fb RK	22	#include <mach/cpu.h>
39a269c0	23
0365ee0a DB	24	#ifndef CONFIG_ARCH_AT91
0365ee0a DB	25	#error "CONFIG_ARCH_AT91 must be defined."
39a269c0 AV	26	#endif
39a269c0 AV	27
ed077bb7 AV	28	/* interface and function clocks; sometimes also an AHB clock */
ed077bb7 AV	29	static struct clk iclk, fclk, *hclk;
0365ee0a	30	static int clocked;
39a269c0 AV	31
	32	extern int usb_disabled(void);
	33
	34	/-------------------------------------------------------------------------/
	35
ed077bb7 AV	36	static void at91_start_clock(void)
ed077bb7 AV	37	{
0af4316b	38	clk_enable(hclk);
ed077bb7 AV	39	clk_enable(iclk);
	40	clk_enable(fclk);
	41	clocked = 1;
	42	}
	43
	44	static void at91_stop_clock(void)
	45	{
	46	clk_disable(fclk);
	47	clk_disable(iclk);
0af4316b	48	clk_disable(hclk);
ed077bb7 AV	49	clocked = 0;
	50	}
	51
39a269c0 AV	52	static void at91_start_hc(struct platform_device *pdev)
	53	{
	54	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	55	struct ohci_regs __iomem *regs = hcd->regs;
	56
0365ee0a	57	dev_dbg(&pdev->dev, "start\n");
39a269c0 AV	58
	59	/*
	60	* Start the USB clocks.
	61	*/
ed077bb7	62	at91_start_clock();
39a269c0 AV	63
	64	/*
	65	* The USB host controller must remain in reset.
	66	*/
	67	writel(0, &regs->control);
	68	}
	69
	70	static void at91_stop_hc(struct platform_device *pdev)
	71	{
	72	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	73	struct ohci_regs __iomem *regs = hcd->regs;
	74
0365ee0a	75	dev_dbg(&pdev->dev, "stop\n");
39a269c0 AV	76
	77	/*
	78	* Put the USB host controller into reset.
	79	*/
	80	writel(0, &regs->control);
	81
	82	/*
	83	* Stop the USB clocks.
	84	*/
ed077bb7	85	at91_stop_clock();
39a269c0 AV	86	}
	87
	88
	89	/-------------------------------------------------------------------------/
	90
421b4bf5	91	static void usb_hcd_at91_remove (struct usb_hcd , struct platform_device );
39a269c0 AV	92
	93	/* configure so an HC device and id are always provided */
	94	/* always called with process context; sleeping is OK */
	95
	96
	97	/**
0365ee0a	98	* usb_hcd_at91_probe - initialize AT91-based HCDs
39a269c0 AV	99	* Context: !in_interrupt()
	100	*
	101	* Allocates basic resources for this USB host controller, and
	102	* then invokes the start() method for the HCD associated with it
	103	* through the hotplug entry's driver_data.
39a269c0	104	*/
0365ee0a DB	105	static int usb_hcd_at91_probe(const struct hc_driver *driver,
0365ee0a DB	106	struct platform_device *pdev)
39a269c0 AV	107	{
	108	int retval;
	109	struct usb_hcd *hcd = NULL;
	110
	111	if (pdev->num_resources != 2) {
	112	pr_debug("hcd probe: invalid num_resources");
	113	return -ENODEV;
	114	}
	115
0365ee0a DB	116	if ((pdev->resource[0].flags != IORESOURCE_MEM)
0365ee0a DB	117	\|\| (pdev->resource[1].flags != IORESOURCE_IRQ)) {
39a269c0 AV	118	pr_debug("hcd probe: invalid resource type\n");
	119	return -ENODEV;
	120	}
	121
0365ee0a	122	hcd = usb_create_hcd(driver, &pdev->dev, "at91");
39a269c0 AV	123	if (!hcd)
	124	return -ENOMEM;
	125	hcd->rsrc_start = pdev->resource[0].start;
	126	hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
	127
	128	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
	129	pr_debug("request_mem_region failed\n");
	130	retval = -EBUSY;
	131	goto err1;
	132	}
	133
	134	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
	135	if (!hcd->regs) {
	136	pr_debug("ioremap failed\n");
	137	retval = -EIO;
	138	goto err2;
	139	}
	140
	141	iclk = clk_get(&pdev->dev, "ohci_clk");
6813463c JCPV	142	if (IS_ERR(iclk)) {
	143	dev_err(&pdev->dev, "failed to get ohci_clk\n");
	144	retval = PTR_ERR(iclk);
	145	goto err3;
	146	}
39a269c0	147	fclk = clk_get(&pdev->dev, "uhpck");
6813463c JCPV	148	if (IS_ERR(fclk)) {
	149	dev_err(&pdev->dev, "failed to get uhpck\n");
	150	retval = PTR_ERR(fclk);
	151	goto err4;
	152	}
0af4316b	153	hclk = clk_get(&pdev->dev, "hclk");
6813463c JCPV	154	if (IS_ERR(hclk)) {
	155	dev_err(&pdev->dev, "failed to get hclk\n");
	156	retval = PTR_ERR(hclk);
	157	goto err5;
	158	}
39a269c0 AV	159
	160	at91_start_hc(pdev);
	161	ohci_hcd_init(hcd_to_ohci(hcd));
	162
2f2cac3c	163	retval = usb_add_hcd(hcd, pdev->resource[1].start, IRQF_SHARED);
39a269c0 AV	164	if (retval == 0)
	165	return retval;
	166
	167	/* Error handling */
	168	at91_stop_hc(pdev);
	169
0af4316b	170	clk_put(hclk);
6813463c	171	err5:
39a269c0	172	clk_put(fclk);
6813463c	173	err4:
39a269c0 AV	174	clk_put(iclk);
39a269c0 AV	175
6813463c	176	err3:
39a269c0 AV	177	iounmap(hcd->regs);
	178
	179	err2:
	180	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	181
	182	err1:
	183	usb_put_hcd(hcd);
	184	return retval;
	185	}
	186
	187
39a269c0 AV	188	/* may be called with controller, bus, and devices active */
	189
	190	/**
0365ee0a	191	* usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
39a269c0 AV	192	* @dev: USB Host Controller being removed
	193	* Context: !in_interrupt()
	194	*
	195	* Reverses the effect of usb_hcd_at91_probe(), first invoking
	196	* the HCD's stop() method. It is always called from a thread
0365ee0a	197	* context, "rmmod" or something similar.
39a269c0 AV	198	*
39a269c0 AV	199	*/
421b4bf5	200	static void usb_hcd_at91_remove(struct usb_hcd *hcd,
0365ee0a	201	struct platform_device *pdev)
39a269c0 AV	202	{
	203	usb_remove_hcd(hcd);
	204	at91_stop_hc(pdev);
	205	iounmap(hcd->regs);
68ba61b8	206	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
421b4bf5	207	usb_put_hcd(hcd);
39a269c0	208
0af4316b	209	clk_put(hclk);
68ba61b8 DB	210	clk_put(fclk);
68ba61b8 DB	211	clk_put(iclk);
ed077bb7	212	fclk = iclk = hclk = NULL;
39a269c0 AV	213
39a269c0 AV	214	dev_set_drvdata(&pdev->dev, NULL);
39a269c0 AV	215	}
	216
	217	/-------------------------------------------------------------------------/
	218
	219	static int __devinit
	220	ohci_at91_start (struct usb_hcd *hcd)
	221	{
0365ee0a	222	struct at91_usbh_data *board = hcd->self.controller->platform_data;
39a269c0 AV	223	struct ohci_hcd *ohci = hcd_to_ohci (hcd);
	224	int ret;
	225
	226	if ((ret = ohci_init(ohci)) < 0)
	227	return ret;
	228
cd22afda	229	ohci->num_ports = board->ports;
0365ee0a	230
39a269c0 AV	231	if ((ret = ohci_run(ohci)) < 0) {
	232	err("can't start %s", hcd->self.bus_name);
	233	ohci_stop(hcd);
	234	return ret;
	235	}
39a269c0 AV	236	return 0;
	237	}
	238
aa6e52a3 TP	239	static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
	240	{
	241	if (port < 0 \|\| port >= 2)
	242	return;
	243
8a7a49d1	244	if (!gpio_is_valid(pdata->vbus_pin[port]))
770f0baa JCPV	245	return;
770f0baa JCPV	246
8134ff55 JCPV	247	gpio_set_value(pdata->vbus_pin[port],
8134ff55 JCPV	248	!pdata->vbus_pin_active_low[port] ^ enable);
aa6e52a3 TP	249	}
	250
	251	static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
	252	{
	253	if (port < 0 \|\| port >= 2)
	254	return -EINVAL;
	255
8a7a49d1	256	if (!gpio_is_valid(pdata->vbus_pin[port]))
770f0baa JCPV	257	return -EINVAL;
770f0baa JCPV	258
8134ff55 JCPV	259	return gpio_get_value(pdata->vbus_pin[port]) ^
8134ff55 JCPV	260	!pdata->vbus_pin_active_low[port];
aa6e52a3 TP	261	}
	262
	263	/*
	264	* Update the status data from the hub with the over-current indicator change.
	265	*/
	266	static int ohci_at91_hub_status_data(struct usb_hcd hcd, char buf)
	267	{
	268	struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
	269	int length = ohci_hub_status_data(hcd, buf);
	270	int port;
	271
	272	for (port = 0; port < ARRAY_SIZE(pdata->overcurrent_pin); port++) {
	273	if (pdata->overcurrent_changed[port]) {
	274	if (! length)
	275	length = 1;
	276	buf[0] \|= 1 << (port + 1);
	277	}
	278	}
	279
	280	return length;
	281	}
	282
	283	/*
	284	* Look at the control requests to the root hub and see if we need to override.
	285	*/
	286	static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
	287	u16 wIndex, char *buf, u16 wLength)
	288	{
	289	struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
	290	struct usb_hub_descriptor *desc;
	291	int ret = -EINVAL;
	292	u32 data = (u32 )buf;
	293
	294	dev_dbg(hcd->self.controller,
	295	"ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
	296	hcd, typeReq, wValue, wIndex, buf, wLength);
	297
	298	switch (typeReq) {
	299	case SetPortFeature:
	300	if (wValue == USB_PORT_FEAT_POWER) {
	301	dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
	302	ohci_at91_usb_set_power(pdata, wIndex - 1, 1);
	303	goto out;
	304	}
	305	break;
	306
	307	case ClearPortFeature:
	308	switch (wValue) {
	309	case USB_PORT_FEAT_C_OVER_CURRENT:
	310	dev_dbg(hcd->self.controller,
	311	"ClearPortFeature: C_OVER_CURRENT\n");
	312
	313	if (wIndex == 1 \|\| wIndex == 2) {
	314	pdata->overcurrent_changed[wIndex-1] = 0;
	315	pdata->overcurrent_status[wIndex-1] = 0;
	316	}
	317
	318	goto out;
	319
	320	case USB_PORT_FEAT_OVER_CURRENT:
	321	dev_dbg(hcd->self.controller,
	322	"ClearPortFeature: OVER_CURRENT\n");
	323
	324	if (wIndex == 1 \|\| wIndex == 2) {
325	pdata->overcurrent_status[wIndex-1] = 0;
326	}
327
328	goto out;
329
330	case USB_PORT_FEAT_POWER:
331	dev_dbg(hcd->self.controller,
332	"ClearPortFeature: POWER\n");
333
334	if (wIndex == 1 \|\| wIndex == 2) {
335	ohci_at91_usb_set_power(pdata, wIndex - 1, 0);
336	return 0;
337	}
338	}
339	break;
340	}
341
342	ret = ohci_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
343	if (ret)
344	goto out;
345
346	switch (typeReq) {
347	case GetHubDescriptor:
348
349	/* update the hub's descriptor */
350
351	desc = (struct usb_hub_descriptor *)buf;
352
353	dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
354	desc->wHubCharacteristics);
355
356	/* remove the old configurations for power-switching, and
357	* over-current protection, and insert our new configuration
358	*/
359
360	desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
361	desc->wHubCharacteristics \|= cpu_to_le16(0x0001);
362
363	if (pdata->overcurrent_supported) {
364	desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
365	desc->wHubCharacteristics \|= cpu_to_le16(0x0008\|0x0001);
366	}
367
368	dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
369	desc->wHubCharacteristics);
370
371	return ret;
372
373	case GetPortStatus:
374	/* check port status */
375
376	dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
377
378	if (wIndex == 1 \|\| wIndex == 2) {
379	if (! ohci_at91_usb_get_power(pdata, wIndex-1)) {
380	*data &= ~cpu_to_le32(RH_PS_PPS);
381	}
382
383	if (pdata->overcurrent_changed[wIndex-1]) {
384	*data \|= cpu_to_le32(RH_PS_OCIC);
385	}
386
387	if (pdata->overcurrent_status[wIndex-1]) {
388	*data \|= cpu_to_le32(RH_PS_POCI);
389	}
390	}
391	}
392
393	out:
394	return ret;
395	}
396
39a269c0 AV	397	/-------------------------------------------------------------------------/
	398
	399	static const struct hc_driver ohci_at91_hc_driver = {
	400	.description = hcd_name,
0365ee0a	401	.product_desc = "AT91 OHCI",
39a269c0 AV	402	.hcd_priv_size = sizeof(struct ohci_hcd),
	403
	404	/*
	405	* generic hardware linkage
	406	*/
	407	.irq = ohci_irq,
	408	.flags = HCD_USB11 \| HCD_MEMORY,
	409
	410	/*
	411	* basic lifecycle operations
	412	*/
	413	.start = ohci_at91_start,
	414	.stop = ohci_stop,
dd9048af	415	.shutdown = ohci_shutdown,
39a269c0 AV	416
	417	/*
	418	* managing i/o requests and associated device resources
	419	*/
	420	.urb_enqueue = ohci_urb_enqueue,
	421	.urb_dequeue = ohci_urb_dequeue,
	422	.endpoint_disable = ohci_endpoint_disable,
	423
	424	/*
	425	* scheduling support
	426	*/
	427	.get_frame_number = ohci_get_frame,
	428
	429	/*
	430	* root hub support
	431	*/
aa6e52a3 TP	432	.hub_status_data = ohci_at91_hub_status_data,
aa6e52a3 TP	433	.hub_control = ohci_at91_hub_control,
39a269c0	434	#ifdef CONFIG_PM
68ba61b8 DB	435	.bus_suspend = ohci_bus_suspend,
68ba61b8 DB	436	.bus_resume = ohci_bus_resume,
39a269c0 AV	437	#endif
	438	.start_port_reset = ohci_start_port_reset,
	439	};
	440
	441	/-------------------------------------------------------------------------/
	442
aa6e52a3 TP	443	static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
	444	{
	445	struct platform_device *pdev = data;
	446	struct at91_usbh_data *pdata = pdev->dev.platform_data;
	447	int val, gpio, port;
	448
	449	/* From the GPIO notifying the over-current situation, find
	450	* out the corresponding port */
	451	gpio = irq_to_gpio(irq);
	452	for (port = 0; port < ARRAY_SIZE(pdata->overcurrent_pin); port++) {
	453	if (pdata->overcurrent_pin[port] == gpio)
	454	break;
	455	}
	456
	457	if (port == ARRAY_SIZE(pdata->overcurrent_pin)) {
	458	dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
	459	return IRQ_HANDLED;
	460	}
	461
	462	val = gpio_get_value(gpio);
	463
	464	/* When notified of an over-current situation, disable power
	465	on the corresponding port, and mark this port in
	466	over-current. */
	467	if (! val) {
	468	ohci_at91_usb_set_power(pdata, port, 0);
	469	pdata->overcurrent_status[port] = 1;
	470	pdata->overcurrent_changed[port] = 1;
	471	}
	472
	473	dev_dbg(& pdev->dev, "overcurrent situation %s\n",
	474	val ? "exited" : "notified");
	475
	476	return IRQ_HANDLED;
	477	}
	478
	479	/-------------------------------------------------------------------------/
	480
0365ee0a	481	static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
39a269c0	482	{
4bde4a4c DB	483	struct at91_usbh_data *pdata = pdev->dev.platform_data;
	484	int i;
	485
	486	if (pdata) {
3d6fdf75	487	for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
8a7a49d1	488	if (!gpio_is_valid(pdata->vbus_pin[i]))
4bde4a4c DB	489	continue;
4bde4a4c DB	490	gpio_request(pdata->vbus_pin[i], "ohci_vbus");
aa6e52a3 TP	491	ohci_at91_usb_set_power(pdata, i, 1);
	492	}
	493
	494	for (i = 0; i < ARRAY_SIZE(pdata->overcurrent_pin); i++) {
	495	int ret;
	496
8a7a49d1	497	if (!gpio_is_valid(pdata->overcurrent_pin[i]))
aa6e52a3 TP	498	continue;
	499	gpio_request(pdata->overcurrent_pin[i], "ohci_overcurrent");
	500
	501	ret = request_irq(gpio_to_irq(pdata->overcurrent_pin[i]),
	502	ohci_hcd_at91_overcurrent_irq,
	503	IRQF_SHARED, "ohci_overcurrent", pdev);
	504	if (ret) {
	505	gpio_free(pdata->overcurrent_pin[i]);
	506	dev_warn(& pdev->dev, "cannot get GPIO IRQ for overcurrent\n");
	507	}
4bde4a4c DB	508	}
	509	}
	510
0365ee0a DB	511	device_init_wakeup(&pdev->dev, 1);
0365ee0a DB	512	return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
39a269c0 AV	513	}
39a269c0 AV	514
0365ee0a	515	static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
39a269c0	516	{
4bde4a4c DB	517	struct at91_usbh_data *pdata = pdev->dev.platform_data;
	518	int i;
	519
	520	if (pdata) {
3d6fdf75	521	for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
8a7a49d1	522	if (!gpio_is_valid(pdata->vbus_pin[i]))
4bde4a4c	523	continue;
aa6e52a3	524	ohci_at91_usb_set_power(pdata, i, 0);
4bde4a4c DB	525	gpio_free(pdata->vbus_pin[i]);
4bde4a4c DB	526	}
aa6e52a3 TP	527
aa6e52a3 TP	528	for (i = 0; i < ARRAY_SIZE(pdata->overcurrent_pin); i++) {
8a7a49d1	529	if (!gpio_is_valid(pdata->overcurrent_pin[i]))
aa6e52a3 TP	530	continue;
	531	free_irq(gpio_to_irq(pdata->overcurrent_pin[i]), pdev);
	532	gpio_free(pdata->overcurrent_pin[i]);
	533	}
4bde4a4c DB	534	}
4bde4a4c DB	535
0365ee0a	536	device_init_wakeup(&pdev->dev, 0);
421b4bf5 PZ	537	usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
421b4bf5 PZ	538	return 0;
39a269c0 AV	539	}
	540
	541	#ifdef CONFIG_PM
39a269c0	542
68ba61b8	543	static int
0365ee0a	544	ohci_hcd_at91_drv_suspend(struct platform_device *pdev, pm_message_t mesg)
68ba61b8	545	{
0365ee0a DB	546	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	547	struct ohci_hcd *ohci = hcd_to_ohci(hcd);
	548
	549	if (device_may_wakeup(&pdev->dev))
	550	enable_irq_wake(hcd->irq);
0365ee0a DB	551
	552	/*
	553	* The integrated transceivers seem unable to notice disconnect,
	554	* reconnect, or wakeup without the 48 MHz clock active. so for
	555	* correctness, always discard connection state (using reset).
	556	*
	557	* REVISIT: some boards will be able to turn VBUS off...
	558	*/
	559	if (at91_suspend_entering_slow_clock()) {
	560	ohci_usb_reset (ohci);
869aa98c PV	561	/* flush the writes */
869aa98c PV	562	(void) ohci_readl (ohci, &ohci->regs->control);
ed077bb7	563	at91_stop_clock();
0365ee0a	564	}
39a269c0 AV	565
	566	return 0;
	567	}
	568
0365ee0a	569	static int ohci_hcd_at91_drv_resume(struct platform_device *pdev)
39a269c0	570	{
6dde896e MP	571	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	572
	573	if (device_may_wakeup(&pdev->dev))
	574	disable_irq_wake(hcd->irq);
	575
ed077bb7 AV	576	if (!clocked)
ed077bb7 AV	577	at91_start_clock();
39a269c0	578
43bbb7e0	579	ohci_finish_controller_resume(hcd);
39a269c0 AV	580	return 0;
	581	}
	582	#else
	583	#define ohci_hcd_at91_drv_suspend NULL
	584	#define ohci_hcd_at91_drv_resume NULL
	585	#endif
	586
f4fce61d	587	MODULE_ALIAS("platform:at91_ohci");
68ba61b8	588
39a269c0 AV	589	static struct platform_driver ohci_hcd_at91_driver = {
	590	.probe = ohci_hcd_at91_drv_probe,
	591	.remove = ohci_hcd_at91_drv_remove,
64a21d02	592	.shutdown = usb_hcd_platform_shutdown,
39a269c0 AV	593	.suspend = ohci_hcd_at91_drv_suspend,
	594	.resume = ohci_hcd_at91_drv_resume,
	595	.driver = {
0365ee0a	596	.name = "at91_ohci",
39a269c0 AV	597	.owner = THIS_MODULE,
	598	},
	599	};