[linux-2.6-block.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>

/*
 * 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.
 */

extern 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);
extern 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);
extern int drm_primary_helper_disable(struct drm_plane *plane);
extern void drm_primary_helper_destroy(struct drm_plane *plane);
extern const struct drm_plane_funcs drm_primary_helper_funcs;
extern struct drm_plane *drm_primary_helper_create_plane(struct drm_device *dev,
							 const uint32_t *formats,
							 int num_formats);


#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 MR	27	#include <drm/drm_rect.h>
	28
	29	/*
	30	* Drivers that don't allow primary plane scaling may pass this macro in place
	31	* of the min/max scale parameters of the update checker function.
	32	*
	33	* Due to src being in 16.16 fixed point and dest being in integer pixels,
	34	* 1<<16 represents no scaling.
	35	*/
	36	#define DRM_PLANE_HELPER_NO_SCALING (1<<16)
	37
c103d1cf MR	38	/**
	39	* DOC: plane helpers
	40	*
	41	* Helper functions to assist with creation and handling of CRTC primary
	42	* planes.
	43	*/
	44
7daf8d54 MR	45	extern int drm_plane_helper_check_update(struct drm_plane *plane,
	46	struct drm_crtc *crtc,
	47	struct drm_framebuffer *fb,
	48	struct drm_rect *src,
	49	struct drm_rect *dest,
	50	const struct drm_rect *clip,
	51	int min_scale,
	52	int max_scale,
	53	bool can_position,
	54	bool can_update_disabled,
	55	bool *visible);
c103d1cf MR	56	extern int drm_primary_helper_update(struct drm_plane *plane,
	57	struct drm_crtc *crtc,
	58	struct drm_framebuffer *fb,
	59	int crtc_x, int crtc_y,
	60	unsigned int crtc_w, unsigned int crtc_h,
	61	uint32_t src_x, uint32_t src_y,
	62	uint32_t src_w, uint32_t src_h);
	63	extern int drm_primary_helper_disable(struct drm_plane *plane);
	64	extern void drm_primary_helper_destroy(struct drm_plane *plane);
	65	extern const struct drm_plane_funcs drm_primary_helper_funcs;
	66	extern struct drm_plane drm_primary_helper_create_plane(struct drm_device dev,
f220e626	67	const uint32_t *formats,
c103d1cf MR	68	int num_formats);
	69
	70
	71	#endif