xref: /openbmc/linux/drivers/usb/host/ehci-ppc-of.c (revision a1e58bbd)
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 
65 	/*
66 	 * scheduling support
67 	 */
68 	.get_frame_number	= ehci_get_frame,
69 
70 	/*
71 	 * root hub support
72 	 */
73 	.hub_status_data	= ehci_hub_status_data,
74 	.hub_control		= ehci_hub_control,
75 #ifdef	CONFIG_PM
76 	.bus_suspend		= ehci_bus_suspend,
77 	.bus_resume		= ehci_bus_resume,
78 #endif
79 };
80 
81 
82 /*
83  * 440EPx Errata USBH_3
84  * Fix: Enable Break Memory Transfer (BMT) in INSNREG3
85  */
86 #define PPC440EPX_EHCI0_INSREG_BMT	(0x1 << 0)
87 static int __devinit
88 ppc44x_enable_bmt(struct device_node *dn)
89 {
90 	__iomem u32 *insreg_virt;
91 
92 	insreg_virt = of_iomap(dn, 1);
93 	if (!insreg_virt)
94 		return  -EINVAL;
95 
96 	out_be32(insreg_virt + 3, PPC440EPX_EHCI0_INSREG_BMT);
97 
98 	iounmap(insreg_virt);
99 	return 0;
100 }
101 
102 
103 static int __devinit
104 ehci_hcd_ppc_of_probe(struct of_device *op, const struct of_device_id *match)
105 {
106 	struct device_node *dn = op->node;
107 	struct usb_hcd *hcd;
108 	struct ehci_hcd	*ehci;
109 	struct resource res;
110 	int irq;
111 	int rv;
112 
113 	if (usb_disabled())
114 		return -ENODEV;
115 
116 	dev_dbg(&op->dev, "initializing PPC-OF USB Controller\n");
117 
118 	rv = of_address_to_resource(dn, 0, &res);
119 	if (rv)
120 		return rv;
121 
122 	hcd = usb_create_hcd(&ehci_ppc_of_hc_driver, &op->dev, "PPC-OF USB");
123 	if (!hcd)
124 		return -ENOMEM;
125 
126 	hcd->rsrc_start = res.start;
127 	hcd->rsrc_len = res.end - res.start + 1;
128 
129 	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
130 		printk(KERN_ERR __FILE__ ": request_mem_region failed\n");
131 		rv = -EBUSY;
132 		goto err_rmr;
133 	}
134 
135 	irq = irq_of_parse_and_map(dn, 0);
136 	if (irq == NO_IRQ) {
137 		printk(KERN_ERR __FILE__ ": irq_of_parse_and_map failed\n");
138 		rv = -EBUSY;
139 		goto err_irq;
140 	}
141 
142 	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
143 	if (!hcd->regs) {
144 		printk(KERN_ERR __FILE__ ": ioremap failed\n");
145 		rv = -ENOMEM;
146 		goto err_ioremap;
147 	}
148 
149 	ehci = hcd_to_ehci(hcd);
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 	ehci->regs = hcd->regs +
162 			HC_LENGTH(ehci_readl(ehci, &ehci->caps->hc_capbase));
163 
164 	/* cache this readonly data; minimize chip reads */
165 	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
166 
167 	if (of_device_is_compatible(dn, "ibm,usb-ehci-440epx")) {
168 		rv = ppc44x_enable_bmt(dn);
169 		ehci_dbg(ehci, "Break Memory Transfer (BMT) is %senabled!\n",
170 				rv ? "NOT ": "");
171 	}
172 
173 	rv = usb_add_hcd(hcd, irq, 0);
174 	if (rv == 0)
175 		return 0;
176 
177 	iounmap(hcd->regs);
178 err_ioremap:
179 	irq_dispose_mapping(irq);
180 err_irq:
181 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
182 err_rmr:
183 	usb_put_hcd(hcd);
184 
185 	return rv;
186 }
187 
188 
189 static int ehci_hcd_ppc_of_remove(struct of_device *op)
190 {
191 	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
192 	dev_set_drvdata(&op->dev, NULL);
193 
194 	dev_dbg(&op->dev, "stopping PPC-OF USB Controller\n");
195 
196 	usb_remove_hcd(hcd);
197 
198 	iounmap(hcd->regs);
199 	irq_dispose_mapping(hcd->irq);
200 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
201 
202 	usb_put_hcd(hcd);
203 
204 	return 0;
205 }
206 
207 
208 static int ehci_hcd_ppc_of_shutdown(struct of_device *op)
209 {
210 	struct usb_hcd *hcd = dev_get_drvdata(&op->dev);
211 
212 	if (hcd->driver->shutdown)
213 		hcd->driver->shutdown(hcd);
214 
215 	return 0;
216 }
217 
218 
219 static struct of_device_id ehci_hcd_ppc_of_match[] = {
220 	{
221 		.compatible = "usb-ehci",
222 	},
223 	{},
224 };
225 MODULE_DEVICE_TABLE(of, ehci_hcd_ppc_of_match);
226 
227 
228 static struct of_platform_driver ehci_hcd_ppc_of_driver = {
229 	.name		= "ppc-of-ehci",
230 	.match_table	= ehci_hcd_ppc_of_match,
231 	.probe		= ehci_hcd_ppc_of_probe,
232 	.remove		= ehci_hcd_ppc_of_remove,
233 	.shutdown	= ehci_hcd_ppc_of_shutdown,
234 	.driver		= {
235 		.name	= "ppc-of-ehci",
236 		.owner	= THIS_MODULE,
237 	},
238 };
239