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 {
85 /* bit positions for control */
88 /* bit positions for interrupt */
94 unsigned txep_shift:5;
98 unsigned rxep_shift:5;
102 /* bit positions for phy_utmi */
103 unsigned otg_disable:5;
105 /* bit positions for mode */
107 /* miscellaneous stuff */
108 u32 musb_core_offset;
110 /* number of musb instances */
115 * DSPS glue structure.
119 struct platform_device *musb[2]; /* child musb pdev */
120 const struct dsps_musb_wrapper *wrp; /* wrapper register offsets */
121 struct timer_list timer[2]; /* otg_workaround timer */
122 unsigned long last_timer[2]; /* last timer data for each instance */
123 u32 __iomem *usb_ctrl[2];
126 #define DSPS_AM33XX_CONTROL_MODULE_PHYS_0 0x44e10620
127 #define DSPS_AM33XX_CONTROL_MODULE_PHYS_1 0x44e10628
129 static const resource_size_t dsps_control_module_phys[] = {
130 DSPS_AM33XX_CONTROL_MODULE_PHYS_0,
131 DSPS_AM33XX_CONTROL_MODULE_PHYS_1,
134 #define USBPHY_CM_PWRDN (1 << 0)
135 #define USBPHY_OTG_PWRDN (1 << 1)
136 #define USBPHY_OTGVDET_EN (1 << 19)
137 #define USBPHY_OTGSESSEND_EN (1 << 20)
140 * musb_dsps_phy_control - phy on/off
141 * @glue: struct dsps_glue *
143 * @on: flag for phy to be switched on or off
145 * This is to enable the PHY using usb_ctrl register in system control
148 * XXX: This function will be removed once we have a seperate driver for
151 static void musb_dsps_phy_control(struct dsps_glue *glue, u8 id, u8 on)
155 usbphycfg = readl(glue->usb_ctrl[id]);
158 usbphycfg &= ~(USBPHY_CM_PWRDN | USBPHY_OTG_PWRDN);
159 usbphycfg |= USBPHY_OTGVDET_EN | USBPHY_OTGSESSEND_EN;
161 usbphycfg |= USBPHY_CM_PWRDN | USBPHY_OTG_PWRDN;
164 writel(usbphycfg, glue->usb_ctrl[id]);
167 * dsps_musb_enable - enable interrupts
169 static void dsps_musb_enable(struct musb *musb)
171 struct device *dev = musb->controller;
172 struct platform_device *pdev = to_platform_device(dev->parent);
173 struct dsps_glue *glue = platform_get_drvdata(pdev);
174 const struct dsps_musb_wrapper *wrp = glue->wrp;
175 void __iomem *reg_base = musb->ctrl_base;
176 u32 epmask, coremask;
178 /* Workaround: setup IRQs through both register sets. */
179 epmask = ((musb->epmask & wrp->txep_mask) << wrp->txep_shift) |
180 ((musb->epmask & wrp->rxep_mask) << wrp->rxep_shift);
181 coremask = (wrp->usb_bitmap & ~MUSB_INTR_SOF);
183 dsps_writel(reg_base, wrp->epintr_set, epmask);
184 dsps_writel(reg_base, wrp->coreintr_set, coremask);
185 /* Force the DRVVBUS IRQ so we can start polling for ID change. */
186 dsps_writel(reg_base, wrp->coreintr_set,
187 (1 << wrp->drvvbus) << wrp->usb_shift);
191 * dsps_musb_disable - disable HDRC and flush interrupts
193 static void dsps_musb_disable(struct musb *musb)
195 struct device *dev = musb->controller;
196 struct platform_device *pdev = to_platform_device(dev->parent);
197 struct dsps_glue *glue = platform_get_drvdata(pdev);
198 const struct dsps_musb_wrapper *wrp = glue->wrp;
199 void __iomem *reg_base = musb->ctrl_base;
201 dsps_writel(reg_base, wrp->coreintr_clear, wrp->usb_bitmap);
202 dsps_writel(reg_base, wrp->epintr_clear,
203 wrp->txep_bitmap | wrp->rxep_bitmap);
204 dsps_writeb(musb->mregs, MUSB_DEVCTL, 0);
207 static void otg_timer(unsigned long _musb)
209 struct musb *musb = (void *)_musb;
210 void __iomem *mregs = musb->mregs;
211 struct device *dev = musb->controller;
212 struct platform_device *pdev = to_platform_device(dev);
213 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
214 const struct dsps_musb_wrapper *wrp = glue->wrp;
219 * We poll because DSPS IP's won't expose several OTG-critical
220 * status change events (from the transceiver) otherwise.
222 devctl = dsps_readb(mregs, MUSB_DEVCTL);
223 dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
224 usb_otg_state_string(musb->xceiv->state));
226 spin_lock_irqsave(&musb->lock, flags);
227 switch (musb->xceiv->state) {
228 case OTG_STATE_A_WAIT_BCON:
229 devctl &= ~MUSB_DEVCTL_SESSION;
230 dsps_writeb(musb->mregs, MUSB_DEVCTL, devctl);
232 devctl = dsps_readb(musb->mregs, MUSB_DEVCTL);
233 if (devctl & MUSB_DEVCTL_BDEVICE) {
234 musb->xceiv->state = OTG_STATE_B_IDLE;
237 musb->xceiv->state = OTG_STATE_A_IDLE;
241 case OTG_STATE_A_WAIT_VFALL:
242 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
243 dsps_writel(musb->ctrl_base, wrp->coreintr_set,
244 MUSB_INTR_VBUSERROR << wrp->usb_shift);
246 case OTG_STATE_B_IDLE:
247 devctl = dsps_readb(mregs, MUSB_DEVCTL);
248 if (devctl & MUSB_DEVCTL_BDEVICE)
249 mod_timer(&glue->timer[pdev->id],
250 jiffies + wrp->poll_seconds * HZ);
252 musb->xceiv->state = OTG_STATE_A_IDLE;
257 spin_unlock_irqrestore(&musb->lock, flags);
260 static void dsps_musb_try_idle(struct musb *musb, unsigned long timeout)
262 struct device *dev = musb->controller;
263 struct platform_device *pdev = to_platform_device(dev);
264 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
267 timeout = jiffies + msecs_to_jiffies(3);
269 /* Never idle if active, or when VBUS timeout is not set as host */
270 if (musb->is_active || (musb->a_wait_bcon == 0 &&
271 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) {
272 dev_dbg(musb->controller, "%s active, deleting timer\n",
273 usb_otg_state_string(musb->xceiv->state));
274 del_timer(&glue->timer[pdev->id]);
275 glue->last_timer[pdev->id] = jiffies;
279 if (time_after(glue->last_timer[pdev->id], timeout) &&
280 timer_pending(&glue->timer[pdev->id])) {
281 dev_dbg(musb->controller,
282 "Longer idle timer already pending, ignoring...\n");
285 glue->last_timer[pdev->id] = timeout;
287 dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n",
288 usb_otg_state_string(musb->xceiv->state),
289 jiffies_to_msecs(timeout - jiffies));
290 mod_timer(&glue->timer[pdev->id], timeout);
293 static irqreturn_t dsps_interrupt(int irq, void *hci)
295 struct musb *musb = hci;
296 void __iomem *reg_base = musb->ctrl_base;
297 struct device *dev = musb->controller;
298 struct platform_device *pdev = to_platform_device(dev);
299 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
300 const struct dsps_musb_wrapper *wrp = glue->wrp;
302 irqreturn_t ret = IRQ_NONE;
305 spin_lock_irqsave(&musb->lock, flags);
307 /* Get endpoint interrupts */
308 epintr = dsps_readl(reg_base, wrp->epintr_status);
309 musb->int_rx = (epintr & wrp->rxep_bitmap) >> wrp->rxep_shift;
310 musb->int_tx = (epintr & wrp->txep_bitmap) >> wrp->txep_shift;
313 dsps_writel(reg_base, wrp->epintr_status, epintr);
315 /* Get usb core interrupts */
316 usbintr = dsps_readl(reg_base, wrp->coreintr_status);
317 if (!usbintr && !epintr)
320 musb->int_usb = (usbintr & wrp->usb_bitmap) >> wrp->usb_shift;
322 dsps_writel(reg_base, wrp->coreintr_status, usbintr);
324 dev_dbg(musb->controller, "usbintr (%x) epintr(%x)\n",
327 * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
328 * DSPS IP's missing ID change IRQ. We need an ID change IRQ to
329 * switch appropriately between halves of the OTG state machine.
330 * Managing DEVCTL.SESSION per Mentor docs requires that we know its
331 * value but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
332 * Also, DRVVBUS pulses for SRP (but not at 5V) ...
334 if (is_host_active(musb) && usbintr & MUSB_INTR_BABBLE)
335 pr_info("CAUTION: musb: Babble Interrupt Occurred\n");
337 if (usbintr & ((1 << wrp->drvvbus) << wrp->usb_shift)) {
338 int drvvbus = dsps_readl(reg_base, wrp->status);
339 void __iomem *mregs = musb->mregs;
340 u8 devctl = dsps_readb(mregs, MUSB_DEVCTL);
343 err = musb->int_usb & MUSB_INTR_VBUSERROR;
346 * The Mentor core doesn't debounce VBUS as needed
347 * to cope with device connect current spikes. This
348 * means it's not uncommon for bus-powered devices
349 * to get VBUS errors during enumeration.
351 * This is a workaround, but newer RTL from Mentor
352 * seems to allow a better one: "re"-starting sessions
353 * without waiting for VBUS to stop registering in
356 musb->int_usb &= ~MUSB_INTR_VBUSERROR;
357 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
358 mod_timer(&glue->timer[pdev->id],
359 jiffies + wrp->poll_seconds * HZ);
360 WARNING("VBUS error workaround (delay coming)\n");
361 } else if (drvvbus) {
364 musb->xceiv->otg->default_a = 1;
365 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
366 del_timer(&glue->timer[pdev->id]);
370 musb->xceiv->otg->default_a = 0;
371 musb->xceiv->state = OTG_STATE_B_IDLE;
374 /* NOTE: this must complete power-on within 100 ms. */
375 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
376 drvvbus ? "on" : "off",
377 usb_otg_state_string(musb->xceiv->state),
383 if (musb->int_tx || musb->int_rx || musb->int_usb)
384 ret |= musb_interrupt(musb);
386 /* Poll for ID change */
387 if (musb->xceiv->state == OTG_STATE_B_IDLE)
388 mod_timer(&glue->timer[pdev->id],
389 jiffies + wrp->poll_seconds * HZ);
391 spin_unlock_irqrestore(&musb->lock, flags);
396 static int dsps_musb_init(struct musb *musb)
398 struct device *dev = musb->controller;
399 struct platform_device *pdev = to_platform_device(dev);
400 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
401 const struct dsps_musb_wrapper *wrp = glue->wrp;
402 void __iomem *reg_base = musb->ctrl_base;
406 /* mentor core register starts at offset of 0x400 from musb base */
407 musb->mregs += wrp->musb_core_offset;
409 /* NOP driver needs change if supporting dual instance */
410 usb_nop_xceiv_register();
411 musb->xceiv = usb_get_phy(USB_PHY_TYPE_USB2);
412 if (IS_ERR_OR_NULL(musb->xceiv))
413 return -EPROBE_DEFER;
415 /* Returns zero if e.g. not clocked */
416 rev = dsps_readl(reg_base, wrp->revision);
422 usb_phy_init(musb->xceiv);
424 setup_timer(&glue->timer[pdev->id], otg_timer, (unsigned long) musb);
427 dsps_writel(reg_base, wrp->control, (1 << wrp->reset));
429 /* Start the on-chip PHY and its PLL. */
430 musb_dsps_phy_control(glue, pdev->id, 1);
432 musb->isr = dsps_interrupt;
434 /* reset the otgdisable bit, needed for host mode to work */
435 val = dsps_readl(reg_base, wrp->phy_utmi);
436 val &= ~(1 << wrp->otg_disable);
437 dsps_writel(musb->ctrl_base, wrp->phy_utmi, val);
441 usb_put_phy(musb->xceiv);
442 usb_nop_xceiv_unregister();
446 static int dsps_musb_exit(struct musb *musb)
448 struct device *dev = musb->controller;
449 struct platform_device *pdev = to_platform_device(dev);
450 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
452 del_timer_sync(&glue->timer[pdev->id]);
454 /* Shutdown the on-chip PHY and its PLL. */
455 musb_dsps_phy_control(glue, pdev->id, 0);
456 usb_phy_shutdown(musb->xceiv);
458 /* NOP driver needs change if supporting dual instance */
459 usb_put_phy(musb->xceiv);
460 usb_nop_xceiv_unregister();
465 static struct musb_platform_ops dsps_ops = {
466 .init = dsps_musb_init,
467 .exit = dsps_musb_exit,
469 .enable = dsps_musb_enable,
470 .disable = dsps_musb_disable,
472 .try_idle = dsps_musb_try_idle,
475 static u64 musb_dmamask = DMA_BIT_MASK(32);
477 static int dsps_create_musb_pdev(struct dsps_glue *glue, u8 id)
479 struct device *dev = glue->dev;
480 struct platform_device *pdev = to_platform_device(dev);
481 struct musb_hdrc_platform_data *pdata = dev->platform_data;
482 struct device_node *np = pdev->dev.of_node;
483 struct musb_hdrc_config *config;
484 struct platform_device *musb;
485 struct resource *res;
486 struct resource resources[2];
490 resources[0].start = dsps_control_module_phys[id];
491 resources[0].end = resources[0].start + SZ_4 - 1;
492 resources[0].flags = IORESOURCE_MEM;
494 glue->usb_ctrl[id] = devm_ioremap_resource(&pdev->dev, resources);
495 if (IS_ERR(glue->usb_ctrl[id])) {
496 ret = PTR_ERR(glue->usb_ctrl[id]);
500 /* first resource is for usbss, so start index from 1 */
501 res = platform_get_resource(pdev, IORESOURCE_MEM, id + 1);
503 dev_err(dev, "failed to get memory for instance %d\n", id);
510 /* first resource is for usbss, so start index from 1 */
511 res = platform_get_resource(pdev, IORESOURCE_IRQ, id + 1);
513 dev_err(dev, "failed to get irq for instance %d\n", id);
519 resources[1].name = "mc";
521 /* allocate the child platform device */
522 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO);
524 dev_err(dev, "failed to allocate musb device\n");
529 musb->dev.parent = dev;
530 musb->dev.dma_mask = &musb_dmamask;
531 musb->dev.coherent_dma_mask = musb_dmamask;
533 glue->musb[id] = musb;
535 ret = platform_device_add_resources(musb, resources, 2);
537 dev_err(dev, "failed to add resources\n");
542 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
545 "failed to allocate musb platform data\n");
550 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL);
553 "failed to allocate musb hdrc config\n");
558 of_property_read_u32(np, "num-eps", (u32 *)&config->num_eps);
559 of_property_read_u32(np, "ram-bits", (u32 *)&config->ram_bits);
560 snprintf(res_name, sizeof(res_name), "port%d-mode", id);
561 of_property_read_u32(np, res_name, (u32 *)&pdata->mode);
562 of_property_read_u32(np, "power", (u32 *)&pdata->power);
563 config->multipoint = of_property_read_bool(np, "multipoint");
565 pdata->config = config;
568 pdata->platform_ops = &dsps_ops;
570 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
572 dev_err(dev, "failed to add platform_data\n");
576 ret = platform_device_add(musb);
578 dev_err(dev, "failed to register musb device\n");
585 platform_device_put(musb);
590 static int dsps_probe(struct platform_device *pdev)
592 const struct of_device_id *match;
593 const struct dsps_musb_wrapper *wrp;
594 struct dsps_glue *glue;
595 struct resource *iomem;
598 match = of_match_node(musb_dsps_of_match, pdev->dev.of_node);
600 dev_err(&pdev->dev, "fail to get matching of_match struct\n");
607 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
609 dev_err(&pdev->dev, "unable to allocate glue memory\n");
614 /* get memory resource */
615 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
617 dev_err(&pdev->dev, "failed to get usbss mem resourse\n");
622 glue->dev = &pdev->dev;
624 glue->wrp = kmemdup(wrp, sizeof(*wrp), GFP_KERNEL);
626 dev_err(&pdev->dev, "failed to duplicate wrapper struct memory\n");
630 platform_set_drvdata(pdev, glue);
632 /* enable the usbss clocks */
633 pm_runtime_enable(&pdev->dev);
635 ret = pm_runtime_get_sync(&pdev->dev);
637 dev_err(&pdev->dev, "pm_runtime_get_sync FAILED");
641 /* create the child platform device for all instances of musb */
642 for (i = 0; i < wrp->instances ; i++) {
643 ret = dsps_create_musb_pdev(glue, i);
645 dev_err(&pdev->dev, "failed to create child pdev\n");
646 /* release resources of previously created instances */
647 for (i--; i >= 0 ; i--)
648 platform_device_unregister(glue->musb[i]);
656 pm_runtime_put(&pdev->dev);
658 pm_runtime_disable(&pdev->dev);
665 static int dsps_remove(struct platform_device *pdev)
667 struct dsps_glue *glue = platform_get_drvdata(pdev);
668 const struct dsps_musb_wrapper *wrp = glue->wrp;
671 /* delete the child platform device */
672 for (i = 0; i < wrp->instances ; i++)
673 platform_device_unregister(glue->musb[i]);
675 /* disable usbss clocks */
676 pm_runtime_put(&pdev->dev);
677 pm_runtime_disable(&pdev->dev);
683 #ifdef CONFIG_PM_SLEEP
684 static int dsps_suspend(struct device *dev)
686 struct platform_device *pdev = to_platform_device(dev->parent);
687 struct dsps_glue *glue = platform_get_drvdata(pdev);
688 const struct dsps_musb_wrapper *wrp = glue->wrp;
691 for (i = 0; i < wrp->instances; i++)
692 musb_dsps_phy_control(glue, i, 0);
697 static int dsps_resume(struct device *dev)
699 struct platform_device *pdev = to_platform_device(dev->parent);
700 struct dsps_glue *glue = platform_get_drvdata(pdev);
701 const struct dsps_musb_wrapper *wrp = glue->wrp;
704 for (i = 0; i < wrp->instances; i++)
705 musb_dsps_phy_control(glue, i, 1);
711 static SIMPLE_DEV_PM_OPS(dsps_pm_ops, dsps_suspend, dsps_resume);
713 static const struct dsps_musb_wrapper am33xx_driver_data = {
718 .epintr_clear = 0x40,
719 .epintr_status = 0x30,
720 .coreintr_set = 0x3c,
721 .coreintr_clear = 0x44,
722 .coreintr_status = 0x34,
730 .usb_bitmap = (0x1ff << 0),
734 .txep_bitmap = (0xffff << 0),
737 .rxep_bitmap = (0xfffe << 16),
738 .musb_core_offset = 0x400,
743 static const struct of_device_id musb_dsps_of_match[] = {
744 { .compatible = "ti,musb-am33xx",
745 .data = (void *) &am33xx_driver_data, },
748 MODULE_DEVICE_TABLE(of, musb_dsps_of_match);
750 static struct platform_driver dsps_usbss_driver = {
752 .remove = dsps_remove,
756 .of_match_table = of_match_ptr(musb_dsps_of_match),
760 MODULE_DESCRIPTION("TI DSPS MUSB Glue Layer");
761 MODULE_AUTHOR("Ravi B <ravibabu@ti.com>");
762 MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>");
763 MODULE_LICENSE("GPL v2");
765 static int __init dsps_init(void)
767 return platform_driver_register(&dsps_usbss_driver);
769 subsys_initcall(dsps_init);
771 static void __exit dsps_exit(void)
773 platform_driver_unregister(&dsps_usbss_driver);
775 module_exit(dsps_exit);