xref: /linux/drivers/usb/host/ehci-ppc-of.c (revision f222e8b40f2177b1c4cac015b117744c1d3fa3e9)
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
109 ehci_hcd_ppc_of_probe(struct of_device *op, const struct of_device_id *match)
110 {
111 	struct device_node *dn = op->node;
112 	struct usb_hcd *hcd;
113 	struct ehci_hcd	*ehci = NULL;
114 	struct resource res;
115 	int irq;
116 	int rv;
117 
118 	struct device_node *np;
119 
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)) {
137 		printk(KERN_ERR __FILE__ ": request_mem_region failed\n");
138 		rv = -EBUSY;
139 		goto err_rmr;
140 	}
141 
142 	irq = irq_of_parse_and_map(dn, 0);
143 	if (irq == NO_IRQ) {
144 		printk(KERN_ERR __FILE__ ": irq_of_parse_and_map failed\n");
145 		rv = -EBUSY;
146 		goto err_irq;
147 	}
148 
149 	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
150 	if (!hcd->regs) {
151 		printk(KERN_ERR __FILE__ ": ioremap failed\n");
152 		rv = -ENOMEM;
153 		goto err_ioremap;
154 	}
155 
156 	ehci = hcd_to_ehci(hcd);
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
164 			pr_debug(__FILE__ ": no ohci offset in fdt\n");
165 		if (!ehci->ohci_hcctrl_reg) {
166 			pr_debug(__FILE__ ": ioremap for ohci hcctrl failed\n");
167 		} else {
168 			ehci->has_amcc_usb23 = 1;
169 		}
170 	}
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);
195 	if (rv == 0)
196 		return 0;
197 
198 	iounmap(hcd->regs);
199 err_ioremap:
200 	irq_dispose_mapping(irq);
201 err_irq:
202 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
203 
204 	if (ehci->has_amcc_usb23)
205 		iounmap(ehci->ohci_hcctrl_reg);
206 err_rmr:
207 	usb_put_hcd(hcd);
208 
209 	return rv;
210 }
211 
212 
213 static int ehci_hcd_ppc_of_remove(struct of_device *op)
214 {
215 	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
216 	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
217 
218 	struct device_node *np;
219 	struct resource res;
220 
221 	dev_set_drvdata(&op->dev, NULL);
222 
223 	dev_dbg(&op->dev, "stopping PPC-OF USB Controller\n");
224 
225 	usb_remove_hcd(hcd);
226 
227 	iounmap(hcd->regs);
228 	irq_dispose_mapping(hcd->irq);
229 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
230 
231 	/* use request_mem_region to test if the ohci driver is loaded.  if so
232 	 * ensure the ohci core is operational.
233 	 */
234 	if (ehci->has_amcc_usb23) {
235 		np = of_find_compatible_node(NULL, NULL, "ibm,usb-ohci-440epx");
236 		if (np != NULL) {
237 			if (!of_address_to_resource(np, 0, &res))
238 				if (!request_mem_region(res.start,
239 							    0x4, hcd_name))
240 					set_ohci_hcfs(ehci, 1);
241 				else
242 					release_mem_region(res.start, 0x4);
243 			else
244 				pr_debug(__FILE__ ": no ohci offset in fdt\n");
245 			of_node_put(np);
246 		}
247 
248 		iounmap(ehci->ohci_hcctrl_reg);
249 	}
250 	usb_put_hcd(hcd);
251 
252 	return 0;
253 }
254 
255 
256 static int ehci_hcd_ppc_of_shutdown(struct of_device *op)
257 {
258 	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
259 
260 	if (hcd->driver->shutdown)
261 		hcd->driver->shutdown(hcd);
262 
263 	return 0;
264 }
265 
266 
267 static struct of_device_id ehci_hcd_ppc_of_match[] = {
268 	{
269 		.compatible = "usb-ehci",
270 	},
271 	{},
272 };
273 MODULE_DEVICE_TABLE(of, ehci_hcd_ppc_of_match);
274 
275 
276 static struct of_platform_driver ehci_hcd_ppc_of_driver = {
277 	.name		= "ppc-of-ehci",
278 	.match_table	= ehci_hcd_ppc_of_match,
279 	.probe		= ehci_hcd_ppc_of_probe,
280 	.remove		= ehci_hcd_ppc_of_remove,
281 	.shutdown	= ehci_hcd_ppc_of_shutdown,
282 	.driver		= {
283 		.name	= "ppc-of-ehci",
284 		.owner	= THIS_MODULE,
285 	},
286 };
287