1 // SPDX-License-Identifier: GPL-1.0+
3 * OHCI HCD (Host Controller Driver) for USB.
5 * Copyright (C) 2004 SAN People (Pty) Ltd.
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/arm-smccc.h>
17 #include <linux/clk.h>
18 #include <linux/dma-mapping.h>
19 #include <linux/gpio/consumer.h>
20 #include <linux/of_platform.h>
21 #include <linux/platform_device.h>
22 #include <linux/platform_data/atmel.h>
24 #include <linux/kernel.h>
25 #include <linux/module.h>
26 #include <linux/mfd/syscon.h>
27 #include <linux/regmap.h>
28 #include <linux/usb.h>
29 #include <linux/usb/hcd.h>
30 #include <soc/at91/atmel-sfr.h>
34 #define valid_port(index) ((index) >= 0 && (index) < AT91_MAX_USBH_PORTS)
35 #define at91_for_each_port(index) \
36 for ((index) = 0; (index) < AT91_MAX_USBH_PORTS; (index)++)
38 /* interface, function and usb clocks; sometimes also an AHB clock */
39 #define hcd_to_ohci_at91_priv(h) \
40 ((struct ohci_at91_priv *)hcd_to_ohci(h)->priv)
42 #define AT91_MAX_USBH_PORTS 3
43 struct at91_usbh_data {
44 struct gpio_desc *vbus_pin[AT91_MAX_USBH_PORTS];
45 struct gpio_desc *overcurrent_pin[AT91_MAX_USBH_PORTS];
46 u8 ports; /* number of ports on root hub */
47 u8 overcurrent_supported;
48 u8 overcurrent_status[AT91_MAX_USBH_PORTS];
49 u8 overcurrent_changed[AT91_MAX_USBH_PORTS];
52 struct ohci_at91_priv {
57 bool wakeup; /* Saved wake-up state for resume */
58 struct regmap *sfr_regmap;
61 /* interface and function clocks; sometimes also an AHB clock */
63 #define DRIVER_DESC "OHCI Atmel driver"
65 static const char hcd_name[] = "ohci-atmel";
67 static struct hc_driver __read_mostly ohci_at91_hc_driver;
69 static const struct ohci_driver_overrides ohci_at91_drv_overrides __initconst = {
70 .extra_priv_size = sizeof(struct ohci_at91_priv),
73 /*-------------------------------------------------------------------------*/
75 static void at91_start_clock(struct ohci_at91_priv *ohci_at91)
77 if (ohci_at91->clocked)
80 clk_set_rate(ohci_at91->fclk, 48000000);
81 clk_prepare_enable(ohci_at91->hclk);
82 clk_prepare_enable(ohci_at91->iclk);
83 clk_prepare_enable(ohci_at91->fclk);
84 ohci_at91->clocked = true;
87 static void at91_stop_clock(struct ohci_at91_priv *ohci_at91)
89 if (!ohci_at91->clocked)
92 clk_disable_unprepare(ohci_at91->fclk);
93 clk_disable_unprepare(ohci_at91->iclk);
94 clk_disable_unprepare(ohci_at91->hclk);
95 ohci_at91->clocked = false;
98 static void at91_start_hc(struct platform_device *pdev)
100 struct usb_hcd *hcd = platform_get_drvdata(pdev);
101 struct ohci_regs __iomem *regs = hcd->regs;
102 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
104 dev_dbg(&pdev->dev, "start\n");
107 * Start the USB clocks.
109 at91_start_clock(ohci_at91);
112 * The USB host controller must remain in reset.
114 writel(0, ®s->control);
117 static void at91_stop_hc(struct platform_device *pdev)
119 struct usb_hcd *hcd = platform_get_drvdata(pdev);
120 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
122 dev_dbg(&pdev->dev, "stop\n");
125 * Put the USB host controller into reset.
127 usb_hcd_platform_shutdown(pdev);
130 * Stop the USB clocks.
132 at91_stop_clock(ohci_at91);
136 /*-------------------------------------------------------------------------*/
138 static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
140 static u32 at91_dt_suspend_smc(struct device *dev)
147 if (of_property_read_u32(dev->of_node, "microchip,suspend-smc-id", &suspend_smc_id))
150 return suspend_smc_id;
153 static struct regmap *at91_dt_syscon_sfr(void)
155 struct regmap *regmap;
157 regmap = syscon_regmap_lookup_by_compatible("atmel,sama5d2-sfr");
158 if (IS_ERR(regmap)) {
159 regmap = syscon_regmap_lookup_by_compatible("microchip,sam9x60-sfr");
167 /* configure so an HC device and id are always provided */
168 /* always called with process context; sleeping is OK */
172 * usb_hcd_at91_probe - initialize AT91-based HCDs
173 * @driver: Pointer to hc driver instance
174 * @pdev: USB controller to probe
176 * Context: task context, might sleep
178 * Allocates basic resources for this USB host controller, and
179 * then invokes the start() method for the HCD associated with it
180 * through the hotplug entry's driver_data.
182 static int usb_hcd_at91_probe(const struct hc_driver *driver,
183 struct platform_device *pdev)
185 struct at91_usbh_data *board;
186 struct ohci_hcd *ohci;
189 struct ohci_at91_priv *ohci_at91;
190 struct device *dev = &pdev->dev;
191 struct resource *res;
194 irq = platform_get_irq(pdev, 0);
196 dev_dbg(dev, "hcd probe: missing irq resource\n");
200 hcd = usb_create_hcd(driver, dev, "at91");
203 ohci_at91 = hcd_to_ohci_at91_priv(hcd);
205 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
206 hcd->regs = devm_ioremap_resource(dev, res);
207 if (IS_ERR(hcd->regs)) {
208 retval = PTR_ERR(hcd->regs);
211 hcd->rsrc_start = res->start;
212 hcd->rsrc_len = resource_size(res);
214 ohci_at91->iclk = devm_clk_get(dev, "ohci_clk");
215 if (IS_ERR(ohci_at91->iclk)) {
216 dev_err(dev, "failed to get ohci_clk\n");
217 retval = PTR_ERR(ohci_at91->iclk);
220 ohci_at91->fclk = devm_clk_get(dev, "uhpck");
221 if (IS_ERR(ohci_at91->fclk)) {
222 dev_err(dev, "failed to get uhpck\n");
223 retval = PTR_ERR(ohci_at91->fclk);
226 ohci_at91->hclk = devm_clk_get(dev, "hclk");
227 if (IS_ERR(ohci_at91->hclk)) {
228 dev_err(dev, "failed to get hclk\n");
229 retval = PTR_ERR(ohci_at91->hclk);
233 ohci_at91->suspend_smc_id = at91_dt_suspend_smc(dev);
234 if (!ohci_at91->suspend_smc_id) {
235 dev_dbg(dev, "failed to find sfr suspend smc id, using regmap\n");
236 ohci_at91->sfr_regmap = at91_dt_syscon_sfr();
237 if (!ohci_at91->sfr_regmap)
238 dev_dbg(dev, "failed to find sfr node\n");
241 board = hcd->self.controller->platform_data;
242 ohci = hcd_to_ohci(hcd);
243 ohci->num_ports = board->ports;
247 * The RemoteWakeupConnected bit has to be set explicitly
248 * before calling ohci_run. The reset value of this bit is 0.
250 ohci->hc_control = OHCI_CTRL_RWC;
252 retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
254 device_wakeup_enable(hcd->self.controller);
267 /* may be called with controller, bus, and devices active */
270 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
271 * @hcd: USB controller to remove
272 * @pdev: Platform device required for cleanup
274 * Context: task context, might sleep
276 * Reverses the effect of usb_hcd_at91_probe(), first invoking
277 * the HCD's stop() method. It is always called from a thread
278 * context, "rmmod" or something similar.
280 static void usb_hcd_at91_remove(struct usb_hcd *hcd,
281 struct platform_device *pdev)
288 /*-------------------------------------------------------------------------*/
289 static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
291 if (!valid_port(port))
294 gpiod_set_value(pdata->vbus_pin[port], enable);
297 static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
299 if (!valid_port(port))
302 return gpiod_get_value(pdata->vbus_pin[port]);
306 * Update the status data from the hub with the over-current indicator change.
308 static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
310 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
311 int length = ohci_hub_status_data(hcd, buf);
314 at91_for_each_port(port) {
315 if (pdata->overcurrent_changed[port]) {
318 buf[0] |= 1 << (port + 1);
325 static int ohci_at91_port_suspend(struct ohci_at91_priv *ohci_at91, u8 set)
327 struct regmap *regmap = ohci_at91->sfr_regmap;
331 if (ohci_at91->suspend_smc_id) {
332 struct arm_smccc_res res;
334 arm_smccc_smc(ohci_at91->suspend_smc_id, set, 0, 0, 0, 0, 0, 0, &res);
338 ret = regmap_read(regmap, AT91_SFR_OHCIICR, ®val);
343 regval |= AT91_OHCIICR_USB_SUSPEND;
345 regval &= ~AT91_OHCIICR_USB_SUSPEND;
347 regmap_write(regmap, AT91_SFR_OHCIICR, regval);
354 * Look at the control requests to the root hub and see if we need to override.
356 static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
357 u16 wIndex, char *buf, u16 wLength)
359 struct at91_usbh_data *pdata = dev_get_platdata(hcd->self.controller);
360 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
361 struct usb_hub_descriptor *desc;
363 u32 *data = (u32 *)buf;
365 dev_dbg(hcd->self.controller,
366 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
367 hcd, typeReq, wValue, wIndex, buf, wLength);
374 case USB_PORT_FEAT_POWER:
375 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
376 if (valid_port(wIndex)) {
377 ohci_at91_usb_set_power(pdata, wIndex, 1);
383 case USB_PORT_FEAT_SUSPEND:
384 dev_dbg(hcd->self.controller, "SetPortFeat: SUSPEND\n");
385 if (valid_port(wIndex)) {
386 ohci_at91_port_suspend(ohci_at91, 1);
393 case ClearPortFeature:
395 case USB_PORT_FEAT_C_OVER_CURRENT:
396 dev_dbg(hcd->self.controller,
397 "ClearPortFeature: C_OVER_CURRENT\n");
399 if (valid_port(wIndex)) {
400 pdata->overcurrent_changed[wIndex] = 0;
401 pdata->overcurrent_status[wIndex] = 0;
406 case USB_PORT_FEAT_OVER_CURRENT:
407 dev_dbg(hcd->self.controller,
408 "ClearPortFeature: OVER_CURRENT\n");
410 if (valid_port(wIndex))
411 pdata->overcurrent_status[wIndex] = 0;
415 case USB_PORT_FEAT_POWER:
416 dev_dbg(hcd->self.controller,
417 "ClearPortFeature: POWER\n");
419 if (valid_port(wIndex)) {
420 ohci_at91_usb_set_power(pdata, wIndex, 0);
425 case USB_PORT_FEAT_SUSPEND:
426 dev_dbg(hcd->self.controller, "ClearPortFeature: SUSPEND\n");
427 if (valid_port(wIndex)) {
428 ohci_at91_port_suspend(ohci_at91, 0);
436 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex + 1, buf, wLength);
441 case GetHubDescriptor:
443 /* update the hub's descriptor */
445 desc = (struct usb_hub_descriptor *)buf;
447 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
448 desc->wHubCharacteristics);
450 /* remove the old configurations for power-switching, and
451 * over-current protection, and insert our new configuration
454 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
455 desc->wHubCharacteristics |=
456 cpu_to_le16(HUB_CHAR_INDV_PORT_LPSM);
458 if (pdata->overcurrent_supported) {
459 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
460 desc->wHubCharacteristics |=
461 cpu_to_le16(HUB_CHAR_INDV_PORT_OCPM);
464 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
465 desc->wHubCharacteristics);
470 /* check port status */
472 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
474 if (valid_port(wIndex)) {
475 if (!ohci_at91_usb_get_power(pdata, wIndex))
476 *data &= ~cpu_to_le32(RH_PS_PPS);
478 if (pdata->overcurrent_changed[wIndex])
479 *data |= cpu_to_le32(RH_PS_OCIC);
481 if (pdata->overcurrent_status[wIndex])
482 *data |= cpu_to_le32(RH_PS_POCI);
490 /*-------------------------------------------------------------------------*/
492 static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
494 struct platform_device *pdev = data;
495 struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
498 /* From the GPIO notifying the over-current situation, find
499 * out the corresponding port */
500 at91_for_each_port(port) {
501 if (gpiod_to_irq(pdata->overcurrent_pin[port]) == irq)
505 if (port == AT91_MAX_USBH_PORTS) {
506 dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
510 val = gpiod_get_value(pdata->overcurrent_pin[port]);
512 /* When notified of an over-current situation, disable power
513 on the corresponding port, and mark this port in
516 ohci_at91_usb_set_power(pdata, port, 0);
517 pdata->overcurrent_status[port] = 1;
518 pdata->overcurrent_changed[port] = 1;
521 dev_dbg(& pdev->dev, "overcurrent situation %s\n",
522 val ? "exited" : "notified");
527 static const struct of_device_id at91_ohci_dt_ids[] = {
528 { .compatible = "atmel,at91rm9200-ohci" },
532 MODULE_DEVICE_TABLE(of, at91_ohci_dt_ids);
534 /*-------------------------------------------------------------------------*/
536 static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
538 struct device_node *np = pdev->dev.of_node;
539 struct at91_usbh_data *pdata;
545 /* Right now device-tree probed devices don't get dma_mask set.
546 * Since shared usb code relies on it, set it here for now.
547 * Once we have dma capability bindings this can go away.
549 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
553 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
557 pdev->dev.platform_data = pdata;
559 if (!of_property_read_u32(np, "num-ports", &ports))
560 pdata->ports = ports;
562 at91_for_each_port(i) {
563 if (i >= pdata->ports)
567 devm_gpiod_get_index_optional(&pdev->dev, "atmel,vbus",
569 if (IS_ERR(pdata->vbus_pin[i])) {
570 err = PTR_ERR(pdata->vbus_pin[i]);
571 dev_err(&pdev->dev, "unable to claim gpio \"vbus\": %d\n", err);
576 at91_for_each_port(i) {
577 if (i >= pdata->ports)
580 pdata->overcurrent_pin[i] =
581 devm_gpiod_get_index_optional(&pdev->dev, "atmel,oc",
583 if (!pdata->overcurrent_pin[i])
585 if (IS_ERR(pdata->overcurrent_pin[i])) {
586 err = PTR_ERR(pdata->overcurrent_pin[i]);
587 dev_err(&pdev->dev, "unable to claim gpio \"overcurrent\": %d\n", err);
591 ret = devm_request_irq(&pdev->dev,
592 gpiod_to_irq(pdata->overcurrent_pin[i]),
593 ohci_hcd_at91_overcurrent_irq,
595 "ohci_overcurrent", pdev);
597 dev_info(&pdev->dev, "failed to request gpio \"overcurrent\" IRQ\n");
600 device_init_wakeup(&pdev->dev, 1);
601 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
604 static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
606 struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
610 at91_for_each_port(i)
611 ohci_at91_usb_set_power(pdata, i, 0);
614 device_init_wakeup(&pdev->dev, 0);
615 usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
619 static int __maybe_unused
620 ohci_hcd_at91_drv_suspend(struct device *dev)
622 struct usb_hcd *hcd = dev_get_drvdata(dev);
623 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
624 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
628 * Disable wakeup if we are going to sleep with slow clock mode
631 ohci_at91->wakeup = device_may_wakeup(dev)
632 && !at91_suspend_entering_slow_clock();
634 if (ohci_at91->wakeup)
635 enable_irq_wake(hcd->irq);
637 ret = ohci_suspend(hcd, ohci_at91->wakeup);
639 if (ohci_at91->wakeup)
640 disable_irq_wake(hcd->irq);
644 * The integrated transceivers seem unable to notice disconnect,
645 * reconnect, or wakeup without the 48 MHz clock active. so for
646 * correctness, always discard connection state (using reset).
648 * REVISIT: some boards will be able to turn VBUS off...
650 if (!ohci_at91->wakeup) {
651 ohci->rh_state = OHCI_RH_HALTED;
653 /* flush the writes */
654 (void) ohci_readl (ohci, &ohci->regs->control);
656 ohci_at91_port_suspend(ohci_at91, 1);
657 at91_stop_clock(ohci_at91);
659 ohci_at91_port_suspend(ohci_at91, 1);
665 static int __maybe_unused
666 ohci_hcd_at91_drv_resume(struct device *dev)
668 struct usb_hcd *hcd = dev_get_drvdata(dev);
669 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
671 ohci_at91_port_suspend(ohci_at91, 0);
673 if (ohci_at91->wakeup)
674 disable_irq_wake(hcd->irq);
676 at91_start_clock(ohci_at91);
678 ohci_resume(hcd, false);
683 static SIMPLE_DEV_PM_OPS(ohci_hcd_at91_pm_ops, ohci_hcd_at91_drv_suspend,
684 ohci_hcd_at91_drv_resume);
686 static struct platform_driver ohci_hcd_at91_driver = {
687 .probe = ohci_hcd_at91_drv_probe,
688 .remove = ohci_hcd_at91_drv_remove,
689 .shutdown = usb_hcd_platform_shutdown,
692 .pm = &ohci_hcd_at91_pm_ops,
693 .of_match_table = at91_ohci_dt_ids,
697 static int __init ohci_at91_init(void)
702 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
703 ohci_init_driver(&ohci_at91_hc_driver, &ohci_at91_drv_overrides);
706 * The Atmel HW has some unusual quirks, which require Atmel-specific
707 * workarounds. We override certain hc_driver functions here to
708 * achieve that. We explicitly do not enhance ohci_driver_overrides to
709 * allow this more easily, since this is an unusual case, and we don't
710 * want to encourage others to override these functions by making it
714 ohci_at91_hc_driver.hub_status_data = ohci_at91_hub_status_data;
715 ohci_at91_hc_driver.hub_control = ohci_at91_hub_control;
717 return platform_driver_register(&ohci_hcd_at91_driver);
719 module_init(ohci_at91_init);
721 static void __exit ohci_at91_cleanup(void)
723 platform_driver_unregister(&ohci_hcd_at91_driver);
725 module_exit(ohci_at91_cleanup);
727 MODULE_DESCRIPTION(DRIVER_DESC);
728 MODULE_LICENSE("GPL");
729 MODULE_ALIAS("platform:at91_ohci");