drivers/usb/musb/blackfin.c

   1 /*
   2  * MUSB OTG controller driver for Blackfin Processors
   3  *
   4  * Copyright 2006-2008 Analog Devices Inc.
   5  *
   6  * Enter bugs at http://blackfin.uclinux.org/
   7  *
   8  * Licensed under the GPL-2 or later.
   9  */
  10
  11 #include <linux/module.h>
  12 #include <linux/kernel.h>
  13 #include <linux/sched.h>
  14 #include <linux/init.h>
  15 #include <linux/list.h>
  16 #include <linux/gpio.h>
  17 #include <linux/io.h>
  18 #include <linux/platform_device.h>
  19 #include <linux/dma-mapping.h>
  20 #include <linux/prefetch.h>
  21
  22 #include <asm/cacheflush.h>
  23
  24 #include "musb_core.h"
  25 #include "musbhsdma.h"
  26 #include "blackfin.h"
  27
  28 struct bfin_glue {
  29         struct device           *dev;
  30         struct platform_device  *musb;
  31 };
  32 #define glue_to_musb(g)         platform_get_drvdata(g->musb)
  33
  34 /*
  35  * Load an endpoint's FIFO
  36  */
  37 static void bfin_musb_write_fifo(struct musb_hw_ep *hw_ep, u16 len,
  38                                 const u8 *src)
  39 {
  40         struct musb *musb = hw_ep->musb;
  41         void __iomem *fifo = hw_ep->fifo;
  42         void __iomem *epio = hw_ep->regs;
  43         u8 epnum = hw_ep->epnum;
  44
  45         prefetch((u8 *)src);
  46
  47         musb_writew(epio, MUSB_TXCOUNT, len);
  48
  49         dev_dbg(musb->controller, "TX ep%d fifo %p count %d buf %p, epio %p\n",
  50                         hw_ep->epnum, fifo, len, src, epio);
  51
  52         dump_fifo_data(src, len);
  53
  54         if (!ANOMALY_05000380 && epnum != 0) {
  55                 u16 dma_reg;
  56
  57                 flush_dcache_range((unsigned long)src,
  58                         (unsigned long)(src + len));
  59
  60                 /* Setup DMA address register */
  61                 dma_reg = (u32)src;
  62                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_ADDR_LOW), dma_reg);
  63                 SSYNC();
  64
  65                 dma_reg = (u32)src >> 16;
  66                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_ADDR_HIGH), dma_reg);
  67                 SSYNC();
  68
  69                 /* Setup DMA count register */
  70                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_COUNT_LOW), len);
  71                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_COUNT_HIGH), 0);
  72                 SSYNC();
  73
  74                 /* Enable the DMA */
  75                 dma_reg = (epnum << 4) | DMA_ENA | INT_ENA | DIRECTION;
  76                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_CTRL), dma_reg);
  77                 SSYNC();
  78
  79                 /* Wait for compelete */
  80                 while (!(bfin_read_USB_DMA_INTERRUPT() & (1 << epnum)))
  81                         cpu_relax();
  82
  83                 /* acknowledge dma interrupt */
  84                 bfin_write_USB_DMA_INTERRUPT(1 << epnum);
  85                 SSYNC();
  86
  87                 /* Reset DMA */
  88                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_CTRL), 0);
  89                 SSYNC();
  90         } else {
  91                 SSYNC();
  92
  93                 if (unlikely((unsigned long)src & 0x01))
  94                         outsw_8((unsigned long)fifo, src, (len + 1) >> 1);
  95                 else
  96                         outsw((unsigned long)fifo, src, (len + 1) >> 1);
  97         }
  98 }
  99 /*
 100  * Unload an endpoint's FIFO
 101  */
 102 static void bfin_musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
 103 {
 104         struct musb *musb = hw_ep->musb;
 105         void __iomem *fifo = hw_ep->fifo;
 106         u8 epnum = hw_ep->epnum;
 107
 108         if (ANOMALY_05000467 && epnum != 0) {
 109                 u16 dma_reg;
 110
 111                 invalidate_dcache_range((unsigned long)dst,
 112                         (unsigned long)(dst + len));
 113
 114                 /* Setup DMA address register */
 115                 dma_reg = (u32)dst;
 116                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_ADDR_LOW), dma_reg);
 117                 SSYNC();
 118
 119                 dma_reg = (u32)dst >> 16;
 120                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_ADDR_HIGH), dma_reg);
 121                 SSYNC();
 122
 123                 /* Setup DMA count register */
 124                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_COUNT_LOW), len);
 125                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_COUNT_HIGH), 0);
 126                 SSYNC();
 127
 128                 /* Enable the DMA */
 129                 dma_reg = (epnum << 4) | DMA_ENA | INT_ENA;
 130                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_CTRL), dma_reg);
 131                 SSYNC();
 132
 133                 /* Wait for compelete */
 134                 while (!(bfin_read_USB_DMA_INTERRUPT() & (1 << epnum)))
 135                         cpu_relax();
 136
 137                 /* acknowledge dma interrupt */
 138                 bfin_write_USB_DMA_INTERRUPT(1 << epnum);
 139                 SSYNC();
 140
 141                 /* Reset DMA */
 142                 bfin_write16(USB_DMA_REG(epnum, USB_DMAx_CTRL), 0);
 143                 SSYNC();
 144         } else {
 145                 SSYNC();
 146                 /* Read the last byte of packet with odd size from address fifo + 4
 147                  * to trigger 1 byte access to EP0 FIFO.
 148                  */
 149                 if (len == 1)
 150                         *dst = (u8)inw((unsigned long)fifo + 4);
 151                 else {
 152                         if (unlikely((unsigned long)dst & 0x01))
 153                                 insw_8((unsigned long)fifo, dst, len >> 1);
 154                         else
 155                                 insw((unsigned long)fifo, dst, len >> 1);
 156
 157                         if (len & 0x01)
 158                                 *(dst + len - 1) = (u8)inw((unsigned long)fifo + 4);
 159                 }
 160         }
 161         dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
 162                         'R', hw_ep->epnum, fifo, len, dst);
 163
 164         dump_fifo_data(dst, len);
 165 }
 166
 167 static irqreturn_t blackfin_interrupt(int irq, void *__hci)
 168 {
 169         unsigned long   flags;
 170         irqreturn_t     retval = IRQ_NONE;
 171         struct musb     *musb = __hci;
 172
 173         spin_lock_irqsave(&musb->lock, flags);
 174
 175         musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
 176         musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
 177         musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
 178
 179         if (musb->int_usb || musb->int_tx || musb->int_rx) {
 180                 musb_writeb(musb->mregs, MUSB_INTRUSB, musb->int_usb);
 181                 musb_writew(musb->mregs, MUSB_INTRTX, musb->int_tx);
 182                 musb_writew(musb->mregs, MUSB_INTRRX, musb->int_rx);
 183                 retval = musb_interrupt(musb);
 184         }
 185
 186         /* Start sampling ID pin, when plug is removed from MUSB */
 187         if ((is_otg_enabled(musb) && (musb->xceiv->state == OTG_STATE_B_IDLE
 188                 || musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) ||
 189                 (musb->int_usb & MUSB_INTR_DISCONNECT && is_host_active(musb))) {
 190                 mod_timer(&musb_conn_timer, jiffies + TIMER_DELAY);
 191                 musb->a_wait_bcon = TIMER_DELAY;
 192         }
 193
 194         spin_unlock_irqrestore(&musb->lock, flags);
 195
 196         return retval;
 197 }
 198
 199 static void musb_conn_timer_handler(unsigned long _musb)
 200 {
 201         struct musb *musb = (void *)_musb;
 202         unsigned long flags;
 203         u16 val;
 204         static u8 toggle;
 205
 206         spin_lock_irqsave(&musb->lock, flags);
 207         switch (musb->xceiv->state) {
 208         case OTG_STATE_A_IDLE:
 209         case OTG_STATE_A_WAIT_BCON:
 210                 /* Start a new session */
 211                 val = musb_readw(musb->mregs, MUSB_DEVCTL);
 212                 val &= ~MUSB_DEVCTL_SESSION;
 213                 musb_writew(musb->mregs, MUSB_DEVCTL, val);
 214                 val |= MUSB_DEVCTL_SESSION;
 215                 musb_writew(musb->mregs, MUSB_DEVCTL, val);
 216                 /* Check if musb is host or peripheral. */
 217                 val = musb_readw(musb->mregs, MUSB_DEVCTL);
 218
 219                 if (!(val & MUSB_DEVCTL_BDEVICE)) {
 220                         gpio_set_value(musb->config->gpio_vrsel, 1);
 221                         musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
 222                 } else {
 223                         gpio_set_value(musb->config->gpio_vrsel, 0);
 224                         /* Ignore VBUSERROR and SUSPEND IRQ */
 225                         val = musb_readb(musb->mregs, MUSB_INTRUSBE);
 226                         val &= ~MUSB_INTR_VBUSERROR;
 227                         musb_writeb(musb->mregs, MUSB_INTRUSBE, val);
 228
 229                         val = MUSB_INTR_SUSPEND | MUSB_INTR_VBUSERROR;
 230                         musb_writeb(musb->mregs, MUSB_INTRUSB, val);
 231                         if (is_otg_enabled(musb))
 232                                 musb->xceiv->state = OTG_STATE_B_IDLE;
 233                         else
 234                                 musb_writeb(musb->mregs, MUSB_POWER, MUSB_POWER_HSENAB);
 235                 }
 236                 mod_timer(&musb_conn_timer, jiffies + TIMER_DELAY);
 237                 break;
 238         case OTG_STATE_B_IDLE:
 239
 240                 if (!is_peripheral_enabled(musb))
 241                         break;
 242                 /* Start a new session.  It seems that MUSB needs taking
 243                  * some time to recognize the type of the plug inserted?
 244                  */
 245                 val = musb_readw(musb->mregs, MUSB_DEVCTL);
 246                 val |= MUSB_DEVCTL_SESSION;
 247                 musb_writew(musb->mregs, MUSB_DEVCTL, val);
 248                 val = musb_readw(musb->mregs, MUSB_DEVCTL);
 249
 250                 if (!(val & MUSB_DEVCTL_BDEVICE)) {
 251                         gpio_set_value(musb->config->gpio_vrsel, 1);
 252                         musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
 253                 } else {
 254                         gpio_set_value(musb->config->gpio_vrsel, 0);
 255
 256                         /* Ignore VBUSERROR and SUSPEND IRQ */
 257                         val = musb_readb(musb->mregs, MUSB_INTRUSBE);
 258                         val &= ~MUSB_INTR_VBUSERROR;
 259                         musb_writeb(musb->mregs, MUSB_INTRUSBE, val);
 260
 261                         val = MUSB_INTR_SUSPEND | MUSB_INTR_VBUSERROR;
 262                         musb_writeb(musb->mregs, MUSB_INTRUSB, val);
 263
 264                         /* Toggle the Soft Conn bit, so that we can response to
 265                          * the inserting of either A-plug or B-plug.
 266                          */
 267                         if (toggle) {
 268                                 val = musb_readb(musb->mregs, MUSB_POWER);
 269                                 val &= ~MUSB_POWER_SOFTCONN;
 270                                 musb_writeb(musb->mregs, MUSB_POWER, val);
 271                                 toggle = 0;
 272                         } else {
 273                                 val = musb_readb(musb->mregs, MUSB_POWER);
 274                                 val |= MUSB_POWER_SOFTCONN;
 275                                 musb_writeb(musb->mregs, MUSB_POWER, val);
 276                                 toggle = 1;
 277                         }
 278                         /* The delay time is set to 1/4 second by default,
 279                          * shortening it, if accelerating A-plug detection
 280                          * is needed in OTG mode.
 281                          */
 282                         mod_timer(&musb_conn_timer, jiffies + TIMER_DELAY / 4);
 283                 }
 284                 break;
 285         default:
 286                 dev_dbg(musb->controller, "%s state not handled\n",
 287                         otg_state_string(musb->xceiv->state));
 288                 break;
 289         }
 290         spin_unlock_irqrestore(&musb->lock, flags);
 291
 292         dev_dbg(musb->controller, "state is %s\n",
 293                 otg_state_string(musb->xceiv->state));
 294 }
 295
 296 static void bfin_musb_enable(struct musb *musb)
 297 {
 298         if (!is_otg_enabled(musb) && is_host_enabled(musb)) {
 299                 mod_timer(&musb_conn_timer, jiffies + TIMER_DELAY);
 300                 musb->a_wait_bcon = TIMER_DELAY;
 301         }
 302 }
 303
 304 static void bfin_musb_disable(struct musb *musb)
 305 {
 306 }
 307
 308 static void bfin_musb_set_vbus(struct musb *musb, int is_on)
 309 {
 310         int value = musb->config->gpio_vrsel_active;
 311         if (!is_on)
 312                 value = !value;
 313         gpio_set_value(musb->config->gpio_vrsel, value);
 314
 315         dev_dbg(musb->controller, "VBUS %s, devctl %02x "
 316                 /* otg %3x conf %08x prcm %08x */ "\n",
 317                 otg_state_string(musb->xceiv->state),
 318                 musb_readb(musb->mregs, MUSB_DEVCTL));
 319 }
 320
 321 static int bfin_musb_set_power(struct otg_transceiver *x, unsigned mA)
 322 {
 323         return 0;
 324 }
 325
 326 static void bfin_musb_try_idle(struct musb *musb, unsigned long timeout)
 327 {
 328         if (!is_otg_enabled(musb) && is_host_enabled(musb))
 329                 mod_timer(&musb_conn_timer, jiffies + TIMER_DELAY);
 330 }
 331
 332 static int bfin_musb_vbus_status(struct musb *musb)
 333 {
 334         return 0;
 335 }
 336
 337 static int bfin_musb_set_mode(struct musb *musb, u8 musb_mode)
 338 {
 339         return -EIO;
 340 }
 341
 342 static int bfin_musb_adjust_channel_params(struct dma_channel *channel,
 343                                 u16 packet_sz, u8 *mode,
 344                                 dma_addr_t *dma_addr, u32 *len)
 345 {
 346         struct musb_dma_channel *musb_channel = channel->private_data;
 347
 348         /*
 349          * Anomaly 05000450 might cause data corruption when using DMA
 350          * MODE 1 transmits with short packet.  So to work around this,
 351          * we truncate all MODE 1 transfers down to a multiple of the
 352          * max packet size, and then do the last short packet transfer
 353          * (if there is any) using MODE 0.
 354          */
 355         if (ANOMALY_05000450) {
 356                 if (musb_channel->transmit && *mode == 1)
 357                         *len = *len - (*len % packet_sz);
 358         }
 359
 360         return 0;
 361 }
 362
 363 static void bfin_musb_reg_init(struct musb *musb)
 364 {
 365         if (ANOMALY_05000346) {
 366                 bfin_write_USB_APHY_CALIB(ANOMALY_05000346_value);
 367                 SSYNC();
 368         }
 369
 370         if (ANOMALY_05000347) {
 371                 bfin_write_USB_APHY_CNTRL(0x0);
 372                 SSYNC();
 373         }
 374
 375         /* Configure PLL oscillator register */
 376         bfin_write_USB_PLLOSC_CTRL(0x3080 |
 377                         ((480/musb->config->clkin) << 1));
 378         SSYNC();
 379
 380         bfin_write_USB_SRP_CLKDIV((get_sclk()/1000) / 32 - 1);
 381         SSYNC();
 382
 383         bfin_write_USB_EP_NI0_RXMAXP(64);
 384         SSYNC();
 385
 386         bfin_write_USB_EP_NI0_TXMAXP(64);
 387         SSYNC();
 388
 389         /* Route INTRUSB/INTR_RX/INTR_TX to USB_INT0*/
 390         bfin_write_USB_GLOBINTR(0x7);
 391         SSYNC();
 392
 393         bfin_write_USB_GLOBAL_CTL(GLOBAL_ENA | EP1_TX_ENA | EP2_TX_ENA |
 394                                 EP3_TX_ENA | EP4_TX_ENA | EP5_TX_ENA |
 395                                 EP6_TX_ENA | EP7_TX_ENA | EP1_RX_ENA |
 396                                 EP2_RX_ENA | EP3_RX_ENA | EP4_RX_ENA |
 397                                 EP5_RX_ENA | EP6_RX_ENA | EP7_RX_ENA);
 398         SSYNC();
 399 }
 400
 401 static int bfin_musb_init(struct musb *musb)
 402 {
 403
 404         /*
 405          * Rev 1.0 BF549 EZ-KITs require PE7 to be high for both DEVICE
 406          * and OTG HOST modes, while rev 1.1 and greater require PE7 to
 407          * be low for DEVICE mode and high for HOST mode. We set it high
 408          * here because we are in host mode
 409          */
 410
 411         if (gpio_request(musb->config->gpio_vrsel, "USB_VRSEL")) {
 412                 printk(KERN_ERR "Failed ro request USB_VRSEL GPIO_%d\n",
 413                         musb->config->gpio_vrsel);
 414                 return -ENODEV;
 415         }
 416         gpio_direction_output(musb->config->gpio_vrsel, 0);
 417
 418         usb_nop_xceiv_register();
 419         musb->xceiv = otg_get_transceiver();
 420         if (!musb->xceiv) {
 421                 gpio_free(musb->config->gpio_vrsel);
 422                 return -ENODEV;
 423         }
 424
 425         bfin_musb_reg_init(musb);
 426
 427         if (is_host_enabled(musb)) {
 428                 setup_timer(&musb_conn_timer,
 429                         musb_conn_timer_handler, (unsigned long) musb);
 430         }
 431         if (is_peripheral_enabled(musb))
 432                 musb->xceiv->set_power = bfin_musb_set_power;
 433
 434         musb->isr = blackfin_interrupt;
 435         musb->double_buffer_not_ok = true;
 436
 437         return 0;
 438 }
 439
 440 static int bfin_musb_exit(struct musb *musb)
 441 {
 442         gpio_free(musb->config->gpio_vrsel);
 443
 444         otg_put_transceiver(musb->xceiv);
 445         usb_nop_xceiv_unregister();
 446         return 0;
 447 }
 448
 449 static const struct musb_platform_ops bfin_ops = {
 450         .fifo_mode      = 2,
 451         .init           = bfin_musb_init,
 452         .exit           = bfin_musb_exit,
 453
 454         .enable         = bfin_musb_enable,
 455         .disable        = bfin_musb_disable,
 456
 457         .read_fifo      = bfin_musb_read_fifo,
 458         .write_fifo     = bfin_musb_write_fifo,
 459
 460         .set_mode       = bfin_musb_set_mode,
 461         .try_idle       = bfin_musb_try_idle,
 462
 463         .vbus_status    = bfin_musb_vbus_status,
 464         .set_vbus       = bfin_musb_set_vbus,
 465
 466         .adjust_channel_params = bfin_musb_adjust_channel_params,
 467 };
 468
 469 static u64 bfin_dmamask = DMA_BIT_MASK(32);
 470
 471 static int __init bfin_probe(struct platform_device *pdev)
 472 {
 473         struct musb_hdrc_platform_data  *pdata = pdev->dev.platform_data;
 474         struct platform_device          *musb;
 475         struct bfin_glue                *glue;
 476
 477         int                             ret = -ENOMEM;
 478
 479         glue = kzalloc(sizeof(*glue), GFP_KERNEL);
 480         if (!glue) {
 481                 dev_err(&pdev->dev, "failed to allocate glue context\n");
 482                 goto err0;
 483         }
 484
 485         musb = platform_device_alloc("musb-hdrc", -1);
 486         if (!musb) {
 487                 dev_err(&pdev->dev, "failed to allocate musb device\n");
 488                 goto err1;
 489         }
 490
 491         musb->dev.parent                = &pdev->dev;
 492         musb->dev.dma_mask              = &bfin_dmamask;
 493         musb->dev.coherent_dma_mask     = bfin_dmamask;
 494
 495         glue->dev                       = &pdev->dev;
 496         glue->musb                      = musb;
 497
 498         pdata->platform_ops             = &bfin_ops;
 499
 500         platform_set_drvdata(pdev, glue);
 501
 502         ret = platform_device_add_resources(musb, pdev->resource,
 503                         pdev->num_resources);
 504         if (ret) {
 505                 dev_err(&pdev->dev, "failed to add resources\n");
 506                 goto err2;
 507         }
 508
 509         ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
 510         if (ret) {
 511                 dev_err(&pdev->dev, "failed to add platform_data\n");
 512                 goto err2;
 513         }
 514
 515         ret = platform_device_add(musb);
 516         if (ret) {
 517                 dev_err(&pdev->dev, "failed to register musb device\n");
 518                 goto err2;
 519         }
 520
 521         return 0;
 522
 523 err2:
 524         platform_device_put(musb);
 525
 526 err1:
 527         kfree(glue);
 528
 529 err0:
 530         return ret;
 531 }
 532
 533 static int __exit bfin_remove(struct platform_device *pdev)
 534 {
 535         struct bfin_glue                *glue = platform_get_drvdata(pdev);
 536
 537         platform_device_del(glue->musb);
 538         platform_device_put(glue->musb);
 539         kfree(glue);
 540
 541         return 0;
 542 }
 543
 544 #ifdef CONFIG_PM
 545 static int bfin_suspend(struct device *dev)
 546 {
 547         struct bfin_glue        *glue = dev_get_drvdata(dev);
 548         struct musb             *musb = glue_to_musb(glue);
 549
 550         if (is_host_active(musb))
 551                 /*
 552                  * During hibernate gpio_vrsel will change from high to low
 553                  * low which will generate wakeup event resume the system
 554                  * immediately.  Set it to 0 before hibernate to avoid this
 555                  * wakeup event.
 556                  */
 557                 gpio_set_value(musb->config->gpio_vrsel, 0);
 558
 559         return 0;
 560 }
 561
 562 static int bfin_resume(struct device *dev)
 563 {
 564         struct bfin_glue        *glue = dev_get_drvdata(dev);
 565         struct musb             *musb = glue_to_musb(glue);
 566
 567         bfin_musb_reg_init(musb);
 568
 569         return 0;
 570 }
 571
 572 static struct dev_pm_ops bfin_pm_ops = {
 573         .suspend        = bfin_suspend,
 574         .resume         = bfin_resume,
 575 };
 576
 577 #define DEV_PM_OPS      &bfin_pm_ops
 578 #else
 579 #define DEV_PM_OPS      NULL
 580 #endif
 581
 582 static struct platform_driver bfin_driver = {
 583         .remove         = __exit_p(bfin_remove),
 584         .driver         = {
 585                 .name   = "musb-blackfin",
 586                 .pm     = DEV_PM_OPS,
 587         },
 588 };
 589
 590 MODULE_DESCRIPTION("Blackfin MUSB Glue Layer");
 591 MODULE_AUTHOR("Bryan Wy <cooloney@kernel.org>");
 592 MODULE_LICENSE("GPL v2");
 593
 594 static int __init bfin_init(void)
 595 {
 596         return platform_driver_probe(&bfin_driver, bfin_probe);
 597 }
 598 subsys_initcall(bfin_init);
 599
 600 static void __exit bfin_exit(void)
 601 {
 602         platform_driver_unregister(&bfin_driver);
 603 }
 604 module_exit(bfin_exit);