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 
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 
38 /**
39  * DOC: plane helpers
40  *
41  * Helper functions to assist with creation and handling of CRTC primary
42  * planes.
43  */
44 
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);
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,
67 							 const uint32_t *formats,
68 							 int num_formats);
69 
70 
71 #endif
72