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