drivers/usb/chipidea/ci_hdrc_imx.c

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