[mirror_ubuntu-bionic-kernel.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>

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_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);
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 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_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_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_crtc_set_property(struct drm_crtc *crtc,
					struct drm_property *property,
					uint64_t val);
int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
					struct drm_property *property,
					uint64_t val);
int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
					struct drm_property *property,
					uint64_t val);
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_connector_dpms(struct drm_connector *connector,
				     int mode);
struct drm_encoder *
drm_atomic_helper_best_encoder(struct drm_connector *connector);

/* default implementations for state handling */
void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
					      struct drm_crtc_state *state);
struct drm_crtc_state *
drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state);
void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
					  struct drm_crtc_state *state);

void drm_atomic_helper_plane_reset(struct drm_plane *plane);
void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
					       struct drm_plane_state *state);
struct drm_plane_state *
drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state);
void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
					  struct drm_plane_state *state);

void __drm_atomic_helper_connector_reset(struct drm_connector *connector,
					 struct drm_connector_state *conn_state);
void drm_atomic_helper_connector_reset(struct drm_connector *connector);
void
__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
					   struct drm_connector_state *state);
struct drm_connector_state *
drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
struct drm_atomic_state *
drm_atomic_helper_duplicate_state(struct drm_device *dev,
				  struct drm_modeset_acquire_ctx *ctx);
void
__drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state);
void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
					  struct drm_connector_state *state);
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);
void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj *obj,
						     struct drm_private_state *state);

/**
 * 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>
0254951d	34
bbb1e524	35	struct drm_atomic_state;
a4370c77 VS	36	struct drm_private_obj;
a4370c77 VS	37	struct drm_private_state;
bbb1e524	38
d9b13620 DV	39	int drm_atomic_helper_check_modeset(struct drm_device *dev,
	40	struct drm_atomic_state *state);
	41	int drm_atomic_helper_check_planes(struct drm_device *dev,
	42	struct drm_atomic_state *state);
c2fcd274 DV	43	int drm_atomic_helper_check(struct drm_device *dev,
c2fcd274 DV	44	struct drm_atomic_state *state);
9f2a7950	45	void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
623369e5 DV	46	int drm_atomic_helper_commit(struct drm_device *dev,
623369e5 DV	47	struct drm_atomic_state *state,
286dbb8d	48	bool nonblock);
fef9df8b GP	49	int drm_atomic_helper_async_check(struct drm_device *dev,
	50	struct drm_atomic_state *state);
	51	void drm_atomic_helper_async_commit(struct drm_device *dev,
	52	struct drm_atomic_state *state);
623369e5	53
f6ce410a GP	54	int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
	55	struct drm_atomic_state *state,
	56	bool pre_swap);
c240906d	57
5ee3229c RC	58	void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
	59	struct drm_atomic_state *old_state);
	60
01086487 BB	61	void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
	62	struct drm_atomic_state *old_state);
	63
4c18d301 DV	64	void
	65	drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
	66	struct drm_atomic_state *old_state);
	67
1af434a9 DV	68	void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
	69	struct drm_atomic_state *state);
	70	void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
623369e5	71	struct drm_atomic_state *old_state);
c2fcd274 DV	72
	73	int drm_atomic_helper_prepare_planes(struct drm_device *dev,
	74	struct drm_atomic_state *state);
2b58e98d LY	75
	76	#define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0)
	77	#define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1)
	78
c2fcd274	79	void drm_atomic_helper_commit_planes(struct drm_device *dev,
aef9dbb8	80	struct drm_atomic_state *state,
2b58e98d	81	uint32_t flags);
c2fcd274 DV	82	void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
c2fcd274 DV	83	struct drm_atomic_state *old_state);
de28d021	84	void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
28500291 LY	85	void
	86	drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
	87	bool atomic);
c2fcd274	88
c066d231	89	int drm_atomic_helper_swap_state(struct drm_atomic_state *state, bool stall);
c2fcd274	90
a095caa7 DV	91	/* nonblocking commit helpers */
	92	int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
	93	bool nonblock);
	94	void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
	95	void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
	96	void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
	97
042652ed DV	98	/* implementations for legacy interfaces */
	99	int drm_atomic_helper_update_plane(struct drm_plane *plane,
	100	struct drm_crtc *crtc,
	101	struct drm_framebuffer *fb,
	102	int crtc_x, int crtc_y,
	103	unsigned int crtc_w, unsigned int crtc_h,
	104	uint32_t src_x, uint32_t src_y,
34a2ab5e DV	105	uint32_t src_w, uint32_t src_h,
34a2ab5e DV	106	struct drm_modeset_acquire_ctx *ctx);
19315294 DV	107	int drm_atomic_helper_disable_plane(struct drm_plane *plane,
19315294 DV	108	struct drm_modeset_acquire_ctx *ctx);
bbb1e524 RC	109	int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
bbb1e524 RC	110	struct drm_plane_state *plane_state);
a4eff9aa DV	111	int drm_atomic_helper_set_config(struct drm_mode_set *set,
a4eff9aa DV	112	struct drm_modeset_acquire_ctx *ctx);
bbb1e524 RC	113	int __drm_atomic_helper_set_config(struct drm_mode_set *set,
bbb1e524 RC	114	struct drm_atomic_state *state);
042652ed	115
14942760 TR	116	int drm_atomic_helper_disable_all(struct drm_device *dev,
14942760 TR	117	struct drm_modeset_acquire_ctx *ctx);
18dddadc	118	void drm_atomic_helper_shutdown(struct drm_device *dev);
14942760	119	struct drm_atomic_state drm_atomic_helper_suspend(struct drm_device dev);
581e49fe ML	120	int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
581e49fe ML	121	struct drm_modeset_acquire_ctx *ctx);
14942760 TR	122	int drm_atomic_helper_resume(struct drm_device *dev,
	123	struct drm_atomic_state *state);
	124
042652ed DV	125	int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
	126	struct drm_property *property,
	127	uint64_t val);
	128	int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
	129	struct drm_property *property,
	130	uint64_t val);
	131	int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
	132	struct drm_property *property,
	133	uint64_t val);
8bc0f312 DV	134	int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
	135	struct drm_framebuffer *fb,
	136	struct drm_pending_vblank_event *event,
41292b1f DV	137	uint32_t flags,
41292b1f DV	138	struct drm_modeset_acquire_ctx *ctx);
f869a6ec AG	139	int drm_atomic_helper_page_flip_target(
	140	struct drm_crtc *crtc,
	141	struct drm_framebuffer *fb,
	142	struct drm_pending_vblank_event *event,
	143	uint32_t flags,
41292b1f DV	144	uint32_t target,
41292b1f DV	145	struct drm_modeset_acquire_ctx *ctx);
9a69a9ac ML	146	int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
9a69a9ac ML	147	int mode);
9ecb5498 NT	148	struct drm_encoder *
9ecb5498 NT	149	drm_atomic_helper_best_encoder(struct drm_connector *connector);
8bc0f312	150
d461701c DV	151	/* default implementations for state handling */
d461701c DV	152	void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
f5e7840b TR	153	void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
f5e7840b TR	154	struct drm_crtc_state *state);
d461701c DV	155	struct drm_crtc_state *
d461701c DV	156	drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
ec2dc6a0	157	void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state);
d461701c DV	158	void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
	159	struct drm_crtc_state *state);
	160
	161	void drm_atomic_helper_plane_reset(struct drm_plane *plane);
f5e7840b TR	162	void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
f5e7840b TR	163	struct drm_plane_state *state);
d461701c DV	164	struct drm_plane_state *
d461701c DV	165	drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
2f701695	166	void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state);
d461701c DV	167	void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
	168	struct drm_plane_state *state);
	169
4cd39917 ML	170	void __drm_atomic_helper_connector_reset(struct drm_connector *connector,
4cd39917 ML	171	struct drm_connector_state *conn_state);
d461701c	172	void drm_atomic_helper_connector_reset(struct drm_connector *connector);
f5e7840b TR	173	void
	174	__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
	175	struct drm_connector_state *state);
d461701c DV	176	struct drm_connector_state *
d461701c DV	177	drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
397fd77c TR	178	struct drm_atomic_state *
	179	drm_atomic_helper_duplicate_state(struct drm_device *dev,
	180	struct drm_modeset_acquire_ctx *ctx);
f5e7840b	181	void
fabd9106	182	__drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state);
d461701c DV	183	void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
d461701c DV	184	struct drm_connector_state *state);
7ea77283 ML	185	int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
7ea77283 ML	186	u16 red, u16 green, u16 *blue,
6d124ff8 DV	187	uint32_t size,
6d124ff8 DV	188	struct drm_modeset_acquire_ctx *ctx);
a4370c77 VS	189	void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj *obj,
a4370c77 VS	190	struct drm_private_state *state);
d461701c	191
dd275956 RC	192	/**
	193	* drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
	194	* @plane: the loop cursor
	195	* @crtc: the crtc whose planes are iterated
	196	*
	197	* This iterates over the current state, useful (for example) when applying
	198	* atomic state after it has been checked and swapped. To iterate over the
6806cdf9 DV	199	* planes which will be attached (more useful in code called from
6806cdf9 DV	200	* &drm_mode_config_funcs.atomic_check) see
5c0be3f1	201	* drm_atomic_crtc_state_for_each_plane().
dd275956 RC	202	*/
	203	#define drm_atomic_crtc_for_each_plane(plane, crtc) \
	204	drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
	205
	206	/**
	207	* drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
	208	* @plane: the loop cursor
	209	* @crtc_state: the incoming crtc-state
	210	*
	211	* Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
6806cdf9 DV	212	* attached if the specified state is applied. Useful during for example
	213	* in code called from &drm_mode_config_funcs.atomic_check operations, to
	214	* validate the incoming state.
dd275956 RC	215	*/
	216	#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
	217	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
042652ed	218
2f196b7c DV	219	/**
	220	* drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state
	221	* @plane: the loop cursor
	222	* @plane_state: loop cursor for the plane's state, must be const
	223	* @crtc_state: the incoming crtc-state
	224	*
	225	* Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
6806cdf9 DV	226	* attached if the specified state is applied. Useful during for example
	227	* in code called from &drm_mode_config_funcs.atomic_check operations, to
	228	* validate the incoming state.
2f196b7c DV	229	*
	230	* Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a
	231	* const plane_state. This is useful when a driver just wants to peek at other
	232	* active planes on this crtc, but does not need to change it.
	233	*/
	234	#define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \
	235	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
	236	for_each_if ((plane_state = \
	237	__drm_atomic_get_current_plane_state((crtc_state)->state, \
	238	plane)))
	239
51ffa12d	240	/**
407b8bd9	241	* drm_atomic_plane_disabling - check whether a plane is being disabled
51ffa12d ML	242	* @old_plane_state: old atomic plane state
51ffa12d ML	243	* @new_plane_state: new atomic plane state
407b8bd9 TR	244	*
	245	* Checks the atomic state of a plane to determine whether it's being disabled
	246	* or not. This also WARNs if it detects an invalid state (both CRTC and FB
	247	* need to either both be NULL or both be non-NULL).
	248	*
	249	* RETURNS:
	250	* True if the plane is being disabled, false otherwise.
	251	*/
	252	static inline bool
51ffa12d ML	253	drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state,
51ffa12d ML	254	struct drm_plane_state *new_plane_state)
407b8bd9 TR	255	{
	256	/*
	257	* When disabling a plane, CRTC and FB should always be NULL together.
	258	* Anything else should be considered a bug in the atomic core, so we
	259	* gently warn about it.
	260	*/
51ffa12d ML	261	WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) \|\|
51ffa12d ML	262	(new_plane_state->crtc != NULL && new_plane_state->fb == NULL));
407b8bd9	263
51ffa12d	264	return old_plane_state->crtc && !new_plane_state->crtc;
407b8bd9 TR	265	}
407b8bd9 TR	266
c2fcd274	267	#endif /* DRM_ATOMIC_HELPER_H_ */