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 /** 51 * drm_plane_helper_funcs - helper operations for CRTCs 52 * @prepare_fb: prepare a framebuffer for use by the plane 53 * @cleanup_fb: cleanup a framebuffer when it's no longer used by the plane 54 * @atomic_check: check that a given atomic state is valid and can be applied 55 * @atomic_update: apply an atomic state to the plane (mandatory) 56 * @atomic_disable: disable the plane 57 * 58 * The helper operations are called by the mid-layer CRTC helper. 59 */ 60 struct drm_plane_helper_funcs { 61 int (*prepare_fb)(struct drm_plane *plane, 62 struct drm_framebuffer *fb, 63 const struct drm_plane_state *new_state); 64 void (*cleanup_fb)(struct drm_plane *plane, 65 struct drm_framebuffer *fb, 66 const struct drm_plane_state *old_state); 67 68 int (*atomic_check)(struct drm_plane *plane, 69 struct drm_plane_state *state); 70 void (*atomic_update)(struct drm_plane *plane, 71 struct drm_plane_state *old_state); 72 void (*atomic_disable)(struct drm_plane *plane, 73 struct drm_plane_state *old_state); 74 }; 75 76 static inline void drm_plane_helper_add(struct drm_plane *plane, 77 const struct drm_plane_helper_funcs *funcs) 78 { 79 plane->helper_private = funcs; 80 } 81 82 extern int drm_plane_helper_check_update(struct drm_plane *plane, 83 struct drm_crtc *crtc, 84 struct drm_framebuffer *fb, 85 struct drm_rect *src, 86 struct drm_rect *dest, 87 const struct drm_rect *clip, 88 int min_scale, 89 int max_scale, 90 bool can_position, 91 bool can_update_disabled, 92 bool *visible); 93 extern int drm_primary_helper_update(struct drm_plane *plane, 94 struct drm_crtc *crtc, 95 struct drm_framebuffer *fb, 96 int crtc_x, int crtc_y, 97 unsigned int crtc_w, unsigned int crtc_h, 98 uint32_t src_x, uint32_t src_y, 99 uint32_t src_w, uint32_t src_h); 100 extern int drm_primary_helper_disable(struct drm_plane *plane); 101 extern void drm_primary_helper_destroy(struct drm_plane *plane); 102 extern const struct drm_plane_funcs drm_primary_helper_funcs; 103 104 int drm_plane_helper_update(struct drm_plane *plane, struct drm_crtc *crtc, 105 struct drm_framebuffer *fb, 106 int crtc_x, int crtc_y, 107 unsigned int crtc_w, unsigned int crtc_h, 108 uint32_t src_x, uint32_t src_y, 109 uint32_t src_w, uint32_t src_h); 110 int drm_plane_helper_disable(struct drm_plane *plane); 111 112 /* For use by drm_crtc_helper.c */ 113 int drm_plane_helper_commit(struct drm_plane *plane, 114 struct drm_plane_state *plane_state, 115 struct drm_framebuffer *old_fb); 116 #endif 117