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);
143 return ERR_PTR(-EPROBE_DEFER);
145 if (!platform_get_drvdata(misc_pdev)) {
146 put_device(&misc_pdev->dev);
147 return ERR_PTR(-EPROBE_DEFER);
149 data->dev = &misc_pdev->dev;
152 * Check the various over current related properties. If over current
153 * detection is disabled we're not interested in the polarity.
155 if (of_find_property(np, "disable-over-current", NULL)) {
156 data->disable_oc = 1;
157 } else if (of_find_property(np, "over-current-active-high", NULL)) {
158 data->oc_pol_active_low = 0;
159 data->oc_pol_configured = 1;
160 } else if (of_find_property(np, "over-current-active-low", NULL)) {
161 data->oc_pol_active_low = 1;
162 data->oc_pol_configured = 1;
164 dev_warn(dev, "No over current polarity defined\n");
167 data->pwr_pol = of_property_read_bool(np, "power-active-high");
168 data->evdo = of_property_read_bool(np, "external-vbus-divider");
170 if (of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI)
173 of_property_read_u32(np, "samsung,picophy-pre-emp-curr-control",
174 &data->emp_curr_control);
175 of_property_read_u32(np, "samsung,picophy-dc-vol-level-adjust",
176 &data->dc_vol_level_adjust);
181 /* End of common functions shared by usbmisc drivers*/
182 static int imx_get_clks(struct device *dev)
184 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
187 data->clk_ipg = devm_clk_get(dev, "ipg");
188 if (IS_ERR(data->clk_ipg)) {
189 /* If the platform only needs one clocks */
190 data->clk = devm_clk_get(dev, NULL);
191 if (IS_ERR(data->clk)) {
192 ret = PTR_ERR(data->clk);
194 "Failed to get clks, err=%ld,%ld\n",
195 PTR_ERR(data->clk), PTR_ERR(data->clk_ipg));
201 data->clk_ahb = devm_clk_get(dev, "ahb");
202 if (IS_ERR(data->clk_ahb)) {
203 ret = PTR_ERR(data->clk_ahb);
205 "Failed to get ahb clock, err=%d\n", ret);
209 data->clk_per = devm_clk_get(dev, "per");
210 if (IS_ERR(data->clk_per)) {
211 ret = PTR_ERR(data->clk_per);
213 "Failed to get per clock, err=%d\n", ret);
217 data->need_three_clks = true;
221 static int imx_prepare_enable_clks(struct device *dev)
223 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
226 if (data->need_three_clks) {
227 ret = clk_prepare_enable(data->clk_ipg);
230 "Failed to prepare/enable ipg clk, err=%d\n",
235 ret = clk_prepare_enable(data->clk_ahb);
238 "Failed to prepare/enable ahb clk, err=%d\n",
240 clk_disable_unprepare(data->clk_ipg);
244 ret = clk_prepare_enable(data->clk_per);
247 "Failed to prepare/enable per clk, err=%d\n",
249 clk_disable_unprepare(data->clk_ahb);
250 clk_disable_unprepare(data->clk_ipg);
254 ret = clk_prepare_enable(data->clk);
257 "Failed to prepare/enable clk, err=%d\n",
266 static void imx_disable_unprepare_clks(struct device *dev)
268 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
270 if (data->need_three_clks) {
271 clk_disable_unprepare(data->clk_per);
272 clk_disable_unprepare(data->clk_ahb);
273 clk_disable_unprepare(data->clk_ipg);
275 clk_disable_unprepare(data->clk);
279 static int ci_hdrc_imx_notify_event(struct ci_hdrc *ci, unsigned int event)
281 struct device *dev = ci->dev->parent;
282 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
284 struct imx_usbmisc_data *mdata = data->usbmisc_data;
287 case CI_HDRC_IMX_HSIC_ACTIVE_EVENT:
289 ret = pinctrl_select_state(data->pinctrl,
290 data->pinctrl_hsic_active);
293 "hsic_active select failed, err=%d\n",
297 case CI_HDRC_IMX_HSIC_SUSPEND_EVENT:
298 ret = imx_usbmisc_hsic_set_connect(mdata);
301 "hsic_set_connect failed, err=%d\n", ret);
303 case CI_HDRC_CONTROLLER_VBUS_EVENT:
305 ret = imx_usbmisc_charger_detection(mdata, true);
307 ret = imx_usbmisc_charger_detection(mdata, false);
309 schedule_work(&ci->usb_phy->chg_work);
318 static int ci_hdrc_imx_probe(struct platform_device *pdev)
320 struct ci_hdrc_imx_data *data;
321 struct ci_hdrc_platform_data pdata = {
322 .name = dev_name(&pdev->dev),
323 .capoffset = DEF_CAPOFFSET,
324 .notify_event = ci_hdrc_imx_notify_event,
327 const struct of_device_id *of_id;
328 const struct ci_hdrc_imx_platform_flag *imx_platform_flag;
329 struct device_node *np = pdev->dev.of_node;
330 struct device *dev = &pdev->dev;
332 of_id = of_match_device(ci_hdrc_imx_dt_ids, dev);
336 imx_platform_flag = of_id->data;
338 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
342 data->plat_data = imx_platform_flag;
343 pdata.flags |= imx_platform_flag->flags;
344 platform_set_drvdata(pdev, data);
345 data->usbmisc_data = usbmisc_get_init_data(dev);
346 if (IS_ERR(data->usbmisc_data))
347 return PTR_ERR(data->usbmisc_data);
349 if ((of_usb_get_phy_mode(dev->of_node) == USBPHY_INTERFACE_MODE_HSIC)
350 && data->usbmisc_data) {
351 pdata.flags |= CI_HDRC_IMX_IS_HSIC;
352 data->usbmisc_data->hsic = 1;
353 data->pinctrl = devm_pinctrl_get(dev);
354 if (PTR_ERR(data->pinctrl) == -ENODEV)
355 data->pinctrl = NULL;
356 else if (IS_ERR(data->pinctrl)) {
357 if (PTR_ERR(data->pinctrl) != -EPROBE_DEFER)
358 dev_err(dev, "pinctrl get failed, err=%ld\n",
359 PTR_ERR(data->pinctrl));
360 return PTR_ERR(data->pinctrl);
363 data->hsic_pad_regulator =
364 devm_regulator_get_optional(dev, "hsic");
365 if (PTR_ERR(data->hsic_pad_regulator) == -ENODEV) {
366 /* no pad regualator is needed */
367 data->hsic_pad_regulator = NULL;
368 } else if (IS_ERR(data->hsic_pad_regulator)) {
369 if (PTR_ERR(data->hsic_pad_regulator) != -EPROBE_DEFER)
371 "Get HSIC pad regulator error: %ld\n",
372 PTR_ERR(data->hsic_pad_regulator));
373 return PTR_ERR(data->hsic_pad_regulator);
376 if (data->hsic_pad_regulator) {
377 ret = regulator_enable(data->hsic_pad_regulator);
380 "Failed to enable HSIC pad regulator\n");
386 /* HSIC pinctrl handling */
388 struct pinctrl_state *pinctrl_hsic_idle;
390 pinctrl_hsic_idle = pinctrl_lookup_state(data->pinctrl, "idle");
391 if (IS_ERR(pinctrl_hsic_idle)) {
393 "pinctrl_hsic_idle lookup failed, err=%ld\n",
394 PTR_ERR(pinctrl_hsic_idle));
395 return PTR_ERR(pinctrl_hsic_idle);
398 ret = pinctrl_select_state(data->pinctrl, pinctrl_hsic_idle);
400 dev_err(dev, "hsic_idle select failed, err=%d\n", ret);
404 data->pinctrl_hsic_active = pinctrl_lookup_state(data->pinctrl,
406 if (IS_ERR(data->pinctrl_hsic_active)) {
408 "pinctrl_hsic_active lookup failed, err=%ld\n",
409 PTR_ERR(data->pinctrl_hsic_active));
410 return PTR_ERR(data->pinctrl_hsic_active);
414 if (pdata.flags & CI_HDRC_PMQOS)
415 cpu_latency_qos_add_request(&data->pm_qos_req, 0);
417 ret = imx_get_clks(dev);
419 goto disable_hsic_regulator;
421 ret = imx_prepare_enable_clks(dev);
423 goto disable_hsic_regulator;
425 data->phy = devm_usb_get_phy_by_phandle(dev, "fsl,usbphy", 0);
426 if (IS_ERR(data->phy)) {
427 ret = PTR_ERR(data->phy);
430 data->phy = devm_usb_get_phy_by_phandle(dev, "phys", 0);
431 if (IS_ERR(data->phy)) {
432 ret = PTR_ERR(data->phy);
440 pdata.usb_phy = data->phy;
441 if (data->usbmisc_data)
442 data->usbmisc_data->usb_phy = data->phy;
444 if ((of_device_is_compatible(np, "fsl,imx53-usb") ||
445 of_device_is_compatible(np, "fsl,imx51-usb")) && pdata.usb_phy &&
446 of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI) {
447 pdata.flags |= CI_HDRC_OVERRIDE_PHY_CONTROL;
448 data->override_phy_control = true;
449 usb_phy_init(pdata.usb_phy);
452 if (pdata.flags & CI_HDRC_SUPPORTS_RUNTIME_PM)
453 data->supports_runtime_pm = true;
455 ret = imx_usbmisc_init(data->usbmisc_data);
457 dev_err(dev, "usbmisc init failed, ret=%d\n", ret);
461 data->ci_pdev = ci_hdrc_add_device(dev,
462 pdev->resource, pdev->num_resources,
464 if (IS_ERR(data->ci_pdev)) {
465 ret = PTR_ERR(data->ci_pdev);
466 if (ret != -EPROBE_DEFER)
467 dev_err(dev, "ci_hdrc_add_device failed, err=%d\n",
472 if (data->usbmisc_data) {
473 if (!IS_ERR(pdata.id_extcon.edev) ||
474 of_property_read_bool(np, "usb-role-switch"))
475 data->usbmisc_data->ext_id = 1;
477 if (!IS_ERR(pdata.vbus_extcon.edev) ||
478 of_property_read_bool(np, "usb-role-switch"))
479 data->usbmisc_data->ext_vbus = 1;
481 /* usbmisc needs to know dr mode to choose wakeup setting */
482 data->usbmisc_data->available_role =
483 ci_hdrc_query_available_role(data->ci_pdev);
486 ret = imx_usbmisc_init_post(data->usbmisc_data);
488 dev_err(dev, "usbmisc post failed, ret=%d\n", ret);
492 if (data->supports_runtime_pm) {
493 pm_runtime_set_active(dev);
494 pm_runtime_enable(dev);
497 device_set_wakeup_capable(dev, true);
502 ci_hdrc_remove_device(data->ci_pdev);
504 imx_disable_unprepare_clks(dev);
505 disable_hsic_regulator:
506 if (data->hsic_pad_regulator)
507 /* don't overwrite original ret (cf. EPROBE_DEFER) */
508 regulator_disable(data->hsic_pad_regulator);
509 if (pdata.flags & CI_HDRC_PMQOS)
510 cpu_latency_qos_remove_request(&data->pm_qos_req);
511 data->ci_pdev = NULL;
515 static int ci_hdrc_imx_remove(struct platform_device *pdev)
517 struct ci_hdrc_imx_data *data = platform_get_drvdata(pdev);
519 if (data->supports_runtime_pm) {
520 pm_runtime_get_sync(&pdev->dev);
521 pm_runtime_disable(&pdev->dev);
522 pm_runtime_put_noidle(&pdev->dev);
525 ci_hdrc_remove_device(data->ci_pdev);
526 if (data->override_phy_control)
527 usb_phy_shutdown(data->phy);
529 imx_disable_unprepare_clks(&pdev->dev);
530 if (data->plat_data->flags & CI_HDRC_PMQOS)
531 cpu_latency_qos_remove_request(&data->pm_qos_req);
532 if (data->hsic_pad_regulator)
533 regulator_disable(data->hsic_pad_regulator);
539 static void ci_hdrc_imx_shutdown(struct platform_device *pdev)
541 ci_hdrc_imx_remove(pdev);
544 static int __maybe_unused imx_controller_suspend(struct device *dev)
546 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
549 dev_dbg(dev, "at %s\n", __func__);
551 ret = imx_usbmisc_hsic_set_clk(data->usbmisc_data, false);
553 dev_err(dev, "usbmisc hsic_set_clk failed, ret=%d\n", ret);
557 imx_disable_unprepare_clks(dev);
558 if (data->plat_data->flags & CI_HDRC_PMQOS)
559 cpu_latency_qos_remove_request(&data->pm_qos_req);
566 static int __maybe_unused imx_controller_resume(struct device *dev)
568 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
571 dev_dbg(dev, "at %s\n", __func__);
578 if (data->plat_data->flags & CI_HDRC_PMQOS)
579 cpu_latency_qos_add_request(&data->pm_qos_req, 0);
581 ret = imx_prepare_enable_clks(dev);
585 data->in_lpm = false;
587 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, false);
589 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
593 ret = imx_usbmisc_hsic_set_clk(data->usbmisc_data, true);
595 dev_err(dev, "usbmisc hsic_set_clk failed, ret=%d\n", ret);
596 goto hsic_set_clk_fail;
602 imx_usbmisc_set_wakeup(data->usbmisc_data, true);
604 imx_disable_unprepare_clks(dev);
608 static int __maybe_unused ci_hdrc_imx_suspend(struct device *dev)
612 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
615 /* The core's suspend doesn't run */
618 if (device_may_wakeup(dev)) {
619 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
621 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n",
627 ret = imx_controller_suspend(dev);
631 pinctrl_pm_select_sleep_state(dev);
635 static int __maybe_unused ci_hdrc_imx_resume(struct device *dev)
637 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
640 pinctrl_pm_select_default_state(dev);
641 ret = imx_controller_resume(dev);
642 if (!ret && data->supports_runtime_pm) {
643 pm_runtime_disable(dev);
644 pm_runtime_set_active(dev);
645 pm_runtime_enable(dev);
651 static int __maybe_unused ci_hdrc_imx_runtime_suspend(struct device *dev)
653 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
661 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
663 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
667 return imx_controller_suspend(dev);
670 static int __maybe_unused ci_hdrc_imx_runtime_resume(struct device *dev)
672 return imx_controller_resume(dev);
675 static const struct dev_pm_ops ci_hdrc_imx_pm_ops = {
676 SET_SYSTEM_SLEEP_PM_OPS(ci_hdrc_imx_suspend, ci_hdrc_imx_resume)
677 SET_RUNTIME_PM_OPS(ci_hdrc_imx_runtime_suspend,
678 ci_hdrc_imx_runtime_resume, NULL)
680 static struct platform_driver ci_hdrc_imx_driver = {
681 .probe = ci_hdrc_imx_probe,
682 .remove = ci_hdrc_imx_remove,
683 .shutdown = ci_hdrc_imx_shutdown,
686 .of_match_table = ci_hdrc_imx_dt_ids,
687 .pm = &ci_hdrc_imx_pm_ops,
691 module_platform_driver(ci_hdrc_imx_driver);
693 MODULE_ALIAS("platform:imx-usb");
694 MODULE_LICENSE("GPL");
695 MODULE_DESCRIPTION("CI HDRC i.MX USB binding");
696 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
697 MODULE_AUTHOR("Richard Zhao <richard.zhao@freescale.com>");