2 * OHCI HCD (Host Controller Driver) for USB.
4 * Copyright (C) 2004 SAN People (Pty) Ltd.
5 * Copyright (C) 2005 Thibaut VARENE <varenet@parisc-linux.org>
9 * Based on fragments of 2.4 driver by Rick Bronson.
10 * Based on ohci-omap.c
12 * This file is licenced under the GPL.
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>
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>
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)++)
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)
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
];
50 struct ohci_at91_priv
{
55 bool wakeup
; /* Saved wake-up state for resume */
56 struct regmap
*sfr_regmap
;
58 /* interface and function clocks; sometimes also an AHB clock */
60 #define DRIVER_DESC "OHCI Atmel driver"
62 static const char hcd_name
[] = "ohci-atmel";
64 static struct hc_driver __read_mostly ohci_at91_hc_driver
;
66 static const struct ohci_driver_overrides ohci_at91_drv_overrides __initconst
= {
67 .extra_priv_size
= sizeof(struct ohci_at91_priv
),
70 /*-------------------------------------------------------------------------*/
72 static void at91_start_clock(struct ohci_at91_priv
*ohci_at91
)
74 if (ohci_at91
->clocked
)
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;
84 static void at91_stop_clock(struct ohci_at91_priv
*ohci_at91
)
86 if (!ohci_at91
->clocked
)
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;
95 static void at91_start_hc(struct platform_device
*pdev
)
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
);
101 dev_dbg(&pdev
->dev
, "start\n");
104 * Start the USB clocks.
106 at91_start_clock(ohci_at91
);
109 * The USB host controller must remain in reset.
111 writel(0, ®s
->control
);
114 static void at91_stop_hc(struct platform_device
*pdev
)
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
);
120 dev_dbg(&pdev
->dev
, "stop\n");
123 * Put the USB host controller into reset.
125 writel(0, ®s
->control
);
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 struct regmap
*at91_dt_syscon_sfr(void)
140 struct regmap
*regmap
;
142 regmap
= syscon_regmap_lookup_by_compatible("atmel,sama5d2-sfr");
149 /* configure so an HC device and id are always provided */
150 /* always called with process context; sleeping is OK */
154 * usb_hcd_at91_probe - initialize AT91-based HCDs
155 * Context: !in_interrupt()
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.
161 static int usb_hcd_at91_probe(const struct hc_driver
*driver
,
162 struct platform_device
*pdev
)
164 struct at91_usbh_data
*board
;
165 struct ohci_hcd
*ohci
;
168 struct ohci_at91_priv
*ohci_at91
;
169 struct device
*dev
= &pdev
->dev
;
170 struct resource
*res
;
173 irq
= platform_get_irq(pdev
, 0);
175 dev_dbg(dev
, "hcd probe: missing irq resource\n");
179 hcd
= usb_create_hcd(driver
, dev
, "at91");
182 ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
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
);
190 hcd
->rsrc_start
= res
->start
;
191 hcd
->rsrc_len
= resource_size(res
);
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
);
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
);
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
);
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");
216 board
= hcd
->self
.controller
->platform_data
;
217 ohci
= hcd_to_ohci(hcd
);
218 ohci
->num_ports
= board
->ports
;
222 * The RemoteWakeupConnected bit has to be set explicitly
223 * before calling ohci_run. The reset value of this bit is 0.
225 ohci
->hc_control
= OHCI_CTRL_RWC
;
227 retval
= usb_add_hcd(hcd
, irq
, IRQF_SHARED
);
229 device_wakeup_enable(hcd
->self
.controller
);
242 /* may be called with controller, bus, and devices active */
245 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
246 * @dev: USB Host Controller being removed
247 * Context: !in_interrupt()
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.
254 static void usb_hcd_at91_remove(struct usb_hcd
*hcd
,
255 struct platform_device
*pdev
)
262 /*-------------------------------------------------------------------------*/
263 static void ohci_at91_usb_set_power(struct at91_usbh_data
*pdata
, int port
, int enable
)
265 if (!valid_port(port
))
268 gpiod_set_value(pdata
->vbus_pin
[port
], enable
);
271 static int ohci_at91_usb_get_power(struct at91_usbh_data
*pdata
, int port
)
273 if (!valid_port(port
))
276 return gpiod_get_value(pdata
->vbus_pin
[port
]);
280 * Update the status data from the hub with the over-current indicator change.
282 static int ohci_at91_hub_status_data(struct usb_hcd
*hcd
, char *buf
)
284 struct at91_usbh_data
*pdata
= hcd
->self
.controller
->platform_data
;
285 int length
= ohci_hub_status_data(hcd
, buf
);
288 at91_for_each_port(port
) {
289 if (pdata
->overcurrent_changed
[port
]) {
292 buf
[0] |= 1 << (port
+ 1);
299 static int ohci_at91_port_suspend(struct regmap
*regmap
, u8 set
)
307 ret
= regmap_read(regmap
, AT91_SFR_OHCIICR
, ®val
);
312 regval
|= AT91_OHCIICR_USB_SUSPEND
;
314 regval
&= ~AT91_OHCIICR_USB_SUSPEND
;
316 regmap_write(regmap
, AT91_SFR_OHCIICR
, regval
);
322 * Look at the control requests to the root hub and see if we need to override.
324 static int ohci_at91_hub_control(struct usb_hcd
*hcd
, u16 typeReq
, u16 wValue
,
325 u16 wIndex
, char *buf
, u16 wLength
)
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
;
331 u32
*data
= (u32
*)buf
;
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
);
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);
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
,
362 case ClearPortFeature
:
364 case USB_PORT_FEAT_C_OVER_CURRENT
:
365 dev_dbg(hcd
->self
.controller
,
366 "ClearPortFeature: C_OVER_CURRENT\n");
368 if (valid_port(wIndex
)) {
369 pdata
->overcurrent_changed
[wIndex
] = 0;
370 pdata
->overcurrent_status
[wIndex
] = 0;
375 case USB_PORT_FEAT_OVER_CURRENT
:
376 dev_dbg(hcd
->self
.controller
,
377 "ClearPortFeature: OVER_CURRENT\n");
379 if (valid_port(wIndex
))
380 pdata
->overcurrent_status
[wIndex
] = 0;
384 case USB_PORT_FEAT_POWER
:
385 dev_dbg(hcd
->self
.controller
,
386 "ClearPortFeature: POWER\n");
388 if (valid_port(wIndex
)) {
389 ohci_at91_usb_set_power(pdata
, wIndex
, 0);
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
,
406 ret
= ohci_hub_control(hcd
, typeReq
, wValue
, wIndex
+ 1, buf
, wLength
);
411 case GetHubDescriptor
:
413 /* update the hub's descriptor */
415 desc
= (struct usb_hub_descriptor
*)buf
;
417 dev_dbg(hcd
->self
.controller
, "wHubCharacteristics 0x%04x\n",
418 desc
->wHubCharacteristics
);
420 /* remove the old configurations for power-switching, and
421 * over-current protection, and insert our new configuration
424 desc
->wHubCharacteristics
&= ~cpu_to_le16(HUB_CHAR_LPSM
);
425 desc
->wHubCharacteristics
|=
426 cpu_to_le16(HUB_CHAR_INDV_PORT_LPSM
);
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
);
434 dev_dbg(hcd
->self
.controller
, "wHubCharacteristics after 0x%04x\n",
435 desc
->wHubCharacteristics
);
440 /* check port status */
442 dev_dbg(hcd
->self
.controller
, "GetPortStatus(%d)\n", wIndex
);
444 if (valid_port(wIndex
)) {
445 if (!ohci_at91_usb_get_power(pdata
, wIndex
))
446 *data
&= ~cpu_to_le32(RH_PS_PPS
);
448 if (pdata
->overcurrent_changed
[wIndex
])
449 *data
|= cpu_to_le32(RH_PS_OCIC
);
451 if (pdata
->overcurrent_status
[wIndex
])
452 *data
|= cpu_to_le32(RH_PS_POCI
);
460 /*-------------------------------------------------------------------------*/
462 static irqreturn_t
ohci_hcd_at91_overcurrent_irq(int irq
, void *data
)
464 struct platform_device
*pdev
= data
;
465 struct at91_usbh_data
*pdata
= dev_get_platdata(&pdev
->dev
);
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
)
475 if (port
== AT91_MAX_USBH_PORTS
) {
476 dev_err(& pdev
->dev
, "overcurrent interrupt from unknown GPIO\n");
480 val
= gpiod_get_value(pdata
->overcurrent_pin
[port
]);
482 /* When notified of an over-current situation, disable power
483 on the corresponding port, and mark this port in
486 ohci_at91_usb_set_power(pdata
, port
, 0);
487 pdata
->overcurrent_status
[port
] = 1;
488 pdata
->overcurrent_changed
[port
] = 1;
491 dev_dbg(& pdev
->dev
, "overcurrent situation %s\n",
492 val
? "exited" : "notified");
497 static const struct of_device_id at91_ohci_dt_ids
[] = {
498 { .compatible
= "atmel,at91rm9200-ohci" },
502 MODULE_DEVICE_TABLE(of
, at91_ohci_dt_ids
);
504 /*-------------------------------------------------------------------------*/
506 static int ohci_hcd_at91_drv_probe(struct platform_device
*pdev
)
508 struct device_node
*np
= pdev
->dev
.of_node
;
509 struct at91_usbh_data
*pdata
;
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.
519 ret
= dma_coerce_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(32));
523 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
527 pdev
->dev
.platform_data
= pdata
;
529 if (!of_property_read_u32(np
, "num-ports", &ports
))
530 pdata
->ports
= ports
;
532 at91_for_each_port(i
) {
533 if (i
>= pdata
->ports
)
537 devm_gpiod_get_index_optional(&pdev
->dev
, "atmel,vbus",
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
);
546 at91_for_each_port(i
) {
547 if (i
>= pdata
->ports
)
550 pdata
->overcurrent_pin
[i
] =
551 devm_gpiod_get_index_optional(&pdev
->dev
, "atmel,oc",
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
);
559 ret
= devm_request_irq(&pdev
->dev
,
560 gpiod_to_irq(pdata
->overcurrent_pin
[i
]),
561 ohci_hcd_at91_overcurrent_irq
,
563 "ohci_overcurrent", pdev
);
565 dev_info(&pdev
->dev
, "failed to request gpio \"overcurrent\" IRQ\n");
568 device_init_wakeup(&pdev
->dev
, 1);
569 return usb_hcd_at91_probe(&ohci_at91_hc_driver
, pdev
);
572 static int ohci_hcd_at91_drv_remove(struct platform_device
*pdev
)
574 struct at91_usbh_data
*pdata
= dev_get_platdata(&pdev
->dev
);
578 at91_for_each_port(i
)
579 ohci_at91_usb_set_power(pdata
, i
, 0);
582 device_init_wakeup(&pdev
->dev
, 0);
583 usb_hcd_at91_remove(platform_get_drvdata(pdev
), pdev
);
587 static int __maybe_unused
588 ohci_hcd_at91_drv_suspend(struct device
*dev
)
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
);
596 * Disable wakeup if we are going to sleep with slow clock mode
599 ohci_at91
->wakeup
= device_may_wakeup(dev
)
600 && !at91_suspend_entering_slow_clock();
602 if (ohci_at91
->wakeup
)
603 enable_irq_wake(hcd
->irq
);
605 ohci_at91_port_suspend(ohci_at91
->sfr_regmap
, 1);
607 ret
= ohci_suspend(hcd
, ohci_at91
->wakeup
);
609 if (ohci_at91
->wakeup
)
610 disable_irq_wake(hcd
->irq
);
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).
618 * REVISIT: some boards will be able to turn VBUS off...
620 if (!ohci_at91
->wakeup
) {
621 ohci
->rh_state
= OHCI_RH_HALTED
;
623 /* flush the writes */
624 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
625 at91_stop_clock(ohci_at91
);
631 static int __maybe_unused
632 ohci_hcd_at91_drv_resume(struct device
*dev
)
634 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
635 struct ohci_at91_priv
*ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
637 if (ohci_at91
->wakeup
)
638 disable_irq_wake(hcd
->irq
);
640 at91_start_clock(ohci_at91
);
642 ohci_resume(hcd
, false);
644 ohci_at91_port_suspend(ohci_at91
->sfr_regmap
, 0);
649 static SIMPLE_DEV_PM_OPS(ohci_hcd_at91_pm_ops
, ohci_hcd_at91_drv_suspend
,
650 ohci_hcd_at91_drv_resume
);
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
,
658 .pm
= &ohci_hcd_at91_pm_ops
,
659 .of_match_table
= at91_ohci_dt_ids
,
663 static int __init
ohci_at91_init(void)
668 pr_info("%s: " DRIVER_DESC
"\n", hcd_name
);
669 ohci_init_driver(&ohci_at91_hc_driver
, &ohci_at91_drv_overrides
);
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
680 ohci_at91_hc_driver
.hub_status_data
= ohci_at91_hub_status_data
;
681 ohci_at91_hc_driver
.hub_control
= ohci_at91_hub_control
;
683 return platform_driver_register(&ohci_hcd_at91_driver
);
685 module_init(ohci_at91_init
);
687 static void __exit
ohci_at91_cleanup(void)
689 platform_driver_unregister(&ohci_hcd_at91_driver
);
691 module_exit(ohci_at91_cleanup
);
693 MODULE_DESCRIPTION(DRIVER_DESC
);
694 MODULE_LICENSE("GPL");
695 MODULE_ALIAS("platform:at91_ohci");