Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Copyright 2012 Freescale Semiconductor, Inc.
4 * Copyright (C) 2012 Marek Vasut <marex@denx.de>
5 * on behalf of DENX Software Engineering GmbH
6 */
7
8#include <linux/module.h>
9#include <linux/of.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>
18
19#include "ci.h"
20#include "ci_hdrc_imx.h"
21
22struct ci_hdrc_imx_platform_flag {
23 unsigned int flags;
24};
25
26static const struct ci_hdrc_imx_platform_flag imx23_usb_data = {
27 .flags = CI_HDRC_TURN_VBUS_EARLY_ON |
28 CI_HDRC_DISABLE_STREAMING,
29};
30
31static const struct ci_hdrc_imx_platform_flag imx27_usb_data = {
32 .flags = CI_HDRC_DISABLE_STREAMING,
33};
34
35static 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,
39};
40
41static 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,
45};
46
47static 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,
51};
52
53static 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,
57};
58
59static 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,
63};
64
65static const struct ci_hdrc_imx_platform_flag imx7d_usb_data = {
66 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM,
67};
68
69static const struct ci_hdrc_imx_platform_flag imx7ulp_usb_data = {
70 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM |
71 CI_HDRC_HAS_PORTSC_PEC_MISSED |
72 CI_HDRC_PMQOS,
73};
74
75static const struct ci_hdrc_imx_platform_flag imx8ulp_usb_data = {
76 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM |
77 CI_HDRC_HAS_PORTSC_PEC_MISSED,
78};
79
80static 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},
91 { /* sentinel */ }
92};
93MODULE_DEVICE_TABLE(of, ci_hdrc_imx_dt_ids);
94
95struct ci_hdrc_imx_data {
96 struct usb_phy *phy;
97 struct platform_device *ci_pdev;
98 struct clk *clk;
99 struct clk *clk_wakeup;
100 struct imx_usbmisc_data *usbmisc_data;
101 bool supports_runtime_pm;
102 bool override_phy_control;
103 bool in_lpm;
104 struct pinctrl *pinctrl;
105 struct pinctrl_state *pinctrl_hsic_active;
106 struct regulator *hsic_pad_regulator;
107 /* SoC before i.mx6 (except imx23/imx28) needs three clks */
108 bool need_three_clks;
109 struct clk *clk_ipg;
110 struct clk *clk_ahb;
111 struct clk *clk_per;
112 /* --------------------------------- */
113 struct pm_qos_request pm_qos_req;
114 const struct ci_hdrc_imx_platform_flag *plat_data;
115};
116
117/* Common functions shared by usbmisc drivers */
118
119static struct imx_usbmisc_data *usbmisc_get_init_data(struct device *dev)
120{
121 struct platform_device *misc_pdev;
122 struct device_node *np = dev->of_node;
123 struct of_phandle_args args;
124 struct imx_usbmisc_data *data;
125 int ret;
126
127 /*
128 * In case the fsl,usbmisc property is not present this device doesn't
129 * need usbmisc. Return NULL (which is no error here)
130 */
131 if (!of_get_property(np, "fsl,usbmisc", NULL))
132 return NULL;
133
134 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
135 if (!data)
136 return ERR_PTR(-ENOMEM);
137
138 ret = of_parse_phandle_with_args(np, "fsl,usbmisc", "#index-cells",
139 0, &args);
140 if (ret) {
141 dev_err(dev, "Failed to parse property fsl,usbmisc, errno %d\n",
142 ret);
143 return ERR_PTR(ret);
144 }
145
146 data->index = args.args[0];
147
148 misc_pdev = of_find_device_by_node(args.np);
149 of_node_put(args.np);
150
151 if (!misc_pdev)
152 return ERR_PTR(-EPROBE_DEFER);
153
154 if (!platform_get_drvdata(misc_pdev)) {
155 put_device(&misc_pdev->dev);
156 return ERR_PTR(-EPROBE_DEFER);
157 }
158 data->dev = &misc_pdev->dev;
159
160 /*
161 * Check the various over current related properties. If over current
162 * detection is disabled we're not interested in the polarity.
163 */
164 if (of_property_read_bool(np, "disable-over-current")) {
165 data->disable_oc = 1;
166 } else if (of_property_read_bool(np, "over-current-active-high")) {
167 data->oc_pol_active_low = 0;
168 data->oc_pol_configured = 1;
169 } else if (of_property_read_bool(np, "over-current-active-low")) {
170 data->oc_pol_active_low = 1;
171 data->oc_pol_configured = 1;
172 } else {
173 dev_warn(dev, "No over current polarity defined\n");
174 }
175
176 data->pwr_pol = of_property_read_bool(np, "power-active-high");
177 data->evdo = of_property_read_bool(np, "external-vbus-divider");
178
179 if (of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI)
180 data->ulpi = 1;
181
182 if (of_property_read_u32(np, "samsung,picophy-pre-emp-curr-control",
183 &data->emp_curr_control))
184 data->emp_curr_control = -1;
185 if (of_property_read_u32(np, "samsung,picophy-dc-vol-level-adjust",
186 &data->dc_vol_level_adjust))
187 data->dc_vol_level_adjust = -1;
188 if (of_property_read_u32(np, "fsl,picophy-rise-fall-time-adjust",
189 &data->rise_fall_time_adjust))
190 data->rise_fall_time_adjust = -1;
191
192 return data;
193}
194
195/* End of common functions shared by usbmisc drivers*/
196static int imx_get_clks(struct device *dev)
197{
198 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
199 int ret = 0;
200
201 data->clk_ipg = devm_clk_get(dev, "ipg");
202 if (IS_ERR(data->clk_ipg)) {
203 /* If the platform only needs one primary clock */
204 data->clk = devm_clk_get(dev, NULL);
205 if (IS_ERR(data->clk)) {
206 ret = PTR_ERR(data->clk);
207 dev_err(dev,
208 "Failed to get clks, err=%ld,%ld\n",
209 PTR_ERR(data->clk), PTR_ERR(data->clk_ipg));
210 return ret;
211 }
212 /* Get wakeup clock. Not all of the platforms need to
213 * handle this clock. So make it optional.
214 */
215 data->clk_wakeup = devm_clk_get_optional(dev, "usb_wakeup_clk");
216 if (IS_ERR(data->clk_wakeup))
217 ret = dev_err_probe(dev, PTR_ERR(data->clk_wakeup),
218 "Failed to get wakeup clk\n");
219 return ret;
220 }
221
222 data->clk_ahb = devm_clk_get(dev, "ahb");
223 if (IS_ERR(data->clk_ahb)) {
224 ret = PTR_ERR(data->clk_ahb);
225 dev_err(dev,
226 "Failed to get ahb clock, err=%d\n", ret);
227 return ret;
228 }
229
230 data->clk_per = devm_clk_get(dev, "per");
231 if (IS_ERR(data->clk_per)) {
232 ret = PTR_ERR(data->clk_per);
233 dev_err(dev,
234 "Failed to get per clock, err=%d\n", ret);
235 return ret;
236 }
237
238 data->need_three_clks = true;
239 return ret;
240}
241
242static int imx_prepare_enable_clks(struct device *dev)
243{
244 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
245 int ret = 0;
246
247 if (data->need_three_clks) {
248 ret = clk_prepare_enable(data->clk_ipg);
249 if (ret) {
250 dev_err(dev,
251 "Failed to prepare/enable ipg clk, err=%d\n",
252 ret);
253 return ret;
254 }
255
256 ret = clk_prepare_enable(data->clk_ahb);
257 if (ret) {
258 dev_err(dev,
259 "Failed to prepare/enable ahb clk, err=%d\n",
260 ret);
261 clk_disable_unprepare(data->clk_ipg);
262 return ret;
263 }
264
265 ret = clk_prepare_enable(data->clk_per);
266 if (ret) {
267 dev_err(dev,
268 "Failed to prepare/enable per clk, err=%d\n",
269 ret);
270 clk_disable_unprepare(data->clk_ahb);
271 clk_disable_unprepare(data->clk_ipg);
272 return ret;
273 }
274 } else {
275 ret = clk_prepare_enable(data->clk);
276 if (ret) {
277 dev_err(dev,
278 "Failed to prepare/enable clk, err=%d\n",
279 ret);
280 return ret;
281 }
282 }
283
284 return ret;
285}
286
287static void imx_disable_unprepare_clks(struct device *dev)
288{
289 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
290
291 if (data->need_three_clks) {
292 clk_disable_unprepare(data->clk_per);
293 clk_disable_unprepare(data->clk_ahb);
294 clk_disable_unprepare(data->clk_ipg);
295 } else {
296 clk_disable_unprepare(data->clk);
297 }
298}
299
300static int ci_hdrc_imx_notify_event(struct ci_hdrc *ci, unsigned int event)
301{
302 struct device *dev = ci->dev->parent;
303 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
304 int ret = 0;
305 struct imx_usbmisc_data *mdata = data->usbmisc_data;
306
307 switch (event) {
308 case CI_HDRC_IMX_HSIC_ACTIVE_EVENT:
309 if (data->pinctrl) {
310 ret = pinctrl_select_state(data->pinctrl,
311 data->pinctrl_hsic_active);
312 if (ret)
313 dev_err(dev,
314 "hsic_active select failed, err=%d\n",
315 ret);
316 }
317 break;
318 case CI_HDRC_IMX_HSIC_SUSPEND_EVENT:
319 ret = imx_usbmisc_hsic_set_connect(mdata);
320 if (ret)
321 dev_err(dev,
322 "hsic_set_connect failed, err=%d\n", ret);
323 break;
324 case CI_HDRC_CONTROLLER_VBUS_EVENT:
325 if (ci->vbus_active)
326 ret = imx_usbmisc_charger_detection(mdata, true);
327 else
328 ret = imx_usbmisc_charger_detection(mdata, false);
329 if (ci->usb_phy)
330 schedule_work(&ci->usb_phy->chg_work);
331 break;
332 default:
333 break;
334 }
335
336 return ret;
337}
338
339static int ci_hdrc_imx_probe(struct platform_device *pdev)
340{
341 struct ci_hdrc_imx_data *data;
342 struct ci_hdrc_platform_data pdata = {
343 .name = dev_name(&pdev->dev),
344 .capoffset = DEF_CAPOFFSET,
345 .notify_event = ci_hdrc_imx_notify_event,
346 };
347 int ret;
348 const struct ci_hdrc_imx_platform_flag *imx_platform_flag;
349 struct device_node *np = pdev->dev.of_node;
350 struct device *dev = &pdev->dev;
351
352 imx_platform_flag = of_device_get_match_data(&pdev->dev);
353
354 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
355 if (!data)
356 return -ENOMEM;
357
358 data->plat_data = imx_platform_flag;
359 pdata.flags |= imx_platform_flag->flags;
360 platform_set_drvdata(pdev, data);
361 data->usbmisc_data = usbmisc_get_init_data(dev);
362 if (IS_ERR(data->usbmisc_data))
363 return PTR_ERR(data->usbmisc_data);
364
365 if ((of_usb_get_phy_mode(dev->of_node) == USBPHY_INTERFACE_MODE_HSIC)
366 && data->usbmisc_data) {
367 pdata.flags |= CI_HDRC_IMX_IS_HSIC;
368 data->usbmisc_data->hsic = 1;
369 data->pinctrl = devm_pinctrl_get(dev);
370 if (PTR_ERR(data->pinctrl) == -ENODEV)
371 data->pinctrl = NULL;
372 else if (IS_ERR(data->pinctrl))
373 return dev_err_probe(dev, PTR_ERR(data->pinctrl),
374 "pinctrl get failed\n");
375
376 data->hsic_pad_regulator =
377 devm_regulator_get_optional(dev, "hsic");
378 if (PTR_ERR(data->hsic_pad_regulator) == -ENODEV) {
379 /* no pad regulator is needed */
380 data->hsic_pad_regulator = NULL;
381 } else if (IS_ERR(data->hsic_pad_regulator))
382 return dev_err_probe(dev, PTR_ERR(data->hsic_pad_regulator),
383 "Get HSIC pad regulator error\n");
384
385 if (data->hsic_pad_regulator) {
386 ret = regulator_enable(data->hsic_pad_regulator);
387 if (ret) {
388 dev_err(dev,
389 "Failed to enable HSIC pad regulator\n");
390 return ret;
391 }
392 }
393 }
394
395 /* HSIC pinctrl handling */
396 if (data->pinctrl) {
397 struct pinctrl_state *pinctrl_hsic_idle;
398
399 pinctrl_hsic_idle = pinctrl_lookup_state(data->pinctrl, "idle");
400 if (IS_ERR(pinctrl_hsic_idle)) {
401 dev_err(dev,
402 "pinctrl_hsic_idle lookup failed, err=%ld\n",
403 PTR_ERR(pinctrl_hsic_idle));
404 return PTR_ERR(pinctrl_hsic_idle);
405 }
406
407 ret = pinctrl_select_state(data->pinctrl, pinctrl_hsic_idle);
408 if (ret) {
409 dev_err(dev, "hsic_idle select failed, err=%d\n", ret);
410 return ret;
411 }
412
413 data->pinctrl_hsic_active = pinctrl_lookup_state(data->pinctrl,
414 "active");
415 if (IS_ERR(data->pinctrl_hsic_active)) {
416 dev_err(dev,
417 "pinctrl_hsic_active lookup failed, err=%ld\n",
418 PTR_ERR(data->pinctrl_hsic_active));
419 return PTR_ERR(data->pinctrl_hsic_active);
420 }
421 }
422
423 if (pdata.flags & CI_HDRC_PMQOS)
424 cpu_latency_qos_add_request(&data->pm_qos_req, 0);
425
426 ret = imx_get_clks(dev);
427 if (ret)
428 goto disable_hsic_regulator;
429
430 ret = imx_prepare_enable_clks(dev);
431 if (ret)
432 goto disable_hsic_regulator;
433
434 ret = clk_prepare_enable(data->clk_wakeup);
435 if (ret)
436 goto err_wakeup_clk;
437
438 data->phy = devm_usb_get_phy_by_phandle(dev, "fsl,usbphy", 0);
439 if (IS_ERR(data->phy)) {
440 ret = PTR_ERR(data->phy);
441 if (ret != -ENODEV) {
442 dev_err_probe(dev, ret, "Failed to parse fsl,usbphy\n");
443 goto err_clk;
444 }
445 data->phy = devm_usb_get_phy_by_phandle(dev, "phys", 0);
446 if (IS_ERR(data->phy)) {
447 ret = PTR_ERR(data->phy);
448 if (ret == -ENODEV) {
449 data->phy = NULL;
450 } else {
451 dev_err_probe(dev, ret, "Failed to parse phys\n");
452 goto err_clk;
453 }
454 }
455 }
456
457 pdata.usb_phy = data->phy;
458 if (data->usbmisc_data)
459 data->usbmisc_data->usb_phy = data->phy;
460
461 if ((of_device_is_compatible(np, "fsl,imx53-usb") ||
462 of_device_is_compatible(np, "fsl,imx51-usb")) && pdata.usb_phy &&
463 of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI) {
464 pdata.flags |= CI_HDRC_OVERRIDE_PHY_CONTROL;
465 data->override_phy_control = true;
466 usb_phy_init(pdata.usb_phy);
467 }
468
469 if (pdata.flags & CI_HDRC_SUPPORTS_RUNTIME_PM)
470 data->supports_runtime_pm = true;
471
472 ret = imx_usbmisc_init(data->usbmisc_data);
473 if (ret) {
474 dev_err(dev, "usbmisc init failed, ret=%d\n", ret);
475 goto err_clk;
476 }
477
478 data->ci_pdev = ci_hdrc_add_device(dev,
479 pdev->resource, pdev->num_resources,
480 &pdata);
481 if (IS_ERR(data->ci_pdev)) {
482 ret = PTR_ERR(data->ci_pdev);
483 dev_err_probe(dev, ret, "ci_hdrc_add_device failed\n");
484 goto err_clk;
485 }
486
487 if (data->usbmisc_data) {
488 if (!IS_ERR(pdata.id_extcon.edev) ||
489 of_property_read_bool(np, "usb-role-switch"))
490 data->usbmisc_data->ext_id = 1;
491
492 if (!IS_ERR(pdata.vbus_extcon.edev) ||
493 of_property_read_bool(np, "usb-role-switch"))
494 data->usbmisc_data->ext_vbus = 1;
495
496 /* usbmisc needs to know dr mode to choose wakeup setting */
497 data->usbmisc_data->available_role =
498 ci_hdrc_query_available_role(data->ci_pdev);
499 }
500
501 ret = imx_usbmisc_init_post(data->usbmisc_data);
502 if (ret) {
503 dev_err(dev, "usbmisc post failed, ret=%d\n", ret);
504 goto disable_device;
505 }
506
507 if (data->supports_runtime_pm) {
508 pm_runtime_set_active(dev);
509 pm_runtime_enable(dev);
510 }
511
512 device_set_wakeup_capable(dev, true);
513
514 return 0;
515
516disable_device:
517 ci_hdrc_remove_device(data->ci_pdev);
518err_clk:
519 clk_disable_unprepare(data->clk_wakeup);
520err_wakeup_clk:
521 imx_disable_unprepare_clks(dev);
522disable_hsic_regulator:
523 if (data->hsic_pad_regulator)
524 /* don't overwrite original ret (cf. EPROBE_DEFER) */
525 regulator_disable(data->hsic_pad_regulator);
526 if (pdata.flags & CI_HDRC_PMQOS)
527 cpu_latency_qos_remove_request(&data->pm_qos_req);
528 data->ci_pdev = NULL;
529 return ret;
530}
531
532static void ci_hdrc_imx_remove(struct platform_device *pdev)
533{
534 struct ci_hdrc_imx_data *data = platform_get_drvdata(pdev);
535
536 if (data->supports_runtime_pm) {
537 pm_runtime_get_sync(&pdev->dev);
538 pm_runtime_disable(&pdev->dev);
539 pm_runtime_put_noidle(&pdev->dev);
540 }
541 if (data->ci_pdev)
542 ci_hdrc_remove_device(data->ci_pdev);
543 if (data->override_phy_control)
544 usb_phy_shutdown(data->phy);
545 if (data->ci_pdev) {
546 imx_disable_unprepare_clks(&pdev->dev);
547 clk_disable_unprepare(data->clk_wakeup);
548 if (data->plat_data->flags & CI_HDRC_PMQOS)
549 cpu_latency_qos_remove_request(&data->pm_qos_req);
550 if (data->hsic_pad_regulator)
551 regulator_disable(data->hsic_pad_regulator);
552 }
553}
554
555static void ci_hdrc_imx_shutdown(struct platform_device *pdev)
556{
557 ci_hdrc_imx_remove(pdev);
558}
559
560static int __maybe_unused imx_controller_suspend(struct device *dev,
561 pm_message_t msg)
562{
563 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
564 int ret = 0;
565
566 dev_dbg(dev, "at %s\n", __func__);
567
568 ret = imx_usbmisc_suspend(data->usbmisc_data,
569 PMSG_IS_AUTO(msg) || device_may_wakeup(dev));
570 if (ret) {
571 dev_err(dev,
572 "usbmisc suspend failed, ret=%d\n", ret);
573 return ret;
574 }
575
576 imx_disable_unprepare_clks(dev);
577 if (data->plat_data->flags & CI_HDRC_PMQOS)
578 cpu_latency_qos_remove_request(&data->pm_qos_req);
579
580 data->in_lpm = true;
581
582 return 0;
583}
584
585static int __maybe_unused imx_controller_resume(struct device *dev,
586 pm_message_t msg)
587{
588 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
589 int ret = 0;
590
591 dev_dbg(dev, "at %s\n", __func__);
592
593 if (!data->in_lpm) {
594 WARN_ON(1);
595 return 0;
596 }
597
598 if (data->plat_data->flags & CI_HDRC_PMQOS)
599 cpu_latency_qos_add_request(&data->pm_qos_req, 0);
600
601 ret = imx_prepare_enable_clks(dev);
602 if (ret)
603 return ret;
604
605 data->in_lpm = false;
606
607 ret = imx_usbmisc_resume(data->usbmisc_data,
608 PMSG_IS_AUTO(msg) || device_may_wakeup(dev));
609 if (ret) {
610 dev_err(dev, "usbmisc resume failed, ret=%d\n", ret);
611 goto clk_disable;
612 }
613
614 return 0;
615
616clk_disable:
617 imx_disable_unprepare_clks(dev);
618 return ret;
619}
620
621static int __maybe_unused ci_hdrc_imx_suspend(struct device *dev)
622{
623 int ret;
624
625 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
626
627 if (data->in_lpm)
628 /* The core's suspend doesn't run */
629 return 0;
630
631 ret = imx_controller_suspend(dev, PMSG_SUSPEND);
632 if (ret)
633 return ret;
634
635 pinctrl_pm_select_sleep_state(dev);
636 return ret;
637}
638
639static int __maybe_unused ci_hdrc_imx_resume(struct device *dev)
640{
641 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
642 int ret;
643
644 pinctrl_pm_select_default_state(dev);
645 ret = imx_controller_resume(dev, PMSG_RESUME);
646 if (!ret && data->supports_runtime_pm) {
647 pm_runtime_disable(dev);
648 pm_runtime_set_active(dev);
649 pm_runtime_enable(dev);
650 }
651
652 return ret;
653}
654
655static int __maybe_unused ci_hdrc_imx_runtime_suspend(struct device *dev)
656{
657 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
658
659 if (data->in_lpm) {
660 WARN_ON(1);
661 return 0;
662 }
663
664 return imx_controller_suspend(dev, PMSG_AUTO_SUSPEND);
665}
666
667static int __maybe_unused ci_hdrc_imx_runtime_resume(struct device *dev)
668{
669 return imx_controller_resume(dev, PMSG_AUTO_RESUME);
670}
671
672static const struct dev_pm_ops ci_hdrc_imx_pm_ops = {
673 SET_SYSTEM_SLEEP_PM_OPS(ci_hdrc_imx_suspend, ci_hdrc_imx_resume)
674 SET_RUNTIME_PM_OPS(ci_hdrc_imx_runtime_suspend,
675 ci_hdrc_imx_runtime_resume, NULL)
676};
677static struct platform_driver ci_hdrc_imx_driver = {
678 .probe = ci_hdrc_imx_probe,
679 .remove_new = ci_hdrc_imx_remove,
680 .shutdown = ci_hdrc_imx_shutdown,
681 .driver = {
682 .name = "imx_usb",
683 .of_match_table = ci_hdrc_imx_dt_ids,
684 .pm = &ci_hdrc_imx_pm_ops,
685 },
686};
687
688module_platform_driver(ci_hdrc_imx_driver);
689
690MODULE_ALIAS("platform:imx-usb");
691MODULE_LICENSE("GPL");
692MODULE_DESCRIPTION("CI HDRC i.MX USB binding");
693MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
694MODULE_AUTHOR("Richard Zhao <richard.zhao@freescale.com>");
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Copyright 2012 Freescale Semiconductor, Inc.
4 * Copyright (C) 2012 Marek Vasut <marex@denx.de>
5 * on behalf of DENX Software Engineering GmbH
6 */
7
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
18#include "ci.h"
19#include "ci_hdrc_imx.h"
20
21struct ci_hdrc_imx_platform_flag {
22 unsigned int flags;
23};
24
25static const struct ci_hdrc_imx_platform_flag imx23_usb_data = {
26 .flags = CI_HDRC_TURN_VBUS_EARLY_ON |
27 CI_HDRC_DISABLE_STREAMING,
28};
29
30static const struct ci_hdrc_imx_platform_flag imx27_usb_data = {
31 .flags = CI_HDRC_DISABLE_STREAMING,
32};
33
34static 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,
38};
39
40static 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,
44};
45
46static 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,
50};
51
52static 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,
56};
57
58static 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};
62
63static const struct ci_hdrc_imx_platform_flag imx7d_usb_data = {
64 .flags = CI_HDRC_SUPPORTS_RUNTIME_PM,
65};
66
67static const struct of_device_id ci_hdrc_imx_dt_ids[] = {
68 { .compatible = "fsl,imx23-usb", .data = &imx23_usb_data},
69 { .compatible = "fsl,imx28-usb", .data = &imx28_usb_data},
70 { .compatible = "fsl,imx27-usb", .data = &imx27_usb_data},
71 { .compatible = "fsl,imx6q-usb", .data = &imx6q_usb_data},
72 { .compatible = "fsl,imx6sl-usb", .data = &imx6sl_usb_data},
73 { .compatible = "fsl,imx6sx-usb", .data = &imx6sx_usb_data},
74 { .compatible = "fsl,imx6ul-usb", .data = &imx6ul_usb_data},
75 { .compatible = "fsl,imx7d-usb", .data = &imx7d_usb_data},
76 { /* sentinel */ }
77};
78MODULE_DEVICE_TABLE(of, ci_hdrc_imx_dt_ids);
79
80struct ci_hdrc_imx_data {
81 struct usb_phy *phy;
82 struct platform_device *ci_pdev;
83 struct clk *clk;
84 struct imx_usbmisc_data *usbmisc_data;
85 bool supports_runtime_pm;
86 bool override_phy_control;
87 bool in_lpm;
88 /* SoC before i.mx6 (except imx23/imx28) needs three clks */
89 bool need_three_clks;
90 struct clk *clk_ipg;
91 struct clk *clk_ahb;
92 struct clk *clk_per;
93 /* --------------------------------- */
94};
95
96/* Common functions shared by usbmisc drivers */
97
98static struct imx_usbmisc_data *usbmisc_get_init_data(struct device *dev)
99{
100 struct platform_device *misc_pdev;
101 struct device_node *np = dev->of_node;
102 struct of_phandle_args args;
103 struct imx_usbmisc_data *data;
104 int ret;
105
106 /*
107 * In case the fsl,usbmisc property is not present this device doesn't
108 * need usbmisc. Return NULL (which is no error here)
109 */
110 if (!of_get_property(np, "fsl,usbmisc", NULL))
111 return NULL;
112
113 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
114 if (!data)
115 return ERR_PTR(-ENOMEM);
116
117 ret = of_parse_phandle_with_args(np, "fsl,usbmisc", "#index-cells",
118 0, &args);
119 if (ret) {
120 dev_err(dev, "Failed to parse property fsl,usbmisc, errno %d\n",
121 ret);
122 return ERR_PTR(ret);
123 }
124
125 data->index = args.args[0];
126
127 misc_pdev = of_find_device_by_node(args.np);
128 of_node_put(args.np);
129
130 if (!misc_pdev || !platform_get_drvdata(misc_pdev))
131 return ERR_PTR(-EPROBE_DEFER);
132
133 data->dev = &misc_pdev->dev;
134
135 if (of_find_property(np, "disable-over-current", NULL))
136 data->disable_oc = 1;
137
138 if (of_find_property(np, "over-current-active-high", NULL))
139 data->oc_polarity = 1;
140
141 if (of_find_property(np, "external-vbus-divider", NULL))
142 data->evdo = 1;
143
144 if (of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI)
145 data->ulpi = 1;
146
147 return data;
148}
149
150/* End of common functions shared by usbmisc drivers*/
151static int imx_get_clks(struct device *dev)
152{
153 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
154 int ret = 0;
155
156 data->clk_ipg = devm_clk_get(dev, "ipg");
157 if (IS_ERR(data->clk_ipg)) {
158 /* If the platform only needs one clocks */
159 data->clk = devm_clk_get(dev, NULL);
160 if (IS_ERR(data->clk)) {
161 ret = PTR_ERR(data->clk);
162 dev_err(dev,
163 "Failed to get clks, err=%ld,%ld\n",
164 PTR_ERR(data->clk), PTR_ERR(data->clk_ipg));
165 return ret;
166 }
167 return ret;
168 }
169
170 data->clk_ahb = devm_clk_get(dev, "ahb");
171 if (IS_ERR(data->clk_ahb)) {
172 ret = PTR_ERR(data->clk_ahb);
173 dev_err(dev,
174 "Failed to get ahb clock, err=%d\n", ret);
175 return ret;
176 }
177
178 data->clk_per = devm_clk_get(dev, "per");
179 if (IS_ERR(data->clk_per)) {
180 ret = PTR_ERR(data->clk_per);
181 dev_err(dev,
182 "Failed to get per clock, err=%d\n", ret);
183 return ret;
184 }
185
186 data->need_three_clks = true;
187 return ret;
188}
189
190static int imx_prepare_enable_clks(struct device *dev)
191{
192 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
193 int ret = 0;
194
195 if (data->need_three_clks) {
196 ret = clk_prepare_enable(data->clk_ipg);
197 if (ret) {
198 dev_err(dev,
199 "Failed to prepare/enable ipg clk, err=%d\n",
200 ret);
201 return ret;
202 }
203
204 ret = clk_prepare_enable(data->clk_ahb);
205 if (ret) {
206 dev_err(dev,
207 "Failed to prepare/enable ahb clk, err=%d\n",
208 ret);
209 clk_disable_unprepare(data->clk_ipg);
210 return ret;
211 }
212
213 ret = clk_prepare_enable(data->clk_per);
214 if (ret) {
215 dev_err(dev,
216 "Failed to prepare/enable per clk, err=%d\n",
217 ret);
218 clk_disable_unprepare(data->clk_ahb);
219 clk_disable_unprepare(data->clk_ipg);
220 return ret;
221 }
222 } else {
223 ret = clk_prepare_enable(data->clk);
224 if (ret) {
225 dev_err(dev,
226 "Failed to prepare/enable clk, err=%d\n",
227 ret);
228 return ret;
229 }
230 }
231
232 return ret;
233}
234
235static void imx_disable_unprepare_clks(struct device *dev)
236{
237 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
238
239 if (data->need_three_clks) {
240 clk_disable_unprepare(data->clk_per);
241 clk_disable_unprepare(data->clk_ahb);
242 clk_disable_unprepare(data->clk_ipg);
243 } else {
244 clk_disable_unprepare(data->clk);
245 }
246}
247
248static int ci_hdrc_imx_probe(struct platform_device *pdev)
249{
250 struct ci_hdrc_imx_data *data;
251 struct ci_hdrc_platform_data pdata = {
252 .name = dev_name(&pdev->dev),
253 .capoffset = DEF_CAPOFFSET,
254 };
255 int ret;
256 const struct of_device_id *of_id;
257 const struct ci_hdrc_imx_platform_flag *imx_platform_flag;
258 struct device_node *np = pdev->dev.of_node;
259
260 of_id = of_match_device(ci_hdrc_imx_dt_ids, &pdev->dev);
261 if (!of_id)
262 return -ENODEV;
263
264 imx_platform_flag = of_id->data;
265
266 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
267 if (!data)
268 return -ENOMEM;
269
270 platform_set_drvdata(pdev, data);
271 data->usbmisc_data = usbmisc_get_init_data(&pdev->dev);
272 if (IS_ERR(data->usbmisc_data))
273 return PTR_ERR(data->usbmisc_data);
274
275 ret = imx_get_clks(&pdev->dev);
276 if (ret)
277 return ret;
278
279 ret = imx_prepare_enable_clks(&pdev->dev);
280 if (ret)
281 return ret;
282
283 data->phy = devm_usb_get_phy_by_phandle(&pdev->dev, "fsl,usbphy", 0);
284 if (IS_ERR(data->phy)) {
285 ret = PTR_ERR(data->phy);
286 /* Return -EINVAL if no usbphy is available */
287 if (ret == -ENODEV)
288 ret = -EINVAL;
289 goto err_clk;
290 }
291
292 pdata.usb_phy = data->phy;
293
294 if (of_device_is_compatible(np, "fsl,imx53-usb") && pdata.usb_phy &&
295 of_usb_get_phy_mode(np) == USBPHY_INTERFACE_MODE_ULPI) {
296 pdata.flags |= CI_HDRC_OVERRIDE_PHY_CONTROL;
297 data->override_phy_control = true;
298 usb_phy_init(pdata.usb_phy);
299 }
300
301 pdata.flags |= imx_platform_flag->flags;
302 if (pdata.flags & CI_HDRC_SUPPORTS_RUNTIME_PM)
303 data->supports_runtime_pm = true;
304
305 ret = imx_usbmisc_init(data->usbmisc_data);
306 if (ret) {
307 dev_err(&pdev->dev, "usbmisc init failed, ret=%d\n", ret);
308 goto err_clk;
309 }
310
311 data->ci_pdev = ci_hdrc_add_device(&pdev->dev,
312 pdev->resource, pdev->num_resources,
313 &pdata);
314 if (IS_ERR(data->ci_pdev)) {
315 ret = PTR_ERR(data->ci_pdev);
316 if (ret != -EPROBE_DEFER)
317 dev_err(&pdev->dev,
318 "ci_hdrc_add_device failed, err=%d\n", ret);
319 goto err_clk;
320 }
321
322 ret = imx_usbmisc_init_post(data->usbmisc_data);
323 if (ret) {
324 dev_err(&pdev->dev, "usbmisc post failed, ret=%d\n", ret);
325 goto disable_device;
326 }
327
328 if (data->supports_runtime_pm) {
329 pm_runtime_set_active(&pdev->dev);
330 pm_runtime_enable(&pdev->dev);
331 }
332
333 device_set_wakeup_capable(&pdev->dev, true);
334
335 return 0;
336
337disable_device:
338 ci_hdrc_remove_device(data->ci_pdev);
339err_clk:
340 imx_disable_unprepare_clks(&pdev->dev);
341 return ret;
342}
343
344static int ci_hdrc_imx_remove(struct platform_device *pdev)
345{
346 struct ci_hdrc_imx_data *data = platform_get_drvdata(pdev);
347
348 if (data->supports_runtime_pm) {
349 pm_runtime_get_sync(&pdev->dev);
350 pm_runtime_disable(&pdev->dev);
351 pm_runtime_put_noidle(&pdev->dev);
352 }
353 ci_hdrc_remove_device(data->ci_pdev);
354 if (data->override_phy_control)
355 usb_phy_shutdown(data->phy);
356 imx_disable_unprepare_clks(&pdev->dev);
357
358 return 0;
359}
360
361static void ci_hdrc_imx_shutdown(struct platform_device *pdev)
362{
363 ci_hdrc_imx_remove(pdev);
364}
365
366#ifdef CONFIG_PM
367static int imx_controller_suspend(struct device *dev)
368{
369 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
370
371 dev_dbg(dev, "at %s\n", __func__);
372
373 imx_disable_unprepare_clks(dev);
374 data->in_lpm = true;
375
376 return 0;
377}
378
379static int imx_controller_resume(struct device *dev)
380{
381 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
382 int ret = 0;
383
384 dev_dbg(dev, "at %s\n", __func__);
385
386 if (!data->in_lpm) {
387 WARN_ON(1);
388 return 0;
389 }
390
391 ret = imx_prepare_enable_clks(dev);
392 if (ret)
393 return ret;
394
395 data->in_lpm = false;
396
397 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, false);
398 if (ret) {
399 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
400 goto clk_disable;
401 }
402
403 return 0;
404
405clk_disable:
406 imx_disable_unprepare_clks(dev);
407 return ret;
408}
409
410#ifdef CONFIG_PM_SLEEP
411static int ci_hdrc_imx_suspend(struct device *dev)
412{
413 int ret;
414
415 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
416
417 if (data->in_lpm)
418 /* The core's suspend doesn't run */
419 return 0;
420
421 if (device_may_wakeup(dev)) {
422 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
423 if (ret) {
424 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n",
425 ret);
426 return ret;
427 }
428 }
429
430 return imx_controller_suspend(dev);
431}
432
433static int ci_hdrc_imx_resume(struct device *dev)
434{
435 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
436 int ret;
437
438 ret = imx_controller_resume(dev);
439 if (!ret && data->supports_runtime_pm) {
440 pm_runtime_disable(dev);
441 pm_runtime_set_active(dev);
442 pm_runtime_enable(dev);
443 }
444
445 return ret;
446}
447#endif /* CONFIG_PM_SLEEP */
448
449static int ci_hdrc_imx_runtime_suspend(struct device *dev)
450{
451 struct ci_hdrc_imx_data *data = dev_get_drvdata(dev);
452 int ret;
453
454 if (data->in_lpm) {
455 WARN_ON(1);
456 return 0;
457 }
458
459 ret = imx_usbmisc_set_wakeup(data->usbmisc_data, true);
460 if (ret) {
461 dev_err(dev, "usbmisc set_wakeup failed, ret=%d\n", ret);
462 return ret;
463 }
464
465 return imx_controller_suspend(dev);
466}
467
468static int ci_hdrc_imx_runtime_resume(struct device *dev)
469{
470 return imx_controller_resume(dev);
471}
472
473#endif /* CONFIG_PM */
474
475static const struct dev_pm_ops ci_hdrc_imx_pm_ops = {
476 SET_SYSTEM_SLEEP_PM_OPS(ci_hdrc_imx_suspend, ci_hdrc_imx_resume)
477 SET_RUNTIME_PM_OPS(ci_hdrc_imx_runtime_suspend,
478 ci_hdrc_imx_runtime_resume, NULL)
479};
480static struct platform_driver ci_hdrc_imx_driver = {
481 .probe = ci_hdrc_imx_probe,
482 .remove = ci_hdrc_imx_remove,
483 .shutdown = ci_hdrc_imx_shutdown,
484 .driver = {
485 .name = "imx_usb",
486 .of_match_table = ci_hdrc_imx_dt_ids,
487 .pm = &ci_hdrc_imx_pm_ops,
488 },
489};
490
491module_platform_driver(ci_hdrc_imx_driver);
492
493MODULE_ALIAS("platform:imx-usb");
494MODULE_LICENSE("GPL v2");
495MODULE_DESCRIPTION("CI HDRC i.MX USB binding");
496MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
497MODULE_AUTHOR("Richard Zhao <richard.zhao@freescale.com>");