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>
27 #include <mach/hardware.h>
35 #define valid_port(index) ((index) >= 0 && (index) < AT91_MAX_USBH_PORTS)
36 #define at91_for_each_port(index) \
37 for ((index) = 0; (index) < AT91_MAX_USBH_PORTS; (index)++)
39 /* interface, function and usb clocks; sometimes also an AHB clock */
40 static struct clk
*iclk
, *fclk
, *uclk
, *hclk
;
41 /* interface and function clocks; sometimes also an AHB clock */
43 #define DRIVER_DESC "OHCI Atmel driver"
45 static const char hcd_name
[] = "ohci-atmel";
47 static struct hc_driver __read_mostly ohci_at91_hc_driver
;
49 static int (*orig_ohci_hub_control
)(struct usb_hcd
*hcd
, u16 typeReq
,
50 u16 wValue
, u16 wIndex
, char *buf
, u16 wLength
);
51 static int (*orig_ohci_hub_status_data
)(struct usb_hcd
*hcd
, char *buf
);
53 extern int usb_disabled(void);
55 /*-------------------------------------------------------------------------*/
57 static void at91_start_clock(void)
59 if (IS_ENABLED(CONFIG_COMMON_CLK
)) {
60 clk_set_rate(uclk
, 48000000);
61 clk_prepare_enable(uclk
);
63 clk_prepare_enable(hclk
);
64 clk_prepare_enable(iclk
);
65 clk_prepare_enable(fclk
);
69 static void at91_stop_clock(void)
71 clk_disable_unprepare(fclk
);
72 clk_disable_unprepare(iclk
);
73 clk_disable_unprepare(hclk
);
74 if (IS_ENABLED(CONFIG_COMMON_CLK
))
75 clk_disable_unprepare(uclk
);
79 static void at91_start_hc(struct platform_device
*pdev
)
81 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
82 struct ohci_regs __iomem
*regs
= hcd
->regs
;
84 dev_dbg(&pdev
->dev
, "start\n");
87 * Start the USB clocks.
92 * The USB host controller must remain in reset.
94 writel(0, ®s
->control
);
97 static void at91_stop_hc(struct platform_device
*pdev
)
99 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
100 struct ohci_regs __iomem
*regs
= hcd
->regs
;
102 dev_dbg(&pdev
->dev
, "stop\n");
105 * Put the USB host controller into reset.
107 writel(0, ®s
->control
);
110 * Stop the USB clocks.
116 /*-------------------------------------------------------------------------*/
118 static void usb_hcd_at91_remove (struct usb_hcd
*, struct platform_device
*);
120 /* configure so an HC device and id are always provided */
121 /* always called with process context; sleeping is OK */
125 * usb_hcd_at91_probe - initialize AT91-based HCDs
126 * Context: !in_interrupt()
128 * Allocates basic resources for this USB host controller, and
129 * then invokes the start() method for the HCD associated with it
130 * through the hotplug entry's driver_data.
132 static int usb_hcd_at91_probe(const struct hc_driver
*driver
,
133 struct platform_device
*pdev
)
135 struct at91_usbh_data
*board
;
136 struct ohci_hcd
*ohci
;
138 struct usb_hcd
*hcd
= NULL
;
140 if (pdev
->num_resources
!= 2) {
141 pr_debug("hcd probe: invalid num_resources");
145 if ((pdev
->resource
[0].flags
!= IORESOURCE_MEM
)
146 || (pdev
->resource
[1].flags
!= IORESOURCE_IRQ
)) {
147 pr_debug("hcd probe: invalid resource type\n");
151 hcd
= usb_create_hcd(driver
, &pdev
->dev
, "at91");
154 hcd
->rsrc_start
= pdev
->resource
[0].start
;
155 hcd
->rsrc_len
= resource_size(&pdev
->resource
[0]);
157 if (!request_mem_region(hcd
->rsrc_start
, hcd
->rsrc_len
, hcd_name
)) {
158 pr_debug("request_mem_region failed\n");
163 hcd
->regs
= ioremap(hcd
->rsrc_start
, hcd
->rsrc_len
);
165 pr_debug("ioremap failed\n");
170 iclk
= clk_get(&pdev
->dev
, "ohci_clk");
172 dev_err(&pdev
->dev
, "failed to get ohci_clk\n");
173 retval
= PTR_ERR(iclk
);
176 fclk
= clk_get(&pdev
->dev
, "uhpck");
178 dev_err(&pdev
->dev
, "failed to get uhpck\n");
179 retval
= PTR_ERR(fclk
);
182 hclk
= clk_get(&pdev
->dev
, "hclk");
184 dev_err(&pdev
->dev
, "failed to get hclk\n");
185 retval
= PTR_ERR(hclk
);
188 if (IS_ENABLED(CONFIG_COMMON_CLK
)) {
189 uclk
= clk_get(&pdev
->dev
, "usb_clk");
191 dev_err(&pdev
->dev
, "failed to get uclk\n");
192 retval
= PTR_ERR(uclk
);
197 board
= hcd
->self
.controller
->platform_data
;
198 ohci
= hcd_to_ohci(hcd
);
199 ohci
->num_ports
= board
->ports
;
202 retval
= usb_add_hcd(hcd
, pdev
->resource
[1].start
, IRQF_SHARED
);
209 if (IS_ENABLED(CONFIG_COMMON_CLK
))
222 release_mem_region(hcd
->rsrc_start
, hcd
->rsrc_len
);
230 /* may be called with controller, bus, and devices active */
233 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
234 * @dev: USB Host Controller being removed
235 * Context: !in_interrupt()
237 * Reverses the effect of usb_hcd_at91_probe(), first invoking
238 * the HCD's stop() method. It is always called from a thread
239 * context, "rmmod" or something similar.
242 static void usb_hcd_at91_remove(struct usb_hcd
*hcd
,
243 struct platform_device
*pdev
)
248 release_mem_region(hcd
->rsrc_start
, hcd
->rsrc_len
);
251 if (IS_ENABLED(CONFIG_COMMON_CLK
))
256 fclk
= iclk
= hclk
= NULL
;
259 /*-------------------------------------------------------------------------*/
260 static void ohci_at91_usb_set_power(struct at91_usbh_data
*pdata
, int port
, int enable
)
262 if (!valid_port(port
))
265 if (!gpio_is_valid(pdata
->vbus_pin
[port
]))
268 gpio_set_value(pdata
->vbus_pin
[port
],
269 pdata
->vbus_pin_active_low
[port
] ^ enable
);
272 static int ohci_at91_usb_get_power(struct at91_usbh_data
*pdata
, int port
)
274 if (!valid_port(port
))
277 if (!gpio_is_valid(pdata
->vbus_pin
[port
]))
280 return gpio_get_value(pdata
->vbus_pin
[port
]) ^
281 pdata
->vbus_pin_active_low
[port
];
285 * Update the status data from the hub with the over-current indicator change.
287 static int ohci_at91_hub_status_data(struct usb_hcd
*hcd
, char *buf
)
289 struct at91_usbh_data
*pdata
= hcd
->self
.controller
->platform_data
;
290 int length
= orig_ohci_hub_status_data(hcd
, buf
);
293 at91_for_each_port(port
) {
294 if (pdata
->overcurrent_changed
[port
]) {
297 buf
[0] |= 1 << (port
+ 1);
305 * Look at the control requests to the root hub and see if we need to override.
307 static int ohci_at91_hub_control(struct usb_hcd
*hcd
, u16 typeReq
, u16 wValue
,
308 u16 wIndex
, char *buf
, u16 wLength
)
310 struct at91_usbh_data
*pdata
= dev_get_platdata(hcd
->self
.controller
);
311 struct usb_hub_descriptor
*desc
;
313 u32
*data
= (u32
*)buf
;
315 dev_dbg(hcd
->self
.controller
,
316 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
317 hcd
, typeReq
, wValue
, wIndex
, buf
, wLength
);
323 if (wValue
== USB_PORT_FEAT_POWER
) {
324 dev_dbg(hcd
->self
.controller
, "SetPortFeat: POWER\n");
325 if (valid_port(wIndex
)) {
326 ohci_at91_usb_set_power(pdata
, wIndex
, 1);
334 case ClearPortFeature
:
336 case USB_PORT_FEAT_C_OVER_CURRENT
:
337 dev_dbg(hcd
->self
.controller
,
338 "ClearPortFeature: C_OVER_CURRENT\n");
340 if (valid_port(wIndex
)) {
341 pdata
->overcurrent_changed
[wIndex
] = 0;
342 pdata
->overcurrent_status
[wIndex
] = 0;
347 case USB_PORT_FEAT_OVER_CURRENT
:
348 dev_dbg(hcd
->self
.controller
,
349 "ClearPortFeature: OVER_CURRENT\n");
351 if (valid_port(wIndex
))
352 pdata
->overcurrent_status
[wIndex
] = 0;
356 case USB_PORT_FEAT_POWER
:
357 dev_dbg(hcd
->self
.controller
,
358 "ClearPortFeature: POWER\n");
360 if (valid_port(wIndex
)) {
361 ohci_at91_usb_set_power(pdata
, wIndex
, 0);
368 ret
= orig_ohci_hub_control(hcd
, typeReq
, wValue
, wIndex
+ 1,
374 case GetHubDescriptor
:
376 /* update the hub's descriptor */
378 desc
= (struct usb_hub_descriptor
*)buf
;
380 dev_dbg(hcd
->self
.controller
, "wHubCharacteristics 0x%04x\n",
381 desc
->wHubCharacteristics
);
383 /* remove the old configurations for power-switching, and
384 * over-current protection, and insert our new configuration
387 desc
->wHubCharacteristics
&= ~cpu_to_le16(HUB_CHAR_LPSM
);
388 desc
->wHubCharacteristics
|= cpu_to_le16(0x0001);
390 if (pdata
->overcurrent_supported
) {
391 desc
->wHubCharacteristics
&= ~cpu_to_le16(HUB_CHAR_OCPM
);
392 desc
->wHubCharacteristics
|= cpu_to_le16(0x0008|0x0001);
395 dev_dbg(hcd
->self
.controller
, "wHubCharacteristics after 0x%04x\n",
396 desc
->wHubCharacteristics
);
401 /* check port status */
403 dev_dbg(hcd
->self
.controller
, "GetPortStatus(%d)\n", wIndex
);
405 if (valid_port(wIndex
)) {
406 if (!ohci_at91_usb_get_power(pdata
, wIndex
))
407 *data
&= ~cpu_to_le32(RH_PS_PPS
);
409 if (pdata
->overcurrent_changed
[wIndex
])
410 *data
|= cpu_to_le32(RH_PS_OCIC
);
412 if (pdata
->overcurrent_status
[wIndex
])
413 *data
|= cpu_to_le32(RH_PS_POCI
);
421 /*-------------------------------------------------------------------------*/
423 static irqreturn_t
ohci_hcd_at91_overcurrent_irq(int irq
, void *data
)
425 struct platform_device
*pdev
= data
;
426 struct at91_usbh_data
*pdata
= dev_get_platdata(&pdev
->dev
);
429 /* From the GPIO notifying the over-current situation, find
430 * out the corresponding port */
431 at91_for_each_port(port
) {
432 if (gpio_is_valid(pdata
->overcurrent_pin
[port
]) &&
433 gpio_to_irq(pdata
->overcurrent_pin
[port
]) == irq
) {
434 gpio
= pdata
->overcurrent_pin
[port
];
439 if (port
== AT91_MAX_USBH_PORTS
) {
440 dev_err(& pdev
->dev
, "overcurrent interrupt from unknown GPIO\n");
444 val
= gpio_get_value(gpio
);
446 /* When notified of an over-current situation, disable power
447 on the corresponding port, and mark this port in
450 ohci_at91_usb_set_power(pdata
, port
, 0);
451 pdata
->overcurrent_status
[port
] = 1;
452 pdata
->overcurrent_changed
[port
] = 1;
455 dev_dbg(& pdev
->dev
, "overcurrent situation %s\n",
456 val
? "exited" : "notified");
462 static const struct of_device_id at91_ohci_dt_ids
[] = {
463 { .compatible
= "atmel,at91rm9200-ohci" },
467 MODULE_DEVICE_TABLE(of
, at91_ohci_dt_ids
);
469 static int ohci_at91_of_init(struct platform_device
*pdev
)
471 struct device_node
*np
= pdev
->dev
.of_node
;
473 enum of_gpio_flags flags
;
474 struct at91_usbh_data
*pdata
;
480 /* Right now device-tree probed devices don't get dma_mask set.
481 * Since shared usb code relies on it, set it here for now.
482 * Once we have dma capability bindings this can go away.
484 ret
= dma_coerce_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(32));
488 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
492 if (!of_property_read_u32(np
, "num-ports", &ports
))
493 pdata
->ports
= ports
;
495 at91_for_each_port(i
) {
496 gpio
= of_get_named_gpio_flags(np
, "atmel,vbus-gpio", i
, &flags
);
497 pdata
->vbus_pin
[i
] = gpio
;
498 if (!gpio_is_valid(gpio
))
500 pdata
->vbus_pin_active_low
[i
] = flags
& OF_GPIO_ACTIVE_LOW
;
503 at91_for_each_port(i
)
504 pdata
->overcurrent_pin
[i
] =
505 of_get_named_gpio_flags(np
, "atmel,oc-gpio", i
, &flags
);
507 pdev
->dev
.platform_data
= pdata
;
512 static int ohci_at91_of_init(struct platform_device
*pdev
)
518 /*-------------------------------------------------------------------------*/
520 static int ohci_hcd_at91_drv_probe(struct platform_device
*pdev
)
522 struct at91_usbh_data
*pdata
;
527 ret
= ohci_at91_of_init(pdev
);
531 pdata
= dev_get_platdata(&pdev
->dev
);
534 at91_for_each_port(i
) {
536 * do not configure PIO if not in relation with
537 * real USB port on board
539 if (i
>= pdata
->ports
) {
540 pdata
->vbus_pin
[i
] = -EINVAL
;
541 pdata
->overcurrent_pin
[i
] = -EINVAL
;
545 if (!gpio_is_valid(pdata
->vbus_pin
[i
]))
547 gpio
= pdata
->vbus_pin
[i
];
549 ret
= gpio_request(gpio
, "ohci_vbus");
552 "can't request vbus gpio %d\n", gpio
);
555 ret
= gpio_direction_output(gpio
,
556 !pdata
->vbus_pin_active_low
[i
]);
559 "can't put vbus gpio %d as output %d\n",
560 gpio
, !pdata
->vbus_pin_active_low
[i
]);
565 ohci_at91_usb_set_power(pdata
, i
, 1);
568 at91_for_each_port(i
) {
569 if (!gpio_is_valid(pdata
->overcurrent_pin
[i
]))
571 gpio
= pdata
->overcurrent_pin
[i
];
573 ret
= gpio_request(gpio
, "ohci_overcurrent");
576 "can't request overcurrent gpio %d\n",
581 ret
= gpio_direction_input(gpio
);
584 "can't configure overcurrent gpio %d as input\n",
590 ret
= request_irq(gpio_to_irq(gpio
),
591 ohci_hcd_at91_overcurrent_irq
,
592 IRQF_SHARED
, "ohci_overcurrent", pdev
);
596 "can't get gpio IRQ for overcurrent\n");
601 device_init_wakeup(&pdev
->dev
, 1);
602 return usb_hcd_at91_probe(&ohci_at91_hc_driver
, pdev
);
605 static int ohci_hcd_at91_drv_remove(struct platform_device
*pdev
)
607 struct at91_usbh_data
*pdata
= dev_get_platdata(&pdev
->dev
);
611 at91_for_each_port(i
) {
612 if (!gpio_is_valid(pdata
->vbus_pin
[i
]))
614 ohci_at91_usb_set_power(pdata
, i
, 0);
615 gpio_free(pdata
->vbus_pin
[i
]);
618 at91_for_each_port(i
) {
619 if (!gpio_is_valid(pdata
->overcurrent_pin
[i
]))
621 free_irq(gpio_to_irq(pdata
->overcurrent_pin
[i
]), pdev
);
622 gpio_free(pdata
->overcurrent_pin
[i
]);
626 device_init_wakeup(&pdev
->dev
, 0);
627 usb_hcd_at91_remove(platform_get_drvdata(pdev
), pdev
);
634 ohci_hcd_at91_drv_suspend(struct platform_device
*pdev
, pm_message_t mesg
)
636 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
637 struct ohci_hcd
*ohci
= hcd_to_ohci(hcd
);
639 if (device_may_wakeup(&pdev
->dev
))
640 enable_irq_wake(hcd
->irq
);
643 * The integrated transceivers seem unable to notice disconnect,
644 * reconnect, or wakeup without the 48 MHz clock active. so for
645 * correctness, always discard connection state (using reset).
647 * REVISIT: some boards will be able to turn VBUS off...
649 if (at91_suspend_entering_slow_clock()) {
650 ohci
->hc_control
= ohci_readl(ohci
, &ohci
->regs
->control
);
651 ohci
->hc_control
&= OHCI_CTRL_RWC
;
652 ohci_writel(ohci
, ohci
->hc_control
, &ohci
->regs
->control
);
653 ohci
->rh_state
= OHCI_RH_HALTED
;
655 /* flush the writes */
656 (void) ohci_readl (ohci
, &ohci
->regs
->control
);
663 static int ohci_hcd_at91_drv_resume(struct platform_device
*pdev
)
665 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
667 if (device_may_wakeup(&pdev
->dev
))
668 disable_irq_wake(hcd
->irq
);
673 ohci_resume(hcd
, false);
677 #define ohci_hcd_at91_drv_suspend NULL
678 #define ohci_hcd_at91_drv_resume NULL
681 static struct platform_driver ohci_hcd_at91_driver
= {
682 .probe
= ohci_hcd_at91_drv_probe
,
683 .remove
= ohci_hcd_at91_drv_remove
,
684 .shutdown
= usb_hcd_platform_shutdown
,
685 .suspend
= ohci_hcd_at91_drv_suspend
,
686 .resume
= ohci_hcd_at91_drv_resume
,
689 .owner
= THIS_MODULE
,
690 .of_match_table
= of_match_ptr(at91_ohci_dt_ids
),
694 static int __init
ohci_at91_init(void)
699 pr_info("%s: " DRIVER_DESC
"\n", hcd_name
);
700 ohci_init_driver(&ohci_at91_hc_driver
, NULL
);
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 orig_ohci_hub_control
= ohci_at91_hc_driver
.hub_control
;
712 orig_ohci_hub_status_data
= ohci_at91_hc_driver
.hub_status_data
;
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");