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