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 33 struct drm_atomic_state; 34 35 int drm_atomic_helper_check_modeset(struct drm_device *dev, 36 struct drm_atomic_state *state); 37 int drm_atomic_helper_check_planes(struct drm_device *dev, 38 struct drm_atomic_state *state); 39 int drm_atomic_helper_check(struct drm_device *dev, 40 struct drm_atomic_state *state); 41 int drm_atomic_helper_commit(struct drm_device *dev, 42 struct drm_atomic_state *state, 43 bool async); 44 45 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev, 46 struct drm_atomic_state *old_state, 47 struct drm_crtc *crtc); 48 49 void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 50 struct drm_atomic_state *old_state); 51 52 void 53 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 54 struct drm_atomic_state *old_state); 55 56 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 57 struct drm_atomic_state *state); 58 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 59 struct drm_atomic_state *old_state); 60 61 int drm_atomic_helper_prepare_planes(struct drm_device *dev, 62 struct drm_atomic_state *state); 63 void drm_atomic_helper_commit_planes(struct drm_device *dev, 64 struct drm_atomic_state *state, 65 bool active_only); 66 void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 67 struct drm_atomic_state *old_state); 68 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 69 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc, 70 bool atomic); 71 72 void drm_atomic_helper_swap_state(struct drm_device *dev, 73 struct drm_atomic_state *state); 74 75 /* implementations for legacy interfaces */ 76 int drm_atomic_helper_update_plane(struct drm_plane *plane, 77 struct drm_crtc *crtc, 78 struct drm_framebuffer *fb, 79 int crtc_x, int crtc_y, 80 unsigned int crtc_w, unsigned int crtc_h, 81 uint32_t src_x, uint32_t src_y, 82 uint32_t src_w, uint32_t src_h); 83 int drm_atomic_helper_disable_plane(struct drm_plane *plane); 84 int __drm_atomic_helper_disable_plane(struct drm_plane *plane, 85 struct drm_plane_state *plane_state); 86 int drm_atomic_helper_set_config(struct drm_mode_set *set); 87 int __drm_atomic_helper_set_config(struct drm_mode_set *set, 88 struct drm_atomic_state *state); 89 90 int drm_atomic_helper_disable_all(struct drm_device *dev, 91 struct drm_modeset_acquire_ctx *ctx); 92 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 93 int drm_atomic_helper_resume(struct drm_device *dev, 94 struct drm_atomic_state *state); 95 96 int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, 97 struct drm_property *property, 98 uint64_t val); 99 int drm_atomic_helper_plane_set_property(struct drm_plane *plane, 100 struct drm_property *property, 101 uint64_t val); 102 int drm_atomic_helper_connector_set_property(struct drm_connector *connector, 103 struct drm_property *property, 104 uint64_t val); 105 int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 106 struct drm_framebuffer *fb, 107 struct drm_pending_vblank_event *event, 108 uint32_t flags); 109 int drm_atomic_helper_connector_dpms(struct drm_connector *connector, 110 int mode); 111 112 /* default implementations for state handling */ 113 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 114 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 115 struct drm_crtc_state *state); 116 struct drm_crtc_state * 117 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 118 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 119 struct drm_crtc_state *state); 120 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 121 struct drm_crtc_state *state); 122 123 void drm_atomic_helper_plane_reset(struct drm_plane *plane); 124 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 125 struct drm_plane_state *state); 126 struct drm_plane_state * 127 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 128 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 129 struct drm_plane_state *state); 130 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 131 struct drm_plane_state *state); 132 133 void __drm_atomic_helper_connector_reset(struct drm_connector *connector, 134 struct drm_connector_state *conn_state); 135 void drm_atomic_helper_connector_reset(struct drm_connector *connector); 136 void 137 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 138 struct drm_connector_state *state); 139 struct drm_connector_state * 140 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 141 struct drm_atomic_state * 142 drm_atomic_helper_duplicate_state(struct drm_device *dev, 143 struct drm_modeset_acquire_ctx *ctx); 144 void 145 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 146 struct drm_connector_state *state); 147 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 148 struct drm_connector_state *state); 149 void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 150 u16 *red, u16 *green, u16 *blue, 151 uint32_t start, uint32_t size); 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 (for ->atomic_check()) see 161 * drm_crtc_for_each_pending_plane() 162 */ 163 #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 164 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 165 166 /** 167 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 168 * @plane: the loop cursor 169 * @crtc_state: the incoming crtc-state 170 * 171 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 172 * attached if the specified state is applied. Useful during (for example) 173 * ->atomic_check() operations, to validate the incoming state 174 */ 175 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 176 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 177 178 /* 179 * drm_atomic_plane_disabling - check whether a plane is being disabled 180 * @plane: plane object 181 * @old_state: previous atomic state 182 * 183 * Checks the atomic state of a plane to determine whether it's being disabled 184 * or not. This also WARNs if it detects an invalid state (both CRTC and FB 185 * need to either both be NULL or both be non-NULL). 186 * 187 * RETURNS: 188 * True if the plane is being disabled, false otherwise. 189 */ 190 static inline bool 191 drm_atomic_plane_disabling(struct drm_plane *plane, 192 struct drm_plane_state *old_state) 193 { 194 /* 195 * When disabling a plane, CRTC and FB should always be NULL together. 196 * Anything else should be considered a bug in the atomic core, so we 197 * gently warn about it. 198 */ 199 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || 200 (plane->state->crtc != NULL && plane->state->fb == NULL)); 201 202 /* 203 * When using the transitional helpers, old_state may be NULL. If so, 204 * we know nothing about the current state and have to assume that it 205 * might be enabled. 206 * 207 * When using the atomic helpers, old_state won't be NULL. Therefore 208 * this check assumes that either the driver will have reconstructed 209 * the correct state in ->reset() or that the driver will have taken 210 * appropriate measures to disable all planes. 211 */ 212 return (!old_state || old_state->crtc) && !plane->state->crtc; 213 } 214 215 #endif /* DRM_ATOMIC_HELPER_H_ */ 216