xref: /linux/include/drm/drm_plane_helper.h (revision 3cb9ae4fd82ebc9759bc59998c88c385d35496fe)
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 
27 #include <drm/drm_rect.h>
28 #include <drm/drm_crtc.h>
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 
39 /**
40  * DOC: plane helpers
41  *
42  * Helper functions to assist with creation and handling of CRTC primary
43  * planes.
44  */
45 
46 extern int drm_crtc_init(struct drm_device *dev,
47 			 struct drm_crtc *crtc,
48 			 const struct drm_crtc_funcs *funcs);
49 
50 extern int drm_plane_helper_check_update(struct drm_plane *plane,
51 					 struct drm_crtc *crtc,
52 					 struct drm_framebuffer *fb,
53 					 struct drm_rect *src,
54 					 struct drm_rect *dest,
55 					 const struct drm_rect *clip,
56 					 int min_scale,
57 					 int max_scale,
58 					 bool can_position,
59 					 bool can_update_disabled,
60 					 bool *visible);
61 extern int drm_primary_helper_update(struct drm_plane *plane,
62 				     struct drm_crtc *crtc,
63 				     struct drm_framebuffer *fb,
64 				     int crtc_x, int crtc_y,
65 				     unsigned int crtc_w, unsigned int crtc_h,
66 				     uint32_t src_x, uint32_t src_y,
67 				     uint32_t src_w, uint32_t src_h);
68 extern int drm_primary_helper_disable(struct drm_plane *plane);
69 extern void drm_primary_helper_destroy(struct drm_plane *plane);
70 extern const struct drm_plane_funcs drm_primary_helper_funcs;
71 extern struct drm_plane *drm_primary_helper_create_plane(struct drm_device *dev,
72 							 const uint32_t *formats,
73 							 int num_formats);
74 
75 
76 #endif
77