[mirror_ubuntu-artful-kernel.git] / include / drm / drm_atomic.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_H_
#define DRM_ATOMIC_H_

#include <drm/drm_crtc.h>

/**
 * struct drm_crtc_commit - track modeset commits on a CRTC
 *
 * This structure is used to track pending modeset changes and atomic commit on
 * a per-CRTC basis. Since updating the list should never block this structure
 * is reference counted to allow waiters to safely wait on an event to complete,
 * without holding any locks.
 *
 * It has 3 different events in total to allow a fine-grained synchronization
 * between outstanding updates::
 *
 *	atomic commit thread			hardware
 *
 * 	write new state into hardware	---->	...
 * 	signal hw_done
 * 						switch to new state on next
 * 	...					v/hblank
 *
 *	wait for buffers to show up		...
 *
 *	...					send completion irq
 *						irq handler signals flip_done
 *	cleanup old buffers
 *
 * 	signal cleanup_done
 *
 * 	wait for flip_done		<----
 * 	clean up atomic state
 *
 * The important bit to know is that cleanup_done is the terminal event, but the
 * ordering between flip_done and hw_done is entirely up to the specific driver
 * and modeset state change.
 *
 * For an implementation of how to use this look at
 * drm_atomic_helper_setup_commit() from the atomic helper library.
 */
struct drm_crtc_commit {
	/**
	 * @crtc:
	 *
	 * DRM CRTC for this commit.
	 */
	struct drm_crtc *crtc;

	/**
	 * @ref:
	 *
	 * Reference count for this structure. Needed to allow blocking on
	 * completions without the risk of the completion disappearing
	 * meanwhile.
	 */
	struct kref ref;

	/**
	 * @flip_done:
	 *
	 * Will be signaled when the hardware has flipped to the new set of
	 * buffers. Signals at the same time as when the drm event for this
	 * commit is sent to userspace, or when an out-fence is singalled. Note
	 * that for most hardware, in most cases this happens after @hw_done is
	 * signalled.
	 */
	struct completion flip_done;

	/**
	 * @hw_done:
	 *
	 * Will be signalled when all hw register changes for this commit have
	 * been written out. Especially when disabling a pipe this can be much
	 * later than than @flip_done, since that can signal already when the
	 * screen goes black, whereas to fully shut down a pipe more register
	 * I/O is required.
	 *
	 * Note that this does not need to include separately reference-counted
	 * resources like backing storage buffer pinning, or runtime pm
	 * management.
	 */
	struct completion hw_done;

	/**
	 * @cleanup_done:
	 *
	 * Will be signalled after old buffers have been cleaned up by calling
	 * drm_atomic_helper_cleanup_planes(). Since this can only happen after
	 * a vblank wait completed it might be a bit later. This completion is
	 * useful to throttle updates and avoid hardware updates getting ahead
	 * of the buffer cleanup too much.
	 */
	struct completion cleanup_done;

	/**
	 * @commit_entry:
	 *
	 * Entry on the per-CRTC &drm_crtc.commit_list. Protected by
	 * $drm_crtc.commit_lock.
	 */
	struct list_head commit_entry;

	/**
	 * @event:
	 *
	 * &drm_pending_vblank_event pointer to clean up private events.
	 */
	struct drm_pending_vblank_event *event;
};

struct __drm_planes_state {
	struct drm_plane *ptr;
	struct drm_plane_state *state;
};

struct __drm_crtcs_state {
	struct drm_crtc *ptr;
	struct drm_crtc_state *state;
	struct drm_crtc_commit *commit;
	s32 __user *out_fence_ptr;
	unsigned last_vblank_count;
};

struct __drm_connnectors_state {
	struct drm_connector *ptr;
	struct drm_connector_state *state;
};

/**
 * struct drm_atomic_state - the global state object for atomic updates
 * @ref: count of all references to this state (will not be freed until zero)
 * @dev: parent DRM device
 * @allow_modeset: allow full modeset
 * @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics
 * @legacy_set_config: Disable conflicting encoders instead of failing with -EINVAL.
 * @planes: pointer to array of structures with per-plane data
 * @crtcs: pointer to array of CRTC pointers
 * @num_connector: size of the @connectors and @connector_states arrays
 * @connectors: pointer to array of structures with per-connector data
 * @acquire_ctx: acquire context for this atomic modeset state update
 */
struct drm_atomic_state {
	struct kref ref;

	struct drm_device *dev;
	bool allow_modeset : 1;
	bool legacy_cursor_update : 1;
	bool legacy_set_config : 1;
	struct __drm_planes_state *planes;
	struct __drm_crtcs_state *crtcs;
	int num_connector;
	struct __drm_connnectors_state *connectors;

	struct drm_modeset_acquire_ctx *acquire_ctx;

	/**
	 * @commit_work:
	 *
	 * Work item which can be used by the driver or helpers to execute the
	 * commit without blocking.
	 */
	struct work_struct commit_work;
};

void __drm_crtc_commit_free(struct kref *kref);

/**
 * drm_crtc_commit_get - acquire a reference to the CRTC commit
 * @commit: CRTC commit
 *
 * Increases the reference of @commit.
 */
static inline void drm_crtc_commit_get(struct drm_crtc_commit *commit)
{
	kref_get(&commit->ref);
}

/**
 * drm_crtc_commit_put - release a reference to the CRTC commmit
 * @commit: CRTC commit
 *
 * This releases a reference to @commit which is freed after removing the
 * final reference. No locking required and callable from any context.
 */
static inline void drm_crtc_commit_put(struct drm_crtc_commit *commit)
{
	kref_put(&commit->ref, __drm_crtc_commit_free);
}

struct drm_atomic_state * __must_check
drm_atomic_state_alloc(struct drm_device *dev);
void drm_atomic_state_clear(struct drm_atomic_state *state);

/**
 * drm_atomic_state_get - acquire a reference to the atomic state
 * @state: The atomic state
 *
 * Returns a new reference to the @state
 */
static inline struct drm_atomic_state *
drm_atomic_state_get(struct drm_atomic_state *state)
{
	kref_get(&state->ref);
	return state;
}

void __drm_atomic_state_free(struct kref *ref);

/**
 * drm_atomic_state_put - release a reference to the atomic state
 * @state: The atomic state
 *
 * This releases a reference to @state which is freed after removing the
 * final reference. No locking required and callable from any context.
 */
static inline void drm_atomic_state_put(struct drm_atomic_state *state)
{
	kref_put(&state->ref, __drm_atomic_state_free);
}

int  __must_check
drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state);
void drm_atomic_state_default_clear(struct drm_atomic_state *state);
void drm_atomic_state_default_release(struct drm_atomic_state *state);

struct drm_crtc_state * __must_check
drm_atomic_get_crtc_state(struct drm_atomic_state *state,
			  struct drm_crtc *crtc);
int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
		struct drm_crtc_state *state, struct drm_property *property,
		uint64_t val);
struct drm_plane_state * __must_check
drm_atomic_get_plane_state(struct drm_atomic_state *state,
			   struct drm_plane *plane);
int drm_atomic_plane_set_property(struct drm_plane *plane,
		struct drm_plane_state *state, struct drm_property *property,
		uint64_t val);
struct drm_connector_state * __must_check
drm_atomic_get_connector_state(struct drm_atomic_state *state,
			       struct drm_connector *connector);
int drm_atomic_connector_set_property(struct drm_connector *connector,
		struct drm_connector_state *state, struct drm_property *property,
		uint64_t val);

/**
 * drm_atomic_get_existing_crtc_state - get crtc state, if it exists
 * @state: global atomic state object
 * @crtc: crtc to grab
 *
 * This function returns the crtc state for the given crtc, or NULL
 * if the crtc is not part of the global atomic state.
 */
static inline struct drm_crtc_state *
drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state,
				   struct drm_crtc *crtc)
{
	return state->crtcs[drm_crtc_index(crtc)].state;
}

/**
 * drm_atomic_get_existing_plane_state - get plane state, if it exists
 * @state: global atomic state object
 * @plane: plane to grab
 *
 * This function returns the plane state for the given plane, or NULL
 * if the plane is not part of the global atomic state.
 */
static inline struct drm_plane_state *
drm_atomic_get_existing_plane_state(struct drm_atomic_state *state,
				    struct drm_plane *plane)
{
	return state->planes[drm_plane_index(plane)].state;
}

/**
 * drm_atomic_get_existing_connector_state - get connector state, if it exists
 * @state: global atomic state object
 * @connector: connector to grab
 *
 * This function returns the connector state for the given connector,
 * or NULL if the connector is not part of the global atomic state.
 */
static inline struct drm_connector_state *
drm_atomic_get_existing_connector_state(struct drm_atomic_state *state,
					struct drm_connector *connector)
{
	int index = drm_connector_index(connector);

	if (index >= state->num_connector)
		return NULL;

	return state->connectors[index].state;
}

/**
 * __drm_atomic_get_current_plane_state - get current plane state
 * @state: global atomic state object
 * @plane: plane to grab
 *
 * This function returns the plane state for the given plane, either from
 * @state, or if the plane isn't part of the atomic state update, from @plane.
 * This is useful in atomic check callbacks, when drivers need to peek at, but
 * not change, state of other planes, since it avoids threading an error code
 * back up the call chain.
 *
 * WARNING:
 *
 * Note that this function is in general unsafe since it doesn't check for the
 * required locking for access state structures. Drivers must ensure that it is
 * safe to access the returned state structure through other means. One common
 * example is when planes are fixed to a single CRTC, and the driver knows that
 * the CRTC lock is held already. In that case holding the CRTC lock gives a
 * read-lock on all planes connected to that CRTC. But if planes can be
 * reassigned things get more tricky. In that case it's better to use
 * drm_atomic_get_plane_state and wire up full error handling.
 *
 * Returns:
 *
 * Read-only pointer to the current plane state.
 */
static inline const struct drm_plane_state *
__drm_atomic_get_current_plane_state(struct drm_atomic_state *state,
				     struct drm_plane *plane)
{
	if (state->planes[drm_plane_index(plane)].state)
		return state->planes[drm_plane_index(plane)].state;

	return plane->state;
}

int __must_check
drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
			     struct drm_display_mode *mode);
int __must_check
drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
				  struct drm_property_blob *blob);
int __must_check
drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
			      struct drm_crtc *crtc);
void drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
				 struct drm_framebuffer *fb);
void drm_atomic_set_fence_for_plane(struct drm_plane_state *plane_state,
				    struct dma_fence *fence);
int __must_check
drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
				  struct drm_crtc *crtc);
int __must_check
drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
				   struct drm_crtc *crtc);
int __must_check
drm_atomic_add_affected_planes(struct drm_atomic_state *state,
			       struct drm_crtc *crtc);

void drm_atomic_legacy_backoff(struct drm_atomic_state *state);

void
drm_atomic_clean_old_fb(struct drm_device *dev, unsigned plane_mask, int ret);

int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
int __must_check drm_atomic_commit(struct drm_atomic_state *state);
int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state);

void drm_state_dump(struct drm_device *dev, struct drm_printer *p);

#define for_each_connector_in_state(__state, connector, connector_state, __i) \
	for ((__i) = 0;							\
	     (__i) < (__state)->num_connector &&				\
	     ((connector) = (__state)->connectors[__i].ptr,			\
	     (connector_state) = (__state)->connectors[__i].state, 1); 	\
	     (__i)++)							\
		for_each_if (connector)

#define for_each_crtc_in_state(__state, crtc, crtc_state, __i)	\
	for ((__i) = 0;						\
	     (__i) < (__state)->dev->mode_config.num_crtc &&	\
	     ((crtc) = (__state)->crtcs[__i].ptr,			\
	     (crtc_state) = (__state)->crtcs[__i].state, 1);	\
	     (__i)++)						\
		for_each_if (crtc_state)

#define for_each_plane_in_state(__state, plane, plane_state, __i)		\
	for ((__i) = 0;							\
	     (__i) < (__state)->dev->mode_config.num_total_plane &&	\
	     ((plane) = (__state)->planes[__i].ptr,				\
	     (plane_state) = (__state)->planes[__i].state, 1);		\
	     (__i)++)							\
		for_each_if (plane_state)

/**
 * drm_atomic_crtc_needs_modeset - compute combined modeset need
 * @state: &drm_crtc_state for the CRTC
 *
 * To give drivers flexibility &struct drm_crtc_state has 3 booleans to track
 * whether the state CRTC changed enough to need a full modeset cycle:
 * connectors_changed, mode_changed and active_changed. This helper simply
 * combines these three to compute the overall need for a modeset for @state.
 *
 * The atomic helper code sets these booleans, but drivers can and should
 * change them appropriately to accurately represent whether a modeset is
 * really needed. In general, drivers should avoid full modesets whenever
 * possible.
 *
 * For example if the CRTC mode has changed, and the hardware is able to enact
 * the requested mode change without going through a full modeset, the driver
 * should clear mode_changed in its &drm_mode_config_funcs.atomic_check
 * implementation.
 */
static inline bool
drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state)
{
	return state->mode_changed || state->active_changed ||
	       state->connectors_changed;
}

#endif /* DRM_ATOMIC_H_ */
Commit	Line	Data
cc4ceb48 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_H_
	29	#define DRM_ATOMIC_H_
	30
37cc0148 TR	31	#include <drm/drm_crtc.h>
37cc0148 TR	32
43968d7b DV	33	/**
	34	* struct drm_crtc_commit - track modeset commits on a CRTC
	35	*
	36	* This structure is used to track pending modeset changes and atomic commit on
	37	* a per-CRTC basis. Since updating the list should never block this structure
	38	* is reference counted to allow waiters to safely wait on an event to complete,
	39	* without holding any locks.
	40	*
	41	* It has 3 different events in total to allow a fine-grained synchronization
	42	* between outstanding updates::
	43	*
	44	* atomic commit thread hardware
	45	*
	46	* write new state into hardware ----> ...
	47	* signal hw_done
	48	* switch to new state on next
	49	* ... v/hblank
	50	*
	51	* wait for buffers to show up ...
	52	*
	53	* ... send completion irq
	54	* irq handler signals flip_done
	55	* cleanup old buffers
	56	*
	57	* signal cleanup_done
	58	*
	59	* wait for flip_done <----
	60	* clean up atomic state
	61	*
	62	* The important bit to know is that cleanup_done is the terminal event, but the
	63	* ordering between flip_done and hw_done is entirely up to the specific driver
	64	* and modeset state change.
	65	*
	66	* For an implementation of how to use this look at
	67	* drm_atomic_helper_setup_commit() from the atomic helper library.
	68	*/
	69	struct drm_crtc_commit {
	70	/**
	71	* @crtc:
	72	*
	73	* DRM CRTC for this commit.
	74	*/
	75	struct drm_crtc *crtc;
	76
	77	/**
	78	* @ref:
	79	*
	80	* Reference count for this structure. Needed to allow blocking on
	81	* completions without the risk of the completion disappearing
	82	* meanwhile.
	83	*/
	84	struct kref ref;
	85
	86	/**
	87	* @flip_done:
	88	*
	89	* Will be signaled when the hardware has flipped to the new set of
	90	* buffers. Signals at the same time as when the drm event for this
	91	* commit is sent to userspace, or when an out-fence is singalled. Note
	92	* that for most hardware, in most cases this happens after @hw_done is
	93	* signalled.
	94	*/
	95	struct completion flip_done;
	96
97	/**
98	* @hw_done:
99	*
100	* Will be signalled when all hw register changes for this commit have
101	* been written out. Especially when disabling a pipe this can be much
102	* later than than @flip_done, since that can signal already when the
103	* screen goes black, whereas to fully shut down a pipe more register
104	* I/O is required.
105	*
106	* Note that this does not need to include separately reference-counted
107	* resources like backing storage buffer pinning, or runtime pm
108	* management.
109	*/
110	struct completion hw_done;
111
112	/**
113	* @cleanup_done:
114	*
115	* Will be signalled after old buffers have been cleaned up by calling
116	* drm_atomic_helper_cleanup_planes(). Since this can only happen after
117	* a vblank wait completed it might be a bit later. This completion is
118	* useful to throttle updates and avoid hardware updates getting ahead
119	* of the buffer cleanup too much.
120	*/
121	struct completion cleanup_done;
122
123	/**
124	* @commit_entry:
125	*
d574528a DV	126	* Entry on the per-CRTC &drm_crtc.commit_list. Protected by
d574528a DV	127	* $drm_crtc.commit_lock.
43968d7b DV	128	*/
	129	struct list_head commit_entry;
	130
	131	/**
	132	* @event:
	133	*
	134	* &drm_pending_vblank_event pointer to clean up private events.
	135	*/
	136	struct drm_pending_vblank_event *event;
	137	};
	138
	139	struct __drm_planes_state {
	140	struct drm_plane *ptr;
	141	struct drm_plane_state *state;
	142	};
	143
	144	struct __drm_crtcs_state {
	145	struct drm_crtc *ptr;
	146	struct drm_crtc_state *state;
	147	struct drm_crtc_commit *commit;
7e9081c5	148	s32 __user *out_fence_ptr;
bdc57146	149	unsigned last_vblank_count;
43968d7b DV	150	};
	151
	152	struct __drm_connnectors_state {
	153	struct drm_connector *ptr;
	154	struct drm_connector_state *state;
	155	};
	156
	157	/**
	158	* struct drm_atomic_state - the global state object for atomic updates
0853695c	159	* @ref: count of all references to this state (will not be freed until zero)
43968d7b DV	160	* @dev: parent DRM device
	161	* @allow_modeset: allow full modeset
	162	* @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics
	163	* @legacy_set_config: Disable conflicting encoders instead of failing with -EINVAL.
	164	* @planes: pointer to array of structures with per-plane data
	165	* @crtcs: pointer to array of CRTC pointers
	166	* @num_connector: size of the @connectors and @connector_states arrays
	167	* @connectors: pointer to array of structures with per-connector data
	168	* @acquire_ctx: acquire context for this atomic modeset state update
	169	*/
	170	struct drm_atomic_state {
0853695c CW	171	struct kref ref;
0853695c CW	172
43968d7b DV	173	struct drm_device *dev;
	174	bool allow_modeset : 1;
	175	bool legacy_cursor_update : 1;
	176	bool legacy_set_config : 1;
	177	struct __drm_planes_state *planes;
	178	struct __drm_crtcs_state *crtcs;
	179	int num_connector;
	180	struct __drm_connnectors_state *connectors;
	181
	182	struct drm_modeset_acquire_ctx *acquire_ctx;
	183
	184	/**
	185	* @commit_work:
	186	*
	187	* Work item which can be used by the driver or helpers to execute the
	188	* commit without blocking.
	189	*/
	190	struct work_struct commit_work;
	191	};
	192
b3ba3f6f DV	193	void __drm_crtc_commit_free(struct kref *kref);
	194
	195	/**
	196	* drm_crtc_commit_get - acquire a reference to the CRTC commit
	197	* @commit: CRTC commit
	198	*
	199	* Increases the reference of @commit.
	200	*/
3b24f7d6 DV	201	static inline void drm_crtc_commit_get(struct drm_crtc_commit *commit)
	202	{
	203	kref_get(&commit->ref);
	204	}
	205
b3ba3f6f DV	206	/**
	207	* drm_crtc_commit_put - release a reference to the CRTC commmit
	208	* @commit: CRTC commit
	209	*
	210	* This releases a reference to @commit which is freed after removing the
	211	* final reference. No locking required and callable from any context.
	212	*/
	213	static inline void drm_crtc_commit_put(struct drm_crtc_commit *commit)
	214	{
	215	kref_put(&commit->ref, __drm_crtc_commit_free);
	216	}
	217
cc4ceb48 DV	218	struct drm_atomic_state * __must_check
	219	drm_atomic_state_alloc(struct drm_device *dev);
	220	void drm_atomic_state_clear(struct drm_atomic_state *state);
0853695c CW	221
	222	/**
	223	* drm_atomic_state_get - acquire a reference to the atomic state
	224	* @state: The atomic state
	225	*
	226	* Returns a new reference to the @state
	227	*/
	228	static inline struct drm_atomic_state *
	229	drm_atomic_state_get(struct drm_atomic_state *state)
	230	{
	231	kref_get(&state->ref);
	232	return state;
	233	}
	234
	235	void __drm_atomic_state_free(struct kref *ref);
	236
	237	/**
	238	* drm_atomic_state_put - release a reference to the atomic state
	239	* @state: The atomic state
	240	*
	241	* This releases a reference to @state which is freed after removing the
	242	* final reference. No locking required and callable from any context.
	243	*/
	244	static inline void drm_atomic_state_put(struct drm_atomic_state *state)
	245	{
	246	kref_put(&state->ref, __drm_atomic_state_free);
	247	}
036ef573 ML	248
	249	int __must_check
	250	drm_atomic_state_init(struct drm_device dev, struct drm_atomic_state state);
	251	void drm_atomic_state_default_clear(struct drm_atomic_state *state);
	252	void drm_atomic_state_default_release(struct drm_atomic_state *state);
cc4ceb48 DV	253
	254	struct drm_crtc_state * __must_check
	255	drm_atomic_get_crtc_state(struct drm_atomic_state *state,
	256	struct drm_crtc *crtc);
40ecc694 RC	257	int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
	258	struct drm_crtc_state state, struct drm_property property,
	259	uint64_t val);
cc4ceb48 DV	260	struct drm_plane_state * __must_check
	261	drm_atomic_get_plane_state(struct drm_atomic_state *state,
	262	struct drm_plane *plane);
40ecc694 RC	263	int drm_atomic_plane_set_property(struct drm_plane *plane,
	264	struct drm_plane_state state, struct drm_property property,
	265	uint64_t val);
cc4ceb48 DV	266	struct drm_connector_state * __must_check
	267	drm_atomic_get_connector_state(struct drm_atomic_state *state,
	268	struct drm_connector *connector);
40ecc694 RC	269	int drm_atomic_connector_set_property(struct drm_connector *connector,
	270	struct drm_connector_state state, struct drm_property property,
	271	uint64_t val);
88a48e29	272
1b26a5e1 ML	273	/**
	274	* drm_atomic_get_existing_crtc_state - get crtc state, if it exists
	275	* @state: global atomic state object
	276	* @crtc: crtc to grab
	277	*
	278	* This function returns the crtc state for the given crtc, or NULL
	279	* if the crtc is not part of the global atomic state.
	280	*/
	281	static inline struct drm_crtc_state *
	282	drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state,
	283	struct drm_crtc *crtc)
	284	{
5d943aa6	285	return state->crtcs[drm_crtc_index(crtc)].state;
1b26a5e1 ML	286	}
	287
	288	/**
	289	* drm_atomic_get_existing_plane_state - get plane state, if it exists
	290	* @state: global atomic state object
	291	* @plane: plane to grab
	292	*
	293	* This function returns the plane state for the given plane, or NULL
	294	* if the plane is not part of the global atomic state.
	295	*/
	296	static inline struct drm_plane_state *
	297	drm_atomic_get_existing_plane_state(struct drm_atomic_state *state,
	298	struct drm_plane *plane)
	299	{
b8b5342b	300	return state->planes[drm_plane_index(plane)].state;
1b26a5e1 ML	301	}
	302
	303	/**
	304	* drm_atomic_get_existing_connector_state - get connector state, if it exists
	305	* @state: global atomic state object
	306	* @connector: connector to grab
	307	*
	308	* This function returns the connector state for the given connector,
	309	* or NULL if the connector is not part of the global atomic state.
	310	*/
	311	static inline struct drm_connector_state *
	312	drm_atomic_get_existing_connector_state(struct drm_atomic_state *state,
	313	struct drm_connector *connector)
	314	{
	315	int index = drm_connector_index(connector);
	316
	317	if (index >= state->num_connector)
	318	return NULL;
	319
63e83c1d	320	return state->connectors[index].state;
1b26a5e1 ML	321	}
1b26a5e1 ML	322
2f196b7c DV	323	/**
	324	* __drm_atomic_get_current_plane_state - get current plane state
	325	* @state: global atomic state object
	326	* @plane: plane to grab
	327	*
	328	* This function returns the plane state for the given plane, either from
	329	* @state, or if the plane isn't part of the atomic state update, from @plane.
	330	* This is useful in atomic check callbacks, when drivers need to peek at, but
	331	* not change, state of other planes, since it avoids threading an error code
	332	* back up the call chain.
	333	*
	334	* WARNING:
	335	*
	336	* Note that this function is in general unsafe since it doesn't check for the
	337	* required locking for access state structures. Drivers must ensure that it is
60c9e190	338	* safe to access the returned state structure through other means. One common
2f196b7c	339	* example is when planes are fixed to a single CRTC, and the driver knows that
60c9e190	340	* the CRTC lock is held already. In that case holding the CRTC lock gives a
2f196b7c DV	341	* read-lock on all planes connected to that CRTC. But if planes can be
	342	* reassigned things get more tricky. In that case it's better to use
	343	* drm_atomic_get_plane_state and wire up full error handling.
	344	*
	345	* Returns:
	346	*
	347	* Read-only pointer to the current plane state.
	348	*/
	349	static inline const struct drm_plane_state *
	350	__drm_atomic_get_current_plane_state(struct drm_atomic_state *state,
	351	struct drm_plane *plane)
	352	{
b8b5342b DV	353	if (state->planes[drm_plane_index(plane)].state)
b8b5342b DV	354	return state->planes[drm_plane_index(plane)].state;
2f196b7c DV	355
	356	return plane->state;
	357	}
	358
819364da DS	359	int __must_check
	360	drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
	361	struct drm_display_mode *mode);
cc4ceb48	362	int __must_check
955f3c33 DS	363	drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
	364	struct drm_property_blob *blob);
	365	int __must_check
07cc0ef6 DV	366	drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
07cc0ef6 DV	367	struct drm_crtc *crtc);
321ebf04 DV	368	void drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
321ebf04 DV	369	struct drm_framebuffer *fb);
13b55664 GP	370	void drm_atomic_set_fence_for_plane(struct drm_plane_state *plane_state,
13b55664 GP	371	struct dma_fence *fence);
cc4ceb48 DV	372	int __must_check
	373	drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
	374	struct drm_crtc *crtc);
	375	int __must_check
	376	drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
	377	struct drm_crtc *crtc);
e01e9f75 ML	378	int __must_check
	379	drm_atomic_add_affected_planes(struct drm_atomic_state *state,
	380	struct drm_crtc *crtc);
	381
cc4ceb48 DV	382	void drm_atomic_legacy_backoff(struct drm_atomic_state *state);
cc4ceb48 DV	383
0f45c26f ML	384	void
	385	drm_atomic_clean_old_fb(struct drm_device *dev, unsigned plane_mask, int ret);
	386
cc4ceb48 DV	387	int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
cc4ceb48 DV	388	int __must_check drm_atomic_commit(struct drm_atomic_state *state);
b837ba0a	389	int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state);
cc4ceb48	390
6559c901 RC	391	void drm_state_dump(struct drm_device dev, struct drm_printer p);
6559c901 RC	392
63e83c1d	393	#define for_each_connector_in_state(__state, connector, connector_state, __i) \
df63b999	394	for ((__i) = 0; \
63e83c1d DV	395	(__i) < (__state)->num_connector && \
	396	((connector) = (__state)->connectors[__i].ptr, \
	397	(connector_state) = (__state)->connectors[__i].state, 1); \
df63b999	398	(__i)++) \
373701b1	399	for_each_if (connector)
df63b999	400
5d943aa6	401	#define for_each_crtc_in_state(__state, crtc, crtc_state, __i) \
df63b999	402	for ((__i) = 0; \
5d943aa6 DV	403	(__i) < (__state)->dev->mode_config.num_crtc && \
	404	((crtc) = (__state)->crtcs[__i].ptr, \
	405	(crtc_state) = (__state)->crtcs[__i].state, 1); \
df63b999	406	(__i)++) \
373701b1	407	for_each_if (crtc_state)
df63b999	408
b8b5342b	409	#define for_each_plane_in_state(__state, plane, plane_state, __i) \
60f207a5	410	for ((__i) = 0; \
b8b5342b DV	411	(__i) < (__state)->dev->mode_config.num_total_plane && \
	412	((plane) = (__state)->planes[__i].ptr, \
	413	(plane_state) = (__state)->planes[__i].state, 1); \
60f207a5	414	(__i)++) \
373701b1	415	for_each_if (plane_state)
081e9c0f DV	416
	417	/**
	418	* drm_atomic_crtc_needs_modeset - compute combined modeset need
	419	* @state: &drm_crtc_state for the CRTC
	420	*
ea0dd85a	421	* To give drivers flexibility &struct drm_crtc_state has 3 booleans to track
081e9c0f	422	* whether the state CRTC changed enough to need a full modeset cycle:
d807ed1c	423	* connectors_changed, mode_changed and active_changed. This helper simply
081e9c0f	424	* combines these three to compute the overall need for a modeset for @state.
d807ed1c BS	425	*
	426	* The atomic helper code sets these booleans, but drivers can and should
	427	* change them appropriately to accurately represent whether a modeset is
	428	* really needed. In general, drivers should avoid full modesets whenever
	429	* possible.
	430	*
	431	* For example if the CRTC mode has changed, and the hardware is able to enact
	432	* the requested mode change without going through a full modeset, the driver
d574528a DV	433	* should clear mode_changed in its &drm_mode_config_funcs.atomic_check
d574528a DV	434	* implementation.
081e9c0f	435	*/
2465ff62	436	static inline bool
79b95552	437	drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state)
2465ff62	438	{
fc596660 ML	439	return state->mode_changed \|\| state->active_changed \|\|
fc596660 ML	440	state->connectors_changed;
2465ff62 DV	441	}
2465ff62 DV	442
cc4ceb48	443	#endif /* DRM_ATOMIC_H_ */