1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Driver for EHCI HCD on SPEAr SOC
4 *
5 * Copyright (C) 2010 ST Micro Electronics,
6 * Deepak Sikri <deepak.sikri@st.com>
7 *
8 * Based on various ehci-*.c drivers
9 */
10
11 #include <linux/clk.h>
12 #include <linux/dma-mapping.h>
13 #include <linux/io.h>
14 #include <linux/jiffies.h>
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/of.h>
18 #include <linux/platform_device.h>
19 #include <linux/pm.h>
20 #include <linux/usb.h>
21 #include <linux/usb/hcd.h>
22
23 #include "ehci.h"
24
25 #define DRIVER_DESC "EHCI SPEAr driver"
26
27 struct spear_ehci {
28 struct clk *clk;
29 };
30
31 #define to_spear_ehci(hcd) (struct spear_ehci *)(hcd_to_ehci(hcd)->priv)
32
33 static struct hc_driver __read_mostly ehci_spear_hc_driver;
34
ehci_spear_drv_suspend(struct device * dev)35 static int __maybe_unused ehci_spear_drv_suspend(struct device *dev)
36 {
37 struct usb_hcd *hcd = dev_get_drvdata(dev);
38 bool do_wakeup = device_may_wakeup(dev);
39
40 return ehci_suspend(hcd, do_wakeup);
41 }
42
ehci_spear_drv_resume(struct device * dev)43 static int __maybe_unused ehci_spear_drv_resume(struct device *dev)
44 {
45 struct usb_hcd *hcd = dev_get_drvdata(dev);
46
47 ehci_resume(hcd, false);
48 return 0;
49 }
50
51 static SIMPLE_DEV_PM_OPS(ehci_spear_pm_ops, ehci_spear_drv_suspend,
52 ehci_spear_drv_resume);
53
spear_ehci_hcd_drv_probe(struct platform_device * pdev)54 static int spear_ehci_hcd_drv_probe(struct platform_device *pdev)
55 {
56 struct usb_hcd *hcd ;
57 struct spear_ehci *sehci;
58 struct resource *res;
59 struct clk *usbh_clk;
60 const struct hc_driver *driver = &ehci_spear_hc_driver;
61 int irq, retval;
62
63 if (usb_disabled())
64 return -ENODEV;
65
66 irq = platform_get_irq(pdev, 0);
67 if (irq < 0) {
68 retval = irq;
69 goto fail;
70 }
71
72 /*
73 * Right now device-tree probed devices don't get dma_mask set.
74 * Since shared usb code relies on it, set it here for now.
75 * Once we have dma capability bindings this can go away.
76 */
77 retval = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
78 if (retval)
79 goto fail;
80
81 usbh_clk = devm_clk_get(&pdev->dev, NULL);
82 if (IS_ERR(usbh_clk)) {
83 dev_err(&pdev->dev, "Error getting interface clock\n");
84 retval = PTR_ERR(usbh_clk);
85 goto fail;
86 }
87
88 hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
89 if (!hcd) {
90 retval = -ENOMEM;
91 goto fail;
92 }
93
94 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
95 hcd->regs = devm_ioremap_resource(&pdev->dev, res);
96 if (IS_ERR(hcd->regs)) {
97 retval = PTR_ERR(hcd->regs);
98 goto err_put_hcd;
99 }
100 hcd->rsrc_start = res->start;
101 hcd->rsrc_len = resource_size(res);
102
103 sehci = to_spear_ehci(hcd);
104 sehci->clk = usbh_clk;
105
106 /* registers start at offset 0x0 */
107 hcd_to_ehci(hcd)->caps = hcd->regs;
108
109 clk_prepare_enable(sehci->clk);
110 retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
111 if (retval)
112 goto err_stop_ehci;
113
114 device_wakeup_enable(hcd->self.controller);
115 return retval;
116
117 err_stop_ehci:
118 clk_disable_unprepare(sehci->clk);
119 err_put_hcd:
120 usb_put_hcd(hcd);
121 fail:
122 dev_err(&pdev->dev, "init fail, %d\n", retval);
123
124 return retval ;
125 }
126
spear_ehci_hcd_drv_remove(struct platform_device * pdev)127 static int spear_ehci_hcd_drv_remove(struct platform_device *pdev)
128 {
129 struct usb_hcd *hcd = platform_get_drvdata(pdev);
130 struct spear_ehci *sehci = to_spear_ehci(hcd);
131
132 usb_remove_hcd(hcd);
133
134 if (sehci->clk)
135 clk_disable_unprepare(sehci->clk);
136 usb_put_hcd(hcd);
137
138 return 0;
139 }
140
141 static const struct of_device_id spear_ehci_id_table[] = {
142 { .compatible = "st,spear600-ehci", },
143 { },
144 };
145 MODULE_DEVICE_TABLE(of, spear_ehci_id_table);
146
147 static struct platform_driver spear_ehci_hcd_driver = {
148 .probe = spear_ehci_hcd_drv_probe,
149 .remove = spear_ehci_hcd_drv_remove,
150 .shutdown = usb_hcd_platform_shutdown,
151 .driver = {
152 .name = "spear-ehci",
153 .bus = &platform_bus_type,
154 .pm = pm_ptr(&ehci_spear_pm_ops),
155 .of_match_table = spear_ehci_id_table,
156 }
157 };
158
159 static const struct ehci_driver_overrides spear_overrides __initconst = {
160 .extra_priv_size = sizeof(struct spear_ehci),
161 };
162
ehci_spear_init(void)163 static int __init ehci_spear_init(void)
164 {
165 if (usb_disabled())
166 return -ENODEV;
167
168 ehci_init_driver(&ehci_spear_hc_driver, &spear_overrides);
169 return platform_driver_register(&spear_ehci_hcd_driver);
170 }
171 module_init(ehci_spear_init);
172
ehci_spear_cleanup(void)173 static void __exit ehci_spear_cleanup(void)
174 {
175 platform_driver_unregister(&spear_ehci_hcd_driver);
176 }
177 module_exit(ehci_spear_cleanup);
178
179 MODULE_DESCRIPTION(DRIVER_DESC);
180 MODULE_ALIAS("platform:spear-ehci");
181 MODULE_AUTHOR("Deepak Sikri");
182 MODULE_LICENSE("GPL");
183
