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