2 * Texas Instruments AM35x "glue layer"
4 * Copyright (c) 2010, by Texas Instruments
6 * Based on the DA8xx "glue layer" code.
7 * Copyright (c) 2008-2009, MontaVista Software, Inc. <source@mvista.com>
9 * This file is part of the Inventra Controller Driver for Linux.
11 * The Inventra Controller Driver for Linux is free software; you
12 * can redistribute it and/or modify it under the terms of the GNU
13 * General Public License version 2 as published by the Free Software
16 * The Inventra Controller Driver for Linux is distributed in
17 * the hope that it will be useful, but WITHOUT ANY WARRANTY;
18 * without even the implied warranty of MERCHANTABILITY or
19 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
20 * License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with The Inventra Controller Driver for Linux ; if not,
24 * write to the Free Software Foundation, Inc., 59 Temple Place,
25 * Suite 330, Boston, MA 02111-1307 USA
29 #include <linux/init.h>
30 #include <linux/module.h>
31 #include <linux/clk.h>
32 #include <linux/err.h>
34 #include <linux/platform_device.h>
35 #include <linux/dma-mapping.h>
39 #include "musb_core.h"
42 * AM35x specific definitions
44 /* USB 2.0 OTG module registers */
45 #define USB_REVISION_REG 0x00
46 #define USB_CTRL_REG 0x04
47 #define USB_STAT_REG 0x08
48 #define USB_EMULATION_REG 0x0c
50 #define USB_AUTOREQ_REG 0x14
51 #define USB_SRP_FIX_TIME_REG 0x18
52 #define USB_TEARDOWN_REG 0x1c
53 #define EP_INTR_SRC_REG 0x20
54 #define EP_INTR_SRC_SET_REG 0x24
55 #define EP_INTR_SRC_CLEAR_REG 0x28
56 #define EP_INTR_MASK_REG 0x2c
57 #define EP_INTR_MASK_SET_REG 0x30
58 #define EP_INTR_MASK_CLEAR_REG 0x34
59 #define EP_INTR_SRC_MASKED_REG 0x38
60 #define CORE_INTR_SRC_REG 0x40
61 #define CORE_INTR_SRC_SET_REG 0x44
62 #define CORE_INTR_SRC_CLEAR_REG 0x48
63 #define CORE_INTR_MASK_REG 0x4c
64 #define CORE_INTR_MASK_SET_REG 0x50
65 #define CORE_INTR_MASK_CLEAR_REG 0x54
66 #define CORE_INTR_SRC_MASKED_REG 0x58
68 #define USB_END_OF_INTR_REG 0x60
70 /* Control register bits */
71 #define AM35X_SOFT_RESET_MASK 1
73 /* USB interrupt register bits */
74 #define AM35X_INTR_USB_SHIFT 16
75 #define AM35X_INTR_USB_MASK (0x1ff << AM35X_INTR_USB_SHIFT)
76 #define AM35X_INTR_DRVVBUS 0x100
77 #define AM35X_INTR_RX_SHIFT 16
78 #define AM35X_INTR_TX_SHIFT 0
79 #define AM35X_TX_EP_MASK 0xffff /* EP0 + 15 Tx EPs */
80 #define AM35X_RX_EP_MASK 0xfffe /* 15 Rx EPs */
81 #define AM35X_TX_INTR_MASK (AM35X_TX_EP_MASK << AM35X_INTR_TX_SHIFT)
82 #define AM35X_RX_INTR_MASK (AM35X_RX_EP_MASK << AM35X_INTR_RX_SHIFT)
84 #define USB_MENTOR_CORE_OFFSET 0x400
88 struct platform_device *musb;
92 #define glue_to_musb(g) platform_get_drvdata(g->musb)
95 * am35x_musb_enable - enable interrupts
97 static void am35x_musb_enable(struct musb *musb)
99 void __iomem *reg_base = musb->ctrl_base;
102 /* Workaround: setup IRQs through both register sets. */
103 epmask = ((musb->epmask & AM35X_TX_EP_MASK) << AM35X_INTR_TX_SHIFT) |
104 ((musb->epmask & AM35X_RX_EP_MASK) << AM35X_INTR_RX_SHIFT);
106 musb_writel(reg_base, EP_INTR_MASK_SET_REG, epmask);
107 musb_writel(reg_base, CORE_INTR_MASK_SET_REG, AM35X_INTR_USB_MASK);
109 /* Force the DRVVBUS IRQ so we can start polling for ID change. */
110 if (is_otg_enabled(musb))
111 musb_writel(reg_base, CORE_INTR_SRC_SET_REG,
112 AM35X_INTR_DRVVBUS << AM35X_INTR_USB_SHIFT);
116 * am35x_musb_disable - disable HDRC and flush interrupts
118 static void am35x_musb_disable(struct musb *musb)
120 void __iomem *reg_base = musb->ctrl_base;
122 musb_writel(reg_base, CORE_INTR_MASK_CLEAR_REG, AM35X_INTR_USB_MASK);
123 musb_writel(reg_base, EP_INTR_MASK_CLEAR_REG,
124 AM35X_TX_INTR_MASK | AM35X_RX_INTR_MASK);
125 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
126 musb_writel(reg_base, USB_END_OF_INTR_REG, 0);
129 #define portstate(stmt) stmt
131 static void am35x_musb_set_vbus(struct musb *musb, int is_on)
133 WARN_ON(is_on && is_peripheral_active(musb));
136 #define POLL_SECONDS 2
138 static struct timer_list otg_workaround;
140 static void otg_timer(unsigned long _musb)
142 struct musb *musb = (void *)_musb;
143 void __iomem *mregs = musb->mregs;
148 * We poll because AM35x's won't expose several OTG-critical
149 * status change events (from the transceiver) otherwise.
151 devctl = musb_readb(mregs, MUSB_DEVCTL);
152 dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
153 otg_state_string(musb->xceiv->state));
155 spin_lock_irqsave(&musb->lock, flags);
156 switch (musb->xceiv->state) {
157 case OTG_STATE_A_WAIT_BCON:
158 devctl &= ~MUSB_DEVCTL_SESSION;
159 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
161 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
162 if (devctl & MUSB_DEVCTL_BDEVICE) {
163 musb->xceiv->state = OTG_STATE_B_IDLE;
166 musb->xceiv->state = OTG_STATE_A_IDLE;
170 case OTG_STATE_A_WAIT_VFALL:
171 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
172 musb_writel(musb->ctrl_base, CORE_INTR_SRC_SET_REG,
173 MUSB_INTR_VBUSERROR << AM35X_INTR_USB_SHIFT);
175 case OTG_STATE_B_IDLE:
176 if (!is_peripheral_enabled(musb))
179 devctl = musb_readb(mregs, MUSB_DEVCTL);
180 if (devctl & MUSB_DEVCTL_BDEVICE)
181 mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
183 musb->xceiv->state = OTG_STATE_A_IDLE;
188 spin_unlock_irqrestore(&musb->lock, flags);
191 static void am35x_musb_try_idle(struct musb *musb, unsigned long timeout)
193 static unsigned long last_timer;
195 if (!is_otg_enabled(musb))
199 timeout = jiffies + msecs_to_jiffies(3);
201 /* Never idle if active, or when VBUS timeout is not set as host */
202 if (musb->is_active || (musb->a_wait_bcon == 0 &&
203 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) {
204 dev_dbg(musb->controller, "%s active, deleting timer\n",
205 otg_state_string(musb->xceiv->state));
206 del_timer(&otg_workaround);
207 last_timer = jiffies;
211 if (time_after(last_timer, timeout) && timer_pending(&otg_workaround)) {
212 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring...\n");
215 last_timer = timeout;
217 dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n",
218 otg_state_string(musb->xceiv->state),
219 jiffies_to_msecs(timeout - jiffies));
220 mod_timer(&otg_workaround, timeout);
223 static irqreturn_t am35x_musb_interrupt(int irq, void *hci)
225 struct musb *musb = hci;
226 void __iomem *reg_base = musb->ctrl_base;
227 struct device *dev = musb->controller;
228 struct musb_hdrc_platform_data *plat = dev->platform_data;
229 struct omap_musb_board_data *data = plat->board_data;
230 struct usb_otg *otg = musb->xceiv->otg;
232 irqreturn_t ret = IRQ_NONE;
235 spin_lock_irqsave(&musb->lock, flags);
237 /* Get endpoint interrupts */
238 epintr = musb_readl(reg_base, EP_INTR_SRC_MASKED_REG);
241 musb_writel(reg_base, EP_INTR_SRC_CLEAR_REG, epintr);
244 (epintr & AM35X_RX_INTR_MASK) >> AM35X_INTR_RX_SHIFT;
246 (epintr & AM35X_TX_INTR_MASK) >> AM35X_INTR_TX_SHIFT;
249 /* Get usb core interrupts */
250 usbintr = musb_readl(reg_base, CORE_INTR_SRC_MASKED_REG);
251 if (!usbintr && !epintr)
255 musb_writel(reg_base, CORE_INTR_SRC_CLEAR_REG, usbintr);
258 (usbintr & AM35X_INTR_USB_MASK) >> AM35X_INTR_USB_SHIFT;
261 * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
262 * AM35x's missing ID change IRQ. We need an ID change IRQ to
263 * switch appropriately between halves of the OTG state machine.
264 * Managing DEVCTL.SESSION per Mentor docs requires that we know its
265 * value but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
266 * Also, DRVVBUS pulses for SRP (but not at 5V) ...
268 if (usbintr & (AM35X_INTR_DRVVBUS << AM35X_INTR_USB_SHIFT)) {
269 int drvvbus = musb_readl(reg_base, USB_STAT_REG);
270 void __iomem *mregs = musb->mregs;
271 u8 devctl = musb_readb(mregs, MUSB_DEVCTL);
274 err = is_host_enabled(musb) && (musb->int_usb &
275 MUSB_INTR_VBUSERROR);
278 * The Mentor core doesn't debounce VBUS as needed
279 * to cope with device connect current spikes. This
280 * means it's not uncommon for bus-powered devices
281 * to get VBUS errors during enumeration.
283 * This is a workaround, but newer RTL from Mentor
284 * seems to allow a better one: "re"-starting sessions
285 * without waiting for VBUS to stop registering in
288 musb->int_usb &= ~MUSB_INTR_VBUSERROR;
289 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
290 mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
291 WARNING("VBUS error workaround (delay coming)\n");
292 } else if (is_host_enabled(musb) && drvvbus) {
295 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
296 portstate(musb->port1_status |= USB_PORT_STAT_POWER);
297 del_timer(&otg_workaround);
302 musb->xceiv->state = OTG_STATE_B_IDLE;
303 portstate(musb->port1_status &= ~USB_PORT_STAT_POWER);
306 /* NOTE: this must complete power-on within 100 ms. */
307 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
308 drvvbus ? "on" : "off",
309 otg_state_string(musb->xceiv->state),
315 if (musb->int_tx || musb->int_rx || musb->int_usb)
316 ret |= musb_interrupt(musb);
319 /* EOI needs to be written for the IRQ to be re-asserted. */
320 if (ret == IRQ_HANDLED || epintr || usbintr) {
321 /* clear level interrupt */
325 musb_writel(reg_base, USB_END_OF_INTR_REG, 0);
328 /* Poll for ID change */
329 if (is_otg_enabled(musb) && musb->xceiv->state == OTG_STATE_B_IDLE)
330 mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
332 spin_unlock_irqrestore(&musb->lock, flags);
337 static int am35x_musb_set_mode(struct musb *musb, u8 musb_mode)
339 struct device *dev = musb->controller;
340 struct musb_hdrc_platform_data *plat = dev->platform_data;
341 struct omap_musb_board_data *data = plat->board_data;
345 data->set_mode(musb_mode);
352 static int am35x_musb_init(struct musb *musb)
354 struct device *dev = musb->controller;
355 struct musb_hdrc_platform_data *plat = dev->platform_data;
356 struct omap_musb_board_data *data = plat->board_data;
357 void __iomem *reg_base = musb->ctrl_base;
360 musb->mregs += USB_MENTOR_CORE_OFFSET;
362 /* Returns zero if e.g. not clocked */
363 rev = musb_readl(reg_base, USB_REVISION_REG);
367 usb_nop_xceiv_register();
368 musb->xceiv = usb_get_phy(USB_PHY_TYPE_USB2);
369 if (IS_ERR_OR_NULL(musb->xceiv))
372 if (is_host_enabled(musb))
373 setup_timer(&otg_workaround, otg_timer, (unsigned long) musb);
379 /* Reset the controller */
380 musb_writel(reg_base, USB_CTRL_REG, AM35X_SOFT_RESET_MASK);
382 /* Start the on-chip PHY and its PLL. */
383 if (data->set_phy_power)
384 data->set_phy_power(1);
388 musb->isr = am35x_musb_interrupt;
390 /* clear level interrupt */
397 static int am35x_musb_exit(struct musb *musb)
399 struct device *dev = musb->controller;
400 struct musb_hdrc_platform_data *plat = dev->platform_data;
401 struct omap_musb_board_data *data = plat->board_data;
403 if (is_host_enabled(musb))
404 del_timer_sync(&otg_workaround);
406 /* Shutdown the on-chip PHY and its PLL. */
407 if (data->set_phy_power)
408 data->set_phy_power(0);
410 usb_put_phy(musb->xceiv);
411 usb_nop_xceiv_unregister();
416 /* AM35x supports only 32bit read operation */
417 void musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
419 void __iomem *fifo = hw_ep->fifo;
423 /* Read for 32bit-aligned destination address */
424 if (likely((0x03 & (unsigned long) dst) == 0) && len >= 4) {
425 readsl(fifo, dst, len >> 2);
430 * Now read the remaining 1 to 3 byte or complete length if
434 for (i = 0; i < (len >> 2); i++) {
435 *(u32 *) dst = musb_readl(fifo, 0);
441 val = musb_readl(fifo, 0);
442 memcpy(dst, &val, len);
446 static const struct musb_platform_ops am35x_ops = {
447 .init = am35x_musb_init,
448 .exit = am35x_musb_exit,
450 .enable = am35x_musb_enable,
451 .disable = am35x_musb_disable,
453 .set_mode = am35x_musb_set_mode,
454 .try_idle = am35x_musb_try_idle,
456 .set_vbus = am35x_musb_set_vbus,
459 static u64 am35x_dmamask = DMA_BIT_MASK(32);
461 static int __devinit am35x_probe(struct platform_device *pdev)
463 struct musb_hdrc_platform_data *pdata = pdev->dev.platform_data;
464 struct platform_device *musb;
465 struct am35x_glue *glue;
472 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
474 dev_err(&pdev->dev, "failed to allocate glue context\n");
478 musb = platform_device_alloc("musb-hdrc", -1);
480 dev_err(&pdev->dev, "failed to allocate musb device\n");
484 phy_clk = clk_get(&pdev->dev, "fck");
485 if (IS_ERR(phy_clk)) {
486 dev_err(&pdev->dev, "failed to get PHY clock\n");
487 ret = PTR_ERR(phy_clk);
491 clk = clk_get(&pdev->dev, "ick");
493 dev_err(&pdev->dev, "failed to get clock\n");
498 ret = clk_enable(phy_clk);
500 dev_err(&pdev->dev, "failed to enable PHY clock\n");
504 ret = clk_enable(clk);
506 dev_err(&pdev->dev, "failed to enable clock\n");
510 musb->dev.parent = &pdev->dev;
511 musb->dev.dma_mask = &am35x_dmamask;
512 musb->dev.coherent_dma_mask = am35x_dmamask;
514 glue->dev = &pdev->dev;
516 glue->phy_clk = phy_clk;
519 pdata->platform_ops = &am35x_ops;
521 platform_set_drvdata(pdev, glue);
523 ret = platform_device_add_resources(musb, pdev->resource,
524 pdev->num_resources);
526 dev_err(&pdev->dev, "failed to add resources\n");
530 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
532 dev_err(&pdev->dev, "failed to add platform_data\n");
536 ret = platform_device_add(musb);
538 dev_err(&pdev->dev, "failed to register musb device\n");
548 clk_disable(phy_clk);
557 platform_device_put(musb);
566 static int __devexit am35x_remove(struct platform_device *pdev)
568 struct am35x_glue *glue = platform_get_drvdata(pdev);
570 platform_device_del(glue->musb);
571 platform_device_put(glue->musb);
572 clk_disable(glue->clk);
573 clk_disable(glue->phy_clk);
575 clk_put(glue->phy_clk);
582 static int am35x_suspend(struct device *dev)
584 struct am35x_glue *glue = dev_get_drvdata(dev);
585 struct musb_hdrc_platform_data *plat = dev->platform_data;
586 struct omap_musb_board_data *data = plat->board_data;
588 /* Shutdown the on-chip PHY and its PLL. */
589 if (data->set_phy_power)
590 data->set_phy_power(0);
592 clk_disable(glue->phy_clk);
593 clk_disable(glue->clk);
598 static int am35x_resume(struct device *dev)
600 struct am35x_glue *glue = dev_get_drvdata(dev);
601 struct musb_hdrc_platform_data *plat = dev->platform_data;
602 struct omap_musb_board_data *data = plat->board_data;
605 /* Start the on-chip PHY and its PLL. */
606 if (data->set_phy_power)
607 data->set_phy_power(1);
609 ret = clk_enable(glue->phy_clk);
611 dev_err(dev, "failed to enable PHY clock\n");
615 ret = clk_enable(glue->clk);
617 dev_err(dev, "failed to enable clock\n");
624 static struct dev_pm_ops am35x_pm_ops = {
625 .suspend = am35x_suspend,
626 .resume = am35x_resume,
629 #define DEV_PM_OPS &am35x_pm_ops
631 #define DEV_PM_OPS NULL
634 static struct platform_driver am35x_driver = {
635 .probe = am35x_probe,
636 .remove = __devexit_p(am35x_remove),
638 .name = "musb-am35x",
643 MODULE_DESCRIPTION("AM35x MUSB Glue Layer");
644 MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>");
645 MODULE_LICENSE("GPL v2");
647 static int __init am35x_init(void)
649 return platform_driver_register(&am35x_driver);
651 module_init(am35x_init);
653 static void __exit am35x_exit(void)
655 platform_driver_unregister(&am35x_driver);
657 module_exit(am35x_exit);