[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>


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_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)
{
	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 = resource_size(&res);

	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 = devm_request_and_ioremap(&op->dev, &res);
	if (!hcd->regs) {
		pr_err("%s: devm_request_and_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 =
				devm_ioremap(&op->dev,
					     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;

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

	return 0;

err_ioremap:
	irq_dispose_mapping(irq);
err_irq:
	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);

	irq_dispose_mapping(hcd->irq);

	/* 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);
		}
	}
	usb_put_hcd(hcd);

	return 0;
}


static void 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);
}


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 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
da0e8fb0 VB	20
	21	static const struct hc_driver ehci_ppc_of_hc_driver = {
	22	.description = hcd_name,
	23	.product_desc = "OF EHCI",
	24	.hcd_priv_size = sizeof(struct ehci_hcd),
	25
	26	/*
	27	* generic hardware linkage
	28	*/
	29	.irq = ehci_irq,
	30	.flags = HCD_MEMORY \| HCD_USB2,
	31
	32	/*
	33	* basic lifecycle operations
	34	*/
1a49e2ac	35	.reset = ehci_setup,
da0e8fb0 VB	36	.start = ehci_run,
	37	.stop = ehci_stop,
	38	.shutdown = ehci_shutdown,
	39
	40	/*
	41	* managing i/o requests and associated device resources
	42	*/
	43	.urb_enqueue = ehci_urb_enqueue,
	44	.urb_dequeue = ehci_urb_dequeue,
	45	.endpoint_disable = ehci_endpoint_disable,
b18ffd49	46	.endpoint_reset = ehci_endpoint_reset,
da0e8fb0 VB	47
	48	/*
	49	* scheduling support
	50	*/
	51	.get_frame_number = ehci_get_frame,
	52
	53	/*
	54	* root hub support
	55	*/
	56	.hub_status_data = ehci_hub_status_data,
	57	.hub_control = ehci_hub_control,
	58	#ifdef CONFIG_PM
	59	.bus_suspend = ehci_bus_suspend,
	60	.bus_resume = ehci_bus_resume,
	61	#endif
a8e51775	62	.relinquish_port = ehci_relinquish_port,
3a31155c	63	.port_handed_over = ehci_port_handed_over,
914b7012 AS	64
914b7012 AS	65	.clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
da0e8fb0 VB	66	};
	67
	68
	69	/*
	70	* 440EPx Errata USBH_3
	71	* Fix: Enable Break Memory Transfer (BMT) in INSNREG3
	72	*/
	73	#define PPC440EPX_EHCI0_INSREG_BMT (0x1 << 0)
	74	static int __devinit
	75	ppc44x_enable_bmt(struct device_node *dn)
	76	{
	77	__iomem u32 *insreg_virt;
	78
	79	insreg_virt = of_iomap(dn, 1);
	80	if (!insreg_virt)
	81	return -EINVAL;
	82
	83	out_be32(insreg_virt + 3, PPC440EPX_EHCI0_INSREG_BMT);
	84
	85	iounmap(insreg_virt);
	86	return 0;
	87	}
	88
	89
d35fb641	90	static int __devinit ehci_hcd_ppc_of_probe(struct platform_device *op)
da0e8fb0	91	{
61c7a080	92	struct device_node *dn = op->dev.of_node;
da0e8fb0	93	struct usb_hcd *hcd;
796bcae7	94	struct ehci_hcd *ehci = NULL;
da0e8fb0 VB	95	struct resource res;
	96	int irq;
	97	int rv;
	98
796bcae7 VB	99	struct device_node *np;
796bcae7 VB	100
da0e8fb0 VB	101	if (usb_disabled())
	102	return -ENODEV;
	103
	104	dev_dbg(&op->dev, "initializing PPC-OF USB Controller\n");
	105
	106	rv = of_address_to_resource(dn, 0, &res);
	107	if (rv)
	108	return rv;
	109
	110	hcd = usb_create_hcd(&ehci_ppc_of_hc_driver, &op->dev, "PPC-OF USB");
	111	if (!hcd)
	112	return -ENOMEM;
	113
	114	hcd->rsrc_start = res.start;
28f65c11	115	hcd->rsrc_len = resource_size(&res);
da0e8fb0	116
da0e8fb0 VB	117	irq = irq_of_parse_and_map(dn, 0);
da0e8fb0 VB	118	if (irq == NO_IRQ) {
f45ba776	119	printk(KERN_ERR "%s: irq_of_parse_and_map failed\n", __FILE__);
da0e8fb0 VB	120	rv = -EBUSY;
	121	goto err_irq;
	122	}
	123
1c5404f7	124	hcd->regs = devm_request_and_ioremap(&op->dev, &res);
da0e8fb0	125	if (!hcd->regs) {
1c5404f7	126	pr_err("%s: devm_request_and_ioremap failed\n", __FILE__);
da0e8fb0 VB	127	rv = -ENOMEM;
	128	goto err_ioremap;
	129	}
	130
	131	ehci = hcd_to_ehci(hcd);
796bcae7 VB	132	np = of_find_compatible_node(NULL, NULL, "ibm,usb-ohci-440epx");
	133	if (np != NULL) {
	134	/* claim we really affected by usb23 erratum */
	135	if (!of_address_to_resource(np, 0, &res))
1c5404f7 JL	136	ehci->ohci_hcctrl_reg =
	137	devm_ioremap(&op->dev,
	138	res.start + OHCI_HCCTRL_OFFSET,
	139	OHCI_HCCTRL_LEN);
796bcae7	140	else
f45ba776	141	pr_debug("%s: no ohci offset in fdt\n", __FILE__);
796bcae7	142	if (!ehci->ohci_hcctrl_reg) {
f45ba776	143	pr_debug("%s: ioremap for ohci hcctrl failed\n", __FILE__);
796bcae7 VB	144	} else {
	145	ehci->has_amcc_usb23 = 1;
	146	}
	147	}
da0e8fb0 VB	148
	149	if (of_get_property(dn, "big-endian", NULL)) {
	150	ehci->big_endian_mmio = 1;
	151	ehci->big_endian_desc = 1;
	152	}
	153	if (of_get_property(dn, "big-endian-regs", NULL))
	154	ehci->big_endian_mmio = 1;
	155	if (of_get_property(dn, "big-endian-desc", NULL))
	156	ehci->big_endian_desc = 1;
	157
	158	ehci->caps = hcd->regs;
da0e8fb0 VB	159
	160	if (of_device_is_compatible(dn, "ibm,usb-ehci-440epx")) {
	161	rv = ppc44x_enable_bmt(dn);
	162	ehci_dbg(ehci, "Break Memory Transfer (BMT) is %senabled!\n",
	163	rv ? "NOT ": "");
	164	}
	165
	166	rv = usb_add_hcd(hcd, irq, 0);
08a3b3b1	167	if (rv)
1c5404f7	168	goto err_ioremap;
08a3b3b1 DC	169
08a3b3b1 DC	170	return 0;
da0e8fb0	171
da0e8fb0 VB	172	err_ioremap:
	173	irq_dispose_mapping(irq);
	174	err_irq:
da0e8fb0 VB	175	usb_put_hcd(hcd);
	176
	177	return rv;
	178	}
	179
	180
2dc11581	181	static int ehci_hcd_ppc_of_remove(struct platform_device *op)
da0e8fb0 VB	182	{
da0e8fb0 VB	183	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
796bcae7 VB	184	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	185
	186	struct device_node *np;
	187	struct resource res;
	188
da0e8fb0 VB	189	dev_set_drvdata(&op->dev, NULL);
	190
	191	dev_dbg(&op->dev, "stopping PPC-OF USB Controller\n");
	192
	193	usb_remove_hcd(hcd);
	194
da0e8fb0	195	irq_dispose_mapping(hcd->irq);
da0e8fb0	196
796bcae7 VB	197	/* use request_mem_region to test if the ohci driver is loaded. if so
	198	* ensure the ohci core is operational.
	199	*/
	200	if (ehci->has_amcc_usb23) {
	201	np = of_find_compatible_node(NULL, NULL, "ibm,usb-ohci-440epx");
	202	if (np != NULL) {
	203	if (!of_address_to_resource(np, 0, &res))
	204	if (!request_mem_region(res.start,
	205	0x4, hcd_name))
	206	set_ohci_hcfs(ehci, 1);
	207	else
	208	release_mem_region(res.start, 0x4);
	209	else
f45ba776	210	pr_debug("%s: no ohci offset in fdt\n", __FILE__);
796bcae7 VB	211	of_node_put(np);
796bcae7 VB	212	}
796bcae7	213	}
da0e8fb0 VB	214	usb_put_hcd(hcd);
	215
	216	return 0;
	217	}
	218
	219
d35fb641	220	static void ehci_hcd_ppc_of_shutdown(struct platform_device *op)
da0e8fb0 VB	221	{
	222	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
	223
	224	if (hcd->driver->shutdown)
	225	hcd->driver->shutdown(hcd);
da0e8fb0 VB	226	}
	227
	228
c4386ad0	229	static const struct of_device_id ehci_hcd_ppc_of_match[] = {
da0e8fb0 VB	230	{
	231	.compatible = "usb-ehci",
	232	},
	233	{},
	234	};
	235	MODULE_DEVICE_TABLE(of, ehci_hcd_ppc_of_match);
	236
	237
d35fb641	238	static struct platform_driver ehci_hcd_ppc_of_driver = {
da0e8fb0 VB	239	.probe = ehci_hcd_ppc_of_probe,
	240	.remove = ehci_hcd_ppc_of_remove,
	241	.shutdown = ehci_hcd_ppc_of_shutdown,
4018294b GL	242	.driver = {
	243	.name = "ppc-of-ehci",
	244	.owner = THIS_MODULE,
	245	.of_match_table = ehci_hcd_ppc_of_match,
da0e8fb0 VB	246	},
da0e8fb0 VB	247	};