[linux-2.6-block.git] / drivers / gpu / drm / i915 / i915_selftest.h

/*
 * Copyright © 2016 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef __I915_SELFTEST_H__
#define __I915_SELFTEST_H__

struct pci_dev;
struct drm_i915_private;

struct i915_selftest {
	unsigned long timeout_jiffies;
	unsigned int timeout_ms;
	unsigned int random_seed;
	char *filter;
	int mock;
	int live;
};

#if IS_ENABLED(CONFIG_DRM_I915_SELFTEST)
#include <linux/fault-inject.h>

extern struct i915_selftest i915_selftest;

int i915_mock_selftests(void);
int i915_live_selftests(struct pci_dev *pdev);

/* We extract the function declarations from i915_mock_selftests.h and
 * i915_live_selftests.h Add your unit test declarations there!
 *
 * Mock unit tests are run very early upon module load, before the driver
 * is probed. All hardware interactions, as well as other subsystems, must
 * be "mocked".
 *
 * Live unit tests are run after the driver is loaded - all hardware
 * interactions are real.
 */
#define selftest(name, func) int func(void);
#include "selftests/i915_mock_selftests.h"
#undef selftest
#define selftest(name, func) int func(struct drm_i915_private *i915);
#include "selftests/i915_live_selftests.h"
#undef selftest

struct i915_subtest {
	int (*func)(void *data);
	const char *name;
};

int __i915_subtests(const char *caller,
		    const struct i915_subtest *st,
		    unsigned int count,
		    void *data);
#define i915_subtests(T, data) \
	__i915_subtests(__func__, T, ARRAY_SIZE(T), data)

#define SUBTEST(x) { x, #x }

#define I915_SELFTEST_DECLARE(x) x
#define I915_SELFTEST_ONLY(x) unlikely(x)

#else /* !IS_ENABLED(CONFIG_DRM_I915_SELFTEST) */

static inline int i915_mock_selftests(void) { return 0; }
static inline int i915_live_selftests(struct pci_dev *pdev) { return 0; }

#define I915_SELFTEST_DECLARE(x)
#define I915_SELFTEST_ONLY(x) 0

#endif

/* Using the i915_selftest_ prefix becomes a little unwieldy with the helpers.
 * Instead we use the igt_ shorthand, in reference to the intel-gpu-tools
 * suite of uabi test cases (which includes a test runner for our selftests).
 */

#define IGT_TIMEOUT(name__) \
	unsigned long name__ = jiffies + i915_selftest.timeout_jiffies

__printf(2, 3)
bool __igt_timeout(unsigned long timeout, const char *fmt, ...);

#define igt_timeout(t, fmt, ...) \
	__igt_timeout((t), KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)

#endif /* !__I915_SELFTEST_H__ */
Commit	Line	Data
953c7f82 CW	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;
06039d98	34	char *filter;
953c7f82 CW	35	int mock;
	36	int live;
	37	};
	38
	39	#if IS_ENABLED(CONFIG_DRM_I915_SELFTEST)
aae4a3d8 CW	40	#include <linux/fault-inject.h>
aae4a3d8 CW	41
953c7f82 CW	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_subtests(const char *caller,
	70	const struct i915_subtest *st,
	71	unsigned int count,
	72	void *data);
	73	#define i915_subtests(T, data) \
	74	__i915_subtests(__func__, T, ARRAY_SIZE(T), data)
	75
	76	#define SUBTEST(x) { x, #x }
	77
	78	#define I915_SELFTEST_DECLARE(x) x
	79	#define I915_SELFTEST_ONLY(x) unlikely(x)
	80
	81	#else /* !IS_ENABLED(CONFIG_DRM_I915_SELFTEST) */
	82
	83	static inline int i915_mock_selftests(void) { return 0; }
	84	static inline int i915_live_selftests(struct pci_dev *pdev) { return 0; }
	85
	86	#define I915_SELFTEST_DECLARE(x)
	87	#define I915_SELFTEST_ONLY(x) 0
	88
	89	#endif
	90
	91	/* Using the i915_selftest_ prefix becomes a little unwieldy with the helpers.
	92	* Instead we use the igt_ shorthand, in reference to the intel-gpu-tools
	93	* suite of uabi test cases (which includes a test runner for our selftests).
	94	*/
	95
	96	#define IGT_TIMEOUT(name__) \
	97	unsigned long name__ = jiffies + i915_selftest.timeout_jiffies
	98
	99	__printf(2, 3)
	100	bool __igt_timeout(unsigned long timeout, const char *fmt, ...);
	101
	102	#define igt_timeout(t, fmt, ...) \
55e4b859	103	__igt_timeout((t), KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
953c7f82 CW	104
953c7f82 CW	105	#endif /* !__I915_SELFTEST_H__ */