1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Copyright(c) 2004 - 2006 Intel Corporation. All rights reserved.
4 */
5
6 /*
7 * This code implements the DMA subsystem. It provides a HW-neutral interface
8 * for other kernel code to use asynchronous memory copy capabilities,
9 * if present, and allows different HW DMA drivers to register as providing
10 * this capability.
11 *
12 * Due to the fact we are accelerating what is already a relatively fast
13 * operation, the code goes to great lengths to avoid additional overhead,
14 * such as locking.
15 *
16 * LOCKING:
17 *
18 * The subsystem keeps a global list of dma_device structs it is protected by a
19 * mutex, dma_list_mutex.
20 *
21 * A subsystem can get access to a channel by calling dmaengine_get() followed
22 * by dma_find_channel(), or if it has need for an exclusive channel it can call
23 * dma_request_channel(). Once a channel is allocated a reference is taken
24 * against its corresponding driver to disable removal.
25 *
26 * Each device has a channels list, which runs unlocked but is never modified
27 * once the device is registered, it's just setup by the driver.
28 *
29 * See Documentation/driver-api/dmaengine for more details
30 */
31
32 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
33
34 #include <linux/acpi.h>
35 #include <linux/acpi_dma.h>
36 #include <linux/device.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/dmaengine.h>
39 #include <linux/hardirq.h>
40 #include <linux/idr.h>
41 #include <linux/init.h>
42 #include <linux/jiffies.h>
43 #include <linux/mempool.h>
44 #include <linux/mm.h>
45 #include <linux/module.h>
46 #include <linux/mutex.h>
47 #include <linux/numa.h>
48 #include <linux/of.h>
49 #include <linux/of_dma.h>
50 #include <linux/percpu.h>
51 #include <linux/platform_device.h>
52 #include <linux/property.h>
53 #include <linux/rculist.h>
54 #include <linux/rcupdate.h>
55 #include <linux/slab.h>
56 #include <linux/spinlock.h>
57
58 #include "dmaengine.h"
59
60 static DEFINE_MUTEX(dma_list_mutex);
61 static DEFINE_IDA(dma_ida);
62 static LIST_HEAD(dma_device_list);
63 static long dmaengine_ref_count;
64
65 /* --- debugfs implementation --- */
66 #ifdef CONFIG_DEBUG_FS
67 #include <linux/debugfs.h>
68
69 static struct dentry *rootdir;
70
dmaengine_debug_register(struct dma_device * dma_dev)71 static void dmaengine_debug_register(struct dma_device *dma_dev)
72 {
73 dma_dev->dbg_dev_root = debugfs_create_dir(dev_name(dma_dev->dev),
74 rootdir);
75 if (IS_ERR(dma_dev->dbg_dev_root))
76 dma_dev->dbg_dev_root = NULL;
77 }
78
dmaengine_debug_unregister(struct dma_device * dma_dev)79 static void dmaengine_debug_unregister(struct dma_device *dma_dev)
80 {
81 debugfs_remove_recursive(dma_dev->dbg_dev_root);
82 dma_dev->dbg_dev_root = NULL;
83 }
84
dmaengine_dbg_summary_show(struct seq_file * s,struct dma_device * dma_dev)85 static void dmaengine_dbg_summary_show(struct seq_file *s,
86 struct dma_device *dma_dev)
87 {
88 struct dma_chan *chan;
89
90 list_for_each_entry(chan, &dma_dev->channels, device_node) {
91 if (chan->client_count) {
92 seq_printf(s, " %-13s| %s", dma_chan_name(chan),
93 chan->dbg_client_name ?: "in-use");
94
95 if (chan->router)
96 seq_printf(s, " (via router: %s)\n",
97 dev_name(chan->router->dev));
98 else
99 seq_puts(s, "\n");
100 }
101 }
102 }
103
dmaengine_summary_show(struct seq_file * s,void * data)104 static int dmaengine_summary_show(struct seq_file *s, void *data)
105 {
106 struct dma_device *dma_dev = NULL;
107
108 mutex_lock(&dma_list_mutex);
109 list_for_each_entry(dma_dev, &dma_device_list, global_node) {
110 seq_printf(s, "dma%d (%s): number of channels: %u\n",
111 dma_dev->dev_id, dev_name(dma_dev->dev),
112 dma_dev->chancnt);
113
114 if (dma_dev->dbg_summary_show)
115 dma_dev->dbg_summary_show(s, dma_dev);
116 else
117 dmaengine_dbg_summary_show(s, dma_dev);
118
119 if (!list_is_last(&dma_dev->global_node, &dma_device_list))
120 seq_puts(s, "\n");
121 }
122 mutex_unlock(&dma_list_mutex);
123
124 return 0;
125 }
126 DEFINE_SHOW_ATTRIBUTE(dmaengine_summary);
127
dmaengine_debugfs_init(void)128 static void __init dmaengine_debugfs_init(void)
129 {
130 rootdir = debugfs_create_dir("dmaengine", NULL);
131
132 /* /sys/kernel/debug/dmaengine/summary */
133 debugfs_create_file("summary", 0444, rootdir, NULL,
134 &dmaengine_summary_fops);
135 }
136 #else
dmaengine_debugfs_init(void)137 static inline void dmaengine_debugfs_init(void) { }
dmaengine_debug_register(struct dma_device * dma_dev)138 static inline int dmaengine_debug_register(struct dma_device *dma_dev)
139 {
140 return 0;
141 }
142
dmaengine_debug_unregister(struct dma_device * dma_dev)143 static inline void dmaengine_debug_unregister(struct dma_device *dma_dev) { }
144 #endif /* DEBUG_FS */
145
146 /* --- sysfs implementation --- */
147
148 #define DMA_SLAVE_NAME "slave"
149
150 /**
151 * dev_to_dma_chan - convert a device pointer to its sysfs container object
152 * @dev: device node
153 *
154 * Must be called under dma_list_mutex.
155 */
dev_to_dma_chan(struct device * dev)156 static struct dma_chan *dev_to_dma_chan(struct device *dev)
157 {
158 struct dma_chan_dev *chan_dev;
159
160 chan_dev = container_of(dev, typeof(*chan_dev), device);
161 return chan_dev->chan;
162 }
163
memcpy_count_show(struct device * dev,struct device_attribute * attr,char * buf)164 static ssize_t memcpy_count_show(struct device *dev,
165 struct device_attribute *attr, char *buf)
166 {
167 struct dma_chan *chan;
168 unsigned long count = 0;
169 int i;
170 int err;
171
172 mutex_lock(&dma_list_mutex);
173 chan = dev_to_dma_chan(dev);
174 if (chan) {
175 for_each_possible_cpu(i)
176 count += per_cpu_ptr(chan->local, i)->memcpy_count;
177 err = sysfs_emit(buf, "%lu\n", count);
178 } else
179 err = -ENODEV;
180 mutex_unlock(&dma_list_mutex);
181
182 return err;
183 }
184 static DEVICE_ATTR_RO(memcpy_count);
185
bytes_transferred_show(struct device * dev,struct device_attribute * attr,char * buf)186 static ssize_t bytes_transferred_show(struct device *dev,
187 struct device_attribute *attr, char *buf)
188 {
189 struct dma_chan *chan;
190 unsigned long count = 0;
191 int i;
192 int err;
193
194 mutex_lock(&dma_list_mutex);
195 chan = dev_to_dma_chan(dev);
196 if (chan) {
197 for_each_possible_cpu(i)
198 count += per_cpu_ptr(chan->local, i)->bytes_transferred;
199 err = sysfs_emit(buf, "%lu\n", count);
200 } else
201 err = -ENODEV;
202 mutex_unlock(&dma_list_mutex);
203
204 return err;
205 }
206 static DEVICE_ATTR_RO(bytes_transferred);
207
in_use_show(struct device * dev,struct device_attribute * attr,char * buf)208 static ssize_t in_use_show(struct device *dev, struct device_attribute *attr,
209 char *buf)
210 {
211 struct dma_chan *chan;
212 int err;
213
214 mutex_lock(&dma_list_mutex);
215 chan = dev_to_dma_chan(dev);
216 if (chan)
217 err = sysfs_emit(buf, "%d\n", chan->client_count);
218 else
219 err = -ENODEV;
220 mutex_unlock(&dma_list_mutex);
221
222 return err;
223 }
224 static DEVICE_ATTR_RO(in_use);
225
226 static struct attribute *dma_dev_attrs[] = {
227 &dev_attr_memcpy_count.attr,
228 &dev_attr_bytes_transferred.attr,
229 &dev_attr_in_use.attr,
230 NULL,
231 };
232 ATTRIBUTE_GROUPS(dma_dev);
233
chan_dev_release(struct device * dev)234 static void chan_dev_release(struct device *dev)
235 {
236 struct dma_chan_dev *chan_dev;
237
238 chan_dev = container_of(dev, typeof(*chan_dev), device);
239 kfree(chan_dev);
240 }
241
242 static struct class dma_devclass = {
243 .name = "dma",
244 .dev_groups = dma_dev_groups,
245 .dev_release = chan_dev_release,
246 };
247
248 /* --- client and device registration --- */
249
250 /* enable iteration over all operation types */
251 static dma_cap_mask_t dma_cap_mask_all;
252
253 /**
254 * struct dma_chan_tbl_ent - tracks channel allocations per core/operation
255 * @chan: associated channel for this entry
256 */
257 struct dma_chan_tbl_ent {
258 struct dma_chan *chan;
259 };
260
261 /* percpu lookup table for memory-to-memory offload providers */
262 static struct dma_chan_tbl_ent __percpu *channel_table[DMA_TX_TYPE_END];
263
dma_channel_table_init(void)264 static int __init dma_channel_table_init(void)
265 {
266 enum dma_transaction_type cap;
267 int err = 0;
268
269 bitmap_fill(dma_cap_mask_all.bits, DMA_TX_TYPE_END);
270
271 /* 'interrupt', 'private', and 'slave' are channel capabilities,
272 * but are not associated with an operation so they do not need
273 * an entry in the channel_table
274 */
275 clear_bit(DMA_INTERRUPT, dma_cap_mask_all.bits);
276 clear_bit(DMA_PRIVATE, dma_cap_mask_all.bits);
277 clear_bit(DMA_SLAVE, dma_cap_mask_all.bits);
278
279 for_each_dma_cap_mask(cap, dma_cap_mask_all) {
280 channel_table[cap] = alloc_percpu(struct dma_chan_tbl_ent);
281 if (!channel_table[cap]) {
282 err = -ENOMEM;
283 break;
284 }
285 }
286
287 if (err) {
288 pr_err("dmaengine dma_channel_table_init failure: %d\n", err);
289 for_each_dma_cap_mask(cap, dma_cap_mask_all)
290 free_percpu(channel_table[cap]);
291 }
292
293 return err;
294 }
295 arch_initcall(dma_channel_table_init);
296
297 /**
298 * dma_chan_is_local - checks if the channel is in the same NUMA-node as the CPU
299 * @chan: DMA channel to test
300 * @cpu: CPU index which the channel should be close to
301 *
302 * Returns true if the channel is in the same NUMA-node as the CPU.
303 */
dma_chan_is_local(struct dma_chan * chan,int cpu)304 static bool dma_chan_is_local(struct dma_chan *chan, int cpu)
305 {
306 int node = dev_to_node(chan->device->dev);
307 return node == NUMA_NO_NODE ||
308 cpumask_test_cpu(cpu, cpumask_of_node(node));
309 }
310
311 /**
312 * min_chan - finds the channel with min count and in the same NUMA-node as the CPU
313 * @cap: capability to match
314 * @cpu: CPU index which the channel should be close to
315 *
316 * If some channels are close to the given CPU, the one with the lowest
317 * reference count is returned. Otherwise, CPU is ignored and only the
318 * reference count is taken into account.
319 *
320 * Must be called under dma_list_mutex.
321 */
min_chan(enum dma_transaction_type cap,int cpu)322 static struct dma_chan *min_chan(enum dma_transaction_type cap, int cpu)
323 {
324 struct dma_device *device;
325 struct dma_chan *chan;
326 struct dma_chan *min = NULL;
327 struct dma_chan *localmin = NULL;
328
329 list_for_each_entry(device, &dma_device_list, global_node) {
330 if (!dma_has_cap(cap, device->cap_mask) ||
331 dma_has_cap(DMA_PRIVATE, device->cap_mask))
332 continue;
333 list_for_each_entry(chan, &device->channels, device_node) {
334 if (!chan->client_count)
335 continue;
336 if (!min || chan->table_count < min->table_count)
337 min = chan;
338
339 if (dma_chan_is_local(chan, cpu))
340 if (!localmin ||
341 chan->table_count < localmin->table_count)
342 localmin = chan;
343 }
344 }
345
346 chan = localmin ? localmin : min;
347
348 if (chan)
349 chan->table_count++;
350
351 return chan;
352 }
353
354 /**
355 * dma_channel_rebalance - redistribute the available channels
356 *
357 * Optimize for CPU isolation (each CPU gets a dedicated channel for an
358 * operation type) in the SMP case, and operation isolation (avoid
359 * multi-tasking channels) in the non-SMP case.
360 *
361 * Must be called under dma_list_mutex.
362 */
dma_channel_rebalance(void)363 static void dma_channel_rebalance(void)
364 {
365 struct dma_chan *chan;
366 struct dma_device *device;
367 int cpu;
368 int cap;
369
370 /* undo the last distribution */
371 for_each_dma_cap_mask(cap, dma_cap_mask_all)
372 for_each_possible_cpu(cpu)
373 per_cpu_ptr(channel_table[cap], cpu)->chan = NULL;
374
375 list_for_each_entry(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 chan->table_count = 0;
380 }
381
382 /* don't populate the channel_table if no clients are available */
383 if (!dmaengine_ref_count)
384 return;
385
386 /* redistribute available channels */
387 for_each_dma_cap_mask(cap, dma_cap_mask_all)
388 for_each_online_cpu(cpu) {
389 chan = min_chan(cap, cpu);
390 per_cpu_ptr(channel_table[cap], cpu)->chan = chan;
391 }
392 }
393
dma_device_satisfies_mask(struct dma_device * device,const dma_cap_mask_t * want)394 static int dma_device_satisfies_mask(struct dma_device *device,
395 const dma_cap_mask_t *want)
396 {
397 dma_cap_mask_t has;
398
399 bitmap_and(has.bits, want->bits, device->cap_mask.bits,
400 DMA_TX_TYPE_END);
401 return bitmap_equal(want->bits, has.bits, DMA_TX_TYPE_END);
402 }
403
dma_chan_to_owner(struct dma_chan * chan)404 static struct module *dma_chan_to_owner(struct dma_chan *chan)
405 {
406 return chan->device->owner;
407 }
408
409 /**
410 * balance_ref_count - catch up the channel reference count
411 * @chan: channel to balance ->client_count versus dmaengine_ref_count
412 *
413 * Must be called under dma_list_mutex.
414 */
balance_ref_count(struct dma_chan * chan)415 static void balance_ref_count(struct dma_chan *chan)
416 {
417 struct module *owner = dma_chan_to_owner(chan);
418
419 while (chan->client_count < dmaengine_ref_count) {
420 __module_get(owner);
421 chan->client_count++;
422 }
423 }
424
dma_device_release(struct kref * ref)425 static void dma_device_release(struct kref *ref)
426 {
427 struct dma_device *device = container_of(ref, struct dma_device, ref);
428
429 list_del_rcu(&device->global_node);
430 dma_channel_rebalance();
431
432 if (device->device_release)
433 device->device_release(device);
434 }
435
dma_device_put(struct dma_device * device)436 static void dma_device_put(struct dma_device *device)
437 {
438 lockdep_assert_held(&dma_list_mutex);
439 kref_put(&device->ref, dma_device_release);
440 }
441
442 /**
443 * dma_chan_get - try to grab a DMA channel's parent driver module
444 * @chan: channel to grab
445 *
446 * Must be called under dma_list_mutex.
447 */
dma_chan_get(struct dma_chan * chan)448 static int dma_chan_get(struct dma_chan *chan)
449 {
450 struct module *owner = dma_chan_to_owner(chan);
451 int ret;
452
453 /* The channel is already in use, update client count */
454 if (chan->client_count) {
455 __module_get(owner);
456 chan->client_count++;
457 return 0;
458 }
459
460 if (!try_module_get(owner))
461 return -ENODEV;
462
463 ret = kref_get_unless_zero(&chan->device->ref);
464 if (!ret) {
465 ret = -ENODEV;
466 goto module_put_out;
467 }
468
469 /* allocate upon first client reference */
470 if (chan->device->device_alloc_chan_resources) {
471 ret = chan->device->device_alloc_chan_resources(chan);
472 if (ret < 0)
473 goto err_out;
474 }
475
476 chan->client_count++;
477
478 if (!dma_has_cap(DMA_PRIVATE, chan->device->cap_mask))
479 balance_ref_count(chan);
480
481 return 0;
482
483 err_out:
484 dma_device_put(chan->device);
485 module_put_out:
486 module_put(owner);
487 return ret;
488 }
489
490 /**
491 * dma_chan_put - drop a reference to a DMA channel's parent driver module
492 * @chan: channel to release
493 *
494 * Must be called under dma_list_mutex.
495 */
dma_chan_put(struct dma_chan * chan)496 static void dma_chan_put(struct dma_chan *chan)
497 {
498 /* This channel is not in use, bail out */
499 if (!chan->client_count)
500 return;
501
502 chan->client_count--;
503
504 /* This channel is not in use anymore, free it */
505 if (!chan->client_count && chan->device->device_free_chan_resources) {
506 /* Make sure all operations have completed */
507 dmaengine_synchronize(chan);
508 chan->device->device_free_chan_resources(chan);
509 }
510
511 /* If the channel is used via a DMA request router, free the mapping */
512 if (chan->router && chan->router->route_free) {
513 chan->router->route_free(chan->router->dev, chan->route_data);
514 chan->router = NULL;
515 chan->route_data = NULL;
516 }
517
518 dma_device_put(chan->device);
519 module_put(dma_chan_to_owner(chan));
520 }
521
dma_sync_wait(struct dma_chan * chan,dma_cookie_t cookie)522 enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie)
523 {
524 enum dma_status status;
525 unsigned long dma_sync_wait_timeout = jiffies + msecs_to_jiffies(5000);
526
527 dma_async_issue_pending(chan);
528 do {
529 status = dma_async_is_tx_complete(chan, cookie, NULL, NULL);
530 if (time_after_eq(jiffies, dma_sync_wait_timeout)) {
531 dev_err(chan->device->dev, "%s: timeout!\n", __func__);
532 return DMA_ERROR;
533 }
534 if (status != DMA_IN_PROGRESS)
535 break;
536 cpu_relax();
537 } while (1);
538
539 return status;
540 }
541 EXPORT_SYMBOL(dma_sync_wait);
542
543 /**
544 * dma_find_channel - find a channel to carry out the operation
545 * @tx_type: transaction type
546 */
dma_find_channel(enum dma_transaction_type tx_type)547 struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type)
548 {
549 return this_cpu_read(channel_table[tx_type]->chan);
550 }
551 EXPORT_SYMBOL(dma_find_channel);
552
553 /**
554 * dma_issue_pending_all - flush all pending operations across all channels
555 */
dma_issue_pending_all(void)556 void dma_issue_pending_all(void)
557 {
558 struct dma_device *device;
559 struct dma_chan *chan;
560
561 rcu_read_lock();
562 list_for_each_entry_rcu(device, &dma_device_list, global_node) {
563 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
564 continue;
565 list_for_each_entry(chan, &device->channels, device_node)
566 if (chan->client_count)
567 device->device_issue_pending(chan);
568 }
569 rcu_read_unlock();
570 }
571 EXPORT_SYMBOL(dma_issue_pending_all);
572
dma_get_slave_caps(struct dma_chan * chan,struct dma_slave_caps * caps)573 int dma_get_slave_caps(struct dma_chan *chan, struct dma_slave_caps *caps)
574 {
575 struct dma_device *device;
576
577 if (!chan || !caps)
578 return -EINVAL;
579
580 device = chan->device;
581
582 /* check if the channel supports slave transactions */
583 if (!(test_bit(DMA_SLAVE, device->cap_mask.bits) ||
584 test_bit(DMA_CYCLIC, device->cap_mask.bits)))
585 return -ENXIO;
586
587 /*
588 * Check whether it reports it uses the generic slave
589 * capabilities, if not, that means it doesn't support any
590 * kind of slave capabilities reporting.
591 */
592 if (!device->directions)
593 return -ENXIO;
594
595 caps->src_addr_widths = device->src_addr_widths;
596 caps->dst_addr_widths = device->dst_addr_widths;
597 caps->directions = device->directions;
598 caps->min_burst = device->min_burst;
599 caps->max_burst = device->max_burst;
600 caps->max_sg_burst = device->max_sg_burst;
601 caps->residue_granularity = device->residue_granularity;
602 caps->descriptor_reuse = device->descriptor_reuse;
603 caps->cmd_pause = !!device->device_pause;
604 caps->cmd_resume = !!device->device_resume;
605 caps->cmd_terminate = !!device->device_terminate_all;
606
607 /*
608 * DMA engine device might be configured with non-uniformly
609 * distributed slave capabilities per device channels. In this
610 * case the corresponding driver may provide the device_caps
611 * callback to override the generic capabilities with
612 * channel-specific ones.
613 */
614 if (device->device_caps)
615 device->device_caps(chan, caps);
616
617 return 0;
618 }
619 EXPORT_SYMBOL_GPL(dma_get_slave_caps);
620
private_candidate(const dma_cap_mask_t * mask,struct dma_device * dev,dma_filter_fn fn,void * fn_param)621 static struct dma_chan *private_candidate(const dma_cap_mask_t *mask,
622 struct dma_device *dev,
623 dma_filter_fn fn, void *fn_param)
624 {
625 struct dma_chan *chan;
626
627 if (mask && !dma_device_satisfies_mask(dev, mask)) {
628 dev_dbg(dev->dev, "%s: wrong capabilities\n", __func__);
629 return NULL;
630 }
631 /* devices with multiple channels need special handling as we need to
632 * ensure that all channels are either private or public.
633 */
634 if (dev->chancnt > 1 && !dma_has_cap(DMA_PRIVATE, dev->cap_mask))
635 list_for_each_entry(chan, &dev->channels, device_node) {
636 /* some channels are already publicly allocated */
637 if (chan->client_count)
638 return NULL;
639 }
640
641 list_for_each_entry(chan, &dev->channels, device_node) {
642 if (chan->client_count) {
643 dev_dbg(dev->dev, "%s: %s busy\n",
644 __func__, dma_chan_name(chan));
645 continue;
646 }
647 if (fn && !fn(chan, fn_param)) {
648 dev_dbg(dev->dev, "%s: %s filter said false\n",
649 __func__, dma_chan_name(chan));
650 continue;
651 }
652 return chan;
653 }
654
655 return NULL;
656 }
657
find_candidate(struct dma_device * device,const dma_cap_mask_t * mask,dma_filter_fn fn,void * fn_param)658 static struct dma_chan *find_candidate(struct dma_device *device,
659 const dma_cap_mask_t *mask,
660 dma_filter_fn fn, void *fn_param)
661 {
662 struct dma_chan *chan = private_candidate(mask, device, fn, fn_param);
663 int err;
664
665 if (chan) {
666 /* Found a suitable channel, try to grab, prep, and return it.
667 * We first set DMA_PRIVATE to disable balance_ref_count as this
668 * channel will not be published in the general-purpose
669 * allocator
670 */
671 dma_cap_set(DMA_PRIVATE, device->cap_mask);
672 device->privatecnt++;
673 err = dma_chan_get(chan);
674
675 if (err) {
676 if (err == -ENODEV) {
677 dev_dbg(device->dev, "%s: %s module removed\n",
678 __func__, dma_chan_name(chan));
679 list_del_rcu(&device->global_node);
680 } else
681 dev_dbg(device->dev,
682 "%s: failed to get %s: (%d)\n",
683 __func__, dma_chan_name(chan), err);
684
685 if (--device->privatecnt == 0)
686 dma_cap_clear(DMA_PRIVATE, device->cap_mask);
687
688 chan = ERR_PTR(err);
689 }
690 }
691
692 return chan ? chan : ERR_PTR(-EPROBE_DEFER);
693 }
694
695 /**
696 * dma_get_slave_channel - try to get specific channel exclusively
697 * @chan: target channel
698 */
dma_get_slave_channel(struct dma_chan * chan)699 struct dma_chan *dma_get_slave_channel(struct dma_chan *chan)
700 {
701 /* lock against __dma_request_channel */
702 mutex_lock(&dma_list_mutex);
703
704 if (chan->client_count == 0) {
705 struct dma_device *device = chan->device;
706 int err;
707
708 dma_cap_set(DMA_PRIVATE, device->cap_mask);
709 device->privatecnt++;
710 err = dma_chan_get(chan);
711 if (err) {
712 dev_dbg(chan->device->dev,
713 "%s: failed to get %s: (%d)\n",
714 __func__, dma_chan_name(chan), err);
715 chan = NULL;
716 if (--device->privatecnt == 0)
717 dma_cap_clear(DMA_PRIVATE, device->cap_mask);
718 }
719 } else
720 chan = NULL;
721
722 mutex_unlock(&dma_list_mutex);
723
724
725 return chan;
726 }
727 EXPORT_SYMBOL_GPL(dma_get_slave_channel);
728
dma_get_any_slave_channel(struct dma_device * device)729 struct dma_chan *dma_get_any_slave_channel(struct dma_device *device)
730 {
731 dma_cap_mask_t mask;
732 struct dma_chan *chan;
733
734 dma_cap_zero(mask);
735 dma_cap_set(DMA_SLAVE, mask);
736
737 /* lock against __dma_request_channel */
738 mutex_lock(&dma_list_mutex);
739
740 chan = find_candidate(device, &mask, NULL, NULL);
741
742 mutex_unlock(&dma_list_mutex);
743
744 return IS_ERR(chan) ? NULL : chan;
745 }
746 EXPORT_SYMBOL_GPL(dma_get_any_slave_channel);
747
748 /**
749 * __dma_request_channel - try to allocate an exclusive channel
750 * @mask: capabilities that the channel must satisfy
751 * @fn: optional callback to disposition available channels
752 * @fn_param: opaque parameter to pass to dma_filter_fn()
753 * @np: device node to look for DMA channels
754 *
755 * Returns pointer to appropriate DMA channel on success or NULL.
756 */
__dma_request_channel(const dma_cap_mask_t * mask,dma_filter_fn fn,void * fn_param,struct device_node * np)757 struct dma_chan *__dma_request_channel(const dma_cap_mask_t *mask,
758 dma_filter_fn fn, void *fn_param,
759 struct device_node *np)
760 {
761 struct dma_device *device, *_d;
762 struct dma_chan *chan = NULL;
763
764 /* Find a channel */
765 mutex_lock(&dma_list_mutex);
766 list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
767 /* Finds a DMA controller with matching device node */
768 if (np && !device_match_of_node(device->dev, np))
769 continue;
770
771 chan = find_candidate(device, mask, fn, fn_param);
772 if (!IS_ERR(chan))
773 break;
774
775 chan = NULL;
776 }
777 mutex_unlock(&dma_list_mutex);
778
779 pr_debug("%s: %s (%s)\n",
780 __func__,
781 chan ? "success" : "fail",
782 chan ? dma_chan_name(chan) : NULL);
783
784 return chan;
785 }
786 EXPORT_SYMBOL_GPL(__dma_request_channel);
787
dma_filter_match(struct dma_device * device,const char * name,struct device * dev)788 static const struct dma_slave_map *dma_filter_match(struct dma_device *device,
789 const char *name,
790 struct device *dev)
791 {
792 int i;
793
794 if (!device->filter.mapcnt)
795 return NULL;
796
797 for (i = 0; i < device->filter.mapcnt; i++) {
798 const struct dma_slave_map *map = &device->filter.map[i];
799
800 if (!strcmp(map->devname, dev_name(dev)) &&
801 !strcmp(map->slave, name))
802 return map;
803 }
804
805 return NULL;
806 }
807
808 /**
809 * dma_request_chan - try to allocate an exclusive slave channel
810 * @dev: pointer to client device structure
811 * @name: slave channel name
812 *
813 * Returns pointer to appropriate DMA channel on success or an error pointer.
814 */
dma_request_chan(struct device * dev,const char * name)815 struct dma_chan *dma_request_chan(struct device *dev, const char *name)
816 {
817 struct fwnode_handle *fwnode;
818 struct dma_device *d, *_d;
819 struct dma_chan *chan = NULL;
820
821 if (WARN_ON(!dev || !name))
822 return ERR_PTR(-EINVAL);
823
824 fwnode = dev_fwnode(dev);
825
826 if (is_of_node(fwnode))
827 chan = of_dma_request_slave_channel(to_of_node(fwnode), name);
828 else if (is_acpi_device_node(fwnode))
829 chan = acpi_dma_request_slave_chan_by_name(dev, name);
830
831 if (PTR_ERR(chan) == -EPROBE_DEFER)
832 return chan;
833
834 if (!IS_ERR_OR_NULL(chan))
835 goto found;
836
837 /* Try to find the channel via the DMA filter map(s) */
838 mutex_lock(&dma_list_mutex);
839 list_for_each_entry_safe(d, _d, &dma_device_list, global_node) {
840 dma_cap_mask_t mask;
841 const struct dma_slave_map *map = dma_filter_match(d, name, dev);
842
843 if (!map)
844 continue;
845
846 dma_cap_zero(mask);
847 dma_cap_set(DMA_SLAVE, mask);
848
849 chan = find_candidate(d, &mask, d->filter.fn, map->param);
850 if (!IS_ERR(chan))
851 break;
852 }
853 mutex_unlock(&dma_list_mutex);
854
855 if (IS_ERR(chan))
856 return chan;
857 if (!chan)
858 return ERR_PTR(-EPROBE_DEFER);
859
860 found:
861 #ifdef CONFIG_DEBUG_FS
862 chan->dbg_client_name = kasprintf(GFP_KERNEL, "%s:%s", dev_name(dev), name);
863 /* No functional issue if it fails, users are supposed to test before use */
864 #endif
865
866 chan->name = kasprintf(GFP_KERNEL, "dma:%s", name);
867 if (!chan->name)
868 return chan;
869 chan->slave = dev;
870
871 if (sysfs_create_link(&chan->dev->device.kobj, &dev->kobj,
872 DMA_SLAVE_NAME))
873 dev_warn(dev, "Cannot create DMA %s symlink\n", DMA_SLAVE_NAME);
874 if (sysfs_create_link(&dev->kobj, &chan->dev->device.kobj, chan->name))
875 dev_warn(dev, "Cannot create DMA %s symlink\n", chan->name);
876
877 return chan;
878 }
879 EXPORT_SYMBOL_GPL(dma_request_chan);
880
881 /**
882 * dma_request_chan_by_mask - allocate a channel satisfying certain capabilities
883 * @mask: capabilities that the channel must satisfy
884 *
885 * Returns pointer to appropriate DMA channel on success or an error pointer.
886 */
dma_request_chan_by_mask(const dma_cap_mask_t * mask)887 struct dma_chan *dma_request_chan_by_mask(const dma_cap_mask_t *mask)
888 {
889 struct dma_chan *chan;
890
891 if (!mask)
892 return ERR_PTR(-ENODEV);
893
894 chan = __dma_request_channel(mask, NULL, NULL, NULL);
895 if (!chan) {
896 mutex_lock(&dma_list_mutex);
897 if (list_empty(&dma_device_list))
898 chan = ERR_PTR(-EPROBE_DEFER);
899 else
900 chan = ERR_PTR(-ENODEV);
901 mutex_unlock(&dma_list_mutex);
902 }
903
904 return chan;
905 }
906 EXPORT_SYMBOL_GPL(dma_request_chan_by_mask);
907
dma_release_channel(struct dma_chan * chan)908 void dma_release_channel(struct dma_chan *chan)
909 {
910 mutex_lock(&dma_list_mutex);
911 WARN_ONCE(chan->client_count != 1,
912 "chan reference count %d != 1\n", chan->client_count);
913 /* drop PRIVATE cap enabled by __dma_request_channel() */
914 if (--chan->device->privatecnt == 0)
915 dma_cap_clear(DMA_PRIVATE, chan->device->cap_mask);
916
917 dma_chan_put(chan);
918
919 if (chan->slave) {
920 sysfs_remove_link(&chan->dev->device.kobj, DMA_SLAVE_NAME);
921 sysfs_remove_link(&chan->slave->kobj, chan->name);
922 kfree(chan->name);
923 chan->name = NULL;
924 chan->slave = NULL;
925 }
926
927 #ifdef CONFIG_DEBUG_FS
928 kfree(chan->dbg_client_name);
929 chan->dbg_client_name = NULL;
930 #endif
931 mutex_unlock(&dma_list_mutex);
932 }
933 EXPORT_SYMBOL_GPL(dma_release_channel);
934
dmaenginem_release_channel(void * chan)935 static void dmaenginem_release_channel(void *chan)
936 {
937 dma_release_channel(chan);
938 }
939
940 /**
941 * devm_dma_request_chan - try to allocate an exclusive slave channel
942 * @dev: pointer to client device structure
943 * @name: slave channel name
944 *
945 * Returns pointer to appropriate DMA channel on success or an error pointer.
946 *
947 * The operation is managed and will be undone on driver detach.
948 */
949
devm_dma_request_chan(struct device * dev,const char * name)950 struct dma_chan *devm_dma_request_chan(struct device *dev, const char *name)
951 {
952 struct dma_chan *chan;
953 int ret;
954
955 chan = dma_request_chan(dev, name);
956 if (IS_ERR(chan))
957 return chan;
958
959 ret = devm_add_action_or_reset(dev, dmaenginem_release_channel, chan);
960 if (ret)
961 return ERR_PTR(ret);
962
963 return chan;
964 }
965 EXPORT_SYMBOL_GPL(devm_dma_request_chan);
966
967 /**
968 * dmaengine_get - register interest in dma_channels
969 */
dmaengine_get(void)970 void dmaengine_get(void)
971 {
972 struct dma_device *device, *_d;
973 struct dma_chan *chan;
974 int err;
975
976 mutex_lock(&dma_list_mutex);
977 dmaengine_ref_count++;
978
979 /* try to grab channels */
980 list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
981 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
982 continue;
983 list_for_each_entry(chan, &device->channels, device_node) {
984 err = dma_chan_get(chan);
985 if (err == -ENODEV) {
986 /* module removed before we could use it */
987 list_del_rcu(&device->global_node);
988 break;
989 } else if (err)
990 dev_dbg(chan->device->dev,
991 "%s: failed to get %s: (%d)\n",
992 __func__, dma_chan_name(chan), err);
993 }
994 }
995
996 /* if this is the first reference and there were channels
997 * waiting we need to rebalance to get those channels
998 * incorporated into the channel table
999 */
1000 if (dmaengine_ref_count == 1)
1001 dma_channel_rebalance();
1002 mutex_unlock(&dma_list_mutex);
1003 }
1004 EXPORT_SYMBOL(dmaengine_get);
1005
1006 /**
1007 * dmaengine_put - let DMA drivers be removed when ref_count == 0
1008 */
dmaengine_put(void)1009 void dmaengine_put(void)
1010 {
1011 struct dma_device *device, *_d;
1012 struct dma_chan *chan;
1013
1014 mutex_lock(&dma_list_mutex);
1015 dmaengine_ref_count--;
1016 BUG_ON(dmaengine_ref_count < 0);
1017 /* drop channel references */
1018 list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
1019 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
1020 continue;
1021 list_for_each_entry(chan, &device->channels, device_node)
1022 dma_chan_put(chan);
1023 }
1024 mutex_unlock(&dma_list_mutex);
1025 }
1026 EXPORT_SYMBOL(dmaengine_put);
1027
device_has_all_tx_types(struct dma_device * device)1028 static bool device_has_all_tx_types(struct dma_device *device)
1029 {
1030 /* A device that satisfies this test has channels that will never cause
1031 * an async_tx channel switch event as all possible operation types can
1032 * be handled.
1033 */
1034 #ifdef CONFIG_ASYNC_TX_DMA
1035 if (!dma_has_cap(DMA_INTERRUPT, device->cap_mask))
1036 return false;
1037 #endif
1038
1039 #if IS_ENABLED(CONFIG_ASYNC_MEMCPY)
1040 if (!dma_has_cap(DMA_MEMCPY, device->cap_mask))
1041 return false;
1042 #endif
1043
1044 #if IS_ENABLED(CONFIG_ASYNC_XOR)
1045 if (!dma_has_cap(DMA_XOR, device->cap_mask))
1046 return false;
1047
1048 #ifndef CONFIG_ASYNC_TX_DISABLE_XOR_VAL_DMA
1049 if (!dma_has_cap(DMA_XOR_VAL, device->cap_mask))
1050 return false;
1051 #endif
1052 #endif
1053
1054 #if IS_ENABLED(CONFIG_ASYNC_PQ)
1055 if (!dma_has_cap(DMA_PQ, device->cap_mask))
1056 return false;
1057
1058 #ifndef CONFIG_ASYNC_TX_DISABLE_PQ_VAL_DMA
1059 if (!dma_has_cap(DMA_PQ_VAL, device->cap_mask))
1060 return false;
1061 #endif
1062 #endif
1063
1064 return true;
1065 }
1066
get_dma_id(struct dma_device * device)1067 static int get_dma_id(struct dma_device *device)
1068 {
1069 int rc = ida_alloc(&dma_ida, GFP_KERNEL);
1070
1071 if (rc < 0)
1072 return rc;
1073 device->dev_id = rc;
1074 return 0;
1075 }
1076
__dma_async_device_channel_register(struct dma_device * device,struct dma_chan * chan,const char * name)1077 static int __dma_async_device_channel_register(struct dma_device *device,
1078 struct dma_chan *chan,
1079 const char *name)
1080 {
1081 int rc;
1082
1083 chan->local = alloc_percpu(typeof(*chan->local));
1084 if (!chan->local)
1085 return -ENOMEM;
1086 chan->dev = kzalloc_obj(*chan->dev);
1087 if (!chan->dev) {
1088 rc = -ENOMEM;
1089 goto err_free_local;
1090 }
1091
1092 /*
1093 * When the chan_id is a negative value, we are dynamically adding
1094 * the channel. Otherwise we are static enumerating.
1095 */
1096 chan->chan_id = ida_alloc(&device->chan_ida, GFP_KERNEL);
1097 if (chan->chan_id < 0) {
1098 pr_err("%s: unable to alloc ida for chan: %d\n",
1099 __func__, chan->chan_id);
1100 rc = chan->chan_id;
1101 goto err_free_dev;
1102 }
1103
1104 chan->dev->device.class = &dma_devclass;
1105 chan->dev->device.parent = device->dev;
1106 chan->dev->chan = chan;
1107 chan->dev->dev_id = device->dev_id;
1108 spin_lock_init(&chan->lock);
1109
1110 if (!name)
1111 dev_set_name(&chan->dev->device, "dma%dchan%d", device->dev_id, chan->chan_id);
1112 else
1113 dev_set_name(&chan->dev->device, "%s", name);
1114 rc = device_register(&chan->dev->device);
1115 if (rc)
1116 goto err_out_ida;
1117 chan->client_count = 0;
1118 device->chancnt++;
1119
1120 return 0;
1121
1122 err_out_ida:
1123 ida_free(&device->chan_ida, chan->chan_id);
1124 err_free_dev:
1125 kfree(chan->dev);
1126 err_free_local:
1127 free_percpu(chan->local);
1128 chan->local = NULL;
1129 return rc;
1130 }
1131
dma_async_device_channel_register(struct dma_device * device,struct dma_chan * chan,const char * name)1132 int dma_async_device_channel_register(struct dma_device *device,
1133 struct dma_chan *chan,
1134 const char *name)
1135 {
1136 int rc;
1137
1138 rc = __dma_async_device_channel_register(device, chan, name);
1139 if (rc < 0)
1140 return rc;
1141
1142 dma_channel_rebalance();
1143 return 0;
1144 }
1145 EXPORT_SYMBOL_GPL(dma_async_device_channel_register);
1146
__dma_async_device_channel_unregister(struct dma_device * device,struct dma_chan * chan)1147 static void __dma_async_device_channel_unregister(struct dma_device *device,
1148 struct dma_chan *chan)
1149 {
1150 if (chan->local == NULL)
1151 return;
1152
1153 WARN_ONCE(!device->device_release && chan->client_count,
1154 "%s called while %d clients hold a reference\n",
1155 __func__, chan->client_count);
1156 mutex_lock(&dma_list_mutex);
1157 device->chancnt--;
1158 chan->dev->chan = NULL;
1159 mutex_unlock(&dma_list_mutex);
1160 ida_free(&device->chan_ida, chan->chan_id);
1161 device_unregister(&chan->dev->device);
1162 free_percpu(chan->local);
1163 }
1164
dma_async_device_channel_unregister(struct dma_device * device,struct dma_chan * chan)1165 void dma_async_device_channel_unregister(struct dma_device *device,
1166 struct dma_chan *chan)
1167 {
1168 __dma_async_device_channel_unregister(device, chan);
1169 dma_channel_rebalance();
1170 }
1171 EXPORT_SYMBOL_GPL(dma_async_device_channel_unregister);
1172
1173 /**
1174 * dma_async_device_register - registers DMA devices found
1175 * @device: pointer to &struct dma_device
1176 *
1177 * After calling this routine the structure should not be freed except in the
1178 * device_release() callback which will be called after
1179 * dma_async_device_unregister() is called and no further references are taken.
1180 */
dma_async_device_register(struct dma_device * device)1181 int dma_async_device_register(struct dma_device *device)
1182 {
1183 int rc;
1184 struct dma_chan* chan;
1185
1186 if (!device)
1187 return -ENODEV;
1188
1189 /* validate device routines */
1190 if (!device->dev) {
1191 pr_err("DMAdevice must have dev\n");
1192 return -EIO;
1193 }
1194
1195 device->owner = device->dev->driver->owner;
1196
1197 #define CHECK_CAP(_name, _type) \
1198 { \
1199 if (dma_has_cap(_type, device->cap_mask) && !device->device_prep_##_name) { \
1200 dev_err(device->dev, \
1201 "Device claims capability %s, but op is not defined\n", \
1202 __stringify(_type)); \
1203 return -EIO; \
1204 } \
1205 }
1206
1207 CHECK_CAP(dma_memcpy, DMA_MEMCPY);
1208 CHECK_CAP(dma_xor, DMA_XOR);
1209 CHECK_CAP(dma_xor_val, DMA_XOR_VAL);
1210 CHECK_CAP(dma_pq, DMA_PQ);
1211 CHECK_CAP(dma_pq_val, DMA_PQ_VAL);
1212 CHECK_CAP(dma_memset, DMA_MEMSET);
1213 CHECK_CAP(dma_interrupt, DMA_INTERRUPT);
1214 CHECK_CAP(dma_cyclic, DMA_CYCLIC);
1215 CHECK_CAP(interleaved_dma, DMA_INTERLEAVE);
1216
1217 #undef CHECK_CAP
1218
1219 if (!device->device_tx_status) {
1220 dev_err(device->dev, "Device tx_status is not defined\n");
1221 return -EIO;
1222 }
1223
1224
1225 if (!device->device_issue_pending) {
1226 dev_err(device->dev, "Device issue_pending is not defined\n");
1227 return -EIO;
1228 }
1229
1230 if (!device->device_release)
1231 dev_dbg(device->dev,
1232 "WARN: Device release is not defined so it is not safe to unbind this driver while in use\n");
1233
1234 kref_init(&device->ref);
1235
1236 /* note: this only matters in the
1237 * CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH=n case
1238 */
1239 if (device_has_all_tx_types(device))
1240 dma_cap_set(DMA_ASYNC_TX, device->cap_mask);
1241
1242 rc = get_dma_id(device);
1243 if (rc != 0)
1244 return rc;
1245
1246 ida_init(&device->chan_ida);
1247
1248 /* represent channels in sysfs. Probably want devs too */
1249 list_for_each_entry(chan, &device->channels, device_node) {
1250 rc = __dma_async_device_channel_register(device, chan, NULL);
1251 if (rc < 0)
1252 goto err_out;
1253 }
1254
1255 mutex_lock(&dma_list_mutex);
1256 /* take references on public channels */
1257 if (dmaengine_ref_count && !dma_has_cap(DMA_PRIVATE, device->cap_mask))
1258 list_for_each_entry(chan, &device->channels, device_node) {
1259 /* if clients are already waiting for channels we need
1260 * to take references on their behalf
1261 */
1262 if (dma_chan_get(chan) == -ENODEV) {
1263 /* note we can only get here for the first
1264 * channel as the remaining channels are
1265 * guaranteed to get a reference
1266 */
1267 rc = -ENODEV;
1268 mutex_unlock(&dma_list_mutex);
1269 goto err_out;
1270 }
1271 }
1272 list_add_tail_rcu(&device->global_node, &dma_device_list);
1273 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
1274 device->privatecnt++; /* Always private */
1275 dma_channel_rebalance();
1276 mutex_unlock(&dma_list_mutex);
1277
1278 dmaengine_debug_register(device);
1279
1280 return 0;
1281
1282 err_out:
1283 /* if we never registered a channel just release the idr */
1284 if (!device->chancnt) {
1285 ida_free(&dma_ida, device->dev_id);
1286 return rc;
1287 }
1288
1289 list_for_each_entry(chan, &device->channels, device_node) {
1290 if (chan->local == NULL)
1291 continue;
1292 mutex_lock(&dma_list_mutex);
1293 chan->dev->chan = NULL;
1294 mutex_unlock(&dma_list_mutex);
1295 device_unregister(&chan->dev->device);
1296 free_percpu(chan->local);
1297 }
1298 return rc;
1299 }
1300 EXPORT_SYMBOL(dma_async_device_register);
1301
1302 /**
1303 * dma_async_device_unregister - unregister a DMA device
1304 * @device: pointer to &struct dma_device
1305 *
1306 * This routine is called by dma driver exit routines, dmaengine holds module
1307 * references to prevent it being called while channels are in use.
1308 */
dma_async_device_unregister(struct dma_device * device)1309 void dma_async_device_unregister(struct dma_device *device)
1310 {
1311 struct dma_chan *chan, *n;
1312
1313 dmaengine_debug_unregister(device);
1314
1315 list_for_each_entry_safe(chan, n, &device->channels, device_node)
1316 __dma_async_device_channel_unregister(device, chan);
1317
1318 mutex_lock(&dma_list_mutex);
1319 /*
1320 * setting DMA_PRIVATE ensures the device being torn down will not
1321 * be used in the channel_table
1322 */
1323 dma_cap_set(DMA_PRIVATE, device->cap_mask);
1324 dma_channel_rebalance();
1325 ida_free(&dma_ida, device->dev_id);
1326 dma_device_put(device);
1327 mutex_unlock(&dma_list_mutex);
1328 }
1329 EXPORT_SYMBOL(dma_async_device_unregister);
1330
dmaenginem_async_device_unregister(void * device)1331 static void dmaenginem_async_device_unregister(void *device)
1332 {
1333 dma_async_device_unregister(device);
1334 }
1335
1336 /**
1337 * dmaenginem_async_device_register - registers DMA devices found
1338 * @device: pointer to &struct dma_device
1339 *
1340 * The operation is managed and will be undone on driver detach.
1341 */
dmaenginem_async_device_register(struct dma_device * device)1342 int dmaenginem_async_device_register(struct dma_device *device)
1343 {
1344 int ret;
1345
1346 ret = dma_async_device_register(device);
1347 if (ret)
1348 return ret;
1349
1350 return devm_add_action_or_reset(device->dev, dmaenginem_async_device_unregister, device);
1351 }
1352 EXPORT_SYMBOL(dmaenginem_async_device_register);
1353
1354 struct dmaengine_unmap_pool {
1355 struct kmem_cache *cache;
1356 const char *name;
1357 mempool_t *pool;
1358 size_t size;
1359 };
1360
1361 #define __UNMAP_POOL(x) { .size = x, .name = "dmaengine-unmap-" __stringify(x) }
1362 static struct dmaengine_unmap_pool unmap_pool[] = {
1363 __UNMAP_POOL(2),
1364 #if IS_ENABLED(CONFIG_DMA_ENGINE_RAID)
1365 __UNMAP_POOL(16),
1366 __UNMAP_POOL(128),
1367 __UNMAP_POOL(256),
1368 #endif
1369 };
1370
__get_unmap_pool(int nr)1371 static struct dmaengine_unmap_pool *__get_unmap_pool(int nr)
1372 {
1373 int order = get_count_order(nr);
1374
1375 switch (order) {
1376 case 0 ... 1:
1377 return &unmap_pool[0];
1378 #if IS_ENABLED(CONFIG_DMA_ENGINE_RAID)
1379 case 2 ... 4:
1380 return &unmap_pool[1];
1381 case 5 ... 7:
1382 return &unmap_pool[2];
1383 case 8:
1384 return &unmap_pool[3];
1385 #endif
1386 default:
1387 BUG();
1388 return NULL;
1389 }
1390 }
1391
dmaengine_unmap(struct kref * kref)1392 static void dmaengine_unmap(struct kref *kref)
1393 {
1394 struct dmaengine_unmap_data *unmap = container_of(kref, typeof(*unmap), kref);
1395 struct device *dev = unmap->dev;
1396 int cnt, i;
1397
1398 cnt = unmap->to_cnt;
1399 for (i = 0; i < cnt; i++)
1400 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1401 DMA_TO_DEVICE);
1402 cnt += unmap->from_cnt;
1403 for (; i < cnt; i++)
1404 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1405 DMA_FROM_DEVICE);
1406 cnt += unmap->bidi_cnt;
1407 for (; i < cnt; i++) {
1408 if (unmap->addr[i] == 0)
1409 continue;
1410 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1411 DMA_BIDIRECTIONAL);
1412 }
1413 cnt = unmap->map_cnt;
1414 mempool_free(unmap, __get_unmap_pool(cnt)->pool);
1415 }
1416
dmaengine_unmap_put(struct dmaengine_unmap_data * unmap)1417 void dmaengine_unmap_put(struct dmaengine_unmap_data *unmap)
1418 {
1419 if (unmap)
1420 kref_put(&unmap->kref, dmaengine_unmap);
1421 }
1422 EXPORT_SYMBOL_GPL(dmaengine_unmap_put);
1423
dmaengine_destroy_unmap_pool(void)1424 static void dmaengine_destroy_unmap_pool(void)
1425 {
1426 int i;
1427
1428 for (i = 0; i < ARRAY_SIZE(unmap_pool); i++) {
1429 struct dmaengine_unmap_pool *p = &unmap_pool[i];
1430
1431 mempool_destroy(p->pool);
1432 p->pool = NULL;
1433 kmem_cache_destroy(p->cache);
1434 p->cache = NULL;
1435 }
1436 }
1437
dmaengine_init_unmap_pool(void)1438 static int __init dmaengine_init_unmap_pool(void)
1439 {
1440 int i;
1441
1442 for (i = 0; i < ARRAY_SIZE(unmap_pool); i++) {
1443 struct dmaengine_unmap_pool *p = &unmap_pool[i];
1444 size_t size;
1445
1446 size = sizeof(struct dmaengine_unmap_data) +
1447 sizeof(dma_addr_t) * p->size;
1448
1449 p->cache = kmem_cache_create(p->name, size, 0,
1450 SLAB_HWCACHE_ALIGN, NULL);
1451 if (!p->cache)
1452 break;
1453 p->pool = mempool_create_slab_pool(1, p->cache);
1454 if (!p->pool)
1455 break;
1456 }
1457
1458 if (i == ARRAY_SIZE(unmap_pool))
1459 return 0;
1460
1461 dmaengine_destroy_unmap_pool();
1462 return -ENOMEM;
1463 }
1464
1465 struct dmaengine_unmap_data *
dmaengine_get_unmap_data(struct device * dev,int nr,gfp_t flags)1466 dmaengine_get_unmap_data(struct device *dev, int nr, gfp_t flags)
1467 {
1468 struct dmaengine_unmap_data *unmap;
1469
1470 unmap = mempool_alloc(__get_unmap_pool(nr)->pool, flags);
1471 if (!unmap)
1472 return NULL;
1473
1474 memset(unmap, 0, sizeof(*unmap));
1475 kref_init(&unmap->kref);
1476 unmap->dev = dev;
1477 unmap->map_cnt = nr;
1478
1479 return unmap;
1480 }
1481 EXPORT_SYMBOL(dmaengine_get_unmap_data);
1482
dma_async_tx_descriptor_init(struct dma_async_tx_descriptor * tx,struct dma_chan * chan)1483 void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx,
1484 struct dma_chan *chan)
1485 {
1486 tx->chan = chan;
1487 #ifdef CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH
1488 spin_lock_init(&tx->lock);
1489 #endif
1490 }
1491 EXPORT_SYMBOL(dma_async_tx_descriptor_init);
1492
desc_check_and_set_metadata_mode(struct dma_async_tx_descriptor * desc,enum dma_desc_metadata_mode mode)1493 static inline int desc_check_and_set_metadata_mode(
1494 struct dma_async_tx_descriptor *desc, enum dma_desc_metadata_mode mode)
1495 {
1496 /* Make sure that the metadata mode is not mixed */
1497 if (!desc->desc_metadata_mode) {
1498 if (dmaengine_is_metadata_mode_supported(desc->chan, mode))
1499 desc->desc_metadata_mode = mode;
1500 else
1501 return -ENOTSUPP;
1502 } else if (desc->desc_metadata_mode != mode) {
1503 return -EINVAL;
1504 }
1505
1506 return 0;
1507 }
1508
dmaengine_desc_attach_metadata(struct dma_async_tx_descriptor * desc,void * data,size_t len)1509 int dmaengine_desc_attach_metadata(struct dma_async_tx_descriptor *desc,
1510 void *data, size_t len)
1511 {
1512 int ret;
1513
1514 if (!desc)
1515 return -EINVAL;
1516
1517 ret = desc_check_and_set_metadata_mode(desc, DESC_METADATA_CLIENT);
1518 if (ret)
1519 return ret;
1520
1521 if (!desc->metadata_ops || !desc->metadata_ops->attach)
1522 return -ENOTSUPP;
1523
1524 return desc->metadata_ops->attach(desc, data, len);
1525 }
1526 EXPORT_SYMBOL_GPL(dmaengine_desc_attach_metadata);
1527
dmaengine_desc_get_metadata_ptr(struct dma_async_tx_descriptor * desc,size_t * payload_len,size_t * max_len)1528 void *dmaengine_desc_get_metadata_ptr(struct dma_async_tx_descriptor *desc,
1529 size_t *payload_len, size_t *max_len)
1530 {
1531 int ret;
1532
1533 if (!desc)
1534 return ERR_PTR(-EINVAL);
1535
1536 ret = desc_check_and_set_metadata_mode(desc, DESC_METADATA_ENGINE);
1537 if (ret)
1538 return ERR_PTR(ret);
1539
1540 if (!desc->metadata_ops || !desc->metadata_ops->get_ptr)
1541 return ERR_PTR(-ENOTSUPP);
1542
1543 return desc->metadata_ops->get_ptr(desc, payload_len, max_len);
1544 }
1545 EXPORT_SYMBOL_GPL(dmaengine_desc_get_metadata_ptr);
1546
dmaengine_desc_set_metadata_len(struct dma_async_tx_descriptor * desc,size_t payload_len)1547 int dmaengine_desc_set_metadata_len(struct dma_async_tx_descriptor *desc,
1548 size_t payload_len)
1549 {
1550 int ret;
1551
1552 if (!desc)
1553 return -EINVAL;
1554
1555 ret = desc_check_and_set_metadata_mode(desc, DESC_METADATA_ENGINE);
1556 if (ret)
1557 return ret;
1558
1559 if (!desc->metadata_ops || !desc->metadata_ops->set_len)
1560 return -ENOTSUPP;
1561
1562 return desc->metadata_ops->set_len(desc, payload_len);
1563 }
1564 EXPORT_SYMBOL_GPL(dmaengine_desc_set_metadata_len);
1565
1566 /**
1567 * dma_wait_for_async_tx - spin wait for a transaction to complete
1568 * @tx: in-flight transaction to wait on
1569 */
1570 enum dma_status
dma_wait_for_async_tx(struct dma_async_tx_descriptor * tx)1571 dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx)
1572 {
1573 unsigned long dma_sync_wait_timeout = jiffies + msecs_to_jiffies(5000);
1574
1575 if (!tx)
1576 return DMA_COMPLETE;
1577
1578 while (tx->cookie == -EBUSY) {
1579 if (time_after_eq(jiffies, dma_sync_wait_timeout)) {
1580 dev_err(tx->chan->device->dev,
1581 "%s timeout waiting for descriptor submission\n",
1582 __func__);
1583 return DMA_ERROR;
1584 }
1585 cpu_relax();
1586 }
1587 return dma_sync_wait(tx->chan, tx->cookie);
1588 }
1589 EXPORT_SYMBOL_GPL(dma_wait_for_async_tx);
1590
1591 /**
1592 * dma_run_dependencies - process dependent operations on the target channel
1593 * @tx: transaction with dependencies
1594 *
1595 * Helper routine for DMA drivers to process (start) dependent operations
1596 * on their target channel.
1597 */
dma_run_dependencies(struct dma_async_tx_descriptor * tx)1598 void dma_run_dependencies(struct dma_async_tx_descriptor *tx)
1599 {
1600 struct dma_async_tx_descriptor *dep = txd_next(tx);
1601 struct dma_async_tx_descriptor *dep_next;
1602 struct dma_chan *chan;
1603
1604 if (!dep)
1605 return;
1606
1607 /* we'll submit tx->next now, so clear the link */
1608 txd_clear_next(tx);
1609 chan = dep->chan;
1610
1611 /* keep submitting up until a channel switch is detected
1612 * in that case we will be called again as a result of
1613 * processing the interrupt from async_tx_channel_switch
1614 */
1615 for (; dep; dep = dep_next) {
1616 txd_lock(dep);
1617 txd_clear_parent(dep);
1618 dep_next = txd_next(dep);
1619 if (dep_next && dep_next->chan == chan)
1620 txd_clear_next(dep); /* ->next will be submitted */
1621 else
1622 dep_next = NULL; /* submit current dep and terminate */
1623 txd_unlock(dep);
1624
1625 dep->tx_submit(dep);
1626 }
1627
1628 chan->device->device_issue_pending(chan);
1629 }
1630 EXPORT_SYMBOL_GPL(dma_run_dependencies);
1631
dma_bus_init(void)1632 static int __init dma_bus_init(void)
1633 {
1634 int err = dmaengine_init_unmap_pool();
1635
1636 if (err)
1637 return err;
1638
1639 err = class_register(&dma_devclass);
1640 if (!err)
1641 dmaengine_debugfs_init();
1642
1643 return err;
1644 }
1645 arch_initcall(dma_bus_init);
1646