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 <[email protected]>
   6  */
   7
   8 #include <linux/clk.h>
   9 #include <linux/dma-mapping.h>
  10 #include <linux/iopoll.h>
  11 #include <linux/kernel.h>
  12 #include <linux/module.h>
  13 #include <linux/of_address.h>
  14 #include <linux/of_irq.h>
  15 #include <linux/platform_device.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 ssusb_phy_init(struct ssusb_mtk *ssusb)
  49 {
  50         int i;
  51         int ret;
  52
  53         for (i = 0; i < ssusb->num_phys; i++) {
  54                 ret = phy_init(ssusb->phys[i]);
  55                 if (ret)
  56                         goto exit_phy;
  57         }
  58         return 0;
  59
  60 exit_phy:
  61         for (; i > 0; i--)
  62                 phy_exit(ssusb->phys[i - 1]);
  63
  64         return ret;
  65 }
  66
  67 static int ssusb_phy_exit(struct ssusb_mtk *ssusb)
  68 {
  69         int i;
  70
  71         for (i = 0; i < ssusb->num_phys; i++)
  72                 phy_exit(ssusb->phys[i]);
  73
  74         return 0;
  75 }
  76
  77 static int ssusb_phy_power_on(struct ssusb_mtk *ssusb)
  78 {
  79         int i;
  80         int ret;
  81
  82         for (i = 0; i < ssusb->num_phys; i++) {
  83                 ret = phy_power_on(ssusb->phys[i]);
  84                 if (ret)
  85                         goto power_off_phy;
  86         }
  87         return 0;
  88
  89 power_off_phy:
  90         for (; i > 0; i--)
  91                 phy_power_off(ssusb->phys[i - 1]);
  92
  93         return ret;
  94 }
  95
  96 static void ssusb_phy_power_off(struct ssusb_mtk *ssusb)
  97 {
  98         unsigned int i;
  99
 100         for (i = 0; i < ssusb->num_phys; i++)
 101                 phy_power_off(ssusb->phys[i]);
 102 }
 103
 104 static int ssusb_clks_enable(struct ssusb_mtk *ssusb)
 105 {
 106         int ret;
 107
 108         ret = clk_prepare_enable(ssusb->sys_clk);
 109         if (ret) {
 110                 dev_err(ssusb->dev, "failed to enable sys_clk\n");
 111                 goto sys_clk_err;
 112         }
 113
 114         ret = clk_prepare_enable(ssusb->ref_clk);
 115         if (ret) {
 116                 dev_err(ssusb->dev, "failed to enable ref_clk\n");
 117                 goto ref_clk_err;
 118         }
 119
 120         ret = clk_prepare_enable(ssusb->mcu_clk);
 121         if (ret) {
 122                 dev_err(ssusb->dev, "failed to enable mcu_clk\n");
 123                 goto mcu_clk_err;
 124         }
 125
 126         ret = clk_prepare_enable(ssusb->dma_clk);
 127         if (ret) {
 128                 dev_err(ssusb->dev, "failed to enable dma_clk\n");
 129                 goto dma_clk_err;
 130         }
 131
 132         return 0;
 133
 134 dma_clk_err:
 135         clk_disable_unprepare(ssusb->mcu_clk);
 136 mcu_clk_err:
 137         clk_disable_unprepare(ssusb->ref_clk);
 138 ref_clk_err:
 139         clk_disable_unprepare(ssusb->sys_clk);
 140 sys_clk_err:
 141         return ret;
 142 }
 143
 144 static void ssusb_clks_disable(struct ssusb_mtk *ssusb)
 145 {
 146         clk_disable_unprepare(ssusb->dma_clk);
 147         clk_disable_unprepare(ssusb->mcu_clk);
 148         clk_disable_unprepare(ssusb->ref_clk);
 149         clk_disable_unprepare(ssusb->sys_clk);
 150 }
 151
 152 static int ssusb_rscs_init(struct ssusb_mtk *ssusb)
 153 {
 154         int ret = 0;
 155
 156         ret = regulator_enable(ssusb->vusb33);
 157         if (ret) {
 158                 dev_err(ssusb->dev, "failed to enable vusb33\n");
 159                 goto vusb33_err;
 160         }
 161
 162         ret = ssusb_clks_enable(ssusb);
 163         if (ret)
 164                 goto clks_err;
 165
 166         ret = ssusb_phy_init(ssusb);
 167         if (ret) {
 168                 dev_err(ssusb->dev, "failed to init phy\n");
 169                 goto phy_init_err;
 170         }
 171
 172         ret = ssusb_phy_power_on(ssusb);
 173         if (ret) {
 174                 dev_err(ssusb->dev, "failed to power on phy\n");
 175                 goto phy_err;
 176         }
 177
 178         return 0;
 179
 180 phy_err:
 181         ssusb_phy_exit(ssusb);
 182 phy_init_err:
 183         ssusb_clks_disable(ssusb);
 184 clks_err:
 185         regulator_disable(ssusb->vusb33);
 186 vusb33_err:
 187         return ret;
 188 }
 189
 190 static void ssusb_rscs_exit(struct ssusb_mtk *ssusb)
 191 {
 192         ssusb_clks_disable(ssusb);
 193         regulator_disable(ssusb->vusb33);
 194         ssusb_phy_power_off(ssusb);
 195         ssusb_phy_exit(ssusb);
 196 }
 197
 198 static void ssusb_ip_sw_reset(struct ssusb_mtk *ssusb)
 199 {
 200         /* reset whole ip (xhci & u3d) */
 201         mtu3_setbits(ssusb->ippc_base, U3D_SSUSB_IP_PW_CTRL0, SSUSB_IP_SW_RST);
 202         udelay(1);
 203         mtu3_clrbits(ssusb->ippc_base, U3D_SSUSB_IP_PW_CTRL0, SSUSB_IP_SW_RST);
 204
 205         /*
 206          * device ip may be powered on in firmware/BROM stage before entering
 207          * kernel stage;
 208          * power down device ip, otherwise ip-sleep will fail when working as
 209          * host only mode
 210          */
 211         mtu3_setbits(ssusb->ippc_base, U3D_SSUSB_IP_PW_CTRL2, SSUSB_IP_DEV_PDN);
 212 }
 213
 214 /* ignore the error if the clock does not exist */
 215 static struct clk *get_optional_clk(struct device *dev, const char *id)
 216 {
 217         struct clk *opt_clk;
 218
 219         opt_clk = devm_clk_get(dev, id);
 220         /* ignore error number except EPROBE_DEFER */
 221         if (IS_ERR(opt_clk) && (PTR_ERR(opt_clk) != -EPROBE_DEFER))
 222                 opt_clk = NULL;
 223
 224         return opt_clk;
 225 }
 226
 227 static int get_ssusb_rscs(struct platform_device *pdev, struct ssusb_mtk *ssusb)
 228 {
 229         struct device_node *node = pdev->dev.of_node;
 230         struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
 231         struct device *dev = &pdev->dev;
 232         struct resource *res;
 233         int i;
 234         int ret;
 235
 236         ssusb->vusb33 = devm_regulator_get(dev, "vusb33");
 237         if (IS_ERR(ssusb->vusb33)) {
 238                 dev_err(dev, "failed to get vusb33\n");
 239                 return PTR_ERR(ssusb->vusb33);
 240         }
 241
 242         ssusb->sys_clk = devm_clk_get(dev, "sys_ck");
 243         if (IS_ERR(ssusb->sys_clk)) {
 244                 dev_err(dev, "failed to get sys clock\n");
 245                 return PTR_ERR(ssusb->sys_clk);
 246         }
 247
 248         ssusb->ref_clk = get_optional_clk(dev, "ref_ck");
 249         if (IS_ERR(ssusb->ref_clk))
 250                 return PTR_ERR(ssusb->ref_clk);
 251
 252         ssusb->mcu_clk = get_optional_clk(dev, "mcu_ck");
 253         if (IS_ERR(ssusb->mcu_clk))
 254                 return PTR_ERR(ssusb->mcu_clk);
 255
 256         ssusb->dma_clk = get_optional_clk(dev, "dma_ck");
 257         if (IS_ERR(ssusb->dma_clk))
 258                 return PTR_ERR(ssusb->dma_clk);
 259
 260         ssusb->num_phys = of_count_phandle_with_args(node,
 261                         "phys", "#phy-cells");
 262         if (ssusb->num_phys > 0) {
 263                 ssusb->phys = devm_kcalloc(dev, ssusb->num_phys,
 264                                         sizeof(*ssusb->phys), GFP_KERNEL);
 265                 if (!ssusb->phys)
 266                         return -ENOMEM;
 267         } else {
 268                 ssusb->num_phys = 0;
 269         }
 270
 271         for (i = 0; i < ssusb->num_phys; i++) {
 272                 ssusb->phys[i] = devm_of_phy_get_by_index(dev, node, i);
 273                 if (IS_ERR(ssusb->phys[i])) {
 274                         dev_err(dev, "failed to get phy-%d\n", i);
 275                         return PTR_ERR(ssusb->phys[i]);
 276                 }
 277         }
 278
 279         res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "ippc");
 280         ssusb->ippc_base = devm_ioremap_resource(dev, res);
 281         if (IS_ERR(ssusb->ippc_base))
 282                 return PTR_ERR(ssusb->ippc_base);
 283
 284         ssusb->dr_mode = usb_get_dr_mode(dev);
 285         if (ssusb->dr_mode == USB_DR_MODE_UNKNOWN)
 286                 ssusb->dr_mode = USB_DR_MODE_OTG;
 287
 288         if (ssusb->dr_mode == USB_DR_MODE_PERIPHERAL)
 289                 goto out;
 290
 291         /* if host role is supported */
 292         ret = ssusb_wakeup_of_property_parse(ssusb, node);
 293         if (ret) {
 294                 dev_err(dev, "failed to parse uwk property\n");
 295                 return ret;
 296         }
 297
 298         /* optional property, ignore the error if it does not exist */
 299         of_property_read_u32(node, "mediatek,u3p-dis-msk",
 300                              &ssusb->u3p_dis_msk);
 301
 302         otg_sx->vbus = devm_regulator_get(dev, "vbus");
 303         if (IS_ERR(otg_sx->vbus)) {
 304                 dev_err(dev, "failed to get vbus\n");
 305                 return PTR_ERR(otg_sx->vbus);
 306         }
 307
 308         if (ssusb->dr_mode == USB_DR_MODE_HOST)
 309                 goto out;
 310
 311         /* if dual-role mode is supported */
 312         otg_sx->is_u3_drd = of_property_read_bool(node, "mediatek,usb3-drd");
 313         otg_sx->manual_drd_enabled =
 314                 of_property_read_bool(node, "enable-manual-drd");
 315
 316         if (of_property_read_bool(node, "extcon")) {
 317                 otg_sx->edev = extcon_get_edev_by_phandle(ssusb->dev, 0);
 318                 if (IS_ERR(otg_sx->edev)) {
 319                         dev_err(ssusb->dev, "couldn't get extcon device\n");
 320                         return PTR_ERR(otg_sx->edev);
 321                 }
 322         }
 323
 324 out:
 325         dev_info(dev, "dr_mode: %d, is_u3_dr: %d, u3p_dis_msk: %x, drd: %s\n",
 326                 ssusb->dr_mode, otg_sx->is_u3_drd, ssusb->u3p_dis_msk,
 327                 otg_sx->manual_drd_enabled ? "manual" : "auto");
 328
 329         return 0;
 330 }
 331
 332 static int mtu3_probe(struct platform_device *pdev)
 333 {
 334         struct device_node *node = pdev->dev.of_node;
 335         struct device *dev = &pdev->dev;
 336         struct ssusb_mtk *ssusb;
 337         int ret = -ENOMEM;
 338
 339         /* all elements are set to ZERO as default value */
 340         ssusb = devm_kzalloc(dev, sizeof(*ssusb), GFP_KERNEL);
 341         if (!ssusb)
 342                 return -ENOMEM;
 343
 344         ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
 345         if (ret) {
 346                 dev_err(dev, "No suitable DMA config available\n");
 347                 return -ENOTSUPP;
 348         }
 349
 350         platform_set_drvdata(pdev, ssusb);
 351         ssusb->dev = dev;
 352
 353         ret = get_ssusb_rscs(pdev, ssusb);
 354         if (ret)
 355                 return ret;
 356
 357         ssusb_debugfs_create_root(ssusb);
 358
 359         /* enable power domain */
 360         pm_runtime_enable(dev);
 361         pm_runtime_get_sync(dev);
 362         device_enable_async_suspend(dev);
 363
 364         ret = ssusb_rscs_init(ssusb);
 365         if (ret)
 366                 goto comm_init_err;
 367
 368         ssusb_ip_sw_reset(ssusb);
 369
 370         if (IS_ENABLED(CONFIG_USB_MTU3_HOST))
 371                 ssusb->dr_mode = USB_DR_MODE_HOST;
 372         else if (IS_ENABLED(CONFIG_USB_MTU3_GADGET))
 373                 ssusb->dr_mode = USB_DR_MODE_PERIPHERAL;
 374
 375         /* default as host */
 376         ssusb->is_host = !(ssusb->dr_mode == USB_DR_MODE_PERIPHERAL);
 377
 378         switch (ssusb->dr_mode) {
 379         case USB_DR_MODE_PERIPHERAL:
 380                 ret = ssusb_gadget_init(ssusb);
 381                 if (ret) {
 382                         dev_err(dev, "failed to initialize gadget\n");
 383                         goto comm_exit;
 384                 }
 385                 break;
 386         case USB_DR_MODE_HOST:
 387                 ret = ssusb_host_init(ssusb, node);
 388                 if (ret) {
 389                         dev_err(dev, "failed to initialize host\n");
 390                         goto comm_exit;
 391                 }
 392                 break;
 393         case USB_DR_MODE_OTG:
 394                 ret = ssusb_gadget_init(ssusb);
 395                 if (ret) {
 396                         dev_err(dev, "failed to initialize gadget\n");
 397                         goto comm_exit;
 398                 }
 399
 400                 ret = ssusb_host_init(ssusb, node);
 401                 if (ret) {
 402                         dev_err(dev, "failed to initialize host\n");
 403                         goto gadget_exit;
 404                 }
 405
 406                 ret = ssusb_otg_switch_init(ssusb);
 407                 if (ret) {
 408                         dev_err(dev, "failed to initialize switch\n");
 409                         goto host_exit;
 410                 }
 411                 break;
 412         default:
 413                 dev_err(dev, "unsupported mode: %d\n", ssusb->dr_mode);
 414                 ret = -EINVAL;
 415                 goto comm_exit;
 416         }
 417
 418         return 0;
 419
 420 host_exit:
 421         ssusb_host_exit(ssusb);
 422 gadget_exit:
 423         ssusb_gadget_exit(ssusb);
 424 comm_exit:
 425         ssusb_rscs_exit(ssusb);
 426 comm_init_err:
 427         pm_runtime_put_sync(dev);
 428         pm_runtime_disable(dev);
 429         ssusb_debugfs_remove_root(ssusb);
 430
 431         return ret;
 432 }
 433
 434 static int mtu3_remove(struct platform_device *pdev)
 435 {
 436         struct ssusb_mtk *ssusb = platform_get_drvdata(pdev);
 437
 438         switch (ssusb->dr_mode) {
 439         case USB_DR_MODE_PERIPHERAL:
 440                 ssusb_gadget_exit(ssusb);
 441                 break;
 442         case USB_DR_MODE_HOST:
 443                 ssusb_host_exit(ssusb);
 444                 break;
 445         case USB_DR_MODE_OTG:
 446                 ssusb_otg_switch_exit(ssusb);
 447                 ssusb_gadget_exit(ssusb);
 448                 ssusb_host_exit(ssusb);
 449                 break;
 450         default:
 451                 return -EINVAL;
 452         }
 453
 454         ssusb_rscs_exit(ssusb);
 455         pm_runtime_put_sync(&pdev->dev);
 456         pm_runtime_disable(&pdev->dev);
 457         ssusb_debugfs_remove_root(ssusb);
 458
 459         return 0;
 460 }
 461
 462 /*
 463  * when support dual-role mode, we reject suspend when
 464  * it works as device mode;
 465  */
 466 static int __maybe_unused mtu3_suspend(struct device *dev)
 467 {
 468         struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
 469
 470         dev_dbg(dev, "%s\n", __func__);
 471
 472         /* REVISIT: disconnect it for only device mode? */
 473         if (!ssusb->is_host)
 474                 return 0;
 475
 476         ssusb_host_disable(ssusb, true);
 477         ssusb_phy_power_off(ssusb);
 478         ssusb_clks_disable(ssusb);
 479         ssusb_wakeup_set(ssusb, true);
 480
 481         return 0;
 482 }
 483
 484 static int __maybe_unused mtu3_resume(struct device *dev)
 485 {
 486         struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
 487         int ret;
 488
 489         dev_dbg(dev, "%s\n", __func__);
 490
 491         if (!ssusb->is_host)
 492                 return 0;
 493
 494         ssusb_wakeup_set(ssusb, false);
 495         ret = ssusb_clks_enable(ssusb);
 496         if (ret)
 497                 goto clks_err;
 498
 499         ret = ssusb_phy_power_on(ssusb);
 500         if (ret)
 501                 goto phy_err;
 502
 503         ssusb_host_enable(ssusb);
 504
 505         return 0;
 506
 507 phy_err:
 508         ssusb_clks_disable(ssusb);
 509 clks_err:
 510         return ret;
 511 }
 512
 513 static const struct dev_pm_ops mtu3_pm_ops = {
 514         SET_SYSTEM_SLEEP_PM_OPS(mtu3_suspend, mtu3_resume)
 515 };
 516
 517 #define DEV_PM_OPS (IS_ENABLED(CONFIG_PM) ? &mtu3_pm_ops : NULL)
 518
 519 #ifdef CONFIG_OF
 520
 521 static const struct of_device_id mtu3_of_match[] = {
 522         {.compatible = "mediatek,mt8173-mtu3",},
 523         {.compatible = "mediatek,mtu3",},
 524         {},
 525 };
 526
 527 MODULE_DEVICE_TABLE(of, mtu3_of_match);
 528
 529 #endif
 530
 531 static struct platform_driver mtu3_driver = {
 532         .probe = mtu3_probe,
 533         .remove = mtu3_remove,
 534         .driver = {
 535                 .name = MTU3_DRIVER_NAME,
 536                 .pm = DEV_PM_OPS,
 537                 .of_match_table = of_match_ptr(mtu3_of_match),
 538         },
 539 };
 540 module_platform_driver(mtu3_driver);
 541
 542 MODULE_AUTHOR("Chunfeng Yun <[email protected]>");
 543 MODULE_LICENSE("GPL v2");
 544 MODULE_DESCRIPTION("MediaTek USB3 DRD Controller Driver");