1 /*
2 * Copyright © 2016 Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 */
23
24 #ifndef __I915_SELFTEST_H__
25 #define __I915_SELFTEST_H__
26
27 #include <linux/types.h>
28
29 #define STACK_MAGIC 0xdeadbeef
30
31 struct pci_dev;
32 struct drm_i915_private;
33
34 struct i915_selftest {
35 unsigned long timeout_jiffies;
36 unsigned int timeout_ms;
37 unsigned int random_seed;
38 char *filter;
39 int mock;
40 int live;
41 int perf;
42 };
43
44 #if IS_ENABLED(CONFIG_DRM_I915_SELFTEST)
45 #include <linux/fault-inject.h>
46
47 extern struct i915_selftest i915_selftest;
48
49 int i915_mock_selftests(void);
50 int i915_live_selftests(struct pci_dev *pdev);
51 int i915_perf_selftests(struct pci_dev *pdev);
52
53 /* We extract the function declarations from i915_mock_selftests.h and
54 * i915_live_selftests.h Add your unit test declarations there!
55 *
56 * Mock unit tests are run very early upon module load, before the driver
57 * is probed. All hardware interactions, as well as other subsystems, must
58 * be "mocked".
59 *
60 * Live unit tests are run after the driver is loaded - all hardware
61 * interactions are real.
62 */
63 #define selftest(name, func) int func(void);
64 #include "selftests/i915_mock_selftests.h"
65 #undef selftest
66 #define selftest(name, func) int func(struct drm_i915_private *i915);
67 #include "selftests/i915_live_selftests.h"
68 #include "selftests/i915_perf_selftests.h"
69 #undef selftest
70
71 struct i915_subtest {
72 int (*func)(void *data);
73 const char *name;
74 };
75
76 int __i915_nop_setup(void *data);
77 int __i915_nop_teardown(int err, void *data);
78
79 int __i915_live_setup(void *data);
80 int __i915_live_teardown(int err, void *data);
81
82 int __intel_gt_live_setup(void *data);
83 int __intel_gt_live_teardown(int err, void *data);
84
85 int __i915_subtests(const char *caller,
86 int (*setup)(void *data),
87 int (*teardown)(int err, void *data),
88 const struct i915_subtest *st,
89 unsigned int count,
90 void *data);
91 #define i915_subtests(T, data) \
92 __i915_subtests(__func__, \
93 __i915_nop_setup, __i915_nop_teardown, \
94 T, ARRAY_SIZE(T), data)
95 #define i915_live_subtests(T, data) ({ \
96 typecheck(struct drm_i915_private *, data); \
97 (data)->gt[0]->uc.guc.submission_state.sched_disable_delay_ms = 0; \
98 __i915_subtests(__func__, \
99 __i915_live_setup, __i915_live_teardown, \
100 T, ARRAY_SIZE(T), data); \
101 })
102 #define intel_gt_live_subtests(T, data) ({ \
103 typecheck(struct intel_gt *, data); \
104 (data)->uc.guc.submission_state.sched_disable_delay_ms = 0; \
105 __i915_subtests(__func__, \
106 __intel_gt_live_setup, __intel_gt_live_teardown, \
107 T, ARRAY_SIZE(T), data); \
108 })
109
110 #define SUBTEST(x) { x, #x }
111
112 #define I915_SELFTEST_DECLARE(x) x
113 #define I915_SELFTEST_ONLY(x) unlikely(x)
114 #define I915_SELFTEST_EXPORT
115
116 #else /* !IS_ENABLED(CONFIG_DRM_I915_SELFTEST) */
117
i915_mock_selftests(void)118 static inline int i915_mock_selftests(void) { return 0; }
i915_live_selftests(struct pci_dev * pdev)119 static inline int i915_live_selftests(struct pci_dev *pdev) { return 0; }
i915_perf_selftests(struct pci_dev * pdev)120 static inline int i915_perf_selftests(struct pci_dev *pdev) { return 0; }
121
122 #define I915_SELFTEST_DECLARE(x)
123 #define I915_SELFTEST_ONLY(x) 0
124 #define I915_SELFTEST_EXPORT static
125
126 #endif
127
128 /* Using the i915_selftest_ prefix becomes a little unwieldy with the helpers.
129 * Instead we use the igt_ shorthand, in reference to the intel-gpu-tools
130 * suite of uabi test cases (which includes a test runner for our selftests).
131 */
132
133 #define IGT_TIMEOUT(name__) \
134 unsigned long name__ = jiffies + i915_selftest.timeout_jiffies
135
136 __printf(2, 3)
137 bool __igt_timeout(unsigned long timeout, const char *fmt, ...);
138
139 #define igt_timeout(t, fmt, ...) \
140 __igt_timeout((t), KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
141
142 void igt_hexdump(const void *buf, size_t len);
143
144 #endif /* !__I915_SELFTEST_H__ */
145