[net-next-2.6.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,
	.endpoint_reset		= ehci_endpoint_reset,

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

	.clear_tt_buffer_complete	= ehci_clear_tt_buffer_complete,
};


/*
 * 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 platform_device *op, const struct of_device_id *match)
{
	struct device_node *dn = op->dev.of_node;
	struct usb_hcd *hcd;
	struct ehci_hcd	*ehci = NULL;
	struct resource res;
	int irq;
	int rv;

	struct device_node *np;

	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 "%s: request_mem_region failed\n", __FILE__);
		rv = -EBUSY;
		goto err_rmr;
	}

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

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

	ehci = hcd_to_ehci(hcd);
	np = of_find_compatible_node(NULL, NULL, "ibm,usb-ohci-440epx");
	if (np != NULL) {
		/* claim we really affected by usb23 erratum */
		if (!of_address_to_resource(np, 0, &res))
			ehci->ohci_hcctrl_reg = ioremap(res.start +
					OHCI_HCCTRL_OFFSET, OHCI_HCCTRL_LEN);
		else
			pr_debug("%s: no ohci offset in fdt\n", __FILE__);
		if (!ehci->ohci_hcctrl_reg) {
			pr_debug("%s: ioremap for ohci hcctrl failed\n", __FILE__);
		} else {
			ehci->has_amcc_usb23 = 1;
		}
	}

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

	return 0;

err_ehci:
	if (ehci->has_amcc_usb23)
		iounmap(ehci->ohci_hcctrl_reg);
	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 platform_device *op)
{
	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
	struct ehci_hcd *ehci = hcd_to_ehci(hcd);

	struct device_node *np;
	struct resource res;

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

	/* use request_mem_region to test if the ohci driver is loaded.  if so
	 * ensure the ohci core is operational.
	 */
	if (ehci->has_amcc_usb23) {
		np = of_find_compatible_node(NULL, NULL, "ibm,usb-ohci-440epx");
		if (np != NULL) {
			if (!of_address_to_resource(np, 0, &res))
				if (!request_mem_region(res.start,
							    0x4, hcd_name))
					set_ohci_hcfs(ehci, 1);
				else
					release_mem_region(res.start, 0x4);
			else
				pr_debug("%s: no ohci offset in fdt\n", __FILE__);
			of_node_put(np);
		}

		iounmap(ehci->ohci_hcctrl_reg);
	}
	usb_put_hcd(hcd);

	return 0;
}


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

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

	return 0;
}


static const 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 = {
	.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,
		.of_match_table = ehci_hcd_ppc_of_match,
	},
};
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,
b18ffd49	64	.endpoint_reset = ehci_endpoint_reset,
da0e8fb0 VB	65
	66	/*
	67	* scheduling support
	68	*/
	69	.get_frame_number = ehci_get_frame,
	70
	71	/*
	72	* root hub support
	73	*/
	74	.hub_status_data = ehci_hub_status_data,
	75	.hub_control = ehci_hub_control,
	76	#ifdef CONFIG_PM
	77	.bus_suspend = ehci_bus_suspend,
	78	.bus_resume = ehci_bus_resume,
	79	#endif
a8e51775	80	.relinquish_port = ehci_relinquish_port,
3a31155c	81	.port_handed_over = ehci_port_handed_over,
914b7012 AS	82
914b7012 AS	83	.clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
da0e8fb0 VB	84	};
	85
	86
	87	/*
	88	* 440EPx Errata USBH_3
	89	* Fix: Enable Break Memory Transfer (BMT) in INSNREG3
	90	*/
	91	#define PPC440EPX_EHCI0_INSREG_BMT (0x1 << 0)
	92	static int __devinit
	93	ppc44x_enable_bmt(struct device_node *dn)
	94	{
	95	__iomem u32 *insreg_virt;
	96
	97	insreg_virt = of_iomap(dn, 1);
	98	if (!insreg_virt)
	99	return -EINVAL;
	100
	101	out_be32(insreg_virt + 3, PPC440EPX_EHCI0_INSREG_BMT);
	102
	103	iounmap(insreg_virt);
	104	return 0;
	105	}
	106
	107
	108	static int __devinit
2dc11581	109	ehci_hcd_ppc_of_probe(struct platform_device op, const struct of_device_id match)
da0e8fb0	110	{
61c7a080	111	struct device_node *dn = op->dev.of_node;
da0e8fb0	112	struct usb_hcd *hcd;
796bcae7	113	struct ehci_hcd *ehci = NULL;
da0e8fb0 VB	114	struct resource res;
	115	int irq;
	116	int rv;
	117
796bcae7 VB	118	struct device_node *np;
796bcae7 VB	119
da0e8fb0 VB	120	if (usb_disabled())
	121	return -ENODEV;
	122
	123	dev_dbg(&op->dev, "initializing PPC-OF USB Controller\n");
	124
	125	rv = of_address_to_resource(dn, 0, &res);
	126	if (rv)
	127	return rv;
	128
	129	hcd = usb_create_hcd(&ehci_ppc_of_hc_driver, &op->dev, "PPC-OF USB");
	130	if (!hcd)
	131	return -ENOMEM;
	132
	133	hcd->rsrc_start = res.start;
	134	hcd->rsrc_len = res.end - res.start + 1;
	135
	136	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
f45ba776	137	printk(KERN_ERR "%s: request_mem_region failed\n", __FILE__);
da0e8fb0 VB	138	rv = -EBUSY;
	139	goto err_rmr;
	140	}
	141
	142	irq = irq_of_parse_and_map(dn, 0);
	143	if (irq == NO_IRQ) {
f45ba776	144	printk(KERN_ERR "%s: irq_of_parse_and_map failed\n", __FILE__);
da0e8fb0 VB	145	rv = -EBUSY;
	146	goto err_irq;
	147	}
	148
	149	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
	150	if (!hcd->regs) {
f45ba776	151	printk(KERN_ERR "%s: ioremap failed\n", __FILE__);
da0e8fb0 VB	152	rv = -ENOMEM;
	153	goto err_ioremap;
	154	}
	155
	156	ehci = hcd_to_ehci(hcd);
796bcae7 VB	157	np = of_find_compatible_node(NULL, NULL, "ibm,usb-ohci-440epx");
	158	if (np != NULL) {
	159	/* claim we really affected by usb23 erratum */
	160	if (!of_address_to_resource(np, 0, &res))
	161	ehci->ohci_hcctrl_reg = ioremap(res.start +
	162	OHCI_HCCTRL_OFFSET, OHCI_HCCTRL_LEN);
	163	else
f45ba776	164	pr_debug("%s: no ohci offset in fdt\n", __FILE__);
796bcae7	165	if (!ehci->ohci_hcctrl_reg) {
f45ba776	166	pr_debug("%s: ioremap for ohci hcctrl failed\n", __FILE__);
796bcae7 VB	167	} else {
	168	ehci->has_amcc_usb23 = 1;
	169	}
	170	}
da0e8fb0 VB	171
	172	if (of_get_property(dn, "big-endian", NULL)) {
	173	ehci->big_endian_mmio = 1;
	174	ehci->big_endian_desc = 1;
	175	}
	176	if (of_get_property(dn, "big-endian-regs", NULL))
	177	ehci->big_endian_mmio = 1;
	178	if (of_get_property(dn, "big-endian-desc", NULL))
	179	ehci->big_endian_desc = 1;
	180
	181	ehci->caps = hcd->regs;
	182	ehci->regs = hcd->regs +
	183	HC_LENGTH(ehci_readl(ehci, &ehci->caps->hc_capbase));
	184
	185	/* cache this readonly data; minimize chip reads */
	186	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
	187
	188	if (of_device_is_compatible(dn, "ibm,usb-ehci-440epx")) {
	189	rv = ppc44x_enable_bmt(dn);
	190	ehci_dbg(ehci, "Break Memory Transfer (BMT) is %senabled!\n",
	191	rv ? "NOT ": "");
	192	}
	193
	194	rv = usb_add_hcd(hcd, irq, 0);
08a3b3b1 DC	195	if (rv)
	196	goto err_ehci;
	197
	198	return 0;
da0e8fb0	199
08a3b3b1 DC	200	err_ehci:
	201	if (ehci->has_amcc_usb23)
	202	iounmap(ehci->ohci_hcctrl_reg);
da0e8fb0 VB	203	iounmap(hcd->regs);
	204	err_ioremap:
	205	irq_dispose_mapping(irq);
	206	err_irq:
	207	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	208	err_rmr:
	209	usb_put_hcd(hcd);
	210
	211	return rv;
	212	}
	213
	214
2dc11581	215	static int ehci_hcd_ppc_of_remove(struct platform_device *op)
da0e8fb0 VB	216	{
da0e8fb0 VB	217	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
796bcae7 VB	218	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	219
	220	struct device_node *np;
	221	struct resource res;
	222
da0e8fb0 VB	223	dev_set_drvdata(&op->dev, NULL);
	224
	225	dev_dbg(&op->dev, "stopping PPC-OF USB Controller\n");
	226
	227	usb_remove_hcd(hcd);
	228
	229	iounmap(hcd->regs);
	230	irq_dispose_mapping(hcd->irq);
	231	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	232
796bcae7 VB	233	/* use request_mem_region to test if the ohci driver is loaded. if so
	234	* ensure the ohci core is operational.
	235	*/
	236	if (ehci->has_amcc_usb23) {
	237	np = of_find_compatible_node(NULL, NULL, "ibm,usb-ohci-440epx");
	238	if (np != NULL) {
	239	if (!of_address_to_resource(np, 0, &res))
	240	if (!request_mem_region(res.start,
	241	0x4, hcd_name))
	242	set_ohci_hcfs(ehci, 1);
	243	else
	244	release_mem_region(res.start, 0x4);
	245	else
f45ba776	246	pr_debug("%s: no ohci offset in fdt\n", __FILE__);
796bcae7 VB	247	of_node_put(np);
	248	}
	249
	250	iounmap(ehci->ohci_hcctrl_reg);
	251	}
da0e8fb0 VB	252	usb_put_hcd(hcd);
	253
	254	return 0;
	255	}
	256
	257
2dc11581	258	static int ehci_hcd_ppc_of_shutdown(struct platform_device *op)
da0e8fb0 VB	259	{
	260	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
	261
	262	if (hcd->driver->shutdown)
	263	hcd->driver->shutdown(hcd);
	264
	265	return 0;
	266	}
	267
	268
c4386ad0	269	static const struct of_device_id ehci_hcd_ppc_of_match[] = {
da0e8fb0 VB	270	{
	271	.compatible = "usb-ehci",
	272	},
	273	{},
	274	};
	275	MODULE_DEVICE_TABLE(of, ehci_hcd_ppc_of_match);
	276
	277
	278	static struct of_platform_driver ehci_hcd_ppc_of_driver = {
da0e8fb0 VB	279	.probe = ehci_hcd_ppc_of_probe,
	280	.remove = ehci_hcd_ppc_of_remove,
	281	.shutdown = ehci_hcd_ppc_of_shutdown,
4018294b GL	282	.driver = {
	283	.name = "ppc-of-ehci",
	284	.owner = THIS_MODULE,
	285	.of_match_table = ehci_hcd_ppc_of_match,
da0e8fb0 VB	286	},
da0e8fb0 VB	287	};