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