Commit | Line | Data |
---|---|---|
7a7a4a59 HM |
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> | |
a4aeb211 | 6 | * Copyright 2014 Hans de Goede <hdegoede@redhat.com> |
7a7a4a59 HM |
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 | */ | |
a4aeb211 | 22 | #include <linux/clk.h> |
f3bc64d6 | 23 | #include <linux/dma-mapping.h> |
148e1134 | 24 | #include <linux/err.h> |
99f91934 | 25 | #include <linux/kernel.h> |
d1bb67a7 AS |
26 | #include <linux/hrtimer.h> |
27 | #include <linux/io.h> | |
99f91934 | 28 | #include <linux/module.h> |
f3bc64d6 | 29 | #include <linux/of.h> |
a4aeb211 | 30 | #include <linux/phy/phy.h> |
7a7a4a59 | 31 | #include <linux/platform_device.h> |
99f91934 AS |
32 | #include <linux/usb.h> |
33 | #include <linux/usb/hcd.h> | |
7a7a4a59 HM |
34 | #include <linux/usb/ehci_pdriver.h> |
35 | ||
99f91934 AS |
36 | #include "ehci.h" |
37 | ||
38 | #define DRIVER_DESC "EHCI generic platform driver" | |
a4aeb211 HG |
39 | #define EHCI_MAX_CLKS 3 |
40 | #define hcd_to_ehci_priv(h) ((struct ehci_platform_priv *)hcd_to_ehci(h)->priv) | |
41 | ||
42 | struct ehci_platform_priv { | |
43 | struct clk *clks[EHCI_MAX_CLKS]; | |
44 | struct phy *phy; | |
45 | }; | |
99f91934 AS |
46 | |
47 | static const char hcd_name[] = "ehci-platform"; | |
48 | ||
7a7a4a59 HM |
49 | static int ehci_platform_reset(struct usb_hcd *hcd) |
50 | { | |
51 | struct platform_device *pdev = to_platform_device(hcd->self.controller); | |
d4f09e28 | 52 | struct usb_ehci_pdata *pdata = dev_get_platdata(&pdev->dev); |
7a7a4a59 HM |
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; | |
7a7a4a59 | 58 | |
743fcce0 SS |
59 | if (pdata->pre_setup) { |
60 | retval = pdata->pre_setup(hcd); | |
61 | if (retval < 0) | |
62 | return retval; | |
63 | } | |
64 | ||
7a7a4a59 HM |
65 | ehci->caps = hcd->regs + pdata->caps_offset; |
66 | retval = ehci_setup(hcd); | |
67 | if (retval) | |
68 | return retval; | |
69 | ||
4534874a FF |
70 | if (pdata->no_io_watchdog) |
71 | ehci->need_io_watchdog = 0; | |
7a7a4a59 HM |
72 | return 0; |
73 | } | |
74 | ||
a4aeb211 HG |
75 | static 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 | ||
99 | err_exit_phy: | |
100 | phy_exit(priv->phy); | |
101 | err_disable_clks: | |
102 | while (--clk >= 0) | |
103 | clk_disable_unprepare(priv->clks[clk]); | |
104 | ||
105 | return ret; | |
106 | } | |
107 | ||
108 | static 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 | ||
99f91934 | 124 | static struct hc_driver __read_mostly ehci_platform_hc_driver; |
7a7a4a59 | 125 | |
62d08a11 | 126 | static const struct ehci_driver_overrides platform_overrides __initconst = { |
a4aeb211 HG |
127 | .reset = ehci_platform_reset, |
128 | .extra_priv_size = sizeof(struct ehci_platform_priv), | |
7a7a4a59 HM |
129 | }; |
130 | ||
a4aeb211 HG |
131 | static 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 | }; | |
f3bc64d6 | 136 | |
41ac7b3a | 137 | static int ehci_platform_probe(struct platform_device *dev) |
7a7a4a59 HM |
138 | { |
139 | struct usb_hcd *hcd; | |
140 | struct resource *res_mem; | |
a4aeb211 HG |
141 | struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev); |
142 | struct ehci_platform_priv *priv; | |
ad3db5da | 143 | struct ehci_hcd *ehci; |
a4aeb211 | 144 | int err, irq, clk = 0; |
7a7a4a59 | 145 | |
7a7a4a59 HM |
146 | if (usb_disabled()) |
147 | return -ENODEV; | |
148 | ||
f3bc64d6 | 149 | /* |
a4aeb211 HG |
150 | * Use reasonable defaults so platforms don't have to provide these |
151 | * with DT probing on ARM. | |
f3bc64d6 | 152 | */ |
a4aeb211 HG |
153 | if (!pdata) |
154 | pdata = &ehci_platform_defaults; | |
e1fd7341 RK |
155 | |
156 | err = dma_coerce_mask_and_coherent(&dev->dev, DMA_BIT_MASK(32)); | |
22d9d8e8 RK |
157 | if (err) |
158 | return err; | |
f3bc64d6 | 159 | |
7a7a4a59 HM |
160 | irq = platform_get_irq(dev, 0); |
161 | if (irq < 0) { | |
2350cb0c | 162 | dev_err(&dev->dev, "no irq provided"); |
7a7a4a59 HM |
163 | return irq; |
164 | } | |
165 | res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0); | |
166 | if (!res_mem) { | |
5c9b2b28 | 167 | dev_err(&dev->dev, "no memory resource provided"); |
7a7a4a59 HM |
168 | return -ENXIO; |
169 | } | |
170 | ||
a4aeb211 HG |
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); | |
ad3db5da | 179 | ehci = hcd_to_ehci(hcd); |
a4aeb211 HG |
180 | |
181 | if (pdata == &ehci_platform_defaults && dev->dev.of_node) { | |
ad3db5da HG |
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 | ||
a4aeb211 HG |
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 | ||
843d5e03 AS |
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 | ||
04216bed KM |
233 | if (pdata->power_on) { |
234 | err = pdata->power_on(dev); | |
235 | if (err < 0) | |
a4aeb211 | 236 | goto err_put_clks; |
04216bed | 237 | } |
7a7a4a59 HM |
238 | |
239 | hcd->rsrc_start = res_mem->start; | |
240 | hcd->rsrc_len = resource_size(res_mem); | |
241 | ||
148e1134 TR |
242 | hcd->regs = devm_ioremap_resource(&dev->dev, res_mem); |
243 | if (IS_ERR(hcd->regs)) { | |
244 | err = PTR_ERR(hcd->regs); | |
a4aeb211 | 245 | goto err_power; |
ec03ad85 | 246 | } |
7a7a4a59 HM |
247 | err = usb_add_hcd(hcd, irq, IRQF_SHARED); |
248 | if (err) | |
a4aeb211 | 249 | goto err_power; |
7a7a4a59 | 250 | |
3c9740a1 | 251 | device_wakeup_enable(hcd->self.controller); |
7a7a4a59 HM |
252 | platform_set_drvdata(dev, hcd); |
253 | ||
254 | return err; | |
255 | ||
04216bed KM |
256 | err_power: |
257 | if (pdata->power_off) | |
258 | pdata->power_off(dev); | |
a4aeb211 HG |
259 | err_put_clks: |
260 | while (--clk >= 0) | |
261 | clk_put(priv->clks[clk]); | |
262 | err_put_hcd: | |
263 | if (pdata == &ehci_platform_defaults) | |
264 | dev->dev.platform_data = NULL; | |
265 | ||
266 | usb_put_hcd(hcd); | |
04216bed | 267 | |
7a7a4a59 HM |
268 | return err; |
269 | } | |
270 | ||
fb4e98ab | 271 | static int ehci_platform_remove(struct platform_device *dev) |
7a7a4a59 HM |
272 | { |
273 | struct usb_hcd *hcd = platform_get_drvdata(dev); | |
d4f09e28 | 274 | struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev); |
a4aeb211 HG |
275 | struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd); |
276 | int clk; | |
7a7a4a59 HM |
277 | |
278 | usb_remove_hcd(hcd); | |
7a7a4a59 | 279 | |
04216bed KM |
280 | if (pdata->power_off) |
281 | pdata->power_off(dev); | |
282 | ||
a4aeb211 HG |
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 | ||
f3bc64d6 AB |
288 | if (pdata == &ehci_platform_defaults) |
289 | dev->dev.platform_data = NULL; | |
290 | ||
7a7a4a59 HM |
291 | return 0; |
292 | } | |
293 | ||
294 | #ifdef CONFIG_PM | |
295 | ||
296 | static int ehci_platform_suspend(struct device *dev) | |
297 | { | |
298 | struct usb_hcd *hcd = dev_get_drvdata(dev); | |
d4f09e28 | 299 | struct usb_ehci_pdata *pdata = dev_get_platdata(dev); |
04216bed KM |
300 | struct platform_device *pdev = |
301 | container_of(dev, struct platform_device, dev); | |
c5cf9212 | 302 | bool do_wakeup = device_may_wakeup(dev); |
04216bed KM |
303 | int ret; |
304 | ||
305 | ret = ehci_suspend(hcd, do_wakeup); | |
7a7a4a59 | 306 | |
04216bed KM |
307 | if (pdata->power_suspend) |
308 | pdata->power_suspend(pdev); | |
309 | ||
310 | return ret; | |
7a7a4a59 HM |
311 | } |
312 | ||
313 | static int ehci_platform_resume(struct device *dev) | |
314 | { | |
315 | struct usb_hcd *hcd = dev_get_drvdata(dev); | |
d4f09e28 | 316 | struct usb_ehci_pdata *pdata = dev_get_platdata(dev); |
04216bed KM |
317 | struct platform_device *pdev = |
318 | container_of(dev, struct platform_device, dev); | |
319 | ||
320 | if (pdata->power_on) { | |
321 | int err = pdata->power_on(pdev); | |
322 | if (err < 0) | |
323 | return err; | |
324 | } | |
7a7a4a59 | 325 | |
c5cf9212 | 326 | ehci_resume(hcd, false); |
7a7a4a59 HM |
327 | return 0; |
328 | } | |
329 | ||
330 | #else /* !CONFIG_PM */ | |
331 | #define ehci_platform_suspend NULL | |
332 | #define ehci_platform_resume NULL | |
333 | #endif /* CONFIG_PM */ | |
334 | ||
f3bc64d6 AB |
335 | static const struct of_device_id vt8500_ehci_ids[] = { |
336 | { .compatible = "via,vt8500-ehci", }, | |
337 | { .compatible = "wm,prizm-ehci", }, | |
915974c3 | 338 | { .compatible = "generic-ehci", }, |
f3bc64d6 AB |
339 | {} |
340 | }; | |
a4aeb211 | 341 | MODULE_DEVICE_TABLE(of, vt8500_ehci_ids); |
f3bc64d6 | 342 | |
7a7a4a59 HM |
343 | static const struct platform_device_id ehci_platform_table[] = { |
344 | { "ehci-platform", 0 }, | |
345 | { } | |
346 | }; | |
347 | MODULE_DEVICE_TABLE(platform, ehci_platform_table); | |
348 | ||
349 | static const struct dev_pm_ops ehci_platform_pm_ops = { | |
350 | .suspend = ehci_platform_suspend, | |
351 | .resume = ehci_platform_resume, | |
352 | }; | |
353 | ||
354 | static struct platform_driver ehci_platform_driver = { | |
355 | .id_table = ehci_platform_table, | |
356 | .probe = ehci_platform_probe, | |
7690417d | 357 | .remove = ehci_platform_remove, |
7a7a4a59 HM |
358 | .shutdown = usb_hcd_platform_shutdown, |
359 | .driver = { | |
360 | .owner = THIS_MODULE, | |
361 | .name = "ehci-platform", | |
362 | .pm = &ehci_platform_pm_ops, | |
ae5e5f7b | 363 | .of_match_table = vt8500_ehci_ids, |
7a7a4a59 HM |
364 | } |
365 | }; | |
99f91934 AS |
366 | |
367 | static int __init ehci_platform_init(void) | |
368 | { | |
369 | if (usb_disabled()) | |
370 | return -ENODEV; | |
371 | ||
372 | pr_info("%s: " DRIVER_DESC "\n", hcd_name); | |
373 | ||
374 | ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides); | |
375 | return platform_driver_register(&ehci_platform_driver); | |
376 | } | |
377 | module_init(ehci_platform_init); | |
378 | ||
379 | static void __exit ehci_platform_cleanup(void) | |
380 | { | |
381 | platform_driver_unregister(&ehci_platform_driver); | |
382 | } | |
383 | module_exit(ehci_platform_cleanup); | |
384 | ||
385 | MODULE_DESCRIPTION(DRIVER_DESC); | |
386 | MODULE_AUTHOR("Hauke Mehrtens"); | |
387 | MODULE_AUTHOR("Alan Stern"); | |
388 | MODULE_LICENSE("GPL"); |