Linux 4.16.11
[linux/fpc-iii.git] / drivers / usb / host / ohci-at91.c
blob5ad9e9bdc8ee7e68913bf1286aea0b78faa7515f
1 // SPDX-License-Identifier: GPL-1.0+
2 /*
3 * OHCI HCD (Host Controller Driver) for USB.
5 * Copyright (C) 2004 SAN People (Pty) Ltd.
6 * Copyright (C) 2005 Thibaut VARENE <varenet@parisc-linux.org>
8 * AT91 Bus Glue
10 * Based on fragments of 2.4 driver by Rick Bronson.
11 * Based on ohci-omap.c
13 * This file is licenced under the GPL.
16 #include <linux/clk.h>
17 #include <linux/dma-mapping.h>
18 #include <linux/gpio/consumer.h>
19 #include <linux/of_platform.h>
20 #include <linux/platform_device.h>
21 #include <linux/platform_data/atmel.h>
22 #include <linux/io.h>
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/mfd/syscon.h>
26 #include <linux/regmap.h>
27 #include <linux/usb.h>
28 #include <linux/usb/hcd.h>
29 #include <soc/at91/atmel-sfr.h>
31 #include "ohci.h"
33 #define valid_port(index) ((index) >= 0 && (index) < AT91_MAX_USBH_PORTS)
34 #define at91_for_each_port(index) \
35 for ((index) = 0; (index) < AT91_MAX_USBH_PORTS; (index)++)
37 /* interface, function and usb clocks; sometimes also an AHB clock */
38 #define hcd_to_ohci_at91_priv(h) \
39 ((struct ohci_at91_priv *)hcd_to_ohci(h)->priv)
41 #define AT91_MAX_USBH_PORTS 3
42 struct at91_usbh_data {
43 struct gpio_desc *vbus_pin[AT91_MAX_USBH_PORTS];
44 struct gpio_desc *overcurrent_pin[AT91_MAX_USBH_PORTS];
45 u8 ports; /* number of ports on root hub */
46 u8 overcurrent_supported;
47 u8 overcurrent_status[AT91_MAX_USBH_PORTS];
48 u8 overcurrent_changed[AT91_MAX_USBH_PORTS];
51 struct ohci_at91_priv {
52 struct clk *iclk;
53 struct clk *fclk;
54 struct clk *hclk;
55 bool clocked;
56 bool wakeup; /* Saved wake-up state for resume */
57 struct regmap *sfr_regmap;
59 /* interface and function clocks; sometimes also an AHB clock */
61 #define DRIVER_DESC "OHCI Atmel driver"
63 static const char hcd_name[] = "ohci-atmel";
65 static struct hc_driver __read_mostly ohci_at91_hc_driver;
67 static const struct ohci_driver_overrides ohci_at91_drv_overrides __initconst = {
68 .extra_priv_size = sizeof(struct ohci_at91_priv),
71 /*-------------------------------------------------------------------------*/
73 static void at91_start_clock(struct ohci_at91_priv *ohci_at91)
75 if (ohci_at91->clocked)
76 return;
78 clk_set_rate(ohci_at91->fclk, 48000000);
79 clk_prepare_enable(ohci_at91->hclk);
80 clk_prepare_enable(ohci_at91->iclk);
81 clk_prepare_enable(ohci_at91->fclk);
82 ohci_at91->clocked = true;
85 static void at91_stop_clock(struct ohci_at91_priv *ohci_at91)
87 if (!ohci_at91->clocked)
88 return;
90 clk_disable_unprepare(ohci_at91->fclk);
91 clk_disable_unprepare(ohci_at91->iclk);
92 clk_disable_unprepare(ohci_at91->hclk);
93 ohci_at91->clocked = false;
96 static void at91_start_hc(struct platform_device *pdev)
98 struct usb_hcd *hcd = platform_get_drvdata(pdev);
99 struct ohci_regs __iomem *regs = hcd->regs;
100 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
102 dev_dbg(&pdev->dev, "start\n");
105 * Start the USB clocks.
107 at91_start_clock(ohci_at91);
110 * The USB host controller must remain in reset.
112 writel(0, &regs->control);
115 static void at91_stop_hc(struct platform_device *pdev)
117 struct usb_hcd *hcd = platform_get_drvdata(pdev);
118 struct ohci_regs __iomem *regs = hcd->regs;
119 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
121 dev_dbg(&pdev->dev, "stop\n");
124 * Put the USB host controller into reset.
126 writel(0, &regs->control);
129 * Stop the USB clocks.
131 at91_stop_clock(ohci_at91);
135 /*-------------------------------------------------------------------------*/
137 static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
139 static struct regmap *at91_dt_syscon_sfr(void)
141 struct regmap *regmap;
143 regmap = syscon_regmap_lookup_by_compatible("atmel,sama5d2-sfr");
144 if (IS_ERR(regmap))
145 regmap = NULL;
147 return regmap;
150 /* configure so an HC device and id are always provided */
151 /* always called with process context; sleeping is OK */
155 * usb_hcd_at91_probe - initialize AT91-based HCDs
156 * Context: !in_interrupt()
158 * Allocates basic resources for this USB host controller, and
159 * then invokes the start() method for the HCD associated with it
160 * through the hotplug entry's driver_data.
162 static int usb_hcd_at91_probe(const struct hc_driver *driver,
163 struct platform_device *pdev)
165 struct at91_usbh_data *board;
166 struct ohci_hcd *ohci;
167 int retval;
168 struct usb_hcd *hcd;
169 struct ohci_at91_priv *ohci_at91;
170 struct device *dev = &pdev->dev;
171 struct resource *res;
172 int irq;
174 irq = platform_get_irq(pdev, 0);
175 if (irq < 0) {
176 dev_dbg(dev, "hcd probe: missing irq resource\n");
177 return irq;
180 hcd = usb_create_hcd(driver, dev, "at91");
181 if (!hcd)
182 return -ENOMEM;
183 ohci_at91 = hcd_to_ohci_at91_priv(hcd);
185 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
186 hcd->regs = devm_ioremap_resource(dev, res);
187 if (IS_ERR(hcd->regs)) {
188 retval = PTR_ERR(hcd->regs);
189 goto err;
191 hcd->rsrc_start = res->start;
192 hcd->rsrc_len = resource_size(res);
194 ohci_at91->iclk = devm_clk_get(dev, "ohci_clk");
195 if (IS_ERR(ohci_at91->iclk)) {
196 dev_err(dev, "failed to get ohci_clk\n");
197 retval = PTR_ERR(ohci_at91->iclk);
198 goto err;
200 ohci_at91->fclk = devm_clk_get(dev, "uhpck");
201 if (IS_ERR(ohci_at91->fclk)) {
202 dev_err(dev, "failed to get uhpck\n");
203 retval = PTR_ERR(ohci_at91->fclk);
204 goto err;
206 ohci_at91->hclk = devm_clk_get(dev, "hclk");
207 if (IS_ERR(ohci_at91->hclk)) {
208 dev_err(dev, "failed to get hclk\n");
209 retval = PTR_ERR(ohci_at91->hclk);
210 goto err;
213 ohci_at91->sfr_regmap = at91_dt_syscon_sfr();
214 if (!ohci_at91->sfr_regmap)
215 dev_warn(dev, "failed to find sfr node\n");
217 board = hcd->self.controller->platform_data;
218 ohci = hcd_to_ohci(hcd);
219 ohci->num_ports = board->ports;
220 at91_start_hc(pdev);
223 * The RemoteWakeupConnected bit has to be set explicitly
224 * before calling ohci_run. The reset value of this bit is 0.
226 ohci->hc_control = OHCI_CTRL_RWC;
228 retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
229 if (retval == 0) {
230 device_wakeup_enable(hcd->self.controller);
231 return retval;
234 /* Error handling */
235 at91_stop_hc(pdev);
237 err:
238 usb_put_hcd(hcd);
239 return retval;
243 /* may be called with controller, bus, and devices active */
246 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
247 * @dev: USB Host Controller being removed
248 * Context: !in_interrupt()
250 * Reverses the effect of usb_hcd_at91_probe(), first invoking
251 * the HCD's stop() method. It is always called from a thread
252 * context, "rmmod" or something similar.
255 static void usb_hcd_at91_remove(struct usb_hcd *hcd,
256 struct platform_device *pdev)
258 usb_remove_hcd(hcd);
259 at91_stop_hc(pdev);
260 usb_put_hcd(hcd);
263 /*-------------------------------------------------------------------------*/
264 static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
266 if (!valid_port(port))
267 return;
269 gpiod_set_value(pdata->vbus_pin[port], enable);
272 static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
274 if (!valid_port(port))
275 return -EINVAL;
277 return gpiod_get_value(pdata->vbus_pin[port]);
281 * Update the status data from the hub with the over-current indicator change.
283 static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
285 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
286 int length = ohci_hub_status_data(hcd, buf);
287 int port;
289 at91_for_each_port(port) {
290 if (pdata->overcurrent_changed[port]) {
291 if (!length)
292 length = 1;
293 buf[0] |= 1 << (port + 1);
297 return length;
300 static int ohci_at91_port_suspend(struct regmap *regmap, u8 set)
302 u32 regval;
303 int ret;
305 if (!regmap)
306 return 0;
308 ret = regmap_read(regmap, AT91_SFR_OHCIICR, &regval);
309 if (ret)
310 return ret;
312 if (set)
313 regval |= AT91_OHCIICR_USB_SUSPEND;
314 else
315 regval &= ~AT91_OHCIICR_USB_SUSPEND;
317 regmap_write(regmap, AT91_SFR_OHCIICR, regval);
319 return 0;
323 * Look at the control requests to the root hub and see if we need to override.
325 static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
326 u16 wIndex, char *buf, u16 wLength)
328 struct at91_usbh_data *pdata = dev_get_platdata(hcd->self.controller);
329 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
330 struct usb_hub_descriptor *desc;
331 int ret = -EINVAL;
332 u32 *data = (u32 *)buf;
334 dev_dbg(hcd->self.controller,
335 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
336 hcd, typeReq, wValue, wIndex, buf, wLength);
338 wIndex--;
340 switch (typeReq) {
341 case SetPortFeature:
342 switch (wValue) {
343 case USB_PORT_FEAT_POWER:
344 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
345 if (valid_port(wIndex)) {
346 ohci_at91_usb_set_power(pdata, wIndex, 1);
347 ret = 0;
350 goto out;
352 case USB_PORT_FEAT_SUSPEND:
353 dev_dbg(hcd->self.controller, "SetPortFeat: SUSPEND\n");
354 if (valid_port(wIndex) && ohci_at91->sfr_regmap) {
355 ohci_at91_port_suspend(ohci_at91->sfr_regmap,
357 return 0;
359 break;
361 break;
363 case ClearPortFeature:
364 switch (wValue) {
365 case USB_PORT_FEAT_C_OVER_CURRENT:
366 dev_dbg(hcd->self.controller,
367 "ClearPortFeature: C_OVER_CURRENT\n");
369 if (valid_port(wIndex)) {
370 pdata->overcurrent_changed[wIndex] = 0;
371 pdata->overcurrent_status[wIndex] = 0;
374 goto out;
376 case USB_PORT_FEAT_OVER_CURRENT:
377 dev_dbg(hcd->self.controller,
378 "ClearPortFeature: OVER_CURRENT\n");
380 if (valid_port(wIndex))
381 pdata->overcurrent_status[wIndex] = 0;
383 goto out;
385 case USB_PORT_FEAT_POWER:
386 dev_dbg(hcd->self.controller,
387 "ClearPortFeature: POWER\n");
389 if (valid_port(wIndex)) {
390 ohci_at91_usb_set_power(pdata, wIndex, 0);
391 return 0;
393 break;
395 case USB_PORT_FEAT_SUSPEND:
396 dev_dbg(hcd->self.controller, "ClearPortFeature: SUSPEND\n");
397 if (valid_port(wIndex) && ohci_at91->sfr_regmap) {
398 ohci_at91_port_suspend(ohci_at91->sfr_regmap,
400 return 0;
402 break;
404 break;
407 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex + 1, buf, wLength);
408 if (ret)
409 goto out;
411 switch (typeReq) {
412 case GetHubDescriptor:
414 /* update the hub's descriptor */
416 desc = (struct usb_hub_descriptor *)buf;
418 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
419 desc->wHubCharacteristics);
421 /* remove the old configurations for power-switching, and
422 * over-current protection, and insert our new configuration
425 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
426 desc->wHubCharacteristics |=
427 cpu_to_le16(HUB_CHAR_INDV_PORT_LPSM);
429 if (pdata->overcurrent_supported) {
430 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
431 desc->wHubCharacteristics |=
432 cpu_to_le16(HUB_CHAR_INDV_PORT_OCPM);
435 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
436 desc->wHubCharacteristics);
438 return ret;
440 case GetPortStatus:
441 /* check port status */
443 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
445 if (valid_port(wIndex)) {
446 if (!ohci_at91_usb_get_power(pdata, wIndex))
447 *data &= ~cpu_to_le32(RH_PS_PPS);
449 if (pdata->overcurrent_changed[wIndex])
450 *data |= cpu_to_le32(RH_PS_OCIC);
452 if (pdata->overcurrent_status[wIndex])
453 *data |= cpu_to_le32(RH_PS_POCI);
457 out:
458 return ret;
461 /*-------------------------------------------------------------------------*/
463 static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
465 struct platform_device *pdev = data;
466 struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
467 int val, port;
469 /* From the GPIO notifying the over-current situation, find
470 * out the corresponding port */
471 at91_for_each_port(port) {
472 if (gpiod_to_irq(pdata->overcurrent_pin[port]) == irq)
473 break;
476 if (port == AT91_MAX_USBH_PORTS) {
477 dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
478 return IRQ_HANDLED;
481 val = gpiod_get_value(pdata->overcurrent_pin[port]);
483 /* When notified of an over-current situation, disable power
484 on the corresponding port, and mark this port in
485 over-current. */
486 if (!val) {
487 ohci_at91_usb_set_power(pdata, port, 0);
488 pdata->overcurrent_status[port] = 1;
489 pdata->overcurrent_changed[port] = 1;
492 dev_dbg(& pdev->dev, "overcurrent situation %s\n",
493 val ? "exited" : "notified");
495 return IRQ_HANDLED;
498 static const struct of_device_id at91_ohci_dt_ids[] = {
499 { .compatible = "atmel,at91rm9200-ohci" },
500 { /* sentinel */ }
503 MODULE_DEVICE_TABLE(of, at91_ohci_dt_ids);
505 /*-------------------------------------------------------------------------*/
507 static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
509 struct device_node *np = pdev->dev.of_node;
510 struct at91_usbh_data *pdata;
511 int i;
512 int ret;
513 int err;
514 u32 ports;
516 /* Right now device-tree probed devices don't get dma_mask set.
517 * Since shared usb code relies on it, set it here for now.
518 * Once we have dma capability bindings this can go away.
520 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
521 if (ret)
522 return ret;
524 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
525 if (!pdata)
526 return -ENOMEM;
528 pdev->dev.platform_data = pdata;
530 if (!of_property_read_u32(np, "num-ports", &ports))
531 pdata->ports = ports;
533 at91_for_each_port(i) {
534 if (i >= pdata->ports)
535 break;
537 pdata->vbus_pin[i] =
538 devm_gpiod_get_index_optional(&pdev->dev, "atmel,vbus",
539 i, GPIOD_OUT_HIGH);
540 if (IS_ERR(pdata->vbus_pin[i])) {
541 err = PTR_ERR(pdata->vbus_pin[i]);
542 dev_err(&pdev->dev, "unable to claim gpio \"vbus\": %d\n", err);
543 continue;
547 at91_for_each_port(i) {
548 if (i >= pdata->ports)
549 break;
551 pdata->overcurrent_pin[i] =
552 devm_gpiod_get_index_optional(&pdev->dev, "atmel,oc",
553 i, GPIOD_IN);
554 if (IS_ERR(pdata->overcurrent_pin[i])) {
555 err = PTR_ERR(pdata->overcurrent_pin[i]);
556 dev_err(&pdev->dev, "unable to claim gpio \"overcurrent\": %d\n", err);
557 continue;
560 ret = devm_request_irq(&pdev->dev,
561 gpiod_to_irq(pdata->overcurrent_pin[i]),
562 ohci_hcd_at91_overcurrent_irq,
563 IRQF_SHARED,
564 "ohci_overcurrent", pdev);
565 if (ret)
566 dev_info(&pdev->dev, "failed to request gpio \"overcurrent\" IRQ\n");
569 device_init_wakeup(&pdev->dev, 1);
570 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
573 static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
575 struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
576 int i;
578 if (pdata) {
579 at91_for_each_port(i)
580 ohci_at91_usb_set_power(pdata, i, 0);
583 device_init_wakeup(&pdev->dev, 0);
584 usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
585 return 0;
588 static int __maybe_unused
589 ohci_hcd_at91_drv_suspend(struct device *dev)
591 struct usb_hcd *hcd = dev_get_drvdata(dev);
592 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
593 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
594 int ret;
597 * Disable wakeup if we are going to sleep with slow clock mode
598 * enabled.
600 ohci_at91->wakeup = device_may_wakeup(dev)
601 && !at91_suspend_entering_slow_clock();
603 if (ohci_at91->wakeup)
604 enable_irq_wake(hcd->irq);
606 ohci_at91_port_suspend(ohci_at91->sfr_regmap, 1);
608 ret = ohci_suspend(hcd, ohci_at91->wakeup);
609 if (ret) {
610 if (ohci_at91->wakeup)
611 disable_irq_wake(hcd->irq);
612 return ret;
615 * The integrated transceivers seem unable to notice disconnect,
616 * reconnect, or wakeup without the 48 MHz clock active. so for
617 * correctness, always discard connection state (using reset).
619 * REVISIT: some boards will be able to turn VBUS off...
621 if (!ohci_at91->wakeup) {
622 ohci->rh_state = OHCI_RH_HALTED;
624 /* flush the writes */
625 (void) ohci_readl (ohci, &ohci->regs->control);
626 at91_stop_clock(ohci_at91);
629 return ret;
632 static int __maybe_unused
633 ohci_hcd_at91_drv_resume(struct device *dev)
635 struct usb_hcd *hcd = dev_get_drvdata(dev);
636 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
638 if (ohci_at91->wakeup)
639 disable_irq_wake(hcd->irq);
641 at91_start_clock(ohci_at91);
643 ohci_resume(hcd, false);
645 ohci_at91_port_suspend(ohci_at91->sfr_regmap, 0);
647 return 0;
650 static SIMPLE_DEV_PM_OPS(ohci_hcd_at91_pm_ops, ohci_hcd_at91_drv_suspend,
651 ohci_hcd_at91_drv_resume);
653 static struct platform_driver ohci_hcd_at91_driver = {
654 .probe = ohci_hcd_at91_drv_probe,
655 .remove = ohci_hcd_at91_drv_remove,
656 .shutdown = usb_hcd_platform_shutdown,
657 .driver = {
658 .name = "at91_ohci",
659 .pm = &ohci_hcd_at91_pm_ops,
660 .of_match_table = at91_ohci_dt_ids,
664 static int __init ohci_at91_init(void)
666 if (usb_disabled())
667 return -ENODEV;
669 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
670 ohci_init_driver(&ohci_at91_hc_driver, &ohci_at91_drv_overrides);
673 * The Atmel HW has some unusual quirks, which require Atmel-specific
674 * workarounds. We override certain hc_driver functions here to
675 * achieve that. We explicitly do not enhance ohci_driver_overrides to
676 * allow this more easily, since this is an unusual case, and we don't
677 * want to encourage others to override these functions by making it
678 * too easy.
681 ohci_at91_hc_driver.hub_status_data = ohci_at91_hub_status_data;
682 ohci_at91_hc_driver.hub_control = ohci_at91_hub_control;
684 return platform_driver_register(&ohci_hcd_at91_driver);
686 module_init(ohci_at91_init);
688 static void __exit ohci_at91_cleanup(void)
690 platform_driver_unregister(&ohci_hcd_at91_driver);
692 module_exit(ohci_at91_cleanup);
694 MODULE_DESCRIPTION(DRIVER_DESC);
695 MODULE_LICENSE("GPL");
696 MODULE_ALIAS("platform:at91_ohci");