[deliverable/linux.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_atomic_state * __must_check
drm_atomic_state_alloc(struct drm_device *dev);
void drm_atomic_state_clear(struct drm_atomic_state *state);
void drm_atomic_state_free(struct drm_atomic_state *state);

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->crtc_states[drm_crtc_index(crtc)];
}

/**
 * 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->plane_states[drm_plane_index(plane)];
}

/**
 * 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->connector_states[index];
}

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);
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);

int
drm_atomic_connectors_for_crtc(struct drm_atomic_state *state,
			       struct drm_crtc *crtc);

void drm_atomic_legacy_backoff(struct drm_atomic_state *state);

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_async_commit(struct drm_atomic_state *state);

#define for_each_connector_in_state(state, connector, connector_state, __i) \
	for ((__i) = 0;							\
	     (connector) = (state)->connectors[__i],			\
	     (connector_state) = (state)->connector_states[__i],	\
	     (__i) < (state)->num_connector;				\
	     (__i)++)							\
		if (connector)

#define for_each_crtc_in_state(state, crtc, crtc_state, __i)	\
	for ((__i) = 0;						\
	     (crtc) = (state)->crtcs[__i],			\
	     (crtc_state) = (state)->crtc_states[__i],		\
	     (__i) < (state)->dev->mode_config.num_crtc;	\
	     (__i)++)						\
		if (crtc_state)

#define for_each_plane_in_state(state, plane, plane_state, __i)	\
	for ((__i) = 0;						\
	     (plane) = (state)->planes[__i],			\
	     (plane_state) = (state)->plane_states[__i],	\
	     (__i) < (state)->dev->mode_config.num_total_plane;	\
	     (__i)++)						\
		if (plane_state)

#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
cc4ceb48 DV	33	struct drm_atomic_state * __must_check
	34	drm_atomic_state_alloc(struct drm_device *dev);
	35	void drm_atomic_state_clear(struct drm_atomic_state *state);
	36	void drm_atomic_state_free(struct drm_atomic_state *state);
036ef573 ML	37
	38	int __must_check
	39	drm_atomic_state_init(struct drm_device dev, struct drm_atomic_state state);
	40	void drm_atomic_state_default_clear(struct drm_atomic_state *state);
	41	void drm_atomic_state_default_release(struct drm_atomic_state *state);
cc4ceb48 DV	42
	43	struct drm_crtc_state * __must_check
	44	drm_atomic_get_crtc_state(struct drm_atomic_state *state,
	45	struct drm_crtc *crtc);
40ecc694 RC	46	int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
	47	struct drm_crtc_state state, struct drm_property property,
	48	uint64_t val);
cc4ceb48 DV	49	struct drm_plane_state * __must_check
	50	drm_atomic_get_plane_state(struct drm_atomic_state *state,
	51	struct drm_plane *plane);
40ecc694 RC	52	int drm_atomic_plane_set_property(struct drm_plane *plane,
	53	struct drm_plane_state state, struct drm_property property,
	54	uint64_t val);
cc4ceb48 DV	55	struct drm_connector_state * __must_check
	56	drm_atomic_get_connector_state(struct drm_atomic_state *state,
	57	struct drm_connector *connector);
40ecc694 RC	58	int drm_atomic_connector_set_property(struct drm_connector *connector,
	59	struct drm_connector_state state, struct drm_property property,
	60	uint64_t val);
88a48e29	61
1b26a5e1 ML	62	/**
	63	* drm_atomic_get_existing_crtc_state - get crtc state, if it exists
	64	* @state: global atomic state object
	65	* @crtc: crtc to grab
	66	*
	67	* This function returns the crtc state for the given crtc, or NULL
	68	* if the crtc is not part of the global atomic state.
	69	*/
	70	static inline struct drm_crtc_state *
	71	drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state,
	72	struct drm_crtc *crtc)
	73	{
	74	return state->crtc_states[drm_crtc_index(crtc)];
	75	}
	76
	77	/**
	78	* drm_atomic_get_existing_plane_state - get plane state, if it exists
	79	* @state: global atomic state object
	80	* @plane: plane to grab
	81	*
	82	* This function returns the plane state for the given plane, or NULL
	83	* if the plane is not part of the global atomic state.
	84	*/
	85	static inline struct drm_plane_state *
	86	drm_atomic_get_existing_plane_state(struct drm_atomic_state *state,
	87	struct drm_plane *plane)
	88	{
	89	return state->plane_states[drm_plane_index(plane)];
	90	}
	91
	92	/**
	93	* drm_atomic_get_existing_connector_state - get connector state, if it exists
	94	* @state: global atomic state object
	95	* @connector: connector to grab
	96	*
	97	* This function returns the connector state for the given connector,
	98	* or NULL if the connector is not part of the global atomic state.
	99	*/
	100	static inline struct drm_connector_state *
	101	drm_atomic_get_existing_connector_state(struct drm_atomic_state *state,
	102	struct drm_connector *connector)
	103	{
	104	int index = drm_connector_index(connector);
	105
	106	if (index >= state->num_connector)
	107	return NULL;
	108
	109	return state->connector_states[index];
	110	}
	111
cc4ceb48	112	int __must_check
07cc0ef6 DV	113	drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
07cc0ef6 DV	114	struct drm_crtc *crtc);
321ebf04 DV	115	void drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
321ebf04 DV	116	struct drm_framebuffer *fb);
cc4ceb48 DV	117	int __must_check
	118	drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
	119	struct drm_crtc *crtc);
	120	int __must_check
	121	drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
	122	struct drm_crtc *crtc);
e01e9f75 ML	123	int __must_check
	124	drm_atomic_add_affected_planes(struct drm_atomic_state *state,
	125	struct drm_crtc *crtc);
	126
cc4ceb48 DV	127	int
	128	drm_atomic_connectors_for_crtc(struct drm_atomic_state *state,
	129	struct drm_crtc *crtc);
	130
	131	void drm_atomic_legacy_backoff(struct drm_atomic_state *state);
	132
	133	int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
	134	int __must_check drm_atomic_commit(struct drm_atomic_state *state);
	135	int __must_check drm_atomic_async_commit(struct drm_atomic_state *state);
	136
df63b999 ACO	137	#define for_each_connector_in_state(state, connector, connector_state, __i) \
	138	for ((__i) = 0; \
	139	(connector) = (state)->connectors[__i], \
	140	(connector_state) = (state)->connector_states[__i], \
	141	(__i) < (state)->num_connector; \
	142	(__i)++) \
	143	if (connector)
	144
	145	#define for_each_crtc_in_state(state, crtc, crtc_state, __i) \
	146	for ((__i) = 0; \
	147	(crtc) = (state)->crtcs[__i], \
	148	(crtc_state) = (state)->crtc_states[__i], \
	149	(__i) < (state)->dev->mode_config.num_crtc; \
	150	(__i)++) \
	151	if (crtc_state)
	152
	153	#define for_each_plane_in_state(state, plane, plane_state, __i) \
	154	for ((__i) = 0; \
	155	(plane) = (state)->planes[__i], \
	156	(plane_state) = (state)->plane_states[__i], \
	157	(__i) < (state)->dev->mode_config.num_total_plane; \
	158	(__i)++) \
	159	if (plane_state)
	160
cc4ceb48	161	#endif /* DRM_ATOMIC_H_ */