bdf1940d6fee8941cee047fa205f520e744a2351
[pandora-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  */
23
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>
35
36 #include <mach/hardware.h>
37 #include <mach/memory.h>
38 #include <mach/gpio.h>
39 #include <mach/cputype.h>
40
41 #include <asm/mach-types.h>
42
43 #include "musb_core.h"
44
45 #ifdef CONFIG_MACH_DAVINCI_EVM
46 #define GPIO_nVBUS_DRV          160
47 #endif
48
49 #include "davinci.h"
50 #include "cppi_dma.h"
51
52
53 #define USB_PHY_CTRL    IO_ADDRESS(USBPHY_CTL_PADDR)
54 #define DM355_DEEPSLEEP IO_ADDRESS(DM355_DEEPSLEEP_PADDR)
55
56 /* REVISIT (PM) we should be able to keep the PHY in low power mode most
57  * of the time (24 MHZ oscillator and PLL off, etc) by setting POWER.D0
58  * and, when in host mode, autosuspending idle root ports... PHYPLLON
59  * (overriding SUSPENDM?) then likely needs to stay off.
60  */
61
62 static inline void phy_on(void)
63 {
64         u32     phy_ctrl = __raw_readl(USB_PHY_CTRL);
65
66         /* power everything up; start the on-chip PHY and its PLL */
67         phy_ctrl &= ~(USBPHY_OSCPDWN | USBPHY_OTGPDWN | USBPHY_PHYPDWN);
68         phy_ctrl |= USBPHY_SESNDEN | USBPHY_VBDTCTEN | USBPHY_PHYPLLON;
69         __raw_writel(phy_ctrl, USB_PHY_CTRL);
70
71         /* wait for PLL to lock before proceeding */
72         while ((__raw_readl(USB_PHY_CTRL) & USBPHY_PHYCLKGD) == 0)
73                 cpu_relax();
74 }
75
76 static inline void phy_off(void)
77 {
78         u32     phy_ctrl = __raw_readl(USB_PHY_CTRL);
79
80         /* powerdown the on-chip PHY, its PLL, and the OTG block */
81         phy_ctrl &= ~(USBPHY_SESNDEN | USBPHY_VBDTCTEN | USBPHY_PHYPLLON);
82         phy_ctrl |= USBPHY_OSCPDWN | USBPHY_OTGPDWN | USBPHY_PHYPDWN;
83         __raw_writel(phy_ctrl, USB_PHY_CTRL);
84 }
85
86 static int dma_off = 1;
87
88 static void davinci_musb_enable(struct musb *musb)
89 {
90         u32     tmp, old, val;
91
92         /* workaround:  setup irqs through both register sets */
93         tmp = (musb->epmask & DAVINCI_USB_TX_ENDPTS_MASK)
94                         << DAVINCI_USB_TXINT_SHIFT;
95         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_SET_REG, tmp);
96         old = tmp;
97         tmp = (musb->epmask & (0xfffe & DAVINCI_USB_RX_ENDPTS_MASK))
98                         << DAVINCI_USB_RXINT_SHIFT;
99         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_SET_REG, tmp);
100         tmp |= old;
101
102         val = ~MUSB_INTR_SOF;
103         tmp |= ((val & 0x01ff) << DAVINCI_USB_USBINT_SHIFT);
104         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_SET_REG, tmp);
105
106         if (is_dma_capable() && !dma_off)
107                 printk(KERN_WARNING "%s %s: dma not reactivated\n",
108                                 __FILE__, __func__);
109         else
110                 dma_off = 0;
111
112         /* force a DRVVBUS irq so we can start polling for ID change */
113         if (is_otg_enabled(musb))
114                 musb_writel(musb->ctrl_base, DAVINCI_USB_INT_SET_REG,
115                         DAVINCI_INTR_DRVVBUS << DAVINCI_USB_USBINT_SHIFT);
116 }
117
118 /*
119  * Disable the HDRC and flush interrupts
120  */
121 static void davinci_musb_disable(struct musb *musb)
122 {
123         /* because we don't set CTRLR.UINT, "important" to:
124          *  - not read/write INTRUSB/INTRUSBE
125          *  - (except during initial setup, as workaround)
126          *  - use INTSETR/INTCLRR instead
127          */
128         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_CLR_REG,
129                           DAVINCI_USB_USBINT_MASK
130                         | DAVINCI_USB_TXINT_MASK
131                         | DAVINCI_USB_RXINT_MASK);
132         musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
133         musb_writel(musb->ctrl_base, DAVINCI_USB_EOI_REG, 0);
134
135         if (is_dma_capable() && !dma_off)
136                 WARNING("dma still active\n");
137 }
138
139
140 #ifdef CONFIG_USB_MUSB_HDRC_HCD
141 #define portstate(stmt)         stmt
142 #else
143 #define portstate(stmt)
144 #endif
145
146
147 /*
148  * VBUS SWITCHING IS BOARD-SPECIFIC ... at least for the DM6446 EVM,
149  * which doesn't wire DRVVBUS to the FET that switches it.  Unclear
150  * if that's a problem with the DM6446 chip or just with that board.
151  *
152  * In either case, the DM355 EVM automates DRVVBUS the normal way,
153  * when J10 is out, and TI documents it as handling OTG.
154  */
155
156 #ifdef CONFIG_MACH_DAVINCI_EVM
157
158 static int vbus_state = -1;
159
160 /* I2C operations are always synchronous, and require a task context.
161  * With unloaded systems, using the shared workqueue seems to suffice
162  * to satisfy the 100msec A_WAIT_VRISE timeout...
163  */
164 static void evm_deferred_drvvbus(struct work_struct *ignored)
165 {
166         gpio_set_value_cansleep(GPIO_nVBUS_DRV, vbus_state);
167         vbus_state = !vbus_state;
168 }
169
170 #endif  /* EVM */
171
172 static void davinci_musb_source_power(struct musb *musb, int is_on, int immediate)
173 {
174 #ifdef CONFIG_MACH_DAVINCI_EVM
175         if (is_on)
176                 is_on = 1;
177
178         if (vbus_state == is_on)
179                 return;
180         vbus_state = !is_on;            /* 0/1 vs "-1 == unknown/init" */
181
182         if (machine_is_davinci_evm()) {
183                 static DECLARE_WORK(evm_vbus_work, evm_deferred_drvvbus);
184
185                 if (immediate)
186                         gpio_set_value_cansleep(GPIO_nVBUS_DRV, vbus_state);
187                 else
188                         schedule_work(&evm_vbus_work);
189         }
190         if (immediate)
191                 vbus_state = is_on;
192 #endif
193 }
194
195 static void davinci_musb_set_vbus(struct musb *musb, int is_on)
196 {
197         WARN_ON(is_on && is_peripheral_active(musb));
198         davinci_musb_source_power(musb, is_on, 0);
199 }
200
201
202 #define POLL_SECONDS    2
203
204 static struct timer_list otg_workaround;
205
206 static void otg_timer(unsigned long _musb)
207 {
208         struct musb             *musb = (void *)_musb;
209         void __iomem            *mregs = musb->mregs;
210         u8                      devctl;
211         unsigned long           flags;
212
213         /* We poll because DaVinci's won't expose several OTG-critical
214         * status change events (from the transceiver) otherwise.
215          */
216         devctl = musb_readb(mregs, MUSB_DEVCTL);
217         DBG(7, "poll devctl %02x (%s)\n", devctl, otg_state_string(musb));
218
219         spin_lock_irqsave(&musb->lock, flags);
220         switch (musb->xceiv->state) {
221         case OTG_STATE_A_WAIT_VFALL:
222                 /* Wait till VBUS falls below SessionEnd (~0.2V); the 1.3 RTL
223                  * seems to mis-handle session "start" otherwise (or in our
224                  * case "recover"), in routine "VBUS was valid by the time
225                  * VBUSERR got reported during enumeration" cases.
226                  */
227                 if (devctl & MUSB_DEVCTL_VBUS) {
228                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
229                         break;
230                 }
231                 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
232                 musb_writel(musb->ctrl_base, DAVINCI_USB_INT_SET_REG,
233                         MUSB_INTR_VBUSERROR << DAVINCI_USB_USBINT_SHIFT);
234                 break;
235         case OTG_STATE_B_IDLE:
236                 if (!is_peripheral_enabled(musb))
237                         break;
238
239                 /* There's no ID-changed IRQ, so we have no good way to tell
240                  * when to switch to the A-Default state machine (by setting
241                  * the DEVCTL.SESSION flag).
242                  *
243                  * Workaround:  whenever we're in B_IDLE, try setting the
244                  * session flag every few seconds.  If it works, ID was
245                  * grounded and we're now in the A-Default state machine.
246                  *
247                  * NOTE setting the session flag is _supposed_ to trigger
248                  * SRP, but clearly it doesn't.
249                  */
250                 musb_writeb(mregs, MUSB_DEVCTL,
251                                 devctl | MUSB_DEVCTL_SESSION);
252                 devctl = musb_readb(mregs, MUSB_DEVCTL);
253                 if (devctl & MUSB_DEVCTL_BDEVICE)
254                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
255                 else
256                         musb->xceiv->state = OTG_STATE_A_IDLE;
257                 break;
258         default:
259                 break;
260         }
261         spin_unlock_irqrestore(&musb->lock, flags);
262 }
263
264 static irqreturn_t davinci_musb_interrupt(int irq, void *__hci)
265 {
266         unsigned long   flags;
267         irqreturn_t     retval = IRQ_NONE;
268         struct musb     *musb = __hci;
269         void __iomem    *tibase = musb->ctrl_base;
270         struct cppi     *cppi;
271         u32             tmp;
272
273         spin_lock_irqsave(&musb->lock, flags);
274
275         /* NOTE: DaVinci shadows the Mentor IRQs.  Don't manage them through
276          * the Mentor registers (except for setup), use the TI ones and EOI.
277          *
278          * Docs describe irq "vector" registers associated with the CPPI and
279          * USB EOI registers.  These hold a bitmask corresponding to the
280          * current IRQ, not an irq handler address.  Would using those bits
281          * resolve some of the races observed in this dispatch code??
282          */
283
284         /* CPPI interrupts share the same IRQ line, but have their own
285          * mask, state, "vector", and EOI registers.
286          */
287         cppi = container_of(musb->dma_controller, struct cppi, controller);
288         if (is_cppi_enabled() && musb->dma_controller && !cppi->irq)
289                 retval = cppi_interrupt(irq, __hci);
290
291         /* ack and handle non-CPPI interrupts */
292         tmp = musb_readl(tibase, DAVINCI_USB_INT_SRC_MASKED_REG);
293         musb_writel(tibase, DAVINCI_USB_INT_SRC_CLR_REG, tmp);
294         DBG(4, "IRQ %08x\n", tmp);
295
296         musb->int_rx = (tmp & DAVINCI_USB_RXINT_MASK)
297                         >> DAVINCI_USB_RXINT_SHIFT;
298         musb->int_tx = (tmp & DAVINCI_USB_TXINT_MASK)
299                         >> DAVINCI_USB_TXINT_SHIFT;
300         musb->int_usb = (tmp & DAVINCI_USB_USBINT_MASK)
301                         >> DAVINCI_USB_USBINT_SHIFT;
302
303         /* DRVVBUS irqs are the only proxy we have (a very poor one!) for
304          * DaVinci's missing ID change IRQ.  We need an ID change IRQ to
305          * switch appropriately between halves of the OTG state machine.
306          * Managing DEVCTL.SESSION per Mentor docs requires we know its
307          * value, but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
308          * Also, DRVVBUS pulses for SRP (but not at 5V) ...
309          */
310         if (tmp & (DAVINCI_INTR_DRVVBUS << DAVINCI_USB_USBINT_SHIFT)) {
311                 int     drvvbus = musb_readl(tibase, DAVINCI_USB_STAT_REG);
312                 void __iomem *mregs = musb->mregs;
313                 u8      devctl = musb_readb(mregs, MUSB_DEVCTL);
314                 int     err = musb->int_usb & MUSB_INTR_VBUSERROR;
315
316                 err = is_host_enabled(musb)
317                                 && (musb->int_usb & MUSB_INTR_VBUSERROR);
318                 if (err) {
319                         /* The Mentor core doesn't debounce VBUS as needed
320                          * to cope with device connect current spikes. This
321                          * means it's not uncommon for bus-powered devices
322                          * to get VBUS errors during enumeration.
323                          *
324                          * This is a workaround, but newer RTL from Mentor
325                          * seems to allow a better one: "re"starting sessions
326                          * without waiting (on EVM, a **long** time) for VBUS
327                          * to stop registering in devctl.
328                          */
329                         musb->int_usb &= ~MUSB_INTR_VBUSERROR;
330                         musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
331                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
332                         WARNING("VBUS error workaround (delay coming)\n");
333                 } else if (is_host_enabled(musb) && drvvbus) {
334                         MUSB_HST_MODE(musb);
335                         musb->xceiv->default_a = 1;
336                         musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
337                         portstate(musb->port1_status |= USB_PORT_STAT_POWER);
338                         del_timer(&otg_workaround);
339                 } else {
340                         musb->is_active = 0;
341                         MUSB_DEV_MODE(musb);
342                         musb->xceiv->default_a = 0;
343                         musb->xceiv->state = OTG_STATE_B_IDLE;
344                         portstate(musb->port1_status &= ~USB_PORT_STAT_POWER);
345                 }
346
347                 /* NOTE:  this must complete poweron within 100 msec
348                  * (OTG_TIME_A_WAIT_VRISE) but we don't check for that.
349                  */
350                 davinci_musb_source_power(musb, drvvbus, 0);
351                 DBG(2, "VBUS %s (%s)%s, devctl %02x\n",
352                                 drvvbus ? "on" : "off",
353                                 otg_state_string(musb),
354                                 err ? " ERROR" : "",
355                                 devctl);
356                 retval = IRQ_HANDLED;
357         }
358
359         if (musb->int_tx || musb->int_rx || musb->int_usb)
360                 retval |= musb_interrupt(musb);
361
362         /* irq stays asserted until EOI is written */
363         musb_writel(tibase, DAVINCI_USB_EOI_REG, 0);
364
365         /* poll for ID change */
366         if (is_otg_enabled(musb)
367                         && musb->xceiv->state == OTG_STATE_B_IDLE)
368                 mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
369
370         spin_unlock_irqrestore(&musb->lock, flags);
371
372         return retval;
373 }
374
375 static int davinci_musb_set_mode(struct musb *musb, u8 mode)
376 {
377         /* EVM can't do this (right?) */
378         return -EIO;
379 }
380
381 static int davinci_musb_init(struct musb *musb)
382 {
383         void __iomem    *tibase = musb->ctrl_base;
384         u32             revision;
385
386         usb_nop_xceiv_register();
387         musb->xceiv = otg_get_transceiver();
388         if (!musb->xceiv)
389                 return -ENODEV;
390
391         musb->mregs += DAVINCI_BASE_OFFSET;
392
393         clk_enable(musb->clock);
394
395         /* returns zero if e.g. not clocked */
396         revision = musb_readl(tibase, DAVINCI_USB_VERSION_REG);
397         if (revision == 0)
398                 goto fail;
399
400         if (is_host_enabled(musb))
401                 setup_timer(&otg_workaround, otg_timer, (unsigned long) musb);
402
403         musb->board_set_vbus = davinci_musb_set_vbus;
404         davinci_musb_source_power(musb, 0, 1);
405
406         /* dm355 EVM swaps D+/D- for signal integrity, and
407          * is clocked from the main 24 MHz crystal.
408          */
409         if (machine_is_davinci_dm355_evm()) {
410                 u32     phy_ctrl = __raw_readl(USB_PHY_CTRL);
411
412                 phy_ctrl &= ~(3 << 9);
413                 phy_ctrl |= USBPHY_DATAPOL;
414                 __raw_writel(phy_ctrl, USB_PHY_CTRL);
415         }
416
417         /* On dm355, the default-A state machine needs DRVVBUS control.
418          * If we won't be a host, there's no need to turn it on.
419          */
420         if (cpu_is_davinci_dm355()) {
421                 u32     deepsleep = __raw_readl(DM355_DEEPSLEEP);
422
423                 if (is_host_enabled(musb)) {
424                         deepsleep &= ~DRVVBUS_OVERRIDE;
425                 } else {
426                         deepsleep &= ~DRVVBUS_FORCE;
427                         deepsleep |= DRVVBUS_OVERRIDE;
428                 }
429                 __raw_writel(deepsleep, DM355_DEEPSLEEP);
430         }
431
432         /* reset the controller */
433         musb_writel(tibase, DAVINCI_USB_CTRL_REG, 0x1);
434
435         /* start the on-chip PHY and its PLL */
436         phy_on();
437
438         msleep(5);
439
440         /* NOTE:  irqs are in mixed mode, not bypass to pure-musb */
441         pr_debug("DaVinci OTG revision %08x phy %03x control %02x\n",
442                 revision, __raw_readl(USB_PHY_CTRL),
443                 musb_readb(tibase, DAVINCI_USB_CTRL_REG));
444
445         musb->isr = davinci_musb_interrupt;
446         return 0;
447
448 fail:
449         clk_disable(musb->clock);
450
451         otg_put_transceiver(musb->xceiv);
452         usb_nop_xceiv_unregister();
453         return -ENODEV;
454 }
455
456 static int davinci_musb_exit(struct musb *musb)
457 {
458         if (is_host_enabled(musb))
459                 del_timer_sync(&otg_workaround);
460
461         /* force VBUS off */
462         if (cpu_is_davinci_dm355()) {
463                 u32     deepsleep = __raw_readl(DM355_DEEPSLEEP);
464
465                 deepsleep &= ~DRVVBUS_FORCE;
466                 deepsleep |= DRVVBUS_OVERRIDE;
467                 __raw_writel(deepsleep, DM355_DEEPSLEEP);
468         }
469
470         davinci_musb_source_power(musb, 0 /*off*/, 1);
471
472         /* delay, to avoid problems with module reload */
473         if (is_host_enabled(musb) && musb->xceiv->default_a) {
474                 int     maxdelay = 30;
475                 u8      devctl, warn = 0;
476
477                 /* if there's no peripheral connected, this can take a
478                  * long time to fall, especially on EVM with huge C133.
479                  */
480                 do {
481                         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
482                         if (!(devctl & MUSB_DEVCTL_VBUS))
483                                 break;
484                         if ((devctl & MUSB_DEVCTL_VBUS) != warn) {
485                                 warn = devctl & MUSB_DEVCTL_VBUS;
486                                 DBG(1, "VBUS %d\n",
487                                         warn >> MUSB_DEVCTL_VBUS_SHIFT);
488                         }
489                         msleep(1000);
490                         maxdelay--;
491                 } while (maxdelay > 0);
492
493                 /* in OTG mode, another host might be connected */
494                 if (devctl & MUSB_DEVCTL_VBUS)
495                         DBG(1, "VBUS off timeout (devctl %02x)\n", devctl);
496         }
497
498         phy_off();
499
500         clk_disable(musb->clock);
501
502         otg_put_transceiver(musb->xceiv);
503         usb_nop_xceiv_unregister();
504
505         return 0;
506 }
507
508 const struct musb_platform_ops musb_ops = {
509         .init           = davinci_musb_init,
510         .exit           = davinci_musb_exit,
511
512         .enable         = davinci_musb_enable,
513         .disable        = davinci_musb_disable,
514
515         .set_mode       = davinci_musb_set_mode,
516
517         .set_vbus       = davinci_musb_set_vbus,
518 };
519
520 static u64 davinci_dmamask = DMA_BIT_MASK(32);
521
522 static int __init davinci_probe(struct platform_device *pdev)
523 {
524         struct musb_hdrc_platform_data  *pdata = pdev->dev.platform_data;
525         struct platform_device          *musb;
526
527         int                             ret = -ENOMEM;
528
529         musb = platform_device_alloc("musb-hdrc", -1);
530         if (!musb) {
531                 dev_err(&pdev->dev, "failed to allocate musb device\n");
532                 goto err0;
533         }
534
535         musb->dev.parent                = &pdev->dev;
536         musb->dev.dma_mask              = &davinci_dmamask;
537         musb->dev.coherent_dma_mask     = davinci_dmamask;
538
539         platform_set_drvdata(pdev, musb);
540
541         ret = platform_device_add_resources(musb, pdev->resource,
542                         pdev->num_resources);
543         if (ret) {
544                 dev_err(&pdev->dev, "failed to add resources\n");
545                 goto err1;
546         }
547
548         ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
549         if (ret) {
550                 dev_err(&pdev->dev, "failed to add platform_data\n");
551                 goto err1;
552         }
553
554         ret = platform_device_add(musb);
555         if (ret) {
556                 dev_err(&pdev->dev, "failed to register musb device\n");
557                 goto err1;
558         }
559
560         return 0;
561
562 err1:
563         platform_device_put(musb);
564
565 err0:
566         return ret;
567 }
568
569 static int __exit davinci_remove(struct platform_device *pdev)
570 {
571         struct platform_device          *musb = platform_get_drvdata(pdev);
572
573         platform_device_del(musb);
574         platform_device_put(musb);
575
576         return 0;
577 }
578
579 static struct platform_driver davinci_driver = {
580         .remove         = __exit_p(davinci_remove),
581         .driver         = {
582                 .name   = "musb-davinci",
583         },
584 };
585
586 MODULE_DESCRIPTION("DaVinci MUSB Glue Layer");
587 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
588 MODULE_LICENSE("GPL v2");
589
590 static int __init davinci_init(void)
591 {
592         return platform_driver_probe(&davinci_driver, davinci_probe);
593 }
594 subsys_initcall(davinci_init);
595
596 static void __exit davinci_exit(void)
597 {
598         platform_driver_unregister(&davinci_driver);
599 }
600 module_exit(davinci_exit);