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_connector_dpms(struct drm_connector *connector, 125 int mode); 126 struct drm_encoder * 127 drm_atomic_helper_best_encoder(struct drm_connector *connector); 128 129 /* default implementations for state handling */ 130 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 131 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 132 struct drm_crtc_state *state); 133 struct drm_crtc_state * 134 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 135 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state); 136 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 137 struct drm_crtc_state *state); 138 139 void drm_atomic_helper_plane_reset(struct drm_plane *plane); 140 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 141 struct drm_plane_state *state); 142 struct drm_plane_state * 143 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 144 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state); 145 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 146 struct drm_plane_state *state); 147 148 void __drm_atomic_helper_connector_reset(struct drm_connector *connector, 149 struct drm_connector_state *conn_state); 150 void drm_atomic_helper_connector_reset(struct drm_connector *connector); 151 void 152 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 153 struct drm_connector_state *state); 154 struct drm_connector_state * 155 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 156 struct drm_atomic_state * 157 drm_atomic_helper_duplicate_state(struct drm_device *dev, 158 struct drm_modeset_acquire_ctx *ctx); 159 void 160 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state); 161 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 162 struct drm_connector_state *state); 163 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 164 u16 *red, u16 *green, u16 *blue, 165 uint32_t size); 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 (for ->atomic_check()) see 175 * drm_atomic_crtc_state_for_each_plane(). 176 */ 177 #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 178 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 179 180 /** 181 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 182 * @plane: the loop cursor 183 * @crtc_state: the incoming crtc-state 184 * 185 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 186 * attached if the specified state is applied. Useful during (for example) 187 * ->atomic_check() operations, to validate the incoming state. 188 */ 189 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 190 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 191 192 /** 193 * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state 194 * @plane: the loop cursor 195 * @plane_state: loop cursor for the plane's state, must be const 196 * @crtc_state: the incoming crtc-state 197 * 198 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 199 * attached if the specified state is applied. Useful during (for example) 200 * ->atomic_check() operations, to validate the incoming state. 201 * 202 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 203 * const plane_state. This is useful when a driver just wants to peek at other 204 * active planes on this crtc, but does not need to change it. 205 */ 206 #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 207 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 208 for_each_if ((plane_state = \ 209 __drm_atomic_get_current_plane_state((crtc_state)->state, \ 210 plane))) 211 212 /* 213 * drm_atomic_plane_disabling - check whether a plane is being disabled 214 * @plane: plane object 215 * @old_state: previous atomic state 216 * 217 * Checks the atomic state of a plane to determine whether it's being disabled 218 * or not. This also WARNs if it detects an invalid state (both CRTC and FB 219 * need to either both be NULL or both be non-NULL). 220 * 221 * RETURNS: 222 * True if the plane is being disabled, false otherwise. 223 */ 224 static inline bool 225 drm_atomic_plane_disabling(struct drm_plane *plane, 226 struct drm_plane_state *old_state) 227 { 228 /* 229 * When disabling a plane, CRTC and FB should always be NULL together. 230 * Anything else should be considered a bug in the atomic core, so we 231 * gently warn about it. 232 */ 233 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || 234 (plane->state->crtc != NULL && plane->state->fb == NULL)); 235 236 /* 237 * When using the transitional helpers, old_state may be NULL. If so, 238 * we know nothing about the current state and have to assume that it 239 * might be enabled. 240 * 241 * When using the atomic helpers, old_state won't be NULL. Therefore 242 * this check assumes that either the driver will have reconstructed 243 * the correct state in ->reset() or that the driver will have taken 244 * appropriate measures to disable all planes. 245 */ 246 return (!old_state || old_state->crtc) && !plane->state->crtc; 247 } 248 249 #endif /* DRM_ATOMIC_HELPER_H_ */ 250