4e0b21a4cbb9b8c1291f8db61ae5f7aa5be615c4
[sitara-epos/sitara-epos-kernel.git] / drivers / usb / musb / davinci.c
1 /*
2  * Copyright (C) 2005-2006 by Texas Instruments
3  *
4  * This file is part of the Inventra Controller Driver for Linux.
5  *
6  * The Inventra Controller Driver for Linux is free software; you
7  * can redistribute it and/or modify it under the terms of the GNU
8  * General Public License version 2 as published by the Free Software
9  * Foundation.
10  *
11  * The Inventra Controller Driver for Linux is distributed in
12  * the hope that it will be useful, but WITHOUT ANY WARRANTY;
13  * without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
15  * License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with The Inventra Controller Driver for Linux ; if not,
19  * write to the Free Software Foundation, Inc., 59 Temple Place,
20  * Suite 330, Boston, MA  02111-1307  USA
21  *
22  */
24 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/sched.h>
27 #include <linux/init.h>
28 #include <linux/list.h>
29 #include <linux/delay.h>
30 #include <linux/clk.h>
31 #include <linux/io.h>
32 #include <linux/gpio.h>
33 #include <linux/platform_device.h>
34 #include <linux/dma-mapping.h>
36 #include <mach/hardware.h>
37 #include <mach/memory.h>
38 #include <asm/gpio.h>
39 #include <mach/cputype.h>
41 #include <asm/mach-types.h>
43 #include "musb_core.h"
45 #ifdef CONFIG_MACH_DAVINCI_EVM
46 #define GPIO_nVBUS_DRV          160
47 #endif
49 #include "davinci.h"
50 #include "cppi_dma.h"
53 #define USB_PHY_CTRL    IO_ADDRESS(USBPHY_CTL_PADDR)
54 #define DM355_DEEPSLEEP IO_ADDRESS(DM355_DEEPSLEEP_PADDR)
56 struct davinci_glue {
57         struct device           *dev;
58         struct platform_device  *musb;
59         struct clk              *clk;
60 };
62 /* REVISIT (PM) we should be able to keep the PHY in low power mode most
63  * of the time (24 MHZ oscillator and PLL off, etc) by setting POWER.D0
64  * and, when in host mode, autosuspending idle root ports... PHYPLLON
65  * (overriding SUSPENDM?) then likely needs to stay off.
66  */
68 static inline void phy_on(void)
69 {
70         u32     phy_ctrl = __raw_readl(USB_PHY_CTRL);
72         /* power everything up; start the on-chip PHY and its PLL */
73         phy_ctrl &= ~(USBPHY_OSCPDWN | USBPHY_OTGPDWN | USBPHY_PHYPDWN);
74         phy_ctrl |= USBPHY_SESNDEN | USBPHY_VBDTCTEN | USBPHY_PHYPLLON;
75         __raw_writel(phy_ctrl, USB_PHY_CTRL);
77         /* wait for PLL to lock before proceeding */
78         while ((__raw_readl(USB_PHY_CTRL) & USBPHY_PHYCLKGD) == 0)
79                 cpu_relax();
80 }
82 static inline void phy_off(void)
83 {
84         u32     phy_ctrl = __raw_readl(USB_PHY_CTRL);
86         /* powerdown the on-chip PHY, its PLL, and the OTG block */
87         phy_ctrl &= ~(USBPHY_SESNDEN | USBPHY_VBDTCTEN | USBPHY_PHYPLLON);
88         phy_ctrl |= USBPHY_OSCPDWN | USBPHY_OTGPDWN | USBPHY_PHYPDWN;
89         __raw_writel(phy_ctrl, USB_PHY_CTRL);
90 }
92 static int dma_off = 1;
94 static void davinci_musb_enable(struct musb *musb)
95 {
96         u32     tmp, old, val;
98         /* workaround:  setup irqs through both register sets */
99         tmp = (musb->epmask & DAVINCI_USB_TX_ENDPTS_MASK)
100                         << DAVINCI_USB_TXINT_SHIFT;
101         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_SET_REG, tmp);
102         old = tmp;
103         tmp = (musb->epmask & (0xfffe & DAVINCI_USB_RX_ENDPTS_MASK))
104                         << DAVINCI_USB_RXINT_SHIFT;
105         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_SET_REG, tmp);
106         tmp |= old;
108         val = ~MUSB_INTR_SOF;
109         tmp |= ((val & 0x01ff) << DAVINCI_USB_USBINT_SHIFT);
110         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_SET_REG, tmp);
112         if (is_dma_capable() && !dma_off)
113                 printk(KERN_WARNING "%s %s: dma not reactivated\n",
114                                 __FILE__, __func__);
115         else
116                 dma_off = 0;
118         /* force a DRVVBUS irq so we can start polling for ID change */
119         if (is_otg_enabled(musb))
120                 musb_writel(musb->ctrl_base, DAVINCI_USB_INT_SET_REG,
121                         DAVINCI_INTR_DRVVBUS << DAVINCI_USB_USBINT_SHIFT);
124 /*
125  * Disable the HDRC and flush interrupts
126  */
127 static void davinci_musb_disable(struct musb *musb)
129         /* because we don't set CTRLR.UINT, "important" to:
130          *  - not read/write INTRUSB/INTRUSBE
131          *  - (except during initial setup, as workaround)
132          *  - use INTSETR/INTCLRR instead
133          */
134         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_CLR_REG,
135                           DAVINCI_USB_USBINT_MASK
136                         | DAVINCI_USB_TXINT_MASK
137                         | DAVINCI_USB_RXINT_MASK);
138         musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
139         musb_writel(musb->ctrl_base, DAVINCI_USB_EOI_REG, 0);
141         if (is_dma_capable() && !dma_off)
142                 WARNING("dma still active\n");
146 #define portstate(stmt)         stmt
148 /*
149  * VBUS SWITCHING IS BOARD-SPECIFIC ... at least for the DM6446 EVM,
150  * which doesn't wire DRVVBUS to the FET that switches it.  Unclear
151  * if that's a problem with the DM6446 chip or just with that board.
152  *
153  * In either case, the DM355 EVM automates DRVVBUS the normal way,
154  * when J10 is out, and TI documents it as handling OTG.
155  */
157 #ifdef CONFIG_MACH_DAVINCI_EVM
159 static int vbus_state = -1;
161 /* I2C operations are always synchronous, and require a task context.
162  * With unloaded systems, using the shared workqueue seems to suffice
163  * to satisfy the 100msec A_WAIT_VRISE timeout...
164  */
165 static void evm_deferred_drvvbus(struct work_struct *ignored)
167         gpio_set_value_cansleep(GPIO_nVBUS_DRV, vbus_state);
168         vbus_state = !vbus_state;
171 #endif  /* EVM */
173 static void davinci_musb_source_power(struct musb *musb, int is_on, int immediate)
175 #ifdef CONFIG_MACH_DAVINCI_EVM
176         if (is_on)
177                 is_on = 1;
179         if (vbus_state == is_on)
180                 return;
181         vbus_state = !is_on;            /* 0/1 vs "-1 == unknown/init" */
183         if (machine_is_davinci_evm()) {
184                 static DECLARE_WORK(evm_vbus_work, evm_deferred_drvvbus);
186                 if (immediate)
187                         gpio_set_value_cansleep(GPIO_nVBUS_DRV, vbus_state);
188                 else
189                         schedule_work(&evm_vbus_work);
190         }
191         if (immediate)
192                 vbus_state = is_on;
193 #endif
196 static void davinci_musb_set_vbus(struct musb *musb, int is_on)
198         WARN_ON(is_on && is_peripheral_active(musb));
199         davinci_musb_source_power(musb, is_on, 0);
203 #define POLL_SECONDS    2
205 static struct timer_list otg_workaround;
207 static void otg_timer(unsigned long _musb)
209         struct musb             *musb = (void *)_musb;
210         void __iomem            *mregs = musb->mregs;
211         u8                      devctl;
212         unsigned long           flags;
214         /* We poll because DaVinci's won't expose several OTG-critical
215         * status change events (from the transceiver) otherwise.
216          */
217         devctl = musb_readb(mregs, MUSB_DEVCTL);
218         dev_dbg(musb->controller, "poll devctl %02x (%s)\n", devctl,
219                 otg_state_string(musb->xceiv->state));
221         spin_lock_irqsave(&musb->lock, flags);
222         switch (musb->xceiv->state) {
223         case OTG_STATE_A_WAIT_VFALL:
224                 /* Wait till VBUS falls below SessionEnd (~0.2V); the 1.3 RTL
225                  * seems to mis-handle session "start" otherwise (or in our
226                  * case "recover"), in routine "VBUS was valid by the time
227                  * VBUSERR got reported during enumeration" cases.
228                  */
229                 if (devctl & MUSB_DEVCTL_VBUS) {
230                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
231                         break;
232                 }
233                 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
234                 musb_writel(musb->ctrl_base, DAVINCI_USB_INT_SET_REG,
235                         MUSB_INTR_VBUSERROR << DAVINCI_USB_USBINT_SHIFT);
236                 break;
237         case OTG_STATE_B_IDLE:
238                 if (!is_peripheral_enabled(musb))
239                         break;
241                 /* There's no ID-changed IRQ, so we have no good way to tell
242                  * when to switch to the A-Default state machine (by setting
243                  * the DEVCTL.SESSION flag).
244                  *
245                  * Workaround:  whenever we're in B_IDLE, try setting the
246                  * session flag every few seconds.  If it works, ID was
247                  * grounded and we're now in the A-Default state machine.
248                  *
249                  * NOTE setting the session flag is _supposed_ to trigger
250                  * SRP, but clearly it doesn't.
251                  */
252                 musb_writeb(mregs, MUSB_DEVCTL,
253                                 devctl | MUSB_DEVCTL_SESSION);
254                 devctl = musb_readb(mregs, MUSB_DEVCTL);
255                 if (devctl & MUSB_DEVCTL_BDEVICE)
256                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
257                 else
258                         musb->xceiv->state = OTG_STATE_A_IDLE;
259                 break;
260         default:
261                 break;
262         }
263         spin_unlock_irqrestore(&musb->lock, flags);
266 static irqreturn_t davinci_musb_interrupt(int irq, void *__hci)
268         unsigned long   flags;
269         irqreturn_t     retval = IRQ_NONE;
270         struct musb     *musb = __hci;
271         void __iomem    *tibase = musb->ctrl_base;
272         struct cppi     *cppi;
273         u32             tmp;
275         spin_lock_irqsave(&musb->lock, flags);
277         /* NOTE: DaVinci shadows the Mentor IRQs.  Don't manage them through
278          * the Mentor registers (except for setup), use the TI ones and EOI.
279          *
280          * Docs describe irq "vector" registers associated with the CPPI and
281          * USB EOI registers.  These hold a bitmask corresponding to the
282          * current IRQ, not an irq handler address.  Would using those bits
283          * resolve some of the races observed in this dispatch code??
284          */
286         /* CPPI interrupts share the same IRQ line, but have their own
287          * mask, state, "vector", and EOI registers.
288          */
289         cppi = container_of(musb->dma_controller, struct cppi, controller);
290         if (is_cppi_enabled() && musb->dma_controller && !cppi->irq)
291                 retval = cppi_interrupt(irq, __hci);
293         /* ack and handle non-CPPI interrupts */
294         tmp = musb_readl(tibase, DAVINCI_USB_INT_SRC_MASKED_REG);
295         musb_writel(tibase, DAVINCI_USB_INT_SRC_CLR_REG, tmp);
296         dev_dbg(musb->controller, "IRQ %08x\n", tmp);
298         musb->int_rx = (tmp & DAVINCI_USB_RXINT_MASK)
299                         >> DAVINCI_USB_RXINT_SHIFT;
300         musb->int_tx = (tmp & DAVINCI_USB_TXINT_MASK)
301                         >> DAVINCI_USB_TXINT_SHIFT;
302         musb->int_usb = (tmp & DAVINCI_USB_USBINT_MASK)
303                         >> DAVINCI_USB_USBINT_SHIFT;
305         /* DRVVBUS irqs are the only proxy we have (a very poor one!) for
306          * DaVinci's missing ID change IRQ.  We need an ID change IRQ to
307          * switch appropriately between halves of the OTG state machine.
308          * Managing DEVCTL.SESSION per Mentor docs requires we know its
309          * value, but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
310          * Also, DRVVBUS pulses for SRP (but not at 5V) ...
311          */
312         if (tmp & (DAVINCI_INTR_DRVVBUS << DAVINCI_USB_USBINT_SHIFT)) {
313                 int     drvvbus = musb_readl(tibase, DAVINCI_USB_STAT_REG);
314                 void __iomem *mregs = musb->mregs;
315                 u8      devctl = musb_readb(mregs, MUSB_DEVCTL);
316                 int     err = musb->int_usb & MUSB_INTR_VBUSERROR;
318                 err = is_host_enabled(musb)
319                                 && (musb->int_usb & MUSB_INTR_VBUSERROR);
320                 if (err) {
321                         /* The Mentor core doesn't debounce VBUS as needed
322                          * to cope with device connect current spikes. This
323                          * means it's not uncommon for bus-powered devices
324                          * to get VBUS errors during enumeration.
325                          *
326                          * This is a workaround, but newer RTL from Mentor
327                          * seems to allow a better one: "re"starting sessions
328                          * without waiting (on EVM, a **long** time) for VBUS
329                          * to stop registering in devctl.
330                          */
331                         musb->int_usb &= ~MUSB_INTR_VBUSERROR;
332                         musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
333                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
334                         WARNING("VBUS error workaround (delay coming)\n");
335                 } else if (is_host_enabled(musb) && drvvbus) {
336                         MUSB_HST_MODE(musb);
337                         musb->xceiv->default_a = 1;
338                         musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
339                         portstate(musb->port1_status |= USB_PORT_STAT_POWER);
340                         del_timer(&otg_workaround);
341                 } else {
342                         musb->is_active = 0;
343                         MUSB_DEV_MODE(musb);
344                         musb->xceiv->default_a = 0;
345                         musb->xceiv->state = OTG_STATE_B_IDLE;
346                         portstate(musb->port1_status &= ~USB_PORT_STAT_POWER);
347                 }
349                 /* NOTE:  this must complete poweron within 100 msec
350                  * (OTG_TIME_A_WAIT_VRISE) but we don't check for that.
351                  */
352                 davinci_musb_source_power(musb, drvvbus, 0);
353                 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
354                                 drvvbus ? "on" : "off",
355                                 otg_state_string(musb->xceiv->state),
356                                 err ? " ERROR" : "",
357                                 devctl);
358                 retval = IRQ_HANDLED;
359         }
361         if (musb->int_tx || musb->int_rx || musb->int_usb)
362                 retval |= musb_interrupt(musb);
364         /* irq stays asserted until EOI is written */
365         musb_writel(tibase, DAVINCI_USB_EOI_REG, 0);
367         /* poll for ID change */
368         if (is_otg_enabled(musb)
369                         && musb->xceiv->state == OTG_STATE_B_IDLE)
370                 mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
372         spin_unlock_irqrestore(&musb->lock, flags);
374         return retval;
377 static int davinci_musb_set_mode(struct musb *musb, u8 mode)
379         /* EVM can't do this (right?) */
380         return -EIO;
383 static int davinci_musb_init(struct musb *musb)
385         void __iomem    *tibase = musb->ctrl_base;
386         u32             revision;
388         usb_nop_xceiv_register();
389         musb->xceiv = otg_get_transceiver();
390         if (!musb->xceiv)
391                 return -ENODEV;
393         musb->mregs += DAVINCI_BASE_OFFSET;
395         /* returns zero if e.g. not clocked */
396         revision = musb_readl(tibase, DAVINCI_USB_VERSION_REG);
397         if (revision == 0)
398                 goto fail;
400         if (is_host_enabled(musb))
401                 setup_timer(&otg_workaround, otg_timer, (unsigned long) musb);
403         davinci_musb_source_power(musb, 0, 1);
405         /* dm355 EVM swaps D+/D- for signal integrity, and
406          * is clocked from the main 24 MHz crystal.
407          */
408         if (machine_is_davinci_dm355_evm()) {
409                 u32     phy_ctrl = __raw_readl(USB_PHY_CTRL);
411                 phy_ctrl &= ~(3 << 9);
412                 phy_ctrl |= USBPHY_DATAPOL;
413                 __raw_writel(phy_ctrl, USB_PHY_CTRL);
414         }
416         /* On dm355, the default-A state machine needs DRVVBUS control.
417          * If we won't be a host, there's no need to turn it on.
418          */
419         if (cpu_is_davinci_dm355()) {
420                 u32     deepsleep = __raw_readl(DM355_DEEPSLEEP);
422                 if (is_host_enabled(musb)) {
423                         deepsleep &= ~DRVVBUS_OVERRIDE;
424                 } else {
425                         deepsleep &= ~DRVVBUS_FORCE;
426                         deepsleep |= DRVVBUS_OVERRIDE;
427                 }
428                 __raw_writel(deepsleep, DM355_DEEPSLEEP);
429         }
431         /* reset the controller */
432         musb_writel(tibase, DAVINCI_USB_CTRL_REG, 0x1);
434         /* start the on-chip PHY and its PLL */
435         phy_on();
437         msleep(5);
439         /* NOTE:  irqs are in mixed mode, not bypass to pure-musb */
440         pr_debug("DaVinci OTG revision %08x phy %03x control %02x\n",
441                 revision, __raw_readl(USB_PHY_CTRL),
442                 musb_readb(tibase, DAVINCI_USB_CTRL_REG));
444         musb->isr = davinci_musb_interrupt;
445         return 0;
447 fail:
448         otg_put_transceiver(musb->xceiv);
449         usb_nop_xceiv_unregister();
450         return -ENODEV;
453 static int davinci_musb_exit(struct musb *musb)
455         if (is_host_enabled(musb))
456                 del_timer_sync(&otg_workaround);
458         /* force VBUS off */
459         if (cpu_is_davinci_dm355()) {
460                 u32     deepsleep = __raw_readl(DM355_DEEPSLEEP);
462                 deepsleep &= ~DRVVBUS_FORCE;
463                 deepsleep |= DRVVBUS_OVERRIDE;
464                 __raw_writel(deepsleep, DM355_DEEPSLEEP);
465         }
467         davinci_musb_source_power(musb, 0 /*off*/, 1);
469         /* delay, to avoid problems with module reload */
470         if (is_host_enabled(musb) && musb->xceiv->default_a) {
471                 int     maxdelay = 30;
472                 u8      devctl, warn = 0;
474                 /* if there's no peripheral connected, this can take a
475                  * long time to fall, especially on EVM with huge C133.
476                  */
477                 do {
478                         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
479                         if (!(devctl & MUSB_DEVCTL_VBUS))
480                                 break;
481                         if ((devctl & MUSB_DEVCTL_VBUS) != warn) {
482                                 warn = devctl & MUSB_DEVCTL_VBUS;
483                                 dev_dbg(musb->controller, "VBUS %d\n",
484                                         warn >> MUSB_DEVCTL_VBUS_SHIFT);
485                         }
486                         msleep(1000);
487                         maxdelay--;
488                 } while (maxdelay > 0);
490                 /* in OTG mode, another host might be connected */
491                 if (devctl & MUSB_DEVCTL_VBUS)
492                         dev_dbg(musb->controller, "VBUS off timeout (devctl %02x)\n", devctl);
493         }
495         phy_off();
497         otg_put_transceiver(musb->xceiv);
498         usb_nop_xceiv_unregister();
500         return 0;
503 static const struct musb_platform_ops davinci_ops = {
504         .fifo_mode      = 2,
505         .init           = davinci_musb_init,
506         .exit           = davinci_musb_exit,
508         .enable         = davinci_musb_enable,
509         .disable        = davinci_musb_disable,
511         .set_mode       = davinci_musb_set_mode,
513         .set_vbus       = davinci_musb_set_vbus,
515         .read_fifo      = musb_read_fifo,
516         .write_fifo     = musb_write_fifo,
517 };
519 static u64 davinci_dmamask = DMA_BIT_MASK(32);
521 static int __init davinci_probe(struct platform_device *pdev)
523         struct musb_hdrc_platform_data  *pdata = pdev->dev.platform_data;
524         struct platform_device          *musb;
525         struct davinci_glue             *glue;
526         struct clk                      *clk;
528         int                             ret = -ENOMEM;
530         glue = kzalloc(sizeof(*glue), GFP_KERNEL);
531         if (!glue) {
532                 dev_err(&pdev->dev, "failed to allocate glue context\n");
533                 goto err0;
534         }
536         musb = platform_device_alloc("musb-hdrc", -1);
537         if (!musb) {
538                 dev_err(&pdev->dev, "failed to allocate musb device\n");
539                 goto err1;
540         }
542         clk = clk_get(&pdev->dev, "usb");
543         if (IS_ERR(clk)) {
544                 dev_err(&pdev->dev, "failed to get clock\n");
545                 ret = PTR_ERR(clk);
546                 goto err2;
547         }
549         ret = clk_enable(clk);
550         if (ret) {
551                 dev_err(&pdev->dev, "failed to enable clock\n");
552                 goto err3;
553         }
555         musb->dev.parent                = &pdev->dev;
556         musb->dev.dma_mask              = &davinci_dmamask;
557         musb->dev.coherent_dma_mask     = davinci_dmamask;
559         glue->dev                       = &pdev->dev;
560         glue->musb                      = musb;
561         glue->clk                       = clk;
563         pdata->platform_ops             = &davinci_ops;
565         platform_set_drvdata(pdev, glue);
567         ret = platform_device_add_resources(musb, pdev->resource,
568                         pdev->num_resources);
569         if (ret) {
570                 dev_err(&pdev->dev, "failed to add resources\n");
571                 goto err4;
572         }
574         ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
575         if (ret) {
576                 dev_err(&pdev->dev, "failed to add platform_data\n");
577                 goto err4;
578         }
580         ret = platform_device_add(musb);
581         if (ret) {
582                 dev_err(&pdev->dev, "failed to register musb device\n");
583                 goto err4;
584         }
586         return 0;
588 err4:
589         clk_disable(clk);
591 err3:
592         clk_put(clk);
594 err2:
595         platform_device_put(musb);
597 err1:
598         kfree(glue);
600 err0:
601         return ret;
604 static int __exit davinci_remove(struct platform_device *pdev)
606         struct davinci_glue             *glue = platform_get_drvdata(pdev);
608         platform_device_del(glue->musb);
609         platform_device_put(glue->musb);
610         clk_disable(glue->clk);
611         clk_put(glue->clk);
612         kfree(glue);
614         return 0;
617 static struct platform_driver davinci_driver = {
618         .remove         = __exit_p(davinci_remove),
619         .driver         = {
620                 .name   = "musb-davinci",
621         },
622 };
624 MODULE_DESCRIPTION("DaVinci MUSB Glue Layer");
625 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
626 MODULE_LICENSE("GPL v2");
628 static int __init davinci_init(void)
630         return platform_driver_probe(&davinci_driver, davinci_probe);
632 subsys_initcall(davinci_init);
634 static void __exit davinci_exit(void)
636         platform_driver_unregister(&davinci_driver);
638 module_exit(davinci_exit);