xref: /linux/drivers/gpu/drm/i915/i915_gem.h (revision 87807f77a03d0271211b75f84b2a8b88f4e8e5d4)
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 #include <linux/types.h>
30 
31 #include <drm/drm_drv.h>
32 
33 #include "i915_utils.h"
34 
35 struct drm_file;
36 struct drm_i915_gem_object;
37 struct drm_i915_private;
38 struct i915_gem_ww_ctx;
39 struct i915_gtt_view;
40 struct i915_vma;
41 
42 #define I915_GEM_GPU_DOMAINS	       \
43 	(I915_GEM_DOMAIN_RENDER |      \
44 	 I915_GEM_DOMAIN_SAMPLER |     \
45 	 I915_GEM_DOMAIN_COMMAND |     \
46 	 I915_GEM_DOMAIN_INSTRUCTION | \
47 	 I915_GEM_DOMAIN_VERTEX)
48 
49 void i915_gem_init_early(struct drm_i915_private *i915);
50 void i915_gem_cleanup_early(struct drm_i915_private *i915);
51 
52 void i915_gem_drain_freed_objects(struct drm_i915_private *i915);
53 void i915_gem_drain_workqueue(struct drm_i915_private *i915);
54 
55 struct i915_vma * __must_check
56 i915_gem_object_ggtt_pin_ww(struct drm_i915_gem_object *obj,
57 			    struct i915_gem_ww_ctx *ww,
58 			    const struct i915_gtt_view *view,
59 			    u64 size, u64 alignment, u64 flags);
60 
61 struct i915_vma * __must_check
62 i915_gem_object_ggtt_pin(struct drm_i915_gem_object *obj,
63 			 const struct i915_gtt_view *view,
64 			 u64 size, u64 alignment, u64 flags);
65 
66 int i915_gem_object_unbind(struct drm_i915_gem_object *obj,
67 			   unsigned long flags);
68 #define I915_GEM_OBJECT_UNBIND_ACTIVE BIT(0)
69 #define I915_GEM_OBJECT_UNBIND_BARRIER BIT(1)
70 #define I915_GEM_OBJECT_UNBIND_TEST BIT(2)
71 #define I915_GEM_OBJECT_UNBIND_VM_TRYLOCK BIT(3)
72 #define I915_GEM_OBJECT_UNBIND_ASYNC BIT(4)
73 
74 void i915_gem_runtime_suspend(struct drm_i915_private *i915);
75 
76 int __must_check i915_gem_init(struct drm_i915_private *i915);
77 void i915_gem_driver_register(struct drm_i915_private *i915);
78 void i915_gem_driver_unregister(struct drm_i915_private *i915);
79 void i915_gem_driver_remove(struct drm_i915_private *i915);
80 void i915_gem_driver_release(struct drm_i915_private *i915);
81 
82 int i915_gem_open(struct drm_i915_private *i915, struct drm_file *file);
83 
84 /* FIXME: All of the below belong somewhere else. */
85 
86 #ifdef CONFIG_DRM_I915_DEBUG_GEM
87 
88 #define GEM_SHOW_DEBUG() drm_debug_enabled(DRM_UT_DRIVER)
89 
90 #ifdef CONFIG_DRM_I915_DEBUG_GEM_ONCE
91 #define __GEM_BUG(cond) BUG()
92 #else
93 #define __GEM_BUG(cond) \
94 	WARN(1, "%s:%d GEM_BUG_ON(%s)\n", __func__, __LINE__, __stringify(cond))
95 #endif
96 
97 #define GEM_BUG_ON(condition) do { if (unlikely((condition))) {	\
98 		GEM_TRACE_ERR("%s:%d GEM_BUG_ON(%s)\n", \
99 			      __func__, __LINE__, __stringify(condition)); \
100 		GEM_TRACE_DUMP(); \
101 		__GEM_BUG(condition); \
102 		} \
103 	} while(0)
104 #define GEM_WARN_ON(expr) WARN_ON(expr)
105 
106 #define GEM_DEBUG_WARN_ON(expr) GEM_WARN_ON(expr)
107 
108 #else
109 
110 #define GEM_SHOW_DEBUG() (0)
111 
112 #define GEM_BUG_ON(expr) BUILD_BUG_ON_INVALID(expr)
113 #define GEM_WARN_ON(expr) ({ unlikely(!!(expr)); })
114 
115 #define GEM_DEBUG_WARN_ON(expr) ({ BUILD_BUG_ON_INVALID(expr); 0; })
116 #endif
117 
118 #if IS_ENABLED(CONFIG_DRM_I915_TRACE_GEM)
119 #define GEM_TRACE(...) trace_printk(__VA_ARGS__)
120 #define GEM_TRACE_ERR(...) do {						\
121 	pr_err(__VA_ARGS__);						\
122 	trace_printk(__VA_ARGS__);					\
123 } while (0)
124 #define GEM_TRACE_DUMP() \
125 	do { ftrace_dump(DUMP_ALL); __add_taint_for_CI(TAINT_WARN); } while (0)
126 #define GEM_TRACE_DUMP_ON(expr) \
127 	do { if (expr) GEM_TRACE_DUMP(); } while (0)
128 #else
129 #define GEM_TRACE(...) do { } while (0)
130 #define GEM_TRACE_ERR(...) do { } while (0)
131 #define GEM_TRACE_DUMP() do { } while (0)
132 #define GEM_TRACE_DUMP_ON(expr) BUILD_BUG_ON_INVALID(expr)
133 #endif
134 
135 #define I915_GEM_IDLE_TIMEOUT (HZ / 5)
136 
137 #endif /* __I915_GEM_H__ */
138