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 35 struct drm_atomic_state; 36 37 int drm_atomic_helper_check_modeset(struct drm_device *dev, 38 struct drm_atomic_state *state); 39 int drm_atomic_helper_check_planes(struct drm_device *dev, 40 struct drm_atomic_state *state); 41 int drm_atomic_helper_check(struct drm_device *dev, 42 struct drm_atomic_state *state); 43 void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 44 int drm_atomic_helper_commit(struct drm_device *dev, 45 struct drm_atomic_state *state, 46 bool nonblock); 47 48 int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 49 struct drm_atomic_state *state, 50 bool pre_swap); 51 52 void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 53 struct drm_atomic_state *old_state); 54 55 void 56 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 57 struct drm_atomic_state *old_state); 58 59 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 60 struct drm_atomic_state *state); 61 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 62 struct drm_atomic_state *old_state); 63 64 int drm_atomic_helper_prepare_planes(struct drm_device *dev, 65 struct drm_atomic_state *state); 66 67 #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 68 #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 69 70 void drm_atomic_helper_commit_planes(struct drm_device *dev, 71 struct drm_atomic_state *state, 72 uint32_t flags); 73 void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 74 struct drm_atomic_state *old_state); 75 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 76 void 77 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 78 bool atomic); 79 80 void drm_atomic_helper_swap_state(struct drm_atomic_state *state, 81 bool stall); 82 83 /* nonblocking commit helpers */ 84 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 85 bool nonblock); 86 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 87 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 88 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 89 90 /* implementations for legacy interfaces */ 91 int drm_atomic_helper_update_plane(struct drm_plane *plane, 92 struct drm_crtc *crtc, 93 struct drm_framebuffer *fb, 94 int crtc_x, int crtc_y, 95 unsigned int crtc_w, unsigned int crtc_h, 96 uint32_t src_x, uint32_t src_y, 97 uint32_t src_w, uint32_t src_h); 98 int drm_atomic_helper_disable_plane(struct drm_plane *plane); 99 int __drm_atomic_helper_disable_plane(struct drm_plane *plane, 100 struct drm_plane_state *plane_state); 101 int drm_atomic_helper_set_config(struct drm_mode_set *set); 102 int __drm_atomic_helper_set_config(struct drm_mode_set *set, 103 struct drm_atomic_state *state); 104 105 int drm_atomic_helper_disable_all(struct drm_device *dev, 106 struct drm_modeset_acquire_ctx *ctx); 107 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 108 int drm_atomic_helper_resume(struct drm_device *dev, 109 struct drm_atomic_state *state); 110 111 int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, 112 struct drm_property *property, 113 uint64_t val); 114 int drm_atomic_helper_plane_set_property(struct drm_plane *plane, 115 struct drm_property *property, 116 uint64_t val); 117 int drm_atomic_helper_connector_set_property(struct drm_connector *connector, 118 struct drm_property *property, 119 uint64_t val); 120 int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 121 struct drm_framebuffer *fb, 122 struct drm_pending_vblank_event *event, 123 uint32_t flags); 124 int drm_atomic_helper_page_flip_target( 125 struct drm_crtc *crtc, 126 struct drm_framebuffer *fb, 127 struct drm_pending_vblank_event *event, 128 uint32_t flags, 129 uint32_t target); 130 int drm_atomic_helper_connector_dpms(struct drm_connector *connector, 131 int mode); 132 struct drm_encoder * 133 drm_atomic_helper_best_encoder(struct drm_connector *connector); 134 135 /* default implementations for state handling */ 136 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 137 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 138 struct drm_crtc_state *state); 139 struct drm_crtc_state * 140 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 141 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state); 142 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 143 struct drm_crtc_state *state); 144 145 void drm_atomic_helper_plane_reset(struct drm_plane *plane); 146 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 147 struct drm_plane_state *state); 148 struct drm_plane_state * 149 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 150 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state); 151 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 152 struct drm_plane_state *state); 153 154 void __drm_atomic_helper_connector_reset(struct drm_connector *connector, 155 struct drm_connector_state *conn_state); 156 void drm_atomic_helper_connector_reset(struct drm_connector *connector); 157 void 158 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 159 struct drm_connector_state *state); 160 struct drm_connector_state * 161 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 162 struct drm_atomic_state * 163 drm_atomic_helper_duplicate_state(struct drm_device *dev, 164 struct drm_modeset_acquire_ctx *ctx); 165 void 166 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state); 167 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 168 struct drm_connector_state *state); 169 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 170 u16 *red, u16 *green, u16 *blue, 171 uint32_t size); 172 173 /** 174 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 175 * @plane: the loop cursor 176 * @crtc: the crtc whose planes are iterated 177 * 178 * This iterates over the current state, useful (for example) when applying 179 * atomic state after it has been checked and swapped. To iterate over the 180 * planes which *will* be attached (more useful in code called from 181 * &drm_mode_config_funcs.atomic_check) see 182 * drm_atomic_crtc_state_for_each_plane(). 183 */ 184 #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 185 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 186 187 /** 188 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 189 * @plane: the loop cursor 190 * @crtc_state: the incoming crtc-state 191 * 192 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 193 * attached if the specified state is applied. Useful during for example 194 * in code called from &drm_mode_config_funcs.atomic_check operations, to 195 * validate the incoming state. 196 */ 197 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 198 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 199 200 /** 201 * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state 202 * @plane: the loop cursor 203 * @plane_state: loop cursor for the plane's state, must be const 204 * @crtc_state: the incoming crtc-state 205 * 206 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 207 * attached if the specified state is applied. Useful during for example 208 * in code called from &drm_mode_config_funcs.atomic_check operations, to 209 * validate the incoming state. 210 * 211 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 212 * const plane_state. This is useful when a driver just wants to peek at other 213 * active planes on this crtc, but does not need to change it. 214 */ 215 #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 216 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 217 for_each_if ((plane_state = \ 218 __drm_atomic_get_current_plane_state((crtc_state)->state, \ 219 plane))) 220 221 /* 222 * drm_atomic_plane_disabling - check whether a plane is being disabled 223 * @plane: plane object 224 * @old_state: previous atomic state 225 * 226 * Checks the atomic state of a plane to determine whether it's being disabled 227 * or not. This also WARNs if it detects an invalid state (both CRTC and FB 228 * need to either both be NULL or both be non-NULL). 229 * 230 * RETURNS: 231 * True if the plane is being disabled, false otherwise. 232 */ 233 static inline bool 234 drm_atomic_plane_disabling(struct drm_plane *plane, 235 struct drm_plane_state *old_state) 236 { 237 /* 238 * When disabling a plane, CRTC and FB should always be NULL together. 239 * Anything else should be considered a bug in the atomic core, so we 240 * gently warn about it. 241 */ 242 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || 243 (plane->state->crtc != NULL && plane->state->fb == NULL)); 244 245 /* 246 * When using the transitional helpers, old_state may be NULL. If so, 247 * we know nothing about the current state and have to assume that it 248 * might be enabled. 249 * 250 * When using the atomic helpers, old_state won't be NULL. Therefore 251 * this check assumes that either the driver will have reconstructed 252 * the correct state in ->reset() or that the driver will have taken 253 * appropriate measures to disable all planes. 254 */ 255 return (!old_state || old_state->crtc) && !plane->state->crtc; 256 } 257 258 #endif /* DRM_ATOMIC_HELPER_H_ */ 259