xref: /dragonfly/sys/dev/drm/i915/intel_frontbuffer.h (revision abf903a5)
1 /*
2  * Copyright (c) 2014-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 __INTEL_FRONTBUFFER_H__
25 #define __INTEL_FRONTBUFFER_H__
26 
27 struct drm_i915_private;
28 struct drm_i915_gem_object;
29 
30 void intel_frontbuffer_flip_prepare(struct drm_i915_private *dev_priv,
31 				    unsigned frontbuffer_bits);
32 void intel_frontbuffer_flip_complete(struct drm_i915_private *dev_priv,
33 				     unsigned frontbuffer_bits);
34 void intel_frontbuffer_flip(struct drm_i915_private *dev_priv,
35 			    unsigned frontbuffer_bits);
36 
37 void __intel_fb_obj_invalidate(struct drm_i915_gem_object *obj,
38 			       enum fb_op_origin origin,
39 			       unsigned int frontbuffer_bits);
40 void __intel_fb_obj_flush(struct drm_i915_gem_object *obj,
41 			  bool retire,
42 			  enum fb_op_origin origin,
43 			  unsigned int frontbuffer_bits);
44 
45 /**
46  * intel_fb_obj_invalidate - invalidate frontbuffer object
47  * @obj: GEM object to invalidate
48  * @origin: which operation caused the invalidation
49  *
50  * This function gets called every time rendering on the given object starts and
51  * frontbuffer caching (fbc, low refresh rate for DRRS, panel self refresh) must
52  * be invalidated. For ORIGIN_CS any subsequent invalidation will be delayed
53  * until the rendering completes or a flip on this frontbuffer plane is
54  * scheduled.
55  */
56 static inline void intel_fb_obj_invalidate(struct drm_i915_gem_object *obj,
57 					   enum fb_op_origin origin)
58 {
59 	unsigned int frontbuffer_bits;
60 
61 	frontbuffer_bits = atomic_read(&obj->frontbuffer_bits);
62 	if (!frontbuffer_bits)
63 		return;
64 
65 	__intel_fb_obj_invalidate(obj, origin, frontbuffer_bits);
66 }
67 
68 /**
69  * intel_fb_obj_flush - flush frontbuffer object
70  * @obj: GEM object to flush
71  * @retire: set when retiring asynchronous rendering
72  * @origin: which operation caused the flush
73  *
74  * This function gets called every time rendering on the given object has
75  * completed and frontbuffer caching can be started again. If @retire is true
76  * then any delayed flushes will be unblocked.
77  */
78 static inline void intel_fb_obj_flush(struct drm_i915_gem_object *obj,
79 				      bool retire,
80 				      enum fb_op_origin origin)
81 {
82 	unsigned int frontbuffer_bits;
83 
84 	frontbuffer_bits = atomic_read(&obj->frontbuffer_bits);
85 	if (!frontbuffer_bits)
86 		return;
87 
88 	__intel_fb_obj_flush(obj, retire, origin, frontbuffer_bits);
89 }
90 
91 #endif /* __INTEL_FRONTBUFFER_H__ */
92