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>
10 #include <linux/of_platform.h>
11 #include <linux/platform_device.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/usb/chipidea.h>
14 #include <linux/usb/of.h>
15 #include <linux/clk.h>
16 #include <linux/pinctrl/consumer.h>
17 #include <linux/pm_qos.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 |
62 CI_HDRC_DISABLE_DEVICE_STREAMING,
65 static const struct ci_hdrc_imx_platform_flag imx7d_usb_data = {
66 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM,
69 static const struct ci_hdrc_imx_platform_flag imx7ulp_usb_data = {
70 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM |
71 CI_HDRC_HAS_PORTSC_PEC_MISSED |
75 static const struct ci_hdrc_imx_platform_flag imx8ulp_usb_data = {
76 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM |
77 CI_HDRC_HAS_PORTSC_PEC_MISSED,
80 static const struct of_device_id ci_hdrc_imx_dt_ids[] = {
81 { .compatible = "fsl,imx23-usb", .data = &imx23_usb_data},
82 { .compatible = "fsl,imx28-usb", .data = &imx28_usb_data},
83 { .compatible = "fsl,imx27-usb", .data = &imx27_usb_data},
84 { .compatible = "fsl,imx6q-usb", .data = &imx6q_usb_data},
85 { .compatible = "fsl,imx6sl-usb", .data = &imx6sl_usb_data},
86 { .compatible = "fsl,imx6sx-usb", .data = &imx6sx_usb_data},
87 { .compatible = "fsl,imx6ul-usb", .data = &imx6ul_usb_data},
88 { .compatible = "fsl,imx7d-usb", .data = &imx7d_usb_data},
89 { .compatible = "fsl,imx7ulp-usb", .data = &imx7ulp_usb_data},
90 { .compatible = "fsl,imx8ulp-usb", .data = &imx8ulp_usb_data},
93 MODULE_DEVICE_TABLE(of, ci_hdrc_imx_dt_ids);
95 struct ci_hdrc_imx_data {
97 struct platform_device *ci_pdev;
99 struct imx_usbmisc_data *usbmisc_data;
100 bool supports_runtime_pm;
101 bool override_phy_control;
103 struct pinctrl *pinctrl;
104 struct pinctrl_state *pinctrl_hsic_active;
105 struct regulator *hsic_pad_regulator;
106 /* SoC before i.mx6 (except imx23/imx28) needs three clks */
107 bool need_three_clks;
111 /* --------------------------------- */
112 struct pm_qos_request pm_qos_req;
113 const struct ci_hdrc_imx_platform_flag *plat_data;
116 /* Common functions shared by usbmisc drivers */
118 static struct imx_usbmisc_data *usbmisc_get_init_data(struct device *dev)
120 struct platform_device *misc_pdev;
121 struct device_node *np = dev->of_node;
122 struct of_phandle_args args;
123 struct imx_usbmisc_data *data;
127 * In case the fsl,usbmisc property is not present this device doesn't
128 * need usbmisc. Return NULL (which is no error here)
130 if (!of_get_property(np, "fsl,usbmisc", NULL))
133 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
135 return ERR_PTR(-ENOMEM);
137 ret = of_parse_phandle_with_args(np, "fsl,usbmisc", "#index-cells",
140 dev_err(dev, "Failed to parse property fsl,usbmisc, errno %d\n",
145 data->index = args.args[0];
147 misc_pdev = of_find_device_by_node(args.np);
148 of_node_put(args.np);
151 return ERR_PTR(-EPROBE_DEFER);
153 if (!platform_get_drvdata(misc_pdev)) {
154 put_device(&misc_pdev->dev);
155 return ERR_PTR(-EPROBE_DEFER);
157 data->dev = &misc_pdev->dev;
160 * Check the various over current related properties. If over current
161 * detection is disabled we're not interested in the polarity.
163 if (of_property_read_bool(np, "disable-over-current")) {
164 data->disable_oc = 1;
165 } else if (of_property_read_bool(np, "over-current-active-high")) {
166 data->oc_pol_active_low = 0;
167 data->oc_pol_configured = 1;
168 } else if (of_property_read_bool(np, "over-current-active-low")) {
169 data->oc_pol_active_low = 1;
170 data->oc_pol_configured = 1;
172 dev_warn(dev, "No over current polarity defined\n");
175 data->pwr_pol = of_property_read_bool(np, "power-active-high");
176 data->evdo = of_property_read_bool(np, "external-vbus-divider");
178 if (of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI)
181 if (of_property_read_u32(np, "samsung,picophy-pre-emp-curr-control",
182 &data->emp_curr_control))
183 data->emp_curr_control = -1;
184 if (of_property_read_u32(np, "samsung,picophy-dc-vol-level-adjust",
185 &data->dc_vol_level_adjust))
186 data->dc_vol_level_adjust = -1;
187 if (of_property_read_u32(np, "fsl,picophy-rise-fall-time-adjust",
188 &data->rise_fall_time_adjust))
189 data->rise_fall_time_adjust = -1;
194 /* End of common functions shared by usbmisc drivers*/
195 static int imx_get_clks(struct device *dev)
197 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
200 data->clk_ipg = devm_clk_get(dev, "ipg");
201 if (IS_ERR(data->clk_ipg)) {
202 /* If the platform only needs one clocks */
203 data->clk = devm_clk_get(dev, NULL);
204 if (IS_ERR(data->clk)) {
205 ret = PTR_ERR(data->clk);
207 "Failed to get clks, err=%ld,%ld\n",
208 PTR_ERR(data->clk), PTR_ERR(data->clk_ipg));
214 data->clk_ahb = devm_clk_get(dev, "ahb");
215 if (IS_ERR(data->clk_ahb)) {
216 ret = PTR_ERR(data->clk_ahb);
218 "Failed to get ahb clock, err=%d\n", ret);
222 data->clk_per = devm_clk_get(dev, "per");
223 if (IS_ERR(data->clk_per)) {
224 ret = PTR_ERR(data->clk_per);
226 "Failed to get per clock, err=%d\n", ret);
230 data->need_three_clks = true;
234 static int imx_prepare_enable_clks(struct device *dev)
236 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
239 if (data->need_three_clks) {
240 ret = clk_prepare_enable(data->clk_ipg);
243 "Failed to prepare/enable ipg clk, err=%d\n",
248 ret = clk_prepare_enable(data->clk_ahb);
251 "Failed to prepare/enable ahb clk, err=%d\n",
253 clk_disable_unprepare(data->clk_ipg);
257 ret = clk_prepare_enable(data->clk_per);
260 "Failed to prepare/enable per clk, err=%d\n",
262 clk_disable_unprepare(data->clk_ahb);
263 clk_disable_unprepare(data->clk_ipg);
267 ret = clk_prepare_enable(data->clk);
270 "Failed to prepare/enable clk, err=%d\n",
279 static void imx_disable_unprepare_clks(struct device *dev)
281 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
283 if (data->need_three_clks) {
284 clk_disable_unprepare(data->clk_per);
285 clk_disable_unprepare(data->clk_ahb);
286 clk_disable_unprepare(data->clk_ipg);
288 clk_disable_unprepare(data->clk);
292 static int ci_hdrc_imx_notify_event(struct ci_hdrc *ci, unsigned int event)
294 struct device *dev = ci->dev->parent;
295 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
297 struct imx_usbmisc_data *mdata = data->usbmisc_data;
300 case CI_HDRC_IMX_HSIC_ACTIVE_EVENT:
302 ret = pinctrl_select_state(data->pinctrl,
303 data->pinctrl_hsic_active);
306 "hsic_active select failed, err=%d\n",
310 case CI_HDRC_IMX_HSIC_SUSPEND_EVENT:
311 ret = imx_usbmisc_hsic_set_connect(mdata);
314 "hsic_set_connect failed, err=%d\n", ret);
316 case CI_HDRC_CONTROLLER_VBUS_EVENT:
318 ret = imx_usbmisc_charger_detection(mdata, true);
320 ret = imx_usbmisc_charger_detection(mdata, false);
322 schedule_work(&ci->usb_phy->chg_work);
331 static int ci_hdrc_imx_probe(struct platform_device *pdev)
333 struct ci_hdrc_imx_data *data;
334 struct ci_hdrc_platform_data pdata = {
335 .name = dev_name(&pdev->dev),
336 .capoffset = DEF_CAPOFFSET,
337 .notify_event = ci_hdrc_imx_notify_event,
340 const struct ci_hdrc_imx_platform_flag *imx_platform_flag;
341 struct device_node *np = pdev->dev.of_node;
342 struct device *dev = &pdev->dev;
344 imx_platform_flag = of_device_get_match_data(&pdev->dev);
346 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
350 data->plat_data = imx_platform_flag;
351 pdata.flags |= imx_platform_flag->flags;
352 platform_set_drvdata(pdev, data);
353 data->usbmisc_data = usbmisc_get_init_data(dev);
354 if (IS_ERR(data->usbmisc_data))
355 return PTR_ERR(data->usbmisc_data);
357 if ((of_usb_get_phy_mode(dev->of_node) == USBPHY_INTERFACE_MODE_HSIC)
358 && data->usbmisc_data) {
359 pdata.flags |= CI_HDRC_IMX_IS_HSIC;
360 data->usbmisc_data->hsic = 1;
361 data->pinctrl = devm_pinctrl_get(dev);
362 if (PTR_ERR(data->pinctrl) == -ENODEV)
363 data->pinctrl = NULL;
364 else if (IS_ERR(data->pinctrl))
365 return dev_err_probe(dev, PTR_ERR(data->pinctrl),
366 "pinctrl get failed\n");
368 data->hsic_pad_regulator =
369 devm_regulator_get_optional(dev, "hsic");
370 if (PTR_ERR(data->hsic_pad_regulator) == -ENODEV) {
371 /* no pad regulator is needed */
372 data->hsic_pad_regulator = NULL;
373 } else if (IS_ERR(data->hsic_pad_regulator))
374 return dev_err_probe(dev, PTR_ERR(data->hsic_pad_regulator),
375 "Get HSIC pad regulator error\n");
377 if (data->hsic_pad_regulator) {
378 ret = regulator_enable(data->hsic_pad_regulator);
381 "Failed to enable HSIC pad regulator\n");
387 /* HSIC pinctrl handling */
389 struct pinctrl_state *pinctrl_hsic_idle;
391 pinctrl_hsic_idle = pinctrl_lookup_state(data->pinctrl, "idle");
392 if (IS_ERR(pinctrl_hsic_idle)) {
394 "pinctrl_hsic_idle lookup failed, err=%ld\n",
395 PTR_ERR(pinctrl_hsic_idle));
396 return PTR_ERR(pinctrl_hsic_idle);
399 ret = pinctrl_select_state(data->pinctrl, pinctrl_hsic_idle);
401 dev_err(dev, "hsic_idle select failed, err=%d\n", ret);
405 data->pinctrl_hsic_active = pinctrl_lookup_state(data->pinctrl,
407 if (IS_ERR(data->pinctrl_hsic_active)) {
409 "pinctrl_hsic_active lookup failed, err=%ld\n",
410 PTR_ERR(data->pinctrl_hsic_active));
411 return PTR_ERR(data->pinctrl_hsic_active);
415 if (pdata.flags & CI_HDRC_PMQOS)
416 cpu_latency_qos_add_request(&data->pm_qos_req, 0);
418 ret = imx_get_clks(dev);
420 goto disable_hsic_regulator;
422 ret = imx_prepare_enable_clks(dev);
424 goto disable_hsic_regulator;
426 data->phy = devm_usb_get_phy_by_phandle(dev, "fsl,usbphy", 0);
427 if (IS_ERR(data->phy)) {
428 ret = PTR_ERR(data->phy);
429 if (ret != -ENODEV) {
430 dev_err_probe(dev, ret, "Failed to parse fsl,usbphy\n");
433 data->phy = devm_usb_get_phy_by_phandle(dev, "phys", 0);
434 if (IS_ERR(data->phy)) {
435 ret = PTR_ERR(data->phy);
436 if (ret == -ENODEV) {
439 dev_err_probe(dev, ret, "Failed to parse phys\n");
445 pdata.usb_phy = data->phy;
446 if (data->usbmisc_data)
447 data->usbmisc_data->usb_phy = data->phy;
449 if ((of_device_is_compatible(np, "fsl,imx53-usb") ||
450 of_device_is_compatible(np, "fsl,imx51-usb")) && pdata.usb_phy &&
451 of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI) {
452 pdata.flags |= CI_HDRC_OVERRIDE_PHY_CONTROL;
453 data->override_phy_control = true;
454 usb_phy_init(pdata.usb_phy);
457 if (pdata.flags & CI_HDRC_SUPPORTS_RUNTIME_PM)
458 data->supports_runtime_pm = true;
460 ret = imx_usbmisc_init(data->usbmisc_data);
462 dev_err(dev, "usbmisc init failed, ret=%d\n", ret);
466 data->ci_pdev = ci_hdrc_add_device(dev,
467 pdev->resource, pdev->num_resources,
469 if (IS_ERR(data->ci_pdev)) {
470 ret = PTR_ERR(data->ci_pdev);
471 dev_err_probe(dev, ret, "ci_hdrc_add_device failed\n");
475 if (data->usbmisc_data) {
476 if (!IS_ERR(pdata.id_extcon.edev) ||
477 of_property_read_bool(np, "usb-role-switch"))
478 data->usbmisc_data->ext_id = 1;
480 if (!IS_ERR(pdata.vbus_extcon.edev) ||
481 of_property_read_bool(np, "usb-role-switch"))
482 data->usbmisc_data->ext_vbus = 1;
484 /* usbmisc needs to know dr mode to choose wakeup setting */
485 data->usbmisc_data->available_role =
486 ci_hdrc_query_available_role(data->ci_pdev);
489 ret = imx_usbmisc_init_post(data->usbmisc_data);
491 dev_err(dev, "usbmisc post failed, ret=%d\n", ret);
495 if (data->supports_runtime_pm) {
496 pm_runtime_set_active(dev);
497 pm_runtime_enable(dev);
500 device_set_wakeup_capable(dev, true);
505 ci_hdrc_remove_device(data->ci_pdev);
507 imx_disable_unprepare_clks(dev);
508 disable_hsic_regulator:
509 if (data->hsic_pad_regulator)
510 /* don't overwrite original ret (cf. EPROBE_DEFER) */
511 regulator_disable(data->hsic_pad_regulator);
512 if (pdata.flags & CI_HDRC_PMQOS)
513 cpu_latency_qos_remove_request(&data->pm_qos_req);
514 data->ci_pdev = NULL;
518 static void ci_hdrc_imx_remove(struct platform_device *pdev)
520 struct ci_hdrc_imx_data *data = platform_get_drvdata(pdev);
522 if (data->supports_runtime_pm) {
523 pm_runtime_get_sync(&pdev->dev);
524 pm_runtime_disable(&pdev->dev);
525 pm_runtime_put_noidle(&pdev->dev);
528 ci_hdrc_remove_device(data->ci_pdev);
529 if (data->override_phy_control)
530 usb_phy_shutdown(data->phy);
532 imx_disable_unprepare_clks(&pdev->dev);
533 if (data->plat_data->flags & CI_HDRC_PMQOS)
534 cpu_latency_qos_remove_request(&data->pm_qos_req);
535 if (data->hsic_pad_regulator)
536 regulator_disable(data->hsic_pad_regulator);
540 static void ci_hdrc_imx_shutdown(struct platform_device *pdev)
542 ci_hdrc_imx_remove(pdev);
545 static int __maybe_unused imx_controller_suspend(struct device *dev,
548 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
551 dev_dbg(dev, "at %s\n", __func__);
553 ret = imx_usbmisc_suspend(data->usbmisc_data,
554 PMSG_IS_AUTO(msg) || device_may_wakeup(dev));
557 "usbmisc suspend failed, ret=%d\n", ret);
561 imx_disable_unprepare_clks(dev);
562 if (data->plat_data->flags & CI_HDRC_PMQOS)
563 cpu_latency_qos_remove_request(&data->pm_qos_req);
570 static int __maybe_unused imx_controller_resume(struct device *dev,
573 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
576 dev_dbg(dev, "at %s\n", __func__);
583 if (data->plat_data->flags & CI_HDRC_PMQOS)
584 cpu_latency_qos_add_request(&data->pm_qos_req, 0);
586 ret = imx_prepare_enable_clks(dev);
590 data->in_lpm = false;
592 ret = imx_usbmisc_resume(data->usbmisc_data,
593 PMSG_IS_AUTO(msg) || device_may_wakeup(dev));
595 dev_err(dev, "usbmisc resume failed, ret=%d\n", ret);
602 imx_disable_unprepare_clks(dev);
606 static int __maybe_unused ci_hdrc_imx_suspend(struct device *dev)
610 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
613 /* The core's suspend doesn't run */
616 ret = imx_controller_suspend(dev, PMSG_SUSPEND);
620 pinctrl_pm_select_sleep_state(dev);
624 static int __maybe_unused ci_hdrc_imx_resume(struct device *dev)
626 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
629 pinctrl_pm_select_default_state(dev);
630 ret = imx_controller_resume(dev, PMSG_RESUME);
631 if (!ret && data->supports_runtime_pm) {
632 pm_runtime_disable(dev);
633 pm_runtime_set_active(dev);
634 pm_runtime_enable(dev);
640 static int __maybe_unused ci_hdrc_imx_runtime_suspend(struct device *dev)
642 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
649 return imx_controller_suspend(dev, PMSG_AUTO_SUSPEND);
652 static int __maybe_unused ci_hdrc_imx_runtime_resume(struct device *dev)
654 return imx_controller_resume(dev, PMSG_AUTO_RESUME);
657 static const struct dev_pm_ops ci_hdrc_imx_pm_ops = {
658 SET_SYSTEM_SLEEP_PM_OPS(ci_hdrc_imx_suspend, ci_hdrc_imx_resume)
659 SET_RUNTIME_PM_OPS(ci_hdrc_imx_runtime_suspend,
660 ci_hdrc_imx_runtime_resume, NULL)
662 static struct platform_driver ci_hdrc_imx_driver = {
663 .probe = ci_hdrc_imx_probe,
664 .remove_new = ci_hdrc_imx_remove,
665 .shutdown = ci_hdrc_imx_shutdown,
668 .of_match_table = ci_hdrc_imx_dt_ids,
669 .pm = &ci_hdrc_imx_pm_ops,
673 module_platform_driver(ci_hdrc_imx_driver);
675 MODULE_ALIAS("platform:imx-usb");
676 MODULE_LICENSE("GPL");
677 MODULE_DESCRIPTION("CI HDRC i.MX USB binding");
678 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
679 MODULE_AUTHOR("Richard Zhao <richard.zhao@freescale.com>");