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

/*
 * Copyright (c) 2014-2016 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.
 */

#ifndef __INTEL_FRONTBUFFER_H__
#define __INTEL_FRONTBUFFER_H__

struct drm_device;
struct drm_i915_private;
struct drm_i915_gem_object;

void intel_frontbuffer_flip_prepare(struct drm_device *dev,
				    unsigned frontbuffer_bits);
void intel_frontbuffer_flip_complete(struct drm_device *dev,
				     unsigned frontbuffer_bits);
void intel_frontbuffer_flip(struct drm_device *dev,
			    unsigned frontbuffer_bits);

void __intel_fb_obj_invalidate(struct drm_i915_gem_object *obj,
			       enum fb_op_origin origin,
			       unsigned int frontbuffer_bits);
void __intel_fb_obj_flush(struct drm_i915_gem_object *obj,
			  bool retire,
			  enum fb_op_origin origin,
			  unsigned int frontbuffer_bits);

/**
 * 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.
 */
static inline void intel_fb_obj_invalidate(struct drm_i915_gem_object *obj,
					   enum fb_op_origin origin)
{
	unsigned int frontbuffer_bits;

	frontbuffer_bits = atomic_read(&obj->frontbuffer_bits);
	if (!frontbuffer_bits)
		return;

	__intel_fb_obj_invalidate(obj, origin, frontbuffer_bits);
}

/**
 * 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.
 */
static inline void intel_fb_obj_flush(struct drm_i915_gem_object *obj,
				      bool retire,
				      enum fb_op_origin origin)
{
	unsigned int frontbuffer_bits;

	frontbuffer_bits = atomic_read(&obj->frontbuffer_bits);
	if (!frontbuffer_bits)
		return;

	__intel_fb_obj_flush(obj, retire, origin, frontbuffer_bits);
}

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