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