Loading...
1/*
2 * MediaTek xHCI Host Controller Driver
3 *
4 * Copyright (c) 2015 MediaTek Inc.
5 * Author:
6 * Chunfeng Yun <chunfeng.yun@mediatek.com>
7 *
8 * This software is licensed under the terms of the GNU General Public
9 * License version 2, as published by the Free Software Foundation, and
10 * may be copied, distributed, and modified under those terms.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 */
18
19#include <linux/clk.h>
20#include <linux/dma-mapping.h>
21#include <linux/iopoll.h>
22#include <linux/kernel.h>
23#include <linux/mfd/syscon.h>
24#include <linux/module.h>
25#include <linux/of.h>
26#include <linux/phy/phy.h>
27#include <linux/platform_device.h>
28#include <linux/pm_runtime.h>
29#include <linux/regmap.h>
30#include <linux/regulator/consumer.h>
31
32#include "xhci.h"
33#include "xhci-mtk.h"
34
35/* ip_pw_ctrl0 register */
36#define CTRL0_IP_SW_RST BIT(0)
37
38/* ip_pw_ctrl1 register */
39#define CTRL1_IP_HOST_PDN BIT(0)
40
41/* ip_pw_ctrl2 register */
42#define CTRL2_IP_DEV_PDN BIT(0)
43
44/* ip_pw_sts1 register */
45#define STS1_IP_SLEEP_STS BIT(30)
46#define STS1_XHCI_RST BIT(11)
47#define STS1_SYS125_RST BIT(10)
48#define STS1_REF_RST BIT(8)
49#define STS1_SYSPLL_STABLE BIT(0)
50
51/* ip_xhci_cap register */
52#define CAP_U3_PORT_NUM(p) ((p) & 0xff)
53#define CAP_U2_PORT_NUM(p) (((p) >> 8) & 0xff)
54
55/* u3_ctrl_p register */
56#define CTRL_U3_PORT_HOST_SEL BIT(2)
57#define CTRL_U3_PORT_PDN BIT(1)
58#define CTRL_U3_PORT_DIS BIT(0)
59
60/* u2_ctrl_p register */
61#define CTRL_U2_PORT_HOST_SEL BIT(2)
62#define CTRL_U2_PORT_PDN BIT(1)
63#define CTRL_U2_PORT_DIS BIT(0)
64
65/* u2_phy_pll register */
66#define CTRL_U2_FORCE_PLL_STB BIT(28)
67
68#define PERI_WK_CTRL0 0x400
69#define UWK_CTR0_0P_LS_PE BIT(8) /* posedge */
70#define UWK_CTR0_0P_LS_NE BIT(7) /* negedge for 0p linestate*/
71#define UWK_CTL1_1P_LS_C(x) (((x) & 0xf) << 1)
72#define UWK_CTL1_1P_LS_E BIT(0)
73
74#define PERI_WK_CTRL1 0x404
75#define UWK_CTL1_IS_C(x) (((x) & 0xf) << 26)
76#define UWK_CTL1_IS_E BIT(25)
77#define UWK_CTL1_0P_LS_C(x) (((x) & 0xf) << 21)
78#define UWK_CTL1_0P_LS_E BIT(20)
79#define UWK_CTL1_IDDIG_C(x) (((x) & 0xf) << 11) /* cycle debounce */
80#define UWK_CTL1_IDDIG_E BIT(10) /* enable debounce */
81#define UWK_CTL1_IDDIG_P BIT(9) /* polarity */
82#define UWK_CTL1_0P_LS_P BIT(7)
83#define UWK_CTL1_IS_P BIT(6) /* polarity for ip sleep */
84
85enum ssusb_wakeup_src {
86 SSUSB_WK_IP_SLEEP = 1,
87 SSUSB_WK_LINE_STATE = 2,
88};
89
90static int xhci_mtk_host_enable(struct xhci_hcd_mtk *mtk)
91{
92 struct mu3c_ippc_regs __iomem *ippc = mtk->ippc_regs;
93 u32 value, check_val;
94 int ret;
95 int i;
96
97 /* power on host ip */
98 value = readl(&ippc->ip_pw_ctr1);
99 value &= ~CTRL1_IP_HOST_PDN;
100 writel(value, &ippc->ip_pw_ctr1);
101
102 /* power on and enable all u3 ports */
103 for (i = 0; i < mtk->num_u3_ports; i++) {
104 value = readl(&ippc->u3_ctrl_p[i]);
105 value &= ~(CTRL_U3_PORT_PDN | CTRL_U3_PORT_DIS);
106 value |= CTRL_U3_PORT_HOST_SEL;
107 writel(value, &ippc->u3_ctrl_p[i]);
108 }
109
110 /* power on and enable all u2 ports */
111 for (i = 0; i < mtk->num_u2_ports; i++) {
112 value = readl(&ippc->u2_ctrl_p[i]);
113 value &= ~(CTRL_U2_PORT_PDN | CTRL_U2_PORT_DIS);
114 value |= CTRL_U2_PORT_HOST_SEL;
115 writel(value, &ippc->u2_ctrl_p[i]);
116 }
117
118 /*
119 * wait for clocks to be stable, and clock domains reset to
120 * be inactive after power on and enable ports
121 */
122 check_val = STS1_SYSPLL_STABLE | STS1_REF_RST |
123 STS1_SYS125_RST | STS1_XHCI_RST;
124
125 ret = readl_poll_timeout(&ippc->ip_pw_sts1, value,
126 (check_val == (value & check_val)), 100, 20000);
127 if (ret) {
128 dev_err(mtk->dev, "clocks are not stable (0x%x)\n", value);
129 return ret;
130 }
131
132 return 0;
133}
134
135static int xhci_mtk_host_disable(struct xhci_hcd_mtk *mtk)
136{
137 struct mu3c_ippc_regs __iomem *ippc = mtk->ippc_regs;
138 u32 value;
139 int ret;
140 int i;
141
142 /* power down all u3 ports */
143 for (i = 0; i < mtk->num_u3_ports; i++) {
144 value = readl(&ippc->u3_ctrl_p[i]);
145 value |= CTRL_U3_PORT_PDN;
146 writel(value, &ippc->u3_ctrl_p[i]);
147 }
148
149 /* power down all u2 ports */
150 for (i = 0; i < mtk->num_u2_ports; i++) {
151 value = readl(&ippc->u2_ctrl_p[i]);
152 value |= CTRL_U2_PORT_PDN;
153 writel(value, &ippc->u2_ctrl_p[i]);
154 }
155
156 /* power down host ip */
157 value = readl(&ippc->ip_pw_ctr1);
158 value |= CTRL1_IP_HOST_PDN;
159 writel(value, &ippc->ip_pw_ctr1);
160
161 /* wait for host ip to sleep */
162 ret = readl_poll_timeout(&ippc->ip_pw_sts1, value,
163 (value & STS1_IP_SLEEP_STS), 100, 100000);
164 if (ret) {
165 dev_err(mtk->dev, "ip sleep failed!!!\n");
166 return ret;
167 }
168 return 0;
169}
170
171static int xhci_mtk_ssusb_config(struct xhci_hcd_mtk *mtk)
172{
173 struct mu3c_ippc_regs __iomem *ippc = mtk->ippc_regs;
174 u32 value;
175
176 /* reset whole ip */
177 value = readl(&ippc->ip_pw_ctr0);
178 value |= CTRL0_IP_SW_RST;
179 writel(value, &ippc->ip_pw_ctr0);
180 udelay(1);
181 value = readl(&ippc->ip_pw_ctr0);
182 value &= ~CTRL0_IP_SW_RST;
183 writel(value, &ippc->ip_pw_ctr0);
184
185 /*
186 * device ip is default power-on in fact
187 * power down device ip, otherwise ip-sleep will fail
188 */
189 value = readl(&ippc->ip_pw_ctr2);
190 value |= CTRL2_IP_DEV_PDN;
191 writel(value, &ippc->ip_pw_ctr2);
192
193 value = readl(&ippc->ip_xhci_cap);
194 mtk->num_u3_ports = CAP_U3_PORT_NUM(value);
195 mtk->num_u2_ports = CAP_U2_PORT_NUM(value);
196 dev_dbg(mtk->dev, "%s u2p:%d, u3p:%d\n", __func__,
197 mtk->num_u2_ports, mtk->num_u3_ports);
198
199 return xhci_mtk_host_enable(mtk);
200}
201
202static int xhci_mtk_clks_enable(struct xhci_hcd_mtk *mtk)
203{
204 int ret;
205
206 ret = clk_prepare_enable(mtk->sys_clk);
207 if (ret) {
208 dev_err(mtk->dev, "failed to enable sys_clk\n");
209 goto sys_clk_err;
210 }
211
212 if (mtk->wakeup_src) {
213 ret = clk_prepare_enable(mtk->wk_deb_p0);
214 if (ret) {
215 dev_err(mtk->dev, "failed to enable wk_deb_p0\n");
216 goto usb_p0_err;
217 }
218
219 ret = clk_prepare_enable(mtk->wk_deb_p1);
220 if (ret) {
221 dev_err(mtk->dev, "failed to enable wk_deb_p1\n");
222 goto usb_p1_err;
223 }
224 }
225 return 0;
226
227usb_p1_err:
228 clk_disable_unprepare(mtk->wk_deb_p0);
229usb_p0_err:
230 clk_disable_unprepare(mtk->sys_clk);
231sys_clk_err:
232 return -EINVAL;
233}
234
235static void xhci_mtk_clks_disable(struct xhci_hcd_mtk *mtk)
236{
237 if (mtk->wakeup_src) {
238 clk_disable_unprepare(mtk->wk_deb_p1);
239 clk_disable_unprepare(mtk->wk_deb_p0);
240 }
241 clk_disable_unprepare(mtk->sys_clk);
242}
243
244/* only clocks can be turn off for ip-sleep wakeup mode */
245static void usb_wakeup_ip_sleep_en(struct xhci_hcd_mtk *mtk)
246{
247 u32 tmp;
248 struct regmap *pericfg = mtk->pericfg;
249
250 regmap_read(pericfg, PERI_WK_CTRL1, &tmp);
251 tmp &= ~UWK_CTL1_IS_P;
252 tmp &= ~(UWK_CTL1_IS_C(0xf));
253 tmp |= UWK_CTL1_IS_C(0x8);
254 regmap_write(pericfg, PERI_WK_CTRL1, tmp);
255 regmap_write(pericfg, PERI_WK_CTRL1, tmp | UWK_CTL1_IS_E);
256
257 regmap_read(pericfg, PERI_WK_CTRL1, &tmp);
258 dev_dbg(mtk->dev, "%s(): WK_CTRL1[P6,E25,C26:29]=%#x\n",
259 __func__, tmp);
260}
261
262static void usb_wakeup_ip_sleep_dis(struct xhci_hcd_mtk *mtk)
263{
264 u32 tmp;
265
266 regmap_read(mtk->pericfg, PERI_WK_CTRL1, &tmp);
267 tmp &= ~UWK_CTL1_IS_E;
268 regmap_write(mtk->pericfg, PERI_WK_CTRL1, tmp);
269}
270
271/*
272* for line-state wakeup mode, phy's power should not power-down
273* and only support cable plug in/out
274*/
275static void usb_wakeup_line_state_en(struct xhci_hcd_mtk *mtk)
276{
277 u32 tmp;
278 struct regmap *pericfg = mtk->pericfg;
279
280 /* line-state of u2-port0 */
281 regmap_read(pericfg, PERI_WK_CTRL1, &tmp);
282 tmp &= ~UWK_CTL1_0P_LS_P;
283 tmp &= ~(UWK_CTL1_0P_LS_C(0xf));
284 tmp |= UWK_CTL1_0P_LS_C(0x8);
285 regmap_write(pericfg, PERI_WK_CTRL1, tmp);
286 regmap_read(pericfg, PERI_WK_CTRL1, &tmp);
287 regmap_write(pericfg, PERI_WK_CTRL1, tmp | UWK_CTL1_0P_LS_E);
288
289 /* line-state of u2-port1 */
290 regmap_read(pericfg, PERI_WK_CTRL0, &tmp);
291 tmp &= ~(UWK_CTL1_1P_LS_C(0xf));
292 tmp |= UWK_CTL1_1P_LS_C(0x8);
293 regmap_write(pericfg, PERI_WK_CTRL0, tmp);
294 regmap_write(pericfg, PERI_WK_CTRL0, tmp | UWK_CTL1_1P_LS_E);
295}
296
297static void usb_wakeup_line_state_dis(struct xhci_hcd_mtk *mtk)
298{
299 u32 tmp;
300 struct regmap *pericfg = mtk->pericfg;
301
302 /* line-state of u2-port0 */
303 regmap_read(pericfg, PERI_WK_CTRL1, &tmp);
304 tmp &= ~UWK_CTL1_0P_LS_E;
305 regmap_write(pericfg, PERI_WK_CTRL1, tmp);
306
307 /* line-state of u2-port1 */
308 regmap_read(pericfg, PERI_WK_CTRL0, &tmp);
309 tmp &= ~UWK_CTL1_1P_LS_E;
310 regmap_write(pericfg, PERI_WK_CTRL0, tmp);
311}
312
313static void usb_wakeup_enable(struct xhci_hcd_mtk *mtk)
314{
315 if (mtk->wakeup_src == SSUSB_WK_IP_SLEEP)
316 usb_wakeup_ip_sleep_en(mtk);
317 else if (mtk->wakeup_src == SSUSB_WK_LINE_STATE)
318 usb_wakeup_line_state_en(mtk);
319}
320
321static void usb_wakeup_disable(struct xhci_hcd_mtk *mtk)
322{
323 if (mtk->wakeup_src == SSUSB_WK_IP_SLEEP)
324 usb_wakeup_ip_sleep_dis(mtk);
325 else if (mtk->wakeup_src == SSUSB_WK_LINE_STATE)
326 usb_wakeup_line_state_dis(mtk);
327}
328
329static int usb_wakeup_of_property_parse(struct xhci_hcd_mtk *mtk,
330 struct device_node *dn)
331{
332 struct device *dev = mtk->dev;
333
334 /*
335 * wakeup function is optional, so it is not an error if this property
336 * does not exist, and in such case, no need to get relative
337 * properties anymore.
338 */
339 of_property_read_u32(dn, "mediatek,wakeup-src", &mtk->wakeup_src);
340 if (!mtk->wakeup_src)
341 return 0;
342
343 mtk->wk_deb_p0 = devm_clk_get(dev, "wakeup_deb_p0");
344 if (IS_ERR(mtk->wk_deb_p0)) {
345 dev_err(dev, "fail to get wakeup_deb_p0\n");
346 return PTR_ERR(mtk->wk_deb_p0);
347 }
348
349 mtk->wk_deb_p1 = devm_clk_get(dev, "wakeup_deb_p1");
350 if (IS_ERR(mtk->wk_deb_p1)) {
351 dev_err(dev, "fail to get wakeup_deb_p1\n");
352 return PTR_ERR(mtk->wk_deb_p1);
353 }
354
355 mtk->pericfg = syscon_regmap_lookup_by_phandle(dn,
356 "mediatek,syscon-wakeup");
357 if (IS_ERR(mtk->pericfg)) {
358 dev_err(dev, "fail to get pericfg regs\n");
359 return PTR_ERR(mtk->pericfg);
360 }
361
362 return 0;
363}
364
365static int xhci_mtk_setup(struct usb_hcd *hcd);
366static const struct xhci_driver_overrides xhci_mtk_overrides __initconst = {
367 .extra_priv_size = sizeof(struct xhci_hcd),
368 .reset = xhci_mtk_setup,
369};
370
371static struct hc_driver __read_mostly xhci_mtk_hc_driver;
372
373static int xhci_mtk_phy_init(struct xhci_hcd_mtk *mtk)
374{
375 int i;
376 int ret;
377
378 for (i = 0; i < mtk->num_phys; i++) {
379 ret = phy_init(mtk->phys[i]);
380 if (ret)
381 goto exit_phy;
382 }
383 return 0;
384
385exit_phy:
386 for (; i > 0; i--)
387 phy_exit(mtk->phys[i - 1]);
388
389 return ret;
390}
391
392static int xhci_mtk_phy_exit(struct xhci_hcd_mtk *mtk)
393{
394 int i;
395
396 for (i = 0; i < mtk->num_phys; i++)
397 phy_exit(mtk->phys[i]);
398
399 return 0;
400}
401
402static int xhci_mtk_phy_power_on(struct xhci_hcd_mtk *mtk)
403{
404 int i;
405 int ret;
406
407 for (i = 0; i < mtk->num_phys; i++) {
408 ret = phy_power_on(mtk->phys[i]);
409 if (ret)
410 goto power_off_phy;
411 }
412 return 0;
413
414power_off_phy:
415 for (; i > 0; i--)
416 phy_power_off(mtk->phys[i - 1]);
417
418 return ret;
419}
420
421static void xhci_mtk_phy_power_off(struct xhci_hcd_mtk *mtk)
422{
423 unsigned int i;
424
425 for (i = 0; i < mtk->num_phys; i++)
426 phy_power_off(mtk->phys[i]);
427}
428
429static int xhci_mtk_ldos_enable(struct xhci_hcd_mtk *mtk)
430{
431 int ret;
432
433 ret = regulator_enable(mtk->vbus);
434 if (ret) {
435 dev_err(mtk->dev, "failed to enable vbus\n");
436 return ret;
437 }
438
439 ret = regulator_enable(mtk->vusb33);
440 if (ret) {
441 dev_err(mtk->dev, "failed to enable vusb33\n");
442 regulator_disable(mtk->vbus);
443 return ret;
444 }
445 return 0;
446}
447
448static void xhci_mtk_ldos_disable(struct xhci_hcd_mtk *mtk)
449{
450 regulator_disable(mtk->vbus);
451 regulator_disable(mtk->vusb33);
452}
453
454static void xhci_mtk_quirks(struct device *dev, struct xhci_hcd *xhci)
455{
456 struct usb_hcd *hcd = xhci_to_hcd(xhci);
457 struct xhci_hcd_mtk *mtk = hcd_to_mtk(hcd);
458
459 /*
460 * As of now platform drivers don't provide MSI support so we ensure
461 * here that the generic code does not try to make a pci_dev from our
462 * dev struct in order to setup MSI
463 */
464 xhci->quirks |= XHCI_PLAT;
465 xhci->quirks |= XHCI_MTK_HOST;
466 /*
467 * MTK host controller gives a spurious successful event after a
468 * short transfer. Ignore it.
469 */
470 xhci->quirks |= XHCI_SPURIOUS_SUCCESS;
471 if (mtk->lpm_support)
472 xhci->quirks |= XHCI_LPM_SUPPORT;
473}
474
475/* called during probe() after chip reset completes */
476static int xhci_mtk_setup(struct usb_hcd *hcd)
477{
478 struct xhci_hcd_mtk *mtk = hcd_to_mtk(hcd);
479 int ret;
480
481 if (usb_hcd_is_primary_hcd(hcd)) {
482 ret = xhci_mtk_ssusb_config(mtk);
483 if (ret)
484 return ret;
485 ret = xhci_mtk_sch_init(mtk);
486 if (ret)
487 return ret;
488 }
489
490 return xhci_gen_setup(hcd, xhci_mtk_quirks);
491}
492
493static int xhci_mtk_probe(struct platform_device *pdev)
494{
495 struct device *dev = &pdev->dev;
496 struct device_node *node = dev->of_node;
497 struct xhci_hcd_mtk *mtk;
498 const struct hc_driver *driver;
499 struct xhci_hcd *xhci;
500 struct resource *res;
501 struct usb_hcd *hcd;
502 struct phy *phy;
503 int phy_num;
504 int ret = -ENODEV;
505 int irq;
506
507 if (usb_disabled())
508 return -ENODEV;
509
510 driver = &xhci_mtk_hc_driver;
511 mtk = devm_kzalloc(dev, sizeof(*mtk), GFP_KERNEL);
512 if (!mtk)
513 return -ENOMEM;
514
515 mtk->dev = dev;
516 mtk->vbus = devm_regulator_get(dev, "vbus");
517 if (IS_ERR(mtk->vbus)) {
518 dev_err(dev, "fail to get vbus\n");
519 return PTR_ERR(mtk->vbus);
520 }
521
522 mtk->vusb33 = devm_regulator_get(dev, "vusb33");
523 if (IS_ERR(mtk->vusb33)) {
524 dev_err(dev, "fail to get vusb33\n");
525 return PTR_ERR(mtk->vusb33);
526 }
527
528 mtk->sys_clk = devm_clk_get(dev, "sys_ck");
529 if (IS_ERR(mtk->sys_clk)) {
530 dev_err(dev, "fail to get sys_ck\n");
531 return PTR_ERR(mtk->sys_clk);
532 }
533
534 mtk->lpm_support = of_property_read_bool(node, "usb3-lpm-capable");
535
536 ret = usb_wakeup_of_property_parse(mtk, node);
537 if (ret)
538 return ret;
539
540 mtk->num_phys = of_count_phandle_with_args(node,
541 "phys", "#phy-cells");
542 if (mtk->num_phys > 0) {
543 mtk->phys = devm_kcalloc(dev, mtk->num_phys,
544 sizeof(*mtk->phys), GFP_KERNEL);
545 if (!mtk->phys)
546 return -ENOMEM;
547 } else {
548 mtk->num_phys = 0;
549 }
550 pm_runtime_enable(dev);
551 pm_runtime_get_sync(dev);
552 device_enable_async_suspend(dev);
553
554 ret = xhci_mtk_ldos_enable(mtk);
555 if (ret)
556 goto disable_pm;
557
558 ret = xhci_mtk_clks_enable(mtk);
559 if (ret)
560 goto disable_ldos;
561
562 irq = platform_get_irq(pdev, 0);
563 if (irq < 0)
564 goto disable_clk;
565
566 /* Initialize dma_mask and coherent_dma_mask to 32-bits */
567 ret = dma_set_coherent_mask(dev, DMA_BIT_MASK(32));
568 if (ret)
569 goto disable_clk;
570
571 if (!dev->dma_mask)
572 dev->dma_mask = &dev->coherent_dma_mask;
573 else
574 dma_set_mask(dev, DMA_BIT_MASK(32));
575
576 hcd = usb_create_hcd(driver, dev, dev_name(dev));
577 if (!hcd) {
578 ret = -ENOMEM;
579 goto disable_clk;
580 }
581
582 /*
583 * USB 2.0 roothub is stored in the platform_device.
584 * Swap it with mtk HCD.
585 */
586 mtk->hcd = platform_get_drvdata(pdev);
587 platform_set_drvdata(pdev, mtk);
588
589 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
590 hcd->regs = devm_ioremap_resource(dev, res);
591 if (IS_ERR(hcd->regs)) {
592 ret = PTR_ERR(hcd->regs);
593 goto put_usb2_hcd;
594 }
595 hcd->rsrc_start = res->start;
596 hcd->rsrc_len = resource_size(res);
597
598 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
599 mtk->ippc_regs = devm_ioremap_resource(dev, res);
600 if (IS_ERR(mtk->ippc_regs)) {
601 ret = PTR_ERR(mtk->ippc_regs);
602 goto put_usb2_hcd;
603 }
604
605 for (phy_num = 0; phy_num < mtk->num_phys; phy_num++) {
606 phy = devm_of_phy_get_by_index(dev, node, phy_num);
607 if (IS_ERR(phy)) {
608 ret = PTR_ERR(phy);
609 goto put_usb2_hcd;
610 }
611 mtk->phys[phy_num] = phy;
612 }
613
614 ret = xhci_mtk_phy_init(mtk);
615 if (ret)
616 goto put_usb2_hcd;
617
618 ret = xhci_mtk_phy_power_on(mtk);
619 if (ret)
620 goto exit_phys;
621
622 device_init_wakeup(dev, true);
623
624 xhci = hcd_to_xhci(hcd);
625 xhci->main_hcd = hcd;
626 xhci->shared_hcd = usb_create_shared_hcd(driver, dev,
627 dev_name(dev), hcd);
628 if (!xhci->shared_hcd) {
629 ret = -ENOMEM;
630 goto power_off_phys;
631 }
632
633 if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
634 xhci->shared_hcd->can_do_streams = 1;
635
636 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
637 if (ret)
638 goto put_usb3_hcd;
639
640 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
641 if (ret)
642 goto dealloc_usb2_hcd;
643
644 return 0;
645
646dealloc_usb2_hcd:
647 usb_remove_hcd(hcd);
648
649put_usb3_hcd:
650 xhci_mtk_sch_exit(mtk);
651 usb_put_hcd(xhci->shared_hcd);
652
653power_off_phys:
654 xhci_mtk_phy_power_off(mtk);
655 device_init_wakeup(dev, false);
656
657exit_phys:
658 xhci_mtk_phy_exit(mtk);
659
660put_usb2_hcd:
661 usb_put_hcd(hcd);
662
663disable_clk:
664 xhci_mtk_clks_disable(mtk);
665
666disable_ldos:
667 xhci_mtk_ldos_disable(mtk);
668
669disable_pm:
670 pm_runtime_put_sync(dev);
671 pm_runtime_disable(dev);
672 return ret;
673}
674
675static int xhci_mtk_remove(struct platform_device *dev)
676{
677 struct xhci_hcd_mtk *mtk = platform_get_drvdata(dev);
678 struct usb_hcd *hcd = mtk->hcd;
679 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
680
681 usb_remove_hcd(xhci->shared_hcd);
682 xhci_mtk_phy_power_off(mtk);
683 xhci_mtk_phy_exit(mtk);
684 device_init_wakeup(&dev->dev, false);
685
686 usb_remove_hcd(hcd);
687 usb_put_hcd(xhci->shared_hcd);
688 usb_put_hcd(hcd);
689 xhci_mtk_sch_exit(mtk);
690 xhci_mtk_clks_disable(mtk);
691 xhci_mtk_ldos_disable(mtk);
692 pm_runtime_put_sync(&dev->dev);
693 pm_runtime_disable(&dev->dev);
694
695 return 0;
696}
697
698/*
699 * if ip sleep fails, and all clocks are disabled, access register will hang
700 * AHB bus, so stop polling roothubs to avoid regs access on bus suspend.
701 * and no need to check whether ip sleep failed or not; this will cause SPM
702 * to wake up system immediately after system suspend complete if ip sleep
703 * fails, it is what we wanted.
704 */
705static int __maybe_unused xhci_mtk_suspend(struct device *dev)
706{
707 struct xhci_hcd_mtk *mtk = dev_get_drvdata(dev);
708 struct usb_hcd *hcd = mtk->hcd;
709 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
710
711 xhci_dbg(xhci, "%s: stop port polling\n", __func__);
712 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
713 del_timer_sync(&hcd->rh_timer);
714 clear_bit(HCD_FLAG_POLL_RH, &xhci->shared_hcd->flags);
715 del_timer_sync(&xhci->shared_hcd->rh_timer);
716
717 xhci_mtk_host_disable(mtk);
718 xhci_mtk_phy_power_off(mtk);
719 xhci_mtk_clks_disable(mtk);
720 usb_wakeup_enable(mtk);
721 return 0;
722}
723
724static int __maybe_unused xhci_mtk_resume(struct device *dev)
725{
726 struct xhci_hcd_mtk *mtk = dev_get_drvdata(dev);
727 struct usb_hcd *hcd = mtk->hcd;
728 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
729
730 usb_wakeup_disable(mtk);
731 xhci_mtk_clks_enable(mtk);
732 xhci_mtk_phy_power_on(mtk);
733 xhci_mtk_host_enable(mtk);
734
735 xhci_dbg(xhci, "%s: restart port polling\n", __func__);
736 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
737 usb_hcd_poll_rh_status(hcd);
738 set_bit(HCD_FLAG_POLL_RH, &xhci->shared_hcd->flags);
739 usb_hcd_poll_rh_status(xhci->shared_hcd);
740 return 0;
741}
742
743static const struct dev_pm_ops xhci_mtk_pm_ops = {
744 SET_SYSTEM_SLEEP_PM_OPS(xhci_mtk_suspend, xhci_mtk_resume)
745};
746#define DEV_PM_OPS IS_ENABLED(CONFIG_PM) ? &xhci_mtk_pm_ops : NULL
747
748#ifdef CONFIG_OF
749static const struct of_device_id mtk_xhci_of_match[] = {
750 { .compatible = "mediatek,mt8173-xhci"},
751 { },
752};
753MODULE_DEVICE_TABLE(of, mtk_xhci_of_match);
754#endif
755
756static struct platform_driver mtk_xhci_driver = {
757 .probe = xhci_mtk_probe,
758 .remove = xhci_mtk_remove,
759 .driver = {
760 .name = "xhci-mtk",
761 .pm = DEV_PM_OPS,
762 .of_match_table = of_match_ptr(mtk_xhci_of_match),
763 },
764};
765MODULE_ALIAS("platform:xhci-mtk");
766
767static int __init xhci_mtk_init(void)
768{
769 xhci_init_driver(&xhci_mtk_hc_driver, &xhci_mtk_overrides);
770 return platform_driver_register(&mtk_xhci_driver);
771}
772module_init(xhci_mtk_init);
773
774static void __exit xhci_mtk_exit(void)
775{
776 platform_driver_unregister(&mtk_xhci_driver);
777}
778module_exit(xhci_mtk_exit);
779
780MODULE_AUTHOR("Chunfeng Yun <chunfeng.yun@mediatek.com>");
781MODULE_DESCRIPTION("MediaTek xHCI Host Controller Driver");
782MODULE_LICENSE("GPL v2");
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * MediaTek xHCI Host Controller Driver
4 *
5 * Copyright (c) 2015 MediaTek Inc.
6 * Author:
7 * Chunfeng Yun <chunfeng.yun@mediatek.com>
8 */
9
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>
16#include <linux/of.h>
17#include <linux/platform_device.h>
18#include <linux/pm_runtime.h>
19#include <linux/regmap.h>
20#include <linux/regulator/consumer.h>
21
22#include "xhci.h"
23#include "xhci-mtk.h"
24
25/* ip_pw_ctrl0 register */
26#define CTRL0_IP_SW_RST BIT(0)
27
28/* ip_pw_ctrl1 register */
29#define CTRL1_IP_HOST_PDN BIT(0)
30
31/* ip_pw_ctrl2 register */
32#define CTRL2_IP_DEV_PDN BIT(0)
33
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)
41
42/* ip_xhci_cap register */
43#define CAP_U3_PORT_NUM(p) ((p) & 0xff)
44#define CAP_U2_PORT_NUM(p) (((p) >> 8) & 0xff)
45
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)
50
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)
55
56/* u2_phy_pll register */
57#define CTRL_U2_FORCE_PLL_STB BIT(28)
58
59/* usb remote wakeup registers in syscon */
60/* mt8173 etc */
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 */
65
66/* mt2712 etc */
67#define PERI_SSUSB_SPM_CTRL 0x0
68#define SSC_IP_SLEEP_EN BIT(4)
69#define SSC_SPM_INT_EN BIT(1)
70
71enum ssusb_uwk_vers {
72 SSUSB_UWK_V1 = 1,
73 SSUSB_UWK_V2,
74};
75
76static int xhci_mtk_host_enable(struct xhci_hcd_mtk *mtk)
77{
78 struct mu3c_ippc_regs __iomem *ippc = mtk->ippc_regs;
79 u32 value, check_val;
80 int u3_ports_disabed = 0;
81 int ret;
82 int i;
83
84 if (!mtk->has_ippc)
85 return 0;
86
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);
91
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) {
95 u3_ports_disabed++;
96 continue;
97 }
98
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]);
103 }
104
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]);
111 }
112
113 /*
114 * wait for clocks to be stable, and clock domains reset to
115 * be inactive after power on and enable ports
116 */
117 check_val = STS1_SYSPLL_STABLE | STS1_REF_RST |
118 STS1_SYS125_RST | STS1_XHCI_RST;
119
120 if (mtk->num_u3_ports > u3_ports_disabed)
121 check_val |= STS1_U3_MAC_RST;
122
123 ret = readl_poll_timeout(&ippc->ip_pw_sts1, value,
124 (check_val == (value & check_val)), 100, 20000);
125 if (ret) {
126 dev_err(mtk->dev, "clocks are not stable (0x%x)\n", value);
127 return ret;
128 }
129
130 return 0;
131}
132
133static int xhci_mtk_host_disable(struct xhci_hcd_mtk *mtk)
134{
135 struct mu3c_ippc_regs __iomem *ippc = mtk->ippc_regs;
136 u32 value;
137 int ret;
138 int i;
139
140 if (!mtk->has_ippc)
141 return 0;
142
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)
146 continue;
147
148 value = readl(&ippc->u3_ctrl_p[i]);
149 value |= CTRL_U3_PORT_PDN;
150 writel(value, &ippc->u3_ctrl_p[i]);
151 }
152
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]);
158 }
159
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);
164
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);
168 if (ret) {
169 dev_err(mtk->dev, "ip sleep failed!!!\n");
170 return ret;
171 }
172 return 0;
173}
174
175static int xhci_mtk_ssusb_config(struct xhci_hcd_mtk *mtk)
176{
177 struct mu3c_ippc_regs __iomem *ippc = mtk->ippc_regs;
178 u32 value;
179
180 if (!mtk->has_ippc)
181 return 0;
182
183 /* reset whole ip */
184 value = readl(&ippc->ip_pw_ctr0);
185 value |= CTRL0_IP_SW_RST;
186 writel(value, &ippc->ip_pw_ctr0);
187 udelay(1);
188 value = readl(&ippc->ip_pw_ctr0);
189 value &= ~CTRL0_IP_SW_RST;
190 writel(value, &ippc->ip_pw_ctr0);
191
192 /*
193 * device ip is default power-on in fact
194 * power down device ip, otherwise ip-sleep will fail
195 */
196 value = readl(&ippc->ip_pw_ctr2);
197 value |= CTRL2_IP_DEV_PDN;
198 writel(value, &ippc->ip_pw_ctr2);
199
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);
205
206 return xhci_mtk_host_enable(mtk);
207}
208
209static int xhci_mtk_clks_get(struct xhci_hcd_mtk *mtk)
210{
211 struct device *dev = mtk->dev;
212
213 mtk->sys_clk = devm_clk_get(dev, "sys_ck");
214 if (IS_ERR(mtk->sys_clk)) {
215 dev_err(dev, "fail to get sys_ck\n");
216 return PTR_ERR(mtk->sys_clk);
217 }
218
219 mtk->xhci_clk = devm_clk_get_optional(dev, "xhci_ck");
220 if (IS_ERR(mtk->xhci_clk))
221 return PTR_ERR(mtk->xhci_clk);
222
223 mtk->ref_clk = devm_clk_get_optional(dev, "ref_ck");
224 if (IS_ERR(mtk->ref_clk))
225 return PTR_ERR(mtk->ref_clk);
226
227 mtk->mcu_clk = devm_clk_get_optional(dev, "mcu_ck");
228 if (IS_ERR(mtk->mcu_clk))
229 return PTR_ERR(mtk->mcu_clk);
230
231 mtk->dma_clk = devm_clk_get_optional(dev, "dma_ck");
232 return PTR_ERR_OR_ZERO(mtk->dma_clk);
233}
234
235static int xhci_mtk_clks_enable(struct xhci_hcd_mtk *mtk)
236{
237 int ret;
238
239 ret = clk_prepare_enable(mtk->ref_clk);
240 if (ret) {
241 dev_err(mtk->dev, "failed to enable ref_clk\n");
242 goto ref_clk_err;
243 }
244
245 ret = clk_prepare_enable(mtk->sys_clk);
246 if (ret) {
247 dev_err(mtk->dev, "failed to enable sys_clk\n");
248 goto sys_clk_err;
249 }
250
251 ret = clk_prepare_enable(mtk->xhci_clk);
252 if (ret) {
253 dev_err(mtk->dev, "failed to enable xhci_clk\n");
254 goto xhci_clk_err;
255 }
256
257 ret = clk_prepare_enable(mtk->mcu_clk);
258 if (ret) {
259 dev_err(mtk->dev, "failed to enable mcu_clk\n");
260 goto mcu_clk_err;
261 }
262
263 ret = clk_prepare_enable(mtk->dma_clk);
264 if (ret) {
265 dev_err(mtk->dev, "failed to enable dma_clk\n");
266 goto dma_clk_err;
267 }
268
269 return 0;
270
271dma_clk_err:
272 clk_disable_unprepare(mtk->mcu_clk);
273mcu_clk_err:
274 clk_disable_unprepare(mtk->xhci_clk);
275xhci_clk_err:
276 clk_disable_unprepare(mtk->sys_clk);
277sys_clk_err:
278 clk_disable_unprepare(mtk->ref_clk);
279ref_clk_err:
280 return ret;
281}
282
283static void xhci_mtk_clks_disable(struct xhci_hcd_mtk *mtk)
284{
285 clk_disable_unprepare(mtk->dma_clk);
286 clk_disable_unprepare(mtk->mcu_clk);
287 clk_disable_unprepare(mtk->xhci_clk);
288 clk_disable_unprepare(mtk->sys_clk);
289 clk_disable_unprepare(mtk->ref_clk);
290}
291
292/* only clocks can be turn off for ip-sleep wakeup mode */
293static void usb_wakeup_ip_sleep_set(struct xhci_hcd_mtk *mtk, bool enable)
294{
295 u32 reg, msk, val;
296
297 switch (mtk->uwk_vers) {
298 case SSUSB_UWK_V1:
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;
302 break;
303 case SSUSB_UWK_V2:
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;
307 break;
308 default:
309 return;
310 }
311 regmap_update_bits(mtk->uwk, reg, msk, val);
312}
313
314static int usb_wakeup_of_property_parse(struct xhci_hcd_mtk *mtk,
315 struct device_node *dn)
316{
317 struct of_phandle_args args;
318 int ret;
319
320 /* Wakeup function is optional */
321 mtk->uwk_en = of_property_read_bool(dn, "wakeup-source");
322 if (!mtk->uwk_en)
323 return 0;
324
325 ret = of_parse_phandle_with_fixed_args(dn,
326 "mediatek,syscon-wakeup", 2, 0, &args);
327 if (ret)
328 return ret;
329
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);
336
337 return PTR_ERR_OR_ZERO(mtk->uwk);
338
339}
340
341static void usb_wakeup_set(struct xhci_hcd_mtk *mtk, bool enable)
342{
343 if (mtk->uwk_en)
344 usb_wakeup_ip_sleep_set(mtk, enable);
345}
346
347static int xhci_mtk_setup(struct usb_hcd *hcd);
348static const struct xhci_driver_overrides xhci_mtk_overrides __initconst = {
349 .reset = xhci_mtk_setup,
350};
351
352static struct hc_driver __read_mostly xhci_mtk_hc_driver;
353
354static int xhci_mtk_ldos_enable(struct xhci_hcd_mtk *mtk)
355{
356 int ret;
357
358 ret = regulator_enable(mtk->vbus);
359 if (ret) {
360 dev_err(mtk->dev, "failed to enable vbus\n");
361 return ret;
362 }
363
364 ret = regulator_enable(mtk->vusb33);
365 if (ret) {
366 dev_err(mtk->dev, "failed to enable vusb33\n");
367 regulator_disable(mtk->vbus);
368 return ret;
369 }
370 return 0;
371}
372
373static void xhci_mtk_ldos_disable(struct xhci_hcd_mtk *mtk)
374{
375 regulator_disable(mtk->vbus);
376 regulator_disable(mtk->vusb33);
377}
378
379static void xhci_mtk_quirks(struct device *dev, struct xhci_hcd *xhci)
380{
381 struct usb_hcd *hcd = xhci_to_hcd(xhci);
382 struct xhci_hcd_mtk *mtk = hcd_to_mtk(hcd);
383
384 /*
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
388 */
389 xhci->quirks |= XHCI_PLAT;
390 xhci->quirks |= XHCI_MTK_HOST;
391 /*
392 * MTK host controller gives a spurious successful event after a
393 * short transfer. Ignore it.
394 */
395 xhci->quirks |= XHCI_SPURIOUS_SUCCESS;
396 if (mtk->lpm_support)
397 xhci->quirks |= XHCI_LPM_SUPPORT;
398}
399
400/* called during probe() after chip reset completes */
401static int xhci_mtk_setup(struct usb_hcd *hcd)
402{
403 struct xhci_hcd_mtk *mtk = hcd_to_mtk(hcd);
404 int ret;
405
406 if (usb_hcd_is_primary_hcd(hcd)) {
407 ret = xhci_mtk_ssusb_config(mtk);
408 if (ret)
409 return ret;
410 }
411
412 ret = xhci_gen_setup(hcd, xhci_mtk_quirks);
413 if (ret)
414 return ret;
415
416 if (usb_hcd_is_primary_hcd(hcd)) {
417 ret = xhci_mtk_sch_init(mtk);
418 if (ret)
419 return ret;
420 }
421
422 return ret;
423}
424
425static int xhci_mtk_probe(struct platform_device *pdev)
426{
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;
433 struct usb_hcd *hcd;
434 int ret = -ENODEV;
435 int irq;
436
437 if (usb_disabled())
438 return -ENODEV;
439
440 driver = &xhci_mtk_hc_driver;
441 mtk = devm_kzalloc(dev, sizeof(*mtk), GFP_KERNEL);
442 if (!mtk)
443 return -ENOMEM;
444
445 mtk->dev = dev;
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);
450 }
451
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);
456 }
457
458 ret = xhci_mtk_clks_get(mtk);
459 if (ret)
460 return ret;
461
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",
465 &mtk->u3p_dis_msk);
466
467 ret = usb_wakeup_of_property_parse(mtk, node);
468 if (ret) {
469 dev_err(dev, "failed to parse uwk property\n");
470 return ret;
471 }
472
473 pm_runtime_enable(dev);
474 pm_runtime_get_sync(dev);
475 device_enable_async_suspend(dev);
476
477 ret = xhci_mtk_ldos_enable(mtk);
478 if (ret)
479 goto disable_pm;
480
481 ret = xhci_mtk_clks_enable(mtk);
482 if (ret)
483 goto disable_ldos;
484
485 irq = platform_get_irq(pdev, 0);
486 if (irq < 0) {
487 ret = irq;
488 goto disable_clk;
489 }
490
491 hcd = usb_create_hcd(driver, dev, dev_name(dev));
492 if (!hcd) {
493 ret = -ENOMEM;
494 goto disable_clk;
495 }
496
497 /*
498 * USB 2.0 roothub is stored in the platform_device.
499 * Swap it with mtk HCD.
500 */
501 mtk->hcd = platform_get_drvdata(pdev);
502 platform_set_drvdata(pdev, mtk);
503
504 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "mac");
505 hcd->regs = devm_ioremap_resource(dev, res);
506 if (IS_ERR(hcd->regs)) {
507 ret = PTR_ERR(hcd->regs);
508 goto put_usb2_hcd;
509 }
510 hcd->rsrc_start = res->start;
511 hcd->rsrc_len = resource_size(res);
512
513 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "ippc");
514 if (res) { /* ippc register is optional */
515 mtk->ippc_regs = devm_ioremap_resource(dev, res);
516 if (IS_ERR(mtk->ippc_regs)) {
517 ret = PTR_ERR(mtk->ippc_regs);
518 goto put_usb2_hcd;
519 }
520 mtk->has_ippc = true;
521 } else {
522 mtk->has_ippc = false;
523 }
524
525 device_init_wakeup(dev, true);
526
527 xhci = hcd_to_xhci(hcd);
528 xhci->main_hcd = hcd;
529
530 /*
531 * imod_interval is the interrupt moderation value in nanoseconds.
532 * The increment interval is 8 times as much as that defined in
533 * the xHCI spec on MTK's controller.
534 */
535 xhci->imod_interval = 5000;
536 device_property_read_u32(dev, "imod-interval-ns", &xhci->imod_interval);
537
538 xhci->shared_hcd = usb_create_shared_hcd(driver, dev,
539 dev_name(dev), hcd);
540 if (!xhci->shared_hcd) {
541 ret = -ENOMEM;
542 goto disable_device_wakeup;
543 }
544
545 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
546 if (ret)
547 goto put_usb3_hcd;
548
549 if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
550 xhci->shared_hcd->can_do_streams = 1;
551
552 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
553 if (ret)
554 goto dealloc_usb2_hcd;
555
556 return 0;
557
558dealloc_usb2_hcd:
559 usb_remove_hcd(hcd);
560
561put_usb3_hcd:
562 xhci_mtk_sch_exit(mtk);
563 usb_put_hcd(xhci->shared_hcd);
564
565disable_device_wakeup:
566 device_init_wakeup(dev, false);
567
568put_usb2_hcd:
569 usb_put_hcd(hcd);
570
571disable_clk:
572 xhci_mtk_clks_disable(mtk);
573
574disable_ldos:
575 xhci_mtk_ldos_disable(mtk);
576
577disable_pm:
578 pm_runtime_put_sync(dev);
579 pm_runtime_disable(dev);
580 return ret;
581}
582
583static int xhci_mtk_remove(struct platform_device *dev)
584{
585 struct xhci_hcd_mtk *mtk = platform_get_drvdata(dev);
586 struct usb_hcd *hcd = mtk->hcd;
587 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
588 struct usb_hcd *shared_hcd = xhci->shared_hcd;
589
590 pm_runtime_put_noidle(&dev->dev);
591 pm_runtime_disable(&dev->dev);
592
593 usb_remove_hcd(shared_hcd);
594 xhci->shared_hcd = NULL;
595 device_init_wakeup(&dev->dev, false);
596
597 usb_remove_hcd(hcd);
598 usb_put_hcd(shared_hcd);
599 usb_put_hcd(hcd);
600 xhci_mtk_sch_exit(mtk);
601 xhci_mtk_clks_disable(mtk);
602 xhci_mtk_ldos_disable(mtk);
603
604 return 0;
605}
606
607/*
608 * if ip sleep fails, and all clocks are disabled, access register will hang
609 * AHB bus, so stop polling roothubs to avoid regs access on bus suspend.
610 * and no need to check whether ip sleep failed or not; this will cause SPM
611 * to wake up system immediately after system suspend complete if ip sleep
612 * fails, it is what we wanted.
613 */
614static int __maybe_unused xhci_mtk_suspend(struct device *dev)
615{
616 struct xhci_hcd_mtk *mtk = dev_get_drvdata(dev);
617 struct usb_hcd *hcd = mtk->hcd;
618 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
619
620 xhci_dbg(xhci, "%s: stop port polling\n", __func__);
621 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
622 del_timer_sync(&hcd->rh_timer);
623 clear_bit(HCD_FLAG_POLL_RH, &xhci->shared_hcd->flags);
624 del_timer_sync(&xhci->shared_hcd->rh_timer);
625
626 xhci_mtk_host_disable(mtk);
627 xhci_mtk_clks_disable(mtk);
628 usb_wakeup_set(mtk, true);
629 return 0;
630}
631
632static int __maybe_unused xhci_mtk_resume(struct device *dev)
633{
634 struct xhci_hcd_mtk *mtk = dev_get_drvdata(dev);
635 struct usb_hcd *hcd = mtk->hcd;
636 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
637
638 usb_wakeup_set(mtk, false);
639 xhci_mtk_clks_enable(mtk);
640 xhci_mtk_host_enable(mtk);
641
642 xhci_dbg(xhci, "%s: restart port polling\n", __func__);
643 set_bit(HCD_FLAG_POLL_RH, &xhci->shared_hcd->flags);
644 usb_hcd_poll_rh_status(xhci->shared_hcd);
645 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
646 usb_hcd_poll_rh_status(hcd);
647 return 0;
648}
649
650static const struct dev_pm_ops xhci_mtk_pm_ops = {
651 SET_SYSTEM_SLEEP_PM_OPS(xhci_mtk_suspend, xhci_mtk_resume)
652};
653#define DEV_PM_OPS IS_ENABLED(CONFIG_PM) ? &xhci_mtk_pm_ops : NULL
654
655#ifdef CONFIG_OF
656static const struct of_device_id mtk_xhci_of_match[] = {
657 { .compatible = "mediatek,mt8173-xhci"},
658 { .compatible = "mediatek,mtk-xhci"},
659 { },
660};
661MODULE_DEVICE_TABLE(of, mtk_xhci_of_match);
662#endif
663
664static struct platform_driver mtk_xhci_driver = {
665 .probe = xhci_mtk_probe,
666 .remove = xhci_mtk_remove,
667 .driver = {
668 .name = "xhci-mtk",
669 .pm = DEV_PM_OPS,
670 .of_match_table = of_match_ptr(mtk_xhci_of_match),
671 },
672};
673MODULE_ALIAS("platform:xhci-mtk");
674
675static int __init xhci_mtk_init(void)
676{
677 xhci_init_driver(&xhci_mtk_hc_driver, &xhci_mtk_overrides);
678 return platform_driver_register(&mtk_xhci_driver);
679}
680module_init(xhci_mtk_init);
681
682static void __exit xhci_mtk_exit(void)
683{
684 platform_driver_unregister(&mtk_xhci_driver);
685}
686module_exit(xhci_mtk_exit);
687
688MODULE_AUTHOR("Chunfeng Yun <chunfeng.yun@mediatek.com>");
689MODULE_DESCRIPTION("MediaTek xHCI Host Controller Driver");
690MODULE_LICENSE("GPL v2");