drivers/usb/host/ohci-omap.c

   1 /*
   2  * OHCI HCD (Host Controller Driver) for USB.
   3  *
   4  * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
   5  * (C) Copyright 2000-2005 David Brownell
   6  * (C) Copyright 2002 Hewlett-Packard Company
   7  *
   8  * OMAP Bus Glue
   9  *
  10  * Modified for OMAP by Tony Lindgren <tony@atomide.com>
  11  * Based on the 2.4 OMAP OHCI driver originally done by MontaVista Software Inc.
  12  * and on ohci-sa1111.c by Christopher Hoover <ch@hpl.hp.com>
  13  *
  14  * This file is licenced under the GPL.
  15  */
  16
  17 #include <linux/signal.h>       /* SA_INTERRUPT */
  18 #include <linux/jiffies.h>
  19 #include <linux/platform_device.h>
  20 #include <linux/clk.h>
  21
  22 #include <asm/hardware.h>
  23 #include <asm/io.h>
  24 #include <asm/mach-types.h>
  25
  26 #include <asm/arch/mux.h>
  27 #include <asm/arch/irqs.h>
  28 #include <asm/arch/gpio.h>
  29 #include <asm/arch/fpga.h>
  30 #include <asm/arch/usb.h>
  31
  32
  33 /* OMAP-1510 OHCI has its own MMU for DMA */
  34 #define OMAP1510_LB_MEMSIZE     32      /* Should be same as SDRAM size */
  35 #define OMAP1510_LB_CLOCK_DIV   0xfffec10c
  36 #define OMAP1510_LB_MMU_CTL     0xfffec208
  37 #define OMAP1510_LB_MMU_LCK     0xfffec224
  38 #define OMAP1510_LB_MMU_LD_TLB  0xfffec228
  39 #define OMAP1510_LB_MMU_CAM_H   0xfffec22c
  40 #define OMAP1510_LB_MMU_CAM_L   0xfffec230
  41 #define OMAP1510_LB_MMU_RAM_H   0xfffec234
  42 #define OMAP1510_LB_MMU_RAM_L   0xfffec238
  43
  44
  45 #ifndef CONFIG_ARCH_OMAP
  46 #error "This file is OMAP bus glue.  CONFIG_OMAP must be defined."
  47 #endif
  48
  49 #ifdef CONFIG_TPS65010
  50 #include <asm/arch/tps65010.h>
  51 #else
  52
  53 #define LOW     0
  54 #define HIGH    1
  55
  56 #define GPIO1   1
  57
  58 static inline int tps65010_set_gpio_out_value(unsigned gpio, unsigned value)
  59 {
  60         return 0;
  61 }
  62
  63 #endif
  64
  65 extern int usb_disabled(void);
  66 extern int ocpi_enable(void);
  67
  68 static struct clk *usb_host_ck;
  69 static struct clk *usb_dc_ck;
  70 static int host_enabled;
  71 static int host_initialized;
  72
  73 static void omap_ohci_clock_power(int on)
  74 {
  75         if (on) {
  76                 clk_enable(usb_dc_ck);
  77                 clk_enable(usb_host_ck);
  78                 /* guesstimate for T5 == 1x 32K clock + APLL lock time */
  79                 udelay(100);
  80         } else {
  81                 clk_disable(usb_host_ck);
  82                 clk_disable(usb_dc_ck);
  83         }
  84 }
  85
  86 /*
  87  * Board specific gang-switched transceiver power on/off.
  88  * NOTE:  OSK supplies power from DC, not battery.
  89  */
  90 static int omap_ohci_transceiver_power(int on)
  91 {
  92         if (on) {
  93                 if (machine_is_omap_innovator() && cpu_is_omap1510())
  94                         fpga_write(fpga_read(INNOVATOR_FPGA_CAM_USB_CONTROL)
  95                                 | ((1 << 5/*usb1*/) | (1 << 3/*usb2*/)),
  96                                INNOVATOR_FPGA_CAM_USB_CONTROL);
  97                 else if (machine_is_omap_osk())
  98                         tps65010_set_gpio_out_value(GPIO1, LOW);
  99         } else {
 100                 if (machine_is_omap_innovator() && cpu_is_omap1510())
 101                         fpga_write(fpga_read(INNOVATOR_FPGA_CAM_USB_CONTROL)
 102                                 & ~((1 << 5/*usb1*/) | (1 << 3/*usb2*/)),
 103                                INNOVATOR_FPGA_CAM_USB_CONTROL);
 104                 else if (machine_is_omap_osk())
 105                         tps65010_set_gpio_out_value(GPIO1, HIGH);
 106         }
 107
 108         return 0;
 109 }
 110
 111 #ifdef CONFIG_ARCH_OMAP15XX
 112 /*
 113  * OMAP-1510 specific Local Bus clock on/off
 114  */
 115 static int omap_1510_local_bus_power(int on)
 116 {
 117         if (on) {
 118                 omap_writel((1 << 1) | (1 << 0), OMAP1510_LB_MMU_CTL);
 119                 udelay(200);
 120         } else {
 121                 omap_writel(0, OMAP1510_LB_MMU_CTL);
 122         }
 123
 124         return 0;
 125 }
 126
 127 /*
 128  * OMAP-1510 specific Local Bus initialization
 129  * NOTE: This assumes 32MB memory size in OMAP1510LB_MEMSIZE.
 130  *       See also arch/mach-omap/memory.h for __virt_to_dma() and
 131  *       __dma_to_virt() which need to match with the physical
 132  *       Local Bus address below.
 133  */
 134 static int omap_1510_local_bus_init(void)
 135 {
 136         unsigned int tlb;
 137         unsigned long lbaddr, physaddr;
 138
 139         omap_writel((omap_readl(OMAP1510_LB_CLOCK_DIV) & 0xfffffff8) | 0x4,
 140                OMAP1510_LB_CLOCK_DIV);
 141
 142         /* Configure the Local Bus MMU table */
 143         for (tlb = 0; tlb < OMAP1510_LB_MEMSIZE; tlb++) {
 144                 lbaddr = tlb * 0x00100000 + OMAP1510_LB_OFFSET;
 145                 physaddr = tlb * 0x00100000 + PHYS_OFFSET;
 146                 omap_writel((lbaddr & 0x0fffffff) >> 22, OMAP1510_LB_MMU_CAM_H);
 147                 omap_writel(((lbaddr & 0x003ffc00) >> 6) | 0xc,
 148                        OMAP1510_LB_MMU_CAM_L);
 149                 omap_writel(physaddr >> 16, OMAP1510_LB_MMU_RAM_H);
 150                 omap_writel((physaddr & 0x0000fc00) | 0x300, OMAP1510_LB_MMU_RAM_L);
 151                 omap_writel(tlb << 4, OMAP1510_LB_MMU_LCK);
 152                 omap_writel(0x1, OMAP1510_LB_MMU_LD_TLB);
 153         }
 154
 155         /* Enable the walking table */
 156         omap_writel(omap_readl(OMAP1510_LB_MMU_CTL) | (1 << 3), OMAP1510_LB_MMU_CTL);
 157         udelay(200);
 158
 159         return 0;
 160 }
 161 #else
 162 #define omap_1510_local_bus_power(x)    {}
 163 #define omap_1510_local_bus_init()      {}
 164 #endif
 165
 166 #ifdef  CONFIG_USB_OTG
 167
 168 static void start_hnp(struct ohci_hcd *ohci)
 169 {
 170         const unsigned  port = ohci_to_hcd(ohci)->self.otg_port - 1;
 171         unsigned long   flags;
 172
 173         otg_start_hnp(ohci->transceiver);
 174
 175         local_irq_save(flags);
 176         ohci->transceiver->state = OTG_STATE_A_SUSPEND;
 177         writel (RH_PS_PSS, &ohci->regs->roothub.portstatus [port]);
 178         OTG_CTRL_REG &= ~OTG_A_BUSREQ;
 179         local_irq_restore(flags);
 180 }
 181
 182 #endif
 183
 184 /*-------------------------------------------------------------------------*/
 185
 186 static int omap_start_hc(struct ohci_hcd *ohci, struct platform_device *pdev)
 187 {
 188         struct omap_usb_config  *config = pdev->dev.platform_data;
 189         int                     need_transceiver = (config->otg != 0);
 190         int                     ret;
 191
 192         dev_dbg(&pdev->dev, "starting USB Controller\n");
 193
 194         if (config->otg) {
 195                 ohci_to_hcd(ohci)->self.otg_port = config->otg;
 196                 /* default/minimum OTG power budget:  8 mA */
 197                 ohci_to_hcd(ohci)->power_budget = 8;
 198         }
 199
 200         /* boards can use OTG transceivers in non-OTG modes */
 201         need_transceiver = need_transceiver
 202                         || machine_is_omap_h2() || machine_is_omap_h3();
 203
 204         if (cpu_is_omap16xx())
 205                 ocpi_enable();
 206
 207 #ifdef  CONFIG_ARCH_OMAP_OTG
 208         if (need_transceiver) {
 209                 ohci->transceiver = otg_get_transceiver();
 210                 if (ohci->transceiver) {
 211                         int     status = otg_set_host(ohci->transceiver,
 212                                                 &ohci_to_hcd(ohci)->self);
 213                         dev_dbg(&pdev->dev, "init %s transceiver, status %d\n",
 214                                         ohci->transceiver->label, status);
 215                         if (status) {
 216                                 if (ohci->transceiver)
 217                                         put_device(ohci->transceiver->dev);
 218                                 return status;
 219                         }
 220                 } else {
 221                         dev_err(&pdev->dev, "can't find transceiver\n");
 222                         return -ENODEV;
 223                 }
 224         }
 225 #endif
 226
 227         omap_ohci_clock_power(1);
 228
 229         if (cpu_is_omap1510()) {
 230                 omap_1510_local_bus_power(1);
 231                 omap_1510_local_bus_init();
 232         }
 233
 234         if ((ret = ohci_init(ohci)) < 0)
 235                 return ret;
 236
 237         /* board-specific power switching and overcurrent support */
 238         if (machine_is_omap_osk() || machine_is_omap_innovator()) {
 239                 u32     rh = roothub_a (ohci);
 240
 241                 /* power switching (ganged by default) */
 242                 rh &= ~RH_A_NPS;
 243
 244                 /* TPS2045 switch for internal transceiver (port 1) */
 245                 if (machine_is_omap_osk()) {
 246                         ohci_to_hcd(ohci)->power_budget = 250;
 247
 248                         rh &= ~RH_A_NOCP;
 249
 250                         /* gpio9 for overcurrent detction */
 251                         omap_cfg_reg(W8_1610_GPIO9);
 252                         omap_request_gpio(9);
 253                         omap_set_gpio_direction(9, 1 /* IN */);
 254
 255                         /* for paranoia's sake:  disable USB.PUEN */
 256                         omap_cfg_reg(W4_USB_HIGHZ);
 257                 }
 258                 ohci_writel(ohci, rh, &ohci->regs->roothub.a);
 259                 distrust_firmware = 0;
 260         } else if (machine_is_nokia770()) {
 261                 /* We require a self-powered hub, which should have
 262                  * plenty of power. */
 263                 ohci_to_hcd(ohci)->power_budget = 0;
 264         }
 265
 266         /* FIXME khubd hub requests should manage power switching */
 267         omap_ohci_transceiver_power(1);
 268
 269         /* board init will have already handled HMC and mux setup.
 270          * any external transceiver should already be initialized
 271          * too, so all configured ports use the right signaling now.
 272          */
 273
 274         return 0;
 275 }
 276
 277 static void omap_stop_hc(struct platform_device *pdev)
 278 {
 279         dev_dbg(&pdev->dev, "stopping USB Controller\n");
 280         omap_ohci_clock_power(0);
 281 }
 282
 283
 284 /*-------------------------------------------------------------------------*/
 285
 286 void usb_hcd_omap_remove (struct usb_hcd *, struct platform_device *);
 287
 288 /**
 289  * usb_hcd_omap_probe - initialize OMAP-based HCDs
 290  * Context: !in_interrupt()
 291  *
 292  * Allocates basic resources for this USB host controller, and
 293  * then invokes the start() method for the HCD associated with it
 294  * through the hotplug entry's driver_data.
 295  */
 296 int usb_hcd_omap_probe (const struct hc_driver *driver,
 297                           struct platform_device *pdev)
 298 {
 299         int retval, irq;
 300         struct usb_hcd *hcd = 0;
 301         struct ohci_hcd *ohci;
 302
 303         if (pdev->num_resources != 2) {
 304                 printk(KERN_ERR "hcd probe: invalid num_resources: %i\n",
 305                        pdev->num_resources);
 306                 return -ENODEV;
 307         }
 308
 309         if (pdev->resource[0].flags != IORESOURCE_MEM
 310                         || pdev->resource[1].flags != IORESOURCE_IRQ) {
 311                 printk(KERN_ERR "hcd probe: invalid resource type\n");
 312                 return -ENODEV;
 313         }
 314
 315         usb_host_ck = clk_get(0, "usb_hhc_ck");
 316         if (IS_ERR(usb_host_ck))
 317                 return PTR_ERR(usb_host_ck);
 318
 319         if (!cpu_is_omap1510())
 320                 usb_dc_ck = clk_get(0, "usb_dc_ck");
 321         else
 322                 usb_dc_ck = clk_get(0, "lb_ck");
 323
 324         if (IS_ERR(usb_dc_ck)) {
 325                 clk_put(usb_host_ck);
 326                 return PTR_ERR(usb_dc_ck);
 327         }
 328
 329
 330         hcd = usb_create_hcd (driver, &pdev->dev, pdev->dev.bus_id);
 331         if (!hcd) {
 332                 retval = -ENOMEM;
 333                 goto err0;
 334         }
 335         hcd->rsrc_start = pdev->resource[0].start;
 336         hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
 337
 338         if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
 339                 dev_dbg(&pdev->dev, "request_mem_region failed\n");
 340                 retval = -EBUSY;
 341                 goto err1;
 342         }
 343
 344         hcd->regs = (void __iomem *) (int) IO_ADDRESS(hcd->rsrc_start);
 345
 346         ohci = hcd_to_ohci(hcd);
 347         ohci_hcd_init(ohci);
 348
 349         host_initialized = 0;
 350         host_enabled = 1;
 351
 352         retval = omap_start_hc(ohci, pdev);
 353         if (retval < 0)
 354                 goto err2;
 355
 356         irq = platform_get_irq(pdev, 0);
 357         if (irq < 0) {
 358                 retval = -ENXIO;
 359                 goto err2;
 360         }
 361         retval = usb_add_hcd(hcd, irq, SA_INTERRUPT);
 362         if (retval)
 363                 goto err3;
 364
 365         host_initialized = 1;
 366
 367         if (!host_enabled)
 368                 omap_ohci_clock_power(0);
 369
 370         return 0;
 371 err3:
 372         omap_stop_hc(pdev);
 373 err2:
 374         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 375 err1:
 376         usb_put_hcd(hcd);
 377 err0:
 378         clk_put(usb_dc_ck);
 379         clk_put(usb_host_ck);
 380         return retval;
 381 }
 382
 383
 384 /* may be called with controller, bus, and devices active */
 385
 386 /**
 387  * usb_hcd_omap_remove - shutdown processing for OMAP-based HCDs
 388  * @dev: USB Host Controller being removed
 389  * Context: !in_interrupt()
 390  *
 391  * Reverses the effect of usb_hcd_omap_probe(), first invoking
 392  * the HCD's stop() method.  It is always called from a thread
 393  * context, normally "rmmod", "apmd", or something similar.
 394  *
 395  */
 396 void usb_hcd_omap_remove (struct usb_hcd *hcd, struct platform_device *pdev)
 397 {
 398         usb_remove_hcd(hcd);
 399         if (machine_is_omap_osk())
 400                 omap_free_gpio(9);
 401         omap_stop_hc(pdev);
 402         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 403         usb_put_hcd(hcd);
 404         clk_put(usb_dc_ck);
 405         clk_put(usb_host_ck);
 406 }
 407
 408 /*-------------------------------------------------------------------------*/
 409
 410 static int
 411 ohci_omap_start (struct usb_hcd *hcd)
 412 {
 413         struct omap_usb_config *config;
 414         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
 415         int             ret;
 416
 417         if (!host_enabled)
 418                 return 0;
 419         config = hcd->self.controller->platform_data;
 420         if (config->otg || config->rwc)
 421                 writel(OHCI_CTRL_RWC, &ohci->regs->control);
 422
 423         if ((ret = ohci_run (ohci)) < 0) {
 424                 dev_err(hcd->self.controller, "can't start\n");
 425                 ohci_stop (hcd);
 426                 return ret;
 427         }
 428         return 0;
 429 }
 430
 431 /*-------------------------------------------------------------------------*/
 432
 433 static const struct hc_driver ohci_omap_hc_driver = {
 434         .description =          hcd_name,
 435         .product_desc =         "OMAP OHCI",
 436         .hcd_priv_size =        sizeof(struct ohci_hcd),
 437
 438         /*
 439          * generic hardware linkage
 440          */
 441         .irq =                  ohci_irq,
 442         .flags =                HCD_USB11 | HCD_MEMORY,
 443
 444         /*
 445          * basic lifecycle operations
 446          */
 447         .start =                ohci_omap_start,
 448         .stop =                 ohci_stop,
 449
 450         /*
 451          * managing i/o requests and associated device resources
 452          */
 453         .urb_enqueue =          ohci_urb_enqueue,
 454         .urb_dequeue =          ohci_urb_dequeue,
 455         .endpoint_disable =     ohci_endpoint_disable,
 456
 457         /*
 458          * scheduling support
 459          */
 460         .get_frame_number =     ohci_get_frame,
 461
 462         /*
 463          * root hub support
 464          */
 465         .hub_status_data =      ohci_hub_status_data,
 466         .hub_control =          ohci_hub_control,
 467 #ifdef  CONFIG_PM
 468         .bus_suspend =          ohci_bus_suspend,
 469         .bus_resume =           ohci_bus_resume,
 470 #endif
 471         .start_port_reset =     ohci_start_port_reset,
 472 };
 473
 474 /*-------------------------------------------------------------------------*/
 475
 476 static int ohci_hcd_omap_drv_probe(struct platform_device *dev)
 477 {
 478         return usb_hcd_omap_probe(&ohci_omap_hc_driver, dev);
 479 }
 480
 481 static int ohci_hcd_omap_drv_remove(struct platform_device *dev)
 482 {
 483         struct usb_hcd          *hcd = platform_get_drvdata(dev);
 484         struct ohci_hcd         *ohci = hcd_to_ohci (hcd);
 485
 486         usb_hcd_omap_remove(hcd, dev);
 487         if (ohci->transceiver) {
 488                 (void) otg_set_host(ohci->transceiver, 0);
 489                 put_device(ohci->transceiver->dev);
 490         }
 491         platform_set_drvdata(dev, NULL);
 492
 493         return 0;
 494 }
 495
 496 /*-------------------------------------------------------------------------*/
 497
 498 #ifdef  CONFIG_PM
 499
 500 static int ohci_omap_suspend(struct platform_device *dev, pm_message_t message)
 501 {
 502         struct ohci_hcd *ohci = hcd_to_ohci(platform_get_drvdata(dev));
 503
 504         if (time_before(jiffies, ohci->next_statechange))
 505                 msleep(5);
 506         ohci->next_statechange = jiffies;
 507
 508         omap_ohci_clock_power(0);
 509         ohci_to_hcd(ohci)->state = HC_STATE_SUSPENDED;
 510         dev->dev.power.power_state = PMSG_SUSPEND;
 511         return 0;
 512 }
 513
 514 static int ohci_omap_resume(struct platform_device *dev)
 515 {
 516         struct ohci_hcd *ohci = hcd_to_ohci(platform_get_drvdata(dev));
 517
 518         if (time_before(jiffies, ohci->next_statechange))
 519                 msleep(5);
 520         ohci->next_statechange = jiffies;
 521
 522         omap_ohci_clock_power(1);
 523         dev->dev.power.power_state = PMSG_ON;
 524         usb_hcd_resume_root_hub(platform_get_drvdata(dev));
 525         return 0;
 526 }
 527
 528 #endif
 529
 530 /*-------------------------------------------------------------------------*/
 531
 532 /*
 533  * Driver definition to register with the OMAP bus
 534  */
 535 static struct platform_driver ohci_hcd_omap_driver = {
 536         .probe          = ohci_hcd_omap_drv_probe,
 537         .remove         = ohci_hcd_omap_drv_remove,
 538 #ifdef  CONFIG_PM
 539         .suspend        = ohci_omap_suspend,
 540         .resume         = ohci_omap_resume,
 541 #endif
 542         .driver         = {
 543                 .owner  = THIS_MODULE,
 544                 .name   = "ohci",
 545         },
 546 };
 547
 548 static int __init ohci_hcd_omap_init (void)
 549 {
 550         printk (KERN_DEBUG "%s: " DRIVER_INFO " (OMAP)\n", hcd_name);
 551         if (usb_disabled())
 552                 return -ENODEV;
 553
 554         pr_debug("%s: block sizes: ed %Zd td %Zd\n", hcd_name,
 555                 sizeof (struct ed), sizeof (struct td));
 556
 557         return platform_driver_register(&ohci_hcd_omap_driver);
 558 }
 559
 560 static void __exit ohci_hcd_omap_cleanup (void)
 561 {
 562         platform_driver_unregister(&ohci_hcd_omap_driver);
 563 }
 564
 565 module_init (ohci_hcd_omap_init);
 566 module_exit (ohci_hcd_omap_cleanup);