xref: /openbmc/linux/drivers/dma/dmatest.c (revision f32e5616)
1 /*
2  * DMA Engine test module
3  *
4  * Copyright (C) 2007 Atmel Corporation
5  * Copyright (C) 2013 Intel Corporation
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  */
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 
13 #include <linux/delay.h>
14 #include <linux/dma-mapping.h>
15 #include <linux/dmaengine.h>
16 #include <linux/freezer.h>
17 #include <linux/init.h>
18 #include <linux/kthread.h>
19 #include <linux/sched/task.h>
20 #include <linux/module.h>
21 #include <linux/moduleparam.h>
22 #include <linux/random.h>
23 #include <linux/slab.h>
24 #include <linux/wait.h>
25 
26 static unsigned int test_buf_size = 16384;
27 module_param(test_buf_size, uint, S_IRUGO | S_IWUSR);
28 MODULE_PARM_DESC(test_buf_size, "Size of the memcpy test buffer");
29 
30 static char test_device[32];
31 module_param_string(device, test_device, sizeof(test_device),
32 		S_IRUGO | S_IWUSR);
33 MODULE_PARM_DESC(device, "Bus ID of the DMA Engine to test (default: any)");
34 
35 static unsigned int threads_per_chan = 1;
36 module_param(threads_per_chan, uint, S_IRUGO | S_IWUSR);
37 MODULE_PARM_DESC(threads_per_chan,
38 		"Number of threads to start per channel (default: 1)");
39 
40 static unsigned int max_channels;
41 module_param(max_channels, uint, S_IRUGO | S_IWUSR);
42 MODULE_PARM_DESC(max_channels,
43 		"Maximum number of channels to use (default: all)");
44 
45 static unsigned int iterations;
46 module_param(iterations, uint, S_IRUGO | S_IWUSR);
47 MODULE_PARM_DESC(iterations,
48 		"Iterations before stopping test (default: infinite)");
49 
50 static unsigned int dmatest;
51 module_param(dmatest, uint, S_IRUGO | S_IWUSR);
52 MODULE_PARM_DESC(dmatest,
53 		"dmatest 0-memcpy 1-memset (default: 0)");
54 
55 static unsigned int xor_sources = 3;
56 module_param(xor_sources, uint, S_IRUGO | S_IWUSR);
57 MODULE_PARM_DESC(xor_sources,
58 		"Number of xor source buffers (default: 3)");
59 
60 static unsigned int pq_sources = 3;
61 module_param(pq_sources, uint, S_IRUGO | S_IWUSR);
62 MODULE_PARM_DESC(pq_sources,
63 		"Number of p+q source buffers (default: 3)");
64 
65 static int timeout = 3000;
66 module_param(timeout, uint, S_IRUGO | S_IWUSR);
67 MODULE_PARM_DESC(timeout, "Transfer Timeout in msec (default: 3000), "
68 		 "Pass -1 for infinite timeout");
69 
70 static bool noverify;
71 module_param(noverify, bool, S_IRUGO | S_IWUSR);
72 MODULE_PARM_DESC(noverify, "Disable data verification (default: verify)");
73 
74 static bool norandom;
75 module_param(norandom, bool, 0644);
76 MODULE_PARM_DESC(norandom, "Disable random offset setup (default: random)");
77 
78 static bool verbose;
79 module_param(verbose, bool, S_IRUGO | S_IWUSR);
80 MODULE_PARM_DESC(verbose, "Enable \"success\" result messages (default: off)");
81 
82 static int alignment = -1;
83 module_param(alignment, int, 0644);
84 MODULE_PARM_DESC(alignment, "Custom data address alignment taken as 2^(alignment) (default: not used (-1))");
85 
86 static unsigned int transfer_size;
87 module_param(transfer_size, uint, 0644);
88 MODULE_PARM_DESC(transfer_size, "Optional custom transfer size in bytes (default: not used (0))");
89 
90 /**
91  * struct dmatest_params - test parameters.
92  * @buf_size:		size of the memcpy test buffer
93  * @channel:		bus ID of the channel to test
94  * @device:		bus ID of the DMA Engine to test
95  * @threads_per_chan:	number of threads to start per channel
96  * @max_channels:	maximum number of channels to use
97  * @iterations:		iterations before stopping test
98  * @xor_sources:	number of xor source buffers
99  * @pq_sources:		number of p+q source buffers
100  * @timeout:		transfer timeout in msec, -1 for infinite timeout
101  */
102 struct dmatest_params {
103 	unsigned int	buf_size;
104 	char		channel[20];
105 	char		device[32];
106 	unsigned int	threads_per_chan;
107 	unsigned int	max_channels;
108 	unsigned int	iterations;
109 	unsigned int	xor_sources;
110 	unsigned int	pq_sources;
111 	int		timeout;
112 	bool		noverify;
113 	bool		norandom;
114 	int		alignment;
115 	unsigned int	transfer_size;
116 };
117 
118 /**
119  * struct dmatest_info - test information.
120  * @params:		test parameters
121  * @lock:		access protection to the fields of this structure
122  */
123 static struct dmatest_info {
124 	/* Test parameters */
125 	struct dmatest_params	params;
126 
127 	/* Internal state */
128 	struct list_head	channels;
129 	unsigned int		nr_channels;
130 	struct mutex		lock;
131 	bool			did_init;
132 } test_info = {
133 	.channels = LIST_HEAD_INIT(test_info.channels),
134 	.lock = __MUTEX_INITIALIZER(test_info.lock),
135 };
136 
137 static int dmatest_run_set(const char *val, const struct kernel_param *kp);
138 static int dmatest_run_get(char *val, const struct kernel_param *kp);
139 static const struct kernel_param_ops run_ops = {
140 	.set = dmatest_run_set,
141 	.get = dmatest_run_get,
142 };
143 static bool dmatest_run;
144 module_param_cb(run, &run_ops, &dmatest_run, S_IRUGO | S_IWUSR);
145 MODULE_PARM_DESC(run, "Run the test (default: false)");
146 
147 static int dmatest_chan_set(const char *val, const struct kernel_param *kp);
148 static int dmatest_chan_get(char *val, const struct kernel_param *kp);
149 static const struct kernel_param_ops multi_chan_ops = {
150 	.set = dmatest_chan_set,
151 	.get = dmatest_chan_get,
152 };
153 
154 static char test_channel[20];
155 static struct kparam_string newchan_kps = {
156 	.string = test_channel,
157 	.maxlen = 20,
158 };
159 module_param_cb(channel, &multi_chan_ops, &newchan_kps, 0644);
160 MODULE_PARM_DESC(channel, "Bus ID of the channel to test (default: any)");
161 
162 static int dmatest_test_list_get(char *val, const struct kernel_param *kp);
163 static const struct kernel_param_ops test_list_ops = {
164 	.get = dmatest_test_list_get,
165 };
166 module_param_cb(test_list, &test_list_ops, NULL, 0444);
167 MODULE_PARM_DESC(test_list, "Print current test list");
168 
169 /* Maximum amount of mismatched bytes in buffer to print */
170 #define MAX_ERROR_COUNT		32
171 
172 /*
173  * Initialization patterns. All bytes in the source buffer has bit 7
174  * set, all bytes in the destination buffer has bit 7 cleared.
175  *
176  * Bit 6 is set for all bytes which are to be copied by the DMA
177  * engine. Bit 5 is set for all bytes which are to be overwritten by
178  * the DMA engine.
179  *
180  * The remaining bits are the inverse of a counter which increments by
181  * one for each byte address.
182  */
183 #define PATTERN_SRC		0x80
184 #define PATTERN_DST		0x00
185 #define PATTERN_COPY		0x40
186 #define PATTERN_OVERWRITE	0x20
187 #define PATTERN_COUNT_MASK	0x1f
188 #define PATTERN_MEMSET_IDX	0x01
189 
190 /* Fixed point arithmetic ops */
191 #define FIXPT_SHIFT		8
192 #define FIXPNT_MASK		0xFF
193 #define FIXPT_TO_INT(a)	((a) >> FIXPT_SHIFT)
194 #define INT_TO_FIXPT(a)	((a) << FIXPT_SHIFT)
195 #define FIXPT_GET_FRAC(a)	((((a) & FIXPNT_MASK) * 100) >> FIXPT_SHIFT)
196 
197 /* poor man's completion - we want to use wait_event_freezable() on it */
198 struct dmatest_done {
199 	bool			done;
200 	wait_queue_head_t	*wait;
201 };
202 
203 struct dmatest_thread {
204 	struct list_head	node;
205 	struct dmatest_info	*info;
206 	struct task_struct	*task;
207 	struct dma_chan		*chan;
208 	u8			**srcs;
209 	u8			**usrcs;
210 	u8			**dsts;
211 	u8			**udsts;
212 	enum dma_transaction_type type;
213 	wait_queue_head_t done_wait;
214 	struct dmatest_done test_done;
215 	bool			done;
216 	bool			pending;
217 };
218 
219 struct dmatest_chan {
220 	struct list_head	node;
221 	struct dma_chan		*chan;
222 	struct list_head	threads;
223 };
224 
225 static DECLARE_WAIT_QUEUE_HEAD(thread_wait);
226 static bool wait;
227 
228 static bool is_threaded_test_run(struct dmatest_info *info)
229 {
230 	struct dmatest_chan *dtc;
231 
232 	list_for_each_entry(dtc, &info->channels, node) {
233 		struct dmatest_thread *thread;
234 
235 		list_for_each_entry(thread, &dtc->threads, node) {
236 			if (!thread->done)
237 				return true;
238 		}
239 	}
240 
241 	return false;
242 }
243 
244 static bool is_threaded_test_pending(struct dmatest_info *info)
245 {
246 	struct dmatest_chan *dtc;
247 
248 	list_for_each_entry(dtc, &info->channels, node) {
249 		struct dmatest_thread *thread;
250 
251 		list_for_each_entry(thread, &dtc->threads, node) {
252 			if (thread->pending)
253 				return true;
254 		}
255 	}
256 
257 	return false;
258 }
259 
260 static int dmatest_wait_get(char *val, const struct kernel_param *kp)
261 {
262 	struct dmatest_info *info = &test_info;
263 	struct dmatest_params *params = &info->params;
264 
265 	if (params->iterations)
266 		wait_event(thread_wait, !is_threaded_test_run(info));
267 	wait = true;
268 	return param_get_bool(val, kp);
269 }
270 
271 static const struct kernel_param_ops wait_ops = {
272 	.get = dmatest_wait_get,
273 	.set = param_set_bool,
274 };
275 module_param_cb(wait, &wait_ops, &wait, S_IRUGO);
276 MODULE_PARM_DESC(wait, "Wait for tests to complete (default: false)");
277 
278 static bool dmatest_match_channel(struct dmatest_params *params,
279 		struct dma_chan *chan)
280 {
281 	if (params->channel[0] == '\0')
282 		return true;
283 	return strcmp(dma_chan_name(chan), params->channel) == 0;
284 }
285 
286 static bool dmatest_match_device(struct dmatest_params *params,
287 		struct dma_device *device)
288 {
289 	if (params->device[0] == '\0')
290 		return true;
291 	return strcmp(dev_name(device->dev), params->device) == 0;
292 }
293 
294 static unsigned long dmatest_random(void)
295 {
296 	unsigned long buf;
297 
298 	prandom_bytes(&buf, sizeof(buf));
299 	return buf;
300 }
301 
302 static inline u8 gen_inv_idx(u8 index, bool is_memset)
303 {
304 	u8 val = is_memset ? PATTERN_MEMSET_IDX : index;
305 
306 	return ~val & PATTERN_COUNT_MASK;
307 }
308 
309 static inline u8 gen_src_value(u8 index, bool is_memset)
310 {
311 	return PATTERN_SRC | gen_inv_idx(index, is_memset);
312 }
313 
314 static inline u8 gen_dst_value(u8 index, bool is_memset)
315 {
316 	return PATTERN_DST | gen_inv_idx(index, is_memset);
317 }
318 
319 static void dmatest_init_srcs(u8 **bufs, unsigned int start, unsigned int len,
320 		unsigned int buf_size, bool is_memset)
321 {
322 	unsigned int i;
323 	u8 *buf;
324 
325 	for (; (buf = *bufs); bufs++) {
326 		for (i = 0; i < start; i++)
327 			buf[i] = gen_src_value(i, is_memset);
328 		for ( ; i < start + len; i++)
329 			buf[i] = gen_src_value(i, is_memset) | PATTERN_COPY;
330 		for ( ; i < buf_size; i++)
331 			buf[i] = gen_src_value(i, is_memset);
332 		buf++;
333 	}
334 }
335 
336 static void dmatest_init_dsts(u8 **bufs, unsigned int start, unsigned int len,
337 		unsigned int buf_size, bool is_memset)
338 {
339 	unsigned int i;
340 	u8 *buf;
341 
342 	for (; (buf = *bufs); bufs++) {
343 		for (i = 0; i < start; i++)
344 			buf[i] = gen_dst_value(i, is_memset);
345 		for ( ; i < start + len; i++)
346 			buf[i] = gen_dst_value(i, is_memset) |
347 						PATTERN_OVERWRITE;
348 		for ( ; i < buf_size; i++)
349 			buf[i] = gen_dst_value(i, is_memset);
350 	}
351 }
352 
353 static void dmatest_mismatch(u8 actual, u8 pattern, unsigned int index,
354 		unsigned int counter, bool is_srcbuf, bool is_memset)
355 {
356 	u8		diff = actual ^ pattern;
357 	u8		expected = pattern | gen_inv_idx(counter, is_memset);
358 	const char	*thread_name = current->comm;
359 
360 	if (is_srcbuf)
361 		pr_warn("%s: srcbuf[0x%x] overwritten! Expected %02x, got %02x\n",
362 			thread_name, index, expected, actual);
363 	else if ((pattern & PATTERN_COPY)
364 			&& (diff & (PATTERN_COPY | PATTERN_OVERWRITE)))
365 		pr_warn("%s: dstbuf[0x%x] not copied! Expected %02x, got %02x\n",
366 			thread_name, index, expected, actual);
367 	else if (diff & PATTERN_SRC)
368 		pr_warn("%s: dstbuf[0x%x] was copied! Expected %02x, got %02x\n",
369 			thread_name, index, expected, actual);
370 	else
371 		pr_warn("%s: dstbuf[0x%x] mismatch! Expected %02x, got %02x\n",
372 			thread_name, index, expected, actual);
373 }
374 
375 static unsigned int dmatest_verify(u8 **bufs, unsigned int start,
376 		unsigned int end, unsigned int counter, u8 pattern,
377 		bool is_srcbuf, bool is_memset)
378 {
379 	unsigned int i;
380 	unsigned int error_count = 0;
381 	u8 actual;
382 	u8 expected;
383 	u8 *buf;
384 	unsigned int counter_orig = counter;
385 
386 	for (; (buf = *bufs); bufs++) {
387 		counter = counter_orig;
388 		for (i = start; i < end; i++) {
389 			actual = buf[i];
390 			expected = pattern | gen_inv_idx(counter, is_memset);
391 			if (actual != expected) {
392 				if (error_count < MAX_ERROR_COUNT)
393 					dmatest_mismatch(actual, pattern, i,
394 							 counter, is_srcbuf,
395 							 is_memset);
396 				error_count++;
397 			}
398 			counter++;
399 		}
400 	}
401 
402 	if (error_count > MAX_ERROR_COUNT)
403 		pr_warn("%s: %u errors suppressed\n",
404 			current->comm, error_count - MAX_ERROR_COUNT);
405 
406 	return error_count;
407 }
408 
409 
410 static void dmatest_callback(void *arg)
411 {
412 	struct dmatest_done *done = arg;
413 	struct dmatest_thread *thread =
414 		container_of(done, struct dmatest_thread, test_done);
415 	if (!thread->done) {
416 		done->done = true;
417 		wake_up_all(done->wait);
418 	} else {
419 		/*
420 		 * If thread->done, it means that this callback occurred
421 		 * after the parent thread has cleaned up. This can
422 		 * happen in the case that driver doesn't implement
423 		 * the terminate_all() functionality and a dma operation
424 		 * did not occur within the timeout period
425 		 */
426 		WARN(1, "dmatest: Kernel memory may be corrupted!!\n");
427 	}
428 }
429 
430 static unsigned int min_odd(unsigned int x, unsigned int y)
431 {
432 	unsigned int val = min(x, y);
433 
434 	return val % 2 ? val : val - 1;
435 }
436 
437 static void result(const char *err, unsigned int n, unsigned int src_off,
438 		   unsigned int dst_off, unsigned int len, unsigned long data)
439 {
440 	pr_info("%s: result #%u: '%s' with src_off=0x%x dst_off=0x%x len=0x%x (%lu)\n",
441 		current->comm, n, err, src_off, dst_off, len, data);
442 }
443 
444 static void dbg_result(const char *err, unsigned int n, unsigned int src_off,
445 		       unsigned int dst_off, unsigned int len,
446 		       unsigned long data)
447 {
448 	pr_debug("%s: result #%u: '%s' with src_off=0x%x dst_off=0x%x len=0x%x (%lu)\n",
449 		 current->comm, n, err, src_off, dst_off, len, data);
450 }
451 
452 #define verbose_result(err, n, src_off, dst_off, len, data) ({	\
453 	if (verbose)						\
454 		result(err, n, src_off, dst_off, len, data);	\
455 	else							\
456 		dbg_result(err, n, src_off, dst_off, len, data);\
457 })
458 
459 static unsigned long long dmatest_persec(s64 runtime, unsigned int val)
460 {
461 	unsigned long long per_sec = 1000000;
462 
463 	if (runtime <= 0)
464 		return 0;
465 
466 	/* drop precision until runtime is 32-bits */
467 	while (runtime > UINT_MAX) {
468 		runtime >>= 1;
469 		per_sec <<= 1;
470 	}
471 
472 	per_sec *= val;
473 	per_sec = INT_TO_FIXPT(per_sec);
474 	do_div(per_sec, runtime);
475 
476 	return per_sec;
477 }
478 
479 static unsigned long long dmatest_KBs(s64 runtime, unsigned long long len)
480 {
481 	return FIXPT_TO_INT(dmatest_persec(runtime, len >> 10));
482 }
483 
484 /*
485  * This function repeatedly tests DMA transfers of various lengths and
486  * offsets for a given operation type until it is told to exit by
487  * kthread_stop(). There may be multiple threads running this function
488  * in parallel for a single channel, and there may be multiple channels
489  * being tested in parallel.
490  *
491  * Before each test, the source and destination buffer is initialized
492  * with a known pattern. This pattern is different depending on
493  * whether it's in an area which is supposed to be copied or
494  * overwritten, and different in the source and destination buffers.
495  * So if the DMA engine doesn't copy exactly what we tell it to copy,
496  * we'll notice.
497  */
498 static int dmatest_func(void *data)
499 {
500 	struct dmatest_thread	*thread = data;
501 	struct dmatest_done	*done = &thread->test_done;
502 	struct dmatest_info	*info;
503 	struct dmatest_params	*params;
504 	struct dma_chan		*chan;
505 	struct dma_device	*dev;
506 	unsigned int		error_count;
507 	unsigned int		failed_tests = 0;
508 	unsigned int		total_tests = 0;
509 	dma_cookie_t		cookie;
510 	enum dma_status		status;
511 	enum dma_ctrl_flags 	flags;
512 	u8			*pq_coefs = NULL;
513 	int			ret;
514 	int			src_cnt;
515 	int			dst_cnt;
516 	int			i;
517 	ktime_t			ktime, start, diff;
518 	ktime_t			filltime = 0;
519 	ktime_t			comparetime = 0;
520 	s64			runtime = 0;
521 	unsigned long long	total_len = 0;
522 	unsigned long long	iops = 0;
523 	u8			align = 0;
524 	bool			is_memset = false;
525 	dma_addr_t		*srcs;
526 	dma_addr_t		*dma_pq;
527 
528 	set_freezable();
529 
530 	ret = -ENOMEM;
531 
532 	smp_rmb();
533 	thread->pending = false;
534 	info = thread->info;
535 	params = &info->params;
536 	chan = thread->chan;
537 	dev = chan->device;
538 	if (thread->type == DMA_MEMCPY) {
539 		align = params->alignment < 0 ? dev->copy_align :
540 						params->alignment;
541 		src_cnt = dst_cnt = 1;
542 	} else if (thread->type == DMA_MEMSET) {
543 		align = params->alignment < 0 ? dev->fill_align :
544 						params->alignment;
545 		src_cnt = dst_cnt = 1;
546 		is_memset = true;
547 	} else if (thread->type == DMA_XOR) {
548 		/* force odd to ensure dst = src */
549 		src_cnt = min_odd(params->xor_sources | 1, dev->max_xor);
550 		dst_cnt = 1;
551 		align = params->alignment < 0 ? dev->xor_align :
552 						params->alignment;
553 	} else if (thread->type == DMA_PQ) {
554 		/* force odd to ensure dst = src */
555 		src_cnt = min_odd(params->pq_sources | 1, dma_maxpq(dev, 0));
556 		dst_cnt = 2;
557 		align = params->alignment < 0 ? dev->pq_align :
558 						params->alignment;
559 
560 		pq_coefs = kmalloc(params->pq_sources + 1, GFP_KERNEL);
561 		if (!pq_coefs)
562 			goto err_thread_type;
563 
564 		for (i = 0; i < src_cnt; i++)
565 			pq_coefs[i] = 1;
566 	} else
567 		goto err_thread_type;
568 
569 	/* Check if buffer count fits into map count variable (u8) */
570 	if ((src_cnt + dst_cnt) >= 255) {
571 		pr_err("too many buffers (%d of 255 supported)\n",
572 		       src_cnt + dst_cnt);
573 		goto err_free_coefs;
574 	}
575 
576 	if (1 << align > params->buf_size) {
577 		pr_err("%u-byte buffer too small for %d-byte alignment\n",
578 		       params->buf_size, 1 << align);
579 		goto err_free_coefs;
580 	}
581 
582 	thread->srcs = kcalloc(src_cnt + 1, sizeof(u8 *), GFP_KERNEL);
583 	if (!thread->srcs)
584 		goto err_free_coefs;
585 
586 	thread->usrcs = kcalloc(src_cnt + 1, sizeof(u8 *), GFP_KERNEL);
587 	if (!thread->usrcs)
588 		goto err_usrcs;
589 
590 	for (i = 0; i < src_cnt; i++) {
591 		thread->usrcs[i] = kmalloc(params->buf_size + align,
592 					   GFP_KERNEL);
593 		if (!thread->usrcs[i])
594 			goto err_srcbuf;
595 
596 		/* align srcs to alignment restriction */
597 		if (align)
598 			thread->srcs[i] = PTR_ALIGN(thread->usrcs[i], align);
599 		else
600 			thread->srcs[i] = thread->usrcs[i];
601 	}
602 	thread->srcs[i] = NULL;
603 
604 	thread->dsts = kcalloc(dst_cnt + 1, sizeof(u8 *), GFP_KERNEL);
605 	if (!thread->dsts)
606 		goto err_dsts;
607 
608 	thread->udsts = kcalloc(dst_cnt + 1, sizeof(u8 *), GFP_KERNEL);
609 	if (!thread->udsts)
610 		goto err_udsts;
611 
612 	for (i = 0; i < dst_cnt; i++) {
613 		thread->udsts[i] = kmalloc(params->buf_size + align,
614 					   GFP_KERNEL);
615 		if (!thread->udsts[i])
616 			goto err_dstbuf;
617 
618 		/* align dsts to alignment restriction */
619 		if (align)
620 			thread->dsts[i] = PTR_ALIGN(thread->udsts[i], align);
621 		else
622 			thread->dsts[i] = thread->udsts[i];
623 	}
624 	thread->dsts[i] = NULL;
625 
626 	set_user_nice(current, 10);
627 
628 	srcs = kcalloc(src_cnt, sizeof(dma_addr_t), GFP_KERNEL);
629 	if (!srcs)
630 		goto err_dstbuf;
631 
632 	dma_pq = kcalloc(dst_cnt, sizeof(dma_addr_t), GFP_KERNEL);
633 	if (!dma_pq)
634 		goto err_srcs_array;
635 
636 	/*
637 	 * src and dst buffers are freed by ourselves below
638 	 */
639 	flags = DMA_CTRL_ACK | DMA_PREP_INTERRUPT;
640 
641 	ktime = ktime_get();
642 	while (!kthread_should_stop()
643 	       && !(params->iterations && total_tests >= params->iterations)) {
644 		struct dma_async_tx_descriptor *tx = NULL;
645 		struct dmaengine_unmap_data *um;
646 		dma_addr_t *dsts;
647 		unsigned int src_off, dst_off, len;
648 
649 		total_tests++;
650 
651 		if (params->transfer_size) {
652 			if (params->transfer_size >= params->buf_size) {
653 				pr_err("%u-byte transfer size must be lower than %u-buffer size\n",
654 				       params->transfer_size, params->buf_size);
655 				break;
656 			}
657 			len = params->transfer_size;
658 		} else if (params->norandom) {
659 			len = params->buf_size;
660 		} else {
661 			len = dmatest_random() % params->buf_size + 1;
662 		}
663 
664 		/* Do not alter transfer size explicitly defined by user */
665 		if (!params->transfer_size) {
666 			len = (len >> align) << align;
667 			if (!len)
668 				len = 1 << align;
669 		}
670 		total_len += len;
671 
672 		if (params->norandom) {
673 			src_off = 0;
674 			dst_off = 0;
675 		} else {
676 			src_off = dmatest_random() % (params->buf_size - len + 1);
677 			dst_off = dmatest_random() % (params->buf_size - len + 1);
678 
679 			src_off = (src_off >> align) << align;
680 			dst_off = (dst_off >> align) << align;
681 		}
682 
683 		if (!params->noverify) {
684 			start = ktime_get();
685 			dmatest_init_srcs(thread->srcs, src_off, len,
686 					  params->buf_size, is_memset);
687 			dmatest_init_dsts(thread->dsts, dst_off, len,
688 					  params->buf_size, is_memset);
689 
690 			diff = ktime_sub(ktime_get(), start);
691 			filltime = ktime_add(filltime, diff);
692 		}
693 
694 		um = dmaengine_get_unmap_data(dev->dev, src_cnt + dst_cnt,
695 					      GFP_KERNEL);
696 		if (!um) {
697 			failed_tests++;
698 			result("unmap data NULL", total_tests,
699 			       src_off, dst_off, len, ret);
700 			continue;
701 		}
702 
703 		um->len = params->buf_size;
704 		for (i = 0; i < src_cnt; i++) {
705 			void *buf = thread->srcs[i];
706 			struct page *pg = virt_to_page(buf);
707 			unsigned long pg_off = offset_in_page(buf);
708 
709 			um->addr[i] = dma_map_page(dev->dev, pg, pg_off,
710 						   um->len, DMA_TO_DEVICE);
711 			srcs[i] = um->addr[i] + src_off;
712 			ret = dma_mapping_error(dev->dev, um->addr[i]);
713 			if (ret) {
714 				dmaengine_unmap_put(um);
715 				result("src mapping error", total_tests,
716 				       src_off, dst_off, len, ret);
717 				failed_tests++;
718 				continue;
719 			}
720 			um->to_cnt++;
721 		}
722 		/* map with DMA_BIDIRECTIONAL to force writeback/invalidate */
723 		dsts = &um->addr[src_cnt];
724 		for (i = 0; i < dst_cnt; i++) {
725 			void *buf = thread->dsts[i];
726 			struct page *pg = virt_to_page(buf);
727 			unsigned long pg_off = offset_in_page(buf);
728 
729 			dsts[i] = dma_map_page(dev->dev, pg, pg_off, um->len,
730 					       DMA_BIDIRECTIONAL);
731 			ret = dma_mapping_error(dev->dev, dsts[i]);
732 			if (ret) {
733 				dmaengine_unmap_put(um);
734 				result("dst mapping error", total_tests,
735 				       src_off, dst_off, len, ret);
736 				failed_tests++;
737 				continue;
738 			}
739 			um->bidi_cnt++;
740 		}
741 
742 		if (thread->type == DMA_MEMCPY)
743 			tx = dev->device_prep_dma_memcpy(chan,
744 							 dsts[0] + dst_off,
745 							 srcs[0], len, flags);
746 		else if (thread->type == DMA_MEMSET)
747 			tx = dev->device_prep_dma_memset(chan,
748 						dsts[0] + dst_off,
749 						*(thread->srcs[0] + src_off),
750 						len, flags);
751 		else if (thread->type == DMA_XOR)
752 			tx = dev->device_prep_dma_xor(chan,
753 						      dsts[0] + dst_off,
754 						      srcs, src_cnt,
755 						      len, flags);
756 		else if (thread->type == DMA_PQ) {
757 			for (i = 0; i < dst_cnt; i++)
758 				dma_pq[i] = dsts[i] + dst_off;
759 			tx = dev->device_prep_dma_pq(chan, dma_pq, srcs,
760 						     src_cnt, pq_coefs,
761 						     len, flags);
762 		}
763 
764 		if (!tx) {
765 			dmaengine_unmap_put(um);
766 			result("prep error", total_tests, src_off,
767 			       dst_off, len, ret);
768 			msleep(100);
769 			failed_tests++;
770 			continue;
771 		}
772 
773 		done->done = false;
774 		tx->callback = dmatest_callback;
775 		tx->callback_param = done;
776 		cookie = tx->tx_submit(tx);
777 
778 		if (dma_submit_error(cookie)) {
779 			dmaengine_unmap_put(um);
780 			result("submit error", total_tests, src_off,
781 			       dst_off, len, ret);
782 			msleep(100);
783 			failed_tests++;
784 			continue;
785 		}
786 		dma_async_issue_pending(chan);
787 
788 		wait_event_freezable_timeout(thread->done_wait, done->done,
789 					     msecs_to_jiffies(params->timeout));
790 
791 		status = dma_async_is_tx_complete(chan, cookie, NULL, NULL);
792 
793 		dmaengine_unmap_put(um);
794 
795 		if (!done->done) {
796 			result("test timed out", total_tests, src_off, dst_off,
797 			       len, 0);
798 			failed_tests++;
799 			continue;
800 		} else if (status != DMA_COMPLETE) {
801 			result(status == DMA_ERROR ?
802 			       "completion error status" :
803 			       "completion busy status", total_tests, src_off,
804 			       dst_off, len, ret);
805 			failed_tests++;
806 			continue;
807 		}
808 
809 		if (params->noverify) {
810 			verbose_result("test passed", total_tests, src_off,
811 				       dst_off, len, 0);
812 			continue;
813 		}
814 
815 		start = ktime_get();
816 		pr_debug("%s: verifying source buffer...\n", current->comm);
817 		error_count = dmatest_verify(thread->srcs, 0, src_off,
818 				0, PATTERN_SRC, true, is_memset);
819 		error_count += dmatest_verify(thread->srcs, src_off,
820 				src_off + len, src_off,
821 				PATTERN_SRC | PATTERN_COPY, true, is_memset);
822 		error_count += dmatest_verify(thread->srcs, src_off + len,
823 				params->buf_size, src_off + len,
824 				PATTERN_SRC, true, is_memset);
825 
826 		pr_debug("%s: verifying dest buffer...\n", current->comm);
827 		error_count += dmatest_verify(thread->dsts, 0, dst_off,
828 				0, PATTERN_DST, false, is_memset);
829 
830 		error_count += dmatest_verify(thread->dsts, dst_off,
831 				dst_off + len, src_off,
832 				PATTERN_SRC | PATTERN_COPY, false, is_memset);
833 
834 		error_count += dmatest_verify(thread->dsts, dst_off + len,
835 				params->buf_size, dst_off + len,
836 				PATTERN_DST, false, is_memset);
837 
838 		diff = ktime_sub(ktime_get(), start);
839 		comparetime = ktime_add(comparetime, diff);
840 
841 		if (error_count) {
842 			result("data error", total_tests, src_off, dst_off,
843 			       len, error_count);
844 			failed_tests++;
845 		} else {
846 			verbose_result("test passed", total_tests, src_off,
847 				       dst_off, len, 0);
848 		}
849 	}
850 	ktime = ktime_sub(ktime_get(), ktime);
851 	ktime = ktime_sub(ktime, comparetime);
852 	ktime = ktime_sub(ktime, filltime);
853 	runtime = ktime_to_us(ktime);
854 
855 	ret = 0;
856 	kfree(dma_pq);
857 err_srcs_array:
858 	kfree(srcs);
859 err_dstbuf:
860 	for (i = 0; thread->udsts[i]; i++)
861 		kfree(thread->udsts[i]);
862 	kfree(thread->udsts);
863 err_udsts:
864 	kfree(thread->dsts);
865 err_dsts:
866 err_srcbuf:
867 	for (i = 0; thread->usrcs[i]; i++)
868 		kfree(thread->usrcs[i]);
869 	kfree(thread->usrcs);
870 err_usrcs:
871 	kfree(thread->srcs);
872 err_free_coefs:
873 	kfree(pq_coefs);
874 err_thread_type:
875 	iops = dmatest_persec(runtime, total_tests);
876 	pr_info("%s: summary %u tests, %u failures %llu.%02llu iops %llu KB/s (%d)\n",
877 		current->comm, total_tests, failed_tests,
878 		FIXPT_TO_INT(iops), FIXPT_GET_FRAC(iops),
879 		dmatest_KBs(runtime, total_len), ret);
880 
881 	/* terminate all transfers on specified channels */
882 	if (ret || failed_tests)
883 		dmaengine_terminate_sync(chan);
884 
885 	thread->done = true;
886 	wake_up(&thread_wait);
887 
888 	return ret;
889 }
890 
891 static void dmatest_cleanup_channel(struct dmatest_chan *dtc)
892 {
893 	struct dmatest_thread	*thread;
894 	struct dmatest_thread	*_thread;
895 	int			ret;
896 
897 	list_for_each_entry_safe(thread, _thread, &dtc->threads, node) {
898 		ret = kthread_stop(thread->task);
899 		pr_debug("thread %s exited with status %d\n",
900 			 thread->task->comm, ret);
901 		list_del(&thread->node);
902 		put_task_struct(thread->task);
903 		kfree(thread);
904 	}
905 
906 	/* terminate all transfers on specified channels */
907 	dmaengine_terminate_sync(dtc->chan);
908 
909 	kfree(dtc);
910 }
911 
912 static int dmatest_add_threads(struct dmatest_info *info,
913 		struct dmatest_chan *dtc, enum dma_transaction_type type)
914 {
915 	struct dmatest_params *params = &info->params;
916 	struct dmatest_thread *thread;
917 	struct dma_chan *chan = dtc->chan;
918 	char *op;
919 	unsigned int i;
920 
921 	if (type == DMA_MEMCPY)
922 		op = "copy";
923 	else if (type == DMA_MEMSET)
924 		op = "set";
925 	else if (type == DMA_XOR)
926 		op = "xor";
927 	else if (type == DMA_PQ)
928 		op = "pq";
929 	else
930 		return -EINVAL;
931 
932 	for (i = 0; i < params->threads_per_chan; i++) {
933 		thread = kzalloc(sizeof(struct dmatest_thread), GFP_KERNEL);
934 		if (!thread) {
935 			pr_warn("No memory for %s-%s%u\n",
936 				dma_chan_name(chan), op, i);
937 			break;
938 		}
939 		thread->info = info;
940 		thread->chan = dtc->chan;
941 		thread->type = type;
942 		thread->test_done.wait = &thread->done_wait;
943 		init_waitqueue_head(&thread->done_wait);
944 		smp_wmb();
945 		thread->task = kthread_create(dmatest_func, thread, "%s-%s%u",
946 				dma_chan_name(chan), op, i);
947 		if (IS_ERR(thread->task)) {
948 			pr_warn("Failed to create thread %s-%s%u\n",
949 				dma_chan_name(chan), op, i);
950 			kfree(thread);
951 			break;
952 		}
953 
954 		/* srcbuf and dstbuf are allocated by the thread itself */
955 		get_task_struct(thread->task);
956 		list_add_tail(&thread->node, &dtc->threads);
957 		thread->pending = true;
958 	}
959 
960 	return i;
961 }
962 
963 static int dmatest_add_channel(struct dmatest_info *info,
964 		struct dma_chan *chan)
965 {
966 	struct dmatest_chan	*dtc;
967 	struct dma_device	*dma_dev = chan->device;
968 	unsigned int		thread_count = 0;
969 	int cnt;
970 
971 	dtc = kmalloc(sizeof(struct dmatest_chan), GFP_KERNEL);
972 	if (!dtc) {
973 		pr_warn("No memory for %s\n", dma_chan_name(chan));
974 		return -ENOMEM;
975 	}
976 
977 	dtc->chan = chan;
978 	INIT_LIST_HEAD(&dtc->threads);
979 
980 	if (dma_has_cap(DMA_MEMCPY, dma_dev->cap_mask)) {
981 		if (dmatest == 0) {
982 			cnt = dmatest_add_threads(info, dtc, DMA_MEMCPY);
983 			thread_count += cnt > 0 ? cnt : 0;
984 		}
985 	}
986 
987 	if (dma_has_cap(DMA_MEMSET, dma_dev->cap_mask)) {
988 		if (dmatest == 1) {
989 			cnt = dmatest_add_threads(info, dtc, DMA_MEMSET);
990 			thread_count += cnt > 0 ? cnt : 0;
991 		}
992 	}
993 
994 	if (dma_has_cap(DMA_XOR, dma_dev->cap_mask)) {
995 		cnt = dmatest_add_threads(info, dtc, DMA_XOR);
996 		thread_count += cnt > 0 ? cnt : 0;
997 	}
998 	if (dma_has_cap(DMA_PQ, dma_dev->cap_mask)) {
999 		cnt = dmatest_add_threads(info, dtc, DMA_PQ);
1000 		thread_count += cnt > 0 ? cnt : 0;
1001 	}
1002 
1003 	pr_info("Added %u threads using %s\n",
1004 		thread_count, dma_chan_name(chan));
1005 
1006 	list_add_tail(&dtc->node, &info->channels);
1007 	info->nr_channels++;
1008 
1009 	return 0;
1010 }
1011 
1012 static bool filter(struct dma_chan *chan, void *param)
1013 {
1014 	struct dmatest_params *params = param;
1015 
1016 	if (!dmatest_match_channel(params, chan) ||
1017 	    !dmatest_match_device(params, chan->device))
1018 		return false;
1019 	else
1020 		return true;
1021 }
1022 
1023 static void request_channels(struct dmatest_info *info,
1024 			     enum dma_transaction_type type)
1025 {
1026 	dma_cap_mask_t mask;
1027 
1028 	dma_cap_zero(mask);
1029 	dma_cap_set(type, mask);
1030 	for (;;) {
1031 		struct dmatest_params *params = &info->params;
1032 		struct dma_chan *chan;
1033 
1034 		chan = dma_request_channel(mask, filter, params);
1035 		if (chan) {
1036 			if (dmatest_add_channel(info, chan)) {
1037 				dma_release_channel(chan);
1038 				break; /* add_channel failed, punt */
1039 			}
1040 		} else
1041 			break; /* no more channels available */
1042 		if (params->max_channels &&
1043 		    info->nr_channels >= params->max_channels)
1044 			break; /* we have all we need */
1045 	}
1046 }
1047 
1048 static void add_threaded_test(struct dmatest_info *info)
1049 {
1050 	struct dmatest_params *params = &info->params;
1051 
1052 	/* Copy test parameters */
1053 	params->buf_size = test_buf_size;
1054 	strlcpy(params->channel, strim(test_channel), sizeof(params->channel));
1055 	strlcpy(params->device, strim(test_device), sizeof(params->device));
1056 	params->threads_per_chan = threads_per_chan;
1057 	params->max_channels = max_channels;
1058 	params->iterations = iterations;
1059 	params->xor_sources = xor_sources;
1060 	params->pq_sources = pq_sources;
1061 	params->timeout = timeout;
1062 	params->noverify = noverify;
1063 	params->norandom = norandom;
1064 	params->alignment = alignment;
1065 	params->transfer_size = transfer_size;
1066 
1067 	request_channels(info, DMA_MEMCPY);
1068 	request_channels(info, DMA_MEMSET);
1069 	request_channels(info, DMA_XOR);
1070 	request_channels(info, DMA_PQ);
1071 }
1072 
1073 static void run_pending_tests(struct dmatest_info *info)
1074 {
1075 	struct dmatest_chan *dtc;
1076 	unsigned int thread_count = 0;
1077 
1078 	list_for_each_entry(dtc, &info->channels, node) {
1079 		struct dmatest_thread *thread;
1080 
1081 		thread_count = 0;
1082 		list_for_each_entry(thread, &dtc->threads, node) {
1083 			wake_up_process(thread->task);
1084 			thread_count++;
1085 		}
1086 		pr_info("Started %u threads using %s\n",
1087 			thread_count, dma_chan_name(dtc->chan));
1088 	}
1089 }
1090 
1091 static void stop_threaded_test(struct dmatest_info *info)
1092 {
1093 	struct dmatest_chan *dtc, *_dtc;
1094 	struct dma_chan *chan;
1095 
1096 	list_for_each_entry_safe(dtc, _dtc, &info->channels, node) {
1097 		list_del(&dtc->node);
1098 		chan = dtc->chan;
1099 		dmatest_cleanup_channel(dtc);
1100 		pr_debug("dropped channel %s\n", dma_chan_name(chan));
1101 		dma_release_channel(chan);
1102 	}
1103 
1104 	info->nr_channels = 0;
1105 }
1106 
1107 static void start_threaded_tests(struct dmatest_info *info)
1108 {
1109 	/* we might be called early to set run=, defer running until all
1110 	 * parameters have been evaluated
1111 	 */
1112 	if (!info->did_init)
1113 		return;
1114 
1115 	run_pending_tests(info);
1116 }
1117 
1118 static int dmatest_run_get(char *val, const struct kernel_param *kp)
1119 {
1120 	struct dmatest_info *info = &test_info;
1121 
1122 	mutex_lock(&info->lock);
1123 	if (is_threaded_test_run(info)) {
1124 		dmatest_run = true;
1125 	} else {
1126 		if (!is_threaded_test_pending(info))
1127 			stop_threaded_test(info);
1128 		dmatest_run = false;
1129 	}
1130 	mutex_unlock(&info->lock);
1131 
1132 	return param_get_bool(val, kp);
1133 }
1134 
1135 static int dmatest_run_set(const char *val, const struct kernel_param *kp)
1136 {
1137 	struct dmatest_info *info = &test_info;
1138 	int ret;
1139 
1140 	mutex_lock(&info->lock);
1141 	ret = param_set_bool(val, kp);
1142 	if (ret) {
1143 		mutex_unlock(&info->lock);
1144 		return ret;
1145 	} else if (dmatest_run) {
1146 		if (is_threaded_test_pending(info))
1147 			start_threaded_tests(info);
1148 		else
1149 			pr_info("Could not start test, no channels configured\n");
1150 	} else {
1151 		stop_threaded_test(info);
1152 	}
1153 
1154 	mutex_unlock(&info->lock);
1155 
1156 	return ret;
1157 }
1158 
1159 static int dmatest_chan_set(const char *val, const struct kernel_param *kp)
1160 {
1161 	struct dmatest_info *info = &test_info;
1162 	struct dmatest_chan *dtc;
1163 	char chan_reset_val[20];
1164 	int ret = 0;
1165 
1166 	mutex_lock(&info->lock);
1167 	ret = param_set_copystring(val, kp);
1168 	if (ret) {
1169 		mutex_unlock(&info->lock);
1170 		return ret;
1171 	}
1172 	/*Clear any previously run threads */
1173 	if (!is_threaded_test_run(info) && !is_threaded_test_pending(info))
1174 		stop_threaded_test(info);
1175 	/* Reject channels that are already registered */
1176 	if (is_threaded_test_pending(info)) {
1177 		list_for_each_entry(dtc, &info->channels, node) {
1178 			if (strcmp(dma_chan_name(dtc->chan),
1179 				   strim(test_channel)) == 0) {
1180 				dtc = list_last_entry(&info->channels,
1181 						      struct dmatest_chan,
1182 						      node);
1183 				strlcpy(chan_reset_val,
1184 					dma_chan_name(dtc->chan),
1185 					sizeof(chan_reset_val));
1186 				ret = -EBUSY;
1187 				goto add_chan_err;
1188 			}
1189 		}
1190 	}
1191 
1192 	add_threaded_test(info);
1193 
1194 	/* Check if channel was added successfully */
1195 	dtc = list_last_entry(&info->channels, struct dmatest_chan, node);
1196 
1197 	if (dtc->chan) {
1198 		/*
1199 		 * if new channel was not successfully added, revert the
1200 		 * "test_channel" string to the name of the last successfully
1201 		 * added channel. exception for when users issues empty string
1202 		 * to channel parameter.
1203 		 */
1204 		if ((strcmp(dma_chan_name(dtc->chan), strim(test_channel)) != 0)
1205 		    && (strcmp("", strim(test_channel)) != 0)) {
1206 			ret = -EINVAL;
1207 			strlcpy(chan_reset_val, dma_chan_name(dtc->chan),
1208 				sizeof(chan_reset_val));
1209 			goto add_chan_err;
1210 		}
1211 
1212 	} else {
1213 		/* Clear test_channel if no channels were added successfully */
1214 		strlcpy(chan_reset_val, "", sizeof(chan_reset_val));
1215 		ret = -EBUSY;
1216 		goto add_chan_err;
1217 	}
1218 
1219 	mutex_unlock(&info->lock);
1220 
1221 	return ret;
1222 
1223 add_chan_err:
1224 	param_set_copystring(chan_reset_val, kp);
1225 	mutex_unlock(&info->lock);
1226 
1227 	return ret;
1228 }
1229 
1230 static int dmatest_chan_get(char *val, const struct kernel_param *kp)
1231 {
1232 	struct dmatest_info *info = &test_info;
1233 
1234 	mutex_lock(&info->lock);
1235 	if (!is_threaded_test_run(info) && !is_threaded_test_pending(info)) {
1236 		stop_threaded_test(info);
1237 		strlcpy(test_channel, "", sizeof(test_channel));
1238 	}
1239 	mutex_unlock(&info->lock);
1240 
1241 	return param_get_string(val, kp);
1242 }
1243 
1244 static int dmatest_test_list_get(char *val, const struct kernel_param *kp)
1245 {
1246 	struct dmatest_info *info = &test_info;
1247 	struct dmatest_chan *dtc;
1248 	unsigned int thread_count = 0;
1249 
1250 	list_for_each_entry(dtc, &info->channels, node) {
1251 		struct dmatest_thread *thread;
1252 
1253 		thread_count = 0;
1254 		list_for_each_entry(thread, &dtc->threads, node) {
1255 			thread_count++;
1256 		}
1257 		pr_info("%u threads using %s\n",
1258 			thread_count, dma_chan_name(dtc->chan));
1259 	}
1260 
1261 	return 0;
1262 }
1263 
1264 static int __init dmatest_init(void)
1265 {
1266 	struct dmatest_info *info = &test_info;
1267 	struct dmatest_params *params = &info->params;
1268 
1269 	if (dmatest_run) {
1270 		mutex_lock(&info->lock);
1271 		add_threaded_test(info);
1272 		run_pending_tests(info);
1273 		mutex_unlock(&info->lock);
1274 	}
1275 
1276 	if (params->iterations && wait)
1277 		wait_event(thread_wait, !is_threaded_test_run(info));
1278 
1279 	/* module parameters are stable, inittime tests are started,
1280 	 * let userspace take over 'run' control
1281 	 */
1282 	info->did_init = true;
1283 
1284 	return 0;
1285 }
1286 /* when compiled-in wait for drivers to load first */
1287 late_initcall(dmatest_init);
1288 
1289 static void __exit dmatest_exit(void)
1290 {
1291 	struct dmatest_info *info = &test_info;
1292 
1293 	mutex_lock(&info->lock);
1294 	stop_threaded_test(info);
1295 	mutex_unlock(&info->lock);
1296 }
1297 module_exit(dmatest_exit);
1298 
1299 MODULE_AUTHOR("Haavard Skinnemoen (Atmel)");
1300 MODULE_LICENSE("GPL v2");
1301