]> git.ipfire.org Git - thirdparty/linux.git/blob - drivers/usb/host/ohci-at91.c
Merge remote-tracking branches 'asoc/topic/samsung', 'asoc/topic/sgtl5000', 'asoc...
[thirdparty/linux.git] / drivers / usb / host / ohci-at91.c
1 /*
2 * OHCI HCD (Host Controller Driver) for USB.
3 *
4 * Copyright (C) 2004 SAN People (Pty) Ltd.
5 * Copyright (C) 2005 Thibaut VARENE <varenet@parisc-linux.org>
6 *
7 * AT91 Bus Glue
8 *
9 * Based on fragments of 2.4 driver by Rick Bronson.
10 * Based on ohci-omap.c
11 *
12 * This file is licenced under the GPL.
13 */
14
15 #include <linux/clk.h>
16 #include <linux/dma-mapping.h>
17 #include <linux/gpio/consumer.h>
18 #include <linux/of_platform.h>
19 #include <linux/platform_device.h>
20 #include <linux/platform_data/atmel.h>
21 #include <linux/io.h>
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/mfd/syscon.h>
25 #include <linux/regmap.h>
26 #include <linux/usb.h>
27 #include <linux/usb/hcd.h>
28 #include <soc/at91/atmel-sfr.h>
29
30 #include "ohci.h"
31
32 #define valid_port(index) ((index) >= 0 && (index) < AT91_MAX_USBH_PORTS)
33 #define at91_for_each_port(index) \
34 for ((index) = 0; (index) < AT91_MAX_USBH_PORTS; (index)++)
35
36 /* interface, function and usb clocks; sometimes also an AHB clock */
37 #define hcd_to_ohci_at91_priv(h) \
38 ((struct ohci_at91_priv *)hcd_to_ohci(h)->priv)
39
40 #define AT91_MAX_USBH_PORTS 3
41 struct at91_usbh_data {
42 struct gpio_desc *vbus_pin[AT91_MAX_USBH_PORTS];
43 struct gpio_desc *overcurrent_pin[AT91_MAX_USBH_PORTS];
44 u8 ports; /* number of ports on root hub */
45 u8 overcurrent_supported;
46 u8 overcurrent_status[AT91_MAX_USBH_PORTS];
47 u8 overcurrent_changed[AT91_MAX_USBH_PORTS];
48 };
49
50 struct ohci_at91_priv {
51 struct clk *iclk;
52 struct clk *fclk;
53 struct clk *hclk;
54 bool clocked;
55 bool wakeup; /* Saved wake-up state for resume */
56 struct regmap *sfr_regmap;
57 };
58 /* interface and function clocks; sometimes also an AHB clock */
59
60 #define DRIVER_DESC "OHCI Atmel driver"
61
62 static const char hcd_name[] = "ohci-atmel";
63
64 static struct hc_driver __read_mostly ohci_at91_hc_driver;
65
66 static const struct ohci_driver_overrides ohci_at91_drv_overrides __initconst = {
67 .extra_priv_size = sizeof(struct ohci_at91_priv),
68 };
69
70 /*-------------------------------------------------------------------------*/
71
72 static void at91_start_clock(struct ohci_at91_priv *ohci_at91)
73 {
74 if (ohci_at91->clocked)
75 return;
76
77 clk_set_rate(ohci_at91->fclk, 48000000);
78 clk_prepare_enable(ohci_at91->hclk);
79 clk_prepare_enable(ohci_at91->iclk);
80 clk_prepare_enable(ohci_at91->fclk);
81 ohci_at91->clocked = true;
82 }
83
84 static void at91_stop_clock(struct ohci_at91_priv *ohci_at91)
85 {
86 if (!ohci_at91->clocked)
87 return;
88
89 clk_disable_unprepare(ohci_at91->fclk);
90 clk_disable_unprepare(ohci_at91->iclk);
91 clk_disable_unprepare(ohci_at91->hclk);
92 ohci_at91->clocked = false;
93 }
94
95 static void at91_start_hc(struct platform_device *pdev)
96 {
97 struct usb_hcd *hcd = platform_get_drvdata(pdev);
98 struct ohci_regs __iomem *regs = hcd->regs;
99 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
100
101 dev_dbg(&pdev->dev, "start\n");
102
103 /*
104 * Start the USB clocks.
105 */
106 at91_start_clock(ohci_at91);
107
108 /*
109 * The USB host controller must remain in reset.
110 */
111 writel(0, &regs->control);
112 }
113
114 static void at91_stop_hc(struct platform_device *pdev)
115 {
116 struct usb_hcd *hcd = platform_get_drvdata(pdev);
117 struct ohci_regs __iomem *regs = hcd->regs;
118 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
119
120 dev_dbg(&pdev->dev, "stop\n");
121
122 /*
123 * Put the USB host controller into reset.
124 */
125 writel(0, &regs->control);
126
127 /*
128 * Stop the USB clocks.
129 */
130 at91_stop_clock(ohci_at91);
131 }
132
133
134 /*-------------------------------------------------------------------------*/
135
136 static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
137
138 static struct regmap *at91_dt_syscon_sfr(void)
139 {
140 struct regmap *regmap;
141
142 regmap = syscon_regmap_lookup_by_compatible("atmel,sama5d2-sfr");
143 if (IS_ERR(regmap))
144 regmap = NULL;
145
146 return regmap;
147 }
148
149 /* configure so an HC device and id are always provided */
150 /* always called with process context; sleeping is OK */
151
152
153 /**
154 * usb_hcd_at91_probe - initialize AT91-based HCDs
155 * Context: !in_interrupt()
156 *
157 * Allocates basic resources for this USB host controller, and
158 * then invokes the start() method for the HCD associated with it
159 * through the hotplug entry's driver_data.
160 */
161 static int usb_hcd_at91_probe(const struct hc_driver *driver,
162 struct platform_device *pdev)
163 {
164 struct at91_usbh_data *board;
165 struct ohci_hcd *ohci;
166 int retval;
167 struct usb_hcd *hcd;
168 struct ohci_at91_priv *ohci_at91;
169 struct device *dev = &pdev->dev;
170 struct resource *res;
171 int irq;
172
173 irq = platform_get_irq(pdev, 0);
174 if (irq < 0) {
175 dev_dbg(dev, "hcd probe: missing irq resource\n");
176 return irq;
177 }
178
179 hcd = usb_create_hcd(driver, dev, "at91");
180 if (!hcd)
181 return -ENOMEM;
182 ohci_at91 = hcd_to_ohci_at91_priv(hcd);
183
184 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
185 hcd->regs = devm_ioremap_resource(dev, res);
186 if (IS_ERR(hcd->regs)) {
187 retval = PTR_ERR(hcd->regs);
188 goto err;
189 }
190 hcd->rsrc_start = res->start;
191 hcd->rsrc_len = resource_size(res);
192
193 ohci_at91->iclk = devm_clk_get(dev, "ohci_clk");
194 if (IS_ERR(ohci_at91->iclk)) {
195 dev_err(dev, "failed to get ohci_clk\n");
196 retval = PTR_ERR(ohci_at91->iclk);
197 goto err;
198 }
199 ohci_at91->fclk = devm_clk_get(dev, "uhpck");
200 if (IS_ERR(ohci_at91->fclk)) {
201 dev_err(dev, "failed to get uhpck\n");
202 retval = PTR_ERR(ohci_at91->fclk);
203 goto err;
204 }
205 ohci_at91->hclk = devm_clk_get(dev, "hclk");
206 if (IS_ERR(ohci_at91->hclk)) {
207 dev_err(dev, "failed to get hclk\n");
208 retval = PTR_ERR(ohci_at91->hclk);
209 goto err;
210 }
211
212 ohci_at91->sfr_regmap = at91_dt_syscon_sfr();
213 if (!ohci_at91->sfr_regmap)
214 dev_warn(dev, "failed to find sfr node\n");
215
216 board = hcd->self.controller->platform_data;
217 ohci = hcd_to_ohci(hcd);
218 ohci->num_ports = board->ports;
219 at91_start_hc(pdev);
220
221 /*
222 * The RemoteWakeupConnected bit has to be set explicitly
223 * before calling ohci_run. The reset value of this bit is 0.
224 */
225 ohci->hc_control = OHCI_CTRL_RWC;
226
227 retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
228 if (retval == 0) {
229 device_wakeup_enable(hcd->self.controller);
230 return retval;
231 }
232
233 /* Error handling */
234 at91_stop_hc(pdev);
235
236 err:
237 usb_put_hcd(hcd);
238 return retval;
239 }
240
241
242 /* may be called with controller, bus, and devices active */
243
244 /**
245 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
246 * @dev: USB Host Controller being removed
247 * Context: !in_interrupt()
248 *
249 * Reverses the effect of usb_hcd_at91_probe(), first invoking
250 * the HCD's stop() method. It is always called from a thread
251 * context, "rmmod" or something similar.
252 *
253 */
254 static void usb_hcd_at91_remove(struct usb_hcd *hcd,
255 struct platform_device *pdev)
256 {
257 usb_remove_hcd(hcd);
258 at91_stop_hc(pdev);
259 usb_put_hcd(hcd);
260 }
261
262 /*-------------------------------------------------------------------------*/
263 static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
264 {
265 if (!valid_port(port))
266 return;
267
268 gpiod_set_value(pdata->vbus_pin[port], enable);
269 }
270
271 static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
272 {
273 if (!valid_port(port))
274 return -EINVAL;
275
276 return gpiod_get_value(pdata->vbus_pin[port]);
277 }
278
279 /*
280 * Update the status data from the hub with the over-current indicator change.
281 */
282 static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
283 {
284 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
285 int length = ohci_hub_status_data(hcd, buf);
286 int port;
287
288 at91_for_each_port(port) {
289 if (pdata->overcurrent_changed[port]) {
290 if (!length)
291 length = 1;
292 buf[0] |= 1 << (port + 1);
293 }
294 }
295
296 return length;
297 }
298
299 static int ohci_at91_port_suspend(struct regmap *regmap, u8 set)
300 {
301 u32 regval;
302 int ret;
303
304 if (!regmap)
305 return 0;
306
307 ret = regmap_read(regmap, AT91_SFR_OHCIICR, &regval);
308 if (ret)
309 return ret;
310
311 if (set)
312 regval |= AT91_OHCIICR_USB_SUSPEND;
313 else
314 regval &= ~AT91_OHCIICR_USB_SUSPEND;
315
316 regmap_write(regmap, AT91_SFR_OHCIICR, regval);
317
318 return 0;
319 }
320
321 /*
322 * Look at the control requests to the root hub and see if we need to override.
323 */
324 static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
325 u16 wIndex, char *buf, u16 wLength)
326 {
327 struct at91_usbh_data *pdata = dev_get_platdata(hcd->self.controller);
328 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
329 struct usb_hub_descriptor *desc;
330 int ret = -EINVAL;
331 u32 *data = (u32 *)buf;
332
333 dev_dbg(hcd->self.controller,
334 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
335 hcd, typeReq, wValue, wIndex, buf, wLength);
336
337 wIndex--;
338
339 switch (typeReq) {
340 case SetPortFeature:
341 switch (wValue) {
342 case USB_PORT_FEAT_POWER:
343 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
344 if (valid_port(wIndex)) {
345 ohci_at91_usb_set_power(pdata, wIndex, 1);
346 ret = 0;
347 }
348
349 goto out;
350
351 case USB_PORT_FEAT_SUSPEND:
352 dev_dbg(hcd->self.controller, "SetPortFeat: SUSPEND\n");
353 if (valid_port(wIndex) && ohci_at91->sfr_regmap) {
354 ohci_at91_port_suspend(ohci_at91->sfr_regmap,
355 1);
356 return 0;
357 }
358 break;
359 }
360 break;
361
362 case ClearPortFeature:
363 switch (wValue) {
364 case USB_PORT_FEAT_C_OVER_CURRENT:
365 dev_dbg(hcd->self.controller,
366 "ClearPortFeature: C_OVER_CURRENT\n");
367
368 if (valid_port(wIndex)) {
369 pdata->overcurrent_changed[wIndex] = 0;
370 pdata->overcurrent_status[wIndex] = 0;
371 }
372
373 goto out;
374
375 case USB_PORT_FEAT_OVER_CURRENT:
376 dev_dbg(hcd->self.controller,
377 "ClearPortFeature: OVER_CURRENT\n");
378
379 if (valid_port(wIndex))
380 pdata->overcurrent_status[wIndex] = 0;
381
382 goto out;
383
384 case USB_PORT_FEAT_POWER:
385 dev_dbg(hcd->self.controller,
386 "ClearPortFeature: POWER\n");
387
388 if (valid_port(wIndex)) {
389 ohci_at91_usb_set_power(pdata, wIndex, 0);
390 return 0;
391 }
392 break;
393
394 case USB_PORT_FEAT_SUSPEND:
395 dev_dbg(hcd->self.controller, "ClearPortFeature: SUSPEND\n");
396 if (valid_port(wIndex) && ohci_at91->sfr_regmap) {
397 ohci_at91_port_suspend(ohci_at91->sfr_regmap,
398 0);
399 return 0;
400 }
401 break;
402 }
403 break;
404 }
405
406 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex + 1, buf, wLength);
407 if (ret)
408 goto out;
409
410 switch (typeReq) {
411 case GetHubDescriptor:
412
413 /* update the hub's descriptor */
414
415 desc = (struct usb_hub_descriptor *)buf;
416
417 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
418 desc->wHubCharacteristics);
419
420 /* remove the old configurations for power-switching, and
421 * over-current protection, and insert our new configuration
422 */
423
424 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
425 desc->wHubCharacteristics |=
426 cpu_to_le16(HUB_CHAR_INDV_PORT_LPSM);
427
428 if (pdata->overcurrent_supported) {
429 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
430 desc->wHubCharacteristics |=
431 cpu_to_le16(HUB_CHAR_INDV_PORT_OCPM);
432 }
433
434 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
435 desc->wHubCharacteristics);
436
437 return ret;
438
439 case GetPortStatus:
440 /* check port status */
441
442 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
443
444 if (valid_port(wIndex)) {
445 if (!ohci_at91_usb_get_power(pdata, wIndex))
446 *data &= ~cpu_to_le32(RH_PS_PPS);
447
448 if (pdata->overcurrent_changed[wIndex])
449 *data |= cpu_to_le32(RH_PS_OCIC);
450
451 if (pdata->overcurrent_status[wIndex])
452 *data |= cpu_to_le32(RH_PS_POCI);
453 }
454 }
455
456 out:
457 return ret;
458 }
459
460 /*-------------------------------------------------------------------------*/
461
462 static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
463 {
464 struct platform_device *pdev = data;
465 struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
466 int val, port;
467
468 /* From the GPIO notifying the over-current situation, find
469 * out the corresponding port */
470 at91_for_each_port(port) {
471 if (gpiod_to_irq(pdata->overcurrent_pin[port]) == irq)
472 break;
473 }
474
475 if (port == AT91_MAX_USBH_PORTS) {
476 dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
477 return IRQ_HANDLED;
478 }
479
480 val = gpiod_get_value(pdata->overcurrent_pin[port]);
481
482 /* When notified of an over-current situation, disable power
483 on the corresponding port, and mark this port in
484 over-current. */
485 if (!val) {
486 ohci_at91_usb_set_power(pdata, port, 0);
487 pdata->overcurrent_status[port] = 1;
488 pdata->overcurrent_changed[port] = 1;
489 }
490
491 dev_dbg(& pdev->dev, "overcurrent situation %s\n",
492 val ? "exited" : "notified");
493
494 return IRQ_HANDLED;
495 }
496
497 static const struct of_device_id at91_ohci_dt_ids[] = {
498 { .compatible = "atmel,at91rm9200-ohci" },
499 { /* sentinel */ }
500 };
501
502 MODULE_DEVICE_TABLE(of, at91_ohci_dt_ids);
503
504 /*-------------------------------------------------------------------------*/
505
506 static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
507 {
508 struct device_node *np = pdev->dev.of_node;
509 struct at91_usbh_data *pdata;
510 int i;
511 int ret;
512 int err;
513 u32 ports;
514
515 /* Right now device-tree probed devices don't get dma_mask set.
516 * Since shared usb code relies on it, set it here for now.
517 * Once we have dma capability bindings this can go away.
518 */
519 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
520 if (ret)
521 return ret;
522
523 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
524 if (!pdata)
525 return -ENOMEM;
526
527 pdev->dev.platform_data = pdata;
528
529 if (!of_property_read_u32(np, "num-ports", &ports))
530 pdata->ports = ports;
531
532 at91_for_each_port(i) {
533 if (i >= pdata->ports)
534 break;
535
536 pdata->vbus_pin[i] =
537 devm_gpiod_get_index_optional(&pdev->dev, "atmel,vbus",
538 i, GPIOD_OUT_HIGH);
539 if (IS_ERR(pdata->vbus_pin[i])) {
540 err = PTR_ERR(pdata->vbus_pin[i]);
541 dev_err(&pdev->dev, "unable to claim gpio \"vbus\": %d\n", err);
542 continue;
543 }
544 }
545
546 at91_for_each_port(i) {
547 if (i >= pdata->ports)
548 break;
549
550 pdata->overcurrent_pin[i] =
551 devm_gpiod_get_index_optional(&pdev->dev, "atmel,oc",
552 i, GPIOD_IN);
553 if (IS_ERR(pdata->overcurrent_pin[i])) {
554 err = PTR_ERR(pdata->overcurrent_pin[i]);
555 dev_err(&pdev->dev, "unable to claim gpio \"overcurrent\": %d\n", err);
556 continue;
557 }
558
559 ret = devm_request_irq(&pdev->dev,
560 gpiod_to_irq(pdata->overcurrent_pin[i]),
561 ohci_hcd_at91_overcurrent_irq,
562 IRQF_SHARED,
563 "ohci_overcurrent", pdev);
564 if (ret)
565 dev_info(&pdev->dev, "failed to request gpio \"overcurrent\" IRQ\n");
566 }
567
568 device_init_wakeup(&pdev->dev, 1);
569 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
570 }
571
572 static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
573 {
574 struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
575 int i;
576
577 if (pdata) {
578 at91_for_each_port(i)
579 ohci_at91_usb_set_power(pdata, i, 0);
580 }
581
582 device_init_wakeup(&pdev->dev, 0);
583 usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
584 return 0;
585 }
586
587 static int __maybe_unused
588 ohci_hcd_at91_drv_suspend(struct device *dev)
589 {
590 struct usb_hcd *hcd = dev_get_drvdata(dev);
591 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
592 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
593 int ret;
594
595 /*
596 * Disable wakeup if we are going to sleep with slow clock mode
597 * enabled.
598 */
599 ohci_at91->wakeup = device_may_wakeup(dev)
600 && !at91_suspend_entering_slow_clock();
601
602 if (ohci_at91->wakeup)
603 enable_irq_wake(hcd->irq);
604
605 ohci_at91_port_suspend(ohci_at91->sfr_regmap, 1);
606
607 ret = ohci_suspend(hcd, ohci_at91->wakeup);
608 if (ret) {
609 if (ohci_at91->wakeup)
610 disable_irq_wake(hcd->irq);
611 return ret;
612 }
613 /*
614 * The integrated transceivers seem unable to notice disconnect,
615 * reconnect, or wakeup without the 48 MHz clock active. so for
616 * correctness, always discard connection state (using reset).
617 *
618 * REVISIT: some boards will be able to turn VBUS off...
619 */
620 if (!ohci_at91->wakeup) {
621 ohci->rh_state = OHCI_RH_HALTED;
622
623 /* flush the writes */
624 (void) ohci_readl (ohci, &ohci->regs->control);
625 at91_stop_clock(ohci_at91);
626 }
627
628 return ret;
629 }
630
631 static int __maybe_unused
632 ohci_hcd_at91_drv_resume(struct device *dev)
633 {
634 struct usb_hcd *hcd = dev_get_drvdata(dev);
635 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
636
637 if (ohci_at91->wakeup)
638 disable_irq_wake(hcd->irq);
639
640 at91_start_clock(ohci_at91);
641
642 ohci_resume(hcd, false);
643
644 ohci_at91_port_suspend(ohci_at91->sfr_regmap, 0);
645
646 return 0;
647 }
648
649 static SIMPLE_DEV_PM_OPS(ohci_hcd_at91_pm_ops, ohci_hcd_at91_drv_suspend,
650 ohci_hcd_at91_drv_resume);
651
652 static struct platform_driver ohci_hcd_at91_driver = {
653 .probe = ohci_hcd_at91_drv_probe,
654 .remove = ohci_hcd_at91_drv_remove,
655 .shutdown = usb_hcd_platform_shutdown,
656 .driver = {
657 .name = "at91_ohci",
658 .pm = &ohci_hcd_at91_pm_ops,
659 .of_match_table = at91_ohci_dt_ids,
660 },
661 };
662
663 static int __init ohci_at91_init(void)
664 {
665 if (usb_disabled())
666 return -ENODEV;
667
668 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
669 ohci_init_driver(&ohci_at91_hc_driver, &ohci_at91_drv_overrides);
670
671 /*
672 * The Atmel HW has some unusual quirks, which require Atmel-specific
673 * workarounds. We override certain hc_driver functions here to
674 * achieve that. We explicitly do not enhance ohci_driver_overrides to
675 * allow this more easily, since this is an unusual case, and we don't
676 * want to encourage others to override these functions by making it
677 * too easy.
678 */
679
680 ohci_at91_hc_driver.hub_status_data = ohci_at91_hub_status_data;
681 ohci_at91_hc_driver.hub_control = ohci_at91_hub_control;
682
683 return platform_driver_register(&ohci_hcd_at91_driver);
684 }
685 module_init(ohci_at91_init);
686
687 static void __exit ohci_at91_cleanup(void)
688 {
689 platform_driver_unregister(&ohci_hcd_at91_driver);
690 }
691 module_exit(ohci_at91_cleanup);
692
693 MODULE_DESCRIPTION(DRIVER_DESC);
694 MODULE_LICENSE("GPL");
695 MODULE_ALIAS("platform:at91_ohci");