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; 36bbb1e524SRob Clark 37d9b13620SDaniel Vetter int drm_atomic_helper_check_modeset(struct drm_device *dev, 38d9b13620SDaniel Vetter struct drm_atomic_state *state); 39d9b13620SDaniel Vetter int drm_atomic_helper_check_planes(struct drm_device *dev, 40d9b13620SDaniel Vetter struct drm_atomic_state *state); 41c2fcd274SDaniel Vetter int drm_atomic_helper_check(struct drm_device *dev, 42c2fcd274SDaniel Vetter struct drm_atomic_state *state); 439f2a7950SDaniel Vetter void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); 44623369e5SDaniel Vetter int drm_atomic_helper_commit(struct drm_device *dev, 45623369e5SDaniel Vetter struct drm_atomic_state *state, 46286dbb8dSMaarten Lankhorst bool nonblock); 47623369e5SDaniel Vetter 48f6ce410aSGustavo Padovan int drm_atomic_helper_wait_for_fences(struct drm_device *dev, 49f6ce410aSGustavo Padovan struct drm_atomic_state *state, 50f6ce410aSGustavo Padovan bool pre_swap); 51c240906dSJohn Keeping bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev, 52c240906dSJohn Keeping struct drm_atomic_state *old_state, 53c240906dSJohn Keeping struct drm_crtc *crtc); 54c240906dSJohn Keeping 555ee3229cSRob Clark void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 565ee3229cSRob Clark struct drm_atomic_state *old_state); 575ee3229cSRob Clark 584c18d301SDaniel Vetter void 594c18d301SDaniel Vetter drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 604c18d301SDaniel Vetter struct drm_atomic_state *old_state); 614c18d301SDaniel Vetter 621af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 63623369e5SDaniel Vetter struct drm_atomic_state *state); 641af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 65623369e5SDaniel Vetter struct drm_atomic_state *old_state); 66c2fcd274SDaniel Vetter 67c2fcd274SDaniel Vetter int drm_atomic_helper_prepare_planes(struct drm_device *dev, 68c2fcd274SDaniel Vetter struct drm_atomic_state *state); 692b58e98dSLiu Ying 702b58e98dSLiu Ying #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) 712b58e98dSLiu Ying #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) 722b58e98dSLiu Ying 73c2fcd274SDaniel Vetter void drm_atomic_helper_commit_planes(struct drm_device *dev, 74aef9dbb8SDaniel Vetter struct drm_atomic_state *state, 752b58e98dSLiu Ying uint32_t flags); 76c2fcd274SDaniel Vetter void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 77c2fcd274SDaniel Vetter struct drm_atomic_state *old_state); 78de28d021SMaarten Lankhorst void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 7928500291SLiu Ying void 8028500291SLiu Ying drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, 816753ba97SJyri Sarha bool atomic); 82c2fcd274SDaniel Vetter 835e84c269SDaniel Vetter void drm_atomic_helper_swap_state(struct drm_atomic_state *state, 845e84c269SDaniel Vetter bool stall); 85c2fcd274SDaniel Vetter 86a095caa7SDaniel Vetter /* nonblocking commit helpers */ 87a095caa7SDaniel Vetter int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 88a095caa7SDaniel Vetter bool nonblock); 89a095caa7SDaniel Vetter void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 90a095caa7SDaniel Vetter void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 91a095caa7SDaniel Vetter void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 92a095caa7SDaniel Vetter 93042652edSDaniel Vetter /* implementations for legacy interfaces */ 94042652edSDaniel Vetter int drm_atomic_helper_update_plane(struct drm_plane *plane, 95042652edSDaniel Vetter struct drm_crtc *crtc, 96042652edSDaniel Vetter struct drm_framebuffer *fb, 97042652edSDaniel Vetter int crtc_x, int crtc_y, 98042652edSDaniel Vetter unsigned int crtc_w, unsigned int crtc_h, 99042652edSDaniel Vetter uint32_t src_x, uint32_t src_y, 100042652edSDaniel Vetter uint32_t src_w, uint32_t src_h); 101042652edSDaniel Vetter int drm_atomic_helper_disable_plane(struct drm_plane *plane); 102bbb1e524SRob Clark int __drm_atomic_helper_disable_plane(struct drm_plane *plane, 103bbb1e524SRob Clark struct drm_plane_state *plane_state); 104042652edSDaniel Vetter int drm_atomic_helper_set_config(struct drm_mode_set *set); 105bbb1e524SRob Clark int __drm_atomic_helper_set_config(struct drm_mode_set *set, 106bbb1e524SRob Clark struct drm_atomic_state *state); 107042652edSDaniel Vetter 10814942760SThierry Reding int drm_atomic_helper_disable_all(struct drm_device *dev, 10914942760SThierry Reding struct drm_modeset_acquire_ctx *ctx); 11014942760SThierry Reding struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 11114942760SThierry Reding int drm_atomic_helper_resume(struct drm_device *dev, 11214942760SThierry Reding struct drm_atomic_state *state); 11314942760SThierry Reding 114042652edSDaniel Vetter int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, 115042652edSDaniel Vetter struct drm_property *property, 116042652edSDaniel Vetter uint64_t val); 117042652edSDaniel Vetter int drm_atomic_helper_plane_set_property(struct drm_plane *plane, 118042652edSDaniel Vetter struct drm_property *property, 119042652edSDaniel Vetter uint64_t val); 120042652edSDaniel Vetter int drm_atomic_helper_connector_set_property(struct drm_connector *connector, 121042652edSDaniel Vetter struct drm_property *property, 122042652edSDaniel Vetter uint64_t val); 1238bc0f312SDaniel Vetter int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 1248bc0f312SDaniel Vetter struct drm_framebuffer *fb, 1258bc0f312SDaniel Vetter struct drm_pending_vblank_event *event, 1268bc0f312SDaniel Vetter uint32_t flags); 1279a69a9acSMaarten Lankhorst int drm_atomic_helper_connector_dpms(struct drm_connector *connector, 128b486e0e6SDaniel Vetter int mode); 1299ecb5498SNoralf Trønnes struct drm_encoder * 1309ecb5498SNoralf Trønnes drm_atomic_helper_best_encoder(struct drm_connector *connector); 1318bc0f312SDaniel Vetter 132d461701cSDaniel Vetter /* default implementations for state handling */ 133d461701cSDaniel Vetter void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 134f5e7840bSThierry Reding void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 135f5e7840bSThierry Reding struct drm_crtc_state *state); 136d461701cSDaniel Vetter struct drm_crtc_state * 137d461701cSDaniel Vetter drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 138ec2dc6a0SDaniel Vetter void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state); 139d461701cSDaniel Vetter void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 140d461701cSDaniel Vetter struct drm_crtc_state *state); 141d461701cSDaniel Vetter 142d461701cSDaniel Vetter void drm_atomic_helper_plane_reset(struct drm_plane *plane); 143f5e7840bSThierry Reding void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 144f5e7840bSThierry Reding struct drm_plane_state *state); 145d461701cSDaniel Vetter struct drm_plane_state * 146d461701cSDaniel Vetter drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 1472f701695SDaniel Vetter void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state); 148d461701cSDaniel Vetter void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 149d461701cSDaniel Vetter struct drm_plane_state *state); 150d461701cSDaniel Vetter 1514cd39917SMaarten Lankhorst void __drm_atomic_helper_connector_reset(struct drm_connector *connector, 1524cd39917SMaarten Lankhorst struct drm_connector_state *conn_state); 153d461701cSDaniel Vetter void drm_atomic_helper_connector_reset(struct drm_connector *connector); 154f5e7840bSThierry Reding void 155f5e7840bSThierry Reding __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 156f5e7840bSThierry Reding struct drm_connector_state *state); 157d461701cSDaniel Vetter struct drm_connector_state * 158d461701cSDaniel Vetter drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 159397fd77cSThierry Reding struct drm_atomic_state * 160397fd77cSThierry Reding drm_atomic_helper_duplicate_state(struct drm_device *dev, 161397fd77cSThierry Reding struct drm_modeset_acquire_ctx *ctx); 162f5e7840bSThierry Reding void 163fabd9106SDaniel Vetter __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state); 164d461701cSDaniel Vetter void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 165d461701cSDaniel Vetter struct drm_connector_state *state); 1667ea77283SMaarten Lankhorst int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 1675488dc16SLionel Landwerlin u16 *red, u16 *green, u16 *blue, 1687ea77283SMaarten Lankhorst uint32_t size); 169d461701cSDaniel Vetter 170dd275956SRob Clark /** 171dd275956SRob Clark * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 172dd275956SRob Clark * @plane: the loop cursor 173dd275956SRob Clark * @crtc: the crtc whose planes are iterated 174dd275956SRob Clark * 175dd275956SRob Clark * This iterates over the current state, useful (for example) when applying 176dd275956SRob Clark * atomic state after it has been checked and swapped. To iterate over the 177dd275956SRob Clark * planes which *will* be attached (for ->atomic_check()) see 1785c0be3f1SLiviu Dudau * drm_atomic_crtc_state_for_each_plane(). 179dd275956SRob Clark */ 180dd275956SRob Clark #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 181dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 182dd275956SRob Clark 183dd275956SRob Clark /** 184dd275956SRob Clark * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 185dd275956SRob Clark * @plane: the loop cursor 186dd275956SRob Clark * @crtc_state: the incoming crtc-state 187dd275956SRob Clark * 188dd275956SRob Clark * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 189dd275956SRob Clark * attached if the specified state is applied. Useful during (for example) 1902f196b7cSDaniel Vetter * ->atomic_check() operations, to validate the incoming state. 191dd275956SRob Clark */ 192dd275956SRob Clark #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 193dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 194042652edSDaniel Vetter 1952f196b7cSDaniel Vetter /** 1962f196b7cSDaniel Vetter * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state 1972f196b7cSDaniel Vetter * @plane: the loop cursor 1982f196b7cSDaniel Vetter * @plane_state: loop cursor for the plane's state, must be const 1992f196b7cSDaniel Vetter * @crtc_state: the incoming crtc-state 2002f196b7cSDaniel Vetter * 2012f196b7cSDaniel Vetter * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 2022f196b7cSDaniel Vetter * attached if the specified state is applied. Useful during (for example) 2032f196b7cSDaniel Vetter * ->atomic_check() operations, to validate the incoming state. 2042f196b7cSDaniel Vetter * 2052f196b7cSDaniel Vetter * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 2062f196b7cSDaniel Vetter * const plane_state. This is useful when a driver just wants to peek at other 2072f196b7cSDaniel Vetter * active planes on this crtc, but does not need to change it. 2082f196b7cSDaniel Vetter */ 2092f196b7cSDaniel Vetter #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 2102f196b7cSDaniel Vetter drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 2112f196b7cSDaniel Vetter for_each_if ((plane_state = \ 2122f196b7cSDaniel Vetter __drm_atomic_get_current_plane_state((crtc_state)->state, \ 2132f196b7cSDaniel Vetter plane))) 2142f196b7cSDaniel Vetter 215407b8bd9SThierry Reding /* 216407b8bd9SThierry Reding * drm_atomic_plane_disabling - check whether a plane is being disabled 217407b8bd9SThierry Reding * @plane: plane object 218407b8bd9SThierry Reding * @old_state: previous atomic state 219407b8bd9SThierry Reding * 220407b8bd9SThierry Reding * Checks the atomic state of a plane to determine whether it's being disabled 221407b8bd9SThierry Reding * or not. This also WARNs if it detects an invalid state (both CRTC and FB 222407b8bd9SThierry Reding * need to either both be NULL or both be non-NULL). 223407b8bd9SThierry Reding * 224407b8bd9SThierry Reding * RETURNS: 225407b8bd9SThierry Reding * True if the plane is being disabled, false otherwise. 226407b8bd9SThierry Reding */ 227407b8bd9SThierry Reding static inline bool 228407b8bd9SThierry Reding drm_atomic_plane_disabling(struct drm_plane *plane, 229407b8bd9SThierry Reding struct drm_plane_state *old_state) 230407b8bd9SThierry Reding { 231407b8bd9SThierry Reding /* 232407b8bd9SThierry Reding * When disabling a plane, CRTC and FB should always be NULL together. 233407b8bd9SThierry Reding * Anything else should be considered a bug in the atomic core, so we 234407b8bd9SThierry Reding * gently warn about it. 235407b8bd9SThierry Reding */ 236407b8bd9SThierry Reding WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || 237407b8bd9SThierry Reding (plane->state->crtc != NULL && plane->state->fb == NULL)); 238407b8bd9SThierry Reding 239407b8bd9SThierry Reding /* 240407b8bd9SThierry Reding * When using the transitional helpers, old_state may be NULL. If so, 241407b8bd9SThierry Reding * we know nothing about the current state and have to assume that it 242407b8bd9SThierry Reding * might be enabled. 243407b8bd9SThierry Reding * 244407b8bd9SThierry Reding * When using the atomic helpers, old_state won't be NULL. Therefore 245407b8bd9SThierry Reding * this check assumes that either the driver will have reconstructed 246407b8bd9SThierry Reding * the correct state in ->reset() or that the driver will have taken 247407b8bd9SThierry Reding * appropriate measures to disable all planes. 248407b8bd9SThierry Reding */ 249407b8bd9SThierry Reding return (!old_state || old_state->crtc) && !plane->state->crtc; 250407b8bd9SThierry Reding } 251407b8bd9SThierry Reding 252c2fcd274SDaniel Vetter #endif /* DRM_ATOMIC_HELPER_H_ */ 253