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