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> 349ef8a9dcSDaniel Vetter #include <drm/drm_atomic_state_helper.h> 35d78aa650SDaniel Vetter #include <drm/drm_util.h> 360254951dSThierry Reding 37bbb1e524SRob Clark struct drm_atomic_state; 38a4370c77SVille Syrjälä struct drm_private_obj; 39a4370c77SVille Syrjälä struct drm_private_state; 40bbb1e524SRob Clark 41d9b13620SDaniel Vetter int drm_atomic_helper_check_modeset(struct drm_device *dev, 42d9b13620SDaniel Vetter struct drm_atomic_state *state); 43a01cb8baSVille Syrjälä int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state, 44a01cb8baSVille Syrjälä const struct drm_crtc_state *crtc_state, 45a01cb8baSVille Syrjälä int min_scale, 46a01cb8baSVille Syrjälä int max_scale, 47a01cb8baSVille Syrjälä bool can_position, 48a01cb8baSVille Syrjälä bool can_update_disabled); 49d9b13620SDaniel Vetter int drm_atomic_helper_check_planes(struct drm_device *dev, 50d9b13620SDaniel Vetter struct drm_atomic_state *state); 51c2fcd274SDaniel Vetter int drm_atomic_helper_check(struct drm_device *dev, 52c2fcd274SDaniel Vetter struct drm_atomic_state *state); 539f2a7950SDaniel Vetter void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 5481a099acSMaxime Ripard void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state); 55623369e5SDaniel Vetter int drm_atomic_helper_commit(struct drm_device *dev, 56623369e5SDaniel Vetter struct drm_atomic_state *state, 57286dbb8dSMaarten Lankhorst bool nonblock); 58fef9df8bSGustavo Padovan int drm_atomic_helper_async_check(struct drm_device *dev, 59fef9df8bSGustavo Padovan struct drm_atomic_state *state); 60fef9df8bSGustavo Padovan void drm_atomic_helper_async_commit(struct drm_device *dev, 61fef9df8bSGustavo Padovan struct drm_atomic_state *state); 62623369e5SDaniel Vetter 63f6ce410aSGustavo Padovan int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 64f6ce410aSGustavo Padovan struct drm_atomic_state *state, 65f6ce410aSGustavo Padovan bool pre_swap); 66c240906dSJohn Keeping 675ee3229cSRob Clark void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 685ee3229cSRob Clark struct drm_atomic_state *old_state); 695ee3229cSRob Clark 7001086487SBoris Brezillon void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev, 7101086487SBoris Brezillon struct drm_atomic_state *old_state); 7201086487SBoris Brezillon 734c18d301SDaniel Vetter void 744c18d301SDaniel Vetter drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 754c18d301SDaniel Vetter struct drm_atomic_state *old_state); 764c18d301SDaniel Vetter 771af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 78623369e5SDaniel Vetter struct drm_atomic_state *state); 791af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 80623369e5SDaniel Vetter struct drm_atomic_state *old_state); 81c2fcd274SDaniel Vetter 82c2fcd274SDaniel Vetter int drm_atomic_helper_prepare_planes(struct drm_device *dev, 83c2fcd274SDaniel Vetter struct drm_atomic_state *state); 842b58e98dSLiu Ying 852b58e98dSLiu Ying #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 862b58e98dSLiu Ying #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 872b58e98dSLiu Ying 88c2fcd274SDaniel Vetter void drm_atomic_helper_commit_planes(struct drm_device *dev, 89aef9dbb8SDaniel Vetter struct drm_atomic_state *state, 902b58e98dSLiu Ying uint32_t flags); 91c2fcd274SDaniel Vetter void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 92c2fcd274SDaniel Vetter struct drm_atomic_state *old_state); 93de28d021SMaarten Lankhorst void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 9428500291SLiu Ying void 9528500291SLiu Ying drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 966753ba97SJyri Sarha bool atomic); 97c2fcd274SDaniel Vetter 988a39374eSMaarten Lankhorst int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state, 998a39374eSMaarten Lankhorst bool stall); 100c2fcd274SDaniel Vetter 101a095caa7SDaniel Vetter /* nonblocking commit helpers */ 102a095caa7SDaniel Vetter int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 103a095caa7SDaniel Vetter bool nonblock); 104a095caa7SDaniel Vetter void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 105b25c60afSBoris Brezillon void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state); 106a095caa7SDaniel Vetter void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 107a095caa7SDaniel Vetter void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 108a095caa7SDaniel Vetter 109042652edSDaniel Vetter /* implementations for legacy interfaces */ 110042652edSDaniel Vetter int drm_atomic_helper_update_plane(struct drm_plane *plane, 111042652edSDaniel Vetter struct drm_crtc *crtc, 112042652edSDaniel Vetter struct drm_framebuffer *fb, 113042652edSDaniel Vetter int crtc_x, int crtc_y, 114042652edSDaniel Vetter unsigned int crtc_w, unsigned int crtc_h, 115042652edSDaniel Vetter uint32_t src_x, uint32_t src_y, 11634a2ab5eSDaniel Vetter uint32_t src_w, uint32_t src_h, 11734a2ab5eSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 11819315294SDaniel Vetter int drm_atomic_helper_disable_plane(struct drm_plane *plane, 11919315294SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 120a4eff9aaSDaniel Vetter int drm_atomic_helper_set_config(struct drm_mode_set *set, 121a4eff9aaSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 122042652edSDaniel Vetter 12314942760SThierry Reding int drm_atomic_helper_disable_all(struct drm_device *dev, 12414942760SThierry Reding struct drm_modeset_acquire_ctx *ctx); 12518dddadcSDaniel Vetter void drm_atomic_helper_shutdown(struct drm_device *dev); 1261d8224e7SDaniel Vetter struct drm_atomic_state * 1271d8224e7SDaniel Vetter drm_atomic_helper_duplicate_state(struct drm_device *dev, 1281d8224e7SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 12914942760SThierry Reding struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 130581e49feSMaarten Lankhorst int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state, 131581e49feSMaarten Lankhorst struct drm_modeset_acquire_ctx *ctx); 13214942760SThierry Reding int drm_atomic_helper_resume(struct drm_device *dev, 13314942760SThierry Reding struct drm_atomic_state *state); 13414942760SThierry Reding 1358bc0f312SDaniel Vetter int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 1368bc0f312SDaniel Vetter struct drm_framebuffer *fb, 1378bc0f312SDaniel Vetter struct drm_pending_vblank_event *event, 13841292b1fSDaniel Vetter uint32_t flags, 13941292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 140f869a6ecSAndrey Grodzovsky int drm_atomic_helper_page_flip_target( 141f869a6ecSAndrey Grodzovsky struct drm_crtc *crtc, 142f869a6ecSAndrey Grodzovsky struct drm_framebuffer *fb, 143f869a6ecSAndrey Grodzovsky struct drm_pending_vblank_event *event, 144f869a6ecSAndrey Grodzovsky uint32_t flags, 14541292b1fSDaniel Vetter uint32_t target, 14641292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 1471d8224e7SDaniel Vetter int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 1481d8224e7SDaniel Vetter u16 *red, u16 *green, u16 *blue, 1491d8224e7SDaniel Vetter uint32_t size, 1501d8224e7SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 1518bc0f312SDaniel Vetter 152dd275956SRob Clark /** 153dd275956SRob Clark * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 154dd275956SRob Clark * @plane: the loop cursor 15542240c90SThierry Reding * @crtc: the CRTC whose planes are iterated 156dd275956SRob Clark * 157dd275956SRob Clark * This iterates over the current state, useful (for example) when applying 158dd275956SRob Clark * atomic state after it has been checked and swapped. To iterate over the 1596806cdf9SDaniel Vetter * planes which *will* be attached (more useful in code called from 1606806cdf9SDaniel Vetter * &drm_mode_config_funcs.atomic_check) see 1615c0be3f1SLiviu Dudau * drm_atomic_crtc_state_for_each_plane(). 162dd275956SRob Clark */ 163dd275956SRob Clark #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 164dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 165dd275956SRob Clark 166dd275956SRob Clark /** 167dd275956SRob Clark * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 168dd275956SRob Clark * @plane: the loop cursor 16942240c90SThierry Reding * @crtc_state: the incoming CRTC state 170dd275956SRob Clark * 171dd275956SRob Clark * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 1726806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 1736806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 1746806cdf9SDaniel Vetter * validate the incoming state. 175dd275956SRob Clark */ 176dd275956SRob Clark #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 177dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 178042652edSDaniel Vetter 1792f196b7cSDaniel Vetter /** 1802f196b7cSDaniel Vetter * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state 1812f196b7cSDaniel Vetter * @plane: the loop cursor 1822f196b7cSDaniel Vetter * @plane_state: loop cursor for the plane's state, must be const 18342240c90SThierry Reding * @crtc_state: the incoming CRTC state 1842f196b7cSDaniel Vetter * 1852f196b7cSDaniel Vetter * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 1866806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 1876806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 1886806cdf9SDaniel Vetter * validate the incoming state. 1892f196b7cSDaniel Vetter * 1902f196b7cSDaniel Vetter * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 1912f196b7cSDaniel Vetter * const plane_state. This is useful when a driver just wants to peek at other 19242240c90SThierry Reding * active planes on this CRTC, but does not need to change it. 1932f196b7cSDaniel Vetter */ 1942f196b7cSDaniel Vetter #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 1952f196b7cSDaniel Vetter drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 1962f196b7cSDaniel Vetter for_each_if ((plane_state = \ 1972f196b7cSDaniel Vetter __drm_atomic_get_current_plane_state((crtc_state)->state, \ 1982f196b7cSDaniel Vetter plane))) 1992f196b7cSDaniel Vetter 20051ffa12dSMaarten Lankhorst /** 201407b8bd9SThierry Reding * drm_atomic_plane_disabling - check whether a plane is being disabled 20251ffa12dSMaarten Lankhorst * @old_plane_state: old atomic plane state 20351ffa12dSMaarten Lankhorst * @new_plane_state: new atomic plane state 204407b8bd9SThierry Reding * 205407b8bd9SThierry Reding * Checks the atomic state of a plane to determine whether it's being disabled 206407b8bd9SThierry Reding * or not. This also WARNs if it detects an invalid state (both CRTC and FB 207407b8bd9SThierry Reding * need to either both be NULL or both be non-NULL). 208407b8bd9SThierry Reding * 209407b8bd9SThierry Reding * RETURNS: 210407b8bd9SThierry Reding * True if the plane is being disabled, false otherwise. 211407b8bd9SThierry Reding */ 212407b8bd9SThierry Reding static inline bool 21351ffa12dSMaarten Lankhorst drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state, 21451ffa12dSMaarten Lankhorst struct drm_plane_state *new_plane_state) 215407b8bd9SThierry Reding { 216407b8bd9SThierry Reding /* 217407b8bd9SThierry Reding * When disabling a plane, CRTC and FB should always be NULL together. 218407b8bd9SThierry Reding * Anything else should be considered a bug in the atomic core, so we 219407b8bd9SThierry Reding * gently warn about it. 220407b8bd9SThierry Reding */ 22151ffa12dSMaarten Lankhorst WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) || 22251ffa12dSMaarten Lankhorst (new_plane_state->crtc != NULL && new_plane_state->fb == NULL)); 223407b8bd9SThierry Reding 22451ffa12dSMaarten Lankhorst return old_plane_state->crtc && !new_plane_state->crtc; 225407b8bd9SThierry Reding } 226407b8bd9SThierry Reding 227c2fcd274SDaniel Vetter #endif /* DRM_ATOMIC_HELPER_H_ */ 228