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);
294 len
= dmatest_random() % test_buf_size
+ 1;
295 src_off
= dmatest_random() % (test_buf_size
- len
+ 1);
296 dst_off
= dmatest_random() % (test_buf_size
- len
+ 1);
298 dmatest_init_srcs(thread
->srcs
, src_off
, len
);
299 dmatest_init_dsts(thread
->dsts
, dst_off
, len
);
301 for (i
= 0; i
< src_cnt
; i
++) {
302 u8
*buf
= thread
->srcs
[i
] + src_off
;
304 dma_srcs
[i
] = dma_map_single(dev
->dev
, buf
, len
,
307 /* map with DMA_BIDIRECTIONAL to force writeback/invalidate */
308 for (i
= 0; i
< dst_cnt
; i
++) {
309 dma_dsts
[i
] = dma_map_single(dev
->dev
, thread
->dsts
[i
],
314 if (thread
->type
== DMA_MEMCPY
)
315 tx
= dev
->device_prep_dma_memcpy(chan
,
316 dma_dsts
[0] + dst_off
,
319 else if (thread
->type
== DMA_XOR
)
320 tx
= dev
->device_prep_dma_xor(chan
,
321 dma_dsts
[0] + dst_off
,
322 dma_srcs
, xor_sources
,
324 else if (thread
->type
== DMA_PQ
) {
325 dma_addr_t dma_pq
[dst_cnt
];
327 for (i
= 0; i
< dst_cnt
; i
++)
328 dma_pq
[i
] = dma_dsts
[i
] + dst_off
;
329 tx
= dev
->device_prep_dma_pq(chan
, dma_pq
, dma_srcs
,
330 pq_sources
, pq_coefs
,
335 for (i
= 0; i
< src_cnt
; i
++)
336 dma_unmap_single(dev
->dev
, dma_srcs
[i
], len
,
338 for (i
= 0; i
< dst_cnt
; i
++)
339 dma_unmap_single(dev
->dev
, dma_dsts
[i
],
342 pr_warning("%s: #%u: prep error with src_off=0x%x "
343 "dst_off=0x%x len=0x%x\n",
344 thread_name
, total_tests
- 1,
345 src_off
, dst_off
, len
);
351 init_completion(&cmp
);
352 tx
->callback
= dmatest_callback
;
353 tx
->callback_param
= &cmp
;
354 cookie
= tx
->tx_submit(tx
);
356 if (dma_submit_error(cookie
)) {
357 pr_warning("%s: #%u: submit error %d with src_off=0x%x "
358 "dst_off=0x%x len=0x%x\n",
359 thread_name
, total_tests
- 1, cookie
,
360 src_off
, dst_off
, len
);
365 dma_async_issue_pending(chan
);
367 tmo
= wait_for_completion_timeout(&cmp
, tmo
);
368 status
= dma_async_is_tx_complete(chan
, cookie
, NULL
, NULL
);
371 pr_warning("%s: #%u: test timed out\n",
372 thread_name
, total_tests
- 1);
375 } else if (status
!= DMA_SUCCESS
) {
376 pr_warning("%s: #%u: got completion callback,"
377 " but status is \'%s\'\n",
378 thread_name
, total_tests
- 1,
379 status
== DMA_ERROR
? "error" : "in progress");
384 /* Unmap by myself (see DMA_COMPL_SKIP_DEST_UNMAP above) */
385 for (i
= 0; i
< dst_cnt
; i
++)
386 dma_unmap_single(dev
->dev
, dma_dsts
[i
], test_buf_size
,
391 pr_debug("%s: verifying source buffer...\n", thread_name
);
392 error_count
+= dmatest_verify(thread
->srcs
, 0, src_off
,
393 0, PATTERN_SRC
, true);
394 error_count
+= dmatest_verify(thread
->srcs
, src_off
,
395 src_off
+ len
, src_off
,
396 PATTERN_SRC
| PATTERN_COPY
, true);
397 error_count
+= dmatest_verify(thread
->srcs
, src_off
+ len
,
398 test_buf_size
, src_off
+ len
,
401 pr_debug("%s: verifying dest buffer...\n",
403 error_count
+= dmatest_verify(thread
->dsts
, 0, dst_off
,
404 0, PATTERN_DST
, false);
405 error_count
+= dmatest_verify(thread
->dsts
, dst_off
,
406 dst_off
+ len
, src_off
,
407 PATTERN_SRC
| PATTERN_COPY
, false);
408 error_count
+= dmatest_verify(thread
->dsts
, dst_off
+ len
,
409 test_buf_size
, dst_off
+ len
,
413 pr_warning("%s: #%u: %u errors with "
414 "src_off=0x%x dst_off=0x%x len=0x%x\n",
415 thread_name
, total_tests
- 1, error_count
,
416 src_off
, dst_off
, len
);
419 pr_debug("%s: #%u: No errors with "
420 "src_off=0x%x dst_off=0x%x len=0x%x\n",
421 thread_name
, total_tests
- 1,
422 src_off
, dst_off
, len
);
427 for (i
= 0; thread
->dsts
[i
]; i
++)
428 kfree(thread
->dsts
[i
]);
432 for (i
= 0; thread
->srcs
[i
]; i
++)
433 kfree(thread
->srcs
[i
]);
437 pr_notice("%s: terminating after %u tests, %u failures (status %d)\n",
438 thread_name
, total_tests
, failed_tests
, ret
);
442 static void dmatest_cleanup_channel(struct dmatest_chan
*dtc
)
444 struct dmatest_thread
*thread
;
445 struct dmatest_thread
*_thread
;
448 list_for_each_entry_safe(thread
, _thread
, &dtc
->threads
, node
) {
449 ret
= kthread_stop(thread
->task
);
450 pr_debug("dmatest: thread %s exited with status %d\n",
451 thread
->task
->comm
, ret
);
452 list_del(&thread
->node
);
458 static int dmatest_add_threads(struct dmatest_chan
*dtc
, enum dma_transaction_type type
)
460 struct dmatest_thread
*thread
;
461 struct dma_chan
*chan
= dtc
->chan
;
465 if (type
== DMA_MEMCPY
)
467 else if (type
== DMA_XOR
)
469 else if (type
== DMA_PQ
)
474 for (i
= 0; i
< threads_per_chan
; i
++) {
475 thread
= kzalloc(sizeof(struct dmatest_thread
), GFP_KERNEL
);
477 pr_warning("dmatest: No memory for %s-%s%u\n",
478 dma_chan_name(chan
), op
, i
);
482 thread
->chan
= dtc
->chan
;
485 thread
->task
= kthread_run(dmatest_func
, thread
, "%s-%s%u",
486 dma_chan_name(chan
), op
, i
);
487 if (IS_ERR(thread
->task
)) {
488 pr_warning("dmatest: Failed to run thread %s-%s%u\n",
489 dma_chan_name(chan
), op
, i
);
494 /* srcbuf and dstbuf are allocated by the thread itself */
496 list_add_tail(&thread
->node
, &dtc
->threads
);
502 static int dmatest_add_channel(struct dma_chan
*chan
)
504 struct dmatest_chan
*dtc
;
505 struct dma_device
*dma_dev
= chan
->device
;
506 unsigned int thread_count
= 0;
509 dtc
= kmalloc(sizeof(struct dmatest_chan
), GFP_KERNEL
);
511 pr_warning("dmatest: No memory for %s\n", dma_chan_name(chan
));
516 INIT_LIST_HEAD(&dtc
->threads
);
518 if (dma_has_cap(DMA_MEMCPY
, dma_dev
->cap_mask
)) {
519 cnt
= dmatest_add_threads(dtc
, DMA_MEMCPY
);
520 thread_count
+= cnt
> 0 ?: 0;
522 if (dma_has_cap(DMA_XOR
, dma_dev
->cap_mask
)) {
523 cnt
= dmatest_add_threads(dtc
, DMA_XOR
);
524 thread_count
+= cnt
> 0 ?: 0;
526 if (dma_has_cap(DMA_PQ
, dma_dev
->cap_mask
)) {
527 cnt
= dmatest_add_threads(dtc
, DMA_PQ
);
528 thread_count
+= cnt
> 0 ?: 0;
531 pr_info("dmatest: Started %u threads using %s\n",
532 thread_count
, dma_chan_name(chan
));
534 list_add_tail(&dtc
->node
, &dmatest_channels
);
540 static bool filter(struct dma_chan
*chan
, void *param
)
542 if (!dmatest_match_channel(chan
) || !dmatest_match_device(chan
->device
))
548 static int __init
dmatest_init(void)
551 struct dma_chan
*chan
;
555 dma_cap_set(DMA_MEMCPY
, mask
);
557 chan
= dma_request_channel(mask
, filter
, NULL
);
559 err
= dmatest_add_channel(chan
);
563 dma_release_channel(chan
);
564 break; /* add_channel failed, punt */
567 break; /* no more channels available */
568 if (max_channels
&& nr_channels
>= max_channels
)
569 break; /* we have all we need */
574 /* when compiled-in wait for drivers to load first */
575 late_initcall(dmatest_init
);
577 static void __exit
dmatest_exit(void)
579 struct dmatest_chan
*dtc
, *_dtc
;
580 struct dma_chan
*chan
;
582 list_for_each_entry_safe(dtc
, _dtc
, &dmatest_channels
, node
) {
583 list_del(&dtc
->node
);
585 dmatest_cleanup_channel(dtc
);
586 pr_debug("dmatest: dropped channel %s\n",
587 dma_chan_name(chan
));
588 dma_release_channel(chan
);
591 module_exit(dmatest_exit
);
593 MODULE_AUTHOR("Haavard Skinnemoen <hskinnemoen@atmel.com>");
594 MODULE_LICENSE("GPL v2");