drivers/usb/host/ehci-tegra.c

   1 /*
   2  * EHCI-compliant USB host controller driver for NVIDIA Tegra SoCs
   3  *
   4  * Copyright (C) 2010 Google, Inc.
   5  * Copyright (C) 2009 - 2013 NVIDIA Corporation
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2 of the License, or (at your
  10  * option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  15  * more details.
  16  *
  17  */
  18
  19 #include <linux/clk.h>
  20 #include <linux/clk/tegra.h>
  21 #include <linux/dma-mapping.h>
  22 #include <linux/err.h>
  23 #include <linux/gpio.h>
  24 #include <linux/io.h>
  25 #include <linux/irq.h>
  26 #include <linux/module.h>
  27 #include <linux/of.h>
  28 #include <linux/of_gpio.h>
  29 #include <linux/platform_device.h>
  30 #include <linux/platform_data/tegra_usb.h>
  31 #include <linux/pm_runtime.h>
  32 #include <linux/slab.h>
  33 #include <linux/usb/ehci_def.h>
  34 #include <linux/usb/tegra_usb_phy.h>
  35 #include <linux/usb.h>
  36 #include <linux/usb/hcd.h>
  37 #include <linux/usb/otg.h>
  38
  39 #include "ehci.h"
  40
  41 #define TEGRA_USB_BASE                  0xC5000000
  42 #define TEGRA_USB2_BASE                 0xC5004000
  43 #define TEGRA_USB3_BASE                 0xC5008000
  44
  45 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
  46
  47 #define TEGRA_USB_DMA_ALIGN 32
  48
  49 #define DRIVER_DESC "Tegra EHCI driver"
  50 #define DRV_NAME "tegra-ehci"
  51
  52 static struct hc_driver __read_mostly tegra_ehci_hc_driver;
  53
  54 static int (*orig_hub_control)(struct usb_hcd *hcd,
  55                                 u16 typeReq, u16 wValue, u16 wIndex,
  56                                 char *buf, u16 wLength);
  57
  58 struct tegra_ehci_hcd {
  59         struct ehci_hcd *ehci;
  60         struct tegra_usb_phy *phy;
  61         struct clk *clk;
  62         struct usb_phy *transceiver;
  63         int port_resuming;
  64         bool needs_double_reset;
  65         enum tegra_usb_phy_port_speed port_speed;
  66 };
  67
  68 static int tegra_ehci_internal_port_reset(
  69         struct ehci_hcd *ehci,
  70         u32 __iomem     *portsc_reg
  71 )
  72 {
  73         u32             temp;
  74         unsigned long   flags;
  75         int             retval = 0;
  76         int             i, tries;
  77         u32             saved_usbintr;
  78
  79         spin_lock_irqsave(&ehci->lock, flags);
  80         saved_usbintr = ehci_readl(ehci, &ehci->regs->intr_enable);
  81         /* disable USB interrupt */
  82         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
  83         spin_unlock_irqrestore(&ehci->lock, flags);
  84
  85         /*
  86          * Here we have to do Port Reset at most twice for
  87          * Port Enable bit to be set.
  88          */
  89         for (i = 0; i < 2; i++) {
  90                 temp = ehci_readl(ehci, portsc_reg);
  91                 temp |= PORT_RESET;
  92                 ehci_writel(ehci, temp, portsc_reg);
  93                 mdelay(10);
  94                 temp &= ~PORT_RESET;
  95                 ehci_writel(ehci, temp, portsc_reg);
  96                 mdelay(1);
  97                 tries = 100;
  98                 do {
  99                         mdelay(1);
 100                         /*
 101                          * Up to this point, Port Enable bit is
 102                          * expected to be set after 2 ms waiting.
 103                          * USB1 usually takes extra 45 ms, for safety,
 104                          * we take 100 ms as timeout.
 105                          */
 106                         temp = ehci_readl(ehci, portsc_reg);
 107                 } while (!(temp & PORT_PE) && tries--);
 108                 if (temp & PORT_PE)
 109                         break;
 110         }
 111         if (i == 2)
 112                 retval = -ETIMEDOUT;
 113
 114         /*
 115          * Clear Connect Status Change bit if it's set.
 116          * We can't clear PORT_PEC. It will also cause PORT_PE to be cleared.
 117          */
 118         if (temp & PORT_CSC)
 119                 ehci_writel(ehci, PORT_CSC, portsc_reg);
 120
 121         /*
 122          * Write to clear any interrupt status bits that might be set
 123          * during port reset.
 124          */
 125         temp = ehci_readl(ehci, &ehci->regs->status);
 126         ehci_writel(ehci, temp, &ehci->regs->status);
 127
 128         /* restore original interrupt enable bits */
 129         ehci_writel(ehci, saved_usbintr, &ehci->regs->intr_enable);
 130         return retval;
 131 }
 132
 133 static int tegra_ehci_hub_control(
 134         struct usb_hcd  *hcd,
 135         u16             typeReq,
 136         u16             wValue,
 137         u16             wIndex,
 138         char            *buf,
 139         u16             wLength
 140 )
 141 {
 142         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
 143         struct tegra_ehci_hcd *tegra = dev_get_drvdata(hcd->self.controller);
 144         u32 __iomem     *status_reg;
 145         u32             temp;
 146         unsigned long   flags;
 147         int             retval = 0;
 148
 149         status_reg = &ehci->regs->port_status[(wIndex & 0xff) - 1];
 150
 151         spin_lock_irqsave(&ehci->lock, flags);
 152
 153         if (typeReq == GetPortStatus) {
 154                 temp = ehci_readl(ehci, status_reg);
 155                 if (tegra->port_resuming && !(temp & PORT_SUSPEND)) {
 156                         /* Resume completed, re-enable disconnect detection */
 157                         tegra->port_resuming = 0;
 158                         tegra_usb_phy_postresume(hcd->phy);
 159                 }
 160         }
 161
 162         else if (typeReq == SetPortFeature && wValue == USB_PORT_FEAT_SUSPEND) {
 163                 temp = ehci_readl(ehci, status_reg);
 164                 if ((temp & PORT_PE) == 0 || (temp & PORT_RESET) != 0) {
 165                         retval = -EPIPE;
 166                         goto done;
 167                 }
 168
 169                 temp &= ~(PORT_RWC_BITS | PORT_WKCONN_E);
 170                 temp |= PORT_WKDISC_E | PORT_WKOC_E;
 171                 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
 172
 173                 /*
 174                  * If a transaction is in progress, there may be a delay in
 175                  * suspending the port. Poll until the port is suspended.
 176                  */
 177                 if (ehci_handshake(ehci, status_reg, PORT_SUSPEND,
 178                                                 PORT_SUSPEND, 5000))
 179                         pr_err("%s: timeout waiting for SUSPEND\n", __func__);
 180
 181                 set_bit((wIndex & 0xff) - 1, &ehci->suspended_ports);
 182                 goto done;
 183         }
 184
 185         /* For USB1 port we need to issue Port Reset twice internally */
 186         if (tegra->needs_double_reset &&
 187            (typeReq == SetPortFeature && wValue == USB_PORT_FEAT_RESET)) {
 188                 spin_unlock_irqrestore(&ehci->lock, flags);
 189                 return tegra_ehci_internal_port_reset(ehci, status_reg);
 190         }
 191
 192         /*
 193          * Tegra host controller will time the resume operation to clear the bit
 194          * when the port control state switches to HS or FS Idle. This behavior
 195          * is different from EHCI where the host controller driver is required
 196          * to set this bit to a zero after the resume duration is timed in the
 197          * driver.
 198          */
 199         else if (typeReq == ClearPortFeature &&
 200                                         wValue == USB_PORT_FEAT_SUSPEND) {
 201                 temp = ehci_readl(ehci, status_reg);
 202                 if ((temp & PORT_RESET) || !(temp & PORT_PE)) {
 203                         retval = -EPIPE;
 204                         goto done;
 205                 }
 206
 207                 if (!(temp & PORT_SUSPEND))
 208                         goto done;
 209
 210                 /* Disable disconnect detection during port resume */
 211                 tegra_usb_phy_preresume(hcd->phy);
 212
 213                 ehci->reset_done[wIndex-1] = jiffies + msecs_to_jiffies(25);
 214
 215                 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
 216                 /* start resume signalling */
 217                 ehci_writel(ehci, temp | PORT_RESUME, status_reg);
 218                 set_bit(wIndex-1, &ehci->resuming_ports);
 219
 220                 spin_unlock_irqrestore(&ehci->lock, flags);
 221                 msleep(20);
 222                 spin_lock_irqsave(&ehci->lock, flags);
 223
 224                 /* Poll until the controller clears RESUME and SUSPEND */
 225                 if (ehci_handshake(ehci, status_reg, PORT_RESUME, 0, 2000))
 226                         pr_err("%s: timeout waiting for RESUME\n", __func__);
 227                 if (ehci_handshake(ehci, status_reg, PORT_SUSPEND, 0, 2000))
 228                         pr_err("%s: timeout waiting for SUSPEND\n", __func__);
 229
 230                 ehci->reset_done[wIndex-1] = 0;
 231                 clear_bit(wIndex-1, &ehci->resuming_ports);
 232
 233                 tegra->port_resuming = 1;
 234                 goto done;
 235         }
 236
 237         spin_unlock_irqrestore(&ehci->lock, flags);
 238
 239         /* Handle the hub control events here */
 240         return orig_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
 241
 242 done:
 243         spin_unlock_irqrestore(&ehci->lock, flags);
 244         return retval;
 245 }
 246
 247 struct dma_aligned_buffer {
 248         void *kmalloc_ptr;
 249         void *old_xfer_buffer;
 250         u8 data[0];
 251 };
 252
 253 static void free_dma_aligned_buffer(struct urb *urb)
 254 {
 255         struct dma_aligned_buffer *temp;
 256
 257         if (!(urb->transfer_flags & URB_ALIGNED_TEMP_BUFFER))
 258                 return;
 259
 260         temp = container_of(urb->transfer_buffer,
 261                 struct dma_aligned_buffer, data);
 262
 263         if (usb_urb_dir_in(urb))
 264                 memcpy(temp->old_xfer_buffer, temp->data,
 265                        urb->transfer_buffer_length);
 266         urb->transfer_buffer = temp->old_xfer_buffer;
 267         kfree(temp->kmalloc_ptr);
 268
 269         urb->transfer_flags &= ~URB_ALIGNED_TEMP_BUFFER;
 270 }
 271
 272 static int alloc_dma_aligned_buffer(struct urb *urb, gfp_t mem_flags)
 273 {
 274         struct dma_aligned_buffer *temp, *kmalloc_ptr;
 275         size_t kmalloc_size;
 276
 277         if (urb->num_sgs || urb->sg ||
 278             urb->transfer_buffer_length == 0 ||
 279             !((uintptr_t)urb->transfer_buffer & (TEGRA_USB_DMA_ALIGN - 1)))
 280                 return 0;
 281
 282         /* Allocate a buffer with enough padding for alignment */
 283         kmalloc_size = urb->transfer_buffer_length +
 284                 sizeof(struct dma_aligned_buffer) + TEGRA_USB_DMA_ALIGN - 1;
 285
 286         kmalloc_ptr = kmalloc(kmalloc_size, mem_flags);
 287         if (!kmalloc_ptr)
 288                 return -ENOMEM;
 289
 290         /* Position our struct dma_aligned_buffer such that data is aligned */
 291         temp = PTR_ALIGN(kmalloc_ptr + 1, TEGRA_USB_DMA_ALIGN) - 1;
 292         temp->kmalloc_ptr = kmalloc_ptr;
 293         temp->old_xfer_buffer = urb->transfer_buffer;
 294         if (usb_urb_dir_out(urb))
 295                 memcpy(temp->data, urb->transfer_buffer,
 296                        urb->transfer_buffer_length);
 297         urb->transfer_buffer = temp->data;
 298
 299         urb->transfer_flags |= URB_ALIGNED_TEMP_BUFFER;
 300
 301         return 0;
 302 }
 303
 304 static int tegra_ehci_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
 305                                       gfp_t mem_flags)
 306 {
 307         int ret;
 308
 309         ret = alloc_dma_aligned_buffer(urb, mem_flags);
 310         if (ret)
 311                 return ret;
 312
 313         ret = usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
 314         if (ret)
 315                 free_dma_aligned_buffer(urb);
 316
 317         return ret;
 318 }
 319
 320 static void tegra_ehci_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
 321 {
 322         usb_hcd_unmap_urb_for_dma(hcd, urb);
 323         free_dma_aligned_buffer(urb);
 324 }
 325
 326 static int setup_vbus_gpio(struct platform_device *pdev,
 327                            struct tegra_ehci_platform_data *pdata)
 328 {
 329         int err = 0;
 330         int gpio;
 331
 332         gpio = pdata->vbus_gpio;
 333         if (!gpio_is_valid(gpio))
 334                 gpio = of_get_named_gpio(pdev->dev.of_node,
 335                                          "nvidia,vbus-gpio", 0);
 336         if (!gpio_is_valid(gpio))
 337                 return 0;
 338
 339         err = gpio_request(gpio, "vbus_gpio");
 340         if (err) {
 341                 dev_err(&pdev->dev, "can't request vbus gpio %d", gpio);
 342                 return err;
 343         }
 344         err = gpio_direction_output(gpio, 1);
 345         if (err) {
 346                 dev_err(&pdev->dev, "can't enable vbus\n");
 347                 return err;
 348         }
 349
 350         return err;
 351 }
 352
 353 static int tegra_ehci_probe(struct platform_device *pdev)
 354 {
 355         struct resource *res;
 356         struct usb_hcd *hcd;
 357         struct tegra_ehci_hcd *tegra;
 358         struct tegra_ehci_platform_data *pdata;
 359         int err = 0;
 360         int irq;
 361         struct device_node *np_phy;
 362         struct usb_phy *u_phy;
 363
 364         pdata = pdev->dev.platform_data;
 365         if (!pdata) {
 366                 dev_err(&pdev->dev, "Platform data missing\n");
 367                 return -EINVAL;
 368         }
 369
 370         /* Right now device-tree probed devices don't get dma_mask set.
 371          * Since shared usb code relies on it, set it here for now.
 372          * Once we have dma capability bindings this can go away.
 373          */
 374         if (!pdev->dev.dma_mask)
 375                 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
 376         if (!pdev->dev.coherent_dma_mask)
 377                 pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
 378
 379         setup_vbus_gpio(pdev, pdata);
 380
 381         tegra = devm_kzalloc(&pdev->dev, sizeof(struct tegra_ehci_hcd),
 382                              GFP_KERNEL);
 383         if (!tegra)
 384                 return -ENOMEM;
 385
 386         tegra->clk = devm_clk_get(&pdev->dev, NULL);
 387         if (IS_ERR(tegra->clk)) {
 388                 dev_err(&pdev->dev, "Can't get ehci clock\n");
 389                 return PTR_ERR(tegra->clk);
 390         }
 391
 392         err = clk_prepare_enable(tegra->clk);
 393         if (err)
 394                 return err;
 395
 396         tegra_periph_reset_assert(tegra->clk);
 397         udelay(1);
 398         tegra_periph_reset_deassert(tegra->clk);
 399
 400         np_phy = of_parse_phandle(pdev->dev.of_node, "nvidia,phy", 0);
 401         if (!np_phy) {
 402                 err = -ENODEV;
 403                 goto cleanup_clk;
 404         }
 405
 406         u_phy = tegra_usb_get_phy(np_phy);
 407         if (IS_ERR(u_phy)) {
 408                 err = PTR_ERR(u_phy);
 409                 goto cleanup_clk;
 410         }
 411
 412         tegra->needs_double_reset = of_property_read_bool(pdev->dev.of_node,
 413                 "nvidia,needs-double-reset");
 414
 415         hcd = usb_create_hcd(&tegra_ehci_hc_driver, &pdev->dev,
 416                                         dev_name(&pdev->dev));
 417         if (!hcd) {
 418                 dev_err(&pdev->dev, "Unable to create HCD\n");
 419                 err = -ENOMEM;
 420                 goto cleanup_clk;
 421         }
 422         tegra->ehci = hcd_to_ehci(hcd);
 423
 424         hcd->has_tt = 1;
 425         hcd->phy = u_phy;
 426
 427         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 428         if (!res) {
 429                 dev_err(&pdev->dev, "Failed to get I/O memory\n");
 430                 err = -ENXIO;
 431                 goto cleanup_hcd_create;
 432         }
 433         hcd->rsrc_start = res->start;
 434         hcd->rsrc_len = resource_size(res);
 435         hcd->regs = devm_ioremap(&pdev->dev, res->start, resource_size(res));
 436         if (!hcd->regs) {
 437                 dev_err(&pdev->dev, "Failed to remap I/O memory\n");
 438                 err = -ENOMEM;
 439                 goto cleanup_hcd_create;
 440         }
 441         tegra->ehci->caps = hcd->regs + 0x100;
 442
 443         err = usb_phy_init(hcd->phy);
 444         if (err) {
 445                 dev_err(&pdev->dev, "Failed to initialize phy\n");
 446                 goto cleanup_hcd_create;
 447         }
 448
 449         u_phy->otg = devm_kzalloc(&pdev->dev, sizeof(struct usb_otg),
 450                              GFP_KERNEL);
 451         if (!u_phy->otg) {
 452                 dev_err(&pdev->dev, "Failed to alloc memory for otg\n");
 453                 err = -ENOMEM;
 454                 goto cleanup_phy;
 455         }
 456         u_phy->otg->host = hcd_to_bus(hcd);
 457
 458         err = usb_phy_set_suspend(hcd->phy, 0);
 459         if (err) {
 460                 dev_err(&pdev->dev, "Failed to power on the phy\n");
 461                 goto cleanup_phy;
 462         }
 463
 464         irq = platform_get_irq(pdev, 0);
 465         if (!irq) {
 466                 dev_err(&pdev->dev, "Failed to get IRQ\n");
 467                 err = -ENODEV;
 468                 goto cleanup_phy;
 469         }
 470
 471         if (pdata->operating_mode == TEGRA_USB_OTG) {
 472                 tegra->transceiver =
 473                         devm_usb_get_phy(&pdev->dev, USB_PHY_TYPE_USB2);
 474                 if (!IS_ERR(tegra->transceiver))
 475                         otg_set_host(tegra->transceiver->otg, &hcd->self);
 476         } else {
 477                 tegra->transceiver = ERR_PTR(-ENODEV);
 478         }
 479
 480         platform_set_drvdata(pdev, tegra);
 481
 482         err = usb_add_hcd(hcd, irq, IRQF_SHARED);
 483         if (err) {
 484                 dev_err(&pdev->dev, "Failed to add USB HCD\n");
 485                 goto cleanup_phy;
 486         }
 487
 488         return err;
 489
 490 cleanup_phy:
 491         if (!IS_ERR(tegra->transceiver))
 492                 otg_set_host(tegra->transceiver->otg, NULL);
 493
 494         usb_phy_shutdown(hcd->phy);
 495 cleanup_hcd_create:
 496         usb_put_hcd(hcd);
 497 cleanup_clk:
 498         clk_disable_unprepare(tegra->clk);
 499         return err;
 500 }
 501
 502 static int tegra_ehci_remove(struct platform_device *pdev)
 503 {
 504         struct tegra_ehci_hcd *tegra = platform_get_drvdata(pdev);
 505         struct usb_hcd *hcd = ehci_to_hcd(tegra->ehci);
 506
 507         if (!IS_ERR(tegra->transceiver))
 508                 otg_set_host(tegra->transceiver->otg, NULL);
 509
 510         usb_phy_shutdown(hcd->phy);
 511         usb_remove_hcd(hcd);
 512         usb_put_hcd(hcd);
 513
 514         clk_disable_unprepare(tegra->clk);
 515
 516         return 0;
 517 }
 518
 519 static void tegra_ehci_hcd_shutdown(struct platform_device *pdev)
 520 {
 521         struct tegra_ehci_hcd *tegra = platform_get_drvdata(pdev);
 522         struct usb_hcd *hcd = ehci_to_hcd(tegra->ehci);
 523
 524         if (hcd->driver->shutdown)
 525                 hcd->driver->shutdown(hcd);
 526 }
 527
 528 static struct of_device_id tegra_ehci_of_match[] = {
 529         { .compatible = "nvidia,tegra20-ehci", },
 530         { },
 531 };
 532
 533 static struct platform_driver tegra_ehci_driver = {
 534         .probe          = tegra_ehci_probe,
 535         .remove         = tegra_ehci_remove,
 536         .shutdown       = tegra_ehci_hcd_shutdown,
 537         .driver         = {
 538                 .name   = DRV_NAME,
 539                 .of_match_table = tegra_ehci_of_match,
 540         }
 541 };
 542
 543 static const struct ehci_driver_overrides tegra_overrides __initconst = {
 544         .extra_priv_size        = sizeof(struct tegra_ehci_hcd),
 545 };
 546
 547 static int __init ehci_tegra_init(void)
 548 {
 549         if (usb_disabled())
 550                 return -ENODEV;
 551
 552         pr_info(DRV_NAME ": " DRIVER_DESC "\n");
 553
 554         ehci_init_driver(&tegra_ehci_hc_driver, &tegra_overrides);
 555
 556         /*
 557          * The Tegra HW has some unusual quirks, which require Tegra-specific
 558          * workarounds. We override certain hc_driver functions here to
 559          * achieve that. We explicitly do not enhance ehci_driver_overrides to
 560          * allow this more easily, since this is an unusual case, and we don't
 561          * want to encourage others to override these functions by making it
 562          * too easy.
 563          */
 564
 565         orig_hub_control = tegra_ehci_hc_driver.hub_control;
 566
 567         tegra_ehci_hc_driver.map_urb_for_dma = tegra_ehci_map_urb_for_dma;
 568         tegra_ehci_hc_driver.unmap_urb_for_dma = tegra_ehci_unmap_urb_for_dma;
 569         tegra_ehci_hc_driver.hub_control = tegra_ehci_hub_control;
 570
 571         return platform_driver_register(&tegra_ehci_driver);
 572 }
 573 module_init(ehci_tegra_init);
 574
 575 static void __exit ehci_tegra_cleanup(void)
 576 {
 577         platform_driver_unregister(&tegra_ehci_driver);
 578 }
 579 module_exit(ehci_tegra_cleanup);
 580
 581 MODULE_DESCRIPTION(DRIVER_DESC);
 582 MODULE_LICENSE("GPL");
 583 MODULE_ALIAS("platform:" DRV_NAME);
 584 MODULE_DEVICE_TABLE(of, tegra_ehci_of_match);