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 ci_hdrc_imx_platform_flag imx8ulp_usb_data = {
74 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM,
77 static const struct of_device_id ci_hdrc_imx_dt_ids[] = {
78 { .compatible = "fsl,imx23-usb", .data = &imx23_usb_data},
79 { .compatible = "fsl,imx28-usb", .data = &imx28_usb_data},
80 { .compatible = "fsl,imx27-usb", .data = &imx27_usb_data},
81 { .compatible = "fsl,imx6q-usb", .data = &imx6q_usb_data},
82 { .compatible = "fsl,imx6sl-usb", .data = &imx6sl_usb_data},
83 { .compatible = "fsl,imx6sx-usb", .data = &imx6sx_usb_data},
84 { .compatible = "fsl,imx6ul-usb", .data = &imx6ul_usb_data},
85 { .compatible = "fsl,imx7d-usb", .data = &imx7d_usb_data},
86 { .compatible = "fsl,imx7ulp-usb", .data = &imx7ulp_usb_data},
87 { .compatible = "fsl,imx8ulp-usb", .data = &imx8ulp_usb_data},
90 MODULE_DEVICE_TABLE(of, ci_hdrc_imx_dt_ids);
92 struct ci_hdrc_imx_data {
94 struct platform_device *ci_pdev;
96 struct imx_usbmisc_data *usbmisc_data;
97 bool supports_runtime_pm;
98 bool override_phy_control;
100 struct pinctrl *pinctrl;
101 struct pinctrl_state *pinctrl_hsic_active;
102 struct regulator *hsic_pad_regulator;
103 /* SoC before i.mx6 (except imx23/imx28) needs three clks */
104 bool need_three_clks;
108 /* --------------------------------- */
109 struct pm_qos_request pm_qos_req;
110 const struct ci_hdrc_imx_platform_flag *plat_data;
113 /* Common functions shared by usbmisc drivers */
115 static struct imx_usbmisc_data *usbmisc_get_init_data(struct device *dev)
117 struct platform_device *misc_pdev;
118 struct device_node *np = dev->of_node;
119 struct of_phandle_args args;
120 struct imx_usbmisc_data *data;
124 * In case the fsl,usbmisc property is not present this device doesn't
125 * need usbmisc. Return NULL (which is no error here)
127 if (!of_get_property(np, "fsl,usbmisc", NULL))
130 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
132 return ERR_PTR(-ENOMEM);
134 ret = of_parse_phandle_with_args(np, "fsl,usbmisc", "#index-cells",
137 dev_err(dev, "Failed to parse property fsl,usbmisc, errno %d\n",
142 data->index = args.args[0];
144 misc_pdev = of_find_device_by_node(args.np);
145 of_node_put(args.np);
148 return ERR_PTR(-EPROBE_DEFER);
150 if (!platform_get_drvdata(misc_pdev)) {
151 put_device(&misc_pdev->dev);
152 return ERR_PTR(-EPROBE_DEFER);
154 data->dev = &misc_pdev->dev;
157 * Check the various over current related properties. If over current
158 * detection is disabled we're not interested in the polarity.
160 if (of_find_property(np, "disable-over-current", NULL)) {
161 data->disable_oc = 1;
162 } else if (of_find_property(np, "over-current-active-high", NULL)) {
163 data->oc_pol_active_low = 0;
164 data->oc_pol_configured = 1;
165 } else if (of_find_property(np, "over-current-active-low", NULL)) {
166 data->oc_pol_active_low = 1;
167 data->oc_pol_configured = 1;
169 dev_warn(dev, "No over current polarity defined\n");
172 data->pwr_pol = of_property_read_bool(np, "power-active-high");
173 data->evdo = of_property_read_bool(np, "external-vbus-divider");
175 if (of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI)
178 if (of_property_read_u32(np, "samsung,picophy-pre-emp-curr-control",
179 &data->emp_curr_control))
180 data->emp_curr_control = -1;
181 if (of_property_read_u32(np, "samsung,picophy-dc-vol-level-adjust",
182 &data->dc_vol_level_adjust))
183 data->dc_vol_level_adjust = -1;
188 /* End of common functions shared by usbmisc drivers*/
189 static int imx_get_clks(struct device *dev)
191 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
194 data->clk_ipg = devm_clk_get(dev, "ipg");
195 if (IS_ERR(data->clk_ipg)) {
196 /* If the platform only needs one clocks */
197 data->clk = devm_clk_get(dev, NULL);
198 if (IS_ERR(data->clk)) {
199 ret = PTR_ERR(data->clk);
201 "Failed to get clks, err=%ld,%ld\n",
202 PTR_ERR(data->clk), PTR_ERR(data->clk_ipg));
208 data->clk_ahb = devm_clk_get(dev, "ahb");
209 if (IS_ERR(data->clk_ahb)) {
210 ret = PTR_ERR(data->clk_ahb);
212 "Failed to get ahb clock, err=%d\n", ret);
216 data->clk_per = devm_clk_get(dev, "per");
217 if (IS_ERR(data->clk_per)) {
218 ret = PTR_ERR(data->clk_per);
220 "Failed to get per clock, err=%d\n", ret);
224 data->need_three_clks = true;
228 static int imx_prepare_enable_clks(struct device *dev)
230 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
233 if (data->need_three_clks) {
234 ret = clk_prepare_enable(data->clk_ipg);
237 "Failed to prepare/enable ipg clk, err=%d\n",
242 ret = clk_prepare_enable(data->clk_ahb);
245 "Failed to prepare/enable ahb clk, err=%d\n",
247 clk_disable_unprepare(data->clk_ipg);
251 ret = clk_prepare_enable(data->clk_per);
254 "Failed to prepare/enable per clk, err=%d\n",
256 clk_disable_unprepare(data->clk_ahb);
257 clk_disable_unprepare(data->clk_ipg);
261 ret = clk_prepare_enable(data->clk);
264 "Failed to prepare/enable clk, err=%d\n",
273 static void imx_disable_unprepare_clks(struct device *dev)
275 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
277 if (data->need_three_clks) {
278 clk_disable_unprepare(data->clk_per);
279 clk_disable_unprepare(data->clk_ahb);
280 clk_disable_unprepare(data->clk_ipg);
282 clk_disable_unprepare(data->clk);
286 static int ci_hdrc_imx_notify_event(struct ci_hdrc *ci, unsigned int event)
288 struct device *dev = ci->dev->parent;
289 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
291 struct imx_usbmisc_data *mdata = data->usbmisc_data;
294 case CI_HDRC_IMX_HSIC_ACTIVE_EVENT:
296 ret = pinctrl_select_state(data->pinctrl,
297 data->pinctrl_hsic_active);
300 "hsic_active select failed, err=%d\n",
304 case CI_HDRC_IMX_HSIC_SUSPEND_EVENT:
305 ret = imx_usbmisc_hsic_set_connect(mdata);
308 "hsic_set_connect failed, err=%d\n", ret);
310 case CI_HDRC_CONTROLLER_VBUS_EVENT:
312 ret = imx_usbmisc_charger_detection(mdata, true);
314 ret = imx_usbmisc_charger_detection(mdata, false);
316 schedule_work(&ci->usb_phy->chg_work);
325 static int ci_hdrc_imx_probe(struct platform_device *pdev)
327 struct ci_hdrc_imx_data *data;
328 struct ci_hdrc_platform_data pdata = {
329 .name = dev_name(&pdev->dev),
330 .capoffset = DEF_CAPOFFSET,
331 .notify_event = ci_hdrc_imx_notify_event,
334 const struct of_device_id *of_id;
335 const struct ci_hdrc_imx_platform_flag *imx_platform_flag;
336 struct device_node *np = pdev->dev.of_node;
337 struct device *dev = &pdev->dev;
339 of_id = of_match_device(ci_hdrc_imx_dt_ids, dev);
343 imx_platform_flag = of_id->data;
345 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
349 data->plat_data = imx_platform_flag;
350 pdata.flags |= imx_platform_flag->flags;
351 platform_set_drvdata(pdev, data);
352 data->usbmisc_data = usbmisc_get_init_data(dev);
353 if (IS_ERR(data->usbmisc_data))
354 return PTR_ERR(data->usbmisc_data);
356 if ((of_usb_get_phy_mode(dev->of_node) == USBPHY_INTERFACE_MODE_HSIC)
357 && data->usbmisc_data) {
358 pdata.flags |= CI_HDRC_IMX_IS_HSIC;
359 data->usbmisc_data->hsic = 1;
360 data->pinctrl = devm_pinctrl_get(dev);
361 if (PTR_ERR(data->pinctrl) == -ENODEV)
362 data->pinctrl = NULL;
363 else if (IS_ERR(data->pinctrl)) {
364 if (PTR_ERR(data->pinctrl) != -EPROBE_DEFER)
365 dev_err(dev, "pinctrl get failed, err=%ld\n",
366 PTR_ERR(data->pinctrl));
367 return PTR_ERR(data->pinctrl);
370 data->hsic_pad_regulator =
371 devm_regulator_get_optional(dev, "hsic");
372 if (PTR_ERR(data->hsic_pad_regulator) == -ENODEV) {
373 /* no pad regualator is needed */
374 data->hsic_pad_regulator = NULL;
375 } else if (IS_ERR(data->hsic_pad_regulator)) {
376 if (PTR_ERR(data->hsic_pad_regulator) != -EPROBE_DEFER)
378 "Get HSIC pad regulator error: %ld\n",
379 PTR_ERR(data->hsic_pad_regulator));
380 return PTR_ERR(data->hsic_pad_regulator);
383 if (data->hsic_pad_regulator) {
384 ret = regulator_enable(data->hsic_pad_regulator);
387 "Failed to enable HSIC pad regulator\n");
393 /* HSIC pinctrl handling */
395 struct pinctrl_state *pinctrl_hsic_idle;
397 pinctrl_hsic_idle = pinctrl_lookup_state(data->pinctrl, "idle");
398 if (IS_ERR(pinctrl_hsic_idle)) {
400 "pinctrl_hsic_idle lookup failed, err=%ld\n",
401 PTR_ERR(pinctrl_hsic_idle));
402 return PTR_ERR(pinctrl_hsic_idle);
405 ret = pinctrl_select_state(data->pinctrl, pinctrl_hsic_idle);
407 dev_err(dev, "hsic_idle select failed, err=%d\n", ret);
411 data->pinctrl_hsic_active = pinctrl_lookup_state(data->pinctrl,
413 if (IS_ERR(data->pinctrl_hsic_active)) {
415 "pinctrl_hsic_active lookup failed, err=%ld\n",
416 PTR_ERR(data->pinctrl_hsic_active));
417 return PTR_ERR(data->pinctrl_hsic_active);
421 if (pdata.flags & CI_HDRC_PMQOS)
422 cpu_latency_qos_add_request(&data->pm_qos_req, 0);
424 ret = imx_get_clks(dev);
426 goto disable_hsic_regulator;
428 ret = imx_prepare_enable_clks(dev);
430 goto disable_hsic_regulator;
432 data->phy = devm_usb_get_phy_by_phandle(dev, "fsl,usbphy", 0);
433 if (IS_ERR(data->phy)) {
434 ret = PTR_ERR(data->phy);
437 data->phy = devm_usb_get_phy_by_phandle(dev, "phys", 0);
438 if (IS_ERR(data->phy)) {
439 ret = PTR_ERR(data->phy);
447 pdata.usb_phy = data->phy;
448 if (data->usbmisc_data)
449 data->usbmisc_data->usb_phy = data->phy;
451 if ((of_device_is_compatible(np, "fsl,imx53-usb") ||
452 of_device_is_compatible(np, "fsl,imx51-usb")) && pdata.usb_phy &&
453 of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI) {
454 pdata.flags |= CI_HDRC_OVERRIDE_PHY_CONTROL;
455 data->override_phy_control = true;
456 usb_phy_init(pdata.usb_phy);
459 if (pdata.flags & CI_HDRC_SUPPORTS_RUNTIME_PM)
460 data->supports_runtime_pm = true;
462 ret = imx_usbmisc_init(data->usbmisc_data);
464 dev_err(dev, "usbmisc init failed, ret=%d\n", ret);
468 data->ci_pdev = ci_hdrc_add_device(dev,
469 pdev->resource, pdev->num_resources,
471 if (IS_ERR(data->ci_pdev)) {
472 ret = PTR_ERR(data->ci_pdev);
473 if (ret != -EPROBE_DEFER)
474 dev_err(dev, "ci_hdrc_add_device failed, err=%d\n",
479 if (data->usbmisc_data) {
480 if (!IS_ERR(pdata.id_extcon.edev) ||
481 of_property_read_bool(np, "usb-role-switch"))
482 data->usbmisc_data->ext_id = 1;
484 if (!IS_ERR(pdata.vbus_extcon.edev) ||
485 of_property_read_bool(np, "usb-role-switch"))
486 data->usbmisc_data->ext_vbus = 1;
488 /* usbmisc needs to know dr mode to choose wakeup setting */
489 data->usbmisc_data->available_role =
490 ci_hdrc_query_available_role(data->ci_pdev);
493 ret = imx_usbmisc_init_post(data->usbmisc_data);
495 dev_err(dev, "usbmisc post failed, ret=%d\n", ret);
499 if (data->supports_runtime_pm) {
500 pm_runtime_set_active(dev);
501 pm_runtime_enable(dev);
504 device_set_wakeup_capable(dev, true);
509 ci_hdrc_remove_device(data->ci_pdev);
511 imx_disable_unprepare_clks(dev);
512 disable_hsic_regulator:
513 if (data->hsic_pad_regulator)
514 /* don't overwrite original ret (cf. EPROBE_DEFER) */
515 regulator_disable(data->hsic_pad_regulator);
516 if (pdata.flags & CI_HDRC_PMQOS)
517 cpu_latency_qos_remove_request(&data->pm_qos_req);
518 data->ci_pdev = NULL;
522 static int ci_hdrc_imx_remove(struct platform_device *pdev)
524 struct ci_hdrc_imx_data *data = platform_get_drvdata(pdev);
526 if (data->supports_runtime_pm) {
527 pm_runtime_get_sync(&pdev->dev);
528 pm_runtime_disable(&pdev->dev);
529 pm_runtime_put_noidle(&pdev->dev);
532 ci_hdrc_remove_device(data->ci_pdev);
533 if (data->override_phy_control)
534 usb_phy_shutdown(data->phy);
536 imx_disable_unprepare_clks(&pdev->dev);
537 if (data->plat_data->flags & CI_HDRC_PMQOS)
538 cpu_latency_qos_remove_request(&data->pm_qos_req);
539 if (data->hsic_pad_regulator)
540 regulator_disable(data->hsic_pad_regulator);
546 static void ci_hdrc_imx_shutdown(struct platform_device *pdev)
548 ci_hdrc_imx_remove(pdev);
551 static int __maybe_unused imx_controller_suspend(struct device *dev)
553 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
556 dev_dbg(dev, "at %s\n", __func__);
558 ret = imx_usbmisc_hsic_set_clk(data->usbmisc_data, false);
560 dev_err(dev, "usbmisc hsic_set_clk failed, ret=%d\n", ret);
564 imx_disable_unprepare_clks(dev);
565 if (data->plat_data->flags & CI_HDRC_PMQOS)
566 cpu_latency_qos_remove_request(&data->pm_qos_req);
573 static int __maybe_unused imx_controller_resume(struct device *dev)
575 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
578 dev_dbg(dev, "at %s\n", __func__);
585 if (data->plat_data->flags & CI_HDRC_PMQOS)
586 cpu_latency_qos_add_request(&data->pm_qos_req, 0);
588 ret = imx_prepare_enable_clks(dev);
592 data->in_lpm = false;
594 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, false);
596 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
600 ret = imx_usbmisc_hsic_set_clk(data->usbmisc_data, true);
602 dev_err(dev, "usbmisc hsic_set_clk failed, ret=%d\n", ret);
603 goto hsic_set_clk_fail;
609 imx_usbmisc_set_wakeup(data->usbmisc_data, true);
611 imx_disable_unprepare_clks(dev);
615 static int __maybe_unused ci_hdrc_imx_suspend(struct device *dev)
619 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
622 /* The core's suspend doesn't run */
625 if (device_may_wakeup(dev)) {
626 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
628 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n",
634 ret = imx_controller_suspend(dev);
638 pinctrl_pm_select_sleep_state(dev);
642 static int __maybe_unused ci_hdrc_imx_resume(struct device *dev)
644 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
647 pinctrl_pm_select_default_state(dev);
648 ret = imx_controller_resume(dev);
649 if (!ret && data->supports_runtime_pm) {
650 pm_runtime_disable(dev);
651 pm_runtime_set_active(dev);
652 pm_runtime_enable(dev);
658 static int __maybe_unused ci_hdrc_imx_runtime_suspend(struct device *dev)
660 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
668 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
670 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
674 return imx_controller_suspend(dev);
677 static int __maybe_unused ci_hdrc_imx_runtime_resume(struct device *dev)
679 return imx_controller_resume(dev);
682 static const struct dev_pm_ops ci_hdrc_imx_pm_ops = {
683 SET_SYSTEM_SLEEP_PM_OPS(ci_hdrc_imx_suspend, ci_hdrc_imx_resume)
684 SET_RUNTIME_PM_OPS(ci_hdrc_imx_runtime_suspend,
685 ci_hdrc_imx_runtime_resume, NULL)
687 static struct platform_driver ci_hdrc_imx_driver = {
688 .probe = ci_hdrc_imx_probe,
689 .remove = ci_hdrc_imx_remove,
690 .shutdown = ci_hdrc_imx_shutdown,
693 .of_match_table = ci_hdrc_imx_dt_ids,
694 .pm = &ci_hdrc_imx_pm_ops,
698 module_platform_driver(ci_hdrc_imx_driver);
700 MODULE_ALIAS("platform:imx-usb");
701 MODULE_LICENSE("GPL");
702 MODULE_DESCRIPTION("CI HDRC i.MX USB binding");
703 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
704 MODULE_AUTHOR("Richard Zhao <richard.zhao@freescale.com>");