[mirror_ubuntu-bionic-kernel.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>
#include <drm/drm_modeset_helper_vtables.h>
#include <drm/drm_modeset_helper.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)

int drm_plane_helper_check_state(struct drm_plane_state *state,
				 const struct drm_rect *clip,
				 int min_scale, int max_scale,
				 bool can_position,
				 bool can_update_disabled);
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,
				  unsigned int rotation,
				  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,
			      struct drm_modeset_acquire_ctx *ctx);
int drm_primary_helper_disable(struct drm_plane *plane,
			       struct drm_modeset_acquire_ctx *ctx);
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>
092d01da	29	#include <drm/drm_modeset_helper_vtables.h>
1de72faf	30	#include <drm/drm_modeset_helper.h>
7daf8d54 MR	31
	32	/*
	33	* Drivers that don't allow primary plane scaling may pass this macro in place
	34	* of the min/max scale parameters of the update checker function.
	35	*
	36	* Due to src being in 16.16 fixed point and dest being in integer pixels,
	37	* 1<<16 represents no scaling.
	38	*/
	39	#define DRM_PLANE_HELPER_NO_SCALING (1<<16)
	40
df86af91 VS	41	int drm_plane_helper_check_state(struct drm_plane_state *state,
	42	const struct drm_rect *clip,
	43	int min_scale, int max_scale,
	44	bool can_position,
	45	bool can_update_disabled);
b54a0935 TR	46	int drm_plane_helper_check_update(struct drm_plane *plane,
	47	struct drm_crtc *crtc,
	48	struct drm_framebuffer *fb,
	49	struct drm_rect *src,
	50	struct drm_rect *dest,
	51	const struct drm_rect *clip,
9b8b013d	52	unsigned int rotation,
b54a0935 TR	53	int min_scale,
	54	int max_scale,
	55	bool can_position,
	56	bool can_update_disabled,
	57	bool *visible);
	58	int drm_primary_helper_update(struct drm_plane *plane,
	59	struct drm_crtc *crtc,
	60	struct drm_framebuffer *fb,
	61	int crtc_x, int crtc_y,
	62	unsigned int crtc_w, unsigned int crtc_h,
	63	uint32_t src_x, uint32_t src_y,
34a2ab5e DV	64	uint32_t src_w, uint32_t src_h,
34a2ab5e DV	65	struct drm_modeset_acquire_ctx *ctx);
19315294 DV	66	int drm_primary_helper_disable(struct drm_plane *plane,
19315294 DV	67	struct drm_modeset_acquire_ctx *ctx);
b54a0935	68	void drm_primary_helper_destroy(struct drm_plane *plane);
c103d1cf	69	extern const struct drm_plane_funcs drm_primary_helper_funcs;
c103d1cf	70
acf24a39 DV	71	int drm_plane_helper_update(struct drm_plane plane, struct drm_crtc crtc,
	72	struct drm_framebuffer *fb,
	73	int crtc_x, int crtc_y,
	74	unsigned int crtc_w, unsigned int crtc_h,
	75	uint32_t src_x, uint32_t src_y,
	76	uint32_t src_w, uint32_t src_h);
	77	int drm_plane_helper_disable(struct drm_plane *plane);
	78
2f324b42 DV	79	/* For use by drm_crtc_helper.c */
	80	int drm_plane_helper_commit(struct drm_plane *plane,
	81	struct drm_plane_state *plane_state,
	82	struct drm_framebuffer *old_fb);
c103d1cf	83	#endif