1 // SPDX-License-Identifier: GPL-2.0
3 * MediaTek xHCI Host Controller Driver
5 * Copyright (c) 2015 MediaTek Inc.
7 * Chunfeng Yun <chunfeng.yun@mediatek.com>
10 #include <linux/clk.h>
11 #include <linux/dma-mapping.h>
12 #include <linux/iopoll.h>
13 #include <linux/kernel.h>
14 #include <linux/mfd/syscon.h>
15 #include <linux/module.h>
17 #include <linux/platform_device.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/regmap.h>
20 #include <linux/regulator/consumer.h>
25 /* ip_pw_ctrl0 register */
26 #define CTRL0_IP_SW_RST BIT(0)
28 /* ip_pw_ctrl1 register */
29 #define CTRL1_IP_HOST_PDN BIT(0)
31 /* ip_pw_ctrl2 register */
32 #define CTRL2_IP_DEV_PDN BIT(0)
34 /* ip_pw_sts1 register */
35 #define STS1_IP_SLEEP_STS BIT(30)
36 #define STS1_U3_MAC_RST BIT(16)
37 #define STS1_XHCI_RST BIT(11)
38 #define STS1_SYS125_RST BIT(10)
39 #define STS1_REF_RST BIT(8)
40 #define STS1_SYSPLL_STABLE BIT(0)
42 /* ip_xhci_cap register */
43 #define CAP_U3_PORT_NUM(p) ((p) & 0xff)
44 #define CAP_U2_PORT_NUM(p) (((p) >> 8) & 0xff)
46 /* u3_ctrl_p register */
47 #define CTRL_U3_PORT_HOST_SEL BIT(2)
48 #define CTRL_U3_PORT_PDN BIT(1)
49 #define CTRL_U3_PORT_DIS BIT(0)
51 /* u2_ctrl_p register */
52 #define CTRL_U2_PORT_HOST_SEL BIT(2)
53 #define CTRL_U2_PORT_PDN BIT(1)
54 #define CTRL_U2_PORT_DIS BIT(0)
56 /* u2_phy_pll register */
57 #define CTRL_U2_FORCE_PLL_STB BIT(28)
59 /* usb remote wakeup registers in syscon */
61 #define PERI_WK_CTRL1 0x4
62 #define WC1_IS_C(x) (((x) & 0xf) << 26) /* cycle debounce */
63 #define WC1_IS_EN BIT(25)
64 #define WC1_IS_P BIT(6) /* polarity for ip sleep */
67 #define PERI_SSUSB_SPM_CTRL 0x0
68 #define SSC_IP_SLEEP_EN BIT(4)
69 #define SSC_SPM_INT_EN BIT(1)
76 static int xhci_mtk_host_enable(struct xhci_hcd_mtk
*mtk
)
78 struct mu3c_ippc_regs __iomem
*ippc
= mtk
->ippc_regs
;
80 int u3_ports_disabed
= 0;
87 /* power on host ip */
88 value
= readl(&ippc
->ip_pw_ctr1
);
89 value
&= ~CTRL1_IP_HOST_PDN
;
90 writel(value
, &ippc
->ip_pw_ctr1
);
92 /* power on and enable u3 ports except skipped ones */
93 for (i
= 0; i
< mtk
->num_u3_ports
; i
++) {
94 if ((0x1 << i
) & mtk
->u3p_dis_msk
) {
99 value
= readl(&ippc
->u3_ctrl_p
[i
]);
100 value
&= ~(CTRL_U3_PORT_PDN
| CTRL_U3_PORT_DIS
);
101 value
|= CTRL_U3_PORT_HOST_SEL
;
102 writel(value
, &ippc
->u3_ctrl_p
[i
]);
105 /* power on and enable all u2 ports */
106 for (i
= 0; i
< mtk
->num_u2_ports
; i
++) {
107 value
= readl(&ippc
->u2_ctrl_p
[i
]);
108 value
&= ~(CTRL_U2_PORT_PDN
| CTRL_U2_PORT_DIS
);
109 value
|= CTRL_U2_PORT_HOST_SEL
;
110 writel(value
, &ippc
->u2_ctrl_p
[i
]);
114 * wait for clocks to be stable, and clock domains reset to
115 * be inactive after power on and enable ports
117 check_val
= STS1_SYSPLL_STABLE
| STS1_REF_RST
|
118 STS1_SYS125_RST
| STS1_XHCI_RST
;
120 if (mtk
->num_u3_ports
> u3_ports_disabed
)
121 check_val
|= STS1_U3_MAC_RST
;
123 ret
= readl_poll_timeout(&ippc
->ip_pw_sts1
, value
,
124 (check_val
== (value
& check_val
)), 100, 20000);
126 dev_err(mtk
->dev
, "clocks are not stable (0x%x)\n", value
);
133 static int xhci_mtk_host_disable(struct xhci_hcd_mtk
*mtk
)
135 struct mu3c_ippc_regs __iomem
*ippc
= mtk
->ippc_regs
;
143 /* power down u3 ports except skipped ones */
144 for (i
= 0; i
< mtk
->num_u3_ports
; i
++) {
145 if ((0x1 << i
) & mtk
->u3p_dis_msk
)
148 value
= readl(&ippc
->u3_ctrl_p
[i
]);
149 value
|= CTRL_U3_PORT_PDN
;
150 writel(value
, &ippc
->u3_ctrl_p
[i
]);
153 /* power down all u2 ports */
154 for (i
= 0; i
< mtk
->num_u2_ports
; i
++) {
155 value
= readl(&ippc
->u2_ctrl_p
[i
]);
156 value
|= CTRL_U2_PORT_PDN
;
157 writel(value
, &ippc
->u2_ctrl_p
[i
]);
160 /* power down host ip */
161 value
= readl(&ippc
->ip_pw_ctr1
);
162 value
|= CTRL1_IP_HOST_PDN
;
163 writel(value
, &ippc
->ip_pw_ctr1
);
165 /* wait for host ip to sleep */
166 ret
= readl_poll_timeout(&ippc
->ip_pw_sts1
, value
,
167 (value
& STS1_IP_SLEEP_STS
), 100, 100000);
169 dev_err(mtk
->dev
, "ip sleep failed!!!\n");
175 static int xhci_mtk_ssusb_config(struct xhci_hcd_mtk
*mtk
)
177 struct mu3c_ippc_regs __iomem
*ippc
= mtk
->ippc_regs
;
184 value
= readl(&ippc
->ip_pw_ctr0
);
185 value
|= CTRL0_IP_SW_RST
;
186 writel(value
, &ippc
->ip_pw_ctr0
);
188 value
= readl(&ippc
->ip_pw_ctr0
);
189 value
&= ~CTRL0_IP_SW_RST
;
190 writel(value
, &ippc
->ip_pw_ctr0
);
193 * device ip is default power-on in fact
194 * power down device ip, otherwise ip-sleep will fail
196 value
= readl(&ippc
->ip_pw_ctr2
);
197 value
|= CTRL2_IP_DEV_PDN
;
198 writel(value
, &ippc
->ip_pw_ctr2
);
200 value
= readl(&ippc
->ip_xhci_cap
);
201 mtk
->num_u3_ports
= CAP_U3_PORT_NUM(value
);
202 mtk
->num_u2_ports
= CAP_U2_PORT_NUM(value
);
203 dev_dbg(mtk
->dev
, "%s u2p:%d, u3p:%d\n", __func__
,
204 mtk
->num_u2_ports
, mtk
->num_u3_ports
);
206 return xhci_mtk_host_enable(mtk
);
209 /* ignore the error if the clock does not exist */
210 static struct clk
*optional_clk_get(struct device
*dev
, const char *id
)
214 opt_clk
= devm_clk_get(dev
, id
);
215 /* ignore error number except EPROBE_DEFER */
216 if (IS_ERR(opt_clk
) && (PTR_ERR(opt_clk
) != -EPROBE_DEFER
))
222 static int xhci_mtk_clks_get(struct xhci_hcd_mtk
*mtk
)
224 struct device
*dev
= mtk
->dev
;
226 mtk
->sys_clk
= devm_clk_get(dev
, "sys_ck");
227 if (IS_ERR(mtk
->sys_clk
)) {
228 dev_err(dev
, "fail to get sys_ck\n");
229 return PTR_ERR(mtk
->sys_clk
);
232 mtk
->ref_clk
= optional_clk_get(dev
, "ref_ck");
233 if (IS_ERR(mtk
->ref_clk
))
234 return PTR_ERR(mtk
->ref_clk
);
236 mtk
->mcu_clk
= optional_clk_get(dev
, "mcu_ck");
237 if (IS_ERR(mtk
->mcu_clk
))
238 return PTR_ERR(mtk
->mcu_clk
);
240 mtk
->dma_clk
= optional_clk_get(dev
, "dma_ck");
241 return PTR_ERR_OR_ZERO(mtk
->dma_clk
);
244 static int xhci_mtk_clks_enable(struct xhci_hcd_mtk
*mtk
)
248 ret
= clk_prepare_enable(mtk
->ref_clk
);
250 dev_err(mtk
->dev
, "failed to enable ref_clk\n");
254 ret
= clk_prepare_enable(mtk
->sys_clk
);
256 dev_err(mtk
->dev
, "failed to enable sys_clk\n");
260 ret
= clk_prepare_enable(mtk
->mcu_clk
);
262 dev_err(mtk
->dev
, "failed to enable mcu_clk\n");
266 ret
= clk_prepare_enable(mtk
->dma_clk
);
268 dev_err(mtk
->dev
, "failed to enable dma_clk\n");
275 clk_disable_unprepare(mtk
->mcu_clk
);
277 clk_disable_unprepare(mtk
->sys_clk
);
279 clk_disable_unprepare(mtk
->ref_clk
);
284 static void xhci_mtk_clks_disable(struct xhci_hcd_mtk
*mtk
)
286 clk_disable_unprepare(mtk
->dma_clk
);
287 clk_disable_unprepare(mtk
->mcu_clk
);
288 clk_disable_unprepare(mtk
->sys_clk
);
289 clk_disable_unprepare(mtk
->ref_clk
);
292 /* only clocks can be turn off for ip-sleep wakeup mode */
293 static void usb_wakeup_ip_sleep_set(struct xhci_hcd_mtk
*mtk
, bool enable
)
297 switch (mtk
->uwk_vers
) {
299 reg
= mtk
->uwk_reg_base
+ PERI_WK_CTRL1
;
300 msk
= WC1_IS_EN
| WC1_IS_C(0xf) | WC1_IS_P
;
301 val
= enable
? (WC1_IS_EN
| WC1_IS_C(0x8)) : 0;
304 reg
= mtk
->uwk_reg_base
+ PERI_SSUSB_SPM_CTRL
;
305 msk
= SSC_IP_SLEEP_EN
| SSC_SPM_INT_EN
;
306 val
= enable
? msk
: 0;
311 regmap_update_bits(mtk
->uwk
, reg
, msk
, val
);
314 static int usb_wakeup_of_property_parse(struct xhci_hcd_mtk
*mtk
,
315 struct device_node
*dn
)
317 struct of_phandle_args args
;
320 /* Wakeup function is optional */
321 mtk
->uwk_en
= of_property_read_bool(dn
, "wakeup-source");
325 ret
= of_parse_phandle_with_fixed_args(dn
,
326 "mediatek,syscon-wakeup", 2, 0, &args
);
330 mtk
->uwk_reg_base
= args
.args
[0];
331 mtk
->uwk_vers
= args
.args
[1];
332 mtk
->uwk
= syscon_node_to_regmap(args
.np
);
333 of_node_put(args
.np
);
334 dev_info(mtk
->dev
, "uwk - reg:0x%x, version:%d\n",
335 mtk
->uwk_reg_base
, mtk
->uwk_vers
);
337 return PTR_ERR_OR_ZERO(mtk
->uwk
);
341 static void usb_wakeup_set(struct xhci_hcd_mtk
*mtk
, bool enable
)
344 usb_wakeup_ip_sleep_set(mtk
, enable
);
347 static int xhci_mtk_setup(struct usb_hcd
*hcd
);
348 static const struct xhci_driver_overrides xhci_mtk_overrides __initconst
= {
349 .reset
= xhci_mtk_setup
,
352 static struct hc_driver __read_mostly xhci_mtk_hc_driver
;
354 static int xhci_mtk_ldos_enable(struct xhci_hcd_mtk
*mtk
)
358 ret
= regulator_enable(mtk
->vbus
);
360 dev_err(mtk
->dev
, "failed to enable vbus\n");
364 ret
= regulator_enable(mtk
->vusb33
);
366 dev_err(mtk
->dev
, "failed to enable vusb33\n");
367 regulator_disable(mtk
->vbus
);
373 static void xhci_mtk_ldos_disable(struct xhci_hcd_mtk
*mtk
)
375 regulator_disable(mtk
->vbus
);
376 regulator_disable(mtk
->vusb33
);
379 static void xhci_mtk_quirks(struct device
*dev
, struct xhci_hcd
*xhci
)
381 struct usb_hcd
*hcd
= xhci_to_hcd(xhci
);
382 struct xhci_hcd_mtk
*mtk
= hcd_to_mtk(hcd
);
385 * As of now platform drivers don't provide MSI support so we ensure
386 * here that the generic code does not try to make a pci_dev from our
387 * dev struct in order to setup MSI
389 xhci
->quirks
|= XHCI_PLAT
;
390 xhci
->quirks
|= XHCI_MTK_HOST
;
392 * MTK host controller gives a spurious successful event after a
393 * short transfer. Ignore it.
395 xhci
->quirks
|= XHCI_SPURIOUS_SUCCESS
;
396 if (mtk
->lpm_support
)
397 xhci
->quirks
|= XHCI_LPM_SUPPORT
;
400 /* called during probe() after chip reset completes */
401 static int xhci_mtk_setup(struct usb_hcd
*hcd
)
403 struct xhci_hcd_mtk
*mtk
= hcd_to_mtk(hcd
);
406 if (usb_hcd_is_primary_hcd(hcd
)) {
407 ret
= xhci_mtk_ssusb_config(mtk
);
412 ret
= xhci_gen_setup(hcd
, xhci_mtk_quirks
);
416 if (usb_hcd_is_primary_hcd(hcd
)) {
417 ret
= xhci_mtk_sch_init(mtk
);
425 static int xhci_mtk_probe(struct platform_device
*pdev
)
427 struct device
*dev
= &pdev
->dev
;
428 struct device_node
*node
= dev
->of_node
;
429 struct xhci_hcd_mtk
*mtk
;
430 const struct hc_driver
*driver
;
431 struct xhci_hcd
*xhci
;
432 struct resource
*res
;
440 driver
= &xhci_mtk_hc_driver
;
441 mtk
= devm_kzalloc(dev
, sizeof(*mtk
), GFP_KERNEL
);
446 mtk
->vbus
= devm_regulator_get(dev
, "vbus");
447 if (IS_ERR(mtk
->vbus
)) {
448 dev_err(dev
, "fail to get vbus\n");
449 return PTR_ERR(mtk
->vbus
);
452 mtk
->vusb33
= devm_regulator_get(dev
, "vusb33");
453 if (IS_ERR(mtk
->vusb33
)) {
454 dev_err(dev
, "fail to get vusb33\n");
455 return PTR_ERR(mtk
->vusb33
);
458 ret
= xhci_mtk_clks_get(mtk
);
462 mtk
->lpm_support
= of_property_read_bool(node
, "usb3-lpm-capable");
463 /* optional property, ignore the error if it does not exist */
464 of_property_read_u32(node
, "mediatek,u3p-dis-msk",
467 ret
= usb_wakeup_of_property_parse(mtk
, node
);
469 dev_err(dev
, "failed to parse uwk property\n");
473 pm_runtime_enable(dev
);
474 pm_runtime_get_sync(dev
);
475 device_enable_async_suspend(dev
);
477 ret
= xhci_mtk_ldos_enable(mtk
);
481 ret
= xhci_mtk_clks_enable(mtk
);
485 irq
= platform_get_irq(pdev
, 0);
491 /* Initialize dma_mask and coherent_dma_mask to 32-bits */
492 ret
= dma_set_mask_and_coherent(dev
, DMA_BIT_MASK(32));
496 hcd
= usb_create_hcd(driver
, dev
, dev_name(dev
));
503 * USB 2.0 roothub is stored in the platform_device.
504 * Swap it with mtk HCD.
506 mtk
->hcd
= platform_get_drvdata(pdev
);
507 platform_set_drvdata(pdev
, mtk
);
509 res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "mac");
510 hcd
->regs
= devm_ioremap_resource(dev
, res
);
511 if (IS_ERR(hcd
->regs
)) {
512 ret
= PTR_ERR(hcd
->regs
);
515 hcd
->rsrc_start
= res
->start
;
516 hcd
->rsrc_len
= resource_size(res
);
518 res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "ippc");
519 if (res
) { /* ippc register is optional */
520 mtk
->ippc_regs
= devm_ioremap_resource(dev
, res
);
521 if (IS_ERR(mtk
->ippc_regs
)) {
522 ret
= PTR_ERR(mtk
->ippc_regs
);
525 mtk
->has_ippc
= true;
527 mtk
->has_ippc
= false;
530 device_init_wakeup(dev
, true);
532 xhci
= hcd_to_xhci(hcd
);
533 xhci
->main_hcd
= hcd
;
536 * imod_interval is the interrupt moderation value in nanoseconds.
537 * The increment interval is 8 times as much as that defined in
538 * the xHCI spec on MTK's controller.
540 xhci
->imod_interval
= 5000;
541 device_property_read_u32(dev
, "imod-interval-ns", &xhci
->imod_interval
);
543 xhci
->shared_hcd
= usb_create_shared_hcd(driver
, dev
,
545 if (!xhci
->shared_hcd
) {
547 goto disable_device_wakeup
;
550 ret
= usb_add_hcd(hcd
, irq
, IRQF_SHARED
);
554 if (HCC_MAX_PSA(xhci
->hcc_params
) >= 4)
555 xhci
->shared_hcd
->can_do_streams
= 1;
557 ret
= usb_add_hcd(xhci
->shared_hcd
, irq
, IRQF_SHARED
);
559 goto dealloc_usb2_hcd
;
567 xhci_mtk_sch_exit(mtk
);
568 usb_put_hcd(xhci
->shared_hcd
);
570 disable_device_wakeup
:
571 device_init_wakeup(dev
, false);
577 xhci_mtk_clks_disable(mtk
);
580 xhci_mtk_ldos_disable(mtk
);
583 pm_runtime_put_sync(dev
);
584 pm_runtime_disable(dev
);
588 static int xhci_mtk_remove(struct platform_device
*dev
)
590 struct xhci_hcd_mtk
*mtk
= platform_get_drvdata(dev
);
591 struct usb_hcd
*hcd
= mtk
->hcd
;
592 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
594 usb_remove_hcd(xhci
->shared_hcd
);
595 device_init_wakeup(&dev
->dev
, false);
598 usb_put_hcd(xhci
->shared_hcd
);
600 xhci_mtk_sch_exit(mtk
);
601 xhci_mtk_clks_disable(mtk
);
602 xhci_mtk_ldos_disable(mtk
);
603 pm_runtime_put_sync(&dev
->dev
);
604 pm_runtime_disable(&dev
->dev
);
610 * if ip sleep fails, and all clocks are disabled, access register will hang
611 * AHB bus, so stop polling roothubs to avoid regs access on bus suspend.
612 * and no need to check whether ip sleep failed or not; this will cause SPM
613 * to wake up system immediately after system suspend complete if ip sleep
614 * fails, it is what we wanted.
616 static int __maybe_unused
xhci_mtk_suspend(struct device
*dev
)
618 struct xhci_hcd_mtk
*mtk
= dev_get_drvdata(dev
);
619 struct usb_hcd
*hcd
= mtk
->hcd
;
620 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
622 xhci_dbg(xhci
, "%s: stop port polling\n", __func__
);
623 clear_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
624 del_timer_sync(&hcd
->rh_timer
);
625 clear_bit(HCD_FLAG_POLL_RH
, &xhci
->shared_hcd
->flags
);
626 del_timer_sync(&xhci
->shared_hcd
->rh_timer
);
628 xhci_mtk_host_disable(mtk
);
629 xhci_mtk_clks_disable(mtk
);
630 usb_wakeup_set(mtk
, true);
634 static int __maybe_unused
xhci_mtk_resume(struct device
*dev
)
636 struct xhci_hcd_mtk
*mtk
= dev_get_drvdata(dev
);
637 struct usb_hcd
*hcd
= mtk
->hcd
;
638 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
640 usb_wakeup_set(mtk
, false);
641 xhci_mtk_clks_enable(mtk
);
642 xhci_mtk_host_enable(mtk
);
644 xhci_dbg(xhci
, "%s: restart port polling\n", __func__
);
645 set_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
646 usb_hcd_poll_rh_status(hcd
);
647 set_bit(HCD_FLAG_POLL_RH
, &xhci
->shared_hcd
->flags
);
648 usb_hcd_poll_rh_status(xhci
->shared_hcd
);
652 static const struct dev_pm_ops xhci_mtk_pm_ops
= {
653 SET_SYSTEM_SLEEP_PM_OPS(xhci_mtk_suspend
, xhci_mtk_resume
)
655 #define DEV_PM_OPS IS_ENABLED(CONFIG_PM) ? &xhci_mtk_pm_ops : NULL
658 static const struct of_device_id mtk_xhci_of_match
[] = {
659 { .compatible
= "mediatek,mt8173-xhci"},
660 { .compatible
= "mediatek,mtk-xhci"},
663 MODULE_DEVICE_TABLE(of
, mtk_xhci_of_match
);
666 static struct platform_driver mtk_xhci_driver
= {
667 .probe
= xhci_mtk_probe
,
668 .remove
= xhci_mtk_remove
,
672 .of_match_table
= of_match_ptr(mtk_xhci_of_match
),
675 MODULE_ALIAS("platform:xhci-mtk");
677 static int __init
xhci_mtk_init(void)
679 xhci_init_driver(&xhci_mtk_hc_driver
, &xhci_mtk_overrides
);
680 return platform_driver_register(&mtk_xhci_driver
);
682 module_init(xhci_mtk_init
);
684 static void __exit
xhci_mtk_exit(void)
686 platform_driver_unregister(&mtk_xhci_driver
);
688 module_exit(xhci_mtk_exit
);
690 MODULE_AUTHOR("Chunfeng Yun <chunfeng.yun@mediatek.com>");
691 MODULE_DESCRIPTION("MediaTek xHCI Host Controller Driver");
692 MODULE_LICENSE("GPL v2");