eCryptfs: Extend array bounds for all filename chars
[pandora-kernel.git] / drivers / usb / musb / da8xx.c
1 /*
2  * Texas Instruments DA8xx/OMAP-L1x "glue layer"
3  *
4  * Copyright (c) 2008-2009 MontaVista Software, Inc. <source@mvista.com>
5  *
6  * Based on the DaVinci "glue layer" code.
7  * Copyright (C) 2005-2006 by Texas Instruments
8  *
9  * This file is part of the Inventra Controller Driver for Linux.
10  *
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
14  * Foundation.
15  *
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.
21  *
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
26  *
27  */
28
29 #include <linux/init.h>
30 #include <linux/clk.h>
31 #include <linux/io.h>
32 #include <linux/platform_device.h>
33 #include <linux/dma-mapping.h>
34
35 #include <mach/da8xx.h>
36 #include <mach/usb.h>
37
38 #include "musb_core.h"
39
40 /*
41  * DA8XX specific definitions
42  */
43
44 /* USB 2.0 OTG module registers */
45 #define DA8XX_USB_REVISION_REG  0x00
46 #define DA8XX_USB_CTRL_REG      0x04
47 #define DA8XX_USB_STAT_REG      0x08
48 #define DA8XX_USB_EMULATION_REG 0x0c
49 #define DA8XX_USB_MODE_REG      0x10    /* Transparent, CDC, [Generic] RNDIS */
50 #define DA8XX_USB_AUTOREQ_REG   0x14
51 #define DA8XX_USB_SRP_FIX_TIME_REG 0x18
52 #define DA8XX_USB_TEARDOWN_REG  0x1c
53 #define DA8XX_USB_INTR_SRC_REG  0x20
54 #define DA8XX_USB_INTR_SRC_SET_REG 0x24
55 #define DA8XX_USB_INTR_SRC_CLEAR_REG 0x28
56 #define DA8XX_USB_INTR_MASK_REG 0x2c
57 #define DA8XX_USB_INTR_MASK_SET_REG 0x30
58 #define DA8XX_USB_INTR_MASK_CLEAR_REG 0x34
59 #define DA8XX_USB_INTR_SRC_MASKED_REG 0x38
60 #define DA8XX_USB_END_OF_INTR_REG 0x3c
61 #define DA8XX_USB_GENERIC_RNDIS_EP_SIZE_REG(n) (0x50 + (((n) - 1) << 2))
62
63 /* Control register bits */
64 #define DA8XX_SOFT_RESET_MASK   1
65
66 #define DA8XX_USB_TX_EP_MASK    0x1f            /* EP0 + 4 Tx EPs */
67 #define DA8XX_USB_RX_EP_MASK    0x1e            /* 4 Rx EPs */
68
69 /* USB interrupt register bits */
70 #define DA8XX_INTR_USB_SHIFT    16
71 #define DA8XX_INTR_USB_MASK     (0x1ff << DA8XX_INTR_USB_SHIFT) /* 8 Mentor */
72                                         /* interrupts and DRVVBUS interrupt */
73 #define DA8XX_INTR_DRVVBUS      0x100
74 #define DA8XX_INTR_RX_SHIFT     8
75 #define DA8XX_INTR_RX_MASK      (DA8XX_USB_RX_EP_MASK << DA8XX_INTR_RX_SHIFT)
76 #define DA8XX_INTR_TX_SHIFT     0
77 #define DA8XX_INTR_TX_MASK      (DA8XX_USB_TX_EP_MASK << DA8XX_INTR_TX_SHIFT)
78
79 #define DA8XX_MENTOR_CORE_OFFSET 0x400
80
81 #define CFGCHIP2        IO_ADDRESS(DA8XX_SYSCFG0_BASE + DA8XX_CFGCHIP2_REG)
82
83 struct da8xx_glue {
84         struct device           *dev;
85         struct platform_device  *musb;
86         struct clk              *clk;
87 };
88
89 /*
90  * REVISIT (PM): we should be able to keep the PHY in low power mode most
91  * of the time (24 MHz oscillator and PLL off, etc.) by setting POWER.D0
92  * and, when in host mode, autosuspending idle root ports... PHY_PLLON
93  * (overriding SUSPENDM?) then likely needs to stay off.
94  */
95
96 static inline void phy_on(void)
97 {
98         u32 cfgchip2 = __raw_readl(CFGCHIP2);
99
100         /*
101          * Start the on-chip PHY and its PLL.
102          */
103         cfgchip2 &= ~(CFGCHIP2_RESET | CFGCHIP2_PHYPWRDN | CFGCHIP2_OTGPWRDN);
104         cfgchip2 |= CFGCHIP2_PHY_PLLON;
105         __raw_writel(cfgchip2, CFGCHIP2);
106
107         pr_info("Waiting for USB PHY clock good...\n");
108         while (!(__raw_readl(CFGCHIP2) & CFGCHIP2_PHYCLKGD))
109                 cpu_relax();
110 }
111
112 static inline void phy_off(void)
113 {
114         u32 cfgchip2 = __raw_readl(CFGCHIP2);
115
116         /*
117          * Ensure that USB 1.1 reference clock is not being sourced from
118          * USB 2.0 PHY.  Otherwise do not power down the PHY.
119          */
120         if (!(cfgchip2 & CFGCHIP2_USB1PHYCLKMUX) &&
121              (cfgchip2 & CFGCHIP2_USB1SUSPENDM)) {
122                 pr_warning("USB 1.1 clocked from USB 2.0 PHY -- "
123                            "can't power it down\n");
124                 return;
125         }
126
127         /*
128          * Power down the on-chip PHY.
129          */
130         cfgchip2 |= CFGCHIP2_PHYPWRDN | CFGCHIP2_OTGPWRDN;
131         __raw_writel(cfgchip2, CFGCHIP2);
132 }
133
134 /*
135  * Because we don't set CTRL.UINT, it's "important" to:
136  *      - not read/write INTRUSB/INTRUSBE (except during
137  *        initial setup, as a workaround);
138  *      - use INTSET/INTCLR instead.
139  */
140
141 /**
142  * da8xx_musb_enable - enable interrupts
143  */
144 static void da8xx_musb_enable(struct musb *musb)
145 {
146         void __iomem *reg_base = musb->ctrl_base;
147         u32 mask;
148
149         /* Workaround: setup IRQs through both register sets. */
150         mask = ((musb->epmask & DA8XX_USB_TX_EP_MASK) << DA8XX_INTR_TX_SHIFT) |
151                ((musb->epmask & DA8XX_USB_RX_EP_MASK) << DA8XX_INTR_RX_SHIFT) |
152                DA8XX_INTR_USB_MASK;
153         musb_writel(reg_base, DA8XX_USB_INTR_MASK_SET_REG, mask);
154
155         /* Force the DRVVBUS IRQ so we can start polling for ID change. */
156         if (is_otg_enabled(musb))
157                 musb_writel(reg_base, DA8XX_USB_INTR_SRC_SET_REG,
158                             DA8XX_INTR_DRVVBUS << DA8XX_INTR_USB_SHIFT);
159 }
160
161 /**
162  * da8xx_musb_disable - disable HDRC and flush interrupts
163  */
164 static void da8xx_musb_disable(struct musb *musb)
165 {
166         void __iomem *reg_base = musb->ctrl_base;
167
168         musb_writel(reg_base, DA8XX_USB_INTR_MASK_CLEAR_REG,
169                     DA8XX_INTR_USB_MASK |
170                     DA8XX_INTR_TX_MASK | DA8XX_INTR_RX_MASK);
171         musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
172         musb_writel(reg_base, DA8XX_USB_END_OF_INTR_REG, 0);
173 }
174
175 #define portstate(stmt)         stmt
176
177 static void da8xx_musb_set_vbus(struct musb *musb, int is_on)
178 {
179         WARN_ON(is_on && is_peripheral_active(musb));
180 }
181
182 #define POLL_SECONDS    2
183
184 static struct timer_list otg_workaround;
185
186 static void otg_timer(unsigned long _musb)
187 {
188         struct musb             *musb = (void *)_musb;
189         void __iomem            *mregs = musb->mregs;
190         u8                      devctl;
191         unsigned long           flags;
192
193         /*
194          * We poll because DaVinci's won't expose several OTG-critical
195          * status change events (from the transceiver) otherwise.
196          */
197         devctl = musb_readb(mregs, MUSB_DEVCTL);
198         dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
199                 otg_state_string(musb->xceiv->state));
200
201         spin_lock_irqsave(&musb->lock, flags);
202         switch (musb->xceiv->state) {
203         case OTG_STATE_A_WAIT_BCON:
204                 devctl &= ~MUSB_DEVCTL_SESSION;
205                 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
206
207                 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
208                 if (devctl & MUSB_DEVCTL_BDEVICE) {
209                         musb->xceiv->state = OTG_STATE_B_IDLE;
210                         MUSB_DEV_MODE(musb);
211                 } else {
212                         musb->xceiv->state = OTG_STATE_A_IDLE;
213                         MUSB_HST_MODE(musb);
214                 }
215                 break;
216         case OTG_STATE_A_WAIT_VFALL:
217                 /*
218                  * Wait till VBUS falls below SessionEnd (~0.2 V); the 1.3
219                  * RTL seems to mis-handle session "start" otherwise (or in
220                  * our case "recover"), in routine "VBUS was valid by the time
221                  * VBUSERR got reported during enumeration" cases.
222                  */
223                 if (devctl & MUSB_DEVCTL_VBUS) {
224                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
225                         break;
226                 }
227                 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
228                 musb_writel(musb->ctrl_base, DA8XX_USB_INTR_SRC_SET_REG,
229                             MUSB_INTR_VBUSERROR << DA8XX_INTR_USB_SHIFT);
230                 break;
231         case OTG_STATE_B_IDLE:
232                 if (!is_peripheral_enabled(musb))
233                         break;
234
235                 /*
236                  * There's no ID-changed IRQ, so we have no good way to tell
237                  * when to switch to the A-Default state machine (by setting
238                  * the DEVCTL.Session bit).
239                  *
240                  * Workaround:  whenever we're in B_IDLE, try setting the
241                  * session flag every few seconds.  If it works, ID was
242                  * grounded and we're now in the A-Default state machine.
243                  *
244                  * NOTE: setting the session flag is _supposed_ to trigger
245                  * SRP but clearly it doesn't.
246                  */
247                 musb_writeb(mregs, MUSB_DEVCTL, devctl | MUSB_DEVCTL_SESSION);
248                 devctl = musb_readb(mregs, MUSB_DEVCTL);
249                 if (devctl & MUSB_DEVCTL_BDEVICE)
250                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
251                 else
252                         musb->xceiv->state = OTG_STATE_A_IDLE;
253                 break;
254         default:
255                 break;
256         }
257         spin_unlock_irqrestore(&musb->lock, flags);
258 }
259
260 static void da8xx_musb_try_idle(struct musb *musb, unsigned long timeout)
261 {
262         static unsigned long last_timer;
263
264         if (!is_otg_enabled(musb))
265                 return;
266
267         if (timeout == 0)
268                 timeout = jiffies + msecs_to_jiffies(3);
269
270         /* Never idle if active, or when VBUS timeout is not set as host */
271         if (musb->is_active || (musb->a_wait_bcon == 0 &&
272                                 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) {
273                 dev_dbg(musb->controller, "%s active, deleting timer\n",
274                         otg_state_string(musb->xceiv->state));
275                 del_timer(&otg_workaround);
276                 last_timer = jiffies;
277                 return;
278         }
279
280         if (time_after(last_timer, timeout) && timer_pending(&otg_workaround)) {
281                 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring...\n");
282                 return;
283         }
284         last_timer = timeout;
285
286         dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n",
287                 otg_state_string(musb->xceiv->state),
288                 jiffies_to_msecs(timeout - jiffies));
289         mod_timer(&otg_workaround, timeout);
290 }
291
292 static irqreturn_t da8xx_musb_interrupt(int irq, void *hci)
293 {
294         struct musb             *musb = hci;
295         void __iomem            *reg_base = musb->ctrl_base;
296         unsigned long           flags;
297         irqreturn_t             ret = IRQ_NONE;
298         u32                     status;
299
300         spin_lock_irqsave(&musb->lock, flags);
301
302         /*
303          * NOTE: DA8XX shadows the Mentor IRQs.  Don't manage them through
304          * the Mentor registers (except for setup), use the TI ones and EOI.
305          */
306
307         /* Acknowledge and handle non-CPPI interrupts */
308         status = musb_readl(reg_base, DA8XX_USB_INTR_SRC_MASKED_REG);
309         if (!status)
310                 goto eoi;
311
312         musb_writel(reg_base, DA8XX_USB_INTR_SRC_CLEAR_REG, status);
313         dev_dbg(musb->controller, "USB IRQ %08x\n", status);
314
315         musb->int_rx = (status & DA8XX_INTR_RX_MASK) >> DA8XX_INTR_RX_SHIFT;
316         musb->int_tx = (status & DA8XX_INTR_TX_MASK) >> DA8XX_INTR_TX_SHIFT;
317         musb->int_usb = (status & DA8XX_INTR_USB_MASK) >> DA8XX_INTR_USB_SHIFT;
318
319         /*
320          * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
321          * DA8xx's missing ID change IRQ.  We need an ID change IRQ to
322          * switch appropriately between halves of the OTG state machine.
323          * Managing DEVCTL.Session per Mentor docs requires that we know its
324          * value but DEVCTL.BDevice is invalid without DEVCTL.Session set.
325          * Also, DRVVBUS pulses for SRP (but not at 5 V)...
326          */
327         if (status & (DA8XX_INTR_DRVVBUS << DA8XX_INTR_USB_SHIFT)) {
328                 int drvvbus = musb_readl(reg_base, DA8XX_USB_STAT_REG);
329                 void __iomem *mregs = musb->mregs;
330                 u8 devctl = musb_readb(mregs, MUSB_DEVCTL);
331                 int err;
332
333                 err = is_host_enabled(musb) && (musb->int_usb &
334                                                 MUSB_INTR_VBUSERROR);
335                 if (err) {
336                         /*
337                          * The Mentor core doesn't debounce VBUS as needed
338                          * to cope with device connect current spikes. This
339                          * means it's not uncommon for bus-powered devices
340                          * to get VBUS errors during enumeration.
341                          *
342                          * This is a workaround, but newer RTL from Mentor
343                          * seems to allow a better one: "re"-starting sessions
344                          * without waiting for VBUS to stop registering in
345                          * devctl.
346                          */
347                         musb->int_usb &= ~MUSB_INTR_VBUSERROR;
348                         musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
349                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
350                         WARNING("VBUS error workaround (delay coming)\n");
351                 } else if (is_host_enabled(musb) && drvvbus) {
352                         MUSB_HST_MODE(musb);
353                         musb->xceiv->default_a = 1;
354                         musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
355                         portstate(musb->port1_status |= USB_PORT_STAT_POWER);
356                         del_timer(&otg_workaround);
357                 } else {
358                         musb->is_active = 0;
359                         MUSB_DEV_MODE(musb);
360                         musb->xceiv->default_a = 0;
361                         musb->xceiv->state = OTG_STATE_B_IDLE;
362                         portstate(musb->port1_status &= ~USB_PORT_STAT_POWER);
363                 }
364
365                 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
366                                 drvvbus ? "on" : "off",
367                                 otg_state_string(musb->xceiv->state),
368                                 err ? " ERROR" : "",
369                                 devctl);
370                 ret = IRQ_HANDLED;
371         }
372
373         if (musb->int_tx || musb->int_rx || musb->int_usb)
374                 ret |= musb_interrupt(musb);
375
376  eoi:
377         /* EOI needs to be written for the IRQ to be re-asserted. */
378         if (ret == IRQ_HANDLED || status)
379                 musb_writel(reg_base, DA8XX_USB_END_OF_INTR_REG, 0);
380
381         /* Poll for ID change */
382         if (is_otg_enabled(musb) && musb->xceiv->state == OTG_STATE_B_IDLE)
383                 mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
384
385         spin_unlock_irqrestore(&musb->lock, flags);
386
387         return ret;
388 }
389
390 static int da8xx_musb_set_mode(struct musb *musb, u8 musb_mode)
391 {
392         u32 cfgchip2 = __raw_readl(CFGCHIP2);
393
394         cfgchip2 &= ~CFGCHIP2_OTGMODE;
395         switch (musb_mode) {
396         case MUSB_HOST:         /* Force VBUS valid, ID = 0 */
397                 cfgchip2 |= CFGCHIP2_FORCE_HOST;
398                 break;
399         case MUSB_PERIPHERAL:   /* Force VBUS valid, ID = 1 */
400                 cfgchip2 |= CFGCHIP2_FORCE_DEVICE;
401                 break;
402         case MUSB_OTG:          /* Don't override the VBUS/ID comparators */
403                 cfgchip2 |= CFGCHIP2_NO_OVERRIDE;
404                 break;
405         default:
406                 dev_dbg(musb->controller, "Trying to set unsupported mode %u\n", musb_mode);
407         }
408
409         __raw_writel(cfgchip2, CFGCHIP2);
410         return 0;
411 }
412
413 static int da8xx_musb_init(struct musb *musb)
414 {
415         void __iomem *reg_base = musb->ctrl_base;
416         u32 rev;
417
418         musb->mregs += DA8XX_MENTOR_CORE_OFFSET;
419
420         /* Returns zero if e.g. not clocked */
421         rev = musb_readl(reg_base, DA8XX_USB_REVISION_REG);
422         if (!rev)
423                 goto fail;
424
425         usb_nop_xceiv_register();
426         musb->xceiv = otg_get_transceiver();
427         if (!musb->xceiv)
428                 goto fail;
429
430         if (is_host_enabled(musb))
431                 setup_timer(&otg_workaround, otg_timer, (unsigned long)musb);
432
433         /* Reset the controller */
434         musb_writel(reg_base, DA8XX_USB_CTRL_REG, DA8XX_SOFT_RESET_MASK);
435
436         /* Start the on-chip PHY and its PLL. */
437         phy_on();
438
439         msleep(5);
440
441         /* NOTE: IRQs are in mixed mode, not bypass to pure MUSB */
442         pr_debug("DA8xx OTG revision %08x, PHY %03x, control %02x\n",
443                  rev, __raw_readl(CFGCHIP2),
444                  musb_readb(reg_base, DA8XX_USB_CTRL_REG));
445
446         musb->isr = da8xx_musb_interrupt;
447         return 0;
448 fail:
449         return -ENODEV;
450 }
451
452 static int da8xx_musb_exit(struct musb *musb)
453 {
454         if (is_host_enabled(musb))
455                 del_timer_sync(&otg_workaround);
456
457         phy_off();
458
459         otg_put_transceiver(musb->xceiv);
460         usb_nop_xceiv_unregister();
461
462         return 0;
463 }
464
465 static const struct musb_platform_ops da8xx_ops = {
466         .init           = da8xx_musb_init,
467         .exit           = da8xx_musb_exit,
468
469         .enable         = da8xx_musb_enable,
470         .disable        = da8xx_musb_disable,
471
472         .set_mode       = da8xx_musb_set_mode,
473         .try_idle       = da8xx_musb_try_idle,
474
475         .set_vbus       = da8xx_musb_set_vbus,
476 };
477
478 static u64 da8xx_dmamask = DMA_BIT_MASK(32);
479
480 static int __init da8xx_probe(struct platform_device *pdev)
481 {
482         struct musb_hdrc_platform_data  *pdata = pdev->dev.platform_data;
483         struct platform_device          *musb;
484         struct da8xx_glue               *glue;
485
486         struct clk                      *clk;
487
488         int                             ret = -ENOMEM;
489
490         glue = kzalloc(sizeof(*glue), GFP_KERNEL);
491         if (!glue) {
492                 dev_err(&pdev->dev, "failed to allocate glue context\n");
493                 goto err0;
494         }
495
496         musb = platform_device_alloc("musb-hdrc", -1);
497         if (!musb) {
498                 dev_err(&pdev->dev, "failed to allocate musb device\n");
499                 goto err1;
500         }
501
502         clk = clk_get(&pdev->dev, "usb20");
503         if (IS_ERR(clk)) {
504                 dev_err(&pdev->dev, "failed to get clock\n");
505                 ret = PTR_ERR(clk);
506                 goto err2;
507         }
508
509         ret = clk_enable(clk);
510         if (ret) {
511                 dev_err(&pdev->dev, "failed to enable clock\n");
512                 goto err3;
513         }
514
515         musb->dev.parent                = &pdev->dev;
516         musb->dev.dma_mask              = &da8xx_dmamask;
517         musb->dev.coherent_dma_mask     = da8xx_dmamask;
518
519         glue->dev                       = &pdev->dev;
520         glue->musb                      = musb;
521         glue->clk                       = clk;
522
523         pdata->platform_ops             = &da8xx_ops;
524
525         platform_set_drvdata(pdev, glue);
526
527         ret = platform_device_add_resources(musb, pdev->resource,
528                         pdev->num_resources);
529         if (ret) {
530                 dev_err(&pdev->dev, "failed to add resources\n");
531                 goto err4;
532         }
533
534         ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
535         if (ret) {
536                 dev_err(&pdev->dev, "failed to add platform_data\n");
537                 goto err4;
538         }
539
540         ret = platform_device_add(musb);
541         if (ret) {
542                 dev_err(&pdev->dev, "failed to register musb device\n");
543                 goto err4;
544         }
545
546         return 0;
547
548 err4:
549         clk_disable(clk);
550
551 err3:
552         clk_put(clk);
553
554 err2:
555         platform_device_put(musb);
556
557 err1:
558         kfree(glue);
559
560 err0:
561         return ret;
562 }
563
564 static int __exit da8xx_remove(struct platform_device *pdev)
565 {
566         struct da8xx_glue               *glue = platform_get_drvdata(pdev);
567
568         platform_device_del(glue->musb);
569         platform_device_put(glue->musb);
570         clk_disable(glue->clk);
571         clk_put(glue->clk);
572         kfree(glue);
573
574         return 0;
575 }
576
577 static struct platform_driver da8xx_driver = {
578         .remove         = __exit_p(da8xx_remove),
579         .driver         = {
580                 .name   = "musb-da8xx",
581         },
582 };
583
584 MODULE_DESCRIPTION("DA8xx/OMAP-L1x MUSB Glue Layer");
585 MODULE_AUTHOR("Sergei Shtylyov <sshtylyov@ru.mvista.com>");
586 MODULE_LICENSE("GPL v2");
587
588 static int __init da8xx_init(void)
589 {
590         return platform_driver_probe(&da8xx_driver, da8xx_probe);
591 }
592 subsys_initcall(da8xx_init);
593
594 static void __exit da8xx_exit(void)
595 {
596         platform_driver_unregister(&da8xx_driver);
597 }
598 module_exit(da8xx_exit);