drivers/dma/mxs-dma.c

   1 /*
   2  * Copyright 2011 Freescale Semiconductor, Inc. All Rights Reserved.
   3  *
   4  * Refer to drivers/dma/imx-sdma.c
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  */
  10
  11 #include <linux/init.h>
  12 #include <linux/types.h>
  13 #include <linux/mm.h>
  14 #include <linux/interrupt.h>
  15 #include <linux/clk.h>
  16 #include <linux/wait.h>
  17 #include <linux/sched.h>
  18 #include <linux/semaphore.h>
  19 #include <linux/device.h>
  20 #include <linux/dma-mapping.h>
  21 #include <linux/slab.h>
  22 #include <linux/platform_device.h>
  23 #include <linux/dmaengine.h>
  24 #include <linux/delay.h>
  25 #include <linux/module.h>
  26 #include <linux/stmp_device.h>
  27 #include <linux/of.h>
  28 #include <linux/of_device.h>
  29 #include <linux/of_dma.h>
  30 #include <linux/list.h>
  31
  32 #include <asm/irq.h>
  33
  34 #include "dmaengine.h"
  35
  36 /*
  37  * NOTE: The term "PIO" throughout the mxs-dma implementation means
  38  * PIO mode of mxs apbh-dma and apbx-dma.  With this working mode,
  39  * dma can program the controller registers of peripheral devices.
  40  */
  41
  42 #define dma_is_apbh(mxs_dma)    ((mxs_dma)->type == MXS_DMA_APBH)
  43 #define apbh_is_old(mxs_dma)    ((mxs_dma)->dev_id == IMX23_DMA)
  44
  45 #define HW_APBHX_CTRL0                          0x000
  46 #define BM_APBH_CTRL0_APB_BURST8_EN             (1 << 29)
  47 #define BM_APBH_CTRL0_APB_BURST_EN              (1 << 28)
  48 #define BP_APBH_CTRL0_RESET_CHANNEL             16
  49 #define HW_APBHX_CTRL1                          0x010
  50 #define HW_APBHX_CTRL2                          0x020
  51 #define HW_APBHX_CHANNEL_CTRL                   0x030
  52 #define BP_APBHX_CHANNEL_CTRL_RESET_CHANNEL     16
  53 /*
  54  * The offset of NXTCMDAR register is different per both dma type and version,
  55  * while stride for each channel is all the same 0x70.
  56  */
  57 #define HW_APBHX_CHn_NXTCMDAR(d, n) \
  58         (((dma_is_apbh(d) && apbh_is_old(d)) ? 0x050 : 0x110) + (n) * 0x70)
  59 #define HW_APBHX_CHn_SEMA(d, n) \
  60         (((dma_is_apbh(d) && apbh_is_old(d)) ? 0x080 : 0x140) + (n) * 0x70)
  61 #define HW_APBHX_CHn_BAR(d, n) \
  62         (((dma_is_apbh(d) && apbh_is_old(d)) ? 0x070 : 0x130) + (n) * 0x70)
  63 #define HW_APBX_CHn_DEBUG1(d, n) (0x150 + (n) * 0x70)
  64
  65 /*
  66  * ccw bits definitions
  67  *
  68  * COMMAND:             0..1    (2)
  69  * CHAIN:               2       (1)
  70  * IRQ:                 3       (1)
  71  * NAND_LOCK:           4       (1) - not implemented
  72  * NAND_WAIT4READY:     5       (1) - not implemented
  73  * DEC_SEM:             6       (1)
  74  * WAIT4END:            7       (1)
  75  * HALT_ON_TERMINATE:   8       (1)
  76  * TERMINATE_FLUSH:     9       (1)
  77  * RESERVED:            10..11  (2)
  78  * PIO_NUM:             12..15  (4)
  79  */
  80 #define BP_CCW_COMMAND          0
  81 #define BM_CCW_COMMAND          (3 << 0)
  82 #define CCW_CHAIN               (1 << 2)
  83 #define CCW_IRQ                 (1 << 3)
  84 #define CCW_DEC_SEM             (1 << 6)
  85 #define CCW_WAIT4END            (1 << 7)
  86 #define CCW_HALT_ON_TERM        (1 << 8)
  87 #define CCW_TERM_FLUSH          (1 << 9)
  88 #define BP_CCW_PIO_NUM          12
  89 #define BM_CCW_PIO_NUM          (0xf << 12)
  90
  91 #define BF_CCW(value, field)    (((value) << BP_CCW_##field) & BM_CCW_##field)
  92
  93 #define MXS_DMA_CMD_NO_XFER     0
  94 #define MXS_DMA_CMD_WRITE       1
  95 #define MXS_DMA_CMD_READ        2
  96 #define MXS_DMA_CMD_DMA_SENSE   3       /* not implemented */
  97
  98 struct mxs_dma_ccw {
  99         u32             next;
 100         u16             bits;
 101         u16             xfer_bytes;
 102 #define MAX_XFER_BYTES  0xff00
 103         u32             bufaddr;
 104 #define MXS_PIO_WORDS   16
 105         u32             pio_words[MXS_PIO_WORDS];
 106 };
 107
 108 #define CCW_BLOCK_SIZE  (4 * PAGE_SIZE)
 109 #define NUM_CCW (int)(CCW_BLOCK_SIZE / sizeof(struct mxs_dma_ccw))
 110
 111 struct mxs_dma_chan {
 112         struct mxs_dma_engine           *mxs_dma;
 113         struct dma_chan                 chan;
 114         struct dma_async_tx_descriptor  desc;
 115         struct tasklet_struct           tasklet;
 116         unsigned int                    chan_irq;
 117         struct mxs_dma_ccw              *ccw;
 118         dma_addr_t                      ccw_phys;
 119         int                             desc_count;
 120         enum dma_status                 status;
 121         unsigned int                    flags;
 122         bool                            reset;
 123 #define MXS_DMA_SG_LOOP                 (1 << 0)
 124 #define MXS_DMA_USE_SEMAPHORE           (1 << 1)
 125 };
 126
 127 #define MXS_DMA_CHANNELS                16
 128 #define MXS_DMA_CHANNELS_MASK           0xffff
 129
 130 enum mxs_dma_devtype {
 131         MXS_DMA_APBH,
 132         MXS_DMA_APBX,
 133 };
 134
 135 enum mxs_dma_id {
 136         IMX23_DMA,
 137         IMX28_DMA,
 138 };
 139
 140 struct mxs_dma_engine {
 141         enum mxs_dma_id                 dev_id;
 142         enum mxs_dma_devtype            type;
 143         void __iomem                    *base;
 144         struct clk                      *clk;
 145         struct dma_device               dma_device;
 146         struct device_dma_parameters    dma_parms;
 147         struct mxs_dma_chan             mxs_chans[MXS_DMA_CHANNELS];
 148         struct platform_device          *pdev;
 149         unsigned int                    nr_channels;
 150 };
 151
 152 struct mxs_dma_type {
 153         enum mxs_dma_id id;
 154         enum mxs_dma_devtype type;
 155 };
 156
 157 static struct mxs_dma_type mxs_dma_types[] = {
 158         {
 159                 .id = IMX23_DMA,
 160                 .type = MXS_DMA_APBH,
 161         }, {
 162                 .id = IMX23_DMA,
 163                 .type = MXS_DMA_APBX,
 164         }, {
 165                 .id = IMX28_DMA,
 166                 .type = MXS_DMA_APBH,
 167         }, {
 168                 .id = IMX28_DMA,
 169                 .type = MXS_DMA_APBX,
 170         }
 171 };
 172
 173 static const struct platform_device_id mxs_dma_ids[] = {
 174         {
 175                 .name = "imx23-dma-apbh",
 176                 .driver_data = (kernel_ulong_t) &mxs_dma_types[0],
 177         }, {
 178                 .name = "imx23-dma-apbx",
 179                 .driver_data = (kernel_ulong_t) &mxs_dma_types[1],
 180         }, {
 181                 .name = "imx28-dma-apbh",
 182                 .driver_data = (kernel_ulong_t) &mxs_dma_types[2],
 183         }, {
 184                 .name = "imx28-dma-apbx",
 185                 .driver_data = (kernel_ulong_t) &mxs_dma_types[3],
 186         }, {
 187                 /* end of list */
 188         }
 189 };
 190
 191 static const struct of_device_id mxs_dma_dt_ids[] = {
 192         { .compatible = "fsl,imx23-dma-apbh", .data = &mxs_dma_ids[0], },
 193         { .compatible = "fsl,imx23-dma-apbx", .data = &mxs_dma_ids[1], },
 194         { .compatible = "fsl,imx28-dma-apbh", .data = &mxs_dma_ids[2], },
 195         { .compatible = "fsl,imx28-dma-apbx", .data = &mxs_dma_ids[3], },
 196         { /* sentinel */ }
 197 };
 198 MODULE_DEVICE_TABLE(of, mxs_dma_dt_ids);
 199
 200 static struct mxs_dma_chan *to_mxs_dma_chan(struct dma_chan *chan)
 201 {
 202         return container_of(chan, struct mxs_dma_chan, chan);
 203 }
 204
 205 static void mxs_dma_reset_chan(struct dma_chan *chan)
 206 {
 207         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 208         struct mxs_dma_engine *mxs_dma = mxs_chan->mxs_dma;
 209         int chan_id = mxs_chan->chan.chan_id;
 210
 211         /*
 212          * mxs dma channel resets can cause a channel stall. To recover from a
 213          * channel stall, we have to reset the whole DMA engine. To avoid this,
 214          * we use cyclic DMA with semaphores, that are enhanced in
 215          * mxs_dma_int_handler. To reset the channel, we can simply stop writing
 216          * into the semaphore counter.
 217          */
 218         if (mxs_chan->flags & MXS_DMA_USE_SEMAPHORE &&
 219                         mxs_chan->flags & MXS_DMA_SG_LOOP) {
 220                 mxs_chan->reset = true;
 221         } else if (dma_is_apbh(mxs_dma) && apbh_is_old(mxs_dma)) {
 222                 writel(1 << (chan_id + BP_APBH_CTRL0_RESET_CHANNEL),
 223                         mxs_dma->base + HW_APBHX_CTRL0 + STMP_OFFSET_REG_SET);
 224         } else {
 225                 unsigned long elapsed = 0;
 226                 const unsigned long max_wait = 50000; /* 50ms */
 227                 void __iomem *reg_dbg1 = mxs_dma->base +
 228                                 HW_APBX_CHn_DEBUG1(mxs_dma, chan_id);
 229
 230                 /*
 231                  * On i.MX28 APBX, the DMA channel can stop working if we reset
 232                  * the channel while it is in READ_FLUSH (0x08) state.
 233                  * We wait here until we leave the state. Then we trigger the
 234                  * reset. Waiting a maximum of 50ms, the kernel shouldn't crash
 235                  * because of this.
 236                  */
 237                 while ((readl(reg_dbg1) & 0xf) == 0x8 && elapsed < max_wait) {
 238                         udelay(100);
 239                         elapsed += 100;
 240                 }
 241
 242                 if (elapsed >= max_wait)
 243                         dev_err(&mxs_chan->mxs_dma->pdev->dev,
 244                                         "Failed waiting for the DMA channel %d to leave state READ_FLUSH, trying to reset channel in READ_FLUSH state now\n",
 245                                         chan_id);
 246
 247                 writel(1 << (chan_id + BP_APBHX_CHANNEL_CTRL_RESET_CHANNEL),
 248                         mxs_dma->base + HW_APBHX_CHANNEL_CTRL + STMP_OFFSET_REG_SET);
 249         }
 250
 251         mxs_chan->status = DMA_COMPLETE;
 252 }
 253
 254 static void mxs_dma_enable_chan(struct dma_chan *chan)
 255 {
 256         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 257         struct mxs_dma_engine *mxs_dma = mxs_chan->mxs_dma;
 258         int chan_id = mxs_chan->chan.chan_id;
 259
 260         /* set cmd_addr up */
 261         writel(mxs_chan->ccw_phys,
 262                 mxs_dma->base + HW_APBHX_CHn_NXTCMDAR(mxs_dma, chan_id));
 263
 264         /* write 1 to SEMA to kick off the channel */
 265         if (mxs_chan->flags & MXS_DMA_USE_SEMAPHORE &&
 266                         mxs_chan->flags & MXS_DMA_SG_LOOP) {
 267                 /* A cyclic DMA consists of at least 2 segments, so initialize
 268                  * the semaphore with 2 so we have enough time to add 1 to the
 269                  * semaphore if we need to */
 270                 writel(2, mxs_dma->base + HW_APBHX_CHn_SEMA(mxs_dma, chan_id));
 271         } else {
 272                 writel(1, mxs_dma->base + HW_APBHX_CHn_SEMA(mxs_dma, chan_id));
 273         }
 274         mxs_chan->reset = false;
 275 }
 276
 277 static void mxs_dma_disable_chan(struct dma_chan *chan)
 278 {
 279         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 280
 281         mxs_chan->status = DMA_COMPLETE;
 282 }
 283
 284 static int mxs_dma_pause_chan(struct dma_chan *chan)
 285 {
 286         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 287         struct mxs_dma_engine *mxs_dma = mxs_chan->mxs_dma;
 288         int chan_id = mxs_chan->chan.chan_id;
 289
 290         /* freeze the channel */
 291         if (dma_is_apbh(mxs_dma) && apbh_is_old(mxs_dma))
 292                 writel(1 << chan_id,
 293                         mxs_dma->base + HW_APBHX_CTRL0 + STMP_OFFSET_REG_SET);
 294         else
 295                 writel(1 << chan_id,
 296                         mxs_dma->base + HW_APBHX_CHANNEL_CTRL + STMP_OFFSET_REG_SET);
 297
 298         mxs_chan->status = DMA_PAUSED;
 299         return 0;
 300 }
 301
 302 static int mxs_dma_resume_chan(struct dma_chan *chan)
 303 {
 304         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 305         struct mxs_dma_engine *mxs_dma = mxs_chan->mxs_dma;
 306         int chan_id = mxs_chan->chan.chan_id;
 307
 308         /* unfreeze the channel */
 309         if (dma_is_apbh(mxs_dma) && apbh_is_old(mxs_dma))
 310                 writel(1 << chan_id,
 311                         mxs_dma->base + HW_APBHX_CTRL0 + STMP_OFFSET_REG_CLR);
 312         else
 313                 writel(1 << chan_id,
 314                         mxs_dma->base + HW_APBHX_CHANNEL_CTRL + STMP_OFFSET_REG_CLR);
 315
 316         mxs_chan->status = DMA_IN_PROGRESS;
 317         return 0;
 318 }
 319
 320 static dma_cookie_t mxs_dma_tx_submit(struct dma_async_tx_descriptor *tx)
 321 {
 322         return dma_cookie_assign(tx);
 323 }
 324
 325 static void mxs_dma_tasklet(unsigned long data)
 326 {
 327         struct mxs_dma_chan *mxs_chan = (struct mxs_dma_chan *) data;
 328
 329         if (mxs_chan->desc.callback)
 330                 mxs_chan->desc.callback(mxs_chan->desc.callback_param);
 331 }
 332
 333 static int mxs_dma_irq_to_chan(struct mxs_dma_engine *mxs_dma, int irq)
 334 {
 335         int i;
 336
 337         for (i = 0; i != mxs_dma->nr_channels; ++i)
 338                 if (mxs_dma->mxs_chans[i].chan_irq == irq)
 339                         return i;
 340
 341         return -EINVAL;
 342 }
 343
 344 static irqreturn_t mxs_dma_int_handler(int irq, void *dev_id)
 345 {
 346         struct mxs_dma_engine *mxs_dma = dev_id;
 347         struct mxs_dma_chan *mxs_chan;
 348         u32 completed;
 349         u32 err;
 350         int chan = mxs_dma_irq_to_chan(mxs_dma, irq);
 351
 352         if (chan < 0)
 353                 return IRQ_NONE;
 354
 355         /* completion status */
 356         completed = readl(mxs_dma->base + HW_APBHX_CTRL1);
 357         completed = (completed >> chan) & 0x1;
 358
 359         /* Clear interrupt */
 360         writel((1 << chan),
 361                         mxs_dma->base + HW_APBHX_CTRL1 + STMP_OFFSET_REG_CLR);
 362
 363         /* error status */
 364         err = readl(mxs_dma->base + HW_APBHX_CTRL2);
 365         err &= (1 << (MXS_DMA_CHANNELS + chan)) | (1 << chan);
 366
 367         /*
 368          * error status bit is in the upper 16 bits, error irq bit in the lower
 369          * 16 bits. We transform it into a simpler error code:
 370          * err: 0x00 = no error, 0x01 = TERMINATION, 0x02 = BUS_ERROR
 371          */
 372         err = (err >> (MXS_DMA_CHANNELS + chan)) + (err >> chan);
 373
 374         /* Clear error irq */
 375         writel((1 << chan),
 376                         mxs_dma->base + HW_APBHX_CTRL2 + STMP_OFFSET_REG_CLR);
 377
 378         /*
 379          * When both completion and error of termination bits set at the
 380          * same time, we do not take it as an error.  IOW, it only becomes
 381          * an error we need to handle here in case of either it's a bus
 382          * error or a termination error with no completion. 0x01 is termination
 383          * error, so we can subtract err & completed to get the real error case.
 384          */
 385         err -= err & completed;
 386
 387         mxs_chan = &mxs_dma->mxs_chans[chan];
 388
 389         if (err) {
 390                 dev_dbg(mxs_dma->dma_device.dev,
 391                         "%s: error in channel %d\n", __func__,
 392                         chan);
 393                 mxs_chan->status = DMA_ERROR;
 394                 mxs_dma_reset_chan(&mxs_chan->chan);
 395         } else if (mxs_chan->status != DMA_COMPLETE) {
 396                 if (mxs_chan->flags & MXS_DMA_SG_LOOP) {
 397                         mxs_chan->status = DMA_IN_PROGRESS;
 398                         if (mxs_chan->flags & MXS_DMA_USE_SEMAPHORE)
 399                                 writel(1, mxs_dma->base +
 400                                         HW_APBHX_CHn_SEMA(mxs_dma, chan));
 401                 } else {
 402                         mxs_chan->status = DMA_COMPLETE;
 403                 }
 404         }
 405
 406         if (mxs_chan->status == DMA_COMPLETE) {
 407                 if (mxs_chan->reset)
 408                         return IRQ_HANDLED;
 409                 dma_cookie_complete(&mxs_chan->desc);
 410         }
 411
 412         /* schedule tasklet on this channel */
 413         tasklet_schedule(&mxs_chan->tasklet);
 414
 415         return IRQ_HANDLED;
 416 }
 417
 418 static int mxs_dma_alloc_chan_resources(struct dma_chan *chan)
 419 {
 420         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 421         struct mxs_dma_engine *mxs_dma = mxs_chan->mxs_dma;
 422         int ret;
 423
 424         mxs_chan->ccw = dma_zalloc_coherent(mxs_dma->dma_device.dev,
 425                                             CCW_BLOCK_SIZE,
 426                                             &mxs_chan->ccw_phys, GFP_KERNEL);
 427         if (!mxs_chan->ccw) {
 428                 ret = -ENOMEM;
 429                 goto err_alloc;
 430         }
 431
 432         ret = request_irq(mxs_chan->chan_irq, mxs_dma_int_handler,
 433                           0, "mxs-dma", mxs_dma);
 434         if (ret)
 435                 goto err_irq;
 436
 437         ret = clk_prepare_enable(mxs_dma->clk);
 438         if (ret)
 439                 goto err_clk;
 440
 441         mxs_dma_reset_chan(chan);
 442
 443         dma_async_tx_descriptor_init(&mxs_chan->desc, chan);
 444         mxs_chan->desc.tx_submit = mxs_dma_tx_submit;
 445
 446         /* the descriptor is ready */
 447         async_tx_ack(&mxs_chan->desc);
 448
 449         return 0;
 450
 451 err_clk:
 452         free_irq(mxs_chan->chan_irq, mxs_dma);
 453 err_irq:
 454         dma_free_coherent(mxs_dma->dma_device.dev, CCW_BLOCK_SIZE,
 455                         mxs_chan->ccw, mxs_chan->ccw_phys);
 456 err_alloc:
 457         return ret;
 458 }
 459
 460 static void mxs_dma_free_chan_resources(struct dma_chan *chan)
 461 {
 462         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 463         struct mxs_dma_engine *mxs_dma = mxs_chan->mxs_dma;
 464
 465         mxs_dma_disable_chan(chan);
 466
 467         free_irq(mxs_chan->chan_irq, mxs_dma);
 468
 469         dma_free_coherent(mxs_dma->dma_device.dev, CCW_BLOCK_SIZE,
 470                         mxs_chan->ccw, mxs_chan->ccw_phys);
 471
 472         clk_disable_unprepare(mxs_dma->clk);
 473 }
 474
 475 /*
 476  * How to use the flags for ->device_prep_slave_sg() :
 477  *    [1] If there is only one DMA command in the DMA chain, the code should be:
 478  *            ......
 479  *            ->device_prep_slave_sg(DMA_CTRL_ACK);
 480  *            ......
 481  *    [2] If there are two DMA commands in the DMA chain, the code should be
 482  *            ......
 483  *            ->device_prep_slave_sg(0);
 484  *            ......
 485  *            ->device_prep_slave_sg(DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 486  *            ......
 487  *    [3] If there are more than two DMA commands in the DMA chain, the code
 488  *        should be:
 489  *            ......
 490  *            ->device_prep_slave_sg(0);                                // First
 491  *            ......
 492  *            ->device_prep_slave_sg(DMA_PREP_INTERRUPT [| DMA_CTRL_ACK]);
 493  *            ......
 494  *            ->device_prep_slave_sg(DMA_PREP_INTERRUPT | DMA_CTRL_ACK); // Last
 495  *            ......
 496  */
 497 static struct dma_async_tx_descriptor *mxs_dma_prep_slave_sg(
 498                 struct dma_chan *chan, struct scatterlist *sgl,
 499                 unsigned int sg_len, enum dma_transfer_direction direction,
 500                 unsigned long flags, void *context)
 501 {
 502         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 503         struct mxs_dma_engine *mxs_dma = mxs_chan->mxs_dma;
 504         struct mxs_dma_ccw *ccw;
 505         struct scatterlist *sg;
 506         u32 i, j;
 507         u32 *pio;
 508         bool append = flags & DMA_PREP_INTERRUPT;
 509         int idx = append ? mxs_chan->desc_count : 0;
 510
 511         if (mxs_chan->status == DMA_IN_PROGRESS && !append)
 512                 return NULL;
 513
 514         if (sg_len + (append ? idx : 0) > NUM_CCW) {
 515                 dev_err(mxs_dma->dma_device.dev,
 516                                 "maximum number of sg exceeded: %d > %d\n",
 517                                 sg_len, NUM_CCW);
 518                 goto err_out;
 519         }
 520
 521         mxs_chan->status = DMA_IN_PROGRESS;
 522         mxs_chan->flags = 0;
 523
 524         /*
 525          * If the sg is prepared with append flag set, the sg
 526          * will be appended to the last prepared sg.
 527          */
 528         if (append) {
 529                 BUG_ON(idx < 1);
 530                 ccw = &mxs_chan->ccw[idx - 1];
 531                 ccw->next = mxs_chan->ccw_phys + sizeof(*ccw) * idx;
 532                 ccw->bits |= CCW_CHAIN;
 533                 ccw->bits &= ~CCW_IRQ;
 534                 ccw->bits &= ~CCW_DEC_SEM;
 535         } else {
 536                 idx = 0;
 537         }
 538
 539         if (direction == DMA_TRANS_NONE) {
 540                 ccw = &mxs_chan->ccw[idx++];
 541                 pio = (u32 *) sgl;
 542
 543                 for (j = 0; j < sg_len;)
 544                         ccw->pio_words[j++] = *pio++;
 545
 546                 ccw->bits = 0;
 547                 ccw->bits |= CCW_IRQ;
 548                 ccw->bits |= CCW_DEC_SEM;
 549                 if (flags & DMA_CTRL_ACK)
 550                         ccw->bits |= CCW_WAIT4END;
 551                 ccw->bits |= CCW_HALT_ON_TERM;
 552                 ccw->bits |= CCW_TERM_FLUSH;
 553                 ccw->bits |= BF_CCW(sg_len, PIO_NUM);
 554                 ccw->bits |= BF_CCW(MXS_DMA_CMD_NO_XFER, COMMAND);
 555         } else {
 556                 for_each_sg(sgl, sg, sg_len, i) {
 557                         if (sg_dma_len(sg) > MAX_XFER_BYTES) {
 558                                 dev_err(mxs_dma->dma_device.dev, "maximum bytes for sg entry exceeded: %d > %d\n",
 559                                                 sg_dma_len(sg), MAX_XFER_BYTES);
 560                                 goto err_out;
 561                         }
 562
 563                         ccw = &mxs_chan->ccw[idx++];
 564
 565                         ccw->next = mxs_chan->ccw_phys + sizeof(*ccw) * idx;
 566                         ccw->bufaddr = sg->dma_address;
 567                         ccw->xfer_bytes = sg_dma_len(sg);
 568
 569                         ccw->bits = 0;
 570                         ccw->bits |= CCW_CHAIN;
 571                         ccw->bits |= CCW_HALT_ON_TERM;
 572                         ccw->bits |= CCW_TERM_FLUSH;
 573                         ccw->bits |= BF_CCW(direction == DMA_DEV_TO_MEM ?
 574                                         MXS_DMA_CMD_WRITE : MXS_DMA_CMD_READ,
 575                                         COMMAND);
 576
 577                         if (i + 1 == sg_len) {
 578                                 ccw->bits &= ~CCW_CHAIN;
 579                                 ccw->bits |= CCW_IRQ;
 580                                 ccw->bits |= CCW_DEC_SEM;
 581                                 if (flags & DMA_CTRL_ACK)
 582                                         ccw->bits |= CCW_WAIT4END;
 583                         }
 584                 }
 585         }
 586         mxs_chan->desc_count = idx;
 587
 588         return &mxs_chan->desc;
 589
 590 err_out:
 591         mxs_chan->status = DMA_ERROR;
 592         return NULL;
 593 }
 594
 595 static struct dma_async_tx_descriptor *mxs_dma_prep_dma_cyclic(
 596                 struct dma_chan *chan, dma_addr_t dma_addr, size_t buf_len,
 597                 size_t period_len, enum dma_transfer_direction direction,
 598                 unsigned long flags)
 599 {
 600         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 601         struct mxs_dma_engine *mxs_dma = mxs_chan->mxs_dma;
 602         u32 num_periods = buf_len / period_len;
 603         u32 i = 0, buf = 0;
 604
 605         if (mxs_chan->status == DMA_IN_PROGRESS)
 606                 return NULL;
 607
 608         mxs_chan->status = DMA_IN_PROGRESS;
 609         mxs_chan->flags |= MXS_DMA_SG_LOOP;
 610         mxs_chan->flags |= MXS_DMA_USE_SEMAPHORE;
 611
 612         if (num_periods > NUM_CCW) {
 613                 dev_err(mxs_dma->dma_device.dev,
 614                                 "maximum number of sg exceeded: %d > %d\n",
 615                                 num_periods, NUM_CCW);
 616                 goto err_out;
 617         }
 618
 619         if (period_len > MAX_XFER_BYTES) {
 620                 dev_err(mxs_dma->dma_device.dev,
 621                                 "maximum period size exceeded: %d > %d\n",
 622                                 period_len, MAX_XFER_BYTES);
 623                 goto err_out;
 624         }
 625
 626         while (buf < buf_len) {
 627                 struct mxs_dma_ccw *ccw = &mxs_chan->ccw[i];
 628
 629                 if (i + 1 == num_periods)
 630                         ccw->next = mxs_chan->ccw_phys;
 631                 else
 632                         ccw->next = mxs_chan->ccw_phys + sizeof(*ccw) * (i + 1);
 633
 634                 ccw->bufaddr = dma_addr;
 635                 ccw->xfer_bytes = period_len;
 636
 637                 ccw->bits = 0;
 638                 ccw->bits |= CCW_CHAIN;
 639                 ccw->bits |= CCW_IRQ;
 640                 ccw->bits |= CCW_HALT_ON_TERM;
 641                 ccw->bits |= CCW_TERM_FLUSH;
 642                 ccw->bits |= CCW_DEC_SEM;
 643                 ccw->bits |= BF_CCW(direction == DMA_DEV_TO_MEM ?
 644                                 MXS_DMA_CMD_WRITE : MXS_DMA_CMD_READ, COMMAND);
 645
 646                 dma_addr += period_len;
 647                 buf += period_len;
 648
 649                 i++;
 650         }
 651         mxs_chan->desc_count = i;
 652
 653         return &mxs_chan->desc;
 654
 655 err_out:
 656         mxs_chan->status = DMA_ERROR;
 657         return NULL;
 658 }
 659
 660 static int mxs_dma_terminate_all(struct dma_chan *chan)
 661 {
 662         mxs_dma_reset_chan(chan);
 663         mxs_dma_disable_chan(chan);
 664
 665         return 0;
 666 }
 667
 668 static enum dma_status mxs_dma_tx_status(struct dma_chan *chan,
 669                         dma_cookie_t cookie, struct dma_tx_state *txstate)
 670 {
 671         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 672         struct mxs_dma_engine *mxs_dma = mxs_chan->mxs_dma;
 673         u32 residue = 0;
 674
 675         if (mxs_chan->status == DMA_IN_PROGRESS &&
 676                         mxs_chan->flags & MXS_DMA_SG_LOOP) {
 677                 struct mxs_dma_ccw *last_ccw;
 678                 u32 bar;
 679
 680                 last_ccw = &mxs_chan->ccw[mxs_chan->desc_count - 1];
 681                 residue = last_ccw->xfer_bytes + last_ccw->bufaddr;
 682
 683                 bar = readl(mxs_dma->base +
 684                                 HW_APBHX_CHn_BAR(mxs_dma, chan->chan_id));
 685                 residue -= bar;
 686         }
 687
 688         dma_set_tx_state(txstate, chan->completed_cookie, chan->cookie,
 689                         residue);
 690
 691         return mxs_chan->status;
 692 }
 693
 694 static int __init mxs_dma_init(struct mxs_dma_engine *mxs_dma)
 695 {
 696         int ret;
 697
 698         ret = clk_prepare_enable(mxs_dma->clk);
 699         if (ret)
 700                 return ret;
 701
 702         ret = stmp_reset_block(mxs_dma->base);
 703         if (ret)
 704                 goto err_out;
 705
 706         /* enable apbh burst */
 707         if (dma_is_apbh(mxs_dma)) {
 708                 writel(BM_APBH_CTRL0_APB_BURST_EN,
 709                         mxs_dma->base + HW_APBHX_CTRL0 + STMP_OFFSET_REG_SET);
 710                 writel(BM_APBH_CTRL0_APB_BURST8_EN,
 711                         mxs_dma->base + HW_APBHX_CTRL0 + STMP_OFFSET_REG_SET);
 712         }
 713
 714         /* enable irq for all the channels */
 715         writel(MXS_DMA_CHANNELS_MASK << MXS_DMA_CHANNELS,
 716                 mxs_dma->base + HW_APBHX_CTRL1 + STMP_OFFSET_REG_SET);
 717
 718 err_out:
 719         clk_disable_unprepare(mxs_dma->clk);
 720         return ret;
 721 }
 722
 723 struct mxs_dma_filter_param {
 724         struct device_node *of_node;
 725         unsigned int chan_id;
 726 };
 727
 728 static bool mxs_dma_filter_fn(struct dma_chan *chan, void *fn_param)
 729 {
 730         struct mxs_dma_filter_param *param = fn_param;
 731         struct mxs_dma_chan *mxs_chan = to_mxs_dma_chan(chan);
 732         struct mxs_dma_engine *mxs_dma = mxs_chan->mxs_dma;
 733         int chan_irq;
 734
 735         if (mxs_dma->dma_device.dev->of_node != param->of_node)
 736                 return false;
 737
 738         if (chan->chan_id != param->chan_id)
 739                 return false;
 740
 741         chan_irq = platform_get_irq(mxs_dma->pdev, param->chan_id);
 742         if (chan_irq < 0)
 743                 return false;
 744
 745         mxs_chan->chan_irq = chan_irq;
 746
 747         return true;
 748 }
 749
 750 static struct dma_chan *mxs_dma_xlate(struct of_phandle_args *dma_spec,
 751                                struct of_dma *ofdma)
 752 {
 753         struct mxs_dma_engine *mxs_dma = ofdma->of_dma_data;
 754         dma_cap_mask_t mask = mxs_dma->dma_device.cap_mask;
 755         struct mxs_dma_filter_param param;
 756
 757         if (dma_spec->args_count != 1)
 758                 return NULL;
 759
 760         param.of_node = ofdma->of_node;
 761         param.chan_id = dma_spec->args[0];
 762
 763         if (param.chan_id >= mxs_dma->nr_channels)
 764                 return NULL;
 765
 766         return dma_request_channel(mask, mxs_dma_filter_fn, &param);
 767 }
 768
 769 static int __init mxs_dma_probe(struct platform_device *pdev)
 770 {
 771         struct device_node *np = pdev->dev.of_node;
 772         const struct platform_device_id *id_entry;
 773         const struct of_device_id *of_id;
 774         const struct mxs_dma_type *dma_type;
 775         struct mxs_dma_engine *mxs_dma;
 776         struct resource *iores;
 777         int ret, i;
 778
 779         mxs_dma = devm_kzalloc(&pdev->dev, sizeof(*mxs_dma), GFP_KERNEL);
 780         if (!mxs_dma)
 781                 return -ENOMEM;
 782
 783         ret = of_property_read_u32(np, "dma-channels", &mxs_dma->nr_channels);
 784         if (ret) {
 785                 dev_err(&pdev->dev, "failed to read dma-channels\n");
 786                 return ret;
 787         }
 788
 789         of_id = of_match_device(mxs_dma_dt_ids, &pdev->dev);
 790         if (of_id)
 791                 id_entry = of_id->data;
 792         else
 793                 id_entry = platform_get_device_id(pdev);
 794
 795         dma_type = (struct mxs_dma_type *)id_entry->driver_data;
 796         mxs_dma->type = dma_type->type;
 797         mxs_dma->dev_id = dma_type->id;
 798
 799         iores = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 800         mxs_dma->base = devm_ioremap_resource(&pdev->dev, iores);
 801         if (IS_ERR(mxs_dma->base))
 802                 return PTR_ERR(mxs_dma->base);
 803
 804         mxs_dma->clk = devm_clk_get(&pdev->dev, NULL);
 805         if (IS_ERR(mxs_dma->clk))
 806                 return PTR_ERR(mxs_dma->clk);
 807
 808         dma_cap_set(DMA_SLAVE, mxs_dma->dma_device.cap_mask);
 809         dma_cap_set(DMA_CYCLIC, mxs_dma->dma_device.cap_mask);
 810
 811         INIT_LIST_HEAD(&mxs_dma->dma_device.channels);
 812
 813         /* Initialize channel parameters */
 814         for (i = 0; i < MXS_DMA_CHANNELS; i++) {
 815                 struct mxs_dma_chan *mxs_chan = &mxs_dma->mxs_chans[i];
 816
 817                 mxs_chan->mxs_dma = mxs_dma;
 818                 mxs_chan->chan.device = &mxs_dma->dma_device;
 819                 dma_cookie_init(&mxs_chan->chan);
 820
 821                 tasklet_init(&mxs_chan->tasklet, mxs_dma_tasklet,
 822                              (unsigned long) mxs_chan);
 823
 824
 825                 /* Add the channel to mxs_chan list */
 826                 list_add_tail(&mxs_chan->chan.device_node,
 827                         &mxs_dma->dma_device.channels);
 828         }
 829
 830         ret = mxs_dma_init(mxs_dma);
 831         if (ret)
 832                 return ret;
 833
 834         mxs_dma->pdev = pdev;
 835         mxs_dma->dma_device.dev = &pdev->dev;
 836
 837         /* mxs_dma gets 65535 bytes maximum sg size */
 838         mxs_dma->dma_device.dev->dma_parms = &mxs_dma->dma_parms;
 839         dma_set_max_seg_size(mxs_dma->dma_device.dev, MAX_XFER_BYTES);
 840
 841         mxs_dma->dma_device.device_alloc_chan_resources = mxs_dma_alloc_chan_resources;
 842         mxs_dma->dma_device.device_free_chan_resources = mxs_dma_free_chan_resources;
 843         mxs_dma->dma_device.device_tx_status = mxs_dma_tx_status;
 844         mxs_dma->dma_device.device_prep_slave_sg = mxs_dma_prep_slave_sg;
 845         mxs_dma->dma_device.device_prep_dma_cyclic = mxs_dma_prep_dma_cyclic;
 846         mxs_dma->dma_device.device_pause = mxs_dma_pause_chan;
 847         mxs_dma->dma_device.device_resume = mxs_dma_resume_chan;
 848         mxs_dma->dma_device.device_terminate_all = mxs_dma_terminate_all;
 849         mxs_dma->dma_device.src_addr_widths = BIT(DMA_SLAVE_BUSWIDTH_4_BYTES);
 850         mxs_dma->dma_device.dst_addr_widths = BIT(DMA_SLAVE_BUSWIDTH_4_BYTES);
 851         mxs_dma->dma_device.directions = BIT(DMA_DEV_TO_MEM) | BIT(DMA_MEM_TO_DEV);
 852         mxs_dma->dma_device.residue_granularity = DMA_RESIDUE_GRANULARITY_BURST;
 853         mxs_dma->dma_device.device_issue_pending = mxs_dma_enable_chan;
 854
 855         ret = dma_async_device_register(&mxs_dma->dma_device);
 856         if (ret) {
 857                 dev_err(mxs_dma->dma_device.dev, "unable to register\n");
 858                 return ret;
 859         }
 860
 861         ret = of_dma_controller_register(np, mxs_dma_xlate, mxs_dma);
 862         if (ret) {
 863                 dev_err(mxs_dma->dma_device.dev,
 864                         "failed to register controller\n");
 865                 dma_async_device_unregister(&mxs_dma->dma_device);
 866         }
 867
 868         dev_info(mxs_dma->dma_device.dev, "initialized\n");
 869
 870         return 0;
 871 }
 872
 873 static struct platform_driver mxs_dma_driver = {
 874         .driver         = {
 875                 .name   = "mxs-dma",
 876                 .of_match_table = mxs_dma_dt_ids,
 877         },
 878         .id_table       = mxs_dma_ids,
 879 };
 880
 881 static int __init mxs_dma_module_init(void)
 882 {
 883         return platform_driver_probe(&mxs_dma_driver, mxs_dma_probe);
 884 }
 885 subsys_initcall(mxs_dma_module_init);