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