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