drivers/usb/host/ohci-at91.c

   1 /*
   2  * OHCI HCD (Host Controller Driver) for USB.
   3  *
   4  *  Copyright (C) 2004 SAN People (Pty) Ltd.
   5  *  Copyright (C) 2005 Thibaut VARENE <varenet@parisc-linux.org>
   6  *
   7  * AT91 Bus Glue
   8  *
   9  * Based on fragments of 2.4 driver by Rick Bronson.
  10  * Based on ohci-omap.c
  11  *
  12  * This file is licenced under the GPL.
  13  */
  14
  15 #include <linux/clk.h>
  16 #include <linux/platform_device.h>
  17
  18 #include <mach/hardware.h>
  19 #include <asm/gpio.h>
  20
  21 #include <mach/board.h>
  22 #include <mach/cpu.h>
  23
  24 #ifndef CONFIG_ARCH_AT91
  25 #error "CONFIG_ARCH_AT91 must be defined."
  26 #endif
  27
  28 /* interface and function clocks; sometimes also an AHB clock */
  29 static struct clk *iclk, *fclk, *hclk;
  30 static int clocked;
  31
  32 extern int usb_disabled(void);
  33
  34 /*-------------------------------------------------------------------------*/
  35
  36 static void at91_start_clock(void)
  37 {
  38         clk_enable(hclk);
  39         clk_enable(iclk);
  40         clk_enable(fclk);
  41         clocked = 1;
  42 }
  43
  44 static void at91_stop_clock(void)
  45 {
  46         clk_disable(fclk);
  47         clk_disable(iclk);
  48         clk_disable(hclk);
  49         clocked = 0;
  50 }
  51
  52 static void at91_start_hc(struct platform_device *pdev)
  53 {
  54         struct usb_hcd *hcd = platform_get_drvdata(pdev);
  55         struct ohci_regs __iomem *regs = hcd->regs;
  56
  57         dev_dbg(&pdev->dev, "start\n");
  58
  59         /*
  60          * Start the USB clocks.
  61          */
  62         at91_start_clock();
  63
  64         /*
  65          * The USB host controller must remain in reset.
  66          */
  67         writel(0, &regs->control);
  68 }
  69
  70 static void at91_stop_hc(struct platform_device *pdev)
  71 {
  72         struct usb_hcd *hcd = platform_get_drvdata(pdev);
  73         struct ohci_regs __iomem *regs = hcd->regs;
  74
  75         dev_dbg(&pdev->dev, "stop\n");
  76
  77         /*
  78          * Put the USB host controller into reset.
  79          */
  80         writel(0, &regs->control);
  81
  82         /*
  83          * Stop the USB clocks.
  84          */
  85         at91_stop_clock();
  86 }
  87
  88
  89 /*-------------------------------------------------------------------------*/
  90
  91 static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
  92
  93 /* configure so an HC device and id are always provided */
  94 /* always called with process context; sleeping is OK */
  95
  96
  97 /**
  98  * usb_hcd_at91_probe - initialize AT91-based HCDs
  99  * Context: !in_interrupt()
 100  *
 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.
 104  */
 105 static int usb_hcd_at91_probe(const struct hc_driver *driver,
 106                         struct platform_device *pdev)
 107 {
 108         int retval;
 109         struct usb_hcd *hcd = NULL;
 110
 111         if (pdev->num_resources != 2) {
 112                 pr_debug("hcd probe: invalid num_resources");
 113                 return -ENODEV;
 114         }
 115
 116         if ((pdev->resource[0].flags != IORESOURCE_MEM)
 117                         || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
 118                 pr_debug("hcd probe: invalid resource type\n");
 119                 return -ENODEV;
 120         }
 121
 122         hcd = usb_create_hcd(driver, &pdev->dev, "at91");
 123         if (!hcd)
 124                 return -ENOMEM;
 125         hcd->rsrc_start = pdev->resource[0].start;
 126         hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
 127
 128         if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
 129                 pr_debug("request_mem_region failed\n");
 130                 retval = -EBUSY;
 131                 goto err1;
 132         }
 133
 134         hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
 135         if (!hcd->regs) {
 136                 pr_debug("ioremap failed\n");
 137                 retval = -EIO;
 138                 goto err2;
 139         }
 140
 141         iclk = clk_get(&pdev->dev, "ohci_clk");
 142         if (IS_ERR(iclk)) {
 143                 dev_err(&pdev->dev, "failed to get ohci_clk\n");
 144                 retval = PTR_ERR(iclk);
 145                 goto err3;
 146         }
 147         fclk = clk_get(&pdev->dev, "uhpck");
 148         if (IS_ERR(fclk)) {
 149                 dev_err(&pdev->dev, "failed to get uhpck\n");
 150                 retval = PTR_ERR(fclk);
 151                 goto err4;
 152         }
 153         hclk = clk_get(&pdev->dev, "hclk");
 154         if (IS_ERR(hclk)) {
 155                 dev_err(&pdev->dev, "failed to get hclk\n");
 156                 retval = PTR_ERR(hclk);
 157                 goto err5;
 158         }
 159
 160         at91_start_hc(pdev);
 161         ohci_hcd_init(hcd_to_ohci(hcd));
 162
 163         retval = usb_add_hcd(hcd, pdev->resource[1].start, IRQF_SHARED);
 164         if (retval == 0)
 165                 return retval;
 166
 167         /* Error handling */
 168         at91_stop_hc(pdev);
 169
 170         clk_put(hclk);
 171  err5:
 172         clk_put(fclk);
 173  err4:
 174         clk_put(iclk);
 175
 176  err3:
 177         iounmap(hcd->regs);
 178
 179  err2:
 180         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 181
 182  err1:
 183         usb_put_hcd(hcd);
 184         return retval;
 185 }
 186
 187
 188 /* may be called with controller, bus, and devices active */
 189
 190 /**
 191  * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
 192  * @dev: USB Host Controller being removed
 193  * Context: !in_interrupt()
 194  *
 195  * Reverses the effect of usb_hcd_at91_probe(), first invoking
 196  * the HCD's stop() method.  It is always called from a thread
 197  * context, "rmmod" or something similar.
 198  *
 199  */
 200 static void usb_hcd_at91_remove(struct usb_hcd *hcd,
 201                                 struct platform_device *pdev)
 202 {
 203         usb_remove_hcd(hcd);
 204         at91_stop_hc(pdev);
 205         iounmap(hcd->regs);
 206         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 207         usb_put_hcd(hcd);
 208
 209         clk_put(hclk);
 210         clk_put(fclk);
 211         clk_put(iclk);
 212         fclk = iclk = hclk = NULL;
 213
 214         dev_set_drvdata(&pdev->dev, NULL);
 215 }
 216
 217 /*-------------------------------------------------------------------------*/
 218
 219 static int __devinit
 220 ohci_at91_start (struct usb_hcd *hcd)
 221 {
 222         struct at91_usbh_data   *board = hcd->self.controller->platform_data;
 223         struct ohci_hcd         *ohci = hcd_to_ohci (hcd);
 224         int                     ret;
 225
 226         if ((ret = ohci_init(ohci)) < 0)
 227                 return ret;
 228
 229         ohci->num_ports = board->ports;
 230
 231         if ((ret = ohci_run(ohci)) < 0) {
 232                 err("can't start %s", hcd->self.bus_name);
 233                 ohci_stop(hcd);
 234                 return ret;
 235         }
 236         return 0;
 237 }
 238
 239 static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
 240 {
 241         if (port < 0 || port >= 2)
 242                 return;
 243
 244         if (!gpio_is_valid(pdata->vbus_pin[port]))
 245                 return;
 246
 247         gpio_set_value(pdata->vbus_pin[port], !pdata->vbus_pin_inverted ^ enable);
 248 }
 249
 250 static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
 251 {
 252         if (port < 0 || port >= 2)
 253                 return -EINVAL;
 254
 255         if (!gpio_is_valid(pdata->vbus_pin[port]))
 256                 return -EINVAL;
 257
 258         return gpio_get_value(pdata->vbus_pin[port]) ^ !pdata->vbus_pin_inverted;
 259 }
 260
 261 /*
 262  * Update the status data from the hub with the over-current indicator change.
 263  */
 264 static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
 265 {
 266         struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
 267         int length = ohci_hub_status_data(hcd, buf);
 268         int port;
 269
 270         for (port = 0; port < ARRAY_SIZE(pdata->overcurrent_pin); port++) {
 271                 if (pdata->overcurrent_changed[port]) {
 272                         if (! length)
 273                                 length = 1;
 274                         buf[0] |= 1 << (port + 1);
 275                 }
 276         }
 277
 278         return length;
 279 }
 280
 281 /*
 282  * Look at the control requests to the root hub and see if we need to override.
 283  */
 284 static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
 285                                  u16 wIndex, char *buf, u16 wLength)
 286 {
 287         struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
 288         struct usb_hub_descriptor *desc;
 289         int ret = -EINVAL;
 290         u32 *data = (u32 *)buf;
 291
 292         dev_dbg(hcd->self.controller,
 293                 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
 294                 hcd, typeReq, wValue, wIndex, buf, wLength);
 295
 296         switch (typeReq) {
 297         case SetPortFeature:
 298                 if (wValue == USB_PORT_FEAT_POWER) {
 299                         dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
 300                         ohci_at91_usb_set_power(pdata, wIndex - 1, 1);
 301                         goto out;
 302                 }
 303                 break;
 304
 305         case ClearPortFeature:
 306                 switch (wValue) {
 307                 case USB_PORT_FEAT_C_OVER_CURRENT:
 308                         dev_dbg(hcd->self.controller,
 309                                 "ClearPortFeature: C_OVER_CURRENT\n");
 310
 311                         if (wIndex == 1 || wIndex == 2) {
 312                                 pdata->overcurrent_changed[wIndex-1] = 0;
 313                                 pdata->overcurrent_status[wIndex-1] = 0;
 314                         }
 315
 316                         goto out;
 317
 318                 case USB_PORT_FEAT_OVER_CURRENT:
 319                         dev_dbg(hcd->self.controller,
 320                                 "ClearPortFeature: OVER_CURRENT\n");
 321
 322                         if (wIndex == 1 || wIndex == 2) {
 323                                 pdata->overcurrent_status[wIndex-1] = 0;
 324                         }
 325
 326                         goto out;
 327
 328                 case USB_PORT_FEAT_POWER:
 329                         dev_dbg(hcd->self.controller,
 330                                 "ClearPortFeature: POWER\n");
 331
 332                         if (wIndex == 1 || wIndex == 2) {
 333                                 ohci_at91_usb_set_power(pdata, wIndex - 1, 0);
 334                                 return 0;
 335                         }
 336                 }
 337                 break;
 338         }
 339
 340         ret = ohci_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
 341         if (ret)
 342                 goto out;
 343
 344         switch (typeReq) {
 345         case GetHubDescriptor:
 346
 347                 /* update the hub's descriptor */
 348
 349                 desc = (struct usb_hub_descriptor *)buf;
 350
 351                 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
 352                         desc->wHubCharacteristics);
 353
 354                 /* remove the old configurations for power-switching, and
 355                  * over-current protection, and insert our new configuration
 356                  */
 357
 358                 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
 359                 desc->wHubCharacteristics |= cpu_to_le16(0x0001);
 360
 361                 if (pdata->overcurrent_supported) {
 362                         desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
 363                         desc->wHubCharacteristics |=  cpu_to_le16(0x0008|0x0001);
 364                 }
 365
 366                 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
 367                         desc->wHubCharacteristics);
 368
 369                 return ret;
 370
 371         case GetPortStatus:
 372                 /* check port status */
 373
 374                 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
 375
 376                 if (wIndex == 1 || wIndex == 2) {
 377                         if (! ohci_at91_usb_get_power(pdata, wIndex-1)) {
 378                                 *data &= ~cpu_to_le32(RH_PS_PPS);
 379                         }
 380
 381                         if (pdata->overcurrent_changed[wIndex-1]) {
 382                                 *data |= cpu_to_le32(RH_PS_OCIC);
 383                         }
 384
 385                         if (pdata->overcurrent_status[wIndex-1]) {
 386                                 *data |= cpu_to_le32(RH_PS_POCI);
 387                         }
 388                 }
 389         }
 390
 391  out:
 392         return ret;
 393 }
 394
 395 /*-------------------------------------------------------------------------*/
 396
 397 static const struct hc_driver ohci_at91_hc_driver = {
 398         .description =          hcd_name,
 399         .product_desc =         "AT91 OHCI",
 400         .hcd_priv_size =        sizeof(struct ohci_hcd),
 401
 402         /*
 403          * generic hardware linkage
 404          */
 405         .irq =                  ohci_irq,
 406         .flags =                HCD_USB11 | HCD_MEMORY,
 407
 408         /*
 409          * basic lifecycle operations
 410          */
 411         .start =                ohci_at91_start,
 412         .stop =                 ohci_stop,
 413         .shutdown =             ohci_shutdown,
 414
 415         /*
 416          * managing i/o requests and associated device resources
 417          */
 418         .urb_enqueue =          ohci_urb_enqueue,
 419         .urb_dequeue =          ohci_urb_dequeue,
 420         .endpoint_disable =     ohci_endpoint_disable,
 421
 422         /*
 423          * scheduling support
 424          */
 425         .get_frame_number =     ohci_get_frame,
 426
 427         /*
 428          * root hub support
 429          */
 430         .hub_status_data =      ohci_at91_hub_status_data,
 431         .hub_control =          ohci_at91_hub_control,
 432 #ifdef CONFIG_PM
 433         .bus_suspend =          ohci_bus_suspend,
 434         .bus_resume =           ohci_bus_resume,
 435 #endif
 436         .start_port_reset =     ohci_start_port_reset,
 437 };
 438
 439 /*-------------------------------------------------------------------------*/
 440
 441 static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
 442 {
 443         struct platform_device *pdev = data;
 444         struct at91_usbh_data *pdata = pdev->dev.platform_data;
 445         int val, gpio, port;
 446
 447         /* From the GPIO notifying the over-current situation, find
 448          * out the corresponding port */
 449         gpio = irq_to_gpio(irq);
 450         for (port = 0; port < ARRAY_SIZE(pdata->overcurrent_pin); port++) {
 451                 if (pdata->overcurrent_pin[port] == gpio)
 452                         break;
 453         }
 454
 455         if (port == ARRAY_SIZE(pdata->overcurrent_pin)) {
 456                 dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
 457                 return IRQ_HANDLED;
 458         }
 459
 460         val = gpio_get_value(gpio);
 461
 462         /* When notified of an over-current situation, disable power
 463            on the corresponding port, and mark this port in
 464            over-current. */
 465         if (! val) {
 466                 ohci_at91_usb_set_power(pdata, port, 0);
 467                 pdata->overcurrent_status[port]  = 1;
 468                 pdata->overcurrent_changed[port] = 1;
 469         }
 470
 471         dev_dbg(& pdev->dev, "overcurrent situation %s\n",
 472                 val ? "exited" : "notified");
 473
 474         return IRQ_HANDLED;
 475 }
 476
 477 /*-------------------------------------------------------------------------*/
 478
 479 static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
 480 {
 481         struct at91_usbh_data   *pdata = pdev->dev.platform_data;
 482         int                     i;
 483
 484         if (pdata) {
 485                 for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
 486                         if (!gpio_is_valid(pdata->vbus_pin[i]))
 487                                 continue;
 488                         gpio_request(pdata->vbus_pin[i], "ohci_vbus");
 489                         ohci_at91_usb_set_power(pdata, i, 1);
 490                 }
 491
 492                 for (i = 0; i < ARRAY_SIZE(pdata->overcurrent_pin); i++) {
 493                         int ret;
 494
 495                         if (!gpio_is_valid(pdata->overcurrent_pin[i]))
 496                                 continue;
 497                         gpio_request(pdata->overcurrent_pin[i], "ohci_overcurrent");
 498
 499                         ret = request_irq(gpio_to_irq(pdata->overcurrent_pin[i]),
 500                                           ohci_hcd_at91_overcurrent_irq,
 501                                           IRQF_SHARED, "ohci_overcurrent", pdev);
 502                         if (ret) {
 503                                 gpio_free(pdata->overcurrent_pin[i]);
 504                                 dev_warn(& pdev->dev, "cannot get GPIO IRQ for overcurrent\n");
 505                         }
 506                 }
 507         }
 508
 509         device_init_wakeup(&pdev->dev, 1);
 510         return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
 511 }
 512
 513 static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
 514 {
 515         struct at91_usbh_data   *pdata = pdev->dev.platform_data;
 516         int                     i;
 517
 518         if (pdata) {
 519                 for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
 520                         if (!gpio_is_valid(pdata->vbus_pin[i]))
 521                                 continue;
 522                         ohci_at91_usb_set_power(pdata, i, 0);
 523                         gpio_free(pdata->vbus_pin[i]);
 524                 }
 525
 526                 for (i = 0; i < ARRAY_SIZE(pdata->overcurrent_pin); i++) {
 527                         if (!gpio_is_valid(pdata->overcurrent_pin[i]))
 528                                 continue;
 529                         free_irq(gpio_to_irq(pdata->overcurrent_pin[i]), pdev);
 530                         gpio_free(pdata->overcurrent_pin[i]);
 531                 }
 532         }
 533
 534         device_init_wakeup(&pdev->dev, 0);
 535         usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
 536         return 0;
 537 }
 538
 539 #ifdef CONFIG_PM
 540
 541 static int
 542 ohci_hcd_at91_drv_suspend(struct platform_device *pdev, pm_message_t mesg)
 543 {
 544         struct usb_hcd  *hcd = platform_get_drvdata(pdev);
 545         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
 546
 547         if (device_may_wakeup(&pdev->dev))
 548                 enable_irq_wake(hcd->irq);
 549
 550         /*
 551          * The integrated transceivers seem unable to notice disconnect,
 552          * reconnect, or wakeup without the 48 MHz clock active.  so for
 553          * correctness, always discard connection state (using reset).
 554          *
 555          * REVISIT: some boards will be able to turn VBUS off...
 556          */
 557         if (at91_suspend_entering_slow_clock()) {
 558                 ohci_usb_reset (ohci);
 559                 /* flush the writes */
 560                 (void) ohci_readl (ohci, &ohci->regs->control);
 561                 at91_stop_clock();
 562         }
 563
 564         return 0;
 565 }
 566
 567 static int ohci_hcd_at91_drv_resume(struct platform_device *pdev)
 568 {
 569         struct usb_hcd  *hcd = platform_get_drvdata(pdev);
 570
 571         if (device_may_wakeup(&pdev->dev))
 572                 disable_irq_wake(hcd->irq);
 573
 574         if (!clocked)
 575                 at91_start_clock();
 576
 577         ohci_finish_controller_resume(hcd);
 578         return 0;
 579 }
 580 #else
 581 #define ohci_hcd_at91_drv_suspend NULL
 582 #define ohci_hcd_at91_drv_resume  NULL
 583 #endif
 584
 585 MODULE_ALIAS("platform:at91_ohci");
 586
 587 static struct platform_driver ohci_hcd_at91_driver = {
 588         .probe          = ohci_hcd_at91_drv_probe,
 589         .remove         = ohci_hcd_at91_drv_remove,
 590         .shutdown       = usb_hcd_platform_shutdown,
 591         .suspend        = ohci_hcd_at91_drv_suspend,
 592         .resume         = ohci_hcd_at91_drv_resume,
 593         .driver         = {
 594                 .name   = "at91_ohci",
 595                 .owner  = THIS_MODULE,
 596         },
 597 };