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/platform_device.h>
11 #include <linux/pm_runtime.h>
12 #include <linux/usb/chipidea.h>
13 #include <linux/usb/of.h>
14 #include <linux/clk.h>
15 #include <linux/pinctrl/consumer.h>
16 #include <linux/pm_qos.h>
19 #include "ci_hdrc_imx.h"
21 struct ci_hdrc_imx_platform_flag {
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,
30 static const struct ci_hdrc_imx_platform_flag imx27_usb_data = {
31 .flags = CI_HDRC_DISABLE_STREAMING,
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,
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,
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,
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,
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,
64 static const struct ci_hdrc_imx_platform_flag imx7d_usb_data = {
65 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM,
68 static const struct ci_hdrc_imx_platform_flag imx7ulp_usb_data = {
69 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM |
73 static const struct of_device_id ci_hdrc_imx_dt_ids[] = {
74 { .compatible = "fsl,imx23-usb", .data = &imx23_usb_data},
75 { .compatible = "fsl,imx28-usb", .data = &imx28_usb_data},
76 { .compatible = "fsl,imx27-usb", .data = &imx27_usb_data},
77 { .compatible = "fsl,imx6q-usb", .data = &imx6q_usb_data},
78 { .compatible = "fsl,imx6sl-usb", .data = &imx6sl_usb_data},
79 { .compatible = "fsl,imx6sx-usb", .data = &imx6sx_usb_data},
80 { .compatible = "fsl,imx6ul-usb", .data = &imx6ul_usb_data},
81 { .compatible = "fsl,imx7d-usb", .data = &imx7d_usb_data},
82 { .compatible = "fsl,imx7ulp-usb", .data = &imx7ulp_usb_data},
85 MODULE_DEVICE_TABLE(of, ci_hdrc_imx_dt_ids);
87 struct ci_hdrc_imx_data {
89 struct platform_device *ci_pdev;
91 struct imx_usbmisc_data *usbmisc_data;
92 bool supports_runtime_pm;
93 bool override_phy_control;
95 struct pinctrl *pinctrl;
96 struct pinctrl_state *pinctrl_hsic_active;
97 struct regulator *hsic_pad_regulator;
98 /* SoC before i.mx6 (except imx23/imx28) needs three clks */
103 /* --------------------------------- */
104 struct pm_qos_request pm_qos_req;
105 const struct ci_hdrc_imx_platform_flag *plat_data;
108 /* Common functions shared by usbmisc drivers */
110 static struct imx_usbmisc_data *usbmisc_get_init_data(struct device *dev)
112 struct platform_device *misc_pdev;
113 struct device_node *np = dev->of_node;
114 struct of_phandle_args args;
115 struct imx_usbmisc_data *data;
119 * In case the fsl,usbmisc property is not present this device doesn't
120 * need usbmisc. Return NULL (which is no error here)
122 if (!of_get_property(np, "fsl,usbmisc", NULL))
125 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
127 return ERR_PTR(-ENOMEM);
129 ret = of_parse_phandle_with_args(np, "fsl,usbmisc", "#index-cells",
132 dev_err(dev, "Failed to parse property fsl,usbmisc, errno %d\n",
137 data->index = args.args[0];
139 misc_pdev = of_find_device_by_node(args.np);
140 of_node_put(args.np);
142 if (!misc_pdev || !platform_get_drvdata(misc_pdev))
143 return ERR_PTR(-EPROBE_DEFER);
145 data->dev = &misc_pdev->dev;
148 * Check the various over current related properties. If over current
149 * detection is disabled we're not interested in the polarity.
151 if (of_find_property(np, "disable-over-current", NULL)) {
152 data->disable_oc = 1;
153 } else if (of_find_property(np, "over-current-active-high", NULL)) {
154 data->oc_pol_active_low = 0;
155 data->oc_pol_configured = 1;
156 } else if (of_find_property(np, "over-current-active-low", NULL)) {
157 data->oc_pol_active_low = 1;
158 data->oc_pol_configured = 1;
160 dev_warn(dev, "No over current polarity defined\n");
163 data->pwr_pol = of_property_read_bool(np, "power-active-high");
164 data->evdo = of_property_read_bool(np, "external-vbus-divider");
166 if (of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI)
169 of_property_read_u32(np, "samsung,picophy-pre-emp-curr-control",
170 &data->emp_curr_control);
171 of_property_read_u32(np, "samsung,picophy-dc-vol-level-adjust",
172 &data->dc_vol_level_adjust);
177 /* End of common functions shared by usbmisc drivers*/
178 static int imx_get_clks(struct device *dev)
180 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
183 data->clk_ipg = devm_clk_get(dev, "ipg");
184 if (IS_ERR(data->clk_ipg)) {
185 /* If the platform only needs one clocks */
186 data->clk = devm_clk_get(dev, NULL);
187 if (IS_ERR(data->clk)) {
188 ret = PTR_ERR(data->clk);
190 "Failed to get clks, err=%ld,%ld\n",
191 PTR_ERR(data->clk), PTR_ERR(data->clk_ipg));
197 data->clk_ahb = devm_clk_get(dev, "ahb");
198 if (IS_ERR(data->clk_ahb)) {
199 ret = PTR_ERR(data->clk_ahb);
201 "Failed to get ahb clock, err=%d\n", ret);
205 data->clk_per = devm_clk_get(dev, "per");
206 if (IS_ERR(data->clk_per)) {
207 ret = PTR_ERR(data->clk_per);
209 "Failed to get per clock, err=%d\n", ret);
213 data->need_three_clks = true;
217 static int imx_prepare_enable_clks(struct device *dev)
219 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
222 if (data->need_three_clks) {
223 ret = clk_prepare_enable(data->clk_ipg);
226 "Failed to prepare/enable ipg clk, err=%d\n",
231 ret = clk_prepare_enable(data->clk_ahb);
234 "Failed to prepare/enable ahb clk, err=%d\n",
236 clk_disable_unprepare(data->clk_ipg);
240 ret = clk_prepare_enable(data->clk_per);
243 "Failed to prepare/enable per clk, err=%d\n",
245 clk_disable_unprepare(data->clk_ahb);
246 clk_disable_unprepare(data->clk_ipg);
250 ret = clk_prepare_enable(data->clk);
253 "Failed to prepare/enable clk, err=%d\n",
262 static void imx_disable_unprepare_clks(struct device *dev)
264 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
266 if (data->need_three_clks) {
267 clk_disable_unprepare(data->clk_per);
268 clk_disable_unprepare(data->clk_ahb);
269 clk_disable_unprepare(data->clk_ipg);
271 clk_disable_unprepare(data->clk);
275 static int ci_hdrc_imx_notify_event(struct ci_hdrc *ci, unsigned int event)
277 struct device *dev = ci->dev->parent;
278 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
280 struct imx_usbmisc_data *mdata = data->usbmisc_data;
283 case CI_HDRC_IMX_HSIC_ACTIVE_EVENT:
285 ret = pinctrl_select_state(data->pinctrl,
286 data->pinctrl_hsic_active);
289 "hsic_active select failed, err=%d\n",
293 case CI_HDRC_IMX_HSIC_SUSPEND_EVENT:
294 ret = imx_usbmisc_hsic_set_connect(mdata);
297 "hsic_set_connect failed, err=%d\n", ret);
299 case CI_HDRC_CONTROLLER_VBUS_EVENT:
301 ret = imx_usbmisc_charger_detection(mdata, true);
303 ret = imx_usbmisc_charger_detection(mdata, false);
305 schedule_work(&ci->usb_phy->chg_work);
314 static int ci_hdrc_imx_probe(struct platform_device *pdev)
316 struct ci_hdrc_imx_data *data;
317 struct ci_hdrc_platform_data pdata = {
318 .name = dev_name(&pdev->dev),
319 .capoffset = DEF_CAPOFFSET,
320 .notify_event = ci_hdrc_imx_notify_event,
323 const struct ci_hdrc_imx_platform_flag *imx_platform_flag;
324 struct device_node *np = pdev->dev.of_node;
325 struct device *dev = &pdev->dev;
327 imx_platform_flag = of_device_get_match_data(&pdev->dev);
329 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
333 data->plat_data = imx_platform_flag;
334 pdata.flags |= imx_platform_flag->flags;
335 platform_set_drvdata(pdev, data);
336 data->usbmisc_data = usbmisc_get_init_data(dev);
337 if (IS_ERR(data->usbmisc_data))
338 return PTR_ERR(data->usbmisc_data);
340 if ((of_usb_get_phy_mode(dev->of_node) == USBPHY_INTERFACE_MODE_HSIC)
341 && data->usbmisc_data) {
342 pdata.flags |= CI_HDRC_IMX_IS_HSIC;
343 data->usbmisc_data->hsic = 1;
344 data->pinctrl = devm_pinctrl_get(dev);
345 if (PTR_ERR(data->pinctrl) == -ENODEV)
346 data->pinctrl = NULL;
347 else if (IS_ERR(data->pinctrl)) {
348 if (PTR_ERR(data->pinctrl) != -EPROBE_DEFER)
349 dev_err(dev, "pinctrl get failed, err=%ld\n",
350 PTR_ERR(data->pinctrl));
351 return PTR_ERR(data->pinctrl);
354 data->hsic_pad_regulator =
355 devm_regulator_get_optional(dev, "hsic");
356 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 if (PTR_ERR(data->hsic_pad_regulator) != -EPROBE_DEFER)
362 "Get HSIC pad regulator error: %ld\n",
363 PTR_ERR(data->hsic_pad_regulator));
364 return PTR_ERR(data->hsic_pad_regulator);
367 if (data->hsic_pad_regulator) {
368 ret = regulator_enable(data->hsic_pad_regulator);
371 "Failed to enable HSIC pad regulator\n");
377 /* HSIC pinctrl handling */
379 struct pinctrl_state *pinctrl_hsic_idle;
381 pinctrl_hsic_idle = pinctrl_lookup_state(data->pinctrl, "idle");
382 if (IS_ERR(pinctrl_hsic_idle)) {
384 "pinctrl_hsic_idle lookup failed, err=%ld\n",
385 PTR_ERR(pinctrl_hsic_idle));
386 return PTR_ERR(pinctrl_hsic_idle);
389 ret = pinctrl_select_state(data->pinctrl, pinctrl_hsic_idle);
391 dev_err(dev, "hsic_idle select failed, err=%d\n", ret);
395 data->pinctrl_hsic_active = pinctrl_lookup_state(data->pinctrl,
397 if (IS_ERR(data->pinctrl_hsic_active)) {
399 "pinctrl_hsic_active lookup failed, err=%ld\n",
400 PTR_ERR(data->pinctrl_hsic_active));
401 return PTR_ERR(data->pinctrl_hsic_active);
405 if (pdata.flags & CI_HDRC_PMQOS)
406 cpu_latency_qos_add_request(&data->pm_qos_req, 0);
408 ret = imx_get_clks(dev);
410 goto disable_hsic_regulator;
412 ret = imx_prepare_enable_clks(dev);
414 goto disable_hsic_regulator;
416 data->phy = devm_usb_get_phy_by_phandle(dev, "fsl,usbphy", 0);
417 if (IS_ERR(data->phy)) {
418 ret = PTR_ERR(data->phy);
419 /* Return -EINVAL if no usbphy is available */
426 pdata.usb_phy = data->phy;
427 if (data->usbmisc_data)
428 data->usbmisc_data->usb_phy = data->phy;
430 if ((of_device_is_compatible(np, "fsl,imx53-usb") ||
431 of_device_is_compatible(np, "fsl,imx51-usb")) && pdata.usb_phy &&
432 of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI) {
433 pdata.flags |= CI_HDRC_OVERRIDE_PHY_CONTROL;
434 data->override_phy_control = true;
435 usb_phy_init(pdata.usb_phy);
438 if (pdata.flags & CI_HDRC_SUPPORTS_RUNTIME_PM)
439 data->supports_runtime_pm = true;
441 ret = imx_usbmisc_init(data->usbmisc_data);
443 dev_err(dev, "usbmisc init failed, ret=%d\n", ret);
447 data->ci_pdev = ci_hdrc_add_device(dev,
448 pdev->resource, pdev->num_resources,
450 if (IS_ERR(data->ci_pdev)) {
451 ret = PTR_ERR(data->ci_pdev);
452 if (ret != -EPROBE_DEFER)
453 dev_err(dev, "ci_hdrc_add_device failed, err=%d\n",
458 if (data->usbmisc_data) {
459 if (!IS_ERR(pdata.id_extcon.edev) ||
460 of_property_read_bool(np, "usb-role-switch"))
461 data->usbmisc_data->ext_id = 1;
463 if (!IS_ERR(pdata.vbus_extcon.edev) ||
464 of_property_read_bool(np, "usb-role-switch"))
465 data->usbmisc_data->ext_vbus = 1;
467 /* usbmisc needs to know dr mode to choose wakeup setting */
468 data->usbmisc_data->available_role =
469 ci_hdrc_query_available_role(data->ci_pdev);
472 ret = imx_usbmisc_init_post(data->usbmisc_data);
474 dev_err(dev, "usbmisc post failed, ret=%d\n", ret);
478 if (data->supports_runtime_pm) {
479 pm_runtime_set_active(dev);
480 pm_runtime_enable(dev);
483 device_set_wakeup_capable(dev, true);
488 ci_hdrc_remove_device(data->ci_pdev);
490 imx_disable_unprepare_clks(dev);
491 disable_hsic_regulator:
492 if (data->hsic_pad_regulator)
493 /* don't overwrite original ret (cf. EPROBE_DEFER) */
494 regulator_disable(data->hsic_pad_regulator);
495 if (pdata.flags & CI_HDRC_PMQOS)
496 cpu_latency_qos_remove_request(&data->pm_qos_req);
497 data->ci_pdev = NULL;
501 static int ci_hdrc_imx_remove(struct platform_device *pdev)
503 struct ci_hdrc_imx_data *data = platform_get_drvdata(pdev);
505 if (data->supports_runtime_pm) {
506 pm_runtime_get_sync(&pdev->dev);
507 pm_runtime_disable(&pdev->dev);
508 pm_runtime_put_noidle(&pdev->dev);
511 ci_hdrc_remove_device(data->ci_pdev);
512 if (data->override_phy_control)
513 usb_phy_shutdown(data->phy);
515 imx_disable_unprepare_clks(&pdev->dev);
516 if (data->plat_data->flags & CI_HDRC_PMQOS)
517 cpu_latency_qos_remove_request(&data->pm_qos_req);
518 if (data->hsic_pad_regulator)
519 regulator_disable(data->hsic_pad_regulator);
525 static void ci_hdrc_imx_shutdown(struct platform_device *pdev)
527 ci_hdrc_imx_remove(pdev);
530 static int __maybe_unused imx_controller_suspend(struct device *dev)
532 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
535 dev_dbg(dev, "at %s\n", __func__);
537 ret = imx_usbmisc_hsic_set_clk(data->usbmisc_data, false);
539 dev_err(dev, "usbmisc hsic_set_clk failed, ret=%d\n", ret);
543 imx_disable_unprepare_clks(dev);
544 if (data->plat_data->flags & CI_HDRC_PMQOS)
545 cpu_latency_qos_remove_request(&data->pm_qos_req);
552 static int __maybe_unused imx_controller_resume(struct device *dev)
554 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
557 dev_dbg(dev, "at %s\n", __func__);
564 if (data->plat_data->flags & CI_HDRC_PMQOS)
565 cpu_latency_qos_add_request(&data->pm_qos_req, 0);
567 ret = imx_prepare_enable_clks(dev);
571 data->in_lpm = false;
573 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, false);
575 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
579 ret = imx_usbmisc_hsic_set_clk(data->usbmisc_data, true);
581 dev_err(dev, "usbmisc hsic_set_clk failed, ret=%d\n", ret);
582 goto hsic_set_clk_fail;
588 imx_usbmisc_set_wakeup(data->usbmisc_data, true);
590 imx_disable_unprepare_clks(dev);
594 static int __maybe_unused ci_hdrc_imx_suspend(struct device *dev)
598 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
601 /* The core's suspend doesn't run */
604 if (device_may_wakeup(dev)) {
605 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
607 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n",
613 ret = imx_controller_suspend(dev);
617 pinctrl_pm_select_sleep_state(dev);
621 static int __maybe_unused ci_hdrc_imx_resume(struct device *dev)
623 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
626 pinctrl_pm_select_default_state(dev);
627 ret = imx_controller_resume(dev);
628 if (!ret && data->supports_runtime_pm) {
629 pm_runtime_disable(dev);
630 pm_runtime_set_active(dev);
631 pm_runtime_enable(dev);
637 static int __maybe_unused ci_hdrc_imx_runtime_suspend(struct device *dev)
639 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
647 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
649 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
653 return imx_controller_suspend(dev);
656 static int __maybe_unused ci_hdrc_imx_runtime_resume(struct device *dev)
658 return imx_controller_resume(dev);
661 static const struct dev_pm_ops ci_hdrc_imx_pm_ops = {
662 SET_SYSTEM_SLEEP_PM_OPS(ci_hdrc_imx_suspend, ci_hdrc_imx_resume)
663 SET_RUNTIME_PM_OPS(ci_hdrc_imx_runtime_suspend,
664 ci_hdrc_imx_runtime_resume, NULL)
666 static struct platform_driver ci_hdrc_imx_driver = {
667 .probe = ci_hdrc_imx_probe,
668 .remove = ci_hdrc_imx_remove,
669 .shutdown = ci_hdrc_imx_shutdown,
672 .of_match_table = ci_hdrc_imx_dt_ids,
673 .pm = &ci_hdrc_imx_pm_ops,
677 module_platform_driver(ci_hdrc_imx_driver);
679 MODULE_ALIAS("platform:imx-usb");
680 MODULE_LICENSE("GPL");
681 MODULE_DESCRIPTION("CI HDRC i.MX USB binding");
682 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
683 MODULE_AUTHOR("Richard Zhao <richard.zhao@freescale.com>");