Loading...
Note: File does not exist in v3.1.
1/*
2 * Generic platform ehci driver
3 *
4 * Copyright 2007 Steven Brown <sbrown@cortland.com>
5 * Copyright 2010-2012 Hauke Mehrtens <hauke@hauke-m.de>
6 * Copyright 2014 Hans de Goede <hdegoede@redhat.com>
7 *
8 * Derived from the ohci-ssb driver
9 * Copyright 2007 Michael Buesch <m@bues.ch>
10 *
11 * Derived from the EHCI-PCI driver
12 * Copyright (c) 2000-2004 by David Brownell
13 *
14 * Derived from the ohci-pci driver
15 * Copyright 1999 Roman Weissgaerber
16 * Copyright 2000-2002 David Brownell
17 * Copyright 1999 Linus Torvalds
18 * Copyright 1999 Gregory P. Smith
19 *
20 * Licensed under the GNU/GPL. See COPYING for details.
21 */
22#include <linux/clk.h>
23#include <linux/dma-mapping.h>
24#include <linux/err.h>
25#include <linux/kernel.h>
26#include <linux/hrtimer.h>
27#include <linux/io.h>
28#include <linux/module.h>
29#include <linux/of.h>
30#include <linux/phy/phy.h>
31#include <linux/platform_device.h>
32#include <linux/usb.h>
33#include <linux/usb/hcd.h>
34#include <linux/usb/ehci_pdriver.h>
35
36#include "ehci.h"
37
38#define DRIVER_DESC "EHCI generic platform driver"
39#define EHCI_MAX_CLKS 3
40#define hcd_to_ehci_priv(h) ((struct ehci_platform_priv *)hcd_to_ehci(h)->priv)
41
42struct ehci_platform_priv {
43 struct clk *clks[EHCI_MAX_CLKS];
44 struct phy *phy;
45};
46
47static const char hcd_name[] = "ehci-platform";
48
49static int ehci_platform_reset(struct usb_hcd *hcd)
50{
51 struct platform_device *pdev = to_platform_device(hcd->self.controller);
52 struct usb_ehci_pdata *pdata = dev_get_platdata(&pdev->dev);
53 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
54 int retval;
55
56 hcd->has_tt = pdata->has_tt;
57 ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
58
59 if (pdata->pre_setup) {
60 retval = pdata->pre_setup(hcd);
61 if (retval < 0)
62 return retval;
63 }
64
65 ehci->caps = hcd->regs + pdata->caps_offset;
66 retval = ehci_setup(hcd);
67 if (retval)
68 return retval;
69
70 if (pdata->no_io_watchdog)
71 ehci->need_io_watchdog = 0;
72 return 0;
73}
74
75static int ehci_platform_power_on(struct platform_device *dev)
76{
77 struct usb_hcd *hcd = platform_get_drvdata(dev);
78 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
79 int clk, ret;
80
81 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) {
82 ret = clk_prepare_enable(priv->clks[clk]);
83 if (ret)
84 goto err_disable_clks;
85 }
86
87 if (priv->phy) {
88 ret = phy_init(priv->phy);
89 if (ret)
90 goto err_disable_clks;
91
92 ret = phy_power_on(priv->phy);
93 if (ret)
94 goto err_exit_phy;
95 }
96
97 return 0;
98
99err_exit_phy:
100 phy_exit(priv->phy);
101err_disable_clks:
102 while (--clk >= 0)
103 clk_disable_unprepare(priv->clks[clk]);
104
105 return ret;
106}
107
108static void ehci_platform_power_off(struct platform_device *dev)
109{
110 struct usb_hcd *hcd = platform_get_drvdata(dev);
111 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
112 int clk;
113
114 if (priv->phy) {
115 phy_power_off(priv->phy);
116 phy_exit(priv->phy);
117 }
118
119 for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--)
120 if (priv->clks[clk])
121 clk_disable_unprepare(priv->clks[clk]);
122}
123
124static struct hc_driver __read_mostly ehci_platform_hc_driver;
125
126static const struct ehci_driver_overrides platform_overrides __initconst = {
127 .reset = ehci_platform_reset,
128 .extra_priv_size = sizeof(struct ehci_platform_priv),
129};
130
131static struct usb_ehci_pdata ehci_platform_defaults = {
132 .power_on = ehci_platform_power_on,
133 .power_suspend = ehci_platform_power_off,
134 .power_off = ehci_platform_power_off,
135};
136
137static int ehci_platform_probe(struct platform_device *dev)
138{
139 struct usb_hcd *hcd;
140 struct resource *res_mem;
141 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
142 struct ehci_platform_priv *priv;
143 struct ehci_hcd *ehci;
144 int err, irq, clk = 0;
145
146 if (usb_disabled())
147 return -ENODEV;
148
149 /*
150 * Use reasonable defaults so platforms don't have to provide these
151 * with DT probing on ARM.
152 */
153 if (!pdata)
154 pdata = &ehci_platform_defaults;
155
156 err = dma_coerce_mask_and_coherent(&dev->dev, DMA_BIT_MASK(32));
157 if (err)
158 return err;
159
160 irq = platform_get_irq(dev, 0);
161 if (irq < 0) {
162 dev_err(&dev->dev, "no irq provided");
163 return irq;
164 }
165 res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
166 if (!res_mem) {
167 dev_err(&dev->dev, "no memory resource provided");
168 return -ENXIO;
169 }
170
171 hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
172 dev_name(&dev->dev));
173 if (!hcd)
174 return -ENOMEM;
175
176 platform_set_drvdata(dev, hcd);
177 dev->dev.platform_data = pdata;
178 priv = hcd_to_ehci_priv(hcd);
179 ehci = hcd_to_ehci(hcd);
180
181 if (pdata == &ehci_platform_defaults && dev->dev.of_node) {
182 if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
183 ehci->big_endian_mmio = 1;
184
185 if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
186 ehci->big_endian_desc = 1;
187
188 if (of_property_read_bool(dev->dev.of_node, "big-endian"))
189 ehci->big_endian_mmio = ehci->big_endian_desc = 1;
190
191 priv->phy = devm_phy_get(&dev->dev, "usb");
192 if (IS_ERR(priv->phy)) {
193 err = PTR_ERR(priv->phy);
194 if (err == -EPROBE_DEFER)
195 goto err_put_hcd;
196 priv->phy = NULL;
197 }
198
199 for (clk = 0; clk < EHCI_MAX_CLKS; clk++) {
200 priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
201 if (IS_ERR(priv->clks[clk])) {
202 err = PTR_ERR(priv->clks[clk]);
203 if (err == -EPROBE_DEFER)
204 goto err_put_clks;
205 priv->clks[clk] = NULL;
206 break;
207 }
208 }
209 }
210
211 if (pdata->big_endian_desc)
212 ehci->big_endian_desc = 1;
213 if (pdata->big_endian_mmio)
214 ehci->big_endian_mmio = 1;
215
216#ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
217 if (ehci->big_endian_mmio) {
218 dev_err(&dev->dev,
219 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n");
220 err = -EINVAL;
221 goto err_put_clks;
222 }
223#endif
224#ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
225 if (ehci->big_endian_desc) {
226 dev_err(&dev->dev,
227 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n");
228 err = -EINVAL;
229 goto err_put_clks;
230 }
231#endif
232
233 if (pdata->power_on) {
234 err = pdata->power_on(dev);
235 if (err < 0)
236 goto err_put_clks;
237 }
238
239 hcd->rsrc_start = res_mem->start;
240 hcd->rsrc_len = resource_size(res_mem);
241
242 hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
243 if (IS_ERR(hcd->regs)) {
244 err = PTR_ERR(hcd->regs);
245 goto err_power;
246 }
247 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
248 if (err)
249 goto err_power;
250
251 device_wakeup_enable(hcd->self.controller);
252 platform_set_drvdata(dev, hcd);
253
254 return err;
255
256err_power:
257 if (pdata->power_off)
258 pdata->power_off(dev);
259err_put_clks:
260 while (--clk >= 0)
261 clk_put(priv->clks[clk]);
262err_put_hcd:
263 if (pdata == &ehci_platform_defaults)
264 dev->dev.platform_data = NULL;
265
266 usb_put_hcd(hcd);
267
268 return err;
269}
270
271static int ehci_platform_remove(struct platform_device *dev)
272{
273 struct usb_hcd *hcd = platform_get_drvdata(dev);
274 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
275 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
276 int clk;
277
278 usb_remove_hcd(hcd);
279
280 if (pdata->power_off)
281 pdata->power_off(dev);
282
283 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++)
284 clk_put(priv->clks[clk]);
285
286 usb_put_hcd(hcd);
287
288 if (pdata == &ehci_platform_defaults)
289 dev->dev.platform_data = NULL;
290
291 return 0;
292}
293
294#ifdef CONFIG_PM
295
296static int ehci_platform_suspend(struct device *dev)
297{
298 struct usb_hcd *hcd = dev_get_drvdata(dev);
299 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
300 struct platform_device *pdev =
301 container_of(dev, struct platform_device, dev);
302 bool do_wakeup = device_may_wakeup(dev);
303 int ret;
304
305 ret = ehci_suspend(hcd, do_wakeup);
306 if (ret)
307 return ret;
308
309 if (pdata->power_suspend)
310 pdata->power_suspend(pdev);
311
312 return ret;
313}
314
315static int ehci_platform_resume(struct device *dev)
316{
317 struct usb_hcd *hcd = dev_get_drvdata(dev);
318 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
319 struct platform_device *pdev =
320 container_of(dev, struct platform_device, dev);
321
322 if (pdata->power_on) {
323 int err = pdata->power_on(pdev);
324 if (err < 0)
325 return err;
326 }
327
328 ehci_resume(hcd, false);
329 return 0;
330}
331
332#else /* !CONFIG_PM */
333#define ehci_platform_suspend NULL
334#define ehci_platform_resume NULL
335#endif /* CONFIG_PM */
336
337static const struct of_device_id vt8500_ehci_ids[] = {
338 { .compatible = "via,vt8500-ehci", },
339 { .compatible = "wm,prizm-ehci", },
340 { .compatible = "generic-ehci", },
341 {}
342};
343MODULE_DEVICE_TABLE(of, vt8500_ehci_ids);
344
345static const struct platform_device_id ehci_platform_table[] = {
346 { "ehci-platform", 0 },
347 { }
348};
349MODULE_DEVICE_TABLE(platform, ehci_platform_table);
350
351static const struct dev_pm_ops ehci_platform_pm_ops = {
352 .suspend = ehci_platform_suspend,
353 .resume = ehci_platform_resume,
354};
355
356static struct platform_driver ehci_platform_driver = {
357 .id_table = ehci_platform_table,
358 .probe = ehci_platform_probe,
359 .remove = ehci_platform_remove,
360 .shutdown = usb_hcd_platform_shutdown,
361 .driver = {
362 .owner = THIS_MODULE,
363 .name = "ehci-platform",
364 .pm = &ehci_platform_pm_ops,
365 .of_match_table = vt8500_ehci_ids,
366 }
367};
368
369static int __init ehci_platform_init(void)
370{
371 if (usb_disabled())
372 return -ENODEV;
373
374 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
375
376 ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
377 return platform_driver_register(&ehci_platform_driver);
378}
379module_init(ehci_platform_init);
380
381static void __exit ehci_platform_cleanup(void)
382{
383 platform_driver_unregister(&ehci_platform_driver);
384}
385module_exit(ehci_platform_cleanup);
386
387MODULE_DESCRIPTION(DRIVER_DESC);
388MODULE_AUTHOR("Hauke Mehrtens");
389MODULE_AUTHOR("Alan Stern");
390MODULE_LICENSE("GPL");