dmaengine: use idr for registering dma device numbers
[linux-2.6] / drivers / dma / dmaengine.c
1 /*
2  * Copyright(c) 2004 - 2006 Intel Corporation. All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License as published by the Free
6  * Software Foundation; either version 2 of the License, or (at your option)
7  * any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program; if not, write to the Free Software Foundation, Inc., 59
16  * Temple Place - Suite 330, Boston, MA  02111-1307, USA.
17  *
18  * The full GNU General Public License is included in this distribution in the
19  * file called COPYING.
20  */
21
22 /*
23  * This code implements the DMA subsystem. It provides a HW-neutral interface
24  * for other kernel code to use asynchronous memory copy capabilities,
25  * if present, and allows different HW DMA drivers to register as providing
26  * this capability.
27  *
28  * Due to the fact we are accelerating what is already a relatively fast
29  * operation, the code goes to great lengths to avoid additional overhead,
30  * such as locking.
31  *
32  * LOCKING:
33  *
34  * The subsystem keeps a global list of dma_device structs it is protected by a
35  * mutex, dma_list_mutex.
36  *
37  * A subsystem can get access to a channel by calling dmaengine_get() followed
38  * by dma_find_channel(), or if it has need for an exclusive channel it can call
39  * dma_request_channel().  Once a channel is allocated a reference is taken
40  * against its corresponding driver to disable removal.
41  *
42  * Each device has a channels list, which runs unlocked but is never modified
43  * once the device is registered, it's just setup by the driver.
44  *
45  * See Documentation/dmaengine.txt for more details
46  */
47
48 #include <linux/init.h>
49 #include <linux/module.h>
50 #include <linux/mm.h>
51 #include <linux/device.h>
52 #include <linux/dmaengine.h>
53 #include <linux/hardirq.h>
54 #include <linux/spinlock.h>
55 #include <linux/percpu.h>
56 #include <linux/rcupdate.h>
57 #include <linux/mutex.h>
58 #include <linux/jiffies.h>
59 #include <linux/rculist.h>
60 #include <linux/idr.h>
61
62 static DEFINE_MUTEX(dma_list_mutex);
63 static LIST_HEAD(dma_device_list);
64 static long dmaengine_ref_count;
65 static struct idr dma_idr;
66
67 /* --- sysfs implementation --- */
68
69 /**
70  * dev_to_dma_chan - convert a device pointer to the its sysfs container object
71  * @dev - device node
72  *
73  * Must be called under dma_list_mutex
74  */
75 static struct dma_chan *dev_to_dma_chan(struct device *dev)
76 {
77         struct dma_chan_dev *chan_dev;
78
79         chan_dev = container_of(dev, typeof(*chan_dev), device);
80         return chan_dev->chan;
81 }
82
83 static ssize_t show_memcpy_count(struct device *dev, struct device_attribute *attr, char *buf)
84 {
85         struct dma_chan *chan;
86         unsigned long count = 0;
87         int i;
88         int err;
89
90         mutex_lock(&dma_list_mutex);
91         chan = dev_to_dma_chan(dev);
92         if (chan) {
93                 for_each_possible_cpu(i)
94                         count += per_cpu_ptr(chan->local, i)->memcpy_count;
95                 err = sprintf(buf, "%lu\n", count);
96         } else
97                 err = -ENODEV;
98         mutex_unlock(&dma_list_mutex);
99
100         return err;
101 }
102
103 static ssize_t show_bytes_transferred(struct device *dev, struct device_attribute *attr,
104                                       char *buf)
105 {
106         struct dma_chan *chan;
107         unsigned long count = 0;
108         int i;
109         int err;
110
111         mutex_lock(&dma_list_mutex);
112         chan = dev_to_dma_chan(dev);
113         if (chan) {
114                 for_each_possible_cpu(i)
115                         count += per_cpu_ptr(chan->local, i)->bytes_transferred;
116                 err = sprintf(buf, "%lu\n", count);
117         } else
118                 err = -ENODEV;
119         mutex_unlock(&dma_list_mutex);
120
121         return err;
122 }
123
124 static ssize_t show_in_use(struct device *dev, struct device_attribute *attr, char *buf)
125 {
126         struct dma_chan *chan;
127         int err;
128
129         mutex_lock(&dma_list_mutex);
130         chan = dev_to_dma_chan(dev);
131         if (chan)
132                 err = sprintf(buf, "%d\n", chan->client_count);
133         else
134                 err = -ENODEV;
135         mutex_unlock(&dma_list_mutex);
136
137         return err;
138 }
139
140 static struct device_attribute dma_attrs[] = {
141         __ATTR(memcpy_count, S_IRUGO, show_memcpy_count, NULL),
142         __ATTR(bytes_transferred, S_IRUGO, show_bytes_transferred, NULL),
143         __ATTR(in_use, S_IRUGO, show_in_use, NULL),
144         __ATTR_NULL
145 };
146
147 static void chan_dev_release(struct device *dev)
148 {
149         struct dma_chan_dev *chan_dev;
150
151         chan_dev = container_of(dev, typeof(*chan_dev), device);
152         if (atomic_dec_and_test(chan_dev->idr_ref)) {
153                 mutex_lock(&dma_list_mutex);
154                 idr_remove(&dma_idr, chan_dev->dev_id);
155                 mutex_unlock(&dma_list_mutex);
156                 kfree(chan_dev->idr_ref);
157         }
158         kfree(chan_dev);
159 }
160
161 static struct class dma_devclass = {
162         .name           = "dma",
163         .dev_attrs      = dma_attrs,
164         .dev_release    = chan_dev_release,
165 };
166
167 /* --- client and device registration --- */
168
169 #define dma_device_satisfies_mask(device, mask) \
170         __dma_device_satisfies_mask((device), &(mask))
171 static int
172 __dma_device_satisfies_mask(struct dma_device *device, dma_cap_mask_t *want)
173 {
174         dma_cap_mask_t has;
175
176         bitmap_and(has.bits, want->bits, device->cap_mask.bits,
177                 DMA_TX_TYPE_END);
178         return bitmap_equal(want->bits, has.bits, DMA_TX_TYPE_END);
179 }
180
181 static struct module *dma_chan_to_owner(struct dma_chan *chan)
182 {
183         return chan->device->dev->driver->owner;
184 }
185
186 /**
187  * balance_ref_count - catch up the channel reference count
188  * @chan - channel to balance ->client_count versus dmaengine_ref_count
189  *
190  * balance_ref_count must be called under dma_list_mutex
191  */
192 static void balance_ref_count(struct dma_chan *chan)
193 {
194         struct module *owner = dma_chan_to_owner(chan);
195
196         while (chan->client_count < dmaengine_ref_count) {
197                 __module_get(owner);
198                 chan->client_count++;
199         }
200 }
201
202 /**
203  * dma_chan_get - try to grab a dma channel's parent driver module
204  * @chan - channel to grab
205  *
206  * Must be called under dma_list_mutex
207  */
208 static int dma_chan_get(struct dma_chan *chan)
209 {
210         int err = -ENODEV;
211         struct module *owner = dma_chan_to_owner(chan);
212
213         if (chan->client_count) {
214                 __module_get(owner);
215                 err = 0;
216         } else if (try_module_get(owner))
217                 err = 0;
218
219         if (err == 0)
220                 chan->client_count++;
221
222         /* allocate upon first client reference */
223         if (chan->client_count == 1 && err == 0) {
224                 int desc_cnt = chan->device->device_alloc_chan_resources(chan);
225
226                 if (desc_cnt < 0) {
227                         err = desc_cnt;
228                         chan->client_count = 0;
229                         module_put(owner);
230                 } else if (!dma_has_cap(DMA_PRIVATE, chan->device->cap_mask))
231                         balance_ref_count(chan);
232         }
233
234         return err;
235 }
236
237 /**
238  * dma_chan_put - drop a reference to a dma channel's parent driver module
239  * @chan - channel to release
240  *
241  * Must be called under dma_list_mutex
242  */
243 static void dma_chan_put(struct dma_chan *chan)
244 {
245         if (!chan->client_count)
246                 return; /* this channel failed alloc_chan_resources */
247         chan->client_count--;
248         module_put(dma_chan_to_owner(chan));
249         if (chan->client_count == 0)
250                 chan->device->device_free_chan_resources(chan);
251 }
252
253 enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie)
254 {
255         enum dma_status status;
256         unsigned long dma_sync_wait_timeout = jiffies + msecs_to_jiffies(5000);
257
258         dma_async_issue_pending(chan);
259         do {
260                 status = dma_async_is_tx_complete(chan, cookie, NULL, NULL);
261                 if (time_after_eq(jiffies, dma_sync_wait_timeout)) {
262                         printk(KERN_ERR "dma_sync_wait_timeout!\n");
263                         return DMA_ERROR;
264                 }
265         } while (status == DMA_IN_PROGRESS);
266
267         return status;
268 }
269 EXPORT_SYMBOL(dma_sync_wait);
270
271 /**
272  * dma_cap_mask_all - enable iteration over all operation types
273  */
274 static dma_cap_mask_t dma_cap_mask_all;
275
276 /**
277  * dma_chan_tbl_ent - tracks channel allocations per core/operation
278  * @chan - associated channel for this entry
279  */
280 struct dma_chan_tbl_ent {
281         struct dma_chan *chan;
282 };
283
284 /**
285  * channel_table - percpu lookup table for memory-to-memory offload providers
286  */
287 static struct dma_chan_tbl_ent *channel_table[DMA_TX_TYPE_END];
288
289 static int __init dma_channel_table_init(void)
290 {
291         enum dma_transaction_type cap;
292         int err = 0;
293
294         bitmap_fill(dma_cap_mask_all.bits, DMA_TX_TYPE_END);
295
296         /* 'interrupt', 'private', and 'slave' are channel capabilities,
297          * but are not associated with an operation so they do not need
298          * an entry in the channel_table
299          */
300         clear_bit(DMA_INTERRUPT, dma_cap_mask_all.bits);
301         clear_bit(DMA_PRIVATE, dma_cap_mask_all.bits);
302         clear_bit(DMA_SLAVE, dma_cap_mask_all.bits);
303
304         for_each_dma_cap_mask(cap, dma_cap_mask_all) {
305                 channel_table[cap] = alloc_percpu(struct dma_chan_tbl_ent);
306                 if (!channel_table[cap]) {
307                         err = -ENOMEM;
308                         break;
309                 }
310         }
311
312         if (err) {
313                 pr_err("dmaengine: initialization failure\n");
314                 for_each_dma_cap_mask(cap, dma_cap_mask_all)
315                         if (channel_table[cap])
316                                 free_percpu(channel_table[cap]);
317         }
318
319         return err;
320 }
321 subsys_initcall(dma_channel_table_init);
322
323 /**
324  * dma_find_channel - find a channel to carry out the operation
325  * @tx_type: transaction type
326  */
327 struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type)
328 {
329         struct dma_chan *chan;
330         int cpu;
331
332         WARN_ONCE(dmaengine_ref_count == 0,
333                   "client called %s without a reference", __func__);
334
335         cpu = get_cpu();
336         chan = per_cpu_ptr(channel_table[tx_type], cpu)->chan;
337         put_cpu();
338
339         return chan;
340 }
341 EXPORT_SYMBOL(dma_find_channel);
342
343 /**
344  * dma_issue_pending_all - flush all pending operations across all channels
345  */
346 void dma_issue_pending_all(void)
347 {
348         struct dma_device *device;
349         struct dma_chan *chan;
350
351         WARN_ONCE(dmaengine_ref_count == 0,
352                   "client called %s without a reference", __func__);
353
354         rcu_read_lock();
355         list_for_each_entry_rcu(device, &dma_device_list, global_node) {
356                 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
357                         continue;
358                 list_for_each_entry(chan, &device->channels, device_node)
359                         if (chan->client_count)
360                                 device->device_issue_pending(chan);
361         }
362         rcu_read_unlock();
363 }
364 EXPORT_SYMBOL(dma_issue_pending_all);
365
366 /**
367  * nth_chan - returns the nth channel of the given capability
368  * @cap: capability to match
369  * @n: nth channel desired
370  *
371  * Defaults to returning the channel with the desired capability and the
372  * lowest reference count when 'n' cannot be satisfied.  Must be called
373  * under dma_list_mutex.
374  */
375 static struct dma_chan *nth_chan(enum dma_transaction_type cap, int n)
376 {
377         struct dma_device *device;
378         struct dma_chan *chan;
379         struct dma_chan *ret = NULL;
380         struct dma_chan *min = NULL;
381
382         list_for_each_entry(device, &dma_device_list, global_node) {
383                 if (!dma_has_cap(cap, device->cap_mask) ||
384                     dma_has_cap(DMA_PRIVATE, device->cap_mask))
385                         continue;
386                 list_for_each_entry(chan, &device->channels, device_node) {
387                         if (!chan->client_count)
388                                 continue;
389                         if (!min)
390                                 min = chan;
391                         else if (chan->table_count < min->table_count)
392                                 min = chan;
393
394                         if (n-- == 0) {
395                                 ret = chan;
396                                 break; /* done */
397                         }
398                 }
399                 if (ret)
400                         break; /* done */
401         }
402
403         if (!ret)
404                 ret = min;
405
406         if (ret)
407                 ret->table_count++;
408
409         return ret;
410 }
411
412 /**
413  * dma_channel_rebalance - redistribute the available channels
414  *
415  * Optimize for cpu isolation (each cpu gets a dedicated channel for an
416  * operation type) in the SMP case,  and operation isolation (avoid
417  * multi-tasking channels) in the non-SMP case.  Must be called under
418  * dma_list_mutex.
419  */
420 static void dma_channel_rebalance(void)
421 {
422         struct dma_chan *chan;
423         struct dma_device *device;
424         int cpu;
425         int cap;
426         int n;
427
428         /* undo the last distribution */
429         for_each_dma_cap_mask(cap, dma_cap_mask_all)
430                 for_each_possible_cpu(cpu)
431                         per_cpu_ptr(channel_table[cap], cpu)->chan = NULL;
432
433         list_for_each_entry(device, &dma_device_list, global_node) {
434                 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
435                         continue;
436                 list_for_each_entry(chan, &device->channels, device_node)
437                         chan->table_count = 0;
438         }
439
440         /* don't populate the channel_table if no clients are available */
441         if (!dmaengine_ref_count)
442                 return;
443
444         /* redistribute available channels */
445         n = 0;
446         for_each_dma_cap_mask(cap, dma_cap_mask_all)
447                 for_each_online_cpu(cpu) {
448                         if (num_possible_cpus() > 1)
449                                 chan = nth_chan(cap, n++);
450                         else
451                                 chan = nth_chan(cap, -1);
452
453                         per_cpu_ptr(channel_table[cap], cpu)->chan = chan;
454                 }
455 }
456
457 static struct dma_chan *private_candidate(dma_cap_mask_t *mask, struct dma_device *dev)
458 {
459         struct dma_chan *chan;
460         struct dma_chan *ret = NULL;
461
462         if (!__dma_device_satisfies_mask(dev, mask)) {
463                 pr_debug("%s: wrong capabilities\n", __func__);
464                 return NULL;
465         }
466         /* devices with multiple channels need special handling as we need to
467          * ensure that all channels are either private or public.
468          */
469         if (dev->chancnt > 1 && !dma_has_cap(DMA_PRIVATE, dev->cap_mask))
470                 list_for_each_entry(chan, &dev->channels, device_node) {
471                         /* some channels are already publicly allocated */
472                         if (chan->client_count)
473                                 return NULL;
474                 }
475
476         list_for_each_entry(chan, &dev->channels, device_node) {
477                 if (chan->client_count) {
478                         pr_debug("%s: %s busy\n",
479                                  __func__, dma_chan_name(chan));
480                         continue;
481                 }
482                 ret = chan;
483                 break;
484         }
485
486         return ret;
487 }
488
489 /**
490  * dma_request_channel - try to allocate an exclusive channel
491  * @mask: capabilities that the channel must satisfy
492  * @fn: optional callback to disposition available channels
493  * @fn_param: opaque parameter to pass to dma_filter_fn
494  */
495 struct dma_chan *__dma_request_channel(dma_cap_mask_t *mask, dma_filter_fn fn, void *fn_param)
496 {
497         struct dma_device *device, *_d;
498         struct dma_chan *chan = NULL;
499         bool ack;
500         int err;
501
502         /* Find a channel */
503         mutex_lock(&dma_list_mutex);
504         list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
505                 chan = private_candidate(mask, device);
506                 if (!chan)
507                         continue;
508
509                 if (fn)
510                         ack = fn(chan, fn_param);
511                 else
512                         ack = true;
513
514                 if (ack) {
515                         /* Found a suitable channel, try to grab, prep, and
516                          * return it.  We first set DMA_PRIVATE to disable
517                          * balance_ref_count as this channel will not be
518                          * published in the general-purpose allocator
519                          */
520                         dma_cap_set(DMA_PRIVATE, device->cap_mask);
521                         err = dma_chan_get(chan);
522
523                         if (err == -ENODEV) {
524                                 pr_debug("%s: %s module removed\n", __func__,
525                                          dma_chan_name(chan));
526                                 list_del_rcu(&device->global_node);
527                         } else if (err)
528                                 pr_err("dmaengine: failed to get %s: (%d)\n",
529                                        dma_chan_name(chan), err);
530                         else
531                                 break;
532                 } else
533                         pr_debug("%s: %s filter said false\n",
534                                  __func__, dma_chan_name(chan));
535                 chan = NULL;
536         }
537         mutex_unlock(&dma_list_mutex);
538
539         pr_debug("%s: %s (%s)\n", __func__, chan ? "success" : "fail",
540                  chan ? dma_chan_name(chan) : NULL);
541
542         return chan;
543 }
544 EXPORT_SYMBOL_GPL(__dma_request_channel);
545
546 void dma_release_channel(struct dma_chan *chan)
547 {
548         mutex_lock(&dma_list_mutex);
549         WARN_ONCE(chan->client_count != 1,
550                   "chan reference count %d != 1\n", chan->client_count);
551         dma_chan_put(chan);
552         mutex_unlock(&dma_list_mutex);
553 }
554 EXPORT_SYMBOL_GPL(dma_release_channel);
555
556 /**
557  * dmaengine_get - register interest in dma_channels
558  */
559 void dmaengine_get(void)
560 {
561         struct dma_device *device, *_d;
562         struct dma_chan *chan;
563         int err;
564
565         mutex_lock(&dma_list_mutex);
566         dmaengine_ref_count++;
567
568         /* try to grab channels */
569         list_for_each_entry_safe(device, _d, &dma_device_list, global_node) {
570                 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
571                         continue;
572                 list_for_each_entry(chan, &device->channels, device_node) {
573                         err = dma_chan_get(chan);
574                         if (err == -ENODEV) {
575                                 /* module removed before we could use it */
576                                 list_del_rcu(&device->global_node);
577                                 break;
578                         } else if (err)
579                                 pr_err("dmaengine: failed to get %s: (%d)\n",
580                                        dma_chan_name(chan), err);
581                 }
582         }
583
584         /* if this is the first reference and there were channels
585          * waiting we need to rebalance to get those channels
586          * incorporated into the channel table
587          */
588         if (dmaengine_ref_count == 1)
589                 dma_channel_rebalance();
590         mutex_unlock(&dma_list_mutex);
591 }
592 EXPORT_SYMBOL(dmaengine_get);
593
594 /**
595  * dmaengine_put - let dma drivers be removed when ref_count == 0
596  */
597 void dmaengine_put(void)
598 {
599         struct dma_device *device;
600         struct dma_chan *chan;
601
602         mutex_lock(&dma_list_mutex);
603         dmaengine_ref_count--;
604         BUG_ON(dmaengine_ref_count < 0);
605         /* drop channel references */
606         list_for_each_entry(device, &dma_device_list, global_node) {
607                 if (dma_has_cap(DMA_PRIVATE, device->cap_mask))
608                         continue;
609                 list_for_each_entry(chan, &device->channels, device_node)
610                         dma_chan_put(chan);
611         }
612         mutex_unlock(&dma_list_mutex);
613 }
614 EXPORT_SYMBOL(dmaengine_put);
615
616 /**
617  * dma_async_device_register - registers DMA devices found
618  * @device: &dma_device
619  */
620 int dma_async_device_register(struct dma_device *device)
621 {
622         int chancnt = 0, rc;
623         struct dma_chan* chan;
624         atomic_t *idr_ref;
625
626         if (!device)
627                 return -ENODEV;
628
629         /* validate device routines */
630         BUG_ON(dma_has_cap(DMA_MEMCPY, device->cap_mask) &&
631                 !device->device_prep_dma_memcpy);
632         BUG_ON(dma_has_cap(DMA_XOR, device->cap_mask) &&
633                 !device->device_prep_dma_xor);
634         BUG_ON(dma_has_cap(DMA_ZERO_SUM, device->cap_mask) &&
635                 !device->device_prep_dma_zero_sum);
636         BUG_ON(dma_has_cap(DMA_MEMSET, device->cap_mask) &&
637                 !device->device_prep_dma_memset);
638         BUG_ON(dma_has_cap(DMA_INTERRUPT, device->cap_mask) &&
639                 !device->device_prep_dma_interrupt);
640         BUG_ON(dma_has_cap(DMA_SLAVE, device->cap_mask) &&
641                 !device->device_prep_slave_sg);
642         BUG_ON(dma_has_cap(DMA_SLAVE, device->cap_mask) &&
643                 !device->device_terminate_all);
644
645         BUG_ON(!device->device_alloc_chan_resources);
646         BUG_ON(!device->device_free_chan_resources);
647         BUG_ON(!device->device_is_tx_complete);
648         BUG_ON(!device->device_issue_pending);
649         BUG_ON(!device->dev);
650
651         idr_ref = kmalloc(sizeof(*idr_ref), GFP_KERNEL);
652         if (!idr_ref)
653                 return -ENOMEM;
654         atomic_set(idr_ref, 0);
655  idr_retry:
656         if (!idr_pre_get(&dma_idr, GFP_KERNEL))
657                 return -ENOMEM;
658         mutex_lock(&dma_list_mutex);
659         rc = idr_get_new(&dma_idr, NULL, &device->dev_id);
660         mutex_unlock(&dma_list_mutex);
661         if (rc == -EAGAIN)
662                 goto idr_retry;
663         else if (rc != 0)
664                 return rc;
665
666         /* represent channels in sysfs. Probably want devs too */
667         list_for_each_entry(chan, &device->channels, device_node) {
668                 chan->local = alloc_percpu(typeof(*chan->local));
669                 if (chan->local == NULL)
670                         continue;
671                 chan->dev = kzalloc(sizeof(*chan->dev), GFP_KERNEL);
672                 if (chan->dev == NULL) {
673                         free_percpu(chan->local);
674                         continue;
675                 }
676
677                 chan->chan_id = chancnt++;
678                 chan->dev->device.class = &dma_devclass;
679                 chan->dev->device.parent = device->dev;
680                 chan->dev->chan = chan;
681                 chan->dev->idr_ref = idr_ref;
682                 chan->dev->dev_id = device->dev_id;
683                 atomic_inc(idr_ref);
684                 dev_set_name(&chan->dev->device, "dma%dchan%d",
685                              device->dev_id, chan->chan_id);
686
687                 rc = device_register(&chan->dev->device);
688                 if (rc) {
689                         free_percpu(chan->local);
690                         chan->local = NULL;
691                         goto err_out;
692                 }
693                 chan->client_count = 0;
694         }
695         device->chancnt = chancnt;
696
697         mutex_lock(&dma_list_mutex);
698         /* take references on public channels */
699         if (dmaengine_ref_count && !dma_has_cap(DMA_PRIVATE, device->cap_mask))
700                 list_for_each_entry(chan, &device->channels, device_node) {
701                         /* if clients are already waiting for channels we need
702                          * to take references on their behalf
703                          */
704                         if (dma_chan_get(chan) == -ENODEV) {
705                                 /* note we can only get here for the first
706                                  * channel as the remaining channels are
707                                  * guaranteed to get a reference
708                                  */
709                                 rc = -ENODEV;
710                                 mutex_unlock(&dma_list_mutex);
711                                 goto err_out;
712                         }
713                 }
714         list_add_tail_rcu(&device->global_node, &dma_device_list);
715         dma_channel_rebalance();
716         mutex_unlock(&dma_list_mutex);
717
718         return 0;
719
720 err_out:
721         list_for_each_entry(chan, &device->channels, device_node) {
722                 if (chan->local == NULL)
723                         continue;
724                 mutex_lock(&dma_list_mutex);
725                 chan->dev->chan = NULL;
726                 mutex_unlock(&dma_list_mutex);
727                 device_unregister(&chan->dev->device);
728                 free_percpu(chan->local);
729         }
730         return rc;
731 }
732 EXPORT_SYMBOL(dma_async_device_register);
733
734 /**
735  * dma_async_device_unregister - unregister a DMA device
736  * @device: &dma_device
737  *
738  * This routine is called by dma driver exit routines, dmaengine holds module
739  * references to prevent it being called while channels are in use.
740  */
741 void dma_async_device_unregister(struct dma_device *device)
742 {
743         struct dma_chan *chan;
744
745         mutex_lock(&dma_list_mutex);
746         list_del_rcu(&device->global_node);
747         dma_channel_rebalance();
748         mutex_unlock(&dma_list_mutex);
749
750         list_for_each_entry(chan, &device->channels, device_node) {
751                 WARN_ONCE(chan->client_count,
752                           "%s called while %d clients hold a reference\n",
753                           __func__, chan->client_count);
754                 mutex_lock(&dma_list_mutex);
755                 chan->dev->chan = NULL;
756                 mutex_unlock(&dma_list_mutex);
757                 device_unregister(&chan->dev->device);
758         }
759 }
760 EXPORT_SYMBOL(dma_async_device_unregister);
761
762 /**
763  * dma_async_memcpy_buf_to_buf - offloaded copy between virtual addresses
764  * @chan: DMA channel to offload copy to
765  * @dest: destination address (virtual)
766  * @src: source address (virtual)
767  * @len: length
768  *
769  * Both @dest and @src must be mappable to a bus address according to the
770  * DMA mapping API rules for streaming mappings.
771  * Both @dest and @src must stay memory resident (kernel memory or locked
772  * user space pages).
773  */
774 dma_cookie_t
775 dma_async_memcpy_buf_to_buf(struct dma_chan *chan, void *dest,
776                         void *src, size_t len)
777 {
778         struct dma_device *dev = chan->device;
779         struct dma_async_tx_descriptor *tx;
780         dma_addr_t dma_dest, dma_src;
781         dma_cookie_t cookie;
782         int cpu;
783
784         dma_src = dma_map_single(dev->dev, src, len, DMA_TO_DEVICE);
785         dma_dest = dma_map_single(dev->dev, dest, len, DMA_FROM_DEVICE);
786         tx = dev->device_prep_dma_memcpy(chan, dma_dest, dma_src, len,
787                                          DMA_CTRL_ACK);
788
789         if (!tx) {
790                 dma_unmap_single(dev->dev, dma_src, len, DMA_TO_DEVICE);
791                 dma_unmap_single(dev->dev, dma_dest, len, DMA_FROM_DEVICE);
792                 return -ENOMEM;
793         }
794
795         tx->callback = NULL;
796         cookie = tx->tx_submit(tx);
797
798         cpu = get_cpu();
799         per_cpu_ptr(chan->local, cpu)->bytes_transferred += len;
800         per_cpu_ptr(chan->local, cpu)->memcpy_count++;
801         put_cpu();
802
803         return cookie;
804 }
805 EXPORT_SYMBOL(dma_async_memcpy_buf_to_buf);
806
807 /**
808  * dma_async_memcpy_buf_to_pg - offloaded copy from address to page
809  * @chan: DMA channel to offload copy to
810  * @page: destination page
811  * @offset: offset in page to copy to
812  * @kdata: source address (virtual)
813  * @len: length
814  *
815  * Both @page/@offset and @kdata must be mappable to a bus address according
816  * to the DMA mapping API rules for streaming mappings.
817  * Both @page/@offset and @kdata must stay memory resident (kernel memory or
818  * locked user space pages)
819  */
820 dma_cookie_t
821 dma_async_memcpy_buf_to_pg(struct dma_chan *chan, struct page *page,
822                         unsigned int offset, void *kdata, size_t len)
823 {
824         struct dma_device *dev = chan->device;
825         struct dma_async_tx_descriptor *tx;
826         dma_addr_t dma_dest, dma_src;
827         dma_cookie_t cookie;
828         int cpu;
829
830         dma_src = dma_map_single(dev->dev, kdata, len, DMA_TO_DEVICE);
831         dma_dest = dma_map_page(dev->dev, page, offset, len, DMA_FROM_DEVICE);
832         tx = dev->device_prep_dma_memcpy(chan, dma_dest, dma_src, len,
833                                          DMA_CTRL_ACK);
834
835         if (!tx) {
836                 dma_unmap_single(dev->dev, dma_src, len, DMA_TO_DEVICE);
837                 dma_unmap_page(dev->dev, dma_dest, len, DMA_FROM_DEVICE);
838                 return -ENOMEM;
839         }
840
841         tx->callback = NULL;
842         cookie = tx->tx_submit(tx);
843
844         cpu = get_cpu();
845         per_cpu_ptr(chan->local, cpu)->bytes_transferred += len;
846         per_cpu_ptr(chan->local, cpu)->memcpy_count++;
847         put_cpu();
848
849         return cookie;
850 }
851 EXPORT_SYMBOL(dma_async_memcpy_buf_to_pg);
852
853 /**
854  * dma_async_memcpy_pg_to_pg - offloaded copy from page to page
855  * @chan: DMA channel to offload copy to
856  * @dest_pg: destination page
857  * @dest_off: offset in page to copy to
858  * @src_pg: source page
859  * @src_off: offset in page to copy from
860  * @len: length
861  *
862  * Both @dest_page/@dest_off and @src_page/@src_off must be mappable to a bus
863  * address according to the DMA mapping API rules for streaming mappings.
864  * Both @dest_page/@dest_off and @src_page/@src_off must stay memory resident
865  * (kernel memory or locked user space pages).
866  */
867 dma_cookie_t
868 dma_async_memcpy_pg_to_pg(struct dma_chan *chan, struct page *dest_pg,
869         unsigned int dest_off, struct page *src_pg, unsigned int src_off,
870         size_t len)
871 {
872         struct dma_device *dev = chan->device;
873         struct dma_async_tx_descriptor *tx;
874         dma_addr_t dma_dest, dma_src;
875         dma_cookie_t cookie;
876         int cpu;
877
878         dma_src = dma_map_page(dev->dev, src_pg, src_off, len, DMA_TO_DEVICE);
879         dma_dest = dma_map_page(dev->dev, dest_pg, dest_off, len,
880                                 DMA_FROM_DEVICE);
881         tx = dev->device_prep_dma_memcpy(chan, dma_dest, dma_src, len,
882                                          DMA_CTRL_ACK);
883
884         if (!tx) {
885                 dma_unmap_page(dev->dev, dma_src, len, DMA_TO_DEVICE);
886                 dma_unmap_page(dev->dev, dma_dest, len, DMA_FROM_DEVICE);
887                 return -ENOMEM;
888         }
889
890         tx->callback = NULL;
891         cookie = tx->tx_submit(tx);
892
893         cpu = get_cpu();
894         per_cpu_ptr(chan->local, cpu)->bytes_transferred += len;
895         per_cpu_ptr(chan->local, cpu)->memcpy_count++;
896         put_cpu();
897
898         return cookie;
899 }
900 EXPORT_SYMBOL(dma_async_memcpy_pg_to_pg);
901
902 void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx,
903         struct dma_chan *chan)
904 {
905         tx->chan = chan;
906         spin_lock_init(&tx->lock);
907 }
908 EXPORT_SYMBOL(dma_async_tx_descriptor_init);
909
910 /* dma_wait_for_async_tx - spin wait for a transaction to complete
911  * @tx: in-flight transaction to wait on
912  *
913  * This routine assumes that tx was obtained from a call to async_memcpy,
914  * async_xor, async_memset, etc which ensures that tx is "in-flight" (prepped
915  * and submitted).  Walking the parent chain is only meant to cover for DMA
916  * drivers that do not implement the DMA_INTERRUPT capability and may race with
917  * the driver's descriptor cleanup routine.
918  */
919 enum dma_status
920 dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx)
921 {
922         enum dma_status status;
923         struct dma_async_tx_descriptor *iter;
924         struct dma_async_tx_descriptor *parent;
925
926         if (!tx)
927                 return DMA_SUCCESS;
928
929         WARN_ONCE(tx->parent, "%s: speculatively walking dependency chain for"
930                   " %s\n", __func__, dma_chan_name(tx->chan));
931
932         /* poll through the dependency chain, return when tx is complete */
933         do {
934                 iter = tx;
935
936                 /* find the root of the unsubmitted dependency chain */
937                 do {
938                         parent = iter->parent;
939                         if (!parent)
940                                 break;
941                         else
942                                 iter = parent;
943                 } while (parent);
944
945                 /* there is a small window for ->parent == NULL and
946                  * ->cookie == -EBUSY
947                  */
948                 while (iter->cookie == -EBUSY)
949                         cpu_relax();
950
951                 status = dma_sync_wait(iter->chan, iter->cookie);
952         } while (status == DMA_IN_PROGRESS || (iter != tx));
953
954         return status;
955 }
956 EXPORT_SYMBOL_GPL(dma_wait_for_async_tx);
957
958 /* dma_run_dependencies - helper routine for dma drivers to process
959  *      (start) dependent operations on their target channel
960  * @tx: transaction with dependencies
961  */
962 void dma_run_dependencies(struct dma_async_tx_descriptor *tx)
963 {
964         struct dma_async_tx_descriptor *dep = tx->next;
965         struct dma_async_tx_descriptor *dep_next;
966         struct dma_chan *chan;
967
968         if (!dep)
969                 return;
970
971         chan = dep->chan;
972
973         /* keep submitting up until a channel switch is detected
974          * in that case we will be called again as a result of
975          * processing the interrupt from async_tx_channel_switch
976          */
977         for (; dep; dep = dep_next) {
978                 spin_lock_bh(&dep->lock);
979                 dep->parent = NULL;
980                 dep_next = dep->next;
981                 if (dep_next && dep_next->chan == chan)
982                         dep->next = NULL; /* ->next will be submitted */
983                 else
984                         dep_next = NULL; /* submit current dep and terminate */
985                 spin_unlock_bh(&dep->lock);
986
987                 dep->tx_submit(dep);
988         }
989
990         chan->device->device_issue_pending(chan);
991 }
992 EXPORT_SYMBOL_GPL(dma_run_dependencies);
993
994 static int __init dma_bus_init(void)
995 {
996         idr_init(&dma_idr);
997         mutex_init(&dma_list_mutex);
998         return class_register(&dma_devclass);
999 }
1000 subsys_initcall(dma_bus_init);
1001
1002