244ca85524f2894b72d29c2a1b95938462f64c3c
[sitara-epos/sitara-epos-kernel.git] / drivers / usb / musb / am35x.c
1 /*
2  * Texas Instruments AM35x "glue layer"
3  *
4  * Copyright (c) 2010, by Texas Instruments
5  *
6  * Based on the DA8xx "glue layer" code.
7  * Copyright (c) 2008-2009, MontaVista Software, Inc. <source@mvista.com>
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  */
29 #include <linux/init.h>
30 #include <linux/module.h>
31 #include <linux/clk.h>
32 #include <linux/io.h>
33 #include <linux/platform_device.h>
34 #include <linux/dma-mapping.h>
36 #include <plat/usb.h>
38 #include "musb_core.h"
40 /*
41  * AM35x specific definitions
42  */
43 /* USB 2.0 OTG module registers */
44 #define USB_REVISION_REG        0x00
45 #define USB_CTRL_REG            0x04
46 #define USB_STAT_REG            0x08
47 #define USB_EMULATION_REG       0x0c
48 /* 0x10 Reserved */
49 #define USB_AUTOREQ_REG         0x14
50 #define USB_SRP_FIX_TIME_REG    0x18
51 #define USB_TEARDOWN_REG        0x1c
52 #define EP_INTR_SRC_REG         0x20
53 #define EP_INTR_SRC_SET_REG     0x24
54 #define EP_INTR_SRC_CLEAR_REG   0x28
55 #define EP_INTR_MASK_REG        0x2c
56 #define EP_INTR_MASK_SET_REG    0x30
57 #define EP_INTR_MASK_CLEAR_REG  0x34
58 #define EP_INTR_SRC_MASKED_REG  0x38
59 #define CORE_INTR_SRC_REG       0x40
60 #define CORE_INTR_SRC_SET_REG   0x44
61 #define CORE_INTR_SRC_CLEAR_REG 0x48
62 #define CORE_INTR_MASK_REG      0x4c
63 #define CORE_INTR_MASK_SET_REG  0x50
64 #define CORE_INTR_MASK_CLEAR_REG 0x54
65 #define CORE_INTR_SRC_MASKED_REG 0x58
66 /* 0x5c Reserved */
67 #define USB_END_OF_INTR_REG     0x60
69 /* Control register bits */
70 #define AM35X_SOFT_RESET_MASK   1
72 /* USB interrupt register bits */
73 #define AM35X_INTR_USB_SHIFT    16
74 #define AM35X_INTR_USB_MASK     (0x1ff << AM35X_INTR_USB_SHIFT)
75 #define AM35X_INTR_DRVVBUS      0x100
76 #define AM35X_INTR_RX_SHIFT     16
77 #define AM35X_INTR_TX_SHIFT     0
78 #define AM35X_TX_EP_MASK        0xffff          /* EP0 + 15 Tx EPs */
79 #define AM35X_RX_EP_MASK        0xfffe          /* 15 Rx EPs */
80 #define AM35X_TX_INTR_MASK      (AM35X_TX_EP_MASK << AM35X_INTR_TX_SHIFT)
81 #define AM35X_RX_INTR_MASK      (AM35X_RX_EP_MASK << AM35X_INTR_RX_SHIFT)
83 #define USB_MENTOR_CORE_OFFSET  0x400
85 struct am35x_glue {
86         struct device           *dev;
87         struct platform_device  *musb;
88         struct clk              *phy_clk;
89         struct clk              *clk;
90 };
91 #define glue_to_musb(g)         platform_get_drvdata(g->musb)
93 /*
94  * am35x_musb_enable - enable interrupts
95  */
96 static void am35x_musb_enable(struct musb *musb)
97 {
98         void __iomem *reg_base = musb->ctrl_base;
99         u32 epmask;
101         /* Workaround: setup IRQs through both register sets. */
102         epmask = ((musb->epmask & AM35X_TX_EP_MASK) << AM35X_INTR_TX_SHIFT) |
103                ((musb->epmask & AM35X_RX_EP_MASK) << AM35X_INTR_RX_SHIFT);
105         musb_writel(reg_base, EP_INTR_MASK_SET_REG, epmask);
106         musb_writel(reg_base, CORE_INTR_MASK_SET_REG, AM35X_INTR_USB_MASK);
108         /* Force the DRVVBUS IRQ so we can start polling for ID change. */
109         if (is_otg_enabled(musb))
110                 musb_writel(reg_base, CORE_INTR_SRC_SET_REG,
111                             AM35X_INTR_DRVVBUS << AM35X_INTR_USB_SHIFT);
114 /*
115  * am35x_musb_disable - disable HDRC and flush interrupts
116  */
117 static void am35x_musb_disable(struct musb *musb)
119         void __iomem *reg_base = musb->ctrl_base;
121         musb_writel(reg_base, CORE_INTR_MASK_CLEAR_REG, AM35X_INTR_USB_MASK);
122         musb_writel(reg_base, EP_INTR_MASK_CLEAR_REG,
123                          AM35X_TX_INTR_MASK | AM35X_RX_INTR_MASK);
124         musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
125         musb_writel(reg_base, USB_END_OF_INTR_REG, 0);
128 #define portstate(stmt)         stmt
130 static void am35x_musb_set_vbus(struct musb *musb, int is_on)
132         WARN_ON(is_on && is_peripheral_active(musb));
135 #define POLL_SECONDS    2
137 static struct timer_list otg_workaround;
139 static void otg_timer(unsigned long _musb)
141         struct musb             *musb = (void *)_musb;
142         void __iomem            *mregs = musb->mregs;
143         u8                      devctl;
144         unsigned long           flags;
146         /*
147          * We poll because AM35x's won't expose several OTG-critical
148          * status change events (from the transceiver) otherwise.
149          */
150         devctl = musb_readb(mregs, MUSB_DEVCTL);
151         dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
152                 otg_state_string(musb->xceiv->state));
154         spin_lock_irqsave(&musb->lock, flags);
155         switch (musb->xceiv->state) {
156         case OTG_STATE_A_WAIT_BCON:
157                 devctl &= ~MUSB_DEVCTL_SESSION;
158                 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
160                 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
161                 if (devctl & MUSB_DEVCTL_BDEVICE) {
162                         musb->xceiv->state = OTG_STATE_B_IDLE;
163                         MUSB_DEV_MODE(musb);
164                 } else {
165                         musb->xceiv->state = OTG_STATE_A_IDLE;
166                         MUSB_HST_MODE(musb);
167                 }
168                 break;
169         case OTG_STATE_A_WAIT_VFALL:
170                 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
171                 musb_writel(musb->ctrl_base, CORE_INTR_SRC_SET_REG,
172                             MUSB_INTR_VBUSERROR << AM35X_INTR_USB_SHIFT);
173                 break;
174         case OTG_STATE_B_IDLE:
175                 if (!is_peripheral_enabled(musb))
176                         break;
178                 devctl = musb_readb(mregs, MUSB_DEVCTL);
179                 if (devctl & MUSB_DEVCTL_BDEVICE)
180                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
181                 else
182                         musb->xceiv->state = OTG_STATE_A_IDLE;
183                 break;
184         default:
185                 break;
186         }
187         spin_unlock_irqrestore(&musb->lock, flags);
190 static void am35x_musb_try_idle(struct musb *musb, unsigned long timeout)
192         static unsigned long last_timer;
194         if (!is_otg_enabled(musb))
195                 return;
197         if (timeout == 0)
198                 timeout = jiffies + msecs_to_jiffies(3);
200         /* Never idle if active, or when VBUS timeout is not set as host */
201         if (musb->is_active || (musb->a_wait_bcon == 0 &&
202                                 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) {
203                 dev_dbg(musb->controller, "%s active, deleting timer\n",
204                         otg_state_string(musb->xceiv->state));
205                 del_timer(&otg_workaround);
206                 last_timer = jiffies;
207                 return;
208         }
210         if (time_after(last_timer, timeout) && timer_pending(&otg_workaround)) {
211                 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring...\n");
212                 return;
213         }
214         last_timer = timeout;
216         dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n",
217                 otg_state_string(musb->xceiv->state),
218                 jiffies_to_msecs(timeout - jiffies));
219         mod_timer(&otg_workaround, timeout);
222 static irqreturn_t am35x_musb_interrupt(int irq, void *hci)
224         struct musb  *musb = hci;
225         void __iomem *reg_base = musb->ctrl_base;
226         struct device *dev = musb->controller;
227         struct musb_hdrc_platform_data *plat = dev->platform_data;
228         struct omap_musb_board_data *data = plat->board_data;
229         unsigned long flags;
230         irqreturn_t ret = IRQ_NONE;
231         u32 epintr, usbintr;
233         spin_lock_irqsave(&musb->lock, flags);
235         /* Get endpoint interrupts */
236         epintr = musb_readl(reg_base, EP_INTR_SRC_MASKED_REG);
238         if (epintr) {
239                 musb_writel(reg_base, EP_INTR_SRC_CLEAR_REG, epintr);
241                 musb->int_rx =
242                         (epintr & AM35X_RX_INTR_MASK) >> AM35X_INTR_RX_SHIFT;
243                 musb->int_tx =
244                         (epintr & AM35X_TX_INTR_MASK) >> AM35X_INTR_TX_SHIFT;
245         }
247         /* Get usb core interrupts */
248         usbintr = musb_readl(reg_base, CORE_INTR_SRC_MASKED_REG);
249         if (!usbintr && !epintr)
250                 goto eoi;
252         if (usbintr) {
253                 musb_writel(reg_base, CORE_INTR_SRC_CLEAR_REG, usbintr);
255                 musb->int_usb =
256                         (usbintr & AM35X_INTR_USB_MASK) >> AM35X_INTR_USB_SHIFT;
257         }
258         /*
259          * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
260          * AM35x's missing ID change IRQ.  We need an ID change IRQ to
261          * switch appropriately between halves of the OTG state machine.
262          * Managing DEVCTL.SESSION per Mentor docs requires that we know its
263          * value but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
264          * Also, DRVVBUS pulses for SRP (but not at 5V) ...
265          */
266         if (usbintr & (AM35X_INTR_DRVVBUS << AM35X_INTR_USB_SHIFT)) {
267                 int drvvbus = musb_readl(reg_base, USB_STAT_REG);
268                 void __iomem *mregs = musb->mregs;
269                 u8 devctl = musb_readb(mregs, MUSB_DEVCTL);
270                 int err;
272                 err = is_host_enabled(musb) && (musb->int_usb &
273                                                 MUSB_INTR_VBUSERROR);
274                 if (err) {
275                         /*
276                          * The Mentor core doesn't debounce VBUS as needed
277                          * to cope with device connect current spikes. This
278                          * means it's not uncommon for bus-powered devices
279                          * to get VBUS errors during enumeration.
280                          *
281                          * This is a workaround, but newer RTL from Mentor
282                          * seems to allow a better one: "re"-starting sessions
283                          * without waiting for VBUS to stop registering in
284                          * devctl.
285                          */
286                         musb->int_usb &= ~MUSB_INTR_VBUSERROR;
287                         musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
288                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
289                         WARNING("VBUS error workaround (delay coming)\n");
290                 } else if (is_host_enabled(musb) && drvvbus) {
291                         MUSB_HST_MODE(musb);
292                         musb->xceiv->default_a = 1;
293                         musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
294                         portstate(musb->port1_status |= USB_PORT_STAT_POWER);
295                         del_timer(&otg_workaround);
296                 } else {
297                         musb->is_active = 0;
298                         MUSB_DEV_MODE(musb);
299                         musb->xceiv->default_a = 0;
300                         musb->xceiv->state = OTG_STATE_B_IDLE;
301                         portstate(musb->port1_status &= ~USB_PORT_STAT_POWER);
302                 }
304                 /* NOTE: this must complete power-on within 100 ms. */
305                 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
306                                 drvvbus ? "on" : "off",
307                                 otg_state_string(musb->xceiv->state),
308                                 err ? " ERROR" : "",
309                                 devctl);
310                 ret = IRQ_HANDLED;
311         }
313         if (musb->int_tx || musb->int_rx || musb->int_usb)
314                 ret |= musb_interrupt(musb);
316 eoi:
317         /* EOI needs to be written for the IRQ to be re-asserted. */
318         if (ret == IRQ_HANDLED || epintr || usbintr) {
319                 /* clear level interrupt */
320                 if (data->clear_irq)
321                         data->clear_irq();
322                 /* write EOI */
323                 musb_writel(reg_base, USB_END_OF_INTR_REG, 0);
324         }
326         /* Poll for ID change */
327         if (is_otg_enabled(musb) && musb->xceiv->state == OTG_STATE_B_IDLE)
328                 mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
330         spin_unlock_irqrestore(&musb->lock, flags);
332         return ret;
335 static int am35x_musb_set_mode(struct musb *musb, u8 musb_mode)
337         struct device *dev = musb->controller;
338         struct musb_hdrc_platform_data *plat = dev->platform_data;
339         struct omap_musb_board_data *data = plat->board_data;
340         int     retval = 0;
342         if (data->set_mode)
343                 data->set_mode(musb_mode);
344         else
345                 retval = -EIO;
347         return retval;
350 static int am35x_musb_init(struct musb *musb)
352         struct device *dev = musb->controller;
353         struct musb_hdrc_platform_data *plat = dev->platform_data;
354         struct omap_musb_board_data *data = plat->board_data;
355         void __iomem *reg_base = musb->ctrl_base;
356         u32 rev;
358         musb->mregs += USB_MENTOR_CORE_OFFSET;
360         /* Returns zero if e.g. not clocked */
361         rev = musb_readl(reg_base, USB_REVISION_REG);
362         if (!rev)
363                 return -ENODEV;
365         usb_nop_xceiv_register();
366         musb->xceiv = otg_get_transceiver();
367         if (!musb->xceiv)
368                 return -ENODEV;
370         if (is_host_enabled(musb))
371                 setup_timer(&otg_workaround, otg_timer, (unsigned long) musb);
373         /* Reset the musb */
374         if (data->reset)
375                 data->reset();
377         /* Reset the controller */
378         musb_writel(reg_base, USB_CTRL_REG, AM35X_SOFT_RESET_MASK);
380         /* Start the on-chip PHY and its PLL. */
381         if (data->set_phy_power)
382                 data->set_phy_power(1);
384         msleep(5);
386         musb->isr = am35x_musb_interrupt;
388         /* clear level interrupt */
389         if (data->clear_irq)
390                 data->clear_irq();
392         return 0;
395 static int am35x_musb_exit(struct musb *musb)
397         struct device *dev = musb->controller;
398         struct musb_hdrc_platform_data *plat = dev->platform_data;
399         struct omap_musb_board_data *data = plat->board_data;
401         if (is_host_enabled(musb))
402                 del_timer_sync(&otg_workaround);
404         /* Shutdown the on-chip PHY and its PLL. */
405         if (data->set_phy_power)
406                 data->set_phy_power(0);
408         otg_put_transceiver(musb->xceiv);
409         usb_nop_xceiv_unregister();
411         return 0;
414 /* AM35x supports only 32bit read operation */
415 static void am35x_musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
417         void __iomem *fifo = hw_ep->fifo;
418         u32             val;
419         int             i;
421         /* Read for 32bit-aligned destination address */
422         if (likely((0x03 & (unsigned long) dst) == 0) && len >= 4) {
423                 readsl(fifo, dst, len >> 2);
424                 dst += len & ~0x03;
425                 len &= 0x03;
426         }
427         /*
428          * Now read the remaining 1 to 3 byte or complete length if
429          * unaligned address.
430          */
431         if (len > 4) {
432                 for (i = 0; i < (len >> 2); i++) {
433                         *(u32 *) dst = musb_readl(fifo, 0);
434                         dst += 4;
435                 }
436                 len &= 0x03;
437         }
438         if (len > 0) {
439                 val = musb_readl(fifo, 0);
440                 memcpy(dst, &val, len);
441         }
444 static const struct musb_platform_ops am35x_ops = {
445         .fifo_mode      = 4,
446         .init           = am35x_musb_init,
447         .exit           = am35x_musb_exit,
449         .enable         = am35x_musb_enable,
450         .disable        = am35x_musb_disable,
452         .set_mode       = am35x_musb_set_mode,
453         .try_idle       = am35x_musb_try_idle,
455         .set_vbus       = am35x_musb_set_vbus,
457         .read_fifo  = am35x_musb_read_fifo,
458         .write_fifo = musb_write_fifo,
459 };
461 static u64 am35x_dmamask = DMA_BIT_MASK(32);
463 static int __init am35x_probe(struct platform_device *pdev)
465         struct musb_hdrc_platform_data  *pdata = pdev->dev.platform_data;
466         struct platform_device          *musb;
467         struct am35x_glue               *glue;
469         struct clk                      *phy_clk;
470         struct clk                      *clk;
472         int                             ret = -ENOMEM;
474         glue = kzalloc(sizeof(*glue), GFP_KERNEL);
475         if (!glue) {
476                 dev_err(&pdev->dev, "failed to allocate glue context\n");
477                 goto err0;
478         }
480         musb = platform_device_alloc("musb-hdrc", -1);
481         if (!musb) {
482                 dev_err(&pdev->dev, "failed to allocate musb device\n");
483                 goto err1;
484         }
486         phy_clk = clk_get(&pdev->dev, "fck");
487         if (IS_ERR(phy_clk)) {
488                 dev_err(&pdev->dev, "failed to get PHY clock\n");
489                 ret = PTR_ERR(phy_clk);
490                 goto err2;
491         }
493         clk = clk_get(&pdev->dev, "ick");
494         if (IS_ERR(clk)) {
495                 dev_err(&pdev->dev, "failed to get clock\n");
496                 ret = PTR_ERR(clk);
497                 goto err3;
498         }
500         ret = clk_enable(phy_clk);
501         if (ret) {
502                 dev_err(&pdev->dev, "failed to enable PHY clock\n");
503                 goto err4;
504         }
506         ret = clk_enable(clk);
507         if (ret) {
508                 dev_err(&pdev->dev, "failed to enable clock\n");
509                 goto err5;
510         }
512         musb->dev.parent                = &pdev->dev;
513         musb->dev.dma_mask              = &am35x_dmamask;
514         musb->dev.coherent_dma_mask     = am35x_dmamask;
516         glue->dev                       = &pdev->dev;
517         glue->musb                      = musb;
518         glue->phy_clk                   = phy_clk;
519         glue->clk                       = clk;
521         pdata->platform_ops             = &am35x_ops;
523         platform_set_drvdata(pdev, glue);
525         ret = platform_device_add_resources(musb, pdev->resource,
526                         pdev->num_resources);
527         if (ret) {
528                 dev_err(&pdev->dev, "failed to add resources\n");
529                 goto err6;
530         }
532         ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
533         if (ret) {
534                 dev_err(&pdev->dev, "failed to add platform_data\n");
535                 goto err6;
536         }
538         ret = platform_device_add(musb);
539         if (ret) {
540                 dev_err(&pdev->dev, "failed to register musb device\n");
541                 goto err6;
542         }
544         return 0;
546 err6:
547         clk_disable(clk);
549 err5:
550         clk_disable(phy_clk);
552 err4:
553         clk_put(clk);
555 err3:
556         clk_put(phy_clk);
558 err2:
559         platform_device_put(musb);
561 err1:
562         kfree(glue);
564 err0:
565         return ret;
568 static int __exit am35x_remove(struct platform_device *pdev)
570         struct am35x_glue       *glue = platform_get_drvdata(pdev);
572         platform_device_del(glue->musb);
573         platform_device_put(glue->musb);
574         clk_disable(glue->clk);
575         clk_disable(glue->phy_clk);
576         clk_put(glue->clk);
577         clk_put(glue->phy_clk);
578         kfree(glue);
580         return 0;
583 #ifdef CONFIG_PM
584 static int am35x_suspend(struct device *dev)
586         struct am35x_glue       *glue = dev_get_drvdata(dev);
587         struct musb_hdrc_platform_data *plat = dev->platform_data;
588         struct omap_musb_board_data *data = plat->board_data;
590         /* Shutdown the on-chip PHY and its PLL. */
591         if (data->set_phy_power)
592                 data->set_phy_power(0);
594         clk_disable(glue->phy_clk);
595         clk_disable(glue->clk);
597         return 0;
600 static int am35x_resume(struct device *dev)
602         struct am35x_glue       *glue = dev_get_drvdata(dev);
603         struct musb_hdrc_platform_data *plat = dev->platform_data;
604         struct omap_musb_board_data *data = plat->board_data;
605         int                     ret;
607         /* Start the on-chip PHY and its PLL. */
608         if (data->set_phy_power)
609                 data->set_phy_power(1);
611         ret = clk_enable(glue->phy_clk);
612         if (ret) {
613                 dev_err(dev, "failed to enable PHY clock\n");
614                 return ret;
615         }
617         ret = clk_enable(glue->clk);
618         if (ret) {
619                 dev_err(dev, "failed to enable clock\n");
620                 return ret;
621         }
623         return 0;
626 static struct dev_pm_ops am35x_pm_ops = {
627         .suspend        = am35x_suspend,
628         .resume         = am35x_resume,
629 };
631 #define DEV_PM_OPS      &am35x_pm_ops
632 #else
633 #define DEV_PM_OPS      NULL
634 #endif
636 static struct platform_driver am35x_driver = {
637         .remove         = __exit_p(am35x_remove),
638         .driver         = {
639                 .name   = "musb-am35x",
640                 .pm     = DEV_PM_OPS,
641         },
642 };
644 MODULE_DESCRIPTION("AM35x MUSB Glue Layer");
645 MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>");
646 MODULE_LICENSE("GPL v2");
648 static int __init am35x_init(void)
650         return platform_driver_probe(&am35x_driver, am35x_probe);
652 subsys_initcall(am35x_init);
654 static void __exit am35x_exit(void)
656         platform_driver_unregister(&am35x_driver);
658 module_exit(am35x_exit);