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); 41d9b13620SDaniel Vetter int drm_atomic_helper_check_planes(struct drm_device *dev, 42d9b13620SDaniel Vetter struct drm_atomic_state *state); 43c2fcd274SDaniel Vetter int drm_atomic_helper_check(struct drm_device *dev, 44c2fcd274SDaniel Vetter struct drm_atomic_state *state); 459f2a7950SDaniel Vetter void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 4681a099acSMaxime Ripard void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state); 47623369e5SDaniel Vetter int drm_atomic_helper_commit(struct drm_device *dev, 48623369e5SDaniel Vetter struct drm_atomic_state *state, 49286dbb8dSMaarten Lankhorst bool nonblock); 50fef9df8bSGustavo Padovan int drm_atomic_helper_async_check(struct drm_device *dev, 51fef9df8bSGustavo Padovan struct drm_atomic_state *state); 52fef9df8bSGustavo Padovan void drm_atomic_helper_async_commit(struct drm_device *dev, 53fef9df8bSGustavo Padovan struct drm_atomic_state *state); 54623369e5SDaniel Vetter 55f6ce410aSGustavo Padovan int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 56f6ce410aSGustavo Padovan struct drm_atomic_state *state, 57f6ce410aSGustavo Padovan bool pre_swap); 58c240906dSJohn Keeping 595ee3229cSRob Clark void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 605ee3229cSRob Clark struct drm_atomic_state *old_state); 615ee3229cSRob Clark 6201086487SBoris Brezillon void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev, 6301086487SBoris Brezillon struct drm_atomic_state *old_state); 6401086487SBoris Brezillon 654c18d301SDaniel Vetter void 664c18d301SDaniel Vetter drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 674c18d301SDaniel Vetter struct drm_atomic_state *old_state); 684c18d301SDaniel Vetter 691af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 70623369e5SDaniel Vetter struct drm_atomic_state *state); 711af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 72623369e5SDaniel Vetter struct drm_atomic_state *old_state); 73c2fcd274SDaniel Vetter 74c2fcd274SDaniel Vetter int drm_atomic_helper_prepare_planes(struct drm_device *dev, 75c2fcd274SDaniel Vetter struct drm_atomic_state *state); 762b58e98dSLiu Ying 772b58e98dSLiu Ying #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 782b58e98dSLiu Ying #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 792b58e98dSLiu Ying 80c2fcd274SDaniel Vetter void drm_atomic_helper_commit_planes(struct drm_device *dev, 81aef9dbb8SDaniel Vetter struct drm_atomic_state *state, 822b58e98dSLiu Ying uint32_t flags); 83c2fcd274SDaniel Vetter void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 84c2fcd274SDaniel Vetter struct drm_atomic_state *old_state); 85de28d021SMaarten Lankhorst void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 8628500291SLiu Ying void 8728500291SLiu Ying drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 886753ba97SJyri Sarha bool atomic); 89c2fcd274SDaniel Vetter 908a39374eSMaarten Lankhorst int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state, 918a39374eSMaarten Lankhorst bool stall); 92c2fcd274SDaniel Vetter 93a095caa7SDaniel Vetter /* nonblocking commit helpers */ 94a095caa7SDaniel Vetter int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 95a095caa7SDaniel Vetter bool nonblock); 96a095caa7SDaniel Vetter void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 97a095caa7SDaniel Vetter void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 98a095caa7SDaniel Vetter void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 99a095caa7SDaniel Vetter 100042652edSDaniel Vetter /* implementations for legacy interfaces */ 101042652edSDaniel Vetter int drm_atomic_helper_update_plane(struct drm_plane *plane, 102042652edSDaniel Vetter struct drm_crtc *crtc, 103042652edSDaniel Vetter struct drm_framebuffer *fb, 104042652edSDaniel Vetter int crtc_x, int crtc_y, 105042652edSDaniel Vetter unsigned int crtc_w, unsigned int crtc_h, 106042652edSDaniel Vetter uint32_t src_x, uint32_t src_y, 10734a2ab5eSDaniel Vetter uint32_t src_w, uint32_t src_h, 10834a2ab5eSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 10919315294SDaniel Vetter int drm_atomic_helper_disable_plane(struct drm_plane *plane, 11019315294SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 111bbb1e524SRob Clark int __drm_atomic_helper_disable_plane(struct drm_plane *plane, 112bbb1e524SRob Clark struct drm_plane_state *plane_state); 113a4eff9aaSDaniel Vetter int drm_atomic_helper_set_config(struct drm_mode_set *set, 114a4eff9aaSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 115bbb1e524SRob Clark int __drm_atomic_helper_set_config(struct drm_mode_set *set, 116bbb1e524SRob Clark struct drm_atomic_state *state); 117042652edSDaniel Vetter 11814942760SThierry Reding int drm_atomic_helper_disable_all(struct drm_device *dev, 11914942760SThierry Reding struct drm_modeset_acquire_ctx *ctx); 12018dddadcSDaniel Vetter void drm_atomic_helper_shutdown(struct drm_device *dev); 12114942760SThierry Reding struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 122581e49feSMaarten Lankhorst int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state, 123581e49feSMaarten Lankhorst struct drm_modeset_acquire_ctx *ctx); 12414942760SThierry Reding int drm_atomic_helper_resume(struct drm_device *dev, 12514942760SThierry Reding struct drm_atomic_state *state); 12614942760SThierry Reding 127042652edSDaniel Vetter int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, 128042652edSDaniel Vetter struct drm_property *property, 129042652edSDaniel Vetter uint64_t val); 130042652edSDaniel Vetter int drm_atomic_helper_plane_set_property(struct drm_plane *plane, 131042652edSDaniel Vetter struct drm_property *property, 132042652edSDaniel Vetter uint64_t val); 133042652edSDaniel Vetter int drm_atomic_helper_connector_set_property(struct drm_connector *connector, 134042652edSDaniel Vetter struct drm_property *property, 135042652edSDaniel Vetter uint64_t val); 1368bc0f312SDaniel Vetter int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 1378bc0f312SDaniel Vetter struct drm_framebuffer *fb, 1388bc0f312SDaniel Vetter struct drm_pending_vblank_event *event, 13941292b1fSDaniel Vetter uint32_t flags, 14041292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 141f869a6ecSAndrey Grodzovsky int drm_atomic_helper_page_flip_target( 142f869a6ecSAndrey Grodzovsky struct drm_crtc *crtc, 143f869a6ecSAndrey Grodzovsky struct drm_framebuffer *fb, 144f869a6ecSAndrey Grodzovsky struct drm_pending_vblank_event *event, 145f869a6ecSAndrey Grodzovsky uint32_t flags, 14641292b1fSDaniel Vetter uint32_t target, 14741292b1fSDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 1489a69a9acSMaarten Lankhorst int drm_atomic_helper_connector_dpms(struct drm_connector *connector, 149b486e0e6SDaniel Vetter int mode); 1509ecb5498SNoralf Trønnes struct drm_encoder * 1519ecb5498SNoralf Trønnes drm_atomic_helper_best_encoder(struct drm_connector *connector); 1528bc0f312SDaniel Vetter 153d461701cSDaniel Vetter /* default implementations for state handling */ 154d461701cSDaniel Vetter void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 155f5e7840bSThierry Reding void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 156f5e7840bSThierry Reding struct drm_crtc_state *state); 157d461701cSDaniel Vetter struct drm_crtc_state * 158d461701cSDaniel Vetter drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 159ec2dc6a0SDaniel Vetter void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state); 160d461701cSDaniel Vetter void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 161d461701cSDaniel Vetter struct drm_crtc_state *state); 162d461701cSDaniel Vetter 163d461701cSDaniel Vetter void drm_atomic_helper_plane_reset(struct drm_plane *plane); 164f5e7840bSThierry Reding void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 165f5e7840bSThierry Reding struct drm_plane_state *state); 166d461701cSDaniel Vetter struct drm_plane_state * 167d461701cSDaniel Vetter drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 1682f701695SDaniel Vetter void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state); 169d461701cSDaniel Vetter void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 170d461701cSDaniel Vetter struct drm_plane_state *state); 171d461701cSDaniel Vetter 1724cd39917SMaarten Lankhorst void __drm_atomic_helper_connector_reset(struct drm_connector *connector, 1734cd39917SMaarten Lankhorst struct drm_connector_state *conn_state); 174d461701cSDaniel Vetter void drm_atomic_helper_connector_reset(struct drm_connector *connector); 175f5e7840bSThierry Reding void 176f5e7840bSThierry Reding __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 177f5e7840bSThierry Reding struct drm_connector_state *state); 178d461701cSDaniel Vetter struct drm_connector_state * 179d461701cSDaniel Vetter drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 180397fd77cSThierry Reding struct drm_atomic_state * 181397fd77cSThierry Reding drm_atomic_helper_duplicate_state(struct drm_device *dev, 182397fd77cSThierry Reding struct drm_modeset_acquire_ctx *ctx); 183f5e7840bSThierry Reding void 184fabd9106SDaniel Vetter __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state); 185d461701cSDaniel Vetter void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 186d461701cSDaniel Vetter struct drm_connector_state *state); 1877ea77283SMaarten Lankhorst int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 1885488dc16SLionel Landwerlin u16 *red, u16 *green, u16 *blue, 1896d124ff8SDaniel Vetter uint32_t size, 1906d124ff8SDaniel Vetter struct drm_modeset_acquire_ctx *ctx); 191a4370c77SVille Syrjälä void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj *obj, 192a4370c77SVille Syrjälä struct drm_private_state *state); 193d461701cSDaniel Vetter 194dd275956SRob Clark /** 195dd275956SRob Clark * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 196dd275956SRob Clark * @plane: the loop cursor 197dd275956SRob Clark * @crtc: the crtc whose planes are iterated 198dd275956SRob Clark * 199dd275956SRob Clark * This iterates over the current state, useful (for example) when applying 200dd275956SRob Clark * atomic state after it has been checked and swapped. To iterate over the 2016806cdf9SDaniel Vetter * planes which *will* be attached (more useful in code called from 2026806cdf9SDaniel Vetter * &drm_mode_config_funcs.atomic_check) see 2035c0be3f1SLiviu Dudau * drm_atomic_crtc_state_for_each_plane(). 204dd275956SRob Clark */ 205dd275956SRob Clark #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 206dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 207dd275956SRob Clark 208dd275956SRob Clark /** 209dd275956SRob Clark * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 210dd275956SRob Clark * @plane: the loop cursor 211dd275956SRob Clark * @crtc_state: the incoming crtc-state 212dd275956SRob Clark * 213dd275956SRob Clark * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 2146806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 2156806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 2166806cdf9SDaniel Vetter * validate the incoming state. 217dd275956SRob Clark */ 218dd275956SRob Clark #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 219dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 220042652edSDaniel Vetter 2212f196b7cSDaniel Vetter /** 2222f196b7cSDaniel Vetter * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state 2232f196b7cSDaniel Vetter * @plane: the loop cursor 2242f196b7cSDaniel Vetter * @plane_state: loop cursor for the plane's state, must be const 2252f196b7cSDaniel Vetter * @crtc_state: the incoming crtc-state 2262f196b7cSDaniel Vetter * 2272f196b7cSDaniel Vetter * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 2286806cdf9SDaniel Vetter * attached if the specified state is applied. Useful during for example 2296806cdf9SDaniel Vetter * in code called from &drm_mode_config_funcs.atomic_check operations, to 2306806cdf9SDaniel Vetter * validate the incoming state. 2312f196b7cSDaniel Vetter * 2322f196b7cSDaniel Vetter * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 2332f196b7cSDaniel Vetter * const plane_state. This is useful when a driver just wants to peek at other 2342f196b7cSDaniel Vetter * active planes on this crtc, but does not need to change it. 2352f196b7cSDaniel Vetter */ 2362f196b7cSDaniel Vetter #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 2372f196b7cSDaniel Vetter drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 2382f196b7cSDaniel Vetter for_each_if ((plane_state = \ 2392f196b7cSDaniel Vetter __drm_atomic_get_current_plane_state((crtc_state)->state, \ 2402f196b7cSDaniel Vetter plane))) 2412f196b7cSDaniel Vetter 24251ffa12dSMaarten Lankhorst /** 243407b8bd9SThierry Reding * drm_atomic_plane_disabling - check whether a plane is being disabled 24451ffa12dSMaarten Lankhorst * @old_plane_state: old atomic plane state 24551ffa12dSMaarten Lankhorst * @new_plane_state: new atomic plane state 246407b8bd9SThierry Reding * 247407b8bd9SThierry Reding * Checks the atomic state of a plane to determine whether it's being disabled 248407b8bd9SThierry Reding * or not. This also WARNs if it detects an invalid state (both CRTC and FB 249407b8bd9SThierry Reding * need to either both be NULL or both be non-NULL). 250407b8bd9SThierry Reding * 251407b8bd9SThierry Reding * RETURNS: 252407b8bd9SThierry Reding * True if the plane is being disabled, false otherwise. 253407b8bd9SThierry Reding */ 254407b8bd9SThierry Reding static inline bool 25551ffa12dSMaarten Lankhorst drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state, 25651ffa12dSMaarten Lankhorst struct drm_plane_state *new_plane_state) 257407b8bd9SThierry Reding { 258407b8bd9SThierry Reding /* 259407b8bd9SThierry Reding * When disabling a plane, CRTC and FB should always be NULL together. 260407b8bd9SThierry Reding * Anything else should be considered a bug in the atomic core, so we 261407b8bd9SThierry Reding * gently warn about it. 262407b8bd9SThierry Reding */ 26351ffa12dSMaarten Lankhorst WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) || 26451ffa12dSMaarten Lankhorst (new_plane_state->crtc != NULL && new_plane_state->fb == NULL)); 265407b8bd9SThierry Reding 26651ffa12dSMaarten Lankhorst return old_plane_state->crtc && !new_plane_state->crtc; 267407b8bd9SThierry Reding } 268407b8bd9SThierry Reding 269c2fcd274SDaniel Vetter #endif /* DRM_ATOMIC_HELPER_H_ */ 270