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 37382fc1f6SThomas Zimmermann /* 38382fc1f6SThomas Zimmermann * Drivers that don't allow primary plane scaling may pass this macro in place 39382fc1f6SThomas Zimmermann * of the min/max scale parameters of the plane-state checker function. 40382fc1f6SThomas Zimmermann * 41382fc1f6SThomas Zimmermann * Due to src being in 16.16 fixed point and dest being in integer pixels, 42382fc1f6SThomas Zimmermann * 1<<16 represents no scaling. 43382fc1f6SThomas Zimmermann */ 44cce32e4eSThomas Zimmermann #define DRM_PLANE_NO_SCALING (1<<16) 45382fc1f6SThomas Zimmermann 46bbb1e524SRob Clark struct drm_atomic_state; 47a4370c77SVille Syrjälä struct drm_private_obj; 48a4370c77SVille Syrjälä struct drm_private_state; 49bbb1e524SRob Clark 50d9b13620SDaniel Vetter int drm_atomic_helper_check_modeset(struct drm_device *dev, 51d9b13620SDaniel Vetter struct drm_atomic_state *state); 52254fe9c1SIgor Torrente int 53254fe9c1SIgor Torrente drm_atomic_helper_check_wb_encoder_state(struct drm_encoder *encoder, 54254fe9c1SIgor Torrente struct drm_connector_state *conn_state); 55a01cb8baSVille Syrjälä int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state, 56a01cb8baSVille Syrjälä const struct drm_crtc_state *crtc_state, 57a01cb8baSVille Syrjälä int min_scale, 58a01cb8baSVille Syrjälä int max_scale, 59a01cb8baSVille Syrjälä bool can_position, 60a01cb8baSVille Syrjälä bool can_update_disabled); 61d9b13620SDaniel Vetter int drm_atomic_helper_check_planes(struct drm_device *dev, 62d9b13620SDaniel Vetter struct drm_atomic_state *state); 638f2fd57dSThomas Zimmermann int drm_atomic_helper_check_crtc_primary_plane(struct drm_crtc_state *crtc_state); 64c2fcd274SDaniel Vetter int drm_atomic_helper_check(struct drm_device *dev, 65c2fcd274SDaniel Vetter struct drm_atomic_state *state); 669f2a7950SDaniel Vetter void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 6781a099acSMaxime Ripard void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state); 68623369e5SDaniel Vetter int drm_atomic_helper_commit(struct drm_device *dev, 69623369e5SDaniel Vetter struct drm_atomic_state *state, 70286dbb8dSMaarten Lankhorst bool nonblock); 71fef9df8bSGustavo Padovan int drm_atomic_helper_async_check(struct drm_device *dev, 72fef9df8bSGustavo Padovan struct drm_atomic_state *state); 73fef9df8bSGustavo Padovan void drm_atomic_helper_async_commit(struct drm_device *dev, 74fef9df8bSGustavo Padovan struct drm_atomic_state *state); 75623369e5SDaniel Vetter 76f6ce410aSGustavo Padovan int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 77f6ce410aSGustavo Padovan struct drm_atomic_state *state, 78f6ce410aSGustavo Padovan bool pre_swap); 79c240906dSJohn Keeping 805ee3229cSRob Clark void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 815ee3229cSRob Clark struct drm_atomic_state *old_state); 825ee3229cSRob Clark 8301086487SBoris Brezillon void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev, 8401086487SBoris Brezillon struct drm_atomic_state *old_state); 8501086487SBoris Brezillon 864c18d301SDaniel Vetter void 874c18d301SDaniel Vetter drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 884c18d301SDaniel Vetter struct drm_atomic_state *old_state); 894c18d301SDaniel Vetter 904b31a9c7SVille Syrjälä void 914b31a9c7SVille Syrjälä drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state); 924b31a9c7SVille Syrjälä 931af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 94623369e5SDaniel Vetter struct drm_atomic_state *state); 951af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 96623369e5SDaniel Vetter struct drm_atomic_state *old_state); 97c2fcd274SDaniel Vetter 98c2fcd274SDaniel Vetter int drm_atomic_helper_prepare_planes(struct drm_device *dev, 99c2fcd274SDaniel Vetter struct drm_atomic_state *state); 1002b58e98dSLiu Ying 1012b58e98dSLiu Ying #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 1022b58e98dSLiu Ying #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 1032b58e98dSLiu Ying 104c2fcd274SDaniel Vetter void drm_atomic_helper_commit_planes(struct drm_device *dev, 105aef9dbb8SDaniel Vetter struct drm_atomic_state *state, 1062b58e98dSLiu Ying uint32_t flags); 107c2fcd274SDaniel Vetter void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 108c2fcd274SDaniel Vetter struct drm_atomic_state *old_state); 109de28d021SMaarten Lankhorst void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 11028500291SLiu Ying void 11128500291SLiu Ying drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 1126753ba97SJyri Sarha bool atomic); 113c2fcd274SDaniel Vetter 1148a39374eSMaarten Lankhorst int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state, 1158a39374eSMaarten Lankhorst bool stall); 116c2fcd274SDaniel Vetter 117a095caa7SDaniel Vetter /* nonblocking commit helpers */ 118a095caa7SDaniel Vetter int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 119a095caa7SDaniel Vetter bool nonblock); 120a095caa7SDaniel Vetter void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 121b25c60afSBoris Brezillon void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state); 122a095caa7SDaniel Vetter void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 123a095caa7SDaniel Vetter void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 124a095caa7SDaniel Vetter 125042652edSDaniel Vetter /* implementations for legacy interfaces */ 126042652edSDaniel Vetter int drm_atomic_helper_update_plane(struct drm_plane *plane, 127042652edSDaniel Vetter struct drm_crtc *crtc, 128042652edSDaniel Vetter struct drm_framebuffer *fb, 129042652edSDaniel Vetter int crtc_x, int crtc_y, 130042652edSDaniel Vetter unsigned int crtc_w, unsigned int crtc_h, 131042652edSDaniel Vetter uint32_t src_x, uint32_t src_y, 13234a2ab5eSDaniel Vetter uint32_t src_w, uint32_t src_h, 13334a2ab5eSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 13419315294SDaniel Vetter int drm_atomic_helper_disable_plane(struct drm_plane *plane, 13519315294SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 136a4eff9aaSDaniel Vetter int drm_atomic_helper_set_config(struct drm_mode_set *set, 137a4eff9aaSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 138042652edSDaniel Vetter 13914942760SThierry Reding int drm_atomic_helper_disable_all(struct drm_device *dev, 14014942760SThierry Reding struct drm_modeset_acquire_ctx *ctx); 14118dddadcSDaniel Vetter void drm_atomic_helper_shutdown(struct drm_device *dev); 1421d8224e7SDaniel Vetter struct drm_atomic_state * 1431d8224e7SDaniel Vetter drm_atomic_helper_duplicate_state(struct drm_device *dev, 1441d8224e7SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 14514942760SThierry Reding struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 146581e49feSMaarten Lankhorst int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state, 147581e49feSMaarten Lankhorst struct drm_modeset_acquire_ctx *ctx); 14814942760SThierry Reding int drm_atomic_helper_resume(struct drm_device *dev, 14914942760SThierry Reding struct drm_atomic_state *state); 15014942760SThierry Reding 1518bc0f312SDaniel Vetter int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 1528bc0f312SDaniel Vetter struct drm_framebuffer *fb, 1538bc0f312SDaniel Vetter struct drm_pending_vblank_event *event, 15441292b1fSDaniel Vetter uint32_t flags, 15541292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 156f869a6ecSAndrey Grodzovsky int drm_atomic_helper_page_flip_target( 157f869a6ecSAndrey Grodzovsky struct drm_crtc *crtc, 158f869a6ecSAndrey Grodzovsky struct drm_framebuffer *fb, 159f869a6ecSAndrey Grodzovsky struct drm_pending_vblank_event *event, 160f869a6ecSAndrey Grodzovsky uint32_t flags, 16141292b1fSDaniel Vetter uint32_t target, 16241292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 1638bc0f312SDaniel Vetter 164dd275956SRob Clark /** 165dd275956SRob Clark * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 166dd275956SRob Clark * @plane: the loop cursor 16742240c90SThierry Reding * @crtc: the CRTC whose planes are iterated 168dd275956SRob Clark * 169dd275956SRob Clark * This iterates over the current state, useful (for example) when applying 170dd275956SRob Clark * atomic state after it has been checked and swapped. To iterate over the 1716806cdf9SDaniel Vetter * planes which *will* be attached (more useful in code called from 1726806cdf9SDaniel Vetter * &drm_mode_config_funcs.atomic_check) see 1735c0be3f1SLiviu Dudau * drm_atomic_crtc_state_for_each_plane(). 174dd275956SRob Clark */ 175dd275956SRob Clark #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 176dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 177dd275956SRob Clark 178dd275956SRob Clark /** 179e9d2871fSMauro Carvalho Chehab * drm_atomic_crtc_state_for_each_plane - iterate over attached planes in new state 180dd275956SRob Clark * @plane: the loop cursor 18142240c90SThierry Reding * @crtc_state: the incoming CRTC state 182dd275956SRob Clark * 183dd275956SRob Clark * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 1846806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 1856806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 1866806cdf9SDaniel Vetter * validate the incoming state. 187dd275956SRob Clark */ 188dd275956SRob Clark #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 189dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 190042652edSDaniel Vetter 1912f196b7cSDaniel Vetter /** 192e9d2871fSMauro Carvalho Chehab * drm_atomic_crtc_state_for_each_plane_state - iterate over attached planes in new state 1932f196b7cSDaniel Vetter * @plane: the loop cursor 1942f196b7cSDaniel Vetter * @plane_state: loop cursor for the plane's state, must be const 19542240c90SThierry Reding * @crtc_state: the incoming CRTC state 1962f196b7cSDaniel Vetter * 1972f196b7cSDaniel Vetter * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 1986806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 1996806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 2006806cdf9SDaniel Vetter * validate the incoming state. 2012f196b7cSDaniel Vetter * 2022f196b7cSDaniel Vetter * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 2032f196b7cSDaniel Vetter * const plane_state. This is useful when a driver just wants to peek at other 20442240c90SThierry Reding * active planes on this CRTC, but does not need to change it. 2052f196b7cSDaniel Vetter */ 2062f196b7cSDaniel Vetter #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 2072f196b7cSDaniel Vetter drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 2082f196b7cSDaniel Vetter for_each_if ((plane_state = \ 2092f196b7cSDaniel Vetter __drm_atomic_get_current_plane_state((crtc_state)->state, \ 2102f196b7cSDaniel Vetter plane))) 2112f196b7cSDaniel Vetter 21251ffa12dSMaarten Lankhorst /** 213*169b9182SThomas Zimmermann * drm_atomic_plane_enabling - check whether a plane is being enabled 214*169b9182SThomas Zimmermann * @old_plane_state: old atomic plane state 215*169b9182SThomas Zimmermann * @new_plane_state: new atomic plane state 216*169b9182SThomas Zimmermann * 217*169b9182SThomas Zimmermann * Checks the atomic state of a plane to determine whether it's being enabled 218*169b9182SThomas Zimmermann * or not. This also WARNs if it detects an invalid state (both CRTC and FB 219*169b9182SThomas Zimmermann * need to either both be NULL or both be non-NULL). 220*169b9182SThomas Zimmermann * 221*169b9182SThomas Zimmermann * RETURNS: 222*169b9182SThomas Zimmermann * True if the plane is being enabled, false otherwise. 223*169b9182SThomas Zimmermann */ 224*169b9182SThomas Zimmermann static inline bool drm_atomic_plane_enabling(struct drm_plane_state *old_plane_state, 225*169b9182SThomas Zimmermann struct drm_plane_state *new_plane_state) 226*169b9182SThomas Zimmermann { 227*169b9182SThomas Zimmermann /* 228*169b9182SThomas Zimmermann * When enabling a plane, CRTC and FB should always be set together. 229*169b9182SThomas Zimmermann * Anything else should be considered a bug in the atomic core, so we 230*169b9182SThomas Zimmermann * gently warn about it. 231*169b9182SThomas Zimmermann */ 232*169b9182SThomas Zimmermann WARN_ON((!new_plane_state->crtc && new_plane_state->fb) || 233*169b9182SThomas Zimmermann (new_plane_state->crtc && !new_plane_state->fb)); 234*169b9182SThomas Zimmermann 235*169b9182SThomas Zimmermann return !old_plane_state->crtc && new_plane_state->crtc; 236*169b9182SThomas Zimmermann } 237*169b9182SThomas Zimmermann 238*169b9182SThomas Zimmermann /** 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 265f32df58aSBoris Brezillon u32 * 266f32df58aSBoris Brezillon drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge, 267f32df58aSBoris Brezillon struct drm_bridge_state *bridge_state, 268f32df58aSBoris Brezillon struct drm_crtc_state *crtc_state, 269f32df58aSBoris Brezillon struct drm_connector_state *conn_state, 270f32df58aSBoris Brezillon u32 output_fmt, 271f32df58aSBoris Brezillon unsigned int *num_input_fmts); 272f32df58aSBoris Brezillon 273c2fcd274SDaniel Vetter #endif /* DRM_ATOMIC_HELPER_H_ */ 274