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>
18 #include <mach/hardware.h>
21 #include <mach/board.h>
24 #ifndef CONFIG_ARCH_AT91
25 #error "CONFIG_ARCH_AT91 must be defined."
28 /* interface and function clocks; sometimes also an AHB clock */
29 static struct clk *iclk, *fclk, *hclk;
32 extern int usb_disabled(void);
34 /*-------------------------------------------------------------------------*/
36 static void at91_start_clock(void)
44 static void at91_stop_clock(void)
52 static void at91_start_hc(struct platform_device *pdev)
54 struct usb_hcd *hcd = platform_get_drvdata(pdev);
55 struct ohci_regs __iomem *regs = hcd->regs;
57 dev_dbg(&pdev->dev, "start\n");
60 * Start the USB clocks.
65 * The USB host controller must remain in reset.
67 writel(0, ®s->control);
70 static void at91_stop_hc(struct platform_device *pdev)
72 struct usb_hcd *hcd = platform_get_drvdata(pdev);
73 struct ohci_regs __iomem *regs = hcd->regs;
75 dev_dbg(&pdev->dev, "stop\n");
78 * Put the USB host controller into reset.
80 writel(0, ®s->control);
83 * Stop the USB clocks.
89 /*-------------------------------------------------------------------------*/
91 static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
93 /* configure so an HC device and id are always provided */
94 /* always called with process context; sleeping is OK */
98 * usb_hcd_at91_probe - initialize AT91-based HCDs
99 * Context: !in_interrupt()
101 * Allocates basic resources for this USB host controller, and
102 * then invokes the start() method for the HCD associated with it
103 * through the hotplug entry's driver_data.
105 static int usb_hcd_at91_probe(const struct hc_driver *driver,
106 struct platform_device *pdev)
109 struct usb_hcd *hcd = NULL;
111 if (pdev->num_resources != 2) {
112 pr_debug("hcd probe: invalid num_resources");
116 if ((pdev->resource[0].flags != IORESOURCE_MEM)
117 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
118 pr_debug("hcd probe: invalid resource type\n");
122 hcd = usb_create_hcd(driver, &pdev->dev, "at91");
125 hcd->rsrc_start = pdev->resource[0].start;
126 hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
128 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
129 pr_debug("request_mem_region failed\n");
134 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
136 pr_debug("ioremap failed\n");
141 iclk = clk_get(&pdev->dev, "ohci_clk");
142 fclk = clk_get(&pdev->dev, "uhpck");
143 hclk = clk_get(&pdev->dev, "hclk");
146 ohci_hcd_init(hcd_to_ohci(hcd));
148 retval = usb_add_hcd(hcd, pdev->resource[1].start, IRQF_SHARED);
162 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
170 /* may be called with controller, bus, and devices active */
173 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
174 * @dev: USB Host Controller being removed
175 * Context: !in_interrupt()
177 * Reverses the effect of usb_hcd_at91_probe(), first invoking
178 * the HCD's stop() method. It is always called from a thread
179 * context, "rmmod" or something similar.
182 static void usb_hcd_at91_remove(struct usb_hcd *hcd,
183 struct platform_device *pdev)
188 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
194 fclk = iclk = hclk = NULL;
196 dev_set_drvdata(&pdev->dev, NULL);
199 /*-------------------------------------------------------------------------*/
202 ohci_at91_start (struct usb_hcd *hcd)
204 struct at91_usbh_data *board = hcd->self.controller->platform_data;
205 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
208 if ((ret = ohci_init(ohci)) < 0)
211 ohci->num_ports = board->ports;
213 if ((ret = ohci_run(ohci)) < 0) {
214 err("can't start %s", hcd->self.bus_name);
221 static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
223 if (port < 0 || port >= 2)
226 if (!gpio_is_valid(pdata->vbus_pin[port]))
229 gpio_set_value(pdata->vbus_pin[port], !pdata->vbus_pin_inverted ^ enable);
232 static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
234 if (port < 0 || port >= 2)
237 if (!gpio_is_valid(pdata->vbus_pin[port]))
240 return gpio_get_value(pdata->vbus_pin[port]) ^ !pdata->vbus_pin_inverted;
244 * Update the status data from the hub with the over-current indicator change.
246 static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
248 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
249 int length = ohci_hub_status_data(hcd, buf);
252 for (port = 0; port < ARRAY_SIZE(pdata->overcurrent_pin); port++) {
253 if (pdata->overcurrent_changed[port]) {
256 buf[0] |= 1 << (port + 1);
264 * Look at the control requests to the root hub and see if we need to override.
266 static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
267 u16 wIndex, char *buf, u16 wLength)
269 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
270 struct usb_hub_descriptor *desc;
272 u32 *data = (u32 *)buf;
274 dev_dbg(hcd->self.controller,
275 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
276 hcd, typeReq, wValue, wIndex, buf, wLength);
280 if (wValue == USB_PORT_FEAT_POWER) {
281 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
282 ohci_at91_usb_set_power(pdata, wIndex - 1, 1);
287 case ClearPortFeature:
289 case USB_PORT_FEAT_C_OVER_CURRENT:
290 dev_dbg(hcd->self.controller,
291 "ClearPortFeature: C_OVER_CURRENT\n");
293 if (wIndex == 1 || wIndex == 2) {
294 pdata->overcurrent_changed[wIndex-1] = 0;
295 pdata->overcurrent_status[wIndex-1] = 0;
300 case USB_PORT_FEAT_OVER_CURRENT:
301 dev_dbg(hcd->self.controller,
302 "ClearPortFeature: OVER_CURRENT\n");
304 if (wIndex == 1 || wIndex == 2) {
305 pdata->overcurrent_status[wIndex-1] = 0;
310 case USB_PORT_FEAT_POWER:
311 dev_dbg(hcd->self.controller,
312 "ClearPortFeature: POWER\n");
314 if (wIndex == 1 || wIndex == 2) {
315 ohci_at91_usb_set_power(pdata, wIndex - 1, 0);
322 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
327 case GetHubDescriptor:
329 /* update the hub's descriptor */
331 desc = (struct usb_hub_descriptor *)buf;
333 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
334 desc->wHubCharacteristics);
336 /* remove the old configurations for power-switching, and
337 * over-current protection, and insert our new configuration
340 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
341 desc->wHubCharacteristics |= cpu_to_le16(0x0001);
343 if (pdata->overcurrent_supported) {
344 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
345 desc->wHubCharacteristics |= cpu_to_le16(0x0008|0x0001);
348 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
349 desc->wHubCharacteristics);
354 /* check port status */
356 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
358 if (wIndex == 1 || wIndex == 2) {
359 if (! ohci_at91_usb_get_power(pdata, wIndex-1)) {
360 *data &= ~cpu_to_le32(RH_PS_PPS);
363 if (pdata->overcurrent_changed[wIndex-1]) {
364 *data |= cpu_to_le32(RH_PS_OCIC);
367 if (pdata->overcurrent_status[wIndex-1]) {
368 *data |= cpu_to_le32(RH_PS_POCI);
377 /*-------------------------------------------------------------------------*/
379 static const struct hc_driver ohci_at91_hc_driver = {
380 .description = hcd_name,
381 .product_desc = "AT91 OHCI",
382 .hcd_priv_size = sizeof(struct ohci_hcd),
385 * generic hardware linkage
388 .flags = HCD_USB11 | HCD_MEMORY,
391 * basic lifecycle operations
393 .start = ohci_at91_start,
395 .shutdown = ohci_shutdown,
398 * managing i/o requests and associated device resources
400 .urb_enqueue = ohci_urb_enqueue,
401 .urb_dequeue = ohci_urb_dequeue,
402 .endpoint_disable = ohci_endpoint_disable,
407 .get_frame_number = ohci_get_frame,
412 .hub_status_data = ohci_at91_hub_status_data,
413 .hub_control = ohci_at91_hub_control,
415 .bus_suspend = ohci_bus_suspend,
416 .bus_resume = ohci_bus_resume,
418 .start_port_reset = ohci_start_port_reset,
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 = pdev->dev.platform_data;
429 /* From the GPIO notifying the over-current situation, find
430 * out the corresponding port */
431 gpio = irq_to_gpio(irq);
432 for (port = 0; port < ARRAY_SIZE(pdata->overcurrent_pin); port++) {
433 if (pdata->overcurrent_pin[port] == gpio)
437 if (port == ARRAY_SIZE(pdata->overcurrent_pin)) {
438 dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
442 val = gpio_get_value(gpio);
444 /* When notified of an over-current situation, disable power
445 on the corresponding port, and mark this port in
448 ohci_at91_usb_set_power(pdata, port, 0);
449 pdata->overcurrent_status[port] = 1;
450 pdata->overcurrent_changed[port] = 1;
453 dev_dbg(& pdev->dev, "overcurrent situation %s\n",
454 val ? "exited" : "notified");
459 /*-------------------------------------------------------------------------*/
461 static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
463 struct at91_usbh_data *pdata = pdev->dev.platform_data;
467 for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
468 if (!gpio_is_valid(pdata->vbus_pin[i]))
470 gpio_request(pdata->vbus_pin[i], "ohci_vbus");
471 ohci_at91_usb_set_power(pdata, i, 1);
474 for (i = 0; i < ARRAY_SIZE(pdata->overcurrent_pin); i++) {
477 if (!gpio_is_valid(pdata->overcurrent_pin[i]))
479 gpio_request(pdata->overcurrent_pin[i], "ohci_overcurrent");
481 ret = request_irq(gpio_to_irq(pdata->overcurrent_pin[i]),
482 ohci_hcd_at91_overcurrent_irq,
483 IRQF_SHARED, "ohci_overcurrent", pdev);
485 gpio_free(pdata->overcurrent_pin[i]);
486 dev_warn(& pdev->dev, "cannot get GPIO IRQ for overcurrent\n");
491 device_init_wakeup(&pdev->dev, 1);
492 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
495 static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
497 struct at91_usbh_data *pdata = pdev->dev.platform_data;
501 for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
502 if (!gpio_is_valid(pdata->vbus_pin[i]))
504 ohci_at91_usb_set_power(pdata, i, 0);
505 gpio_free(pdata->vbus_pin[i]);
508 for (i = 0; i < ARRAY_SIZE(pdata->overcurrent_pin); i++) {
509 if (!gpio_is_valid(pdata->overcurrent_pin[i]))
511 free_irq(gpio_to_irq(pdata->overcurrent_pin[i]), pdev);
512 gpio_free(pdata->overcurrent_pin[i]);
516 device_init_wakeup(&pdev->dev, 0);
517 usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
524 ohci_hcd_at91_drv_suspend(struct platform_device *pdev, pm_message_t mesg)
526 struct usb_hcd *hcd = platform_get_drvdata(pdev);
527 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
529 if (device_may_wakeup(&pdev->dev))
530 enable_irq_wake(hcd->irq);
533 * The integrated transceivers seem unable to notice disconnect,
534 * reconnect, or wakeup without the 48 MHz clock active. so for
535 * correctness, always discard connection state (using reset).
537 * REVISIT: some boards will be able to turn VBUS off...
539 if (at91_suspend_entering_slow_clock()) {
540 ohci_usb_reset (ohci);
541 /* flush the writes */
542 (void) ohci_readl (ohci, &ohci->regs->control);
549 static int ohci_hcd_at91_drv_resume(struct platform_device *pdev)
551 struct usb_hcd *hcd = platform_get_drvdata(pdev);
553 if (device_may_wakeup(&pdev->dev))
554 disable_irq_wake(hcd->irq);
559 ohci_finish_controller_resume(hcd);
563 #define ohci_hcd_at91_drv_suspend NULL
564 #define ohci_hcd_at91_drv_resume NULL
567 MODULE_ALIAS("platform:at91_ohci");
569 static struct platform_driver ohci_hcd_at91_driver = {
570 .probe = ohci_hcd_at91_drv_probe,
571 .remove = ohci_hcd_at91_drv_remove,
572 .shutdown = usb_hcd_platform_shutdown,
573 .suspend = ohci_hcd_at91_drv_suspend,
574 .resume = ohci_hcd_at91_drv_resume,
577 .owner = THIS_MODULE,