1 // SPDX-License-Identifier: GPL-1.0+
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>
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 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)
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)
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, ®s->control);
115 static void at91_stop_hc(struct platform_device *pdev)
117 struct usb_hcd *hcd = platform_get_drvdata(pdev);
118 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
120 dev_dbg(&pdev->dev, "stop\n");
123 * Put the USB host controller into reset.
125 usb_hcd_platform_shutdown(pdev);
128 * Stop the USB clocks.
130 at91_stop_clock(ohci_at91);
134 /*-------------------------------------------------------------------------*/
136 static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
138 static u32 at91_dt_suspend_smc(struct device *dev)
145 if (of_property_read_u32(dev->of_node, "microchip,suspend-smc-id", &suspend_smc_id))
148 return suspend_smc_id;
151 static struct regmap *at91_dt_syscon_sfr(void)
153 struct regmap *regmap;
155 regmap = syscon_regmap_lookup_by_compatible("atmel,sama5d2-sfr");
156 if (IS_ERR(regmap)) {
157 regmap = syscon_regmap_lookup_by_compatible("microchip,sam9x60-sfr");
165 /* configure so an HC device and id are always provided */
166 /* always called with process context; sleeping is OK */
170 * usb_hcd_at91_probe - initialize AT91-based HCDs
171 * @driver: Pointer to hc driver instance
172 * @pdev: USB controller to probe
174 * Context: task context, might sleep
176 * Allocates basic resources for this USB host controller, and
177 * then invokes the start() method for the HCD associated with it
178 * through the hotplug entry's driver_data.
180 static int usb_hcd_at91_probe(const struct hc_driver *driver,
181 struct platform_device *pdev)
183 struct at91_usbh_data *board;
184 struct ohci_hcd *ohci;
187 struct ohci_at91_priv *ohci_at91;
188 struct device *dev = &pdev->dev;
189 struct resource *res;
192 irq = platform_get_irq(pdev, 0);
194 dev_dbg(dev, "hcd probe: missing irq resource\n");
198 hcd = usb_create_hcd(driver, dev, "at91");
201 ohci_at91 = hcd_to_ohci_at91_priv(hcd);
203 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
204 hcd->regs = devm_ioremap_resource(dev, res);
205 if (IS_ERR(hcd->regs)) {
206 retval = PTR_ERR(hcd->regs);
209 hcd->rsrc_start = res->start;
210 hcd->rsrc_len = resource_size(res);
212 ohci_at91->iclk = devm_clk_get(dev, "ohci_clk");
213 if (IS_ERR(ohci_at91->iclk)) {
214 dev_err(dev, "failed to get ohci_clk\n");
215 retval = PTR_ERR(ohci_at91->iclk);
218 ohci_at91->fclk = devm_clk_get(dev, "uhpck");
219 if (IS_ERR(ohci_at91->fclk)) {
220 dev_err(dev, "failed to get uhpck\n");
221 retval = PTR_ERR(ohci_at91->fclk);
224 ohci_at91->hclk = devm_clk_get(dev, "hclk");
225 if (IS_ERR(ohci_at91->hclk)) {
226 dev_err(dev, "failed to get hclk\n");
227 retval = PTR_ERR(ohci_at91->hclk);
231 ohci_at91->suspend_smc_id = at91_dt_suspend_smc(dev);
232 if (!ohci_at91->suspend_smc_id) {
233 dev_dbg(dev, "failed to find sfr suspend smc id, using regmap\n");
234 ohci_at91->sfr_regmap = at91_dt_syscon_sfr();
235 if (!ohci_at91->sfr_regmap)
236 dev_dbg(dev, "failed to find sfr node\n");
239 board = hcd->self.controller->platform_data;
240 ohci = hcd_to_ohci(hcd);
241 ohci->num_ports = board->ports;
245 * The RemoteWakeupConnected bit has to be set explicitly
246 * before calling ohci_run. The reset value of this bit is 0.
248 ohci->hc_control = OHCI_CTRL_RWC;
250 retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
252 device_wakeup_enable(hcd->self.controller);
265 /* may be called with controller, bus, and devices active */
268 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
269 * @hcd: USB controller to remove
270 * @pdev: Platform device required for cleanup
272 * Context: task context, might sleep
274 * Reverses the effect of usb_hcd_at91_probe(), first invoking
275 * the HCD's stop() method. It is always called from a thread
276 * context, "rmmod" or something similar.
278 static void usb_hcd_at91_remove(struct usb_hcd *hcd,
279 struct platform_device *pdev)
286 /*-------------------------------------------------------------------------*/
287 static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
289 if (!valid_port(port))
292 gpiod_set_value(pdata->vbus_pin[port], enable);
295 static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
297 if (!valid_port(port))
300 return gpiod_get_value(pdata->vbus_pin[port]);
304 * Update the status data from the hub with the over-current indicator change.
306 static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
308 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
309 int length = ohci_hub_status_data(hcd, buf);
312 at91_for_each_port(port) {
313 if (pdata->overcurrent_changed[port]) {
316 buf[0] |= 1 << (port + 1);
323 static int ohci_at91_port_suspend(struct ohci_at91_priv *ohci_at91, u8 set)
325 struct regmap *regmap = ohci_at91->sfr_regmap;
329 if (ohci_at91->suspend_smc_id) {
330 struct arm_smccc_res res;
332 arm_smccc_smc(ohci_at91->suspend_smc_id, set, 0, 0, 0, 0, 0, 0, &res);
336 ret = regmap_read(regmap, AT91_SFR_OHCIICR, ®val);
341 regval |= AT91_OHCIICR_USB_SUSPEND;
343 regval &= ~AT91_OHCIICR_USB_SUSPEND;
345 regmap_write(regmap, AT91_SFR_OHCIICR, regval);
352 * Look at the control requests to the root hub and see if we need to override.
354 static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
355 u16 wIndex, char *buf, u16 wLength)
357 struct at91_usbh_data *pdata = dev_get_platdata(hcd->self.controller);
358 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
359 struct usb_hub_descriptor *desc;
361 u32 *data = (u32 *)buf;
363 dev_dbg(hcd->self.controller,
364 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
365 hcd, typeReq, wValue, wIndex, buf, wLength);
372 case USB_PORT_FEAT_POWER:
373 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
374 if (valid_port(wIndex)) {
375 ohci_at91_usb_set_power(pdata, wIndex, 1);
381 case USB_PORT_FEAT_SUSPEND:
382 dev_dbg(hcd->self.controller, "SetPortFeat: SUSPEND\n");
383 if (valid_port(wIndex)) {
384 ohci_at91_port_suspend(ohci_at91, 1);
391 case ClearPortFeature:
393 case USB_PORT_FEAT_C_OVER_CURRENT:
394 dev_dbg(hcd->self.controller,
395 "ClearPortFeature: C_OVER_CURRENT\n");
397 if (valid_port(wIndex)) {
398 pdata->overcurrent_changed[wIndex] = 0;
399 pdata->overcurrent_status[wIndex] = 0;
404 case USB_PORT_FEAT_OVER_CURRENT:
405 dev_dbg(hcd->self.controller,
406 "ClearPortFeature: OVER_CURRENT\n");
408 if (valid_port(wIndex))
409 pdata->overcurrent_status[wIndex] = 0;
413 case USB_PORT_FEAT_POWER:
414 dev_dbg(hcd->self.controller,
415 "ClearPortFeature: POWER\n");
417 if (valid_port(wIndex)) {
418 ohci_at91_usb_set_power(pdata, wIndex, 0);
423 case USB_PORT_FEAT_SUSPEND:
424 dev_dbg(hcd->self.controller, "ClearPortFeature: SUSPEND\n");
425 if (valid_port(wIndex)) {
426 ohci_at91_port_suspend(ohci_at91, 0);
434 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex + 1, buf, wLength);
439 case GetHubDescriptor:
441 /* update the hub's descriptor */
443 desc = (struct usb_hub_descriptor *)buf;
445 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
446 desc->wHubCharacteristics);
448 /* remove the old configurations for power-switching, and
449 * over-current protection, and insert our new configuration
452 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
453 desc->wHubCharacteristics |=
454 cpu_to_le16(HUB_CHAR_INDV_PORT_LPSM);
456 if (pdata->overcurrent_supported) {
457 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
458 desc->wHubCharacteristics |=
459 cpu_to_le16(HUB_CHAR_INDV_PORT_OCPM);
462 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
463 desc->wHubCharacteristics);
468 /* check port status */
470 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
472 if (valid_port(wIndex)) {
473 if (!ohci_at91_usb_get_power(pdata, wIndex))
474 *data &= ~cpu_to_le32(RH_PS_PPS);
476 if (pdata->overcurrent_changed[wIndex])
477 *data |= cpu_to_le32(RH_PS_OCIC);
479 if (pdata->overcurrent_status[wIndex])
480 *data |= cpu_to_le32(RH_PS_POCI);
488 /*-------------------------------------------------------------------------*/
490 static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
492 struct platform_device *pdev = data;
493 struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
496 /* From the GPIO notifying the over-current situation, find
497 * out the corresponding port */
498 at91_for_each_port(port) {
499 if (gpiod_to_irq(pdata->overcurrent_pin[port]) == irq)
503 if (port == AT91_MAX_USBH_PORTS) {
504 dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
508 val = gpiod_get_value(pdata->overcurrent_pin[port]);
510 /* When notified of an over-current situation, disable power
511 on the corresponding port, and mark this port in
514 ohci_at91_usb_set_power(pdata, port, 0);
515 pdata->overcurrent_status[port] = 1;
516 pdata->overcurrent_changed[port] = 1;
519 dev_dbg(& pdev->dev, "overcurrent situation %s\n",
520 val ? "exited" : "notified");
525 static const struct of_device_id at91_ohci_dt_ids[] = {
526 { .compatible = "atmel,at91rm9200-ohci" },
530 MODULE_DEVICE_TABLE(of, at91_ohci_dt_ids);
532 /*-------------------------------------------------------------------------*/
534 static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
536 struct device_node *np = pdev->dev.of_node;
537 struct at91_usbh_data *pdata;
543 /* Right now device-tree probed devices don't get dma_mask set.
544 * Since shared usb code relies on it, set it here for now.
545 * Once we have dma capability bindings this can go away.
547 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
551 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
555 pdev->dev.platform_data = pdata;
557 if (!of_property_read_u32(np, "num-ports", &ports))
558 pdata->ports = ports;
560 at91_for_each_port(i) {
561 if (i >= pdata->ports)
565 devm_gpiod_get_index_optional(&pdev->dev, "atmel,vbus",
567 if (IS_ERR(pdata->vbus_pin[i])) {
568 err = PTR_ERR(pdata->vbus_pin[i]);
569 dev_err(&pdev->dev, "unable to claim gpio \"vbus\": %d\n", err);
574 at91_for_each_port(i) {
575 if (i >= pdata->ports)
578 pdata->overcurrent_pin[i] =
579 devm_gpiod_get_index_optional(&pdev->dev, "atmel,oc",
581 if (!pdata->overcurrent_pin[i])
583 if (IS_ERR(pdata->overcurrent_pin[i])) {
584 err = PTR_ERR(pdata->overcurrent_pin[i]);
585 dev_err(&pdev->dev, "unable to claim gpio \"overcurrent\": %d\n", err);
589 ret = devm_request_irq(&pdev->dev,
590 gpiod_to_irq(pdata->overcurrent_pin[i]),
591 ohci_hcd_at91_overcurrent_irq,
593 "ohci_overcurrent", pdev);
595 dev_info(&pdev->dev, "failed to request gpio \"overcurrent\" IRQ\n");
598 device_init_wakeup(&pdev->dev, 1);
599 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
602 static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
604 struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
608 at91_for_each_port(i)
609 ohci_at91_usb_set_power(pdata, i, 0);
612 device_init_wakeup(&pdev->dev, 0);
613 usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
617 static int __maybe_unused
618 ohci_hcd_at91_drv_suspend(struct device *dev)
620 struct usb_hcd *hcd = dev_get_drvdata(dev);
621 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
622 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
626 * Disable wakeup if we are going to sleep with slow clock mode
629 ohci_at91->wakeup = device_may_wakeup(dev)
630 && !at91_suspend_entering_slow_clock();
632 if (ohci_at91->wakeup)
633 enable_irq_wake(hcd->irq);
635 ret = ohci_suspend(hcd, ohci_at91->wakeup);
637 if (ohci_at91->wakeup)
638 disable_irq_wake(hcd->irq);
642 * The integrated transceivers seem unable to notice disconnect,
643 * reconnect, or wakeup without the 48 MHz clock active. so for
644 * correctness, always discard connection state (using reset).
646 * REVISIT: some boards will be able to turn VBUS off...
648 if (!ohci_at91->wakeup) {
649 ohci->rh_state = OHCI_RH_HALTED;
651 /* flush the writes */
652 (void) ohci_readl (ohci, &ohci->regs->control);
654 ohci_at91_port_suspend(ohci_at91, 1);
655 at91_stop_clock(ohci_at91);
657 ohci_at91_port_suspend(ohci_at91, 1);
663 static int __maybe_unused
664 ohci_hcd_at91_drv_resume(struct device *dev)
666 struct usb_hcd *hcd = dev_get_drvdata(dev);
667 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
669 ohci_at91_port_suspend(ohci_at91, 0);
671 if (ohci_at91->wakeup)
672 disable_irq_wake(hcd->irq);
674 at91_start_clock(ohci_at91);
676 ohci_resume(hcd, false);
681 static SIMPLE_DEV_PM_OPS(ohci_hcd_at91_pm_ops, ohci_hcd_at91_drv_suspend,
682 ohci_hcd_at91_drv_resume);
684 static struct platform_driver ohci_hcd_at91_driver = {
685 .probe = ohci_hcd_at91_drv_probe,
686 .remove = ohci_hcd_at91_drv_remove,
687 .shutdown = usb_hcd_platform_shutdown,
690 .pm = &ohci_hcd_at91_pm_ops,
691 .of_match_table = at91_ohci_dt_ids,
695 static int __init ohci_at91_init(void)
700 ohci_init_driver(&ohci_at91_hc_driver, &ohci_at91_drv_overrides);
703 * The Atmel HW has some unusual quirks, which require Atmel-specific
704 * workarounds. We override certain hc_driver functions here to
705 * achieve that. We explicitly do not enhance ohci_driver_overrides to
706 * allow this more easily, since this is an unusual case, and we don't
707 * want to encourage others to override these functions by making it
711 ohci_at91_hc_driver.hub_status_data = ohci_at91_hub_status_data;
712 ohci_at91_hc_driver.hub_control = ohci_at91_hub_control;
714 return platform_driver_register(&ohci_hcd_at91_driver);
716 module_init(ohci_at91_init);
718 static void __exit ohci_at91_cleanup(void)
720 platform_driver_unregister(&ohci_hcd_at91_driver);
722 module_exit(ohci_at91_cleanup);
724 MODULE_DESCRIPTION(DRIVER_DESC);
725 MODULE_LICENSE("GPL");
726 MODULE_ALIAS("platform:at91_ohci");