1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2019 MediaTek Inc.
6 * Min Guo <min.guo@mediatek.com>
7 * Yonglong Wu <yonglong.wu@mediatek.com>
10 #include <linux/clk.h>
11 #include <linux/dma-mapping.h>
12 #include <linux/module.h>
13 #include <linux/of_platform.h>
14 #include <linux/platform_device.h>
15 #include <linux/usb/role.h>
16 #include <linux/usb/usb_phy_generic.h>
17 #include "musb_core.h"
20 #define USB_L1INTS 0x00a0
21 #define USB_L1INTM 0x00a4
22 #define MTK_MUSB_TXFUNCADDR 0x0480
24 /* MediaTek controller toggle enable and status reg */
25 #define MUSB_RXTOG 0x80
26 #define MUSB_RXTOGEN 0x82
27 #define MUSB_TXTOG 0x84
28 #define MUSB_TXTOGEN 0x86
29 #define MTK_TOGGLE_EN GENMASK(15, 0)
31 #define TX_INT_STATUS BIT(0)
32 #define RX_INT_STATUS BIT(1)
33 #define USBCOM_INT_STATUS BIT(2)
34 #define DMA_INT_STATUS BIT(3)
36 #define DMA_INTR_STATUS_MSK GENMASK(7, 0)
37 #define DMA_INTR_UNMASK_SET_MSK GENMASK(31, 24)
42 struct platform_device *musb_pdev;
43 struct platform_device *usb_phy;
45 struct usb_phy *xceiv;
46 enum phy_mode phy_mode;
51 struct usb_role_switch *role_sw;
54 static int mtk_musb_clks_get(struct mtk_glue *glue)
56 struct device *dev = glue->dev;
58 glue->main = devm_clk_get(dev, "main");
59 if (IS_ERR(glue->main)) {
60 dev_err(dev, "fail to get main clock\n");
61 return PTR_ERR(glue->main);
64 glue->mcu = devm_clk_get(dev, "mcu");
65 if (IS_ERR(glue->mcu)) {
66 dev_err(dev, "fail to get mcu clock\n");
67 return PTR_ERR(glue->mcu);
70 glue->univpll = devm_clk_get(dev, "univpll");
71 if (IS_ERR(glue->univpll)) {
72 dev_err(dev, "fail to get univpll clock\n");
73 return PTR_ERR(glue->univpll);
79 static int mtk_musb_clks_enable(struct mtk_glue *glue)
83 ret = clk_prepare_enable(glue->main);
85 dev_err(glue->dev, "failed to enable main clock\n");
89 ret = clk_prepare_enable(glue->mcu);
91 dev_err(glue->dev, "failed to enable mcu clock\n");
95 ret = clk_prepare_enable(glue->univpll);
97 dev_err(glue->dev, "failed to enable univpll clock\n");
104 clk_disable_unprepare(glue->mcu);
106 clk_disable_unprepare(glue->main);
111 static void mtk_musb_clks_disable(struct mtk_glue *glue)
113 clk_disable_unprepare(glue->univpll);
114 clk_disable_unprepare(glue->mcu);
115 clk_disable_unprepare(glue->main);
118 static int mtk_otg_switch_set(struct mtk_glue *glue, enum usb_role role)
120 struct musb *musb = glue->musb;
121 u8 devctl = readb(musb->mregs + MUSB_DEVCTL);
122 enum usb_role new_role;
124 if (role == glue->role)
129 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE;
130 glue->phy_mode = PHY_MODE_USB_HOST;
131 new_role = USB_ROLE_HOST;
132 if (glue->role == USB_ROLE_NONE)
133 phy_power_on(glue->phy);
135 devctl |= MUSB_DEVCTL_SESSION;
136 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
139 case USB_ROLE_DEVICE:
140 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
141 glue->phy_mode = PHY_MODE_USB_DEVICE;
142 new_role = USB_ROLE_DEVICE;
143 devctl &= ~MUSB_DEVCTL_SESSION;
144 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
145 if (glue->role == USB_ROLE_NONE)
146 phy_power_on(glue->phy);
151 glue->phy_mode = PHY_MODE_USB_OTG;
152 new_role = USB_ROLE_NONE;
153 devctl &= ~MUSB_DEVCTL_SESSION;
154 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
155 if (glue->role != USB_ROLE_NONE)
156 phy_power_off(glue->phy);
160 dev_err(glue->dev, "Invalid State\n");
164 glue->role = new_role;
165 phy_set_mode(glue->phy, glue->phy_mode);
170 static int musb_usb_role_sx_set(struct usb_role_switch *sw, enum usb_role role)
172 return mtk_otg_switch_set(usb_role_switch_get_drvdata(sw), role);
175 static enum usb_role musb_usb_role_sx_get(struct usb_role_switch *sw)
177 struct mtk_glue *glue = usb_role_switch_get_drvdata(sw);
182 static int mtk_otg_switch_init(struct mtk_glue *glue)
184 struct usb_role_switch_desc role_sx_desc = { 0 };
186 role_sx_desc.set = musb_usb_role_sx_set;
187 role_sx_desc.get = musb_usb_role_sx_get;
188 role_sx_desc.allow_userspace_control = true;
189 role_sx_desc.fwnode = dev_fwnode(glue->dev);
190 role_sx_desc.driver_data = glue;
191 glue->role_sw = usb_role_switch_register(glue->dev, &role_sx_desc);
193 return PTR_ERR_OR_ZERO(glue->role_sw);
196 static void mtk_otg_switch_exit(struct mtk_glue *glue)
198 return usb_role_switch_unregister(glue->role_sw);
201 static irqreturn_t generic_interrupt(int irq, void *__hci)
204 irqreturn_t retval = IRQ_NONE;
205 struct musb *musb = __hci;
207 spin_lock_irqsave(&musb->lock, flags);
208 musb->int_usb = musb_clearb(musb->mregs, MUSB_INTRUSB);
209 musb->int_rx = musb_clearw(musb->mregs, MUSB_INTRRX);
210 musb->int_tx = musb_clearw(musb->mregs, MUSB_INTRTX);
212 if ((musb->int_usb & MUSB_INTR_RESET) && !is_host_active(musb)) {
213 /* ep0 FADDR must be 0 when (re)entering peripheral mode */
214 musb_ep_select(musb->mregs, 0);
215 musb_writeb(musb->mregs, MUSB_FADDR, 0);
218 if (musb->int_usb || musb->int_tx || musb->int_rx)
219 retval = musb_interrupt(musb);
221 spin_unlock_irqrestore(&musb->lock, flags);
226 static irqreturn_t mtk_musb_interrupt(int irq, void *dev_id)
228 irqreturn_t retval = IRQ_NONE;
229 struct musb *musb = (struct musb *)dev_id;
232 l1_ints = musb_readl(musb->mregs, USB_L1INTS) &
233 musb_readl(musb->mregs, USB_L1INTM);
235 if (l1_ints & (TX_INT_STATUS | RX_INT_STATUS | USBCOM_INT_STATUS))
236 retval = generic_interrupt(irq, musb);
238 #if defined(CONFIG_USB_INVENTRA_DMA)
239 if (l1_ints & DMA_INT_STATUS)
240 retval = dma_controller_irq(irq, musb->dma_controller);
245 static u32 mtk_musb_busctl_offset(u8 epnum, u16 offset)
247 return MTK_MUSB_TXFUNCADDR + offset + 8 * epnum;
250 static u8 mtk_musb_clearb(void __iomem *addr, unsigned int offset)
255 data = musb_readb(addr, offset);
256 musb_writeb(addr, offset, data);
260 static u16 mtk_musb_clearw(void __iomem *addr, unsigned int offset)
265 data = musb_readw(addr, offset);
266 musb_writew(addr, offset, data);
270 static int mtk_musb_set_mode(struct musb *musb, u8 mode)
272 struct device *dev = musb->controller;
273 struct mtk_glue *glue = dev_get_drvdata(dev->parent);
274 enum phy_mode new_mode;
275 enum usb_role new_role;
279 new_mode = PHY_MODE_USB_HOST;
280 new_role = USB_ROLE_HOST;
282 case MUSB_PERIPHERAL:
283 new_mode = PHY_MODE_USB_DEVICE;
284 new_role = USB_ROLE_DEVICE;
287 new_mode = PHY_MODE_USB_OTG;
288 new_role = USB_ROLE_NONE;
291 dev_err(glue->dev, "Invalid mode request\n");
295 if (glue->phy_mode == new_mode)
298 if (musb->port_mode != MUSB_OTG) {
299 dev_err(glue->dev, "Does not support changing modes\n");
303 mtk_otg_switch_set(glue, new_role);
307 static int mtk_musb_init(struct musb *musb)
309 struct device *dev = musb->controller;
310 struct mtk_glue *glue = dev_get_drvdata(dev->parent);
314 musb->phy = glue->phy;
315 musb->xceiv = glue->xceiv;
316 musb->is_host = false;
317 musb->isr = mtk_musb_interrupt;
319 /* Set TX/RX toggle enable */
320 musb_writew(musb->mregs, MUSB_TXTOGEN, MTK_TOGGLE_EN);
321 musb_writew(musb->mregs, MUSB_RXTOGEN, MTK_TOGGLE_EN);
323 if (musb->port_mode == MUSB_OTG) {
324 ret = mtk_otg_switch_init(glue);
329 ret = phy_init(glue->phy);
333 ret = phy_power_on(glue->phy);
335 goto err_phy_power_on;
337 phy_set_mode(glue->phy, glue->phy_mode);
339 #if defined(CONFIG_USB_INVENTRA_DMA)
340 musb_writel(musb->mregs, MUSB_HSDMA_INTR,
341 DMA_INTR_STATUS_MSK | DMA_INTR_UNMASK_SET_MSK);
343 musb_writel(musb->mregs, USB_L1INTM, TX_INT_STATUS | RX_INT_STATUS |
344 USBCOM_INT_STATUS | DMA_INT_STATUS);
350 mtk_otg_switch_exit(glue);
354 static u16 mtk_musb_get_toggle(struct musb_qh *qh, int is_out)
356 struct musb *musb = qh->hw_ep->musb;
357 u8 epnum = qh->hw_ep->epnum;
360 toggle = musb_readw(musb->mregs, is_out ? MUSB_TXTOG : MUSB_RXTOG);
361 return toggle & (1 << epnum);
364 static u16 mtk_musb_set_toggle(struct musb_qh *qh, int is_out, struct urb *urb)
366 struct musb *musb = qh->hw_ep->musb;
367 u8 epnum = qh->hw_ep->epnum;
370 toggle = usb_gettoggle(urb->dev, qh->epnum, is_out);
373 value = musb_readw(musb->mregs, MUSB_TXTOG);
374 value |= toggle << epnum;
375 musb_writew(musb->mregs, MUSB_TXTOG, value);
377 value = musb_readw(musb->mregs, MUSB_RXTOG);
378 value |= toggle << epnum;
379 musb_writew(musb->mregs, MUSB_RXTOG, value);
385 static int mtk_musb_exit(struct musb *musb)
387 struct device *dev = musb->controller;
388 struct mtk_glue *glue = dev_get_drvdata(dev->parent);
390 mtk_otg_switch_exit(glue);
391 phy_power_off(glue->phy);
393 mtk_musb_clks_disable(glue);
395 pm_runtime_put_sync(dev);
396 pm_runtime_disable(dev);
400 static const struct musb_platform_ops mtk_musb_ops = {
401 .quirks = MUSB_DMA_INVENTRA,
402 .init = mtk_musb_init,
403 .get_toggle = mtk_musb_get_toggle,
404 .set_toggle = mtk_musb_set_toggle,
405 .exit = mtk_musb_exit,
406 #ifdef CONFIG_USB_INVENTRA_DMA
407 .dma_init = musbhs_dma_controller_create_noirq,
408 .dma_exit = musbhs_dma_controller_destroy,
410 .clearb = mtk_musb_clearb,
411 .clearw = mtk_musb_clearw,
412 .busctl_offset = mtk_musb_busctl_offset,
413 .set_mode = mtk_musb_set_mode,
416 #define MTK_MUSB_MAX_EP_NUM 8
417 #define MTK_MUSB_RAM_BITS 11
419 static struct musb_fifo_cfg mtk_musb_mode_cfg[] = {
420 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
421 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
422 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
423 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
424 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
425 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
426 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
427 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
428 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
429 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
430 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 1024, },
431 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 1024, },
432 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 512, },
433 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 64, },
436 static const struct musb_hdrc_config mtk_musb_hdrc_config = {
437 .fifo_cfg = mtk_musb_mode_cfg,
438 .fifo_cfg_size = ARRAY_SIZE(mtk_musb_mode_cfg),
441 .num_eps = MTK_MUSB_MAX_EP_NUM,
442 .ram_bits = MTK_MUSB_RAM_BITS,
445 static const struct platform_device_info mtk_dev_info = {
447 .id = PLATFORM_DEVID_AUTO,
448 .dma_mask = DMA_BIT_MASK(32),
451 static int mtk_musb_probe(struct platform_device *pdev)
453 struct musb_hdrc_platform_data *pdata;
454 struct mtk_glue *glue;
455 struct platform_device_info pinfo;
456 struct device *dev = &pdev->dev;
457 struct device_node *np = dev->of_node;
460 glue = devm_kzalloc(dev, sizeof(*glue), GFP_KERNEL);
465 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
469 ret = of_platform_populate(np, NULL, NULL, dev);
471 dev_err(dev, "failed to create child devices at %p\n", np);
475 ret = mtk_musb_clks_get(glue);
479 pdata->config = &mtk_musb_hdrc_config;
480 pdata->platform_ops = &mtk_musb_ops;
481 pdata->mode = usb_get_dr_mode(dev);
483 if (IS_ENABLED(CONFIG_USB_MUSB_HOST))
484 pdata->mode = USB_DR_MODE_HOST;
485 else if (IS_ENABLED(CONFIG_USB_MUSB_GADGET))
486 pdata->mode = USB_DR_MODE_PERIPHERAL;
488 switch (pdata->mode) {
489 case USB_DR_MODE_HOST:
490 glue->phy_mode = PHY_MODE_USB_HOST;
491 glue->role = USB_ROLE_HOST;
493 case USB_DR_MODE_PERIPHERAL:
494 glue->phy_mode = PHY_MODE_USB_DEVICE;
495 glue->role = USB_ROLE_DEVICE;
497 case USB_DR_MODE_OTG:
498 glue->phy_mode = PHY_MODE_USB_OTG;
499 glue->role = USB_ROLE_NONE;
502 dev_err(&pdev->dev, "Error 'dr_mode' property\n");
506 glue->phy = devm_of_phy_get_by_index(dev, np, 0);
507 if (IS_ERR(glue->phy)) {
508 dev_err(dev, "fail to getting phy %ld\n",
510 return PTR_ERR(glue->phy);
513 glue->usb_phy = usb_phy_generic_register();
514 if (IS_ERR(glue->usb_phy)) {
515 dev_err(dev, "fail to registering usb-phy %ld\n",
516 PTR_ERR(glue->usb_phy));
517 return PTR_ERR(glue->usb_phy);
520 glue->xceiv = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
521 if (IS_ERR(glue->xceiv)) {
522 ret = PTR_ERR(glue->xceiv);
523 dev_err(dev, "fail to getting usb-phy %d\n", ret);
524 goto err_unregister_usb_phy;
527 platform_set_drvdata(pdev, glue);
528 pm_runtime_enable(dev);
529 pm_runtime_get_sync(dev);
531 ret = mtk_musb_clks_enable(glue);
535 pinfo = mtk_dev_info;
537 pinfo.res = pdev->resource;
538 pinfo.num_res = pdev->num_resources;
540 pinfo.size_data = sizeof(*pdata);
542 glue->musb_pdev = platform_device_register_full(&pinfo);
543 if (IS_ERR(glue->musb_pdev)) {
544 ret = PTR_ERR(glue->musb_pdev);
545 dev_err(dev, "failed to register musb device: %d\n", ret);
546 goto err_device_register;
552 mtk_musb_clks_disable(glue);
554 pm_runtime_put_sync(dev);
555 pm_runtime_disable(dev);
556 err_unregister_usb_phy:
557 usb_phy_generic_unregister(glue->usb_phy);
561 static int mtk_musb_remove(struct platform_device *pdev)
563 struct mtk_glue *glue = platform_get_drvdata(pdev);
564 struct platform_device *usb_phy = glue->usb_phy;
566 platform_device_unregister(glue->musb_pdev);
567 usb_phy_generic_unregister(usb_phy);
573 static const struct of_device_id mtk_musb_match[] = {
574 {.compatible = "mediatek,mtk-musb",},
577 MODULE_DEVICE_TABLE(of, mtk_musb_match);
580 static struct platform_driver mtk_musb_driver = {
581 .probe = mtk_musb_probe,
582 .remove = mtk_musb_remove,
585 .of_match_table = of_match_ptr(mtk_musb_match),
589 module_platform_driver(mtk_musb_driver);
591 MODULE_DESCRIPTION("MediaTek MUSB Glue Layer");
592 MODULE_AUTHOR("Min Guo <min.guo@mediatek.com>");
593 MODULE_LICENSE("GPL v2");