drivers/usb/host/ohci-exynos.c

   1 /*
   2  * SAMSUNG EXYNOS USB HOST OHCI Controller
   3  *
   4  * Copyright (C) 2011 Samsung Electronics Co.Ltd
   5  * Author: Jingoo Han <jg1.han@samsung.com>
   6  *
   7  * This program is free software; you can redistribute  it and/or modify it
   8  * under  the terms of  the GNU General  Public License as published by the
   9  * Free Software Foundation;  either version 2 of the  License, or (at your
  10  * option) any later version.
  11  *
  12  */
  13
  14 #include <linux/clk.h>
  15 #include <linux/dma-mapping.h>
  16 #include <linux/io.h>
  17 #include <linux/kernel.h>
  18 #include <linux/module.h>
  19 #include <linux/of.h>
  20 #include <linux/platform_device.h>
  21 #include <linux/usb/phy.h>
  22 #include <linux/usb/samsung_usb_phy.h>
  23 #include <linux/usb.h>
  24 #include <linux/usb/hcd.h>
  25 #include <linux/usb/otg.h>
  26
  27 #include "ohci.h"
  28
  29 #define DRIVER_DESC "OHCI EXYNOS driver"
  30
  31 static const char hcd_name[] = "ohci-exynos";
  32 static struct hc_driver __read_mostly exynos_ohci_hc_driver;
  33
  34 #define to_exynos_ohci(hcd) (struct exynos_ohci_hcd *)(hcd_to_ohci(hcd)->priv)
  35
  36 struct exynos_ohci_hcd {
  37         struct clk *clk;
  38         struct usb_phy *phy;
  39         struct usb_otg *otg;
  40 };
  41
  42 static void exynos_ohci_phy_enable(struct platform_device *pdev)
  43 {
  44         struct usb_hcd *hcd = platform_get_drvdata(pdev);
  45         struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
  46
  47         if (exynos_ohci->phy)
  48                 usb_phy_init(exynos_ohci->phy);
  49 }
  50
  51 static void exynos_ohci_phy_disable(struct platform_device *pdev)
  52 {
  53         struct usb_hcd *hcd = platform_get_drvdata(pdev);
  54         struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
  55
  56         if (exynos_ohci->phy)
  57                 usb_phy_shutdown(exynos_ohci->phy);
  58 }
  59
  60 static int exynos_ohci_probe(struct platform_device *pdev)
  61 {
  62         struct exynos_ohci_hcd *exynos_ohci;
  63         struct usb_hcd *hcd;
  64         struct resource *res;
  65         struct usb_phy *phy;
  66         int irq;
  67         int err;
  68
  69         /*
  70          * Right now device-tree probed devices don't get dma_mask set.
  71          * Since shared usb code relies on it, set it here for now.
  72          * Once we move to full device tree support this will vanish off.
  73          */
  74         if (!pdev->dev.dma_mask)
  75                 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
  76         if (!pdev->dev.coherent_dma_mask)
  77                 pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
  78
  79         hcd = usb_create_hcd(&exynos_ohci_hc_driver,
  80                                 &pdev->dev, dev_name(&pdev->dev));
  81         if (!hcd) {
  82                 dev_err(&pdev->dev, "Unable to create HCD\n");
  83                 return -ENOMEM;
  84         }
  85
  86         exynos_ohci = to_exynos_ohci(hcd);
  87
  88         if (of_device_is_compatible(pdev->dev.of_node,
  89                                         "samsung,exynos5440-ohci"))
  90                 goto skip_phy;
  91
  92         phy = devm_usb_get_phy(&pdev->dev, USB_PHY_TYPE_USB2);
  93         if (IS_ERR(phy)) {
  94                 usb_put_hcd(hcd);
  95                 dev_warn(&pdev->dev, "no platform data or transceiver defined\n");
  96                 return -EPROBE_DEFER;
  97         } else {
  98                 exynos_ohci->phy = phy;
  99                 exynos_ohci->otg = phy->otg;
 100         }
 101
 102 skip_phy:
 103         exynos_ohci->clk = devm_clk_get(&pdev->dev, "usbhost");
 104
 105         if (IS_ERR(exynos_ohci->clk)) {
 106                 dev_err(&pdev->dev, "Failed to get usbhost clock\n");
 107                 err = PTR_ERR(exynos_ohci->clk);
 108                 goto fail_clk;
 109         }
 110
 111         err = clk_prepare_enable(exynos_ohci->clk);
 112         if (err)
 113                 goto fail_clk;
 114
 115         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 116         if (!res) {
 117                 dev_err(&pdev->dev, "Failed to get I/O memory\n");
 118                 err = -ENXIO;
 119                 goto fail_io;
 120         }
 121
 122         hcd->rsrc_start = res->start;
 123         hcd->rsrc_len = resource_size(res);
 124         hcd->regs = devm_ioremap(&pdev->dev, res->start, hcd->rsrc_len);
 125         if (!hcd->regs) {
 126                 dev_err(&pdev->dev, "Failed to remap I/O memory\n");
 127                 err = -ENOMEM;
 128                 goto fail_io;
 129         }
 130
 131         irq = platform_get_irq(pdev, 0);
 132         if (!irq) {
 133                 dev_err(&pdev->dev, "Failed to get IRQ\n");
 134                 err = -ENODEV;
 135                 goto fail_io;
 136         }
 137
 138         if (exynos_ohci->otg)
 139                 exynos_ohci->otg->set_host(exynos_ohci->otg, &hcd->self);
 140
 141         platform_set_drvdata(pdev, hcd);
 142
 143         exynos_ohci_phy_enable(pdev);
 144
 145         err = usb_add_hcd(hcd, irq, IRQF_SHARED);
 146         if (err) {
 147                 dev_err(&pdev->dev, "Failed to add USB HCD\n");
 148                 goto fail_add_hcd;
 149         }
 150         return 0;
 151
 152 fail_add_hcd:
 153         exynos_ohci_phy_disable(pdev);
 154 fail_io:
 155         clk_disable_unprepare(exynos_ohci->clk);
 156 fail_clk:
 157         usb_put_hcd(hcd);
 158         return err;
 159 }
 160
 161 static int exynos_ohci_remove(struct platform_device *pdev)
 162 {
 163         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 164         struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
 165
 166         usb_remove_hcd(hcd);
 167
 168         if (exynos_ohci->otg)
 169                 exynos_ohci->otg->set_host(exynos_ohci->otg, &hcd->self);
 170
 171         exynos_ohci_phy_disable(pdev);
 172
 173         clk_disable_unprepare(exynos_ohci->clk);
 174
 175         usb_put_hcd(hcd);
 176
 177         return 0;
 178 }
 179
 180 static void exynos_ohci_shutdown(struct platform_device *pdev)
 181 {
 182         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 183
 184         if (hcd->driver->shutdown)
 185                 hcd->driver->shutdown(hcd);
 186 }
 187
 188 #ifdef CONFIG_PM
 189 static int exynos_ohci_suspend(struct device *dev)
 190 {
 191         struct usb_hcd *hcd = dev_get_drvdata(dev);
 192         struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
 193         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
 194         struct platform_device *pdev = to_platform_device(dev);
 195         unsigned long flags;
 196         int rc = 0;
 197
 198         /*
 199          * Root hub was already suspended. Disable irq emission and
 200          * mark HW unaccessible, bail out if RH has been resumed. Use
 201          * the spinlock to properly synchronize with possible pending
 202          * RH suspend or resume activity.
 203          */
 204         spin_lock_irqsave(&ohci->lock, flags);
 205         if (ohci->rh_state != OHCI_RH_SUSPENDED &&
 206                         ohci->rh_state != OHCI_RH_HALTED) {
 207                 rc = -EINVAL;
 208                 goto fail;
 209         }
 210
 211         clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
 212
 213         if (exynos_ohci->otg)
 214                 exynos_ohci->otg->set_host(exynos_ohci->otg, &hcd->self);
 215
 216         exynos_ohci_phy_disable(pdev);
 217
 218         clk_disable_unprepare(exynos_ohci->clk);
 219
 220 fail:
 221         spin_unlock_irqrestore(&ohci->lock, flags);
 222
 223         return rc;
 224 }
 225
 226 static int exynos_ohci_resume(struct device *dev)
 227 {
 228         struct usb_hcd *hcd                     = dev_get_drvdata(dev);
 229         struct exynos_ohci_hcd *exynos_ohci     = to_exynos_ohci(hcd);
 230         struct platform_device *pdev            = to_platform_device(dev);
 231
 232         clk_prepare_enable(exynos_ohci->clk);
 233
 234         if (exynos_ohci->otg)
 235                 exynos_ohci->otg->set_host(exynos_ohci->otg, &hcd->self);
 236
 237         exynos_ohci_phy_enable(pdev);
 238
 239         ohci_resume(hcd, false);
 240
 241         return 0;
 242 }
 243 #else
 244 #define exynos_ohci_suspend     NULL
 245 #define exynos_ohci_resume      NULL
 246 #endif
 247
 248 static const struct ohci_driver_overrides exynos_overrides __initconst = {
 249         .extra_priv_size =      sizeof(struct exynos_ohci_hcd),
 250 };
 251
 252 static const struct dev_pm_ops exynos_ohci_pm_ops = {
 253         .suspend        = exynos_ohci_suspend,
 254         .resume         = exynos_ohci_resume,
 255 };
 256
 257 #ifdef CONFIG_OF
 258 static const struct of_device_id exynos_ohci_match[] = {
 259         { .compatible = "samsung,exynos4210-ohci" },
 260         { .compatible = "samsung,exynos5440-ohci" },
 261         {},
 262 };
 263 MODULE_DEVICE_TABLE(of, exynos_ohci_match);
 264 #endif
 265
 266 static struct platform_driver exynos_ohci_driver = {
 267         .probe          = exynos_ohci_probe,
 268         .remove         = exynos_ohci_remove,
 269         .shutdown       = exynos_ohci_shutdown,
 270         .driver = {
 271                 .name   = "exynos-ohci",
 272                 .owner  = THIS_MODULE,
 273                 .pm     = &exynos_ohci_pm_ops,
 274                 .of_match_table = of_match_ptr(exynos_ohci_match),
 275         }
 276 };
 277 static int __init ohci_exynos_init(void)
 278 {
 279         if (usb_disabled())
 280                 return -ENODEV;
 281
 282         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 283         ohci_init_driver(&exynos_ohci_hc_driver, &exynos_overrides);
 284         return platform_driver_register(&exynos_ohci_driver);
 285 }
 286 module_init(ohci_exynos_init);
 287
 288 static void __exit ohci_exynos_cleanup(void)
 289 {
 290         platform_driver_unregister(&exynos_ohci_driver);
 291 }
 292 module_exit(ohci_exynos_cleanup);
 293
 294 MODULE_ALIAS("platform:exynos-ohci");
 295 MODULE_AUTHOR("Jingoo Han <jg1.han@samsung.com>");
 296 MODULE_LICENSE("GPL v2");