2 * Texas Instruments DSPS platforms "glue layer"
4 * Copyright (C) 2012, by Texas Instruments
6 * Based on the am35x "glue layer" code.
8 * This file is part of the Inventra Controller Driver for Linux.
10 * The Inventra Controller Driver for Linux is free software; you
11 * can redistribute it and/or modify it under the terms of the GNU
12 * General Public License version 2 as published by the Free Software
15 * The Inventra Controller Driver for Linux is distributed in
16 * the hope that it will be useful, but WITHOUT ANY WARRANTY;
17 * without even the implied warranty of MERCHANTABILITY or
18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
19 * License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with The Inventra Controller Driver for Linux ; if not,
23 * write to the Free Software Foundation, Inc., 59 Temple Place,
24 * Suite 330, Boston, MA 02111-1307 USA
26 * musb_dsps.c will be a common file for all the TI DSPS platforms
27 * such as dm64x, dm36x, dm35x, da8x, am35x and ti81x.
28 * For now only ti81x is using this and in future davinci.c, am35x.c
29 * da8xx.c would be merged to this file after testing.
32 #include <linux/init.h>
34 #include <linux/err.h>
35 #include <linux/platform_device.h>
36 #include <linux/dma-mapping.h>
37 #include <linux/pm_runtime.h>
38 #include <linux/module.h>
39 #include <linux/usb/nop-usb-xceiv.h>
40 #include <linux/platform_data/usb-omap.h>
41 #include <linux/sizes.h>
44 #include <linux/of_device.h>
45 #include <linux/of_address.h>
47 #include "musb_core.h"
50 static const struct of_device_id musb_dsps_of_match[];
54 * avoid using musb_readx()/musb_writex() as glue layer should not be
55 * dependent on musb core layer symbols.
57 static inline u8 dsps_readb(const void __iomem *addr, unsigned offset)
58 { return __raw_readb(addr + offset); }
60 static inline u32 dsps_readl(const void __iomem *addr, unsigned offset)
61 { return __raw_readl(addr + offset); }
63 static inline void dsps_writeb(void __iomem *addr, unsigned offset, u8 data)
64 { __raw_writeb(data, addr + offset); }
66 static inline void dsps_writel(void __iomem *addr, unsigned offset, u32 data)
67 { __raw_writel(data, addr + offset); }
70 * DSPS musb wrapper register offset.
71 * FIXME: This should be expanded to have all the wrapper registers from TI DSPS
74 struct dsps_musb_wrapper {
88 /* bit positions for control */
91 /* bit positions for interrupt */
97 unsigned txep_shift:5;
101 unsigned rxep_shift:5;
105 /* bit positions for phy_utmi */
106 unsigned otg_disable:5;
108 /* bit positions for mode */
110 /* miscellaneous stuff */
111 u32 musb_core_offset;
113 /* number of musb instances */
118 * DSPS glue structure.
122 struct platform_device *musb[2]; /* child musb pdev */
123 const struct dsps_musb_wrapper *wrp; /* wrapper register offsets */
124 struct timer_list timer[2]; /* otg_workaround timer */
125 unsigned long last_timer[2]; /* last timer data for each instance */
126 u32 __iomem *usb_ctrl[2];
129 #define DSPS_AM33XX_CONTROL_MODULE_PHYS_0 0x44e10620
130 #define DSPS_AM33XX_CONTROL_MODULE_PHYS_1 0x44e10628
132 static const resource_size_t dsps_control_module_phys[] = {
133 DSPS_AM33XX_CONTROL_MODULE_PHYS_0,
134 DSPS_AM33XX_CONTROL_MODULE_PHYS_1,
137 #define USBPHY_CM_PWRDN (1 << 0)
138 #define USBPHY_OTG_PWRDN (1 << 1)
139 #define USBPHY_OTGVDET_EN (1 << 19)
140 #define USBPHY_OTGSESSEND_EN (1 << 20)
143 * musb_dsps_phy_control - phy on/off
144 * @glue: struct dsps_glue *
146 * @on: flag for phy to be switched on or off
148 * This is to enable the PHY using usb_ctrl register in system control
151 * XXX: This function will be removed once we have a seperate driver for
154 static void musb_dsps_phy_control(struct dsps_glue *glue, u8 id, u8 on)
158 usbphycfg = readl(glue->usb_ctrl[id]);
161 usbphycfg &= ~(USBPHY_CM_PWRDN | USBPHY_OTG_PWRDN);
162 usbphycfg |= USBPHY_OTGVDET_EN | USBPHY_OTGSESSEND_EN;
164 usbphycfg |= USBPHY_CM_PWRDN | USBPHY_OTG_PWRDN;
167 writel(usbphycfg, glue->usb_ctrl[id]);
170 * dsps_musb_enable - enable interrupts
172 static void dsps_musb_enable(struct musb *musb)
174 struct device *dev = musb->controller;
175 struct platform_device *pdev = to_platform_device(dev->parent);
176 struct dsps_glue *glue = platform_get_drvdata(pdev);
177 const struct dsps_musb_wrapper *wrp = glue->wrp;
178 void __iomem *reg_base = musb->ctrl_base;
179 u32 epmask, coremask;
181 /* Workaround: setup IRQs through both register sets. */
182 epmask = ((musb->epmask & wrp->txep_mask) << wrp->txep_shift) |
183 ((musb->epmask & wrp->rxep_mask) << wrp->rxep_shift);
184 coremask = (wrp->usb_bitmap & ~MUSB_INTR_SOF);
186 dsps_writel(reg_base, wrp->epintr_set, epmask);
187 dsps_writel(reg_base, wrp->coreintr_set, coremask);
188 /* Force the DRVVBUS IRQ so we can start polling for ID change. */
189 dsps_writel(reg_base, wrp->coreintr_set,
190 (1 << wrp->drvvbus) << wrp->usb_shift);
194 * dsps_musb_disable - disable HDRC and flush interrupts
196 static void dsps_musb_disable(struct musb *musb)
198 struct device *dev = musb->controller;
199 struct platform_device *pdev = to_platform_device(dev->parent);
200 struct dsps_glue *glue = platform_get_drvdata(pdev);
201 const struct dsps_musb_wrapper *wrp = glue->wrp;
202 void __iomem *reg_base = musb->ctrl_base;
204 dsps_writel(reg_base, wrp->coreintr_clear, wrp->usb_bitmap);
205 dsps_writel(reg_base, wrp->epintr_clear,
206 wrp->txep_bitmap | wrp->rxep_bitmap);
207 dsps_writeb(musb->mregs, MUSB_DEVCTL, 0);
208 dsps_writel(reg_base, wrp->eoi, 0);
211 static void otg_timer(unsigned long _musb)
213 struct musb *musb = (void *)_musb;
214 void __iomem *mregs = musb->mregs;
215 struct device *dev = musb->controller;
216 struct platform_device *pdev = to_platform_device(dev);
217 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
218 const struct dsps_musb_wrapper *wrp = glue->wrp;
223 * We poll because DSPS IP's won't expose several OTG-critical
224 * status change events (from the transceiver) otherwise.
226 devctl = dsps_readb(mregs, MUSB_DEVCTL);
227 dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
228 usb_otg_state_string(musb->xceiv->state));
230 spin_lock_irqsave(&musb->lock, flags);
231 switch (musb->xceiv->state) {
232 case OTG_STATE_A_WAIT_BCON:
233 devctl &= ~MUSB_DEVCTL_SESSION;
234 dsps_writeb(musb->mregs, MUSB_DEVCTL, devctl);
236 devctl = dsps_readb(musb->mregs, MUSB_DEVCTL);
237 if (devctl & MUSB_DEVCTL_BDEVICE) {
238 musb->xceiv->state = OTG_STATE_B_IDLE;
241 musb->xceiv->state = OTG_STATE_A_IDLE;
245 case OTG_STATE_A_WAIT_VFALL:
246 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
247 dsps_writel(musb->ctrl_base, wrp->coreintr_set,
248 MUSB_INTR_VBUSERROR << wrp->usb_shift);
250 case OTG_STATE_B_IDLE:
251 devctl = dsps_readb(mregs, MUSB_DEVCTL);
252 if (devctl & MUSB_DEVCTL_BDEVICE)
253 mod_timer(&glue->timer[pdev->id],
254 jiffies + wrp->poll_seconds * HZ);
256 musb->xceiv->state = OTG_STATE_A_IDLE;
261 spin_unlock_irqrestore(&musb->lock, flags);
264 static void dsps_musb_try_idle(struct musb *musb, unsigned long timeout)
266 struct device *dev = musb->controller;
267 struct platform_device *pdev = to_platform_device(dev);
268 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
271 timeout = jiffies + msecs_to_jiffies(3);
273 /* Never idle if active, or when VBUS timeout is not set as host */
274 if (musb->is_active || (musb->a_wait_bcon == 0 &&
275 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) {
276 dev_dbg(musb->controller, "%s active, deleting timer\n",
277 usb_otg_state_string(musb->xceiv->state));
278 del_timer(&glue->timer[pdev->id]);
279 glue->last_timer[pdev->id] = jiffies;
283 if (time_after(glue->last_timer[pdev->id], timeout) &&
284 timer_pending(&glue->timer[pdev->id])) {
285 dev_dbg(musb->controller,
286 "Longer idle timer already pending, ignoring...\n");
289 glue->last_timer[pdev->id] = timeout;
291 dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n",
292 usb_otg_state_string(musb->xceiv->state),
293 jiffies_to_msecs(timeout - jiffies));
294 mod_timer(&glue->timer[pdev->id], timeout);
297 static irqreturn_t dsps_interrupt(int irq, void *hci)
299 struct musb *musb = hci;
300 void __iomem *reg_base = musb->ctrl_base;
301 struct device *dev = musb->controller;
302 struct platform_device *pdev = to_platform_device(dev);
303 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
304 const struct dsps_musb_wrapper *wrp = glue->wrp;
306 irqreturn_t ret = IRQ_NONE;
309 spin_lock_irqsave(&musb->lock, flags);
311 /* Get endpoint interrupts */
312 epintr = dsps_readl(reg_base, wrp->epintr_status);
313 musb->int_rx = (epintr & wrp->rxep_bitmap) >> wrp->rxep_shift;
314 musb->int_tx = (epintr & wrp->txep_bitmap) >> wrp->txep_shift;
317 dsps_writel(reg_base, wrp->epintr_status, epintr);
319 /* Get usb core interrupts */
320 usbintr = dsps_readl(reg_base, wrp->coreintr_status);
321 if (!usbintr && !epintr)
324 musb->int_usb = (usbintr & wrp->usb_bitmap) >> wrp->usb_shift;
326 dsps_writel(reg_base, wrp->coreintr_status, usbintr);
328 dev_dbg(musb->controller, "usbintr (%x) epintr(%x)\n",
331 * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
332 * DSPS IP's missing ID change IRQ. We need an ID change IRQ to
333 * switch appropriately between halves of the OTG state machine.
334 * Managing DEVCTL.SESSION per Mentor docs requires that we know its
335 * value but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
336 * Also, DRVVBUS pulses for SRP (but not at 5V) ...
338 if (is_host_active(musb) && usbintr & MUSB_INTR_BABBLE)
339 pr_info("CAUTION: musb: Babble Interrupt Occurred\n");
341 if (usbintr & ((1 << wrp->drvvbus) << wrp->usb_shift)) {
342 int drvvbus = dsps_readl(reg_base, wrp->status);
343 void __iomem *mregs = musb->mregs;
344 u8 devctl = dsps_readb(mregs, MUSB_DEVCTL);
347 err = musb->int_usb & MUSB_INTR_VBUSERROR;
350 * The Mentor core doesn't debounce VBUS as needed
351 * to cope with device connect current spikes. This
352 * means it's not uncommon for bus-powered devices
353 * to get VBUS errors during enumeration.
355 * This is a workaround, but newer RTL from Mentor
356 * seems to allow a better one: "re"-starting sessions
357 * without waiting for VBUS to stop registering in
360 musb->int_usb &= ~MUSB_INTR_VBUSERROR;
361 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
362 mod_timer(&glue->timer[pdev->id],
363 jiffies + wrp->poll_seconds * HZ);
364 WARNING("VBUS error workaround (delay coming)\n");
365 } else if (drvvbus) {
368 musb->xceiv->otg->default_a = 1;
369 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
370 del_timer(&glue->timer[pdev->id]);
374 musb->xceiv->otg->default_a = 0;
375 musb->xceiv->state = OTG_STATE_B_IDLE;
378 /* NOTE: this must complete power-on within 100 ms. */
379 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
380 drvvbus ? "on" : "off",
381 usb_otg_state_string(musb->xceiv->state),
387 if (musb->int_tx || musb->int_rx || musb->int_usb)
388 ret |= musb_interrupt(musb);
391 /* EOI needs to be written for the IRQ to be re-asserted. */
392 if (ret == IRQ_HANDLED || epintr || usbintr)
393 dsps_writel(reg_base, wrp->eoi, 1);
395 /* Poll for ID change */
396 if (musb->xceiv->state == OTG_STATE_B_IDLE)
397 mod_timer(&glue->timer[pdev->id],
398 jiffies + wrp->poll_seconds * HZ);
400 spin_unlock_irqrestore(&musb->lock, flags);
405 static int dsps_musb_init(struct musb *musb)
407 struct device *dev = musb->controller;
408 struct platform_device *pdev = to_platform_device(dev);
409 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
410 const struct dsps_musb_wrapper *wrp = glue->wrp;
411 void __iomem *reg_base = musb->ctrl_base;
415 /* mentor core register starts at offset of 0x400 from musb base */
416 musb->mregs += wrp->musb_core_offset;
418 /* NOP driver needs change if supporting dual instance */
419 usb_nop_xceiv_register();
420 musb->xceiv = usb_get_phy(USB_PHY_TYPE_USB2);
421 if (IS_ERR_OR_NULL(musb->xceiv))
422 return -EPROBE_DEFER;
424 /* Returns zero if e.g. not clocked */
425 rev = dsps_readl(reg_base, wrp->revision);
431 setup_timer(&glue->timer[pdev->id], otg_timer, (unsigned long) musb);
434 dsps_writel(reg_base, wrp->control, (1 << wrp->reset));
436 /* Start the on-chip PHY and its PLL. */
437 musb_dsps_phy_control(glue, pdev->id, 1);
439 musb->isr = dsps_interrupt;
441 /* reset the otgdisable bit, needed for host mode to work */
442 val = dsps_readl(reg_base, wrp->phy_utmi);
443 val &= ~(1 << wrp->otg_disable);
444 dsps_writel(musb->ctrl_base, wrp->phy_utmi, val);
446 /* clear level interrupt */
447 dsps_writel(reg_base, wrp->eoi, 0);
451 usb_put_phy(musb->xceiv);
452 usb_nop_xceiv_unregister();
456 static int dsps_musb_exit(struct musb *musb)
458 struct device *dev = musb->controller;
459 struct platform_device *pdev = to_platform_device(dev);
460 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
462 del_timer_sync(&glue->timer[pdev->id]);
464 /* Shutdown the on-chip PHY and its PLL. */
465 musb_dsps_phy_control(glue, pdev->id, 0);
467 /* NOP driver needs change if supporting dual instance */
468 usb_put_phy(musb->xceiv);
469 usb_nop_xceiv_unregister();
474 static struct musb_platform_ops dsps_ops = {
475 .init = dsps_musb_init,
476 .exit = dsps_musb_exit,
478 .enable = dsps_musb_enable,
479 .disable = dsps_musb_disable,
481 .try_idle = dsps_musb_try_idle,
484 static u64 musb_dmamask = DMA_BIT_MASK(32);
486 static int dsps_create_musb_pdev(struct dsps_glue *glue, u8 id)
488 struct device *dev = glue->dev;
489 struct platform_device *pdev = to_platform_device(dev);
490 struct musb_hdrc_platform_data *pdata = dev->platform_data;
491 struct device_node *np = pdev->dev.of_node;
492 struct musb_hdrc_config *config;
493 struct platform_device *musb;
494 struct resource *res;
495 struct resource resources[2];
499 resources[0].start = dsps_control_module_phys[id];
500 resources[0].end = resources[0].start + SZ_4 - 1;
501 resources[0].flags = IORESOURCE_MEM;
503 glue->usb_ctrl[id] = devm_ioremap_resource(&pdev->dev, resources);
504 if (IS_ERR(glue->usb_ctrl[id])) {
505 ret = PTR_ERR(glue->usb_ctrl[id]);
509 /* first resource is for usbss, so start index from 1 */
510 res = platform_get_resource(pdev, IORESOURCE_MEM, id + 1);
512 dev_err(dev, "failed to get memory for instance %d\n", id);
519 /* first resource is for usbss, so start index from 1 */
520 res = platform_get_resource(pdev, IORESOURCE_IRQ, id + 1);
522 dev_err(dev, "failed to get irq for instance %d\n", id);
528 resources[1].name = "mc";
530 /* allocate the child platform device */
531 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO);
533 dev_err(dev, "failed to allocate musb device\n");
538 musb->dev.parent = dev;
539 musb->dev.dma_mask = &musb_dmamask;
540 musb->dev.coherent_dma_mask = musb_dmamask;
542 glue->musb[id] = musb;
544 ret = platform_device_add_resources(musb, resources, 2);
546 dev_err(dev, "failed to add resources\n");
551 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
554 "failed to allocate musb platfrom data\n");
559 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL);
562 "failed to allocate musb hdrc config\n");
566 of_property_read_u32(np, "num-eps", (u32 *)&config->num_eps);
567 of_property_read_u32(np, "ram-bits", (u32 *)&config->ram_bits);
568 snprintf(res_name, sizeof(res_name), "port%d-mode", id);
569 of_property_read_u32(np, res_name, (u32 *)&pdata->mode);
570 of_property_read_u32(np, "power", (u32 *)&pdata->power);
571 config->multipoint = of_property_read_bool(np, "multipoint");
573 pdata->config = config;
576 pdata->platform_ops = &dsps_ops;
578 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
580 dev_err(dev, "failed to add platform_data\n");
584 ret = platform_device_add(musb);
586 dev_err(dev, "failed to register musb device\n");
593 platform_device_put(musb);
598 static int dsps_probe(struct platform_device *pdev)
600 const struct of_device_id *match;
601 const struct dsps_musb_wrapper *wrp;
602 struct dsps_glue *glue;
603 struct resource *iomem;
606 match = of_match_node(musb_dsps_of_match, pdev->dev.of_node);
608 dev_err(&pdev->dev, "fail to get matching of_match struct\n");
615 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
617 dev_err(&pdev->dev, "unable to allocate glue memory\n");
622 /* get memory resource */
623 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
625 dev_err(&pdev->dev, "failed to get usbss mem resourse\n");
630 glue->dev = &pdev->dev;
632 glue->wrp = kmemdup(wrp, sizeof(*wrp), GFP_KERNEL);
634 dev_err(&pdev->dev, "failed to duplicate wrapper struct memory\n");
638 platform_set_drvdata(pdev, glue);
640 /* enable the usbss clocks */
641 pm_runtime_enable(&pdev->dev);
643 ret = pm_runtime_get_sync(&pdev->dev);
645 dev_err(&pdev->dev, "pm_runtime_get_sync FAILED");
649 /* create the child platform device for all instances of musb */
650 for (i = 0; i < wrp->instances ; i++) {
651 ret = dsps_create_musb_pdev(glue, i);
653 dev_err(&pdev->dev, "failed to create child pdev\n");
654 /* release resources of previously created instances */
655 for (i--; i >= 0 ; i--)
656 platform_device_unregister(glue->musb[i]);
664 pm_runtime_put(&pdev->dev);
666 pm_runtime_disable(&pdev->dev);
673 static int dsps_remove(struct platform_device *pdev)
675 struct dsps_glue *glue = platform_get_drvdata(pdev);
676 const struct dsps_musb_wrapper *wrp = glue->wrp;
679 /* delete the child platform device */
680 for (i = 0; i < wrp->instances ; i++)
681 platform_device_unregister(glue->musb[i]);
683 /* disable usbss clocks */
684 pm_runtime_put(&pdev->dev);
685 pm_runtime_disable(&pdev->dev);
691 #ifdef CONFIG_PM_SLEEP
692 static int dsps_suspend(struct device *dev)
694 struct platform_device *pdev = to_platform_device(dev->parent);
695 struct dsps_glue *glue = platform_get_drvdata(pdev);
696 const struct dsps_musb_wrapper *wrp = glue->wrp;
699 for (i = 0; i < wrp->instances; i++)
700 musb_dsps_phy_control(glue, i, 0);
705 static int dsps_resume(struct device *dev)
707 struct platform_device *pdev = to_platform_device(dev->parent);
708 struct dsps_glue *glue = platform_get_drvdata(pdev);
709 const struct dsps_musb_wrapper *wrp = glue->wrp;
712 for (i = 0; i < wrp->instances; i++)
713 musb_dsps_phy_control(glue, i, 1);
719 static SIMPLE_DEV_PM_OPS(dsps_pm_ops, dsps_suspend, dsps_resume);
721 static const struct dsps_musb_wrapper ti81xx_driver_data = {
727 .epintr_clear = 0x40,
728 .epintr_status = 0x30,
729 .coreintr_set = 0x3c,
730 .coreintr_clear = 0x44,
731 .coreintr_status = 0x34,
739 .usb_bitmap = (0x1ff << 0),
743 .txep_bitmap = (0xffff << 0),
746 .rxep_bitmap = (0xfffe << 16),
747 .musb_core_offset = 0x400,
752 static const struct platform_device_id musb_dsps_id_table[] = {
754 .name = "musb-ti81xx",
755 .driver_data = (kernel_ulong_t) &ti81xx_driver_data,
757 { }, /* Terminating Entry */
759 MODULE_DEVICE_TABLE(platform, musb_dsps_id_table);
762 static const struct of_device_id musb_dsps_of_match[] = {
763 { .compatible = "ti,musb-am33xx",
764 .data = (void *) &ti81xx_driver_data, },
767 MODULE_DEVICE_TABLE(of, musb_dsps_of_match);
770 static struct platform_driver dsps_usbss_driver = {
772 .remove = dsps_remove,
776 .of_match_table = of_match_ptr(musb_dsps_of_match),
778 .id_table = musb_dsps_id_table,
781 MODULE_DESCRIPTION("TI DSPS MUSB Glue Layer");
782 MODULE_AUTHOR("Ravi B <ravibabu@ti.com>");
783 MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>");
784 MODULE_LICENSE("GPL v2");
786 static int __init dsps_init(void)
788 return platform_driver_register(&dsps_usbss_driver);
790 subsys_initcall(dsps_init);
792 static void __exit dsps_exit(void)
794 platform_driver_unregister(&dsps_usbss_driver);
796 module_exit(dsps_exit);