2 * Generic platform ehci driver
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>
8 * Derived from the ohci-ssb driver
9 * Copyright 2007 Michael Buesch <m@bues.ch>
11 * Derived from the EHCI-PCI driver
12 * Copyright (c) 2000-2004 by David Brownell
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
20 * Licensed under the GNU/GPL. See COPYING for details.
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>
28 #include <linux/module.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>
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)
43 struct ehci_platform_priv {
44 struct clk *clks[EHCI_MAX_CLKS];
45 struct reset_control *rst;
49 static const char hcd_name[] = "ehci-platform";
51 static int ehci_platform_reset(struct usb_hcd *hcd)
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);
58 hcd->has_tt = pdata->has_tt;
59 ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
61 if (pdata->pre_setup) {
62 retval = pdata->pre_setup(hcd);
67 ehci->caps = hcd->regs + pdata->caps_offset;
68 retval = ehci_setup(hcd);
72 if (pdata->no_io_watchdog)
73 ehci->need_io_watchdog = 0;
77 static int ehci_platform_power_on(struct platform_device *dev)
79 struct usb_hcd *hcd = platform_get_drvdata(dev);
80 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
83 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) {
84 ret = clk_prepare_enable(priv->clks[clk]);
86 goto err_disable_clks;
90 ret = phy_init(priv->phy);
92 goto err_disable_clks;
94 ret = phy_power_on(priv->phy);
105 clk_disable_unprepare(priv->clks[clk]);
110 static void ehci_platform_power_off(struct platform_device *dev)
112 struct usb_hcd *hcd = platform_get_drvdata(dev);
113 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
117 phy_power_off(priv->phy);
121 for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--)
123 clk_disable_unprepare(priv->clks[clk]);
126 static struct hc_driver __read_mostly ehci_platform_hc_driver;
128 static const struct ehci_driver_overrides platform_overrides __initconst = {
129 .reset = ehci_platform_reset,
130 .extra_priv_size = sizeof(struct ehci_platform_priv),
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,
139 static int ehci_platform_probe(struct platform_device *dev)
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;
152 * Use reasonable defaults so platforms don't have to provide these
153 * with DT probing on ARM.
156 pdata = &ehci_platform_defaults;
158 err = dma_coerce_mask_and_coherent(&dev->dev, DMA_BIT_MASK(32));
162 irq = platform_get_irq(dev, 0);
164 dev_err(&dev->dev, "no irq provided");
167 res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
169 dev_err(&dev->dev, "no memory resource provided");
173 hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
174 dev_name(&dev->dev));
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);
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;
187 if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
188 ehci->big_endian_desc = 1;
190 if (of_property_read_bool(dev->dev.of_node, "big-endian"))
191 ehci->big_endian_mmio = ehci->big_endian_desc = 1;
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)
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)
207 priv->clks[clk] = NULL;
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)
220 err = reset_control_deassert(priv->rst);
225 if (pdata->big_endian_desc)
226 ehci->big_endian_desc = 1;
227 if (pdata->big_endian_mmio)
228 ehci->big_endian_mmio = 1;
230 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
231 if (ehci->big_endian_mmio) {
233 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n");
238 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
239 if (ehci->big_endian_desc) {
241 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n");
247 if (pdata->power_on) {
248 err = pdata->power_on(dev);
253 hcd->rsrc_start = res_mem->start;
254 hcd->rsrc_len = resource_size(res_mem);
256 hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
257 if (IS_ERR(hcd->regs)) {
258 err = PTR_ERR(hcd->regs);
261 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
265 device_wakeup_enable(hcd->self.controller);
266 platform_set_drvdata(dev, hcd);
271 if (pdata->power_off)
272 pdata->power_off(dev);
275 reset_control_assert(priv->rst);
278 clk_put(priv->clks[clk]);
280 if (pdata == &ehci_platform_defaults)
281 dev->dev.platform_data = NULL;
288 static int ehci_platform_remove(struct platform_device *dev)
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);
297 if (pdata->power_off)
298 pdata->power_off(dev);
301 reset_control_assert(priv->rst);
303 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++)
304 clk_put(priv->clks[clk]);
308 if (pdata == &ehci_platform_defaults)
309 dev->dev.platform_data = NULL;
316 static int ehci_platform_suspend(struct device *dev)
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);
325 ret = ehci_suspend(hcd, do_wakeup);
329 if (pdata->power_suspend)
330 pdata->power_suspend(pdev);
335 static int ehci_platform_resume(struct device *dev)
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);
342 if (pdata->power_on) {
343 int err = pdata->power_on(pdev);
348 ehci_resume(hcd, false);
352 #else /* !CONFIG_PM */
353 #define ehci_platform_suspend NULL
354 #define ehci_platform_resume NULL
355 #endif /* CONFIG_PM */
357 static const struct of_device_id vt8500_ehci_ids[] = {
358 { .compatible = "via,vt8500-ehci", },
359 { .compatible = "wm,prizm-ehci", },
360 { .compatible = "generic-ehci", },
363 MODULE_DEVICE_TABLE(of, vt8500_ehci_ids);
365 static const struct platform_device_id ehci_platform_table[] = {
366 { "ehci-platform", 0 },
369 MODULE_DEVICE_TABLE(platform, ehci_platform_table);
371 static const struct dev_pm_ops ehci_platform_pm_ops = {
372 .suspend = ehci_platform_suspend,
373 .resume = ehci_platform_resume,
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,
382 .owner = THIS_MODULE,
383 .name = "ehci-platform",
384 .pm = &ehci_platform_pm_ops,
385 .of_match_table = vt8500_ehci_ids,
389 static int __init ehci_platform_init(void)
394 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
396 ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
397 return platform_driver_register(&ehci_platform_driver);
399 module_init(ehci_platform_init);
401 static void __exit ehci_platform_cleanup(void)
403 platform_driver_unregister(&ehci_platform_driver);
405 module_exit(ehci_platform_cleanup);
407 MODULE_DESCRIPTION(DRIVER_DESC);
408 MODULE_AUTHOR("Hauke Mehrtens");
409 MODULE_AUTHOR("Alan Stern");
410 MODULE_LICENSE("GPL");