drivers/usb/host/ohci-platform.c

   1 /*
   2  * Generic platform ohci driver
   3  *
   4  * Copyright 2007 Michael Buesch <m@bues.ch>
   5  * Copyright 2011-2012 Hauke Mehrtens <hauke@hauke-m.de>
   6  * Copyright 2014 Hans de Goede <hdegoede@redhat.com>
   7  *
   8  * Derived from the OCHI-SSB driver
   9  * Derived from the OHCI-PCI driver
  10  * Copyright 1999 Roman Weissgaerber
  11  * Copyright 2000-2002 David Brownell
  12  * Copyright 1999 Linus Torvalds
  13  * Copyright 1999 Gregory P. Smith
  14  *
  15  * Licensed under the GNU/GPL. See COPYING for details.
  16  */
  17
  18 #include <linux/clk.h>
  19 #include <linux/dma-mapping.h>
  20 #include <linux/hrtimer.h>
  21 #include <linux/io.h>
  22 #include <linux/kernel.h>
  23 #include <linux/module.h>
  24 #include <linux/err.h>
  25 #include <linux/phy/phy.h>
  26 #include <linux/platform_device.h>
  27 #include <linux/reset.h>
  28 #include <linux/usb/ohci_pdriver.h>
  29 #include <linux/usb.h>
  30 #include <linux/usb/hcd.h>
  31
  32 #include "ohci.h"
  33
  34 #define DRIVER_DESC "OHCI generic platform driver"
  35 #define OHCI_MAX_CLKS 3
  36 #define hcd_to_ohci_priv(h) ((struct ohci_platform_priv *)hcd_to_ohci(h)->priv)
  37
  38 struct ohci_platform_priv {
  39         struct clk *clks[OHCI_MAX_CLKS];
  40         struct reset_control *rst;
  41         struct phy **phys;
  42         int num_phys;
  43 };
  44
  45 static const char hcd_name[] = "ohci-platform";
  46
  47 static int ohci_platform_power_on(struct platform_device *dev)
  48 {
  49         struct usb_hcd *hcd = platform_get_drvdata(dev);
  50         struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd);
  51         int clk, ret, phy_num;
  52
  53         for (clk = 0; clk < OHCI_MAX_CLKS && priv->clks[clk]; clk++) {
  54                 ret = clk_prepare_enable(priv->clks[clk]);
  55                 if (ret)
  56                         goto err_disable_clks;
  57         }
  58
  59         for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
  60                 if (priv->phys[phy_num]) {
  61                         ret = phy_init(priv->phys[phy_num]);
  62                         if (ret)
  63                                 goto err_exit_phy;
  64                         ret = phy_power_on(priv->phys[phy_num]);
  65                         if (ret) {
  66                                 phy_exit(priv->phys[phy_num]);
  67                                 goto err_exit_phy;
  68                         }
  69                 }
  70         }
  71
  72         return 0;
  73
  74 err_exit_phy:
  75         while (--phy_num >= 0) {
  76                 if (priv->phys[phy_num]) {
  77                         phy_power_off(priv->phys[phy_num]);
  78                         phy_exit(priv->phys[phy_num]);
  79                 }
  80         }
  81 err_disable_clks:
  82         while (--clk >= 0)
  83                 clk_disable_unprepare(priv->clks[clk]);
  84
  85         return ret;
  86 }
  87
  88 static void ohci_platform_power_off(struct platform_device *dev)
  89 {
  90         struct usb_hcd *hcd = platform_get_drvdata(dev);
  91         struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd);
  92         int clk, phy_num;
  93
  94         for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
  95                 if (priv->phys[phy_num]) {
  96                         phy_power_off(priv->phys[phy_num]);
  97                         phy_exit(priv->phys[phy_num]);
  98                 }
  99         }
 100
 101         for (clk = OHCI_MAX_CLKS - 1; clk >= 0; clk--)
 102                 if (priv->clks[clk])
 103                         clk_disable_unprepare(priv->clks[clk]);
 104 }
 105
 106 static struct hc_driver __read_mostly ohci_platform_hc_driver;
 107
 108 static const struct ohci_driver_overrides platform_overrides __initconst = {
 109         .product_desc =         "Generic Platform OHCI controller",
 110         .extra_priv_size =      sizeof(struct ohci_platform_priv),
 111 };
 112
 113 static struct usb_ohci_pdata ohci_platform_defaults = {
 114         .power_on =             ohci_platform_power_on,
 115         .power_suspend =        ohci_platform_power_off,
 116         .power_off =            ohci_platform_power_off,
 117 };
 118
 119 static int ohci_platform_probe(struct platform_device *dev)
 120 {
 121         struct usb_hcd *hcd;
 122         struct resource *res_mem;
 123         struct usb_ohci_pdata *pdata = dev_get_platdata(&dev->dev);
 124         struct ohci_platform_priv *priv;
 125         struct ohci_hcd *ohci;
 126         const char *phy_name;
 127         int err, irq, phy_num, clk = 0;
 128
 129         if (usb_disabled())
 130                 return -ENODEV;
 131
 132         /*
 133          * Use reasonable defaults so platforms don't have to provide these
 134          * with DT probing on ARM.
 135          */
 136         if (!pdata)
 137                 pdata = &ohci_platform_defaults;
 138
 139         err = dma_coerce_mask_and_coherent(&dev->dev, DMA_BIT_MASK(32));
 140         if (err)
 141                 return err;
 142
 143         irq = platform_get_irq(dev, 0);
 144         if (irq < 0) {
 145                 dev_err(&dev->dev, "no irq provided");
 146                 return irq;
 147         }
 148
 149         hcd = usb_create_hcd(&ohci_platform_hc_driver, &dev->dev,
 150                         dev_name(&dev->dev));
 151         if (!hcd)
 152                 return -ENOMEM;
 153
 154         platform_set_drvdata(dev, hcd);
 155         dev->dev.platform_data = pdata;
 156         priv = hcd_to_ohci_priv(hcd);
 157         ohci = hcd_to_ohci(hcd);
 158
 159         if (pdata == &ohci_platform_defaults && dev->dev.of_node) {
 160                 if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
 161                         ohci->flags |= OHCI_QUIRK_BE_MMIO;
 162
 163                 if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
 164                         ohci->flags |= OHCI_QUIRK_BE_DESC;
 165
 166                 if (of_property_read_bool(dev->dev.of_node, "big-endian"))
 167                         ohci->flags |= OHCI_QUIRK_BE_MMIO | OHCI_QUIRK_BE_DESC;
 168
 169                 if (of_property_read_bool(dev->dev.of_node, "no-big-frame-no"))
 170                         ohci->flags |= OHCI_QUIRK_FRAME_NO;
 171
 172                 of_property_read_u32(dev->dev.of_node, "num-ports",
 173                                      &ohci->num_ports);
 174
 175                 priv->num_phys = of_count_phandle_with_args(dev->dev.of_node,
 176                                 "phys", "#phy-cells");
 177                 priv->num_phys = priv->num_phys > 0 ? priv->num_phys : 1;
 178
 179                 priv->phys = devm_kcalloc(&dev->dev, priv->num_phys,
 180                                 sizeof(struct phy *), GFP_KERNEL);
 181                 if (!priv->phys)
 182                         return -ENOMEM;
 183
 184                 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
 185                                 err = of_property_read_string_index(
 186                                                 dev->dev.of_node,
 187                                                 "phy-names", phy_num,
 188                                                 &phy_name);
 189
 190                                 if (err < 0) {
 191                                         if (priv->num_phys > 1) {
 192                                                 dev_err(&dev->dev, "phy-names not provided");
 193                                                 goto err_put_hcd;
 194                                         } else
 195                                                 phy_name = "usb";
 196                                 }
 197
 198                                 priv->phys[phy_num] = devm_phy_get(&dev->dev,
 199                                                 phy_name);
 200                                 if (IS_ERR(priv->phys[phy_num])) {
 201                                         err = PTR_ERR(priv->phys[phy_num]);
 202                                         if ((priv->num_phys > 1) ||
 203                                             (err == -EPROBE_DEFER))
 204                                                 goto err_put_hcd;
 205                                         priv->phys[phy_num] = NULL;
 206                                 }
 207                 }
 208
 209                 for (clk = 0; clk < OHCI_MAX_CLKS; clk++) {
 210                         priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
 211                         if (IS_ERR(priv->clks[clk])) {
 212                                 err = PTR_ERR(priv->clks[clk]);
 213                                 if (err == -EPROBE_DEFER)
 214                                         goto err_put_clks;
 215                                 priv->clks[clk] = NULL;
 216                                 break;
 217                         }
 218                 }
 219
 220         }
 221
 222         priv->rst = devm_reset_control_get_optional(&dev->dev, NULL);
 223         if (IS_ERR(priv->rst)) {
 224                 err = PTR_ERR(priv->rst);
 225                 if (err == -EPROBE_DEFER)
 226                         goto err_put_clks;
 227                 priv->rst = NULL;
 228         } else {
 229                 err = reset_control_deassert(priv->rst);
 230                 if (err)
 231                         goto err_put_clks;
 232         }
 233
 234         if (pdata->big_endian_desc)
 235                 ohci->flags |= OHCI_QUIRK_BE_DESC;
 236         if (pdata->big_endian_mmio)
 237                 ohci->flags |= OHCI_QUIRK_BE_MMIO;
 238         if (pdata->no_big_frame_no)
 239                 ohci->flags |= OHCI_QUIRK_FRAME_NO;
 240         if (pdata->num_ports)
 241                 ohci->num_ports = pdata->num_ports;
 242
 243 #ifndef CONFIG_USB_OHCI_BIG_ENDIAN_MMIO
 244         if (ohci->flags & OHCI_QUIRK_BE_MMIO) {
 245                 dev_err(&dev->dev,
 246                         "Error: CONFIG_USB_OHCI_BIG_ENDIAN_MMIO not set\n");
 247                 err = -EINVAL;
 248                 goto err_reset;
 249         }
 250 #endif
 251 #ifndef CONFIG_USB_OHCI_BIG_ENDIAN_DESC
 252         if (ohci->flags & OHCI_QUIRK_BE_DESC) {
 253                 dev_err(&dev->dev,
 254                         "Error: CONFIG_USB_OHCI_BIG_ENDIAN_DESC not set\n");
 255                 err = -EINVAL;
 256                 goto err_reset;
 257         }
 258 #endif
 259
 260         if (pdata->power_on) {
 261                 err = pdata->power_on(dev);
 262                 if (err < 0)
 263                         goto err_reset;
 264         }
 265
 266         res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
 267         hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
 268         if (IS_ERR(hcd->regs)) {
 269                 err = PTR_ERR(hcd->regs);
 270                 goto err_power;
 271         }
 272         hcd->rsrc_start = res_mem->start;
 273         hcd->rsrc_len = resource_size(res_mem);
 274
 275         err = usb_add_hcd(hcd, irq, IRQF_SHARED);
 276         if (err)
 277                 goto err_power;
 278
 279         device_wakeup_enable(hcd->self.controller);
 280
 281         platform_set_drvdata(dev, hcd);
 282
 283         return err;
 284
 285 err_power:
 286         if (pdata->power_off)
 287                 pdata->power_off(dev);
 288 err_reset:
 289         if (priv->rst)
 290                 reset_control_assert(priv->rst);
 291 err_put_clks:
 292         while (--clk >= 0)
 293                 clk_put(priv->clks[clk]);
 294 err_put_hcd:
 295         if (pdata == &ohci_platform_defaults)
 296                 dev->dev.platform_data = NULL;
 297
 298         usb_put_hcd(hcd);
 299
 300         return err;
 301 }
 302
 303 static int ohci_platform_remove(struct platform_device *dev)
 304 {
 305         struct usb_hcd *hcd = platform_get_drvdata(dev);
 306         struct usb_ohci_pdata *pdata = dev_get_platdata(&dev->dev);
 307         struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd);
 308         int clk;
 309
 310         usb_remove_hcd(hcd);
 311
 312         if (pdata->power_off)
 313                 pdata->power_off(dev);
 314
 315         if (priv->rst)
 316                 reset_control_assert(priv->rst);
 317
 318         for (clk = 0; clk < OHCI_MAX_CLKS && priv->clks[clk]; clk++)
 319                 clk_put(priv->clks[clk]);
 320
 321         usb_put_hcd(hcd);
 322
 323         if (pdata == &ohci_platform_defaults)
 324                 dev->dev.platform_data = NULL;
 325
 326         return 0;
 327 }
 328
 329 #ifdef CONFIG_PM_SLEEP
 330 static int ohci_platform_suspend(struct device *dev)
 331 {
 332         struct usb_hcd *hcd = dev_get_drvdata(dev);
 333         struct usb_ohci_pdata *pdata = dev->platform_data;
 334         struct platform_device *pdev =
 335                 container_of(dev, struct platform_device, dev);
 336         bool do_wakeup = device_may_wakeup(dev);
 337         int ret;
 338
 339         ret = ohci_suspend(hcd, do_wakeup);
 340         if (ret)
 341                 return ret;
 342
 343         if (pdata->power_suspend)
 344                 pdata->power_suspend(pdev);
 345
 346         return ret;
 347 }
 348
 349 static int ohci_platform_resume(struct device *dev)
 350 {
 351         struct usb_hcd *hcd = dev_get_drvdata(dev);
 352         struct usb_ohci_pdata *pdata = dev_get_platdata(dev);
 353         struct platform_device *pdev =
 354                 container_of(dev, struct platform_device, dev);
 355
 356         if (pdata->power_on) {
 357                 int err = pdata->power_on(pdev);
 358                 if (err < 0)
 359                         return err;
 360         }
 361
 362         ohci_resume(hcd, false);
 363         return 0;
 364 }
 365 #endif /* CONFIG_PM_SLEEP */
 366
 367 static const struct of_device_id ohci_platform_ids[] = {
 368         { .compatible = "generic-ohci", },
 369         { .compatible = "cavium,octeon-6335-ohci", },
 370         { }
 371 };
 372 MODULE_DEVICE_TABLE(of, ohci_platform_ids);
 373
 374 static const struct platform_device_id ohci_platform_table[] = {
 375         { "ohci-platform", 0 },
 376         { }
 377 };
 378 MODULE_DEVICE_TABLE(platform, ohci_platform_table);
 379
 380 static SIMPLE_DEV_PM_OPS(ohci_platform_pm_ops, ohci_platform_suspend,
 381         ohci_platform_resume);
 382
 383 static struct platform_driver ohci_platform_driver = {
 384         .id_table       = ohci_platform_table,
 385         .probe          = ohci_platform_probe,
 386         .remove         = ohci_platform_remove,
 387         .shutdown       = usb_hcd_platform_shutdown,
 388         .driver         = {
 389                 .name   = "ohci-platform",
 390                 .pm     = &ohci_platform_pm_ops,
 391                 .of_match_table = ohci_platform_ids,
 392         }
 393 };
 394
 395 static int __init ohci_platform_init(void)
 396 {
 397         if (usb_disabled())
 398                 return -ENODEV;
 399
 400         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 401
 402         ohci_init_driver(&ohci_platform_hc_driver, &platform_overrides);
 403         return platform_driver_register(&ohci_platform_driver);
 404 }
 405 module_init(ohci_platform_init);
 406
 407 static void __exit ohci_platform_cleanup(void)
 408 {
 409         platform_driver_unregister(&ohci_platform_driver);
 410 }
 411 module_exit(ohci_platform_cleanup);
 412
 413 MODULE_DESCRIPTION(DRIVER_DESC);
 414 MODULE_AUTHOR("Hauke Mehrtens");
 415 MODULE_AUTHOR("Alan Stern");
 416 MODULE_LICENSE("GPL");