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); 49*d6b9af10SThomas Zimmermann int drm_atomic_helper_check_crtc_state(struct drm_crtc_state *crtc_state, 50*d6b9af10SThomas Zimmermann bool can_disable_primary_plane); 51d9b13620SDaniel Vetter int drm_atomic_helper_check_planes(struct drm_device *dev, 52d9b13620SDaniel Vetter struct drm_atomic_state *state); 53c2fcd274SDaniel Vetter int drm_atomic_helper_check(struct drm_device *dev, 54c2fcd274SDaniel Vetter struct drm_atomic_state *state); 559f2a7950SDaniel Vetter void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 5681a099acSMaxime Ripard void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state); 57623369e5SDaniel Vetter int drm_atomic_helper_commit(struct drm_device *dev, 58623369e5SDaniel Vetter struct drm_atomic_state *state, 59286dbb8dSMaarten Lankhorst bool nonblock); 60fef9df8bSGustavo Padovan int drm_atomic_helper_async_check(struct drm_device *dev, 61fef9df8bSGustavo Padovan struct drm_atomic_state *state); 62fef9df8bSGustavo Padovan void drm_atomic_helper_async_commit(struct drm_device *dev, 63fef9df8bSGustavo Padovan struct drm_atomic_state *state); 64623369e5SDaniel Vetter 65f6ce410aSGustavo Padovan int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 66f6ce410aSGustavo Padovan struct drm_atomic_state *state, 67f6ce410aSGustavo Padovan bool pre_swap); 68c240906dSJohn Keeping 695ee3229cSRob Clark void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 705ee3229cSRob Clark struct drm_atomic_state *old_state); 715ee3229cSRob Clark 7201086487SBoris Brezillon void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev, 7301086487SBoris Brezillon struct drm_atomic_state *old_state); 7401086487SBoris Brezillon 754c18d301SDaniel Vetter void 764c18d301SDaniel Vetter drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 774c18d301SDaniel Vetter struct drm_atomic_state *old_state); 784c18d301SDaniel Vetter 794b31a9c7SVille Syrjälä void 804b31a9c7SVille Syrjälä drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state); 814b31a9c7SVille Syrjälä 821af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 83623369e5SDaniel Vetter struct drm_atomic_state *state); 841af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 85623369e5SDaniel Vetter struct drm_atomic_state *old_state); 86c2fcd274SDaniel Vetter 87c2fcd274SDaniel Vetter int drm_atomic_helper_prepare_planes(struct drm_device *dev, 88c2fcd274SDaniel Vetter struct drm_atomic_state *state); 892b58e98dSLiu Ying 902b58e98dSLiu Ying #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 912b58e98dSLiu Ying #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 922b58e98dSLiu Ying 93c2fcd274SDaniel Vetter void drm_atomic_helper_commit_planes(struct drm_device *dev, 94aef9dbb8SDaniel Vetter struct drm_atomic_state *state, 952b58e98dSLiu Ying uint32_t flags); 96c2fcd274SDaniel Vetter void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 97c2fcd274SDaniel Vetter struct drm_atomic_state *old_state); 98de28d021SMaarten Lankhorst void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 9928500291SLiu Ying void 10028500291SLiu Ying drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 1016753ba97SJyri Sarha bool atomic); 102c2fcd274SDaniel Vetter 1038a39374eSMaarten Lankhorst int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state, 1048a39374eSMaarten Lankhorst bool stall); 105c2fcd274SDaniel Vetter 106a095caa7SDaniel Vetter /* nonblocking commit helpers */ 107a095caa7SDaniel Vetter int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 108a095caa7SDaniel Vetter bool nonblock); 109a095caa7SDaniel Vetter void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 110b25c60afSBoris Brezillon void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state); 111a095caa7SDaniel Vetter void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 112a095caa7SDaniel Vetter void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 113a095caa7SDaniel Vetter 114042652edSDaniel Vetter /* implementations for legacy interfaces */ 115042652edSDaniel Vetter int drm_atomic_helper_update_plane(struct drm_plane *plane, 116042652edSDaniel Vetter struct drm_crtc *crtc, 117042652edSDaniel Vetter struct drm_framebuffer *fb, 118042652edSDaniel Vetter int crtc_x, int crtc_y, 119042652edSDaniel Vetter unsigned int crtc_w, unsigned int crtc_h, 120042652edSDaniel Vetter uint32_t src_x, uint32_t src_y, 12134a2ab5eSDaniel Vetter uint32_t src_w, uint32_t src_h, 12234a2ab5eSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 12319315294SDaniel Vetter int drm_atomic_helper_disable_plane(struct drm_plane *plane, 12419315294SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 125a4eff9aaSDaniel Vetter int drm_atomic_helper_set_config(struct drm_mode_set *set, 126a4eff9aaSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 127042652edSDaniel Vetter 12814942760SThierry Reding int drm_atomic_helper_disable_all(struct drm_device *dev, 12914942760SThierry Reding struct drm_modeset_acquire_ctx *ctx); 13018dddadcSDaniel Vetter void drm_atomic_helper_shutdown(struct drm_device *dev); 1311d8224e7SDaniel Vetter struct drm_atomic_state * 1321d8224e7SDaniel Vetter drm_atomic_helper_duplicate_state(struct drm_device *dev, 1331d8224e7SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 13414942760SThierry Reding struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 135581e49feSMaarten Lankhorst int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state, 136581e49feSMaarten Lankhorst struct drm_modeset_acquire_ctx *ctx); 13714942760SThierry Reding int drm_atomic_helper_resume(struct drm_device *dev, 13814942760SThierry Reding struct drm_atomic_state *state); 13914942760SThierry Reding 1408bc0f312SDaniel Vetter int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 1418bc0f312SDaniel Vetter struct drm_framebuffer *fb, 1428bc0f312SDaniel Vetter struct drm_pending_vblank_event *event, 14341292b1fSDaniel Vetter uint32_t flags, 14441292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 145f869a6ecSAndrey Grodzovsky int drm_atomic_helper_page_flip_target( 146f869a6ecSAndrey Grodzovsky struct drm_crtc *crtc, 147f869a6ecSAndrey Grodzovsky struct drm_framebuffer *fb, 148f869a6ecSAndrey Grodzovsky struct drm_pending_vblank_event *event, 149f869a6ecSAndrey Grodzovsky uint32_t flags, 15041292b1fSDaniel Vetter uint32_t target, 15141292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 1528bc0f312SDaniel Vetter 153dd275956SRob Clark /** 154dd275956SRob Clark * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 155dd275956SRob Clark * @plane: the loop cursor 15642240c90SThierry Reding * @crtc: the CRTC whose planes are iterated 157dd275956SRob Clark * 158dd275956SRob Clark * This iterates over the current state, useful (for example) when applying 159dd275956SRob Clark * atomic state after it has been checked and swapped. To iterate over the 1606806cdf9SDaniel Vetter * planes which *will* be attached (more useful in code called from 1616806cdf9SDaniel Vetter * &drm_mode_config_funcs.atomic_check) see 1625c0be3f1SLiviu Dudau * drm_atomic_crtc_state_for_each_plane(). 163dd275956SRob Clark */ 164dd275956SRob Clark #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 165dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 166dd275956SRob Clark 167dd275956SRob Clark /** 168e9d2871fSMauro Carvalho Chehab * drm_atomic_crtc_state_for_each_plane - iterate over attached planes in new state 169dd275956SRob Clark * @plane: the loop cursor 17042240c90SThierry Reding * @crtc_state: the incoming CRTC state 171dd275956SRob Clark * 172dd275956SRob Clark * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 1736806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 1746806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 1756806cdf9SDaniel Vetter * validate the incoming state. 176dd275956SRob Clark */ 177dd275956SRob Clark #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 178dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 179042652edSDaniel Vetter 1802f196b7cSDaniel Vetter /** 181e9d2871fSMauro Carvalho Chehab * drm_atomic_crtc_state_for_each_plane_state - iterate over attached planes in new state 1822f196b7cSDaniel Vetter * @plane: the loop cursor 1832f196b7cSDaniel Vetter * @plane_state: loop cursor for the plane's state, must be const 18442240c90SThierry Reding * @crtc_state: the incoming CRTC state 1852f196b7cSDaniel Vetter * 1862f196b7cSDaniel Vetter * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 1876806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 1886806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 1896806cdf9SDaniel Vetter * validate the incoming state. 1902f196b7cSDaniel Vetter * 1912f196b7cSDaniel Vetter * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 1922f196b7cSDaniel Vetter * const plane_state. This is useful when a driver just wants to peek at other 19342240c90SThierry Reding * active planes on this CRTC, but does not need to change it. 1942f196b7cSDaniel Vetter */ 1952f196b7cSDaniel Vetter #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 1962f196b7cSDaniel Vetter drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 1972f196b7cSDaniel Vetter for_each_if ((plane_state = \ 1982f196b7cSDaniel Vetter __drm_atomic_get_current_plane_state((crtc_state)->state, \ 1992f196b7cSDaniel Vetter plane))) 2002f196b7cSDaniel Vetter 20151ffa12dSMaarten Lankhorst /** 202407b8bd9SThierry Reding * drm_atomic_plane_disabling - check whether a plane is being disabled 20351ffa12dSMaarten Lankhorst * @old_plane_state: old atomic plane state 20451ffa12dSMaarten Lankhorst * @new_plane_state: new atomic plane state 205407b8bd9SThierry Reding * 206407b8bd9SThierry Reding * Checks the atomic state of a plane to determine whether it's being disabled 207407b8bd9SThierry Reding * or not. This also WARNs if it detects an invalid state (both CRTC and FB 208407b8bd9SThierry Reding * need to either both be NULL or both be non-NULL). 209407b8bd9SThierry Reding * 210407b8bd9SThierry Reding * RETURNS: 211407b8bd9SThierry Reding * True if the plane is being disabled, false otherwise. 212407b8bd9SThierry Reding */ 213407b8bd9SThierry Reding static inline bool 21451ffa12dSMaarten Lankhorst drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state, 21551ffa12dSMaarten Lankhorst struct drm_plane_state *new_plane_state) 216407b8bd9SThierry Reding { 217407b8bd9SThierry Reding /* 218407b8bd9SThierry Reding * When disabling a plane, CRTC and FB should always be NULL together. 219407b8bd9SThierry Reding * Anything else should be considered a bug in the atomic core, so we 220407b8bd9SThierry Reding * gently warn about it. 221407b8bd9SThierry Reding */ 22251ffa12dSMaarten Lankhorst WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) || 22351ffa12dSMaarten Lankhorst (new_plane_state->crtc != NULL && new_plane_state->fb == NULL)); 224407b8bd9SThierry Reding 22551ffa12dSMaarten Lankhorst return old_plane_state->crtc && !new_plane_state->crtc; 226407b8bd9SThierry Reding } 227407b8bd9SThierry Reding 228f32df58aSBoris Brezillon u32 * 229f32df58aSBoris Brezillon drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge, 230f32df58aSBoris Brezillon struct drm_bridge_state *bridge_state, 231f32df58aSBoris Brezillon struct drm_crtc_state *crtc_state, 232f32df58aSBoris Brezillon struct drm_connector_state *conn_state, 233f32df58aSBoris Brezillon u32 output_fmt, 234f32df58aSBoris Brezillon unsigned int *num_input_fmts); 235f32df58aSBoris Brezillon 236c2fcd274SDaniel Vetter #endif /* DRM_ATOMIC_HELPER_H_ */ 237