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