drm/i915: DocBook integration for frontbuffer tracking
[firefly-linux-kernel-4.4.55.git] / drivers / gpu / drm / i915 / intel_frontbuffer.c
1 /*
2  * Copyright © 2014 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
21  * DEALINGS IN THE SOFTWARE.
22  *
23  * Authors:
24  *      Daniel Vetter <daniel.vetter@ffwll.ch>
25  */
26
27 /**
28  * DOC: frontbuffer tracking
29  *
30  * Many features require us to track changes to the currently active
31  * frontbuffer, especially rendering targetted at the frontbuffer.
32  *
33  * To be able to do so GEM tracks frontbuffers using a bitmask for all possible
34  * frontbuffer slots through i915_gem_track_fb(). The function in this file are
35  * then called when the contents of the frontbuffer are invalidated, when
36  * frontbuffer rendering has stopped again to flush out all the changes and when
37  * the frontbuffer is exchanged with a flip. Subsystems interested in
38  * frontbuffer changes (e.g. PSR, FBC, DRRS) should directly put their callbacks
39  * into the relevant places and filter for the frontbuffer slots that they are
40  * interested int.
41  *
42  * On a high level there are two types of powersaving features. The first one
43  * work like a special cache (FBC and PSR) and are interested when they should
44  * stop caching and when to restart caching. This is done by placing callbacks
45  * into the invalidate and the flush functions: At invalidate the caching must
46  * be stopped and at flush time it can be restarted. And maybe they need to know
47  * when the frontbuffer changes (e.g. when the hw doesn't initiate an invalidate
48  * and flush on its own) which can be achieved with placing callbacks into the
49  * flip functions.
50  *
51  * The other type of display power saving feature only cares about busyness
52  * (e.g. DRRS). In that case all three (invalidate, flush and flip) indicate
53  * busyness. There is no direct way to detect idleness. Instead an idle timer
54  * work delayed work should be started from the flush and flip functions and
55  * cancelled as soon as busyness is detected.
56  *
57  * Note that there's also an older frontbuffer activity tracking scheme which
58  * just trackings general activity. This is done by the various mark_busy and
59  * mark_idle functions. For display power management features using these
60  * functions is deprecated and should be avoided.
61  */
62
63 #include <drm/drmP.h>
64
65 #include "intel_drv.h"
66 #include "i915_drv.h"
67
68 static void intel_increase_pllclock(struct drm_device *dev,
69                                     enum pipe pipe)
70 {
71         struct drm_i915_private *dev_priv = dev->dev_private;
72         int dpll_reg = DPLL(pipe);
73         int dpll;
74
75         if (!HAS_GMCH_DISPLAY(dev))
76                 return;
77
78         if (!dev_priv->lvds_downclock_avail)
79                 return;
80
81         dpll = I915_READ(dpll_reg);
82         if (!HAS_PIPE_CXSR(dev) && (dpll & DISPLAY_RATE_SELECT_FPA1)) {
83                 DRM_DEBUG_DRIVER("upclocking LVDS\n");
84
85                 assert_panel_unlocked(dev_priv, pipe);
86
87                 dpll &= ~DISPLAY_RATE_SELECT_FPA1;
88                 I915_WRITE(dpll_reg, dpll);
89                 intel_wait_for_vblank(dev, pipe);
90
91                 dpll = I915_READ(dpll_reg);
92                 if (dpll & DISPLAY_RATE_SELECT_FPA1)
93                         DRM_DEBUG_DRIVER("failed to upclock LVDS!\n");
94         }
95 }
96
97 /**
98  * intel_mark_fb_busy - mark given planes as busy
99  * @dev: DRM device
100  * @frontbuffer_bits: bits for the affected planes
101  * @ring: optional ring for asynchronous commands
102  *
103  * This function gets called every time the screen contents change. It can be
104  * used to keep e.g. the update rate at the nominal refresh rate with DRRS.
105  */
106 static void intel_mark_fb_busy(struct drm_device *dev,
107                                unsigned frontbuffer_bits,
108                                struct intel_engine_cs *ring)
109 {
110         struct drm_i915_private *dev_priv = dev->dev_private;
111         enum pipe pipe;
112
113         if (!i915.powersave)
114                 return;
115
116         for_each_pipe(dev_priv, pipe) {
117                 if (!(frontbuffer_bits & INTEL_FRONTBUFFER_ALL_MASK(pipe)))
118                         continue;
119
120                 intel_increase_pllclock(dev, pipe);
121                 if (ring && intel_fbc_enabled(dev))
122                         ring->fbc_dirty = true;
123         }
124 }
125
126 /**
127  * intel_fb_obj_invalidate - invalidate frontbuffer object
128  * @obj: GEM object to invalidate
129  * @ring: set for asynchronous rendering
130  *
131  * This function gets called every time rendering on the given object starts and
132  * frontbuffer caching (fbc, low refresh rate for DRRS, panel self refresh) must
133  * be invalidated. If @ring is non-NULL any subsequent invalidation will be delayed
134  * until the rendering completes or a flip on this frontbuffer plane is
135  * scheduled.
136  */
137 void intel_fb_obj_invalidate(struct drm_i915_gem_object *obj,
138                              struct intel_engine_cs *ring)
139 {
140         struct drm_device *dev = obj->base.dev;
141         struct drm_i915_private *dev_priv = dev->dev_private;
142
143         WARN_ON(!mutex_is_locked(&dev->struct_mutex));
144
145         if (!obj->frontbuffer_bits)
146                 return;
147
148         if (ring) {
149                 mutex_lock(&dev_priv->fb_tracking.lock);
150                 dev_priv->fb_tracking.busy_bits
151                         |= obj->frontbuffer_bits;
152                 dev_priv->fb_tracking.flip_bits
153                         &= ~obj->frontbuffer_bits;
154                 mutex_unlock(&dev_priv->fb_tracking.lock);
155         }
156
157         intel_mark_fb_busy(dev, obj->frontbuffer_bits, ring);
158
159         intel_edp_psr_invalidate(dev, obj->frontbuffer_bits);
160 }
161
162 /**
163  * intel_frontbuffer_flush - flush frontbuffer
164  * @dev: DRM device
165  * @frontbuffer_bits: frontbuffer plane tracking bits
166  *
167  * This function gets called every time rendering on the given planes has
168  * completed and frontbuffer caching can be started again. Flushes will get
169  * delayed if they're blocked by some oustanding asynchronous rendering.
170  *
171  * Can be called without any locks held.
172  */
173 void intel_frontbuffer_flush(struct drm_device *dev,
174                              unsigned frontbuffer_bits)
175 {
176         struct drm_i915_private *dev_priv = dev->dev_private;
177
178         /* Delay flushing when rings are still busy.*/
179         mutex_lock(&dev_priv->fb_tracking.lock);
180         frontbuffer_bits &= ~dev_priv->fb_tracking.busy_bits;
181         mutex_unlock(&dev_priv->fb_tracking.lock);
182
183         intel_mark_fb_busy(dev, frontbuffer_bits, NULL);
184
185         intel_edp_psr_flush(dev, frontbuffer_bits);
186
187         /*
188          * FIXME: Unconditional fbc flushing here is a rather gross hack and
189          * needs to be reworked into a proper frontbuffer tracking scheme like
190          * psr employs.
191          */
192         if (IS_BROADWELL(dev))
193                 gen8_fbc_sw_flush(dev, FBC_REND_CACHE_CLEAN);
194 }
195
196 /**
197  * intel_fb_obj_flush - flush frontbuffer object
198  * @obj: GEM object to flush
199  * @retire: set when retiring asynchronous rendering
200  *
201  * This function gets called every time rendering on the given object has
202  * completed and frontbuffer caching can be started again. If @retire is true
203  * then any delayed flushes will be unblocked.
204  */
205 void intel_fb_obj_flush(struct drm_i915_gem_object *obj,
206                         bool retire)
207 {
208         struct drm_device *dev = obj->base.dev;
209         struct drm_i915_private *dev_priv = dev->dev_private;
210         unsigned frontbuffer_bits;
211
212         WARN_ON(!mutex_is_locked(&dev->struct_mutex));
213
214         if (!obj->frontbuffer_bits)
215                 return;
216
217         frontbuffer_bits = obj->frontbuffer_bits;
218
219         if (retire) {
220                 mutex_lock(&dev_priv->fb_tracking.lock);
221                 /* Filter out new bits since rendering started. */
222                 frontbuffer_bits &= dev_priv->fb_tracking.busy_bits;
223
224                 dev_priv->fb_tracking.busy_bits &= ~frontbuffer_bits;
225                 mutex_unlock(&dev_priv->fb_tracking.lock);
226         }
227
228         intel_frontbuffer_flush(dev, frontbuffer_bits);
229 }
230
231 /**
232  * intel_frontbuffer_flip_prepare - prepare asnychronous frontbuffer flip
233  * @dev: DRM device
234  * @frontbuffer_bits: frontbuffer plane tracking bits
235  *
236  * This function gets called after scheduling a flip on @obj. The actual
237  * frontbuffer flushing will be delayed until completion is signalled with
238  * intel_frontbuffer_flip_complete. If an invalidate happens in between this
239  * flush will be cancelled.
240  *
241  * Can be called without any locks held.
242  */
243 void intel_frontbuffer_flip_prepare(struct drm_device *dev,
244                                     unsigned frontbuffer_bits)
245 {
246         struct drm_i915_private *dev_priv = dev->dev_private;
247
248         mutex_lock(&dev_priv->fb_tracking.lock);
249         dev_priv->fb_tracking.flip_bits
250                 |= frontbuffer_bits;
251         mutex_unlock(&dev_priv->fb_tracking.lock);
252 }
253
254 /**
255  * intel_frontbuffer_flip_complete - complete asynchronous frontbuffer flush
256  * @dev: DRM device
257  * @frontbuffer_bits: frontbuffer plane tracking bits
258  *
259  * This function gets called after the flip has been latched and will complete
260  * on the next vblank. It will execute the fush if it hasn't been cancalled yet.
261  *
262  * Can be called without any locks held.
263  */
264 void intel_frontbuffer_flip_complete(struct drm_device *dev,
265                                      unsigned frontbuffer_bits)
266 {
267         struct drm_i915_private *dev_priv = dev->dev_private;
268
269         mutex_lock(&dev_priv->fb_tracking.lock);
270         /* Mask any cancelled flips. */
271         frontbuffer_bits &= dev_priv->fb_tracking.flip_bits;
272         dev_priv->fb_tracking.flip_bits &= ~frontbuffer_bits;
273         mutex_unlock(&dev_priv->fb_tracking.lock);
274
275         intel_frontbuffer_flush(dev, frontbuffer_bits);
276 }
277