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>
35 #include <linux/err.h>
36 #include <linux/platform_device.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/pm_runtime.h>
39 #include <linux/module.h>
40 #include <linux/usb/nop-usb-xceiv.h>
43 #include <linux/of_device.h>
44 #include <linux/of_address.h>
48 #include "musb_core.h"
51 static const struct of_device_id musb_dsps_of_match[];
55 * avoid using musb_readx()/musb_writex() as glue layer should not be
56 * dependent on musb core layer symbols.
58 static inline u8 dsps_readb(const void __iomem *addr, unsigned offset)
59 { return __raw_readb(addr + offset); }
61 static inline u32 dsps_readl(const void __iomem *addr, unsigned offset)
62 { return __raw_readl(addr + offset); }
64 static inline void dsps_writeb(void __iomem *addr, unsigned offset, u8 data)
65 { __raw_writeb(data, addr + offset); }
67 static inline void dsps_writel(void __iomem *addr, unsigned offset, u32 data)
68 { __raw_writel(data, addr + offset); }
71 * DSPS musb wrapper register offset.
72 * FIXME: This should be expanded to have all the wrapper registers from TI DSPS
75 struct dsps_musb_wrapper {
89 /* bit positions for control */
92 /* bit positions for interrupt */
98 unsigned txep_shift:5;
102 unsigned rxep_shift:5;
106 /* bit positions for phy_utmi */
107 unsigned otg_disable:5;
109 /* bit positions for mode */
111 /* miscellaneous stuff */
112 u32 musb_core_offset;
114 /* number of musb instances */
119 * DSPS glue structure.
123 struct platform_device *musb[2]; /* child musb pdev */
124 const struct dsps_musb_wrapper *wrp; /* wrapper register offsets */
125 struct timer_list timer[2]; /* otg_workaround timer */
126 unsigned long last_timer[2]; /* last timer data for each instance */
130 * dsps_musb_enable - enable interrupts
132 static void dsps_musb_enable(struct musb *musb)
134 struct device *dev = musb->controller;
135 struct platform_device *pdev = to_platform_device(dev->parent);
136 struct dsps_glue *glue = platform_get_drvdata(pdev);
137 const struct dsps_musb_wrapper *wrp = glue->wrp;
138 void __iomem *reg_base = musb->ctrl_base;
139 u32 epmask, coremask;
141 /* Workaround: setup IRQs through both register sets. */
142 epmask = ((musb->epmask & wrp->txep_mask) << wrp->txep_shift) |
143 ((musb->epmask & wrp->rxep_mask) << wrp->rxep_shift);
144 coremask = (wrp->usb_bitmap & ~MUSB_INTR_SOF);
146 dsps_writel(reg_base, wrp->epintr_set, epmask);
147 dsps_writel(reg_base, wrp->coreintr_set, coremask);
148 /* Force the DRVVBUS IRQ so we can start polling for ID change. */
149 dsps_writel(reg_base, wrp->coreintr_set,
150 (1 << wrp->drvvbus) << wrp->usb_shift);
154 * dsps_musb_disable - disable HDRC and flush interrupts
156 static void dsps_musb_disable(struct musb *musb)
158 struct device *dev = musb->controller;
159 struct platform_device *pdev = to_platform_device(dev->parent);
160 struct dsps_glue *glue = platform_get_drvdata(pdev);
161 const struct dsps_musb_wrapper *wrp = glue->wrp;
162 void __iomem *reg_base = musb->ctrl_base;
164 dsps_writel(reg_base, wrp->coreintr_clear, wrp->usb_bitmap);
165 dsps_writel(reg_base, wrp->epintr_clear,
166 wrp->txep_bitmap | wrp->rxep_bitmap);
167 dsps_writeb(musb->mregs, MUSB_DEVCTL, 0);
168 dsps_writel(reg_base, wrp->eoi, 0);
171 static void otg_timer(unsigned long _musb)
173 struct musb *musb = (void *)_musb;
174 void __iomem *mregs = musb->mregs;
175 struct device *dev = musb->controller;
176 struct platform_device *pdev = to_platform_device(dev);
177 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
178 const struct dsps_musb_wrapper *wrp = glue->wrp;
183 * We poll because DSPS IP's won't expose several OTG-critical
184 * status change events (from the transceiver) otherwise.
186 devctl = dsps_readb(mregs, MUSB_DEVCTL);
187 dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
188 otg_state_string(musb->xceiv->state));
190 spin_lock_irqsave(&musb->lock, flags);
191 switch (musb->xceiv->state) {
192 case OTG_STATE_A_WAIT_BCON:
193 devctl &= ~MUSB_DEVCTL_SESSION;
194 dsps_writeb(musb->mregs, MUSB_DEVCTL, devctl);
196 devctl = dsps_readb(musb->mregs, MUSB_DEVCTL);
197 if (devctl & MUSB_DEVCTL_BDEVICE) {
198 musb->xceiv->state = OTG_STATE_B_IDLE;
201 musb->xceiv->state = OTG_STATE_A_IDLE;
205 case OTG_STATE_A_WAIT_VFALL:
206 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
207 dsps_writel(musb->ctrl_base, wrp->coreintr_set,
208 MUSB_INTR_VBUSERROR << wrp->usb_shift);
210 case OTG_STATE_B_IDLE:
211 devctl = dsps_readb(mregs, MUSB_DEVCTL);
212 if (devctl & MUSB_DEVCTL_BDEVICE)
213 mod_timer(&glue->timer[pdev->id],
214 jiffies + wrp->poll_seconds * HZ);
216 musb->xceiv->state = OTG_STATE_A_IDLE;
221 spin_unlock_irqrestore(&musb->lock, flags);
224 static void dsps_musb_try_idle(struct musb *musb, unsigned long timeout)
226 struct device *dev = musb->controller;
227 struct platform_device *pdev = to_platform_device(dev);
228 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
231 timeout = jiffies + msecs_to_jiffies(3);
233 /* Never idle if active, or when VBUS timeout is not set as host */
234 if (musb->is_active || (musb->a_wait_bcon == 0 &&
235 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) {
236 dev_dbg(musb->controller, "%s active, deleting timer\n",
237 otg_state_string(musb->xceiv->state));
238 del_timer(&glue->timer[pdev->id]);
239 glue->last_timer[pdev->id] = jiffies;
243 if (time_after(glue->last_timer[pdev->id], timeout) &&
244 timer_pending(&glue->timer[pdev->id])) {
245 dev_dbg(musb->controller,
246 "Longer idle timer already pending, ignoring...\n");
249 glue->last_timer[pdev->id] = timeout;
251 dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n",
252 otg_state_string(musb->xceiv->state),
253 jiffies_to_msecs(timeout - jiffies));
254 mod_timer(&glue->timer[pdev->id], timeout);
257 static irqreturn_t dsps_interrupt(int irq, void *hci)
259 struct musb *musb = hci;
260 void __iomem *reg_base = musb->ctrl_base;
261 struct device *dev = musb->controller;
262 struct platform_device *pdev = to_platform_device(dev);
263 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
264 const struct dsps_musb_wrapper *wrp = glue->wrp;
266 irqreturn_t ret = IRQ_NONE;
269 spin_lock_irqsave(&musb->lock, flags);
271 /* Get endpoint interrupts */
272 epintr = dsps_readl(reg_base, wrp->epintr_status);
273 musb->int_rx = (epintr & wrp->rxep_bitmap) >> wrp->rxep_shift;
274 musb->int_tx = (epintr & wrp->txep_bitmap) >> wrp->txep_shift;
277 dsps_writel(reg_base, wrp->epintr_status, epintr);
279 /* Get usb core interrupts */
280 usbintr = dsps_readl(reg_base, wrp->coreintr_status);
281 if (!usbintr && !epintr)
284 musb->int_usb = (usbintr & wrp->usb_bitmap) >> wrp->usb_shift;
286 dsps_writel(reg_base, wrp->coreintr_status, usbintr);
288 dev_dbg(musb->controller, "usbintr (%x) epintr(%x)\n",
291 * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
292 * DSPS IP's missing ID change IRQ. We need an ID change IRQ to
293 * switch appropriately between halves of the OTG state machine.
294 * Managing DEVCTL.SESSION per Mentor docs requires that we know its
295 * value but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
296 * Also, DRVVBUS pulses for SRP (but not at 5V) ...
298 if (usbintr & MUSB_INTR_BABBLE)
299 pr_info("CAUTION: musb: Babble Interrupt Occured\n");
301 if (usbintr & ((1 << wrp->drvvbus) << wrp->usb_shift)) {
302 int drvvbus = dsps_readl(reg_base, wrp->status);
303 void __iomem *mregs = musb->mregs;
304 u8 devctl = dsps_readb(mregs, MUSB_DEVCTL);
307 err = musb->int_usb & MUSB_INTR_VBUSERROR;
310 * The Mentor core doesn't debounce VBUS as needed
311 * to cope with device connect current spikes. This
312 * means it's not uncommon for bus-powered devices
313 * to get VBUS errors during enumeration.
315 * This is a workaround, but newer RTL from Mentor
316 * seems to allow a better one: "re"-starting sessions
317 * without waiting for VBUS to stop registering in
320 musb->int_usb &= ~MUSB_INTR_VBUSERROR;
321 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
322 mod_timer(&glue->timer[pdev->id],
323 jiffies + wrp->poll_seconds * HZ);
324 WARNING("VBUS error workaround (delay coming)\n");
325 } else if (drvvbus) {
328 musb->xceiv->otg->default_a = 1;
329 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
330 del_timer(&glue->timer[pdev->id]);
334 musb->xceiv->otg->default_a = 0;
335 musb->xceiv->state = OTG_STATE_B_IDLE;
338 /* NOTE: this must complete power-on within 100 ms. */
339 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
340 drvvbus ? "on" : "off",
341 otg_state_string(musb->xceiv->state),
347 if (musb->int_tx || musb->int_rx || musb->int_usb)
348 ret |= musb_interrupt(musb);
351 /* EOI needs to be written for the IRQ to be re-asserted. */
352 if (ret == IRQ_HANDLED || epintr || usbintr)
353 dsps_writel(reg_base, wrp->eoi, 1);
355 /* Poll for ID change */
356 if (musb->xceiv->state == OTG_STATE_B_IDLE)
357 mod_timer(&glue->timer[pdev->id],
358 jiffies + wrp->poll_seconds * HZ);
360 spin_unlock_irqrestore(&musb->lock, flags);
365 static int dsps_musb_init(struct musb *musb)
367 struct device *dev = musb->controller;
368 struct musb_hdrc_platform_data *plat = dev->platform_data;
369 struct platform_device *pdev = to_platform_device(dev);
370 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
371 const struct dsps_musb_wrapper *wrp = glue->wrp;
372 struct omap_musb_board_data *data = plat->board_data;
373 void __iomem *reg_base = musb->ctrl_base;
377 /* mentor core register starts at offset of 0x400 from musb base */
378 musb->mregs += wrp->musb_core_offset;
380 /* Get the NOP PHY */
381 musb->xceiv = usb_get_phy(USB_PHY_TYPE_USB2);
382 if (IS_ERR_OR_NULL(musb->xceiv))
385 /* Returns zero if e.g. not clocked */
386 rev = dsps_readl(reg_base, wrp->revision);
392 setup_timer(&glue->timer[pdev->id], otg_timer, (unsigned long) musb);
395 dsps_writel(reg_base, wrp->control, (1 << wrp->reset));
397 /* Start the on-chip PHY and its PLL. */
398 if (data->set_phy_power)
399 data->set_phy_power(1);
401 musb->isr = dsps_interrupt;
403 /* reset the otgdisable bit, needed for host mode to work */
404 val = dsps_readl(reg_base, wrp->phy_utmi);
405 val &= ~(1 << wrp->otg_disable);
406 dsps_writel(musb->ctrl_base, wrp->phy_utmi, val);
408 /* clear level interrupt */
409 dsps_writel(reg_base, wrp->eoi, 0);
413 usb_put_phy(musb->xceiv);
414 usb_nop_xceiv_unregister();
418 static int dsps_musb_exit(struct musb *musb)
420 struct device *dev = musb->controller;
421 struct musb_hdrc_platform_data *plat = dev->platform_data;
422 struct omap_musb_board_data *data = plat->board_data;
423 struct platform_device *pdev = to_platform_device(dev);
424 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
426 del_timer_sync(&glue->timer[pdev->id]);
428 /* Shutdown the on-chip PHY and its PLL. */
429 if (data->set_phy_power)
430 data->set_phy_power(0);
432 /* NOP driver needs change if supporting dual instance */
433 usb_put_phy(musb->xceiv);
434 usb_nop_xceiv_unregister();
439 static struct musb_platform_ops dsps_ops = {
440 .init = dsps_musb_init,
441 .exit = dsps_musb_exit,
443 .enable = dsps_musb_enable,
444 .disable = dsps_musb_disable,
446 .try_idle = dsps_musb_try_idle,
449 static u64 musb_dmamask = DMA_BIT_MASK(32);
451 static int __devinit dsps_create_musb_pdev(struct dsps_glue *glue, u8 id)
453 struct device *dev = glue->dev;
454 struct platform_device *pdev = to_platform_device(dev);
455 struct musb_hdrc_platform_data *pdata = dev->platform_data;
456 struct device_node *np = pdev->dev.of_node;
457 struct musb_hdrc_config *config;
458 struct platform_device *musb;
459 struct resource *res;
460 struct resource resources[2];
464 /* get memory resource */
465 sprintf(res_name, "musb%d", id);
466 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, res_name);
468 dev_err(dev, "%s get mem resource failed\n", res_name);
475 /* get irq resource */
476 sprintf(res_name, "musb%d-irq", id);
477 res = platform_get_resource_byname(pdev, IORESOURCE_IRQ, res_name);
479 dev_err(dev, "%s get irq resource failed\n", res_name);
485 resources[1].name = "mc";
487 /* get the musb id */
488 musbid = musb_get_id(dev, GFP_KERNEL);
490 dev_err(dev, "failed to allocate musb id\n");
494 /* allocate the child platform device */
495 musb = platform_device_alloc("musb-hdrc", musbid);
497 dev_err(dev, "failed to allocate musb device\n");
503 musb->dev.parent = dev;
504 musb->dev.dma_mask = &musb_dmamask;
505 musb->dev.coherent_dma_mask = musb_dmamask;
507 glue->musb[id] = musb;
509 ret = platform_device_add_resources(musb, resources, 2);
511 dev_err(dev, "failed to add resources\n");
516 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
519 "failed to allocate musb platfrom data\n");
524 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL);
527 "failed to allocate musb hdrc config\n");
531 of_property_read_u32(np, "num-eps", (u32 *)&config->num_eps);
532 of_property_read_u32(np, "ram-bits", (u32 *)&config->ram_bits);
533 sprintf(res_name, "port%d-mode", id);
534 of_property_read_u32(np, res_name, (u32 *)&pdata->mode);
535 of_property_read_u32(np, "power", (u32 *)&pdata->power);
536 config->multipoint = of_property_read_bool(np, "multipoint");
538 pdata->config = config;
541 pdata->platform_ops = &dsps_ops;
543 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
545 dev_err(dev, "failed to add platform_data\n");
549 ret = platform_device_add(musb);
551 dev_err(dev, "failed to register musb device\n");
558 platform_device_put(musb);
560 musb_put_id(dev, musbid);
565 static void dsps_delete_musb_pdev(struct dsps_glue *glue, u8 id)
567 musb_put_id(glue->dev, glue->musb[id]->id);
568 platform_device_del(glue->musb[id]);
569 platform_device_put(glue->musb[id]);
572 static int __devinit dsps_probe(struct platform_device *pdev)
574 struct device_node *np = pdev->dev.of_node;
575 const struct of_device_id *match;
576 const struct dsps_musb_wrapper *wrp;
577 struct dsps_glue *glue;
578 struct resource *iomem;
581 match = of_match_node(musb_dsps_of_match, np);
583 dev_err(&pdev->dev, "fail to get matching of_match struct\n");
590 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
592 dev_err(&pdev->dev, "unable to allocate glue memory\n");
597 /* get memory resource */
598 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
600 dev_err(&pdev->dev, "failed to get usbss mem resourse\n");
605 glue->dev = &pdev->dev;
607 glue->wrp = kmemdup(wrp, sizeof(*wrp), GFP_KERNEL);
609 dev_err(&pdev->dev, "failed to duplicate wrapper struct memory\n");
613 platform_set_drvdata(pdev, glue);
615 /* enable the usbss clocks */
616 pm_runtime_enable(&pdev->dev);
618 ret = pm_runtime_get_sync(&pdev->dev);
620 dev_err(&pdev->dev, "pm_runtime_get_sync FAILED");
624 /* create the child platform device for all instances of musb */
625 for (i = 0; i < wrp->instances ; i++) {
626 ret = dsps_create_musb_pdev(glue, i);
628 dev_err(&pdev->dev, "failed to create child pdev\n");
629 /* release resources of previously created instances */
630 for (i--; i >= 0 ; i--)
631 dsps_delete_musb_pdev(glue, i);
639 pm_runtime_put(&pdev->dev);
641 pm_runtime_disable(&pdev->dev);
648 static int __devexit dsps_remove(struct platform_device *pdev)
650 struct dsps_glue *glue = platform_get_drvdata(pdev);
651 const struct dsps_musb_wrapper *wrp = glue->wrp;
654 /* delete the child platform device */
655 for (i = 0; i < wrp->instances ; i++)
656 dsps_delete_musb_pdev(glue, i);
658 /* disable usbss clocks */
659 pm_runtime_put(&pdev->dev);
660 pm_runtime_disable(&pdev->dev);
666 #ifdef CONFIG_PM_SLEEP
667 static int dsps_suspend(struct device *dev)
669 struct musb_hdrc_platform_data *plat = dev->platform_data;
670 struct omap_musb_board_data *data = plat->board_data;
672 /* Shutdown the on-chip PHY and its PLL. */
673 if (data->set_phy_power)
674 data->set_phy_power(0);
679 static int dsps_resume(struct device *dev)
681 struct musb_hdrc_platform_data *plat = dev->platform_data;
682 struct omap_musb_board_data *data = plat->board_data;
684 /* Start the on-chip PHY and its PLL. */
685 if (data->set_phy_power)
686 data->set_phy_power(1);
692 static SIMPLE_DEV_PM_OPS(dsps_pm_ops, dsps_suspend, dsps_resume);
694 static const struct dsps_musb_wrapper ti81xx_driver_data __devinitconst = {
700 .epintr_clear = 0x40,
701 .epintr_status = 0x30,
702 .coreintr_set = 0x3c,
703 .coreintr_clear = 0x44,
704 .coreintr_status = 0x34,
712 .usb_bitmap = (0x1ff << 0),
716 .txep_bitmap = (0xffff << 0),
719 .rxep_bitmap = (0xfffe << 16),
720 .musb_core_offset = 0x400,
725 static const struct platform_device_id musb_dsps_id_table[] __devinitconst = {
727 .name = "musb-ti81xx",
728 .driver_data = (kernel_ulong_t) &ti81xx_driver_data,
730 { }, /* Terminating Entry */
732 MODULE_DEVICE_TABLE(platform, musb_dsps_id_table);
735 static const struct of_device_id musb_dsps_of_match[] __devinitconst = {
736 { .compatible = "ti,musb-am33xx",
737 .data = (void *) &ti81xx_driver_data, },
740 MODULE_DEVICE_TABLE(of, musb_dsps_of_match);
743 static struct platform_driver dsps_usbss_driver = {
745 .remove = __devexit_p(dsps_remove),
749 .of_match_table = of_match_ptr(musb_dsps_of_match),
751 .id_table = musb_dsps_id_table,
754 MODULE_DESCRIPTION("TI DSPS MUSB Glue Layer");
755 MODULE_AUTHOR("Ravi B <ravibabu@ti.com>");
756 MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>");
757 MODULE_LICENSE("GPL v2");
759 static int __init dsps_init(void)
761 return platform_driver_register(&dsps_usbss_driver);
763 subsys_initcall(dsps_init);
765 static void __exit dsps_exit(void)
767 platform_driver_unregister(&dsps_usbss_driver);
769 module_exit(dsps_exit);