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/of_platform.h>
18 #include <linux/of_gpio.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/usb.h>
25 #include <linux/usb/hcd.h>
31 #define valid_port(index) ((index) >= 0 && (index) < AT91_MAX_USBH_PORTS)
32 #define at91_for_each_port(index) \
33 for ((index) = 0; (index) < AT91_MAX_USBH_PORTS; (index)++)
35 /* interface, function and usb clocks; sometimes also an AHB clock */
36 #define hcd_to_ohci_at91_priv(h) \
37 ((struct ohci_at91_priv *)hcd_to_ohci(h)->priv)
39 struct ohci_at91_priv
{
44 bool wakeup
; /* Saved wake-up state for resume */
46 /* interface and function clocks; sometimes also an AHB clock */
48 #define DRIVER_DESC "OHCI Atmel driver"
50 static const char hcd_name
[] = "ohci-atmel";
52 static struct hc_driver __read_mostly ohci_at91_hc_driver
;
54 static const struct ohci_driver_overrides ohci_at91_drv_overrides __initconst
= {
55 .extra_priv_size
= sizeof(struct ohci_at91_priv
),
58 extern int usb_disabled(void);
60 /*-------------------------------------------------------------------------*/
62 static void at91_start_clock(struct ohci_at91_priv
*ohci_at91
)
64 if (ohci_at91
->clocked
)
67 clk_set_rate(ohci_at91
->fclk
, 48000000);
68 clk_prepare_enable(ohci_at91
->hclk
);
69 clk_prepare_enable(ohci_at91
->iclk
);
70 clk_prepare_enable(ohci_at91
->fclk
);
71 ohci_at91
->clocked
= true;
74 static void at91_stop_clock(struct ohci_at91_priv
*ohci_at91
)
76 if (!ohci_at91
->clocked
)
79 clk_disable_unprepare(ohci_at91
->fclk
);
80 clk_disable_unprepare(ohci_at91
->iclk
);
81 clk_disable_unprepare(ohci_at91
->hclk
);
82 ohci_at91
->clocked
= false;
85 static void at91_start_hc(struct platform_device
*pdev
)
87 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
88 struct ohci_regs __iomem
*regs
= hcd
->regs
;
89 struct ohci_at91_priv
*ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
91 dev_dbg(&pdev
->dev
, "start\n");
94 * Start the USB clocks.
96 at91_start_clock(ohci_at91
);
99 * The USB host controller must remain in reset.
101 writel(0, ®s
->control
);
104 static void at91_stop_hc(struct platform_device
*pdev
)
106 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
107 struct ohci_regs __iomem
*regs
= hcd
->regs
;
108 struct ohci_at91_priv
*ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
110 dev_dbg(&pdev
->dev
, "stop\n");
113 * Put the USB host controller into reset.
115 writel(0, ®s
->control
);
118 * Stop the USB clocks.
120 at91_stop_clock(ohci_at91
);
124 /*-------------------------------------------------------------------------*/
126 static void usb_hcd_at91_remove (struct usb_hcd
*, struct platform_device
*);
128 /* configure so an HC device and id are always provided */
129 /* always called with process context; sleeping is OK */
133 * usb_hcd_at91_probe - initialize AT91-based HCDs
134 * Context: !in_interrupt()
136 * Allocates basic resources for this USB host controller, and
137 * then invokes the start() method for the HCD associated with it
138 * through the hotplug entry's driver_data.
140 static int usb_hcd_at91_probe(const struct hc_driver
*driver
,
141 struct platform_device
*pdev
)
143 struct at91_usbh_data
*board
;
144 struct ohci_hcd
*ohci
;
147 struct ohci_at91_priv
*ohci_at91
;
148 struct device
*dev
= &pdev
->dev
;
149 struct resource
*res
;
152 irq
= platform_get_irq(pdev
, 0);
154 dev_dbg(dev
, "hcd probe: missing irq resource\n");
158 hcd
= usb_create_hcd(driver
, dev
, "at91");
161 ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
163 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
164 hcd
->regs
= devm_ioremap_resource(dev
, res
);
165 if (IS_ERR(hcd
->regs
)) {
166 retval
= PTR_ERR(hcd
->regs
);
169 hcd
->rsrc_start
= res
->start
;
170 hcd
->rsrc_len
= resource_size(res
);
172 ohci_at91
->iclk
= devm_clk_get(dev
, "ohci_clk");
173 if (IS_ERR(ohci_at91
->iclk
)) {
174 dev_err(dev
, "failed to get ohci_clk\n");
175 retval
= PTR_ERR(ohci_at91
->iclk
);
178 ohci_at91
->fclk
= devm_clk_get(dev
, "uhpck");
179 if (IS_ERR(ohci_at91
->fclk
)) {
180 dev_err(dev
, "failed to get uhpck\n");
181 retval
= PTR_ERR(ohci_at91
->fclk
);
184 ohci_at91
->hclk
= devm_clk_get(dev
, "hclk");
185 if (IS_ERR(ohci_at91
->hclk
)) {
186 dev_err(dev
, "failed to get hclk\n");
187 retval
= PTR_ERR(ohci_at91
->hclk
);
191 board
= hcd
->self
.controller
->platform_data
;
192 ohci
= hcd_to_ohci(hcd
);
193 ohci
->num_ports
= board
->ports
;
196 retval
= usb_add_hcd(hcd
, irq
, IRQF_SHARED
);
198 device_wakeup_enable(hcd
->self
.controller
);
211 /* may be called with controller, bus, and devices active */
214 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
215 * @dev: USB Host Controller being removed
216 * Context: !in_interrupt()
218 * Reverses the effect of usb_hcd_at91_probe(), first invoking
219 * the HCD's stop() method. It is always called from a thread
220 * context, "rmmod" or something similar.
223 static void usb_hcd_at91_remove(struct usb_hcd
*hcd
,
224 struct platform_device
*pdev
)
231 /*-------------------------------------------------------------------------*/
232 static void ohci_at91_usb_set_power(struct at91_usbh_data
*pdata
, int port
, int enable
)
234 if (!valid_port(port
))
237 if (!gpio_is_valid(pdata
->vbus_pin
[port
]))
240 gpio_set_value(pdata
->vbus_pin
[port
],
241 pdata
->vbus_pin_active_low
[port
] ^ enable
);
244 static int ohci_at91_usb_get_power(struct at91_usbh_data
*pdata
, int port
)
246 if (!valid_port(port
))
249 if (!gpio_is_valid(pdata
->vbus_pin
[port
]))
252 return gpio_get_value(pdata
->vbus_pin
[port
]) ^
253 pdata
->vbus_pin_active_low
[port
];
257 * Update the status data from the hub with the over-current indicator change.
259 static int ohci_at91_hub_status_data(struct usb_hcd
*hcd
, char *buf
)
261 struct at91_usbh_data
*pdata
= hcd
->self
.controller
->platform_data
;
262 int length
= ohci_hub_status_data(hcd
, buf
);
265 at91_for_each_port(port
) {
266 if (pdata
->overcurrent_changed
[port
]) {
269 buf
[0] |= 1 << (port
+ 1);
277 * Look at the control requests to the root hub and see if we need to override.
279 static int ohci_at91_hub_control(struct usb_hcd
*hcd
, u16 typeReq
, u16 wValue
,
280 u16 wIndex
, char *buf
, u16 wLength
)
282 struct at91_usbh_data
*pdata
= dev_get_platdata(hcd
->self
.controller
);
283 struct usb_hub_descriptor
*desc
;
285 u32
*data
= (u32
*)buf
;
287 dev_dbg(hcd
->self
.controller
,
288 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
289 hcd
, typeReq
, wValue
, wIndex
, buf
, wLength
);
295 if (wValue
== USB_PORT_FEAT_POWER
) {
296 dev_dbg(hcd
->self
.controller
, "SetPortFeat: POWER\n");
297 if (valid_port(wIndex
)) {
298 ohci_at91_usb_set_power(pdata
, wIndex
, 1);
306 case ClearPortFeature
:
308 case USB_PORT_FEAT_C_OVER_CURRENT
:
309 dev_dbg(hcd
->self
.controller
,
310 "ClearPortFeature: C_OVER_CURRENT\n");
312 if (valid_port(wIndex
)) {
313 pdata
->overcurrent_changed
[wIndex
] = 0;
314 pdata
->overcurrent_status
[wIndex
] = 0;
319 case USB_PORT_FEAT_OVER_CURRENT
:
320 dev_dbg(hcd
->self
.controller
,
321 "ClearPortFeature: OVER_CURRENT\n");
323 if (valid_port(wIndex
))
324 pdata
->overcurrent_status
[wIndex
] = 0;
328 case USB_PORT_FEAT_POWER
:
329 dev_dbg(hcd
->self
.controller
,
330 "ClearPortFeature: POWER\n");
332 if (valid_port(wIndex
)) {
333 ohci_at91_usb_set_power(pdata
, wIndex
, 0);
340 ret
= ohci_hub_control(hcd
, typeReq
, wValue
, wIndex
+ 1, buf
, wLength
);
345 case GetHubDescriptor
:
347 /* update the hub's descriptor */
349 desc
= (struct usb_hub_descriptor
*)buf
;
351 dev_dbg(hcd
->self
.controller
, "wHubCharacteristics 0x%04x\n",
352 desc
->wHubCharacteristics
);
354 /* remove the old configurations for power-switching, and
355 * over-current protection, and insert our new configuration
358 desc
->wHubCharacteristics
&= ~cpu_to_le16(HUB_CHAR_LPSM
);
359 desc
->wHubCharacteristics
|=
360 cpu_to_le16(HUB_CHAR_INDV_PORT_LPSM
);
362 if (pdata
->overcurrent_supported
) {
363 desc
->wHubCharacteristics
&= ~cpu_to_le16(HUB_CHAR_OCPM
);
364 desc
->wHubCharacteristics
|=
365 cpu_to_le16(HUB_CHAR_INDV_PORT_OCPM
);
368 dev_dbg(hcd
->self
.controller
, "wHubCharacteristics after 0x%04x\n",
369 desc
->wHubCharacteristics
);
374 /* check port status */
376 dev_dbg(hcd
->self
.controller
, "GetPortStatus(%d)\n", wIndex
);
378 if (valid_port(wIndex
)) {
379 if (!ohci_at91_usb_get_power(pdata
, wIndex
))
380 *data
&= ~cpu_to_le32(RH_PS_PPS
);
382 if (pdata
->overcurrent_changed
[wIndex
])
383 *data
|= cpu_to_le32(RH_PS_OCIC
);
385 if (pdata
->overcurrent_status
[wIndex
])
386 *data
|= cpu_to_le32(RH_PS_POCI
);
394 /*-------------------------------------------------------------------------*/
396 static irqreturn_t
ohci_hcd_at91_overcurrent_irq(int irq
, void *data
)
398 struct platform_device
*pdev
= data
;
399 struct at91_usbh_data
*pdata
= dev_get_platdata(&pdev
->dev
);
402 /* From the GPIO notifying the over-current situation, find
403 * out the corresponding port */
404 at91_for_each_port(port
) {
405 if (gpio_is_valid(pdata
->overcurrent_pin
[port
]) &&
406 gpio_to_irq(pdata
->overcurrent_pin
[port
]) == irq
) {
407 gpio
= pdata
->overcurrent_pin
[port
];
412 if (port
== AT91_MAX_USBH_PORTS
) {
413 dev_err(& pdev
->dev
, "overcurrent interrupt from unknown GPIO\n");
417 val
= gpio_get_value(gpio
);
419 /* When notified of an over-current situation, disable power
420 on the corresponding port, and mark this port in
423 ohci_at91_usb_set_power(pdata
, port
, 0);
424 pdata
->overcurrent_status
[port
] = 1;
425 pdata
->overcurrent_changed
[port
] = 1;
428 dev_dbg(& pdev
->dev
, "overcurrent situation %s\n",
429 val
? "exited" : "notified");
435 static const struct of_device_id at91_ohci_dt_ids
[] = {
436 { .compatible
= "atmel,at91rm9200-ohci" },
440 MODULE_DEVICE_TABLE(of
, at91_ohci_dt_ids
);
442 static int ohci_at91_of_init(struct platform_device
*pdev
)
444 struct device_node
*np
= pdev
->dev
.of_node
;
446 enum of_gpio_flags flags
;
447 struct at91_usbh_data
*pdata
;
453 /* Right now device-tree probed devices don't get dma_mask set.
454 * Since shared usb code relies on it, set it here for now.
455 * Once we have dma capability bindings this can go away.
457 ret
= dma_coerce_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(32));
461 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
465 if (!of_property_read_u32(np
, "num-ports", &ports
))
466 pdata
->ports
= ports
;
468 at91_for_each_port(i
) {
469 gpio
= of_get_named_gpio_flags(np
, "atmel,vbus-gpio", i
, &flags
);
470 pdata
->vbus_pin
[i
] = gpio
;
471 if (!gpio_is_valid(gpio
))
473 pdata
->vbus_pin_active_low
[i
] = flags
& OF_GPIO_ACTIVE_LOW
;
476 at91_for_each_port(i
)
477 pdata
->overcurrent_pin
[i
] =
478 of_get_named_gpio_flags(np
, "atmel,oc-gpio", i
, &flags
);
480 pdev
->dev
.platform_data
= pdata
;
485 static int ohci_at91_of_init(struct platform_device
*pdev
)
491 /*-------------------------------------------------------------------------*/
493 static int ohci_hcd_at91_drv_probe(struct platform_device
*pdev
)
495 struct at91_usbh_data
*pdata
;
500 ret
= ohci_at91_of_init(pdev
);
504 pdata
= dev_get_platdata(&pdev
->dev
);
507 at91_for_each_port(i
) {
509 * do not configure PIO if not in relation with
510 * real USB port on board
512 if (i
>= pdata
->ports
) {
513 pdata
->vbus_pin
[i
] = -EINVAL
;
514 pdata
->overcurrent_pin
[i
] = -EINVAL
;
518 if (!gpio_is_valid(pdata
->vbus_pin
[i
]))
520 gpio
= pdata
->vbus_pin
[i
];
522 ret
= gpio_request(gpio
, "ohci_vbus");
525 "can't request vbus gpio %d\n", gpio
);
528 ret
= gpio_direction_output(gpio
,
529 !pdata
->vbus_pin_active_low
[i
]);
532 "can't put vbus gpio %d as output %d\n",
533 gpio
, !pdata
->vbus_pin_active_low
[i
]);
538 ohci_at91_usb_set_power(pdata
, i
, 1);
541 at91_for_each_port(i
) {
542 if (!gpio_is_valid(pdata
->overcurrent_pin
[i
]))
544 gpio
= pdata
->overcurrent_pin
[i
];
546 ret
= gpio_request(gpio
, "ohci_overcurrent");
549 "can't request overcurrent gpio %d\n",
554 ret
= gpio_direction_input(gpio
);
557 "can't configure overcurrent gpio %d as input\n",
563 ret
= request_irq(gpio_to_irq(gpio
),
564 ohci_hcd_at91_overcurrent_irq
,
565 IRQF_SHARED
, "ohci_overcurrent", pdev
);
569 "can't get gpio IRQ for overcurrent\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 if (!gpio_is_valid(pdata
->vbus_pin
[i
]))
587 ohci_at91_usb_set_power(pdata
, i
, 0);
588 gpio_free(pdata
->vbus_pin
[i
]);
591 at91_for_each_port(i
) {
592 if (!gpio_is_valid(pdata
->overcurrent_pin
[i
]))
594 free_irq(gpio_to_irq(pdata
->overcurrent_pin
[i
]), pdev
);
595 gpio_free(pdata
->overcurrent_pin
[i
]);
599 device_init_wakeup(&pdev
->dev
, 0);
600 usb_hcd_at91_remove(platform_get_drvdata(pdev
), pdev
);
607 ohci_hcd_at91_drv_suspend(struct device
*dev
)
609 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
610 struct ohci_hcd
*ohci
= hcd_to_ohci(hcd
);
611 struct ohci_at91_priv
*ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
615 * Disable wakeup if we are going to sleep with slow clock mode
618 ohci_at91
->wakeup
= device_may_wakeup(dev
)
619 && !at91_suspend_entering_slow_clock();
621 if (ohci_at91
->wakeup
)
622 enable_irq_wake(hcd
->irq
);
624 ret
= ohci_suspend(hcd
, ohci_at91
->wakeup
);
626 if (ohci_at91
->wakeup
)
627 disable_irq_wake(hcd
->irq
);
631 * The integrated transceivers seem unable to notice disconnect,
632 * reconnect, or wakeup without the 48 MHz clock active. so for
633 * correctness, always discard connection state (using reset).
635 * REVISIT: some boards will be able to turn VBUS off...
637 if (!ohci_at91
->wakeup
) {
638 ohci
->hc_control
= ohci_readl(ohci
, &ohci
->regs
->control
);
639 ohci
->hc_control
&= OHCI_CTRL_RWC
;
640 ohci_writel(ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
641 ohci
->rh_state
= OHCI_RH_HALTED
;
643 /* flush the writes */
644 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
645 at91_stop_clock(ohci_at91
);
651 static int ohci_hcd_at91_drv_resume(struct device
*dev
)
653 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
654 struct ohci_at91_priv
*ohci_at91
= hcd_to_ohci_at91_priv(hcd
);
656 if (ohci_at91
->wakeup
)
657 disable_irq_wake(hcd
->irq
);
659 at91_start_clock(ohci_at91
);
661 ohci_resume(hcd
, false);
666 static SIMPLE_DEV_PM_OPS(ohci_hcd_at91_pm_ops
, ohci_hcd_at91_drv_suspend
,
667 ohci_hcd_at91_drv_resume
);
669 static struct platform_driver ohci_hcd_at91_driver
= {
670 .probe
= ohci_hcd_at91_drv_probe
,
671 .remove
= ohci_hcd_at91_drv_remove
,
672 .shutdown
= usb_hcd_platform_shutdown
,
675 .pm
= &ohci_hcd_at91_pm_ops
,
676 .of_match_table
= of_match_ptr(at91_ohci_dt_ids
),
680 static int __init
ohci_at91_init(void)
685 pr_info("%s: " DRIVER_DESC
"\n", hcd_name
);
686 ohci_init_driver(&ohci_at91_hc_driver
, &ohci_at91_drv_overrides
);
689 * The Atmel HW has some unusual quirks, which require Atmel-specific
690 * workarounds. We override certain hc_driver functions here to
691 * achieve that. We explicitly do not enhance ohci_driver_overrides to
692 * allow this more easily, since this is an unusual case, and we don't
693 * want to encourage others to override these functions by making it
697 ohci_at91_hc_driver
.hub_status_data
= ohci_at91_hub_status_data
;
698 ohci_at91_hc_driver
.hub_control
= ohci_at91_hub_control
;
700 return platform_driver_register(&ohci_hcd_at91_driver
);
702 module_init(ohci_at91_init
);
704 static void __exit
ohci_at91_cleanup(void)
706 platform_driver_unregister(&ohci_hcd_at91_driver
);
708 module_exit(ohci_at91_cleanup
);
710 MODULE_DESCRIPTION(DRIVER_DESC
);
711 MODULE_LICENSE("GPL");
712 MODULE_ALIAS("platform:at91_ohci");