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