1 /* 2 * Copyright (C) 2014 Red Hat 3 * Copyright (C) 2014 Intel Corp. 4 * 5 * Permission is hereby granted, free of charge, to any person obtaining a 6 * copy of this software and associated documentation files (the "Software"), 7 * to deal in the Software without restriction, including without limitation 8 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 9 * and/or sell copies of the Software, and to permit persons to whom the 10 * Software is furnished to do so, subject to the following conditions: 11 * 12 * The above copyright notice and this permission notice shall be included in 13 * all copies or substantial portions of the 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 COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR 19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 21 * OTHER DEALINGS IN THE SOFTWARE. 22 * 23 * Authors: 24 * Rob Clark <robdclark@gmail.com> 25 * Daniel Vetter <daniel.vetter@ffwll.ch> 26 */ 27 28 #ifndef DRM_ATOMIC_HELPER_H_ 29 #define DRM_ATOMIC_HELPER_H_ 30 31 #include <drm/drm_crtc.h> 32 #include <drm/drm_modeset_helper_vtables.h> 33 #include <drm/drm_modeset_helper.h> 34 #include <drm/drm_atomic_state_helper.h> 35 #include <drm/drm_util.h> 36 37 struct drm_atomic_state; 38 struct drm_private_obj; 39 struct drm_private_state; 40 41 int drm_atomic_helper_check_modeset(struct drm_device *dev, 42 struct drm_atomic_state *state); 43 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state, 44 const struct drm_crtc_state *crtc_state, 45 int min_scale, 46 int max_scale, 47 bool can_position, 48 bool can_update_disabled); 49 int drm_atomic_helper_check_planes(struct drm_device *dev, 50 struct drm_atomic_state *state); 51 int drm_atomic_helper_check(struct drm_device *dev, 52 struct drm_atomic_state *state); 53 void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 54 void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state); 55 int drm_atomic_helper_commit(struct drm_device *dev, 56 struct drm_atomic_state *state, 57 bool nonblock); 58 int drm_atomic_helper_async_check(struct drm_device *dev, 59 struct drm_atomic_state *state); 60 void drm_atomic_helper_async_commit(struct drm_device *dev, 61 struct drm_atomic_state *state); 62 63 int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 64 struct drm_atomic_state *state, 65 bool pre_swap); 66 67 void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 68 struct drm_atomic_state *old_state); 69 70 void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev, 71 struct drm_atomic_state *old_state); 72 73 void 74 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 75 struct drm_atomic_state *old_state); 76 77 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 78 struct drm_atomic_state *state); 79 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 80 struct drm_atomic_state *old_state); 81 82 int drm_atomic_helper_prepare_planes(struct drm_device *dev, 83 struct drm_atomic_state *state); 84 85 #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 86 #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 87 88 void drm_atomic_helper_commit_planes(struct drm_device *dev, 89 struct drm_atomic_state *state, 90 uint32_t flags); 91 void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 92 struct drm_atomic_state *old_state); 93 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 94 void 95 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 96 bool atomic); 97 98 int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state, 99 bool stall); 100 101 /* nonblocking commit helpers */ 102 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 103 bool nonblock); 104 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 105 void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state); 106 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 107 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 108 109 /* implementations for legacy interfaces */ 110 int drm_atomic_helper_update_plane(struct drm_plane *plane, 111 struct drm_crtc *crtc, 112 struct drm_framebuffer *fb, 113 int crtc_x, int crtc_y, 114 unsigned int crtc_w, unsigned int crtc_h, 115 uint32_t src_x, uint32_t src_y, 116 uint32_t src_w, uint32_t src_h, 117 struct drm_modeset_acquire_ctx *ctx); 118 int drm_atomic_helper_disable_plane(struct drm_plane *plane, 119 struct drm_modeset_acquire_ctx *ctx); 120 int __drm_atomic_helper_disable_plane(struct drm_plane *plane, 121 struct drm_plane_state *plane_state); 122 int drm_atomic_helper_set_config(struct drm_mode_set *set, 123 struct drm_modeset_acquire_ctx *ctx); 124 int __drm_atomic_helper_set_config(struct drm_mode_set *set, 125 struct drm_atomic_state *state); 126 127 int drm_atomic_helper_disable_all(struct drm_device *dev, 128 struct drm_modeset_acquire_ctx *ctx); 129 void drm_atomic_helper_shutdown(struct drm_device *dev); 130 struct drm_atomic_state * 131 drm_atomic_helper_duplicate_state(struct drm_device *dev, 132 struct drm_modeset_acquire_ctx *ctx); 133 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 134 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state, 135 struct drm_modeset_acquire_ctx *ctx); 136 int drm_atomic_helper_resume(struct drm_device *dev, 137 struct drm_atomic_state *state); 138 139 int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 140 struct drm_framebuffer *fb, 141 struct drm_pending_vblank_event *event, 142 uint32_t flags, 143 struct drm_modeset_acquire_ctx *ctx); 144 int drm_atomic_helper_page_flip_target( 145 struct drm_crtc *crtc, 146 struct drm_framebuffer *fb, 147 struct drm_pending_vblank_event *event, 148 uint32_t flags, 149 uint32_t target, 150 struct drm_modeset_acquire_ctx *ctx); 151 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 152 u16 *red, u16 *green, u16 *blue, 153 uint32_t size, 154 struct drm_modeset_acquire_ctx *ctx); 155 156 /** 157 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 158 * @plane: the loop cursor 159 * @crtc: the crtc whose planes are iterated 160 * 161 * This iterates over the current state, useful (for example) when applying 162 * atomic state after it has been checked and swapped. To iterate over the 163 * planes which *will* be attached (more useful in code called from 164 * &drm_mode_config_funcs.atomic_check) see 165 * drm_atomic_crtc_state_for_each_plane(). 166 */ 167 #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 168 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 169 170 /** 171 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 172 * @plane: the loop cursor 173 * @crtc_state: the incoming crtc-state 174 * 175 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 176 * attached if the specified state is applied. Useful during for example 177 * in code called from &drm_mode_config_funcs.atomic_check operations, to 178 * validate the incoming state. 179 */ 180 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 181 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 182 183 /** 184 * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state 185 * @plane: the loop cursor 186 * @plane_state: loop cursor for the plane's state, must be const 187 * @crtc_state: the incoming crtc-state 188 * 189 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 190 * attached if the specified state is applied. Useful during for example 191 * in code called from &drm_mode_config_funcs.atomic_check operations, to 192 * validate the incoming state. 193 * 194 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 195 * const plane_state. This is useful when a driver just wants to peek at other 196 * active planes on this crtc, but does not need to change it. 197 */ 198 #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 199 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 200 for_each_if ((plane_state = \ 201 __drm_atomic_get_current_plane_state((crtc_state)->state, \ 202 plane))) 203 204 /** 205 * drm_atomic_plane_disabling - check whether a plane is being disabled 206 * @old_plane_state: old atomic plane state 207 * @new_plane_state: new atomic plane state 208 * 209 * Checks the atomic state of a plane to determine whether it's being disabled 210 * or not. This also WARNs if it detects an invalid state (both CRTC and FB 211 * need to either both be NULL or both be non-NULL). 212 * 213 * RETURNS: 214 * True if the plane is being disabled, false otherwise. 215 */ 216 static inline bool 217 drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state, 218 struct drm_plane_state *new_plane_state) 219 { 220 /* 221 * When disabling a plane, CRTC and FB should always be NULL together. 222 * Anything else should be considered a bug in the atomic core, so we 223 * gently warn about it. 224 */ 225 WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) || 226 (new_plane_state->crtc != NULL && new_plane_state->fb == NULL)); 227 228 return old_plane_state->crtc && !new_plane_state->crtc; 229 } 230 231 #endif /* DRM_ATOMIC_HELPER_H_ */ 232