USB: ohci-at91: use resource_size() for memory/io resource length
[linux-2.6/cjktty.git] / drivers / usb / host / ohci-at91.c
blobd4608c2d5b64bb584bd81fa3f4155b05790cae3f
1 /*
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>
7 * AT91 Bus Glue
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>
21 #include <asm/gpio.h>
23 #include <mach/board.h>
24 #include <mach/cpu.h>
26 #ifndef CONFIG_ARCH_AT91
27 #error "CONFIG_ARCH_AT91 must be defined."
28 #endif
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;
36 static int clocked;
38 extern int usb_disabled(void);
40 /*-------------------------------------------------------------------------*/
42 static void at91_start_clock(void)
44 clk_enable(hclk);
45 clk_enable(iclk);
46 clk_enable(fclk);
47 clocked = 1;
50 static void at91_stop_clock(void)
52 clk_disable(fclk);
53 clk_disable(iclk);
54 clk_disable(hclk);
55 clocked = 0;
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.
68 at91_start_clock();
71 * The USB host controller must remain in reset.
73 writel(0, &regs->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, &regs->control);
89 * Stop the USB clocks.
91 at91_stop_clock();
95 /*-------------------------------------------------------------------------*/
97 static void __devexit 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 __devinit usb_hcd_at91_probe(const struct hc_driver *driver,
112 struct platform_device *pdev)
114 int retval;
115 struct usb_hcd *hcd = NULL;
117 if (pdev->num_resources != 2) {
118 pr_debug("hcd probe: invalid num_resources");
119 return -ENODEV;
122 if ((pdev->resource[0].flags != IORESOURCE_MEM)
123 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
124 pr_debug("hcd probe: invalid resource type\n");
125 return -ENODEV;
128 hcd = usb_create_hcd(driver, &pdev->dev, "at91");
129 if (!hcd)
130 return -ENOMEM;
131 hcd->rsrc_start = pdev->resource[0].start;
132 hcd->rsrc_len = resource_size(&pdev->resource[0]);
134 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
135 pr_debug("request_mem_region failed\n");
136 retval = -EBUSY;
137 goto err1;
140 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
141 if (!hcd->regs) {
142 pr_debug("ioremap failed\n");
143 retval = -EIO;
144 goto err2;
147 iclk = clk_get(&pdev->dev, "ohci_clk");
148 if (IS_ERR(iclk)) {
149 dev_err(&pdev->dev, "failed to get ohci_clk\n");
150 retval = PTR_ERR(iclk);
151 goto err3;
153 fclk = clk_get(&pdev->dev, "uhpck");
154 if (IS_ERR(fclk)) {
155 dev_err(&pdev->dev, "failed to get uhpck\n");
156 retval = PTR_ERR(fclk);
157 goto err4;
159 hclk = clk_get(&pdev->dev, "hclk");
160 if (IS_ERR(hclk)) {
161 dev_err(&pdev->dev, "failed to get hclk\n");
162 retval = PTR_ERR(hclk);
163 goto err5;
166 at91_start_hc(pdev);
167 ohci_hcd_init(hcd_to_ohci(hcd));
169 retval = usb_add_hcd(hcd, pdev->resource[1].start, IRQF_SHARED);
170 if (retval == 0)
171 return retval;
173 /* Error handling */
174 at91_stop_hc(pdev);
176 clk_put(hclk);
177 err5:
178 clk_put(fclk);
179 err4:
180 clk_put(iclk);
182 err3:
183 iounmap(hcd->regs);
185 err2:
186 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
188 err1:
189 usb_put_hcd(hcd);
190 return retval;
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 __devexit usb_hcd_at91_remove(struct usb_hcd *hcd,
207 struct platform_device *pdev)
209 usb_remove_hcd(hcd);
210 at91_stop_hc(pdev);
211 iounmap(hcd->regs);
212 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
213 usb_put_hcd(hcd);
215 clk_put(hclk);
216 clk_put(fclk);
217 clk_put(iclk);
218 fclk = iclk = hclk = NULL;
220 dev_set_drvdata(&pdev->dev, NULL);
223 /*-------------------------------------------------------------------------*/
225 static int __devinit
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);
230 int ret;
232 if ((ret = ohci_init(ohci)) < 0)
233 return ret;
235 ohci->num_ports = board->ports;
237 if ((ret = ohci_run(ohci)) < 0) {
238 dev_err(hcd->self.controller, "can't start %s\n",
239 hcd->self.bus_name);
240 ohci_stop(hcd);
241 return ret;
243 return 0;
246 static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
248 if (!valid_port(port))
249 return;
251 if (!gpio_is_valid(pdata->vbus_pin[port]))
252 return;
254 gpio_set_value(pdata->vbus_pin[port],
255 pdata->vbus_pin_active_low[port] ^ enable);
258 static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
260 if (!valid_port(port))
261 return -EINVAL;
263 if (!gpio_is_valid(pdata->vbus_pin[port]))
264 return -EINVAL;
266 return gpio_get_value(pdata->vbus_pin[port]) ^
267 pdata->vbus_pin_active_low[port];
271 * Update the status data from the hub with the over-current indicator change.
273 static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
275 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
276 int length = ohci_hub_status_data(hcd, buf);
277 int port;
279 at91_for_each_port(port) {
280 if (pdata->overcurrent_changed[port]) {
281 if (!length)
282 length = 1;
283 buf[0] |= 1 << (port + 1);
287 return length;
291 * Look at the control requests to the root hub and see if we need to override.
293 static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
294 u16 wIndex, char *buf, u16 wLength)
296 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
297 struct usb_hub_descriptor *desc;
298 int ret = -EINVAL;
299 u32 *data = (u32 *)buf;
301 dev_dbg(hcd->self.controller,
302 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
303 hcd, typeReq, wValue, wIndex, buf, wLength);
305 wIndex--;
307 switch (typeReq) {
308 case SetPortFeature:
309 if (wValue == USB_PORT_FEAT_POWER) {
310 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
311 if (valid_port(wIndex)) {
312 ohci_at91_usb_set_power(pdata, wIndex, 1);
313 ret = 0;
316 goto out;
318 break;
320 case ClearPortFeature:
321 switch (wValue) {
322 case USB_PORT_FEAT_C_OVER_CURRENT:
323 dev_dbg(hcd->self.controller,
324 "ClearPortFeature: C_OVER_CURRENT\n");
326 if (valid_port(wIndex)) {
327 pdata->overcurrent_changed[wIndex] = 0;
328 pdata->overcurrent_status[wIndex] = 0;
331 goto out;
333 case USB_PORT_FEAT_OVER_CURRENT:
334 dev_dbg(hcd->self.controller,
335 "ClearPortFeature: OVER_CURRENT\n");
337 if (valid_port(wIndex))
338 pdata->overcurrent_status[wIndex] = 0;
340 goto out;
342 case USB_PORT_FEAT_POWER:
343 dev_dbg(hcd->self.controller,
344 "ClearPortFeature: POWER\n");
346 if (valid_port(wIndex)) {
347 ohci_at91_usb_set_power(pdata, wIndex, 0);
348 return 0;
351 break;
354 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex + 1, buf, wLength);
355 if (ret)
356 goto out;
358 switch (typeReq) {
359 case GetHubDescriptor:
361 /* update the hub's descriptor */
363 desc = (struct usb_hub_descriptor *)buf;
365 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
366 desc->wHubCharacteristics);
368 /* remove the old configurations for power-switching, and
369 * over-current protection, and insert our new configuration
372 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
373 desc->wHubCharacteristics |= cpu_to_le16(0x0001);
375 if (pdata->overcurrent_supported) {
376 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
377 desc->wHubCharacteristics |= cpu_to_le16(0x0008|0x0001);
380 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
381 desc->wHubCharacteristics);
383 return ret;
385 case GetPortStatus:
386 /* check port status */
388 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
390 if (valid_port(wIndex)) {
391 if (!ohci_at91_usb_get_power(pdata, wIndex))
392 *data &= ~cpu_to_le32(RH_PS_PPS);
394 if (pdata->overcurrent_changed[wIndex])
395 *data |= cpu_to_le32(RH_PS_OCIC);
397 if (pdata->overcurrent_status[wIndex])
398 *data |= cpu_to_le32(RH_PS_POCI);
402 out:
403 return ret;
406 /*-------------------------------------------------------------------------*/
408 static const struct hc_driver ohci_at91_hc_driver = {
409 .description = hcd_name,
410 .product_desc = "AT91 OHCI",
411 .hcd_priv_size = sizeof(struct ohci_hcd),
414 * generic hardware linkage
416 .irq = ohci_irq,
417 .flags = HCD_USB11 | HCD_MEMORY,
420 * basic lifecycle operations
422 .start = ohci_at91_start,
423 .stop = ohci_stop,
424 .shutdown = ohci_shutdown,
427 * managing i/o requests and associated device resources
429 .urb_enqueue = ohci_urb_enqueue,
430 .urb_dequeue = ohci_urb_dequeue,
431 .endpoint_disable = ohci_endpoint_disable,
434 * scheduling support
436 .get_frame_number = ohci_get_frame,
439 * root hub support
441 .hub_status_data = ohci_at91_hub_status_data,
442 .hub_control = ohci_at91_hub_control,
443 #ifdef CONFIG_PM
444 .bus_suspend = ohci_bus_suspend,
445 .bus_resume = ohci_bus_resume,
446 #endif
447 .start_port_reset = ohci_start_port_reset,
450 /*-------------------------------------------------------------------------*/
452 static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
454 struct platform_device *pdev = data;
455 struct at91_usbh_data *pdata = pdev->dev.platform_data;
456 int val, gpio, port;
458 /* From the GPIO notifying the over-current situation, find
459 * out the corresponding port */
460 at91_for_each_port(port) {
461 if (gpio_to_irq(pdata->overcurrent_pin[port]) == irq) {
462 gpio = pdata->overcurrent_pin[port];
463 break;
467 if (port == AT91_MAX_USBH_PORTS) {
468 dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
469 return IRQ_HANDLED;
472 val = gpio_get_value(gpio);
474 /* When notified of an over-current situation, disable power
475 on the corresponding port, and mark this port in
476 over-current. */
477 if (!val) {
478 ohci_at91_usb_set_power(pdata, port, 0);
479 pdata->overcurrent_status[port] = 1;
480 pdata->overcurrent_changed[port] = 1;
483 dev_dbg(& pdev->dev, "overcurrent situation %s\n",
484 val ? "exited" : "notified");
486 return IRQ_HANDLED;
489 #ifdef CONFIG_OF
490 static const struct of_device_id at91_ohci_dt_ids[] = {
491 { .compatible = "atmel,at91rm9200-ohci" },
492 { /* sentinel */ }
495 MODULE_DEVICE_TABLE(of, at91_ohci_dt_ids);
497 static u64 at91_ohci_dma_mask = DMA_BIT_MASK(32);
499 static int __devinit ohci_at91_of_init(struct platform_device *pdev)
501 struct device_node *np = pdev->dev.of_node;
502 int i, gpio;
503 enum of_gpio_flags flags;
504 struct at91_usbh_data *pdata;
505 u32 ports;
507 if (!np)
508 return 0;
510 /* Right now device-tree probed devices don't get dma_mask set.
511 * Since shared usb code relies on it, set it here for now.
512 * Once we have dma capability bindings this can go away.
514 if (!pdev->dev.dma_mask)
515 pdev->dev.dma_mask = &at91_ohci_dma_mask;
517 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
518 if (!pdata)
519 return -ENOMEM;
521 if (!of_property_read_u32(np, "num-ports", &ports))
522 pdata->ports = ports;
524 at91_for_each_port(i) {
525 gpio = of_get_named_gpio_flags(np, "atmel,vbus-gpio", i, &flags);
526 pdata->vbus_pin[i] = gpio;
527 if (!gpio_is_valid(gpio))
528 continue;
529 pdata->vbus_pin_active_low[i] = flags & OF_GPIO_ACTIVE_LOW;
532 at91_for_each_port(i)
533 pdata->overcurrent_pin[i] =
534 of_get_named_gpio_flags(np, "atmel,oc-gpio", i, &flags);
536 pdev->dev.platform_data = pdata;
538 return 0;
540 #else
541 static int __devinit ohci_at91_of_init(struct platform_device *pdev)
543 return 0;
545 #endif
547 /*-------------------------------------------------------------------------*/
549 static int __devinit ohci_hcd_at91_drv_probe(struct platform_device *pdev)
551 struct at91_usbh_data *pdata;
552 int i;
553 int gpio;
554 int ret;
556 ret = ohci_at91_of_init(pdev);
557 if (ret)
558 return ret;
560 pdata = pdev->dev.platform_data;
562 if (pdata) {
563 at91_for_each_port(i) {
564 if (!gpio_is_valid(pdata->vbus_pin[i]))
565 continue;
566 gpio = pdata->vbus_pin[i];
568 ret = gpio_request(gpio, "ohci_vbus");
569 if (ret) {
570 dev_err(&pdev->dev,
571 "can't request vbus gpio %d\n", gpio);
572 continue;
574 ret = gpio_direction_output(gpio,
575 !pdata->vbus_pin_active_low[i]);
576 if (ret) {
577 dev_err(&pdev->dev,
578 "can't put vbus gpio %d as output %d\n",
579 gpio, !pdata->vbus_pin_active_low[i]);
580 gpio_free(gpio);
581 continue;
584 ohci_at91_usb_set_power(pdata, i, 1);
587 at91_for_each_port(i) {
588 if (!gpio_is_valid(pdata->overcurrent_pin[i]))
589 continue;
590 gpio = pdata->overcurrent_pin[i];
592 ret = gpio_request(gpio, "ohci_overcurrent");
593 if (ret) {
594 dev_err(&pdev->dev,
595 "can't request overcurrent gpio %d\n",
596 gpio);
597 continue;
600 ret = gpio_direction_input(gpio);
601 if (ret) {
602 dev_err(&pdev->dev,
603 "can't configure overcurrent gpio %d as input\n",
604 gpio);
605 gpio_free(gpio);
606 continue;
609 ret = request_irq(gpio_to_irq(gpio),
610 ohci_hcd_at91_overcurrent_irq,
611 IRQF_SHARED, "ohci_overcurrent", pdev);
612 if (ret) {
613 gpio_free(gpio);
614 dev_err(&pdev->dev,
615 "can't get gpio IRQ for overcurrent\n");
620 device_init_wakeup(&pdev->dev, 1);
621 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
624 static int __devexit ohci_hcd_at91_drv_remove(struct platform_device *pdev)
626 struct at91_usbh_data *pdata = pdev->dev.platform_data;
627 int i;
629 if (pdata) {
630 at91_for_each_port(i) {
631 if (!gpio_is_valid(pdata->vbus_pin[i]))
632 continue;
633 ohci_at91_usb_set_power(pdata, i, 0);
634 gpio_free(pdata->vbus_pin[i]);
637 at91_for_each_port(i) {
638 if (!gpio_is_valid(pdata->overcurrent_pin[i]))
639 continue;
640 free_irq(gpio_to_irq(pdata->overcurrent_pin[i]), pdev);
641 gpio_free(pdata->overcurrent_pin[i]);
645 device_init_wakeup(&pdev->dev, 0);
646 usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
647 return 0;
650 #ifdef CONFIG_PM
652 static int
653 ohci_hcd_at91_drv_suspend(struct platform_device *pdev, pm_message_t mesg)
655 struct usb_hcd *hcd = platform_get_drvdata(pdev);
656 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
658 if (device_may_wakeup(&pdev->dev))
659 enable_irq_wake(hcd->irq);
662 * The integrated transceivers seem unable to notice disconnect,
663 * reconnect, or wakeup without the 48 MHz clock active. so for
664 * correctness, always discard connection state (using reset).
666 * REVISIT: some boards will be able to turn VBUS off...
668 if (at91_suspend_entering_slow_clock()) {
669 ohci_usb_reset (ohci);
670 /* flush the writes */
671 (void) ohci_readl (ohci, &ohci->regs->control);
672 at91_stop_clock();
675 return 0;
678 static int ohci_hcd_at91_drv_resume(struct platform_device *pdev)
680 struct usb_hcd *hcd = platform_get_drvdata(pdev);
682 if (device_may_wakeup(&pdev->dev))
683 disable_irq_wake(hcd->irq);
685 if (!clocked)
686 at91_start_clock();
688 ohci_finish_controller_resume(hcd);
689 return 0;
691 #else
692 #define ohci_hcd_at91_drv_suspend NULL
693 #define ohci_hcd_at91_drv_resume NULL
694 #endif
696 MODULE_ALIAS("platform:at91_ohci");
698 static struct platform_driver ohci_hcd_at91_driver = {
699 .probe = ohci_hcd_at91_drv_probe,
700 .remove = __devexit_p(ohci_hcd_at91_drv_remove),
701 .shutdown = usb_hcd_platform_shutdown,
702 .suspend = ohci_hcd_at91_drv_suspend,
703 .resume = ohci_hcd_at91_drv_resume,
704 .driver = {
705 .name = "at91_ohci",
706 .owner = THIS_MODULE,
707 .of_match_table = of_match_ptr(at91_ohci_dt_ids),