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/usb_phy_gen_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 */
126 * dsps_musb_enable - enable interrupts
128 static void dsps_musb_enable(struct musb *musb)
130 struct device *dev = musb->controller;
131 struct platform_device *pdev = to_platform_device(dev->parent);
132 struct dsps_glue *glue = platform_get_drvdata(pdev);
133 const struct dsps_musb_wrapper *wrp = glue->wrp;
134 void __iomem *reg_base = musb->ctrl_base;
135 u32 epmask, coremask;
137 /* Workaround: setup IRQs through both register sets. */
138 epmask = ((musb->epmask & wrp->txep_mask) << wrp->txep_shift) |
139 ((musb->epmask & wrp->rxep_mask) << wrp->rxep_shift);
140 coremask = (wrp->usb_bitmap & ~MUSB_INTR_SOF);
142 dsps_writel(reg_base, wrp->epintr_set, epmask);
143 dsps_writel(reg_base, wrp->coreintr_set, coremask);
144 /* Force the DRVVBUS IRQ so we can start polling for ID change. */
145 dsps_writel(reg_base, wrp->coreintr_set,
146 (1 << wrp->drvvbus) << wrp->usb_shift);
150 * dsps_musb_disable - disable HDRC and flush interrupts
152 static void dsps_musb_disable(struct musb *musb)
154 struct device *dev = musb->controller;
155 struct platform_device *pdev = to_platform_device(dev->parent);
156 struct dsps_glue *glue = platform_get_drvdata(pdev);
157 const struct dsps_musb_wrapper *wrp = glue->wrp;
158 void __iomem *reg_base = musb->ctrl_base;
160 dsps_writel(reg_base, wrp->coreintr_clear, wrp->usb_bitmap);
161 dsps_writel(reg_base, wrp->epintr_clear,
162 wrp->txep_bitmap | wrp->rxep_bitmap);
163 dsps_writeb(musb->mregs, MUSB_DEVCTL, 0);
166 static void otg_timer(unsigned long _musb)
168 struct musb *musb = (void *)_musb;
169 void __iomem *mregs = musb->mregs;
170 struct device *dev = musb->controller;
171 struct platform_device *pdev = to_platform_device(dev);
172 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
173 const struct dsps_musb_wrapper *wrp = glue->wrp;
178 * We poll because DSPS IP's won't expose several OTG-critical
179 * status change events (from the transceiver) otherwise.
181 devctl = dsps_readb(mregs, MUSB_DEVCTL);
182 dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
183 usb_otg_state_string(musb->xceiv->state));
185 spin_lock_irqsave(&musb->lock, flags);
186 switch (musb->xceiv->state) {
187 case OTG_STATE_A_WAIT_BCON:
188 devctl &= ~MUSB_DEVCTL_SESSION;
189 dsps_writeb(musb->mregs, MUSB_DEVCTL, devctl);
191 devctl = dsps_readb(musb->mregs, MUSB_DEVCTL);
192 if (devctl & MUSB_DEVCTL_BDEVICE) {
193 musb->xceiv->state = OTG_STATE_B_IDLE;
196 musb->xceiv->state = OTG_STATE_A_IDLE;
200 case OTG_STATE_A_WAIT_VFALL:
201 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
202 dsps_writel(musb->ctrl_base, wrp->coreintr_set,
203 MUSB_INTR_VBUSERROR << wrp->usb_shift);
205 case OTG_STATE_B_IDLE:
206 devctl = dsps_readb(mregs, MUSB_DEVCTL);
207 if (devctl & MUSB_DEVCTL_BDEVICE)
208 mod_timer(&glue->timer[pdev->id],
209 jiffies + wrp->poll_seconds * HZ);
211 musb->xceiv->state = OTG_STATE_A_IDLE;
216 spin_unlock_irqrestore(&musb->lock, flags);
219 static void dsps_musb_try_idle(struct musb *musb, unsigned long timeout)
221 struct device *dev = musb->controller;
222 struct platform_device *pdev = to_platform_device(dev);
223 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
226 timeout = jiffies + msecs_to_jiffies(3);
228 /* Never idle if active, or when VBUS timeout is not set as host */
229 if (musb->is_active || (musb->a_wait_bcon == 0 &&
230 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) {
231 dev_dbg(musb->controller, "%s active, deleting timer\n",
232 usb_otg_state_string(musb->xceiv->state));
233 del_timer(&glue->timer[pdev->id]);
234 glue->last_timer[pdev->id] = jiffies;
238 if (time_after(glue->last_timer[pdev->id], timeout) &&
239 timer_pending(&glue->timer[pdev->id])) {
240 dev_dbg(musb->controller,
241 "Longer idle timer already pending, ignoring...\n");
244 glue->last_timer[pdev->id] = timeout;
246 dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n",
247 usb_otg_state_string(musb->xceiv->state),
248 jiffies_to_msecs(timeout - jiffies));
249 mod_timer(&glue->timer[pdev->id], timeout);
252 static irqreturn_t dsps_interrupt(int irq, void *hci)
254 struct musb *musb = hci;
255 void __iomem *reg_base = musb->ctrl_base;
256 struct device *dev = musb->controller;
257 struct platform_device *pdev = to_platform_device(dev);
258 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
259 const struct dsps_musb_wrapper *wrp = glue->wrp;
261 irqreturn_t ret = IRQ_NONE;
264 spin_lock_irqsave(&musb->lock, flags);
266 /* Get endpoint interrupts */
267 epintr = dsps_readl(reg_base, wrp->epintr_status);
268 musb->int_rx = (epintr & wrp->rxep_bitmap) >> wrp->rxep_shift;
269 musb->int_tx = (epintr & wrp->txep_bitmap) >> wrp->txep_shift;
272 dsps_writel(reg_base, wrp->epintr_status, epintr);
274 /* Get usb core interrupts */
275 usbintr = dsps_readl(reg_base, wrp->coreintr_status);
276 if (!usbintr && !epintr)
279 musb->int_usb = (usbintr & wrp->usb_bitmap) >> wrp->usb_shift;
281 dsps_writel(reg_base, wrp->coreintr_status, usbintr);
283 dev_dbg(musb->controller, "usbintr (%x) epintr(%x)\n",
286 * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
287 * DSPS IP's missing ID change IRQ. We need an ID change IRQ to
288 * switch appropriately between halves of the OTG state machine.
289 * Managing DEVCTL.SESSION per Mentor docs requires that we know its
290 * value but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
291 * Also, DRVVBUS pulses for SRP (but not at 5V) ...
293 if (is_host_active(musb) && usbintr & MUSB_INTR_BABBLE)
294 pr_info("CAUTION: musb: Babble Interrupt Occurred\n");
296 if (usbintr & ((1 << wrp->drvvbus) << wrp->usb_shift)) {
297 int drvvbus = dsps_readl(reg_base, wrp->status);
298 void __iomem *mregs = musb->mregs;
299 u8 devctl = dsps_readb(mregs, MUSB_DEVCTL);
302 err = musb->int_usb & MUSB_INTR_VBUSERROR;
305 * The Mentor core doesn't debounce VBUS as needed
306 * to cope with device connect current spikes. This
307 * means it's not uncommon for bus-powered devices
308 * to get VBUS errors during enumeration.
310 * This is a workaround, but newer RTL from Mentor
311 * seems to allow a better one: "re"-starting sessions
312 * without waiting for VBUS to stop registering in
315 musb->int_usb &= ~MUSB_INTR_VBUSERROR;
316 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
317 mod_timer(&glue->timer[pdev->id],
318 jiffies + wrp->poll_seconds * HZ);
319 WARNING("VBUS error workaround (delay coming)\n");
320 } else if (drvvbus) {
323 musb->xceiv->otg->default_a = 1;
324 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
325 del_timer(&glue->timer[pdev->id]);
329 musb->xceiv->otg->default_a = 0;
330 musb->xceiv->state = OTG_STATE_B_IDLE;
333 /* NOTE: this must complete power-on within 100 ms. */
334 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
335 drvvbus ? "on" : "off",
336 usb_otg_state_string(musb->xceiv->state),
342 if (musb->int_tx || musb->int_rx || musb->int_usb)
343 ret |= musb_interrupt(musb);
345 /* Poll for ID change */
346 if (musb->xceiv->state == OTG_STATE_B_IDLE)
347 mod_timer(&glue->timer[pdev->id],
348 jiffies + wrp->poll_seconds * HZ);
350 spin_unlock_irqrestore(&musb->lock, flags);
355 static int dsps_musb_init(struct musb *musb)
357 struct device *dev = musb->controller;
358 struct platform_device *pdev = to_platform_device(dev);
359 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
360 const struct dsps_musb_wrapper *wrp = glue->wrp;
361 void __iomem *reg_base = musb->ctrl_base;
365 /* mentor core register starts at offset of 0x400 from musb base */
366 musb->mregs += wrp->musb_core_offset;
368 /* NOP driver needs change if supporting dual instance */
369 musb->xceiv = devm_usb_get_phy_by_phandle(glue->dev, "phys", 0);
370 if (IS_ERR_OR_NULL(musb->xceiv))
371 return -EPROBE_DEFER;
373 /* Returns zero if e.g. not clocked */
374 rev = dsps_readl(reg_base, wrp->revision);
380 usb_phy_init(musb->xceiv);
382 setup_timer(&glue->timer[pdev->id], otg_timer, (unsigned long) musb);
385 dsps_writel(reg_base, wrp->control, (1 << wrp->reset));
387 musb->isr = dsps_interrupt;
389 /* reset the otgdisable bit, needed for host mode to work */
390 val = dsps_readl(reg_base, wrp->phy_utmi);
391 val &= ~(1 << wrp->otg_disable);
392 dsps_writel(musb->ctrl_base, wrp->phy_utmi, val);
399 static int dsps_musb_exit(struct musb *musb)
401 struct device *dev = musb->controller;
402 struct platform_device *pdev = to_platform_device(dev);
403 struct dsps_glue *glue = dev_get_drvdata(dev->parent);
405 del_timer_sync(&glue->timer[pdev->id]);
407 usb_phy_shutdown(musb->xceiv);
411 static struct musb_platform_ops dsps_ops = {
412 .init = dsps_musb_init,
413 .exit = dsps_musb_exit,
415 .enable = dsps_musb_enable,
416 .disable = dsps_musb_disable,
418 .try_idle = dsps_musb_try_idle,
421 static u64 musb_dmamask = DMA_BIT_MASK(32);
423 static int dsps_create_musb_pdev(struct dsps_glue *glue, u8 id)
425 struct device *dev = glue->dev;
426 struct platform_device *pdev = to_platform_device(dev);
427 struct musb_hdrc_platform_data *pdata = dev_get_platdata(dev);
428 struct device_node *np = pdev->dev.of_node;
429 struct musb_hdrc_config *config;
430 struct platform_device *musb;
431 struct resource *res;
432 struct resource resources[2];
436 /* first resource is for usbss, so start index from 1 */
437 res = platform_get_resource(pdev, IORESOURCE_MEM, id + 1);
439 dev_err(dev, "failed to get memory for instance %d\n", id);
446 /* first resource is for usbss, so start index from 1 */
447 res = platform_get_resource(pdev, IORESOURCE_IRQ, id + 1);
449 dev_err(dev, "failed to get irq for instance %d\n", id);
455 resources[1].name = "mc";
457 /* allocate the child platform device */
458 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO);
460 dev_err(dev, "failed to allocate musb device\n");
465 musb->dev.parent = dev;
466 musb->dev.dma_mask = &musb_dmamask;
467 musb->dev.coherent_dma_mask = musb_dmamask;
469 glue->musb[id] = musb;
471 ret = platform_device_add_resources(musb, resources, 2);
473 dev_err(dev, "failed to add resources\n");
478 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
481 "failed to allocate musb platform data\n");
486 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL);
489 "failed to allocate musb hdrc config\n");
494 of_property_read_u32(np, "num-eps", (u32 *)&config->num_eps);
495 of_property_read_u32(np, "ram-bits", (u32 *)&config->ram_bits);
496 snprintf(res_name, sizeof(res_name), "port%d-mode", id);
497 of_property_read_u32(np, res_name, (u32 *)&pdata->mode);
498 of_property_read_u32(np, "power", (u32 *)&pdata->power);
499 config->multipoint = of_property_read_bool(np, "multipoint");
501 pdata->config = config;
504 pdata->platform_ops = &dsps_ops;
506 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
508 dev_err(dev, "failed to add platform_data\n");
512 ret = platform_device_add(musb);
514 dev_err(dev, "failed to register musb device\n");
521 platform_device_put(musb);
526 static int dsps_probe(struct platform_device *pdev)
528 const struct of_device_id *match;
529 const struct dsps_musb_wrapper *wrp;
530 struct dsps_glue *glue;
531 struct resource *iomem;
534 match = of_match_node(musb_dsps_of_match, pdev->dev.of_node);
536 dev_err(&pdev->dev, "fail to get matching of_match struct\n");
543 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
545 dev_err(&pdev->dev, "unable to allocate glue memory\n");
550 /* get memory resource */
551 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
553 dev_err(&pdev->dev, "failed to get usbss mem resourse\n");
558 glue->dev = &pdev->dev;
560 glue->wrp = kmemdup(wrp, sizeof(*wrp), GFP_KERNEL);
562 dev_err(&pdev->dev, "failed to duplicate wrapper struct memory\n");
566 platform_set_drvdata(pdev, glue);
568 /* enable the usbss clocks */
569 pm_runtime_enable(&pdev->dev);
571 ret = pm_runtime_get_sync(&pdev->dev);
573 dev_err(&pdev->dev, "pm_runtime_get_sync FAILED");
577 /* create the child platform device for all instances of musb */
578 for (i = 0; i < wrp->instances ; i++) {
579 ret = dsps_create_musb_pdev(glue, i);
581 dev_err(&pdev->dev, "failed to create child pdev\n");
582 /* release resources of previously created instances */
583 for (i--; i >= 0 ; i--)
584 platform_device_unregister(glue->musb[i]);
592 pm_runtime_put(&pdev->dev);
594 pm_runtime_disable(&pdev->dev);
601 static int dsps_remove(struct platform_device *pdev)
603 struct dsps_glue *glue = platform_get_drvdata(pdev);
604 const struct dsps_musb_wrapper *wrp = glue->wrp;
607 /* delete the child platform device */
608 for (i = 0; i < wrp->instances ; i++)
609 platform_device_unregister(glue->musb[i]);
611 /* disable usbss clocks */
612 pm_runtime_put(&pdev->dev);
613 pm_runtime_disable(&pdev->dev);
619 static const struct dsps_musb_wrapper am33xx_driver_data = {
624 .epintr_clear = 0x40,
625 .epintr_status = 0x30,
626 .coreintr_set = 0x3c,
627 .coreintr_clear = 0x44,
628 .coreintr_status = 0x34,
636 .usb_bitmap = (0x1ff << 0),
640 .txep_bitmap = (0xffff << 0),
643 .rxep_bitmap = (0xfffe << 16),
644 .musb_core_offset = 0x400,
649 static const struct of_device_id musb_dsps_of_match[] = {
650 { .compatible = "ti,musb-am33xx",
651 .data = (void *) &am33xx_driver_data, },
654 MODULE_DEVICE_TABLE(of, musb_dsps_of_match);
656 static struct platform_driver dsps_usbss_driver = {
658 .remove = dsps_remove,
661 .of_match_table = of_match_ptr(musb_dsps_of_match),
665 MODULE_DESCRIPTION("TI DSPS MUSB Glue Layer");
666 MODULE_AUTHOR("Ravi B <ravibabu@ti.com>");
667 MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>");
668 MODULE_LICENSE("GPL v2");
670 static int __init dsps_init(void)
672 return platform_driver_register(&dsps_usbss_driver);
674 subsys_initcall(dsps_init);
676 static void __exit dsps_exit(void)
678 platform_driver_unregister(&dsps_usbss_driver);
680 module_exit(dsps_exit);