Merge remote-tracking branch 'usb/usb-next'
[deliverable/linux.git] / drivers / usb / host / ehci-platform.c
CommitLineData
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 */
776c15d0 22#include <linux/acpi.h>
a4aeb211 23#include <linux/clk.h>
f3bc64d6 24#include <linux/dma-mapping.h>
148e1134 25#include <linux/err.h>
99f91934 26#include <linux/kernel.h>
d1bb67a7
AS
27#include <linux/hrtimer.h>
28#include <linux/io.h>
99f91934 29#include <linux/module.h>
f3bc64d6 30#include <linux/of.h>
a4aeb211 31#include <linux/phy/phy.h>
7a7a4a59 32#include <linux/platform_device.h>
2d87bbd6 33#include <linux/reset.h>
99f91934
AS
34#include <linux/usb.h>
35#include <linux/usb/hcd.h>
7a7a4a59
HM
36#include <linux/usb/ehci_pdriver.h>
37
99f91934
AS
38#include "ehci.h"
39
40#define DRIVER_DESC "EHCI generic platform driver"
73577d61 41#define EHCI_MAX_CLKS 4
d0e08b00 42#define EHCI_MAX_RSTS 3
a4aeb211
HG
43#define hcd_to_ehci_priv(h) ((struct ehci_platform_priv *)hcd_to_ehci(h)->priv)
44
45struct ehci_platform_priv {
46 struct clk *clks[EHCI_MAX_CLKS];
d0e08b00 47 struct reset_control *rsts[EHCI_MAX_RSTS];
7e7a0e67
AR
48 struct phy **phys;
49 int num_phys;
b4629a7b 50 bool reset_on_resume;
a4aeb211 51};
99f91934
AS
52
53static const char hcd_name[] = "ehci-platform";
54
7a7a4a59
HM
55static int ehci_platform_reset(struct usb_hcd *hcd)
56{
57 struct platform_device *pdev = to_platform_device(hcd->self.controller);
d4f09e28 58 struct usb_ehci_pdata *pdata = dev_get_platdata(&pdev->dev);
7a7a4a59
HM
59 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
60 int retval;
61
7a7a4a59 62 ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
7a7a4a59 63
743fcce0
SS
64 if (pdata->pre_setup) {
65 retval = pdata->pre_setup(hcd);
66 if (retval < 0)
67 return retval;
68 }
69
7a7a4a59
HM
70 ehci->caps = hcd->regs + pdata->caps_offset;
71 retval = ehci_setup(hcd);
72 if (retval)
73 return retval;
74
4534874a
FF
75 if (pdata->no_io_watchdog)
76 ehci->need_io_watchdog = 0;
7a7a4a59
HM
77 return 0;
78}
79
a4aeb211
HG
80static int ehci_platform_power_on(struct platform_device *dev)
81{
82 struct usb_hcd *hcd = platform_get_drvdata(dev);
83 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
7e7a0e67 84 int clk, ret, phy_num;
a4aeb211
HG
85
86 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) {
87 ret = clk_prepare_enable(priv->clks[clk]);
88 if (ret)
89 goto err_disable_clks;
90 }
91
7e7a0e67 92 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
216e2992
AR
93 ret = phy_init(priv->phys[phy_num]);
94 if (ret)
95 goto err_exit_phy;
96 ret = phy_power_on(priv->phys[phy_num]);
97 if (ret) {
98 phy_exit(priv->phys[phy_num]);
99 goto err_exit_phy;
7e7a0e67 100 }
a4aeb211
HG
101 }
102
103 return 0;
104
105err_exit_phy:
7e7a0e67 106 while (--phy_num >= 0) {
216e2992
AR
107 phy_power_off(priv->phys[phy_num]);
108 phy_exit(priv->phys[phy_num]);
7e7a0e67 109 }
a4aeb211
HG
110err_disable_clks:
111 while (--clk >= 0)
112 clk_disable_unprepare(priv->clks[clk]);
113
114 return ret;
115}
116
117static void ehci_platform_power_off(struct platform_device *dev)
118{
119 struct usb_hcd *hcd = platform_get_drvdata(dev);
120 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
7e7a0e67 121 int clk, phy_num;
a4aeb211 122
7e7a0e67 123 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
216e2992
AR
124 phy_power_off(priv->phys[phy_num]);
125 phy_exit(priv->phys[phy_num]);
a4aeb211
HG
126 }
127
128 for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--)
129 if (priv->clks[clk])
130 clk_disable_unprepare(priv->clks[clk]);
131}
132
99f91934 133static struct hc_driver __read_mostly ehci_platform_hc_driver;
7a7a4a59 134
62d08a11 135static const struct ehci_driver_overrides platform_overrides __initconst = {
a4aeb211
HG
136 .reset = ehci_platform_reset,
137 .extra_priv_size = sizeof(struct ehci_platform_priv),
7a7a4a59
HM
138};
139
a4aeb211
HG
140static struct usb_ehci_pdata ehci_platform_defaults = {
141 .power_on = ehci_platform_power_on,
142 .power_suspend = ehci_platform_power_off,
143 .power_off = ehci_platform_power_off,
144};
f3bc64d6 145
41ac7b3a 146static int ehci_platform_probe(struct platform_device *dev)
7a7a4a59
HM
147{
148 struct usb_hcd *hcd;
149 struct resource *res_mem;
a4aeb211
HG
150 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
151 struct ehci_platform_priv *priv;
ad3db5da 152 struct ehci_hcd *ehci;
d0e08b00 153 int err, irq, phy_num, clk = 0, rst;
7a7a4a59 154
7a7a4a59
HM
155 if (usb_disabled())
156 return -ENODEV;
157
f3bc64d6 158 /*
a4aeb211
HG
159 * Use reasonable defaults so platforms don't have to provide these
160 * with DT probing on ARM.
f3bc64d6 161 */
a4aeb211
HG
162 if (!pdata)
163 pdata = &ehci_platform_defaults;
e1fd7341 164
c99e76c5
AH
165 err = dma_coerce_mask_and_coherent(&dev->dev,
166 pdata->dma_mask_64 ? DMA_BIT_MASK(64) : DMA_BIT_MASK(32));
17f69b5f
JL
167 if (err) {
168 dev_err(&dev->dev, "Error: DMA mask configuration failed\n");
22d9d8e8 169 return err;
17f69b5f 170 }
f3bc64d6 171
7a7a4a59
HM
172 irq = platform_get_irq(dev, 0);
173 if (irq < 0) {
2350cb0c 174 dev_err(&dev->dev, "no irq provided");
7a7a4a59
HM
175 return irq;
176 }
7a7a4a59 177
a4aeb211
HG
178 hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
179 dev_name(&dev->dev));
180 if (!hcd)
181 return -ENOMEM;
182
183 platform_set_drvdata(dev, hcd);
184 dev->dev.platform_data = pdata;
185 priv = hcd_to_ehci_priv(hcd);
ad3db5da 186 ehci = hcd_to_ehci(hcd);
a4aeb211
HG
187
188 if (pdata == &ehci_platform_defaults && dev->dev.of_node) {
ad3db5da
HG
189 if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
190 ehci->big_endian_mmio = 1;
191
192 if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
193 ehci->big_endian_desc = 1;
194
195 if (of_property_read_bool(dev->dev.of_node, "big-endian"))
196 ehci->big_endian_mmio = ehci->big_endian_desc = 1;
197
314b41b1
WL
198 if (of_property_read_bool(dev->dev.of_node,
199 "needs-reset-on-resume"))
b4629a7b 200 priv->reset_on_resume = true;
314b41b1 201
40f2f2a3
JE
202 if (of_property_read_bool(dev->dev.of_node,
203 "has-transaction-translator"))
b4629a7b 204 hcd->has_tt = 1;
40f2f2a3 205
7e7a0e67
AR
206 priv->num_phys = of_count_phandle_with_args(dev->dev.of_node,
207 "phys", "#phy-cells");
7e7a0e67 208
216e2992
AR
209 if (priv->num_phys > 0) {
210 priv->phys = devm_kcalloc(&dev->dev, priv->num_phys,
211 sizeof(struct phy *), GFP_KERNEL);
212 if (!priv->phys)
213 return -ENOMEM;
214 } else
215 priv->num_phys = 0;
7e7a0e67
AR
216
217 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
216e2992
AR
218 priv->phys[phy_num] = devm_of_phy_get_by_index(
219 &dev->dev, dev->dev.of_node, phy_num);
220 if (IS_ERR(priv->phys[phy_num])) {
221 err = PTR_ERR(priv->phys[phy_num]);
222 goto err_put_hcd;
223 }
a4aeb211
HG
224 }
225
226 for (clk = 0; clk < EHCI_MAX_CLKS; clk++) {
227 priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
228 if (IS_ERR(priv->clks[clk])) {
229 err = PTR_ERR(priv->clks[clk]);
230 if (err == -EPROBE_DEFER)
231 goto err_put_clks;
232 priv->clks[clk] = NULL;
233 break;
234 }
235 }
236 }
237
d0e08b00 238 for (rst = 0; rst < EHCI_MAX_RSTS; rst++) {
76d15c8f
HG
239 priv->rsts[rst] = devm_reset_control_get_shared_by_index(
240 &dev->dev, rst);
d0e08b00
JX
241 if (IS_ERR(priv->rsts[rst])) {
242 err = PTR_ERR(priv->rsts[rst]);
243 if (err == -EPROBE_DEFER)
244 goto err_reset;
245 priv->rsts[rst] = NULL;
246 break;
247 }
248
249 err = reset_control_deassert(priv->rsts[rst]);
76d15c8f 250 if (err)
d0e08b00 251 goto err_reset;
2d87bbd6
BB
252 }
253
843d5e03
AS
254 if (pdata->big_endian_desc)
255 ehci->big_endian_desc = 1;
256 if (pdata->big_endian_mmio)
257 ehci->big_endian_mmio = 1;
b4629a7b
AB
258 if (pdata->has_tt)
259 hcd->has_tt = 1;
260 if (pdata->reset_on_resume)
261 priv->reset_on_resume = true;
843d5e03
AS
262
263#ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
264 if (ehci->big_endian_mmio) {
265 dev_err(&dev->dev,
266 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n");
267 err = -EINVAL;
2d87bbd6 268 goto err_reset;
843d5e03
AS
269 }
270#endif
271#ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
272 if (ehci->big_endian_desc) {
273 dev_err(&dev->dev,
274 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n");
275 err = -EINVAL;
2d87bbd6 276 goto err_reset;
843d5e03
AS
277 }
278#endif
279
04216bed
KM
280 if (pdata->power_on) {
281 err = pdata->power_on(dev);
282 if (err < 0)
2d87bbd6 283 goto err_reset;
04216bed 284 }
7a7a4a59 285
2062ff48 286 res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
148e1134
TR
287 hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
288 if (IS_ERR(hcd->regs)) {
289 err = PTR_ERR(hcd->regs);
a4aeb211 290 goto err_power;
ec03ad85 291 }
2062ff48
VB
292 hcd->rsrc_start = res_mem->start;
293 hcd->rsrc_len = resource_size(res_mem);
294
7a7a4a59
HM
295 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
296 if (err)
a4aeb211 297 goto err_power;
7a7a4a59 298
3c9740a1 299 device_wakeup_enable(hcd->self.controller);
7a7a4a59
HM
300 platform_set_drvdata(dev, hcd);
301
302 return err;
303
04216bed
KM
304err_power:
305 if (pdata->power_off)
306 pdata->power_off(dev);
2d87bbd6 307err_reset:
76d15c8f 308 while (--rst >= 0)
d0e08b00 309 reset_control_assert(priv->rsts[rst]);
a4aeb211
HG
310err_put_clks:
311 while (--clk >= 0)
312 clk_put(priv->clks[clk]);
313err_put_hcd:
314 if (pdata == &ehci_platform_defaults)
315 dev->dev.platform_data = NULL;
316
317 usb_put_hcd(hcd);
04216bed 318
7a7a4a59
HM
319 return err;
320}
321
fb4e98ab 322static int ehci_platform_remove(struct platform_device *dev)
7a7a4a59
HM
323{
324 struct usb_hcd *hcd = platform_get_drvdata(dev);
d4f09e28 325 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
a4aeb211 326 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
d0e08b00 327 int clk, rst;
7a7a4a59
HM
328
329 usb_remove_hcd(hcd);
7a7a4a59 330
04216bed
KM
331 if (pdata->power_off)
332 pdata->power_off(dev);
333
76d15c8f 334 for (rst = 0; rst < EHCI_MAX_RSTS && priv->rsts[rst]; rst++)
d0e08b00 335 reset_control_assert(priv->rsts[rst]);
2d87bbd6 336
a4aeb211
HG
337 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++)
338 clk_put(priv->clks[clk]);
339
340 usb_put_hcd(hcd);
341
f3bc64d6
AB
342 if (pdata == &ehci_platform_defaults)
343 dev->dev.platform_data = NULL;
344
7a7a4a59
HM
345 return 0;
346}
347
5e4ccd9e 348#ifdef CONFIG_PM_SLEEP
7a7a4a59
HM
349static int ehci_platform_suspend(struct device *dev)
350{
351 struct usb_hcd *hcd = dev_get_drvdata(dev);
d4f09e28 352 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
20db5513 353 struct platform_device *pdev = to_platform_device(dev);
c5cf9212 354 bool do_wakeup = device_may_wakeup(dev);
04216bed
KM
355 int ret;
356
357 ret = ehci_suspend(hcd, do_wakeup);
e155b5b8
VG
358 if (ret)
359 return ret;
7a7a4a59 360
04216bed
KM
361 if (pdata->power_suspend)
362 pdata->power_suspend(pdev);
363
364 return ret;
7a7a4a59
HM
365}
366
367static int ehci_platform_resume(struct device *dev)
368{
369 struct usb_hcd *hcd = dev_get_drvdata(dev);
d4f09e28 370 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
20db5513 371 struct platform_device *pdev = to_platform_device(dev);
b4629a7b 372 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
04216bed
KM
373
374 if (pdata->power_on) {
375 int err = pdata->power_on(pdev);
376 if (err < 0)
377 return err;
378 }
7a7a4a59 379
b4629a7b 380 ehci_resume(hcd, priv->reset_on_resume);
7a7a4a59
HM
381 return 0;
382}
5e4ccd9e 383#endif /* CONFIG_PM_SLEEP */
7a7a4a59 384
f3bc64d6
AB
385static const struct of_device_id vt8500_ehci_ids[] = {
386 { .compatible = "via,vt8500-ehci", },
387 { .compatible = "wm,prizm-ehci", },
915974c3 388 { .compatible = "generic-ehci", },
a95cfa6b 389 { .compatible = "cavium,octeon-6335-ehci", },
f3bc64d6
AB
390 {}
391};
a4aeb211 392MODULE_DEVICE_TABLE(of, vt8500_ehci_ids);
f3bc64d6 393
776c15d0
JL
394static const struct acpi_device_id ehci_acpi_match[] = {
395 { "PNP0D20", 0 }, /* EHCI controller without debug */
396 { }
397};
398MODULE_DEVICE_TABLE(acpi, ehci_acpi_match);
399
7a7a4a59
HM
400static const struct platform_device_id ehci_platform_table[] = {
401 { "ehci-platform", 0 },
402 { }
403};
404MODULE_DEVICE_TABLE(platform, ehci_platform_table);
405
5e4ccd9e
WK
406static SIMPLE_DEV_PM_OPS(ehci_platform_pm_ops, ehci_platform_suspend,
407 ehci_platform_resume);
7a7a4a59
HM
408
409static struct platform_driver ehci_platform_driver = {
410 .id_table = ehci_platform_table,
411 .probe = ehci_platform_probe,
7690417d 412 .remove = ehci_platform_remove,
7a7a4a59
HM
413 .shutdown = usb_hcd_platform_shutdown,
414 .driver = {
7a7a4a59
HM
415 .name = "ehci-platform",
416 .pm = &ehci_platform_pm_ops,
ae5e5f7b 417 .of_match_table = vt8500_ehci_ids,
776c15d0 418 .acpi_match_table = ACPI_PTR(ehci_acpi_match),
7a7a4a59
HM
419 }
420};
99f91934
AS
421
422static int __init ehci_platform_init(void)
423{
424 if (usb_disabled())
425 return -ENODEV;
426
427 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
428
429 ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
430 return platform_driver_register(&ehci_platform_driver);
431}
432module_init(ehci_platform_init);
433
434static void __exit ehci_platform_cleanup(void)
435{
436 platform_driver_unregister(&ehci_platform_driver);
437}
438module_exit(ehci_platform_cleanup);
439
440MODULE_DESCRIPTION(DRIVER_DESC);
441MODULE_AUTHOR("Hauke Mehrtens");
442MODULE_AUTHOR("Alan Stern");
443MODULE_LICENSE("GPL");
This page took 0.455147 seconds and 5 git commands to generate.