1 // SPDX-License-Identifier: GPL-2.0
3 * Texas Instruments DSPS platforms "glue layer"
5 * Copyright (C) 2012, by Texas Instruments
7 * Based on the am35x "glue layer" code.
9 * This file is part of the Inventra Controller Driver for Linux.
11 * musb_dsps.c will be a common file for all the TI DSPS platforms
12 * such as dm64x, dm36x, dm35x, da8x, am35x and ti81x.
13 * For now only ti81x is using this and in future davinci.c, am35x.c
14 * da8xx.c would be merged to this file after testing.
18 #include <dm/device_compat.h>
19 #include <dm/devres.h>
20 #include <linux/init.h>
22 #include <linux/err.h>
23 #include <linux/platform_device.h>
24 #include <linux/dma-mapping.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/module.h>
29 #include <linux/of_device.h>
30 #include <linux/of_address.h>
35 #include <asm/omap_musb.h>
36 #include "linux-compat.h"
39 #include "musb_core.h"
42 * avoid using musb_readx()/musb_writex() as glue layer should not be
43 * dependent on musb core layer symbols.
45 static inline u8 dsps_readb(const void __iomem *addr, unsigned offset)
46 { return __raw_readb(addr + offset); }
48 static inline u32 dsps_readl(const void __iomem *addr, unsigned offset)
49 { return __raw_readl(addr + offset); }
51 static inline void dsps_writeb(void __iomem *addr, unsigned offset, u8 data)
52 { __raw_writeb(data, addr + offset); }
54 static inline void dsps_writel(void __iomem *addr, unsigned offset, u32 data)
55 { __raw_writel(data, addr + offset); }
58 * DSPS musb wrapper register offset.
59 * FIXME: This should be expanded to have all the wrapper registers from TI DSPS
62 struct dsps_musb_wrapper {
76 /* bit positions for control */
79 /* bit positions for interrupt */
85 unsigned txep_shift:5;
89 unsigned rxep_shift:5;
93 /* bit positions for phy_utmi */
94 unsigned otg_disable:5;
96 /* bit positions for mode */
98 /* miscellaneous stuff */
103 static const struct dsps_musb_wrapper ti81xx_driver_data __devinitconst = {
109 .epintr_clear = 0x40,
110 .epintr_status = 0x30,
111 .coreintr_set = 0x3c,
112 .coreintr_clear = 0x44,
113 .coreintr_status = 0x34,
121 .usb_bitmap = (0x1ff << 0),
125 .txep_bitmap = (0xffff << 0),
128 .rxep_bitmap = (0xfffe << 16),
129 .musb_core_offset = 0x400,
134 * DSPS glue structure.
138 struct platform_device *musb; /* child musb pdev */
139 const struct dsps_musb_wrapper *wrp; /* wrapper register offsets */
140 struct timer_list timer; /* otg_workaround timer */
144 * dsps_musb_enable - enable interrupts
147 static void dsps_musb_enable(struct musb *musb)
149 static int dsps_musb_enable(struct musb *musb)
153 struct device *dev = musb->controller;
154 struct platform_device *pdev = to_platform_device(dev->parent);
155 struct dsps_glue *glue = platform_get_drvdata(pdev);
156 const struct dsps_musb_wrapper *wrp = glue->wrp;
158 const struct dsps_musb_wrapper *wrp = &ti81xx_driver_data;
160 void __iomem *reg_base = musb->ctrl_base;
161 u32 epmask, coremask;
163 /* Workaround: setup IRQs through both register sets. */
164 epmask = ((musb->epmask & wrp->txep_mask) << wrp->txep_shift) |
165 ((musb->epmask & wrp->rxep_mask) << wrp->rxep_shift);
166 coremask = (wrp->usb_bitmap & ~MUSB_INTR_SOF);
168 dsps_writel(reg_base, wrp->epintr_set, epmask);
169 dsps_writel(reg_base, wrp->coreintr_set, coremask);
170 /* Force the DRVVBUS IRQ so we can start polling for ID change. */
172 if (is_otg_enabled(musb))
173 dsps_writel(reg_base, wrp->coreintr_set,
174 (1 << wrp->drvvbus) << wrp->usb_shift);
181 * dsps_musb_disable - disable HDRC and flush interrupts
183 static void dsps_musb_disable(struct musb *musb)
186 struct device *dev = musb->controller;
187 struct platform_device *pdev = to_platform_device(dev->parent);
188 struct dsps_glue *glue = platform_get_drvdata(pdev);
189 const struct dsps_musb_wrapper *wrp = glue->wrp;
190 void __iomem *reg_base = musb->ctrl_base;
192 dsps_writel(reg_base, wrp->coreintr_clear, wrp->usb_bitmap);
193 dsps_writel(reg_base, wrp->epintr_clear,
194 wrp->txep_bitmap | wrp->rxep_bitmap);
195 dsps_writeb(musb->mregs, MUSB_DEVCTL, 0);
196 dsps_writel(reg_base, wrp->eoi, 0);
201 static void otg_timer(unsigned long _musb)
203 struct musb *musb = (void *)_musb;
204 void __iomem *mregs = musb->mregs;
205 struct device *dev = musb->controller;
206 struct platform_device *pdev = to_platform_device(dev->parent);
207 struct dsps_glue *glue = platform_get_drvdata(pdev);
208 const struct dsps_musb_wrapper *wrp = glue->wrp;
213 * We poll because DSPS IP's won't expose several OTG-critical
214 * status change events (from the transceiver) otherwise.
216 devctl = dsps_readb(mregs, MUSB_DEVCTL);
217 dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
218 otg_state_string(musb->xceiv->state));
220 spin_lock_irqsave(&musb->lock, flags);
221 switch (musb->xceiv->state) {
222 case OTG_STATE_A_WAIT_BCON:
223 devctl &= ~MUSB_DEVCTL_SESSION;
224 dsps_writeb(musb->mregs, MUSB_DEVCTL, devctl);
226 devctl = dsps_readb(musb->mregs, MUSB_DEVCTL);
227 if (devctl & MUSB_DEVCTL_BDEVICE) {
228 musb->xceiv->state = OTG_STATE_B_IDLE;
231 musb->xceiv->state = OTG_STATE_A_IDLE;
235 case OTG_STATE_A_WAIT_VFALL:
236 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
237 dsps_writel(musb->ctrl_base, wrp->coreintr_set,
238 MUSB_INTR_VBUSERROR << wrp->usb_shift);
240 case OTG_STATE_B_IDLE:
241 if (!is_peripheral_enabled(musb))
244 devctl = dsps_readb(mregs, MUSB_DEVCTL);
245 if (devctl & MUSB_DEVCTL_BDEVICE)
246 mod_timer(&glue->timer,
247 jiffies + wrp->poll_seconds * HZ);
249 musb->xceiv->state = OTG_STATE_A_IDLE;
254 spin_unlock_irqrestore(&musb->lock, flags);
257 static void dsps_musb_try_idle(struct musb *musb, unsigned long timeout)
259 struct device *dev = musb->controller;
260 struct platform_device *pdev = to_platform_device(dev->parent);
261 struct dsps_glue *glue = platform_get_drvdata(pdev);
262 static unsigned long last_timer;
264 if (!is_otg_enabled(musb))
268 timeout = jiffies + msecs_to_jiffies(3);
270 /* Never idle if active, or when VBUS timeout is not set as host */
271 if (musb->is_active || (musb->a_wait_bcon == 0 &&
272 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) {
273 dev_dbg(musb->controller, "%s active, deleting timer\n",
274 otg_state_string(musb->xceiv->state));
275 del_timer(&glue->timer);
276 last_timer = jiffies;
280 if (time_after(last_timer, timeout) && timer_pending(&glue->timer)) {
281 dev_dbg(musb->controller,
282 "Longer idle timer already pending, ignoring...\n");
285 last_timer = timeout;
287 dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n",
288 otg_state_string(musb->xceiv->state),
289 jiffies_to_msecs(timeout - jiffies));
290 mod_timer(&glue->timer, timeout);
294 static irqreturn_t dsps_interrupt(int irq, void *hci)
296 struct musb *musb = hci;
297 void __iomem *reg_base = musb->ctrl_base;
299 struct device *dev = musb->controller;
300 struct platform_device *pdev = to_platform_device(dev->parent);
301 struct dsps_glue *glue = platform_get_drvdata(pdev);
302 const struct dsps_musb_wrapper *wrp = glue->wrp;
304 const struct dsps_musb_wrapper *wrp = &ti81xx_driver_data;
307 irqreturn_t ret = IRQ_NONE;
310 spin_lock_irqsave(&musb->lock, flags);
312 /* Get endpoint interrupts */
313 epintr = dsps_readl(reg_base, wrp->epintr_status);
314 musb->int_rx = (epintr & wrp->rxep_bitmap) >> wrp->rxep_shift;
315 musb->int_tx = (epintr & wrp->txep_bitmap) >> wrp->txep_shift;
318 dsps_writel(reg_base, wrp->epintr_status, epintr);
320 /* Get usb core interrupts */
321 usbintr = dsps_readl(reg_base, wrp->coreintr_status);
322 if (!usbintr && !epintr)
325 musb->int_usb = (usbintr & wrp->usb_bitmap) >> wrp->usb_shift;
327 dsps_writel(reg_base, wrp->coreintr_status, usbintr);
329 dev_dbg(musb->controller, "usbintr (%x) epintr(%x)\n",
333 * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
334 * DSPS IP's missing ID change IRQ. We need an ID change IRQ to
335 * switch appropriately between halves of the OTG state machine.
336 * Managing DEVCTL.SESSION per Mentor docs requires that we know its
337 * value but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
338 * Also, DRVVBUS pulses for SRP (but not at 5V) ...
340 if ((usbintr & MUSB_INTR_BABBLE) && is_host_enabled(musb))
341 pr_info("CAUTION: musb: Babble Interrupt Occured\n");
343 if (usbintr & ((1 << wrp->drvvbus) << wrp->usb_shift)) {
344 int drvvbus = dsps_readl(reg_base, wrp->status);
345 void __iomem *mregs = musb->mregs;
346 u8 devctl = dsps_readb(mregs, MUSB_DEVCTL);
349 err = is_host_enabled(musb) && (musb->int_usb &
350 MUSB_INTR_VBUSERROR);
353 * The Mentor core doesn't debounce VBUS as needed
354 * to cope with device connect current spikes. This
355 * means it's not uncommon for bus-powered devices
356 * to get VBUS errors during enumeration.
358 * This is a workaround, but newer RTL from Mentor
359 * seems to allow a better one: "re"-starting sessions
360 * without waiting for VBUS to stop registering in
363 musb->int_usb &= ~MUSB_INTR_VBUSERROR;
364 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
365 mod_timer(&glue->timer,
366 jiffies + wrp->poll_seconds * HZ);
367 WARNING("VBUS error workaround (delay coming)\n");
368 } else if (is_host_enabled(musb) && drvvbus) {
371 musb->xceiv->otg->default_a = 1;
372 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
373 del_timer(&glue->timer);
377 musb->xceiv->otg->default_a = 0;
378 musb->xceiv->state = OTG_STATE_B_IDLE;
381 /* NOTE: this must complete power-on within 100 ms. */
382 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
383 drvvbus ? "on" : "off",
384 otg_state_string(musb->xceiv->state),
391 if (musb->int_tx || musb->int_rx || musb->int_usb)
392 ret |= musb_interrupt(musb);
395 /* EOI needs to be written for the IRQ to be re-asserted. */
396 if (ret == IRQ_HANDLED || epintr || usbintr)
397 dsps_writel(reg_base, wrp->eoi, 1);
400 /* Poll for ID change */
401 if (is_otg_enabled(musb) && musb->xceiv->state == OTG_STATE_B_IDLE)
402 mod_timer(&glue->timer, jiffies + wrp->poll_seconds * HZ);
405 spin_unlock_irqrestore(&musb->lock, flags);
410 static int dsps_musb_init(struct musb *musb)
413 struct device *dev = musb->controller;
414 struct musb_hdrc_platform_data *plat = dev->platform_data;
415 struct platform_device *pdev = to_platform_device(dev->parent);
416 struct dsps_glue *glue = platform_get_drvdata(pdev);
417 const struct dsps_musb_wrapper *wrp = glue->wrp;
418 struct omap_musb_board_data *data = plat->board_data;
420 struct omap_musb_board_data *data =
421 (struct omap_musb_board_data *)musb->controller;
422 const struct dsps_musb_wrapper *wrp = &ti81xx_driver_data;
424 void __iomem *reg_base = musb->ctrl_base;
428 /* mentor core register starts at offset of 0x400 from musb base */
429 musb->mregs += wrp->musb_core_offset;
432 /* NOP driver needs change if supporting dual instance */
433 usb_nop_xceiv_register();
434 musb->xceiv = usb_get_phy(USB_PHY_TYPE_USB2);
435 if (IS_ERR_OR_NULL(musb->xceiv))
439 /* Returns zero if e.g. not clocked */
440 rev = dsps_readl(reg_base, wrp->revision);
447 if (is_host_enabled(musb))
448 setup_timer(&glue->timer, otg_timer, (unsigned long) musb);
452 dsps_writel(reg_base, wrp->control, (1 << wrp->reset));
454 /* Start the on-chip PHY and its PLL. */
455 if (data && data->set_phy_power)
456 data->set_phy_power(data->dev, 1);
458 musb->isr = dsps_interrupt;
460 /* reset the otgdisable bit, needed for host mode to work */
461 val = dsps_readl(reg_base, wrp->phy_utmi);
462 val &= ~(1 << wrp->otg_disable);
463 dsps_writel(musb->ctrl_base, wrp->phy_utmi, val);
465 /* clear level interrupt */
466 dsps_writel(reg_base, wrp->eoi, 0);
471 usb_put_phy(musb->xceiv);
472 usb_nop_xceiv_unregister();
477 static int dsps_musb_exit(struct musb *musb)
480 struct device *dev = musb->controller;
481 struct musb_hdrc_platform_data *plat = dev->platform_data;
482 struct omap_musb_board_data *data = plat->board_data;
483 struct platform_device *pdev = to_platform_device(dev->parent);
484 struct dsps_glue *glue = platform_get_drvdata(pdev);
486 struct omap_musb_board_data *data =
487 (struct omap_musb_board_data *)musb->controller;
491 if (is_host_enabled(musb))
492 del_timer_sync(&glue->timer);
495 /* Shutdown the on-chip PHY and its PLL. */
496 if (data && data->set_phy_power)
497 data->set_phy_power(data->dev, 0);
500 /* NOP driver needs change if supporting dual instance */
501 usb_put_phy(musb->xceiv);
502 usb_nop_xceiv_unregister();
509 static struct musb_platform_ops dsps_ops = {
511 struct musb_platform_ops musb_dsps_ops = {
513 .init = dsps_musb_init,
514 .exit = dsps_musb_exit,
516 .enable = dsps_musb_enable,
517 .disable = dsps_musb_disable,
520 .try_idle = dsps_musb_try_idle,
525 static u64 musb_dmamask = DMA_BIT_MASK(32);
529 static int __devinit dsps_create_musb_pdev(struct dsps_glue *glue, u8 id)
531 struct device *dev = glue->dev;
532 struct platform_device *pdev = to_platform_device(dev);
533 struct musb_hdrc_platform_data *pdata = dev->platform_data;
534 struct platform_device *musb;
535 struct resource *res;
536 struct resource resources[2];
540 /* get memory resource */
541 sprintf(res_name, "musb%d", id);
542 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, res_name);
544 dev_err(dev, "%s get mem resource failed\n", res_name);
551 /* get irq resource */
552 sprintf(res_name, "musb%d-irq", id);
553 res = platform_get_resource_byname(pdev, IORESOURCE_IRQ, res_name);
555 dev_err(dev, "%s get irq resource failed\n", res_name);
561 resources[1].name = "mc";
563 /* allocate the child platform device */
564 musb = platform_device_alloc("musb-hdrc", -1);
566 dev_err(dev, "failed to allocate musb device\n");
571 musb->dev.parent = dev;
572 musb->dev.dma_mask = &musb_dmamask;
573 musb->dev.coherent_dma_mask = musb_dmamask;
577 pdata->platform_ops = &dsps_ops;
579 ret = platform_device_add_resources(musb, resources, 2);
581 dev_err(dev, "failed to add resources\n");
585 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
587 dev_err(dev, "failed to add platform_data\n");
591 ret = platform_device_add(musb);
593 dev_err(dev, "failed to register musb device\n");
600 platform_device_put(musb);
605 static void __devexit dsps_delete_musb_pdev(struct dsps_glue *glue)
607 platform_device_del(glue->musb);
608 platform_device_put(glue->musb);
611 static int __devinit dsps_probe(struct platform_device *pdev)
613 const struct platform_device_id *id = platform_get_device_id(pdev);
614 const struct dsps_musb_wrapper *wrp =
615 (struct dsps_musb_wrapper *)id->driver_data;
616 struct dsps_glue *glue;
617 struct resource *iomem;
621 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
623 dev_err(&pdev->dev, "unable to allocate glue memory\n");
628 /* get memory resource */
629 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
631 dev_err(&pdev->dev, "failed to get usbss mem resource\n");
636 glue->dev = &pdev->dev;
638 glue->wrp = kmemdup(wrp, sizeof(*wrp), GFP_KERNEL);
640 dev_err(&pdev->dev, "failed to duplicate wrapper struct memory\n");
644 platform_set_drvdata(pdev, glue);
646 /* enable the usbss clocks */
647 pm_runtime_enable(&pdev->dev);
649 ret = pm_runtime_get_sync(&pdev->dev);
651 dev_err(&pdev->dev, "pm_runtime_get_sync FAILED");
655 /* create the child platform device for first instances of musb */
656 ret = dsps_create_musb_pdev(glue, 0);
658 dev_err(&pdev->dev, "failed to create child pdev\n");
665 pm_runtime_put(&pdev->dev);
667 pm_runtime_disable(&pdev->dev);
674 static int __devexit dsps_remove(struct platform_device *pdev)
676 struct dsps_glue *glue = platform_get_drvdata(pdev);
678 /* delete the child platform device */
679 dsps_delete_musb_pdev(glue);
681 /* disable usbss clocks */
682 pm_runtime_put(&pdev->dev);
683 pm_runtime_disable(&pdev->dev);
689 #ifdef CONFIG_PM_SLEEP
690 static int dsps_suspend(struct device *dev)
692 struct musb_hdrc_platform_data *plat = dev->platform_data;
693 struct omap_musb_board_data *data = plat->board_data;
695 /* Shutdown the on-chip PHY and its PLL. */
696 if (data && data->set_phy_power)
697 data->set_phy_power(data->dev, 0);
702 static int dsps_resume(struct device *dev)
704 struct musb_hdrc_platform_data *plat = dev->platform_data;
705 struct omap_musb_board_data *data = plat->board_data;
707 /* Start the on-chip PHY and its PLL. */
708 if (data && data->set_phy_power)
709 data->set_phy_power(data->dev, 1);
715 static SIMPLE_DEV_PM_OPS(dsps_pm_ops, dsps_suspend, dsps_resume);
719 static const struct platform_device_id musb_dsps_id_table[] __devinitconst = {
721 .name = "musb-ti81xx",
722 .driver_data = (kernel_ulong_t) &ti81xx_driver_data,
724 { }, /* Terminating Entry */
726 MODULE_DEVICE_TABLE(platform, musb_dsps_id_table);
728 static const struct of_device_id musb_dsps_of_match[] __devinitconst = {
729 { .compatible = "musb-ti81xx", },
730 { .compatible = "ti,ti81xx-musb", },
731 { .compatible = "ti,am335x-musb", },
734 MODULE_DEVICE_TABLE(of, musb_dsps_of_match);
736 static struct platform_driver dsps_usbss_driver = {
738 .remove = __devexit_p(dsps_remove),
742 .of_match_table = musb_dsps_of_match,
744 .id_table = musb_dsps_id_table,
747 MODULE_DESCRIPTION("TI DSPS MUSB Glue Layer");
748 MODULE_AUTHOR("Ravi B <ravibabu@ti.com>");
749 MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>");
750 MODULE_LICENSE("GPL v2");
752 static int __init dsps_init(void)
754 return platform_driver_register(&dsps_usbss_driver);
756 subsys_initcall(dsps_init);
758 static void __exit dsps_exit(void)
760 platform_driver_unregister(&dsps_usbss_driver);
762 module_exit(dsps_exit);