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)");
47 * Initialization patterns. All bytes in the source buffer has bit 7
48 * set, all bytes in the destination buffer has bit 7 cleared.
50 * Bit 6 is set for all bytes which are to be copied by the DMA
51 * engine. Bit 5 is set for all bytes which are to be overwritten by
54 * The remaining bits are the inverse of a counter which increments by
55 * one for each byte address.
57 #define PATTERN_SRC 0x80
58 #define PATTERN_DST 0x00
59 #define PATTERN_COPY 0x40
60 #define PATTERN_OVERWRITE 0x20
61 #define PATTERN_COUNT_MASK 0x1f
63 struct dmatest_thread
{
64 struct list_head node
;
65 struct task_struct
*task
;
66 struct dma_chan
*chan
;
69 enum dma_transaction_type type
;
73 struct list_head node
;
74 struct dma_chan
*chan
;
75 struct list_head threads
;
79 * These are protected by dma_list_mutex since they're only used by
80 * the DMA filter function callback
82 static LIST_HEAD(dmatest_channels
);
83 static unsigned int nr_channels
;
85 static bool dmatest_match_channel(struct dma_chan
*chan
)
87 if (test_channel
[0] == '\0')
89 return strcmp(dma_chan_name(chan
), test_channel
) == 0;
92 static bool dmatest_match_device(struct dma_device
*device
)
94 if (test_device
[0] == '\0')
96 return strcmp(dev_name(device
->dev
), test_device
) == 0;
99 static unsigned long dmatest_random(void)
103 get_random_bytes(&buf
, sizeof(buf
));
107 static void dmatest_init_srcs(u8
**bufs
, unsigned int start
, unsigned int len
)
112 for (; (buf
= *bufs
); bufs
++) {
113 for (i
= 0; i
< start
; i
++)
114 buf
[i
] = PATTERN_SRC
| (~i
& PATTERN_COUNT_MASK
);
115 for ( ; i
< start
+ len
; i
++)
116 buf
[i
] = PATTERN_SRC
| PATTERN_COPY
117 | (~i
& PATTERN_COUNT_MASK
);;
118 for ( ; i
< test_buf_size
; i
++)
119 buf
[i
] = PATTERN_SRC
| (~i
& PATTERN_COUNT_MASK
);
124 static void dmatest_init_dsts(u8
**bufs
, unsigned int start
, unsigned int len
)
129 for (; (buf
= *bufs
); bufs
++) {
130 for (i
= 0; i
< start
; i
++)
131 buf
[i
] = PATTERN_DST
| (~i
& PATTERN_COUNT_MASK
);
132 for ( ; i
< start
+ len
; i
++)
133 buf
[i
] = PATTERN_DST
| PATTERN_OVERWRITE
134 | (~i
& PATTERN_COUNT_MASK
);
135 for ( ; i
< test_buf_size
; i
++)
136 buf
[i
] = PATTERN_DST
| (~i
& PATTERN_COUNT_MASK
);
140 static void dmatest_mismatch(u8 actual
, u8 pattern
, unsigned int index
,
141 unsigned int counter
, bool is_srcbuf
)
143 u8 diff
= actual
^ pattern
;
144 u8 expected
= pattern
| (~counter
& PATTERN_COUNT_MASK
);
145 const char *thread_name
= current
->comm
;
148 pr_warning("%s: srcbuf[0x%x] overwritten!"
149 " Expected %02x, got %02x\n",
150 thread_name
, index
, expected
, actual
);
151 else if ((pattern
& PATTERN_COPY
)
152 && (diff
& (PATTERN_COPY
| PATTERN_OVERWRITE
)))
153 pr_warning("%s: dstbuf[0x%x] not copied!"
154 " Expected %02x, got %02x\n",
155 thread_name
, index
, expected
, actual
);
156 else if (diff
& PATTERN_SRC
)
157 pr_warning("%s: dstbuf[0x%x] was copied!"
158 " Expected %02x, got %02x\n",
159 thread_name
, index
, expected
, actual
);
161 pr_warning("%s: dstbuf[0x%x] mismatch!"
162 " Expected %02x, got %02x\n",
163 thread_name
, index
, expected
, actual
);
166 static unsigned int dmatest_verify(u8
**bufs
, unsigned int start
,
167 unsigned int end
, unsigned int counter
, u8 pattern
,
171 unsigned int error_count
= 0;
175 unsigned int counter_orig
= counter
;
177 for (; (buf
= *bufs
); bufs
++) {
178 counter
= counter_orig
;
179 for (i
= start
; i
< end
; i
++) {
181 expected
= pattern
| (~counter
& PATTERN_COUNT_MASK
);
182 if (actual
!= expected
) {
183 if (error_count
< 32)
184 dmatest_mismatch(actual
, pattern
, i
,
192 if (error_count
> 32)
193 pr_warning("%s: %u errors suppressed\n",
194 current
->comm
, error_count
- 32);
199 static void dmatest_callback(void *completion
)
201 complete(completion
);
205 * This function repeatedly tests DMA transfers of various lengths and
206 * offsets for a given operation type until it is told to exit by
207 * kthread_stop(). There may be multiple threads running this function
208 * in parallel for a single channel, and there may be multiple channels
209 * being tested in parallel.
211 * Before each test, the source and destination buffer is initialized
212 * with a known pattern. This pattern is different depending on
213 * whether it's in an area which is supposed to be copied or
214 * overwritten, and different in the source and destination buffers.
215 * So if the DMA engine doesn't copy exactly what we tell it to copy,
218 static int dmatest_func(void *data
)
220 struct dmatest_thread
*thread
= data
;
221 struct dma_chan
*chan
;
222 const char *thread_name
;
223 unsigned int src_off
, dst_off
, len
;
224 unsigned int error_count
;
225 unsigned int failed_tests
= 0;
226 unsigned int total_tests
= 0;
228 enum dma_status status
;
229 enum dma_ctrl_flags flags
;
235 thread_name
= current
->comm
;
241 if (thread
->type
== DMA_MEMCPY
)
242 src_cnt
= dst_cnt
= 1;
243 else if (thread
->type
== DMA_XOR
) {
244 src_cnt
= xor_sources
| 1; /* force odd to ensure dst = src */
249 thread
->srcs
= kcalloc(src_cnt
+1, sizeof(u8
*), GFP_KERNEL
);
252 for (i
= 0; i
< src_cnt
; i
++) {
253 thread
->srcs
[i
] = kmalloc(test_buf_size
, GFP_KERNEL
);
254 if (!thread
->srcs
[i
])
257 thread
->srcs
[i
] = NULL
;
259 thread
->dsts
= kcalloc(dst_cnt
+1, sizeof(u8
*), GFP_KERNEL
);
262 for (i
= 0; i
< dst_cnt
; i
++) {
263 thread
->dsts
[i
] = kmalloc(test_buf_size
, GFP_KERNEL
);
264 if (!thread
->dsts
[i
])
267 thread
->dsts
[i
] = NULL
;
269 set_user_nice(current
, 10);
271 flags
= DMA_CTRL_ACK
| DMA_COMPL_SKIP_DEST_UNMAP
| DMA_PREP_INTERRUPT
;
273 while (!kthread_should_stop()) {
274 struct dma_device
*dev
= chan
->device
;
275 struct dma_async_tx_descriptor
*tx
= NULL
;
276 dma_addr_t dma_srcs
[src_cnt
];
277 dma_addr_t dma_dsts
[dst_cnt
];
278 struct completion cmp
;
279 unsigned long tmo
= msecs_to_jiffies(3000);
283 len
= dmatest_random() % test_buf_size
+ 1;
284 src_off
= dmatest_random() % (test_buf_size
- len
+ 1);
285 dst_off
= dmatest_random() % (test_buf_size
- len
+ 1);
287 dmatest_init_srcs(thread
->srcs
, src_off
, len
);
288 dmatest_init_dsts(thread
->dsts
, dst_off
, len
);
290 for (i
= 0; i
< src_cnt
; i
++) {
291 u8
*buf
= thread
->srcs
[i
] + src_off
;
293 dma_srcs
[i
] = dma_map_single(dev
->dev
, buf
, len
,
296 /* map with DMA_BIDIRECTIONAL to force writeback/invalidate */
297 for (i
= 0; i
< dst_cnt
; i
++) {
298 dma_dsts
[i
] = dma_map_single(dev
->dev
, thread
->dsts
[i
],
303 if (thread
->type
== DMA_MEMCPY
)
304 tx
= dev
->device_prep_dma_memcpy(chan
,
305 dma_dsts
[0] + dst_off
,
308 else if (thread
->type
== DMA_XOR
)
309 tx
= dev
->device_prep_dma_xor(chan
,
310 dma_dsts
[0] + dst_off
,
311 dma_srcs
, xor_sources
,
315 for (i
= 0; i
< src_cnt
; i
++)
316 dma_unmap_single(dev
->dev
, dma_srcs
[i
], len
,
318 for (i
= 0; i
< dst_cnt
; i
++)
319 dma_unmap_single(dev
->dev
, dma_dsts
[i
],
322 pr_warning("%s: #%u: prep error with src_off=0x%x "
323 "dst_off=0x%x len=0x%x\n",
324 thread_name
, total_tests
- 1,
325 src_off
, dst_off
, len
);
331 init_completion(&cmp
);
332 tx
->callback
= dmatest_callback
;
333 tx
->callback_param
= &cmp
;
334 cookie
= tx
->tx_submit(tx
);
336 if (dma_submit_error(cookie
)) {
337 pr_warning("%s: #%u: submit error %d with src_off=0x%x "
338 "dst_off=0x%x len=0x%x\n",
339 thread_name
, total_tests
- 1, cookie
,
340 src_off
, dst_off
, len
);
345 dma_async_issue_pending(chan
);
347 tmo
= wait_for_completion_timeout(&cmp
, tmo
);
348 status
= dma_async_is_tx_complete(chan
, cookie
, NULL
, NULL
);
351 pr_warning("%s: #%u: test timed out\n",
352 thread_name
, total_tests
- 1);
355 } else if (status
!= DMA_SUCCESS
) {
356 pr_warning("%s: #%u: got completion callback,"
357 " but status is \'%s\'\n",
358 thread_name
, total_tests
- 1,
359 status
== DMA_ERROR
? "error" : "in progress");
364 /* Unmap by myself (see DMA_COMPL_SKIP_DEST_UNMAP above) */
365 for (i
= 0; i
< dst_cnt
; i
++)
366 dma_unmap_single(dev
->dev
, dma_dsts
[i
], test_buf_size
,
371 pr_debug("%s: verifying source buffer...\n", thread_name
);
372 error_count
+= dmatest_verify(thread
->srcs
, 0, src_off
,
373 0, PATTERN_SRC
, true);
374 error_count
+= dmatest_verify(thread
->srcs
, src_off
,
375 src_off
+ len
, src_off
,
376 PATTERN_SRC
| PATTERN_COPY
, true);
377 error_count
+= dmatest_verify(thread
->srcs
, src_off
+ len
,
378 test_buf_size
, src_off
+ len
,
381 pr_debug("%s: verifying dest buffer...\n",
383 error_count
+= dmatest_verify(thread
->dsts
, 0, dst_off
,
384 0, PATTERN_DST
, false);
385 error_count
+= dmatest_verify(thread
->dsts
, dst_off
,
386 dst_off
+ len
, src_off
,
387 PATTERN_SRC
| PATTERN_COPY
, false);
388 error_count
+= dmatest_verify(thread
->dsts
, dst_off
+ len
,
389 test_buf_size
, dst_off
+ len
,
393 pr_warning("%s: #%u: %u errors with "
394 "src_off=0x%x dst_off=0x%x len=0x%x\n",
395 thread_name
, total_tests
- 1, error_count
,
396 src_off
, dst_off
, len
);
399 pr_debug("%s: #%u: No errors with "
400 "src_off=0x%x dst_off=0x%x len=0x%x\n",
401 thread_name
, total_tests
- 1,
402 src_off
, dst_off
, len
);
407 for (i
= 0; thread
->dsts
[i
]; i
++)
408 kfree(thread
->dsts
[i
]);
412 for (i
= 0; thread
->srcs
[i
]; i
++)
413 kfree(thread
->srcs
[i
]);
417 pr_notice("%s: terminating after %u tests, %u failures (status %d)\n",
418 thread_name
, total_tests
, failed_tests
, ret
);
422 static void dmatest_cleanup_channel(struct dmatest_chan
*dtc
)
424 struct dmatest_thread
*thread
;
425 struct dmatest_thread
*_thread
;
428 list_for_each_entry_safe(thread
, _thread
, &dtc
->threads
, node
) {
429 ret
= kthread_stop(thread
->task
);
430 pr_debug("dmatest: thread %s exited with status %d\n",
431 thread
->task
->comm
, ret
);
432 list_del(&thread
->node
);
438 static int dmatest_add_threads(struct dmatest_chan
*dtc
, enum dma_transaction_type type
)
440 struct dmatest_thread
*thread
;
441 struct dma_chan
*chan
= dtc
->chan
;
445 if (type
== DMA_MEMCPY
)
447 else if (type
== DMA_XOR
)
452 for (i
= 0; i
< threads_per_chan
; i
++) {
453 thread
= kzalloc(sizeof(struct dmatest_thread
), GFP_KERNEL
);
455 pr_warning("dmatest: No memory for %s-%s%u\n",
456 dma_chan_name(chan
), op
, i
);
460 thread
->chan
= dtc
->chan
;
463 thread
->task
= kthread_run(dmatest_func
, thread
, "%s-%s%u",
464 dma_chan_name(chan
), op
, i
);
465 if (IS_ERR(thread
->task
)) {
466 pr_warning("dmatest: Failed to run thread %s-%s%u\n",
467 dma_chan_name(chan
), op
, i
);
472 /* srcbuf and dstbuf are allocated by the thread itself */
474 list_add_tail(&thread
->node
, &dtc
->threads
);
480 static int dmatest_add_channel(struct dma_chan
*chan
)
482 struct dmatest_chan
*dtc
;
483 struct dma_device
*dma_dev
= chan
->device
;
484 unsigned int thread_count
= 0;
487 dtc
= kmalloc(sizeof(struct dmatest_chan
), GFP_KERNEL
);
489 pr_warning("dmatest: No memory for %s\n", dma_chan_name(chan
));
494 INIT_LIST_HEAD(&dtc
->threads
);
496 if (dma_has_cap(DMA_MEMCPY
, dma_dev
->cap_mask
)) {
497 cnt
= dmatest_add_threads(dtc
, DMA_MEMCPY
);
498 thread_count
+= cnt
> 0 ?: 0;
500 if (dma_has_cap(DMA_XOR
, dma_dev
->cap_mask
)) {
501 cnt
= dmatest_add_threads(dtc
, DMA_XOR
);
502 thread_count
+= cnt
> 0 ?: 0;
505 pr_info("dmatest: Started %u threads using %s\n",
506 thread_count
, dma_chan_name(chan
));
508 list_add_tail(&dtc
->node
, &dmatest_channels
);
514 static bool filter(struct dma_chan
*chan
, void *param
)
516 if (!dmatest_match_channel(chan
) || !dmatest_match_device(chan
->device
))
522 static int __init
dmatest_init(void)
525 struct dma_chan
*chan
;
529 dma_cap_set(DMA_MEMCPY
, mask
);
531 chan
= dma_request_channel(mask
, filter
, NULL
);
533 err
= dmatest_add_channel(chan
);
537 dma_release_channel(chan
);
538 break; /* add_channel failed, punt */
541 break; /* no more channels available */
542 if (max_channels
&& nr_channels
>= max_channels
)
543 break; /* we have all we need */
548 /* when compiled-in wait for drivers to load first */
549 late_initcall(dmatest_init
);
551 static void __exit
dmatest_exit(void)
553 struct dmatest_chan
*dtc
, *_dtc
;
554 struct dma_chan
*chan
;
556 list_for_each_entry_safe(dtc
, _dtc
, &dmatest_channels
, node
) {
557 list_del(&dtc
->node
);
559 dmatest_cleanup_channel(dtc
);
560 pr_debug("dmatest: dropped channel %s\n",
561 dma_chan_name(chan
));
562 dma_release_channel(chan
);
565 module_exit(dmatest_exit
);
567 MODULE_AUTHOR("Haavard Skinnemoen <hskinnemoen@atmel.com>");
568 MODULE_LICENSE("GPL v2");