xref: /linux/include/drm/drm_plane_helper.h (revision 76f623d2d4283cc36a9c8a5b585df74638f1efa5)
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 <linux/types.h>
28 
29 struct drm_crtc;
30 struct drm_framebuffer;
31 struct drm_modeset_acquire_ctx;
32 struct drm_plane;
33 
34 int drm_plane_helper_update_primary(struct drm_plane *plane, struct drm_crtc *crtc,
35 				    struct drm_framebuffer *fb,
36 				    int crtc_x, int crtc_y,
37 				    unsigned int crtc_w, unsigned int crtc_h,
38 				    uint32_t src_x, uint32_t src_y,
39 				    uint32_t src_w, uint32_t src_h,
40 				    struct drm_modeset_acquire_ctx *ctx);
41 int drm_plane_helper_disable_primary(struct drm_plane *plane,
42 				     struct drm_modeset_acquire_ctx *ctx);
43 void drm_plane_helper_destroy(struct drm_plane *plane);
44 
45 /**
46  * DRM_PLANE_NON_ATOMIC_FUNCS - Default plane functions for non-atomic drivers
47  *
48  * This macro initializes plane functions for non-atomic drivers to default
49  * values. Non-atomic interfaces are deprecated and should not be used in new
50  * drivers.
51  */
52 #define DRM_PLANE_NON_ATOMIC_FUNCS \
53 	.update_plane = drm_plane_helper_update_primary, \
54 	.disable_plane = drm_plane_helper_disable_primary, \
55 	.destroy = drm_plane_helper_destroy
56 
57 #endif
58