drivers/usb/chipidea/ci_hdrc_imx.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright 2012 Freescale Semiconductor, Inc.
   4  * Copyright (C) 2012 Marek Vasut <marex@denx.de>
   5  * on behalf of DENX Software Engineering GmbH
   6  */
   7
   8 #include <linux/module.h>
   9 #include <linux/of_platform.h>
  10 #include <linux/of_gpio.h>
  11 #include <linux/platform_device.h>
  12 #include <linux/pm_runtime.h>
  13 #include <linux/dma-mapping.h>
  14 #include <linux/usb/chipidea.h>
  15 #include <linux/usb/of.h>
  16 #include <linux/clk.h>
  17
  18 #include "ci.h"
  19 #include "ci_hdrc_imx.h"
  20
  21 struct ci_hdrc_imx_platform_flag {
  22         unsigned int flags;
  23 };
  24
  25 static const struct ci_hdrc_imx_platform_flag imx23_usb_data = {
  26         .flags = CI_HDRC_TURN_VBUS_EARLY_ON |
  27                 CI_HDRC_DISABLE_STREAMING,
  28 };
  29
  30 static const struct ci_hdrc_imx_platform_flag imx27_usb_data = {
  31         .flags = CI_HDRC_DISABLE_STREAMING,
  32 };
  33
  34 static const struct ci_hdrc_imx_platform_flag imx28_usb_data = {
  35         .flags = CI_HDRC_IMX28_WRITE_FIX |
  36                 CI_HDRC_TURN_VBUS_EARLY_ON |
  37                 CI_HDRC_DISABLE_STREAMING,
  38 };
  39
  40 static const struct ci_hdrc_imx_platform_flag imx6q_usb_data = {
  41         .flags = CI_HDRC_SUPPORTS_RUNTIME_PM |
  42                 CI_HDRC_TURN_VBUS_EARLY_ON |
  43                 CI_HDRC_DISABLE_STREAMING,
  44 };
  45
  46 static const struct ci_hdrc_imx_platform_flag imx6sl_usb_data = {
  47         .flags = CI_HDRC_SUPPORTS_RUNTIME_PM |
  48                 CI_HDRC_TURN_VBUS_EARLY_ON |
  49                 CI_HDRC_DISABLE_HOST_STREAMING,
  50 };
  51
  52 static const struct ci_hdrc_imx_platform_flag imx6sx_usb_data = {
  53         .flags = CI_HDRC_SUPPORTS_RUNTIME_PM |
  54                 CI_HDRC_TURN_VBUS_EARLY_ON |
  55                 CI_HDRC_DISABLE_HOST_STREAMING,
  56 };
  57
  58 static const struct ci_hdrc_imx_platform_flag imx6ul_usb_data = {
  59         .flags = CI_HDRC_SUPPORTS_RUNTIME_PM |
  60                 CI_HDRC_TURN_VBUS_EARLY_ON |
  61                 CI_HDRC_DISABLE_DEVICE_STREAMING,
  62 };
  63
  64 static const struct ci_hdrc_imx_platform_flag imx7d_usb_data = {
  65         .flags = CI_HDRC_SUPPORTS_RUNTIME_PM,
  66 };
  67
  68 static const struct of_device_id ci_hdrc_imx_dt_ids[] = {
  69         { .compatible = "fsl,imx23-usb", .data = &imx23_usb_data},
  70         { .compatible = "fsl,imx28-usb", .data = &imx28_usb_data},
  71         { .compatible = "fsl,imx27-usb", .data = &imx27_usb_data},
  72         { .compatible = "fsl,imx6q-usb", .data = &imx6q_usb_data},
  73         { .compatible = "fsl,imx6sl-usb", .data = &imx6sl_usb_data},
  74         { .compatible = "fsl,imx6sx-usb", .data = &imx6sx_usb_data},
  75         { .compatible = "fsl,imx6ul-usb", .data = &imx6ul_usb_data},
  76         { .compatible = "fsl,imx7d-usb", .data = &imx7d_usb_data},
  77         { /* sentinel */ }
  78 };
  79 MODULE_DEVICE_TABLE(of, ci_hdrc_imx_dt_ids);
  80
  81 struct ci_hdrc_imx_data {
  82         struct usb_phy *phy;
  83         struct platform_device *ci_pdev;
  84         struct clk *clk;
  85         struct imx_usbmisc_data *usbmisc_data;
  86         bool supports_runtime_pm;
  87         bool override_phy_control;
  88         bool in_lpm;
  89         /* SoC before i.mx6 (except imx23/imx28) needs three clks */
  90         bool need_three_clks;
  91         struct clk *clk_ipg;
  92         struct clk *clk_ahb;
  93         struct clk *clk_per;
  94         /* --------------------------------- */
  95 };
  96
  97 /* Common functions shared by usbmisc drivers */
  98
  99 static struct imx_usbmisc_data *usbmisc_get_init_data(struct device *dev)
 100 {
 101         struct platform_device *misc_pdev;
 102         struct device_node *np = dev->of_node;
 103         struct of_phandle_args args;
 104         struct imx_usbmisc_data *data;
 105         int ret;
 106
 107         /*
 108          * In case the fsl,usbmisc property is not present this device doesn't
 109          * need usbmisc. Return NULL (which is no error here)
 110          */
 111         if (!of_get_property(np, "fsl,usbmisc", NULL))
 112                 return NULL;
 113
 114         data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
 115         if (!data)
 116                 return ERR_PTR(-ENOMEM);
 117
 118         ret = of_parse_phandle_with_args(np, "fsl,usbmisc", "#index-cells",
 119                                         0, &args);
 120         if (ret) {
 121                 dev_err(dev, "Failed to parse property fsl,usbmisc, errno %d\n",
 122                         ret);
 123                 return ERR_PTR(ret);
 124         }
 125
 126         data->index = args.args[0];
 127
 128         misc_pdev = of_find_device_by_node(args.np);
 129         of_node_put(args.np);
 130
 131         if (!misc_pdev)
 132                 return ERR_PTR(-EPROBE_DEFER);
 133
 134         if (!platform_get_drvdata(misc_pdev)) {
 135                 put_device(&misc_pdev->dev);
 136                 return ERR_PTR(-EPROBE_DEFER);
 137         }
 138         data->dev = &misc_pdev->dev;
 139
 140         if (of_find_property(np, "disable-over-current", NULL))
 141                 data->disable_oc = 1;
 142
 143         if (of_find_property(np, "over-current-active-high", NULL))
 144                 data->oc_polarity = 1;
 145
 146         if (of_find_property(np, "external-vbus-divider", NULL))
 147                 data->evdo = 1;
 148
 149         if (of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI)
 150                 data->ulpi = 1;
 151
 152         return data;
 153 }
 154
 155 /* End of common functions shared by usbmisc drivers*/
 156 static int imx_get_clks(struct device *dev)
 157 {
 158         struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
 159         int ret = 0;
 160
 161         data->clk_ipg = devm_clk_get(dev, "ipg");
 162         if (IS_ERR(data->clk_ipg)) {
 163                 /* If the platform only needs one clocks */
 164                 data->clk = devm_clk_get(dev, NULL);
 165                 if (IS_ERR(data->clk)) {
 166                         ret = PTR_ERR(data->clk);
 167                         dev_err(dev,
 168                                 "Failed to get clks, err=%ld,%ld\n",
 169                                 PTR_ERR(data->clk), PTR_ERR(data->clk_ipg));
 170                         return ret;
 171                 }
 172                 return ret;
 173         }
 174
 175         data->clk_ahb = devm_clk_get(dev, "ahb");
 176         if (IS_ERR(data->clk_ahb)) {
 177                 ret = PTR_ERR(data->clk_ahb);
 178                 dev_err(dev,
 179                         "Failed to get ahb clock, err=%d\n", ret);
 180                 return ret;
 181         }
 182
 183         data->clk_per = devm_clk_get(dev, "per");
 184         if (IS_ERR(data->clk_per)) {
 185                 ret = PTR_ERR(data->clk_per);
 186                 dev_err(dev,
 187                         "Failed to get per clock, err=%d\n", ret);
 188                 return ret;
 189         }
 190
 191         data->need_three_clks = true;
 192         return ret;
 193 }
 194
 195 static int imx_prepare_enable_clks(struct device *dev)
 196 {
 197         struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
 198         int ret = 0;
 199
 200         if (data->need_three_clks) {
 201                 ret = clk_prepare_enable(data->clk_ipg);
 202                 if (ret) {
 203                         dev_err(dev,
 204                                 "Failed to prepare/enable ipg clk, err=%d\n",
 205                                 ret);
 206                         return ret;
 207                 }
 208
 209                 ret = clk_prepare_enable(data->clk_ahb);
 210                 if (ret) {
 211                         dev_err(dev,
 212                                 "Failed to prepare/enable ahb clk, err=%d\n",
 213                                 ret);
 214                         clk_disable_unprepare(data->clk_ipg);
 215                         return ret;
 216                 }
 217
 218                 ret = clk_prepare_enable(data->clk_per);
 219                 if (ret) {
 220                         dev_err(dev,
 221                                 "Failed to prepare/enable per clk, err=%d\n",
 222                                 ret);
 223                         clk_disable_unprepare(data->clk_ahb);
 224                         clk_disable_unprepare(data->clk_ipg);
 225                         return ret;
 226                 }
 227         } else {
 228                 ret = clk_prepare_enable(data->clk);
 229                 if (ret) {
 230                         dev_err(dev,
 231                                 "Failed to prepare/enable clk, err=%d\n",
 232                                 ret);
 233                         return ret;
 234                 }
 235         }
 236
 237         return ret;
 238 }
 239
 240 static void imx_disable_unprepare_clks(struct device *dev)
 241 {
 242         struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
 243
 244         if (data->need_three_clks) {
 245                 clk_disable_unprepare(data->clk_per);
 246                 clk_disable_unprepare(data->clk_ahb);
 247                 clk_disable_unprepare(data->clk_ipg);
 248         } else {
 249                 clk_disable_unprepare(data->clk);
 250         }
 251 }
 252
 253 static int ci_hdrc_imx_probe(struct platform_device *pdev)
 254 {
 255         struct ci_hdrc_imx_data *data;
 256         struct ci_hdrc_platform_data pdata = {
 257                 .name           = dev_name(&pdev->dev),
 258                 .capoffset      = DEF_CAPOFFSET,
 259         };
 260         int ret;
 261         const struct of_device_id *of_id;
 262         const struct ci_hdrc_imx_platform_flag *imx_platform_flag;
 263         struct device_node *np = pdev->dev.of_node;
 264
 265         of_id = of_match_device(ci_hdrc_imx_dt_ids, &pdev->dev);
 266         if (!of_id)
 267                 return -ENODEV;
 268
 269         imx_platform_flag = of_id->data;
 270
 271         data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
 272         if (!data)
 273                 return -ENOMEM;
 274
 275         platform_set_drvdata(pdev, data);
 276         data->usbmisc_data = usbmisc_get_init_data(&pdev->dev);
 277         if (IS_ERR(data->usbmisc_data))
 278                 return PTR_ERR(data->usbmisc_data);
 279
 280         ret = imx_get_clks(&pdev->dev);
 281         if (ret)
 282                 return ret;
 283
 284         ret = imx_prepare_enable_clks(&pdev->dev);
 285         if (ret)
 286                 return ret;
 287
 288         data->phy = devm_usb_get_phy_by_phandle(&pdev->dev, "fsl,usbphy", 0);
 289         if (IS_ERR(data->phy)) {
 290                 ret = PTR_ERR(data->phy);
 291                 /* Return -EINVAL if no usbphy is available */
 292                 if (ret == -ENODEV)
 293                         ret = -EINVAL;
 294                 goto err_clk;
 295         }
 296
 297         pdata.usb_phy = data->phy;
 298
 299         if ((of_device_is_compatible(np, "fsl,imx53-usb") ||
 300              of_device_is_compatible(np, "fsl,imx51-usb")) && pdata.usb_phy &&
 301             of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI) {
 302                 pdata.flags |= CI_HDRC_OVERRIDE_PHY_CONTROL;
 303                 data->override_phy_control = true;
 304                 usb_phy_init(pdata.usb_phy);
 305         }
 306
 307         pdata.flags |= imx_platform_flag->flags;
 308         if (pdata.flags & CI_HDRC_SUPPORTS_RUNTIME_PM)
 309                 data->supports_runtime_pm = true;
 310
 311         ret = imx_usbmisc_init(data->usbmisc_data);
 312         if (ret) {
 313                 dev_err(&pdev->dev, "usbmisc init failed, ret=%d\n", ret);
 314                 goto err_clk;
 315         }
 316
 317         data->ci_pdev = ci_hdrc_add_device(&pdev->dev,
 318                                 pdev->resource, pdev->num_resources,
 319                                 &pdata);
 320         if (IS_ERR(data->ci_pdev)) {
 321                 ret = PTR_ERR(data->ci_pdev);
 322                 if (ret != -EPROBE_DEFER)
 323                         dev_err(&pdev->dev,
 324                                 "ci_hdrc_add_device failed, err=%d\n", ret);
 325                 goto err_clk;
 326         }
 327
 328         ret = imx_usbmisc_init_post(data->usbmisc_data);
 329         if (ret) {
 330                 dev_err(&pdev->dev, "usbmisc post failed, ret=%d\n", ret);
 331                 goto disable_device;
 332         }
 333
 334         if (data->supports_runtime_pm) {
 335                 pm_runtime_set_active(&pdev->dev);
 336                 pm_runtime_enable(&pdev->dev);
 337         }
 338
 339         device_set_wakeup_capable(&pdev->dev, true);
 340
 341         return 0;
 342
 343 disable_device:
 344         ci_hdrc_remove_device(data->ci_pdev);
 345 err_clk:
 346         imx_disable_unprepare_clks(&pdev->dev);
 347         return ret;
 348 }
 349
 350 static int ci_hdrc_imx_remove(struct platform_device *pdev)
 351 {
 352         struct ci_hdrc_imx_data *data = platform_get_drvdata(pdev);
 353
 354         if (data->supports_runtime_pm) {
 355                 pm_runtime_get_sync(&pdev->dev);
 356                 pm_runtime_disable(&pdev->dev);
 357                 pm_runtime_put_noidle(&pdev->dev);
 358         }
 359         ci_hdrc_remove_device(data->ci_pdev);
 360         if (data->override_phy_control)
 361                 usb_phy_shutdown(data->phy);
 362         imx_disable_unprepare_clks(&pdev->dev);
 363
 364         return 0;
 365 }
 366
 367 static void ci_hdrc_imx_shutdown(struct platform_device *pdev)
 368 {
 369         ci_hdrc_imx_remove(pdev);
 370 }
 371
 372 #ifdef CONFIG_PM
 373 static int imx_controller_suspend(struct device *dev)
 374 {
 375         struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
 376
 377         dev_dbg(dev, "at %s\n", __func__);
 378
 379         imx_disable_unprepare_clks(dev);
 380         data->in_lpm = true;
 381
 382         return 0;
 383 }
 384
 385 static int imx_controller_resume(struct device *dev)
 386 {
 387         struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
 388         int ret = 0;
 389
 390         dev_dbg(dev, "at %s\n", __func__);
 391
 392         if (!data->in_lpm) {
 393                 WARN_ON(1);
 394                 return 0;
 395         }
 396
 397         ret = imx_prepare_enable_clks(dev);
 398         if (ret)
 399                 return ret;
 400
 401         data->in_lpm = false;
 402
 403         ret = imx_usbmisc_set_wakeup(data->usbmisc_data, false);
 404         if (ret) {
 405                 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
 406                 goto clk_disable;
 407         }
 408
 409         return 0;
 410
 411 clk_disable:
 412         imx_disable_unprepare_clks(dev);
 413         return ret;
 414 }
 415
 416 #ifdef CONFIG_PM_SLEEP
 417 static int ci_hdrc_imx_suspend(struct device *dev)
 418 {
 419         int ret;
 420
 421         struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
 422
 423         if (data->in_lpm)
 424                 /* The core's suspend doesn't run */
 425                 return 0;
 426
 427         if (device_may_wakeup(dev)) {
 428                 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
 429                 if (ret) {
 430                         dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n",
 431                                         ret);
 432                         return ret;
 433                 }
 434         }
 435
 436         return imx_controller_suspend(dev);
 437 }
 438
 439 static int ci_hdrc_imx_resume(struct device *dev)
 440 {
 441         struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
 442         int ret;
 443
 444         ret = imx_controller_resume(dev);
 445         if (!ret && data->supports_runtime_pm) {
 446                 pm_runtime_disable(dev);
 447                 pm_runtime_set_active(dev);
 448                 pm_runtime_enable(dev);
 449         }
 450
 451         return ret;
 452 }
 453 #endif /* CONFIG_PM_SLEEP */
 454
 455 static int ci_hdrc_imx_runtime_suspend(struct device *dev)
 456 {
 457         struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
 458         int ret;
 459
 460         if (data->in_lpm) {
 461                 WARN_ON(1);
 462                 return 0;
 463         }
 464
 465         ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
 466         if (ret) {
 467                 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
 468                 return ret;
 469         }
 470
 471         return imx_controller_suspend(dev);
 472 }
 473
 474 static int ci_hdrc_imx_runtime_resume(struct device *dev)
 475 {
 476         return imx_controller_resume(dev);
 477 }
 478
 479 #endif /* CONFIG_PM */
 480
 481 static const struct dev_pm_ops ci_hdrc_imx_pm_ops = {
 482         SET_SYSTEM_SLEEP_PM_OPS(ci_hdrc_imx_suspend, ci_hdrc_imx_resume)
 483         SET_RUNTIME_PM_OPS(ci_hdrc_imx_runtime_suspend,
 484                         ci_hdrc_imx_runtime_resume, NULL)
 485 };
 486 static struct platform_driver ci_hdrc_imx_driver = {
 487         .probe = ci_hdrc_imx_probe,
 488         .remove = ci_hdrc_imx_remove,
 489         .shutdown = ci_hdrc_imx_shutdown,
 490         .driver = {
 491                 .name = "imx_usb",
 492                 .of_match_table = ci_hdrc_imx_dt_ids,
 493                 .pm = &ci_hdrc_imx_pm_ops,
 494          },
 495 };
 496
 497 module_platform_driver(ci_hdrc_imx_driver);
 498
 499 MODULE_ALIAS("platform:imx-usb");
 500 MODULE_LICENSE("GPL v2");
 501 MODULE_DESCRIPTION("CI HDRC i.MX USB binding");
 502 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
 503 MODULE_AUTHOR("Richard Zhao <richard.zhao@freescale.com>");