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