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>
42 #include <linux/of_device.h>
43 #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 */
129 * dsps_musb_enable - enable interrupts
131 static void dsps_musb_enable(struct musb *musb)
133 struct device *dev = musb->controller;
134 struct platform_device *pdev = to_platform_device(dev->parent);
135 struct dsps_glue *glue = platform_get_drvdata(pdev);
136 const struct dsps_musb_wrapper *wrp = glue->wrp;
137 void __iomem *reg_base = musb->ctrl_base;
138 u32 epmask, coremask;
140 /* Workaround: setup IRQs through both register sets. */
141 epmask = ((musb->epmask & wrp->txep_mask) << wrp->txep_shift) |
142 ((musb->epmask & wrp->rxep_mask) << wrp->rxep_shift);
143 coremask = (wrp->usb_bitmap & ~MUSB_INTR_SOF);
145 dsps_writel(reg_base, wrp->epintr_set, epmask);
146 dsps_writel(reg_base, wrp->coreintr_set, coremask);
147 /* Force the DRVVBUS IRQ so we can start polling for ID change. */
148 dsps_writel(reg_base, wrp->coreintr_set,
149 (1 << wrp->drvvbus) << wrp->usb_shift);
153 * dsps_musb_disable - disable HDRC and flush interrupts
155 static void dsps_musb_disable(struct musb *musb)
157 struct device *dev = musb->controller;
158 struct platform_device *pdev = to_platform_device(dev->parent);
159 struct dsps_glue *glue = platform_get_drvdata(pdev);
160 const struct dsps_musb_wrapper *wrp = glue->wrp;
161 void __iomem *reg_base = musb->ctrl_base;
163 dsps_writel(reg_base, wrp->coreintr_clear, wrp->usb_bitmap);
164 dsps_writel(reg_base, wrp->epintr_clear,
165 wrp->txep_bitmap | wrp->rxep_bitmap);
166 dsps_writeb(musb->mregs, MUSB_DEVCTL, 0);
167 dsps_writel(reg_base, wrp->eoi, 0);
170 static void otg_timer(unsigned long _musb)
172 struct musb *musb = (void *)_musb;
173 void __iomem *mregs = musb->mregs;
174 struct device *dev = musb->controller;
175 struct platform_device *pdev = to_platform_device(dev);
176 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
177 const struct dsps_musb_wrapper *wrp = glue->wrp;
182 * We poll because DSPS IP's won't expose several OTG-critical
183 * status change events (from the transceiver) otherwise.
185 devctl = dsps_readb(mregs, MUSB_DEVCTL);
186 dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
187 otg_state_string(musb->xceiv->state));
189 spin_lock_irqsave(&musb->lock, flags);
190 switch (musb->xceiv->state) {
191 case OTG_STATE_A_WAIT_BCON:
192 devctl &= ~MUSB_DEVCTL_SESSION;
193 dsps_writeb(musb->mregs, MUSB_DEVCTL, devctl);
195 devctl = dsps_readb(musb->mregs, MUSB_DEVCTL);
196 if (devctl & MUSB_DEVCTL_BDEVICE) {
197 musb->xceiv->state = OTG_STATE_B_IDLE;
200 musb->xceiv->state = OTG_STATE_A_IDLE;
204 case OTG_STATE_A_WAIT_VFALL:
205 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
206 dsps_writel(musb->ctrl_base, wrp->coreintr_set,
207 MUSB_INTR_VBUSERROR << wrp->usb_shift);
209 case OTG_STATE_B_IDLE:
210 devctl = dsps_readb(mregs, MUSB_DEVCTL);
211 if (devctl & MUSB_DEVCTL_BDEVICE)
212 mod_timer(&glue->timer[pdev->id],
213 jiffies + wrp->poll_seconds * HZ);
215 musb->xceiv->state = OTG_STATE_A_IDLE;
220 spin_unlock_irqrestore(&musb->lock, flags);
223 static void dsps_musb_try_idle(struct musb *musb, unsigned long timeout)
225 struct device *dev = musb->controller;
226 struct platform_device *pdev = to_platform_device(dev);
227 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
230 timeout = jiffies + msecs_to_jiffies(3);
232 /* Never idle if active, or when VBUS timeout is not set as host */
233 if (musb->is_active || (musb->a_wait_bcon == 0 &&
234 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) {
235 dev_dbg(musb->controller, "%s active, deleting timer\n",
236 otg_state_string(musb->xceiv->state));
237 del_timer(&glue->timer[pdev->id]);
238 glue->last_timer[pdev->id] = jiffies;
242 if (time_after(glue->last_timer[pdev->id], timeout) &&
243 timer_pending(&glue->timer[pdev->id])) {
244 dev_dbg(musb->controller,
245 "Longer idle timer already pending, ignoring...\n");
248 glue->last_timer[pdev->id] = timeout;
250 dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n",
251 otg_state_string(musb->xceiv->state),
252 jiffies_to_msecs(timeout - jiffies));
253 mod_timer(&glue->timer[pdev->id], timeout);
256 static irqreturn_t dsps_interrupt(int irq, void *hci)
258 struct musb *musb = hci;
259 void __iomem *reg_base = musb->ctrl_base;
260 struct device *dev = musb->controller;
261 struct platform_device *pdev = to_platform_device(dev);
262 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
263 const struct dsps_musb_wrapper *wrp = glue->wrp;
265 irqreturn_t ret = IRQ_NONE;
268 spin_lock_irqsave(&musb->lock, flags);
270 /* Get endpoint interrupts */
271 epintr = dsps_readl(reg_base, wrp->epintr_status);
272 musb->int_rx = (epintr & wrp->rxep_bitmap) >> wrp->rxep_shift;
273 musb->int_tx = (epintr & wrp->txep_bitmap) >> wrp->txep_shift;
276 dsps_writel(reg_base, wrp->epintr_status, epintr);
278 /* Get usb core interrupts */
279 usbintr = dsps_readl(reg_base, wrp->coreintr_status);
280 if (!usbintr && !epintr)
283 musb->int_usb = (usbintr & wrp->usb_bitmap) >> wrp->usb_shift;
285 dsps_writel(reg_base, wrp->coreintr_status, usbintr);
287 dev_dbg(musb->controller, "usbintr (%x) epintr(%x)\n",
290 * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
291 * DSPS IP's missing ID change IRQ. We need an ID change IRQ to
292 * switch appropriately between halves of the OTG state machine.
293 * Managing DEVCTL.SESSION per Mentor docs requires that we know its
294 * value but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
295 * Also, DRVVBUS pulses for SRP (but not at 5V) ...
297 if (usbintr & MUSB_INTR_BABBLE)
298 pr_info("CAUTION: musb: Babble Interrupt Occured\n");
300 if (usbintr & ((1 << wrp->drvvbus) << wrp->usb_shift)) {
301 int drvvbus = dsps_readl(reg_base, wrp->status);
302 void __iomem *mregs = musb->mregs;
303 u8 devctl = dsps_readb(mregs, MUSB_DEVCTL);
306 err = musb->int_usb & MUSB_INTR_VBUSERROR;
309 * The Mentor core doesn't debounce VBUS as needed
310 * to cope with device connect current spikes. This
311 * means it's not uncommon for bus-powered devices
312 * to get VBUS errors during enumeration.
314 * This is a workaround, but newer RTL from Mentor
315 * seems to allow a better one: "re"-starting sessions
316 * without waiting for VBUS to stop registering in
319 musb->int_usb &= ~MUSB_INTR_VBUSERROR;
320 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
321 mod_timer(&glue->timer[pdev->id],
322 jiffies + wrp->poll_seconds * HZ);
323 WARNING("VBUS error workaround (delay coming)\n");
324 } else if (drvvbus) {
327 musb->xceiv->otg->default_a = 1;
328 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
329 del_timer(&glue->timer[pdev->id]);
333 musb->xceiv->otg->default_a = 0;
334 musb->xceiv->state = OTG_STATE_B_IDLE;
337 /* NOTE: this must complete power-on within 100 ms. */
338 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
339 drvvbus ? "on" : "off",
340 otg_state_string(musb->xceiv->state),
346 if (musb->int_tx || musb->int_rx || musb->int_usb)
347 ret |= musb_interrupt(musb);
350 /* EOI needs to be written for the IRQ to be re-asserted. */
351 if (ret == IRQ_HANDLED || epintr || usbintr)
352 dsps_writel(reg_base, wrp->eoi, 1);
354 /* Poll for ID change */
355 if (musb->xceiv->state == OTG_STATE_B_IDLE)
356 mod_timer(&glue->timer[pdev->id],
357 jiffies + wrp->poll_seconds * HZ);
359 spin_unlock_irqrestore(&musb->lock, flags);
364 static int dsps_musb_init(struct musb *musb)
366 struct device *dev = musb->controller;
367 struct musb_hdrc_platform_data *plat = dev->platform_data;
368 struct platform_device *pdev = to_platform_device(dev);
369 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
370 const struct dsps_musb_wrapper *wrp = glue->wrp;
371 struct omap_musb_board_data *data = plat->board_data;
372 void __iomem *reg_base = musb->ctrl_base;
376 /* mentor core register starts at offset of 0x400 from musb base */
377 musb->mregs += wrp->musb_core_offset;
379 /* Get the NOP PHY */
380 musb->xceiv = usb_get_phy(USB_PHY_TYPE_USB2);
381 if (IS_ERR_OR_NULL(musb->xceiv))
384 /* Returns zero if e.g. not clocked */
385 rev = dsps_readl(reg_base, wrp->revision);
391 setup_timer(&glue->timer[pdev->id], otg_timer, (unsigned long) musb);
394 dsps_writel(reg_base, wrp->control, (1 << wrp->reset));
396 /* Start the on-chip PHY and its PLL. */
397 if (data->set_phy_power)
398 data->set_phy_power(1);
400 musb->isr = dsps_interrupt;
402 /* reset the otgdisable bit, needed for host mode to work */
403 val = dsps_readl(reg_base, wrp->phy_utmi);
404 val &= ~(1 << wrp->otg_disable);
405 dsps_writel(musb->ctrl_base, wrp->phy_utmi, val);
407 /* clear level interrupt */
408 dsps_writel(reg_base, wrp->eoi, 0);
412 usb_put_phy(musb->xceiv);
413 usb_nop_xceiv_unregister();
417 static int dsps_musb_exit(struct musb *musb)
419 struct device *dev = musb->controller;
420 struct musb_hdrc_platform_data *plat = dev->platform_data;
421 struct omap_musb_board_data *data = plat->board_data;
422 struct platform_device *pdev = to_platform_device(dev);
423 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
425 del_timer_sync(&glue->timer[pdev->id]);
427 /* Shutdown the on-chip PHY and its PLL. */
428 if (data->set_phy_power)
429 data->set_phy_power(0);
431 /* NOP driver needs change if supporting dual instance */
432 usb_put_phy(musb->xceiv);
433 usb_nop_xceiv_unregister();
438 static struct musb_platform_ops dsps_ops = {
439 .init = dsps_musb_init,
440 .exit = dsps_musb_exit,
442 .enable = dsps_musb_enable,
443 .disable = dsps_musb_disable,
445 .try_idle = dsps_musb_try_idle,
448 static u64 musb_dmamask = DMA_BIT_MASK(32);
450 static int __devinit dsps_create_musb_pdev(struct dsps_glue *glue, u8 id)
452 struct device *dev = glue->dev;
453 struct platform_device *pdev = to_platform_device(dev);
454 struct musb_hdrc_platform_data *pdata = dev->platform_data;
455 struct device_node *np = pdev->dev.of_node;
456 struct musb_hdrc_config *config;
457 struct platform_device *musb;
458 struct resource *res;
459 struct resource resources[2];
463 /* get memory resource */
464 sprintf(res_name, "musb%d", id);
465 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, res_name);
467 dev_err(dev, "%s get mem resource failed\n", res_name);
474 /* get irq resource */
475 sprintf(res_name, "musb%d-irq", id);
476 res = platform_get_resource_byname(pdev, IORESOURCE_IRQ, res_name);
478 dev_err(dev, "%s get irq resource failed\n", res_name);
482 strcpy((u8 *)res->name, "mc");
486 /* get the musb id */
487 musbid = musb_get_id(dev, GFP_KERNEL);
489 dev_err(dev, "failed to allocate musb id\n");
493 /* allocate the child platform device */
494 musb = platform_device_alloc("musb-hdrc", musbid);
496 dev_err(dev, "failed to allocate musb device\n");
502 musb->dev.parent = dev;
503 musb->dev.dma_mask = &musb_dmamask;
504 musb->dev.coherent_dma_mask = musb_dmamask;
506 glue->musb[id] = musb;
508 ret = platform_device_add_resources(musb, resources, 2);
510 dev_err(dev, "failed to add resources\n");
515 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
518 "failed to allocate musb platfrom data\n");
523 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL);
526 "failed to allocate musb hdrc config\n");
530 of_property_read_u32(np, "num-eps", (u32 *)&config->num_eps);
531 of_property_read_u32(np, "ram-bits", (u32 *)&config->ram_bits);
532 sprintf(res_name, "port%d-mode", id);
533 of_property_read_u32(np, res_name, (u32 *)&pdata->mode);
534 of_property_read_u32(np, "power", (u32 *)&pdata->power);
535 config->multipoint = of_property_read_bool(np, "multipoint");
537 pdata->config = config;
540 pdata->platform_ops = &dsps_ops;
542 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
544 dev_err(dev, "failed to add platform_data\n");
548 ret = platform_device_add(musb);
550 dev_err(dev, "failed to register musb device\n");
557 platform_device_put(musb);
559 musb_put_id(dev, musbid);
564 static void dsps_delete_musb_pdev(struct dsps_glue *glue, u8 id)
566 musb_put_id(glue->dev, glue->musb[id]->id);
567 platform_device_del(glue->musb[id]);
568 platform_device_put(glue->musb[id]);
571 static int __devinit dsps_probe(struct platform_device *pdev)
573 struct device_node *np = pdev->dev.of_node;
574 const struct of_device_id *match;
575 const struct dsps_musb_wrapper *wrp;
576 struct dsps_glue *glue;
577 struct resource *iomem;
580 match = of_match_node(musb_dsps_of_match, np);
582 dev_err(&pdev->dev, "fail to get matching of_match struct\n");
589 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
591 dev_err(&pdev->dev, "unable to allocate glue memory\n");
596 /* get memory resource */
597 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
599 dev_err(&pdev->dev, "failed to get usbss mem resourse\n");
604 glue->dev = &pdev->dev;
606 glue->wrp = kmemdup(wrp, sizeof(*wrp), GFP_KERNEL);
608 dev_err(&pdev->dev, "failed to duplicate wrapper struct memory\n");
612 platform_set_drvdata(pdev, glue);
614 /* create the child platform device for first instances of musb */
615 ret = dsps_create_musb_pdev(glue, 0);
617 dev_err(&pdev->dev, "failed to create child pdev\n");
621 /* enable the usbss clocks */
622 pm_runtime_enable(&pdev->dev);
624 ret = pm_runtime_get_sync(&pdev->dev);
626 dev_err(&pdev->dev, "pm_runtime_get_sync FAILED");
627 /* create the child platform device for all instances of musb */
628 for (i = 0; i < wrp->instances ; i++) {
629 ret = dsps_create_musb_pdev(glue, i);
631 dev_err(&pdev->dev, "failed to create child pdev\n");
632 /* release resources of previously created instances */
633 for (i--; i >= 0 ; i--)
634 dsps_delete_musb_pdev(glue, i);
642 pm_runtime_disable(&pdev->dev);
650 static int __devexit dsps_remove(struct platform_device *pdev)
652 struct dsps_glue *glue = platform_get_drvdata(pdev);
653 const struct dsps_musb_wrapper *wrp = glue->wrp;
656 /* delete the child platform device */
657 for (i = 0; i < wrp->instances ; i++)
658 dsps_delete_musb_pdev(glue, i);
660 /* disable usbss clocks */
661 pm_runtime_put(&pdev->dev);
662 pm_runtime_disable(&pdev->dev);
668 #ifdef CONFIG_PM_SLEEP
669 static int dsps_suspend(struct device *dev)
671 struct musb_hdrc_platform_data *plat = dev->platform_data;
672 struct omap_musb_board_data *data = plat->board_data;
674 /* Shutdown the on-chip PHY and its PLL. */
675 if (data->set_phy_power)
676 data->set_phy_power(0);
681 static int dsps_resume(struct device *dev)
683 struct musb_hdrc_platform_data *plat = dev->platform_data;
684 struct omap_musb_board_data *data = plat->board_data;
686 /* Start the on-chip PHY and its PLL. */
687 if (data->set_phy_power)
688 data->set_phy_power(1);
694 static SIMPLE_DEV_PM_OPS(dsps_pm_ops, dsps_suspend, dsps_resume);
696 static const struct dsps_musb_wrapper ti81xx_driver_data __devinitconst = {
702 .epintr_clear = 0x40,
703 .epintr_status = 0x30,
704 .coreintr_set = 0x3c,
705 .coreintr_clear = 0x44,
706 .coreintr_status = 0x34,
714 .usb_bitmap = (0x1ff << 0),
718 .txep_bitmap = (0xffff << 0),
721 .rxep_bitmap = (0xfffe << 16),
722 .musb_core_offset = 0x400,
727 static const struct platform_device_id musb_dsps_id_table[] __devinitconst = {
729 .name = "musb-ti81xx",
730 .driver_data = (kernel_ulong_t) &ti81xx_driver_data,
732 { }, /* Terminating Entry */
734 MODULE_DEVICE_TABLE(platform, musb_dsps_id_table);
737 static const struct of_device_id musb_dsps_of_match[] __devinitconst = {
738 { .compatible = "ti,musb-am33xx",
739 .data = (void *) &ti81xx_driver_data, },
742 MODULE_DEVICE_TABLE(of, musb_dsps_of_match);
745 static struct platform_driver dsps_usbss_driver = {
747 .remove = __devexit_p(dsps_remove),
751 .of_match_table = of_match_ptr(musb_dsps_of_match),
753 .id_table = musb_dsps_id_table,
756 MODULE_DESCRIPTION("TI DSPS MUSB Glue Layer");
757 MODULE_AUTHOR("Ravi B <ravibabu@ti.com>");
758 MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>");
759 MODULE_LICENSE("GPL v2");
761 static int __init dsps_init(void)
763 return platform_driver_register(&dsps_usbss_driver);
765 subsys_initcall(dsps_init);
767 static void __exit dsps_exit(void)
769 platform_driver_unregister(&dsps_usbss_driver);
771 module_exit(dsps_exit);