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/platform_device.h>
17 #include <linux/of_platform.h>
18 #include <linux/of_gpio.h>
20 #include <mach/hardware.h>
23 #include <mach/board.h>
26 #ifndef CONFIG_ARCH_AT91
27 #error "CONFIG_ARCH_AT91 must be defined."
30 #define valid_port(index) ((index) >= 0 && (index) < AT91_MAX_USBH_PORTS)
31 #define at91_for_each_port(index) \
32 for ((index) = 0; (index) < AT91_MAX_USBH_PORTS; (index)++)
34 /* interface and function clocks; sometimes also an AHB clock */
35 static struct clk *iclk, *fclk, *hclk;
38 extern int usb_disabled(void);
40 /*-------------------------------------------------------------------------*/
42 static void at91_start_clock(void)
50 static void at91_stop_clock(void)
58 static void at91_start_hc(struct platform_device *pdev)
60 struct usb_hcd *hcd = platform_get_drvdata(pdev);
61 struct ohci_regs __iomem *regs = hcd->regs;
63 dev_dbg(&pdev->dev, "start\n");
66 * Start the USB clocks.
71 * The USB host controller must remain in reset.
73 writel(0, ®s->control);
76 static void at91_stop_hc(struct platform_device *pdev)
78 struct usb_hcd *hcd = platform_get_drvdata(pdev);
79 struct ohci_regs __iomem *regs = hcd->regs;
81 dev_dbg(&pdev->dev, "stop\n");
84 * Put the USB host controller into reset.
86 writel(0, ®s->control);
89 * Stop the USB clocks.
95 /*-------------------------------------------------------------------------*/
97 static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
99 /* configure so an HC device and id are always provided */
100 /* always called with process context; sleeping is OK */
104 * usb_hcd_at91_probe - initialize AT91-based HCDs
105 * Context: !in_interrupt()
107 * Allocates basic resources for this USB host controller, and
108 * then invokes the start() method for the HCD associated with it
109 * through the hotplug entry's driver_data.
111 static int usb_hcd_at91_probe(const struct hc_driver *driver,
112 struct platform_device *pdev)
115 struct usb_hcd *hcd = NULL;
117 if (pdev->num_resources != 2) {
118 pr_debug("hcd probe: invalid num_resources");
122 if ((pdev->resource[0].flags != IORESOURCE_MEM)
123 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
124 pr_debug("hcd probe: invalid resource type\n");
128 hcd = usb_create_hcd(driver, &pdev->dev, "at91");
131 hcd->rsrc_start = pdev->resource[0].start;
132 hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
134 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
135 pr_debug("request_mem_region failed\n");
140 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
142 pr_debug("ioremap failed\n");
147 iclk = clk_get(&pdev->dev, "ohci_clk");
149 dev_err(&pdev->dev, "failed to get ohci_clk\n");
150 retval = PTR_ERR(iclk);
153 fclk = clk_get(&pdev->dev, "uhpck");
155 dev_err(&pdev->dev, "failed to get uhpck\n");
156 retval = PTR_ERR(fclk);
159 hclk = clk_get(&pdev->dev, "hclk");
161 dev_err(&pdev->dev, "failed to get hclk\n");
162 retval = PTR_ERR(hclk);
167 ohci_hcd_init(hcd_to_ohci(hcd));
169 retval = usb_add_hcd(hcd, pdev->resource[1].start, IRQF_SHARED);
186 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
194 /* may be called with controller, bus, and devices active */
197 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
198 * @dev: USB Host Controller being removed
199 * Context: !in_interrupt()
201 * Reverses the effect of usb_hcd_at91_probe(), first invoking
202 * the HCD's stop() method. It is always called from a thread
203 * context, "rmmod" or something similar.
206 static void usb_hcd_at91_remove(struct usb_hcd *hcd,
207 struct platform_device *pdev)
212 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
218 fclk = iclk = hclk = NULL;
220 dev_set_drvdata(&pdev->dev, NULL);
223 /*-------------------------------------------------------------------------*/
226 ohci_at91_start (struct usb_hcd *hcd)
228 struct at91_usbh_data *board = hcd->self.controller->platform_data;
229 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
232 if ((ret = ohci_init(ohci)) < 0)
235 ohci->num_ports = board->ports;
237 if ((ret = ohci_run(ohci)) < 0) {
238 err("can't start %s", hcd->self.bus_name);
245 static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
247 if (!valid_port(port))
250 if (!gpio_is_valid(pdata->vbus_pin[port]))
253 gpio_set_value(pdata->vbus_pin[port],
254 pdata->vbus_pin_active_low[port] ^ enable);
257 static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
259 if (!valid_port(port))
262 if (!gpio_is_valid(pdata->vbus_pin[port]))
265 return gpio_get_value(pdata->vbus_pin[port]) ^
266 pdata->vbus_pin_active_low[port];
270 * Update the status data from the hub with the over-current indicator change.
272 static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
274 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
275 int length = ohci_hub_status_data(hcd, buf);
278 at91_for_each_port(port) {
279 if (pdata->overcurrent_changed[port]) {
282 buf[0] |= 1 << (port + 1);
290 * Look at the control requests to the root hub and see if we need to override.
292 static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
293 u16 wIndex, char *buf, u16 wLength)
295 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
296 struct usb_hub_descriptor *desc;
298 u32 *data = (u32 *)buf;
300 dev_dbg(hcd->self.controller,
301 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
302 hcd, typeReq, wValue, wIndex, buf, wLength);
308 if (wValue == USB_PORT_FEAT_POWER) {
309 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
310 if (valid_port(wIndex)) {
311 ohci_at91_usb_set_power(pdata, wIndex, 1);
319 case ClearPortFeature:
321 case USB_PORT_FEAT_C_OVER_CURRENT:
322 dev_dbg(hcd->self.controller,
323 "ClearPortFeature: C_OVER_CURRENT\n");
325 if (valid_port(wIndex)) {
326 pdata->overcurrent_changed[wIndex] = 0;
327 pdata->overcurrent_status[wIndex] = 0;
332 case USB_PORT_FEAT_OVER_CURRENT:
333 dev_dbg(hcd->self.controller,
334 "ClearPortFeature: OVER_CURRENT\n");
336 if (valid_port(wIndex))
337 pdata->overcurrent_status[wIndex] = 0;
341 case USB_PORT_FEAT_POWER:
342 dev_dbg(hcd->self.controller,
343 "ClearPortFeature: POWER\n");
345 if (valid_port(wIndex)) {
346 ohci_at91_usb_set_power(pdata, wIndex, 0);
353 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex + 1, buf, wLength);
358 case GetHubDescriptor:
360 /* update the hub's descriptor */
362 desc = (struct usb_hub_descriptor *)buf;
364 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
365 desc->wHubCharacteristics);
367 /* remove the old configurations for power-switching, and
368 * over-current protection, and insert our new configuration
371 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
372 desc->wHubCharacteristics |= cpu_to_le16(0x0001);
374 if (pdata->overcurrent_supported) {
375 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
376 desc->wHubCharacteristics |= cpu_to_le16(0x0008|0x0001);
379 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
380 desc->wHubCharacteristics);
385 /* check port status */
387 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
389 if (valid_port(wIndex)) {
390 if (!ohci_at91_usb_get_power(pdata, wIndex))
391 *data &= ~cpu_to_le32(RH_PS_PPS);
393 if (pdata->overcurrent_changed[wIndex])
394 *data |= cpu_to_le32(RH_PS_OCIC);
396 if (pdata->overcurrent_status[wIndex])
397 *data |= cpu_to_le32(RH_PS_POCI);
405 /*-------------------------------------------------------------------------*/
407 static const struct hc_driver ohci_at91_hc_driver = {
408 .description = hcd_name,
409 .product_desc = "AT91 OHCI",
410 .hcd_priv_size = sizeof(struct ohci_hcd),
413 * generic hardware linkage
416 .flags = HCD_USB11 | HCD_MEMORY,
419 * basic lifecycle operations
421 .start = ohci_at91_start,
423 .shutdown = ohci_shutdown,
426 * managing i/o requests and associated device resources
428 .urb_enqueue = ohci_urb_enqueue,
429 .urb_dequeue = ohci_urb_dequeue,
430 .endpoint_disable = ohci_endpoint_disable,
435 .get_frame_number = ohci_get_frame,
440 .hub_status_data = ohci_at91_hub_status_data,
441 .hub_control = ohci_at91_hub_control,
443 .bus_suspend = ohci_bus_suspend,
444 .bus_resume = ohci_bus_resume,
446 .start_port_reset = ohci_start_port_reset,
449 /*-------------------------------------------------------------------------*/
451 static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
453 struct platform_device *pdev = data;
454 struct at91_usbh_data *pdata = pdev->dev.platform_data;
457 /* From the GPIO notifying the over-current situation, find
458 * out the corresponding port */
459 at91_for_each_port(port) {
460 if (gpio_to_irq(pdata->overcurrent_pin[port]) == irq) {
461 gpio = pdata->overcurrent_pin[port];
466 if (port == AT91_MAX_USBH_PORTS) {
467 dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
471 val = gpio_get_value(gpio);
473 /* When notified of an over-current situation, disable power
474 on the corresponding port, and mark this port in
477 ohci_at91_usb_set_power(pdata, port, 0);
478 pdata->overcurrent_status[port] = 1;
479 pdata->overcurrent_changed[port] = 1;
482 dev_dbg(& pdev->dev, "overcurrent situation %s\n",
483 val ? "exited" : "notified");
489 static const struct of_device_id at91_ohci_dt_ids[] = {
490 { .compatible = "atmel,at91rm9200-ohci" },
494 MODULE_DEVICE_TABLE(of, at91_ohci_dt_ids);
496 static u64 at91_ohci_dma_mask = DMA_BIT_MASK(32);
498 static int __devinit ohci_at91_of_init(struct platform_device *pdev)
500 struct device_node *np = pdev->dev.of_node;
502 enum of_gpio_flags flags;
503 struct at91_usbh_data *pdata;
509 /* Right now device-tree probed devices don't get dma_mask set.
510 * Since shared usb code relies on it, set it here for now.
511 * Once we have dma capability bindings this can go away.
513 if (!pdev->dev.dma_mask)
514 pdev->dev.dma_mask = &at91_ohci_dma_mask;
516 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
520 if (!of_property_read_u32(np, "num-ports", &ports))
521 pdata->ports = ports;
523 at91_for_each_port(i) {
524 gpio = of_get_named_gpio_flags(np, "atmel,vbus-gpio", i, &flags);
525 pdata->vbus_pin[i] = gpio;
526 if (!gpio_is_valid(gpio))
528 pdata->vbus_pin_active_low[i] = flags & OF_GPIO_ACTIVE_LOW;
531 at91_for_each_port(i)
532 pdata->overcurrent_pin[i] =
533 of_get_named_gpio_flags(np, "atmel,oc-gpio", i, &flags);
535 pdev->dev.platform_data = pdata;
540 static int __devinit ohci_at91_of_init(struct platform_device *pdev)
546 /*-------------------------------------------------------------------------*/
548 static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
550 struct at91_usbh_data *pdata;
555 ret = ohci_at91_of_init(pdev);
559 pdata = pdev->dev.platform_data;
562 at91_for_each_port(i) {
563 if (!gpio_is_valid(pdata->vbus_pin[i]))
565 gpio = pdata->vbus_pin[i];
567 ret = gpio_request(gpio, "ohci_vbus");
570 "can't request vbus gpio %d\n", gpio);
573 ret = gpio_direction_output(gpio,
574 !pdata->vbus_pin_active_low[i]);
577 "can't put vbus gpio %d as output %d\n",
578 gpio, !pdata->vbus_pin_active_low[i]);
583 ohci_at91_usb_set_power(pdata, i, 1);
586 at91_for_each_port(i) {
587 if (!gpio_is_valid(pdata->overcurrent_pin[i]))
589 gpio = pdata->overcurrent_pin[i];
591 ret = gpio_request(gpio, "ohci_overcurrent");
594 "can't request overcurrent gpio %d\n",
599 ret = gpio_direction_input(gpio);
602 "can't configure overcurrent gpio %d as input\n",
608 ret = request_irq(gpio_to_irq(gpio),
609 ohci_hcd_at91_overcurrent_irq,
610 IRQF_SHARED, "ohci_overcurrent", pdev);
614 "can't get gpio IRQ for overcurrent\n");
619 device_init_wakeup(&pdev->dev, 1);
620 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
623 static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
625 struct at91_usbh_data *pdata = pdev->dev.platform_data;
629 at91_for_each_port(i) {
630 if (!gpio_is_valid(pdata->vbus_pin[i]))
632 ohci_at91_usb_set_power(pdata, i, 0);
633 gpio_free(pdata->vbus_pin[i]);
636 at91_for_each_port(i) {
637 if (!gpio_is_valid(pdata->overcurrent_pin[i]))
639 free_irq(gpio_to_irq(pdata->overcurrent_pin[i]), pdev);
640 gpio_free(pdata->overcurrent_pin[i]);
644 device_init_wakeup(&pdev->dev, 0);
645 usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
652 ohci_hcd_at91_drv_suspend(struct platform_device *pdev, pm_message_t mesg)
654 struct usb_hcd *hcd = platform_get_drvdata(pdev);
655 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
657 if (device_may_wakeup(&pdev->dev))
658 enable_irq_wake(hcd->irq);
661 * The integrated transceivers seem unable to notice disconnect,
662 * reconnect, or wakeup without the 48 MHz clock active. so for
663 * correctness, always discard connection state (using reset).
665 * REVISIT: some boards will be able to turn VBUS off...
667 if (at91_suspend_entering_slow_clock()) {
668 ohci_usb_reset (ohci);
669 /* flush the writes */
670 (void) ohci_readl (ohci, &ohci->regs->control);
677 static int ohci_hcd_at91_drv_resume(struct platform_device *pdev)
679 struct usb_hcd *hcd = platform_get_drvdata(pdev);
681 if (device_may_wakeup(&pdev->dev))
682 disable_irq_wake(hcd->irq);
687 ohci_finish_controller_resume(hcd);
691 #define ohci_hcd_at91_drv_suspend NULL
692 #define ohci_hcd_at91_drv_resume NULL
695 MODULE_ALIAS("platform:at91_ohci");
697 static struct platform_driver ohci_hcd_at91_driver = {
698 .probe = ohci_hcd_at91_drv_probe,
699 .remove = ohci_hcd_at91_drv_remove,
700 .shutdown = usb_hcd_platform_shutdown,
701 .suspend = ohci_hcd_at91_drv_suspend,
702 .resume = ohci_hcd_at91_drv_resume,
705 .owner = THIS_MODULE,
706 .of_match_table = of_match_ptr(at91_ohci_dt_ids),