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"
49 static const struct of_device_id musb_dsps_of_match[];
52 * avoid using musb_readx()/musb_writex() as glue layer should not be
53 * dependent on musb core layer symbols.
55 static inline u8 dsps_readb(const void __iomem *addr, unsigned offset)
56 { return __raw_readb(addr + offset); }
58 static inline u32 dsps_readl(const void __iomem *addr, unsigned offset)
59 { return __raw_readl(addr + offset); }
61 static inline void dsps_writeb(void __iomem *addr, unsigned offset, u8 data)
62 { __raw_writeb(data, addr + offset); }
64 static inline void dsps_writel(void __iomem *addr, unsigned offset, u32 data)
65 { __raw_writel(data, addr + offset); }
68 * DSPS musb wrapper register offset.
69 * FIXME: This should be expanded to have all the wrapper registers from TI DSPS
72 struct dsps_musb_wrapper {
86 /* bit positions for control */
89 /* bit positions for interrupt */
95 unsigned txep_shift:5;
99 unsigned rxep_shift:5;
103 /* bit positions for phy_utmi */
104 unsigned otg_disable:5;
106 /* bit positions for mode */
108 /* miscellaneous stuff */
109 u32 musb_core_offset;
111 /* number of musb instances */
116 * DSPS glue structure.
120 struct platform_device *musb[2]; /* child musb pdev */
121 const struct dsps_musb_wrapper *wrp; /* wrapper register offsets */
122 struct timer_list timer[2]; /* otg_workaround timer */
123 unsigned long last_timer[2]; /* last timer data for each instance */
124 u32 __iomem *usb_ctrl[2];
127 #define DSPS_AM33XX_CONTROL_MODULE_PHYS_0 0x44e10620
128 #define DSPS_AM33XX_CONTROL_MODULE_PHYS_1 0x44e10628
130 static const resource_size_t dsps_control_module_phys[] = {
131 DSPS_AM33XX_CONTROL_MODULE_PHYS_0,
132 DSPS_AM33XX_CONTROL_MODULE_PHYS_1,
135 #define USBPHY_CM_PWRDN (1 << 0)
136 #define USBPHY_OTG_PWRDN (1 << 1)
137 #define USBPHY_OTGVDET_EN (1 << 19)
138 #define USBPHY_OTGSESSEND_EN (1 << 20)
141 * musb_dsps_phy_control - phy on/off
142 * @glue: struct dsps_glue *
144 * @on: flag for phy to be switched on or off
146 * This is to enable the PHY using usb_ctrl register in system control
149 * XXX: This function will be removed once we have a seperate driver for
152 static void musb_dsps_phy_control(struct dsps_glue *glue, u8 id, u8 on)
156 usbphycfg = readl(glue->usb_ctrl[id]);
159 usbphycfg &= ~(USBPHY_CM_PWRDN | USBPHY_OTG_PWRDN);
160 usbphycfg |= USBPHY_OTGVDET_EN | USBPHY_OTGSESSEND_EN;
162 usbphycfg |= USBPHY_CM_PWRDN | USBPHY_OTG_PWRDN;
165 writel(usbphycfg, glue->usb_ctrl[id]);
168 * dsps_musb_enable - enable interrupts
170 static void dsps_musb_enable(struct musb *musb)
172 struct device *dev = musb->controller;
173 struct platform_device *pdev = to_platform_device(dev->parent);
174 struct dsps_glue *glue = platform_get_drvdata(pdev);
175 const struct dsps_musb_wrapper *wrp = glue->wrp;
176 void __iomem *reg_base = musb->ctrl_base;
177 u32 epmask, coremask;
179 /* Workaround: setup IRQs through both register sets. */
180 epmask = ((musb->epmask & wrp->txep_mask) << wrp->txep_shift) |
181 ((musb->epmask & wrp->rxep_mask) << wrp->rxep_shift);
182 coremask = (wrp->usb_bitmap & ~MUSB_INTR_SOF);
184 dsps_writel(reg_base, wrp->epintr_set, epmask);
185 dsps_writel(reg_base, wrp->coreintr_set, coremask);
186 /* Force the DRVVBUS IRQ so we can start polling for ID change. */
187 dsps_writel(reg_base, wrp->coreintr_set,
188 (1 << wrp->drvvbus) << wrp->usb_shift);
192 * dsps_musb_disable - disable HDRC and flush interrupts
194 static void dsps_musb_disable(struct musb *musb)
196 struct device *dev = musb->controller;
197 struct platform_device *pdev = to_platform_device(dev->parent);
198 struct dsps_glue *glue = platform_get_drvdata(pdev);
199 const struct dsps_musb_wrapper *wrp = glue->wrp;
200 void __iomem *reg_base = musb->ctrl_base;
202 dsps_writel(reg_base, wrp->coreintr_clear, wrp->usb_bitmap);
203 dsps_writel(reg_base, wrp->epintr_clear,
204 wrp->txep_bitmap | wrp->rxep_bitmap);
205 dsps_writeb(musb->mregs, MUSB_DEVCTL, 0);
206 dsps_writel(reg_base, wrp->eoi, 0);
209 static void otg_timer(unsigned long _musb)
211 struct musb *musb = (void *)_musb;
212 void __iomem *mregs = musb->mregs;
213 struct device *dev = musb->controller;
214 struct platform_device *pdev = to_platform_device(dev);
215 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
216 const struct dsps_musb_wrapper *wrp = glue->wrp;
221 * We poll because DSPS IP's won't expose several OTG-critical
222 * status change events (from the transceiver) otherwise.
224 devctl = dsps_readb(mregs, MUSB_DEVCTL);
225 dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
226 usb_otg_state_string(musb->xceiv->state));
228 spin_lock_irqsave(&musb->lock, flags);
229 switch (musb->xceiv->state) {
230 case OTG_STATE_A_WAIT_BCON:
231 devctl &= ~MUSB_DEVCTL_SESSION;
232 dsps_writeb(musb->mregs, MUSB_DEVCTL, devctl);
234 devctl = dsps_readb(musb->mregs, MUSB_DEVCTL);
235 if (devctl & MUSB_DEVCTL_BDEVICE) {
236 musb->xceiv->state = OTG_STATE_B_IDLE;
239 musb->xceiv->state = OTG_STATE_A_IDLE;
243 case OTG_STATE_A_WAIT_VFALL:
244 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
245 dsps_writel(musb->ctrl_base, wrp->coreintr_set,
246 MUSB_INTR_VBUSERROR << wrp->usb_shift);
248 case OTG_STATE_B_IDLE:
249 devctl = dsps_readb(mregs, MUSB_DEVCTL);
250 if (devctl & MUSB_DEVCTL_BDEVICE)
251 mod_timer(&glue->timer[pdev->id],
252 jiffies + wrp->poll_seconds * HZ);
254 musb->xceiv->state = OTG_STATE_A_IDLE;
259 spin_unlock_irqrestore(&musb->lock, flags);
262 static void dsps_musb_try_idle(struct musb *musb, unsigned long timeout)
264 struct device *dev = musb->controller;
265 struct platform_device *pdev = to_platform_device(dev);
266 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
269 timeout = jiffies + msecs_to_jiffies(3);
271 /* Never idle if active, or when VBUS timeout is not set as host */
272 if (musb->is_active || (musb->a_wait_bcon == 0 &&
273 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) {
274 dev_dbg(musb->controller, "%s active, deleting timer\n",
275 usb_otg_state_string(musb->xceiv->state));
276 del_timer(&glue->timer[pdev->id]);
277 glue->last_timer[pdev->id] = jiffies;
281 if (time_after(glue->last_timer[pdev->id], timeout) &&
282 timer_pending(&glue->timer[pdev->id])) {
283 dev_dbg(musb->controller,
284 "Longer idle timer already pending, ignoring...\n");
287 glue->last_timer[pdev->id] = timeout;
289 dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n",
290 usb_otg_state_string(musb->xceiv->state),
291 jiffies_to_msecs(timeout - jiffies));
292 mod_timer(&glue->timer[pdev->id], timeout);
295 static irqreturn_t dsps_interrupt(int irq, void *hci)
297 struct musb *musb = hci;
298 void __iomem *reg_base = musb->ctrl_base;
299 struct device *dev = musb->controller;
300 struct platform_device *pdev = to_platform_device(dev);
301 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
302 const struct dsps_musb_wrapper *wrp = glue->wrp;
304 irqreturn_t ret = IRQ_NONE;
307 spin_lock_irqsave(&musb->lock, flags);
309 /* Get endpoint interrupts */
310 epintr = dsps_readl(reg_base, wrp->epintr_status);
311 musb->int_rx = (epintr & wrp->rxep_bitmap) >> wrp->rxep_shift;
312 musb->int_tx = (epintr & wrp->txep_bitmap) >> wrp->txep_shift;
315 dsps_writel(reg_base, wrp->epintr_status, epintr);
317 /* Get usb core interrupts */
318 usbintr = dsps_readl(reg_base, wrp->coreintr_status);
319 if (!usbintr && !epintr)
322 musb->int_usb = (usbintr & wrp->usb_bitmap) >> wrp->usb_shift;
324 dsps_writel(reg_base, wrp->coreintr_status, usbintr);
326 dev_dbg(musb->controller, "usbintr (%x) epintr(%x)\n",
329 * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
330 * DSPS IP's missing ID change IRQ. We need an ID change IRQ to
331 * switch appropriately between halves of the OTG state machine.
332 * Managing DEVCTL.SESSION per Mentor docs requires that we know its
333 * value but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
334 * Also, DRVVBUS pulses for SRP (but not at 5V) ...
336 if (is_host_active(musb) && usbintr & MUSB_INTR_BABBLE)
337 pr_info("CAUTION: musb: Babble Interrupt Occurred\n");
339 if (usbintr & ((1 << wrp->drvvbus) << wrp->usb_shift)) {
340 int drvvbus = dsps_readl(reg_base, wrp->status);
341 void __iomem *mregs = musb->mregs;
342 u8 devctl = dsps_readb(mregs, MUSB_DEVCTL);
345 err = musb->int_usb & MUSB_INTR_VBUSERROR;
348 * The Mentor core doesn't debounce VBUS as needed
349 * to cope with device connect current spikes. This
350 * means it's not uncommon for bus-powered devices
351 * to get VBUS errors during enumeration.
353 * This is a workaround, but newer RTL from Mentor
354 * seems to allow a better one: "re"-starting sessions
355 * without waiting for VBUS to stop registering in
358 musb->int_usb &= ~MUSB_INTR_VBUSERROR;
359 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
360 mod_timer(&glue->timer[pdev->id],
361 jiffies + wrp->poll_seconds * HZ);
362 WARNING("VBUS error workaround (delay coming)\n");
363 } else if (drvvbus) {
366 musb->xceiv->otg->default_a = 1;
367 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
368 del_timer(&glue->timer[pdev->id]);
372 musb->xceiv->otg->default_a = 0;
373 musb->xceiv->state = OTG_STATE_B_IDLE;
376 /* NOTE: this must complete power-on within 100 ms. */
377 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
378 drvvbus ? "on" : "off",
379 usb_otg_state_string(musb->xceiv->state),
385 if (musb->int_tx || musb->int_rx || musb->int_usb)
386 ret |= musb_interrupt(musb);
389 /* EOI needs to be written for the IRQ to be re-asserted. */
390 if (ret == IRQ_HANDLED || epintr || usbintr)
391 dsps_writel(reg_base, wrp->eoi, 1);
393 /* Poll for ID change */
394 if (musb->xceiv->state == OTG_STATE_B_IDLE)
395 mod_timer(&glue->timer[pdev->id],
396 jiffies + wrp->poll_seconds * HZ);
398 spin_unlock_irqrestore(&musb->lock, flags);
403 static int dsps_musb_init(struct musb *musb)
405 struct device *dev = musb->controller;
406 struct platform_device *pdev = to_platform_device(dev);
407 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
408 const struct dsps_musb_wrapper *wrp = glue->wrp;
409 void __iomem *reg_base = musb->ctrl_base;
413 /* mentor core register starts at offset of 0x400 from musb base */
414 musb->mregs += wrp->musb_core_offset;
416 /* NOP driver needs change if supporting dual instance */
417 usb_nop_xceiv_register();
418 musb->xceiv = usb_get_phy(USB_PHY_TYPE_USB2);
419 if (IS_ERR_OR_NULL(musb->xceiv))
420 return -EPROBE_DEFER;
422 /* Returns zero if e.g. not clocked */
423 rev = dsps_readl(reg_base, wrp->revision);
429 usb_phy_init(musb->xceiv);
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);
466 usb_phy_shutdown(musb->xceiv);
468 /* NOP driver needs change if supporting dual instance */
469 usb_put_phy(musb->xceiv);
470 usb_nop_xceiv_unregister();
475 static struct musb_platform_ops dsps_ops = {
476 .init = dsps_musb_init,
477 .exit = dsps_musb_exit,
479 .enable = dsps_musb_enable,
480 .disable = dsps_musb_disable,
482 .try_idle = dsps_musb_try_idle,
485 static u64 musb_dmamask = DMA_BIT_MASK(32);
487 static int dsps_create_musb_pdev(struct dsps_glue *glue, u8 id)
489 struct device *dev = glue->dev;
490 struct platform_device *pdev = to_platform_device(dev);
491 struct musb_hdrc_platform_data *pdata = dev->platform_data;
492 struct device_node *np = pdev->dev.of_node;
493 struct musb_hdrc_config *config;
494 struct platform_device *musb;
495 struct resource *res;
496 struct resource resources[2];
500 resources[0].start = dsps_control_module_phys[id];
501 resources[0].end = resources[0].start + SZ_4 - 1;
502 resources[0].flags = IORESOURCE_MEM;
504 glue->usb_ctrl[id] = devm_ioremap_resource(&pdev->dev, resources);
505 if (IS_ERR(glue->usb_ctrl[id])) {
506 ret = PTR_ERR(glue->usb_ctrl[id]);
510 /* first resource is for usbss, so start index from 1 */
511 res = platform_get_resource(pdev, IORESOURCE_MEM, id + 1);
513 dev_err(dev, "failed to get memory for instance %d\n", id);
520 /* first resource is for usbss, so start index from 1 */
521 res = platform_get_resource(pdev, IORESOURCE_IRQ, id + 1);
523 dev_err(dev, "failed to get irq for instance %d\n", id);
529 resources[1].name = "mc";
531 /* allocate the child platform device */
532 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO);
534 dev_err(dev, "failed to allocate musb device\n");
539 musb->dev.parent = dev;
540 musb->dev.dma_mask = &musb_dmamask;
541 musb->dev.coherent_dma_mask = musb_dmamask;
543 glue->musb[id] = musb;
545 ret = platform_device_add_resources(musb, resources, 2);
547 dev_err(dev, "failed to add resources\n");
552 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
555 "failed to allocate musb platform data\n");
560 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL);
563 "failed to allocate musb hdrc config\n");
568 of_property_read_u32(np, "num-eps", (u32 *)&config->num_eps);
569 of_property_read_u32(np, "ram-bits", (u32 *)&config->ram_bits);
570 snprintf(res_name, sizeof(res_name), "port%d-mode", id);
571 of_property_read_u32(np, res_name, (u32 *)&pdata->mode);
572 of_property_read_u32(np, "power", (u32 *)&pdata->power);
573 config->multipoint = of_property_read_bool(np, "multipoint");
575 pdata->config = config;
578 pdata->platform_ops = &dsps_ops;
580 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
582 dev_err(dev, "failed to add platform_data\n");
586 ret = platform_device_add(musb);
588 dev_err(dev, "failed to register musb device\n");
595 platform_device_put(musb);
600 static int dsps_probe(struct platform_device *pdev)
602 const struct of_device_id *match;
603 const struct dsps_musb_wrapper *wrp;
604 struct dsps_glue *glue;
605 struct resource *iomem;
608 match = of_match_node(musb_dsps_of_match, pdev->dev.of_node);
610 dev_err(&pdev->dev, "fail to get matching of_match struct\n");
617 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
619 dev_err(&pdev->dev, "unable to allocate glue memory\n");
624 /* get memory resource */
625 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
627 dev_err(&pdev->dev, "failed to get usbss mem resourse\n");
632 glue->dev = &pdev->dev;
634 glue->wrp = kmemdup(wrp, sizeof(*wrp), GFP_KERNEL);
636 dev_err(&pdev->dev, "failed to duplicate wrapper struct memory\n");
640 platform_set_drvdata(pdev, glue);
642 /* enable the usbss clocks */
643 pm_runtime_enable(&pdev->dev);
645 ret = pm_runtime_get_sync(&pdev->dev);
647 dev_err(&pdev->dev, "pm_runtime_get_sync FAILED");
651 /* create the child platform device for all instances of musb */
652 for (i = 0; i < wrp->instances ; i++) {
653 ret = dsps_create_musb_pdev(glue, i);
655 dev_err(&pdev->dev, "failed to create child pdev\n");
656 /* release resources of previously created instances */
657 for (i--; i >= 0 ; i--)
658 platform_device_unregister(glue->musb[i]);
666 pm_runtime_put(&pdev->dev);
668 pm_runtime_disable(&pdev->dev);
675 static int dsps_remove(struct platform_device *pdev)
677 struct dsps_glue *glue = platform_get_drvdata(pdev);
678 const struct dsps_musb_wrapper *wrp = glue->wrp;
681 /* delete the child platform device */
682 for (i = 0; i < wrp->instances ; i++)
683 platform_device_unregister(glue->musb[i]);
685 /* disable usbss clocks */
686 pm_runtime_put(&pdev->dev);
687 pm_runtime_disable(&pdev->dev);
693 #ifdef CONFIG_PM_SLEEP
694 static int dsps_suspend(struct device *dev)
696 struct platform_device *pdev = to_platform_device(dev->parent);
697 struct dsps_glue *glue = platform_get_drvdata(pdev);
698 const struct dsps_musb_wrapper *wrp = glue->wrp;
701 for (i = 0; i < wrp->instances; i++)
702 musb_dsps_phy_control(glue, i, 0);
707 static int dsps_resume(struct device *dev)
709 struct platform_device *pdev = to_platform_device(dev->parent);
710 struct dsps_glue *glue = platform_get_drvdata(pdev);
711 const struct dsps_musb_wrapper *wrp = glue->wrp;
714 for (i = 0; i < wrp->instances; i++)
715 musb_dsps_phy_control(glue, i, 1);
721 static SIMPLE_DEV_PM_OPS(dsps_pm_ops, dsps_suspend, dsps_resume);
723 static const struct dsps_musb_wrapper ti81xx_driver_data = {
729 .epintr_clear = 0x40,
730 .epintr_status = 0x30,
731 .coreintr_set = 0x3c,
732 .coreintr_clear = 0x44,
733 .coreintr_status = 0x34,
741 .usb_bitmap = (0x1ff << 0),
745 .txep_bitmap = (0xffff << 0),
748 .rxep_bitmap = (0xfffe << 16),
749 .musb_core_offset = 0x400,
754 static const struct of_device_id musb_dsps_of_match[] = {
755 { .compatible = "ti,musb-am33xx",
756 .data = (void *) &ti81xx_driver_data, },
759 MODULE_DEVICE_TABLE(of, musb_dsps_of_match);
761 static struct platform_driver dsps_usbss_driver = {
763 .remove = dsps_remove,
767 .of_match_table = of_match_ptr(musb_dsps_of_match),
771 MODULE_DESCRIPTION("TI DSPS MUSB Glue Layer");
772 MODULE_AUTHOR("Ravi B <ravibabu@ti.com>");
773 MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>");
774 MODULE_LICENSE("GPL v2");
776 static int __init dsps_init(void)
778 return platform_driver_register(&dsps_usbss_driver);
780 subsys_initcall(dsps_init);
782 static void __exit dsps_exit(void)
784 platform_driver_unregister(&dsps_usbss_driver);
786 module_exit(dsps_exit);