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/acpi.h>
23 #include <linux/clk.h>
24 #include <linux/dma-mapping.h>
25 #include <linux/err.h>
26 #include <linux/kernel.h>
27 #include <linux/hrtimer.h>
29 #include <linux/module.h>
31 #include <linux/phy/phy.h>
32 #include <linux/platform_device.h>
33 #include <linux/reset.h>
34 #include <linux/usb.h>
35 #include <linux/usb/hcd.h>
36 #include <linux/usb/ehci_pdriver.h>
40 #define DRIVER_DESC "EHCI generic platform driver"
41 #define EHCI_MAX_CLKS 3
42 #define hcd_to_ehci_priv(h) ((struct ehci_platform_priv *)hcd_to_ehci(h)->priv)
44 struct ehci_platform_priv {
45 struct clk *clks[EHCI_MAX_CLKS];
46 struct reset_control *rst;
52 static const char hcd_name[] = "ehci-platform";
54 static int ehci_platform_reset(struct usb_hcd *hcd)
56 struct platform_device *pdev = to_platform_device(hcd->self.controller);
57 struct usb_ehci_pdata *pdata = dev_get_platdata(&pdev->dev);
58 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
61 ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
63 if (pdata->pre_setup) {
64 retval = pdata->pre_setup(hcd);
69 ehci->caps = hcd->regs + pdata->caps_offset;
70 retval = ehci_setup(hcd);
74 if (pdata->no_io_watchdog)
75 ehci->need_io_watchdog = 0;
79 static int ehci_platform_power_on(struct platform_device *dev)
81 struct usb_hcd *hcd = platform_get_drvdata(dev);
82 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
83 int clk, ret, phy_num;
85 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) {
86 ret = clk_prepare_enable(priv->clks[clk]);
88 goto err_disable_clks;
91 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
92 ret = phy_init(priv->phys[phy_num]);
95 ret = phy_power_on(priv->phys[phy_num]);
97 phy_exit(priv->phys[phy_num]);
105 while (--phy_num >= 0) {
106 phy_power_off(priv->phys[phy_num]);
107 phy_exit(priv->phys[phy_num]);
111 clk_disable_unprepare(priv->clks[clk]);
116 static void ehci_platform_power_off(struct platform_device *dev)
118 struct usb_hcd *hcd = platform_get_drvdata(dev);
119 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
122 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
123 phy_power_off(priv->phys[phy_num]);
124 phy_exit(priv->phys[phy_num]);
127 for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--)
129 clk_disable_unprepare(priv->clks[clk]);
132 static struct hc_driver __read_mostly ehci_platform_hc_driver;
134 static const struct ehci_driver_overrides platform_overrides __initconst = {
135 .reset = ehci_platform_reset,
136 .extra_priv_size = sizeof(struct ehci_platform_priv),
139 static struct usb_ehci_pdata ehci_platform_defaults = {
140 .power_on = ehci_platform_power_on,
141 .power_suspend = ehci_platform_power_off,
142 .power_off = ehci_platform_power_off,
145 static int ehci_platform_probe(struct platform_device *dev)
148 struct resource *res_mem;
149 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
150 struct ehci_platform_priv *priv;
151 struct ehci_hcd *ehci;
152 int err, irq, phy_num, clk = 0;
158 * Use reasonable defaults so platforms don't have to provide these
159 * with DT probing on ARM.
162 pdata = &ehci_platform_defaults;
164 err = dma_coerce_mask_and_coherent(&dev->dev,
165 pdata->dma_mask_64 ? DMA_BIT_MASK(64) : DMA_BIT_MASK(32));
167 dev_err(&dev->dev, "Error: DMA mask configuration failed\n");
171 irq = platform_get_irq(dev, 0);
173 dev_err(&dev->dev, "no irq provided");
177 hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
178 dev_name(&dev->dev));
182 platform_set_drvdata(dev, hcd);
183 dev->dev.platform_data = pdata;
184 priv = hcd_to_ehci_priv(hcd);
185 ehci = hcd_to_ehci(hcd);
187 if (pdata == &ehci_platform_defaults && dev->dev.of_node) {
188 if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
189 ehci->big_endian_mmio = 1;
191 if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
192 ehci->big_endian_desc = 1;
194 if (of_property_read_bool(dev->dev.of_node, "big-endian"))
195 ehci->big_endian_mmio = ehci->big_endian_desc = 1;
197 if (of_property_read_bool(dev->dev.of_node,
198 "needs-reset-on-resume"))
199 priv->reset_on_resume = true;
201 if (of_property_read_bool(dev->dev.of_node,
202 "has-transaction-translator"))
205 if (of_property_read_bool(dev->dev.of_node,
206 "no-relinquish-port"))
207 ehci_platform_hc_driver.relinquish_port = NULL;
209 priv->num_phys = of_count_phandle_with_args(dev->dev.of_node,
210 "phys", "#phy-cells");
212 if (priv->num_phys > 0) {
213 priv->phys = devm_kcalloc(&dev->dev, priv->num_phys,
214 sizeof(struct phy *), GFP_KERNEL);
220 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
221 priv->phys[phy_num] = devm_of_phy_get_by_index(
222 &dev->dev, dev->dev.of_node, phy_num);
223 if (IS_ERR(priv->phys[phy_num])) {
224 err = PTR_ERR(priv->phys[phy_num]);
229 for (clk = 0; clk < EHCI_MAX_CLKS; clk++) {
230 priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
231 if (IS_ERR(priv->clks[clk])) {
232 err = PTR_ERR(priv->clks[clk]);
233 if (err == -EPROBE_DEFER)
235 priv->clks[clk] = NULL;
241 priv->rst = devm_reset_control_get_optional(&dev->dev, NULL);
242 if (IS_ERR(priv->rst)) {
243 err = PTR_ERR(priv->rst);
244 if (err == -EPROBE_DEFER)
248 err = reset_control_deassert(priv->rst);
253 if (pdata->big_endian_desc)
254 ehci->big_endian_desc = 1;
255 if (pdata->big_endian_mmio)
256 ehci->big_endian_mmio = 1;
259 if (pdata->reset_on_resume)
260 priv->reset_on_resume = true;
262 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
263 if (ehci->big_endian_mmio) {
265 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n");
270 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
271 if (ehci->big_endian_desc) {
273 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n");
279 if (pdata->power_on) {
280 err = pdata->power_on(dev);
285 res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
286 hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
287 if (IS_ERR(hcd->regs)) {
288 err = PTR_ERR(hcd->regs);
291 hcd->rsrc_start = res_mem->start;
292 hcd->rsrc_len = resource_size(res_mem);
293 if (priv->num_phys == 1)
294 hcd->phy = priv->phys[0];
296 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
300 device_wakeup_enable(hcd->self.controller);
301 platform_set_drvdata(dev, hcd);
306 if (pdata->power_off)
307 pdata->power_off(dev);
310 reset_control_assert(priv->rst);
313 clk_put(priv->clks[clk]);
315 if (pdata == &ehci_platform_defaults)
316 dev->dev.platform_data = NULL;
323 static int ehci_platform_remove(struct platform_device *dev)
325 struct usb_hcd *hcd = platform_get_drvdata(dev);
326 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
327 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
332 if (pdata->power_off)
333 pdata->power_off(dev);
336 reset_control_assert(priv->rst);
338 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++)
339 clk_put(priv->clks[clk]);
343 if (pdata == &ehci_platform_defaults)
344 dev->dev.platform_data = NULL;
349 #ifdef CONFIG_PM_SLEEP
350 static int ehci_platform_suspend(struct device *dev)
352 struct usb_hcd *hcd = dev_get_drvdata(dev);
353 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
354 struct platform_device *pdev =
355 container_of(dev, struct platform_device, dev);
356 bool do_wakeup = device_may_wakeup(dev);
359 ret = ehci_suspend(hcd, do_wakeup);
363 if (pdata->power_suspend)
364 pdata->power_suspend(pdev);
369 static int ehci_platform_resume(struct device *dev)
371 struct usb_hcd *hcd = dev_get_drvdata(dev);
372 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
373 struct platform_device *pdev =
374 container_of(dev, struct platform_device, dev);
375 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
377 if (pdata->power_on) {
378 int err = pdata->power_on(pdev);
383 ehci_resume(hcd, priv->reset_on_resume);
386 #endif /* CONFIG_PM_SLEEP */
388 static const struct of_device_id vt8500_ehci_ids[] = {
389 { .compatible = "via,vt8500-ehci", },
390 { .compatible = "wm,prizm-ehci", },
391 { .compatible = "generic-ehci", },
392 { .compatible = "cavium,octeon-6335-ehci", },
395 MODULE_DEVICE_TABLE(of, vt8500_ehci_ids);
397 static const struct acpi_device_id ehci_acpi_match[] = {
398 { "PNP0D20", 0 }, /* EHCI controller without debug */
401 MODULE_DEVICE_TABLE(acpi, ehci_acpi_match);
403 static const struct platform_device_id ehci_platform_table[] = {
404 { "ehci-platform", 0 },
407 MODULE_DEVICE_TABLE(platform, ehci_platform_table);
409 static SIMPLE_DEV_PM_OPS(ehci_platform_pm_ops, ehci_platform_suspend,
410 ehci_platform_resume);
412 static struct platform_driver ehci_platform_driver = {
413 .id_table = ehci_platform_table,
414 .probe = ehci_platform_probe,
415 .remove = ehci_platform_remove,
416 .shutdown = usb_hcd_platform_shutdown,
418 .name = "ehci-platform",
419 .pm = &ehci_platform_pm_ops,
420 .of_match_table = vt8500_ehci_ids,
421 .acpi_match_table = ACPI_PTR(ehci_acpi_match),
425 static int __init ehci_platform_init(void)
430 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
432 ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
433 return platform_driver_register(&ehci_platform_driver);
435 module_init(ehci_platform_init);
437 static void __exit ehci_platform_cleanup(void)
439 platform_driver_unregister(&ehci_platform_driver);
441 module_exit(ehci_platform_cleanup);
443 MODULE_DESCRIPTION(DRIVER_DESC);
444 MODULE_AUTHOR("Hauke Mehrtens");
445 MODULE_AUTHOR("Alan Stern");
446 MODULE_LICENSE("GPL");