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/phy/phy.h>
  22 #include <linux/usb.h>
  23 #include <linux/usb/hcd.h>
  24
  25 #include "ohci.h"
  26
  27 #define DRIVER_DESC "OHCI EXYNOS driver"
  28
  29 static const char hcd_name[] = "ohci-exynos";
  30 static struct hc_driver __read_mostly exynos_ohci_hc_driver;
  31
  32 #define to_exynos_ohci(hcd) (struct exynos_ohci_hcd *)(hcd_to_ohci(hcd)->priv)
  33
  34 #define PHY_NUMBER 3
  35
  36 struct exynos_ohci_hcd {
  37         struct clk *clk;
  38         struct phy *phy[PHY_NUMBER];
  39 };
  40
  41 static int exynos_ohci_get_phy(struct device *dev,
  42                                 struct exynos_ohci_hcd *exynos_ohci)
  43 {
  44         struct device_node *child;
  45         struct phy *phy;
  46         int phy_number;
  47         int ret;
  48
  49         /* Get PHYs for the controller */
  50         for_each_available_child_of_node(dev->of_node, child) {
  51                 ret = of_property_read_u32(child, "reg", &phy_number);
  52                 if (ret) {
  53                         dev_err(dev, "Failed to parse device tree\n");
  54                         of_node_put(child);
  55                         return ret;
  56                 }
  57
  58                 if (phy_number >= PHY_NUMBER) {
  59                         dev_err(dev, "Invalid number of PHYs\n");
  60                         of_node_put(child);
  61                         return -EINVAL;
  62                 }
  63
  64                 phy = devm_of_phy_get(dev, child, NULL);
  65                 exynos_ohci->phy[phy_number] = phy;
  66                 if (IS_ERR(phy)) {
  67                         ret = PTR_ERR(phy);
  68                         if (ret == -EPROBE_DEFER) {
  69                                 of_node_put(child);
  70                                 return ret;
  71                         } else if (ret != -ENOSYS && ret != -ENODEV) {
  72                                 dev_err(dev,
  73                                         "Error retrieving usb2 phy: %d\n", ret);
  74                                 of_node_put(child);
  75                                 return ret;
  76                         }
  77                 }
  78         }
  79
  80         return 0;
  81 }
  82
  83 static int exynos_ohci_phy_enable(struct device *dev)
  84 {
  85         struct usb_hcd *hcd = dev_get_drvdata(dev);
  86         struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
  87         int i;
  88         int ret = 0;
  89
  90         for (i = 0; ret == 0 && i < PHY_NUMBER; i++)
  91                 if (!IS_ERR(exynos_ohci->phy[i]))
  92                         ret = phy_power_on(exynos_ohci->phy[i]);
  93         if (ret)
  94                 for (i--; i >= 0; i--)
  95                         if (!IS_ERR(exynos_ohci->phy[i]))
  96                                 phy_power_off(exynos_ohci->phy[i]);
  97
  98         return ret;
  99 }
 100
 101 static void exynos_ohci_phy_disable(struct device *dev)
 102 {
 103         struct usb_hcd *hcd = dev_get_drvdata(dev);
 104         struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
 105         int i;
 106
 107         for (i = 0; i < PHY_NUMBER; i++)
 108                 if (!IS_ERR(exynos_ohci->phy[i]))
 109                         phy_power_off(exynos_ohci->phy[i]);
 110 }
 111
 112 static int exynos_ohci_probe(struct platform_device *pdev)
 113 {
 114         struct exynos_ohci_hcd *exynos_ohci;
 115         struct usb_hcd *hcd;
 116         struct resource *res;
 117         int irq;
 118         int err;
 119
 120         /*
 121          * Right now device-tree probed devices don't get dma_mask set.
 122          * Since shared usb code relies on it, set it here for now.
 123          * Once we move to full device tree support this will vanish off.
 124          */
 125         err = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
 126         if (err)
 127                 return err;
 128
 129         hcd = usb_create_hcd(&exynos_ohci_hc_driver,
 130                                 &pdev->dev, dev_name(&pdev->dev));
 131         if (!hcd) {
 132                 dev_err(&pdev->dev, "Unable to create HCD\n");
 133                 return -ENOMEM;
 134         }
 135
 136         exynos_ohci = to_exynos_ohci(hcd);
 137
 138         if (of_device_is_compatible(pdev->dev.of_node,
 139                                         "samsung,exynos5440-ohci"))
 140                 goto skip_phy;
 141
 142         err = exynos_ohci_get_phy(&pdev->dev, exynos_ohci);
 143         if (err)
 144                 goto fail_clk;
 145
 146 skip_phy:
 147         exynos_ohci->clk = devm_clk_get(&pdev->dev, "usbhost");
 148
 149         if (IS_ERR(exynos_ohci->clk)) {
 150                 dev_err(&pdev->dev, "Failed to get usbhost clock\n");
 151                 err = PTR_ERR(exynos_ohci->clk);
 152                 goto fail_clk;
 153         }
 154
 155         err = clk_prepare_enable(exynos_ohci->clk);
 156         if (err)
 157                 goto fail_clk;
 158
 159         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 160         hcd->regs = devm_ioremap_resource(&pdev->dev, res);
 161         if (IS_ERR(hcd->regs)) {
 162                 err = PTR_ERR(hcd->regs);
 163                 goto fail_io;
 164         }
 165         hcd->rsrc_start = res->start;
 166         hcd->rsrc_len = resource_size(res);
 167
 168         irq = platform_get_irq(pdev, 0);
 169         if (irq < 0) {
 170                 err = irq;
 171                 goto fail_io;
 172         }
 173
 174         platform_set_drvdata(pdev, hcd);
 175
 176         err = exynos_ohci_phy_enable(&pdev->dev);
 177         if (err) {
 178                 dev_err(&pdev->dev, "Failed to enable USB phy\n");
 179                 goto fail_io;
 180         }
 181
 182         err = usb_add_hcd(hcd, irq, IRQF_SHARED);
 183         if (err) {
 184                 dev_err(&pdev->dev, "Failed to add USB HCD\n");
 185                 goto fail_add_hcd;
 186         }
 187         device_wakeup_enable(hcd->self.controller);
 188         return 0;
 189
 190 fail_add_hcd:
 191         exynos_ohci_phy_disable(&pdev->dev);
 192 fail_io:
 193         clk_disable_unprepare(exynos_ohci->clk);
 194 fail_clk:
 195         usb_put_hcd(hcd);
 196         return err;
 197 }
 198
 199 static int exynos_ohci_remove(struct platform_device *pdev)
 200 {
 201         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 202         struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
 203
 204         usb_remove_hcd(hcd);
 205
 206         exynos_ohci_phy_disable(&pdev->dev);
 207
 208         clk_disable_unprepare(exynos_ohci->clk);
 209
 210         usb_put_hcd(hcd);
 211
 212         return 0;
 213 }
 214
 215 static void exynos_ohci_shutdown(struct platform_device *pdev)
 216 {
 217         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 218
 219         if (hcd->driver->shutdown)
 220                 hcd->driver->shutdown(hcd);
 221 }
 222
 223 #ifdef CONFIG_PM
 224 static int exynos_ohci_suspend(struct device *dev)
 225 {
 226         struct usb_hcd *hcd = dev_get_drvdata(dev);
 227         struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
 228         bool do_wakeup = device_may_wakeup(dev);
 229         int rc = ohci_suspend(hcd, do_wakeup);
 230
 231         if (rc)
 232                 return rc;
 233
 234         exynos_ohci_phy_disable(dev);
 235
 236         clk_disable_unprepare(exynos_ohci->clk);
 237
 238         return 0;
 239 }
 240
 241 static int exynos_ohci_resume(struct device *dev)
 242 {
 243         struct usb_hcd *hcd                     = dev_get_drvdata(dev);
 244         struct exynos_ohci_hcd *exynos_ohci     = to_exynos_ohci(hcd);
 245         int ret;
 246
 247         clk_prepare_enable(exynos_ohci->clk);
 248
 249         ret = exynos_ohci_phy_enable(dev);
 250         if (ret) {
 251                 dev_err(dev, "Failed to enable USB phy\n");
 252                 clk_disable_unprepare(exynos_ohci->clk);
 253                 return ret;
 254         }
 255
 256         ohci_resume(hcd, false);
 257
 258         return 0;
 259 }
 260 #else
 261 #define exynos_ohci_suspend     NULL
 262 #define exynos_ohci_resume      NULL
 263 #endif
 264
 265 static const struct ohci_driver_overrides exynos_overrides __initconst = {
 266         .extra_priv_size =      sizeof(struct exynos_ohci_hcd),
 267 };
 268
 269 static const struct dev_pm_ops exynos_ohci_pm_ops = {
 270         .suspend        = exynos_ohci_suspend,
 271         .resume         = exynos_ohci_resume,
 272 };
 273
 274 #ifdef CONFIG_OF
 275 static const struct of_device_id exynos_ohci_match[] = {
 276         { .compatible = "samsung,exynos4210-ohci" },
 277         { .compatible = "samsung,exynos5440-ohci" },
 278         {},
 279 };
 280 MODULE_DEVICE_TABLE(of, exynos_ohci_match);
 281 #endif
 282
 283 static struct platform_driver exynos_ohci_driver = {
 284         .probe          = exynos_ohci_probe,
 285         .remove         = exynos_ohci_remove,
 286         .shutdown       = exynos_ohci_shutdown,
 287         .driver = {
 288                 .name   = "exynos-ohci",
 289                 .pm     = &exynos_ohci_pm_ops,
 290                 .of_match_table = of_match_ptr(exynos_ohci_match),
 291         }
 292 };
 293 static int __init ohci_exynos_init(void)
 294 {
 295         if (usb_disabled())
 296                 return -ENODEV;
 297
 298         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 299         ohci_init_driver(&exynos_ohci_hc_driver, &exynos_overrides);
 300         return platform_driver_register(&exynos_ohci_driver);
 301 }
 302 module_init(ohci_exynos_init);
 303
 304 static void __exit ohci_exynos_cleanup(void)
 305 {
 306         platform_driver_unregister(&exynos_ohci_driver);
 307 }
 308 module_exit(ohci_exynos_cleanup);
 309
 310 MODULE_ALIAS("platform:exynos-ohci");
 311 MODULE_AUTHOR("Jingoo Han <jg1.han@samsung.com>");
 312 MODULE_LICENSE("GPL v2");