drivers/usb/musb/musbhsdma.c

   1 /*
   2  * MUSB OTG driver - support for Mentor's DMA controller
   3  *
   4  * Copyright 2005 Mentor Graphics Corporation
   5  * Copyright (C) 2005-2007 by Texas Instruments
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * version 2 as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  19  * 02110-1301 USA
  20  *
  21  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
  22  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  23  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
  24  * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  27  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  28  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  */
  33 #include <linux/device.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/platform_device.h>
  36 #include "musb_core.h"
  37
  38 #if defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP3430)
  39 #include "omap2430.h"
  40 #endif
  41
  42 #define MUSB_HSDMA_BASE         0x200
  43 #define MUSB_HSDMA_INTR         (MUSB_HSDMA_BASE + 0)
  44 #define MUSB_HSDMA_CONTROL              0x4
  45 #define MUSB_HSDMA_ADDRESS              0x8
  46 #define MUSB_HSDMA_COUNT                0xc
  47
  48 #define MUSB_HSDMA_CHANNEL_OFFSET(_bChannel, _offset)           \
  49                 (MUSB_HSDMA_BASE + (_bChannel << 4) + _offset)
  50
  51 /* control register (16-bit): */
  52 #define MUSB_HSDMA_ENABLE_SHIFT         0
  53 #define MUSB_HSDMA_TRANSMIT_SHIFT               1
  54 #define MUSB_HSDMA_MODE1_SHIFT          2
  55 #define MUSB_HSDMA_IRQENABLE_SHIFT              3
  56 #define MUSB_HSDMA_ENDPOINT_SHIFT               4
  57 #define MUSB_HSDMA_BUSERROR_SHIFT               8
  58 #define MUSB_HSDMA_BURSTMODE_SHIFT              9
  59 #define MUSB_HSDMA_BURSTMODE            (3 << MUSB_HSDMA_BURSTMODE_SHIFT)
  60 #define MUSB_HSDMA_BURSTMODE_UNSPEC     0
  61 #define MUSB_HSDMA_BURSTMODE_INCR4      1
  62 #define MUSB_HSDMA_BURSTMODE_INCR8      2
  63 #define MUSB_HSDMA_BURSTMODE_INCR16     3
  64
  65 #define MUSB_HSDMA_CHANNELS             8
  66
  67 struct musb_dma_controller;
  68
  69 struct musb_dma_channel {
  70         struct dma_channel              Channel;
  71         struct musb_dma_controller      *controller;
  72         u32                             dwStartAddress;
  73         u32                             len;
  74         u16                             wMaxPacketSize;
  75         u8                              bIndex;
  76         u8                              epnum;
  77         u8                              transmit;
  78 };
  79
  80 struct musb_dma_controller {
  81         struct dma_controller           Controller;
  82         struct musb_dma_channel         aChannel[MUSB_HSDMA_CHANNELS];
  83         void                            *pDmaPrivate;
  84         void __iomem                    *pCoreBase;
  85         u8                              bChannelCount;
  86         u8                              bmUsedChannels;
  87         u8                              irq;
  88 };
  89
  90 static int dma_controller_start(struct dma_controller *c)
  91 {
  92         /* nothing to do */
  93         return 0;
  94 }
  95
  96 static void dma_channel_release(struct dma_channel *pChannel);
  97
  98 static int dma_controller_stop(struct dma_controller *c)
  99 {
 100         struct musb_dma_controller *controller =
 101                 container_of(c, struct musb_dma_controller, Controller);
 102         struct musb *musb = (struct musb *) controller->pDmaPrivate;
 103         struct dma_channel *pChannel;
 104         u8 bBit;
 105
 106         if (controller->bmUsedChannels != 0) {
 107                 dev_err(musb->controller,
 108                         "Stopping DMA controller while channel active\n");
 109
 110                 for (bBit = 0; bBit < MUSB_HSDMA_CHANNELS; bBit++) {
 111                         if (controller->bmUsedChannels & (1 << bBit)) {
 112                                 pChannel = &controller->aChannel[bBit].Channel;
 113                                 dma_channel_release(pChannel);
 114
 115                                 if (!controller->bmUsedChannels)
 116                                         break;
 117                         }
 118                 }
 119         }
 120         return 0;
 121 }
 122
 123 static struct dma_channel *dma_channel_allocate(struct dma_controller *c,
 124                                 struct musb_hw_ep *hw_ep, u8 transmit)
 125 {
 126         u8 bBit;
 127         struct dma_channel *pChannel = NULL;
 128         struct musb_dma_channel *pImplChannel = NULL;
 129         struct musb_dma_controller *controller =
 130                         container_of(c, struct musb_dma_controller, Controller);
 131
 132         for (bBit = 0; bBit < MUSB_HSDMA_CHANNELS; bBit++) {
 133                 if (!(controller->bmUsedChannels & (1 << bBit))) {
 134                         controller->bmUsedChannels |= (1 << bBit);
 135                         pImplChannel = &(controller->aChannel[bBit]);
 136                         pImplChannel->controller = controller;
 137                         pImplChannel->bIndex = bBit;
 138                         pImplChannel->epnum = hw_ep->epnum;
 139                         pImplChannel->transmit = transmit;
 140                         pChannel = &(pImplChannel->Channel);
 141                         pChannel->private_data = pImplChannel;
 142                         pChannel->status = MUSB_DMA_STATUS_FREE;
 143                         pChannel->max_len = 0x10000;
 144                         /* Tx => mode 1; Rx => mode 0 */
 145                         pChannel->desired_mode = transmit;
 146                         pChannel->actual_len = 0;
 147                         break;
 148                 }
 149         }
 150         return pChannel;
 151 }
 152
 153 static void dma_channel_release(struct dma_channel *pChannel)
 154 {
 155         struct musb_dma_channel *pImplChannel =
 156                 (struct musb_dma_channel *) pChannel->private_data;
 157
 158         pChannel->actual_len = 0;
 159         pImplChannel->dwStartAddress = 0;
 160         pImplChannel->len = 0;
 161
 162         pImplChannel->controller->bmUsedChannels &=
 163                 ~(1 << pImplChannel->bIndex);
 164
 165         pChannel->status = MUSB_DMA_STATUS_UNKNOWN;
 166 }
 167
 168 static void configure_channel(struct dma_channel *pChannel,
 169                                 u16 packet_sz, u8 mode,
 170                                 dma_addr_t dma_addr, u32 len)
 171 {
 172         struct musb_dma_channel *pImplChannel =
 173                 (struct musb_dma_channel *) pChannel->private_data;
 174         struct musb_dma_controller *controller = pImplChannel->controller;
 175         u8 *mbase = controller->pCoreBase;
 176         u8 bChannel = pImplChannel->bIndex;
 177         u16 csr = 0;
 178
 179         DBG(4, "%p, pkt_sz %d, addr 0x%x, len %d, mode %d\n",
 180                         pChannel, packet_sz, dma_addr, len, mode);
 181
 182         if (mode) {
 183                 csr |= 1 << MUSB_HSDMA_MODE1_SHIFT;
 184                 BUG_ON(len < packet_sz);
 185
 186                 if (packet_sz >= 64) {
 187                         csr |= MUSB_HSDMA_BURSTMODE_INCR16
 188                                         << MUSB_HSDMA_BURSTMODE_SHIFT;
 189                 } else if (packet_sz >= 32) {
 190                         csr |= MUSB_HSDMA_BURSTMODE_INCR8
 191                                         << MUSB_HSDMA_BURSTMODE_SHIFT;
 192                 } else if (packet_sz >= 16) {
 193                         csr |= MUSB_HSDMA_BURSTMODE_INCR4
 194                                         << MUSB_HSDMA_BURSTMODE_SHIFT;
 195                 }
 196         }
 197
 198         csr |= (pImplChannel->epnum << MUSB_HSDMA_ENDPOINT_SHIFT)
 199                 | (1 << MUSB_HSDMA_ENABLE_SHIFT)
 200                 | (1 << MUSB_HSDMA_IRQENABLE_SHIFT)
 201                 | (pImplChannel->transmit
 202                                 ? (1 << MUSB_HSDMA_TRANSMIT_SHIFT)
 203                                 : 0);
 204
 205         /* address/count */
 206         musb_writel(mbase,
 207                 MUSB_HSDMA_CHANNEL_OFFSET(bChannel, MUSB_HSDMA_ADDRESS),
 208                 dma_addr);
 209         musb_writel(mbase,
 210                 MUSB_HSDMA_CHANNEL_OFFSET(bChannel, MUSB_HSDMA_COUNT),
 211                 len);
 212
 213         /* control (this should start things) */
 214         musb_writew(mbase,
 215                 MUSB_HSDMA_CHANNEL_OFFSET(bChannel, MUSB_HSDMA_CONTROL),
 216                 csr);
 217 }
 218
 219 static int dma_channel_program(struct dma_channel * pChannel,
 220                                 u16 packet_sz, u8 mode,
 221                                 dma_addr_t dma_addr, u32 len)
 222 {
 223         struct musb_dma_channel *pImplChannel =
 224                         (struct musb_dma_channel *) pChannel->private_data;
 225
 226         DBG(2, "ep%d-%s pkt_sz %d, dma_addr 0x%x length %d, mode %d\n",
 227                 pImplChannel->epnum,
 228                 pImplChannel->transmit ? "Tx" : "Rx",
 229                 packet_sz, dma_addr, len, mode);
 230
 231         BUG_ON(pChannel->status == MUSB_DMA_STATUS_UNKNOWN ||
 232                 pChannel->status == MUSB_DMA_STATUS_BUSY);
 233
 234         pChannel->actual_len = 0;
 235         pImplChannel->dwStartAddress = dma_addr;
 236         pImplChannel->len = len;
 237         pImplChannel->wMaxPacketSize = packet_sz;
 238         pChannel->status = MUSB_DMA_STATUS_BUSY;
 239
 240         if ((mode == 1) && (len >= packet_sz))
 241                 configure_channel(pChannel, packet_sz, 1, dma_addr, len);
 242         else
 243                 configure_channel(pChannel, packet_sz, 0, dma_addr, len);
 244
 245         return true;
 246 }
 247
 248 static int dma_channel_abort(struct dma_channel *pChannel)
 249 {
 250         struct musb_dma_channel *pImplChannel =
 251                 (struct musb_dma_channel *) pChannel->private_data;
 252         u8 bChannel = pImplChannel->bIndex;
 253         u8 *mbase = pImplChannel->controller->pCoreBase;
 254         u16 csr;
 255
 256         if (pChannel->status == MUSB_DMA_STATUS_BUSY) {
 257                 if (pImplChannel->transmit) {
 258
 259                         csr = musb_readw(mbase,
 260                                 MUSB_EP_OFFSET(pImplChannel->epnum,MUSB_TXCSR));
 261                         csr &= ~(MUSB_TXCSR_AUTOSET |
 262                                  MUSB_TXCSR_DMAENAB |
 263                                  MUSB_TXCSR_DMAMODE);
 264                         musb_writew(mbase,
 265                                 MUSB_EP_OFFSET(pImplChannel->epnum,MUSB_TXCSR),
 266                                 csr);
 267                 }
 268                 else {
 269                         csr = musb_readw(mbase,
 270                                 MUSB_EP_OFFSET(pImplChannel->epnum,MUSB_RXCSR));
 271                         csr &= ~(MUSB_RXCSR_AUTOCLEAR |
 272                                  MUSB_RXCSR_DMAENAB |
 273                                  MUSB_RXCSR_DMAMODE);
 274                         musb_writew(mbase,
 275                                 MUSB_EP_OFFSET(pImplChannel->epnum,MUSB_RXCSR),
 276                                 csr);
 277                 }
 278
 279                 musb_writew(mbase,
 280                         MUSB_HSDMA_CHANNEL_OFFSET(bChannel, MUSB_HSDMA_CONTROL),
 281                         0);
 282                 musb_writel(mbase,
 283                         MUSB_HSDMA_CHANNEL_OFFSET(bChannel, MUSB_HSDMA_ADDRESS),
 284                         0);
 285                 musb_writel(mbase,
 286                         MUSB_HSDMA_CHANNEL_OFFSET(bChannel, MUSB_HSDMA_COUNT),
 287                         0);
 288
 289                 pChannel->status = MUSB_DMA_STATUS_FREE;
 290         }
 291         return 0;
 292 }
 293
 294 static irqreturn_t dma_controller_irq(int irq, void *private_data)
 295 {
 296         struct musb_dma_controller *controller =
 297                 (struct musb_dma_controller *)private_data;
 298         struct musb_dma_channel *pImplChannel;
 299         struct musb *musb = controller->pDmaPrivate;
 300         u8 *mbase = controller->pCoreBase;
 301         struct dma_channel *pChannel;
 302         u8 bChannel;
 303         u16 csr;
 304         u32 dwAddress;
 305         u8 int_hsdma;
 306         irqreturn_t retval = IRQ_NONE;
 307         unsigned long flags;
 308
 309         spin_lock_irqsave(&musb->lock, flags);
 310
 311         int_hsdma = musb_readb(mbase, MUSB_HSDMA_INTR);
 312         if (!int_hsdma)
 313                 goto done;
 314
 315         for (bChannel = 0; bChannel < MUSB_HSDMA_CHANNELS; bChannel++) {
 316                 if (int_hsdma & (1 << bChannel)) {
 317                         pImplChannel = (struct musb_dma_channel *)
 318                                         &(controller->aChannel[bChannel]);
 319                         pChannel = &pImplChannel->Channel;
 320
 321                         csr = musb_readw(mbase,
 322                                         MUSB_HSDMA_CHANNEL_OFFSET(bChannel,
 323                                                         MUSB_HSDMA_CONTROL));
 324
 325                         if (csr & (1 << MUSB_HSDMA_BUSERROR_SHIFT))
 326                                 pImplChannel->Channel.status =
 327                                         MUSB_DMA_STATUS_BUS_ABORT;
 328                         else {
 329                                 dwAddress = musb_readl(mbase,
 330                                                 MUSB_HSDMA_CHANNEL_OFFSET(
 331                                                         bChannel,
 332                                                         MUSB_HSDMA_ADDRESS));
 333                                 pChannel->actual_len = dwAddress
 334                                         - pImplChannel->dwStartAddress;
 335
 336                                 DBG(2, "ch %p, 0x%x -> 0x%x (%d / %d) %s\n",
 337                                         pChannel, pImplChannel->dwStartAddress,
 338                                         dwAddress, pChannel->actual_len,
 339                                         pImplChannel->len,
 340                                         (pChannel->actual_len
 341                                                 < pImplChannel->len) ?
 342                                         "=> reconfig 0": "=> complete");
 343
 344                                 u8 devctl = musb_readb(mbase,
 345                                                 MUSB_DEVCTL);
 346
 347                                 pChannel->status = MUSB_DMA_STATUS_FREE;
 348
 349                                 /* completed */
 350                                 if ((devctl & MUSB_DEVCTL_HM)
 351                                         && (pImplChannel->transmit)
 352                                         && ((pChannel->desired_mode == 0)
 353                                             || (pChannel->actual_len &
 354                                             (pImplChannel->wMaxPacketSize - 1)))
 355                                          ) {
 356                                         /* Send out the packet */
 357                                         musb_ep_select(mbase,
 358                                                 pImplChannel->epnum);
 359                                         musb_writew(mbase, MUSB_EP_OFFSET(
 360                                                         pImplChannel->epnum,
 361                                                         MUSB_TXCSR),
 362                                                 MUSB_TXCSR_TXPKTRDY);
 363                                 } else
 364                                         musb_dma_completion(
 365                                                 musb,
 366                                                 pImplChannel->epnum,
 367                                                 pImplChannel->transmit);
 368                         }
 369                 }
 370         }
 371         retval = IRQ_HANDLED;
 372 done:
 373         spin_unlock_irqrestore(&musb->lock, flags);
 374         return retval;
 375 }
 376
 377 void dma_controller_destroy(struct dma_controller *c)
 378 {
 379         struct musb_dma_controller *controller =
 380                 (struct musb_dma_controller *) c->private_data;
 381
 382         if (!controller)
 383                 return;
 384
 385         if (controller->irq)
 386                 free_irq(controller->irq, c);
 387
 388         kfree(controller);
 389         c->private_data = NULL;
 390 }
 391
 392 struct dma_controller *__init
 393 dma_controller_create(struct musb *musb, void __iomem *pCoreBase)
 394 {
 395         struct musb_dma_controller *controller;
 396         struct device *dev = musb->controller;
 397         struct platform_device *pdev = to_platform_device(dev);
 398         int irq = platform_get_irq(pdev, 1);
 399
 400         if (irq == 0) {
 401                 dev_err(dev, "No DMA interrupt line!\n");
 402                 return NULL;
 403         }
 404
 405         if (!(controller = kzalloc(sizeof(struct musb_dma_controller),
 406                                 GFP_KERNEL)))
 407                 return NULL;
 408
 409         controller->bChannelCount = MUSB_HSDMA_CHANNELS;
 410         controller->pDmaPrivate = musb;
 411         controller->pCoreBase = pCoreBase;
 412
 413         controller->Controller.private_data = controller;
 414         controller->Controller.start = dma_controller_start;
 415         controller->Controller.stop = dma_controller_stop;
 416         controller->Controller.channel_alloc = dma_channel_allocate;
 417         controller->Controller.channel_release = dma_channel_release;
 418         controller->Controller.channel_program = dma_channel_program;
 419         controller->Controller.channel_abort = dma_channel_abort;
 420
 421         if (request_irq(irq, dma_controller_irq, IRQF_DISABLED,
 422                         musb->controller->bus_id, &controller->Controller)) {
 423                 dev_err(dev, "request_irq %d failed!\n", irq);
 424                 dma_controller_destroy(&controller->Controller);
 425                 return NULL;
 426         }
 427
 428         controller->irq = irq;
 429
 430         return &controller->Controller;
 431 }