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