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

/*
 * EHCI HCD (Host Controller Driver) for USB.
 *
 * Bus Glue for PPC On-Chip EHCI driver on the of_platform bus
 * Tested on AMCC PPC 440EPx
 *
 * Valentine Barshak <vbarshak@ru.mvista.com>
 *
 * Based on "ehci-ppc-soc.c" by Stefan Roese <sr@denx.de>
 * and "ohci-ppc-of.c" by Sylvain Munaut <tnt@246tNt.com>
 *
 * This file is licenced under the GPL.
 */

#include <linux/signal.h>

#include <linux/of.h>
#include <linux/of_platform.h>

/* called during probe() after chip reset completes */
static int ehci_ppc_of_setup(struct usb_hcd *hcd)
{
	struct ehci_hcd	*ehci = hcd_to_ehci(hcd);
	int		retval;

	retval = ehci_halt(ehci);
	if (retval)
		return retval;

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

	ehci->sbrn = 0x20;
	return ehci_reset(ehci);
}


static const struct hc_driver ehci_ppc_of_hc_driver = {
	.description		= hcd_name,
	.product_desc		= "OF EHCI",
	.hcd_priv_size		= sizeof(struct ehci_hcd),

	/*
	 * generic hardware linkage
	 */
	.irq			= ehci_irq,
	.flags			= HCD_MEMORY | HCD_USB2,

	/*
	 * basic lifecycle operations
	 */
	.reset			= ehci_ppc_of_setup,
	.start			= ehci_run,
	.stop			= ehci_stop,
	.shutdown		= ehci_shutdown,

	/*
	 * managing i/o requests and associated device resources
	 */
	.urb_enqueue		= ehci_urb_enqueue,
	.urb_dequeue		= ehci_urb_dequeue,
	.endpoint_disable	= ehci_endpoint_disable,

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

	/*
	 * root hub support
	 */
	.hub_status_data	= ehci_hub_status_data,
	.hub_control		= ehci_hub_control,
#ifdef	CONFIG_PM
	.bus_suspend		= ehci_bus_suspend,
	.bus_resume		= ehci_bus_resume,
#endif
	.relinquish_port	= ehci_relinquish_port,
	.port_handed_over	= ehci_port_handed_over,
};


/*
 * 440EPx Errata USBH_3
 * Fix: Enable Break Memory Transfer (BMT) in INSNREG3
 */
#define PPC440EPX_EHCI0_INSREG_BMT	(0x1 << 0)
static int __devinit
ppc44x_enable_bmt(struct device_node *dn)
{
	__iomem u32 *insreg_virt;

	insreg_virt = of_iomap(dn, 1);
	if (!insreg_virt)
		return  -EINVAL;

	out_be32(insreg_virt + 3, PPC440EPX_EHCI0_INSREG_BMT);

	iounmap(insreg_virt);
	return 0;
}


static int __devinit
ehci_hcd_ppc_of_probe(struct of_device *op, const struct of_device_id *match)
{
	struct device_node *dn = op->node;
	struct usb_hcd *hcd;
	struct ehci_hcd	*ehci;
	struct resource res;
	int irq;
	int rv;

	if (usb_disabled())
		return -ENODEV;

	dev_dbg(&op->dev, "initializing PPC-OF USB Controller\n");

	rv = of_address_to_resource(dn, 0, &res);
	if (rv)
		return rv;

	hcd = usb_create_hcd(&ehci_ppc_of_hc_driver, &op->dev, "PPC-OF USB");
	if (!hcd)
		return -ENOMEM;

	hcd->rsrc_start = res.start;
	hcd->rsrc_len = res.end - res.start + 1;

	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
		printk(KERN_ERR __FILE__ ": request_mem_region failed\n");
		rv = -EBUSY;
		goto err_rmr;
	}

	irq = irq_of_parse_and_map(dn, 0);
	if (irq == NO_IRQ) {
		printk(KERN_ERR __FILE__ ": irq_of_parse_and_map failed\n");
		rv = -EBUSY;
		goto err_irq;
	}

	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
	if (!hcd->regs) {
		printk(KERN_ERR __FILE__ ": ioremap failed\n");
		rv = -ENOMEM;
		goto err_ioremap;
	}

	ehci = hcd_to_ehci(hcd);

	if (of_get_property(dn, "big-endian", NULL)) {
		ehci->big_endian_mmio = 1;
		ehci->big_endian_desc = 1;
	}
	if (of_get_property(dn, "big-endian-regs", NULL))
		ehci->big_endian_mmio = 1;
	if (of_get_property(dn, "big-endian-desc", NULL))
		ehci->big_endian_desc = 1;

	ehci->caps = hcd->regs;
	ehci->regs = hcd->regs +
			HC_LENGTH(ehci_readl(ehci, &ehci->caps->hc_capbase));

	/* cache this readonly data; minimize chip reads */
	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);

	if (of_device_is_compatible(dn, "ibm,usb-ehci-440epx")) {
		rv = ppc44x_enable_bmt(dn);
		ehci_dbg(ehci, "Break Memory Transfer (BMT) is %senabled!\n",
				rv ? "NOT ": "");
	}

	rv = usb_add_hcd(hcd, irq, 0);
	if (rv == 0)
		return 0;

	iounmap(hcd->regs);
err_ioremap:
	irq_dispose_mapping(irq);
err_irq:
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
err_rmr:
	usb_put_hcd(hcd);

	return rv;
}


static int ehci_hcd_ppc_of_remove(struct of_device *op)
{
	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
	dev_set_drvdata(&op->dev, NULL);

	dev_dbg(&op->dev, "stopping PPC-OF USB Controller\n");

	usb_remove_hcd(hcd);

	iounmap(hcd->regs);
	irq_dispose_mapping(hcd->irq);
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);

	usb_put_hcd(hcd);

	return 0;
}


static int ehci_hcd_ppc_of_shutdown(struct of_device *op)
{
	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);

	if (hcd->driver->shutdown)
		hcd->driver->shutdown(hcd);

	return 0;
}


static struct of_device_id ehci_hcd_ppc_of_match[] = {
	{
		.compatible = "usb-ehci",
	},
	{},
};
MODULE_DEVICE_TABLE(of, ehci_hcd_ppc_of_match);


static struct of_platform_driver ehci_hcd_ppc_of_driver = {
	.name		= "ppc-of-ehci",
	.match_table	= ehci_hcd_ppc_of_match,
	.probe		= ehci_hcd_ppc_of_probe,
	.remove		= ehci_hcd_ppc_of_remove,
	.shutdown	= ehci_hcd_ppc_of_shutdown,
	.driver		= {
		.name	= "ppc-of-ehci",
		.owner	= THIS_MODULE,
	},
};
Commit	Line	Data
da0e8fb0 VB	1	/*
	2	* EHCI HCD (Host Controller Driver) for USB.
	3	*
	4	* Bus Glue for PPC On-Chip EHCI driver on the of_platform bus
	5	* Tested on AMCC PPC 440EPx
	6	*
	7	* Valentine Barshak <vbarshak@ru.mvista.com>
	8	*
	9	* Based on "ehci-ppc-soc.c" by Stefan Roese <sr@denx.de>
	10	* and "ohci-ppc-of.c" by Sylvain Munaut <tnt@246tNt.com>
	11	*
	12	* This file is licenced under the GPL.
	13	*/
	14
	15	#include <linux/signal.h>
	16
	17	#include <linux/of.h>
	18	#include <linux/of_platform.h>
	19
	20	/* called during probe() after chip reset completes */
	21	static int ehci_ppc_of_setup(struct usb_hcd *hcd)
	22	{
	23	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	24	int retval;
	25
	26	retval = ehci_halt(ehci);
	27	if (retval)
	28	return retval;
	29
	30	retval = ehci_init(hcd);
	31	if (retval)
	32	return retval;
	33
	34	ehci->sbrn = 0x20;
	35	return ehci_reset(ehci);
	36	}
	37
	38
	39	static const struct hc_driver ehci_ppc_of_hc_driver = {
	40	.description = hcd_name,
	41	.product_desc = "OF EHCI",
	42	.hcd_priv_size = sizeof(struct ehci_hcd),
	43
	44	/*
	45	* generic hardware linkage
	46	*/
	47	.irq = ehci_irq,
	48	.flags = HCD_MEMORY \| HCD_USB2,
	49
	50	/*
	51	* basic lifecycle operations
	52	*/
	53	.reset = ehci_ppc_of_setup,
	54	.start = ehci_run,
	55	.stop = ehci_stop,
	56	.shutdown = ehci_shutdown,
	57
	58	/*
	59	* managing i/o requests and associated device resources
	60	*/
	61	.urb_enqueue = ehci_urb_enqueue,
	62	.urb_dequeue = ehci_urb_dequeue,
	63	.endpoint_disable = ehci_endpoint_disable,
	64
65	/*
66	* scheduling support
67	*/
68	.get_frame_number = ehci_get_frame,
69
70	/*
71	* root hub support
72	*/
73	.hub_status_data = ehci_hub_status_data,
74	.hub_control = ehci_hub_control,
75	#ifdef CONFIG_PM
76	.bus_suspend = ehci_bus_suspend,
77	.bus_resume = ehci_bus_resume,
78	#endif
a8e51775	79	.relinquish_port = ehci_relinquish_port,
3a31155c	80	.port_handed_over = ehci_port_handed_over,
da0e8fb0 VB	81	};
	82
	83
	84	/*
	85	* 440EPx Errata USBH_3
	86	* Fix: Enable Break Memory Transfer (BMT) in INSNREG3
	87	*/
	88	#define PPC440EPX_EHCI0_INSREG_BMT (0x1 << 0)
	89	static int __devinit
	90	ppc44x_enable_bmt(struct device_node *dn)
	91	{
	92	__iomem u32 *insreg_virt;
	93
	94	insreg_virt = of_iomap(dn, 1);
	95	if (!insreg_virt)
	96	return -EINVAL;
	97
	98	out_be32(insreg_virt + 3, PPC440EPX_EHCI0_INSREG_BMT);
	99
	100	iounmap(insreg_virt);
	101	return 0;
	102	}
	103
	104
	105	static int __devinit
	106	ehci_hcd_ppc_of_probe(struct of_device op, const struct of_device_id match)
	107	{
	108	struct device_node *dn = op->node;
	109	struct usb_hcd *hcd;
	110	struct ehci_hcd *ehci;
	111	struct resource res;
	112	int irq;
	113	int rv;
	114
	115	if (usb_disabled())
	116	return -ENODEV;
	117
	118	dev_dbg(&op->dev, "initializing PPC-OF USB Controller\n");
	119
	120	rv = of_address_to_resource(dn, 0, &res);
	121	if (rv)
	122	return rv;
	123
	124	hcd = usb_create_hcd(&ehci_ppc_of_hc_driver, &op->dev, "PPC-OF USB");
	125	if (!hcd)
	126	return -ENOMEM;
	127
	128	hcd->rsrc_start = res.start;
	129	hcd->rsrc_len = res.end - res.start + 1;
	130
	131	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
	132	printk(KERN_ERR __FILE__ ": request_mem_region failed\n");
	133	rv = -EBUSY;
	134	goto err_rmr;
	135	}
	136
	137	irq = irq_of_parse_and_map(dn, 0);
	138	if (irq == NO_IRQ) {
	139	printk(KERN_ERR __FILE__ ": irq_of_parse_and_map failed\n");
	140	rv = -EBUSY;
	141	goto err_irq;
	142	}
	143
	144	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
145	if (!hcd->regs) {
146	printk(KERN_ERR __FILE__ ": ioremap failed\n");
147	rv = -ENOMEM;
148	goto err_ioremap;
149	}
150
151	ehci = hcd_to_ehci(hcd);
152
153	if (of_get_property(dn, "big-endian", NULL)) {
154	ehci->big_endian_mmio = 1;
155	ehci->big_endian_desc = 1;
156	}
157	if (of_get_property(dn, "big-endian-regs", NULL))
158	ehci->big_endian_mmio = 1;
159	if (of_get_property(dn, "big-endian-desc", NULL))
160	ehci->big_endian_desc = 1;
161
162	ehci->caps = hcd->regs;
163	ehci->regs = hcd->regs +
164	HC_LENGTH(ehci_readl(ehci, &ehci->caps->hc_capbase));
165
166	/* cache this readonly data; minimize chip reads */
167	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
168
169	if (of_device_is_compatible(dn, "ibm,usb-ehci-440epx")) {
170	rv = ppc44x_enable_bmt(dn);
171	ehci_dbg(ehci, "Break Memory Transfer (BMT) is %senabled!\n",
172	rv ? "NOT ": "");
173	}
174
175	rv = usb_add_hcd(hcd, irq, 0);
176	if (rv == 0)
177	return 0;
178
179	iounmap(hcd->regs);
180	err_ioremap:
181	irq_dispose_mapping(irq);
182	err_irq:
183	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
184	err_rmr:
185	usb_put_hcd(hcd);
186
187	return rv;
188	}
189
190
191	static int ehci_hcd_ppc_of_remove(struct of_device *op)
192	{
193	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
194	dev_set_drvdata(&op->dev, NULL);
195
196	dev_dbg(&op->dev, "stopping PPC-OF USB Controller\n");
197
198	usb_remove_hcd(hcd);
199
200	iounmap(hcd->regs);
201	irq_dispose_mapping(hcd->irq);
202	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
203
204	usb_put_hcd(hcd);
205
206	return 0;
207	}
208
209
210	static int ehci_hcd_ppc_of_shutdown(struct of_device *op)
211	{
212	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
213
214	if (hcd->driver->shutdown)
215	hcd->driver->shutdown(hcd);
216
217	return 0;
218	}
219
220
221	static struct of_device_id ehci_hcd_ppc_of_match[] = {
222	{
223	.compatible = "usb-ehci",
224	},
225	{},
226	};
227	MODULE_DEVICE_TABLE(of, ehci_hcd_ppc_of_match);
228
229
230	static struct of_platform_driver ehci_hcd_ppc_of_driver = {
231	.name = "ppc-of-ehci",
232	.match_table = ehci_hcd_ppc_of_match,
233	.probe = ehci_hcd_ppc_of_probe,
234	.remove = ehci_hcd_ppc_of_remove,
235	.shutdown = ehci_hcd_ppc_of_shutdown,
236	.driver = {
237	.name = "ppc-of-ehci",
238	.owner = THIS_MODULE,
239	},
240	};