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