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