2 * Copyright (C) 2011-2013 Intel Corporation
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:
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
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
24 #ifndef DRM_PLANE_HELPER_H
25 #define DRM_PLANE_HELPER_H
27 #include <drm/drm_rect.h>
28 #include <drm/drm_crtc.h>
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.
34 * Due to src being in 16.16 fixed point and dest being in integer pixels,
35 * 1<<16 represents no scaling.
37 #define DRM_PLANE_HELPER_NO_SCALING (1<<16)
42 * Helper functions to assist with creation and handling of CRTC primary
46 extern int drm_crtc_init(struct drm_device *dev,
47 struct drm_crtc *crtc,
48 const struct drm_crtc_funcs *funcs);
51 * drm_plane_helper_funcs - helper operations for CRTCs
53 * The helper operations are called by the mid-layer CRTC helper.
55 struct drm_plane_helper_funcs {
56 int (*prepare_fb)(struct drm_plane *plane,
57 struct drm_framebuffer *fb);
58 void (*cleanup_fb)(struct drm_plane *plane,
59 struct drm_framebuffer *fb);
61 int (*atomic_check)(struct drm_plane *plane,
62 struct drm_plane_state *state);
63 void (*atomic_update)(struct drm_plane *plane);
66 static inline void drm_plane_helper_add(struct drm_plane *plane,
67 const struct drm_plane_helper_funcs *funcs)
69 plane->helper_private = (void *)funcs;
72 extern int drm_plane_helper_check_update(struct drm_plane *plane,
73 struct drm_crtc *crtc,
74 struct drm_framebuffer *fb,
76 struct drm_rect *dest,
77 const struct drm_rect *clip,
81 bool can_update_disabled,
83 extern int drm_primary_helper_update(struct drm_plane *plane,
84 struct drm_crtc *crtc,
85 struct drm_framebuffer *fb,
86 int crtc_x, int crtc_y,
87 unsigned int crtc_w, unsigned int crtc_h,
88 uint32_t src_x, uint32_t src_y,
89 uint32_t src_w, uint32_t src_h);
90 extern int drm_primary_helper_disable(struct drm_plane *plane);
91 extern void drm_primary_helper_destroy(struct drm_plane *plane);
92 extern const struct drm_plane_funcs drm_primary_helper_funcs;
93 extern struct drm_plane *drm_primary_helper_create_plane(struct drm_device *dev,
94 const uint32_t *formats,