drivers/usb/dwc2/platform.c

   1 /*
   2  * platform.c - DesignWare HS OTG Controller platform driver
   3  *
   4  * Copyright (C) Matthijs Kooijman <matthijs@stdin.nl>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions, and the following disclaimer,
  11  *    without modification.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The names of the above-listed copyright holders may not be used
  16  *    to endorse or promote products derived from this software without
  17  *    specific prior written permission.
  18  *
  19  * ALTERNATIVELY, this software may be distributed under the terms of the
  20  * GNU General Public License ("GPL") as published by the Free Software
  21  * Foundation; either version 2 of the License, or (at your option) any
  22  * later version.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  25  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  26  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  27  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  29  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  30  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  31  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  32  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  33  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  34  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #include <linux/kernel.h>
  38 #include <linux/module.h>
  39 #include <linux/slab.h>
  40 #include <linux/clk.h>
  41 #include <linux/device.h>
  42 #include <linux/dma-mapping.h>
  43 #include <linux/of_device.h>
  44 #include <linux/mutex.h>
  45 #include <linux/platform_device.h>
  46 #include <linux/phy/phy.h>
  47 #include <linux/platform_data/s3c-hsotg.h>
  48 #include <linux/reset.h>
  49
  50 #include <linux/usb/of.h>
  51
  52 #include "core.h"
  53 #include "hcd.h"
  54 #include "debug.h"
  55
  56 static const char dwc2_driver_name[] = "dwc2";
  57
  58 /*
  59  * Check the dr_mode against the module configuration and hardware
  60  * capabilities.
  61  *
  62  * The hardware, module, and dr_mode, can each be set to host, device,
  63  * or otg. Check that all these values are compatible and adjust the
  64  * value of dr_mode if possible.
  65  *
  66  *                      actual
  67  *    HW  MOD dr_mode   dr_mode
  68  *  ------------------------------
  69  *   HST  HST  any    :  HST
  70  *   HST  DEV  any    :  ---
  71  *   HST  OTG  any    :  HST
  72  *
  73  *   DEV  HST  any    :  ---
  74  *   DEV  DEV  any    :  DEV
  75  *   DEV  OTG  any    :  DEV
  76  *
  77  *   OTG  HST  any    :  HST
  78  *   OTG  DEV  any    :  DEV
  79  *   OTG  OTG  any    :  dr_mode
  80  */
  81 static int dwc2_get_dr_mode(struct dwc2_hsotg *hsotg)
  82 {
  83         enum usb_dr_mode mode;
  84
  85         hsotg->dr_mode = usb_get_dr_mode(hsotg->dev);
  86         if (hsotg->dr_mode == USB_DR_MODE_UNKNOWN)
  87                 hsotg->dr_mode = USB_DR_MODE_OTG;
  88
  89         mode = hsotg->dr_mode;
  90
  91         if (dwc2_hw_is_device(hsotg)) {
  92                 if (IS_ENABLED(CONFIG_USB_DWC2_HOST)) {
  93                         dev_err(hsotg->dev,
  94                                 "Controller does not support host mode.\n");
  95                         return -EINVAL;
  96                 }
  97                 mode = USB_DR_MODE_PERIPHERAL;
  98         } else if (dwc2_hw_is_host(hsotg)) {
  99                 if (IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL)) {
 100                         dev_err(hsotg->dev,
 101                                 "Controller does not support device mode.\n");
 102                         return -EINVAL;
 103                 }
 104                 mode = USB_DR_MODE_HOST;
 105         } else {
 106                 if (IS_ENABLED(CONFIG_USB_DWC2_HOST))
 107                         mode = USB_DR_MODE_HOST;
 108                 else if (IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL))
 109                         mode = USB_DR_MODE_PERIPHERAL;
 110         }
 111
 112         if (mode != hsotg->dr_mode) {
 113                 dev_warn(hsotg->dev,
 114                          "Configuration mismatch. dr_mode forced to %s\n",
 115                         mode == USB_DR_MODE_HOST ? "host" : "device");
 116
 117                 hsotg->dr_mode = mode;
 118         }
 119
 120         return 0;
 121 }
 122
 123 static int __dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg)
 124 {
 125         struct platform_device *pdev = to_platform_device(hsotg->dev);
 126         int ret;
 127
 128         ret = regulator_bulk_enable(ARRAY_SIZE(hsotg->supplies),
 129                                     hsotg->supplies);
 130         if (ret)
 131                 return ret;
 132
 133         if (hsotg->clk) {
 134                 ret = clk_prepare_enable(hsotg->clk);
 135                 if (ret)
 136                         return ret;
 137         }
 138
 139         if (hsotg->uphy) {
 140                 ret = usb_phy_init(hsotg->uphy);
 141         } else if (hsotg->plat && hsotg->plat->phy_init) {
 142                 ret = hsotg->plat->phy_init(pdev, hsotg->plat->phy_type);
 143         } else {
 144                 ret = phy_power_on(hsotg->phy);
 145                 if (ret == 0)
 146                         ret = phy_init(hsotg->phy);
 147         }
 148
 149         return ret;
 150 }
 151
 152 /**
 153  * dwc2_lowlevel_hw_enable - enable platform lowlevel hw resources
 154  * @hsotg: The driver state
 155  *
 156  * A wrapper for platform code responsible for controlling
 157  * low-level USB platform resources (phy, clock, regulators)
 158  */
 159 int dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg)
 160 {
 161         int ret = __dwc2_lowlevel_hw_enable(hsotg);
 162
 163         if (ret == 0)
 164                 hsotg->ll_hw_enabled = true;
 165         return ret;
 166 }
 167
 168 static int __dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg)
 169 {
 170         struct platform_device *pdev = to_platform_device(hsotg->dev);
 171         int ret = 0;
 172
 173         if (hsotg->uphy) {
 174                 usb_phy_shutdown(hsotg->uphy);
 175         } else if (hsotg->plat && hsotg->plat->phy_exit) {
 176                 ret = hsotg->plat->phy_exit(pdev, hsotg->plat->phy_type);
 177         } else {
 178                 ret = phy_exit(hsotg->phy);
 179                 if (ret == 0)
 180                         ret = phy_power_off(hsotg->phy);
 181         }
 182         if (ret)
 183                 return ret;
 184
 185         if (hsotg->clk)
 186                 clk_disable_unprepare(hsotg->clk);
 187
 188         ret = regulator_bulk_disable(ARRAY_SIZE(hsotg->supplies),
 189                                      hsotg->supplies);
 190
 191         return ret;
 192 }
 193
 194 /**
 195  * dwc2_lowlevel_hw_disable - disable platform lowlevel hw resources
 196  * @hsotg: The driver state
 197  *
 198  * A wrapper for platform code responsible for controlling
 199  * low-level USB platform resources (phy, clock, regulators)
 200  */
 201 int dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg)
 202 {
 203         int ret = __dwc2_lowlevel_hw_disable(hsotg);
 204
 205         if (ret == 0)
 206                 hsotg->ll_hw_enabled = false;
 207         return ret;
 208 }
 209
 210 static int dwc2_lowlevel_hw_init(struct dwc2_hsotg *hsotg)
 211 {
 212         int i, ret;
 213
 214         hsotg->reset = devm_reset_control_get_optional(hsotg->dev, "dwc2");
 215         if (IS_ERR(hsotg->reset)) {
 216                 ret = PTR_ERR(hsotg->reset);
 217                 dev_err(hsotg->dev, "error getting reset control %d\n", ret);
 218                 return ret;
 219         }
 220
 221         reset_control_deassert(hsotg->reset);
 222
 223         /* Set default UTMI width */
 224         hsotg->phyif = GUSBCFG_PHYIF16;
 225
 226         /*
 227          * Attempt to find a generic PHY, then look for an old style
 228          * USB PHY and then fall back to pdata
 229          */
 230         hsotg->phy = devm_phy_get(hsotg->dev, "usb2-phy");
 231         if (IS_ERR(hsotg->phy)) {
 232                 ret = PTR_ERR(hsotg->phy);
 233                 switch (ret) {
 234                 case -ENODEV:
 235                 case -ENOSYS:
 236                         hsotg->phy = NULL;
 237                         break;
 238                 case -EPROBE_DEFER:
 239                         return ret;
 240                 default:
 241                         dev_err(hsotg->dev, "error getting phy %d\n", ret);
 242                         return ret;
 243                 }
 244         }
 245
 246         if (!hsotg->phy) {
 247                 hsotg->uphy = devm_usb_get_phy(hsotg->dev, USB_PHY_TYPE_USB2);
 248                 if (IS_ERR(hsotg->uphy)) {
 249                         ret = PTR_ERR(hsotg->uphy);
 250                         switch (ret) {
 251                         case -ENODEV:
 252                         case -ENXIO:
 253                                 hsotg->uphy = NULL;
 254                                 break;
 255                         case -EPROBE_DEFER:
 256                                 return ret;
 257                         default:
 258                                 dev_err(hsotg->dev, "error getting usb phy %d\n",
 259                                         ret);
 260                                 return ret;
 261                         }
 262                 }
 263         }
 264
 265         hsotg->plat = dev_get_platdata(hsotg->dev);
 266
 267         if (hsotg->phy) {
 268                 /*
 269                  * If using the generic PHY framework, check if the PHY bus
 270                  * width is 8-bit and set the phyif appropriately.
 271                  */
 272                 if (phy_get_bus_width(hsotg->phy) == 8)
 273                         hsotg->phyif = GUSBCFG_PHYIF8;
 274         }
 275
 276         /* Clock */
 277         hsotg->clk = devm_clk_get(hsotg->dev, "otg");
 278         if (IS_ERR(hsotg->clk)) {
 279                 hsotg->clk = NULL;
 280                 dev_dbg(hsotg->dev, "cannot get otg clock\n");
 281         }
 282
 283         /* Regulators */
 284         for (i = 0; i < ARRAY_SIZE(hsotg->supplies); i++)
 285                 hsotg->supplies[i].supply = dwc2_hsotg_supply_names[i];
 286
 287         ret = devm_regulator_bulk_get(hsotg->dev, ARRAY_SIZE(hsotg->supplies),
 288                                       hsotg->supplies);
 289         if (ret) {
 290                 dev_err(hsotg->dev, "failed to request supplies: %d\n", ret);
 291                 return ret;
 292         }
 293         return 0;
 294 }
 295
 296 /**
 297  * dwc2_driver_remove() - Called when the DWC_otg core is unregistered with the
 298  * DWC_otg driver
 299  *
 300  * @dev: Platform device
 301  *
 302  * This routine is called, for example, when the rmmod command is executed. The
 303  * device may or may not be electrically present. If it is present, the driver
 304  * stops device processing. Any resources used on behalf of this device are
 305  * freed.
 306  */
 307 static int dwc2_driver_remove(struct platform_device *dev)
 308 {
 309         struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
 310
 311         dwc2_debugfs_exit(hsotg);
 312         if (hsotg->hcd_enabled)
 313                 dwc2_hcd_remove(hsotg);
 314         if (hsotg->gadget_enabled)
 315                 dwc2_hsotg_remove(hsotg);
 316
 317         if (hsotg->ll_hw_enabled)
 318                 dwc2_lowlevel_hw_disable(hsotg);
 319
 320         reset_control_assert(hsotg->reset);
 321
 322         return 0;
 323 }
 324
 325 /**
 326  * dwc2_driver_shutdown() - Called on device shutdown
 327  *
 328  * @dev: Platform device
 329  *
 330  * In specific conditions (involving usb hubs) dwc2 devices can create a
 331  * lot of interrupts, even to the point of overwhelming devices running
 332  * at low frequencies. Some devices need to do special clock handling
 333  * at shutdown-time which may bring the system clock below the threshold
 334  * of being able to handle the dwc2 interrupts. Disabling dwc2-irqs
 335  * prevents reboots/poweroffs from getting stuck in such cases.
 336  */
 337 static void dwc2_driver_shutdown(struct platform_device *dev)
 338 {
 339         struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
 340
 341         dwc2_disable_global_interrupts(hsotg);
 342         synchronize_irq(hsotg->irq);
 343 }
 344
 345 /**
 346  * dwc2_driver_probe() - Called when the DWC_otg core is bound to the DWC_otg
 347  * driver
 348  *
 349  * @dev: Platform device
 350  *
 351  * This routine creates the driver components required to control the device
 352  * (core, HCD, and PCD) and initializes the device. The driver components are
 353  * stored in a dwc2_hsotg structure. A reference to the dwc2_hsotg is saved
 354  * in the device private data. This allows the driver to access the dwc2_hsotg
 355  * structure on subsequent calls to driver methods for this device.
 356  */
 357 static int dwc2_driver_probe(struct platform_device *dev)
 358 {
 359         struct dwc2_hsotg *hsotg;
 360         struct resource *res;
 361         int retval;
 362
 363         hsotg = devm_kzalloc(&dev->dev, sizeof(*hsotg), GFP_KERNEL);
 364         if (!hsotg)
 365                 return -ENOMEM;
 366
 367         hsotg->dev = &dev->dev;
 368
 369         /*
 370          * Use reasonable defaults so platforms don't have to provide these.
 371          */
 372         if (!dev->dev.dma_mask)
 373                 dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
 374         retval = dma_set_coherent_mask(&dev->dev, DMA_BIT_MASK(32));
 375         if (retval)
 376                 return retval;
 377
 378         res = platform_get_resource(dev, IORESOURCE_MEM, 0);
 379         hsotg->regs = devm_ioremap_resource(&dev->dev, res);
 380         if (IS_ERR(hsotg->regs))
 381                 return PTR_ERR(hsotg->regs);
 382
 383         dev_dbg(&dev->dev, "mapped PA %08lx to VA %p\n",
 384                 (unsigned long)res->start, hsotg->regs);
 385
 386         retval = dwc2_lowlevel_hw_init(hsotg);
 387         if (retval)
 388                 return retval;
 389
 390         spin_lock_init(&hsotg->lock);
 391
 392         hsotg->irq = platform_get_irq(dev, 0);
 393         if (hsotg->irq < 0) {
 394                 dev_err(&dev->dev, "missing IRQ resource\n");
 395                 return hsotg->irq;
 396         }
 397
 398         dev_dbg(hsotg->dev, "registering common handler for irq%d\n",
 399                 hsotg->irq);
 400         retval = devm_request_irq(hsotg->dev, hsotg->irq,
 401                                   dwc2_handle_common_intr, IRQF_SHARED,
 402                                   dev_name(hsotg->dev), hsotg);
 403         if (retval)
 404                 return retval;
 405
 406         retval = dwc2_lowlevel_hw_enable(hsotg);
 407         if (retval)
 408                 return retval;
 409
 410         retval = dwc2_get_dr_mode(hsotg);
 411         if (retval)
 412                 goto error;
 413
 414         /*
 415          * Reset before dwc2_get_hwparams() then it could get power-on real
 416          * reset value form registers.
 417          */
 418         dwc2_core_reset_and_force_dr_mode(hsotg);
 419
 420         /* Detect config values from hardware */
 421         retval = dwc2_get_hwparams(hsotg);
 422         if (retval)
 423                 goto error;
 424
 425         dwc2_force_dr_mode(hsotg);
 426
 427         retval = dwc2_init_params(hsotg);
 428         if (retval)
 429                 goto error;
 430
 431         if (hsotg->dr_mode != USB_DR_MODE_HOST) {
 432                 retval = dwc2_gadget_init(hsotg, hsotg->irq);
 433                 if (retval)
 434                         goto error;
 435                 hsotg->gadget_enabled = 1;
 436         }
 437
 438         if (hsotg->dr_mode != USB_DR_MODE_PERIPHERAL) {
 439                 retval = dwc2_hcd_init(hsotg);
 440                 if (retval) {
 441                         if (hsotg->gadget_enabled)
 442                                 dwc2_hsotg_remove(hsotg);
 443                         goto error;
 444                 }
 445                 hsotg->hcd_enabled = 1;
 446         }
 447
 448         platform_set_drvdata(dev, hsotg);
 449
 450         dwc2_debugfs_init(hsotg);
 451
 452         /* Gadget code manages lowlevel hw on its own */
 453         if (hsotg->dr_mode == USB_DR_MODE_PERIPHERAL)
 454                 dwc2_lowlevel_hw_disable(hsotg);
 455
 456 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
 457         IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
 458         /* Postponed adding a new gadget to the udc class driver list */
 459         if (hsotg->gadget_enabled) {
 460                 retval = usb_add_gadget_udc(hsotg->dev, &hsotg->gadget);
 461                 if (retval) {
 462                         hsotg->gadget.udc = NULL;
 463                         dwc2_hsotg_remove(hsotg);
 464                         goto error;
 465                 }
 466         }
 467 #endif /* CONFIG_USB_DWC2_PERIPHERAL || CONFIG_USB_DWC2_DUAL_ROLE */
 468         return 0;
 469
 470 error:
 471         if (hsotg->dr_mode != USB_DR_MODE_PERIPHERAL)
 472                 dwc2_lowlevel_hw_disable(hsotg);
 473         return retval;
 474 }
 475
 476 static int __maybe_unused dwc2_suspend(struct device *dev)
 477 {
 478         struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
 479         int ret = 0;
 480
 481         if (dwc2_is_device_mode(dwc2))
 482                 dwc2_hsotg_suspend(dwc2);
 483
 484         if (dwc2->ll_hw_enabled)
 485                 ret = __dwc2_lowlevel_hw_disable(dwc2);
 486
 487         return ret;
 488 }
 489
 490 static int __maybe_unused dwc2_resume(struct device *dev)
 491 {
 492         struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
 493         int ret = 0;
 494
 495         if (dwc2->ll_hw_enabled) {
 496                 ret = __dwc2_lowlevel_hw_enable(dwc2);
 497                 if (ret)
 498                         return ret;
 499         }
 500
 501         if (dwc2_is_device_mode(dwc2))
 502                 ret = dwc2_hsotg_resume(dwc2);
 503
 504         return ret;
 505 }
 506
 507 static const struct dev_pm_ops dwc2_dev_pm_ops = {
 508         SET_SYSTEM_SLEEP_PM_OPS(dwc2_suspend, dwc2_resume)
 509 };
 510
 511 static struct platform_driver dwc2_platform_driver = {
 512         .driver = {
 513                 .name = dwc2_driver_name,
 514                 .of_match_table = dwc2_of_match_table,
 515                 .pm = &dwc2_dev_pm_ops,
 516         },
 517         .probe = dwc2_driver_probe,
 518         .remove = dwc2_driver_remove,
 519         .shutdown = dwc2_driver_shutdown,
 520 };
 521
 522 module_platform_driver(dwc2_platform_driver);
 523
 524 MODULE_DESCRIPTION("DESIGNWARE HS OTG Platform Glue");
 525 MODULE_AUTHOR("Matthijs Kooijman <matthijs@stdin.nl>");
 526 MODULE_LICENSE("Dual BSD/GPL");