Matt Roper | c103d1c | 2014-04-01 15:22:35 -0700 | [diff] [blame] | 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 | |
Matt Roper | 7daf8d5 | 2014-05-29 08:06:52 -0700 | [diff] [blame] | 27 | #include <drm/drm_rect.h> |
Daniel Vetter | 3cb9ae4 | 2014-10-29 10:03:57 +0100 | [diff] [blame] | 28 | #include <drm/drm_crtc.h> |
Matt Roper | 7daf8d5 | 2014-05-29 08:06:52 -0700 | [diff] [blame] | 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 | |
Matt Roper | c103d1c | 2014-04-01 15:22:35 -0700 | [diff] [blame] | 39 | /** |
| 40 | * DOC: plane helpers |
| 41 | * |
| 42 | * Helper functions to assist with creation and handling of CRTC primary |
| 43 | * planes. |
| 44 | */ |
| 45 | |
Daniel Vetter | 3cb9ae4 | 2014-10-29 10:03:57 +0100 | [diff] [blame] | 46 | extern int drm_crtc_init(struct drm_device *dev, |
| 47 | struct drm_crtc *crtc, |
| 48 | const struct drm_crtc_funcs *funcs); |
| 49 | |
Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 50 | /** |
| 51 | * drm_plane_helper_funcs - helper operations for CRTCs |
Thierry Reding | 5d57169 | 2014-11-25 12:09:45 +0100 | [diff] [blame] | 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 |
Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 56 | * |
| 57 | * The helper operations are called by the mid-layer CRTC helper. |
| 58 | */ |
| 59 | struct drm_plane_helper_funcs { |
| 60 | int (*prepare_fb)(struct drm_plane *plane, |
| 61 | struct drm_framebuffer *fb); |
| 62 | void (*cleanup_fb)(struct drm_plane *plane, |
| 63 | struct drm_framebuffer *fb); |
| 64 | |
| 65 | int (*atomic_check)(struct drm_plane *plane, |
| 66 | struct drm_plane_state *state); |
Thierry Reding | f1c37e1 | 2014-11-25 12:09:44 +0100 | [diff] [blame] | 67 | void (*atomic_update)(struct drm_plane *plane, |
| 68 | struct drm_plane_state *old_state); |
Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 69 | }; |
| 70 | |
| 71 | static inline void drm_plane_helper_add(struct drm_plane *plane, |
| 72 | const struct drm_plane_helper_funcs *funcs) |
| 73 | { |
| 74 | plane->helper_private = (void *)funcs; |
| 75 | } |
| 76 | |
Matt Roper | 7daf8d5 | 2014-05-29 08:06:52 -0700 | [diff] [blame] | 77 | extern int drm_plane_helper_check_update(struct drm_plane *plane, |
| 78 | struct drm_crtc *crtc, |
| 79 | struct drm_framebuffer *fb, |
| 80 | struct drm_rect *src, |
| 81 | struct drm_rect *dest, |
| 82 | const struct drm_rect *clip, |
| 83 | int min_scale, |
| 84 | int max_scale, |
| 85 | bool can_position, |
| 86 | bool can_update_disabled, |
| 87 | bool *visible); |
Matt Roper | c103d1c | 2014-04-01 15:22:35 -0700 | [diff] [blame] | 88 | extern int drm_primary_helper_update(struct drm_plane *plane, |
| 89 | struct drm_crtc *crtc, |
| 90 | struct drm_framebuffer *fb, |
| 91 | int crtc_x, int crtc_y, |
| 92 | unsigned int crtc_w, unsigned int crtc_h, |
| 93 | uint32_t src_x, uint32_t src_y, |
| 94 | uint32_t src_w, uint32_t src_h); |
| 95 | extern int drm_primary_helper_disable(struct drm_plane *plane); |
| 96 | extern void drm_primary_helper_destroy(struct drm_plane *plane); |
| 97 | extern const struct drm_plane_funcs drm_primary_helper_funcs; |
| 98 | extern struct drm_plane *drm_primary_helper_create_plane(struct drm_device *dev, |
Thierry Reding | f220e62 | 2014-05-13 12:47:42 +0200 | [diff] [blame] | 99 | const uint32_t *formats, |
Matt Roper | c103d1c | 2014-04-01 15:22:35 -0700 | [diff] [blame] | 100 | int num_formats); |
| 101 | |
| 102 | |
Daniel Vetter | acf24a3 | 2014-07-29 15:33:05 +0200 | [diff] [blame] | 103 | int drm_plane_helper_update(struct drm_plane *plane, struct drm_crtc *crtc, |
| 104 | struct drm_framebuffer *fb, |
| 105 | int crtc_x, int crtc_y, |
| 106 | unsigned int crtc_w, unsigned int crtc_h, |
| 107 | uint32_t src_x, uint32_t src_y, |
| 108 | uint32_t src_w, uint32_t src_h); |
| 109 | int drm_plane_helper_disable(struct drm_plane *plane); |
| 110 | |
Daniel Vetter | 2f324b4 | 2014-10-29 11:13:47 +0100 | [diff] [blame] | 111 | /* For use by drm_crtc_helper.c */ |
| 112 | int drm_plane_helper_commit(struct drm_plane *plane, |
| 113 | struct drm_plane_state *plane_state, |
| 114 | struct drm_framebuffer *old_fb); |
Matt Roper | c103d1c | 2014-04-01 15:22:35 -0700 | [diff] [blame] | 115 | #endif |