drivers/usb/host/ehci-platform.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Generic platform ehci driver
   4  *
   5  * Copyright 2007 Steven Brown <sbrown@cortland.com>
   6  * Copyright 2010-2012 Hauke Mehrtens <hauke@hauke-m.de>
   7  * Copyright 2014 Hans de Goede <hdegoede@redhat.com>
   8  *
   9  * Derived from the ohci-ssb driver
  10  * Copyright 2007 Michael Buesch <m@bues.ch>
  11  *
  12  * Derived from the EHCI-PCI driver
  13  * Copyright (c) 2000-2004 by David Brownell
  14  *
  15  * Derived from the ohci-pci driver
  16  * Copyright 1999 Roman Weissgaerber
  17  * Copyright 2000-2002 David Brownell
  18  * Copyright 1999 Linus Torvalds
  19  * Copyright 1999 Gregory P. Smith
  20  */
  21 #include <linux/acpi.h>
  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/platform_device.h>
  31 #include <linux/reset.h>
  32 #include <linux/sys_soc.h>
  33 #include <linux/timer.h>
  34 #include <linux/usb.h>
  35 #include <linux/usb/hcd.h>
  36 #include <linux/usb/ehci_pdriver.h>
  37 #include <linux/usb/of.h>
  38
  39 #include "ehci.h"
  40
  41 #define DRIVER_DESC "EHCI generic platform driver"
  42 #define EHCI_MAX_CLKS 4
  43 #define hcd_to_ehci_priv(h) ((struct ehci_platform_priv *)hcd_to_ehci(h)->priv)
  44
  45 #define BCM_USB_FIFO_THRESHOLD  0x00800040
  46 #define bcm_iproc_insnreg01     hostpc[0]
  47
  48 struct ehci_platform_priv {
  49         struct clk *clks[EHCI_MAX_CLKS];
  50         struct reset_control *rsts;
  51         bool reset_on_resume;
  52         bool quirk_poll;
  53         struct timer_list poll_timer;
  54         struct delayed_work poll_work;
  55 };
  56
  57 static const char hcd_name[] = "ehci-platform";
  58
  59 static int ehci_platform_reset(struct usb_hcd *hcd)
  60 {
  61         struct platform_device *pdev = to_platform_device(hcd->self.controller);
  62         struct usb_ehci_pdata *pdata = dev_get_platdata(&pdev->dev);
  63         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
  64         int retval;
  65
  66         ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
  67
  68         if (pdata->pre_setup) {
  69                 retval = pdata->pre_setup(hcd);
  70                 if (retval < 0)
  71                         return retval;
  72         }
  73
  74         ehci->caps = hcd->regs + pdata->caps_offset;
  75         retval = ehci_setup(hcd);
  76         if (retval)
  77                 return retval;
  78
  79         if (pdata->no_io_watchdog)
  80                 ehci->need_io_watchdog = 0;
  81
  82         if (of_device_is_compatible(pdev->dev.of_node, "brcm,xgs-iproc-ehci"))
  83                 ehci_writel(ehci, BCM_USB_FIFO_THRESHOLD,
  84                             &ehci->regs->bcm_iproc_insnreg01);
  85
  86         return 0;
  87 }
  88
  89 static int ehci_platform_power_on(struct platform_device *dev)
  90 {
  91         struct usb_hcd *hcd = platform_get_drvdata(dev);
  92         struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
  93         int clk, ret;
  94
  95         for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) {
  96                 ret = clk_prepare_enable(priv->clks[clk]);
  97                 if (ret)
  98                         goto err_disable_clks;
  99         }
 100
 101         return 0;
 102
 103 err_disable_clks:
 104         while (--clk >= 0)
 105                 clk_disable_unprepare(priv->clks[clk]);
 106
 107         return ret;
 108 }
 109
 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         for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--)
 117                 if (priv->clks[clk])
 118                         clk_disable_unprepare(priv->clks[clk]);
 119 }
 120
 121 static struct hc_driver __read_mostly ehci_platform_hc_driver;
 122
 123 static const struct ehci_driver_overrides platform_overrides __initconst = {
 124         .reset =                ehci_platform_reset,
 125         .extra_priv_size =      sizeof(struct ehci_platform_priv),
 126 };
 127
 128 static struct usb_ehci_pdata ehci_platform_defaults = {
 129         .power_on =             ehci_platform_power_on,
 130         .power_suspend =        ehci_platform_power_off,
 131         .power_off =            ehci_platform_power_off,
 132 };
 133
 134 /**
 135  * quirk_poll_check_port_status - Poll port_status if the device sticks
 136  * @ehci: the ehci hcd pointer
 137  *
 138  * Since EHCI/OHCI controllers on R-Car Gen3 SoCs are possible to be getting
 139  * stuck very rarely after a full/low usb device was disconnected. To
 140  * detect such a situation, the controllers require a special way which poll
 141  * the EHCI PORTSC register.
 142  *
 143  * Return: true if the controller's port_status indicated getting stuck
 144  */
 145 static bool quirk_poll_check_port_status(struct ehci_hcd *ehci)
 146 {
 147         u32 port_status = ehci_readl(ehci, &ehci->regs->port_status[0]);
 148
 149         if (!(port_status & PORT_OWNER) &&
 150              (port_status & PORT_POWER) &&
 151             !(port_status & PORT_CONNECT) &&
 152              (port_status & PORT_LS_MASK))
 153                 return true;
 154
 155         return false;
 156 }
 157
 158 /**
 159  * quirk_poll_rebind_companion - rebind comanion device to recover
 160  * @ehci: the ehci hcd pointer
 161  *
 162  * Since EHCI/OHCI controllers on R-Car Gen3 SoCs are possible to be getting
 163  * stuck very rarely after a full/low usb device was disconnected. To
 164  * recover from such a situation, the controllers require changing the OHCI
 165  * functional state.
 166  */
 167 static void quirk_poll_rebind_companion(struct ehci_hcd *ehci)
 168 {
 169         struct device *companion_dev;
 170         struct usb_hcd *hcd = ehci_to_hcd(ehci);
 171
 172         companion_dev = usb_of_get_companion_dev(hcd->self.controller);
 173         if (!companion_dev)
 174                 return;
 175
 176         device_release_driver(companion_dev);
 177         if (device_attach(companion_dev) < 0)
 178                 ehci_err(ehci, "%s: failed\n", __func__);
 179
 180         put_device(companion_dev);
 181 }
 182
 183 static void quirk_poll_work(struct work_struct *work)
 184 {
 185         struct ehci_platform_priv *priv =
 186                 container_of(to_delayed_work(work), struct ehci_platform_priv,
 187                              poll_work);
 188         struct ehci_hcd *ehci = container_of((void *)priv, struct ehci_hcd,
 189                                              priv);
 190
 191         /* check the status twice to reduce misdetection rate */
 192         if (!quirk_poll_check_port_status(ehci))
 193                 return;
 194         udelay(10);
 195         if (!quirk_poll_check_port_status(ehci))
 196                 return;
 197
 198         ehci_dbg(ehci, "%s: detected getting stuck. rebind now!\n", __func__);
 199         quirk_poll_rebind_companion(ehci);
 200 }
 201
 202 static void quirk_poll_timer(struct timer_list *t)
 203 {
 204         struct ehci_platform_priv *priv = from_timer(priv, t, poll_timer);
 205         struct ehci_hcd *ehci = container_of((void *)priv, struct ehci_hcd,
 206                                              priv);
 207
 208         if (quirk_poll_check_port_status(ehci)) {
 209                 /*
 210                  * Now scheduling the work for testing the port more. Note that
 211                  * updating the status is possible to be delayed when
 212                  * reconnection. So, this uses delayed work with 5 ms delay
 213                  * to avoid misdetection.
 214                  */
 215                 schedule_delayed_work(&priv->poll_work, msecs_to_jiffies(5));
 216         }
 217
 218         mod_timer(&priv->poll_timer, jiffies + HZ);
 219 }
 220
 221 static void quirk_poll_init(struct ehci_platform_priv *priv)
 222 {
 223         INIT_DELAYED_WORK(&priv->poll_work, quirk_poll_work);
 224         timer_setup(&priv->poll_timer, quirk_poll_timer, 0);
 225         mod_timer(&priv->poll_timer, jiffies + HZ);
 226 }
 227
 228 static void quirk_poll_end(struct ehci_platform_priv *priv)
 229 {
 230         del_timer_sync(&priv->poll_timer);
 231         cancel_delayed_work(&priv->poll_work);
 232 }
 233
 234 static const struct soc_device_attribute quirk_poll_match[] = {
 235         { .family = "R-Car Gen3" },
 236         { /* sentinel*/ }
 237 };
 238
 239 static int ehci_platform_probe(struct platform_device *dev)
 240 {
 241         struct usb_hcd *hcd;
 242         struct resource *res_mem;
 243         struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
 244         struct ehci_platform_priv *priv;
 245         struct ehci_hcd *ehci;
 246         int err, irq, clk = 0;
 247
 248         if (usb_disabled())
 249                 return -ENODEV;
 250
 251         /*
 252          * Use reasonable defaults so platforms don't have to provide these
 253          * with DT probing on ARM.
 254          */
 255         if (!pdata)
 256                 pdata = &ehci_platform_defaults;
 257
 258         err = dma_coerce_mask_and_coherent(&dev->dev,
 259                 pdata->dma_mask_64 ? DMA_BIT_MASK(64) : DMA_BIT_MASK(32));
 260         if (err) {
 261                 dev_err(&dev->dev, "Error: DMA mask configuration failed\n");
 262                 return err;
 263         }
 264
 265         irq = platform_get_irq(dev, 0);
 266         if (irq < 0)
 267                 return irq;
 268
 269         hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
 270                              dev_name(&dev->dev));
 271         if (!hcd)
 272                 return -ENOMEM;
 273
 274         platform_set_drvdata(dev, hcd);
 275         dev->dev.platform_data = pdata;
 276         priv = hcd_to_ehci_priv(hcd);
 277         ehci = hcd_to_ehci(hcd);
 278
 279         if (pdata == &ehci_platform_defaults && dev->dev.of_node) {
 280                 if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
 281                         ehci->big_endian_mmio = 1;
 282
 283                 if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
 284                         ehci->big_endian_desc = 1;
 285
 286                 if (of_property_read_bool(dev->dev.of_node, "big-endian"))
 287                         ehci->big_endian_mmio = ehci->big_endian_desc = 1;
 288
 289                 if (of_property_read_bool(dev->dev.of_node,
 290                                           "needs-reset-on-resume"))
 291                         priv->reset_on_resume = true;
 292
 293                 if (of_property_read_bool(dev->dev.of_node,
 294                                           "has-transaction-translator"))
 295                         hcd->has_tt = 1;
 296
 297                 if (soc_device_match(quirk_poll_match))
 298                         priv->quirk_poll = true;
 299
 300                 for (clk = 0; clk < EHCI_MAX_CLKS; clk++) {
 301                         priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
 302                         if (IS_ERR(priv->clks[clk])) {
 303                                 err = PTR_ERR(priv->clks[clk]);
 304                                 if (err == -EPROBE_DEFER)
 305                                         goto err_put_clks;
 306                                 priv->clks[clk] = NULL;
 307                                 break;
 308                         }
 309                 }
 310         }
 311
 312         priv->rsts = devm_reset_control_array_get_optional_shared(&dev->dev);
 313         if (IS_ERR(priv->rsts)) {
 314                 err = PTR_ERR(priv->rsts);
 315                 goto err_put_clks;
 316         }
 317
 318         err = reset_control_deassert(priv->rsts);
 319         if (err)
 320                 goto err_put_clks;
 321
 322         if (pdata->big_endian_desc)
 323                 ehci->big_endian_desc = 1;
 324         if (pdata->big_endian_mmio)
 325                 ehci->big_endian_mmio = 1;
 326         if (pdata->has_tt)
 327                 hcd->has_tt = 1;
 328         if (pdata->reset_on_resume)
 329                 priv->reset_on_resume = true;
 330
 331 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
 332         if (ehci->big_endian_mmio) {
 333                 dev_err(&dev->dev,
 334                         "Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n");
 335                 err = -EINVAL;
 336                 goto err_reset;
 337         }
 338 #endif
 339 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
 340         if (ehci->big_endian_desc) {
 341                 dev_err(&dev->dev,
 342                         "Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n");
 343                 err = -EINVAL;
 344                 goto err_reset;
 345         }
 346 #endif
 347
 348         if (pdata->power_on) {
 349                 err = pdata->power_on(dev);
 350                 if (err < 0)
 351                         goto err_reset;
 352         }
 353
 354         res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
 355         hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
 356         if (IS_ERR(hcd->regs)) {
 357                 err = PTR_ERR(hcd->regs);
 358                 goto err_power;
 359         }
 360         hcd->rsrc_start = res_mem->start;
 361         hcd->rsrc_len = resource_size(res_mem);
 362
 363         err = usb_add_hcd(hcd, irq, IRQF_SHARED);
 364         if (err)
 365                 goto err_power;
 366
 367         device_wakeup_enable(hcd->self.controller);
 368         device_enable_async_suspend(hcd->self.controller);
 369         platform_set_drvdata(dev, hcd);
 370
 371         if (priv->quirk_poll)
 372                 quirk_poll_init(priv);
 373
 374         return err;
 375
 376 err_power:
 377         if (pdata->power_off)
 378                 pdata->power_off(dev);
 379 err_reset:
 380         reset_control_assert(priv->rsts);
 381 err_put_clks:
 382         while (--clk >= 0)
 383                 clk_put(priv->clks[clk]);
 384
 385         if (pdata == &ehci_platform_defaults)
 386                 dev->dev.platform_data = NULL;
 387
 388         usb_put_hcd(hcd);
 389
 390         return err;
 391 }
 392
 393 static int ehci_platform_remove(struct platform_device *dev)
 394 {
 395         struct usb_hcd *hcd = platform_get_drvdata(dev);
 396         struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
 397         struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
 398         int clk;
 399
 400         if (priv->quirk_poll)
 401                 quirk_poll_end(priv);
 402
 403         usb_remove_hcd(hcd);
 404
 405         if (pdata->power_off)
 406                 pdata->power_off(dev);
 407
 408         reset_control_assert(priv->rsts);
 409
 410         for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++)
 411                 clk_put(priv->clks[clk]);
 412
 413         usb_put_hcd(hcd);
 414
 415         if (pdata == &ehci_platform_defaults)
 416                 dev->dev.platform_data = NULL;
 417
 418         return 0;
 419 }
 420
 421 static int __maybe_unused ehci_platform_suspend(struct device *dev)
 422 {
 423         struct usb_hcd *hcd = dev_get_drvdata(dev);
 424         struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
 425         struct platform_device *pdev = to_platform_device(dev);
 426         struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
 427         bool do_wakeup = device_may_wakeup(dev);
 428         int ret;
 429
 430         if (priv->quirk_poll)
 431                 quirk_poll_end(priv);
 432
 433         ret = ehci_suspend(hcd, do_wakeup);
 434         if (ret)
 435                 return ret;
 436
 437         if (pdata->power_suspend)
 438                 pdata->power_suspend(pdev);
 439
 440         return ret;
 441 }
 442
 443 static int __maybe_unused ehci_platform_resume(struct device *dev)
 444 {
 445         struct usb_hcd *hcd = dev_get_drvdata(dev);
 446         struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
 447         struct platform_device *pdev = to_platform_device(dev);
 448         struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
 449         struct device *companion_dev;
 450
 451         if (pdata->power_on) {
 452                 int err = pdata->power_on(pdev);
 453                 if (err < 0)
 454                         return err;
 455         }
 456
 457         companion_dev = usb_of_get_companion_dev(hcd->self.controller);
 458         if (companion_dev) {
 459                 device_pm_wait_for_dev(hcd->self.controller, companion_dev);
 460                 put_device(companion_dev);
 461         }
 462
 463         ehci_resume(hcd, priv->reset_on_resume);
 464
 465         pm_runtime_disable(dev);
 466         pm_runtime_set_active(dev);
 467         pm_runtime_enable(dev);
 468
 469         if (priv->quirk_poll)
 470                 quirk_poll_init(priv);
 471
 472         return 0;
 473 }
 474
 475 static const struct of_device_id vt8500_ehci_ids[] = {
 476         { .compatible = "via,vt8500-ehci", },
 477         { .compatible = "wm,prizm-ehci", },
 478         { .compatible = "generic-ehci", },
 479         { .compatible = "cavium,octeon-6335-ehci", },
 480         {}
 481 };
 482 MODULE_DEVICE_TABLE(of, vt8500_ehci_ids);
 483
 484 #ifdef CONFIG_ACPI
 485 static const struct acpi_device_id ehci_acpi_match[] = {
 486         { "PNP0D20", 0 }, /* EHCI controller without debug */
 487         { }
 488 };
 489 MODULE_DEVICE_TABLE(acpi, ehci_acpi_match);
 490 #endif
 491
 492 static const struct platform_device_id ehci_platform_table[] = {
 493         { "ehci-platform", 0 },
 494         { }
 495 };
 496 MODULE_DEVICE_TABLE(platform, ehci_platform_table);
 497
 498 static SIMPLE_DEV_PM_OPS(ehci_platform_pm_ops, ehci_platform_suspend,
 499         ehci_platform_resume);
 500
 501 static struct platform_driver ehci_platform_driver = {
 502         .id_table       = ehci_platform_table,
 503         .probe          = ehci_platform_probe,
 504         .remove         = ehci_platform_remove,
 505         .shutdown       = usb_hcd_platform_shutdown,
 506         .driver         = {
 507                 .name   = "ehci-platform",
 508                 .pm     = pm_ptr(&ehci_platform_pm_ops),
 509                 .of_match_table = vt8500_ehci_ids,
 510                 .acpi_match_table = ACPI_PTR(ehci_acpi_match),
 511         }
 512 };
 513
 514 static int __init ehci_platform_init(void)
 515 {
 516         if (usb_disabled())
 517                 return -ENODEV;
 518
 519         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 520
 521         ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
 522         return platform_driver_register(&ehci_platform_driver);
 523 }
 524 module_init(ehci_platform_init);
 525
 526 static void __exit ehci_platform_cleanup(void)
 527 {
 528         platform_driver_unregister(&ehci_platform_driver);
 529 }
 530 module_exit(ehci_platform_cleanup);
 531
 532 MODULE_DESCRIPTION(DRIVER_DESC);
 533 MODULE_AUTHOR("Hauke Mehrtens");
 534 MODULE_AUTHOR("Alan Stern");
 535 MODULE_LICENSE("GPL");