Commit | Line | Data |
---|---|---|
5fd54ace | 1 | // SPDX-License-Identifier: GPL-2.0 |
fa3364b5 HM |
2 | /* |
3 | * Generic platform ohci driver | |
4 | * | |
5 | * Copyright 2007 Michael Buesch <m@bues.ch> | |
6 | * Copyright 2011-2012 Hauke Mehrtens <hauke@hauke-m.de> | |
ca52a17b | 7 | * Copyright 2014 Hans de Goede <hdegoede@redhat.com> |
fa3364b5 HM |
8 | * |
9 | * Derived from the OCHI-SSB driver | |
10 | * Derived from the OHCI-PCI driver | |
11 | * Copyright 1999 Roman Weissgaerber | |
12 | * Copyright 2000-2002 David Brownell | |
13 | * Copyright 1999 Linus Torvalds | |
14 | * Copyright 1999 Gregory P. Smith | |
fa3364b5 | 15 | */ |
928fb68e | 16 | |
ca52a17b HG |
17 | #include <linux/clk.h> |
18 | #include <linux/dma-mapping.h> | |
928fb68e MG |
19 | #include <linux/hrtimer.h> |
20 | #include <linux/io.h> | |
21 | #include <linux/kernel.h> | |
22 | #include <linux/module.h> | |
148e1134 | 23 | #include <linux/err.h> |
1255dfd1 | 24 | #include <linux/of.h> |
fa3364b5 | 25 | #include <linux/platform_device.h> |
0aa0b93e | 26 | #include <linux/pm_runtime.h> |
4615f3bd | 27 | #include <linux/reset.h> |
fa3364b5 | 28 | #include <linux/usb/ohci_pdriver.h> |
928fb68e MG |
29 | #include <linux/usb.h> |
30 | #include <linux/usb/hcd.h> | |
281aec87 | 31 | #include <linux/usb/of.h> |
928fb68e MG |
32 | |
33 | #include "ohci.h" | |
34 | ||
35 | #define DRIVER_DESC "OHCI generic platform driver" | |
ca52a17b HG |
36 | #define OHCI_MAX_CLKS 3 |
37 | #define hcd_to_ohci_priv(h) ((struct ohci_platform_priv *)hcd_to_ohci(h)->priv) | |
38 | ||
39 | struct ohci_platform_priv { | |
40 | struct clk *clks[OHCI_MAX_CLKS]; | |
20a7f3ad | 41 | struct reset_control *resets; |
ca52a17b | 42 | }; |
928fb68e | 43 | |
ca52a17b HG |
44 | static int ohci_platform_power_on(struct platform_device *dev) |
45 | { | |
46 | struct usb_hcd *hcd = platform_get_drvdata(dev); | |
47 | struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd); | |
1255dfd1 | 48 | int clk, ret; |
ca52a17b HG |
49 | |
50 | for (clk = 0; clk < OHCI_MAX_CLKS && priv->clks[clk]; clk++) { | |
51 | ret = clk_prepare_enable(priv->clks[clk]); | |
52 | if (ret) | |
53 | goto err_disable_clks; | |
54 | } | |
55 | ||
ca52a17b HG |
56 | return 0; |
57 | ||
ca52a17b HG |
58 | err_disable_clks: |
59 | while (--clk >= 0) | |
60 | clk_disable_unprepare(priv->clks[clk]); | |
61 | ||
62 | return ret; | |
63 | } | |
64 | ||
65 | static void ohci_platform_power_off(struct platform_device *dev) | |
66 | { | |
67 | struct usb_hcd *hcd = platform_get_drvdata(dev); | |
68 | struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd); | |
1255dfd1 | 69 | int clk; |
ca52a17b HG |
70 | |
71 | for (clk = OHCI_MAX_CLKS - 1; clk >= 0; clk--) | |
72 | if (priv->clks[clk]) | |
73 | clk_disable_unprepare(priv->clks[clk]); | |
74 | } | |
75 | ||
928fb68e | 76 | static struct hc_driver __read_mostly ohci_platform_hc_driver; |
fa3364b5 | 77 | |
928fb68e | 78 | static const struct ohci_driver_overrides platform_overrides __initconst = { |
ca52a17b | 79 | .product_desc = "Generic Platform OHCI controller", |
ca52a17b HG |
80 | .extra_priv_size = sizeof(struct ohci_platform_priv), |
81 | }; | |
82 | ||
83 | static struct usb_ohci_pdata ohci_platform_defaults = { | |
84 | .power_on = ohci_platform_power_on, | |
85 | .power_suspend = ohci_platform_power_off, | |
86 | .power_off = ohci_platform_power_off, | |
fa3364b5 HM |
87 | }; |
88 | ||
41ac7b3a | 89 | static int ohci_platform_probe(struct platform_device *dev) |
fa3364b5 HM |
90 | { |
91 | struct usb_hcd *hcd; | |
92 | struct resource *res_mem; | |
d4f09e28 | 93 | struct usb_ohci_pdata *pdata = dev_get_platdata(&dev->dev); |
ca52a17b | 94 | struct ohci_platform_priv *priv; |
b1034412 | 95 | struct ohci_hcd *ohci; |
1255dfd1 | 96 | int err, irq, clk = 0; |
fa3364b5 HM |
97 | |
98 | if (usb_disabled()) | |
99 | return -ENODEV; | |
100 | ||
ca52a17b HG |
101 | /* |
102 | * Use reasonable defaults so platforms don't have to provide these | |
103 | * with DT probing on ARM. | |
104 | */ | |
105 | if (!pdata) | |
106 | pdata = &ohci_platform_defaults; | |
107 | ||
108 | err = dma_coerce_mask_and_coherent(&dev->dev, DMA_BIT_MASK(32)); | |
109 | if (err) | |
110 | return err; | |
111 | ||
fa3364b5 | 112 | irq = platform_get_irq(dev, 0); |
b33f3706 | 113 | if (irq < 0) |
fa3364b5 | 114 | return irq; |
fa3364b5 | 115 | |
ca52a17b HG |
116 | hcd = usb_create_hcd(&ohci_platform_hc_driver, &dev->dev, |
117 | dev_name(&dev->dev)); | |
118 | if (!hcd) | |
119 | return -ENOMEM; | |
120 | ||
121 | platform_set_drvdata(dev, hcd); | |
122 | dev->dev.platform_data = pdata; | |
123 | priv = hcd_to_ohci_priv(hcd); | |
b1034412 | 124 | ohci = hcd_to_ohci(hcd); |
ca52a17b HG |
125 | |
126 | if (pdata == &ohci_platform_defaults && dev->dev.of_node) { | |
b1034412 HG |
127 | if (of_property_read_bool(dev->dev.of_node, "big-endian-regs")) |
128 | ohci->flags |= OHCI_QUIRK_BE_MMIO; | |
129 | ||
130 | if (of_property_read_bool(dev->dev.of_node, "big-endian-desc")) | |
131 | ohci->flags |= OHCI_QUIRK_BE_DESC; | |
132 | ||
133 | if (of_property_read_bool(dev->dev.of_node, "big-endian")) | |
134 | ohci->flags |= OHCI_QUIRK_BE_MMIO | OHCI_QUIRK_BE_DESC; | |
135 | ||
c4b8692a KC |
136 | if (of_property_read_bool(dev->dev.of_node, "no-big-frame-no")) |
137 | ohci->flags |= OHCI_QUIRK_FRAME_NO; | |
138 | ||
2545d853 TL |
139 | if (of_property_read_bool(dev->dev.of_node, |
140 | "remote-wakeup-connected")) | |
141 | ohci->hc_control = OHCI_CTRL_RWC; | |
142 | ||
c4b8692a KC |
143 | of_property_read_u32(dev->dev.of_node, "num-ports", |
144 | &ohci->num_ports); | |
145 | ||
ca52a17b HG |
146 | for (clk = 0; clk < OHCI_MAX_CLKS; clk++) { |
147 | priv->clks[clk] = of_clk_get(dev->dev.of_node, clk); | |
148 | if (IS_ERR(priv->clks[clk])) { | |
149 | err = PTR_ERR(priv->clks[clk]); | |
150 | if (err == -EPROBE_DEFER) | |
151 | goto err_put_clks; | |
152 | priv->clks[clk] = NULL; | |
153 | break; | |
154 | } | |
155 | } | |
20a7f3ad MY |
156 | |
157 | priv->resets = devm_reset_control_array_get_optional_shared( | |
158 | &dev->dev); | |
159 | if (IS_ERR(priv->resets)) { | |
160 | err = PTR_ERR(priv->resets); | |
161 | goto err_put_clks; | |
62d9694a | 162 | } |
20a7f3ad MY |
163 | |
164 | err = reset_control_deassert(priv->resets); | |
165 | if (err) | |
166 | goto err_put_clks; | |
ca52a17b HG |
167 | } |
168 | ||
adff5295 AS |
169 | if (pdata->big_endian_desc) |
170 | ohci->flags |= OHCI_QUIRK_BE_DESC; | |
171 | if (pdata->big_endian_mmio) | |
172 | ohci->flags |= OHCI_QUIRK_BE_MMIO; | |
46f21949 KC |
173 | if (pdata->no_big_frame_no) |
174 | ohci->flags |= OHCI_QUIRK_FRAME_NO; | |
175 | if (pdata->num_ports) | |
176 | ohci->num_ports = pdata->num_ports; | |
adff5295 AS |
177 | |
178 | #ifndef CONFIG_USB_OHCI_BIG_ENDIAN_MMIO | |
179 | if (ohci->flags & OHCI_QUIRK_BE_MMIO) { | |
180 | dev_err(&dev->dev, | |
181 | "Error: CONFIG_USB_OHCI_BIG_ENDIAN_MMIO not set\n"); | |
182 | err = -EINVAL; | |
4615f3bd | 183 | goto err_reset; |
adff5295 AS |
184 | } |
185 | #endif | |
186 | #ifndef CONFIG_USB_OHCI_BIG_ENDIAN_DESC | |
187 | if (ohci->flags & OHCI_QUIRK_BE_DESC) { | |
188 | dev_err(&dev->dev, | |
189 | "Error: CONFIG_USB_OHCI_BIG_ENDIAN_DESC not set\n"); | |
190 | err = -EINVAL; | |
4615f3bd | 191 | goto err_reset; |
adff5295 AS |
192 | } |
193 | #endif | |
194 | ||
0aa0b93e TL |
195 | pm_runtime_set_active(&dev->dev); |
196 | pm_runtime_enable(&dev->dev); | |
e4d37aeb KM |
197 | if (pdata->power_on) { |
198 | err = pdata->power_on(dev); | |
199 | if (err < 0) | |
4615f3bd | 200 | goto err_reset; |
e4d37aeb | 201 | } |
fa3364b5 | 202 | |
7b519291 | 203 | res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0); |
148e1134 TR |
204 | hcd->regs = devm_ioremap_resource(&dev->dev, res_mem); |
205 | if (IS_ERR(hcd->regs)) { | |
206 | err = PTR_ERR(hcd->regs); | |
ca52a17b | 207 | goto err_power; |
aece389e | 208 | } |
7b519291 VB |
209 | hcd->rsrc_start = res_mem->start; |
210 | hcd->rsrc_len = resource_size(res_mem); | |
211 | ||
281aec87 AD |
212 | hcd->tpl_support = of_usb_host_tpl_support(dev->dev.of_node); |
213 | ||
fa3364b5 HM |
214 | err = usb_add_hcd(hcd, irq, IRQF_SHARED); |
215 | if (err) | |
ca52a17b | 216 | goto err_power; |
fa3364b5 | 217 | |
3c9740a1 PC |
218 | device_wakeup_enable(hcd->self.controller); |
219 | ||
fa3364b5 HM |
220 | platform_set_drvdata(dev, hcd); |
221 | ||
222 | return err; | |
223 | ||
e4d37aeb KM |
224 | err_power: |
225 | if (pdata->power_off) | |
226 | pdata->power_off(dev); | |
4615f3bd | 227 | err_reset: |
0aa0b93e | 228 | pm_runtime_disable(&dev->dev); |
20a7f3ad | 229 | reset_control_assert(priv->resets); |
ca52a17b HG |
230 | err_put_clks: |
231 | while (--clk >= 0) | |
232 | clk_put(priv->clks[clk]); | |
1255dfd1 | 233 | |
ca52a17b HG |
234 | if (pdata == &ohci_platform_defaults) |
235 | dev->dev.platform_data = NULL; | |
236 | ||
237 | usb_put_hcd(hcd); | |
e4d37aeb | 238 | |
fa3364b5 HM |
239 | return err; |
240 | } | |
241 | ||
fb4e98ab | 242 | static int ohci_platform_remove(struct platform_device *dev) |
fa3364b5 HM |
243 | { |
244 | struct usb_hcd *hcd = platform_get_drvdata(dev); | |
d4f09e28 | 245 | struct usb_ohci_pdata *pdata = dev_get_platdata(&dev->dev); |
ca52a17b | 246 | struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd); |
20a7f3ad | 247 | int clk; |
fa3364b5 | 248 | |
0aa0b93e | 249 | pm_runtime_get_sync(&dev->dev); |
fa3364b5 | 250 | usb_remove_hcd(hcd); |
fa3364b5 | 251 | |
e4d37aeb KM |
252 | if (pdata->power_off) |
253 | pdata->power_off(dev); | |
254 | ||
20a7f3ad | 255 | reset_control_assert(priv->resets); |
4615f3bd | 256 | |
ca52a17b HG |
257 | for (clk = 0; clk < OHCI_MAX_CLKS && priv->clks[clk]; clk++) |
258 | clk_put(priv->clks[clk]); | |
259 | ||
260 | usb_put_hcd(hcd); | |
261 | ||
0aa0b93e TL |
262 | pm_runtime_put_sync(&dev->dev); |
263 | pm_runtime_disable(&dev->dev); | |
264 | ||
ca52a17b HG |
265 | if (pdata == &ohci_platform_defaults) |
266 | dev->dev.platform_data = NULL; | |
267 | ||
fa3364b5 HM |
268 | return 0; |
269 | } | |
270 | ||
5e4ccd9e | 271 | #ifdef CONFIG_PM_SLEEP |
fa3364b5 HM |
272 | static int ohci_platform_suspend(struct device *dev) |
273 | { | |
39dbd7df MG |
274 | struct usb_hcd *hcd = dev_get_drvdata(dev); |
275 | struct usb_ohci_pdata *pdata = dev->platform_data; | |
20db5513 | 276 | struct platform_device *pdev = to_platform_device(dev); |
39dbd7df MG |
277 | bool do_wakeup = device_may_wakeup(dev); |
278 | int ret; | |
279 | ||
280 | ret = ohci_suspend(hcd, do_wakeup); | |
281 | if (ret) | |
282 | return ret; | |
e4d37aeb KM |
283 | |
284 | if (pdata->power_suspend) | |
285 | pdata->power_suspend(pdev); | |
286 | ||
39dbd7df | 287 | return ret; |
fa3364b5 HM |
288 | } |
289 | ||
f3d47885 | 290 | static int ohci_platform_resume_common(struct device *dev, bool hibernated) |
fa3364b5 HM |
291 | { |
292 | struct usb_hcd *hcd = dev_get_drvdata(dev); | |
d4f09e28 | 293 | struct usb_ohci_pdata *pdata = dev_get_platdata(dev); |
20db5513 | 294 | struct platform_device *pdev = to_platform_device(dev); |
e4d37aeb KM |
295 | |
296 | if (pdata->power_on) { | |
297 | int err = pdata->power_on(pdev); | |
298 | if (err < 0) | |
299 | return err; | |
300 | } | |
fa3364b5 | 301 | |
f3d47885 | 302 | ohci_resume(hcd, hibernated); |
1cb3b009 QY |
303 | |
304 | pm_runtime_disable(dev); | |
305 | pm_runtime_set_active(dev); | |
306 | pm_runtime_enable(dev); | |
307 | ||
fa3364b5 HM |
308 | return 0; |
309 | } | |
f3d47885 YZ |
310 | |
311 | static int ohci_platform_resume(struct device *dev) | |
312 | { | |
313 | return ohci_platform_resume_common(dev, false); | |
314 | } | |
315 | ||
316 | static int ohci_platform_restore(struct device *dev) | |
317 | { | |
318 | return ohci_platform_resume_common(dev, true); | |
319 | } | |
5e4ccd9e | 320 | #endif /* CONFIG_PM_SLEEP */ |
fa3364b5 | 321 | |
ca52a17b | 322 | static const struct of_device_id ohci_platform_ids[] = { |
ce149c30 | 323 | { .compatible = "generic-ohci", }, |
a95cfa6b | 324 | { .compatible = "cavium,octeon-6335-ohci", }, |
2545d853 | 325 | { .compatible = "ti,ohci-omap3", }, |
ca52a17b HG |
326 | { } |
327 | }; | |
328 | MODULE_DEVICE_TABLE(of, ohci_platform_ids); | |
329 | ||
fa3364b5 HM |
330 | static const struct platform_device_id ohci_platform_table[] = { |
331 | { "ohci-platform", 0 }, | |
332 | { } | |
333 | }; | |
334 | MODULE_DEVICE_TABLE(platform, ohci_platform_table); | |
335 | ||
f3d47885 YZ |
336 | #ifdef CONFIG_PM_SLEEP |
337 | static const struct dev_pm_ops ohci_platform_pm_ops = { | |
338 | .suspend = ohci_platform_suspend, | |
339 | .resume = ohci_platform_resume, | |
340 | .freeze = ohci_platform_suspend, | |
341 | .thaw = ohci_platform_resume, | |
342 | .poweroff = ohci_platform_suspend, | |
343 | .restore = ohci_platform_restore, | |
344 | }; | |
345 | #endif | |
fa3364b5 HM |
346 | |
347 | static struct platform_driver ohci_platform_driver = { | |
348 | .id_table = ohci_platform_table, | |
349 | .probe = ohci_platform_probe, | |
7690417d | 350 | .remove = ohci_platform_remove, |
fa3364b5 HM |
351 | .shutdown = usb_hcd_platform_shutdown, |
352 | .driver = { | |
fa3364b5 | 353 | .name = "ohci-platform", |
f3d47885 | 354 | #ifdef CONFIG_PM_SLEEP |
fa3364b5 | 355 | .pm = &ohci_platform_pm_ops, |
f3d47885 | 356 | #endif |
ca52a17b | 357 | .of_match_table = ohci_platform_ids, |
69a1c9a9 | 358 | .probe_type = PROBE_PREFER_ASYNCHRONOUS, |
fa3364b5 HM |
359 | } |
360 | }; | |
928fb68e MG |
361 | |
362 | static int __init ohci_platform_init(void) | |
363 | { | |
364 | if (usb_disabled()) | |
365 | return -ENODEV; | |
366 | ||
928fb68e MG |
367 | ohci_init_driver(&ohci_platform_hc_driver, &platform_overrides); |
368 | return platform_driver_register(&ohci_platform_driver); | |
369 | } | |
370 | module_init(ohci_platform_init); | |
371 | ||
372 | static void __exit ohci_platform_cleanup(void) | |
373 | { | |
374 | platform_driver_unregister(&ohci_platform_driver); | |
375 | } | |
376 | module_exit(ohci_platform_cleanup); | |
377 | ||
378 | MODULE_DESCRIPTION(DRIVER_DESC); | |
379 | MODULE_AUTHOR("Hauke Mehrtens"); | |
380 | MODULE_AUTHOR("Alan Stern"); | |
381 | MODULE_LICENSE("GPL"); |