drivers/dma/dmaengine.c

   1 /*
   2  * Copyright(c) 2004 - 2006 Intel Corporation. All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License as published by the Free
   6  * Software Foundation; either version 2 of the License, or (at your option)
   7  * any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * The full GNU General Public License is included in this distribution in the
  15  * file called COPYING.
  16  */
  17
  18 /*
  19  * This code implements the DMA subsystem. It provides a HW-neutral interface
  20  * for other kernel code to use asynchronous memory copy capabilities,
  21  * if present, and allows different HW DMA drivers to register as providing
  22  * this capability.
  23  *
  24  * Due to the fact we are accelerating what is already a relatively fast
  25  * operation, the code goes to great lengths to avoid additional overhead,
  26  * such as locking.
  27  *
  28  * LOCKING:
  29  *
  30  * The subsystem keeps a global list of dma_device structs it is protected by a
  31  * mutex, dma_list_mutex.
  32  *
  33  * A subsystem can get access to a channel by calling dmaengine_get() followed
  34  * by dma_find_channel(), or if it has need for an exclusive channel it can call
  35  * dma_request_channel().  Once a channel is allocated a reference is taken
  36  * against its corresponding driver to disable removal.
  37  *
  38  * Each device has a channels list, which runs unlocked but is never modified
  39  * once the device is registered, it's just setup by the driver.
  40  *
  41  * See Documentation/dmaengine.txt for more details
  42  */
  43
  44 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  45
  46 #include <linux/dma-mapping.h>
  47 #include <linux/init.h>
  48 #include <linux/module.h>
  49 #include <linux/mm.h>
  50 #include <linux/device.h>
  51 #include <linux/dmaengine.h>
  52 #include <linux/hardirq.h>
  53 #include <linux/spinlock.h>
  54 #include <linux/percpu.h>
  55 #include <linux/rcupdate.h>
  56 #include <linux/mutex.h>
  57 #include <linux/jiffies.h>
  58 #include <linux/rculist.h>
  59 #include <linux/idr.h>
  60 #include <linux/slab.h>
  61 #include <linux/acpi.h>
  62 #include <linux/acpi_dma.h>
  63 #include <linux/of_dma.h>
  64 #include <linux/mempool.h>
  65
  66 static DEFINE_MUTEX(dma_list_mutex);
  67 static DEFINE_IDR(dma_idr);
  68 static LIST_HEAD(dma_device_list);
  69 static long dmaengine_ref_count;
  70
  71 /* --- sysfs implementation --- */
  72
  73 /**
  74  * dev_to_dma_chan - convert a device pointer to the its sysfs container object
  75  * @dev - device node
  76  *
  77  * Must be called under dma_list_mutex
  78  */
  79 static struct dma_chan *dev_to_dma_chan(struct device *dev)
  80 {
  81         struct dma_chan_dev *chan_dev;
  82
  83         chan_dev = container_of(dev, typeof(*chan_dev), device);
  84         return chan_dev->chan;
  85 }
  86
  87 static ssize_t memcpy_count_show(struct device *dev,
  88                                  struct device_attribute *attr, char *buf)
  89 {
  90         struct dma_chan *chan;
  91         unsigned long count = 0;
  92         int i;
  93         int err;
  94
  95         mutex_lock(&dma_list_mutex);
  96         chan = dev_to_dma_chan(dev);
  97         if (chan) {
  98                 for_each_possible_cpu(i)
  99                         count += per_cpu_ptr(chan->local, i)->memcpy_count;
 100                 err = sprintf(buf, "%lu\n", count);
 101         } else
 102                 err = -ENODEV;
 103         mutex_unlock(&dma_list_mutex);
 104
 105         return err;
 106 }
 107 static DEVICE_ATTR_RO(memcpy_count);
 108
 109 static ssize_t bytes_transferred_show(struct device *dev,
 110                                       struct device_attribute *attr, char *buf)
 111 {
 112         struct dma_chan *chan;
 113         unsigned long count = 0;
 114         int i;
 115         int err;
 116
 117         mutex_lock(&dma_list_mutex);
 118         chan = dev_to_dma_chan(dev);
 119         if (chan) {
 120                 for_each_possible_cpu(i)
 121                         count += per_cpu_ptr(chan->local, i)->bytes_transferred;
 122                 err = sprintf(buf, "%lu\n", count);
 123         } else
 124                 err = -ENODEV;
 125         mutex_unlock(&dma_list_mutex);
 126
 127         return err;
 128 }
 129 static DEVICE_ATTR_RO(bytes_transferred);
 130
 131 static ssize_t in_use_show(struct device *dev, struct device_attribute *attr,
 132                            char *buf)
 133 {
 134         struct dma_chan *chan;
 135         int err;
 136
 137         mutex_lock(&dma_list_mutex);
 138         chan = dev_to_dma_chan(dev);
 139         if (chan)
 140                 err = sprintf(buf, "%d\n", chan->client_count);
 141         else
 142                 err = -ENODEV;
 143         mutex_unlock(&dma_list_mutex);
 144
 145         return err;
 146 }
 147 static DEVICE_ATTR_RO(in_use);
 148
 149 static struct attribute *dma_dev_attrs[] = {
 150         &dev_attr_memcpy_count.attr,
 151         &dev_attr_bytes_transferred.attr,
 152         &dev_attr_in_use.attr,
 153         NULL,
 154 };
 155 ATTRIBUTE_GROUPS(dma_dev);
 156
 157 static void chan_dev_release(struct device *dev)
 158 {
 159         struct dma_chan_dev *chan_dev;
 160
 161         chan_dev = container_of(dev, typeof(*chan_dev), device);
 162         if (atomic_dec_and_test(chan_dev->idr_ref)) {
 163                 mutex_lock(&dma_list_mutex);
 164                 idr_remove(&dma_idr, chan_dev->dev_id);
 165                 mutex_unlock(&dma_list_mutex);
 166                 kfree(chan_dev->idr_ref);
 167         }
 168         kfree(chan_dev);
 169 }
 170
 171 static struct class dma_devclass = {
 172         .name           = "dma",
 173         .dev_groups     = dma_dev_groups,
 174         .dev_release    = chan_dev_release,
 175 };
 176
 177 /* --- client and device registration --- */
 178
 179 #define dma_device_satisfies_mask(device, mask) \
 180         __dma_device_satisfies_mask((device), &(mask))
 181 static int
 182 __dma_device_satisfies_mask(struct dma_device *device,
 183                             const dma_cap_mask_t *want)
 184 {
 185         dma_cap_mask_t has;
 186
 187         bitmap_and(has.bits, want->bits, device->cap_mask.bits,
 188                 DMA_TX_TYPE_END);
 189         return bitmap_equal(want->bits, has.bits, DMA_TX_TYPE_END);
 190 }
 191
 192 static struct module *dma_chan_to_owner(struct dma_chan *chan)
 193 {
 194         return chan->device->dev->driver->owner;
 195 }
 196
 197 /**
 198  * balance_ref_count - catch up the channel reference count
 199  * @chan - channel to balance ->client_count versus dmaengine_ref_count
 200  *
 201  * balance_ref_count must be called under dma_list_mutex
 202  */
 203 static void balance_ref_count(struct dma_chan *chan)
 204 {
 205         struct module *owner = dma_chan_to_owner(chan);
 206
 207         while (chan->client_count < dmaengine_ref_count) {
 208                 __module_get(owner);
 209                 chan->client_count++;
 210         }
 211 }
 212
 213 /**
 214  * dma_chan_get - try to grab a dma channel's parent driver module
 215  * @chan - channel to grab
 216  *
 217  * Must be called under dma_list_mutex
 218  */
 219 static int dma_chan_get(struct dma_chan *chan)
 220 {
 221         struct module *owner = dma_chan_to_owner(chan);
 222         int ret;
 223
 224         /* The channel is already in use, update client count */
 225         if (chan->client_count) {
 226                 __module_get(owner);
 227                 goto out;
 228         }
 229
 230         if (!try_module_get(owner))
 231                 return -ENODEV;
 232
 233         /* allocate upon first client reference */
 234         if (chan->device->device_alloc_chan_resources) {
 235                 ret = chan->device->device_alloc_chan_resources(chan);
 236                 if (ret < 0)
 237                         goto err_out;
 238         }
 239
 240         if (!dma_has_cap(DMA_PRIVATE, chan->device->cap_mask))
 241                 balance_ref_count(chan);
 242
 243 out:
 244         chan->client_count++;
 245         return 0;
 246
 247 err_out:
 248         module_put(owner);
 249         return ret;
 250 }
 251
 252 /**
 253  * dma_chan_put - drop a reference to a dma channel's parent driver module
 254  * @chan - channel to release
 255  *
 256  * Must be called under dma_list_mutex
 257  */
 258 static void dma_chan_put(struct dma_chan *chan)
 259 {
 260         /* This channel is not in use, bail out */
 261         if (!chan->client_count)
 262                 return;
 263
 264         chan->client_count--;
 265         module_put(dma_chan_to_owner(chan));
 266
 267         /* This channel is not in use anymore, free it */
 268         if (!chan->client_count && chan->device->device_free_chan_resources) {
 269                 /* Make sure all operations have completed */
 270                 dmaengine_synchronize(chan);
 271                 chan->device->device_free_chan_resources(chan);
 272         }
 273
 274         /* If the channel is used via a DMA request router, free the mapping */
 275         if (chan->router && chan->router->route_free) {
 276                 chan->router->route_free(chan->router->dev, chan->route_data);
 277                 chan->router = NULL;
 278                 chan->route_data = NULL;
 279         }
 280 }
 281
 282 enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie)
 283 {
 284         enum dma_status status;
 285         unsigned long dma_sync_wait_timeout = jiffies + msecs_to_jiffies(5000);
 286
 287         dma_async_issue_pending(chan);
 288         do {
 289                 status = dma_async_is_tx_complete(chan, cookie, NULL, NULL);
 290                 if (time_after_eq(jiffies, dma_sync_wait_timeout)) {
 291                         pr_err("%s: timeout!\n", __func__);
 292                         return DMA_ERROR;
 293                 }
 294                 if (status != DMA_IN_PROGRESS)
 295                         break;
 296                 cpu_relax();
 297         } while (1);
 298
 299         return status;
 300 }
 301 EXPORT_SYMBOL(dma_sync_wait);
 302
 303 /**
 304  * dma_cap_mask_all - enable iteration over all operation types
 305  */
 306 static dma_cap_mask_t dma_cap_mask_all;
 307
 308 /**
 309  * dma_chan_tbl_ent - tracks channel allocations per core/operation
 310  * @chan - associated channel for this entry
 311  */
 312 struct dma_chan_tbl_ent {
 313         struct dma_chan *chan;
 314 };
 315
 316 /**
 317  * channel_table - percpu lookup table for memory-to-memory offload providers
 318  */
 319 static struct dma_chan_tbl_ent __percpu *channel_table[DMA_TX_TYPE_END];
 320
 321 static int __init dma_channel_table_init(void)
 322 {
 323         enum dma_transaction_type cap;
 324         int err = 0;
 325
 326         bitmap_fill(dma_cap_mask_all.bits, DMA_TX_TYPE_END);
 327
 328         /* 'interrupt', 'private', and 'slave' are channel capabilities,
 329          * but are not associated with an operation so they do not need
 330          * an entry in the channel_table
 331          */
 332         clear_bit(DMA_INTERRUPT, dma_cap_mask_all.bits);
 333         clear_bit(DMA_PRIVATE, dma_cap_mask_all.bits);
 334         clear_bit(DMA_SLAVE, dma_cap_mask_all.bits);
 335
 336         for_each_dma_cap_mask(cap, dma_cap_mask_all) {
 337                 channel_table[cap] = alloc_percpu(struct dma_chan_tbl_ent);
 338                 if (!channel_table[cap]) {
 339                         err = -ENOMEM;
 340                         break;
 341                 }
 342         }
 343
 344         if (err) {
 345                 pr_err("initialization failure\n");
 346                 for_each_dma_cap_mask(cap, dma_cap_mask_all)
 347                         free_percpu(channel_table[cap]);
 348         }
 349
 350         return err;
 351 }
 352 arch_initcall(dma_channel_table_init);
 353
 354 /**
 355  * dma_find_channel - find a channel to carry out the operation
 356  * @tx_type: transaction type
 357  */
 358 struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type)
 359 {
 360         return this_cpu_read(channel_table[tx_type]->chan);
 361 }
 362 EXPORT_SYMBOL(dma_find_channel);
 363
 364 /**
 365  * dma_issue_pending_all - flush all pending operations across all channels
 366  */
 367 void dma_issue_pending_all(void)
 368 {
 369         struct dma_device *device;
 370         struct dma_chan *chan;
 371
 372         rcu_read_lock();
 373         list_for_each_entry_rcu(device, &dma_device_list, global_node) {
 374                 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
 375                         continue;
 376                 list_for_each_entry(chan, &device->channels, device_node)
 377                         if (chan->client_count)
 378                                 device->device_issue_pending(chan);
 379         }
 380         rcu_read_unlock();
 381 }
 382 EXPORT_SYMBOL(dma_issue_pending_all);
 383
 384 /**
 385  * dma_chan_is_local - returns true if the channel is in the same numa-node as the cpu
 386  */
 387 static bool dma_chan_is_local(struct dma_chan *chan, int cpu)
 388 {
 389         int node = dev_to_node(chan->device->dev);
 390         return node == -1 || cpumask_test_cpu(cpu, cpumask_of_node(node));
 391 }
 392
 393 /**
 394  * min_chan - returns the channel with min count and in the same numa-node as the cpu
 395  * @cap: capability to match
 396  * @cpu: cpu index which the channel should be close to
 397  *
 398  * If some channels are close to the given cpu, the one with the lowest
 399  * reference count is returned. Otherwise, cpu is ignored and only the
 400  * reference count is taken into account.
 401  * Must be called under dma_list_mutex.
 402  */
 403 static struct dma_chan *min_chan(enum dma_transaction_type cap, int cpu)
 404 {
 405         struct dma_device *device;
 406         struct dma_chan *chan;
 407         struct dma_chan *min = NULL;
 408         struct dma_chan *localmin = NULL;
 409
 410         list_for_each_entry(device, &dma_device_list, global_node) {
 411                 if (!dma_has_cap(cap, device->cap_mask) ||
 412                     dma_has_cap(DMA_PRIVATE, device->cap_mask))
 413                         continue;
 414                 list_for_each_entry(chan, &device->channels, device_node) {
 415                         if (!chan->client_count)
 416                                 continue;
 417                         if (!min || chan->table_count < min->table_count)
 418                                 min = chan;
 419
 420                         if (dma_chan_is_local(chan, cpu))
 421                                 if (!localmin ||
 422                                     chan->table_count < localmin->table_count)
 423                                         localmin = chan;
 424                 }
 425         }
 426
 427         chan = localmin ? localmin : min;
 428
 429         if (chan)
 430                 chan->table_count++;
 431
 432         return chan;
 433 }
 434
 435 /**
 436  * dma_channel_rebalance - redistribute the available channels
 437  *
 438  * Optimize for cpu isolation (each cpu gets a dedicated channel for an
 439  * operation type) in the SMP case,  and operation isolation (avoid
 440  * multi-tasking channels) in the non-SMP case.  Must be called under
 441  * dma_list_mutex.
 442  */
 443 static void dma_channel_rebalance(void)
 444 {
 445         struct dma_chan *chan;
 446         struct dma_device *device;
 447         int cpu;
 448         int cap;
 449
 450         /* undo the last distribution */
 451         for_each_dma_cap_mask(cap, dma_cap_mask_all)
 452                 for_each_possible_cpu(cpu)
 453                         per_cpu_ptr(channel_table[cap], cpu)->chan = NULL;
 454
 455         list_for_each_entry(device, &dma_device_list, global_node) {
 456                 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
 457                         continue;
 458                 list_for_each_entry(chan, &device->channels, device_node)
 459                         chan->table_count = 0;
 460         }
 461
 462         /* don't populate the channel_table if no clients are available */
 463         if (!dmaengine_ref_count)
 464                 return;
 465
 466         /* redistribute available channels */
 467         for_each_dma_cap_mask(cap, dma_cap_mask_all)
 468                 for_each_online_cpu(cpu) {
 469                         chan = min_chan(cap, cpu);
 470                         per_cpu_ptr(channel_table[cap], cpu)->chan = chan;
 471                 }
 472 }
 473
 474 int dma_get_slave_caps(struct dma_chan *chan, struct dma_slave_caps *caps)
 475 {
 476         struct dma_device *device;
 477
 478         if (!chan || !caps)
 479                 return -EINVAL;
 480
 481         device = chan->device;
 482
 483         /* check if the channel supports slave transactions */
 484         if (!test_bit(DMA_SLAVE, device->cap_mask.bits))
 485                 return -ENXIO;
 486
 487         /*
 488          * Check whether it reports it uses the generic slave
 489          * capabilities, if not, that means it doesn't support any
 490          * kind of slave capabilities reporting.
 491          */
 492         if (!device->directions)
 493                 return -ENXIO;
 494
 495         caps->src_addr_widths = device->src_addr_widths;
 496         caps->dst_addr_widths = device->dst_addr_widths;
 497         caps->directions = device->directions;
 498         caps->max_burst = device->max_burst;
 499         caps->residue_granularity = device->residue_granularity;
 500
 501         /*
 502          * Some devices implement only pause (e.g. to get residuum) but no
 503          * resume. However cmd_pause is advertised as pause AND resume.
 504          */
 505         caps->cmd_pause = !!(device->device_pause && device->device_resume);
 506         caps->cmd_terminate = !!device->device_terminate_all;
 507
 508         return 0;
 509 }
 510 EXPORT_SYMBOL_GPL(dma_get_slave_caps);
 511
 512 static struct dma_chan *private_candidate(const dma_cap_mask_t *mask,
 513                                           struct dma_device *dev,
 514                                           dma_filter_fn fn, void *fn_param)
 515 {
 516         struct dma_chan *chan;
 517
 518         if (mask && !__dma_device_satisfies_mask(dev, mask)) {
 519                 pr_debug("%s: wrong capabilities\n", __func__);
 520                 return NULL;
 521         }
 522         /* devices with multiple channels need special handling as we need to
 523          * ensure that all channels are either private or public.
 524          */
 525         if (dev->chancnt > 1 && !dma_has_cap(DMA_PRIVATE, dev->cap_mask))
 526                 list_for_each_entry(chan, &dev->channels, device_node) {
 527                         /* some channels are already publicly allocated */
 528                         if (chan->client_count)
 529                                 return NULL;
 530                 }
 531
 532         list_for_each_entry(chan, &dev->channels, device_node) {
 533                 if (chan->client_count) {
 534                         pr_debug("%s: %s busy\n",
 535                                  __func__, dma_chan_name(chan));
 536                         continue;
 537                 }
 538                 if (fn && !fn(chan, fn_param)) {
 539                         pr_debug("%s: %s filter said false\n",
 540                                  __func__, dma_chan_name(chan));
 541                         continue;
 542                 }
 543                 return chan;
 544         }
 545
 546         return NULL;
 547 }
 548
 549 /**
 550  * dma_get_slave_channel - try to get specific channel exclusively
 551  * @chan: target channel
 552  */
 553 struct dma_chan *dma_get_slave_channel(struct dma_chan *chan)
 554 {
 555         int err = -EBUSY;
 556
 557         /* lock against __dma_request_channel */
 558         mutex_lock(&dma_list_mutex);
 559
 560         if (chan->client_count == 0) {
 561                 struct dma_device *device = chan->device;
 562
 563                 dma_cap_set(DMA_PRIVATE, device->cap_mask);
 564                 device->privatecnt++;
 565                 err = dma_chan_get(chan);
 566                 if (err) {
 567                         pr_debug("%s: failed to get %s: (%d)\n",
 568                                 __func__, dma_chan_name(chan), err);
 569                         chan = NULL;
 570                         if (--device->privatecnt == 0)
 571                                 dma_cap_clear(DMA_PRIVATE, device->cap_mask);
 572                 }
 573         } else
 574                 chan = NULL;
 575
 576         mutex_unlock(&dma_list_mutex);
 577
 578
 579         return chan;
 580 }
 581 EXPORT_SYMBOL_GPL(dma_get_slave_channel);
 582
 583 struct dma_chan *dma_get_any_slave_channel(struct dma_device *device)
 584 {
 585         dma_cap_mask_t mask;
 586         struct dma_chan *chan;
 587         int err;
 588
 589         dma_cap_zero(mask);
 590         dma_cap_set(DMA_SLAVE, mask);
 591
 592         /* lock against __dma_request_channel */
 593         mutex_lock(&dma_list_mutex);
 594
 595         chan = private_candidate(&mask, device, NULL, NULL);
 596         if (chan) {
 597                 dma_cap_set(DMA_PRIVATE, device->cap_mask);
 598                 device->privatecnt++;
 599                 err = dma_chan_get(chan);
 600                 if (err) {
 601                         pr_debug("%s: failed to get %s: (%d)\n",
 602                                 __func__, dma_chan_name(chan), err);
 603                         chan = NULL;
 604                         if (--device->privatecnt == 0)
 605                                 dma_cap_clear(DMA_PRIVATE, device->cap_mask);
 606                 }
 607         }
 608
 609         mutex_unlock(&dma_list_mutex);
 610
 611         return chan;
 612 }
 613 EXPORT_SYMBOL_GPL(dma_get_any_slave_channel);
 614
 615 /**
 616  * __dma_request_channel - try to allocate an exclusive channel
 617  * @mask: capabilities that the channel must satisfy
 618  * @fn: optional callback to disposition available channels
 619  * @fn_param: opaque parameter to pass to dma_filter_fn
 620  *
 621  * Returns pointer to appropriate DMA channel on success or NULL.
 622  */
 623 struct dma_chan *__dma_request_channel(const dma_cap_mask_t *mask,
 624                                        dma_filter_fn fn, void *fn_param)
 625 {
 626         struct dma_device *device, *_d;
 627         struct dma_chan *chan = NULL;
 628         int err;
 629
 630         /* Find a channel */
 631         mutex_lock(&dma_list_mutex);
 632         list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
 633                 chan = private_candidate(mask, device, fn, fn_param);
 634                 if (chan) {
 635                         /* Found a suitable channel, try to grab, prep, and
 636                          * return it.  We first set DMA_PRIVATE to disable
 637                          * balance_ref_count as this channel will not be
 638                          * published in the general-purpose allocator
 639                          */
 640                         dma_cap_set(DMA_PRIVATE, device->cap_mask);
 641                         device->privatecnt++;
 642                         err = dma_chan_get(chan);
 643
 644                         if (err == -ENODEV) {
 645                                 pr_debug("%s: %s module removed\n",
 646                                          __func__, dma_chan_name(chan));
 647                                 list_del_rcu(&device->global_node);
 648                         } else if (err)
 649                                 pr_debug("%s: failed to get %s: (%d)\n",
 650                                          __func__, dma_chan_name(chan), err);
 651                         else
 652                                 break;
 653                         if (--device->privatecnt == 0)
 654                                 dma_cap_clear(DMA_PRIVATE, device->cap_mask);
 655                         chan = NULL;
 656                 }
 657         }
 658         mutex_unlock(&dma_list_mutex);
 659
 660         pr_debug("%s: %s (%s)\n",
 661                  __func__,
 662                  chan ? "success" : "fail",
 663                  chan ? dma_chan_name(chan) : NULL);
 664
 665         return chan;
 666 }
 667 EXPORT_SYMBOL_GPL(__dma_request_channel);
 668
 669 /**
 670  * dma_request_slave_channel_reason - try to allocate an exclusive slave channel
 671  * @dev:        pointer to client device structure
 672  * @name:       slave channel name
 673  *
 674  * Returns pointer to appropriate DMA channel on success or an error pointer.
 675  */
 676 struct dma_chan *dma_request_slave_channel_reason(struct device *dev,
 677                                                   const char *name)
 678 {
 679         /* If device-tree is present get slave info from here */
 680         if (dev->of_node)
 681                 return of_dma_request_slave_channel(dev->of_node, name);
 682
 683         /* If device was enumerated by ACPI get slave info from here */
 684         if (ACPI_HANDLE(dev))
 685                 return acpi_dma_request_slave_chan_by_name(dev, name);
 686
 687         return ERR_PTR(-ENODEV);
 688 }
 689 EXPORT_SYMBOL_GPL(dma_request_slave_channel_reason);
 690
 691 /**
 692  * dma_request_slave_channel - try to allocate an exclusive slave channel
 693  * @dev:        pointer to client device structure
 694  * @name:       slave channel name
 695  *
 696  * Returns pointer to appropriate DMA channel on success or NULL.
 697  */
 698 struct dma_chan *dma_request_slave_channel(struct device *dev,
 699                                            const char *name)
 700 {
 701         struct dma_chan *ch = dma_request_slave_channel_reason(dev, name);
 702         if (IS_ERR(ch))
 703                 return NULL;
 704
 705         dma_cap_set(DMA_PRIVATE, ch->device->cap_mask);
 706         ch->device->privatecnt++;
 707
 708         return ch;
 709 }
 710 EXPORT_SYMBOL_GPL(dma_request_slave_channel);
 711
 712 void dma_release_channel(struct dma_chan *chan)
 713 {
 714         mutex_lock(&dma_list_mutex);
 715         WARN_ONCE(chan->client_count != 1,
 716                   "chan reference count %d != 1\n", chan->client_count);
 717         dma_chan_put(chan);
 718         /* drop PRIVATE cap enabled by __dma_request_channel() */
 719         if (--chan->device->privatecnt == 0)
 720                 dma_cap_clear(DMA_PRIVATE, chan->device->cap_mask);
 721         mutex_unlock(&dma_list_mutex);
 722 }
 723 EXPORT_SYMBOL_GPL(dma_release_channel);
 724
 725 /**
 726  * dmaengine_get - register interest in dma_channels
 727  */
 728 void dmaengine_get(void)
 729 {
 730         struct dma_device *device, *_d;
 731         struct dma_chan *chan;
 732         int err;
 733
 734         mutex_lock(&dma_list_mutex);
 735         dmaengine_ref_count++;
 736
 737         /* try to grab channels */
 738         list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
 739                 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
 740                         continue;
 741                 list_for_each_entry(chan, &device->channels, device_node) {
 742                         err = dma_chan_get(chan);
 743                         if (err == -ENODEV) {
 744                                 /* module removed before we could use it */
 745                                 list_del_rcu(&device->global_node);
 746                                 break;
 747                         } else if (err)
 748                                 pr_debug("%s: failed to get %s: (%d)\n",
 749                                        __func__, dma_chan_name(chan), err);
 750                 }
 751         }
 752
 753         /* if this is the first reference and there were channels
 754          * waiting we need to rebalance to get those channels
 755          * incorporated into the channel table
 756          */
 757         if (dmaengine_ref_count == 1)
 758                 dma_channel_rebalance();
 759         mutex_unlock(&dma_list_mutex);
 760 }
 761 EXPORT_SYMBOL(dmaengine_get);
 762
 763 /**
 764  * dmaengine_put - let dma drivers be removed when ref_count == 0
 765  */
 766 void dmaengine_put(void)
 767 {
 768         struct dma_device *device;
 769         struct dma_chan *chan;
 770
 771         mutex_lock(&dma_list_mutex);
 772         dmaengine_ref_count--;
 773         BUG_ON(dmaengine_ref_count < 0);
 774         /* drop channel references */
 775         list_for_each_entry(device, &dma_device_list, global_node) {
 776                 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
 777                         continue;
 778                 list_for_each_entry(chan, &device->channels, device_node)
 779                         dma_chan_put(chan);
 780         }
 781         mutex_unlock(&dma_list_mutex);
 782 }
 783 EXPORT_SYMBOL(dmaengine_put);
 784
 785 static bool device_has_all_tx_types(struct dma_device *device)
 786 {
 787         /* A device that satisfies this test has channels that will never cause
 788          * an async_tx channel switch event as all possible operation types can
 789          * be handled.
 790          */
 791         #ifdef CONFIG_ASYNC_TX_DMA
 792         if (!dma_has_cap(DMA_INTERRUPT, device->cap_mask))
 793                 return false;
 794         #endif
 795
 796         #if defined(CONFIG_ASYNC_MEMCPY) || defined(CONFIG_ASYNC_MEMCPY_MODULE)
 797         if (!dma_has_cap(DMA_MEMCPY, device->cap_mask))
 798                 return false;
 799         #endif
 800
 801         #if defined(CONFIG_ASYNC_XOR) || defined(CONFIG_ASYNC_XOR_MODULE)
 802         if (!dma_has_cap(DMA_XOR, device->cap_mask))
 803                 return false;
 804
 805         #ifndef CONFIG_ASYNC_TX_DISABLE_XOR_VAL_DMA
 806         if (!dma_has_cap(DMA_XOR_VAL, device->cap_mask))
 807                 return false;
 808         #endif
 809         #endif
 810
 811         #if defined(CONFIG_ASYNC_PQ) || defined(CONFIG_ASYNC_PQ_MODULE)
 812         if (!dma_has_cap(DMA_PQ, device->cap_mask))
 813                 return false;
 814
 815         #ifndef CONFIG_ASYNC_TX_DISABLE_PQ_VAL_DMA
 816         if (!dma_has_cap(DMA_PQ_VAL, device->cap_mask))
 817                 return false;
 818         #endif
 819         #endif
 820
 821         return true;
 822 }
 823
 824 static int get_dma_id(struct dma_device *device)
 825 {
 826         int rc;
 827
 828         mutex_lock(&dma_list_mutex);
 829
 830         rc = idr_alloc(&dma_idr, NULL, 0, 0, GFP_KERNEL);
 831         if (rc >= 0)
 832                 device->dev_id = rc;
 833
 834         mutex_unlock(&dma_list_mutex);
 835         return rc < 0 ? rc : 0;
 836 }
 837
 838 /**
 839  * dma_async_device_register - registers DMA devices found
 840  * @device: &dma_device
 841  */
 842 int dma_async_device_register(struct dma_device *device)
 843 {
 844         int chancnt = 0, rc;
 845         struct dma_chan* chan;
 846         atomic_t *idr_ref;
 847
 848         if (!device)
 849                 return -ENODEV;
 850
 851         /* validate device routines */
 852         BUG_ON(dma_has_cap(DMA_MEMCPY, device->cap_mask) &&
 853                 !device->device_prep_dma_memcpy);
 854         BUG_ON(dma_has_cap(DMA_XOR, device->cap_mask) &&
 855                 !device->device_prep_dma_xor);
 856         BUG_ON(dma_has_cap(DMA_XOR_VAL, device->cap_mask) &&
 857                 !device->device_prep_dma_xor_val);
 858         BUG_ON(dma_has_cap(DMA_PQ, device->cap_mask) &&
 859                 !device->device_prep_dma_pq);
 860         BUG_ON(dma_has_cap(DMA_PQ_VAL, device->cap_mask) &&
 861                 !device->device_prep_dma_pq_val);
 862         BUG_ON(dma_has_cap(DMA_MEMSET, device->cap_mask) &&
 863                 !device->device_prep_dma_memset);
 864         BUG_ON(dma_has_cap(DMA_INTERRUPT, device->cap_mask) &&
 865                 !device->device_prep_dma_interrupt);
 866         BUG_ON(dma_has_cap(DMA_SG, device->cap_mask) &&
 867                 !device->device_prep_dma_sg);
 868         BUG_ON(dma_has_cap(DMA_CYCLIC, device->cap_mask) &&
 869                 !device->device_prep_dma_cyclic);
 870         BUG_ON(dma_has_cap(DMA_INTERLEAVE, device->cap_mask) &&
 871                 !device->device_prep_interleaved_dma);
 872
 873         BUG_ON(!device->device_tx_status);
 874         BUG_ON(!device->device_issue_pending);
 875         BUG_ON(!device->dev);
 876
 877         /* note: this only matters in the
 878          * CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH=n case
 879          */
 880         if (device_has_all_tx_types(device))
 881                 dma_cap_set(DMA_ASYNC_TX, device->cap_mask);
 882
 883         idr_ref = kmalloc(sizeof(*idr_ref), GFP_KERNEL);
 884         if (!idr_ref)
 885                 return -ENOMEM;
 886         rc = get_dma_id(device);
 887         if (rc != 0) {
 888                 kfree(idr_ref);
 889                 return rc;
 890         }
 891
 892         atomic_set(idr_ref, 0);
 893
 894         /* represent channels in sysfs. Probably want devs too */
 895         list_for_each_entry(chan, &device->channels, device_node) {
 896                 rc = -ENOMEM;
 897                 chan->local = alloc_percpu(typeof(*chan->local));
 898                 if (chan->local == NULL)
 899                         goto err_out;
 900                 chan->dev = kzalloc(sizeof(*chan->dev), GFP_KERNEL);
 901                 if (chan->dev == NULL) {
 902                         free_percpu(chan->local);
 903                         chan->local = NULL;
 904                         goto err_out;
 905                 }
 906
 907                 chan->chan_id = chancnt++;
 908                 chan->dev->device.class = &dma_devclass;
 909                 chan->dev->device.parent = device->dev;
 910                 chan->dev->chan = chan;
 911                 chan->dev->idr_ref = idr_ref;
 912                 chan->dev->dev_id = device->dev_id;
 913                 atomic_inc(idr_ref);
 914                 dev_set_name(&chan->dev->device, "dma%dchan%d",
 915                              device->dev_id, chan->chan_id);
 916
 917                 rc = device_register(&chan->dev->device);
 918                 if (rc) {
 919                         free_percpu(chan->local);
 920                         chan->local = NULL;
 921                         kfree(chan->dev);
 922                         atomic_dec(idr_ref);
 923                         goto err_out;
 924                 }
 925                 chan->client_count = 0;
 926         }
 927         device->chancnt = chancnt;
 928
 929         mutex_lock(&dma_list_mutex);
 930         /* take references on public channels */
 931         if (dmaengine_ref_count && !dma_has_cap(DMA_PRIVATE, device->cap_mask))
 932                 list_for_each_entry(chan, &device->channels, device_node) {
 933                         /* if clients are already waiting for channels we need
 934                          * to take references on their behalf
 935                          */
 936                         if (dma_chan_get(chan) == -ENODEV) {
 937                                 /* note we can only get here for the first
 938                                  * channel as the remaining channels are
 939                                  * guaranteed to get a reference
 940                                  */
 941                                 rc = -ENODEV;
 942                                 mutex_unlock(&dma_list_mutex);
 943                                 goto err_out;
 944                         }
 945                 }
 946         list_add_tail_rcu(&device->global_node, &dma_device_list);
 947         if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
 948                 device->privatecnt++;   /* Always private */
 949         dma_channel_rebalance();
 950         mutex_unlock(&dma_list_mutex);
 951
 952         return 0;
 953
 954 err_out:
 955         /* if we never registered a channel just release the idr */
 956         if (atomic_read(idr_ref) == 0) {
 957                 mutex_lock(&dma_list_mutex);
 958                 idr_remove(&dma_idr, device->dev_id);
 959                 mutex_unlock(&dma_list_mutex);
 960                 kfree(idr_ref);
 961                 return rc;
 962         }
 963
 964         list_for_each_entry(chan, &device->channels, device_node) {
 965                 if (chan->local == NULL)
 966                         continue;
 967                 mutex_lock(&dma_list_mutex);
 968                 chan->dev->chan = NULL;
 969                 mutex_unlock(&dma_list_mutex);
 970                 device_unregister(&chan->dev->device);
 971                 free_percpu(chan->local);
 972         }
 973         return rc;
 974 }
 975 EXPORT_SYMBOL(dma_async_device_register);
 976
 977 /**
 978  * dma_async_device_unregister - unregister a DMA device
 979  * @device: &dma_device
 980  *
 981  * This routine is called by dma driver exit routines, dmaengine holds module
 982  * references to prevent it being called while channels are in use.
 983  */
 984 void dma_async_device_unregister(struct dma_device *device)
 985 {
 986         struct dma_chan *chan;
 987
 988         mutex_lock(&dma_list_mutex);
 989         list_del_rcu(&device->global_node);
 990         dma_channel_rebalance();
 991         mutex_unlock(&dma_list_mutex);
 992
 993         list_for_each_entry(chan, &device->channels, device_node) {
 994                 WARN_ONCE(chan->client_count,
 995                           "%s called while %d clients hold a reference\n",
 996                           __func__, chan->client_count);
 997                 mutex_lock(&dma_list_mutex);
 998                 chan->dev->chan = NULL;
 999                 mutex_unlock(&dma_list_mutex);
1000                 device_unregister(&chan->dev->device);
1001                 free_percpu(chan->local);
1002         }
1003 }
1004 EXPORT_SYMBOL(dma_async_device_unregister);
1005
1006 struct dmaengine_unmap_pool {
1007         struct kmem_cache *cache;
1008         const char *name;
1009         mempool_t *pool;
1010         size_t size;
1011 };
1012
1013 #define __UNMAP_POOL(x) { .size = x, .name = "dmaengine-unmap-" __stringify(x) }
1014 static struct dmaengine_unmap_pool unmap_pool[] = {
1015         __UNMAP_POOL(2),
1016         #if IS_ENABLED(CONFIG_DMA_ENGINE_RAID)
1017         __UNMAP_POOL(16),
1018         __UNMAP_POOL(128),
1019         __UNMAP_POOL(256),
1020         #endif
1021 };
1022
1023 static struct dmaengine_unmap_pool *__get_unmap_pool(int nr)
1024 {
1025         int order = get_count_order(nr);
1026
1027         switch (order) {
1028         case 0 ... 1:
1029                 return &unmap_pool[0];
1030         case 2 ... 4:
1031                 return &unmap_pool[1];
1032         case 5 ... 7:
1033                 return &unmap_pool[2];
1034         case 8:
1035                 return &unmap_pool[3];
1036         default:
1037                 BUG();
1038                 return NULL;
1039         }
1040 }
1041
1042 static void dmaengine_unmap(struct kref *kref)
1043 {
1044         struct dmaengine_unmap_data *unmap = container_of(kref, typeof(*unmap), kref);
1045         struct device *dev = unmap->dev;
1046         int cnt, i;
1047
1048         cnt = unmap->to_cnt;
1049         for (i = 0; i < cnt; i++)
1050                 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1051                                DMA_TO_DEVICE);
1052         cnt += unmap->from_cnt;
1053         for (; i < cnt; i++)
1054                 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1055                                DMA_FROM_DEVICE);
1056         cnt += unmap->bidi_cnt;
1057         for (; i < cnt; i++) {
1058                 if (unmap->addr[i] == 0)
1059                         continue;
1060                 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1061                                DMA_BIDIRECTIONAL);
1062         }
1063         cnt = unmap->map_cnt;
1064         mempool_free(unmap, __get_unmap_pool(cnt)->pool);
1065 }
1066
1067 void dmaengine_unmap_put(struct dmaengine_unmap_data *unmap)
1068 {
1069         if (unmap)
1070                 kref_put(&unmap->kref, dmaengine_unmap);
1071 }
1072 EXPORT_SYMBOL_GPL(dmaengine_unmap_put);
1073
1074 static void dmaengine_destroy_unmap_pool(void)
1075 {
1076         int i;
1077
1078         for (i = 0; i < ARRAY_SIZE(unmap_pool); i++) {
1079                 struct dmaengine_unmap_pool *p = &unmap_pool[i];
1080
1081                 mempool_destroy(p->pool);
1082                 p->pool = NULL;
1083                 kmem_cache_destroy(p->cache);
1084                 p->cache = NULL;
1085         }
1086 }
1087
1088 static int __init dmaengine_init_unmap_pool(void)
1089 {
1090         int i;
1091
1092         for (i = 0; i < ARRAY_SIZE(unmap_pool); i++) {
1093                 struct dmaengine_unmap_pool *p = &unmap_pool[i];
1094                 size_t size;
1095
1096                 size = sizeof(struct dmaengine_unmap_data) +
1097                        sizeof(dma_addr_t) * p->size;
1098
1099                 p->cache = kmem_cache_create(p->name, size, 0,
1100                                              SLAB_HWCACHE_ALIGN, NULL);
1101                 if (!p->cache)
1102                         break;
1103                 p->pool = mempool_create_slab_pool(1, p->cache);
1104                 if (!p->pool)
1105                         break;
1106         }
1107
1108         if (i == ARRAY_SIZE(unmap_pool))
1109                 return 0;
1110
1111         dmaengine_destroy_unmap_pool();
1112         return -ENOMEM;
1113 }
1114
1115 struct dmaengine_unmap_data *
1116 dmaengine_get_unmap_data(struct device *dev, int nr, gfp_t flags)
1117 {
1118         struct dmaengine_unmap_data *unmap;
1119
1120         unmap = mempool_alloc(__get_unmap_pool(nr)->pool, flags);
1121         if (!unmap)
1122                 return NULL;
1123
1124         memset(unmap, 0, sizeof(*unmap));
1125         kref_init(&unmap->kref);
1126         unmap->dev = dev;
1127         unmap->map_cnt = nr;
1128
1129         return unmap;
1130 }
1131 EXPORT_SYMBOL(dmaengine_get_unmap_data);
1132
1133 void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx,
1134         struct dma_chan *chan)
1135 {
1136         tx->chan = chan;
1137         #ifdef CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH
1138         spin_lock_init(&tx->lock);
1139         #endif
1140 }
1141 EXPORT_SYMBOL(dma_async_tx_descriptor_init);
1142
1143 /* dma_wait_for_async_tx - spin wait for a transaction to complete
1144  * @tx: in-flight transaction to wait on
1145  */
1146 enum dma_status
1147 dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx)
1148 {
1149         unsigned long dma_sync_wait_timeout = jiffies + msecs_to_jiffies(5000);
1150
1151         if (!tx)
1152                 return DMA_COMPLETE;
1153
1154         while (tx->cookie == -EBUSY) {
1155                 if (time_after_eq(jiffies, dma_sync_wait_timeout)) {
1156                         pr_err("%s timeout waiting for descriptor submission\n",
1157                                __func__);
1158                         return DMA_ERROR;
1159                 }
1160                 cpu_relax();
1161         }
1162         return dma_sync_wait(tx->chan, tx->cookie);
1163 }
1164 EXPORT_SYMBOL_GPL(dma_wait_for_async_tx);
1165
1166 /* dma_run_dependencies - helper routine for dma drivers to process
1167  *      (start) dependent operations on their target channel
1168  * @tx: transaction with dependencies
1169  */
1170 void dma_run_dependencies(struct dma_async_tx_descriptor *tx)
1171 {
1172         struct dma_async_tx_descriptor *dep = txd_next(tx);
1173         struct dma_async_tx_descriptor *dep_next;
1174         struct dma_chan *chan;
1175
1176         if (!dep)
1177                 return;
1178
1179         /* we'll submit tx->next now, so clear the link */
1180         txd_clear_next(tx);
1181         chan = dep->chan;
1182
1183         /* keep submitting up until a channel switch is detected
1184          * in that case we will be called again as a result of
1185          * processing the interrupt from async_tx_channel_switch
1186          */
1187         for (; dep; dep = dep_next) {
1188                 txd_lock(dep);
1189                 txd_clear_parent(dep);
1190                 dep_next = txd_next(dep);
1191                 if (dep_next && dep_next->chan == chan)
1192                         txd_clear_next(dep); /* ->next will be submitted */
1193                 else
1194                         dep_next = NULL; /* submit current dep and terminate */
1195                 txd_unlock(dep);
1196
1197                 dep->tx_submit(dep);
1198         }
1199
1200         chan->device->device_issue_pending(chan);
1201 }
1202 EXPORT_SYMBOL_GPL(dma_run_dependencies);
1203
1204 static int __init dma_bus_init(void)
1205 {
1206         int err = dmaengine_init_unmap_pool();
1207
1208         if (err)
1209                 return err;
1210         return class_register(&dma_devclass);
1211 }
1212 arch_initcall(dma_bus_init);
1213
1214