1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2012 Freescale Semiconductor, Inc.
4 * Copyright (C) 2012 Marek Vasut <marex@denx.de>
5 * on behalf of DENX Software Engineering GmbH
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 #include <linux/pinctrl/consumer.h>
20 #include "ci_hdrc_imx.h"
22 struct ci_hdrc_imx_platform_flag {
26 static const struct ci_hdrc_imx_platform_flag imx23_usb_data = {
27 .flags = CI_HDRC_TURN_VBUS_EARLY_ON |
28 CI_HDRC_DISABLE_STREAMING,
31 static const struct ci_hdrc_imx_platform_flag imx27_usb_data = {
32 .flags = CI_HDRC_DISABLE_STREAMING,
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,
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,
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,
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,
59 static const struct ci_hdrc_imx_platform_flag imx6ul_usb_data = {
60 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM |
61 CI_HDRC_TURN_VBUS_EARLY_ON,
64 static const struct ci_hdrc_imx_platform_flag imx7d_usb_data = {
65 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM,
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},
79 MODULE_DEVICE_TABLE(of, ci_hdrc_imx_dt_ids);
81 struct ci_hdrc_imx_data {
83 struct platform_device *ci_pdev;
85 struct imx_usbmisc_data *usbmisc_data;
86 bool supports_runtime_pm;
87 bool override_phy_control;
89 struct pinctrl *pinctrl;
90 struct pinctrl_state *pinctrl_hsic_active;
91 struct regulator *hsic_pad_regulator;
92 /* SoC before i.mx6 (except imx23/imx28) needs three clks */
97 /* --------------------------------- */
100 /* Common functions shared by usbmisc drivers */
102 static struct imx_usbmisc_data *usbmisc_get_init_data(struct device *dev)
104 struct platform_device *misc_pdev;
105 struct device_node *np = dev->of_node;
106 struct of_phandle_args args;
107 struct imx_usbmisc_data *data;
111 * In case the fsl,usbmisc property is not present this device doesn't
112 * need usbmisc. Return NULL (which is no error here)
114 if (!of_get_property(np, "fsl,usbmisc", NULL))
117 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
119 return ERR_PTR(-ENOMEM);
121 ret = of_parse_phandle_with_args(np, "fsl,usbmisc", "#index-cells",
124 dev_err(dev, "Failed to parse property fsl,usbmisc, errno %d\n",
129 data->index = args.args[0];
131 misc_pdev = of_find_device_by_node(args.np);
132 of_node_put(args.np);
134 if (!misc_pdev || !platform_get_drvdata(misc_pdev))
135 return ERR_PTR(-EPROBE_DEFER);
137 data->dev = &misc_pdev->dev;
140 * Check the various over current related properties. If over current
141 * detection is disabled we're not interested in the polarity.
143 if (of_find_property(np, "disable-over-current", NULL)) {
144 data->disable_oc = 1;
145 } else if (of_find_property(np, "over-current-active-high", NULL)) {
146 data->oc_pol_active_low = 0;
147 data->oc_pol_configured = 1;
148 } else if (of_find_property(np, "over-current-active-low", NULL)) {
149 data->oc_pol_active_low = 1;
150 data->oc_pol_configured = 1;
152 dev_warn(dev, "No over current polarity defined\n");
155 if (of_find_property(np, "external-vbus-divider", NULL))
158 if (of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI)
164 /* End of common functions shared by usbmisc drivers*/
165 static int imx_get_clks(struct device *dev)
167 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
170 data->clk_ipg = devm_clk_get(dev, "ipg");
171 if (IS_ERR(data->clk_ipg)) {
172 /* If the platform only needs one clocks */
173 data->clk = devm_clk_get(dev, NULL);
174 if (IS_ERR(data->clk)) {
175 ret = PTR_ERR(data->clk);
177 "Failed to get clks, err=%ld,%ld\n",
178 PTR_ERR(data->clk), PTR_ERR(data->clk_ipg));
184 data->clk_ahb = devm_clk_get(dev, "ahb");
185 if (IS_ERR(data->clk_ahb)) {
186 ret = PTR_ERR(data->clk_ahb);
188 "Failed to get ahb clock, err=%d\n", ret);
192 data->clk_per = devm_clk_get(dev, "per");
193 if (IS_ERR(data->clk_per)) {
194 ret = PTR_ERR(data->clk_per);
196 "Failed to get per clock, err=%d\n", ret);
200 data->need_three_clks = true;
204 static int imx_prepare_enable_clks(struct device *dev)
206 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
209 if (data->need_three_clks) {
210 ret = clk_prepare_enable(data->clk_ipg);
213 "Failed to prepare/enable ipg clk, err=%d\n",
218 ret = clk_prepare_enable(data->clk_ahb);
221 "Failed to prepare/enable ahb clk, err=%d\n",
223 clk_disable_unprepare(data->clk_ipg);
227 ret = clk_prepare_enable(data->clk_per);
230 "Failed to prepare/enable per clk, err=%d\n",
232 clk_disable_unprepare(data->clk_ahb);
233 clk_disable_unprepare(data->clk_ipg);
237 ret = clk_prepare_enable(data->clk);
240 "Failed to prepare/enable clk, err=%d\n",
249 static void imx_disable_unprepare_clks(struct device *dev)
251 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
253 if (data->need_three_clks) {
254 clk_disable_unprepare(data->clk_per);
255 clk_disable_unprepare(data->clk_ahb);
256 clk_disable_unprepare(data->clk_ipg);
258 clk_disable_unprepare(data->clk);
262 static int ci_hdrc_imx_notify_event(struct ci_hdrc *ci, unsigned int event)
264 struct device *dev = ci->dev->parent;
265 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
269 case CI_HDRC_IMX_HSIC_ACTIVE_EVENT:
270 ret = pinctrl_select_state(data->pinctrl,
271 data->pinctrl_hsic_active);
273 dev_err(dev, "hsic_active select failed, err=%d\n",
276 case CI_HDRC_IMX_HSIC_SUSPEND_EVENT:
277 ret = imx_usbmisc_hsic_set_connect(data->usbmisc_data);
280 "hsic_set_connect failed, err=%d\n", ret);
289 static int ci_hdrc_imx_probe(struct platform_device *pdev)
291 struct ci_hdrc_imx_data *data;
292 struct ci_hdrc_platform_data pdata = {
293 .name = dev_name(&pdev->dev),
294 .capoffset = DEF_CAPOFFSET,
295 .notify_event = ci_hdrc_imx_notify_event,
298 const struct of_device_id *of_id;
299 const struct ci_hdrc_imx_platform_flag *imx_platform_flag;
300 struct device_node *np = pdev->dev.of_node;
301 struct device *dev = &pdev->dev;
302 struct pinctrl_state *pinctrl_hsic_idle;
304 of_id = of_match_device(ci_hdrc_imx_dt_ids, dev);
308 imx_platform_flag = of_id->data;
310 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
314 platform_set_drvdata(pdev, data);
315 data->usbmisc_data = usbmisc_get_init_data(dev);
316 if (IS_ERR(data->usbmisc_data))
317 return PTR_ERR(data->usbmisc_data);
319 if ((of_usb_get_phy_mode(dev->of_node) == USBPHY_INTERFACE_MODE_HSIC)
320 && data->usbmisc_data) {
321 pdata.flags |= CI_HDRC_IMX_IS_HSIC;
322 data->usbmisc_data->hsic = 1;
323 data->pinctrl = devm_pinctrl_get(dev);
324 if (IS_ERR(data->pinctrl)) {
325 dev_err(dev, "pinctrl get failed, err=%ld\n",
326 PTR_ERR(data->pinctrl));
327 return PTR_ERR(data->pinctrl);
330 pinctrl_hsic_idle = pinctrl_lookup_state(data->pinctrl, "idle");
331 if (IS_ERR(pinctrl_hsic_idle)) {
333 "pinctrl_hsic_idle lookup failed, err=%ld\n",
334 PTR_ERR(pinctrl_hsic_idle));
335 return PTR_ERR(pinctrl_hsic_idle);
338 ret = pinctrl_select_state(data->pinctrl, pinctrl_hsic_idle);
340 dev_err(dev, "hsic_idle select failed, err=%d\n", ret);
344 data->pinctrl_hsic_active = pinctrl_lookup_state(data->pinctrl,
346 if (IS_ERR(data->pinctrl_hsic_active)) {
348 "pinctrl_hsic_active lookup failed, err=%ld\n",
349 PTR_ERR(data->pinctrl_hsic_active));
350 return PTR_ERR(data->pinctrl_hsic_active);
353 data->hsic_pad_regulator = devm_regulator_get(dev, "hsic");
354 if (PTR_ERR(data->hsic_pad_regulator) == -EPROBE_DEFER) {
355 return -EPROBE_DEFER;
356 } else if (PTR_ERR(data->hsic_pad_regulator) == -ENODEV) {
357 /* no pad regualator is needed */
358 data->hsic_pad_regulator = NULL;
359 } else if (IS_ERR(data->hsic_pad_regulator)) {
360 dev_err(dev, "Get HSIC pad regulator error: %ld\n",
361 PTR_ERR(data->hsic_pad_regulator));
362 return PTR_ERR(data->hsic_pad_regulator);
365 if (data->hsic_pad_regulator) {
366 ret = regulator_enable(data->hsic_pad_regulator);
369 "Failed to enable HSIC pad regulator\n");
374 ret = imx_get_clks(dev);
376 goto disable_hsic_regulator;
378 ret = imx_prepare_enable_clks(dev);
380 goto disable_hsic_regulator;
382 data->phy = devm_usb_get_phy_by_phandle(dev, "fsl,usbphy", 0);
383 if (IS_ERR(data->phy)) {
384 ret = PTR_ERR(data->phy);
385 /* Return -EINVAL if no usbphy is available */
391 pdata.usb_phy = data->phy;
393 if ((of_device_is_compatible(np, "fsl,imx53-usb") ||
394 of_device_is_compatible(np, "fsl,imx51-usb")) && pdata.usb_phy &&
395 of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI) {
396 pdata.flags |= CI_HDRC_OVERRIDE_PHY_CONTROL;
397 data->override_phy_control = true;
398 usb_phy_init(pdata.usb_phy);
401 pdata.flags |= imx_platform_flag->flags;
402 if (pdata.flags & CI_HDRC_SUPPORTS_RUNTIME_PM)
403 data->supports_runtime_pm = true;
405 ret = imx_usbmisc_init(data->usbmisc_data);
407 dev_err(dev, "usbmisc init failed, ret=%d\n", ret);
411 data->ci_pdev = ci_hdrc_add_device(dev,
412 pdev->resource, pdev->num_resources,
414 if (IS_ERR(data->ci_pdev)) {
415 ret = PTR_ERR(data->ci_pdev);
416 if (ret != -EPROBE_DEFER)
417 dev_err(dev, "ci_hdrc_add_device failed, err=%d\n",
422 ret = imx_usbmisc_init_post(data->usbmisc_data);
424 dev_err(dev, "usbmisc post failed, ret=%d\n", ret);
428 if (data->supports_runtime_pm) {
429 pm_runtime_set_active(dev);
430 pm_runtime_enable(dev);
433 device_set_wakeup_capable(dev, true);
438 ci_hdrc_remove_device(data->ci_pdev);
440 imx_disable_unprepare_clks(dev);
441 disable_hsic_regulator:
442 if (data->hsic_pad_regulator)
443 ret = regulator_disable(data->hsic_pad_regulator);
447 static int ci_hdrc_imx_remove(struct platform_device *pdev)
449 struct ci_hdrc_imx_data *data = platform_get_drvdata(pdev);
451 if (data->supports_runtime_pm) {
452 pm_runtime_get_sync(&pdev->dev);
453 pm_runtime_disable(&pdev->dev);
454 pm_runtime_put_noidle(&pdev->dev);
456 ci_hdrc_remove_device(data->ci_pdev);
457 if (data->override_phy_control)
458 usb_phy_shutdown(data->phy);
459 imx_disable_unprepare_clks(&pdev->dev);
460 if (data->hsic_pad_regulator)
461 regulator_disable(data->hsic_pad_regulator);
466 static void ci_hdrc_imx_shutdown(struct platform_device *pdev)
468 ci_hdrc_imx_remove(pdev);
471 static int __maybe_unused imx_controller_suspend(struct device *dev)
473 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
476 dev_dbg(dev, "at %s\n", __func__);
478 ret = imx_usbmisc_hsic_set_clk(data->usbmisc_data, false);
480 dev_err(dev, "usbmisc hsic_set_clk failed, ret=%d\n", ret);
484 imx_disable_unprepare_clks(dev);
490 static int __maybe_unused imx_controller_resume(struct device *dev)
492 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
495 dev_dbg(dev, "at %s\n", __func__);
502 ret = imx_prepare_enable_clks(dev);
506 data->in_lpm = false;
508 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, false);
510 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
514 ret = imx_usbmisc_hsic_set_clk(data->usbmisc_data, true);
516 dev_err(dev, "usbmisc hsic_set_clk failed, ret=%d\n", ret);
517 goto hsic_set_clk_fail;
523 imx_usbmisc_set_wakeup(data->usbmisc_data, true);
525 imx_disable_unprepare_clks(dev);
529 static int __maybe_unused ci_hdrc_imx_suspend(struct device *dev)
533 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
536 /* The core's suspend doesn't run */
539 if (device_may_wakeup(dev)) {
540 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
542 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n",
548 return imx_controller_suspend(dev);
551 static int __maybe_unused ci_hdrc_imx_resume(struct device *dev)
553 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
556 ret = imx_controller_resume(dev);
557 if (!ret && data->supports_runtime_pm) {
558 pm_runtime_disable(dev);
559 pm_runtime_set_active(dev);
560 pm_runtime_enable(dev);
566 static int __maybe_unused ci_hdrc_imx_runtime_suspend(struct device *dev)
568 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
576 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
578 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
582 return imx_controller_suspend(dev);
585 static int __maybe_unused ci_hdrc_imx_runtime_resume(struct device *dev)
587 return imx_controller_resume(dev);
590 static const struct dev_pm_ops ci_hdrc_imx_pm_ops = {
591 SET_SYSTEM_SLEEP_PM_OPS(ci_hdrc_imx_suspend, ci_hdrc_imx_resume)
592 SET_RUNTIME_PM_OPS(ci_hdrc_imx_runtime_suspend,
593 ci_hdrc_imx_runtime_resume, NULL)
595 static struct platform_driver ci_hdrc_imx_driver = {
596 .probe = ci_hdrc_imx_probe,
597 .remove = ci_hdrc_imx_remove,
598 .shutdown = ci_hdrc_imx_shutdown,
601 .of_match_table = ci_hdrc_imx_dt_ids,
602 .pm = &ci_hdrc_imx_pm_ops,
606 module_platform_driver(ci_hdrc_imx_driver);
608 MODULE_ALIAS("platform:imx-usb");
609 MODULE_LICENSE("GPL");
610 MODULE_DESCRIPTION("CI HDRC i.MX USB binding");
611 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
612 MODULE_AUTHOR("Richard Zhao <richard.zhao@freescale.com>");