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> 320254951dSThierry Reding 33bbb1e524SRob Clark struct drm_atomic_state; 34bbb1e524SRob Clark 35d9b13620SDaniel Vetter int drm_atomic_helper_check_modeset(struct drm_device *dev, 36d9b13620SDaniel Vetter struct drm_atomic_state *state); 37d9b13620SDaniel Vetter int drm_atomic_helper_check_planes(struct drm_device *dev, 38d9b13620SDaniel Vetter struct drm_atomic_state *state); 39c2fcd274SDaniel Vetter int drm_atomic_helper_check(struct drm_device *dev, 40c2fcd274SDaniel Vetter struct drm_atomic_state *state); 41623369e5SDaniel Vetter int drm_atomic_helper_commit(struct drm_device *dev, 42623369e5SDaniel Vetter struct drm_atomic_state *state, 43286dbb8dSMaarten Lankhorst bool nonblock); 44623369e5SDaniel Vetter 454c5b7f3aSRob Clark void drm_atomic_helper_wait_for_fences(struct drm_device *dev, 464c5b7f3aSRob Clark struct drm_atomic_state *state); 47c240906dSJohn Keeping bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev, 48c240906dSJohn Keeping struct drm_atomic_state *old_state, 49c240906dSJohn Keeping struct drm_crtc *crtc); 50c240906dSJohn Keeping 515ee3229cSRob Clark void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 525ee3229cSRob Clark struct drm_atomic_state *old_state); 535ee3229cSRob Clark 544c18d301SDaniel Vetter void 554c18d301SDaniel Vetter drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 564c18d301SDaniel Vetter struct drm_atomic_state *old_state); 574c18d301SDaniel Vetter 581af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 59623369e5SDaniel Vetter struct drm_atomic_state *state); 601af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 61623369e5SDaniel Vetter struct drm_atomic_state *old_state); 62c2fcd274SDaniel Vetter 63c2fcd274SDaniel Vetter int drm_atomic_helper_prepare_planes(struct drm_device *dev, 64c2fcd274SDaniel Vetter struct drm_atomic_state *state); 65c2fcd274SDaniel Vetter void drm_atomic_helper_commit_planes(struct drm_device *dev, 66aef9dbb8SDaniel Vetter struct drm_atomic_state *state, 67aef9dbb8SDaniel Vetter bool active_only); 68c2fcd274SDaniel Vetter void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 69c2fcd274SDaniel Vetter struct drm_atomic_state *old_state); 70de28d021SMaarten Lankhorst void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 716753ba97SJyri Sarha void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc, 726753ba97SJyri Sarha bool atomic); 73c2fcd274SDaniel Vetter 745e84c269SDaniel Vetter void drm_atomic_helper_swap_state(struct drm_atomic_state *state, 755e84c269SDaniel Vetter bool stall); 76c2fcd274SDaniel Vetter 77a095caa7SDaniel Vetter /* nonblocking commit helpers */ 78a095caa7SDaniel Vetter int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, 79a095caa7SDaniel Vetter bool nonblock); 80a095caa7SDaniel Vetter void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); 81a095caa7SDaniel Vetter void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); 82a095caa7SDaniel Vetter void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); 83a095caa7SDaniel Vetter 84042652edSDaniel Vetter /* implementations for legacy interfaces */ 85042652edSDaniel Vetter int drm_atomic_helper_update_plane(struct drm_plane *plane, 86042652edSDaniel Vetter struct drm_crtc *crtc, 87042652edSDaniel Vetter struct drm_framebuffer *fb, 88042652edSDaniel Vetter int crtc_x, int crtc_y, 89042652edSDaniel Vetter unsigned int crtc_w, unsigned int crtc_h, 90042652edSDaniel Vetter uint32_t src_x, uint32_t src_y, 91042652edSDaniel Vetter uint32_t src_w, uint32_t src_h); 92042652edSDaniel Vetter int drm_atomic_helper_disable_plane(struct drm_plane *plane); 93bbb1e524SRob Clark int __drm_atomic_helper_disable_plane(struct drm_plane *plane, 94bbb1e524SRob Clark struct drm_plane_state *plane_state); 95042652edSDaniel Vetter int drm_atomic_helper_set_config(struct drm_mode_set *set); 96bbb1e524SRob Clark int __drm_atomic_helper_set_config(struct drm_mode_set *set, 97bbb1e524SRob Clark struct drm_atomic_state *state); 98042652edSDaniel Vetter 9914942760SThierry Reding int drm_atomic_helper_disable_all(struct drm_device *dev, 10014942760SThierry Reding struct drm_modeset_acquire_ctx *ctx); 10114942760SThierry Reding struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 10214942760SThierry Reding int drm_atomic_helper_resume(struct drm_device *dev, 10314942760SThierry Reding struct drm_atomic_state *state); 10414942760SThierry Reding 105042652edSDaniel Vetter int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, 106042652edSDaniel Vetter struct drm_property *property, 107042652edSDaniel Vetter uint64_t val); 108042652edSDaniel Vetter int drm_atomic_helper_plane_set_property(struct drm_plane *plane, 109042652edSDaniel Vetter struct drm_property *property, 110042652edSDaniel Vetter uint64_t val); 111042652edSDaniel Vetter int drm_atomic_helper_connector_set_property(struct drm_connector *connector, 112042652edSDaniel Vetter struct drm_property *property, 113042652edSDaniel Vetter uint64_t val); 1148bc0f312SDaniel Vetter int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 1158bc0f312SDaniel Vetter struct drm_framebuffer *fb, 1168bc0f312SDaniel Vetter struct drm_pending_vblank_event *event, 1178bc0f312SDaniel Vetter uint32_t flags); 1189a69a9acSMaarten Lankhorst int drm_atomic_helper_connector_dpms(struct drm_connector *connector, 119b486e0e6SDaniel Vetter int mode); 1209ecb5498SNoralf Trønnes struct drm_encoder * 1219ecb5498SNoralf Trønnes drm_atomic_helper_best_encoder(struct drm_connector *connector); 1228bc0f312SDaniel Vetter 123d461701cSDaniel Vetter /* default implementations for state handling */ 124d461701cSDaniel Vetter void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 125f5e7840bSThierry Reding void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 126f5e7840bSThierry Reding struct drm_crtc_state *state); 127d461701cSDaniel Vetter struct drm_crtc_state * 128d461701cSDaniel Vetter drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 129ec2dc6a0SDaniel Vetter void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state); 130d461701cSDaniel Vetter void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 131d461701cSDaniel Vetter struct drm_crtc_state *state); 132d461701cSDaniel Vetter 133d461701cSDaniel Vetter void drm_atomic_helper_plane_reset(struct drm_plane *plane); 134f5e7840bSThierry Reding void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 135f5e7840bSThierry Reding struct drm_plane_state *state); 136d461701cSDaniel Vetter struct drm_plane_state * 137d461701cSDaniel Vetter drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 1382f701695SDaniel Vetter void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state); 139d461701cSDaniel Vetter void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 140d461701cSDaniel Vetter struct drm_plane_state *state); 141d461701cSDaniel Vetter 1424cd39917SMaarten Lankhorst void __drm_atomic_helper_connector_reset(struct drm_connector *connector, 1434cd39917SMaarten Lankhorst struct drm_connector_state *conn_state); 144d461701cSDaniel Vetter void drm_atomic_helper_connector_reset(struct drm_connector *connector); 145f5e7840bSThierry Reding void 146f5e7840bSThierry Reding __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 147f5e7840bSThierry Reding struct drm_connector_state *state); 148d461701cSDaniel Vetter struct drm_connector_state * 149d461701cSDaniel Vetter drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 150397fd77cSThierry Reding struct drm_atomic_state * 151397fd77cSThierry Reding drm_atomic_helper_duplicate_state(struct drm_device *dev, 152397fd77cSThierry Reding struct drm_modeset_acquire_ctx *ctx); 153f5e7840bSThierry Reding void 154fabd9106SDaniel Vetter __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state); 155d461701cSDaniel Vetter void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 156d461701cSDaniel Vetter struct drm_connector_state *state); 1577ea77283SMaarten Lankhorst int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 1585488dc16SLionel Landwerlin u16 *red, u16 *green, u16 *blue, 1597ea77283SMaarten Lankhorst uint32_t size); 160d461701cSDaniel Vetter 161dd275956SRob Clark /** 162dd275956SRob Clark * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 163dd275956SRob Clark * @plane: the loop cursor 164dd275956SRob Clark * @crtc: the crtc whose planes are iterated 165dd275956SRob Clark * 166dd275956SRob Clark * This iterates over the current state, useful (for example) when applying 167dd275956SRob Clark * atomic state after it has been checked and swapped. To iterate over the 168dd275956SRob Clark * planes which *will* be attached (for ->atomic_check()) see 1692f196b7cSDaniel Vetter * drm_crtc_for_each_pending_plane(). 170dd275956SRob Clark */ 171dd275956SRob Clark #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 172dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 173dd275956SRob Clark 174dd275956SRob Clark /** 175dd275956SRob Clark * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 176dd275956SRob Clark * @plane: the loop cursor 177dd275956SRob Clark * @crtc_state: the incoming crtc-state 178dd275956SRob Clark * 179dd275956SRob Clark * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 180dd275956SRob Clark * attached if the specified state is applied. Useful during (for example) 1812f196b7cSDaniel Vetter * ->atomic_check() operations, to validate the incoming state. 182dd275956SRob Clark */ 183dd275956SRob Clark #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 184dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 185042652edSDaniel Vetter 1862f196b7cSDaniel Vetter /** 1872f196b7cSDaniel Vetter * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state 1882f196b7cSDaniel Vetter * @plane: the loop cursor 1892f196b7cSDaniel Vetter * @plane_state: loop cursor for the plane's state, must be const 1902f196b7cSDaniel Vetter * @crtc_state: the incoming crtc-state 1912f196b7cSDaniel Vetter * 1922f196b7cSDaniel Vetter * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 1932f196b7cSDaniel Vetter * attached if the specified state is applied. Useful during (for example) 1942f196b7cSDaniel Vetter * ->atomic_check() operations, to validate the incoming state. 1952f196b7cSDaniel Vetter * 1962f196b7cSDaniel Vetter * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 1972f196b7cSDaniel Vetter * const plane_state. This is useful when a driver just wants to peek at other 1982f196b7cSDaniel Vetter * active planes on this crtc, but does not need to change it. 1992f196b7cSDaniel Vetter */ 2002f196b7cSDaniel Vetter #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 2012f196b7cSDaniel Vetter drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ 2022f196b7cSDaniel Vetter for_each_if ((plane_state = \ 2032f196b7cSDaniel Vetter __drm_atomic_get_current_plane_state((crtc_state)->state, \ 2042f196b7cSDaniel Vetter plane))) 2052f196b7cSDaniel Vetter 206407b8bd9SThierry Reding /* 207407b8bd9SThierry Reding * drm_atomic_plane_disabling - check whether a plane is being disabled 208407b8bd9SThierry Reding * @plane: plane object 209407b8bd9SThierry Reding * @old_state: previous atomic state 210407b8bd9SThierry Reding * 211407b8bd9SThierry Reding * Checks the atomic state of a plane to determine whether it's being disabled 212407b8bd9SThierry Reding * or not. This also WARNs if it detects an invalid state (both CRTC and FB 213407b8bd9SThierry Reding * need to either both be NULL or both be non-NULL). 214407b8bd9SThierry Reding * 215407b8bd9SThierry Reding * RETURNS: 216407b8bd9SThierry Reding * True if the plane is being disabled, false otherwise. 217407b8bd9SThierry Reding */ 218407b8bd9SThierry Reding static inline bool 219407b8bd9SThierry Reding drm_atomic_plane_disabling(struct drm_plane *plane, 220407b8bd9SThierry Reding struct drm_plane_state *old_state) 221407b8bd9SThierry Reding { 222407b8bd9SThierry Reding /* 223407b8bd9SThierry Reding * When disabling a plane, CRTC and FB should always be NULL together. 224407b8bd9SThierry Reding * Anything else should be considered a bug in the atomic core, so we 225407b8bd9SThierry Reding * gently warn about it. 226407b8bd9SThierry Reding */ 227407b8bd9SThierry Reding WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || 228407b8bd9SThierry Reding (plane->state->crtc != NULL && plane->state->fb == NULL)); 229407b8bd9SThierry Reding 230407b8bd9SThierry Reding /* 231407b8bd9SThierry Reding * When using the transitional helpers, old_state may be NULL. If so, 232407b8bd9SThierry Reding * we know nothing about the current state and have to assume that it 233407b8bd9SThierry Reding * might be enabled. 234407b8bd9SThierry Reding * 235407b8bd9SThierry Reding * When using the atomic helpers, old_state won't be NULL. Therefore 236407b8bd9SThierry Reding * this check assumes that either the driver will have reconstructed 237407b8bd9SThierry Reding * the correct state in ->reset() or that the driver will have taken 238407b8bd9SThierry Reding * appropriate measures to disable all planes. 239407b8bd9SThierry Reding */ 240407b8bd9SThierry Reding return (!old_state || old_state->crtc) && !plane->state->crtc; 241407b8bd9SThierry Reding } 242407b8bd9SThierry Reding 243c2fcd274SDaniel Vetter #endif /* DRM_ATOMIC_HELPER_H_ */ 244