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_util.h> 35 36 struct drm_atomic_state; 37 struct drm_private_obj; 38 struct drm_private_state; 39 40 int drm_atomic_helper_check_modeset(struct drm_device *dev, 41 struct drm_atomic_state *state); 42 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state, 43 const struct drm_crtc_state *crtc_state, 44 int min_scale, 45 int max_scale, 46 bool can_position, 47 bool can_update_disabled); 48 int drm_atomic_helper_check_planes(struct drm_device *dev, 49 struct drm_atomic_state *state); 50 int drm_atomic_helper_check(struct drm_device *dev, 51 struct drm_atomic_state *state); 52 void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 53 void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state); 54 int drm_atomic_helper_commit(struct drm_device *dev, 55 struct drm_atomic_state *state, 56 bool nonblock); 57 int drm_atomic_helper_async_check(struct drm_device *dev, 58 struct drm_atomic_state *state); 59 void drm_atomic_helper_async_commit(struct drm_device *dev, 60 struct drm_atomic_state *state); 61 62 int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 63 struct drm_atomic_state *state, 64 bool pre_swap); 65 66 void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 67 struct drm_atomic_state *old_state); 68 69 void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev, 70 struct drm_atomic_state *old_state); 71 72 void 73 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 74 struct drm_atomic_state *old_state); 75 76 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 77 struct drm_atomic_state *state); 78 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 79 struct drm_atomic_state *old_state); 80 81 int drm_atomic_helper_prepare_planes(struct drm_device *dev, 82 struct drm_atomic_state *state); 83 84 #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 85 #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 86 87 void drm_atomic_helper_commit_planes(struct drm_device *dev, 88 struct drm_atomic_state *state, 89 uint32_t flags); 90 void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 91 struct drm_atomic_state *old_state); 92 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 93 void 94 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 95 bool atomic); 96 97 int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state, 98 bool stall); 99 100 /* nonblocking commit helpers */ 101 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 102 bool nonblock); 103 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 104 void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state); 105 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 106 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 107 108 /* implementations for legacy interfaces */ 109 int drm_atomic_helper_update_plane(struct drm_plane *plane, 110 struct drm_crtc *crtc, 111 struct drm_framebuffer *fb, 112 int crtc_x, int crtc_y, 113 unsigned int crtc_w, unsigned int crtc_h, 114 uint32_t src_x, uint32_t src_y, 115 uint32_t src_w, uint32_t src_h, 116 struct drm_modeset_acquire_ctx *ctx); 117 int drm_atomic_helper_disable_plane(struct drm_plane *plane, 118 struct drm_modeset_acquire_ctx *ctx); 119 int __drm_atomic_helper_disable_plane(struct drm_plane *plane, 120 struct drm_plane_state *plane_state); 121 int drm_atomic_helper_set_config(struct drm_mode_set *set, 122 struct drm_modeset_acquire_ctx *ctx); 123 int __drm_atomic_helper_set_config(struct drm_mode_set *set, 124 struct drm_atomic_state *state); 125 126 int drm_atomic_helper_disable_all(struct drm_device *dev, 127 struct drm_modeset_acquire_ctx *ctx); 128 void drm_atomic_helper_shutdown(struct drm_device *dev); 129 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 130 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state, 131 struct drm_modeset_acquire_ctx *ctx); 132 int drm_atomic_helper_resume(struct drm_device *dev, 133 struct drm_atomic_state *state); 134 135 int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 136 struct drm_framebuffer *fb, 137 struct drm_pending_vblank_event *event, 138 uint32_t flags, 139 struct drm_modeset_acquire_ctx *ctx); 140 int drm_atomic_helper_page_flip_target( 141 struct drm_crtc *crtc, 142 struct drm_framebuffer *fb, 143 struct drm_pending_vblank_event *event, 144 uint32_t flags, 145 uint32_t target, 146 struct drm_modeset_acquire_ctx *ctx); 147 struct drm_encoder * 148 drm_atomic_helper_best_encoder(struct drm_connector *connector); 149 150 /* default implementations for state handling */ 151 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 152 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 153 struct drm_crtc_state *state); 154 struct drm_crtc_state * 155 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 156 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state); 157 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 158 struct drm_crtc_state *state); 159 160 void __drm_atomic_helper_plane_reset(struct drm_plane *plane, 161 struct drm_plane_state *state); 162 void drm_atomic_helper_plane_reset(struct drm_plane *plane); 163 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 164 struct drm_plane_state *state); 165 struct drm_plane_state * 166 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 167 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state); 168 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 169 struct drm_plane_state *state); 170 171 void __drm_atomic_helper_connector_reset(struct drm_connector *connector, 172 struct drm_connector_state *conn_state); 173 void drm_atomic_helper_connector_reset(struct drm_connector *connector); 174 void 175 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 176 struct drm_connector_state *state); 177 struct drm_connector_state * 178 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 179 struct drm_atomic_state * 180 drm_atomic_helper_duplicate_state(struct drm_device *dev, 181 struct drm_modeset_acquire_ctx *ctx); 182 void 183 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state); 184 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 185 struct drm_connector_state *state); 186 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 187 u16 *red, u16 *green, u16 *blue, 188 uint32_t size, 189 struct drm_modeset_acquire_ctx *ctx); 190 void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj *obj, 191 struct drm_private_state *state); 192 193 /** 194 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 195 * @plane: the loop cursor 196 * @crtc: the crtc whose planes are iterated 197 * 198 * This iterates over the current state, useful (for example) when applying 199 * atomic state after it has been checked and swapped. To iterate over the 200 * planes which *will* be attached (more useful in code called from 201 * &drm_mode_config_funcs.atomic_check) see 202 * drm_atomic_crtc_state_for_each_plane(). 203 */ 204 #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 205 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 206 207 /** 208 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 209 * @plane: the loop cursor 210 * @crtc_state: the incoming crtc-state 211 * 212 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 213 * attached if the specified state is applied. Useful during for example 214 * in code called from &drm_mode_config_funcs.atomic_check operations, to 215 * validate the incoming state. 216 */ 217 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 218 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 219 220 /** 221 * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state 222 * @plane: the loop cursor 223 * @plane_state: loop cursor for the plane's state, must be const 224 * @crtc_state: the incoming crtc-state 225 * 226 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 227 * attached if the specified state is applied. Useful during for example 228 * in code called from &drm_mode_config_funcs.atomic_check operations, to 229 * validate the incoming state. 230 * 231 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 232 * const plane_state. This is useful when a driver just wants to peek at other 233 * active planes on this crtc, but does not need to change it. 234 */ 235 #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 236 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 237 for_each_if ((plane_state = \ 238 __drm_atomic_get_current_plane_state((crtc_state)->state, \ 239 plane))) 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 #endif /* DRM_ATOMIC_HELPER_H_ */ 269