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 xor_sources = 3;
42 module_param(xor_sources, uint, S_IRUGO);
43 MODULE_PARM_DESC(xor_sources,
44 "Number of xor source buffers (default: 3)");
46 static unsigned int pq_sources = 3;
47 module_param(pq_sources, uint, S_IRUGO);
48 MODULE_PARM_DESC(pq_sources,
49 "Number of p+q source buffers (default: 3)");
52 * Initialization patterns. All bytes in the source buffer has bit 7
53 * set, all bytes in the destination buffer has bit 7 cleared.
55 * Bit 6 is set for all bytes which are to be copied by the DMA
56 * engine. Bit 5 is set for all bytes which are to be overwritten by
59 * The remaining bits are the inverse of a counter which increments by
60 * one for each byte address.
62 #define PATTERN_SRC 0x80
63 #define PATTERN_DST 0x00
64 #define PATTERN_COPY 0x40
65 #define PATTERN_OVERWRITE 0x20
66 #define PATTERN_COUNT_MASK 0x1f
68 struct dmatest_thread {
69 struct list_head node;
70 struct task_struct *task;
71 struct dma_chan *chan;
74 enum dma_transaction_type type;
78 struct list_head node;
79 struct dma_chan *chan;
80 struct list_head threads;
84 * These are protected by dma_list_mutex since they're only used by
85 * the DMA filter function callback
87 static LIST_HEAD(dmatest_channels);
88 static unsigned int nr_channels;
90 static bool dmatest_match_channel(struct dma_chan *chan)
92 if (test_channel[0] == '\0')
94 return strcmp(dma_chan_name(chan), test_channel) == 0;
97 static bool dmatest_match_device(struct dma_device *device)
99 if (test_device[0] == '\0')
101 return strcmp(dev_name(device->dev), test_device) == 0;
104 static unsigned long dmatest_random(void)
108 get_random_bytes(&buf, sizeof(buf));
112 static void dmatest_init_srcs(u8 **bufs, unsigned int start, unsigned int len)
117 for (; (buf = *bufs); bufs++) {
118 for (i = 0; i < start; i++)
119 buf[i] = PATTERN_SRC | (~i & PATTERN_COUNT_MASK);
120 for ( ; i < start + len; i++)
121 buf[i] = PATTERN_SRC | PATTERN_COPY
122 | (~i & PATTERN_COUNT_MASK);;
123 for ( ; i < test_buf_size; i++)
124 buf[i] = PATTERN_SRC | (~i & PATTERN_COUNT_MASK);
129 static void dmatest_init_dsts(u8 **bufs, unsigned int start, unsigned int len)
134 for (; (buf = *bufs); bufs++) {
135 for (i = 0; i < start; i++)
136 buf[i] = PATTERN_DST | (~i & PATTERN_COUNT_MASK);
137 for ( ; i < start + len; i++)
138 buf[i] = PATTERN_DST | PATTERN_OVERWRITE
139 | (~i & PATTERN_COUNT_MASK);
140 for ( ; i < test_buf_size; i++)
141 buf[i] = PATTERN_DST | (~i & PATTERN_COUNT_MASK);
145 static void dmatest_mismatch(u8 actual, u8 pattern, unsigned int index,
146 unsigned int counter, bool is_srcbuf)
148 u8 diff = actual ^ pattern;
149 u8 expected = pattern | (~counter & PATTERN_COUNT_MASK);
150 const char *thread_name = current->comm;
153 pr_warning("%s: srcbuf[0x%x] overwritten!"
154 " Expected %02x, got %02x\n",
155 thread_name, index, expected, actual);
156 else if ((pattern & PATTERN_COPY)
157 && (diff & (PATTERN_COPY | PATTERN_OVERWRITE)))
158 pr_warning("%s: dstbuf[0x%x] not copied!"
159 " Expected %02x, got %02x\n",
160 thread_name, index, expected, actual);
161 else if (diff & PATTERN_SRC)
162 pr_warning("%s: dstbuf[0x%x] was copied!"
163 " Expected %02x, got %02x\n",
164 thread_name, index, expected, actual);
166 pr_warning("%s: dstbuf[0x%x] mismatch!"
167 " Expected %02x, got %02x\n",
168 thread_name, index, expected, actual);
171 static unsigned int dmatest_verify(u8 **bufs, unsigned int start,
172 unsigned int end, unsigned int counter, u8 pattern,
176 unsigned int error_count = 0;
180 unsigned int counter_orig = counter;
182 for (; (buf = *bufs); bufs++) {
183 counter = counter_orig;
184 for (i = start; i < end; i++) {
186 expected = pattern | (~counter & PATTERN_COUNT_MASK);
187 if (actual != expected) {
188 if (error_count < 32)
189 dmatest_mismatch(actual, pattern, i,
197 if (error_count > 32)
198 pr_warning("%s: %u errors suppressed\n",
199 current->comm, error_count - 32);
204 static void dmatest_callback(void *completion)
206 complete(completion);
210 * This function repeatedly tests DMA transfers of various lengths and
211 * offsets for a given operation type until it is told to exit by
212 * kthread_stop(). There may be multiple threads running this function
213 * in parallel for a single channel, and there may be multiple channels
214 * being tested in parallel.
216 * Before each test, the source and destination buffer is initialized
217 * with a known pattern. This pattern is different depending on
218 * whether it's in an area which is supposed to be copied or
219 * overwritten, and different in the source and destination buffers.
220 * So if the DMA engine doesn't copy exactly what we tell it to copy,
223 static int dmatest_func(void *data)
225 struct dmatest_thread *thread = data;
226 struct dma_chan *chan;
227 const char *thread_name;
228 unsigned int src_off, dst_off, len;
229 unsigned int error_count;
230 unsigned int failed_tests = 0;
231 unsigned int total_tests = 0;
233 enum dma_status status;
234 enum dma_ctrl_flags flags;
235 u8 pq_coefs[pq_sources];
241 thread_name = current->comm;
247 if (thread->type == DMA_MEMCPY)
248 src_cnt = dst_cnt = 1;
249 else if (thread->type == DMA_XOR) {
250 src_cnt = xor_sources | 1; /* force odd to ensure dst = src */
252 } else if (thread->type == DMA_PQ) {
253 src_cnt = pq_sources | 1; /* force odd to ensure dst = src */
255 for (i = 0; i < pq_sources; i++)
260 thread->srcs = kcalloc(src_cnt+1, sizeof(u8 *), GFP_KERNEL);
263 for (i = 0; i < src_cnt; i++) {
264 thread->srcs[i] = kmalloc(test_buf_size, GFP_KERNEL);
265 if (!thread->srcs[i])
268 thread->srcs[i] = NULL;
270 thread->dsts = kcalloc(dst_cnt+1, sizeof(u8 *), GFP_KERNEL);
273 for (i = 0; i < dst_cnt; i++) {
274 thread->dsts[i] = kmalloc(test_buf_size, GFP_KERNEL);
275 if (!thread->dsts[i])
278 thread->dsts[i] = NULL;
280 set_user_nice(current, 10);
282 flags = DMA_CTRL_ACK | DMA_COMPL_SKIP_DEST_UNMAP | DMA_PREP_INTERRUPT;
284 while (!kthread_should_stop()) {
285 struct dma_device *dev = chan->device;
286 struct dma_async_tx_descriptor *tx = NULL;
287 dma_addr_t dma_srcs[src_cnt];
288 dma_addr_t dma_dsts[dst_cnt];
289 struct completion cmp;
290 unsigned long tmo = msecs_to_jiffies(3000);
295 len = dmatest_random() % test_buf_size + 1;
296 src_off = dmatest_random() % (test_buf_size - len + 1);
297 dst_off = dmatest_random() % (test_buf_size - len + 1);
299 /* honor alignment restrictions */
300 if (thread->type == DMA_MEMCPY)
301 align = dev->copy_align;
302 else if (thread->type == DMA_XOR)
303 align = dev->xor_align;
304 else if (thread->type == DMA_PQ)
305 align = dev->pq_align;
307 len = (len >> align) << align;
308 src_off = (src_off >> align) << align;
309 dst_off = (dst_off >> align) << align;
311 dmatest_init_srcs(thread->srcs, src_off, len);
312 dmatest_init_dsts(thread->dsts, dst_off, len);
314 for (i = 0; i < src_cnt; i++) {
315 u8 *buf = thread->srcs[i] + src_off;
317 dma_srcs[i] = dma_map_single(dev->dev, buf, len,
320 /* map with DMA_BIDIRECTIONAL to force writeback/invalidate */
321 for (i = 0; i < dst_cnt; i++) {
322 dma_dsts[i] = dma_map_single(dev->dev, thread->dsts[i],
328 if (thread->type == DMA_MEMCPY)
329 tx = dev->device_prep_dma_memcpy(chan,
330 dma_dsts[0] + dst_off,
333 else if (thread->type == DMA_XOR)
334 tx = dev->device_prep_dma_xor(chan,
335 dma_dsts[0] + dst_off,
336 dma_srcs, xor_sources,
338 else if (thread->type == DMA_PQ) {
339 dma_addr_t dma_pq[dst_cnt];
341 for (i = 0; i < dst_cnt; i++)
342 dma_pq[i] = dma_dsts[i] + dst_off;
343 tx = dev->device_prep_dma_pq(chan, dma_pq, dma_srcs,
344 pq_sources, pq_coefs,
349 for (i = 0; i < src_cnt; i++)
350 dma_unmap_single(dev->dev, dma_srcs[i], len,
352 for (i = 0; i < dst_cnt; i++)
353 dma_unmap_single(dev->dev, dma_dsts[i],
356 pr_warning("%s: #%u: prep error with src_off=0x%x "
357 "dst_off=0x%x len=0x%x\n",
358 thread_name, total_tests - 1,
359 src_off, dst_off, len);
365 init_completion(&cmp);
366 tx->callback = dmatest_callback;
367 tx->callback_param = &cmp;
368 cookie = tx->tx_submit(tx);
370 if (dma_submit_error(cookie)) {
371 pr_warning("%s: #%u: submit error %d with src_off=0x%x "
372 "dst_off=0x%x len=0x%x\n",
373 thread_name, total_tests - 1, cookie,
374 src_off, dst_off, len);
379 dma_async_issue_pending(chan);
381 tmo = wait_for_completion_timeout(&cmp, tmo);
382 status = dma_async_is_tx_complete(chan, cookie, NULL, NULL);
385 pr_warning("%s: #%u: test timed out\n",
386 thread_name, total_tests - 1);
389 } else if (status != DMA_SUCCESS) {
390 pr_warning("%s: #%u: got completion callback,"
391 " but status is \'%s\'\n",
392 thread_name, total_tests - 1,
393 status == DMA_ERROR ? "error" : "in progress");
398 /* Unmap by myself (see DMA_COMPL_SKIP_DEST_UNMAP above) */
399 for (i = 0; i < dst_cnt; i++)
400 dma_unmap_single(dev->dev, dma_dsts[i], test_buf_size,
405 pr_debug("%s: verifying source buffer...\n", thread_name);
406 error_count += dmatest_verify(thread->srcs, 0, src_off,
407 0, PATTERN_SRC, true);
408 error_count += dmatest_verify(thread->srcs, src_off,
409 src_off + len, src_off,
410 PATTERN_SRC | PATTERN_COPY, true);
411 error_count += dmatest_verify(thread->srcs, src_off + len,
412 test_buf_size, src_off + len,
415 pr_debug("%s: verifying dest buffer...\n",
417 error_count += dmatest_verify(thread->dsts, 0, dst_off,
418 0, PATTERN_DST, false);
419 error_count += dmatest_verify(thread->dsts, dst_off,
420 dst_off + len, src_off,
421 PATTERN_SRC | PATTERN_COPY, false);
422 error_count += dmatest_verify(thread->dsts, dst_off + len,
423 test_buf_size, dst_off + len,
427 pr_warning("%s: #%u: %u errors with "
428 "src_off=0x%x dst_off=0x%x len=0x%x\n",
429 thread_name, total_tests - 1, error_count,
430 src_off, dst_off, len);
433 pr_debug("%s: #%u: No errors with "
434 "src_off=0x%x dst_off=0x%x len=0x%x\n",
435 thread_name, total_tests - 1,
436 src_off, dst_off, len);
441 for (i = 0; thread->dsts[i]; i++)
442 kfree(thread->dsts[i]);
446 for (i = 0; thread->srcs[i]; i++)
447 kfree(thread->srcs[i]);
451 pr_notice("%s: terminating after %u tests, %u failures (status %d)\n",
452 thread_name, total_tests, failed_tests, ret);
456 static void dmatest_cleanup_channel(struct dmatest_chan *dtc)
458 struct dmatest_thread *thread;
459 struct dmatest_thread *_thread;
462 list_for_each_entry_safe(thread, _thread, &dtc->threads, node) {
463 ret = kthread_stop(thread->task);
464 pr_debug("dmatest: thread %s exited with status %d\n",
465 thread->task->comm, ret);
466 list_del(&thread->node);
472 static int dmatest_add_threads(struct dmatest_chan *dtc, enum dma_transaction_type type)
474 struct dmatest_thread *thread;
475 struct dma_chan *chan = dtc->chan;
479 if (type == DMA_MEMCPY)
481 else if (type == DMA_XOR)
483 else if (type == DMA_PQ)
488 for (i = 0; i < threads_per_chan; i++) {
489 thread = kzalloc(sizeof(struct dmatest_thread), GFP_KERNEL);
491 pr_warning("dmatest: No memory for %s-%s%u\n",
492 dma_chan_name(chan), op, i);
496 thread->chan = dtc->chan;
499 thread->task = kthread_run(dmatest_func, thread, "%s-%s%u",
500 dma_chan_name(chan), op, i);
501 if (IS_ERR(thread->task)) {
502 pr_warning("dmatest: Failed to run thread %s-%s%u\n",
503 dma_chan_name(chan), op, i);
508 /* srcbuf and dstbuf are allocated by the thread itself */
510 list_add_tail(&thread->node, &dtc->threads);
516 static int dmatest_add_channel(struct dma_chan *chan)
518 struct dmatest_chan *dtc;
519 struct dma_device *dma_dev = chan->device;
520 unsigned int thread_count = 0;
523 dtc = kmalloc(sizeof(struct dmatest_chan), GFP_KERNEL);
525 pr_warning("dmatest: No memory for %s\n", dma_chan_name(chan));
530 INIT_LIST_HEAD(&dtc->threads);
532 if (dma_has_cap(DMA_MEMCPY, dma_dev->cap_mask)) {
533 cnt = dmatest_add_threads(dtc, DMA_MEMCPY);
534 thread_count += cnt > 0 ?: 0;
536 if (dma_has_cap(DMA_XOR, dma_dev->cap_mask)) {
537 cnt = dmatest_add_threads(dtc, DMA_XOR);
538 thread_count += cnt > 0 ?: 0;
540 if (dma_has_cap(DMA_PQ, dma_dev->cap_mask)) {
541 cnt = dmatest_add_threads(dtc, DMA_PQ);
542 thread_count += cnt > 0 ?: 0;
545 pr_info("dmatest: Started %u threads using %s\n",
546 thread_count, dma_chan_name(chan));
548 list_add_tail(&dtc->node, &dmatest_channels);
554 static bool filter(struct dma_chan *chan, void *param)
556 if (!dmatest_match_channel(chan) || !dmatest_match_device(chan->device))
562 static int __init dmatest_init(void)
565 struct dma_chan *chan;
569 dma_cap_set(DMA_MEMCPY, mask);
571 chan = dma_request_channel(mask, filter, NULL);
573 err = dmatest_add_channel(chan);
575 dma_release_channel(chan);
576 break; /* add_channel failed, punt */
579 break; /* no more channels available */
580 if (max_channels && nr_channels >= max_channels)
581 break; /* we have all we need */
586 /* when compiled-in wait for drivers to load first */
587 late_initcall(dmatest_init);
589 static void __exit dmatest_exit(void)
591 struct dmatest_chan *dtc, *_dtc;
592 struct dma_chan *chan;
594 list_for_each_entry_safe(dtc, _dtc, &dmatest_channels, node) {
595 list_del(&dtc->node);
597 dmatest_cleanup_channel(dtc);
598 pr_debug("dmatest: dropped channel %s\n",
599 dma_chan_name(chan));
600 dma_release_channel(chan);
603 module_exit(dmatest_exit);
605 MODULE_AUTHOR("Haavard Skinnemoen <hskinnemoen@atmel.com>");
606 MODULE_LICENSE("GPL v2");