[deliverable/linux.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>

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);
int drm_atomic_helper_commit(struct drm_device *dev,
			     struct drm_atomic_state *state,
			     bool async);

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

void drm_atomic_helper_commit_pre_planes(struct drm_device *dev,
					 struct drm_atomic_state *state);
void drm_atomic_helper_commit_post_planes(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);
void drm_atomic_helper_commit_planes(struct drm_device *dev,
				     struct drm_atomic_state *state);
void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
				      struct drm_atomic_state *old_state);

void drm_atomic_helper_swap_state(struct drm_device *dev,
				  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);
int drm_atomic_helper_disable_plane(struct drm_plane *plane);
int drm_atomic_helper_set_config(struct drm_mode_set *set);

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

/* default implementations for state handling */
void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
struct drm_crtc_state *
drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
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);
struct drm_plane_state *
drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
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 *
drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
					  struct drm_connector_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 (for ->atomic_check()) see
 * drm_crtc_for_each_pending_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)
 * ->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)

#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 TR	31	#include <drm/drm_crtc.h>
0254951d TR	32
d9b13620 DV	33	int drm_atomic_helper_check_modeset(struct drm_device *dev,
	34	struct drm_atomic_state *state);
	35	int drm_atomic_helper_check_planes(struct drm_device *dev,
	36	struct drm_atomic_state *state);
c2fcd274 DV	37	int drm_atomic_helper_check(struct drm_device *dev,
c2fcd274 DV	38	struct drm_atomic_state *state);
623369e5 DV	39	int drm_atomic_helper_commit(struct drm_device *dev,
	40	struct drm_atomic_state *state,
	41	bool async);
	42
5ee3229c RC	43	void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
	44	struct drm_atomic_state *old_state);
	45
623369e5 DV	46	void drm_atomic_helper_commit_pre_planes(struct drm_device *dev,
	47	struct drm_atomic_state *state);
	48	void drm_atomic_helper_commit_post_planes(struct drm_device *dev,
	49	struct drm_atomic_state *old_state);
c2fcd274 DV	50
	51	int drm_atomic_helper_prepare_planes(struct drm_device *dev,
	52	struct drm_atomic_state *state);
	53	void drm_atomic_helper_commit_planes(struct drm_device *dev,
	54	struct drm_atomic_state *state);
	55	void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
	56	struct drm_atomic_state *old_state);
	57
	58	void drm_atomic_helper_swap_state(struct drm_device *dev,
	59	struct drm_atomic_state *state);
	60
042652ed DV	61	/* implementations for legacy interfaces */
	62	int drm_atomic_helper_update_plane(struct drm_plane *plane,
	63	struct drm_crtc *crtc,
	64	struct drm_framebuffer *fb,
	65	int crtc_x, int crtc_y,
	66	unsigned int crtc_w, unsigned int crtc_h,
	67	uint32_t src_x, uint32_t src_y,
	68	uint32_t src_w, uint32_t src_h);
	69	int drm_atomic_helper_disable_plane(struct drm_plane *plane);
	70	int drm_atomic_helper_set_config(struct drm_mode_set *set);
	71
	72	int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
	73	struct drm_property *property,
	74	uint64_t val);
	75	int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
	76	struct drm_property *property,
	77	uint64_t val);
	78	int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
	79	struct drm_property *property,
	80	uint64_t val);
8bc0f312 DV	81	int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
	82	struct drm_framebuffer *fb,
	83	struct drm_pending_vblank_event *event,
	84	uint32_t flags);
	85
d461701c DV	86	/* default implementations for state handling */
	87	void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
	88	struct drm_crtc_state *
	89	drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
	90	void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
	91	struct drm_crtc_state *state);
	92
	93	void drm_atomic_helper_plane_reset(struct drm_plane *plane);
	94	struct drm_plane_state *
	95	drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
	96	void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
	97	struct drm_plane_state *state);
	98
	99	void drm_atomic_helper_connector_reset(struct drm_connector *connector);
	100	struct drm_connector_state *
	101	drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
	102	void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
	103	struct drm_connector_state *state);
	104
dd275956 RC	105	/**
	106	* drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
	107	* @plane: the loop cursor
	108	* @crtc: the crtc whose planes are iterated
	109	*
	110	* This iterates over the current state, useful (for example) when applying
	111	* atomic state after it has been checked and swapped. To iterate over the
	112	* planes which will be attached (for ->atomic_check()) see
	113	* drm_crtc_for_each_pending_plane()
	114	*/
	115	#define drm_atomic_crtc_for_each_plane(plane, crtc) \
	116	drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
	117
	118	/**
	119	* drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
	120	* @plane: the loop cursor
	121	* @crtc_state: the incoming crtc-state
	122	*
	123	* Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
	124	* attached if the specified state is applied. Useful during (for example)
	125	* ->atomic_check() operations, to validate the incoming state
	126	*/
	127	#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
	128	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
042652ed	129
c2fcd274	130	#endif /* DRM_ATOMIC_HELPER_H_ */