xref: /openbmc/linux/drivers/gpu/drm/i915/i915_gem.h (revision 7ae5c03a)
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 
25 #ifndef __I915_GEM_H__
26 #define __I915_GEM_H__
27 
28 #include <linux/bug.h>
29 
30 #include <drm/drm_drv.h>
31 
32 #include "i915_utils.h"
33 
34 struct drm_i915_private;
35 
36 #ifdef CONFIG_DRM_I915_DEBUG_GEM
37 
38 #define GEM_SHOW_DEBUG() drm_debug_enabled(DRM_UT_DRIVER)
39 
40 #ifdef CONFIG_DRM_I915_DEBUG_GEM_ONCE
41 #define __GEM_BUG(cond) BUG()
42 #else
43 #define __GEM_BUG(cond) \
44 	WARN(1, "%s:%d GEM_BUG_ON(%s)\n", __func__, __LINE__, __stringify(cond))
45 #endif
46 
47 #define GEM_BUG_ON(condition) do { if (unlikely((condition))) {	\
48 		GEM_TRACE_ERR("%s:%d GEM_BUG_ON(%s)\n", \
49 			      __func__, __LINE__, __stringify(condition)); \
50 		GEM_TRACE_DUMP(); \
51 		__GEM_BUG(condition); \
52 		} \
53 	} while(0)
54 #define GEM_WARN_ON(expr) WARN_ON(expr)
55 
56 #define GEM_DEBUG_WARN_ON(expr) GEM_WARN_ON(expr)
57 
58 #else
59 
60 #define GEM_SHOW_DEBUG() (0)
61 
62 #define GEM_BUG_ON(expr) BUILD_BUG_ON_INVALID(expr)
63 #define GEM_WARN_ON(expr) ({ unlikely(!!(expr)); })
64 
65 #define GEM_DEBUG_WARN_ON(expr) ({ BUILD_BUG_ON_INVALID(expr); 0; })
66 #endif
67 
68 #if IS_ENABLED(CONFIG_DRM_I915_TRACE_GEM)
69 #define GEM_TRACE(...) trace_printk(__VA_ARGS__)
70 #define GEM_TRACE_ERR(...) do {						\
71 	pr_err(__VA_ARGS__);						\
72 	trace_printk(__VA_ARGS__);					\
73 } while (0)
74 #define GEM_TRACE_DUMP() \
75 	do { ftrace_dump(DUMP_ALL); __add_taint_for_CI(TAINT_WARN); } while (0)
76 #define GEM_TRACE_DUMP_ON(expr) \
77 	do { if (expr) GEM_TRACE_DUMP(); } while (0)
78 #else
79 #define GEM_TRACE(...) do { } while (0)
80 #define GEM_TRACE_ERR(...) do { } while (0)
81 #define GEM_TRACE_DUMP() do { } while (0)
82 #define GEM_TRACE_DUMP_ON(expr) BUILD_BUG_ON_INVALID(expr)
83 #endif
84 
85 #define I915_GEM_IDLE_TIMEOUT (HZ / 5)
86 
87 #endif /* __I915_GEM_H__ */
88