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