xref: /openbmc/linux/drivers/usb/host/ehci-ppc-of.c (revision 089a49b6)
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 
24 static 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,
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)
77 static int
78 ppc44x_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 
93 static 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 		printk(KERN_ERR "%s: irq_of_parse_and_map failed\n", __FILE__);
123 		rv = -EBUSY;
124 		goto err_irq;
125 	}
126 
127 	hcd->regs = devm_ioremap_resource(&op->dev, &res);
128 	if (IS_ERR(hcd->regs)) {
129 		rv = PTR_ERR(hcd->regs);
130 		goto err_ioremap;
131 	}
132 
133 	ehci = hcd_to_ehci(hcd);
134 	np = of_find_compatible_node(NULL, NULL, "ibm,usb-ohci-440epx");
135 	if (np != NULL) {
136 		/* claim we really affected by usb23 erratum */
137 		if (!of_address_to_resource(np, 0, &res))
138 			ehci->ohci_hcctrl_reg =
139 				devm_ioremap(&op->dev,
140 					     res.start + OHCI_HCCTRL_OFFSET,
141 					     OHCI_HCCTRL_LEN);
142 		else
143 			pr_debug("%s: no ohci offset in fdt\n", __FILE__);
144 		if (!ehci->ohci_hcctrl_reg) {
145 			pr_debug("%s: ioremap for ohci hcctrl failed\n", __FILE__);
146 		} else {
147 			ehci->has_amcc_usb23 = 1;
148 		}
149 	}
150 
151 	if (of_get_property(dn, "big-endian", NULL)) {
152 		ehci->big_endian_mmio = 1;
153 		ehci->big_endian_desc = 1;
154 	}
155 	if (of_get_property(dn, "big-endian-regs", NULL))
156 		ehci->big_endian_mmio = 1;
157 	if (of_get_property(dn, "big-endian-desc", NULL))
158 		ehci->big_endian_desc = 1;
159 
160 	ehci->caps = hcd->regs;
161 
162 	if (of_device_is_compatible(dn, "ibm,usb-ehci-440epx")) {
163 		rv = ppc44x_enable_bmt(dn);
164 		ehci_dbg(ehci, "Break Memory Transfer (BMT) is %senabled!\n",
165 				rv ? "NOT ": "");
166 	}
167 
168 	rv = usb_add_hcd(hcd, irq, 0);
169 	if (rv)
170 		goto err_ioremap;
171 
172 	return 0;
173 
174 err_ioremap:
175 	irq_dispose_mapping(irq);
176 err_irq:
177 	usb_put_hcd(hcd);
178 
179 	return rv;
180 }
181 
182 
183 static int ehci_hcd_ppc_of_remove(struct platform_device *op)
184 {
185 	struct usb_hcd *hcd = platform_get_drvdata(op);
186 	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
187 
188 	struct device_node *np;
189 	struct resource res;
190 
191 	dev_dbg(&op->dev, "stopping PPC-OF USB Controller\n");
192 
193 	usb_remove_hcd(hcd);
194 
195 	irq_dispose_mapping(hcd->irq);
196 
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
210 				pr_debug("%s: no ohci offset in fdt\n", __FILE__);
211 			of_node_put(np);
212 		}
213 	}
214 	usb_put_hcd(hcd);
215 
216 	return 0;
217 }
218 
219 
220 static const struct of_device_id ehci_hcd_ppc_of_match[] = {
221 	{
222 		.compatible = "usb-ehci",
223 	},
224 	{},
225 };
226 MODULE_DEVICE_TABLE(of, ehci_hcd_ppc_of_match);
227 
228 
229 static struct platform_driver ehci_hcd_ppc_of_driver = {
230 	.probe		= ehci_hcd_ppc_of_probe,
231 	.remove		= ehci_hcd_ppc_of_remove,
232 	.shutdown	= usb_hcd_platform_shutdown,
233 	.driver = {
234 		.name = "ppc-of-ehci",
235 		.owner = THIS_MODULE,
236 		.of_match_table = ehci_hcd_ppc_of_match,
237 	},
238 };
239