2 * DMA Engine test module
4 * Copyright (C) 2007 Atmel Corporation
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 #include <linux/delay.h>
11 #include <linux/dmaengine.h>
12 #include <linux/init.h>
13 #include <linux/kthread.h>
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/random.h>
17 #include <linux/wait.h>
19 static unsigned int test_buf_size = 16384;
20 module_param(test_buf_size, uint, S_IRUGO);
21 MODULE_PARM_DESC(test_buf_size, "Size of the memcpy test buffer");
23 static char test_channel[20];
24 module_param_string(channel, test_channel, sizeof(test_channel), S_IRUGO);
25 MODULE_PARM_DESC(channel, "Bus ID of the channel to test (default: any)");
27 static char test_device[20];
28 module_param_string(device, test_device, sizeof(test_device), S_IRUGO);
29 MODULE_PARM_DESC(device, "Bus ID of the DMA Engine to test (default: any)");
31 static unsigned int threads_per_chan = 1;
32 module_param(threads_per_chan, uint, S_IRUGO);
33 MODULE_PARM_DESC(threads_per_chan,
34 "Number of threads to start per channel (default: 1)");
36 static unsigned int max_channels;
37 module_param(max_channels, uint, S_IRUGO);
38 MODULE_PARM_DESC(max_channels,
39 "Maximum number of channels to use (default: all)");
41 static unsigned int iterations;
42 module_param(iterations, uint, S_IRUGO);
43 MODULE_PARM_DESC(iterations,
44 "Iterations before stopping test (default: infinite)");
46 static unsigned int xor_sources = 3;
47 module_param(xor_sources, uint, S_IRUGO);
48 MODULE_PARM_DESC(xor_sources,
49 "Number of xor source buffers (default: 3)");
51 static unsigned int pq_sources = 3;
52 module_param(pq_sources, uint, S_IRUGO);
53 MODULE_PARM_DESC(pq_sources,
54 "Number of p+q source buffers (default: 3)");
57 * Initialization patterns. All bytes in the source buffer has bit 7
58 * set, all bytes in the destination buffer has bit 7 cleared.
60 * Bit 6 is set for all bytes which are to be copied by the DMA
61 * engine. Bit 5 is set for all bytes which are to be overwritten by
64 * The remaining bits are the inverse of a counter which increments by
65 * one for each byte address.
67 #define PATTERN_SRC 0x80
68 #define PATTERN_DST 0x00
69 #define PATTERN_COPY 0x40
70 #define PATTERN_OVERWRITE 0x20
71 #define PATTERN_COUNT_MASK 0x1f
73 struct dmatest_thread {
74 struct list_head node;
75 struct task_struct *task;
76 struct dma_chan *chan;
79 enum dma_transaction_type type;
83 struct list_head node;
84 struct dma_chan *chan;
85 struct list_head threads;
89 * These are protected by dma_list_mutex since they're only used by
90 * the DMA filter function callback
92 static LIST_HEAD(dmatest_channels);
93 static unsigned int nr_channels;
95 static bool dmatest_match_channel(struct dma_chan *chan)
97 if (test_channel[0] == '\0')
99 return strcmp(dma_chan_name(chan), test_channel) == 0;
102 static bool dmatest_match_device(struct dma_device *device)
104 if (test_device[0] == '\0')
106 return strcmp(dev_name(device->dev), test_device) == 0;
109 static unsigned long dmatest_random(void)
113 get_random_bytes(&buf, sizeof(buf));
117 static void dmatest_init_srcs(u8 **bufs, unsigned int start, unsigned int len)
122 for (; (buf = *bufs); bufs++) {
123 for (i = 0; i < start; i++)
124 buf[i] = PATTERN_SRC | (~i & PATTERN_COUNT_MASK);
125 for ( ; i < start + len; i++)
126 buf[i] = PATTERN_SRC | PATTERN_COPY
127 | (~i & PATTERN_COUNT_MASK);
128 for ( ; i < test_buf_size; i++)
129 buf[i] = PATTERN_SRC | (~i & PATTERN_COUNT_MASK);
134 static void dmatest_init_dsts(u8 **bufs, unsigned int start, unsigned int len)
139 for (; (buf = *bufs); bufs++) {
140 for (i = 0; i < start; i++)
141 buf[i] = PATTERN_DST | (~i & PATTERN_COUNT_MASK);
142 for ( ; i < start + len; i++)
143 buf[i] = PATTERN_DST | PATTERN_OVERWRITE
144 | (~i & PATTERN_COUNT_MASK);
145 for ( ; i < test_buf_size; i++)
146 buf[i] = PATTERN_DST | (~i & PATTERN_COUNT_MASK);
150 static void dmatest_mismatch(u8 actual, u8 pattern, unsigned int index,
151 unsigned int counter, bool is_srcbuf)
153 u8 diff = actual ^ pattern;
154 u8 expected = pattern | (~counter & PATTERN_COUNT_MASK);
155 const char *thread_name = current->comm;
158 pr_warning("%s: srcbuf[0x%x] overwritten!"
159 " Expected %02x, got %02x\n",
160 thread_name, index, expected, actual);
161 else if ((pattern & PATTERN_COPY)
162 && (diff & (PATTERN_COPY | PATTERN_OVERWRITE)))
163 pr_warning("%s: dstbuf[0x%x] not copied!"
164 " Expected %02x, got %02x\n",
165 thread_name, index, expected, actual);
166 else if (diff & PATTERN_SRC)
167 pr_warning("%s: dstbuf[0x%x] was copied!"
168 " Expected %02x, got %02x\n",
169 thread_name, index, expected, actual);
171 pr_warning("%s: dstbuf[0x%x] mismatch!"
172 " Expected %02x, got %02x\n",
173 thread_name, index, expected, actual);
176 static unsigned int dmatest_verify(u8 **bufs, unsigned int start,
177 unsigned int end, unsigned int counter, u8 pattern,
181 unsigned int error_count = 0;
185 unsigned int counter_orig = counter;
187 for (; (buf = *bufs); bufs++) {
188 counter = counter_orig;
189 for (i = start; i < end; i++) {
191 expected = pattern | (~counter & PATTERN_COUNT_MASK);
192 if (actual != expected) {
193 if (error_count < 32)
194 dmatest_mismatch(actual, pattern, i,
202 if (error_count > 32)
203 pr_warning("%s: %u errors suppressed\n",
204 current->comm, error_count - 32);
209 static void dmatest_callback(void *completion)
211 complete(completion);
215 * This function repeatedly tests DMA transfers of various lengths and
216 * offsets for a given operation type until it is told to exit by
217 * kthread_stop(). There may be multiple threads running this function
218 * in parallel for a single channel, and there may be multiple channels
219 * being tested in parallel.
221 * Before each test, the source and destination buffer is initialized
222 * with a known pattern. This pattern is different depending on
223 * whether it's in an area which is supposed to be copied or
224 * overwritten, and different in the source and destination buffers.
225 * So if the DMA engine doesn't copy exactly what we tell it to copy,
228 static int dmatest_func(void *data)
230 struct dmatest_thread *thread = data;
231 struct dma_chan *chan;
232 const char *thread_name;
233 unsigned int src_off, dst_off, len;
234 unsigned int error_count;
235 unsigned int failed_tests = 0;
236 unsigned int total_tests = 0;
238 enum dma_status status;
239 enum dma_ctrl_flags flags;
240 u8 pq_coefs[pq_sources + 1];
246 thread_name = current->comm;
252 if (thread->type == DMA_MEMCPY)
253 src_cnt = dst_cnt = 1;
254 else if (thread->type == DMA_XOR) {
255 src_cnt = xor_sources | 1; /* force odd to ensure dst = src */
257 } else if (thread->type == DMA_PQ) {
258 src_cnt = pq_sources | 1; /* force odd to ensure dst = src */
260 for (i = 0; i < src_cnt; i++)
265 thread->srcs = kcalloc(src_cnt+1, sizeof(u8 *), GFP_KERNEL);
268 for (i = 0; i < src_cnt; i++) {
269 thread->srcs[i] = kmalloc(test_buf_size, GFP_KERNEL);
270 if (!thread->srcs[i])
273 thread->srcs[i] = NULL;
275 thread->dsts = kcalloc(dst_cnt+1, sizeof(u8 *), GFP_KERNEL);
278 for (i = 0; i < dst_cnt; i++) {
279 thread->dsts[i] = kmalloc(test_buf_size, GFP_KERNEL);
280 if (!thread->dsts[i])
283 thread->dsts[i] = NULL;
285 set_user_nice(current, 10);
287 flags = DMA_CTRL_ACK | DMA_COMPL_SKIP_DEST_UNMAP | DMA_PREP_INTERRUPT;
289 while (!kthread_should_stop()
290 && !(iterations && total_tests >= iterations)) {
291 struct dma_device *dev = chan->device;
292 struct dma_async_tx_descriptor *tx = NULL;
293 dma_addr_t dma_srcs[src_cnt];
294 dma_addr_t dma_dsts[dst_cnt];
295 struct completion cmp;
296 unsigned long tmo = msecs_to_jiffies(3000);
301 /* honor alignment restrictions */
302 if (thread->type == DMA_MEMCPY)
303 align = dev->copy_align;
304 else if (thread->type == DMA_XOR)
305 align = dev->xor_align;
306 else if (thread->type == DMA_PQ)
307 align = dev->pq_align;
309 if (1 << align > test_buf_size) {
310 pr_err("%u-byte buffer too small for %d-byte alignment\n",
311 test_buf_size, 1 << align);
315 len = dmatest_random() % test_buf_size + 1;
316 len = (len >> align) << align;
319 src_off = dmatest_random() % (test_buf_size - len + 1);
320 dst_off = dmatest_random() % (test_buf_size - len + 1);
322 src_off = (src_off >> align) << align;
323 dst_off = (dst_off >> align) << align;
325 dmatest_init_srcs(thread->srcs, src_off, len);
326 dmatest_init_dsts(thread->dsts, dst_off, len);
328 for (i = 0; i < src_cnt; i++) {
329 u8 *buf = thread->srcs[i] + src_off;
331 dma_srcs[i] = dma_map_single(dev->dev, buf, len,
334 /* map with DMA_BIDIRECTIONAL to force writeback/invalidate */
335 for (i = 0; i < dst_cnt; i++) {
336 dma_dsts[i] = dma_map_single(dev->dev, thread->dsts[i],
342 if (thread->type == DMA_MEMCPY)
343 tx = dev->device_prep_dma_memcpy(chan,
344 dma_dsts[0] + dst_off,
347 else if (thread->type == DMA_XOR)
348 tx = dev->device_prep_dma_xor(chan,
349 dma_dsts[0] + dst_off,
352 else if (thread->type == DMA_PQ) {
353 dma_addr_t dma_pq[dst_cnt];
355 for (i = 0; i < dst_cnt; i++)
356 dma_pq[i] = dma_dsts[i] + dst_off;
357 tx = dev->device_prep_dma_pq(chan, dma_pq, dma_srcs,
363 for (i = 0; i < src_cnt; i++)
364 dma_unmap_single(dev->dev, dma_srcs[i], len,
366 for (i = 0; i < dst_cnt; i++)
367 dma_unmap_single(dev->dev, dma_dsts[i],
370 pr_warning("%s: #%u: prep error with src_off=0x%x "
371 "dst_off=0x%x len=0x%x\n",
372 thread_name, total_tests - 1,
373 src_off, dst_off, len);
379 init_completion(&cmp);
380 tx->callback = dmatest_callback;
381 tx->callback_param = &cmp;
382 cookie = tx->tx_submit(tx);
384 if (dma_submit_error(cookie)) {
385 pr_warning("%s: #%u: submit error %d with src_off=0x%x "
386 "dst_off=0x%x len=0x%x\n",
387 thread_name, total_tests - 1, cookie,
388 src_off, dst_off, len);
393 dma_async_issue_pending(chan);
395 tmo = wait_for_completion_timeout(&cmp, tmo);
396 status = dma_async_is_tx_complete(chan, cookie, NULL, NULL);
399 pr_warning("%s: #%u: test timed out\n",
400 thread_name, total_tests - 1);
403 } else if (status != DMA_SUCCESS) {
404 pr_warning("%s: #%u: got completion callback,"
405 " but status is \'%s\'\n",
406 thread_name, total_tests - 1,
407 status == DMA_ERROR ? "error" : "in progress");
412 /* Unmap by myself (see DMA_COMPL_SKIP_DEST_UNMAP above) */
413 for (i = 0; i < dst_cnt; i++)
414 dma_unmap_single(dev->dev, dma_dsts[i], test_buf_size,
419 pr_debug("%s: verifying source buffer...\n", thread_name);
420 error_count += dmatest_verify(thread->srcs, 0, src_off,
421 0, PATTERN_SRC, true);
422 error_count += dmatest_verify(thread->srcs, src_off,
423 src_off + len, src_off,
424 PATTERN_SRC | PATTERN_COPY, true);
425 error_count += dmatest_verify(thread->srcs, src_off + len,
426 test_buf_size, src_off + len,
429 pr_debug("%s: verifying dest buffer...\n",
431 error_count += dmatest_verify(thread->dsts, 0, dst_off,
432 0, PATTERN_DST, false);
433 error_count += dmatest_verify(thread->dsts, dst_off,
434 dst_off + len, src_off,
435 PATTERN_SRC | PATTERN_COPY, false);
436 error_count += dmatest_verify(thread->dsts, dst_off + len,
437 test_buf_size, dst_off + len,
441 pr_warning("%s: #%u: %u errors with "
442 "src_off=0x%x dst_off=0x%x len=0x%x\n",
443 thread_name, total_tests - 1, error_count,
444 src_off, dst_off, len);
447 pr_debug("%s: #%u: No errors with "
448 "src_off=0x%x dst_off=0x%x len=0x%x\n",
449 thread_name, total_tests - 1,
450 src_off, dst_off, len);
455 for (i = 0; thread->dsts[i]; i++)
456 kfree(thread->dsts[i]);
460 for (i = 0; thread->srcs[i]; i++)
461 kfree(thread->srcs[i]);
465 pr_notice("%s: terminating after %u tests, %u failures (status %d)\n",
466 thread_name, total_tests, failed_tests, ret);
469 while (!kthread_should_stop()) {
470 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wait_dmatest_exit);
471 interruptible_sleep_on(&wait_dmatest_exit);
477 static void dmatest_cleanup_channel(struct dmatest_chan *dtc)
479 struct dmatest_thread *thread;
480 struct dmatest_thread *_thread;
483 list_for_each_entry_safe(thread, _thread, &dtc->threads, node) {
484 ret = kthread_stop(thread->task);
485 pr_debug("dmatest: thread %s exited with status %d\n",
486 thread->task->comm, ret);
487 list_del(&thread->node);
493 static int dmatest_add_threads(struct dmatest_chan *dtc, enum dma_transaction_type type)
495 struct dmatest_thread *thread;
496 struct dma_chan *chan = dtc->chan;
500 if (type == DMA_MEMCPY)
502 else if (type == DMA_XOR)
504 else if (type == DMA_PQ)
509 for (i = 0; i < threads_per_chan; i++) {
510 thread = kzalloc(sizeof(struct dmatest_thread), GFP_KERNEL);
512 pr_warning("dmatest: No memory for %s-%s%u\n",
513 dma_chan_name(chan), op, i);
517 thread->chan = dtc->chan;
520 thread->task = kthread_run(dmatest_func, thread, "%s-%s%u",
521 dma_chan_name(chan), op, i);
522 if (IS_ERR(thread->task)) {
523 pr_warning("dmatest: Failed to run thread %s-%s%u\n",
524 dma_chan_name(chan), op, i);
529 /* srcbuf and dstbuf are allocated by the thread itself */
531 list_add_tail(&thread->node, &dtc->threads);
537 static int dmatest_add_channel(struct dma_chan *chan)
539 struct dmatest_chan *dtc;
540 struct dma_device *dma_dev = chan->device;
541 unsigned int thread_count = 0;
544 dtc = kmalloc(sizeof(struct dmatest_chan), GFP_KERNEL);
546 pr_warning("dmatest: No memory for %s\n", dma_chan_name(chan));
551 INIT_LIST_HEAD(&dtc->threads);
553 if (dma_has_cap(DMA_MEMCPY, dma_dev->cap_mask)) {
554 cnt = dmatest_add_threads(dtc, DMA_MEMCPY);
555 thread_count += cnt > 0 ? cnt : 0;
557 if (dma_has_cap(DMA_XOR, dma_dev->cap_mask)) {
558 cnt = dmatest_add_threads(dtc, DMA_XOR);
559 thread_count += cnt > 0 ? cnt : 0;
561 if (dma_has_cap(DMA_PQ, dma_dev->cap_mask)) {
562 cnt = dmatest_add_threads(dtc, DMA_PQ);
563 thread_count += cnt > 0 ?: 0;
566 pr_info("dmatest: Started %u threads using %s\n",
567 thread_count, dma_chan_name(chan));
569 list_add_tail(&dtc->node, &dmatest_channels);
575 static bool filter(struct dma_chan *chan, void *param)
577 if (!dmatest_match_channel(chan) || !dmatest_match_device(chan->device))
583 static int __init dmatest_init(void)
586 struct dma_chan *chan;
590 dma_cap_set(DMA_MEMCPY, mask);
592 chan = dma_request_channel(mask, filter, NULL);
594 err = dmatest_add_channel(chan);
596 dma_release_channel(chan);
597 break; /* add_channel failed, punt */
600 break; /* no more channels available */
601 if (max_channels && nr_channels >= max_channels)
602 break; /* we have all we need */
607 /* when compiled-in wait for drivers to load first */
608 late_initcall(dmatest_init);
610 static void __exit dmatest_exit(void)
612 struct dmatest_chan *dtc, *_dtc;
613 struct dma_chan *chan;
615 list_for_each_entry_safe(dtc, _dtc, &dmatest_channels, node) {
616 list_del(&dtc->node);
618 dmatest_cleanup_channel(dtc);
619 pr_debug("dmatest: dropped channel %s\n",
620 dma_chan_name(chan));
621 dma_release_channel(chan);
624 module_exit(dmatest_exit);
626 MODULE_AUTHOR("Haavard Skinnemoen <hskinnemoen@atmel.com>");
627 MODULE_LICENSE("GPL v2");