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