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 struct pci_dev; 28 struct drm_i915_private; 29 30 struct i915_selftest { 31 unsigned long timeout_jiffies; 32 unsigned int timeout_ms; 33 unsigned int random_seed; 34 char *filter; 35 int mock; 36 int live; 37 }; 38 39 #if IS_ENABLED(CONFIG_DRM_I915_SELFTEST) 40 #include <linux/fault-inject.h> 41 42 extern struct i915_selftest i915_selftest; 43 44 int i915_mock_selftests(void); 45 int i915_live_selftests(struct pci_dev *pdev); 46 47 /* We extract the function declarations from i915_mock_selftests.h and 48 * i915_live_selftests.h Add your unit test declarations there! 49 * 50 * Mock unit tests are run very early upon module load, before the driver 51 * is probed. All hardware interactions, as well as other subsystems, must 52 * be "mocked". 53 * 54 * Live unit tests are run after the driver is loaded - all hardware 55 * interactions are real. 56 */ 57 #define selftest(name, func) int func(void); 58 #include "selftests/i915_mock_selftests.h" 59 #undef selftest 60 #define selftest(name, func) int func(struct drm_i915_private *i915); 61 #include "selftests/i915_live_selftests.h" 62 #undef selftest 63 64 struct i915_subtest { 65 int (*func)(void *data); 66 const char *name; 67 }; 68 69 int __i915_nop_setup(void *data); 70 int __i915_nop_teardown(int err, void *data); 71 72 int __i915_live_setup(void *data); 73 int __i915_live_teardown(int err, void *data); 74 75 int __intel_gt_live_setup(void *data); 76 int __intel_gt_live_teardown(int err, void *data); 77 78 int __i915_subtests(const char *caller, 79 int (*setup)(void *data), 80 int (*teardown)(int err, void *data), 81 const struct i915_subtest *st, 82 unsigned int count, 83 void *data); 84 #define i915_subtests(T, data) \ 85 __i915_subtests(__func__, \ 86 __i915_nop_setup, __i915_nop_teardown, \ 87 T, ARRAY_SIZE(T), data) 88 #define i915_live_subtests(T, data) ({ \ 89 typecheck(struct drm_i915_private *, data); \ 90 __i915_subtests(__func__, \ 91 __i915_live_setup, __i915_live_teardown, \ 92 T, ARRAY_SIZE(T), data); \ 93 }) 94 #define intel_gt_live_subtests(T, data) ({ \ 95 typecheck(struct intel_gt *, data); \ 96 __i915_subtests(__func__, \ 97 __intel_gt_live_setup, __intel_gt_live_teardown, \ 98 T, ARRAY_SIZE(T), data); \ 99 }) 100 101 #define SUBTEST(x) { x, #x } 102 103 #define I915_SELFTEST_DECLARE(x) x 104 #define I915_SELFTEST_ONLY(x) unlikely(x) 105 106 #else /* !IS_ENABLED(CONFIG_DRM_I915_SELFTEST) */ 107 108 static inline int i915_mock_selftests(void) { return 0; } 109 static inline int i915_live_selftests(struct pci_dev *pdev) { return 0; } 110 111 #define I915_SELFTEST_DECLARE(x) 112 #define I915_SELFTEST_ONLY(x) 0 113 114 #endif 115 116 /* Using the i915_selftest_ prefix becomes a little unwieldy with the helpers. 117 * Instead we use the igt_ shorthand, in reference to the intel-gpu-tools 118 * suite of uabi test cases (which includes a test runner for our selftests). 119 */ 120 121 #define IGT_TIMEOUT(name__) \ 122 unsigned long name__ = jiffies + i915_selftest.timeout_jiffies 123 124 __printf(2, 3) 125 bool __igt_timeout(unsigned long timeout, const char *fmt, ...); 126 127 #define igt_timeout(t, fmt, ...) \ 128 __igt_timeout((t), KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__) 129 130 #endif /* !__I915_SELFTEST_H__ */ 131