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