[deliverable/linux.git] / drivers / gpu / drm / i915 / intel_frontbuffer.c

/*
 * Copyright © 2014 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 * Authors:
 *	Daniel Vetter <daniel.vetter@ffwll.ch>
 */

/**
 * DOC: frontbuffer tracking
 *
 * Many features require us to track changes to the currently active
 * frontbuffer, especially rendering targeted at the frontbuffer.
 *
 * To be able to do so GEM tracks frontbuffers using a bitmask for all possible
 * frontbuffer slots through i915_gem_track_fb(). The function in this file are
 * then called when the contents of the frontbuffer are invalidated, when
 * frontbuffer rendering has stopped again to flush out all the changes and when
 * the frontbuffer is exchanged with a flip. Subsystems interested in
 * frontbuffer changes (e.g. PSR, FBC, DRRS) should directly put their callbacks
 * into the relevant places and filter for the frontbuffer slots that they are
 * interested int.
 *
 * On a high level there are two types of powersaving features. The first one
 * work like a special cache (FBC and PSR) and are interested when they should
 * stop caching and when to restart caching. This is done by placing callbacks
 * into the invalidate and the flush functions: At invalidate the caching must
 * be stopped and at flush time it can be restarted. And maybe they need to know
 * when the frontbuffer changes (e.g. when the hw doesn't initiate an invalidate
 * and flush on its own) which can be achieved with placing callbacks into the
 * flip functions.
 *
 * The other type of display power saving feature only cares about busyness
 * (e.g. DRRS). In that case all three (invalidate, flush and flip) indicate
 * busyness. There is no direct way to detect idleness. Instead an idle timer
 * work delayed work should be started from the flush and flip functions and
 * cancelled as soon as busyness is detected.
 *
 * Note that there's also an older frontbuffer activity tracking scheme which
 * just tracks general activity. This is done by the various mark_busy and
 * mark_idle functions. For display power management features using these
 * functions is deprecated and should be avoided.
 */

#include <drm/drmP.h>

#include "intel_drv.h"
#include "intel_frontbuffer.h"
#include "i915_drv.h"

/**
 * intel_fb_obj_invalidate - invalidate frontbuffer object
 * @obj: GEM object to invalidate
 * @origin: which operation caused the invalidation
 *
 * This function gets called every time rendering on the given object starts and
 * frontbuffer caching (fbc, low refresh rate for DRRS, panel self refresh) must
 * be invalidated. For ORIGIN_CS any subsequent invalidation will be delayed
 * until the rendering completes or a flip on this frontbuffer plane is
 * scheduled.
 */
void intel_fb_obj_invalidate(struct drm_i915_gem_object *obj,
			     enum fb_op_origin origin)
{
	struct drm_device *dev = obj->base.dev;
	struct drm_i915_private *dev_priv = to_i915(dev);

	WARN_ON(!mutex_is_locked(&dev->struct_mutex));

	if (!obj->frontbuffer_bits)
		return;

	if (origin == ORIGIN_CS) {
		mutex_lock(&dev_priv->fb_tracking.lock);
		dev_priv->fb_tracking.busy_bits
			|= obj->frontbuffer_bits;
		dev_priv->fb_tracking.flip_bits
			&= ~obj->frontbuffer_bits;
		mutex_unlock(&dev_priv->fb_tracking.lock);
	}

	intel_psr_invalidate(dev, obj->frontbuffer_bits);
	intel_edp_drrs_invalidate(dev, obj->frontbuffer_bits);
	intel_fbc_invalidate(dev_priv, obj->frontbuffer_bits, origin);
}

/**
 * intel_frontbuffer_flush - flush frontbuffer
 * @dev: DRM device
 * @frontbuffer_bits: frontbuffer plane tracking bits
 * @origin: which operation caused the flush
 *
 * This function gets called every time rendering on the given planes has
 * completed and frontbuffer caching can be started again. Flushes will get
 * delayed if they're blocked by some outstanding asynchronous rendering.
 *
 * Can be called without any locks held.
 */
static void intel_frontbuffer_flush(struct drm_device *dev,
				    unsigned frontbuffer_bits,
				    enum fb_op_origin origin)
{
	struct drm_i915_private *dev_priv = to_i915(dev);

	/* Delay flushing when rings are still busy.*/
	mutex_lock(&dev_priv->fb_tracking.lock);
	frontbuffer_bits &= ~dev_priv->fb_tracking.busy_bits;
	mutex_unlock(&dev_priv->fb_tracking.lock);

	if (!frontbuffer_bits)
		return;

	intel_edp_drrs_flush(dev, frontbuffer_bits);
	intel_psr_flush(dev, frontbuffer_bits, origin);
	intel_fbc_flush(dev_priv, frontbuffer_bits, origin);
}

/**
 * intel_fb_obj_flush - flush frontbuffer object
 * @obj: GEM object to flush
 * @retire: set when retiring asynchronous rendering
 * @origin: which operation caused the flush
 *
 * This function gets called every time rendering on the given object has
 * completed and frontbuffer caching can be started again. If @retire is true
 * then any delayed flushes will be unblocked.
 */
void intel_fb_obj_flush(struct drm_i915_gem_object *obj,
			bool retire, enum fb_op_origin origin)
{
	struct drm_device *dev = obj->base.dev;
	struct drm_i915_private *dev_priv = to_i915(dev);
	unsigned frontbuffer_bits;

	WARN_ON(!mutex_is_locked(&dev->struct_mutex));

	if (!obj->frontbuffer_bits)
		return;

	frontbuffer_bits = obj->frontbuffer_bits;

	if (retire) {
		mutex_lock(&dev_priv->fb_tracking.lock);
		/* Filter out new bits since rendering started. */
		frontbuffer_bits &= dev_priv->fb_tracking.busy_bits;

		dev_priv->fb_tracking.busy_bits &= ~frontbuffer_bits;
		mutex_unlock(&dev_priv->fb_tracking.lock);
	}

	intel_frontbuffer_flush(dev, frontbuffer_bits, origin);
}

/**
 * intel_frontbuffer_flip_prepare - prepare asynchronous frontbuffer flip
 * @dev: DRM device
 * @frontbuffer_bits: frontbuffer plane tracking bits
 *
 * This function gets called after scheduling a flip on @obj. The actual
 * frontbuffer flushing will be delayed until completion is signalled with
 * intel_frontbuffer_flip_complete. If an invalidate happens in between this
 * flush will be cancelled.
 *
 * Can be called without any locks held.
 */
void intel_frontbuffer_flip_prepare(struct drm_device *dev,
				    unsigned frontbuffer_bits)
{
	struct drm_i915_private *dev_priv = to_i915(dev);

	mutex_lock(&dev_priv->fb_tracking.lock);
	dev_priv->fb_tracking.flip_bits |= frontbuffer_bits;
	/* Remove stale busy bits due to the old buffer. */
	dev_priv->fb_tracking.busy_bits &= ~frontbuffer_bits;
	mutex_unlock(&dev_priv->fb_tracking.lock);

	intel_psr_single_frame_update(dev, frontbuffer_bits);
}

/**
 * intel_frontbuffer_flip_complete - complete asynchronous frontbuffer flip
 * @dev: DRM device
 * @frontbuffer_bits: frontbuffer plane tracking bits
 *
 * This function gets called after the flip has been latched and will complete
 * on the next vblank. It will execute the flush if it hasn't been cancelled yet.
 *
 * Can be called without any locks held.
 */
void intel_frontbuffer_flip_complete(struct drm_device *dev,
				     unsigned frontbuffer_bits)
{
	struct drm_i915_private *dev_priv = to_i915(dev);

	mutex_lock(&dev_priv->fb_tracking.lock);
	/* Mask any cancelled flips. */
	frontbuffer_bits &= dev_priv->fb_tracking.flip_bits;
	dev_priv->fb_tracking.flip_bits &= ~frontbuffer_bits;
	mutex_unlock(&dev_priv->fb_tracking.lock);

	intel_frontbuffer_flush(dev, frontbuffer_bits, ORIGIN_FLIP);
}

/**
 * intel_frontbuffer_flip - synchronous frontbuffer flip
 * @dev: DRM device
 * @frontbuffer_bits: frontbuffer plane tracking bits
 *
 * This function gets called after scheduling a flip on @obj. This is for
 * synchronous plane updates which will happen on the next vblank and which will
 * not get delayed by pending gpu rendering.
 *
 * Can be called without any locks held.
 */
void intel_frontbuffer_flip(struct drm_device *dev,
			    unsigned frontbuffer_bits)
{
	struct drm_i915_private *dev_priv = to_i915(dev);

	mutex_lock(&dev_priv->fb_tracking.lock);
	/* Remove stale busy bits due to the old buffer. */
	dev_priv->fb_tracking.busy_bits &= ~frontbuffer_bits;
	mutex_unlock(&dev_priv->fb_tracking.lock);

	intel_frontbuffer_flush(dev, frontbuffer_bits, ORIGIN_FLIP);
}
Commit	Line	Data
b680c37a DV	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
5c323b2a	31	* frontbuffer, especially rendering targeted at the frontbuffer.
b680c37a DV	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
5c323b2a	58	* just tracks general activity. This is done by the various mark_busy and
b680c37a DV	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"
5d723d7a	66	#include "intel_frontbuffer.h"
b680c37a DV	67	#include "i915_drv.h"
b680c37a DV	68
b680c37a DV	69	/**
	70	* intel_fb_obj_invalidate - invalidate frontbuffer object
	71	* @obj: GEM object to invalidate
a4001f1b	72	* @origin: which operation caused the invalidation
b680c37a DV	73	*
	74	* This function gets called every time rendering on the given object starts and
	75	* frontbuffer caching (fbc, low refresh rate for DRRS, panel self refresh) must
77a0d1ca	76	* be invalidated. For ORIGIN_CS any subsequent invalidation will be delayed
b680c37a DV	77	* until the rendering completes or a flip on this frontbuffer plane is
	78	* scheduled.
	79	*/
	80	void intel_fb_obj_invalidate(struct drm_i915_gem_object *obj,
a4001f1b	81	enum fb_op_origin origin)
b680c37a DV	82	{
b680c37a DV	83	struct drm_device *dev = obj->base.dev;
9fb73863	84	struct drm_i915_private *dev_priv = to_i915(dev);
b680c37a DV	85
	86	WARN_ON(!mutex_is_locked(&dev->struct_mutex));
	87
	88	if (!obj->frontbuffer_bits)
	89	return;
	90
77a0d1ca	91	if (origin == ORIGIN_CS) {
b680c37a DV	92	mutex_lock(&dev_priv->fb_tracking.lock);
	93	dev_priv->fb_tracking.busy_bits
	94	\|= obj->frontbuffer_bits;
	95	dev_priv->fb_tracking.flip_bits
	96	&= ~obj->frontbuffer_bits;
	97	mutex_unlock(&dev_priv->fb_tracking.lock);
	98	}
	99
0bc12bcb	100	intel_psr_invalidate(dev, obj->frontbuffer_bits);
a93fad0f	101	intel_edp_drrs_invalidate(dev, obj->frontbuffer_bits);
dbef0f15	102	intel_fbc_invalidate(dev_priv, obj->frontbuffer_bits, origin);
b680c37a DV	103	}
	104
	105	/**
	106	* intel_frontbuffer_flush - flush frontbuffer
	107	* @dev: DRM device
	108	* @frontbuffer_bits: frontbuffer plane tracking bits
de152b62	109	* @origin: which operation caused the flush
b680c37a DV	110	*
	111	* This function gets called every time rendering on the given planes has
	112	* completed and frontbuffer caching can be started again. Flushes will get
5c323b2a	113	* delayed if they're blocked by some outstanding asynchronous rendering.
b680c37a DV	114	*
	115	* Can be called without any locks held.
	116	*/
b6c2aa51 PZ	117	static void intel_frontbuffer_flush(struct drm_device *dev,
	118	unsigned frontbuffer_bits,
	119	enum fb_op_origin origin)
b680c37a	120	{
9fb73863	121	struct drm_i915_private *dev_priv = to_i915(dev);
b680c37a DV	122
	123	/* Delay flushing when rings are still busy.*/
	124	mutex_lock(&dev_priv->fb_tracking.lock);
	125	frontbuffer_bits &= ~dev_priv->fb_tracking.busy_bits;
	126	mutex_unlock(&dev_priv->fb_tracking.lock);
	127
27e78a2a DV	128	if (!frontbuffer_bits)
	129	return;
	130
a93fad0f	131	intel_edp_drrs_flush(dev, frontbuffer_bits);
169de131	132	intel_psr_flush(dev, frontbuffer_bits, origin);
6f4551fe	133	intel_fbc_flush(dev_priv, frontbuffer_bits, origin);
b680c37a DV	134	}
	135
	136	/**
	137	* intel_fb_obj_flush - flush frontbuffer object
	138	* @obj: GEM object to flush
	139	* @retire: set when retiring asynchronous rendering
76f2e13d	140	* @origin: which operation caused the flush
b680c37a DV	141	*
	142	* This function gets called every time rendering on the given object has
	143	* completed and frontbuffer caching can be started again. If @retire is true
	144	* then any delayed flushes will be unblocked.
	145	*/
	146	void intel_fb_obj_flush(struct drm_i915_gem_object *obj,
de152b62	147	bool retire, enum fb_op_origin origin)
b680c37a DV	148	{
b680c37a DV	149	struct drm_device *dev = obj->base.dev;
9fb73863	150	struct drm_i915_private *dev_priv = to_i915(dev);
b680c37a DV	151	unsigned frontbuffer_bits;
	152
	153	WARN_ON(!mutex_is_locked(&dev->struct_mutex));
	154
	155	if (!obj->frontbuffer_bits)
	156	return;
	157
	158	frontbuffer_bits = obj->frontbuffer_bits;
	159
	160	if (retire) {
	161	mutex_lock(&dev_priv->fb_tracking.lock);
	162	/* Filter out new bits since rendering started. */
	163	frontbuffer_bits &= dev_priv->fb_tracking.busy_bits;
	164
	165	dev_priv->fb_tracking.busy_bits &= ~frontbuffer_bits;
	166	mutex_unlock(&dev_priv->fb_tracking.lock);
	167	}
	168
de152b62	169	intel_frontbuffer_flush(dev, frontbuffer_bits, origin);
b680c37a DV	170	}
	171
	172	/**
5c323b2a	173	* intel_frontbuffer_flip_prepare - prepare asynchronous frontbuffer flip
b680c37a DV	174	* @dev: DRM device
	175	* @frontbuffer_bits: frontbuffer plane tracking bits
	176	*
	177	* This function gets called after scheduling a flip on @obj. The actual
	178	* frontbuffer flushing will be delayed until completion is signalled with
	179	* intel_frontbuffer_flip_complete. If an invalidate happens in between this
	180	* flush will be cancelled.
	181	*
	182	* Can be called without any locks held.
	183	*/
	184	void intel_frontbuffer_flip_prepare(struct drm_device *dev,
	185	unsigned frontbuffer_bits)
	186	{
9fb73863	187	struct drm_i915_private *dev_priv = to_i915(dev);
b680c37a DV	188
b680c37a DV	189	mutex_lock(&dev_priv->fb_tracking.lock);
11c9b6c6 DV	190	dev_priv->fb_tracking.flip_bits \|= frontbuffer_bits;
	191	/* Remove stale busy bits due to the old buffer. */
	192	dev_priv->fb_tracking.busy_bits &= ~frontbuffer_bits;
b680c37a	193	mutex_unlock(&dev_priv->fb_tracking.lock);
c7240c3b	194
20c8838b	195	intel_psr_single_frame_update(dev, frontbuffer_bits);
b680c37a DV	196	}
	197
	198	/**
5c323b2a	199	* intel_frontbuffer_flip_complete - complete asynchronous frontbuffer flip
b680c37a DV	200	* @dev: DRM device
	201	* @frontbuffer_bits: frontbuffer plane tracking bits
	202	*
	203	* This function gets called after the flip has been latched and will complete
5c323b2a	204	* on the next vblank. It will execute the flush if it hasn't been cancelled yet.
b680c37a DV	205	*
	206	* Can be called without any locks held.
	207	*/
	208	void intel_frontbuffer_flip_complete(struct drm_device *dev,
	209	unsigned frontbuffer_bits)
	210	{
9fb73863	211	struct drm_i915_private *dev_priv = to_i915(dev);
b680c37a DV	212
	213	mutex_lock(&dev_priv->fb_tracking.lock);
	214	/* Mask any cancelled flips. */
	215	frontbuffer_bits &= dev_priv->fb_tracking.flip_bits;
	216	dev_priv->fb_tracking.flip_bits &= ~frontbuffer_bits;
	217	mutex_unlock(&dev_priv->fb_tracking.lock);
	218
de152b62	219	intel_frontbuffer_flush(dev, frontbuffer_bits, ORIGIN_FLIP);
b680c37a	220	}
fdbff928 DV	221
	222	/**
	223	* intel_frontbuffer_flip - synchronous frontbuffer flip
	224	* @dev: DRM device
	225	* @frontbuffer_bits: frontbuffer plane tracking bits
	226	*
	227	* This function gets called after scheduling a flip on @obj. This is for
	228	* synchronous plane updates which will happen on the next vblank and which will
	229	* not get delayed by pending gpu rendering.
	230	*
	231	* Can be called without any locks held.
	232	*/
fdbff928 DV	233	void intel_frontbuffer_flip(struct drm_device *dev,
	234	unsigned frontbuffer_bits)
	235	{
9fb73863	236	struct drm_i915_private *dev_priv = to_i915(dev);
fdbff928 DV	237
	238	mutex_lock(&dev_priv->fb_tracking.lock);
	239	/* Remove stale busy bits due to the old buffer. */
	240	dev_priv->fb_tracking.busy_bits &= ~frontbuffer_bits;
	241	mutex_unlock(&dev_priv->fb_tracking.lock);
	242
de152b62	243	intel_frontbuffer_flush(dev, frontbuffer_bits, ORIGIN_FLIP);
fdbff928	244	}