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/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>
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>
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
{
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
)
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_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, ®s
->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
= syscon_regmap_lookup_by_compatible("microchip,sam9x60-sfr");
153 /* configure so an HC device and id are always provided */
154 /* always called with process context; sleeping is OK */
158 * usb_hcd_at91_probe - initialize AT91-based HCDs
159 * Context: !in_interrupt()
161 * Allocates basic resources for this USB host controller, and
162 * then invokes the start() method for the HCD associated with it
163 * through the hotplug entry's driver_data.
165 static int usb_hcd_at91_probe(const struct hc_driver
*driver
,
166 struct platform_device
*pdev
)
168 struct at91_usbh_data
*board
;
169 struct ohci_hcd
*ohci
;
172 struct ohci_at91_priv
*ohci_at91
;
173 struct device
*dev
= &pdev
->dev
;
174 struct resource
*res
;
177 irq
= platform_get_irq(pdev
, 0);
179 dev_dbg(dev
, "hcd probe: missing irq resource\n");
183 hcd
= usb_create_hcd(driver
, dev
, "at91");
186 ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
188 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
189 hcd
->regs
= devm_ioremap_resource(dev
, res
);
190 if (IS_ERR(hcd
->regs
)) {
191 retval
= PTR_ERR(hcd
->regs
);
194 hcd
->rsrc_start
= res
->start
;
195 hcd
->rsrc_len
= resource_size(res
);
197 ohci_at91
->iclk
= devm_clk_get(dev
, "ohci_clk");
198 if (IS_ERR(ohci_at91
->iclk
)) {
199 dev_err(dev
, "failed to get ohci_clk\n");
200 retval
= PTR_ERR(ohci_at91
->iclk
);
203 ohci_at91
->fclk
= devm_clk_get(dev
, "uhpck");
204 if (IS_ERR(ohci_at91
->fclk
)) {
205 dev_err(dev
, "failed to get uhpck\n");
206 retval
= PTR_ERR(ohci_at91
->fclk
);
209 ohci_at91
->hclk
= devm_clk_get(dev
, "hclk");
210 if (IS_ERR(ohci_at91
->hclk
)) {
211 dev_err(dev
, "failed to get hclk\n");
212 retval
= PTR_ERR(ohci_at91
->hclk
);
216 ohci_at91
->sfr_regmap
= at91_dt_syscon_sfr();
217 if (!ohci_at91
->sfr_regmap
)
218 dev_dbg(dev
, "failed to find sfr node\n");
220 board
= hcd
->self
.controller
->platform_data
;
221 ohci
= hcd_to_ohci(hcd
);
222 ohci
->num_ports
= board
->ports
;
226 * The RemoteWakeupConnected bit has to be set explicitly
227 * before calling ohci_run. The reset value of this bit is 0.
229 ohci
->hc_control
= OHCI_CTRL_RWC
;
231 retval
= usb_add_hcd(hcd
, irq
, IRQF_SHARED
);
233 device_wakeup_enable(hcd
->self
.controller
);
246 /* may be called with controller, bus, and devices active */
249 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
250 * @dev: USB Host Controller being removed
251 * Context: !in_interrupt()
253 * Reverses the effect of usb_hcd_at91_probe(), first invoking
254 * the HCD's stop() method. It is always called from a thread
255 * context, "rmmod" or something similar.
258 static void usb_hcd_at91_remove(struct usb_hcd
*hcd
,
259 struct platform_device
*pdev
)
266 /*-------------------------------------------------------------------------*/
267 static void ohci_at91_usb_set_power(struct at91_usbh_data
*pdata
, int port
, int enable
)
269 if (!valid_port(port
))
272 gpiod_set_value(pdata
->vbus_pin
[port
], enable
);
275 static int ohci_at91_usb_get_power(struct at91_usbh_data
*pdata
, int port
)
277 if (!valid_port(port
))
280 return gpiod_get_value(pdata
->vbus_pin
[port
]);
284 * Update the status data from the hub with the over-current indicator change.
286 static int ohci_at91_hub_status_data(struct usb_hcd
*hcd
, char *buf
)
288 struct at91_usbh_data
*pdata
= hcd
->self
.controller
->platform_data
;
289 int length
= ohci_hub_status_data(hcd
, buf
);
292 at91_for_each_port(port
) {
293 if (pdata
->overcurrent_changed
[port
]) {
296 buf
[0] |= 1 << (port
+ 1);
303 static int ohci_at91_port_suspend(struct regmap
*regmap
, u8 set
)
311 ret
= regmap_read(regmap
, AT91_SFR_OHCIICR
, ®val
);
316 regval
|= AT91_OHCIICR_USB_SUSPEND
;
318 regval
&= ~AT91_OHCIICR_USB_SUSPEND
;
320 regmap_write(regmap
, AT91_SFR_OHCIICR
, regval
);
326 * Look at the control requests to the root hub and see if we need to override.
328 static int ohci_at91_hub_control(struct usb_hcd
*hcd
, u16 typeReq
, u16 wValue
,
329 u16 wIndex
, char *buf
, u16 wLength
)
331 struct at91_usbh_data
*pdata
= dev_get_platdata(hcd
->self
.controller
);
332 struct ohci_at91_priv
*ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
333 struct usb_hub_descriptor
*desc
;
335 u32
*data
= (u32
*)buf
;
337 dev_dbg(hcd
->self
.controller
,
338 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
339 hcd
, typeReq
, wValue
, wIndex
, buf
, wLength
);
346 case USB_PORT_FEAT_POWER
:
347 dev_dbg(hcd
->self
.controller
, "SetPortFeat: POWER\n");
348 if (valid_port(wIndex
)) {
349 ohci_at91_usb_set_power(pdata
, wIndex
, 1);
355 case USB_PORT_FEAT_SUSPEND
:
356 dev_dbg(hcd
->self
.controller
, "SetPortFeat: SUSPEND\n");
357 if (valid_port(wIndex
) && ohci_at91
->sfr_regmap
) {
358 ohci_at91_port_suspend(ohci_at91
->sfr_regmap
,
366 case ClearPortFeature
:
368 case USB_PORT_FEAT_C_OVER_CURRENT
:
369 dev_dbg(hcd
->self
.controller
,
370 "ClearPortFeature: C_OVER_CURRENT\n");
372 if (valid_port(wIndex
)) {
373 pdata
->overcurrent_changed
[wIndex
] = 0;
374 pdata
->overcurrent_status
[wIndex
] = 0;
379 case USB_PORT_FEAT_OVER_CURRENT
:
380 dev_dbg(hcd
->self
.controller
,
381 "ClearPortFeature: OVER_CURRENT\n");
383 if (valid_port(wIndex
))
384 pdata
->overcurrent_status
[wIndex
] = 0;
388 case USB_PORT_FEAT_POWER
:
389 dev_dbg(hcd
->self
.controller
,
390 "ClearPortFeature: POWER\n");
392 if (valid_port(wIndex
)) {
393 ohci_at91_usb_set_power(pdata
, wIndex
, 0);
398 case USB_PORT_FEAT_SUSPEND
:
399 dev_dbg(hcd
->self
.controller
, "ClearPortFeature: SUSPEND\n");
400 if (valid_port(wIndex
) && ohci_at91
->sfr_regmap
) {
401 ohci_at91_port_suspend(ohci_at91
->sfr_regmap
,
410 ret
= ohci_hub_control(hcd
, typeReq
, wValue
, wIndex
+ 1, buf
, wLength
);
415 case GetHubDescriptor
:
417 /* update the hub's descriptor */
419 desc
= (struct usb_hub_descriptor
*)buf
;
421 dev_dbg(hcd
->self
.controller
, "wHubCharacteristics 0x%04x\n",
422 desc
->wHubCharacteristics
);
424 /* remove the old configurations for power-switching, and
425 * over-current protection, and insert our new configuration
428 desc
->wHubCharacteristics
&= ~cpu_to_le16(HUB_CHAR_LPSM
);
429 desc
->wHubCharacteristics
|=
430 cpu_to_le16(HUB_CHAR_INDV_PORT_LPSM
);
432 if (pdata
->overcurrent_supported
) {
433 desc
->wHubCharacteristics
&= ~cpu_to_le16(HUB_CHAR_OCPM
);
434 desc
->wHubCharacteristics
|=
435 cpu_to_le16(HUB_CHAR_INDV_PORT_OCPM
);
438 dev_dbg(hcd
->self
.controller
, "wHubCharacteristics after 0x%04x\n",
439 desc
->wHubCharacteristics
);
444 /* check port status */
446 dev_dbg(hcd
->self
.controller
, "GetPortStatus(%d)\n", wIndex
);
448 if (valid_port(wIndex
)) {
449 if (!ohci_at91_usb_get_power(pdata
, wIndex
))
450 *data
&= ~cpu_to_le32(RH_PS_PPS
);
452 if (pdata
->overcurrent_changed
[wIndex
])
453 *data
|= cpu_to_le32(RH_PS_OCIC
);
455 if (pdata
->overcurrent_status
[wIndex
])
456 *data
|= cpu_to_le32(RH_PS_POCI
);
464 /*-------------------------------------------------------------------------*/
466 static irqreturn_t
ohci_hcd_at91_overcurrent_irq(int irq
, void *data
)
468 struct platform_device
*pdev
= data
;
469 struct at91_usbh_data
*pdata
= dev_get_platdata(&pdev
->dev
);
472 /* From the GPIO notifying the over-current situation, find
473 * out the corresponding port */
474 at91_for_each_port(port
) {
475 if (gpiod_to_irq(pdata
->overcurrent_pin
[port
]) == irq
)
479 if (port
== AT91_MAX_USBH_PORTS
) {
480 dev_err(& pdev
->dev
, "overcurrent interrupt from unknown GPIO\n");
484 val
= gpiod_get_value(pdata
->overcurrent_pin
[port
]);
486 /* When notified of an over-current situation, disable power
487 on the corresponding port, and mark this port in
490 ohci_at91_usb_set_power(pdata
, port
, 0);
491 pdata
->overcurrent_status
[port
] = 1;
492 pdata
->overcurrent_changed
[port
] = 1;
495 dev_dbg(& pdev
->dev
, "overcurrent situation %s\n",
496 val
? "exited" : "notified");
501 static const struct of_device_id at91_ohci_dt_ids
[] = {
502 { .compatible
= "atmel,at91rm9200-ohci" },
506 MODULE_DEVICE_TABLE(of
, at91_ohci_dt_ids
);
508 /*-------------------------------------------------------------------------*/
510 static int ohci_hcd_at91_drv_probe(struct platform_device
*pdev
)
512 struct device_node
*np
= pdev
->dev
.of_node
;
513 struct at91_usbh_data
*pdata
;
519 /* Right now device-tree probed devices don't get dma_mask set.
520 * Since shared usb code relies on it, set it here for now.
521 * Once we have dma capability bindings this can go away.
523 ret
= dma_coerce_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(32));
527 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
531 pdev
->dev
.platform_data
= pdata
;
533 if (!of_property_read_u32(np
, "num-ports", &ports
))
534 pdata
->ports
= ports
;
536 at91_for_each_port(i
) {
537 if (i
>= pdata
->ports
)
541 devm_gpiod_get_index_optional(&pdev
->dev
, "atmel,vbus",
543 if (IS_ERR(pdata
->vbus_pin
[i
])) {
544 err
= PTR_ERR(pdata
->vbus_pin
[i
]);
545 dev_err(&pdev
->dev
, "unable to claim gpio \"vbus\": %d\n", err
);
550 at91_for_each_port(i
) {
551 if (i
>= pdata
->ports
)
554 pdata
->overcurrent_pin
[i
] =
555 devm_gpiod_get_index_optional(&pdev
->dev
, "atmel,oc",
557 if (!pdata
->overcurrent_pin
[i
])
559 if (IS_ERR(pdata
->overcurrent_pin
[i
])) {
560 err
= PTR_ERR(pdata
->overcurrent_pin
[i
]);
561 dev_err(&pdev
->dev
, "unable to claim gpio \"overcurrent\": %d\n", err
);
565 ret
= devm_request_irq(&pdev
->dev
,
566 gpiod_to_irq(pdata
->overcurrent_pin
[i
]),
567 ohci_hcd_at91_overcurrent_irq
,
569 "ohci_overcurrent", pdev
);
571 dev_info(&pdev
->dev
, "failed to request gpio \"overcurrent\" IRQ\n");
574 device_init_wakeup(&pdev
->dev
, 1);
575 return usb_hcd_at91_probe(&ohci_at91_hc_driver
, pdev
);
578 static int ohci_hcd_at91_drv_remove(struct platform_device
*pdev
)
580 struct at91_usbh_data
*pdata
= dev_get_platdata(&pdev
->dev
);
584 at91_for_each_port(i
)
585 ohci_at91_usb_set_power(pdata
, i
, 0);
588 device_init_wakeup(&pdev
->dev
, 0);
589 usb_hcd_at91_remove(platform_get_drvdata(pdev
), pdev
);
593 static int __maybe_unused
594 ohci_hcd_at91_drv_suspend(struct device
*dev
)
596 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
597 struct ohci_hcd
*ohci
= hcd_to_ohci(hcd
);
598 struct ohci_at91_priv
*ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
602 * Disable wakeup if we are going to sleep with slow clock mode
605 ohci_at91
->wakeup
= device_may_wakeup(dev
)
606 && !at91_suspend_entering_slow_clock();
608 if (ohci_at91
->wakeup
)
609 enable_irq_wake(hcd
->irq
);
611 ohci_at91_port_suspend(ohci_at91
->sfr_regmap
, 1);
613 ret
= ohci_suspend(hcd
, ohci_at91
->wakeup
);
615 if (ohci_at91
->wakeup
)
616 disable_irq_wake(hcd
->irq
);
620 * The integrated transceivers seem unable to notice disconnect,
621 * reconnect, or wakeup without the 48 MHz clock active. so for
622 * correctness, always discard connection state (using reset).
624 * REVISIT: some boards will be able to turn VBUS off...
626 if (!ohci_at91
->wakeup
) {
627 ohci
->rh_state
= OHCI_RH_HALTED
;
629 /* flush the writes */
630 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
631 at91_stop_clock(ohci_at91
);
637 static int __maybe_unused
638 ohci_hcd_at91_drv_resume(struct device
*dev
)
640 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
641 struct ohci_at91_priv
*ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
643 if (ohci_at91
->wakeup
)
644 disable_irq_wake(hcd
->irq
);
646 at91_start_clock(ohci_at91
);
648 ohci_resume(hcd
, false);
650 ohci_at91_port_suspend(ohci_at91
->sfr_regmap
, 0);
655 static SIMPLE_DEV_PM_OPS(ohci_hcd_at91_pm_ops
, ohci_hcd_at91_drv_suspend
,
656 ohci_hcd_at91_drv_resume
);
658 static struct platform_driver ohci_hcd_at91_driver
= {
659 .probe
= ohci_hcd_at91_drv_probe
,
660 .remove
= ohci_hcd_at91_drv_remove
,
661 .shutdown
= usb_hcd_platform_shutdown
,
664 .pm
= &ohci_hcd_at91_pm_ops
,
665 .of_match_table
= at91_ohci_dt_ids
,
669 static int __init
ohci_at91_init(void)
674 pr_info("%s: " DRIVER_DESC
"\n", hcd_name
);
675 ohci_init_driver(&ohci_at91_hc_driver
, &ohci_at91_drv_overrides
);
678 * The Atmel HW has some unusual quirks, which require Atmel-specific
679 * workarounds. We override certain hc_driver functions here to
680 * achieve that. We explicitly do not enhance ohci_driver_overrides to
681 * allow this more easily, since this is an unusual case, and we don't
682 * want to encourage others to override these functions by making it
686 ohci_at91_hc_driver
.hub_status_data
= ohci_at91_hub_status_data
;
687 ohci_at91_hc_driver
.hub_control
= ohci_at91_hub_control
;
689 return platform_driver_register(&ohci_hcd_at91_driver
);
691 module_init(ohci_at91_init
);
693 static void __exit
ohci_at91_cleanup(void)
695 platform_driver_unregister(&ohci_hcd_at91_driver
);
697 module_exit(ohci_at91_cleanup
);
699 MODULE_DESCRIPTION(DRIVER_DESC
);
700 MODULE_LICENSE("GPL");
701 MODULE_ALIAS("platform:at91_ohci");