drm_atomic_helper.h revision 1.1.1.1
1 /* $NetBSD: drm_atomic_helper.h,v 1.1.1.1 2018/08/27 01:35:00 riastradh Exp $ */ 2 3 /* 4 * Copyright (C) 2014 Red Hat 5 * Copyright (C) 2014 Intel Corp. 6 * 7 * Permission is hereby granted, free of charge, to any person obtaining a 8 * copy of this software and associated documentation files (the "Software"), 9 * to deal in the Software without restriction, including without limitation 10 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 11 * and/or sell copies of the Software, and to permit persons to whom the 12 * Software is furnished to do so, subject to the following conditions: 13 * 14 * The above copyright notice and this permission notice shall be included in 15 * all copies or substantial portions of the Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 20 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR 21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 23 * OTHER DEALINGS IN THE SOFTWARE. 24 * 25 * Authors: 26 * Rob Clark <robdclark (at) gmail.com> 27 * Daniel Vetter <daniel.vetter (at) ffwll.ch> 28 */ 29 30 #ifndef DRM_ATOMIC_HELPER_H_ 31 #define DRM_ATOMIC_HELPER_H_ 32 33 #include <drm/drm_crtc.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 int drm_atomic_helper_commit(struct drm_device *dev, 44 struct drm_atomic_state *state, 45 bool async); 46 47 void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 48 struct drm_atomic_state *old_state); 49 50 void 51 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 52 struct drm_atomic_state *old_state); 53 54 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 55 struct drm_atomic_state *state); 56 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 57 struct drm_atomic_state *old_state); 58 59 int drm_atomic_helper_prepare_planes(struct drm_device *dev, 60 struct drm_atomic_state *state); 61 void drm_atomic_helper_commit_planes(struct drm_device *dev, 62 struct drm_atomic_state *state, 63 bool active_only); 64 void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 65 struct drm_atomic_state *old_state); 66 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 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_crtc_set_property(struct drm_crtc *crtc, 87 struct drm_property *property, 88 uint64_t val); 89 int drm_atomic_helper_plane_set_property(struct drm_plane *plane, 90 struct drm_property *property, 91 uint64_t val); 92 int drm_atomic_helper_connector_set_property(struct drm_connector *connector, 93 struct drm_property *property, 94 uint64_t val); 95 int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 96 struct drm_framebuffer *fb, 97 struct drm_pending_vblank_event *event, 98 uint32_t flags); 99 int drm_atomic_helper_connector_dpms(struct drm_connector *connector, 100 int mode); 101 102 /* default implementations for state handling */ 103 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 104 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 105 struct drm_crtc_state *state); 106 struct drm_crtc_state * 107 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 108 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 109 struct drm_crtc_state *state); 110 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 111 struct drm_crtc_state *state); 112 113 void drm_atomic_helper_plane_reset(struct drm_plane *plane); 114 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 115 struct drm_plane_state *state); 116 struct drm_plane_state * 117 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 118 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 119 struct drm_plane_state *state); 120 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 121 struct drm_plane_state *state); 122 123 void drm_atomic_helper_connector_reset(struct drm_connector *connector); 124 void 125 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 126 struct drm_connector_state *state); 127 struct drm_connector_state * 128 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 129 struct drm_atomic_state * 130 drm_atomic_helper_duplicate_state(struct drm_device *dev, 131 struct drm_modeset_acquire_ctx *ctx); 132 void 133 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 134 struct drm_connector_state *state); 135 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 136 struct drm_connector_state *state); 137 138 /** 139 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 140 * @plane: the loop cursor 141 * @crtc: the crtc whose planes are iterated 142 * 143 * This iterates over the current state, useful (for example) when applying 144 * atomic state after it has been checked and swapped. To iterate over the 145 * planes which *will* be attached (for ->atomic_check()) see 146 * drm_crtc_for_each_pending_plane() 147 */ 148 #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 149 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 150 151 /** 152 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 153 * @plane: the loop cursor 154 * @crtc_state: the incoming crtc-state 155 * 156 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 157 * attached if the specified state is applied. Useful during (for example) 158 * ->atomic_check() operations, to validate the incoming state 159 */ 160 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 161 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 162 163 /* 164 * drm_atomic_plane_disabling - check whether a plane is being disabled 165 * @plane: plane object 166 * @old_state: previous atomic state 167 * 168 * Checks the atomic state of a plane to determine whether it's being disabled 169 * or not. This also WARNs if it detects an invalid state (both CRTC and FB 170 * need to either both be NULL or both be non-NULL). 171 * 172 * RETURNS: 173 * True if the plane is being disabled, false otherwise. 174 */ 175 static inline bool 176 drm_atomic_plane_disabling(struct drm_plane *plane, 177 struct drm_plane_state *old_state) 178 { 179 /* 180 * When disabling a plane, CRTC and FB should always be NULL together. 181 * Anything else should be considered a bug in the atomic core, so we 182 * gently warn about it. 183 */ 184 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || 185 (plane->state->crtc != NULL && plane->state->fb == NULL)); 186 187 /* 188 * When using the transitional helpers, old_state may be NULL. If so, 189 * we know nothing about the current state and have to assume that it 190 * might be enabled. 191 * 192 * When using the atomic helpers, old_state won't be NULL. Therefore 193 * this check assumes that either the driver will have reconstructed 194 * the correct state in ->reset() or that the driver will have taken 195 * appropriate measures to disable all planes. 196 */ 197 return (!old_state || old_state->crtc) && !plane->state->crtc; 198 } 199 200 #endif /* DRM_ATOMIC_HELPER_H_ */ 201
Indexes created Sun Oct 19 02:09:48 GMT 2025