blob: 962cbb5e5f7fcb630806ec7abb75be479ffa9899 [file] [log] [blame]
Thomas Gleixner9ab65af2019-05-19 15:51:37 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Chris Leechc13c8262006-05-23 17:18:44 -07002/*
3 * Copyright(c) 2004 - 2006 Intel Corporation. All rights reserved.
Chris Leechc13c8262006-05-23 17:18:44 -07004 */
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 *
Dan Williamsaa1e6f12009-01-06 11:38:17 -070018 * The subsystem keeps a global list of dma_device structs it is protected by a
19 * mutex, dma_list_mutex.
Chris Leechc13c8262006-05-23 17:18:44 -070020 *
Dan Williamsf27c5802009-01-06 11:38:18 -070021 * 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 *
Chris Leechc13c8262006-05-23 17:18:44 -070026 * 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 *
Mauro Carvalho Chehab44348e8a2018-06-14 12:34:32 -030029 * See Documentation/driver-api/dmaengine for more details
Chris Leechc13c8262006-05-23 17:18:44 -070030 */
31
Joe Perches63433252012-07-18 09:51:28 -070032#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
33
Peter Ujfalusia8135d02015-12-14 22:47:40 +020034#include <linux/platform_device.h>
Alexey Dobriyanb7f080c2011-06-16 11:01:34 +000035#include <linux/dma-mapping.h>
Chris Leechc13c8262006-05-23 17:18:44 -070036#include <linux/init.h>
37#include <linux/module.h>
Dan Williams7405f742007-01-02 11:10:43 -070038#include <linux/mm.h>
Chris Leechc13c8262006-05-23 17:18:44 -070039#include <linux/device.h>
40#include <linux/dmaengine.h>
41#include <linux/hardirq.h>
42#include <linux/spinlock.h>
43#include <linux/percpu.h>
44#include <linux/rcupdate.h>
45#include <linux/mutex.h>
Dan Williams7405f742007-01-02 11:10:43 -070046#include <linux/jiffies.h>
Dan Williams2ba05622009-01-06 11:38:14 -070047#include <linux/rculist.h>
Dan Williams864498a2009-01-06 11:38:21 -070048#include <linux/idr.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090049#include <linux/slab.h>
Andy Shevchenko4e82f5d2013-04-09 14:05:44 +030050#include <linux/acpi.h>
51#include <linux/acpi_dma.h>
Jon Hunter9a6cecc2012-09-14 17:41:57 -050052#include <linux/of_dma.h>
Dan Williams45c463a2013-10-18 19:35:24 +020053#include <linux/mempool.h>
Anshuman Khandual98fa15f2019-03-05 15:42:58 -080054#include <linux/numa.h>
Chris Leechc13c8262006-05-23 17:18:44 -070055
Andy Shevchenko833d88f2020-04-29 15:21:50 +030056#include "dmaengine.h"
57
Chris Leechc13c8262006-05-23 17:18:44 -070058static DEFINE_MUTEX(dma_list_mutex);
Matthew Wilcoxadc064c2016-12-15 08:57:51 -080059static DEFINE_IDA(dma_ida);
Chris Leechc13c8262006-05-23 17:18:44 -070060static LIST_HEAD(dma_device_list);
Dan Williams6f49a572009-01-06 11:38:14 -070061static long dmaengine_ref_count;
Chris Leechc13c8262006-05-23 17:18:44 -070062
Peter Ujfalusie937cc12020-03-06 16:28:37 +020063/* --- debugfs implementation --- */
64#ifdef CONFIG_DEBUG_FS
65#include <linux/debugfs.h>
66
Peter Ujfalusi26cf1322020-03-06 16:28:39 +020067static struct dentry *rootdir;
68
69static void dmaengine_debug_register(struct dma_device *dma_dev)
70{
71 dma_dev->dbg_dev_root = debugfs_create_dir(dev_name(dma_dev->dev),
72 rootdir);
73 if (IS_ERR(dma_dev->dbg_dev_root))
74 dma_dev->dbg_dev_root = NULL;
75}
76
77static void dmaengine_debug_unregister(struct dma_device *dma_dev)
78{
79 debugfs_remove_recursive(dma_dev->dbg_dev_root);
80 dma_dev->dbg_dev_root = NULL;
81}
82
Peter Ujfalusie937cc12020-03-06 16:28:37 +020083static void dmaengine_dbg_summary_show(struct seq_file *s,
84 struct dma_device *dma_dev)
85{
86 struct dma_chan *chan;
87
88 list_for_each_entry(chan, &dma_dev->channels, device_node) {
89 if (chan->client_count) {
90 seq_printf(s, " %-13s| %s", dma_chan_name(chan),
91 chan->dbg_client_name ?: "in-use");
92
93 if (chan->router)
94 seq_printf(s, " (via router: %s)\n",
95 dev_name(chan->router->dev));
96 else
97 seq_puts(s, "\n");
98 }
99 }
100}
101
102static int dmaengine_summary_show(struct seq_file *s, void *data)
103{
104 struct dma_device *dma_dev = NULL;
105
106 mutex_lock(&dma_list_mutex);
107 list_for_each_entry(dma_dev, &dma_device_list, global_node) {
108 seq_printf(s, "dma%d (%s): number of channels: %u\n",
109 dma_dev->dev_id, dev_name(dma_dev->dev),
110 dma_dev->chancnt);
111
112 if (dma_dev->dbg_summary_show)
113 dma_dev->dbg_summary_show(s, dma_dev);
114 else
115 dmaengine_dbg_summary_show(s, dma_dev);
116
117 if (!list_is_last(&dma_dev->global_node, &dma_device_list))
118 seq_puts(s, "\n");
119 }
120 mutex_unlock(&dma_list_mutex);
121
122 return 0;
123}
124DEFINE_SHOW_ATTRIBUTE(dmaengine_summary);
125
126static void __init dmaengine_debugfs_init(void)
127{
Peter Ujfalusi26cf1322020-03-06 16:28:39 +0200128 rootdir = debugfs_create_dir("dmaengine", NULL);
Peter Ujfalusie937cc12020-03-06 16:28:37 +0200129
130 /* /sys/kernel/debug/dmaengine/summary */
131 debugfs_create_file("summary", 0444, rootdir, NULL,
132 &dmaengine_summary_fops);
133}
134#else
135static inline void dmaengine_debugfs_init(void) { }
Peter Ujfalusi26cf1322020-03-06 16:28:39 +0200136static inline int dmaengine_debug_register(struct dma_device *dma_dev)
137{
138 return 0;
139}
140
141static inline void dmaengine_debug_unregister(struct dma_device *dma_dev) { }
Peter Ujfalusie937cc12020-03-06 16:28:37 +0200142#endif /* DEBUG_FS */
143
Chris Leechc13c8262006-05-23 17:18:44 -0700144/* --- sysfs implementation --- */
145
Geert Uytterhoeven71723a92020-01-17 16:30:56 +0100146#define DMA_SLAVE_NAME "slave"
147
Dan Williams41d5e592009-01-06 11:38:21 -0700148/**
Geert Uytterhoevenfe333382019-06-07 13:30:39 +0200149 * dev_to_dma_chan - convert a device pointer to its sysfs container object
Andy Shevchenko9872e232020-04-29 15:21:51 +0300150 * @dev: device node
Dan Williams41d5e592009-01-06 11:38:21 -0700151 *
Andy Shevchenko9872e232020-04-29 15:21:51 +0300152 * Must be called under dma_list_mutex.
Dan Williams41d5e592009-01-06 11:38:21 -0700153 */
154static struct dma_chan *dev_to_dma_chan(struct device *dev)
155{
156 struct dma_chan_dev *chan_dev;
157
158 chan_dev = container_of(dev, typeof(*chan_dev), device);
159 return chan_dev->chan;
160}
161
Greg Kroah-Hartman58b267d2013-07-24 15:05:08 -0700162static ssize_t memcpy_count_show(struct device *dev,
163 struct device_attribute *attr, char *buf)
Chris Leechc13c8262006-05-23 17:18:44 -0700164{
Dan Williams41d5e592009-01-06 11:38:21 -0700165 struct dma_chan *chan;
Chris Leechc13c8262006-05-23 17:18:44 -0700166 unsigned long count = 0;
167 int i;
Dan Williams41d5e592009-01-06 11:38:21 -0700168 int err;
Chris Leechc13c8262006-05-23 17:18:44 -0700169
Dan Williams41d5e592009-01-06 11:38:21 -0700170 mutex_lock(&dma_list_mutex);
171 chan = dev_to_dma_chan(dev);
172 if (chan) {
173 for_each_possible_cpu(i)
174 count += per_cpu_ptr(chan->local, i)->memcpy_count;
175 err = sprintf(buf, "%lu\n", count);
176 } else
177 err = -ENODEV;
178 mutex_unlock(&dma_list_mutex);
Chris Leechc13c8262006-05-23 17:18:44 -0700179
Dan Williams41d5e592009-01-06 11:38:21 -0700180 return err;
Chris Leechc13c8262006-05-23 17:18:44 -0700181}
Greg Kroah-Hartman58b267d2013-07-24 15:05:08 -0700182static DEVICE_ATTR_RO(memcpy_count);
Chris Leechc13c8262006-05-23 17:18:44 -0700183
Greg Kroah-Hartman58b267d2013-07-24 15:05:08 -0700184static ssize_t bytes_transferred_show(struct device *dev,
185 struct device_attribute *attr, char *buf)
Chris Leechc13c8262006-05-23 17:18:44 -0700186{
Dan Williams41d5e592009-01-06 11:38:21 -0700187 struct dma_chan *chan;
Chris Leechc13c8262006-05-23 17:18:44 -0700188 unsigned long count = 0;
189 int i;
Dan Williams41d5e592009-01-06 11:38:21 -0700190 int err;
Chris Leechc13c8262006-05-23 17:18:44 -0700191
Dan Williams41d5e592009-01-06 11:38:21 -0700192 mutex_lock(&dma_list_mutex);
193 chan = dev_to_dma_chan(dev);
194 if (chan) {
195 for_each_possible_cpu(i)
196 count += per_cpu_ptr(chan->local, i)->bytes_transferred;
197 err = sprintf(buf, "%lu\n", count);
198 } else
199 err = -ENODEV;
200 mutex_unlock(&dma_list_mutex);
Chris Leechc13c8262006-05-23 17:18:44 -0700201
Dan Williams41d5e592009-01-06 11:38:21 -0700202 return err;
Chris Leechc13c8262006-05-23 17:18:44 -0700203}
Greg Kroah-Hartman58b267d2013-07-24 15:05:08 -0700204static DEVICE_ATTR_RO(bytes_transferred);
Chris Leechc13c8262006-05-23 17:18:44 -0700205
Greg Kroah-Hartman58b267d2013-07-24 15:05:08 -0700206static ssize_t in_use_show(struct device *dev, struct device_attribute *attr,
207 char *buf)
Chris Leechc13c8262006-05-23 17:18:44 -0700208{
Dan Williams41d5e592009-01-06 11:38:21 -0700209 struct dma_chan *chan;
210 int err;
Chris Leechc13c8262006-05-23 17:18:44 -0700211
Dan Williams41d5e592009-01-06 11:38:21 -0700212 mutex_lock(&dma_list_mutex);
213 chan = dev_to_dma_chan(dev);
214 if (chan)
215 err = sprintf(buf, "%d\n", chan->client_count);
216 else
217 err = -ENODEV;
218 mutex_unlock(&dma_list_mutex);
219
220 return err;
Chris Leechc13c8262006-05-23 17:18:44 -0700221}
Greg Kroah-Hartman58b267d2013-07-24 15:05:08 -0700222static DEVICE_ATTR_RO(in_use);
Chris Leechc13c8262006-05-23 17:18:44 -0700223
Greg Kroah-Hartman58b267d2013-07-24 15:05:08 -0700224static struct attribute *dma_dev_attrs[] = {
225 &dev_attr_memcpy_count.attr,
226 &dev_attr_bytes_transferred.attr,
227 &dev_attr_in_use.attr,
228 NULL,
Chris Leechc13c8262006-05-23 17:18:44 -0700229};
Greg Kroah-Hartman58b267d2013-07-24 15:05:08 -0700230ATTRIBUTE_GROUPS(dma_dev);
Chris Leechc13c8262006-05-23 17:18:44 -0700231
Dan Williams41d5e592009-01-06 11:38:21 -0700232static void chan_dev_release(struct device *dev)
233{
234 struct dma_chan_dev *chan_dev;
235
236 chan_dev = container_of(dev, typeof(*chan_dev), device);
237 kfree(chan_dev);
238}
239
Chris Leechc13c8262006-05-23 17:18:44 -0700240static struct class dma_devclass = {
Tony Jones891f78e2007-09-25 02:03:03 +0200241 .name = "dma",
Greg Kroah-Hartman58b267d2013-07-24 15:05:08 -0700242 .dev_groups = dma_dev_groups,
Dan Williams41d5e592009-01-06 11:38:21 -0700243 .dev_release = chan_dev_release,
Chris Leechc13c8262006-05-23 17:18:44 -0700244};
245
246/* --- client and device registration --- */
247
Andy Shevchenko9872e232020-04-29 15:21:51 +0300248/* enable iteration over all operation types */
Logan Gunthorpe11a0fd22019-12-16 12:01:18 -0700249static dma_cap_mask_t dma_cap_mask_all;
250
251/**
Andy Shevchenko9872e232020-04-29 15:21:51 +0300252 * struct dma_chan_tbl_ent - tracks channel allocations per core/operation
253 * @chan: associated channel for this entry
Logan Gunthorpe11a0fd22019-12-16 12:01:18 -0700254 */
255struct dma_chan_tbl_ent {
256 struct dma_chan *chan;
257};
258
Andy Shevchenko9872e232020-04-29 15:21:51 +0300259/* percpu lookup table for memory-to-memory offload providers */
Logan Gunthorpe11a0fd22019-12-16 12:01:18 -0700260static struct dma_chan_tbl_ent __percpu *channel_table[DMA_TX_TYPE_END];
261
262static int __init dma_channel_table_init(void)
263{
264 enum dma_transaction_type cap;
265 int err = 0;
266
267 bitmap_fill(dma_cap_mask_all.bits, DMA_TX_TYPE_END);
268
269 /* 'interrupt', 'private', and 'slave' are channel capabilities,
270 * but are not associated with an operation so they do not need
271 * an entry in the channel_table
272 */
273 clear_bit(DMA_INTERRUPT, dma_cap_mask_all.bits);
274 clear_bit(DMA_PRIVATE, dma_cap_mask_all.bits);
275 clear_bit(DMA_SLAVE, dma_cap_mask_all.bits);
276
277 for_each_dma_cap_mask(cap, dma_cap_mask_all) {
278 channel_table[cap] = alloc_percpu(struct dma_chan_tbl_ent);
279 if (!channel_table[cap]) {
280 err = -ENOMEM;
281 break;
282 }
283 }
284
285 if (err) {
Vinod Koul08baca42019-12-24 10:26:14 +0530286 pr_err("dmaengine dma_channel_table_init failure: %d\n", err);
Logan Gunthorpe11a0fd22019-12-16 12:01:18 -0700287 for_each_dma_cap_mask(cap, dma_cap_mask_all)
288 free_percpu(channel_table[cap]);
289 }
290
291 return err;
292}
293arch_initcall(dma_channel_table_init);
294
295/**
Andy Shevchenko9872e232020-04-29 15:21:51 +0300296 * dma_chan_is_local - checks if the channel is in the same NUMA-node as the CPU
297 * @chan: DMA channel to test
298 * @cpu: CPU index which the channel should be close to
299 *
300 * Returns true if the channel is in the same NUMA-node as the CPU.
Logan Gunthorpe11a0fd22019-12-16 12:01:18 -0700301 */
302static bool dma_chan_is_local(struct dma_chan *chan, int cpu)
303{
304 int node = dev_to_node(chan->device->dev);
305 return node == NUMA_NO_NODE ||
306 cpumask_test_cpu(cpu, cpumask_of_node(node));
307}
308
309/**
Andy Shevchenko9872e232020-04-29 15:21:51 +0300310 * min_chan - finds the channel with min count and in the same NUMA-node as the CPU
311 * @cap: capability to match
312 * @cpu: CPU index which the channel should be close to
Logan Gunthorpe11a0fd22019-12-16 12:01:18 -0700313 *
Andy Shevchenko9872e232020-04-29 15:21:51 +0300314 * If some channels are close to the given CPU, the one with the lowest
315 * reference count is returned. Otherwise, CPU is ignored and only the
Logan Gunthorpe11a0fd22019-12-16 12:01:18 -0700316 * reference count is taken into account.
Andy Shevchenko9872e232020-04-29 15:21:51 +0300317 *
Logan Gunthorpe11a0fd22019-12-16 12:01:18 -0700318 * Must be called under dma_list_mutex.
319 */
320static struct dma_chan *min_chan(enum dma_transaction_type cap, int cpu)
321{
322 struct dma_device *device;
323 struct dma_chan *chan;
324 struct dma_chan *min = NULL;
325 struct dma_chan *localmin = NULL;
326
327 list_for_each_entry(device, &dma_device_list, global_node) {
328 if (!dma_has_cap(cap, device->cap_mask) ||
329 dma_has_cap(DMA_PRIVATE, device->cap_mask))
330 continue;
331 list_for_each_entry(chan, &device->channels, device_node) {
332 if (!chan->client_count)
333 continue;
334 if (!min || chan->table_count < min->table_count)
335 min = chan;
336
337 if (dma_chan_is_local(chan, cpu))
338 if (!localmin ||
339 chan->table_count < localmin->table_count)
340 localmin = chan;
341 }
342 }
343
344 chan = localmin ? localmin : min;
345
346 if (chan)
347 chan->table_count++;
348
349 return chan;
350}
351
352/**
353 * dma_channel_rebalance - redistribute the available channels
354 *
Andy Shevchenko9872e232020-04-29 15:21:51 +0300355 * Optimize for CPU isolation (each CPU gets a dedicated channel for an
356 * operation type) in the SMP case, and operation isolation (avoid
357 * multi-tasking channels) in the non-SMP case.
358 *
359 * Must be called under dma_list_mutex.
Logan Gunthorpe11a0fd22019-12-16 12:01:18 -0700360 */
361static void dma_channel_rebalance(void)
362{
363 struct dma_chan *chan;
364 struct dma_device *device;
365 int cpu;
366 int cap;
367
368 /* undo the last distribution */
369 for_each_dma_cap_mask(cap, dma_cap_mask_all)
370 for_each_possible_cpu(cpu)
371 per_cpu_ptr(channel_table[cap], cpu)->chan = NULL;
372
373 list_for_each_entry(device, &dma_device_list, global_node) {
374 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
375 continue;
376 list_for_each_entry(chan, &device->channels, device_node)
377 chan->table_count = 0;
378 }
379
380 /* don't populate the channel_table if no clients are available */
381 if (!dmaengine_ref_count)
382 return;
383
384 /* redistribute available channels */
385 for_each_dma_cap_mask(cap, dma_cap_mask_all)
386 for_each_online_cpu(cpu) {
387 chan = min_chan(cap, cpu);
388 per_cpu_ptr(channel_table[cap], cpu)->chan = chan;
389 }
390}
391
Geert Uytterhoeven69b11892020-01-21 10:33:09 +0100392static int dma_device_satisfies_mask(struct dma_device *device,
393 const dma_cap_mask_t *want)
Dan Williamsd379b012007-07-09 11:56:42 -0700394{
395 dma_cap_mask_t has;
396
Dan Williams59b5ec22009-01-06 11:38:15 -0700397 bitmap_and(has.bits, want->bits, device->cap_mask.bits,
Dan Williamsd379b012007-07-09 11:56:42 -0700398 DMA_TX_TYPE_END);
399 return bitmap_equal(want->bits, has.bits, DMA_TX_TYPE_END);
400}
401
Dan Williams6f49a572009-01-06 11:38:14 -0700402static struct module *dma_chan_to_owner(struct dma_chan *chan)
403{
Logan Gunthorpedae7a582019-12-16 12:01:16 -0700404 return chan->device->owner;
Dan Williams6f49a572009-01-06 11:38:14 -0700405}
406
407/**
408 * balance_ref_count - catch up the channel reference count
Andy Shevchenko9872e232020-04-29 15:21:51 +0300409 * @chan: channel to balance ->client_count versus dmaengine_ref_count
Dan Williams6f49a572009-01-06 11:38:14 -0700410 *
Andy Shevchenko9872e232020-04-29 15:21:51 +0300411 * Must be called under dma_list_mutex.
Dan Williams6f49a572009-01-06 11:38:14 -0700412 */
413static void balance_ref_count(struct dma_chan *chan)
414{
415 struct module *owner = dma_chan_to_owner(chan);
416
417 while (chan->client_count < dmaengine_ref_count) {
418 __module_get(owner);
419 chan->client_count++;
420 }
421}
422
Logan Gunthorpe8ad342a2019-12-16 12:01:19 -0700423static void dma_device_release(struct kref *ref)
424{
425 struct dma_device *device = container_of(ref, struct dma_device, ref);
426
427 list_del_rcu(&device->global_node);
428 dma_channel_rebalance();
429
430 if (device->device_release)
431 device->device_release(device);
432}
433
434static void dma_device_put(struct dma_device *device)
435{
436 lockdep_assert_held(&dma_list_mutex);
437 kref_put(&device->ref, dma_device_release);
438}
439
Dan Williams6f49a572009-01-06 11:38:14 -0700440/**
Andy Shevchenko9872e232020-04-29 15:21:51 +0300441 * dma_chan_get - try to grab a DMA channel's parent driver module
442 * @chan: channel to grab
Dan Williams6f49a572009-01-06 11:38:14 -0700443 *
Andy Shevchenko9872e232020-04-29 15:21:51 +0300444 * Must be called under dma_list_mutex.
Dan Williams6f49a572009-01-06 11:38:14 -0700445 */
446static int dma_chan_get(struct dma_chan *chan)
447{
Dan Williams6f49a572009-01-06 11:38:14 -0700448 struct module *owner = dma_chan_to_owner(chan);
Maxime Ripardd2f4f992014-11-17 14:41:58 +0100449 int ret;
Dan Williams6f49a572009-01-06 11:38:14 -0700450
Maxime Ripardd2f4f992014-11-17 14:41:58 +0100451 /* The channel is already in use, update client count */
Dan Williams6f49a572009-01-06 11:38:14 -0700452 if (chan->client_count) {
453 __module_get(owner);
Maxime Ripardd2f4f992014-11-17 14:41:58 +0100454 goto out;
Dan Williams6f49a572009-01-06 11:38:14 -0700455 }
456
Maxime Ripardd2f4f992014-11-17 14:41:58 +0100457 if (!try_module_get(owner))
458 return -ENODEV;
459
Logan Gunthorpe8ad342a2019-12-16 12:01:19 -0700460 ret = kref_get_unless_zero(&chan->device->ref);
461 if (!ret) {
462 ret = -ENODEV;
463 goto module_put_out;
464 }
465
Maxime Ripardd2f4f992014-11-17 14:41:58 +0100466 /* allocate upon first client reference */
Maxime Ripardc4b54a62014-11-17 14:41:59 +0100467 if (chan->device->device_alloc_chan_resources) {
468 ret = chan->device->device_alloc_chan_resources(chan);
469 if (ret < 0)
470 goto err_out;
471 }
Maxime Ripardd2f4f992014-11-17 14:41:58 +0100472
473 if (!dma_has_cap(DMA_PRIVATE, chan->device->cap_mask))
474 balance_ref_count(chan);
475
476out:
477 chan->client_count++;
478 return 0;
479
480err_out:
Logan Gunthorpe8ad342a2019-12-16 12:01:19 -0700481 dma_device_put(chan->device);
482module_put_out:
Maxime Ripardd2f4f992014-11-17 14:41:58 +0100483 module_put(owner);
484 return ret;
Dan Williams6f49a572009-01-06 11:38:14 -0700485}
486
487/**
Andy Shevchenko9872e232020-04-29 15:21:51 +0300488 * dma_chan_put - drop a reference to a DMA channel's parent driver module
489 * @chan: channel to release
Dan Williams6f49a572009-01-06 11:38:14 -0700490 *
Andy Shevchenko9872e232020-04-29 15:21:51 +0300491 * Must be called under dma_list_mutex.
Dan Williams6f49a572009-01-06 11:38:14 -0700492 */
493static void dma_chan_put(struct dma_chan *chan)
494{
Maxime Ripardc4b54a62014-11-17 14:41:59 +0100495 /* This channel is not in use, bail out */
Dan Williams6f49a572009-01-06 11:38:14 -0700496 if (!chan->client_count)
Maxime Ripardc4b54a62014-11-17 14:41:59 +0100497 return;
498
Dan Williams6f49a572009-01-06 11:38:14 -0700499 chan->client_count--;
Maxime Ripardc4b54a62014-11-17 14:41:59 +0100500
501 /* This channel is not in use anymore, free it */
Lars-Peter Clausenb36f09c2015-10-20 11:46:28 +0200502 if (!chan->client_count && chan->device->device_free_chan_resources) {
503 /* Make sure all operations have completed */
504 dmaengine_synchronize(chan);
Dan Williams6f49a572009-01-06 11:38:14 -0700505 chan->device->device_free_chan_resources(chan);
Lars-Peter Clausenb36f09c2015-10-20 11:46:28 +0200506 }
Peter Ujfalusi56f13c02015-04-09 12:35:47 +0300507
508 /* If the channel is used via a DMA request router, free the mapping */
509 if (chan->router && chan->router->route_free) {
510 chan->router->route_free(chan->router->dev, chan->route_data);
511 chan->router = NULL;
512 chan->route_data = NULL;
513 }
Vinod Koul83c77942019-12-24 10:22:15 +0530514
515 dma_device_put(chan->device);
516 module_put(dma_chan_to_owner(chan));
Dan Williams6f49a572009-01-06 11:38:14 -0700517}
518
Dan Williams7405f742007-01-02 11:10:43 -0700519enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie)
520{
521 enum dma_status status;
522 unsigned long dma_sync_wait_timeout = jiffies + msecs_to_jiffies(5000);
523
524 dma_async_issue_pending(chan);
525 do {
526 status = dma_async_is_tx_complete(chan, cookie, NULL, NULL);
527 if (time_after_eq(jiffies, dma_sync_wait_timeout)) {
Jarkko Nikulaef859312016-03-14 16:51:09 +0200528 dev_err(chan->device->dev, "%s: timeout!\n", __func__);
Dan Williams7405f742007-01-02 11:10:43 -0700529 return DMA_ERROR;
530 }
Bartlomiej Zolnierkiewicz2cbe7fe2012-11-08 10:02:07 +0000531 if (status != DMA_IN_PROGRESS)
532 break;
533 cpu_relax();
534 } while (1);
Dan Williams7405f742007-01-02 11:10:43 -0700535
536 return status;
537}
538EXPORT_SYMBOL(dma_sync_wait);
539
Chris Leechc13c8262006-05-23 17:18:44 -0700540/**
Dan Williamsbec08512009-01-06 11:38:14 -0700541 * dma_find_channel - find a channel to carry out the operation
Andy Shevchenko9872e232020-04-29 15:21:51 +0300542 * @tx_type: transaction type
Dan Williamsbec08512009-01-06 11:38:14 -0700543 */
544struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type)
545{
Christoph Lametere7dcaa42009-10-03 19:48:23 +0900546 return this_cpu_read(channel_table[tx_type]->chan);
Dan Williamsbec08512009-01-06 11:38:14 -0700547}
548EXPORT_SYMBOL(dma_find_channel);
549
550/**
Dan Williams2ba05622009-01-06 11:38:14 -0700551 * dma_issue_pending_all - flush all pending operations across all channels
552 */
553void dma_issue_pending_all(void)
554{
555 struct dma_device *device;
556 struct dma_chan *chan;
557
Dan Williams2ba05622009-01-06 11:38:14 -0700558 rcu_read_lock();
Dan Williams59b5ec22009-01-06 11:38:15 -0700559 list_for_each_entry_rcu(device, &dma_device_list, global_node) {
560 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
561 continue;
Dan Williams2ba05622009-01-06 11:38:14 -0700562 list_for_each_entry(chan, &device->channels, device_node)
563 if (chan->client_count)
564 device->device_issue_pending(chan);
Dan Williams59b5ec22009-01-06 11:38:15 -0700565 }
Dan Williams2ba05622009-01-06 11:38:14 -0700566 rcu_read_unlock();
567}
568EXPORT_SYMBOL(dma_issue_pending_all);
569
Laurent Pinchart0d5484b2014-10-29 00:30:58 +0200570int dma_get_slave_caps(struct dma_chan *chan, struct dma_slave_caps *caps)
571{
572 struct dma_device *device;
573
574 if (!chan || !caps)
575 return -EINVAL;
576
577 device = chan->device;
578
579 /* check if the channel supports slave transactions */
Andy Shevchenkodd4e91d2016-05-10 20:43:34 +0300580 if (!(test_bit(DMA_SLAVE, device->cap_mask.bits) ||
581 test_bit(DMA_CYCLIC, device->cap_mask.bits)))
Laurent Pinchart0d5484b2014-10-29 00:30:58 +0200582 return -ENXIO;
583
584 /*
585 * Check whether it reports it uses the generic slave
586 * capabilities, if not, that means it doesn't support any
587 * kind of slave capabilities reporting.
588 */
589 if (!device->directions)
590 return -ENXIO;
591
592 caps->src_addr_widths = device->src_addr_widths;
593 caps->dst_addr_widths = device->dst_addr_widths;
594 caps->directions = device->directions;
Serge Semind97758e2020-07-23 03:58:41 +0300595 caps->min_burst = device->min_burst;
Shawn Lin6d5bbed2016-01-22 19:06:50 +0800596 caps->max_burst = device->max_burst;
Serge Seminb1b40b82020-07-23 03:58:42 +0300597 caps->max_sg_burst = device->max_sg_burst;
Laurent Pinchart0d5484b2014-10-29 00:30:58 +0200598 caps->residue_granularity = device->residue_granularity;
Robert Jarzmik9eeacd32015-10-13 21:54:29 +0200599 caps->descriptor_reuse = device->descriptor_reuse;
Marek Szyprowskid8095f92018-07-02 15:08:10 +0200600 caps->cmd_pause = !!device->device_pause;
601 caps->cmd_resume = !!device->device_resume;
Laurent Pinchart0d5484b2014-10-29 00:30:58 +0200602 caps->cmd_terminate = !!device->device_terminate_all;
603
Serge Semin3b6d6942020-07-23 03:58:43 +0300604 /*
605 * DMA engine device might be configured with non-uniformly
606 * distributed slave capabilities per device channels. In this
607 * case the corresponding driver may provide the device_caps
608 * callback to override the generic capabilities with
609 * channel-specific ones.
610 */
611 if (device->device_caps)
612 device->device_caps(chan, caps);
613
Laurent Pinchart0d5484b2014-10-29 00:30:58 +0200614 return 0;
615}
616EXPORT_SYMBOL_GPL(dma_get_slave_caps);
617
Lars-Peter Clausena53e28d2013-03-25 13:23:52 +0100618static struct dma_chan *private_candidate(const dma_cap_mask_t *mask,
619 struct dma_device *dev,
Dan Williamse2346672009-01-06 11:38:21 -0700620 dma_filter_fn fn, void *fn_param)
Dan Williams59b5ec22009-01-06 11:38:15 -0700621{
622 struct dma_chan *chan;
Dan Williams59b5ec22009-01-06 11:38:15 -0700623
Geert Uytterhoeven69b11892020-01-21 10:33:09 +0100624 if (mask && !dma_device_satisfies_mask(dev, mask)) {
Jarkko Nikulaef859312016-03-14 16:51:09 +0200625 dev_dbg(dev->dev, "%s: wrong capabilities\n", __func__);
Dan Williams59b5ec22009-01-06 11:38:15 -0700626 return NULL;
627 }
628 /* devices with multiple channels need special handling as we need to
629 * ensure that all channels are either private or public.
630 */
631 if (dev->chancnt > 1 && !dma_has_cap(DMA_PRIVATE, dev->cap_mask))
632 list_for_each_entry(chan, &dev->channels, device_node) {
633 /* some channels are already publicly allocated */
634 if (chan->client_count)
635 return NULL;
636 }
637
638 list_for_each_entry(chan, &dev->channels, device_node) {
639 if (chan->client_count) {
Jarkko Nikulaef859312016-03-14 16:51:09 +0200640 dev_dbg(dev->dev, "%s: %s busy\n",
Dan Williams41d5e592009-01-06 11:38:21 -0700641 __func__, dma_chan_name(chan));
Dan Williams59b5ec22009-01-06 11:38:15 -0700642 continue;
643 }
Dan Williamse2346672009-01-06 11:38:21 -0700644 if (fn && !fn(chan, fn_param)) {
Jarkko Nikulaef859312016-03-14 16:51:09 +0200645 dev_dbg(dev->dev, "%s: %s filter said false\n",
Dan Williamse2346672009-01-06 11:38:21 -0700646 __func__, dma_chan_name(chan));
647 continue;
648 }
649 return chan;
Dan Williams59b5ec22009-01-06 11:38:15 -0700650 }
651
Dan Williamse2346672009-01-06 11:38:21 -0700652 return NULL;
Dan Williams59b5ec22009-01-06 11:38:15 -0700653}
654
Peter Ujfalusi7bd903c2015-12-14 22:47:39 +0200655static struct dma_chan *find_candidate(struct dma_device *device,
656 const dma_cap_mask_t *mask,
657 dma_filter_fn fn, void *fn_param)
658{
659 struct dma_chan *chan = private_candidate(mask, device, fn, fn_param);
660 int err;
661
662 if (chan) {
663 /* Found a suitable channel, try to grab, prep, and return it.
664 * We first set DMA_PRIVATE to disable balance_ref_count as this
665 * channel will not be published in the general-purpose
666 * allocator
667 */
668 dma_cap_set(DMA_PRIVATE, device->cap_mask);
669 device->privatecnt++;
670 err = dma_chan_get(chan);
671
672 if (err) {
673 if (err == -ENODEV) {
Jarkko Nikulaef859312016-03-14 16:51:09 +0200674 dev_dbg(device->dev, "%s: %s module removed\n",
675 __func__, dma_chan_name(chan));
Peter Ujfalusi7bd903c2015-12-14 22:47:39 +0200676 list_del_rcu(&device->global_node);
677 } else
Jarkko Nikulaef859312016-03-14 16:51:09 +0200678 dev_dbg(device->dev,
679 "%s: failed to get %s: (%d)\n",
Peter Ujfalusi7bd903c2015-12-14 22:47:39 +0200680 __func__, dma_chan_name(chan), err);
681
682 if (--device->privatecnt == 0)
683 dma_cap_clear(DMA_PRIVATE, device->cap_mask);
684
685 chan = ERR_PTR(err);
686 }
687 }
688
689 return chan ? chan : ERR_PTR(-EPROBE_DEFER);
690}
691
Dan Williams59b5ec22009-01-06 11:38:15 -0700692/**
Stefan Agner19d643d2015-06-01 23:53:43 +0200693 * dma_get_slave_channel - try to get specific channel exclusively
Andy Shevchenko9872e232020-04-29 15:21:51 +0300694 * @chan: target channel
Zhangfei Gao7bb587f2013-06-28 20:39:12 +0800695 */
696struct dma_chan *dma_get_slave_channel(struct dma_chan *chan)
697{
698 int err = -EBUSY;
699
700 /* lock against __dma_request_channel */
701 mutex_lock(&dma_list_mutex);
702
Vinod Kould9a6c8f2013-08-19 10:47:26 +0530703 if (chan->client_count == 0) {
Peter Ujfalusi214fc4e2015-09-24 12:03:35 +0300704 struct dma_device *device = chan->device;
705
706 dma_cap_set(DMA_PRIVATE, device->cap_mask);
707 device->privatecnt++;
Zhangfei Gao7bb587f2013-06-28 20:39:12 +0800708 err = dma_chan_get(chan);
Peter Ujfalusi214fc4e2015-09-24 12:03:35 +0300709 if (err) {
Jarkko Nikulaef859312016-03-14 16:51:09 +0200710 dev_dbg(chan->device->dev,
711 "%s: failed to get %s: (%d)\n",
Vinod Kould9a6c8f2013-08-19 10:47:26 +0530712 __func__, dma_chan_name(chan), err);
Peter Ujfalusi214fc4e2015-09-24 12:03:35 +0300713 chan = NULL;
714 if (--device->privatecnt == 0)
715 dma_cap_clear(DMA_PRIVATE, device->cap_mask);
716 }
Vinod Kould9a6c8f2013-08-19 10:47:26 +0530717 } else
Zhangfei Gao7bb587f2013-06-28 20:39:12 +0800718 chan = NULL;
719
720 mutex_unlock(&dma_list_mutex);
721
Zhangfei Gao7bb587f2013-06-28 20:39:12 +0800722
723 return chan;
724}
725EXPORT_SYMBOL_GPL(dma_get_slave_channel);
726
Stephen Warren8010dad2013-11-26 12:40:51 -0700727struct dma_chan *dma_get_any_slave_channel(struct dma_device *device)
728{
729 dma_cap_mask_t mask;
730 struct dma_chan *chan;
Stephen Warren8010dad2013-11-26 12:40:51 -0700731
732 dma_cap_zero(mask);
733 dma_cap_set(DMA_SLAVE, mask);
734
735 /* lock against __dma_request_channel */
736 mutex_lock(&dma_list_mutex);
737
Peter Ujfalusi7bd903c2015-12-14 22:47:39 +0200738 chan = find_candidate(device, &mask, NULL, NULL);
Stephen Warren8010dad2013-11-26 12:40:51 -0700739
740 mutex_unlock(&dma_list_mutex);
741
Peter Ujfalusi7bd903c2015-12-14 22:47:39 +0200742 return IS_ERR(chan) ? NULL : chan;
Stephen Warren8010dad2013-11-26 12:40:51 -0700743}
744EXPORT_SYMBOL_GPL(dma_get_any_slave_channel);
745
Zhangfei Gao7bb587f2013-06-28 20:39:12 +0800746/**
Daniel Mack6b9019a2013-08-14 18:35:03 +0200747 * __dma_request_channel - try to allocate an exclusive channel
Andy Shevchenko9872e232020-04-29 15:21:51 +0300748 * @mask: capabilities that the channel must satisfy
749 * @fn: optional callback to disposition available channels
750 * @fn_param: opaque parameter to pass to dma_filter_fn()
751 * @np: device node to look for DMA channels
Stephen Warren0ad7c002013-11-26 10:04:22 -0700752 *
753 * Returns pointer to appropriate DMA channel on success or NULL.
Dan Williams59b5ec22009-01-06 11:38:15 -0700754 */
Lars-Peter Clausena53e28d2013-03-25 13:23:52 +0100755struct dma_chan *__dma_request_channel(const dma_cap_mask_t *mask,
Baolin Wangf5151312019-05-20 19:32:14 +0800756 dma_filter_fn fn, void *fn_param,
757 struct device_node *np)
Dan Williams59b5ec22009-01-06 11:38:15 -0700758{
759 struct dma_device *device, *_d;
760 struct dma_chan *chan = NULL;
Dan Williams59b5ec22009-01-06 11:38:15 -0700761
762 /* Find a channel */
763 mutex_lock(&dma_list_mutex);
764 list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
Baolin Wangf5151312019-05-20 19:32:14 +0800765 /* Finds a DMA controller with matching device node */
766 if (np && device->dev->of_node && np != device->dev->of_node)
767 continue;
768
Peter Ujfalusi7bd903c2015-12-14 22:47:39 +0200769 chan = find_candidate(device, mask, fn, fn_param);
770 if (!IS_ERR(chan))
771 break;
Dan Williams59b5ec22009-01-06 11:38:15 -0700772
Peter Ujfalusi7bd903c2015-12-14 22:47:39 +0200773 chan = NULL;
Dan Williams59b5ec22009-01-06 11:38:15 -0700774 }
775 mutex_unlock(&dma_list_mutex);
776
Jarkko Nikula4c4d7f872016-04-07 16:49:43 +0300777 pr_debug("%s: %s (%s)\n",
Joe Perches63433252012-07-18 09:51:28 -0700778 __func__,
779 chan ? "success" : "fail",
Dan Williams41d5e592009-01-06 11:38:21 -0700780 chan ? dma_chan_name(chan) : NULL);
Dan Williams59b5ec22009-01-06 11:38:15 -0700781
782 return chan;
783}
784EXPORT_SYMBOL_GPL(__dma_request_channel);
785
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200786static const struct dma_slave_map *dma_filter_match(struct dma_device *device,
787 const char *name,
788 struct device *dev)
789{
790 int i;
791
792 if (!device->filter.mapcnt)
793 return NULL;
794
795 for (i = 0; i < device->filter.mapcnt; i++) {
796 const struct dma_slave_map *map = &device->filter.map[i];
797
798 if (!strcmp(map->devname, dev_name(dev)) &&
799 !strcmp(map->slave, name))
800 return map;
801 }
802
803 return NULL;
804}
805
Jon Hunter9a6cecc2012-09-14 17:41:57 -0500806/**
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200807 * dma_request_chan - try to allocate an exclusive slave channel
Jon Hunter9a6cecc2012-09-14 17:41:57 -0500808 * @dev: pointer to client device structure
809 * @name: slave channel name
Stephen Warren0ad7c002013-11-26 10:04:22 -0700810 *
811 * Returns pointer to appropriate DMA channel on success or an error pointer.
Jon Hunter9a6cecc2012-09-14 17:41:57 -0500812 */
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200813struct dma_chan *dma_request_chan(struct device *dev, const char *name)
Jon Hunter9a6cecc2012-09-14 17:41:57 -0500814{
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200815 struct dma_device *d, *_d;
816 struct dma_chan *chan = NULL;
817
Jon Hunter9a6cecc2012-09-14 17:41:57 -0500818 /* If device-tree is present get slave info from here */
819 if (dev->of_node)
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200820 chan = of_dma_request_slave_channel(dev->of_node, name);
Jon Hunter9a6cecc2012-09-14 17:41:57 -0500821
Andy Shevchenko4e82f5d2013-04-09 14:05:44 +0300822 /* If device was enumerated by ACPI get slave info from here */
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200823 if (has_acpi_companion(dev) && !chan)
824 chan = acpi_dma_request_slave_chan_by_name(dev, name);
Andy Shevchenko4e82f5d2013-04-09 14:05:44 +0300825
Geert Uytterhoeven71723a92020-01-17 16:30:56 +0100826 if (PTR_ERR(chan) == -EPROBE_DEFER)
827 return chan;
828
829 if (!IS_ERR_OR_NULL(chan))
830 goto found;
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200831
832 /* Try to find the channel via the DMA filter map(s) */
833 mutex_lock(&dma_list_mutex);
834 list_for_each_entry_safe(d, _d, &dma_device_list, global_node) {
835 dma_cap_mask_t mask;
836 const struct dma_slave_map *map = dma_filter_match(d, name, dev);
837
838 if (!map)
839 continue;
840
841 dma_cap_zero(mask);
842 dma_cap_set(DMA_SLAVE, mask);
843
844 chan = find_candidate(d, &mask, d->filter.fn, map->param);
845 if (!IS_ERR(chan))
846 break;
847 }
848 mutex_unlock(&dma_list_mutex);
849
Andy Shevchenko5d7e8162020-08-28 17:45:19 +0300850 if (IS_ERR(chan))
851 return chan;
852 if (!chan)
853 return ERR_PTR(-EPROBE_DEFER);
Geert Uytterhoeven71723a92020-01-17 16:30:56 +0100854
855found:
Peter Ujfalusie937cc12020-03-06 16:28:37 +0200856#ifdef CONFIG_DEBUG_FS
857 chan->dbg_client_name = kasprintf(GFP_KERNEL, "%s:%s", dev_name(dev),
858 name);
859#endif
860
Geert Uytterhoeven71723a92020-01-17 16:30:56 +0100861 chan->name = kasprintf(GFP_KERNEL, "dma:%s", name);
862 if (!chan->name)
Peter Ujfalusibad83562020-01-31 11:38:58 +0200863 return chan;
864 chan->slave = dev;
Geert Uytterhoeven71723a92020-01-17 16:30:56 +0100865
866 if (sysfs_create_link(&chan->dev->device.kobj, &dev->kobj,
867 DMA_SLAVE_NAME))
Peter Ujfalusibad83562020-01-31 11:38:58 +0200868 dev_warn(dev, "Cannot create DMA %s symlink\n", DMA_SLAVE_NAME);
Geert Uytterhoeven71723a92020-01-17 16:30:56 +0100869 if (sysfs_create_link(&dev->kobj, &chan->dev->device.kobj, chan->name))
Peter Ujfalusibad83562020-01-31 11:38:58 +0200870 dev_warn(dev, "Cannot create DMA %s symlink\n", chan->name);
871
Geert Uytterhoeven71723a92020-01-17 16:30:56 +0100872 return chan;
Stephen Warren0ad7c002013-11-26 10:04:22 -0700873}
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200874EXPORT_SYMBOL_GPL(dma_request_chan);
Stephen Warren0ad7c002013-11-26 10:04:22 -0700875
876/**
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200877 * dma_request_chan_by_mask - allocate a channel satisfying certain capabilities
Andy Shevchenko9872e232020-04-29 15:21:51 +0300878 * @mask: capabilities that the channel must satisfy
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200879 *
880 * Returns pointer to appropriate DMA channel on success or an error pointer.
881 */
882struct dma_chan *dma_request_chan_by_mask(const dma_cap_mask_t *mask)
883{
884 struct dma_chan *chan;
885
886 if (!mask)
887 return ERR_PTR(-ENODEV);
888
Baolin Wangf5151312019-05-20 19:32:14 +0800889 chan = __dma_request_channel(mask, NULL, NULL, NULL);
Peter Ujfalusiec8ca8e2018-07-18 12:29:57 +0300890 if (!chan) {
891 mutex_lock(&dma_list_mutex);
892 if (list_empty(&dma_device_list))
893 chan = ERR_PTR(-EPROBE_DEFER);
894 else
895 chan = ERR_PTR(-ENODEV);
896 mutex_unlock(&dma_list_mutex);
897 }
Peter Ujfalusia8135d02015-12-14 22:47:40 +0200898
899 return chan;
900}
901EXPORT_SYMBOL_GPL(dma_request_chan_by_mask);
902
Dan Williams59b5ec22009-01-06 11:38:15 -0700903void dma_release_channel(struct dma_chan *chan)
904{
905 mutex_lock(&dma_list_mutex);
906 WARN_ONCE(chan->client_count != 1,
907 "chan reference count %d != 1\n", chan->client_count);
908 dma_chan_put(chan);
Atsushi Nemoto0f571512009-03-06 20:07:14 +0900909 /* drop PRIVATE cap enabled by __dma_request_channel() */
910 if (--chan->device->privatecnt == 0)
911 dma_cap_clear(DMA_PRIVATE, chan->device->cap_mask);
Peter Ujfalusibad83562020-01-31 11:38:58 +0200912
Geert Uytterhoeven71723a92020-01-17 16:30:56 +0100913 if (chan->slave) {
Peter Ujfalusibad83562020-01-31 11:38:58 +0200914 sysfs_remove_link(&chan->dev->device.kobj, DMA_SLAVE_NAME);
Geert Uytterhoeven71723a92020-01-17 16:30:56 +0100915 sysfs_remove_link(&chan->slave->kobj, chan->name);
916 kfree(chan->name);
917 chan->name = NULL;
918 chan->slave = NULL;
919 }
Peter Ujfalusie937cc12020-03-06 16:28:37 +0200920
921#ifdef CONFIG_DEBUG_FS
922 kfree(chan->dbg_client_name);
923 chan->dbg_client_name = NULL;
924#endif
Dan Williams59b5ec22009-01-06 11:38:15 -0700925 mutex_unlock(&dma_list_mutex);
926}
927EXPORT_SYMBOL_GPL(dma_release_channel);
928
Dan Williamsbec08512009-01-06 11:38:14 -0700929/**
Dan Williams209b84a2009-01-06 11:38:17 -0700930 * dmaengine_get - register interest in dma_channels
Chris Leechc13c8262006-05-23 17:18:44 -0700931 */
Dan Williams209b84a2009-01-06 11:38:17 -0700932void dmaengine_get(void)
Chris Leechc13c8262006-05-23 17:18:44 -0700933{
Dan Williams6f49a572009-01-06 11:38:14 -0700934 struct dma_device *device, *_d;
935 struct dma_chan *chan;
936 int err;
937
Chris Leechc13c8262006-05-23 17:18:44 -0700938 mutex_lock(&dma_list_mutex);
Dan Williams6f49a572009-01-06 11:38:14 -0700939 dmaengine_ref_count++;
940
941 /* try to grab channels */
Dan Williams59b5ec22009-01-06 11:38:15 -0700942 list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
943 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
944 continue;
Dan Williams6f49a572009-01-06 11:38:14 -0700945 list_for_each_entry(chan, &device->channels, device_node) {
946 err = dma_chan_get(chan);
947 if (err == -ENODEV) {
948 /* module removed before we could use it */
Dan Williams2ba05622009-01-06 11:38:14 -0700949 list_del_rcu(&device->global_node);
Dan Williams6f49a572009-01-06 11:38:14 -0700950 break;
951 } else if (err)
Jarkko Nikulaef859312016-03-14 16:51:09 +0200952 dev_dbg(chan->device->dev,
953 "%s: failed to get %s: (%d)\n",
954 __func__, dma_chan_name(chan), err);
Dan Williams6f49a572009-01-06 11:38:14 -0700955 }
Dan Williams59b5ec22009-01-06 11:38:15 -0700956 }
Dan Williams6f49a572009-01-06 11:38:14 -0700957
Dan Williamsbec08512009-01-06 11:38:14 -0700958 /* if this is the first reference and there were channels
959 * waiting we need to rebalance to get those channels
960 * incorporated into the channel table
961 */
962 if (dmaengine_ref_count == 1)
963 dma_channel_rebalance();
Chris Leechc13c8262006-05-23 17:18:44 -0700964 mutex_unlock(&dma_list_mutex);
Chris Leechc13c8262006-05-23 17:18:44 -0700965}
Dan Williams209b84a2009-01-06 11:38:17 -0700966EXPORT_SYMBOL(dmaengine_get);
Chris Leechc13c8262006-05-23 17:18:44 -0700967
968/**
Andy Shevchenko9872e232020-04-29 15:21:51 +0300969 * dmaengine_put - let DMA drivers be removed when ref_count == 0
Chris Leechc13c8262006-05-23 17:18:44 -0700970 */
Dan Williams209b84a2009-01-06 11:38:17 -0700971void dmaengine_put(void)
Chris Leechc13c8262006-05-23 17:18:44 -0700972{
Logan Gunthorpe8ad342a2019-12-16 12:01:19 -0700973 struct dma_device *device, *_d;
Chris Leechc13c8262006-05-23 17:18:44 -0700974 struct dma_chan *chan;
975
Chris Leechc13c8262006-05-23 17:18:44 -0700976 mutex_lock(&dma_list_mutex);
Dan Williams6f49a572009-01-06 11:38:14 -0700977 dmaengine_ref_count--;
978 BUG_ON(dmaengine_ref_count < 0);
979 /* drop channel references */
Logan Gunthorpe8ad342a2019-12-16 12:01:19 -0700980 list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
Dan Williams59b5ec22009-01-06 11:38:15 -0700981 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
982 continue;
Dan Williams6f49a572009-01-06 11:38:14 -0700983 list_for_each_entry(chan, &device->channels, device_node)
984 dma_chan_put(chan);
Dan Williams59b5ec22009-01-06 11:38:15 -0700985 }
Chris Leechc13c8262006-05-23 17:18:44 -0700986 mutex_unlock(&dma_list_mutex);
Chris Leechc13c8262006-05-23 17:18:44 -0700987}
Dan Williams209b84a2009-01-06 11:38:17 -0700988EXPORT_SYMBOL(dmaengine_put);
Chris Leechc13c8262006-05-23 17:18:44 -0700989
Dan Williams138f4c32009-09-08 17:42:51 -0700990static bool device_has_all_tx_types(struct dma_device *device)
991{
992 /* A device that satisfies this test has channels that will never cause
993 * an async_tx channel switch event as all possible operation types can
994 * be handled.
995 */
996 #ifdef CONFIG_ASYNC_TX_DMA
997 if (!dma_has_cap(DMA_INTERRUPT, device->cap_mask))
998 return false;
999 #endif
1000
Javier Martinez Canillasd57d3a42016-05-11 13:39:27 -04001001 #if IS_ENABLED(CONFIG_ASYNC_MEMCPY)
Dan Williams138f4c32009-09-08 17:42:51 -07001002 if (!dma_has_cap(DMA_MEMCPY, device->cap_mask))
1003 return false;
1004 #endif
1005
Javier Martinez Canillasd57d3a42016-05-11 13:39:27 -04001006 #if IS_ENABLED(CONFIG_ASYNC_XOR)
Dan Williams138f4c32009-09-08 17:42:51 -07001007 if (!dma_has_cap(DMA_XOR, device->cap_mask))
1008 return false;
Dan Williams7b3cc2b2009-11-19 17:10:37 -07001009
1010 #ifndef CONFIG_ASYNC_TX_DISABLE_XOR_VAL_DMA
Dan Williams4499a242009-11-19 17:10:25 -07001011 if (!dma_has_cap(DMA_XOR_VAL, device->cap_mask))
1012 return false;
Dan Williams138f4c32009-09-08 17:42:51 -07001013 #endif
Dan Williams7b3cc2b2009-11-19 17:10:37 -07001014 #endif
Dan Williams138f4c32009-09-08 17:42:51 -07001015
Javier Martinez Canillasd57d3a42016-05-11 13:39:27 -04001016 #if IS_ENABLED(CONFIG_ASYNC_PQ)
Dan Williams138f4c32009-09-08 17:42:51 -07001017 if (!dma_has_cap(DMA_PQ, device->cap_mask))
1018 return false;
Dan Williams7b3cc2b2009-11-19 17:10:37 -07001019
1020 #ifndef CONFIG_ASYNC_TX_DISABLE_PQ_VAL_DMA
Dan Williams4499a242009-11-19 17:10:25 -07001021 if (!dma_has_cap(DMA_PQ_VAL, device->cap_mask))
1022 return false;
Dan Williams138f4c32009-09-08 17:42:51 -07001023 #endif
Dan Williams7b3cc2b2009-11-19 17:10:37 -07001024 #endif
Dan Williams138f4c32009-09-08 17:42:51 -07001025
1026 return true;
1027}
1028
Dan Williams257b17c2009-03-25 09:13:23 -07001029static int get_dma_id(struct dma_device *device)
1030{
Matthew Wilcox485258b2018-06-18 15:41:48 -04001031 int rc = ida_alloc(&dma_ida, GFP_KERNEL);
Dan Williams257b17c2009-03-25 09:13:23 -07001032
Matthew Wilcox485258b2018-06-18 15:41:48 -04001033 if (rc < 0)
1034 return rc;
1035 device->dev_id = rc;
1036 return 0;
Dan Williams257b17c2009-03-25 09:13:23 -07001037}
1038
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001039static int __dma_async_device_channel_register(struct dma_device *device,
Dave Jiang08210092020-04-13 10:40:12 -07001040 struct dma_chan *chan)
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001041{
Dan Carpenter7e4be122020-11-13 13:16:31 +03001042 int rc;
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001043
1044 chan->local = alloc_percpu(typeof(*chan->local));
1045 if (!chan->local)
Dan Carpenter7e4be122020-11-13 13:16:31 +03001046 return -ENOMEM;
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001047 chan->dev = kzalloc(sizeof(*chan->dev), GFP_KERNEL);
1048 if (!chan->dev) {
Dan Carpenter7e4be122020-11-13 13:16:31 +03001049 rc = -ENOMEM;
1050 goto err_free_local;
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001051 }
1052
1053 /*
1054 * When the chan_id is a negative value, we are dynamically adding
1055 * the channel. Otherwise we are static enumerating.
1056 */
Dave Jiang08210092020-04-13 10:40:12 -07001057 mutex_lock(&device->chan_mutex);
1058 chan->chan_id = ida_alloc(&device->chan_ida, GFP_KERNEL);
1059 mutex_unlock(&device->chan_mutex);
1060 if (chan->chan_id < 0) {
1061 pr_err("%s: unable to alloc ida for chan: %d\n",
1062 __func__, chan->chan_id);
Dan Carpenter7e4be122020-11-13 13:16:31 +03001063 rc = chan->chan_id;
1064 goto err_free_dev;
Dave Jiang08210092020-04-13 10:40:12 -07001065 }
1066
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001067 chan->dev->device.class = &dma_devclass;
1068 chan->dev->device.parent = device->dev;
1069 chan->dev->chan = chan;
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001070 chan->dev->dev_id = device->dev_id;
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001071 dev_set_name(&chan->dev->device, "dma%dchan%d",
1072 device->dev_id, chan->chan_id);
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001073 rc = device_register(&chan->dev->device);
1074 if (rc)
Dave Jiang08210092020-04-13 10:40:12 -07001075 goto err_out_ida;
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001076 chan->client_count = 0;
Dave Jiang08210092020-04-13 10:40:12 -07001077 device->chancnt++;
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001078
1079 return 0;
1080
Dave Jiang08210092020-04-13 10:40:12 -07001081 err_out_ida:
1082 mutex_lock(&device->chan_mutex);
1083 ida_free(&device->chan_ida, chan->chan_id);
1084 mutex_unlock(&device->chan_mutex);
Dan Carpenter7e4be122020-11-13 13:16:31 +03001085 err_free_dev:
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001086 kfree(chan->dev);
Dan Carpenter7e4be122020-11-13 13:16:31 +03001087 err_free_local:
1088 free_percpu(chan->local);
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001089 return rc;
1090}
1091
Dave Jiange81274c2020-01-21 16:43:53 -07001092int dma_async_device_channel_register(struct dma_device *device,
1093 struct dma_chan *chan)
1094{
1095 int rc;
1096
Dave Jiang08210092020-04-13 10:40:12 -07001097 rc = __dma_async_device_channel_register(device, chan);
Dave Jiange81274c2020-01-21 16:43:53 -07001098 if (rc < 0)
1099 return rc;
1100
1101 dma_channel_rebalance();
1102 return 0;
1103}
1104EXPORT_SYMBOL_GPL(dma_async_device_channel_register);
1105
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001106static void __dma_async_device_channel_unregister(struct dma_device *device,
1107 struct dma_chan *chan)
1108{
1109 WARN_ONCE(!device->device_release && chan->client_count,
1110 "%s called while %d clients hold a reference\n",
1111 __func__, chan->client_count);
1112 mutex_lock(&dma_list_mutex);
Dave Jiange81274c2020-01-21 16:43:53 -07001113 list_del(&chan->device_node);
1114 device->chancnt--;
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001115 chan->dev->chan = NULL;
1116 mutex_unlock(&dma_list_mutex);
Dave Jiang08210092020-04-13 10:40:12 -07001117 mutex_lock(&device->chan_mutex);
1118 ida_free(&device->chan_ida, chan->chan_id);
1119 mutex_unlock(&device->chan_mutex);
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001120 device_unregister(&chan->dev->device);
1121 free_percpu(chan->local);
1122}
1123
Dave Jiange81274c2020-01-21 16:43:53 -07001124void dma_async_device_channel_unregister(struct dma_device *device,
1125 struct dma_chan *chan)
1126{
1127 __dma_async_device_channel_unregister(device, chan);
1128 dma_channel_rebalance();
1129}
1130EXPORT_SYMBOL_GPL(dma_async_device_channel_unregister);
1131
Chris Leechc13c8262006-05-23 17:18:44 -07001132/**
Randy Dunlap65088712006-07-03 19:45:31 -07001133 * dma_async_device_register - registers DMA devices found
Andy Shevchenko9872e232020-04-29 15:21:51 +03001134 * @device: pointer to &struct dma_device
Logan Gunthorpe8ad342a2019-12-16 12:01:19 -07001135 *
1136 * After calling this routine the structure should not be freed except in the
1137 * device_release() callback which will be called after
1138 * dma_async_device_unregister() is called and no further references are taken.
Chris Leechc13c8262006-05-23 17:18:44 -07001139 */
1140int dma_async_device_register(struct dma_device *device)
1141{
Dave Jiang08210092020-04-13 10:40:12 -07001142 int rc;
Chris Leechc13c8262006-05-23 17:18:44 -07001143 struct dma_chan* chan;
1144
1145 if (!device)
1146 return -ENODEV;
1147
Dan Williams7405f742007-01-02 11:10:43 -07001148 /* validate device routines */
Vinod Koul3eeb5152017-08-27 16:55:32 +05301149 if (!device->dev) {
1150 pr_err("DMAdevice must have dev\n");
1151 return -EIO;
1152 }
Dan Williams7405f742007-01-02 11:10:43 -07001153
Logan Gunthorpedae7a582019-12-16 12:01:16 -07001154 device->owner = device->dev->driver->owner;
1155
Vinod Koul3eeb5152017-08-27 16:55:32 +05301156 if (dma_has_cap(DMA_MEMCPY, device->cap_mask) && !device->device_prep_dma_memcpy) {
1157 dev_err(device->dev,
1158 "Device claims capability %s, but op is not defined\n",
1159 "DMA_MEMCPY");
1160 return -EIO;
1161 }
1162
1163 if (dma_has_cap(DMA_XOR, device->cap_mask) && !device->device_prep_dma_xor) {
1164 dev_err(device->dev,
1165 "Device claims capability %s, but op is not defined\n",
1166 "DMA_XOR");
1167 return -EIO;
1168 }
1169
1170 if (dma_has_cap(DMA_XOR_VAL, device->cap_mask) && !device->device_prep_dma_xor_val) {
1171 dev_err(device->dev,
1172 "Device claims capability %s, but op is not defined\n",
1173 "DMA_XOR_VAL");
1174 return -EIO;
1175 }
1176
1177 if (dma_has_cap(DMA_PQ, device->cap_mask) && !device->device_prep_dma_pq) {
1178 dev_err(device->dev,
1179 "Device claims capability %s, but op is not defined\n",
1180 "DMA_PQ");
1181 return -EIO;
1182 }
1183
1184 if (dma_has_cap(DMA_PQ_VAL, device->cap_mask) && !device->device_prep_dma_pq_val) {
1185 dev_err(device->dev,
1186 "Device claims capability %s, but op is not defined\n",
1187 "DMA_PQ_VAL");
1188 return -EIO;
1189 }
1190
1191 if (dma_has_cap(DMA_MEMSET, device->cap_mask) && !device->device_prep_dma_memset) {
1192 dev_err(device->dev,
1193 "Device claims capability %s, but op is not defined\n",
1194 "DMA_MEMSET");
1195 return -EIO;
1196 }
1197
1198 if (dma_has_cap(DMA_INTERRUPT, device->cap_mask) && !device->device_prep_dma_interrupt) {
1199 dev_err(device->dev,
1200 "Device claims capability %s, but op is not defined\n",
1201 "DMA_INTERRUPT");
1202 return -EIO;
1203 }
1204
1205 if (dma_has_cap(DMA_CYCLIC, device->cap_mask) && !device->device_prep_dma_cyclic) {
1206 dev_err(device->dev,
1207 "Device claims capability %s, but op is not defined\n",
1208 "DMA_CYCLIC");
1209 return -EIO;
1210 }
1211
1212 if (dma_has_cap(DMA_INTERLEAVE, device->cap_mask) && !device->device_prep_interleaved_dma) {
1213 dev_err(device->dev,
1214 "Device claims capability %s, but op is not defined\n",
1215 "DMA_INTERLEAVE");
1216 return -EIO;
1217 }
1218
1219
1220 if (!device->device_tx_status) {
1221 dev_err(device->dev, "Device tx_status is not defined\n");
1222 return -EIO;
1223 }
1224
1225
1226 if (!device->device_issue_pending) {
1227 dev_err(device->dev, "Device issue_pending is not defined\n");
1228 return -EIO;
1229 }
Dan Williams7405f742007-01-02 11:10:43 -07001230
Logan Gunthorpe8ad342a2019-12-16 12:01:19 -07001231 if (!device->device_release)
Vinod Koulf91da3b2020-03-06 19:20:18 +05301232 dev_dbg(device->dev,
Logan Gunthorpe8ad342a2019-12-16 12:01:19 -07001233 "WARN: Device release is not defined so it is not safe to unbind this driver while in use\n");
1234
1235 kref_init(&device->ref);
1236
Dan Williams138f4c32009-09-08 17:42:51 -07001237 /* note: this only matters in the
Dan Williams5fc6d892010-10-07 16:44:50 -07001238 * CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH=n case
Dan Williams138f4c32009-09-08 17:42:51 -07001239 */
1240 if (device_has_all_tx_types(device))
1241 dma_cap_set(DMA_ASYNC_TX, device->cap_mask);
1242
Dan Williams257b17c2009-03-25 09:13:23 -07001243 rc = get_dma_id(device);
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001244 if (rc != 0)
Dan Williams864498a2009-01-06 11:38:21 -07001245 return rc;
Chris Leechc13c8262006-05-23 17:18:44 -07001246
Dave Jiang08210092020-04-13 10:40:12 -07001247 mutex_init(&device->chan_mutex);
1248 ida_init(&device->chan_ida);
1249
Chris Leechc13c8262006-05-23 17:18:44 -07001250 /* represent channels in sysfs. Probably want devs too */
1251 list_for_each_entry(chan, &device->channels, device_node) {
Dave Jiang08210092020-04-13 10:40:12 -07001252 rc = __dma_async_device_channel_register(device, chan);
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001253 if (rc < 0)
Dan Williams257b17c2009-03-25 09:13:23 -07001254 goto err_out;
Chris Leechc13c8262006-05-23 17:18:44 -07001255 }
Viresh Kumar76d7b842016-07-27 14:32:58 -07001256
Chris Leechc13c8262006-05-23 17:18:44 -07001257 mutex_lock(&dma_list_mutex);
Dan Williams59b5ec22009-01-06 11:38:15 -07001258 /* take references on public channels */
1259 if (dmaengine_ref_count && !dma_has_cap(DMA_PRIVATE, device->cap_mask))
Dan Williams6f49a572009-01-06 11:38:14 -07001260 list_for_each_entry(chan, &device->channels, device_node) {
1261 /* if clients are already waiting for channels we need
1262 * to take references on their behalf
1263 */
1264 if (dma_chan_get(chan) == -ENODEV) {
1265 /* note we can only get here for the first
1266 * channel as the remaining channels are
1267 * guaranteed to get a reference
1268 */
1269 rc = -ENODEV;
1270 mutex_unlock(&dma_list_mutex);
1271 goto err_out;
1272 }
1273 }
Dan Williams2ba05622009-01-06 11:38:14 -07001274 list_add_tail_rcu(&device->global_node, &dma_device_list);
Atsushi Nemoto0f571512009-03-06 20:07:14 +09001275 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
1276 device->privatecnt++; /* Always private */
Dan Williamsbec08512009-01-06 11:38:14 -07001277 dma_channel_rebalance();
Chris Leechc13c8262006-05-23 17:18:44 -07001278 mutex_unlock(&dma_list_mutex);
1279
Peter Ujfalusi26cf1322020-03-06 16:28:39 +02001280 dmaengine_debug_register(device);
1281
Chris Leechc13c8262006-05-23 17:18:44 -07001282 return 0;
Jeff Garzikff487fb2007-03-08 09:57:34 -08001283
1284err_out:
Dan Williams257b17c2009-03-25 09:13:23 -07001285 /* if we never registered a channel just release the idr */
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001286 if (!device->chancnt) {
Matthew Wilcox485258b2018-06-18 15:41:48 -04001287 ida_free(&dma_ida, device->dev_id);
Dan Williams257b17c2009-03-25 09:13:23 -07001288 return rc;
1289 }
1290
Jeff Garzikff487fb2007-03-08 09:57:34 -08001291 list_for_each_entry(chan, &device->channels, device_node) {
1292 if (chan->local == NULL)
1293 continue;
Dan Williams41d5e592009-01-06 11:38:21 -07001294 mutex_lock(&dma_list_mutex);
1295 chan->dev->chan = NULL;
1296 mutex_unlock(&dma_list_mutex);
1297 device_unregister(&chan->dev->device);
Jeff Garzikff487fb2007-03-08 09:57:34 -08001298 free_percpu(chan->local);
1299 }
1300 return rc;
Chris Leechc13c8262006-05-23 17:18:44 -07001301}
David Brownell765e3d82007-03-16 13:38:05 -08001302EXPORT_SYMBOL(dma_async_device_register);
Chris Leechc13c8262006-05-23 17:18:44 -07001303
1304/**
Dan Williams6f49a572009-01-06 11:38:14 -07001305 * dma_async_device_unregister - unregister a DMA device
Andy Shevchenko9872e232020-04-29 15:21:51 +03001306 * @device: pointer to &struct dma_device
Dan Williamsf27c5802009-01-06 11:38:18 -07001307 *
1308 * This routine is called by dma driver exit routines, dmaengine holds module
1309 * references to prevent it being called while channels are in use.
Randy Dunlap65088712006-07-03 19:45:31 -07001310 */
1311void dma_async_device_unregister(struct dma_device *device)
Chris Leechc13c8262006-05-23 17:18:44 -07001312{
Dave Jiange81274c2020-01-21 16:43:53 -07001313 struct dma_chan *chan, *n;
Chris Leechc13c8262006-05-23 17:18:44 -07001314
Peter Ujfalusi26cf1322020-03-06 16:28:39 +02001315 dmaengine_debug_unregister(device);
1316
Dave Jiange81274c2020-01-21 16:43:53 -07001317 list_for_each_entry_safe(chan, n, &device->channels, device_node)
Dave Jiangd2fb0a02020-01-21 16:43:47 -07001318 __dma_async_device_channel_unregister(device, chan);
Logan Gunthorpe8ad342a2019-12-16 12:01:19 -07001319
1320 mutex_lock(&dma_list_mutex);
1321 /*
1322 * setting DMA_PRIVATE ensures the device being torn down will not
1323 * be used in the channel_table
1324 */
1325 dma_cap_set(DMA_PRIVATE, device->cap_mask);
1326 dma_channel_rebalance();
Dave Jiang08210092020-04-13 10:40:12 -07001327 ida_free(&dma_ida, device->dev_id);
Logan Gunthorpe8ad342a2019-12-16 12:01:19 -07001328 dma_device_put(device);
1329 mutex_unlock(&dma_list_mutex);
Chris Leechc13c8262006-05-23 17:18:44 -07001330}
David Brownell765e3d82007-03-16 13:38:05 -08001331EXPORT_SYMBOL(dma_async_device_unregister);
Chris Leechc13c8262006-05-23 17:18:44 -07001332
Huang Shijief39b9482018-07-26 14:45:53 +08001333static void dmam_device_release(struct device *dev, void *res)
1334{
1335 struct dma_device *device;
1336
1337 device = *(struct dma_device **)res;
1338 dma_async_device_unregister(device);
1339}
1340
1341/**
1342 * dmaenginem_async_device_register - registers DMA devices found
Andy Shevchenko9872e232020-04-29 15:21:51 +03001343 * @device: pointer to &struct dma_device
Huang Shijief39b9482018-07-26 14:45:53 +08001344 *
1345 * The operation is managed and will be undone on driver detach.
1346 */
1347int dmaenginem_async_device_register(struct dma_device *device)
1348{
1349 void *p;
1350 int ret;
1351
1352 p = devres_alloc(dmam_device_release, sizeof(void *), GFP_KERNEL);
1353 if (!p)
1354 return -ENOMEM;
1355
1356 ret = dma_async_device_register(device);
1357 if (!ret) {
1358 *(struct dma_device **)p = device;
1359 devres_add(device->dev, p);
1360 } else {
1361 devres_free(p);
1362 }
1363
1364 return ret;
1365}
1366EXPORT_SYMBOL(dmaenginem_async_device_register);
1367
Dan Williams45c463a2013-10-18 19:35:24 +02001368struct dmaengine_unmap_pool {
1369 struct kmem_cache *cache;
1370 const char *name;
1371 mempool_t *pool;
1372 size_t size;
1373};
1374
1375#define __UNMAP_POOL(x) { .size = x, .name = "dmaengine-unmap-" __stringify(x) }
1376static struct dmaengine_unmap_pool unmap_pool[] = {
1377 __UNMAP_POOL(2),
Dan Williams3cc377b2013-12-09 10:33:16 -08001378 #if IS_ENABLED(CONFIG_DMA_ENGINE_RAID)
Dan Williams45c463a2013-10-18 19:35:24 +02001379 __UNMAP_POOL(16),
1380 __UNMAP_POOL(128),
1381 __UNMAP_POOL(256),
1382 #endif
1383};
1384
1385static struct dmaengine_unmap_pool *__get_unmap_pool(int nr)
Dan Williams7405f742007-01-02 11:10:43 -07001386{
Dan Williams45c463a2013-10-18 19:35:24 +02001387 int order = get_count_order(nr);
Dan Williams7405f742007-01-02 11:10:43 -07001388
Dan Williams45c463a2013-10-18 19:35:24 +02001389 switch (order) {
1390 case 0 ... 1:
1391 return &unmap_pool[0];
Matthias Kaehlcke23f963e92017-03-13 14:30:29 -07001392#if IS_ENABLED(CONFIG_DMA_ENGINE_RAID)
Dan Williams45c463a2013-10-18 19:35:24 +02001393 case 2 ... 4:
1394 return &unmap_pool[1];
1395 case 5 ... 7:
1396 return &unmap_pool[2];
1397 case 8:
1398 return &unmap_pool[3];
Matthias Kaehlcke23f963e92017-03-13 14:30:29 -07001399#endif
Dan Williams45c463a2013-10-18 19:35:24 +02001400 default:
1401 BUG();
1402 return NULL;
1403 }
1404}
Dan Williams00367312008-02-02 19:49:57 -07001405
Dan Williams45c463a2013-10-18 19:35:24 +02001406static void dmaengine_unmap(struct kref *kref)
1407{
1408 struct dmaengine_unmap_data *unmap = container_of(kref, typeof(*unmap), kref);
1409 struct device *dev = unmap->dev;
1410 int cnt, i;
1411
1412 cnt = unmap->to_cnt;
1413 for (i = 0; i < cnt; i++)
1414 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1415 DMA_TO_DEVICE);
1416 cnt += unmap->from_cnt;
1417 for (; i < cnt; i++)
1418 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1419 DMA_FROM_DEVICE);
1420 cnt += unmap->bidi_cnt;
Dan Williams7476bd792013-10-18 19:35:29 +02001421 for (; i < cnt; i++) {
1422 if (unmap->addr[i] == 0)
1423 continue;
Dan Williams45c463a2013-10-18 19:35:24 +02001424 dma_unmap_page(dev, unmap->addr[i], unmap->len,
1425 DMA_BIDIRECTIONAL);
Dan Williams7476bd792013-10-18 19:35:29 +02001426 }
Xuelin Shic1f43dd2014-05-21 14:02:37 -07001427 cnt = unmap->map_cnt;
Dan Williams45c463a2013-10-18 19:35:24 +02001428 mempool_free(unmap, __get_unmap_pool(cnt)->pool);
1429}
1430
1431void dmaengine_unmap_put(struct dmaengine_unmap_data *unmap)
1432{
1433 if (unmap)
1434 kref_put(&unmap->kref, dmaengine_unmap);
1435}
1436EXPORT_SYMBOL_GPL(dmaengine_unmap_put);
1437
1438static void dmaengine_destroy_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
Julia Lawall240eb9162015-09-13 14:15:19 +02001445 mempool_destroy(p->pool);
Dan Williams45c463a2013-10-18 19:35:24 +02001446 p->pool = NULL;
Julia Lawall240eb9162015-09-13 14:15:19 +02001447 kmem_cache_destroy(p->cache);
Dan Williams45c463a2013-10-18 19:35:24 +02001448 p->cache = NULL;
1449 }
1450}
1451
1452static int __init dmaengine_init_unmap_pool(void)
1453{
1454 int i;
1455
1456 for (i = 0; i < ARRAY_SIZE(unmap_pool); i++) {
1457 struct dmaengine_unmap_pool *p = &unmap_pool[i];
1458 size_t size;
1459
1460 size = sizeof(struct dmaengine_unmap_data) +
1461 sizeof(dma_addr_t) * p->size;
1462
1463 p->cache = kmem_cache_create(p->name, size, 0,
1464 SLAB_HWCACHE_ALIGN, NULL);
1465 if (!p->cache)
1466 break;
1467 p->pool = mempool_create_slab_pool(1, p->cache);
1468 if (!p->pool)
1469 break;
Dan Williams00367312008-02-02 19:49:57 -07001470 }
Dan Williams7405f742007-01-02 11:10:43 -07001471
Dan Williams45c463a2013-10-18 19:35:24 +02001472 if (i == ARRAY_SIZE(unmap_pool))
1473 return 0;
Dan Williams7405f742007-01-02 11:10:43 -07001474
Dan Williams45c463a2013-10-18 19:35:24 +02001475 dmaengine_destroy_unmap_pool();
1476 return -ENOMEM;
Dan Williams7405f742007-01-02 11:10:43 -07001477}
Dan Williams7405f742007-01-02 11:10:43 -07001478
Dan Williams89716462013-10-18 19:35:25 +02001479struct dmaengine_unmap_data *
Dan Williams45c463a2013-10-18 19:35:24 +02001480dmaengine_get_unmap_data(struct device *dev, int nr, gfp_t flags)
Dan Williams7405f742007-01-02 11:10:43 -07001481{
Dan Williams45c463a2013-10-18 19:35:24 +02001482 struct dmaengine_unmap_data *unmap;
Dan Williams7405f742007-01-02 11:10:43 -07001483
Dan Williams45c463a2013-10-18 19:35:24 +02001484 unmap = mempool_alloc(__get_unmap_pool(nr)->pool, flags);
1485 if (!unmap)
1486 return NULL;
Dan Williams00367312008-02-02 19:49:57 -07001487
Dan Williams45c463a2013-10-18 19:35:24 +02001488 memset(unmap, 0, sizeof(*unmap));
1489 kref_init(&unmap->kref);
1490 unmap->dev = dev;
Xuelin Shic1f43dd2014-05-21 14:02:37 -07001491 unmap->map_cnt = nr;
Dan Williams7405f742007-01-02 11:10:43 -07001492
Dan Williams45c463a2013-10-18 19:35:24 +02001493 return unmap;
Dan Williams7405f742007-01-02 11:10:43 -07001494}
Dan Williams89716462013-10-18 19:35:25 +02001495EXPORT_SYMBOL(dmaengine_get_unmap_data);
Dan Williams7405f742007-01-02 11:10:43 -07001496
Dan Williams7405f742007-01-02 11:10:43 -07001497void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx,
1498 struct dma_chan *chan)
1499{
1500 tx->chan = chan;
Dan Williams5fc6d892010-10-07 16:44:50 -07001501 #ifdef CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH
Dan Williams7405f742007-01-02 11:10:43 -07001502 spin_lock_init(&tx->lock);
Dan Williamscaa20d972010-05-17 16:24:16 -07001503 #endif
Dan Williams7405f742007-01-02 11:10:43 -07001504}
1505EXPORT_SYMBOL(dma_async_tx_descriptor_init);
1506
Peter Ujfalusi4db8fd32019-12-23 13:04:44 +02001507static inline int desc_check_and_set_metadata_mode(
1508 struct dma_async_tx_descriptor *desc, enum dma_desc_metadata_mode mode)
1509{
1510 /* Make sure that the metadata mode is not mixed */
1511 if (!desc->desc_metadata_mode) {
1512 if (dmaengine_is_metadata_mode_supported(desc->chan, mode))
1513 desc->desc_metadata_mode = mode;
1514 else
1515 return -ENOTSUPP;
1516 } else if (desc->desc_metadata_mode != mode) {
1517 return -EINVAL;
1518 }
1519
1520 return 0;
1521}
1522
1523int dmaengine_desc_attach_metadata(struct dma_async_tx_descriptor *desc,
1524 void *data, size_t len)
1525{
1526 int ret;
1527
1528 if (!desc)
1529 return -EINVAL;
1530
1531 ret = desc_check_and_set_metadata_mode(desc, DESC_METADATA_CLIENT);
1532 if (ret)
1533 return ret;
1534
1535 if (!desc->metadata_ops || !desc->metadata_ops->attach)
1536 return -ENOTSUPP;
1537
1538 return desc->metadata_ops->attach(desc, data, len);
1539}
1540EXPORT_SYMBOL_GPL(dmaengine_desc_attach_metadata);
1541
1542void *dmaengine_desc_get_metadata_ptr(struct dma_async_tx_descriptor *desc,
1543 size_t *payload_len, size_t *max_len)
1544{
1545 int ret;
1546
1547 if (!desc)
1548 return ERR_PTR(-EINVAL);
1549
1550 ret = desc_check_and_set_metadata_mode(desc, DESC_METADATA_ENGINE);
1551 if (ret)
1552 return ERR_PTR(ret);
1553
1554 if (!desc->metadata_ops || !desc->metadata_ops->get_ptr)
1555 return ERR_PTR(-ENOTSUPP);
1556
1557 return desc->metadata_ops->get_ptr(desc, payload_len, max_len);
1558}
1559EXPORT_SYMBOL_GPL(dmaengine_desc_get_metadata_ptr);
1560
1561int dmaengine_desc_set_metadata_len(struct dma_async_tx_descriptor *desc,
1562 size_t payload_len)
1563{
1564 int ret;
1565
1566 if (!desc)
1567 return -EINVAL;
1568
1569 ret = desc_check_and_set_metadata_mode(desc, DESC_METADATA_ENGINE);
1570 if (ret)
1571 return ret;
1572
1573 if (!desc->metadata_ops || !desc->metadata_ops->set_len)
1574 return -ENOTSUPP;
1575
1576 return desc->metadata_ops->set_len(desc, payload_len);
1577}
1578EXPORT_SYMBOL_GPL(dmaengine_desc_set_metadata_len);
1579
Andy Shevchenko9872e232020-04-29 15:21:51 +03001580/**
1581 * dma_wait_for_async_tx - spin wait for a transaction to complete
1582 * @tx: in-flight transaction to wait on
Dan Williams07f22112009-01-05 17:14:31 -07001583 */
1584enum dma_status
1585dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx)
1586{
Dan Williams95475e52009-07-14 12:19:02 -07001587 unsigned long dma_sync_wait_timeout = jiffies + msecs_to_jiffies(5000);
Dan Williams07f22112009-01-05 17:14:31 -07001588
1589 if (!tx)
Vinod Kouladfedd92013-10-16 13:29:02 +05301590 return DMA_COMPLETE;
Dan Williams07f22112009-01-05 17:14:31 -07001591
Dan Williams95475e52009-07-14 12:19:02 -07001592 while (tx->cookie == -EBUSY) {
1593 if (time_after_eq(jiffies, dma_sync_wait_timeout)) {
Jarkko Nikulaef859312016-03-14 16:51:09 +02001594 dev_err(tx->chan->device->dev,
1595 "%s timeout waiting for descriptor submission\n",
1596 __func__);
Dan Williams95475e52009-07-14 12:19:02 -07001597 return DMA_ERROR;
1598 }
1599 cpu_relax();
1600 }
1601 return dma_sync_wait(tx->chan, tx->cookie);
Dan Williams07f22112009-01-05 17:14:31 -07001602}
1603EXPORT_SYMBOL_GPL(dma_wait_for_async_tx);
1604
Andy Shevchenko9872e232020-04-29 15:21:51 +03001605/**
1606 * dma_run_dependencies - process dependent operations on the target channel
1607 * @tx: transaction with dependencies
1608 *
1609 * Helper routine for DMA drivers to process (start) dependent operations
1610 * on their target channel.
Dan Williams07f22112009-01-05 17:14:31 -07001611 */
1612void dma_run_dependencies(struct dma_async_tx_descriptor *tx)
1613{
Dan Williamscaa20d972010-05-17 16:24:16 -07001614 struct dma_async_tx_descriptor *dep = txd_next(tx);
Dan Williams07f22112009-01-05 17:14:31 -07001615 struct dma_async_tx_descriptor *dep_next;
1616 struct dma_chan *chan;
1617
1618 if (!dep)
1619 return;
1620
Yuri Tikhonovdd59b852009-01-12 15:17:20 -07001621 /* we'll submit tx->next now, so clear the link */
Dan Williamscaa20d972010-05-17 16:24:16 -07001622 txd_clear_next(tx);
Dan Williams07f22112009-01-05 17:14:31 -07001623 chan = dep->chan;
1624
1625 /* keep submitting up until a channel switch is detected
1626 * in that case we will be called again as a result of
1627 * processing the interrupt from async_tx_channel_switch
1628 */
1629 for (; dep; dep = dep_next) {
Dan Williamscaa20d972010-05-17 16:24:16 -07001630 txd_lock(dep);
1631 txd_clear_parent(dep);
1632 dep_next = txd_next(dep);
Dan Williams07f22112009-01-05 17:14:31 -07001633 if (dep_next && dep_next->chan == chan)
Dan Williamscaa20d972010-05-17 16:24:16 -07001634 txd_clear_next(dep); /* ->next will be submitted */
Dan Williams07f22112009-01-05 17:14:31 -07001635 else
1636 dep_next = NULL; /* submit current dep and terminate */
Dan Williamscaa20d972010-05-17 16:24:16 -07001637 txd_unlock(dep);
Dan Williams07f22112009-01-05 17:14:31 -07001638
1639 dep->tx_submit(dep);
1640 }
1641
1642 chan->device->device_issue_pending(chan);
1643}
1644EXPORT_SYMBOL_GPL(dma_run_dependencies);
1645
Chris Leechc13c8262006-05-23 17:18:44 -07001646static int __init dma_bus_init(void)
1647{
Dan Williams45c463a2013-10-18 19:35:24 +02001648 int err = dmaengine_init_unmap_pool();
1649
1650 if (err)
1651 return err;
Peter Ujfalusie937cc12020-03-06 16:28:37 +02001652
1653 err = class_register(&dma_devclass);
1654 if (!err)
1655 dmaengine_debugfs_init();
1656
1657 return err;
Chris Leechc13c8262006-05-23 17:18:44 -07001658}
Dan Williams652afc22009-01-06 11:38:22 -07001659arch_initcall(dma_bus_init);