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> 321de72fafSDaniel Vetter #include <drm/drm_modeset_helper_vtables.h> 331de72fafSDaniel Vetter #include <drm/drm_modeset_helper.h> 340254951dSThierry Reding 35bbb1e524SRob Clark struct drm_atomic_state; 36a4370c77SVille Syrjälä struct drm_private_obj; 37a4370c77SVille Syrjälä struct drm_private_state; 38bbb1e524SRob Clark 39d9b13620SDaniel Vetter int drm_atomic_helper_check_modeset(struct drm_device *dev, 40d9b13620SDaniel Vetter struct drm_atomic_state *state); 41a01cb8baSVille Syrjälä int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state, 42a01cb8baSVille Syrjälä const struct drm_crtc_state *crtc_state, 43a01cb8baSVille Syrjälä int min_scale, 44a01cb8baSVille Syrjälä int max_scale, 45a01cb8baSVille Syrjälä bool can_position, 46a01cb8baSVille Syrjälä bool can_update_disabled); 47d9b13620SDaniel Vetter int drm_atomic_helper_check_planes(struct drm_device *dev, 48d9b13620SDaniel Vetter struct drm_atomic_state *state); 49c2fcd274SDaniel Vetter int drm_atomic_helper_check(struct drm_device *dev, 50c2fcd274SDaniel Vetter struct drm_atomic_state *state); 519f2a7950SDaniel Vetter void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 5281a099acSMaxime Ripard void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state); 53623369e5SDaniel Vetter int drm_atomic_helper_commit(struct drm_device *dev, 54623369e5SDaniel Vetter struct drm_atomic_state *state, 55286dbb8dSMaarten Lankhorst bool nonblock); 56fef9df8bSGustavo Padovan int drm_atomic_helper_async_check(struct drm_device *dev, 57fef9df8bSGustavo Padovan struct drm_atomic_state *state); 58fef9df8bSGustavo Padovan void drm_atomic_helper_async_commit(struct drm_device *dev, 59fef9df8bSGustavo Padovan struct drm_atomic_state *state); 60623369e5SDaniel Vetter 61f6ce410aSGustavo Padovan int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 62f6ce410aSGustavo Padovan struct drm_atomic_state *state, 63f6ce410aSGustavo Padovan bool pre_swap); 64c240906dSJohn Keeping 655ee3229cSRob Clark void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 665ee3229cSRob Clark struct drm_atomic_state *old_state); 675ee3229cSRob Clark 6801086487SBoris Brezillon void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev, 6901086487SBoris Brezillon struct drm_atomic_state *old_state); 7001086487SBoris Brezillon 714c18d301SDaniel Vetter void 724c18d301SDaniel Vetter drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 734c18d301SDaniel Vetter struct drm_atomic_state *old_state); 744c18d301SDaniel Vetter 751af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 76623369e5SDaniel Vetter struct drm_atomic_state *state); 771af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 78623369e5SDaniel Vetter struct drm_atomic_state *old_state); 79c2fcd274SDaniel Vetter 80c2fcd274SDaniel Vetter int drm_atomic_helper_prepare_planes(struct drm_device *dev, 81c2fcd274SDaniel Vetter struct drm_atomic_state *state); 822b58e98dSLiu Ying 832b58e98dSLiu Ying #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 842b58e98dSLiu Ying #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 852b58e98dSLiu Ying 86c2fcd274SDaniel Vetter void drm_atomic_helper_commit_planes(struct drm_device *dev, 87aef9dbb8SDaniel Vetter struct drm_atomic_state *state, 882b58e98dSLiu Ying uint32_t flags); 89c2fcd274SDaniel Vetter void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 90c2fcd274SDaniel Vetter struct drm_atomic_state *old_state); 91de28d021SMaarten Lankhorst void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 9228500291SLiu Ying void 9328500291SLiu Ying drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 946753ba97SJyri Sarha bool atomic); 95c2fcd274SDaniel Vetter 968a39374eSMaarten Lankhorst int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state, 978a39374eSMaarten Lankhorst bool stall); 98c2fcd274SDaniel Vetter 99a095caa7SDaniel Vetter /* nonblocking commit helpers */ 100a095caa7SDaniel Vetter int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 101a095caa7SDaniel Vetter bool nonblock); 102a095caa7SDaniel Vetter void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 103b25c60afSBoris Brezillon void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state); 104a095caa7SDaniel Vetter void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 105a095caa7SDaniel Vetter void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 106a095caa7SDaniel Vetter 107042652edSDaniel Vetter /* implementations for legacy interfaces */ 108042652edSDaniel Vetter int drm_atomic_helper_update_plane(struct drm_plane *plane, 109042652edSDaniel Vetter struct drm_crtc *crtc, 110042652edSDaniel Vetter struct drm_framebuffer *fb, 111042652edSDaniel Vetter int crtc_x, int crtc_y, 112042652edSDaniel Vetter unsigned int crtc_w, unsigned int crtc_h, 113042652edSDaniel Vetter uint32_t src_x, uint32_t src_y, 11434a2ab5eSDaniel Vetter uint32_t src_w, uint32_t src_h, 11534a2ab5eSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 11619315294SDaniel Vetter int drm_atomic_helper_disable_plane(struct drm_plane *plane, 11719315294SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 118bbb1e524SRob Clark int __drm_atomic_helper_disable_plane(struct drm_plane *plane, 119bbb1e524SRob Clark struct drm_plane_state *plane_state); 120a4eff9aaSDaniel Vetter int drm_atomic_helper_set_config(struct drm_mode_set *set, 121a4eff9aaSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 122bbb1e524SRob Clark int __drm_atomic_helper_set_config(struct drm_mode_set *set, 123bbb1e524SRob Clark struct drm_atomic_state *state); 124042652edSDaniel Vetter 12514942760SThierry Reding int drm_atomic_helper_disable_all(struct drm_device *dev, 12614942760SThierry Reding struct drm_modeset_acquire_ctx *ctx); 12718dddadcSDaniel Vetter void drm_atomic_helper_shutdown(struct drm_device *dev); 12814942760SThierry Reding struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 129581e49feSMaarten Lankhorst int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state, 130581e49feSMaarten Lankhorst struct drm_modeset_acquire_ctx *ctx); 13114942760SThierry Reding int drm_atomic_helper_resume(struct drm_device *dev, 13214942760SThierry Reding struct drm_atomic_state *state); 13314942760SThierry Reding 1348bc0f312SDaniel Vetter int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 1358bc0f312SDaniel Vetter struct drm_framebuffer *fb, 1368bc0f312SDaniel Vetter struct drm_pending_vblank_event *event, 13741292b1fSDaniel Vetter uint32_t flags, 13841292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 139f869a6ecSAndrey Grodzovsky int drm_atomic_helper_page_flip_target( 140f869a6ecSAndrey Grodzovsky struct drm_crtc *crtc, 141f869a6ecSAndrey Grodzovsky struct drm_framebuffer *fb, 142f869a6ecSAndrey Grodzovsky struct drm_pending_vblank_event *event, 143f869a6ecSAndrey Grodzovsky uint32_t flags, 14441292b1fSDaniel Vetter uint32_t target, 14541292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 1469ecb5498SNoralf Trønnes struct drm_encoder * 1479ecb5498SNoralf Trønnes drm_atomic_helper_best_encoder(struct drm_connector *connector); 1488bc0f312SDaniel Vetter 149d461701cSDaniel Vetter /* default implementations for state handling */ 150d461701cSDaniel Vetter void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 151f5e7840bSThierry Reding void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 152f5e7840bSThierry Reding struct drm_crtc_state *state); 153d461701cSDaniel Vetter struct drm_crtc_state * 154d461701cSDaniel Vetter drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 155ec2dc6a0SDaniel Vetter void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state); 156d461701cSDaniel Vetter void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 157d461701cSDaniel Vetter struct drm_crtc_state *state); 158d461701cSDaniel Vetter 159d461701cSDaniel Vetter void drm_atomic_helper_plane_reset(struct drm_plane *plane); 160f5e7840bSThierry Reding void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 161f5e7840bSThierry Reding struct drm_plane_state *state); 162d461701cSDaniel Vetter struct drm_plane_state * 163d461701cSDaniel Vetter drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 1642f701695SDaniel Vetter void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state); 165d461701cSDaniel Vetter void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 166d461701cSDaniel Vetter struct drm_plane_state *state); 167d461701cSDaniel Vetter 1684cd39917SMaarten Lankhorst void __drm_atomic_helper_connector_reset(struct drm_connector *connector, 1694cd39917SMaarten Lankhorst struct drm_connector_state *conn_state); 170d461701cSDaniel Vetter void drm_atomic_helper_connector_reset(struct drm_connector *connector); 171f5e7840bSThierry Reding void 172f5e7840bSThierry Reding __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 173f5e7840bSThierry Reding struct drm_connector_state *state); 174d461701cSDaniel Vetter struct drm_connector_state * 175d461701cSDaniel Vetter drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 176397fd77cSThierry Reding struct drm_atomic_state * 177397fd77cSThierry Reding drm_atomic_helper_duplicate_state(struct drm_device *dev, 178397fd77cSThierry Reding struct drm_modeset_acquire_ctx *ctx); 179f5e7840bSThierry Reding void 180fabd9106SDaniel Vetter __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state); 181d461701cSDaniel Vetter void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 182d461701cSDaniel Vetter struct drm_connector_state *state); 1837ea77283SMaarten Lankhorst int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 1845488dc16SLionel Landwerlin u16 *red, u16 *green, u16 *blue, 1856d124ff8SDaniel Vetter uint32_t size, 1866d124ff8SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 187a4370c77SVille Syrjälä void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj *obj, 188a4370c77SVille Syrjälä struct drm_private_state *state); 189d461701cSDaniel Vetter 190dd275956SRob Clark /** 191dd275956SRob Clark * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 192dd275956SRob Clark * @plane: the loop cursor 193dd275956SRob Clark * @crtc: the crtc whose planes are iterated 194dd275956SRob Clark * 195dd275956SRob Clark * This iterates over the current state, useful (for example) when applying 196dd275956SRob Clark * atomic state after it has been checked and swapped. To iterate over the 1976806cdf9SDaniel Vetter * planes which *will* be attached (more useful in code called from 1986806cdf9SDaniel Vetter * &drm_mode_config_funcs.atomic_check) see 1995c0be3f1SLiviu Dudau * drm_atomic_crtc_state_for_each_plane(). 200dd275956SRob Clark */ 201dd275956SRob Clark #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 202dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 203dd275956SRob Clark 204dd275956SRob Clark /** 205dd275956SRob Clark * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 206dd275956SRob Clark * @plane: the loop cursor 207dd275956SRob Clark * @crtc_state: the incoming crtc-state 208dd275956SRob Clark * 209dd275956SRob Clark * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 2106806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 2116806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 2126806cdf9SDaniel Vetter * validate the incoming state. 213dd275956SRob Clark */ 214dd275956SRob Clark #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 215dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 216042652edSDaniel Vetter 2172f196b7cSDaniel Vetter /** 2182f196b7cSDaniel Vetter * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state 2192f196b7cSDaniel Vetter * @plane: the loop cursor 2202f196b7cSDaniel Vetter * @plane_state: loop cursor for the plane's state, must be const 2212f196b7cSDaniel Vetter * @crtc_state: the incoming crtc-state 2222f196b7cSDaniel Vetter * 2232f196b7cSDaniel Vetter * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 2246806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 2256806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 2266806cdf9SDaniel Vetter * validate the incoming state. 2272f196b7cSDaniel Vetter * 2282f196b7cSDaniel Vetter * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 2292f196b7cSDaniel Vetter * const plane_state. This is useful when a driver just wants to peek at other 2302f196b7cSDaniel Vetter * active planes on this crtc, but does not need to change it. 2312f196b7cSDaniel Vetter */ 2322f196b7cSDaniel Vetter #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 2332f196b7cSDaniel Vetter drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 2342f196b7cSDaniel Vetter for_each_if ((plane_state = \ 2352f196b7cSDaniel Vetter __drm_atomic_get_current_plane_state((crtc_state)->state, \ 2362f196b7cSDaniel Vetter plane))) 2372f196b7cSDaniel Vetter 23851ffa12dSMaarten Lankhorst /** 239407b8bd9SThierry Reding * drm_atomic_plane_disabling - check whether a plane is being disabled 24051ffa12dSMaarten Lankhorst * @old_plane_state: old atomic plane state 24151ffa12dSMaarten Lankhorst * @new_plane_state: new atomic plane state 242407b8bd9SThierry Reding * 243407b8bd9SThierry Reding * Checks the atomic state of a plane to determine whether it's being disabled 244407b8bd9SThierry Reding * or not. This also WARNs if it detects an invalid state (both CRTC and FB 245407b8bd9SThierry Reding * need to either both be NULL or both be non-NULL). 246407b8bd9SThierry Reding * 247407b8bd9SThierry Reding * RETURNS: 248407b8bd9SThierry Reding * True if the plane is being disabled, false otherwise. 249407b8bd9SThierry Reding */ 250407b8bd9SThierry Reding static inline bool 25151ffa12dSMaarten Lankhorst drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state, 25251ffa12dSMaarten Lankhorst struct drm_plane_state *new_plane_state) 253407b8bd9SThierry Reding { 254407b8bd9SThierry Reding /* 255407b8bd9SThierry Reding * When disabling a plane, CRTC and FB should always be NULL together. 256407b8bd9SThierry Reding * Anything else should be considered a bug in the atomic core, so we 257407b8bd9SThierry Reding * gently warn about it. 258407b8bd9SThierry Reding */ 25951ffa12dSMaarten Lankhorst WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) || 26051ffa12dSMaarten Lankhorst (new_plane_state->crtc != NULL && new_plane_state->fb == NULL)); 261407b8bd9SThierry Reding 26251ffa12dSMaarten Lankhorst return old_plane_state->crtc && !new_plane_state->crtc; 263407b8bd9SThierry Reding } 264407b8bd9SThierry Reding 265c2fcd274SDaniel Vetter #endif /* DRM_ATOMIC_HELPER_H_ */ 266