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 /* 38 * Drivers that don't allow primary plane scaling may pass this macro in place 39 * of the min/max scale parameters of the plane-state checker function. 40 * 41 * Due to src being in 16.16 fixed point and dest being in integer pixels, 42 * 1<<16 represents no scaling. 43 */ 44 #define DRM_PLANE_NO_SCALING (1<<16) 45 46 struct drm_atomic_state; 47 struct drm_private_obj; 48 struct drm_private_state; 49 50 int drm_atomic_helper_check_modeset(struct drm_device *dev, 51 struct drm_atomic_state *state); 52 int drm_atomic_helper_check_wb_connector_state(struct drm_connector *connector, 53 struct drm_atomic_state *state); 54 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state, 55 const struct drm_crtc_state *crtc_state, 56 int min_scale, 57 int max_scale, 58 bool can_position, 59 bool can_update_disabled); 60 int drm_atomic_helper_check_planes(struct drm_device *dev, 61 struct drm_atomic_state *state); 62 int drm_atomic_helper_check_crtc_primary_plane(struct drm_crtc_state *crtc_state); 63 int drm_atomic_helper_check(struct drm_device *dev, 64 struct drm_atomic_state *state); 65 void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 66 void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state); 67 int drm_atomic_helper_commit(struct drm_device *dev, 68 struct drm_atomic_state *state, 69 bool nonblock); 70 int drm_atomic_helper_async_check(struct drm_device *dev, 71 struct drm_atomic_state *state); 72 void drm_atomic_helper_async_commit(struct drm_device *dev, 73 struct drm_atomic_state *state); 74 75 int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 76 struct drm_atomic_state *state, 77 bool pre_swap); 78 79 void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 80 struct drm_atomic_state *old_state); 81 82 void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev, 83 struct drm_atomic_state *old_state); 84 85 void 86 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 87 struct drm_atomic_state *old_state); 88 89 void 90 drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state); 91 92 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 93 struct drm_atomic_state *state); 94 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 95 struct drm_atomic_state *old_state); 96 97 int drm_atomic_helper_prepare_planes(struct drm_device *dev, 98 struct drm_atomic_state *state); 99 void drm_atomic_helper_unprepare_planes(struct drm_device *dev, 100 struct drm_atomic_state *state); 101 102 #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 103 #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 104 105 void drm_atomic_helper_commit_planes(struct drm_device *dev, 106 struct drm_atomic_state *state, 107 uint32_t flags); 108 void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 109 struct drm_atomic_state *old_state); 110 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 111 void 112 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 113 bool atomic); 114 115 int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state, 116 bool stall); 117 118 /* nonblocking commit helpers */ 119 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 120 bool nonblock); 121 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 122 void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state); 123 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 124 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 125 126 /* implementations for legacy interfaces */ 127 int drm_atomic_helper_update_plane(struct drm_plane *plane, 128 struct drm_crtc *crtc, 129 struct drm_framebuffer *fb, 130 int crtc_x, int crtc_y, 131 unsigned int crtc_w, unsigned int crtc_h, 132 uint32_t src_x, uint32_t src_y, 133 uint32_t src_w, uint32_t src_h, 134 struct drm_modeset_acquire_ctx *ctx); 135 int drm_atomic_helper_disable_plane(struct drm_plane *plane, 136 struct drm_modeset_acquire_ctx *ctx); 137 int drm_atomic_helper_set_config(struct drm_mode_set *set, 138 struct drm_modeset_acquire_ctx *ctx); 139 140 int drm_atomic_helper_disable_all(struct drm_device *dev, 141 struct drm_modeset_acquire_ctx *ctx); 142 int drm_atomic_helper_reset_crtc(struct drm_crtc *crtc, 143 struct drm_modeset_acquire_ctx *ctx); 144 void drm_atomic_helper_shutdown(struct drm_device *dev); 145 struct drm_atomic_state * 146 drm_atomic_helper_duplicate_state(struct drm_device *dev, 147 struct drm_modeset_acquire_ctx *ctx); 148 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 149 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state, 150 struct drm_modeset_acquire_ctx *ctx); 151 int drm_atomic_helper_resume(struct drm_device *dev, 152 struct drm_atomic_state *state); 153 154 int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 155 struct drm_framebuffer *fb, 156 struct drm_pending_vblank_event *event, 157 uint32_t flags, 158 struct drm_modeset_acquire_ctx *ctx); 159 int drm_atomic_helper_page_flip_target( 160 struct drm_crtc *crtc, 161 struct drm_framebuffer *fb, 162 struct drm_pending_vblank_event *event, 163 uint32_t flags, 164 uint32_t target, 165 struct drm_modeset_acquire_ctx *ctx); 166 167 /** 168 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 169 * @plane: the loop cursor 170 * @crtc: the CRTC whose planes are iterated 171 * 172 * This iterates over the current state, useful (for example) when applying 173 * atomic state after it has been checked and swapped. To iterate over the 174 * planes which *will* be attached (more useful in code called from 175 * &drm_mode_config_funcs.atomic_check) see 176 * drm_atomic_crtc_state_for_each_plane(). 177 */ 178 #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 179 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 180 181 /** 182 * drm_atomic_crtc_state_for_each_plane - iterate over attached planes in new state 183 * @plane: the loop cursor 184 * @crtc_state: the incoming CRTC state 185 * 186 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 187 * attached if the specified state is applied. Useful during for example 188 * in code called from &drm_mode_config_funcs.atomic_check operations, to 189 * validate the incoming state. 190 */ 191 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 192 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 193 194 /** 195 * drm_atomic_crtc_state_for_each_plane_state - iterate over attached planes in new state 196 * @plane: the loop cursor 197 * @plane_state: loop cursor for the plane's state, must be const 198 * @crtc_state: the incoming CRTC state 199 * 200 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 201 * attached if the specified state is applied. Useful during for example 202 * in code called from &drm_mode_config_funcs.atomic_check operations, to 203 * validate the incoming state. 204 * 205 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 206 * const plane_state. This is useful when a driver just wants to peek at other 207 * active planes on this CRTC, but does not need to change it. 208 */ 209 #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 210 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 211 for_each_if ((plane_state = \ 212 __drm_atomic_get_current_plane_state((crtc_state)->state, \ 213 plane))) 214 215 /** 216 * drm_atomic_plane_enabling - check whether a plane is being enabled 217 * @old_plane_state: old atomic plane state 218 * @new_plane_state: new atomic plane state 219 * 220 * Checks the atomic state of a plane to determine whether it's being enabled 221 * or not. This also WARNs if it detects an invalid state (both CRTC and FB 222 * need to either both be NULL or both be non-NULL). 223 * 224 * RETURNS: 225 * True if the plane is being enabled, false otherwise. 226 */ 227 static inline bool drm_atomic_plane_enabling(struct drm_plane_state *old_plane_state, 228 struct drm_plane_state *new_plane_state) 229 { 230 /* 231 * When enabling a plane, CRTC and FB should always be set together. 232 * Anything else should be considered a bug in the atomic core, so we 233 * gently warn about it. 234 */ 235 WARN_ON((!new_plane_state->crtc && new_plane_state->fb) || 236 (new_plane_state->crtc && !new_plane_state->fb)); 237 238 return !old_plane_state->crtc && new_plane_state->crtc; 239 } 240 241 /** 242 * drm_atomic_plane_disabling - check whether a plane is being disabled 243 * @old_plane_state: old atomic plane state 244 * @new_plane_state: new atomic plane state 245 * 246 * Checks the atomic state of a plane to determine whether it's being disabled 247 * or not. This also WARNs if it detects an invalid state (both CRTC and FB 248 * need to either both be NULL or both be non-NULL). 249 * 250 * RETURNS: 251 * True if the plane is being disabled, false otherwise. 252 */ 253 static inline bool 254 drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state, 255 struct drm_plane_state *new_plane_state) 256 { 257 /* 258 * When disabling a plane, CRTC and FB should always be NULL together. 259 * Anything else should be considered a bug in the atomic core, so we 260 * gently warn about it. 261 */ 262 WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) || 263 (new_plane_state->crtc != NULL && new_plane_state->fb == NULL)); 264 265 return old_plane_state->crtc && !new_plane_state->crtc; 266 } 267 268 u32 * 269 drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge, 270 struct drm_bridge_state *bridge_state, 271 struct drm_crtc_state *crtc_state, 272 struct drm_connector_state *conn_state, 273 u32 output_fmt, 274 unsigned int *num_input_fmts); 275 276 #endif /* DRM_ATOMIC_HELPER_H_ */ 277