1c2fcd274SDaniel Vetter /* 2c2fcd274SDaniel Vetter * Copyright (C) 2014 Red Hat 3c2fcd274SDaniel Vetter * Copyright (C) 2014 Intel Corp. 4c2fcd274SDaniel Vetter * 5c2fcd274SDaniel Vetter * Permission is hereby granted, free of charge, to any person obtaining a 6c2fcd274SDaniel Vetter * copy of this software and associated documentation files (the "Software"), 7c2fcd274SDaniel Vetter * to deal in the Software without restriction, including without limitation 8c2fcd274SDaniel Vetter * the rights to use, copy, modify, merge, publish, distribute, sublicense, 9c2fcd274SDaniel Vetter * and/or sell copies of the Software, and to permit persons to whom the 10c2fcd274SDaniel Vetter * Software is furnished to do so, subject to the following conditions: 11c2fcd274SDaniel Vetter * 12c2fcd274SDaniel Vetter * The above copyright notice and this permission notice shall be included in 13c2fcd274SDaniel Vetter * all copies or substantial portions of the Software. 14c2fcd274SDaniel Vetter * 15c2fcd274SDaniel Vetter * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16c2fcd274SDaniel Vetter * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17c2fcd274SDaniel Vetter * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 18c2fcd274SDaniel Vetter * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR 19c2fcd274SDaniel Vetter * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 20c2fcd274SDaniel Vetter * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 21c2fcd274SDaniel Vetter * OTHER DEALINGS IN THE SOFTWARE. 22c2fcd274SDaniel Vetter * 23c2fcd274SDaniel Vetter * Authors: 24c2fcd274SDaniel Vetter * Rob Clark <robdclark@gmail.com> 25c2fcd274SDaniel Vetter * Daniel Vetter <daniel.vetter@ffwll.ch> 26c2fcd274SDaniel Vetter */ 27c2fcd274SDaniel Vetter 28c2fcd274SDaniel Vetter #ifndef DRM_ATOMIC_HELPER_H_ 29c2fcd274SDaniel Vetter #define DRM_ATOMIC_HELPER_H_ 30c2fcd274SDaniel Vetter 310254951dSThierry Reding #include <drm/drm_crtc.h> 320254951dSThierry Reding 33d9b13620SDaniel Vetter int drm_atomic_helper_check_modeset(struct drm_device *dev, 34d9b13620SDaniel Vetter struct drm_atomic_state *state); 35d9b13620SDaniel Vetter int drm_atomic_helper_check_planes(struct drm_device *dev, 36d9b13620SDaniel Vetter struct drm_atomic_state *state); 37c2fcd274SDaniel Vetter int drm_atomic_helper_check(struct drm_device *dev, 38c2fcd274SDaniel Vetter struct drm_atomic_state *state); 39623369e5SDaniel Vetter int drm_atomic_helper_commit(struct drm_device *dev, 40623369e5SDaniel Vetter struct drm_atomic_state *state, 41623369e5SDaniel Vetter bool async); 42623369e5SDaniel Vetter 435ee3229cSRob Clark void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 445ee3229cSRob Clark struct drm_atomic_state *old_state); 455ee3229cSRob Clark 464c18d301SDaniel Vetter void 474c18d301SDaniel Vetter drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 484c18d301SDaniel Vetter struct drm_atomic_state *old_state); 494c18d301SDaniel Vetter 501af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 51623369e5SDaniel Vetter struct drm_atomic_state *state); 521af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 53623369e5SDaniel Vetter struct drm_atomic_state *old_state); 54c2fcd274SDaniel Vetter 55c2fcd274SDaniel Vetter int drm_atomic_helper_prepare_planes(struct drm_device *dev, 56c2fcd274SDaniel Vetter struct drm_atomic_state *state); 57c2fcd274SDaniel Vetter void drm_atomic_helper_commit_planes(struct drm_device *dev, 58c2fcd274SDaniel Vetter struct drm_atomic_state *state); 59c2fcd274SDaniel Vetter void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 60c2fcd274SDaniel Vetter struct drm_atomic_state *old_state); 61de28d021SMaarten Lankhorst void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 62c2fcd274SDaniel Vetter 63c2fcd274SDaniel Vetter void drm_atomic_helper_swap_state(struct drm_device *dev, 64c2fcd274SDaniel Vetter struct drm_atomic_state *state); 65c2fcd274SDaniel Vetter 66042652edSDaniel Vetter /* implementations for legacy interfaces */ 67042652edSDaniel Vetter int drm_atomic_helper_update_plane(struct drm_plane *plane, 68042652edSDaniel Vetter struct drm_crtc *crtc, 69042652edSDaniel Vetter struct drm_framebuffer *fb, 70042652edSDaniel Vetter int crtc_x, int crtc_y, 71042652edSDaniel Vetter unsigned int crtc_w, unsigned int crtc_h, 72042652edSDaniel Vetter uint32_t src_x, uint32_t src_y, 73042652edSDaniel Vetter uint32_t src_w, uint32_t src_h); 74042652edSDaniel Vetter int drm_atomic_helper_disable_plane(struct drm_plane *plane); 75042652edSDaniel Vetter int drm_atomic_helper_set_config(struct drm_mode_set *set); 76042652edSDaniel Vetter 77042652edSDaniel Vetter int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, 78042652edSDaniel Vetter struct drm_property *property, 79042652edSDaniel Vetter uint64_t val); 80042652edSDaniel Vetter int drm_atomic_helper_plane_set_property(struct drm_plane *plane, 81042652edSDaniel Vetter struct drm_property *property, 82042652edSDaniel Vetter uint64_t val); 83042652edSDaniel Vetter int drm_atomic_helper_connector_set_property(struct drm_connector *connector, 84042652edSDaniel Vetter struct drm_property *property, 85042652edSDaniel Vetter uint64_t val); 868bc0f312SDaniel Vetter int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 878bc0f312SDaniel Vetter struct drm_framebuffer *fb, 888bc0f312SDaniel Vetter struct drm_pending_vblank_event *event, 898bc0f312SDaniel Vetter uint32_t flags); 90b486e0e6SDaniel Vetter void drm_atomic_helper_connector_dpms(struct drm_connector *connector, 91b486e0e6SDaniel Vetter int mode); 928bc0f312SDaniel Vetter 93d461701cSDaniel Vetter /* default implementations for state handling */ 94d461701cSDaniel Vetter void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 95f5e7840bSThierry Reding void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 96f5e7840bSThierry Reding struct drm_crtc_state *state); 97d461701cSDaniel Vetter struct drm_crtc_state * 98d461701cSDaniel Vetter drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 99f5e7840bSThierry Reding void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 100f5e7840bSThierry Reding struct drm_crtc_state *state); 101d461701cSDaniel Vetter void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 102d461701cSDaniel Vetter struct drm_crtc_state *state); 103d461701cSDaniel Vetter 104d461701cSDaniel Vetter void drm_atomic_helper_plane_reset(struct drm_plane *plane); 105f5e7840bSThierry Reding void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 106f5e7840bSThierry Reding struct drm_plane_state *state); 107d461701cSDaniel Vetter struct drm_plane_state * 108d461701cSDaniel Vetter drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 109f5e7840bSThierry Reding void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 110f5e7840bSThierry Reding struct drm_plane_state *state); 111d461701cSDaniel Vetter void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 112d461701cSDaniel Vetter struct drm_plane_state *state); 113d461701cSDaniel Vetter 114d461701cSDaniel Vetter void drm_atomic_helper_connector_reset(struct drm_connector *connector); 115f5e7840bSThierry Reding void 116f5e7840bSThierry Reding __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 117f5e7840bSThierry Reding struct drm_connector_state *state); 118d461701cSDaniel Vetter struct drm_connector_state * 119d461701cSDaniel Vetter drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 120f5e7840bSThierry Reding void 121f5e7840bSThierry Reding __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 122f5e7840bSThierry Reding struct drm_connector_state *state); 123d461701cSDaniel Vetter void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 124d461701cSDaniel Vetter struct drm_connector_state *state); 125d461701cSDaniel Vetter 126dd275956SRob Clark /** 127dd275956SRob Clark * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 128dd275956SRob Clark * @plane: the loop cursor 129dd275956SRob Clark * @crtc: the crtc whose planes are iterated 130dd275956SRob Clark * 131dd275956SRob Clark * This iterates over the current state, useful (for example) when applying 132dd275956SRob Clark * atomic state after it has been checked and swapped. To iterate over the 133dd275956SRob Clark * planes which *will* be attached (for ->atomic_check()) see 134dd275956SRob Clark * drm_crtc_for_each_pending_plane() 135dd275956SRob Clark */ 136dd275956SRob Clark #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 137dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 138dd275956SRob Clark 139dd275956SRob Clark /** 140dd275956SRob Clark * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 141dd275956SRob Clark * @plane: the loop cursor 142dd275956SRob Clark * @crtc_state: the incoming crtc-state 143dd275956SRob Clark * 144dd275956SRob Clark * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 145dd275956SRob Clark * attached if the specified state is applied. Useful during (for example) 146dd275956SRob Clark * ->atomic_check() operations, to validate the incoming state 147dd275956SRob Clark */ 148dd275956SRob Clark #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 149dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 150042652edSDaniel Vetter 151407b8bd9SThierry Reding /* 152407b8bd9SThierry Reding * drm_atomic_plane_disabling - check whether a plane is being disabled 153407b8bd9SThierry Reding * @plane: plane object 154407b8bd9SThierry Reding * @old_state: previous atomic state 155407b8bd9SThierry Reding * 156407b8bd9SThierry Reding * Checks the atomic state of a plane to determine whether it's being disabled 157407b8bd9SThierry Reding * or not. This also WARNs if it detects an invalid state (both CRTC and FB 158407b8bd9SThierry Reding * need to either both be NULL or both be non-NULL). 159407b8bd9SThierry Reding * 160407b8bd9SThierry Reding * RETURNS: 161407b8bd9SThierry Reding * True if the plane is being disabled, false otherwise. 162407b8bd9SThierry Reding */ 163407b8bd9SThierry Reding static inline bool 164407b8bd9SThierry Reding drm_atomic_plane_disabling(struct drm_plane *plane, 165407b8bd9SThierry Reding struct drm_plane_state *old_state) 166407b8bd9SThierry Reding { 167407b8bd9SThierry Reding /* 168407b8bd9SThierry Reding * When disabling a plane, CRTC and FB should always be NULL together. 169407b8bd9SThierry Reding * Anything else should be considered a bug in the atomic core, so we 170407b8bd9SThierry Reding * gently warn about it. 171407b8bd9SThierry Reding */ 172407b8bd9SThierry Reding WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || 173407b8bd9SThierry Reding (plane->state->crtc != NULL && plane->state->fb == NULL)); 174407b8bd9SThierry Reding 175407b8bd9SThierry Reding /* 176407b8bd9SThierry Reding * When using the transitional helpers, old_state may be NULL. If so, 177407b8bd9SThierry Reding * we know nothing about the current state and have to assume that it 178407b8bd9SThierry Reding * might be enabled. 179407b8bd9SThierry Reding * 180407b8bd9SThierry Reding * When using the atomic helpers, old_state won't be NULL. Therefore 181407b8bd9SThierry Reding * this check assumes that either the driver will have reconstructed 182407b8bd9SThierry Reding * the correct state in ->reset() or that the driver will have taken 183407b8bd9SThierry Reding * appropriate measures to disable all planes. 184407b8bd9SThierry Reding */ 185407b8bd9SThierry Reding return (!old_state || old_state->crtc) && !plane->state->crtc; 186407b8bd9SThierry Reding } 187407b8bd9SThierry Reding 188c2fcd274SDaniel Vetter #endif /* DRM_ATOMIC_HELPER_H_ */ 189