[deliverable/linux.git] / include / drm / drm_plane_helper.h

/*
 * Copyright (C) 2011-2013 Intel Corporation
 *
 * 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 (including the next
 * paragraph) 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 AUTHORS OR COPYRIGHT HOLDERS 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.
 */

#ifndef DRM_PLANE_HELPER_H
#define DRM_PLANE_HELPER_H

#include <drm/drm_rect.h>
#include <drm/drm_crtc.h>

/*
 * Drivers that don't allow primary plane scaling may pass this macro in place
 * of the min/max scale parameters of the update checker function.
 *
 * Due to src being in 16.16 fixed point and dest being in integer pixels,
 * 1<<16 represents no scaling.
 */
#define DRM_PLANE_HELPER_NO_SCALING (1<<16)

/**
 * DOC: plane helpers
 *
 * Helper functions to assist with creation and handling of CRTC primary
 * planes.
 */

int drm_crtc_init(struct drm_device *dev, struct drm_crtc *crtc,
		  const struct drm_crtc_funcs *funcs);

/**
 * drm_plane_helper_funcs - helper operations for CRTCs
 * @prepare_fb: prepare a framebuffer for use by the plane
 * @cleanup_fb: cleanup a framebuffer when it's no longer used by the plane
 * @atomic_check: check that a given atomic state is valid and can be applied
 * @atomic_update: apply an atomic state to the plane (mandatory)
 * @atomic_disable: disable the plane
 *
 * The helper operations are called by the mid-layer CRTC helper.
 */
struct drm_plane_helper_funcs {
	int (*prepare_fb)(struct drm_plane *plane,
			  const struct drm_plane_state *new_state);
	void (*cleanup_fb)(struct drm_plane *plane,
			   const struct drm_plane_state *old_state);

	int (*atomic_check)(struct drm_plane *plane,
			    struct drm_plane_state *state);
	void (*atomic_update)(struct drm_plane *plane,
			      struct drm_plane_state *old_state);
	void (*atomic_disable)(struct drm_plane *plane,
			       struct drm_plane_state *old_state);
};

static inline void drm_plane_helper_add(struct drm_plane *plane,
					const struct drm_plane_helper_funcs *funcs)
{
	plane->helper_private = funcs;
}

int drm_plane_helper_check_update(struct drm_plane *plane,
				  struct drm_crtc *crtc,
				  struct drm_framebuffer *fb,
				  struct drm_rect *src,
				  struct drm_rect *dest,
				  const struct drm_rect *clip,
				  int min_scale,
				  int max_scale,
				  bool can_position,
				  bool can_update_disabled,
				  bool *visible);
int drm_primary_helper_update(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_primary_helper_disable(struct drm_plane *plane);
void drm_primary_helper_destroy(struct drm_plane *plane);
extern const struct drm_plane_funcs drm_primary_helper_funcs;

int drm_plane_helper_update(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_plane_helper_disable(struct drm_plane *plane);

/* For use by drm_crtc_helper.c */
int drm_plane_helper_commit(struct drm_plane *plane,
			    struct drm_plane_state *plane_state,
			    struct drm_framebuffer *old_fb);
#endif
Commit	Line	Data
c103d1cf MR	1	/*
	2	* Copyright (C) 2011-2013 Intel Corporation
	3	*
	4	* Permission is hereby granted, free of charge, to any person obtaining a
	5	* copy of this software and associated documentation files (the "Software"),
	6	* to deal in the Software without restriction, including without limitation
	7	* the rights to use, copy, modify, merge, publish, distribute, sublicense,
	8	* and/or sell copies of the Software, and to permit persons to whom the
	9	* Software is furnished to do so, subject to the following conditions:
	10	*
	11	* The above copyright notice and this permission notice (including the next
	12	* paragraph) shall be included in all copies or substantial portions of the
	13	* 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 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	19	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	20	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	21	* SOFTWARE.
	22	*/
	23
	24	#ifndef DRM_PLANE_HELPER_H
	25	#define DRM_PLANE_HELPER_H
	26
7daf8d54	27	#include <drm/drm_rect.h>
3cb9ae4f	28	#include <drm/drm_crtc.h>
7daf8d54 MR	29
	30	/*
	31	* Drivers that don't allow primary plane scaling may pass this macro in place
	32	* of the min/max scale parameters of the update checker function.
	33	*
	34	* Due to src being in 16.16 fixed point and dest being in integer pixels,
	35	* 1<<16 represents no scaling.
	36	*/
	37	#define DRM_PLANE_HELPER_NO_SCALING (1<<16)
	38
c103d1cf MR	39	/**
	40	* DOC: plane helpers
	41	*
	42	* Helper functions to assist with creation and handling of CRTC primary
	43	* planes.
	44	*/
	45
b54a0935 TR	46	int drm_crtc_init(struct drm_device dev, struct drm_crtc crtc,
b54a0935 TR	47	const struct drm_crtc_funcs *funcs);
3cb9ae4f	48
c2fcd274 DV	49	/**
c2fcd274 DV	50	* drm_plane_helper_funcs - helper operations for CRTCs
5d571690 TR	51	* @prepare_fb: prepare a framebuffer for use by the plane
	52	* @cleanup_fb: cleanup a framebuffer when it's no longer used by the plane
	53	* @atomic_check: check that a given atomic state is valid and can be applied
3cad4b68	54	* @atomic_update: apply an atomic state to the plane (mandatory)
407b8bd9	55	* @atomic_disable: disable the plane
c2fcd274 DV	56	*
	57	* The helper operations are called by the mid-layer CRTC helper.
	58	*/
	59	struct drm_plane_helper_funcs {
	60	int (prepare_fb)(struct drm_plane plane,
d136dfee	61	const struct drm_plane_state *new_state);
c2fcd274	62	void (cleanup_fb)(struct drm_plane plane,
d136dfee	63	const struct drm_plane_state *old_state);
c2fcd274 DV	64
	65	int (atomic_check)(struct drm_plane plane,
	66	struct drm_plane_state *state);
f1c37e1a TR	67	void (atomic_update)(struct drm_plane plane,
f1c37e1a TR	68	struct drm_plane_state *old_state);
407b8bd9 TR	69	void (atomic_disable)(struct drm_plane plane,
407b8bd9 TR	70	struct drm_plane_state *old_state);
c2fcd274 DV	71	};
	72
	73	static inline void drm_plane_helper_add(struct drm_plane *plane,
	74	const struct drm_plane_helper_funcs *funcs)
	75	{
9a436ee6	76	plane->helper_private = funcs;
c2fcd274 DV	77	}
c2fcd274 DV	78
b54a0935 TR	79	int drm_plane_helper_check_update(struct drm_plane *plane,
	80	struct drm_crtc *crtc,
	81	struct drm_framebuffer *fb,
	82	struct drm_rect *src,
	83	struct drm_rect *dest,
	84	const struct drm_rect *clip,
	85	int min_scale,
	86	int max_scale,
	87	bool can_position,
	88	bool can_update_disabled,
	89	bool *visible);
	90	int drm_primary_helper_update(struct drm_plane *plane,
	91	struct drm_crtc *crtc,
	92	struct drm_framebuffer *fb,
	93	int crtc_x, int crtc_y,
	94	unsigned int crtc_w, unsigned int crtc_h,
	95	uint32_t src_x, uint32_t src_y,
	96	uint32_t src_w, uint32_t src_h);
	97	int drm_primary_helper_disable(struct drm_plane *plane);
	98	void drm_primary_helper_destroy(struct drm_plane *plane);
c103d1cf	99	extern const struct drm_plane_funcs drm_primary_helper_funcs;
c103d1cf	100
acf24a39 DV	101	int drm_plane_helper_update(struct drm_plane plane, struct drm_crtc crtc,
	102	struct drm_framebuffer *fb,
	103	int crtc_x, int crtc_y,
	104	unsigned int crtc_w, unsigned int crtc_h,
	105	uint32_t src_x, uint32_t src_y,
	106	uint32_t src_w, uint32_t src_h);
	107	int drm_plane_helper_disable(struct drm_plane *plane);
	108
2f324b42 DV	109	/* For use by drm_crtc_helper.c */
	110	int drm_plane_helper_commit(struct drm_plane *plane,
	111	struct drm_plane_state *plane_state,
	112	struct drm_framebuffer *old_fb);
c103d1cf	113	#endif