drivers/usb/host/ehci-platform.c

   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/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>
  28 #include <linux/io.h>
  29 #include <linux/module.h>
  30 #include <linux/of.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>
  37
  38 #include "ehci.h"
  39
  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)
  43
  44 struct ehci_platform_priv {
  45         struct clk *clks[EHCI_MAX_CLKS];
  46         struct reset_control *rst;
  47         struct phy **phys;
  48         int num_phys;
  49         bool reset_on_resume;
  50 };
  51
  52 static const char hcd_name[] = "ehci-platform";
  53
  54 static void ehci_rockchip_relinquish_port(struct usb_hcd *hcd, int portnum)
  55 {
  56         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
  57         u32 __iomem *status_reg = &ehci->regs->port_status[--portnum];
  58         u32 portsc;
  59
  60         portsc = ehci_readl(ehci, status_reg);
  61         portsc &= ~(PORT_OWNER | PORT_RWC_BITS);
  62
  63         ehci_writel(ehci, portsc, status_reg);
  64 }
  65
  66 static int ehci_platform_reset(struct usb_hcd *hcd)
  67 {
  68         struct platform_device *pdev = to_platform_device(hcd->self.controller);
  69         struct usb_ehci_pdata *pdata = dev_get_platdata(&pdev->dev);
  70         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
  71         int retval;
  72
  73         ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
  74
  75         if (pdata->pre_setup) {
  76                 retval = pdata->pre_setup(hcd);
  77                 if (retval < 0)
  78                         return retval;
  79         }
  80
  81         ehci->caps = hcd->regs + pdata->caps_offset;
  82         retval = ehci_setup(hcd);
  83         if (retval)
  84                 return retval;
  85
  86         if (pdata->no_io_watchdog)
  87                 ehci->need_io_watchdog = 0;
  88         return 0;
  89 }
  90
  91 static int ehci_platform_power_on(struct platform_device *dev)
  92 {
  93         struct usb_hcd *hcd = platform_get_drvdata(dev);
  94         struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
  95         int clk, ret, phy_num;
  96
  97         for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) {
  98                 ret = clk_prepare_enable(priv->clks[clk]);
  99                 if (ret)
 100                         goto err_disable_clks;
 101         }
 102
 103         for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
 104                 ret = phy_init(priv->phys[phy_num]);
 105                 if (ret)
 106                         goto err_exit_phy;
 107                 ret = phy_power_on(priv->phys[phy_num]);
 108                 if (ret) {
 109                         phy_exit(priv->phys[phy_num]);
 110                         goto err_exit_phy;
 111                 }
 112         }
 113
 114         return 0;
 115
 116 err_exit_phy:
 117         while (--phy_num >= 0) {
 118                 phy_power_off(priv->phys[phy_num]);
 119                 phy_exit(priv->phys[phy_num]);
 120         }
 121 err_disable_clks:
 122         while (--clk >= 0)
 123                 clk_disable_unprepare(priv->clks[clk]);
 124
 125         return ret;
 126 }
 127
 128 static void ehci_platform_power_off(struct platform_device *dev)
 129 {
 130         struct usb_hcd *hcd = platform_get_drvdata(dev);
 131         struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
 132         int clk, phy_num;
 133
 134         for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
 135                 phy_power_off(priv->phys[phy_num]);
 136                 phy_exit(priv->phys[phy_num]);
 137         }
 138
 139         for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--)
 140                 if (priv->clks[clk])
 141                         clk_disable_unprepare(priv->clks[clk]);
 142 }
 143
 144 static struct hc_driver __read_mostly ehci_platform_hc_driver;
 145
 146 static const struct ehci_driver_overrides platform_overrides __initconst = {
 147         .reset =                ehci_platform_reset,
 148         .extra_priv_size =      sizeof(struct ehci_platform_priv),
 149 };
 150
 151 static struct usb_ehci_pdata ehci_platform_defaults = {
 152         .power_on =             ehci_platform_power_on,
 153         .power_suspend =        ehci_platform_power_off,
 154         .power_off =            ehci_platform_power_off,
 155 };
 156
 157 static int ehci_platform_probe(struct platform_device *dev)
 158 {
 159         struct usb_hcd *hcd;
 160         struct resource *res_mem;
 161         struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
 162         struct ehci_platform_priv *priv;
 163         struct ehci_hcd *ehci;
 164         int err, irq, phy_num, clk = 0;
 165
 166         if (usb_disabled())
 167                 return -ENODEV;
 168
 169         /*
 170          * Use reasonable defaults so platforms don't have to provide these
 171          * with DT probing on ARM.
 172          */
 173         if (!pdata)
 174                 pdata = &ehci_platform_defaults;
 175
 176         err = dma_coerce_mask_and_coherent(&dev->dev,
 177                 pdata->dma_mask_64 ? DMA_BIT_MASK(64) : DMA_BIT_MASK(32));
 178         if (err) {
 179                 dev_err(&dev->dev, "Error: DMA mask configuration failed\n");
 180                 return err;
 181         }
 182
 183         irq = platform_get_irq(dev, 0);
 184         if (irq < 0) {
 185                 dev_err(&dev->dev, "no irq provided");
 186                 return irq;
 187         }
 188
 189         hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
 190                              dev_name(&dev->dev));
 191         if (!hcd)
 192                 return -ENOMEM;
 193
 194         platform_set_drvdata(dev, hcd);
 195         dev->dev.platform_data = pdata;
 196         priv = hcd_to_ehci_priv(hcd);
 197         ehci = hcd_to_ehci(hcd);
 198
 199         if (pdata == &ehci_platform_defaults && dev->dev.of_node) {
 200                 if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
 201                         ehci->big_endian_mmio = 1;
 202
 203                 if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
 204                         ehci->big_endian_desc = 1;
 205
 206                 if (of_property_read_bool(dev->dev.of_node, "big-endian"))
 207                         ehci->big_endian_mmio = ehci->big_endian_desc = 1;
 208
 209                 if (of_property_read_bool(dev->dev.of_node,
 210                                           "needs-reset-on-resume"))
 211                         priv->reset_on_resume = true;
 212
 213                 if (of_property_read_bool(dev->dev.of_node,
 214                                           "has-transaction-translator"))
 215                         hcd->has_tt = 1;
 216
 217                 if (of_property_read_bool(dev->dev.of_node,
 218                                           "rockchip-relinquish-port"))
 219                         ehci_platform_hc_driver.relinquish_port =
 220                                           ehci_rockchip_relinquish_port;
 221
 222                 priv->num_phys = of_count_phandle_with_args(dev->dev.of_node,
 223                                 "phys", "#phy-cells");
 224
 225                 if (priv->num_phys > 0) {
 226                         priv->phys = devm_kcalloc(&dev->dev, priv->num_phys,
 227                                             sizeof(struct phy *), GFP_KERNEL);
 228                         if (!priv->phys)
 229                                 return -ENOMEM;
 230                 } else
 231                         priv->num_phys = 0;
 232
 233                 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
 234                         priv->phys[phy_num] = devm_of_phy_get_by_index(
 235                                         &dev->dev, dev->dev.of_node, phy_num);
 236                         if (IS_ERR(priv->phys[phy_num])) {
 237                                 err = PTR_ERR(priv->phys[phy_num]);
 238                                         goto err_put_hcd;
 239                         }
 240                 }
 241
 242                 for (clk = 0; clk < EHCI_MAX_CLKS; clk++) {
 243                         priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
 244                         if (IS_ERR(priv->clks[clk])) {
 245                                 err = PTR_ERR(priv->clks[clk]);
 246                                 if (err == -EPROBE_DEFER)
 247                                         goto err_put_clks;
 248                                 priv->clks[clk] = NULL;
 249                                 break;
 250                         }
 251                 }
 252         }
 253
 254         priv->rst = devm_reset_control_get_optional(&dev->dev, NULL);
 255         if (IS_ERR(priv->rst)) {
 256                 err = PTR_ERR(priv->rst);
 257                 if (err == -EPROBE_DEFER)
 258                         goto err_put_clks;
 259                 priv->rst = NULL;
 260         } else {
 261                 err = reset_control_deassert(priv->rst);
 262                 if (err)
 263                         goto err_put_clks;
 264         }
 265
 266         if (pdata->big_endian_desc)
 267                 ehci->big_endian_desc = 1;
 268         if (pdata->big_endian_mmio)
 269                 ehci->big_endian_mmio = 1;
 270         if (pdata->has_tt)
 271                 hcd->has_tt = 1;
 272         if (pdata->reset_on_resume)
 273                 priv->reset_on_resume = true;
 274
 275 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
 276         if (ehci->big_endian_mmio) {
 277                 dev_err(&dev->dev,
 278                         "Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n");
 279                 err = -EINVAL;
 280                 goto err_reset;
 281         }
 282 #endif
 283 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
 284         if (ehci->big_endian_desc) {
 285                 dev_err(&dev->dev,
 286                         "Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n");
 287                 err = -EINVAL;
 288                 goto err_reset;
 289         }
 290 #endif
 291
 292         if (pdata->power_on) {
 293                 err = pdata->power_on(dev);
 294                 if (err < 0)
 295                         goto err_reset;
 296         }
 297
 298         res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
 299         hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
 300         if (IS_ERR(hcd->regs)) {
 301                 err = PTR_ERR(hcd->regs);
 302                 goto err_power;
 303         }
 304         hcd->rsrc_start = res_mem->start;
 305         hcd->rsrc_len = resource_size(res_mem);
 306         if (priv->num_phys == 1)
 307                 hcd->phy = priv->phys[0];
 308
 309         err = usb_add_hcd(hcd, irq, IRQF_SHARED);
 310         if (err)
 311                 goto err_power;
 312
 313         device_wakeup_enable(hcd->self.controller);
 314         platform_set_drvdata(dev, hcd);
 315
 316         return err;
 317
 318 err_power:
 319         if (pdata->power_off)
 320                 pdata->power_off(dev);
 321 err_reset:
 322         if (priv->rst)
 323                 reset_control_assert(priv->rst);
 324 err_put_clks:
 325         while (--clk >= 0)
 326                 clk_put(priv->clks[clk]);
 327 err_put_hcd:
 328         if (pdata == &ehci_platform_defaults)
 329                 dev->dev.platform_data = NULL;
 330
 331         usb_put_hcd(hcd);
 332
 333         return err;
 334 }
 335
 336 static int ehci_platform_remove(struct platform_device *dev)
 337 {
 338         struct usb_hcd *hcd = platform_get_drvdata(dev);
 339         struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
 340         struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
 341         int clk;
 342
 343         usb_remove_hcd(hcd);
 344
 345         if (pdata->power_off)
 346                 pdata->power_off(dev);
 347
 348         if (priv->rst)
 349                 reset_control_assert(priv->rst);
 350
 351         for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++)
 352                 clk_put(priv->clks[clk]);
 353
 354         usb_put_hcd(hcd);
 355
 356         if (pdata == &ehci_platform_defaults)
 357                 dev->dev.platform_data = NULL;
 358
 359         return 0;
 360 }
 361
 362 #ifdef CONFIG_PM_SLEEP
 363 static int ehci_platform_suspend(struct device *dev)
 364 {
 365         struct usb_hcd *hcd = dev_get_drvdata(dev);
 366         struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
 367         struct platform_device *pdev =
 368                 container_of(dev, struct platform_device, dev);
 369         bool do_wakeup = device_may_wakeup(dev);
 370         int ret;
 371
 372         ret = ehci_suspend(hcd, do_wakeup);
 373         if (ret)
 374                 return ret;
 375
 376         if (pdata->power_suspend)
 377                 pdata->power_suspend(pdev);
 378
 379         return ret;
 380 }
 381
 382 static int ehci_platform_resume(struct device *dev)
 383 {
 384         struct usb_hcd *hcd = dev_get_drvdata(dev);
 385         struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
 386         struct platform_device *pdev =
 387                 container_of(dev, struct platform_device, dev);
 388         struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
 389
 390         if (pdata->power_on) {
 391                 int err = pdata->power_on(pdev);
 392                 if (err < 0)
 393                         return err;
 394         }
 395
 396         ehci_resume(hcd, priv->reset_on_resume);
 397         return 0;
 398 }
 399 #endif /* CONFIG_PM_SLEEP */
 400
 401 static const struct of_device_id vt8500_ehci_ids[] = {
 402         { .compatible = "via,vt8500-ehci", },
 403         { .compatible = "wm,prizm-ehci", },
 404         { .compatible = "generic-ehci", },
 405         { .compatible = "cavium,octeon-6335-ehci", },
 406         {}
 407 };
 408 MODULE_DEVICE_TABLE(of, vt8500_ehci_ids);
 409
 410 static const struct acpi_device_id ehci_acpi_match[] = {
 411         { "PNP0D20", 0 }, /* EHCI controller without debug */
 412         { }
 413 };
 414 MODULE_DEVICE_TABLE(acpi, ehci_acpi_match);
 415
 416 static const struct platform_device_id ehci_platform_table[] = {
 417         { "ehci-platform", 0 },
 418         { }
 419 };
 420 MODULE_DEVICE_TABLE(platform, ehci_platform_table);
 421
 422 static SIMPLE_DEV_PM_OPS(ehci_platform_pm_ops, ehci_platform_suspend,
 423         ehci_platform_resume);
 424
 425 static struct platform_driver ehci_platform_driver = {
 426         .id_table       = ehci_platform_table,
 427         .probe          = ehci_platform_probe,
 428         .remove         = ehci_platform_remove,
 429         .shutdown       = usb_hcd_platform_shutdown,
 430         .driver         = {
 431                 .name   = "ehci-platform",
 432                 .pm     = &ehci_platform_pm_ops,
 433                 .of_match_table = vt8500_ehci_ids,
 434                 .acpi_match_table = ACPI_PTR(ehci_acpi_match),
 435         }
 436 };
 437
 438 static int __init ehci_platform_init(void)
 439 {
 440         if (usb_disabled())
 441                 return -ENODEV;
 442
 443         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 444
 445         ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
 446         return platform_driver_register(&ehci_platform_driver);
 447 }
 448 module_init(ehci_platform_init);
 449
 450 static void __exit ehci_platform_cleanup(void)
 451 {
 452         platform_driver_unregister(&ehci_platform_driver);
 453 }
 454 module_exit(ehci_platform_cleanup);
 455
 456 MODULE_DESCRIPTION(DRIVER_DESC);
 457 MODULE_AUTHOR("Hauke Mehrtens");
 458 MODULE_AUTHOR("Alan Stern");
 459 MODULE_LICENSE("GPL");