1 /*
2 * Generic platform ehci driver
3 *
4 * Copyright 2007 Steven Brown <sbrown@cortland.com>
5 * Copyright 2010-2012 Hauke Mehrtens <hauke@hauke-m.de>
6 * Copyright 2014 Hans de Goede <hdegoede@redhat.com>
7 *
8 * Derived from the ohci-ssb driver
9 * Copyright 2007 Michael Buesch <m@bues.ch>
10 *
11 * Derived from the EHCI-PCI driver
12 * Copyright (c) 2000-2004 by David Brownell
13 *
14 * Derived from the ohci-pci driver
15 * Copyright 1999 Roman Weissgaerber
16 * Copyright 2000-2002 David Brownell
17 * Copyright 1999 Linus Torvalds
18 * Copyright 1999 Gregory P. Smith
19 *
20 * Licensed under the GNU/GPL. See COPYING for details.
21 */
22 #include <linux/clk.h>
23 #include <linux/dma-mapping.h>
24 #include <linux/err.h>
25 #include <linux/kernel.h>
26 #include <linux/hrtimer.h>
27 #include <linux/io.h>
28 #include <linux/module.h>
29 #include <linux/of.h>
30 #include <linux/phy/phy.h>
31 #include <linux/platform_device.h>
32 #include <linux/reset.h>
33 #include <linux/usb.h>
34 #include <linux/usb/hcd.h>
35 #include <linux/usb/ehci_pdriver.h>
36
37 #include "ehci.h"
38
39 #define DRIVER_DESC "EHCI generic platform driver"
40 #define EHCI_MAX_CLKS 3
41 #define hcd_to_ehci_priv(h) ((struct ehci_platform_priv *)hcd_to_ehci(h)->priv)
42
43 struct ehci_platform_priv {
44 struct clk *clks[EHCI_MAX_CLKS];
45 struct reset_control *rst;
46 struct phy *phy;
47 };
48
49 static const char hcd_name[] = "ehci-platform";
50
ehci_platform_reset(struct usb_hcd * hcd)51 static int ehci_platform_reset(struct usb_hcd *hcd)
52 {
53 struct platform_device *pdev = to_platform_device(hcd->self.controller);
54 struct usb_ehci_pdata *pdata = dev_get_platdata(&pdev->dev);
55 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
56 int retval;
57
58 hcd->has_tt = pdata->has_tt;
59 ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
60
61 if (pdata->pre_setup) {
62 retval = pdata->pre_setup(hcd);
63 if (retval < 0)
64 return retval;
65 }
66
67 ehci->caps = hcd->regs + pdata->caps_offset;
68 retval = ehci_setup(hcd);
69 if (retval)
70 return retval;
71
72 if (pdata->no_io_watchdog)
73 ehci->need_io_watchdog = 0;
74 return 0;
75 }
76
ehci_platform_power_on(struct platform_device * dev)77 static int ehci_platform_power_on(struct platform_device *dev)
78 {
79 struct usb_hcd *hcd = platform_get_drvdata(dev);
80 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
81 int clk, ret;
82
83 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) {
84 ret = clk_prepare_enable(priv->clks[clk]);
85 if (ret)
86 goto err_disable_clks;
87 }
88
89 if (priv->phy) {
90 ret = phy_init(priv->phy);
91 if (ret)
92 goto err_disable_clks;
93
94 ret = phy_power_on(priv->phy);
95 if (ret)
96 goto err_exit_phy;
97 }
98
99 return 0;
100
101 err_exit_phy:
102 phy_exit(priv->phy);
103 err_disable_clks:
104 while (--clk >= 0)
105 clk_disable_unprepare(priv->clks[clk]);
106
107 return ret;
108 }
109
ehci_platform_power_off(struct platform_device * dev)110 static void ehci_platform_power_off(struct platform_device *dev)
111 {
112 struct usb_hcd *hcd = platform_get_drvdata(dev);
113 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
114 int clk;
115
116 if (priv->phy) {
117 phy_power_off(priv->phy);
118 phy_exit(priv->phy);
119 }
120
121 for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--)
122 if (priv->clks[clk])
123 clk_disable_unprepare(priv->clks[clk]);
124 }
125
126 static struct hc_driver __read_mostly ehci_platform_hc_driver;
127
128 static const struct ehci_driver_overrides platform_overrides __initconst = {
129 .reset = ehci_platform_reset,
130 .extra_priv_size = sizeof(struct ehci_platform_priv),
131 };
132
133 static struct usb_ehci_pdata ehci_platform_defaults = {
134 .power_on = ehci_platform_power_on,
135 .power_suspend = ehci_platform_power_off,
136 .power_off = ehci_platform_power_off,
137 };
138
ehci_platform_probe(struct platform_device * dev)139 static int ehci_platform_probe(struct platform_device *dev)
140 {
141 struct usb_hcd *hcd;
142 struct resource *res_mem;
143 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
144 struct ehci_platform_priv *priv;
145 struct ehci_hcd *ehci;
146 int err, irq, clk = 0;
147
148 if (usb_disabled())
149 return -ENODEV;
150
151 /*
152 * Use reasonable defaults so platforms don't have to provide these
153 * with DT probing on ARM.
154 */
155 if (!pdata)
156 pdata = &ehci_platform_defaults;
157
158 err = dma_coerce_mask_and_coherent(&dev->dev, DMA_BIT_MASK(32));
159 if (err)
160 return err;
161
162 irq = platform_get_irq(dev, 0);
163 if (irq < 0) {
164 dev_err(&dev->dev, "no irq provided");
165 return irq;
166 }
167 res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
168 if (!res_mem) {
169 dev_err(&dev->dev, "no memory resource provided");
170 return -ENXIO;
171 }
172
173 hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
174 dev_name(&dev->dev));
175 if (!hcd)
176 return -ENOMEM;
177
178 platform_set_drvdata(dev, hcd);
179 dev->dev.platform_data = pdata;
180 priv = hcd_to_ehci_priv(hcd);
181 ehci = hcd_to_ehci(hcd);
182
183 if (pdata == &ehci_platform_defaults && dev->dev.of_node) {
184 if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
185 ehci->big_endian_mmio = 1;
186
187 if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
188 ehci->big_endian_desc = 1;
189
190 if (of_property_read_bool(dev->dev.of_node, "big-endian"))
191 ehci->big_endian_mmio = ehci->big_endian_desc = 1;
192
193 priv->phy = devm_phy_get(&dev->dev, "usb");
194 if (IS_ERR(priv->phy)) {
195 err = PTR_ERR(priv->phy);
196 if (err == -EPROBE_DEFER)
197 goto err_put_hcd;
198 priv->phy = NULL;
199 }
200
201 for (clk = 0; clk < EHCI_MAX_CLKS; clk++) {
202 priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
203 if (IS_ERR(priv->clks[clk])) {
204 err = PTR_ERR(priv->clks[clk]);
205 if (err == -EPROBE_DEFER)
206 goto err_put_clks;
207 priv->clks[clk] = NULL;
208 break;
209 }
210 }
211 }
212
213 priv->rst = devm_reset_control_get_optional(&dev->dev, NULL);
214 if (IS_ERR(priv->rst)) {
215 err = PTR_ERR(priv->rst);
216 if (err == -EPROBE_DEFER)
217 goto err_put_clks;
218 priv->rst = NULL;
219 } else {
220 err = reset_control_deassert(priv->rst);
221 if (err)
222 goto err_put_clks;
223 }
224
225 if (pdata->big_endian_desc)
226 ehci->big_endian_desc = 1;
227 if (pdata->big_endian_mmio)
228 ehci->big_endian_mmio = 1;
229
230 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
231 if (ehci->big_endian_mmio) {
232 dev_err(&dev->dev,
233 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n");
234 err = -EINVAL;
235 goto err_reset;
236 }
237 #endif
238 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
239 if (ehci->big_endian_desc) {
240 dev_err(&dev->dev,
241 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n");
242 err = -EINVAL;
243 goto err_reset;
244 }
245 #endif
246
247 if (pdata->power_on) {
248 err = pdata->power_on(dev);
249 if (err < 0)
250 goto err_reset;
251 }
252
253 hcd->rsrc_start = res_mem->start;
254 hcd->rsrc_len = resource_size(res_mem);
255
256 hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
257 if (IS_ERR(hcd->regs)) {
258 err = PTR_ERR(hcd->regs);
259 goto err_power;
260 }
261 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
262 if (err)
263 goto err_power;
264
265 device_wakeup_enable(hcd->self.controller);
266 platform_set_drvdata(dev, hcd);
267
268 return err;
269
270 err_power:
271 if (pdata->power_off)
272 pdata->power_off(dev);
273 err_reset:
274 if (priv->rst)
275 reset_control_assert(priv->rst);
276 err_put_clks:
277 while (--clk >= 0)
278 clk_put(priv->clks[clk]);
279 err_put_hcd:
280 if (pdata == &ehci_platform_defaults)
281 dev->dev.platform_data = NULL;
282
283 usb_put_hcd(hcd);
284
285 return err;
286 }
287
ehci_platform_remove(struct platform_device * dev)288 static int ehci_platform_remove(struct platform_device *dev)
289 {
290 struct usb_hcd *hcd = platform_get_drvdata(dev);
291 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
292 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
293 int clk;
294
295 usb_remove_hcd(hcd);
296
297 if (pdata->power_off)
298 pdata->power_off(dev);
299
300 if (priv->rst)
301 reset_control_assert(priv->rst);
302
303 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++)
304 clk_put(priv->clks[clk]);
305
306 usb_put_hcd(hcd);
307
308 if (pdata == &ehci_platform_defaults)
309 dev->dev.platform_data = NULL;
310
311 return 0;
312 }
313
314 #ifdef CONFIG_PM
315
ehci_platform_suspend(struct device * dev)316 static int ehci_platform_suspend(struct device *dev)
317 {
318 struct usb_hcd *hcd = dev_get_drvdata(dev);
319 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
320 struct platform_device *pdev =
321 container_of(dev, struct platform_device, dev);
322 bool do_wakeup = device_may_wakeup(dev);
323 int ret;
324
325 ret = ehci_suspend(hcd, do_wakeup);
326 if (ret)
327 return ret;
328
329 if (pdata->power_suspend)
330 pdata->power_suspend(pdev);
331
332 return ret;
333 }
334
ehci_platform_resume(struct device * dev)335 static int ehci_platform_resume(struct device *dev)
336 {
337 struct usb_hcd *hcd = dev_get_drvdata(dev);
338 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
339 struct platform_device *pdev =
340 container_of(dev, struct platform_device, dev);
341
342 if (pdata->power_on) {
343 int err = pdata->power_on(pdev);
344 if (err < 0)
345 return err;
346 }
347
348 ehci_resume(hcd, false);
349 return 0;
350 }
351
352 #else /* !CONFIG_PM */
353 #define ehci_platform_suspend NULL
354 #define ehci_platform_resume NULL
355 #endif /* CONFIG_PM */
356
357 static const struct of_device_id vt8500_ehci_ids[] = {
358 { .compatible = "via,vt8500-ehci", },
359 { .compatible = "wm,prizm-ehci", },
360 { .compatible = "generic-ehci", },
361 {}
362 };
363 MODULE_DEVICE_TABLE(of, vt8500_ehci_ids);
364
365 static const struct platform_device_id ehci_platform_table[] = {
366 { "ehci-platform", 0 },
367 { }
368 };
369 MODULE_DEVICE_TABLE(platform, ehci_platform_table);
370
371 static const struct dev_pm_ops ehci_platform_pm_ops = {
372 .suspend = ehci_platform_suspend,
373 .resume = ehci_platform_resume,
374 };
375
376 static struct platform_driver ehci_platform_driver = {
377 .id_table = ehci_platform_table,
378 .probe = ehci_platform_probe,
379 .remove = ehci_platform_remove,
380 .shutdown = usb_hcd_platform_shutdown,
381 .driver = {
382 .owner = THIS_MODULE,
383 .name = "ehci-platform",
384 .pm = &ehci_platform_pm_ops,
385 .of_match_table = vt8500_ehci_ids,
386 }
387 };
388
ehci_platform_init(void)389 static int __init ehci_platform_init(void)
390 {
391 if (usb_disabled())
392 return -ENODEV;
393
394 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
395
396 ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
397 return platform_driver_register(&ehci_platform_driver);
398 }
399 module_init(ehci_platform_init);
400
ehci_platform_cleanup(void)401 static void __exit ehci_platform_cleanup(void)
402 {
403 platform_driver_unregister(&ehci_platform_driver);
404 }
405 module_exit(ehci_platform_cleanup);
406
407 MODULE_DESCRIPTION(DRIVER_DESC);
408 MODULE_AUTHOR("Hauke Mehrtens");
409 MODULE_AUTHOR("Alan Stern");
410 MODULE_LICENSE("GPL");
411