drivers/dma/bcm2835-dma.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * BCM2835 DMA engine support
   4  *
   5  * Author:      Florian Meier <florian.meier@koalo.de>
   6  *              Copyright 2013
   7  *
   8  * Based on
   9  *      OMAP DMAengine support by Russell King
  10  *
  11  *      BCM2708 DMA Driver
  12  *      Copyright (C) 2010 Broadcom
  13  *
  14  *      Raspberry Pi PCM I2S ALSA Driver
  15  *      Copyright (c) by Phil Poole 2013
  16  *
  17  *      MARVELL MMP Peripheral DMA Driver
  18  *      Copyright 2012 Marvell International Ltd.
  19  */
  20 #include <linux/dmaengine.h>
  21 #include <linux/dma-mapping.h>
  22 #include <linux/dmapool.h>
  23 #include <linux/err.h>
  24 #include <linux/init.h>
  25 #include <linux/interrupt.h>
  26 #include <linux/list.h>
  27 #include <linux/module.h>
  28 #include <linux/platform_device.h>
  29 #include <linux/slab.h>
  30 #include <linux/io.h>
  31 #include <linux/spinlock.h>
  32 #include <linux/of.h>
  33 #include <linux/of_dma.h>
  34
  35 #include "virt-dma.h"
  36
  37 #define BCM2835_DMA_MAX_DMA_CHAN_SUPPORTED 14
  38 #define BCM2835_DMA_CHAN_NAME_SIZE 8
  39
  40 /**
  41  * struct bcm2835_dmadev - BCM2835 DMA controller
  42  * @ddev: DMA device
  43  * @base: base address of register map
  44  * @dma_parms: DMA parameters (to convey 1 GByte max segment size to clients)
  45  */
  46 struct bcm2835_dmadev {
  47         struct dma_device ddev;
  48         void __iomem *base;
  49         struct device_dma_parameters dma_parms;
  50 };
  51
  52 struct bcm2835_dma_cb {
  53         uint32_t info;
  54         uint32_t src;
  55         uint32_t dst;
  56         uint32_t length;
  57         uint32_t stride;
  58         uint32_t next;
  59         uint32_t pad[2];
  60 };
  61
  62 struct bcm2835_cb_entry {
  63         struct bcm2835_dma_cb *cb;
  64         dma_addr_t paddr;
  65 };
  66
  67 struct bcm2835_chan {
  68         struct virt_dma_chan vc;
  69
  70         struct dma_slave_config cfg;
  71         unsigned int dreq;
  72
  73         int ch;
  74         struct bcm2835_desc *desc;
  75         struct dma_pool *cb_pool;
  76
  77         void __iomem *chan_base;
  78         int irq_number;
  79         unsigned int irq_flags;
  80
  81         bool is_lite_channel;
  82 };
  83
  84 struct bcm2835_desc {
  85         struct bcm2835_chan *c;
  86         struct virt_dma_desc vd;
  87         enum dma_transfer_direction dir;
  88
  89         unsigned int frames;
  90         size_t size;
  91
  92         bool cyclic;
  93
  94         struct bcm2835_cb_entry cb_list[];
  95 };
  96
  97 #define BCM2835_DMA_CS          0x00
  98 #define BCM2835_DMA_ADDR        0x04
  99 #define BCM2835_DMA_TI          0x08
 100 #define BCM2835_DMA_SOURCE_AD   0x0c
 101 #define BCM2835_DMA_DEST_AD     0x10
 102 #define BCM2835_DMA_LEN         0x14
 103 #define BCM2835_DMA_STRIDE      0x18
 104 #define BCM2835_DMA_NEXTCB      0x1c
 105 #define BCM2835_DMA_DEBUG       0x20
 106
 107 /* DMA CS Control and Status bits */
 108 #define BCM2835_DMA_ACTIVE      BIT(0)  /* activate the DMA */
 109 #define BCM2835_DMA_END         BIT(1)  /* current CB has ended */
 110 #define BCM2835_DMA_INT         BIT(2)  /* interrupt status */
 111 #define BCM2835_DMA_DREQ        BIT(3)  /* DREQ state */
 112 #define BCM2835_DMA_ISPAUSED    BIT(4)  /* Pause requested or not active */
 113 #define BCM2835_DMA_ISHELD      BIT(5)  /* Is held by DREQ flow control */
 114 #define BCM2835_DMA_WAITING_FOR_WRITES BIT(6) /* waiting for last
 115                                                * AXI-write to ack
 116                                                */
 117 #define BCM2835_DMA_ERR         BIT(8)
 118 #define BCM2835_DMA_PRIORITY(x) ((x & 15) << 16) /* AXI priority */
 119 #define BCM2835_DMA_PANIC_PRIORITY(x) ((x & 15) << 20) /* panic priority */
 120 /* current value of TI.BCM2835_DMA_WAIT_RESP */
 121 #define BCM2835_DMA_WAIT_FOR_WRITES BIT(28)
 122 #define BCM2835_DMA_DIS_DEBUG   BIT(29) /* disable debug pause signal */
 123 #define BCM2835_DMA_ABORT       BIT(30) /* Stop current CB, go to next, WO */
 124 #define BCM2835_DMA_RESET       BIT(31) /* WO, self clearing */
 125
 126 /* Transfer information bits - also bcm2835_cb.info field */
 127 #define BCM2835_DMA_INT_EN      BIT(0)
 128 #define BCM2835_DMA_TDMODE      BIT(1) /* 2D-Mode */
 129 #define BCM2835_DMA_WAIT_RESP   BIT(3) /* wait for AXI-write to be acked */
 130 #define BCM2835_DMA_D_INC       BIT(4)
 131 #define BCM2835_DMA_D_WIDTH     BIT(5) /* 128bit writes if set */
 132 #define BCM2835_DMA_D_DREQ      BIT(6) /* enable DREQ for destination */
 133 #define BCM2835_DMA_D_IGNORE    BIT(7) /* ignore destination writes */
 134 #define BCM2835_DMA_S_INC       BIT(8)
 135 #define BCM2835_DMA_S_WIDTH     BIT(9) /* 128bit writes if set */
 136 #define BCM2835_DMA_S_DREQ      BIT(10) /* enable SREQ for source */
 137 #define BCM2835_DMA_S_IGNORE    BIT(11) /* ignore source reads - read 0 */
 138 #define BCM2835_DMA_BURST_LENGTH(x) ((x & 15) << 12)
 139 #define BCM2835_DMA_PER_MAP(x)  ((x & 31) << 16) /* REQ source */
 140 #define BCM2835_DMA_WAIT(x)     ((x & 31) << 21) /* add DMA-wait cycles */
 141 #define BCM2835_DMA_NO_WIDE_BURSTS BIT(26) /* no 2 beat write bursts */
 142
 143 /* debug register bits */
 144 #define BCM2835_DMA_DEBUG_LAST_NOT_SET_ERR      BIT(0)
 145 #define BCM2835_DMA_DEBUG_FIFO_ERR              BIT(1)
 146 #define BCM2835_DMA_DEBUG_READ_ERR              BIT(2)
 147 #define BCM2835_DMA_DEBUG_OUTSTANDING_WRITES_SHIFT 4
 148 #define BCM2835_DMA_DEBUG_OUTSTANDING_WRITES_BITS 4
 149 #define BCM2835_DMA_DEBUG_ID_SHIFT              16
 150 #define BCM2835_DMA_DEBUG_ID_BITS               9
 151 #define BCM2835_DMA_DEBUG_STATE_SHIFT           16
 152 #define BCM2835_DMA_DEBUG_STATE_BITS            9
 153 #define BCM2835_DMA_DEBUG_VERSION_SHIFT         25
 154 #define BCM2835_DMA_DEBUG_VERSION_BITS          3
 155 #define BCM2835_DMA_DEBUG_LITE                  BIT(28)
 156
 157 /* shared registers for all dma channels */
 158 #define BCM2835_DMA_INT_STATUS         0xfe0
 159 #define BCM2835_DMA_ENABLE             0xff0
 160
 161 #define BCM2835_DMA_DATA_TYPE_S8        1
 162 #define BCM2835_DMA_DATA_TYPE_S16       2
 163 #define BCM2835_DMA_DATA_TYPE_S32       4
 164 #define BCM2835_DMA_DATA_TYPE_S128      16
 165
 166 /* Valid only for channels 0 - 14, 15 has its own base address */
 167 #define BCM2835_DMA_CHAN(n)     ((n) << 8) /* Base address */
 168 #define BCM2835_DMA_CHANIO(base, n) ((base) + BCM2835_DMA_CHAN(n))
 169
 170 /* the max dma length for different channels */
 171 #define MAX_DMA_LEN SZ_1G
 172 #define MAX_LITE_DMA_LEN (SZ_64K - 4)
 173
 174 static inline size_t bcm2835_dma_max_frame_length(struct bcm2835_chan *c)
 175 {
 176         /* lite and normal channels have different max frame length */
 177         return c->is_lite_channel ? MAX_LITE_DMA_LEN : MAX_DMA_LEN;
 178 }
 179
 180 /* how many frames of max_len size do we need to transfer len bytes */
 181 static inline size_t bcm2835_dma_frames_for_length(size_t len,
 182                                                    size_t max_len)
 183 {
 184         return DIV_ROUND_UP(len, max_len);
 185 }
 186
 187 static inline struct bcm2835_dmadev *to_bcm2835_dma_dev(struct dma_device *d)
 188 {
 189         return container_of(d, struct bcm2835_dmadev, ddev);
 190 }
 191
 192 static inline struct bcm2835_chan *to_bcm2835_dma_chan(struct dma_chan *c)
 193 {
 194         return container_of(c, struct bcm2835_chan, vc.chan);
 195 }
 196
 197 static inline struct bcm2835_desc *to_bcm2835_dma_desc(
 198                 struct dma_async_tx_descriptor *t)
 199 {
 200         return container_of(t, struct bcm2835_desc, vd.tx);
 201 }
 202
 203 static void bcm2835_dma_free_cb_chain(struct bcm2835_desc *desc)
 204 {
 205         size_t i;
 206
 207         for (i = 0; i < desc->frames; i++)
 208                 dma_pool_free(desc->c->cb_pool, desc->cb_list[i].cb,
 209                               desc->cb_list[i].paddr);
 210
 211         kfree(desc);
 212 }
 213
 214 static void bcm2835_dma_desc_free(struct virt_dma_desc *vd)
 215 {
 216         bcm2835_dma_free_cb_chain(
 217                 container_of(vd, struct bcm2835_desc, vd));
 218 }
 219
 220 static void bcm2835_dma_create_cb_set_length(
 221         struct bcm2835_chan *chan,
 222         struct bcm2835_dma_cb *control_block,
 223         size_t len,
 224         size_t period_len,
 225         size_t *total_len,
 226         u32 finalextrainfo)
 227 {
 228         size_t max_len = bcm2835_dma_max_frame_length(chan);
 229
 230         /* set the length taking lite-channel limitations into account */
 231         control_block->length = min_t(u32, len, max_len);
 232
 233         /* finished if we have no period_length */
 234         if (!period_len)
 235                 return;
 236
 237         /*
 238          * period_len means: that we need to generate
 239          * transfers that are terminating at every
 240          * multiple of period_len - this is typically
 241          * used to set the interrupt flag in info
 242          * which is required during cyclic transfers
 243          */
 244
 245         /* have we filled in period_length yet? */
 246         if (*total_len + control_block->length < period_len) {
 247                 /* update number of bytes in this period so far */
 248                 *total_len += control_block->length;
 249                 return;
 250         }
 251
 252         /* calculate the length that remains to reach period_length */
 253         control_block->length = period_len - *total_len;
 254
 255         /* reset total_length for next period */
 256         *total_len = 0;
 257
 258         /* add extrainfo bits in info */
 259         control_block->info |= finalextrainfo;
 260 }
 261
 262 static inline size_t bcm2835_dma_count_frames_for_sg(
 263         struct bcm2835_chan *c,
 264         struct scatterlist *sgl,
 265         unsigned int sg_len)
 266 {
 267         size_t frames = 0;
 268         struct scatterlist *sgent;
 269         unsigned int i;
 270         size_t plength = bcm2835_dma_max_frame_length(c);
 271
 272         for_each_sg(sgl, sgent, sg_len, i)
 273                 frames += bcm2835_dma_frames_for_length(
 274                         sg_dma_len(sgent), plength);
 275
 276         return frames;
 277 }
 278
 279 /**
 280  * bcm2835_dma_create_cb_chain - create a control block and fills data in
 281  *
 282  * @chan:           the @dma_chan for which we run this
 283  * @direction:      the direction in which we transfer
 284  * @cyclic:         it is a cyclic transfer
 285  * @info:           the default info bits to apply per controlblock
 286  * @frames:         number of controlblocks to allocate
 287  * @src:            the src address to assign (if the S_INC bit is set
 288  *                  in @info, then it gets incremented)
 289  * @dst:            the dst address to assign (if the D_INC bit is set
 290  *                  in @info, then it gets incremented)
 291  * @buf_len:        the full buffer length (may also be 0)
 292  * @period_len:     the period length when to apply @finalextrainfo
 293  *                  in addition to the last transfer
 294  *                  this will also break some control-blocks early
 295  * @finalextrainfo: additional bits in last controlblock
 296  *                  (or when period_len is reached in case of cyclic)
 297  * @gfp:            the GFP flag to use for allocation
 298  */
 299 static struct bcm2835_desc *bcm2835_dma_create_cb_chain(
 300         struct dma_chan *chan, enum dma_transfer_direction direction,
 301         bool cyclic, u32 info, u32 finalextrainfo, size_t frames,
 302         dma_addr_t src, dma_addr_t dst, size_t buf_len,
 303         size_t period_len, gfp_t gfp)
 304 {
 305         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 306         size_t len = buf_len, total_len;
 307         size_t frame;
 308         struct bcm2835_desc *d;
 309         struct bcm2835_cb_entry *cb_entry;
 310         struct bcm2835_dma_cb *control_block;
 311
 312         if (!frames)
 313                 return NULL;
 314
 315         /* allocate and setup the descriptor. */
 316         d = kzalloc(struct_size(d, cb_list, frames), gfp);
 317         if (!d)
 318                 return NULL;
 319
 320         d->c = c;
 321         d->dir = direction;
 322         d->cyclic = cyclic;
 323
 324         /*
 325          * Iterate over all frames, create a control block
 326          * for each frame and link them together.
 327          */
 328         for (frame = 0, total_len = 0; frame < frames; d->frames++, frame++) {
 329                 cb_entry = &d->cb_list[frame];
 330                 cb_entry->cb = dma_pool_alloc(c->cb_pool, gfp,
 331                                               &cb_entry->paddr);
 332                 if (!cb_entry->cb)
 333                         goto error_cb;
 334
 335                 /* fill in the control block */
 336                 control_block = cb_entry->cb;
 337                 control_block->info = info;
 338                 control_block->src = src;
 339                 control_block->dst = dst;
 340                 control_block->stride = 0;
 341                 control_block->next = 0;
 342                 /* set up length in control_block if requested */
 343                 if (buf_len) {
 344                         /* calculate length honoring period_length */
 345                         bcm2835_dma_create_cb_set_length(
 346                                 c, control_block,
 347                                 len, period_len, &total_len,
 348                                 cyclic ? finalextrainfo : 0);
 349
 350                         /* calculate new remaining length */
 351                         len -= control_block->length;
 352                 }
 353
 354                 /* link this the last controlblock */
 355                 if (frame)
 356                         d->cb_list[frame - 1].cb->next = cb_entry->paddr;
 357
 358                 /* update src and dst and length */
 359                 if (src && (info & BCM2835_DMA_S_INC))
 360                         src += control_block->length;
 361                 if (dst && (info & BCM2835_DMA_D_INC))
 362                         dst += control_block->length;
 363
 364                 /* Length of total transfer */
 365                 d->size += control_block->length;
 366         }
 367
 368         /* the last frame requires extra flags */
 369         d->cb_list[d->frames - 1].cb->info |= finalextrainfo;
 370
 371         /* detect a size missmatch */
 372         if (buf_len && (d->size != buf_len))
 373                 goto error_cb;
 374
 375         return d;
 376 error_cb:
 377         bcm2835_dma_free_cb_chain(d);
 378
 379         return NULL;
 380 }
 381
 382 static void bcm2835_dma_fill_cb_chain_with_sg(
 383         struct dma_chan *chan,
 384         enum dma_transfer_direction direction,
 385         struct bcm2835_cb_entry *cb,
 386         struct scatterlist *sgl,
 387         unsigned int sg_len)
 388 {
 389         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 390         size_t len, max_len;
 391         unsigned int i;
 392         dma_addr_t addr;
 393         struct scatterlist *sgent;
 394
 395         max_len = bcm2835_dma_max_frame_length(c);
 396         for_each_sg(sgl, sgent, sg_len, i) {
 397                 for (addr = sg_dma_address(sgent), len = sg_dma_len(sgent);
 398                      len > 0;
 399                      addr += cb->cb->length, len -= cb->cb->length, cb++) {
 400                         if (direction == DMA_DEV_TO_MEM)
 401                                 cb->cb->dst = addr;
 402                         else
 403                                 cb->cb->src = addr;
 404                         cb->cb->length = min(len, max_len);
 405                 }
 406         }
 407 }
 408
 409 static void bcm2835_dma_abort(struct bcm2835_chan *c)
 410 {
 411         void __iomem *chan_base = c->chan_base;
 412         long int timeout = 10000;
 413
 414         /*
 415          * A zero control block address means the channel is idle.
 416          * (The ACTIVE flag in the CS register is not a reliable indicator.)
 417          */
 418         if (!readl(chan_base + BCM2835_DMA_ADDR))
 419                 return;
 420
 421         /* Write 0 to the active bit - Pause the DMA */
 422         writel(0, chan_base + BCM2835_DMA_CS);
 423
 424         /* Wait for any current AXI transfer to complete */
 425         while ((readl(chan_base + BCM2835_DMA_CS) &
 426                 BCM2835_DMA_WAITING_FOR_WRITES) && --timeout)
 427                 cpu_relax();
 428
 429         /* Peripheral might be stuck and fail to signal AXI write responses */
 430         if (!timeout)
 431                 dev_err(c->vc.chan.device->dev,
 432                         "failed to complete outstanding writes\n");
 433
 434         writel(BCM2835_DMA_RESET, chan_base + BCM2835_DMA_CS);
 435 }
 436
 437 static void bcm2835_dma_start_desc(struct bcm2835_chan *c)
 438 {
 439         struct virt_dma_desc *vd = vchan_next_desc(&c->vc);
 440         struct bcm2835_desc *d;
 441
 442         if (!vd) {
 443                 c->desc = NULL;
 444                 return;
 445         }
 446
 447         list_del(&vd->node);
 448
 449         c->desc = d = to_bcm2835_dma_desc(&vd->tx);
 450
 451         writel(d->cb_list[0].paddr, c->chan_base + BCM2835_DMA_ADDR);
 452         writel(BCM2835_DMA_ACTIVE, c->chan_base + BCM2835_DMA_CS);
 453 }
 454
 455 static irqreturn_t bcm2835_dma_callback(int irq, void *data)
 456 {
 457         struct bcm2835_chan *c = data;
 458         struct bcm2835_desc *d;
 459         unsigned long flags;
 460
 461         /* check the shared interrupt */
 462         if (c->irq_flags & IRQF_SHARED) {
 463                 /* check if the interrupt is enabled */
 464                 flags = readl(c->chan_base + BCM2835_DMA_CS);
 465                 /* if not set then we are not the reason for the irq */
 466                 if (!(flags & BCM2835_DMA_INT))
 467                         return IRQ_NONE;
 468         }
 469
 470         spin_lock_irqsave(&c->vc.lock, flags);
 471
 472         /*
 473          * Clear the INT flag to receive further interrupts. Keep the channel
 474          * active in case the descriptor is cyclic or in case the client has
 475          * already terminated the descriptor and issued a new one. (May happen
 476          * if this IRQ handler is threaded.) If the channel is finished, it
 477          * will remain idle despite the ACTIVE flag being set.
 478          */
 479         writel(BCM2835_DMA_INT | BCM2835_DMA_ACTIVE,
 480                c->chan_base + BCM2835_DMA_CS);
 481
 482         d = c->desc;
 483
 484         if (d) {
 485                 if (d->cyclic) {
 486                         /* call the cyclic callback */
 487                         vchan_cyclic_callback(&d->vd);
 488                 } else if (!readl(c->chan_base + BCM2835_DMA_ADDR)) {
 489                         vchan_cookie_complete(&c->desc->vd);
 490                         bcm2835_dma_start_desc(c);
 491                 }
 492         }
 493
 494         spin_unlock_irqrestore(&c->vc.lock, flags);
 495
 496         return IRQ_HANDLED;
 497 }
 498
 499 static int bcm2835_dma_alloc_chan_resources(struct dma_chan *chan)
 500 {
 501         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 502         struct device *dev = c->vc.chan.device->dev;
 503
 504         dev_dbg(dev, "Allocating DMA channel %d\n", c->ch);
 505
 506         /*
 507          * Control blocks are 256 bit in length and must start at a 256 bit
 508          * (32 byte) aligned address (BCM2835 ARM Peripherals, sec. 4.2.1.1).
 509          */
 510         c->cb_pool = dma_pool_create(dev_name(dev), dev,
 511                                      sizeof(struct bcm2835_dma_cb), 32, 0);
 512         if (!c->cb_pool) {
 513                 dev_err(dev, "unable to allocate descriptor pool\n");
 514                 return -ENOMEM;
 515         }
 516
 517         return request_irq(c->irq_number, bcm2835_dma_callback,
 518                            c->irq_flags, "DMA IRQ", c);
 519 }
 520
 521 static void bcm2835_dma_free_chan_resources(struct dma_chan *chan)
 522 {
 523         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 524
 525         vchan_free_chan_resources(&c->vc);
 526         free_irq(c->irq_number, c);
 527         dma_pool_destroy(c->cb_pool);
 528
 529         dev_dbg(c->vc.chan.device->dev, "Freeing DMA channel %u\n", c->ch);
 530 }
 531
 532 static size_t bcm2835_dma_desc_size(struct bcm2835_desc *d)
 533 {
 534         return d->size;
 535 }
 536
 537 static size_t bcm2835_dma_desc_size_pos(struct bcm2835_desc *d, dma_addr_t addr)
 538 {
 539         unsigned int i;
 540         size_t size;
 541
 542         for (size = i = 0; i < d->frames; i++) {
 543                 struct bcm2835_dma_cb *control_block = d->cb_list[i].cb;
 544                 size_t this_size = control_block->length;
 545                 dma_addr_t dma;
 546
 547                 if (d->dir == DMA_DEV_TO_MEM)
 548                         dma = control_block->dst;
 549                 else
 550                         dma = control_block->src;
 551
 552                 if (size)
 553                         size += this_size;
 554                 else if (addr >= dma && addr < dma + this_size)
 555                         size += dma + this_size - addr;
 556         }
 557
 558         return size;
 559 }
 560
 561 static enum dma_status bcm2835_dma_tx_status(struct dma_chan *chan,
 562         dma_cookie_t cookie, struct dma_tx_state *txstate)
 563 {
 564         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 565         struct virt_dma_desc *vd;
 566         enum dma_status ret;
 567         unsigned long flags;
 568
 569         ret = dma_cookie_status(chan, cookie, txstate);
 570         if (ret == DMA_COMPLETE || !txstate)
 571                 return ret;
 572
 573         spin_lock_irqsave(&c->vc.lock, flags);
 574         vd = vchan_find_desc(&c->vc, cookie);
 575         if (vd) {
 576                 txstate->residue =
 577                         bcm2835_dma_desc_size(to_bcm2835_dma_desc(&vd->tx));
 578         } else if (c->desc && c->desc->vd.tx.cookie == cookie) {
 579                 struct bcm2835_desc *d = c->desc;
 580                 dma_addr_t pos;
 581
 582                 if (d->dir == DMA_MEM_TO_DEV)
 583                         pos = readl(c->chan_base + BCM2835_DMA_SOURCE_AD);
 584                 else if (d->dir == DMA_DEV_TO_MEM)
 585                         pos = readl(c->chan_base + BCM2835_DMA_DEST_AD);
 586                 else
 587                         pos = 0;
 588
 589                 txstate->residue = bcm2835_dma_desc_size_pos(d, pos);
 590         } else {
 591                 txstate->residue = 0;
 592         }
 593
 594         spin_unlock_irqrestore(&c->vc.lock, flags);
 595
 596         return ret;
 597 }
 598
 599 static void bcm2835_dma_issue_pending(struct dma_chan *chan)
 600 {
 601         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 602         unsigned long flags;
 603
 604         spin_lock_irqsave(&c->vc.lock, flags);
 605         if (vchan_issue_pending(&c->vc) && !c->desc)
 606                 bcm2835_dma_start_desc(c);
 607
 608         spin_unlock_irqrestore(&c->vc.lock, flags);
 609 }
 610
 611 static struct dma_async_tx_descriptor *bcm2835_dma_prep_dma_memcpy(
 612         struct dma_chan *chan, dma_addr_t dst, dma_addr_t src,
 613         size_t len, unsigned long flags)
 614 {
 615         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 616         struct bcm2835_desc *d;
 617         u32 info = BCM2835_DMA_D_INC | BCM2835_DMA_S_INC;
 618         u32 extra = BCM2835_DMA_INT_EN | BCM2835_DMA_WAIT_RESP;
 619         size_t max_len = bcm2835_dma_max_frame_length(c);
 620         size_t frames;
 621
 622         /* if src, dst or len is not given return with an error */
 623         if (!src || !dst || !len)
 624                 return NULL;
 625
 626         /* calculate number of frames */
 627         frames = bcm2835_dma_frames_for_length(len, max_len);
 628
 629         /* allocate the CB chain - this also fills in the pointers */
 630         d = bcm2835_dma_create_cb_chain(chan, DMA_MEM_TO_MEM, false,
 631                                         info, extra, frames,
 632                                         src, dst, len, 0, GFP_KERNEL);
 633         if (!d)
 634                 return NULL;
 635
 636         return vchan_tx_prep(&c->vc, &d->vd, flags);
 637 }
 638
 639 static struct dma_async_tx_descriptor *bcm2835_dma_prep_slave_sg(
 640         struct dma_chan *chan,
 641         struct scatterlist *sgl, unsigned int sg_len,
 642         enum dma_transfer_direction direction,
 643         unsigned long flags, void *context)
 644 {
 645         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 646         struct bcm2835_desc *d;
 647         dma_addr_t src = 0, dst = 0;
 648         u32 info = BCM2835_DMA_WAIT_RESP;
 649         u32 extra = BCM2835_DMA_INT_EN;
 650         size_t frames;
 651
 652         if (!is_slave_direction(direction)) {
 653                 dev_err(chan->device->dev,
 654                         "%s: bad direction?\n", __func__);
 655                 return NULL;
 656         }
 657
 658         if (c->dreq != 0)
 659                 info |= BCM2835_DMA_PER_MAP(c->dreq);
 660
 661         if (direction == DMA_DEV_TO_MEM) {
 662                 if (c->cfg.src_addr_width != DMA_SLAVE_BUSWIDTH_4_BYTES)
 663                         return NULL;
 664                 src = c->cfg.src_addr;
 665                 info |= BCM2835_DMA_S_DREQ | BCM2835_DMA_D_INC;
 666         } else {
 667                 if (c->cfg.dst_addr_width != DMA_SLAVE_BUSWIDTH_4_BYTES)
 668                         return NULL;
 669                 dst = c->cfg.dst_addr;
 670                 info |= BCM2835_DMA_D_DREQ | BCM2835_DMA_S_INC;
 671         }
 672
 673         /* count frames in sg list */
 674         frames = bcm2835_dma_count_frames_for_sg(c, sgl, sg_len);
 675
 676         /* allocate the CB chain */
 677         d = bcm2835_dma_create_cb_chain(chan, direction, false,
 678                                         info, extra,
 679                                         frames, src, dst, 0, 0,
 680                                         GFP_NOWAIT);
 681         if (!d)
 682                 return NULL;
 683
 684         /* fill in frames with scatterlist pointers */
 685         bcm2835_dma_fill_cb_chain_with_sg(chan, direction, d->cb_list,
 686                                           sgl, sg_len);
 687
 688         return vchan_tx_prep(&c->vc, &d->vd, flags);
 689 }
 690
 691 static struct dma_async_tx_descriptor *bcm2835_dma_prep_dma_cyclic(
 692         struct dma_chan *chan, dma_addr_t buf_addr, size_t buf_len,
 693         size_t period_len, enum dma_transfer_direction direction,
 694         unsigned long flags)
 695 {
 696         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 697         struct bcm2835_desc *d;
 698         dma_addr_t src, dst;
 699         u32 info = BCM2835_DMA_WAIT_RESP;
 700         u32 extra = 0;
 701         size_t max_len = bcm2835_dma_max_frame_length(c);
 702         size_t frames;
 703
 704         /* Grab configuration */
 705         if (!is_slave_direction(direction)) {
 706                 dev_err(chan->device->dev, "%s: bad direction?\n", __func__);
 707                 return NULL;
 708         }
 709
 710         if (!buf_len) {
 711                 dev_err(chan->device->dev,
 712                         "%s: bad buffer length (= 0)\n", __func__);
 713                 return NULL;
 714         }
 715
 716         if (flags & DMA_PREP_INTERRUPT)
 717                 extra |= BCM2835_DMA_INT_EN;
 718         else
 719                 period_len = buf_len;
 720
 721         /*
 722          * warn if buf_len is not a multiple of period_len - this may leed
 723          * to unexpected latencies for interrupts and thus audiable clicks
 724          */
 725         if (buf_len % period_len)
 726                 dev_warn_once(chan->device->dev,
 727                               "%s: buffer_length (%zd) is not a multiple of period_len (%zd)\n",
 728                               __func__, buf_len, period_len);
 729
 730         /* Setup DREQ channel */
 731         if (c->dreq != 0)
 732                 info |= BCM2835_DMA_PER_MAP(c->dreq);
 733
 734         if (direction == DMA_DEV_TO_MEM) {
 735                 if (c->cfg.src_addr_width != DMA_SLAVE_BUSWIDTH_4_BYTES)
 736                         return NULL;
 737                 src = c->cfg.src_addr;
 738                 dst = buf_addr;
 739                 info |= BCM2835_DMA_S_DREQ | BCM2835_DMA_D_INC;
 740         } else {
 741                 if (c->cfg.dst_addr_width != DMA_SLAVE_BUSWIDTH_4_BYTES)
 742                         return NULL;
 743                 dst = c->cfg.dst_addr;
 744                 src = buf_addr;
 745                 info |= BCM2835_DMA_D_DREQ | BCM2835_DMA_S_INC;
 746         }
 747
 748         /* calculate number of frames */
 749         frames = /* number of periods */
 750                  DIV_ROUND_UP(buf_len, period_len) *
 751                  /* number of frames per period */
 752                  bcm2835_dma_frames_for_length(period_len, max_len);
 753
 754         /*
 755          * allocate the CB chain
 756          * note that we need to use GFP_NOWAIT, as the ALSA i2s dmaengine
 757          * implementation calls prep_dma_cyclic with interrupts disabled.
 758          */
 759         d = bcm2835_dma_create_cb_chain(chan, direction, true,
 760                                         info, extra,
 761                                         frames, src, dst, buf_len,
 762                                         period_len, GFP_NOWAIT);
 763         if (!d)
 764                 return NULL;
 765
 766         /* wrap around into a loop */
 767         d->cb_list[d->frames - 1].cb->next = d->cb_list[0].paddr;
 768
 769         return vchan_tx_prep(&c->vc, &d->vd, flags);
 770 }
 771
 772 static int bcm2835_dma_slave_config(struct dma_chan *chan,
 773                                     struct dma_slave_config *cfg)
 774 {
 775         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 776
 777         c->cfg = *cfg;
 778
 779         return 0;
 780 }
 781
 782 static int bcm2835_dma_terminate_all(struct dma_chan *chan)
 783 {
 784         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 785         unsigned long flags;
 786         LIST_HEAD(head);
 787
 788         spin_lock_irqsave(&c->vc.lock, flags);
 789
 790         /* stop DMA activity */
 791         if (c->desc) {
 792                 if (c->desc->vd.tx.flags & DMA_PREP_INTERRUPT)
 793                         vchan_terminate_vdesc(&c->desc->vd);
 794                 else
 795                         vchan_vdesc_fini(&c->desc->vd);
 796                 c->desc = NULL;
 797                 bcm2835_dma_abort(c);
 798         }
 799
 800         vchan_get_all_descriptors(&c->vc, &head);
 801         spin_unlock_irqrestore(&c->vc.lock, flags);
 802         vchan_dma_desc_free_list(&c->vc, &head);
 803
 804         return 0;
 805 }
 806
 807 static void bcm2835_dma_synchronize(struct dma_chan *chan)
 808 {
 809         struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 810
 811         vchan_synchronize(&c->vc);
 812 }
 813
 814 static int bcm2835_dma_chan_init(struct bcm2835_dmadev *d, int chan_id,
 815                                  int irq, unsigned int irq_flags)
 816 {
 817         struct bcm2835_chan *c;
 818
 819         c = devm_kzalloc(d->ddev.dev, sizeof(*c), GFP_KERNEL);
 820         if (!c)
 821                 return -ENOMEM;
 822
 823         c->vc.desc_free = bcm2835_dma_desc_free;
 824         vchan_init(&c->vc, &d->ddev);
 825
 826         c->chan_base = BCM2835_DMA_CHANIO(d->base, chan_id);
 827         c->ch = chan_id;
 828         c->irq_number = irq;
 829         c->irq_flags = irq_flags;
 830
 831         /* check in DEBUG register if this is a LITE channel */
 832         if (readl(c->chan_base + BCM2835_DMA_DEBUG) &
 833                 BCM2835_DMA_DEBUG_LITE)
 834                 c->is_lite_channel = true;
 835
 836         return 0;
 837 }
 838
 839 static void bcm2835_dma_free(struct bcm2835_dmadev *od)
 840 {
 841         struct bcm2835_chan *c, *next;
 842
 843         list_for_each_entry_safe(c, next, &od->ddev.channels,
 844                                  vc.chan.device_node) {
 845                 list_del(&c->vc.chan.device_node);
 846                 tasklet_kill(&c->vc.task);
 847         }
 848 }
 849
 850 static const struct of_device_id bcm2835_dma_of_match[] = {
 851         { .compatible = "brcm,bcm2835-dma", },
 852         {},
 853 };
 854 MODULE_DEVICE_TABLE(of, bcm2835_dma_of_match);
 855
 856 static struct dma_chan *bcm2835_dma_xlate(struct of_phandle_args *spec,
 857                                            struct of_dma *ofdma)
 858 {
 859         struct bcm2835_dmadev *d = ofdma->of_dma_data;
 860         struct dma_chan *chan;
 861
 862         chan = dma_get_any_slave_channel(&d->ddev);
 863         if (!chan)
 864                 return NULL;
 865
 866         /* Set DREQ from param */
 867         to_bcm2835_dma_chan(chan)->dreq = spec->args[0];
 868
 869         return chan;
 870 }
 871
 872 static int bcm2835_dma_probe(struct platform_device *pdev)
 873 {
 874         struct bcm2835_dmadev *od;
 875         struct resource *res;
 876         void __iomem *base;
 877         int rc;
 878         int i, j;
 879         int irq[BCM2835_DMA_MAX_DMA_CHAN_SUPPORTED + 1];
 880         int irq_flags;
 881         uint32_t chans_available;
 882         char chan_name[BCM2835_DMA_CHAN_NAME_SIZE];
 883
 884         if (!pdev->dev.dma_mask)
 885                 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
 886
 887         rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
 888         if (rc)
 889                 return rc;
 890
 891         od = devm_kzalloc(&pdev->dev, sizeof(*od), GFP_KERNEL);
 892         if (!od)
 893                 return -ENOMEM;
 894
 895         pdev->dev.dma_parms = &od->dma_parms;
 896         dma_set_max_seg_size(&pdev->dev, 0x3FFFFFFF);
 897
 898         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 899         base = devm_ioremap_resource(&pdev->dev, res);
 900         if (IS_ERR(base))
 901                 return PTR_ERR(base);
 902
 903         od->base = base;
 904
 905         dma_cap_set(DMA_SLAVE, od->ddev.cap_mask);
 906         dma_cap_set(DMA_PRIVATE, od->ddev.cap_mask);
 907         dma_cap_set(DMA_CYCLIC, od->ddev.cap_mask);
 908         dma_cap_set(DMA_MEMCPY, od->ddev.cap_mask);
 909         od->ddev.device_alloc_chan_resources = bcm2835_dma_alloc_chan_resources;
 910         od->ddev.device_free_chan_resources = bcm2835_dma_free_chan_resources;
 911         od->ddev.device_tx_status = bcm2835_dma_tx_status;
 912         od->ddev.device_issue_pending = bcm2835_dma_issue_pending;
 913         od->ddev.device_prep_dma_cyclic = bcm2835_dma_prep_dma_cyclic;
 914         od->ddev.device_prep_slave_sg = bcm2835_dma_prep_slave_sg;
 915         od->ddev.device_prep_dma_memcpy = bcm2835_dma_prep_dma_memcpy;
 916         od->ddev.device_config = bcm2835_dma_slave_config;
 917         od->ddev.device_terminate_all = bcm2835_dma_terminate_all;
 918         od->ddev.device_synchronize = bcm2835_dma_synchronize;
 919         od->ddev.src_addr_widths = BIT(DMA_SLAVE_BUSWIDTH_4_BYTES);
 920         od->ddev.dst_addr_widths = BIT(DMA_SLAVE_BUSWIDTH_4_BYTES);
 921         od->ddev.directions = BIT(DMA_DEV_TO_MEM) | BIT(DMA_MEM_TO_DEV) |
 922                               BIT(DMA_MEM_TO_MEM);
 923         od->ddev.residue_granularity = DMA_RESIDUE_GRANULARITY_BURST;
 924         od->ddev.descriptor_reuse = true;
 925         od->ddev.dev = &pdev->dev;
 926         INIT_LIST_HEAD(&od->ddev.channels);
 927
 928         platform_set_drvdata(pdev, od);
 929
 930         /* Request DMA channel mask from device tree */
 931         if (of_property_read_u32(pdev->dev.of_node,
 932                         "brcm,dma-channel-mask",
 933                         &chans_available)) {
 934                 dev_err(&pdev->dev, "Failed to get channel mask\n");
 935                 rc = -EINVAL;
 936                 goto err_no_dma;
 937         }
 938
 939         /* get irqs for each channel that we support */
 940         for (i = 0; i <= BCM2835_DMA_MAX_DMA_CHAN_SUPPORTED; i++) {
 941                 /* skip masked out channels */
 942                 if (!(chans_available & (1 << i))) {
 943                         irq[i] = -1;
 944                         continue;
 945                 }
 946
 947                 /* get the named irq */
 948                 snprintf(chan_name, sizeof(chan_name), "dma%i", i);
 949                 irq[i] = platform_get_irq_byname(pdev, chan_name);
 950                 if (irq[i] >= 0)
 951                         continue;
 952
 953                 /* legacy device tree case handling */
 954                 dev_warn_once(&pdev->dev,
 955                               "missing interrupt-names property in device tree - legacy interpretation is used\n");
 956                 /*
 957                  * in case of channel >= 11
 958                  * use the 11th interrupt and that is shared
 959                  */
 960                 irq[i] = platform_get_irq(pdev, i < 11 ? i : 11);
 961         }
 962
 963         /* get irqs for each channel */
 964         for (i = 0; i <= BCM2835_DMA_MAX_DMA_CHAN_SUPPORTED; i++) {
 965                 /* skip channels without irq */
 966                 if (irq[i] < 0)
 967                         continue;
 968
 969                 /* check if there are other channels that also use this irq */
 970                 irq_flags = 0;
 971                 for (j = 0; j <= BCM2835_DMA_MAX_DMA_CHAN_SUPPORTED; j++)
 972                         if ((i != j) && (irq[j] == irq[i])) {
 973                                 irq_flags = IRQF_SHARED;
 974                                 break;
 975                         }
 976
 977                 /* initialize the channel */
 978                 rc = bcm2835_dma_chan_init(od, i, irq[i], irq_flags);
 979                 if (rc)
 980                         goto err_no_dma;
 981         }
 982
 983         dev_dbg(&pdev->dev, "Initialized %i DMA channels\n", i);
 984
 985         /* Device-tree DMA controller registration */
 986         rc = of_dma_controller_register(pdev->dev.of_node,
 987                         bcm2835_dma_xlate, od);
 988         if (rc) {
 989                 dev_err(&pdev->dev, "Failed to register DMA controller\n");
 990                 goto err_no_dma;
 991         }
 992
 993         rc = dma_async_device_register(&od->ddev);
 994         if (rc) {
 995                 dev_err(&pdev->dev,
 996                         "Failed to register slave DMA engine device: %d\n", rc);
 997                 goto err_no_dma;
 998         }
 999
1000         dev_dbg(&pdev->dev, "Load BCM2835 DMA engine driver\n");
1001
1002         return 0;
1003
1004 err_no_dma:
1005         bcm2835_dma_free(od);
1006         return rc;
1007 }
1008
1009 static int bcm2835_dma_remove(struct platform_device *pdev)
1010 {
1011         struct bcm2835_dmadev *od = platform_get_drvdata(pdev);
1012
1013         dma_async_device_unregister(&od->ddev);
1014         bcm2835_dma_free(od);
1015
1016         return 0;
1017 }
1018
1019 static struct platform_driver bcm2835_dma_driver = {
1020         .probe  = bcm2835_dma_probe,
1021         .remove = bcm2835_dma_remove,
1022         .driver = {
1023                 .name = "bcm2835-dma",
1024                 .of_match_table = of_match_ptr(bcm2835_dma_of_match),
1025         },
1026 };
1027
1028 module_platform_driver(bcm2835_dma_driver);
1029
1030 MODULE_ALIAS("platform:bcm2835-dma");
1031 MODULE_DESCRIPTION("BCM2835 DMA engine driver");
1032 MODULE_AUTHOR("Florian Meier <florian.meier@koalo.de>");
1033 MODULE_LICENSE("GPL");