drivers/usb/host/ohci-spear.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3 * OHCI HCD (Host Controller Driver) for USB.
   4 *
   5 * Copyright (C) 2010 ST Microelectronics.
   6 * Deepak Sikri<[email protected]>
   7 *
   8 * Based on various ohci-*.c drivers
   9 */
  10
  11 #include <linux/clk.h>
  12 #include <linux/dma-mapping.h>
  13 #include <linux/io.h>
  14 #include <linux/kernel.h>
  15 #include <linux/module.h>
  16 #include <linux/of.h>
  17 #include <linux/platform_device.h>
  18 #include <linux/signal.h>
  19 #include <linux/usb.h>
  20 #include <linux/usb/hcd.h>
  21
  22 #include "ohci.h"
  23
  24 #define DRIVER_DESC "OHCI SPEAr driver"
  25
  26 struct spear_ohci {
  27         struct clk *clk;
  28 };
  29
  30 #define to_spear_ohci(hcd)     (struct spear_ohci *)(hcd_to_ohci(hcd)->priv)
  31
  32 static struct hc_driver __read_mostly ohci_spear_hc_driver;
  33
  34 static int spear_ohci_hcd_drv_probe(struct platform_device *pdev)
  35 {
  36         const struct hc_driver *driver = &ohci_spear_hc_driver;
  37         struct usb_hcd *hcd = NULL;
  38         struct clk *usbh_clk;
  39         struct spear_ohci *sohci_p;
  40         struct resource *res;
  41         int retval, irq;
  42
  43         irq = platform_get_irq(pdev, 0);
  44         if (irq < 0) {
  45                 retval = irq;
  46                 goto fail;
  47         }
  48
  49         /*
  50          * Right now device-tree probed devices don't get dma_mask set.
  51          * Since shared usb code relies on it, set it here for now.
  52          * Once we have dma capability bindings this can go away.
  53          */
  54         retval = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
  55         if (retval)
  56                 goto fail;
  57
  58         usbh_clk = devm_clk_get(&pdev->dev, NULL);
  59         if (IS_ERR(usbh_clk)) {
  60                 dev_err(&pdev->dev, "Error getting interface clock\n");
  61                 retval = PTR_ERR(usbh_clk);
  62                 goto fail;
  63         }
  64
  65         hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
  66         if (!hcd) {
  67                 retval = -ENOMEM;
  68                 goto fail;
  69         }
  70
  71         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  72         hcd->regs = devm_ioremap_resource(&pdev->dev, res);
  73         if (IS_ERR(hcd->regs)) {
  74                 retval = PTR_ERR(hcd->regs);
  75                 goto err_put_hcd;
  76         }
  77
  78         hcd->rsrc_start = res->start;
  79         hcd->rsrc_len = resource_size(res);
  80
  81         sohci_p = to_spear_ohci(hcd);
  82         sohci_p->clk = usbh_clk;
  83
  84         clk_prepare_enable(sohci_p->clk);
  85
  86         retval = usb_add_hcd(hcd, irq, 0);
  87         if (retval == 0) {
  88                 device_wakeup_enable(hcd->self.controller);
  89                 return retval;
  90         }
  91
  92         clk_disable_unprepare(sohci_p->clk);
  93 err_put_hcd:
  94         usb_put_hcd(hcd);
  95 fail:
  96         dev_err(&pdev->dev, "init fail, %d\n", retval);
  97
  98         return retval;
  99 }
 100
 101 static int spear_ohci_hcd_drv_remove(struct platform_device *pdev)
 102 {
 103         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 104         struct spear_ohci *sohci_p = to_spear_ohci(hcd);
 105
 106         usb_remove_hcd(hcd);
 107         if (sohci_p->clk)
 108                 clk_disable_unprepare(sohci_p->clk);
 109
 110         usb_put_hcd(hcd);
 111         return 0;
 112 }
 113
 114 #if defined(CONFIG_PM)
 115 static int spear_ohci_hcd_drv_suspend(struct platform_device *pdev,
 116                 pm_message_t message)
 117 {
 118         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 119         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
 120         struct spear_ohci *sohci_p = to_spear_ohci(hcd);
 121         bool do_wakeup = device_may_wakeup(&pdev->dev);
 122         int ret;
 123
 124         if (time_before(jiffies, ohci->next_statechange))
 125                 msleep(5);
 126         ohci->next_statechange = jiffies;
 127
 128         ret = ohci_suspend(hcd, do_wakeup);
 129         if (ret)
 130                 return ret;
 131
 132         clk_disable_unprepare(sohci_p->clk);
 133
 134         return ret;
 135 }
 136
 137 static int spear_ohci_hcd_drv_resume(struct platform_device *dev)
 138 {
 139         struct usb_hcd *hcd = platform_get_drvdata(dev);
 140         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
 141         struct spear_ohci *sohci_p = to_spear_ohci(hcd);
 142
 143         if (time_before(jiffies, ohci->next_statechange))
 144                 msleep(5);
 145         ohci->next_statechange = jiffies;
 146
 147         clk_prepare_enable(sohci_p->clk);
 148         ohci_resume(hcd, false);
 149         return 0;
 150 }
 151 #endif
 152
 153 static const struct of_device_id spear_ohci_id_table[] = {
 154         { .compatible = "st,spear600-ohci", },
 155         { },
 156 };
 157 MODULE_DEVICE_TABLE(of, spear_ohci_id_table);
 158
 159 /* Driver definition to register with the platform bus */
 160 static struct platform_driver spear_ohci_hcd_driver = {
 161         .probe =        spear_ohci_hcd_drv_probe,
 162         .remove =       spear_ohci_hcd_drv_remove,
 163 #ifdef CONFIG_PM
 164         .suspend =      spear_ohci_hcd_drv_suspend,
 165         .resume =       spear_ohci_hcd_drv_resume,
 166 #endif
 167         .driver = {
 168                 .name = "spear-ohci",
 169                 .of_match_table = spear_ohci_id_table,
 170         },
 171 };
 172
 173 static const struct ohci_driver_overrides spear_overrides __initconst = {
 174         .extra_priv_size = sizeof(struct spear_ohci),
 175 };
 176 static int __init ohci_spear_init(void)
 177 {
 178         if (usb_disabled())
 179                 return -ENODEV;
 180
 181         ohci_init_driver(&ohci_spear_hc_driver, &spear_overrides);
 182         return platform_driver_register(&spear_ohci_hcd_driver);
 183 }
 184 module_init(ohci_spear_init);
 185
 186 static void __exit ohci_spear_cleanup(void)
 187 {
 188         platform_driver_unregister(&spear_ohci_hcd_driver);
 189 }
 190 module_exit(ohci_spear_cleanup);
 191
 192 MODULE_DESCRIPTION(DRIVER_DESC);
 193 MODULE_AUTHOR("Deepak Sikri");
 194 MODULE_LICENSE("GPL v2");
 195 MODULE_ALIAS("platform:spear-ohci");