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 #include "gem/i915_gem_object.h"
28 
29 struct drm_i915_private;
30 struct drm_i915_gem_object;
31 
32 enum fb_op_origin {
33 	ORIGIN_GTT,
34 	ORIGIN_CPU,
35 	ORIGIN_CS,
36 	ORIGIN_FLIP,
37 	ORIGIN_DIRTYFB,
38 };
39 
40 void intel_frontbuffer_flip_prepare(struct drm_i915_private *dev_priv,
41 				    unsigned frontbuffer_bits);
42 void intel_frontbuffer_flip_complete(struct drm_i915_private *dev_priv,
43 				     unsigned frontbuffer_bits);
44 void intel_frontbuffer_flip(struct drm_i915_private *dev_priv,
45 			    unsigned frontbuffer_bits);
46 
47 void __intel_fb_obj_invalidate(struct drm_i915_gem_object *obj,
48 			       enum fb_op_origin origin,
49 			       unsigned int frontbuffer_bits);
50 void __intel_fb_obj_flush(struct drm_i915_gem_object *obj,
51 			  enum fb_op_origin origin,
52 			  unsigned int frontbuffer_bits);
53 
54 /**
55  * intel_fb_obj_invalidate - invalidate frontbuffer object
56  * @obj: GEM object to invalidate
57  * @origin: which operation caused the invalidation
58  *
59  * This function gets called every time rendering on the given object starts and
60  * frontbuffer caching (fbc, low refresh rate for DRRS, panel self refresh) must
61  * be invalidated. For ORIGIN_CS any subsequent invalidation will be delayed
62  * until the rendering completes or a flip on this frontbuffer plane is
63  * scheduled.
64  */
65 static inline bool intel_fb_obj_invalidate(struct drm_i915_gem_object *obj,
66 					   enum fb_op_origin origin)
67 {
68 	unsigned int frontbuffer_bits;
69 
70 	frontbuffer_bits = atomic_read(&obj->frontbuffer_bits);
71 	if (!frontbuffer_bits)
72 		return false;
73 
74 	__intel_fb_obj_invalidate(obj, origin, frontbuffer_bits);
75 	return true;
76 }
77 
78 /**
79  * intel_fb_obj_flush - flush frontbuffer object
80  * @obj: GEM object to flush
81  * @origin: which operation caused the flush
82  *
83  * This function gets called every time rendering on the given object has
84  * completed and frontbuffer caching can be started again.
85  */
86 static inline void intel_fb_obj_flush(struct drm_i915_gem_object *obj,
87 				      enum fb_op_origin origin)
88 {
89 	unsigned int frontbuffer_bits;
90 
91 	frontbuffer_bits = atomic_read(&obj->frontbuffer_bits);
92 	if (!frontbuffer_bits)
93 		return;
94 
95 	__intel_fb_obj_flush(obj, origin, frontbuffer_bits);
96 }
97 
98 #endif /* __INTEL_FRONTBUFFER_H__ */
99