Loading...
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/dma-mapping.h>
11#include <linux/iopoll.h>
12#include <linux/kernel.h>
13#include <linux/mfd/syscon.h>
14#include <linux/module.h>
15#include <linux/of.h>
16#include <linux/platform_device.h>
17#include <linux/pm_runtime.h>
18#include <linux/pm_wakeirq.h>
19#include <linux/regmap.h>
20#include <linux/regulator/consumer.h>
21#include <linux/reset.h>
22
23#include "xhci.h"
24#include "xhci-mtk.h"
25
26/* ip_pw_ctrl0 register */
27#define CTRL0_IP_SW_RST BIT(0)
28
29/* ip_pw_ctrl1 register */
30#define CTRL1_IP_HOST_PDN BIT(0)
31
32/* ip_pw_ctrl2 register */
33#define CTRL2_IP_DEV_PDN BIT(0)
34
35/* ip_pw_sts1 register */
36#define STS1_IP_SLEEP_STS BIT(30)
37#define STS1_U3_MAC_RST BIT(16)
38#define STS1_XHCI_RST BIT(11)
39#define STS1_SYS125_RST BIT(10)
40#define STS1_REF_RST BIT(8)
41#define STS1_SYSPLL_STABLE BIT(0)
42
43/* ip_xhci_cap register */
44#define CAP_U3_PORT_NUM(p) ((p) & 0xff)
45#define CAP_U2_PORT_NUM(p) (((p) >> 8) & 0xff)
46
47/* u3_ctrl_p register */
48#define CTRL_U3_PORT_HOST_SEL BIT(2)
49#define CTRL_U3_PORT_PDN BIT(1)
50#define CTRL_U3_PORT_DIS BIT(0)
51
52/* u2_ctrl_p register */
53#define CTRL_U2_PORT_HOST_SEL BIT(2)
54#define CTRL_U2_PORT_PDN BIT(1)
55#define CTRL_U2_PORT_DIS BIT(0)
56
57/* u2_phy_pll register */
58#define CTRL_U2_FORCE_PLL_STB BIT(28)
59
60/* xHCI CSR */
61#define LS_EOF_CFG 0x930
62#define LSEOF_OFFSET 0x89
63
64#define FS_EOF_CFG 0x934
65#define FSEOF_OFFSET 0x2e
66
67#define SS_GEN1_EOF_CFG 0x93c
68#define SSG1EOF_OFFSET 0x78
69
70#define HFCNTR_CFG 0x944
71#define ITP_DELTA_CLK (0xa << 1)
72#define ITP_DELTA_CLK_MASK GENMASK(5, 1)
73#define FRMCNT_LEV1_RANG (0x12b << 8)
74#define FRMCNT_LEV1_RANG_MASK GENMASK(19, 8)
75
76#define SS_GEN2_EOF_CFG 0x990
77#define SSG2EOF_OFFSET 0x3c
78
79#define XSEOF_OFFSET_MASK GENMASK(11, 0)
80
81/* usb remote wakeup registers in syscon */
82
83/* mt8173 etc */
84#define PERI_WK_CTRL1 0x4
85#define WC1_IS_C(x) (((x) & 0xf) << 26) /* cycle debounce */
86#define WC1_IS_EN BIT(25)
87#define WC1_IS_P BIT(6) /* polarity for ip sleep */
88
89/* mt8183 */
90#define PERI_WK_CTRL0 0x0
91#define WC0_IS_C(x) ((u32)(((x) & 0xf) << 28)) /* cycle debounce */
92#define WC0_IS_P BIT(12) /* polarity */
93#define WC0_IS_EN BIT(6)
94
95/* mt8192 */
96#define WC0_SSUSB0_CDEN BIT(6)
97#define WC0_IS_SPM_EN BIT(1)
98
99/* mt8195 */
100#define PERI_WK_CTRL0_8195 0x04
101#define WC0_IS_P_95 BIT(30) /* polarity */
102#define WC0_IS_C_95(x) ((u32)(((x) & 0x7) << 27))
103#define WC0_IS_EN_P3_95 BIT(26)
104#define WC0_IS_EN_P2_95 BIT(25)
105#define WC0_IS_EN_P1_95 BIT(24)
106
107#define PERI_WK_CTRL1_8195 0x20
108#define WC1_IS_C_95(x) ((u32)(((x) & 0xf) << 28))
109#define WC1_IS_P_95 BIT(12)
110#define WC1_IS_EN_P0_95 BIT(6)
111
112/* mt2712 etc */
113#define PERI_SSUSB_SPM_CTRL 0x0
114#define SSC_IP_SLEEP_EN BIT(4)
115#define SSC_SPM_INT_EN BIT(1)
116
117enum ssusb_uwk_vers {
118 SSUSB_UWK_V1 = 1,
119 SSUSB_UWK_V2,
120 SSUSB_UWK_V1_1 = 101, /* specific revision 1.01 */
121 SSUSB_UWK_V1_2, /* specific revision 1.2 */
122 SSUSB_UWK_V1_3, /* mt8195 IP0 */
123 SSUSB_UWK_V1_4, /* mt8195 IP1 */
124 SSUSB_UWK_V1_5, /* mt8195 IP2 */
125 SSUSB_UWK_V1_6, /* mt8195 IP3 */
126};
127
128/*
129 * MT8195 has 4 controllers, the controller1~3's default SOF/ITP interval
130 * is calculated from the frame counter clock 24M, but in fact, the clock
131 * is 48M, add workaround for it.
132 */
133static void xhci_mtk_set_frame_interval(struct xhci_hcd_mtk *mtk)
134{
135 struct device *dev = mtk->dev;
136 struct usb_hcd *hcd = mtk->hcd;
137 u32 value;
138
139 if (!of_device_is_compatible(dev->of_node, "mediatek,mt8195-xhci"))
140 return;
141
142 value = readl(hcd->regs + HFCNTR_CFG);
143 value &= ~(ITP_DELTA_CLK_MASK | FRMCNT_LEV1_RANG_MASK);
144 value |= (ITP_DELTA_CLK | FRMCNT_LEV1_RANG);
145 writel(value, hcd->regs + HFCNTR_CFG);
146
147 value = readl(hcd->regs + LS_EOF_CFG);
148 value &= ~XSEOF_OFFSET_MASK;
149 value |= LSEOF_OFFSET;
150 writel(value, hcd->regs + LS_EOF_CFG);
151
152 value = readl(hcd->regs + FS_EOF_CFG);
153 value &= ~XSEOF_OFFSET_MASK;
154 value |= FSEOF_OFFSET;
155 writel(value, hcd->regs + FS_EOF_CFG);
156
157 value = readl(hcd->regs + SS_GEN1_EOF_CFG);
158 value &= ~XSEOF_OFFSET_MASK;
159 value |= SSG1EOF_OFFSET;
160 writel(value, hcd->regs + SS_GEN1_EOF_CFG);
161
162 value = readl(hcd->regs + SS_GEN2_EOF_CFG);
163 value &= ~XSEOF_OFFSET_MASK;
164 value |= SSG2EOF_OFFSET;
165 writel(value, hcd->regs + SS_GEN2_EOF_CFG);
166}
167
168static int xhci_mtk_host_enable(struct xhci_hcd_mtk *mtk)
169{
170 struct mu3c_ippc_regs __iomem *ippc = mtk->ippc_regs;
171 u32 value, check_val;
172 int u3_ports_disabled = 0;
173 int ret;
174 int i;
175
176 if (!mtk->has_ippc)
177 return 0;
178
179 /* power on host ip */
180 value = readl(&ippc->ip_pw_ctr1);
181 value &= ~CTRL1_IP_HOST_PDN;
182 writel(value, &ippc->ip_pw_ctr1);
183
184 /* power on and enable u3 ports except skipped ones */
185 for (i = 0; i < mtk->num_u3_ports; i++) {
186 if ((0x1 << i) & mtk->u3p_dis_msk) {
187 u3_ports_disabled++;
188 continue;
189 }
190
191 value = readl(&ippc->u3_ctrl_p[i]);
192 value &= ~(CTRL_U3_PORT_PDN | CTRL_U3_PORT_DIS);
193 value |= CTRL_U3_PORT_HOST_SEL;
194 writel(value, &ippc->u3_ctrl_p[i]);
195 }
196
197 /* power on and enable all u2 ports except skipped ones */
198 for (i = 0; i < mtk->num_u2_ports; i++) {
199 if (BIT(i) & mtk->u2p_dis_msk)
200 continue;
201
202 value = readl(&ippc->u2_ctrl_p[i]);
203 value &= ~(CTRL_U2_PORT_PDN | CTRL_U2_PORT_DIS);
204 value |= CTRL_U2_PORT_HOST_SEL;
205 writel(value, &ippc->u2_ctrl_p[i]);
206 }
207
208 /*
209 * wait for clocks to be stable, and clock domains reset to
210 * be inactive after power on and enable ports
211 */
212 check_val = STS1_SYSPLL_STABLE | STS1_REF_RST |
213 STS1_SYS125_RST | STS1_XHCI_RST;
214
215 if (mtk->num_u3_ports > u3_ports_disabled)
216 check_val |= STS1_U3_MAC_RST;
217
218 ret = readl_poll_timeout(&ippc->ip_pw_sts1, value,
219 (check_val == (value & check_val)), 100, 20000);
220 if (ret) {
221 dev_err(mtk->dev, "clocks are not stable (0x%x)\n", value);
222 return ret;
223 }
224
225 return 0;
226}
227
228static int xhci_mtk_host_disable(struct xhci_hcd_mtk *mtk)
229{
230 struct mu3c_ippc_regs __iomem *ippc = mtk->ippc_regs;
231 u32 value;
232 int ret;
233 int i;
234
235 if (!mtk->has_ippc)
236 return 0;
237
238 /* power down u3 ports except skipped ones */
239 for (i = 0; i < mtk->num_u3_ports; i++) {
240 if ((0x1 << i) & mtk->u3p_dis_msk)
241 continue;
242
243 value = readl(&ippc->u3_ctrl_p[i]);
244 value |= CTRL_U3_PORT_PDN;
245 writel(value, &ippc->u3_ctrl_p[i]);
246 }
247
248 /* power down all u2 ports except skipped ones */
249 for (i = 0; i < mtk->num_u2_ports; i++) {
250 if (BIT(i) & mtk->u2p_dis_msk)
251 continue;
252
253 value = readl(&ippc->u2_ctrl_p[i]);
254 value |= CTRL_U2_PORT_PDN;
255 writel(value, &ippc->u2_ctrl_p[i]);
256 }
257
258 /* power down host ip */
259 value = readl(&ippc->ip_pw_ctr1);
260 value |= CTRL1_IP_HOST_PDN;
261 writel(value, &ippc->ip_pw_ctr1);
262
263 /* wait for host ip to sleep */
264 ret = readl_poll_timeout(&ippc->ip_pw_sts1, value,
265 (value & STS1_IP_SLEEP_STS), 100, 100000);
266 if (ret)
267 dev_err(mtk->dev, "ip sleep failed!!!\n");
268 else /* workaound for platforms using low level latch */
269 usleep_range(100, 200);
270
271 return ret;
272}
273
274static int xhci_mtk_ssusb_config(struct xhci_hcd_mtk *mtk)
275{
276 struct mu3c_ippc_regs __iomem *ippc = mtk->ippc_regs;
277 u32 value;
278
279 if (!mtk->has_ippc)
280 return 0;
281
282 /* reset whole ip */
283 value = readl(&ippc->ip_pw_ctr0);
284 value |= CTRL0_IP_SW_RST;
285 writel(value, &ippc->ip_pw_ctr0);
286 udelay(1);
287 value = readl(&ippc->ip_pw_ctr0);
288 value &= ~CTRL0_IP_SW_RST;
289 writel(value, &ippc->ip_pw_ctr0);
290
291 /*
292 * device ip is default power-on in fact
293 * power down device ip, otherwise ip-sleep will fail
294 */
295 value = readl(&ippc->ip_pw_ctr2);
296 value |= CTRL2_IP_DEV_PDN;
297 writel(value, &ippc->ip_pw_ctr2);
298
299 value = readl(&ippc->ip_xhci_cap);
300 mtk->num_u3_ports = CAP_U3_PORT_NUM(value);
301 mtk->num_u2_ports = CAP_U2_PORT_NUM(value);
302 dev_dbg(mtk->dev, "%s u2p:%d, u3p:%d\n", __func__,
303 mtk->num_u2_ports, mtk->num_u3_ports);
304
305 return xhci_mtk_host_enable(mtk);
306}
307
308/* only clocks can be turn off for ip-sleep wakeup mode */
309static void usb_wakeup_ip_sleep_set(struct xhci_hcd_mtk *mtk, bool enable)
310{
311 u32 reg, msk, val;
312
313 switch (mtk->uwk_vers) {
314 case SSUSB_UWK_V1:
315 reg = mtk->uwk_reg_base + PERI_WK_CTRL1;
316 msk = WC1_IS_EN | WC1_IS_C(0xf) | WC1_IS_P;
317 val = enable ? (WC1_IS_EN | WC1_IS_C(0x8)) : 0;
318 break;
319 case SSUSB_UWK_V1_1:
320 reg = mtk->uwk_reg_base + PERI_WK_CTRL0;
321 msk = WC0_IS_EN | WC0_IS_C(0xf) | WC0_IS_P;
322 val = enable ? (WC0_IS_EN | WC0_IS_C(0x1)) : 0;
323 break;
324 case SSUSB_UWK_V1_2:
325 reg = mtk->uwk_reg_base + PERI_WK_CTRL0;
326 msk = WC0_SSUSB0_CDEN | WC0_IS_SPM_EN;
327 val = enable ? msk : 0;
328 break;
329 case SSUSB_UWK_V1_3:
330 reg = mtk->uwk_reg_base + PERI_WK_CTRL1_8195;
331 msk = WC1_IS_EN_P0_95 | WC1_IS_C_95(0xf) | WC1_IS_P_95;
332 val = enable ? (WC1_IS_EN_P0_95 | WC1_IS_C_95(0x1)) : 0;
333 break;
334 case SSUSB_UWK_V1_4:
335 reg = mtk->uwk_reg_base + PERI_WK_CTRL0_8195;
336 msk = WC0_IS_EN_P1_95 | WC0_IS_C_95(0x7) | WC0_IS_P_95;
337 val = enable ? (WC0_IS_EN_P1_95 | WC0_IS_C_95(0x1)) : 0;
338 break;
339 case SSUSB_UWK_V1_5:
340 reg = mtk->uwk_reg_base + PERI_WK_CTRL0_8195;
341 msk = WC0_IS_EN_P2_95 | WC0_IS_C_95(0x7) | WC0_IS_P_95;
342 val = enable ? (WC0_IS_EN_P2_95 | WC0_IS_C_95(0x1)) : 0;
343 break;
344 case SSUSB_UWK_V1_6:
345 reg = mtk->uwk_reg_base + PERI_WK_CTRL0_8195;
346 msk = WC0_IS_EN_P3_95 | WC0_IS_C_95(0x7) | WC0_IS_P_95;
347 val = enable ? (WC0_IS_EN_P3_95 | WC0_IS_C_95(0x1)) : 0;
348 break;
349 case SSUSB_UWK_V2:
350 reg = mtk->uwk_reg_base + PERI_SSUSB_SPM_CTRL;
351 msk = SSC_IP_SLEEP_EN | SSC_SPM_INT_EN;
352 val = enable ? msk : 0;
353 break;
354 default:
355 return;
356 }
357 regmap_update_bits(mtk->uwk, reg, msk, val);
358}
359
360static int usb_wakeup_of_property_parse(struct xhci_hcd_mtk *mtk,
361 struct device_node *dn)
362{
363 struct of_phandle_args args;
364 int ret;
365
366 /* Wakeup function is optional */
367 mtk->uwk_en = of_property_read_bool(dn, "wakeup-source");
368 if (!mtk->uwk_en)
369 return 0;
370
371 ret = of_parse_phandle_with_fixed_args(dn,
372 "mediatek,syscon-wakeup", 2, 0, &args);
373 if (ret)
374 return ret;
375
376 mtk->uwk_reg_base = args.args[0];
377 mtk->uwk_vers = args.args[1];
378 mtk->uwk = syscon_node_to_regmap(args.np);
379 of_node_put(args.np);
380 dev_info(mtk->dev, "uwk - reg:0x%x, version:%d\n",
381 mtk->uwk_reg_base, mtk->uwk_vers);
382
383 return PTR_ERR_OR_ZERO(mtk->uwk);
384}
385
386static void usb_wakeup_set(struct xhci_hcd_mtk *mtk, bool enable)
387{
388 if (mtk->uwk_en)
389 usb_wakeup_ip_sleep_set(mtk, enable);
390}
391
392static int xhci_mtk_clks_get(struct xhci_hcd_mtk *mtk)
393{
394 struct clk_bulk_data *clks = mtk->clks;
395
396 clks[0].id = "sys_ck";
397 clks[1].id = "xhci_ck";
398 clks[2].id = "ref_ck";
399 clks[3].id = "mcu_ck";
400 clks[4].id = "dma_ck";
401
402 return devm_clk_bulk_get_optional(mtk->dev, BULK_CLKS_NUM, clks);
403}
404
405static int xhci_mtk_vregs_get(struct xhci_hcd_mtk *mtk)
406{
407 struct regulator_bulk_data *supplies = mtk->supplies;
408
409 supplies[0].supply = "vbus";
410 supplies[1].supply = "vusb33";
411
412 return devm_regulator_bulk_get(mtk->dev, BULK_VREGS_NUM, supplies);
413}
414
415static void xhci_mtk_quirks(struct device *dev, struct xhci_hcd *xhci)
416{
417 struct usb_hcd *hcd = xhci_to_hcd(xhci);
418 struct xhci_hcd_mtk *mtk = hcd_to_mtk(hcd);
419
420 /*
421 * As of now platform drivers don't provide MSI support so we ensure
422 * here that the generic code does not try to make a pci_dev from our
423 * dev struct in order to setup MSI
424 */
425 xhci->quirks |= XHCI_PLAT;
426 xhci->quirks |= XHCI_MTK_HOST;
427 /*
428 * MTK host controller gives a spurious successful event after a
429 * short transfer. Ignore it.
430 */
431 xhci->quirks |= XHCI_SPURIOUS_SUCCESS;
432 if (mtk->lpm_support)
433 xhci->quirks |= XHCI_LPM_SUPPORT;
434 if (mtk->u2_lpm_disable)
435 xhci->quirks |= XHCI_HW_LPM_DISABLE;
436
437 /*
438 * MTK xHCI 0.96: PSA is 1 by default even if doesn't support stream,
439 * and it's 3 when support it.
440 */
441 if (xhci->hci_version < 0x100 && HCC_MAX_PSA(xhci->hcc_params) == 4)
442 xhci->quirks |= XHCI_BROKEN_STREAMS;
443}
444
445/* called during probe() after chip reset completes */
446static int xhci_mtk_setup(struct usb_hcd *hcd)
447{
448 struct xhci_hcd_mtk *mtk = hcd_to_mtk(hcd);
449 int ret;
450
451 if (usb_hcd_is_primary_hcd(hcd)) {
452 ret = xhci_mtk_ssusb_config(mtk);
453 if (ret)
454 return ret;
455
456 /* workaround only for mt8195 */
457 xhci_mtk_set_frame_interval(mtk);
458 }
459
460 ret = xhci_gen_setup(hcd, xhci_mtk_quirks);
461 if (ret)
462 return ret;
463
464 if (usb_hcd_is_primary_hcd(hcd))
465 ret = xhci_mtk_sch_init(mtk);
466
467 return ret;
468}
469
470static const struct xhci_driver_overrides xhci_mtk_overrides __initconst = {
471 .reset = xhci_mtk_setup,
472 .add_endpoint = xhci_mtk_add_ep,
473 .drop_endpoint = xhci_mtk_drop_ep,
474 .check_bandwidth = xhci_mtk_check_bandwidth,
475 .reset_bandwidth = xhci_mtk_reset_bandwidth,
476};
477
478static struct hc_driver __read_mostly xhci_mtk_hc_driver;
479
480static int xhci_mtk_probe(struct platform_device *pdev)
481{
482 struct device *dev = &pdev->dev;
483 struct device_node *node = dev->of_node;
484 struct xhci_hcd_mtk *mtk;
485 const struct hc_driver *driver;
486 struct xhci_hcd *xhci;
487 struct resource *res;
488 struct usb_hcd *usb3_hcd;
489 struct usb_hcd *hcd;
490 int ret = -ENODEV;
491 int wakeup_irq;
492 int irq;
493
494 if (usb_disabled())
495 return -ENODEV;
496
497 driver = &xhci_mtk_hc_driver;
498 mtk = devm_kzalloc(dev, sizeof(*mtk), GFP_KERNEL);
499 if (!mtk)
500 return -ENOMEM;
501
502 mtk->dev = dev;
503
504 ret = xhci_mtk_vregs_get(mtk);
505 if (ret)
506 return dev_err_probe(dev, ret, "Failed to get regulators\n");
507
508 ret = xhci_mtk_clks_get(mtk);
509 if (ret)
510 return ret;
511
512 irq = platform_get_irq_byname_optional(pdev, "host");
513 if (irq < 0) {
514 if (irq == -EPROBE_DEFER)
515 return irq;
516
517 /* for backward compatibility */
518 irq = platform_get_irq(pdev, 0);
519 if (irq < 0)
520 return irq;
521 }
522
523 wakeup_irq = platform_get_irq_byname_optional(pdev, "wakeup");
524 if (wakeup_irq == -EPROBE_DEFER)
525 return wakeup_irq;
526
527 mtk->lpm_support = of_property_read_bool(node, "usb3-lpm-capable");
528 mtk->u2_lpm_disable = of_property_read_bool(node, "usb2-lpm-disable");
529 /* optional property, ignore the error if it does not exist */
530 of_property_read_u32(node, "mediatek,u3p-dis-msk",
531 &mtk->u3p_dis_msk);
532 of_property_read_u32(node, "mediatek,u2p-dis-msk",
533 &mtk->u2p_dis_msk);
534
535 ret = usb_wakeup_of_property_parse(mtk, node);
536 if (ret) {
537 dev_err(dev, "failed to parse uwk property\n");
538 return ret;
539 }
540
541 pm_runtime_set_active(dev);
542 pm_runtime_use_autosuspend(dev);
543 pm_runtime_set_autosuspend_delay(dev, 4000);
544 pm_runtime_enable(dev);
545 pm_runtime_get_sync(dev);
546
547 ret = regulator_bulk_enable(BULK_VREGS_NUM, mtk->supplies);
548 if (ret)
549 goto disable_pm;
550
551 ret = clk_bulk_prepare_enable(BULK_CLKS_NUM, mtk->clks);
552 if (ret)
553 goto disable_ldos;
554
555 ret = device_reset_optional(dev);
556 if (ret) {
557 dev_err_probe(dev, ret, "failed to reset controller\n");
558 goto disable_clk;
559 }
560
561 hcd = usb_create_hcd(driver, dev, dev_name(dev));
562 if (!hcd) {
563 ret = -ENOMEM;
564 goto disable_clk;
565 }
566
567 /*
568 * USB 2.0 roothub is stored in the platform_device.
569 * Swap it with mtk HCD.
570 */
571 mtk->hcd = platform_get_drvdata(pdev);
572 platform_set_drvdata(pdev, mtk);
573
574 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "mac");
575 hcd->regs = devm_ioremap_resource(dev, res);
576 if (IS_ERR(hcd->regs)) {
577 ret = PTR_ERR(hcd->regs);
578 goto put_usb2_hcd;
579 }
580 hcd->rsrc_start = res->start;
581 hcd->rsrc_len = resource_size(res);
582
583 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "ippc");
584 if (res) { /* ippc register is optional */
585 mtk->ippc_regs = devm_ioremap_resource(dev, res);
586 if (IS_ERR(mtk->ippc_regs)) {
587 ret = PTR_ERR(mtk->ippc_regs);
588 goto put_usb2_hcd;
589 }
590 mtk->has_ippc = true;
591 }
592
593 device_init_wakeup(dev, true);
594
595 xhci = hcd_to_xhci(hcd);
596 xhci->main_hcd = hcd;
597 xhci->allow_single_roothub = 1;
598
599 /*
600 * imod_interval is the interrupt moderation value in nanoseconds.
601 * The increment interval is 8 times as much as that defined in
602 * the xHCI spec on MTK's controller.
603 */
604 xhci->imod_interval = 5000;
605 device_property_read_u32(dev, "imod-interval-ns", &xhci->imod_interval);
606
607 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
608 if (ret)
609 goto disable_device_wakeup;
610
611 if (!xhci_has_one_roothub(xhci)) {
612 xhci->shared_hcd = usb_create_shared_hcd(driver, dev,
613 dev_name(dev), hcd);
614 if (!xhci->shared_hcd) {
615 ret = -ENOMEM;
616 goto dealloc_usb2_hcd;
617 }
618 }
619
620 usb3_hcd = xhci_get_usb3_hcd(xhci);
621 if (usb3_hcd && HCC_MAX_PSA(xhci->hcc_params) >= 4 &&
622 !(xhci->quirks & XHCI_BROKEN_STREAMS))
623 usb3_hcd->can_do_streams = 1;
624
625 if (xhci->shared_hcd) {
626 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
627 if (ret)
628 goto put_usb3_hcd;
629 }
630
631 if (wakeup_irq > 0) {
632 ret = dev_pm_set_dedicated_wake_irq_reverse(dev, wakeup_irq);
633 if (ret) {
634 dev_err(dev, "set wakeup irq %d failed\n", wakeup_irq);
635 goto dealloc_usb3_hcd;
636 }
637 dev_info(dev, "wakeup irq %d\n", wakeup_irq);
638 }
639
640 device_enable_async_suspend(dev);
641 pm_runtime_mark_last_busy(dev);
642 pm_runtime_put_autosuspend(dev);
643 pm_runtime_forbid(dev);
644
645 return 0;
646
647dealloc_usb3_hcd:
648 usb_remove_hcd(xhci->shared_hcd);
649
650put_usb3_hcd:
651 usb_put_hcd(xhci->shared_hcd);
652
653dealloc_usb2_hcd:
654 xhci_mtk_sch_exit(mtk);
655 usb_remove_hcd(hcd);
656
657disable_device_wakeup:
658 device_init_wakeup(dev, false);
659
660put_usb2_hcd:
661 usb_put_hcd(hcd);
662
663disable_clk:
664 clk_bulk_disable_unprepare(BULK_CLKS_NUM, mtk->clks);
665
666disable_ldos:
667 regulator_bulk_disable(BULK_VREGS_NUM, mtk->supplies);
668
669disable_pm:
670 pm_runtime_put_noidle(dev);
671 pm_runtime_disable(dev);
672 return ret;
673}
674
675static int xhci_mtk_remove(struct platform_device *pdev)
676{
677 struct xhci_hcd_mtk *mtk = platform_get_drvdata(pdev);
678 struct usb_hcd *hcd = mtk->hcd;
679 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
680 struct usb_hcd *shared_hcd = xhci->shared_hcd;
681 struct device *dev = &pdev->dev;
682
683 pm_runtime_get_sync(dev);
684 xhci->xhc_state |= XHCI_STATE_REMOVING;
685 dev_pm_clear_wake_irq(dev);
686 device_init_wakeup(dev, false);
687
688 if (shared_hcd) {
689 usb_remove_hcd(shared_hcd);
690 xhci->shared_hcd = NULL;
691 }
692 usb_remove_hcd(hcd);
693
694 if (shared_hcd)
695 usb_put_hcd(shared_hcd);
696
697 usb_put_hcd(hcd);
698 xhci_mtk_sch_exit(mtk);
699 clk_bulk_disable_unprepare(BULK_CLKS_NUM, mtk->clks);
700 regulator_bulk_disable(BULK_VREGS_NUM, mtk->supplies);
701
702 pm_runtime_disable(dev);
703 pm_runtime_put_noidle(dev);
704 pm_runtime_set_suspended(dev);
705
706 return 0;
707}
708
709static int __maybe_unused xhci_mtk_suspend(struct device *dev)
710{
711 struct xhci_hcd_mtk *mtk = dev_get_drvdata(dev);
712 struct usb_hcd *hcd = mtk->hcd;
713 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
714 struct usb_hcd *shared_hcd = xhci->shared_hcd;
715 int ret;
716
717 xhci_dbg(xhci, "%s: stop port polling\n", __func__);
718 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
719 del_timer_sync(&hcd->rh_timer);
720 if (shared_hcd) {
721 clear_bit(HCD_FLAG_POLL_RH, &shared_hcd->flags);
722 del_timer_sync(&shared_hcd->rh_timer);
723 }
724
725 ret = xhci_mtk_host_disable(mtk);
726 if (ret)
727 goto restart_poll_rh;
728
729 clk_bulk_disable_unprepare(BULK_CLKS_NUM, mtk->clks);
730 usb_wakeup_set(mtk, true);
731 return 0;
732
733restart_poll_rh:
734 xhci_dbg(xhci, "%s: restart port polling\n", __func__);
735 if (shared_hcd) {
736 set_bit(HCD_FLAG_POLL_RH, &shared_hcd->flags);
737 usb_hcd_poll_rh_status(shared_hcd);
738 }
739 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
740 usb_hcd_poll_rh_status(hcd);
741 return ret;
742}
743
744static int __maybe_unused xhci_mtk_resume(struct device *dev)
745{
746 struct xhci_hcd_mtk *mtk = dev_get_drvdata(dev);
747 struct usb_hcd *hcd = mtk->hcd;
748 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
749 struct usb_hcd *shared_hcd = xhci->shared_hcd;
750 int ret;
751
752 usb_wakeup_set(mtk, false);
753 ret = clk_bulk_prepare_enable(BULK_CLKS_NUM, mtk->clks);
754 if (ret)
755 goto enable_wakeup;
756
757 ret = xhci_mtk_host_enable(mtk);
758 if (ret)
759 goto disable_clks;
760
761 xhci_dbg(xhci, "%s: restart port polling\n", __func__);
762 if (shared_hcd) {
763 set_bit(HCD_FLAG_POLL_RH, &shared_hcd->flags);
764 usb_hcd_poll_rh_status(shared_hcd);
765 }
766 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
767 usb_hcd_poll_rh_status(hcd);
768 return 0;
769
770disable_clks:
771 clk_bulk_disable_unprepare(BULK_CLKS_NUM, mtk->clks);
772enable_wakeup:
773 usb_wakeup_set(mtk, true);
774 return ret;
775}
776
777static int __maybe_unused xhci_mtk_runtime_suspend(struct device *dev)
778{
779 struct xhci_hcd_mtk *mtk = dev_get_drvdata(dev);
780 struct xhci_hcd *xhci = hcd_to_xhci(mtk->hcd);
781 int ret = 0;
782
783 if (xhci->xhc_state)
784 return -ESHUTDOWN;
785
786 if (device_may_wakeup(dev))
787 ret = xhci_mtk_suspend(dev);
788
789 /* -EBUSY: let PM automatically reschedule another autosuspend */
790 return ret ? -EBUSY : 0;
791}
792
793static int __maybe_unused xhci_mtk_runtime_resume(struct device *dev)
794{
795 struct xhci_hcd_mtk *mtk = dev_get_drvdata(dev);
796 struct xhci_hcd *xhci = hcd_to_xhci(mtk->hcd);
797 int ret = 0;
798
799 if (xhci->xhc_state)
800 return -ESHUTDOWN;
801
802 if (device_may_wakeup(dev))
803 ret = xhci_mtk_resume(dev);
804
805 return ret;
806}
807
808static const struct dev_pm_ops xhci_mtk_pm_ops = {
809 SET_SYSTEM_SLEEP_PM_OPS(xhci_mtk_suspend, xhci_mtk_resume)
810 SET_RUNTIME_PM_OPS(xhci_mtk_runtime_suspend,
811 xhci_mtk_runtime_resume, NULL)
812};
813
814#define DEV_PM_OPS (IS_ENABLED(CONFIG_PM) ? &xhci_mtk_pm_ops : NULL)
815
816static const struct of_device_id mtk_xhci_of_match[] = {
817 { .compatible = "mediatek,mt8173-xhci"},
818 { .compatible = "mediatek,mt8195-xhci"},
819 { .compatible = "mediatek,mtk-xhci"},
820 { },
821};
822MODULE_DEVICE_TABLE(of, mtk_xhci_of_match);
823
824static struct platform_driver mtk_xhci_driver = {
825 .probe = xhci_mtk_probe,
826 .remove = xhci_mtk_remove,
827 .driver = {
828 .name = "xhci-mtk",
829 .pm = DEV_PM_OPS,
830 .of_match_table = mtk_xhci_of_match,
831 },
832};
833
834static int __init xhci_mtk_init(void)
835{
836 xhci_init_driver(&xhci_mtk_hc_driver, &xhci_mtk_overrides);
837 return platform_driver_register(&mtk_xhci_driver);
838}
839module_init(xhci_mtk_init);
840
841static void __exit xhci_mtk_exit(void)
842{
843 platform_driver_unregister(&mtk_xhci_driver);
844}
845module_exit(xhci_mtk_exit);
846
847MODULE_AUTHOR("Chunfeng Yun <chunfeng.yun@mediatek.com>");
848MODULE_DESCRIPTION("MediaTek xHCI Host Controller Driver");
849MODULE_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 /* Initialize dma_mask and coherent_dma_mask to 32-bits */
492 ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
493 if (ret)
494 goto disable_clk;
495
496 hcd = usb_create_hcd(driver, dev, dev_name(dev));
497 if (!hcd) {
498 ret = -ENOMEM;
499 goto disable_clk;
500 }
501
502 /*
503 * USB 2.0 roothub is stored in the platform_device.
504 * Swap it with mtk HCD.
505 */
506 mtk->hcd = platform_get_drvdata(pdev);
507 platform_set_drvdata(pdev, mtk);
508
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);
513 goto put_usb2_hcd;
514 }
515 hcd->rsrc_start = res->start;
516 hcd->rsrc_len = resource_size(res);
517
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);
523 goto put_usb2_hcd;
524 }
525 mtk->has_ippc = true;
526 } else {
527 mtk->has_ippc = false;
528 }
529
530 device_init_wakeup(dev, true);
531
532 xhci = hcd_to_xhci(hcd);
533 xhci->main_hcd = hcd;
534
535 /*
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.
539 */
540 xhci->imod_interval = 5000;
541 device_property_read_u32(dev, "imod-interval-ns", &xhci->imod_interval);
542
543 xhci->shared_hcd = usb_create_shared_hcd(driver, dev,
544 dev_name(dev), hcd);
545 if (!xhci->shared_hcd) {
546 ret = -ENOMEM;
547 goto disable_device_wakeup;
548 }
549
550 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
551 if (ret)
552 goto put_usb3_hcd;
553
554 if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
555 xhci->shared_hcd->can_do_streams = 1;
556
557 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
558 if (ret)
559 goto dealloc_usb2_hcd;
560
561 return 0;
562
563dealloc_usb2_hcd:
564 usb_remove_hcd(hcd);
565
566put_usb3_hcd:
567 xhci_mtk_sch_exit(mtk);
568 usb_put_hcd(xhci->shared_hcd);
569
570disable_device_wakeup:
571 device_init_wakeup(dev, false);
572
573put_usb2_hcd:
574 usb_put_hcd(hcd);
575
576disable_clk:
577 xhci_mtk_clks_disable(mtk);
578
579disable_ldos:
580 xhci_mtk_ldos_disable(mtk);
581
582disable_pm:
583 pm_runtime_put_sync(dev);
584 pm_runtime_disable(dev);
585 return ret;
586}
587
588static int xhci_mtk_remove(struct platform_device *dev)
589{
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);
593 struct usb_hcd *shared_hcd = xhci->shared_hcd;
594
595 usb_remove_hcd(shared_hcd);
596 xhci->shared_hcd = NULL;
597 device_init_wakeup(&dev->dev, false);
598
599 usb_remove_hcd(hcd);
600 usb_put_hcd(shared_hcd);
601 usb_put_hcd(hcd);
602 xhci_mtk_sch_exit(mtk);
603 xhci_mtk_clks_disable(mtk);
604 xhci_mtk_ldos_disable(mtk);
605 pm_runtime_put_sync(&dev->dev);
606 pm_runtime_disable(&dev->dev);
607
608 return 0;
609}
610
611/*
612 * if ip sleep fails, and all clocks are disabled, access register will hang
613 * AHB bus, so stop polling roothubs to avoid regs access on bus suspend.
614 * and no need to check whether ip sleep failed or not; this will cause SPM
615 * to wake up system immediately after system suspend complete if ip sleep
616 * fails, it is what we wanted.
617 */
618static int __maybe_unused xhci_mtk_suspend(struct device *dev)
619{
620 struct xhci_hcd_mtk *mtk = dev_get_drvdata(dev);
621 struct usb_hcd *hcd = mtk->hcd;
622 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
623
624 xhci_dbg(xhci, "%s: stop port polling\n", __func__);
625 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
626 del_timer_sync(&hcd->rh_timer);
627 clear_bit(HCD_FLAG_POLL_RH, &xhci->shared_hcd->flags);
628 del_timer_sync(&xhci->shared_hcd->rh_timer);
629
630 xhci_mtk_host_disable(mtk);
631 xhci_mtk_clks_disable(mtk);
632 usb_wakeup_set(mtk, true);
633 return 0;
634}
635
636static int __maybe_unused xhci_mtk_resume(struct device *dev)
637{
638 struct xhci_hcd_mtk *mtk = dev_get_drvdata(dev);
639 struct usb_hcd *hcd = mtk->hcd;
640 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
641
642 usb_wakeup_set(mtk, false);
643 xhci_mtk_clks_enable(mtk);
644 xhci_mtk_host_enable(mtk);
645
646 xhci_dbg(xhci, "%s: restart port polling\n", __func__);
647 set_bit(HCD_FLAG_POLL_RH, &xhci->shared_hcd->flags);
648 usb_hcd_poll_rh_status(xhci->shared_hcd);
649 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
650 usb_hcd_poll_rh_status(hcd);
651 return 0;
652}
653
654static const struct dev_pm_ops xhci_mtk_pm_ops = {
655 SET_SYSTEM_SLEEP_PM_OPS(xhci_mtk_suspend, xhci_mtk_resume)
656};
657#define DEV_PM_OPS IS_ENABLED(CONFIG_PM) ? &xhci_mtk_pm_ops : NULL
658
659#ifdef CONFIG_OF
660static const struct of_device_id mtk_xhci_of_match[] = {
661 { .compatible = "mediatek,mt8173-xhci"},
662 { .compatible = "mediatek,mtk-xhci"},
663 { },
664};
665MODULE_DEVICE_TABLE(of, mtk_xhci_of_match);
666#endif
667
668static struct platform_driver mtk_xhci_driver = {
669 .probe = xhci_mtk_probe,
670 .remove = xhci_mtk_remove,
671 .driver = {
672 .name = "xhci-mtk",
673 .pm = DEV_PM_OPS,
674 .of_match_table = of_match_ptr(mtk_xhci_of_match),
675 },
676};
677MODULE_ALIAS("platform:xhci-mtk");
678
679static int __init xhci_mtk_init(void)
680{
681 xhci_init_driver(&xhci_mtk_hc_driver, &xhci_mtk_overrides);
682 return platform_driver_register(&mtk_xhci_driver);
683}
684module_init(xhci_mtk_init);
685
686static void __exit xhci_mtk_exit(void)
687{
688 platform_driver_unregister(&mtk_xhci_driver);
689}
690module_exit(xhci_mtk_exit);
691
692MODULE_AUTHOR("Chunfeng Yun <chunfeng.yun@mediatek.com>");
693MODULE_DESCRIPTION("MediaTek xHCI Host Controller Driver");
694MODULE_LICENSE("GPL v2");