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 37*382fc1f6SThomas Zimmermann /* 38*382fc1f6SThomas Zimmermann * Drivers that don't allow primary plane scaling may pass this macro in place 39*382fc1f6SThomas Zimmermann * of the min/max scale parameters of the plane-state checker function. 40*382fc1f6SThomas Zimmermann * 41*382fc1f6SThomas Zimmermann * Due to src being in 16.16 fixed point and dest being in integer pixels, 42*382fc1f6SThomas Zimmermann * 1<<16 represents no scaling. 43*382fc1f6SThomas Zimmermann */ 44*382fc1f6SThomas Zimmermann #define DRM_PLANE_HELPER_NO_SCALING (1<<16) 45*382fc1f6SThomas 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); 52a01cb8baSVille Syrjälä int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state, 53a01cb8baSVille Syrjälä const struct drm_crtc_state *crtc_state, 54a01cb8baSVille Syrjälä int min_scale, 55a01cb8baSVille Syrjälä int max_scale, 56a01cb8baSVille Syrjälä bool can_position, 57a01cb8baSVille Syrjälä bool can_update_disabled); 58d6b9af10SThomas Zimmermann int drm_atomic_helper_check_crtc_state(struct drm_crtc_state *crtc_state, 59d6b9af10SThomas Zimmermann bool can_disable_primary_plane); 60d9b13620SDaniel Vetter int drm_atomic_helper_check_planes(struct drm_device *dev, 61d9b13620SDaniel Vetter struct drm_atomic_state *state); 62c2fcd274SDaniel Vetter int drm_atomic_helper_check(struct drm_device *dev, 63c2fcd274SDaniel Vetter struct drm_atomic_state *state); 649f2a7950SDaniel Vetter void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 6581a099acSMaxime Ripard void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state); 66623369e5SDaniel Vetter int drm_atomic_helper_commit(struct drm_device *dev, 67623369e5SDaniel Vetter struct drm_atomic_state *state, 68286dbb8dSMaarten Lankhorst bool nonblock); 69fef9df8bSGustavo Padovan int drm_atomic_helper_async_check(struct drm_device *dev, 70fef9df8bSGustavo Padovan struct drm_atomic_state *state); 71fef9df8bSGustavo Padovan void drm_atomic_helper_async_commit(struct drm_device *dev, 72fef9df8bSGustavo Padovan struct drm_atomic_state *state); 73623369e5SDaniel Vetter 74f6ce410aSGustavo Padovan int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 75f6ce410aSGustavo Padovan struct drm_atomic_state *state, 76f6ce410aSGustavo Padovan bool pre_swap); 77c240906dSJohn Keeping 785ee3229cSRob Clark void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 795ee3229cSRob Clark struct drm_atomic_state *old_state); 805ee3229cSRob Clark 8101086487SBoris Brezillon void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev, 8201086487SBoris Brezillon struct drm_atomic_state *old_state); 8301086487SBoris Brezillon 844c18d301SDaniel Vetter void 854c18d301SDaniel Vetter drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 864c18d301SDaniel Vetter struct drm_atomic_state *old_state); 874c18d301SDaniel Vetter 884b31a9c7SVille Syrjälä void 894b31a9c7SVille Syrjälä drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state); 904b31a9c7SVille Syrjälä 911af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 92623369e5SDaniel Vetter struct drm_atomic_state *state); 931af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 94623369e5SDaniel Vetter struct drm_atomic_state *old_state); 95c2fcd274SDaniel Vetter 96c2fcd274SDaniel Vetter int drm_atomic_helper_prepare_planes(struct drm_device *dev, 97c2fcd274SDaniel Vetter struct drm_atomic_state *state); 982b58e98dSLiu Ying 992b58e98dSLiu Ying #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 1002b58e98dSLiu Ying #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 1012b58e98dSLiu Ying 102c2fcd274SDaniel Vetter void drm_atomic_helper_commit_planes(struct drm_device *dev, 103aef9dbb8SDaniel Vetter struct drm_atomic_state *state, 1042b58e98dSLiu Ying uint32_t flags); 105c2fcd274SDaniel Vetter void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 106c2fcd274SDaniel Vetter struct drm_atomic_state *old_state); 107de28d021SMaarten Lankhorst void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 10828500291SLiu Ying void 10928500291SLiu Ying drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 1106753ba97SJyri Sarha bool atomic); 111c2fcd274SDaniel Vetter 1128a39374eSMaarten Lankhorst int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state, 1138a39374eSMaarten Lankhorst bool stall); 114c2fcd274SDaniel Vetter 115a095caa7SDaniel Vetter /* nonblocking commit helpers */ 116a095caa7SDaniel Vetter int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 117a095caa7SDaniel Vetter bool nonblock); 118a095caa7SDaniel Vetter void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 119b25c60afSBoris Brezillon void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state); 120a095caa7SDaniel Vetter void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 121a095caa7SDaniel Vetter void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 122a095caa7SDaniel Vetter 123042652edSDaniel Vetter /* implementations for legacy interfaces */ 124042652edSDaniel Vetter int drm_atomic_helper_update_plane(struct drm_plane *plane, 125042652edSDaniel Vetter struct drm_crtc *crtc, 126042652edSDaniel Vetter struct drm_framebuffer *fb, 127042652edSDaniel Vetter int crtc_x, int crtc_y, 128042652edSDaniel Vetter unsigned int crtc_w, unsigned int crtc_h, 129042652edSDaniel Vetter uint32_t src_x, uint32_t src_y, 13034a2ab5eSDaniel Vetter uint32_t src_w, uint32_t src_h, 13134a2ab5eSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 13219315294SDaniel Vetter int drm_atomic_helper_disable_plane(struct drm_plane *plane, 13319315294SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 134a4eff9aaSDaniel Vetter int drm_atomic_helper_set_config(struct drm_mode_set *set, 135a4eff9aaSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 136042652edSDaniel Vetter 13714942760SThierry Reding int drm_atomic_helper_disable_all(struct drm_device *dev, 13814942760SThierry Reding struct drm_modeset_acquire_ctx *ctx); 13918dddadcSDaniel Vetter void drm_atomic_helper_shutdown(struct drm_device *dev); 1401d8224e7SDaniel Vetter struct drm_atomic_state * 1411d8224e7SDaniel Vetter drm_atomic_helper_duplicate_state(struct drm_device *dev, 1421d8224e7SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 14314942760SThierry Reding struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 144581e49feSMaarten Lankhorst int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state, 145581e49feSMaarten Lankhorst struct drm_modeset_acquire_ctx *ctx); 14614942760SThierry Reding int drm_atomic_helper_resume(struct drm_device *dev, 14714942760SThierry Reding struct drm_atomic_state *state); 14814942760SThierry Reding 1498bc0f312SDaniel Vetter int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 1508bc0f312SDaniel Vetter struct drm_framebuffer *fb, 1518bc0f312SDaniel Vetter struct drm_pending_vblank_event *event, 15241292b1fSDaniel Vetter uint32_t flags, 15341292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 154f869a6ecSAndrey Grodzovsky int drm_atomic_helper_page_flip_target( 155f869a6ecSAndrey Grodzovsky struct drm_crtc *crtc, 156f869a6ecSAndrey Grodzovsky struct drm_framebuffer *fb, 157f869a6ecSAndrey Grodzovsky struct drm_pending_vblank_event *event, 158f869a6ecSAndrey Grodzovsky uint32_t flags, 15941292b1fSDaniel Vetter uint32_t target, 16041292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 1618bc0f312SDaniel Vetter 162dd275956SRob Clark /** 163dd275956SRob Clark * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 164dd275956SRob Clark * @plane: the loop cursor 16542240c90SThierry Reding * @crtc: the CRTC whose planes are iterated 166dd275956SRob Clark * 167dd275956SRob Clark * This iterates over the current state, useful (for example) when applying 168dd275956SRob Clark * atomic state after it has been checked and swapped. To iterate over the 1696806cdf9SDaniel Vetter * planes which *will* be attached (more useful in code called from 1706806cdf9SDaniel Vetter * &drm_mode_config_funcs.atomic_check) see 1715c0be3f1SLiviu Dudau * drm_atomic_crtc_state_for_each_plane(). 172dd275956SRob Clark */ 173dd275956SRob Clark #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 174dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 175dd275956SRob Clark 176dd275956SRob Clark /** 177e9d2871fSMauro Carvalho Chehab * drm_atomic_crtc_state_for_each_plane - iterate over attached planes in new state 178dd275956SRob Clark * @plane: the loop cursor 17942240c90SThierry Reding * @crtc_state: the incoming CRTC state 180dd275956SRob Clark * 181dd275956SRob Clark * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 1826806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 1836806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 1846806cdf9SDaniel Vetter * validate the incoming state. 185dd275956SRob Clark */ 186dd275956SRob Clark #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 187dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 188042652edSDaniel Vetter 1892f196b7cSDaniel Vetter /** 190e9d2871fSMauro Carvalho Chehab * drm_atomic_crtc_state_for_each_plane_state - iterate over attached planes in new state 1912f196b7cSDaniel Vetter * @plane: the loop cursor 1922f196b7cSDaniel Vetter * @plane_state: loop cursor for the plane's state, must be const 19342240c90SThierry Reding * @crtc_state: the incoming CRTC state 1942f196b7cSDaniel Vetter * 1952f196b7cSDaniel Vetter * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 1966806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 1976806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 1986806cdf9SDaniel Vetter * validate the incoming state. 1992f196b7cSDaniel Vetter * 2002f196b7cSDaniel Vetter * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 2012f196b7cSDaniel Vetter * const plane_state. This is useful when a driver just wants to peek at other 20242240c90SThierry Reding * active planes on this CRTC, but does not need to change it. 2032f196b7cSDaniel Vetter */ 2042f196b7cSDaniel Vetter #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 2052f196b7cSDaniel Vetter drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 2062f196b7cSDaniel Vetter for_each_if ((plane_state = \ 2072f196b7cSDaniel Vetter __drm_atomic_get_current_plane_state((crtc_state)->state, \ 2082f196b7cSDaniel Vetter plane))) 2092f196b7cSDaniel Vetter 21051ffa12dSMaarten Lankhorst /** 211407b8bd9SThierry Reding * drm_atomic_plane_disabling - check whether a plane is being disabled 21251ffa12dSMaarten Lankhorst * @old_plane_state: old atomic plane state 21351ffa12dSMaarten Lankhorst * @new_plane_state: new atomic plane state 214407b8bd9SThierry Reding * 215407b8bd9SThierry Reding * Checks the atomic state of a plane to determine whether it's being disabled 216407b8bd9SThierry Reding * or not. This also WARNs if it detects an invalid state (both CRTC and FB 217407b8bd9SThierry Reding * need to either both be NULL or both be non-NULL). 218407b8bd9SThierry Reding * 219407b8bd9SThierry Reding * RETURNS: 220407b8bd9SThierry Reding * True if the plane is being disabled, false otherwise. 221407b8bd9SThierry Reding */ 222407b8bd9SThierry Reding static inline bool 22351ffa12dSMaarten Lankhorst drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state, 22451ffa12dSMaarten Lankhorst struct drm_plane_state *new_plane_state) 225407b8bd9SThierry Reding { 226407b8bd9SThierry Reding /* 227407b8bd9SThierry Reding * When disabling a plane, CRTC and FB should always be NULL together. 228407b8bd9SThierry Reding * Anything else should be considered a bug in the atomic core, so we 229407b8bd9SThierry Reding * gently warn about it. 230407b8bd9SThierry Reding */ 23151ffa12dSMaarten Lankhorst WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) || 23251ffa12dSMaarten Lankhorst (new_plane_state->crtc != NULL && new_plane_state->fb == NULL)); 233407b8bd9SThierry Reding 23451ffa12dSMaarten Lankhorst return old_plane_state->crtc && !new_plane_state->crtc; 235407b8bd9SThierry Reding } 236407b8bd9SThierry Reding 237f32df58aSBoris Brezillon u32 * 238f32df58aSBoris Brezillon drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge, 239f32df58aSBoris Brezillon struct drm_bridge_state *bridge_state, 240f32df58aSBoris Brezillon struct drm_crtc_state *crtc_state, 241f32df58aSBoris Brezillon struct drm_connector_state *conn_state, 242f32df58aSBoris Brezillon u32 output_fmt, 243f32df58aSBoris Brezillon unsigned int *num_input_fmts); 244f32df58aSBoris Brezillon 245c2fcd274SDaniel Vetter #endif /* DRM_ATOMIC_HELPER_H_ */ 246