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