[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 "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
 *
 * 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.
 */
void intel_frontbuffer_flush(struct drm_device *dev,
			     unsigned frontbuffer_bits)
{
	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);
	intel_fbc_flush(dev_priv, frontbuffer_bits);
}

/**
 * intel_fb_obj_flush - flush frontbuffer object
 * @obj: GEM object to flush
 * @retire: set when retiring asynchronous rendering
 *
 * 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)
{
	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);
}

/**
 * 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);
}

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