2 * Copyright(c) 2004 - 2006 Intel Corporation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; either version 2 of the License, or (at your option)
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * 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.
18 * The full GNU General Public License is included in this distribution in the
19 * file called COPYING.
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
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,
34 * The subsystem keeps two global lists, dma_device_list and dma_client_list.
35 * Both of these are protected by a mutex, dma_list_mutex.
37 * Each device has a channels list, which runs unlocked but is never modified
38 * once the device is registered, it's just setup by the driver.
40 * Each client is responsible for keeping track of the channels it uses. See
41 * the definition of dma_event_callback in dmaengine.h.
43 * Each device has a kref, which is initialized to 1 when the device is
44 * registered. A kref_get is done for each device registered. When the
45 * device is released, the corresponding kref_put is done in the release
46 * method. Every time one of the device's channels is allocated to a client,
47 * a kref_get occurs. When the channel is freed, the corresponding kref_put
48 * happens. The device's release function does a completion, so
49 * unregister_device does a remove event, device_unregister, a kref_put
50 * for the first reference, then waits on the completion for all other
51 * references to finish.
53 * Each channel has an open-coded implementation of Rusty Russell's "bigref,"
54 * with a kref and a per_cpu local_t. A dma_chan_get is called when a client
55 * signals that it wants to use a channel, and dma_chan_put is called when
56 * a channel is removed or a client using it is unregistered. A client can
57 * take extra references per outstanding transaction, as is the case with
58 * the NET DMA client. The release function does a kref_put on the device.
62 #include <linux/init.h>
63 #include <linux/module.h>
65 #include <linux/device.h>
66 #include <linux/dmaengine.h>
67 #include <linux/hardirq.h>
68 #include <linux/spinlock.h>
69 #include <linux/percpu.h>
70 #include <linux/rcupdate.h>
71 #include <linux/mutex.h>
72 #include <linux/jiffies.h>
74 static DEFINE_MUTEX(dma_list_mutex);
75 static LIST_HEAD(dma_device_list);
76 static LIST_HEAD(dma_client_list);
78 /* --- sysfs implementation --- */
80 static ssize_t show_memcpy_count(struct device *dev, struct device_attribute *attr, char *buf)
82 struct dma_chan *chan = to_dma_chan(dev);
83 unsigned long count = 0;
86 for_each_possible_cpu(i)
87 count += per_cpu_ptr(chan->local, i)->memcpy_count;
89 return sprintf(buf, "%lu\n", count);
92 static ssize_t show_bytes_transferred(struct device *dev, struct device_attribute *attr,
95 struct dma_chan *chan = to_dma_chan(dev);
96 unsigned long count = 0;
99 for_each_possible_cpu(i)
100 count += per_cpu_ptr(chan->local, i)->bytes_transferred;
102 return sprintf(buf, "%lu\n", count);
105 static ssize_t show_in_use(struct device *dev, struct device_attribute *attr, char *buf)
107 struct dma_chan *chan = to_dma_chan(dev);
110 if (unlikely(chan->slow_ref) &&
111 atomic_read(&chan->refcount.refcount) > 1)
114 if (local_read(&(per_cpu_ptr(chan->local,
115 get_cpu())->refcount)) > 0)
120 return sprintf(buf, "%d\n", in_use);
123 static struct device_attribute dma_attrs[] = {
124 __ATTR(memcpy_count, S_IRUGO, show_memcpy_count, NULL),
125 __ATTR(bytes_transferred, S_IRUGO, show_bytes_transferred, NULL),
126 __ATTR(in_use, S_IRUGO, show_in_use, NULL),
130 static void dma_async_device_cleanup(struct kref *kref);
132 static void dma_dev_release(struct device *dev)
134 struct dma_chan *chan = to_dma_chan(dev);
135 kref_put(&chan->device->refcount, dma_async_device_cleanup);
138 static struct class dma_devclass = {
140 .dev_attrs = dma_attrs,
141 .dev_release = dma_dev_release,
144 /* --- client and device registration --- */
146 #define dma_chan_satisfies_mask(chan, mask) \
147 __dma_chan_satisfies_mask((chan), &(mask))
149 __dma_chan_satisfies_mask(struct dma_chan *chan, dma_cap_mask_t *want)
153 bitmap_and(has.bits, want->bits, chan->device->cap_mask.bits,
155 return bitmap_equal(want->bits, has.bits, DMA_TX_TYPE_END);
159 * dma_client_chan_alloc - try to allocate channels to a client
160 * @client: &dma_client
162 * Called with dma_list_mutex held.
164 static void dma_client_chan_alloc(struct dma_client *client)
166 struct dma_device *device;
167 struct dma_chan *chan;
168 int desc; /* allocated descriptor count */
169 enum dma_state_client ack;
172 list_for_each_entry(device, &dma_device_list, global_node)
173 list_for_each_entry(chan, &device->channels, device_node) {
174 if (!dma_chan_satisfies_mask(chan, client->cap_mask))
177 desc = chan->device->device_alloc_chan_resources(chan);
179 ack = client->event_callback(client,
181 DMA_RESOURCE_AVAILABLE);
183 /* we are done once this client rejects
184 * an available resource
186 if (ack == DMA_ACK) {
188 chan->client_count++;
189 } else if (ack == DMA_NAK)
195 enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie)
197 enum dma_status status;
198 unsigned long dma_sync_wait_timeout = jiffies + msecs_to_jiffies(5000);
200 dma_async_issue_pending(chan);
202 status = dma_async_is_tx_complete(chan, cookie, NULL, NULL);
203 if (time_after_eq(jiffies, dma_sync_wait_timeout)) {
204 printk(KERN_ERR "dma_sync_wait_timeout!\n");
207 } while (status == DMA_IN_PROGRESS);
211 EXPORT_SYMBOL(dma_sync_wait);
214 * dma_chan_cleanup - release a DMA channel's resources
215 * @kref: kernel reference structure that contains the DMA channel device
217 void dma_chan_cleanup(struct kref *kref)
219 struct dma_chan *chan = container_of(kref, struct dma_chan, refcount);
220 chan->device->device_free_chan_resources(chan);
221 kref_put(&chan->device->refcount, dma_async_device_cleanup);
223 EXPORT_SYMBOL(dma_chan_cleanup);
225 static void dma_chan_free_rcu(struct rcu_head *rcu)
227 struct dma_chan *chan = container_of(rcu, struct dma_chan, rcu);
228 int bias = 0x7FFFFFFF;
230 for_each_possible_cpu(i)
231 bias -= local_read(&per_cpu_ptr(chan->local, i)->refcount);
232 atomic_sub(bias, &chan->refcount.refcount);
233 kref_put(&chan->refcount, dma_chan_cleanup);
236 static void dma_chan_release(struct dma_chan *chan)
238 atomic_add(0x7FFFFFFF, &chan->refcount.refcount);
240 call_rcu(&chan->rcu, dma_chan_free_rcu);
244 * dma_chans_notify_available - broadcast available channels to the clients
246 static void dma_clients_notify_available(void)
248 struct dma_client *client;
250 mutex_lock(&dma_list_mutex);
252 list_for_each_entry(client, &dma_client_list, global_node)
253 dma_client_chan_alloc(client);
255 mutex_unlock(&dma_list_mutex);
259 * dma_chans_notify_available - tell the clients that a channel is going away
260 * @chan: channel on its way out
262 static void dma_clients_notify_removed(struct dma_chan *chan)
264 struct dma_client *client;
265 enum dma_state_client ack;
267 mutex_lock(&dma_list_mutex);
269 list_for_each_entry(client, &dma_client_list, global_node) {
270 ack = client->event_callback(client, chan,
271 DMA_RESOURCE_REMOVED);
273 /* client was holding resources for this channel so
276 if (ack == DMA_ACK) {
278 chan->client_count--;
282 mutex_unlock(&dma_list_mutex);
286 * dma_async_client_register - register a &dma_client
287 * @client: ptr to a client structure with valid 'event_callback' and 'cap_mask'
289 void dma_async_client_register(struct dma_client *client)
291 mutex_lock(&dma_list_mutex);
292 list_add_tail(&client->global_node, &dma_client_list);
293 mutex_unlock(&dma_list_mutex);
295 EXPORT_SYMBOL(dma_async_client_register);
298 * dma_async_client_unregister - unregister a client and free the &dma_client
299 * @client: &dma_client to free
301 * Force frees any allocated DMA channels, frees the &dma_client memory
303 void dma_async_client_unregister(struct dma_client *client)
305 struct dma_device *device;
306 struct dma_chan *chan;
307 enum dma_state_client ack;
312 mutex_lock(&dma_list_mutex);
313 /* free all channels the client is holding */
314 list_for_each_entry(device, &dma_device_list, global_node)
315 list_for_each_entry(chan, &device->channels, device_node) {
316 ack = client->event_callback(client, chan,
317 DMA_RESOURCE_REMOVED);
319 if (ack == DMA_ACK) {
321 chan->client_count--;
325 list_del(&client->global_node);
326 mutex_unlock(&dma_list_mutex);
328 EXPORT_SYMBOL(dma_async_client_unregister);
331 * dma_async_client_chan_request - send all available channels to the
332 * client that satisfy the capability mask
333 * @client - requester
335 void dma_async_client_chan_request(struct dma_client *client)
337 mutex_lock(&dma_list_mutex);
338 dma_client_chan_alloc(client);
339 mutex_unlock(&dma_list_mutex);
341 EXPORT_SYMBOL(dma_async_client_chan_request);
344 * dma_async_device_register - registers DMA devices found
345 * @device: &dma_device
347 int dma_async_device_register(struct dma_device *device)
351 struct dma_chan* chan;
356 /* validate device routines */
357 BUG_ON(dma_has_cap(DMA_MEMCPY, device->cap_mask) &&
358 !device->device_prep_dma_memcpy);
359 BUG_ON(dma_has_cap(DMA_XOR, device->cap_mask) &&
360 !device->device_prep_dma_xor);
361 BUG_ON(dma_has_cap(DMA_ZERO_SUM, device->cap_mask) &&
362 !device->device_prep_dma_zero_sum);
363 BUG_ON(dma_has_cap(DMA_MEMSET, device->cap_mask) &&
364 !device->device_prep_dma_memset);
365 BUG_ON(dma_has_cap(DMA_INTERRUPT, device->cap_mask) &&
366 !device->device_prep_dma_interrupt);
368 BUG_ON(!device->device_alloc_chan_resources);
369 BUG_ON(!device->device_free_chan_resources);
370 BUG_ON(!device->device_is_tx_complete);
371 BUG_ON(!device->device_issue_pending);
372 BUG_ON(!device->dev);
374 init_completion(&device->done);
375 kref_init(&device->refcount);
376 device->dev_id = id++;
378 /* represent channels in sysfs. Probably want devs too */
379 list_for_each_entry(chan, &device->channels, device_node) {
380 chan->local = alloc_percpu(typeof(*chan->local));
381 if (chan->local == NULL)
384 chan->chan_id = chancnt++;
385 chan->dev.class = &dma_devclass;
386 chan->dev.parent = device->dev;
387 snprintf(chan->dev.bus_id, BUS_ID_SIZE, "dma%dchan%d",
388 device->dev_id, chan->chan_id);
390 rc = device_register(&chan->dev);
393 free_percpu(chan->local);
398 /* One for the channel, one of the class device */
399 kref_get(&device->refcount);
400 kref_get(&device->refcount);
401 kref_init(&chan->refcount);
402 chan->client_count = 0;
404 INIT_RCU_HEAD(&chan->rcu);
407 mutex_lock(&dma_list_mutex);
408 list_add_tail(&device->global_node, &dma_device_list);
409 mutex_unlock(&dma_list_mutex);
411 dma_clients_notify_available();
416 list_for_each_entry(chan, &device->channels, device_node) {
417 if (chan->local == NULL)
419 kref_put(&device->refcount, dma_async_device_cleanup);
420 device_unregister(&chan->dev);
422 free_percpu(chan->local);
426 EXPORT_SYMBOL(dma_async_device_register);
429 * dma_async_device_cleanup - function called when all references are released
430 * @kref: kernel reference object
432 static void dma_async_device_cleanup(struct kref *kref)
434 struct dma_device *device;
436 device = container_of(kref, struct dma_device, refcount);
437 complete(&device->done);
441 * dma_async_device_unregister - unregisters DMA devices
442 * @device: &dma_device
444 void dma_async_device_unregister(struct dma_device *device)
446 struct dma_chan *chan;
448 mutex_lock(&dma_list_mutex);
449 list_del(&device->global_node);
450 mutex_unlock(&dma_list_mutex);
452 list_for_each_entry(chan, &device->channels, device_node) {
453 dma_clients_notify_removed(chan);
454 device_unregister(&chan->dev);
455 dma_chan_release(chan);
458 kref_put(&device->refcount, dma_async_device_cleanup);
459 wait_for_completion(&device->done);
461 EXPORT_SYMBOL(dma_async_device_unregister);
464 * dma_async_memcpy_buf_to_buf - offloaded copy between virtual addresses
465 * @chan: DMA channel to offload copy to
466 * @dest: destination address (virtual)
467 * @src: source address (virtual)
470 * Both @dest and @src must be mappable to a bus address according to the
471 * DMA mapping API rules for streaming mappings.
472 * Both @dest and @src must stay memory resident (kernel memory or locked
476 dma_async_memcpy_buf_to_buf(struct dma_chan *chan, void *dest,
477 void *src, size_t len)
479 struct dma_device *dev = chan->device;
480 struct dma_async_tx_descriptor *tx;
481 dma_addr_t dma_dest, dma_src;
485 dma_src = dma_map_single(dev->dev, src, len, DMA_TO_DEVICE);
486 dma_dest = dma_map_single(dev->dev, dest, len, DMA_FROM_DEVICE);
487 tx = dev->device_prep_dma_memcpy(chan, dma_dest, dma_src, len,
491 dma_unmap_single(dev->dev, dma_src, len, DMA_TO_DEVICE);
492 dma_unmap_single(dev->dev, dma_dest, len, DMA_FROM_DEVICE);
497 cookie = tx->tx_submit(tx);
500 per_cpu_ptr(chan->local, cpu)->bytes_transferred += len;
501 per_cpu_ptr(chan->local, cpu)->memcpy_count++;
506 EXPORT_SYMBOL(dma_async_memcpy_buf_to_buf);
509 * dma_async_memcpy_buf_to_pg - offloaded copy from address to page
510 * @chan: DMA channel to offload copy to
511 * @page: destination page
512 * @offset: offset in page to copy to
513 * @kdata: source address (virtual)
516 * Both @page/@offset and @kdata must be mappable to a bus address according
517 * to the DMA mapping API rules for streaming mappings.
518 * Both @page/@offset and @kdata must stay memory resident (kernel memory or
519 * locked user space pages)
522 dma_async_memcpy_buf_to_pg(struct dma_chan *chan, struct page *page,
523 unsigned int offset, void *kdata, size_t len)
525 struct dma_device *dev = chan->device;
526 struct dma_async_tx_descriptor *tx;
527 dma_addr_t dma_dest, dma_src;
531 dma_src = dma_map_single(dev->dev, kdata, len, DMA_TO_DEVICE);
532 dma_dest = dma_map_page(dev->dev, page, offset, len, DMA_FROM_DEVICE);
533 tx = dev->device_prep_dma_memcpy(chan, dma_dest, dma_src, len,
537 dma_unmap_single(dev->dev, dma_src, len, DMA_TO_DEVICE);
538 dma_unmap_page(dev->dev, dma_dest, len, DMA_FROM_DEVICE);
543 cookie = tx->tx_submit(tx);
546 per_cpu_ptr(chan->local, cpu)->bytes_transferred += len;
547 per_cpu_ptr(chan->local, cpu)->memcpy_count++;
552 EXPORT_SYMBOL(dma_async_memcpy_buf_to_pg);
555 * dma_async_memcpy_pg_to_pg - offloaded copy from page to page
556 * @chan: DMA channel to offload copy to
557 * @dest_pg: destination page
558 * @dest_off: offset in page to copy to
559 * @src_pg: source page
560 * @src_off: offset in page to copy from
563 * Both @dest_page/@dest_off and @src_page/@src_off must be mappable to a bus
564 * address according to the DMA mapping API rules for streaming mappings.
565 * Both @dest_page/@dest_off and @src_page/@src_off must stay memory resident
566 * (kernel memory or locked user space pages).
569 dma_async_memcpy_pg_to_pg(struct dma_chan *chan, struct page *dest_pg,
570 unsigned int dest_off, struct page *src_pg, unsigned int src_off,
573 struct dma_device *dev = chan->device;
574 struct dma_async_tx_descriptor *tx;
575 dma_addr_t dma_dest, dma_src;
579 dma_src = dma_map_page(dev->dev, src_pg, src_off, len, DMA_TO_DEVICE);
580 dma_dest = dma_map_page(dev->dev, dest_pg, dest_off, len,
582 tx = dev->device_prep_dma_memcpy(chan, dma_dest, dma_src, len,
586 dma_unmap_page(dev->dev, dma_src, len, DMA_TO_DEVICE);
587 dma_unmap_page(dev->dev, dma_dest, len, DMA_FROM_DEVICE);
592 cookie = tx->tx_submit(tx);
595 per_cpu_ptr(chan->local, cpu)->bytes_transferred += len;
596 per_cpu_ptr(chan->local, cpu)->memcpy_count++;
601 EXPORT_SYMBOL(dma_async_memcpy_pg_to_pg);
603 void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx,
604 struct dma_chan *chan)
607 spin_lock_init(&tx->lock);
609 EXPORT_SYMBOL(dma_async_tx_descriptor_init);
611 static int __init dma_bus_init(void)
613 mutex_init(&dma_list_mutex);
614 return class_register(&dma_devclass);
616 subsys_initcall(dma_bus_init);