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