2 * Copyright(c) 2004 - 2006 Intel Corporation. All rights reserved.
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)
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
14 * The full GNU General Public License is included in this distribution in the
15 * file called COPYING.
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
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,
30 * The subsystem keeps a global list of dma_device structs it is protected by a
31 * mutex, dma_list_mutex.
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.
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.
41 * See Documentation/dmaengine.txt for more details
44 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
46 #include <linux/platform_device.h>
47 #include <linux/dma-mapping.h>
48 #include <linux/init.h>
49 #include <linux/module.h>
51 #include <linux/device.h>
52 #include <linux/dmaengine.h>
53 #include <linux/hardirq.h>
54 #include <linux/spinlock.h>
55 #include <linux/percpu.h>
56 #include <linux/rcupdate.h>
57 #include <linux/mutex.h>
58 #include <linux/jiffies.h>
59 #include <linux/rculist.h>
60 #include <linux/idr.h>
61 #include <linux/slab.h>
62 #include <linux/acpi.h>
63 #include <linux/acpi_dma.h>
64 #include <linux/of_dma.h>
65 #include <linux/mempool.h>
67 static DEFINE_MUTEX(dma_list_mutex);
68 static DEFINE_IDA(dma_ida);
69 static LIST_HEAD(dma_device_list);
70 static long dmaengine_ref_count;
72 /* --- sysfs implementation --- */
75 * dev_to_dma_chan - convert a device pointer to the its sysfs container object
78 * Must be called under dma_list_mutex
80 static struct dma_chan *dev_to_dma_chan(struct device *dev)
82 struct dma_chan_dev *chan_dev;
84 chan_dev = container_of(dev, typeof(*chan_dev), device);
85 return chan_dev->chan;
88 static ssize_t memcpy_count_show(struct device *dev,
89 struct device_attribute *attr, char *buf)
91 struct dma_chan *chan;
92 unsigned long count = 0;
96 mutex_lock(&dma_list_mutex);
97 chan = dev_to_dma_chan(dev);
99 for_each_possible_cpu(i)
100 count += per_cpu_ptr(chan->local, i)->memcpy_count;
101 err = sprintf(buf, "%lu\n", count);
104 mutex_unlock(&dma_list_mutex);
108 static DEVICE_ATTR_RO(memcpy_count);
110 static ssize_t bytes_transferred_show(struct device *dev,
111 struct device_attribute *attr, char *buf)
113 struct dma_chan *chan;
114 unsigned long count = 0;
118 mutex_lock(&dma_list_mutex);
119 chan = dev_to_dma_chan(dev);
121 for_each_possible_cpu(i)
122 count += per_cpu_ptr(chan->local, i)->bytes_transferred;
123 err = sprintf(buf, "%lu\n", count);
126 mutex_unlock(&dma_list_mutex);
130 static DEVICE_ATTR_RO(bytes_transferred);
132 static ssize_t in_use_show(struct device *dev, struct device_attribute *attr,
135 struct dma_chan *chan;
138 mutex_lock(&dma_list_mutex);
139 chan = dev_to_dma_chan(dev);
141 err = sprintf(buf, "%d\n", chan->client_count);
144 mutex_unlock(&dma_list_mutex);
148 static DEVICE_ATTR_RO(in_use);
150 static struct attribute *dma_dev_attrs[] = {
151 &dev_attr_memcpy_count.attr,
152 &dev_attr_bytes_transferred.attr,
153 &dev_attr_in_use.attr,
156 ATTRIBUTE_GROUPS(dma_dev);
158 static void chan_dev_release(struct device *dev)
160 struct dma_chan_dev *chan_dev;
162 chan_dev = container_of(dev, typeof(*chan_dev), device);
163 if (atomic_dec_and_test(chan_dev->idr_ref)) {
164 mutex_lock(&dma_list_mutex);
165 ida_remove(&dma_ida, chan_dev->dev_id);
166 mutex_unlock(&dma_list_mutex);
167 kfree(chan_dev->idr_ref);
172 static struct class dma_devclass = {
174 .dev_groups = dma_dev_groups,
175 .dev_release = chan_dev_release,
178 /* --- client and device registration --- */
180 #define dma_device_satisfies_mask(device, mask) \
181 __dma_device_satisfies_mask((device), &(mask))
183 __dma_device_satisfies_mask(struct dma_device *device,
184 const dma_cap_mask_t *want)
188 bitmap_and(has.bits, want->bits, device->cap_mask.bits,
190 return bitmap_equal(want->bits, has.bits, DMA_TX_TYPE_END);
193 static struct module *dma_chan_to_owner(struct dma_chan *chan)
195 return chan->device->dev->driver->owner;
199 * balance_ref_count - catch up the channel reference count
200 * @chan - channel to balance ->client_count versus dmaengine_ref_count
202 * balance_ref_count must be called under dma_list_mutex
204 static void balance_ref_count(struct dma_chan *chan)
206 struct module *owner = dma_chan_to_owner(chan);
208 while (chan->client_count < dmaengine_ref_count) {
210 chan->client_count++;
215 * dma_chan_get - try to grab a dma channel's parent driver module
216 * @chan - channel to grab
218 * Must be called under dma_list_mutex
220 static int dma_chan_get(struct dma_chan *chan)
222 struct module *owner = dma_chan_to_owner(chan);
225 /* The channel is already in use, update client count */
226 if (chan->client_count) {
231 if (!try_module_get(owner))
234 /* allocate upon first client reference */
235 if (chan->device->device_alloc_chan_resources) {
236 ret = chan->device->device_alloc_chan_resources(chan);
241 if (!dma_has_cap(DMA_PRIVATE, chan->device->cap_mask))
242 balance_ref_count(chan);
245 chan->client_count++;
254 * dma_chan_put - drop a reference to a dma channel's parent driver module
255 * @chan - channel to release
257 * Must be called under dma_list_mutex
259 static void dma_chan_put(struct dma_chan *chan)
261 /* This channel is not in use, bail out */
262 if (!chan->client_count)
265 chan->client_count--;
266 module_put(dma_chan_to_owner(chan));
268 /* This channel is not in use anymore, free it */
269 if (!chan->client_count && chan->device->device_free_chan_resources) {
270 /* Make sure all operations have completed */
271 dmaengine_synchronize(chan);
272 chan->device->device_free_chan_resources(chan);
275 /* If the channel is used via a DMA request router, free the mapping */
276 if (chan->router && chan->router->route_free) {
277 chan->router->route_free(chan->router->dev, chan->route_data);
279 chan->route_data = NULL;
283 enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie)
285 enum dma_status status;
286 unsigned long dma_sync_wait_timeout = jiffies + msecs_to_jiffies(5000);
288 dma_async_issue_pending(chan);
290 status = dma_async_is_tx_complete(chan, cookie, NULL, NULL);
291 if (time_after_eq(jiffies, dma_sync_wait_timeout)) {
292 dev_err(chan->device->dev, "%s: timeout!\n", __func__);
295 if (status != DMA_IN_PROGRESS)
302 EXPORT_SYMBOL(dma_sync_wait);
305 * dma_cap_mask_all - enable iteration over all operation types
307 static dma_cap_mask_t dma_cap_mask_all;
310 * dma_chan_tbl_ent - tracks channel allocations per core/operation
311 * @chan - associated channel for this entry
313 struct dma_chan_tbl_ent {
314 struct dma_chan *chan;
318 * channel_table - percpu lookup table for memory-to-memory offload providers
320 static struct dma_chan_tbl_ent __percpu *channel_table[DMA_TX_TYPE_END];
322 static int __init dma_channel_table_init(void)
324 enum dma_transaction_type cap;
327 bitmap_fill(dma_cap_mask_all.bits, DMA_TX_TYPE_END);
329 /* 'interrupt', 'private', and 'slave' are channel capabilities,
330 * but are not associated with an operation so they do not need
331 * an entry in the channel_table
333 clear_bit(DMA_INTERRUPT, dma_cap_mask_all.bits);
334 clear_bit(DMA_PRIVATE, dma_cap_mask_all.bits);
335 clear_bit(DMA_SLAVE, dma_cap_mask_all.bits);
337 for_each_dma_cap_mask(cap, dma_cap_mask_all) {
338 channel_table[cap] = alloc_percpu(struct dma_chan_tbl_ent);
339 if (!channel_table[cap]) {
346 pr_err("initialization failure\n");
347 for_each_dma_cap_mask(cap, dma_cap_mask_all)
348 free_percpu(channel_table[cap]);
353 arch_initcall(dma_channel_table_init);
356 * dma_find_channel - find a channel to carry out the operation
357 * @tx_type: transaction type
359 struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type)
361 return this_cpu_read(channel_table[tx_type]->chan);
363 EXPORT_SYMBOL(dma_find_channel);
366 * dma_issue_pending_all - flush all pending operations across all channels
368 void dma_issue_pending_all(void)
370 struct dma_device *device;
371 struct dma_chan *chan;
374 list_for_each_entry_rcu(device, &dma_device_list, global_node) {
375 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
377 list_for_each_entry(chan, &device->channels, device_node)
378 if (chan->client_count)
379 device->device_issue_pending(chan);
383 EXPORT_SYMBOL(dma_issue_pending_all);
386 * dma_chan_is_local - returns true if the channel is in the same numa-node as the cpu
388 static bool dma_chan_is_local(struct dma_chan *chan, int cpu)
390 int node = dev_to_node(chan->device->dev);
391 return node == -1 || cpumask_test_cpu(cpu, cpumask_of_node(node));
395 * min_chan - returns the channel with min count and in the same numa-node as the cpu
396 * @cap: capability to match
397 * @cpu: cpu index which the channel should be close to
399 * If some channels are close to the given cpu, the one with the lowest
400 * reference count is returned. Otherwise, cpu is ignored and only the
401 * reference count is taken into account.
402 * Must be called under dma_list_mutex.
404 static struct dma_chan *min_chan(enum dma_transaction_type cap, int cpu)
406 struct dma_device *device;
407 struct dma_chan *chan;
408 struct dma_chan *min = NULL;
409 struct dma_chan *localmin = NULL;
411 list_for_each_entry(device, &dma_device_list, global_node) {
412 if (!dma_has_cap(cap, device->cap_mask) ||
413 dma_has_cap(DMA_PRIVATE, device->cap_mask))
415 list_for_each_entry(chan, &device->channels, device_node) {
416 if (!chan->client_count)
418 if (!min || chan->table_count < min->table_count)
421 if (dma_chan_is_local(chan, cpu))
423 chan->table_count < localmin->table_count)
428 chan = localmin ? localmin : min;
437 * dma_channel_rebalance - redistribute the available channels
439 * Optimize for cpu isolation (each cpu gets a dedicated channel for an
440 * operation type) in the SMP case, and operation isolation (avoid
441 * multi-tasking channels) in the non-SMP case. Must be called under
444 static void dma_channel_rebalance(void)
446 struct dma_chan *chan;
447 struct dma_device *device;
451 /* undo the last distribution */
452 for_each_dma_cap_mask(cap, dma_cap_mask_all)
453 for_each_possible_cpu(cpu)
454 per_cpu_ptr(channel_table[cap], cpu)->chan = NULL;
456 list_for_each_entry(device, &dma_device_list, global_node) {
457 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
459 list_for_each_entry(chan, &device->channels, device_node)
460 chan->table_count = 0;
463 /* don't populate the channel_table if no clients are available */
464 if (!dmaengine_ref_count)
467 /* redistribute available channels */
468 for_each_dma_cap_mask(cap, dma_cap_mask_all)
469 for_each_online_cpu(cpu) {
470 chan = min_chan(cap, cpu);
471 per_cpu_ptr(channel_table[cap], cpu)->chan = chan;
475 int dma_get_slave_caps(struct dma_chan *chan, struct dma_slave_caps *caps)
477 struct dma_device *device;
482 device = chan->device;
484 /* check if the channel supports slave transactions */
485 if (!(test_bit(DMA_SLAVE, device->cap_mask.bits) ||
486 test_bit(DMA_CYCLIC, device->cap_mask.bits)))
490 * Check whether it reports it uses the generic slave
491 * capabilities, if not, that means it doesn't support any
492 * kind of slave capabilities reporting.
494 if (!device->directions)
497 caps->src_addr_widths = device->src_addr_widths;
498 caps->dst_addr_widths = device->dst_addr_widths;
499 caps->directions = device->directions;
500 caps->max_burst = device->max_burst;
501 caps->residue_granularity = device->residue_granularity;
502 caps->descriptor_reuse = device->descriptor_reuse;
505 * Some devices implement only pause (e.g. to get residuum) but no
506 * resume. However cmd_pause is advertised as pause AND resume.
508 caps->cmd_pause = !!(device->device_pause && device->device_resume);
509 caps->cmd_terminate = !!device->device_terminate_all;
513 EXPORT_SYMBOL_GPL(dma_get_slave_caps);
515 static struct dma_chan *private_candidate(const dma_cap_mask_t *mask,
516 struct dma_device *dev,
517 dma_filter_fn fn, void *fn_param)
519 struct dma_chan *chan;
521 if (mask && !__dma_device_satisfies_mask(dev, mask)) {
522 dev_dbg(dev->dev, "%s: wrong capabilities\n", __func__);
525 /* devices with multiple channels need special handling as we need to
526 * ensure that all channels are either private or public.
528 if (dev->chancnt > 1 && !dma_has_cap(DMA_PRIVATE, dev->cap_mask))
529 list_for_each_entry(chan, &dev->channels, device_node) {
530 /* some channels are already publicly allocated */
531 if (chan->client_count)
535 list_for_each_entry(chan, &dev->channels, device_node) {
536 if (chan->client_count) {
537 dev_dbg(dev->dev, "%s: %s busy\n",
538 __func__, dma_chan_name(chan));
541 if (fn && !fn(chan, fn_param)) {
542 dev_dbg(dev->dev, "%s: %s filter said false\n",
543 __func__, dma_chan_name(chan));
552 static struct dma_chan *find_candidate(struct dma_device *device,
553 const dma_cap_mask_t *mask,
554 dma_filter_fn fn, void *fn_param)
556 struct dma_chan *chan = private_candidate(mask, device, fn, fn_param);
560 /* Found a suitable channel, try to grab, prep, and return it.
561 * We first set DMA_PRIVATE to disable balance_ref_count as this
562 * channel will not be published in the general-purpose
565 dma_cap_set(DMA_PRIVATE, device->cap_mask);
566 device->privatecnt++;
567 err = dma_chan_get(chan);
570 if (err == -ENODEV) {
571 dev_dbg(device->dev, "%s: %s module removed\n",
572 __func__, dma_chan_name(chan));
573 list_del_rcu(&device->global_node);
576 "%s: failed to get %s: (%d)\n",
577 __func__, dma_chan_name(chan), err);
579 if (--device->privatecnt == 0)
580 dma_cap_clear(DMA_PRIVATE, device->cap_mask);
586 return chan ? chan : ERR_PTR(-EPROBE_DEFER);
590 * dma_get_slave_channel - try to get specific channel exclusively
591 * @chan: target channel
593 struct dma_chan *dma_get_slave_channel(struct dma_chan *chan)
597 /* lock against __dma_request_channel */
598 mutex_lock(&dma_list_mutex);
600 if (chan->client_count == 0) {
601 struct dma_device *device = chan->device;
603 dma_cap_set(DMA_PRIVATE, device->cap_mask);
604 device->privatecnt++;
605 err = dma_chan_get(chan);
607 dev_dbg(chan->device->dev,
608 "%s: failed to get %s: (%d)\n",
609 __func__, dma_chan_name(chan), err);
611 if (--device->privatecnt == 0)
612 dma_cap_clear(DMA_PRIVATE, device->cap_mask);
617 mutex_unlock(&dma_list_mutex);
622 EXPORT_SYMBOL_GPL(dma_get_slave_channel);
624 struct dma_chan *dma_get_any_slave_channel(struct dma_device *device)
627 struct dma_chan *chan;
630 dma_cap_set(DMA_SLAVE, mask);
632 /* lock against __dma_request_channel */
633 mutex_lock(&dma_list_mutex);
635 chan = find_candidate(device, &mask, NULL, NULL);
637 mutex_unlock(&dma_list_mutex);
639 return IS_ERR(chan) ? NULL : chan;
641 EXPORT_SYMBOL_GPL(dma_get_any_slave_channel);
644 * __dma_request_channel - try to allocate an exclusive channel
645 * @mask: capabilities that the channel must satisfy
646 * @fn: optional callback to disposition available channels
647 * @fn_param: opaque parameter to pass to dma_filter_fn
649 * Returns pointer to appropriate DMA channel on success or NULL.
651 struct dma_chan *__dma_request_channel(const dma_cap_mask_t *mask,
652 dma_filter_fn fn, void *fn_param)
654 struct dma_device *device, *_d;
655 struct dma_chan *chan = NULL;
658 mutex_lock(&dma_list_mutex);
659 list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
660 chan = find_candidate(device, mask, fn, fn_param);
666 mutex_unlock(&dma_list_mutex);
668 pr_debug("%s: %s (%s)\n",
670 chan ? "success" : "fail",
671 chan ? dma_chan_name(chan) : NULL);
675 EXPORT_SYMBOL_GPL(__dma_request_channel);
677 static const struct dma_slave_map *dma_filter_match(struct dma_device *device,
683 if (!device->filter.mapcnt)
686 for (i = 0; i < device->filter.mapcnt; i++) {
687 const struct dma_slave_map *map = &device->filter.map[i];
689 if (!strcmp(map->devname, dev_name(dev)) &&
690 !strcmp(map->slave, name))
698 * dma_request_chan - try to allocate an exclusive slave channel
699 * @dev: pointer to client device structure
700 * @name: slave channel name
702 * Returns pointer to appropriate DMA channel on success or an error pointer.
704 struct dma_chan *dma_request_chan(struct device *dev, const char *name)
706 struct dma_device *d, *_d;
707 struct dma_chan *chan = NULL;
709 /* If device-tree is present get slave info from here */
711 chan = of_dma_request_slave_channel(dev->of_node, name);
713 /* If device was enumerated by ACPI get slave info from here */
714 if (has_acpi_companion(dev) && !chan)
715 chan = acpi_dma_request_slave_chan_by_name(dev, name);
718 /* Valid channel found or requester need to be deferred */
719 if (!IS_ERR(chan) || PTR_ERR(chan) == -EPROBE_DEFER)
723 /* Try to find the channel via the DMA filter map(s) */
724 mutex_lock(&dma_list_mutex);
725 list_for_each_entry_safe(d, _d, &dma_device_list, global_node) {
727 const struct dma_slave_map *map = dma_filter_match(d, name, dev);
733 dma_cap_set(DMA_SLAVE, mask);
735 chan = find_candidate(d, &mask, d->filter.fn, map->param);
739 mutex_unlock(&dma_list_mutex);
741 return chan ? chan : ERR_PTR(-EPROBE_DEFER);
743 EXPORT_SYMBOL_GPL(dma_request_chan);
746 * dma_request_slave_channel - try to allocate an exclusive slave channel
747 * @dev: pointer to client device structure
748 * @name: slave channel name
750 * Returns pointer to appropriate DMA channel on success or NULL.
752 struct dma_chan *dma_request_slave_channel(struct device *dev,
755 struct dma_chan *ch = dma_request_chan(dev, name);
761 EXPORT_SYMBOL_GPL(dma_request_slave_channel);
764 * dma_request_chan_by_mask - allocate a channel satisfying certain capabilities
765 * @mask: capabilities that the channel must satisfy
767 * Returns pointer to appropriate DMA channel on success or an error pointer.
769 struct dma_chan *dma_request_chan_by_mask(const dma_cap_mask_t *mask)
771 struct dma_chan *chan;
774 return ERR_PTR(-ENODEV);
776 chan = __dma_request_channel(mask, NULL, NULL);
778 chan = ERR_PTR(-ENODEV);
782 EXPORT_SYMBOL_GPL(dma_request_chan_by_mask);
784 void dma_release_channel(struct dma_chan *chan)
786 mutex_lock(&dma_list_mutex);
787 WARN_ONCE(chan->client_count != 1,
788 "chan reference count %d != 1\n", chan->client_count);
790 /* drop PRIVATE cap enabled by __dma_request_channel() */
791 if (--chan->device->privatecnt == 0)
792 dma_cap_clear(DMA_PRIVATE, chan->device->cap_mask);
793 mutex_unlock(&dma_list_mutex);
795 EXPORT_SYMBOL_GPL(dma_release_channel);
798 * dmaengine_get - register interest in dma_channels
800 void dmaengine_get(void)
802 struct dma_device *device, *_d;
803 struct dma_chan *chan;
806 mutex_lock(&dma_list_mutex);
807 dmaengine_ref_count++;
809 /* try to grab channels */
810 list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
811 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
813 list_for_each_entry(chan, &device->channels, device_node) {
814 err = dma_chan_get(chan);
815 if (err == -ENODEV) {
816 /* module removed before we could use it */
817 list_del_rcu(&device->global_node);
820 dev_dbg(chan->device->dev,
821 "%s: failed to get %s: (%d)\n",
822 __func__, dma_chan_name(chan), err);
826 /* if this is the first reference and there were channels
827 * waiting we need to rebalance to get those channels
828 * incorporated into the channel table
830 if (dmaengine_ref_count == 1)
831 dma_channel_rebalance();
832 mutex_unlock(&dma_list_mutex);
834 EXPORT_SYMBOL(dmaengine_get);
837 * dmaengine_put - let dma drivers be removed when ref_count == 0
839 void dmaengine_put(void)
841 struct dma_device *device;
842 struct dma_chan *chan;
844 mutex_lock(&dma_list_mutex);
845 dmaengine_ref_count--;
846 BUG_ON(dmaengine_ref_count < 0);
847 /* drop channel references */
848 list_for_each_entry(device, &dma_device_list, global_node) {
849 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
851 list_for_each_entry(chan, &device->channels, device_node)
854 mutex_unlock(&dma_list_mutex);
856 EXPORT_SYMBOL(dmaengine_put);
858 static bool device_has_all_tx_types(struct dma_device *device)
860 /* A device that satisfies this test has channels that will never cause
861 * an async_tx channel switch event as all possible operation types can
864 #ifdef CONFIG_ASYNC_TX_DMA
865 if (!dma_has_cap(DMA_INTERRUPT, device->cap_mask))
869 #if IS_ENABLED(CONFIG_ASYNC_MEMCPY)
870 if (!dma_has_cap(DMA_MEMCPY, device->cap_mask))
874 #if IS_ENABLED(CONFIG_ASYNC_XOR)
875 if (!dma_has_cap(DMA_XOR, device->cap_mask))
878 #ifndef CONFIG_ASYNC_TX_DISABLE_XOR_VAL_DMA
879 if (!dma_has_cap(DMA_XOR_VAL, device->cap_mask))
884 #if IS_ENABLED(CONFIG_ASYNC_PQ)
885 if (!dma_has_cap(DMA_PQ, device->cap_mask))
888 #ifndef CONFIG_ASYNC_TX_DISABLE_PQ_VAL_DMA
889 if (!dma_has_cap(DMA_PQ_VAL, device->cap_mask))
897 static int get_dma_id(struct dma_device *device)
902 if (!ida_pre_get(&dma_ida, GFP_KERNEL))
904 mutex_lock(&dma_list_mutex);
905 rc = ida_get_new(&dma_ida, &device->dev_id);
906 mutex_unlock(&dma_list_mutex);
907 } while (rc == -EAGAIN);
913 * dma_async_device_register - registers DMA devices found
914 * @device: &dma_device
916 int dma_async_device_register(struct dma_device *device)
919 struct dma_chan* chan;
925 /* validate device routines */
927 pr_err("DMAdevice must have dev\n");
931 if (dma_has_cap(DMA_MEMCPY, device->cap_mask) && !device->device_prep_dma_memcpy) {
933 "Device claims capability %s, but op is not defined\n",
938 if (dma_has_cap(DMA_XOR, device->cap_mask) && !device->device_prep_dma_xor) {
940 "Device claims capability %s, but op is not defined\n",
945 if (dma_has_cap(DMA_XOR_VAL, device->cap_mask) && !device->device_prep_dma_xor_val) {
947 "Device claims capability %s, but op is not defined\n",
952 if (dma_has_cap(DMA_PQ, device->cap_mask) && !device->device_prep_dma_pq) {
954 "Device claims capability %s, but op is not defined\n",
959 if (dma_has_cap(DMA_PQ_VAL, device->cap_mask) && !device->device_prep_dma_pq_val) {
961 "Device claims capability %s, but op is not defined\n",
966 if (dma_has_cap(DMA_MEMSET, device->cap_mask) && !device->device_prep_dma_memset) {
968 "Device claims capability %s, but op is not defined\n",
973 if (dma_has_cap(DMA_INTERRUPT, device->cap_mask) && !device->device_prep_dma_interrupt) {
975 "Device claims capability %s, but op is not defined\n",
980 if (dma_has_cap(DMA_CYCLIC, device->cap_mask) && !device->device_prep_dma_cyclic) {
982 "Device claims capability %s, but op is not defined\n",
987 if (dma_has_cap(DMA_INTERLEAVE, device->cap_mask) && !device->device_prep_interleaved_dma) {
989 "Device claims capability %s, but op is not defined\n",
995 if (!device->device_tx_status) {
996 dev_err(device->dev, "Device tx_status is not defined\n");
1001 if (!device->device_issue_pending) {
1002 dev_err(device->dev, "Device issue_pending is not defined\n");
1006 /* note: this only matters in the
1007 * CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH=n case
1009 if (device_has_all_tx_types(device))
1010 dma_cap_set(DMA_ASYNC_TX, device->cap_mask);
1012 idr_ref = kmalloc(sizeof(*idr_ref), GFP_KERNEL);
1015 rc = get_dma_id(device);
1021 atomic_set(idr_ref, 0);
1023 /* represent channels in sysfs. Probably want devs too */
1024 list_for_each_entry(chan, &device->channels, device_node) {
1026 chan->local = alloc_percpu(typeof(*chan->local));
1027 if (chan->local == NULL)
1029 chan->dev = kzalloc(sizeof(*chan->dev), GFP_KERNEL);
1030 if (chan->dev == NULL) {
1031 free_percpu(chan->local);
1036 chan->chan_id = chancnt++;
1037 chan->dev->device.class = &dma_devclass;
1038 chan->dev->device.parent = device->dev;
1039 chan->dev->chan = chan;
1040 chan->dev->idr_ref = idr_ref;
1041 chan->dev->dev_id = device->dev_id;
1042 atomic_inc(idr_ref);
1043 dev_set_name(&chan->dev->device, "dma%dchan%d",
1044 device->dev_id, chan->chan_id);
1046 rc = device_register(&chan->dev->device);
1048 free_percpu(chan->local);
1051 atomic_dec(idr_ref);
1054 chan->client_count = 0;
1058 dev_err(device->dev, "%s: device has no channels!\n", __func__);
1063 device->chancnt = chancnt;
1065 mutex_lock(&dma_list_mutex);
1066 /* take references on public channels */
1067 if (dmaengine_ref_count && !dma_has_cap(DMA_PRIVATE, device->cap_mask))
1068 list_for_each_entry(chan, &device->channels, device_node) {
1069 /* if clients are already waiting for channels we need
1070 * to take references on their behalf
1072 if (dma_chan_get(chan) == -ENODEV) {
1073 /* note we can only get here for the first
1074 * channel as the remaining channels are
1075 * guaranteed to get a reference
1078 mutex_unlock(&dma_list_mutex);
1082 list_add_tail_rcu(&device->global_node, &dma_device_list);
1083 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
1084 device->privatecnt++; /* Always private */
1085 dma_channel_rebalance();
1086 mutex_unlock(&dma_list_mutex);
1091 /* if we never registered a channel just release the idr */
1092 if (atomic_read(idr_ref) == 0) {
1093 mutex_lock(&dma_list_mutex);
1094 ida_remove(&dma_ida, device->dev_id);
1095 mutex_unlock(&dma_list_mutex);
1100 list_for_each_entry(chan, &device->channels, device_node) {
1101 if (chan->local == NULL)
1103 mutex_lock(&dma_list_mutex);
1104 chan->dev->chan = NULL;
1105 mutex_unlock(&dma_list_mutex);
1106 device_unregister(&chan->dev->device);
1107 free_percpu(chan->local);
1111 EXPORT_SYMBOL(dma_async_device_register);
1114 * dma_async_device_unregister - unregister a DMA device
1115 * @device: &dma_device
1117 * This routine is called by dma driver exit routines, dmaengine holds module
1118 * references to prevent it being called while channels are in use.
1120 void dma_async_device_unregister(struct dma_device *device)
1122 struct dma_chan *chan;
1124 mutex_lock(&dma_list_mutex);
1125 list_del_rcu(&device->global_node);
1126 dma_channel_rebalance();
1127 mutex_unlock(&dma_list_mutex);
1129 list_for_each_entry(chan, &device->channels, device_node) {
1130 WARN_ONCE(chan->client_count,
1131 "%s called while %d clients hold a reference\n",
1132 __func__, chan->client_count);
1133 mutex_lock(&dma_list_mutex);
1134 chan->dev->chan = NULL;
1135 mutex_unlock(&dma_list_mutex);
1136 device_unregister(&chan->dev->device);
1137 free_percpu(chan->local);
1140 EXPORT_SYMBOL(dma_async_device_unregister);
1142 struct dmaengine_unmap_pool {
1143 struct kmem_cache *cache;
1149 #define __UNMAP_POOL(x) { .size = x, .name = "dmaengine-unmap-" __stringify(x) }
1150 static struct dmaengine_unmap_pool unmap_pool[] = {
1152 #if IS_ENABLED(CONFIG_DMA_ENGINE_RAID)
1159 static struct dmaengine_unmap_pool *__get_unmap_pool(int nr)
1161 int order = get_count_order(nr);
1165 return &unmap_pool[0];
1166 #if IS_ENABLED(CONFIG_DMA_ENGINE_RAID)
1168 return &unmap_pool[1];
1170 return &unmap_pool[2];
1172 return &unmap_pool[3];
1180 static void dmaengine_unmap(struct kref *kref)
1182 struct dmaengine_unmap_data *unmap = container_of(kref, typeof(*unmap), kref);
1183 struct device *dev = unmap->dev;
1186 cnt = unmap->to_cnt;
1187 for (i = 0; i < cnt; i++)
1188 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1190 cnt += unmap->from_cnt;
1191 for (; i < cnt; i++)
1192 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1194 cnt += unmap->bidi_cnt;
1195 for (; i < cnt; i++) {
1196 if (unmap->addr[i] == 0)
1198 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1201 cnt = unmap->map_cnt;
1202 mempool_free(unmap, __get_unmap_pool(cnt)->pool);
1205 void dmaengine_unmap_put(struct dmaengine_unmap_data *unmap)
1208 kref_put(&unmap->kref, dmaengine_unmap);
1210 EXPORT_SYMBOL_GPL(dmaengine_unmap_put);
1212 static void dmaengine_destroy_unmap_pool(void)
1216 for (i = 0; i < ARRAY_SIZE(unmap_pool); i++) {
1217 struct dmaengine_unmap_pool *p = &unmap_pool[i];
1219 mempool_destroy(p->pool);
1221 kmem_cache_destroy(p->cache);
1226 static int __init dmaengine_init_unmap_pool(void)
1230 for (i = 0; i < ARRAY_SIZE(unmap_pool); i++) {
1231 struct dmaengine_unmap_pool *p = &unmap_pool[i];
1234 size = sizeof(struct dmaengine_unmap_data) +
1235 sizeof(dma_addr_t) * p->size;
1237 p->cache = kmem_cache_create(p->name, size, 0,
1238 SLAB_HWCACHE_ALIGN, NULL);
1241 p->pool = mempool_create_slab_pool(1, p->cache);
1246 if (i == ARRAY_SIZE(unmap_pool))
1249 dmaengine_destroy_unmap_pool();
1253 struct dmaengine_unmap_data *
1254 dmaengine_get_unmap_data(struct device *dev, int nr, gfp_t flags)
1256 struct dmaengine_unmap_data *unmap;
1258 unmap = mempool_alloc(__get_unmap_pool(nr)->pool, flags);
1262 memset(unmap, 0, sizeof(*unmap));
1263 kref_init(&unmap->kref);
1265 unmap->map_cnt = nr;
1269 EXPORT_SYMBOL(dmaengine_get_unmap_data);
1271 void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx,
1272 struct dma_chan *chan)
1275 #ifdef CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH
1276 spin_lock_init(&tx->lock);
1279 EXPORT_SYMBOL(dma_async_tx_descriptor_init);
1281 /* dma_wait_for_async_tx - spin wait for a transaction to complete
1282 * @tx: in-flight transaction to wait on
1285 dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx)
1287 unsigned long dma_sync_wait_timeout = jiffies + msecs_to_jiffies(5000);
1290 return DMA_COMPLETE;
1292 while (tx->cookie == -EBUSY) {
1293 if (time_after_eq(jiffies, dma_sync_wait_timeout)) {
1294 dev_err(tx->chan->device->dev,
1295 "%s timeout waiting for descriptor submission\n",
1301 return dma_sync_wait(tx->chan, tx->cookie);
1303 EXPORT_SYMBOL_GPL(dma_wait_for_async_tx);
1305 /* dma_run_dependencies - helper routine for dma drivers to process
1306 * (start) dependent operations on their target channel
1307 * @tx: transaction with dependencies
1309 void dma_run_dependencies(struct dma_async_tx_descriptor *tx)
1311 struct dma_async_tx_descriptor *dep = txd_next(tx);
1312 struct dma_async_tx_descriptor *dep_next;
1313 struct dma_chan *chan;
1318 /* we'll submit tx->next now, so clear the link */
1322 /* keep submitting up until a channel switch is detected
1323 * in that case we will be called again as a result of
1324 * processing the interrupt from async_tx_channel_switch
1326 for (; dep; dep = dep_next) {
1328 txd_clear_parent(dep);
1329 dep_next = txd_next(dep);
1330 if (dep_next && dep_next->chan == chan)
1331 txd_clear_next(dep); /* ->next will be submitted */
1333 dep_next = NULL; /* submit current dep and terminate */
1336 dep->tx_submit(dep);
1339 chan->device->device_issue_pending(chan);
1341 EXPORT_SYMBOL_GPL(dma_run_dependencies);
1343 static int __init dma_bus_init(void)
1345 int err = dmaengine_init_unmap_pool();
1349 return class_register(&dma_devclass);
1351 arch_initcall(dma_bus_init);