[linux-2.6-block.git] / include / drm / drm_atomic_helper.h

/*
 * Copyright (C) 2014 Red Hat
 * Copyright (C) 2014 Intel Corp.
 *
 * 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 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 COPYRIGHT HOLDER(S) OR AUTHOR(S) 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:
 * Rob Clark <robdclark@gmail.com>
 * Daniel Vetter <daniel.vetter@ffwll.ch>
 */

#ifndef DRM_ATOMIC_HELPER_H_
#define DRM_ATOMIC_HELPER_H_

#include <drm/drm_crtc.h>
#include <drm/drm_modeset_helper_vtables.h>
#include <drm/drm_modeset_helper.h>
#include <drm/drm_atomic_state_helper.h>
#include <drm/drm_util.h>

struct drm_atomic_state;
struct drm_private_obj;
struct drm_private_state;

int drm_atomic_helper_check_modeset(struct drm_device *dev,
				struct drm_atomic_state *state);
int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
					const struct drm_crtc_state *crtc_state,
					int min_scale,
					int max_scale,
					bool can_position,
					bool can_update_disabled);
int drm_atomic_helper_check_planes(struct drm_device *dev,
			       struct drm_atomic_state *state);
int drm_atomic_helper_check(struct drm_device *dev,
			    struct drm_atomic_state *state);
void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state);
int drm_atomic_helper_commit(struct drm_device *dev,
			     struct drm_atomic_state *state,
			     bool nonblock);
int drm_atomic_helper_async_check(struct drm_device *dev,
				  struct drm_atomic_state *state);
void drm_atomic_helper_async_commit(struct drm_device *dev,
				    struct drm_atomic_state *state);

int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
					struct drm_atomic_state *state,
					bool pre_swap);

void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
					struct drm_atomic_state *old_state);

void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
					  struct drm_atomic_state *old_state);

void
drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
					      struct drm_atomic_state *old_state);

void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
					       struct drm_atomic_state *state);
void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
					  struct drm_atomic_state *old_state);

int drm_atomic_helper_prepare_planes(struct drm_device *dev,
				     struct drm_atomic_state *state);

#define DRM_PLANE_COMMIT_ACTIVE_ONLY			BIT(0)
#define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET	BIT(1)

void drm_atomic_helper_commit_planes(struct drm_device *dev,
				     struct drm_atomic_state *state,
				     uint32_t flags);
void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
				      struct drm_atomic_state *old_state);
void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
void
drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
					 bool atomic);

int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state,
					      bool stall);

/* nonblocking commit helpers */
int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
				   bool nonblock);
void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state);
void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);

/* implementations for legacy interfaces */
int drm_atomic_helper_update_plane(struct drm_plane *plane,
				   struct drm_crtc *crtc,
				   struct drm_framebuffer *fb,
				   int crtc_x, int crtc_y,
				   unsigned int crtc_w, unsigned int crtc_h,
				   uint32_t src_x, uint32_t src_y,
				   uint32_t src_w, uint32_t src_h,
				   struct drm_modeset_acquire_ctx *ctx);
int drm_atomic_helper_disable_plane(struct drm_plane *plane,
				    struct drm_modeset_acquire_ctx *ctx);
int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
		struct drm_plane_state *plane_state);
int drm_atomic_helper_set_config(struct drm_mode_set *set,
				 struct drm_modeset_acquire_ctx *ctx);
int __drm_atomic_helper_set_config(struct drm_mode_set *set,
		struct drm_atomic_state *state);

int drm_atomic_helper_disable_all(struct drm_device *dev,
				  struct drm_modeset_acquire_ctx *ctx);
void drm_atomic_helper_shutdown(struct drm_device *dev);
struct drm_atomic_state *
drm_atomic_helper_duplicate_state(struct drm_device *dev,
				  struct drm_modeset_acquire_ctx *ctx);
struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
					      struct drm_modeset_acquire_ctx *ctx);
int drm_atomic_helper_resume(struct drm_device *dev,
			     struct drm_atomic_state *state);

int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
				struct drm_framebuffer *fb,
				struct drm_pending_vblank_event *event,
				uint32_t flags,
				struct drm_modeset_acquire_ctx *ctx);
int drm_atomic_helper_page_flip_target(
				struct drm_crtc *crtc,
				struct drm_framebuffer *fb,
				struct drm_pending_vblank_event *event,
				uint32_t flags,
				uint32_t target,
				struct drm_modeset_acquire_ctx *ctx);
int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
				       u16 *red, u16 *green, u16 *blue,
				       uint32_t size,
				       struct drm_modeset_acquire_ctx *ctx);

/**
 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
 * @plane: the loop cursor
 * @crtc:  the crtc whose planes are iterated
 *
 * This iterates over the current state, useful (for example) when applying
 * atomic state after it has been checked and swapped.  To iterate over the
 * planes which *will* be attached (more useful in code called from
 * &drm_mode_config_funcs.atomic_check) see
 * drm_atomic_crtc_state_for_each_plane().
 */
#define drm_atomic_crtc_for_each_plane(plane, crtc) \
	drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)

/**
 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
 * @plane: the loop cursor
 * @crtc_state: the incoming crtc-state
 *
 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
 * attached if the specified state is applied.  Useful during for example
 * in code called from &drm_mode_config_funcs.atomic_check operations, to
 * validate the incoming state.
 */
#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)

/**
 * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state
 * @plane: the loop cursor
 * @plane_state: loop cursor for the plane's state, must be const
 * @crtc_state: the incoming crtc-state
 *
 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
 * attached if the specified state is applied.  Useful during for example
 * in code called from &drm_mode_config_funcs.atomic_check operations, to
 * validate the incoming state.
 *
 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a
 * const plane_state. This is useful when a driver just wants to peek at other
 * active planes on this crtc, but does not need to change it.
 */
#define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \
	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
		for_each_if ((plane_state = \
			      __drm_atomic_get_current_plane_state((crtc_state)->state, \
								   plane)))

/**
 * drm_atomic_plane_disabling - check whether a plane is being disabled
 * @old_plane_state: old atomic plane state
 * @new_plane_state: new atomic plane state
 *
 * Checks the atomic state of a plane to determine whether it's being disabled
 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
 * need to either both be NULL or both be non-NULL).
 *
 * RETURNS:
 * True if the plane is being disabled, false otherwise.
 */
static inline bool
drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state,
			   struct drm_plane_state *new_plane_state)
{
	/*
	 * When disabling a plane, CRTC and FB should always be NULL together.
	 * Anything else should be considered a bug in the atomic core, so we
	 * gently warn about it.
	 */
	WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) ||
		(new_plane_state->crtc != NULL && new_plane_state->fb == NULL));

	return old_plane_state->crtc && !new_plane_state->crtc;
}

#endif /* DRM_ATOMIC_HELPER_H_ */
Commit	Line	Data
c2fcd274 DV	1	/*
	2	* Copyright (C) 2014 Red Hat
	3	* Copyright (C) 2014 Intel Corp.
	4	*
	5	* Permission is hereby granted, free of charge, to any person obtaining a
	6	* copy of this software and associated documentation files (the "Software"),
	7	* to deal in the Software without restriction, including without limitation
	8	* the rights to use, copy, modify, merge, publish, distribute, sublicense,
	9	* and/or sell copies of the Software, and to permit persons to whom the
	10	* Software is furnished to do so, subject to the following conditions:
	11	*
	12	* The above copyright notice and this permission notice shall be included in
	13	* all copies or substantial portions of the 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 COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
	19	* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
	20	* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	21	* OTHER DEALINGS IN THE SOFTWARE.
	22	*
	23	* Authors:
	24	* Rob Clark <robdclark@gmail.com>
	25	* Daniel Vetter <daniel.vetter@ffwll.ch>
	26	*/
	27
	28	#ifndef DRM_ATOMIC_HELPER_H_
	29	#define DRM_ATOMIC_HELPER_H_
	30
0254951d	31	#include <drm/drm_crtc.h>
1de72faf DV	32	#include <drm/drm_modeset_helper_vtables.h>
1de72faf DV	33	#include <drm/drm_modeset_helper.h>
9ef8a9dc	34	#include <drm/drm_atomic_state_helper.h>
d78aa650	35	#include <drm/drm_util.h>
0254951d	36
bbb1e524	37	struct drm_atomic_state;
a4370c77 VS	38	struct drm_private_obj;
a4370c77 VS	39	struct drm_private_state;
bbb1e524	40
d9b13620 DV	41	int drm_atomic_helper_check_modeset(struct drm_device *dev,
d9b13620 DV	42	struct drm_atomic_state *state);
a01cb8ba VS	43	int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
a01cb8ba VS	44	const struct drm_crtc_state *crtc_state,
a01cb8ba VS	45	int min_scale,
	46	int max_scale,
	47	bool can_position,
	48	bool can_update_disabled);
d9b13620 DV	49	int drm_atomic_helper_check_planes(struct drm_device *dev,
d9b13620 DV	50	struct drm_atomic_state *state);
c2fcd274 DV	51	int drm_atomic_helper_check(struct drm_device *dev,
c2fcd274 DV	52	struct drm_atomic_state *state);
9f2a7950	53	void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
81a099ac	54	void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state);
623369e5 DV	55	int drm_atomic_helper_commit(struct drm_device *dev,
623369e5 DV	56	struct drm_atomic_state *state,
286dbb8d	57	bool nonblock);
fef9df8b GP	58	int drm_atomic_helper_async_check(struct drm_device *dev,
	59	struct drm_atomic_state *state);
	60	void drm_atomic_helper_async_commit(struct drm_device *dev,
	61	struct drm_atomic_state *state);
623369e5	62
f6ce410a GP	63	int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
	64	struct drm_atomic_state *state,
	65	bool pre_swap);
c240906d	66
5ee3229c RC	67	void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
	68	struct drm_atomic_state *old_state);
	69
01086487 BB	70	void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
	71	struct drm_atomic_state *old_state);
	72
4c18d301 DV	73	void
	74	drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
	75	struct drm_atomic_state *old_state);
	76
1af434a9 DV	77	void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
	78	struct drm_atomic_state *state);
	79	void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
623369e5	80	struct drm_atomic_state *old_state);
c2fcd274 DV	81
	82	int drm_atomic_helper_prepare_planes(struct drm_device *dev,
	83	struct drm_atomic_state *state);
2b58e98d LY	84
	85	#define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0)
	86	#define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1)
	87
c2fcd274	88	void drm_atomic_helper_commit_planes(struct drm_device *dev,
aef9dbb8	89	struct drm_atomic_state *state,
2b58e98d	90	uint32_t flags);
c2fcd274 DV	91	void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
c2fcd274 DV	92	struct drm_atomic_state *old_state);
de28d021	93	void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
28500291 LY	94	void
	95	drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
	96	bool atomic);
c2fcd274	97
8a39374e ML	98	int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state,
8a39374e ML	99	bool stall);
c2fcd274	100
a095caa7 DV	101	/* nonblocking commit helpers */
	102	int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
	103	bool nonblock);
	104	void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
b25c60af	105	void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state);
a095caa7 DV	106	void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
	107	void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
	108
042652ed DV	109	/* implementations for legacy interfaces */
	110	int drm_atomic_helper_update_plane(struct drm_plane *plane,
	111	struct drm_crtc *crtc,
	112	struct drm_framebuffer *fb,
	113	int crtc_x, int crtc_y,
	114	unsigned int crtc_w, unsigned int crtc_h,
	115	uint32_t src_x, uint32_t src_y,
34a2ab5e DV	116	uint32_t src_w, uint32_t src_h,
34a2ab5e DV	117	struct drm_modeset_acquire_ctx *ctx);
19315294 DV	118	int drm_atomic_helper_disable_plane(struct drm_plane *plane,
19315294 DV	119	struct drm_modeset_acquire_ctx *ctx);
bbb1e524 RC	120	int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
bbb1e524 RC	121	struct drm_plane_state *plane_state);
a4eff9aa DV	122	int drm_atomic_helper_set_config(struct drm_mode_set *set,
a4eff9aa DV	123	struct drm_modeset_acquire_ctx *ctx);
bbb1e524 RC	124	int __drm_atomic_helper_set_config(struct drm_mode_set *set,
bbb1e524 RC	125	struct drm_atomic_state *state);
042652ed	126
14942760 TR	127	int drm_atomic_helper_disable_all(struct drm_device *dev,
14942760 TR	128	struct drm_modeset_acquire_ctx *ctx);
18dddadc	129	void drm_atomic_helper_shutdown(struct drm_device *dev);
1d8224e7 DV	130	struct drm_atomic_state *
	131	drm_atomic_helper_duplicate_state(struct drm_device *dev,
	132	struct drm_modeset_acquire_ctx *ctx);
14942760	133	struct drm_atomic_state drm_atomic_helper_suspend(struct drm_device dev);
581e49fe ML	134	int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
581e49fe ML	135	struct drm_modeset_acquire_ctx *ctx);
14942760 TR	136	int drm_atomic_helper_resume(struct drm_device *dev,
	137	struct drm_atomic_state *state);
	138
8bc0f312 DV	139	int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
	140	struct drm_framebuffer *fb,
	141	struct drm_pending_vblank_event *event,
41292b1f DV	142	uint32_t flags,
41292b1f DV	143	struct drm_modeset_acquire_ctx *ctx);
f869a6ec AG	144	int drm_atomic_helper_page_flip_target(
	145	struct drm_crtc *crtc,
	146	struct drm_framebuffer *fb,
	147	struct drm_pending_vblank_event *event,
	148	uint32_t flags,
41292b1f DV	149	uint32_t target,
41292b1f DV	150	struct drm_modeset_acquire_ctx *ctx);
1d8224e7 DV	151	int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
	152	u16 red, u16 green, u16 *blue,
	153	uint32_t size,
	154	struct drm_modeset_acquire_ctx *ctx);
8bc0f312	155
dd275956 RC	156	/**
	157	* drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
	158	* @plane: the loop cursor
	159	* @crtc: the crtc whose planes are iterated
	160	*
	161	* This iterates over the current state, useful (for example) when applying
	162	* atomic state after it has been checked and swapped. To iterate over the
6806cdf9 DV	163	* planes which will be attached (more useful in code called from
6806cdf9 DV	164	* &drm_mode_config_funcs.atomic_check) see
5c0be3f1	165	* drm_atomic_crtc_state_for_each_plane().
dd275956 RC	166	*/
	167	#define drm_atomic_crtc_for_each_plane(plane, crtc) \
	168	drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
	169
	170	/**
	171	* drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
	172	* @plane: the loop cursor
	173	* @crtc_state: the incoming crtc-state
	174	*
	175	* Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
6806cdf9 DV	176	* attached if the specified state is applied. Useful during for example
	177	* in code called from &drm_mode_config_funcs.atomic_check operations, to
	178	* validate the incoming state.
dd275956 RC	179	*/
	180	#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
	181	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
042652ed	182
2f196b7c DV	183	/**
	184	* drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state
	185	* @plane: the loop cursor
	186	* @plane_state: loop cursor for the plane's state, must be const
	187	* @crtc_state: the incoming crtc-state
	188	*
	189	* Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
6806cdf9 DV	190	* attached if the specified state is applied. Useful during for example
	191	* in code called from &drm_mode_config_funcs.atomic_check operations, to
	192	* validate the incoming state.
2f196b7c DV	193	*
	194	* Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a
	195	* const plane_state. This is useful when a driver just wants to peek at other
	196	* active planes on this crtc, but does not need to change it.
	197	*/
	198	#define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \
	199	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
	200	for_each_if ((plane_state = \
	201	__drm_atomic_get_current_plane_state((crtc_state)->state, \
	202	plane)))
	203
51ffa12d	204	/**
407b8bd9	205	* drm_atomic_plane_disabling - check whether a plane is being disabled
51ffa12d ML	206	* @old_plane_state: old atomic plane state
51ffa12d ML	207	* @new_plane_state: new atomic plane state
407b8bd9 TR	208	*
	209	* Checks the atomic state of a plane to determine whether it's being disabled
	210	* or not. This also WARNs if it detects an invalid state (both CRTC and FB
	211	* need to either both be NULL or both be non-NULL).
	212	*
	213	* RETURNS:
	214	* True if the plane is being disabled, false otherwise.
	215	*/
	216	static inline bool
51ffa12d ML	217	drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state,
51ffa12d ML	218	struct drm_plane_state *new_plane_state)
407b8bd9 TR	219	{
	220	/*
	221	* When disabling a plane, CRTC and FB should always be NULL together.
	222	* Anything else should be considered a bug in the atomic core, so we
	223	* gently warn about it.
	224	*/
51ffa12d ML	225	WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) \|\|
51ffa12d ML	226	(new_plane_state->crtc != NULL && new_plane_state->fb == NULL));
407b8bd9	227
51ffa12d	228	return old_plane_state->crtc && !new_plane_state->crtc;
407b8bd9 TR	229	}
407b8bd9 TR	230
c2fcd274	231	#endif /* DRM_ATOMIC_HELPER_H_ */