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