xref: /openbmc/linux/drivers/usb/host/ehci-ppc-of.c (revision 54525552)
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 	.endpoint_reset		= ehci_endpoint_reset,
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
80 	.relinquish_port	= ehci_relinquish_port,
81 	.port_handed_over	= ehci_port_handed_over,
82 
83 	.clear_tt_buffer_complete	= ehci_clear_tt_buffer_complete,
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 ehci_hcd_ppc_of_probe(struct platform_device *op)
109 {
110 	struct device_node *dn = op->dev.of_node;
111 	struct usb_hcd *hcd;
112 	struct ehci_hcd	*ehci = NULL;
113 	struct resource res;
114 	int irq;
115 	int rv;
116 
117 	struct device_node *np;
118 
119 	if (usb_disabled())
120 		return -ENODEV;
121 
122 	dev_dbg(&op->dev, "initializing PPC-OF USB Controller\n");
123 
124 	rv = of_address_to_resource(dn, 0, &res);
125 	if (rv)
126 		return rv;
127 
128 	hcd = usb_create_hcd(&ehci_ppc_of_hc_driver, &op->dev, "PPC-OF USB");
129 	if (!hcd)
130 		return -ENOMEM;
131 
132 	hcd->rsrc_start = res.start;
133 	hcd->rsrc_len = res.end - res.start + 1;
134 
135 	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
136 		printk(KERN_ERR "%s: request_mem_region failed\n", __FILE__);
137 		rv = -EBUSY;
138 		goto err_rmr;
139 	}
140 
141 	irq = irq_of_parse_and_map(dn, 0);
142 	if (irq == NO_IRQ) {
143 		printk(KERN_ERR "%s: irq_of_parse_and_map failed\n", __FILE__);
144 		rv = -EBUSY;
145 		goto err_irq;
146 	}
147 
148 	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
149 	if (!hcd->regs) {
150 		printk(KERN_ERR "%s: ioremap failed\n", __FILE__);
151 		rv = -ENOMEM;
152 		goto err_ioremap;
153 	}
154 
155 	ehci = hcd_to_ehci(hcd);
156 	np = of_find_compatible_node(NULL, NULL, "ibm,usb-ohci-440epx");
157 	if (np != NULL) {
158 		/* claim we really affected by usb23 erratum */
159 		if (!of_address_to_resource(np, 0, &res))
160 			ehci->ohci_hcctrl_reg = ioremap(res.start +
161 					OHCI_HCCTRL_OFFSET, OHCI_HCCTRL_LEN);
162 		else
163 			pr_debug("%s: no ohci offset in fdt\n", __FILE__);
164 		if (!ehci->ohci_hcctrl_reg) {
165 			pr_debug("%s: ioremap for ohci hcctrl failed\n", __FILE__);
166 		} else {
167 			ehci->has_amcc_usb23 = 1;
168 		}
169 	}
170 
171 	if (of_get_property(dn, "big-endian", NULL)) {
172 		ehci->big_endian_mmio = 1;
173 		ehci->big_endian_desc = 1;
174 	}
175 	if (of_get_property(dn, "big-endian-regs", NULL))
176 		ehci->big_endian_mmio = 1;
177 	if (of_get_property(dn, "big-endian-desc", NULL))
178 		ehci->big_endian_desc = 1;
179 
180 	ehci->caps = hcd->regs;
181 	ehci->regs = hcd->regs +
182 		HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
183 
184 	/* cache this readonly data; minimize chip reads */
185 	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
186 
187 	if (of_device_is_compatible(dn, "ibm,usb-ehci-440epx")) {
188 		rv = ppc44x_enable_bmt(dn);
189 		ehci_dbg(ehci, "Break Memory Transfer (BMT) is %senabled!\n",
190 				rv ? "NOT ": "");
191 	}
192 
193 	rv = usb_add_hcd(hcd, irq, 0);
194 	if (rv)
195 		goto err_ehci;
196 
197 	return 0;
198 
199 err_ehci:
200 	if (ehci->has_amcc_usb23)
201 		iounmap(ehci->ohci_hcctrl_reg);
202 	iounmap(hcd->regs);
203 err_ioremap:
204 	irq_dispose_mapping(irq);
205 err_irq:
206 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
207 err_rmr:
208 	usb_put_hcd(hcd);
209 
210 	return rv;
211 }
212 
213 
214 static int ehci_hcd_ppc_of_remove(struct platform_device *op)
215 {
216 	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
217 	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
218 
219 	struct device_node *np;
220 	struct resource res;
221 
222 	dev_set_drvdata(&op->dev, NULL);
223 
224 	dev_dbg(&op->dev, "stopping PPC-OF USB Controller\n");
225 
226 	usb_remove_hcd(hcd);
227 
228 	iounmap(hcd->regs);
229 	irq_dispose_mapping(hcd->irq);
230 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
231 
232 	/* use request_mem_region to test if the ohci driver is loaded.  if so
233 	 * ensure the ohci core is operational.
234 	 */
235 	if (ehci->has_amcc_usb23) {
236 		np = of_find_compatible_node(NULL, NULL, "ibm,usb-ohci-440epx");
237 		if (np != NULL) {
238 			if (!of_address_to_resource(np, 0, &res))
239 				if (!request_mem_region(res.start,
240 							    0x4, hcd_name))
241 					set_ohci_hcfs(ehci, 1);
242 				else
243 					release_mem_region(res.start, 0x4);
244 			else
245 				pr_debug("%s: no ohci offset in fdt\n", __FILE__);
246 			of_node_put(np);
247 		}
248 
249 		iounmap(ehci->ohci_hcctrl_reg);
250 	}
251 	usb_put_hcd(hcd);
252 
253 	return 0;
254 }
255 
256 
257 static void ehci_hcd_ppc_of_shutdown(struct platform_device *op)
258 {
259 	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
260 
261 	if (hcd->driver->shutdown)
262 		hcd->driver->shutdown(hcd);
263 }
264 
265 
266 static const struct of_device_id ehci_hcd_ppc_of_match[] = {
267 	{
268 		.compatible = "usb-ehci",
269 	},
270 	{},
271 };
272 MODULE_DEVICE_TABLE(of, ehci_hcd_ppc_of_match);
273 
274 
275 static struct platform_driver ehci_hcd_ppc_of_driver = {
276 	.probe		= ehci_hcd_ppc_of_probe,
277 	.remove		= ehci_hcd_ppc_of_remove,
278 	.shutdown	= ehci_hcd_ppc_of_shutdown,
279 	.driver = {
280 		.name = "ppc-of-ehci",
281 		.owner = THIS_MODULE,
282 		.of_match_table = ehci_hcd_ppc_of_match,
283 	},
284 };
285