drivers/usb/mtu3/mtu3_plat.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 2016 MediaTek Inc.
   4  *
   5  * Author: Chunfeng Yun <chunfeng.yun@mediatek.com>
   6  */
   7
   8 #include <linux/dma-mapping.h>
   9 #include <linux/iopoll.h>
  10 #include <linux/kernel.h>
  11 #include <linux/module.h>
  12 #include <linux/of_address.h>
  13 #include <linux/of_irq.h>
  14 #include <linux/platform_device.h>
  15 #include <linux/pm_wakeirq.h>
  16
  17 #include "mtu3.h"
  18 #include "mtu3_dr.h"
  19 #include "mtu3_debug.h"
  20
  21 /* u2-port0 should be powered on and enabled; */
  22 int ssusb_check_clocks(struct ssusb_mtk *ssusb, u32 ex_clks)
  23 {
  24         void __iomem *ibase = ssusb->ippc_base;
  25         u32 value, check_val;
  26         int ret;
  27
  28         check_val = ex_clks | SSUSB_SYS125_RST_B_STS | SSUSB_SYSPLL_STABLE |
  29                         SSUSB_REF_RST_B_STS;
  30
  31         ret = readl_poll_timeout(ibase + U3D_SSUSB_IP_PW_STS1, value,
  32                         (check_val == (value & check_val)), 100, 20000);
  33         if (ret) {
  34                 dev_err(ssusb->dev, "clks of sts1 are not stable!\n");
  35                 return ret;
  36         }
  37
  38         ret = readl_poll_timeout(ibase + U3D_SSUSB_IP_PW_STS2, value,
  39                         (value & SSUSB_U2_MAC_SYS_RST_B_STS), 100, 10000);
  40         if (ret) {
  41                 dev_err(ssusb->dev, "mac2 clock is not stable\n");
  42                 return ret;
  43         }
  44
  45         return 0;
  46 }
  47
  48 static int wait_for_ip_sleep(struct ssusb_mtk *ssusb)
  49 {
  50         bool sleep_check = true;
  51         u32 value;
  52         int ret;
  53
  54         if (!ssusb->is_host)
  55                 sleep_check = ssusb_gadget_ip_sleep_check(ssusb);
  56
  57         if (!sleep_check)
  58                 return 0;
  59
  60         /* wait for ip enter sleep mode */
  61         ret = readl_poll_timeout(ssusb->ippc_base + U3D_SSUSB_IP_PW_STS1, value,
  62                                  (value & SSUSB_IP_SLEEP_STS), 100, 100000);
  63         if (ret) {
  64                 dev_err(ssusb->dev, "ip sleep failed!!!\n");
  65                 ret = -EBUSY;
  66         }
  67
  68         return ret;
  69 }
  70
  71 static int ssusb_phy_init(struct ssusb_mtk *ssusb)
  72 {
  73         int i;
  74         int ret;
  75
  76         for (i = 0; i < ssusb->num_phys; i++) {
  77                 ret = phy_init(ssusb->phys[i]);
  78                 if (ret)
  79                         goto exit_phy;
  80         }
  81         return 0;
  82
  83 exit_phy:
  84         for (; i > 0; i--)
  85                 phy_exit(ssusb->phys[i - 1]);
  86
  87         return ret;
  88 }
  89
  90 static int ssusb_phy_exit(struct ssusb_mtk *ssusb)
  91 {
  92         int i;
  93
  94         for (i = 0; i < ssusb->num_phys; i++)
  95                 phy_exit(ssusb->phys[i]);
  96
  97         return 0;
  98 }
  99
 100 static int ssusb_phy_power_on(struct ssusb_mtk *ssusb)
 101 {
 102         int i;
 103         int ret;
 104
 105         for (i = 0; i < ssusb->num_phys; i++) {
 106                 ret = phy_power_on(ssusb->phys[i]);
 107                 if (ret)
 108                         goto power_off_phy;
 109         }
 110         return 0;
 111
 112 power_off_phy:
 113         for (; i > 0; i--)
 114                 phy_power_off(ssusb->phys[i - 1]);
 115
 116         return ret;
 117 }
 118
 119 static void ssusb_phy_power_off(struct ssusb_mtk *ssusb)
 120 {
 121         unsigned int i;
 122
 123         for (i = 0; i < ssusb->num_phys; i++)
 124                 phy_power_off(ssusb->phys[i]);
 125 }
 126
 127 static int ssusb_rscs_init(struct ssusb_mtk *ssusb)
 128 {
 129         int ret = 0;
 130
 131         ret = regulator_enable(ssusb->vusb33);
 132         if (ret) {
 133                 dev_err(ssusb->dev, "failed to enable vusb33\n");
 134                 goto vusb33_err;
 135         }
 136
 137         ret = clk_bulk_prepare_enable(BULK_CLKS_CNT, ssusb->clks);
 138         if (ret)
 139                 goto clks_err;
 140
 141         ret = ssusb_phy_init(ssusb);
 142         if (ret) {
 143                 dev_err(ssusb->dev, "failed to init phy\n");
 144                 goto phy_init_err;
 145         }
 146
 147         ret = ssusb_phy_power_on(ssusb);
 148         if (ret) {
 149                 dev_err(ssusb->dev, "failed to power on phy\n");
 150                 goto phy_err;
 151         }
 152
 153         return 0;
 154
 155 phy_err:
 156         ssusb_phy_exit(ssusb);
 157 phy_init_err:
 158         clk_bulk_disable_unprepare(BULK_CLKS_CNT, ssusb->clks);
 159 clks_err:
 160         regulator_disable(ssusb->vusb33);
 161 vusb33_err:
 162         return ret;
 163 }
 164
 165 static void ssusb_rscs_exit(struct ssusb_mtk *ssusb)
 166 {
 167         clk_bulk_disable_unprepare(BULK_CLKS_CNT, ssusb->clks);
 168         regulator_disable(ssusb->vusb33);
 169         ssusb_phy_power_off(ssusb);
 170         ssusb_phy_exit(ssusb);
 171 }
 172
 173 static void ssusb_ip_sw_reset(struct ssusb_mtk *ssusb)
 174 {
 175         /* reset whole ip (xhci & u3d) */
 176         mtu3_setbits(ssusb->ippc_base, U3D_SSUSB_IP_PW_CTRL0, SSUSB_IP_SW_RST);
 177         udelay(1);
 178         mtu3_clrbits(ssusb->ippc_base, U3D_SSUSB_IP_PW_CTRL0, SSUSB_IP_SW_RST);
 179
 180         /*
 181          * device ip may be powered on in firmware/BROM stage before entering
 182          * kernel stage;
 183          * power down device ip, otherwise ip-sleep will fail when working as
 184          * host only mode
 185          */
 186         mtu3_setbits(ssusb->ippc_base, U3D_SSUSB_IP_PW_CTRL2, SSUSB_IP_DEV_PDN);
 187 }
 188
 189 static int get_ssusb_rscs(struct platform_device *pdev, struct ssusb_mtk *ssusb)
 190 {
 191         struct device_node *node = pdev->dev.of_node;
 192         struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
 193         struct clk_bulk_data *clks = ssusb->clks;
 194         struct device *dev = &pdev->dev;
 195         int i;
 196         int ret;
 197
 198         ssusb->vusb33 = devm_regulator_get(dev, "vusb33");
 199         if (IS_ERR(ssusb->vusb33)) {
 200                 dev_err(dev, "failed to get vusb33\n");
 201                 return PTR_ERR(ssusb->vusb33);
 202         }
 203
 204         clks[0].id = "sys_ck";
 205         clks[1].id = "ref_ck";
 206         clks[2].id = "mcu_ck";
 207         clks[3].id = "dma_ck";
 208         ret = devm_clk_bulk_get_optional(dev, BULK_CLKS_CNT, clks);
 209         if (ret)
 210                 return ret;
 211
 212         ssusb->num_phys = of_count_phandle_with_args(node,
 213                         "phys", "#phy-cells");
 214         if (ssusb->num_phys > 0) {
 215                 ssusb->phys = devm_kcalloc(dev, ssusb->num_phys,
 216                                         sizeof(*ssusb->phys), GFP_KERNEL);
 217                 if (!ssusb->phys)
 218                         return -ENOMEM;
 219         } else {
 220                 ssusb->num_phys = 0;
 221         }
 222
 223         for (i = 0; i < ssusb->num_phys; i++) {
 224                 ssusb->phys[i] = devm_of_phy_get_by_index(dev, node, i);
 225                 if (IS_ERR(ssusb->phys[i])) {
 226                         dev_err(dev, "failed to get phy-%d\n", i);
 227                         return PTR_ERR(ssusb->phys[i]);
 228                 }
 229         }
 230
 231         ssusb->ippc_base = devm_platform_ioremap_resource_byname(pdev, "ippc");
 232         if (IS_ERR(ssusb->ippc_base))
 233                 return PTR_ERR(ssusb->ippc_base);
 234
 235         ssusb->wakeup_irq = platform_get_irq_byname_optional(pdev, "wakeup");
 236         if (ssusb->wakeup_irq == -EPROBE_DEFER)
 237                 return ssusb->wakeup_irq;
 238
 239         ssusb->dr_mode = usb_get_dr_mode(dev);
 240         if (ssusb->dr_mode == USB_DR_MODE_UNKNOWN)
 241                 ssusb->dr_mode = USB_DR_MODE_OTG;
 242
 243         if (ssusb->dr_mode == USB_DR_MODE_PERIPHERAL)
 244                 goto out;
 245
 246         /* if host role is supported */
 247         ret = ssusb_wakeup_of_property_parse(ssusb, node);
 248         if (ret) {
 249                 dev_err(dev, "failed to parse uwk property\n");
 250                 return ret;
 251         }
 252
 253         /* optional property, ignore the error if it does not exist */
 254         of_property_read_u32(node, "mediatek,u3p-dis-msk",
 255                              &ssusb->u3p_dis_msk);
 256         of_property_read_u32(node, "mediatek,u2p-dis-msk",
 257                              &ssusb->u2p_dis_msk);
 258
 259         otg_sx->vbus = devm_regulator_get(dev, "vbus");
 260         if (IS_ERR(otg_sx->vbus)) {
 261                 dev_err(dev, "failed to get vbus\n");
 262                 return PTR_ERR(otg_sx->vbus);
 263         }
 264
 265         if (ssusb->dr_mode == USB_DR_MODE_HOST)
 266                 goto out;
 267
 268         /* if dual-role mode is supported */
 269         otg_sx->is_u3_drd = of_property_read_bool(node, "mediatek,usb3-drd");
 270         otg_sx->manual_drd_enabled =
 271                 of_property_read_bool(node, "enable-manual-drd");
 272         otg_sx->role_sw_used = of_property_read_bool(node, "usb-role-switch");
 273
 274         /* can't disable port0 when use dual-role mode */
 275         ssusb->u2p_dis_msk &= ~0x1;
 276
 277         if (otg_sx->role_sw_used || otg_sx->manual_drd_enabled)
 278                 goto out;
 279
 280         if (of_property_read_bool(node, "extcon")) {
 281                 otg_sx->edev = extcon_get_edev_by_phandle(ssusb->dev, 0);
 282                 if (IS_ERR(otg_sx->edev)) {
 283                         return dev_err_probe(dev, PTR_ERR(otg_sx->edev),
 284                                              "couldn't get extcon device\n");
 285                 }
 286         }
 287
 288 out:
 289         dev_info(dev, "dr_mode: %d, is_u3_dr: %d, drd: %s\n",
 290                  ssusb->dr_mode, otg_sx->is_u3_drd,
 291                 otg_sx->manual_drd_enabled ? "manual" : "auto");
 292         dev_info(dev, "u2p_dis_msk: %x, u3p_dis_msk: %x\n",
 293                  ssusb->u2p_dis_msk, ssusb->u3p_dis_msk);
 294
 295         return 0;
 296 }
 297
 298 static int mtu3_probe(struct platform_device *pdev)
 299 {
 300         struct device_node *node = pdev->dev.of_node;
 301         struct device *dev = &pdev->dev;
 302         struct ssusb_mtk *ssusb;
 303         int ret = -ENOMEM;
 304
 305         /* all elements are set to ZERO as default value */
 306         ssusb = devm_kzalloc(dev, sizeof(*ssusb), GFP_KERNEL);
 307         if (!ssusb)
 308                 return -ENOMEM;
 309
 310         ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
 311         if (ret) {
 312                 dev_err(dev, "No suitable DMA config available\n");
 313                 return -ENOTSUPP;
 314         }
 315
 316         platform_set_drvdata(pdev, ssusb);
 317         ssusb->dev = dev;
 318
 319         ret = get_ssusb_rscs(pdev, ssusb);
 320         if (ret)
 321                 return ret;
 322
 323         ssusb_debugfs_create_root(ssusb);
 324
 325         /* enable power domain */
 326         pm_runtime_set_active(dev);
 327         pm_runtime_use_autosuspend(dev);
 328         pm_runtime_set_autosuspend_delay(dev, 4000);
 329         pm_runtime_enable(dev);
 330         pm_runtime_get_sync(dev);
 331
 332         ret = ssusb_rscs_init(ssusb);
 333         if (ret)
 334                 goto comm_init_err;
 335
 336         if (ssusb->wakeup_irq > 0) {
 337                 ret = dev_pm_set_dedicated_wake_irq(dev, ssusb->wakeup_irq);
 338                 if (ret) {
 339                         dev_err(dev, "failed to set wakeup irq %d\n", ssusb->wakeup_irq);
 340                         goto comm_exit;
 341                 }
 342                 dev_info(dev, "wakeup irq %d\n", ssusb->wakeup_irq);
 343         }
 344
 345         ssusb_ip_sw_reset(ssusb);
 346
 347         if (IS_ENABLED(CONFIG_USB_MTU3_HOST))
 348                 ssusb->dr_mode = USB_DR_MODE_HOST;
 349         else if (IS_ENABLED(CONFIG_USB_MTU3_GADGET))
 350                 ssusb->dr_mode = USB_DR_MODE_PERIPHERAL;
 351
 352         /* default as host */
 353         ssusb->is_host = !(ssusb->dr_mode == USB_DR_MODE_PERIPHERAL);
 354
 355         switch (ssusb->dr_mode) {
 356         case USB_DR_MODE_PERIPHERAL:
 357                 ret = ssusb_gadget_init(ssusb);
 358                 if (ret) {
 359                         dev_err(dev, "failed to initialize gadget\n");
 360                         goto comm_exit;
 361                 }
 362                 break;
 363         case USB_DR_MODE_HOST:
 364                 ret = ssusb_host_init(ssusb, node);
 365                 if (ret) {
 366                         dev_err(dev, "failed to initialize host\n");
 367                         goto comm_exit;
 368                 }
 369                 break;
 370         case USB_DR_MODE_OTG:
 371                 ret = ssusb_gadget_init(ssusb);
 372                 if (ret) {
 373                         dev_err(dev, "failed to initialize gadget\n");
 374                         goto comm_exit;
 375                 }
 376
 377                 ret = ssusb_host_init(ssusb, node);
 378                 if (ret) {
 379                         dev_err(dev, "failed to initialize host\n");
 380                         goto gadget_exit;
 381                 }
 382
 383                 ret = ssusb_otg_switch_init(ssusb);
 384                 if (ret) {
 385                         dev_err(dev, "failed to initialize switch\n");
 386                         goto host_exit;
 387                 }
 388                 break;
 389         default:
 390                 dev_err(dev, "unsupported mode: %d\n", ssusb->dr_mode);
 391                 ret = -EINVAL;
 392                 goto comm_exit;
 393         }
 394
 395         device_enable_async_suspend(dev);
 396         pm_runtime_mark_last_busy(dev);
 397         pm_runtime_put_autosuspend(dev);
 398         pm_runtime_forbid(dev);
 399
 400         return 0;
 401
 402 host_exit:
 403         ssusb_host_exit(ssusb);
 404 gadget_exit:
 405         ssusb_gadget_exit(ssusb);
 406 comm_exit:
 407         ssusb_rscs_exit(ssusb);
 408 comm_init_err:
 409         pm_runtime_put_noidle(dev);
 410         pm_runtime_disable(dev);
 411         ssusb_debugfs_remove_root(ssusb);
 412
 413         return ret;
 414 }
 415
 416 static int mtu3_remove(struct platform_device *pdev)
 417 {
 418         struct ssusb_mtk *ssusb = platform_get_drvdata(pdev);
 419
 420         pm_runtime_get_sync(&pdev->dev);
 421
 422         switch (ssusb->dr_mode) {
 423         case USB_DR_MODE_PERIPHERAL:
 424                 ssusb_gadget_exit(ssusb);
 425                 break;
 426         case USB_DR_MODE_HOST:
 427                 ssusb_host_exit(ssusb);
 428                 break;
 429         case USB_DR_MODE_OTG:
 430                 ssusb_otg_switch_exit(ssusb);
 431                 ssusb_gadget_exit(ssusb);
 432                 ssusb_host_exit(ssusb);
 433                 break;
 434         default:
 435                 return -EINVAL;
 436         }
 437
 438         ssusb_rscs_exit(ssusb);
 439         ssusb_debugfs_remove_root(ssusb);
 440         pm_runtime_disable(&pdev->dev);
 441         pm_runtime_put_noidle(&pdev->dev);
 442         pm_runtime_set_suspended(&pdev->dev);
 443
 444         return 0;
 445 }
 446
 447 static int resume_ip_and_ports(struct ssusb_mtk *ssusb, pm_message_t msg)
 448 {
 449         switch (ssusb->dr_mode) {
 450         case USB_DR_MODE_PERIPHERAL:
 451                 ssusb_gadget_resume(ssusb, msg);
 452                 break;
 453         case USB_DR_MODE_HOST:
 454                 ssusb_host_resume(ssusb, false);
 455                 break;
 456         case USB_DR_MODE_OTG:
 457                 ssusb_host_resume(ssusb, !ssusb->is_host);
 458                 if (!ssusb->is_host)
 459                         ssusb_gadget_resume(ssusb, msg);
 460
 461                 break;
 462         default:
 463                 return -EINVAL;
 464         }
 465
 466         return 0;
 467 }
 468
 469 static int mtu3_suspend_common(struct device *dev, pm_message_t msg)
 470 {
 471         struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
 472         int ret = 0;
 473
 474         dev_dbg(dev, "%s\n", __func__);
 475
 476         switch (ssusb->dr_mode) {
 477         case USB_DR_MODE_PERIPHERAL:
 478                 ret = ssusb_gadget_suspend(ssusb, msg);
 479                 if (ret)
 480                         goto err;
 481
 482                 break;
 483         case USB_DR_MODE_HOST:
 484                 ssusb_host_suspend(ssusb);
 485                 break;
 486         case USB_DR_MODE_OTG:
 487                 if (!ssusb->is_host) {
 488                         ret = ssusb_gadget_suspend(ssusb, msg);
 489                         if (ret)
 490                                 goto err;
 491                 }
 492                 ssusb_host_suspend(ssusb);
 493                 break;
 494         default:
 495                 return -EINVAL;
 496         }
 497
 498         ret = wait_for_ip_sleep(ssusb);
 499         if (ret)
 500                 goto sleep_err;
 501
 502         ssusb_phy_power_off(ssusb);
 503         clk_bulk_disable_unprepare(BULK_CLKS_CNT, ssusb->clks);
 504         ssusb_wakeup_set(ssusb, true);
 505         return 0;
 506
 507 sleep_err:
 508         resume_ip_and_ports(ssusb, msg);
 509 err:
 510         return ret;
 511 }
 512
 513 static int mtu3_resume_common(struct device *dev, pm_message_t msg)
 514 {
 515         struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
 516         int ret;
 517
 518         dev_dbg(dev, "%s\n", __func__);
 519
 520         ssusb_wakeup_set(ssusb, false);
 521         ret = clk_bulk_prepare_enable(BULK_CLKS_CNT, ssusb->clks);
 522         if (ret)
 523                 goto clks_err;
 524
 525         ret = ssusb_phy_power_on(ssusb);
 526         if (ret)
 527                 goto phy_err;
 528
 529         return resume_ip_and_ports(ssusb, msg);
 530
 531 phy_err:
 532         clk_bulk_disable_unprepare(BULK_CLKS_CNT, ssusb->clks);
 533 clks_err:
 534         return ret;
 535 }
 536
 537 static int __maybe_unused mtu3_suspend(struct device *dev)
 538 {
 539         return mtu3_suspend_common(dev, PMSG_SUSPEND);
 540 }
 541
 542 static int __maybe_unused mtu3_resume(struct device *dev)
 543 {
 544         return mtu3_resume_common(dev, PMSG_SUSPEND);
 545 }
 546
 547 static int __maybe_unused mtu3_runtime_suspend(struct device *dev)
 548 {
 549         if (!device_may_wakeup(dev))
 550                 return 0;
 551
 552         return mtu3_suspend_common(dev, PMSG_AUTO_SUSPEND);
 553 }
 554
 555 static int __maybe_unused mtu3_runtime_resume(struct device *dev)
 556 {
 557         if (!device_may_wakeup(dev))
 558                 return 0;
 559
 560         return mtu3_resume_common(dev, PMSG_AUTO_SUSPEND);
 561 }
 562
 563 static const struct dev_pm_ops mtu3_pm_ops = {
 564         SET_SYSTEM_SLEEP_PM_OPS(mtu3_suspend, mtu3_resume)
 565         SET_RUNTIME_PM_OPS(mtu3_runtime_suspend,
 566                            mtu3_runtime_resume, NULL)
 567 };
 568
 569 #define DEV_PM_OPS (IS_ENABLED(CONFIG_PM) ? &mtu3_pm_ops : NULL)
 570
 571 static const struct of_device_id mtu3_of_match[] = {
 572         {.compatible = "mediatek,mt8173-mtu3",},
 573         {.compatible = "mediatek,mtu3",},
 574         {},
 575 };
 576 MODULE_DEVICE_TABLE(of, mtu3_of_match);
 577
 578 static struct platform_driver mtu3_driver = {
 579         .probe = mtu3_probe,
 580         .remove = mtu3_remove,
 581         .driver = {
 582                 .name = MTU3_DRIVER_NAME,
 583                 .pm = DEV_PM_OPS,
 584                 .of_match_table = mtu3_of_match,
 585         },
 586 };
 587 module_platform_driver(mtu3_driver);
 588
 589 MODULE_AUTHOR("Chunfeng Yun <chunfeng.yun@mediatek.com>");
 590 MODULE_LICENSE("GPL v2");
 591 MODULE_DESCRIPTION("MediaTek USB3 DRD Controller Driver");