xref: /freebsd/sys/dev/ioat/ioat_test.h (revision 277fbb92d5e4cd0938c67f77b08d9ba4ac9d54a6)
1 /*-
2  * Copyright (C) 2012 Intel Corporation
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 __FBSDID("$FreeBSD$");
28 
29 #ifndef __IOAT_TEST_H__
30 #define __IOAT_TEST_H__
31 
32 enum ioat_res {
33 	IOAT_TEST_OK = 0,
34 	IOAT_TEST_NO_DMA_ENGINE,
35 	IOAT_TEST_NO_MEMORY,
36 	IOAT_TEST_MISCOMPARE,
37 	IOAT_TEST_INVALID_INPUT,
38 	IOAT_NUM_RES
39 };
40 
41 enum ioat_test_kind {
42 	IOAT_TEST_FILL = 0,
43 	IOAT_TEST_DMA,
44 	IOAT_TEST_RAW_DMA,
45 	IOAT_NUM_TESTKINDS
46 };
47 
48 struct test_transaction;
49 
50 struct ioat_test {
51 	volatile uint32_t status[IOAT_NUM_RES];
52 	uint32_t channel_index;
53 
54 	enum ioat_test_kind testkind;
55 
56 	/* HW max of 1MB */
57 	uint32_t buffer_size;
58 	uint32_t chain_depth;
59 	uint32_t transactions;
60 
61 	/*
62 	 * If non-zero, duration is time in ms;
63 	 * If zero, bounded by 'transactions' above.
64 	 */
65 	uint32_t duration;
66 
67 	/* If true, check for miscompares after a copy. */
68 	bool verify;
69 
70 	/* DMA directly to/from some memory address */
71 	uint64_t raw_target;
72 	void *raw_vtarget;
73 	bool raw_write;
74 	bool raw_is_virtual;
75 
76 	/* Internal usage -- not test inputs */
77 	TAILQ_HEAD(, test_transaction) free_q;
78 	TAILQ_HEAD(, test_transaction) pend_q;
79 	volatile bool too_late;
80 };
81 
82 #define	IOAT_DMATEST	_IOWR('i', 0, struct ioat_test)
83 
84 #endif /* __IOAT_TEST_H__ */
85