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, 43623369e5SDaniel Vetter bool async); 44623369e5SDaniel Vetter 45c240906dSJohn Keeping bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev, 46c240906dSJohn Keeping struct drm_atomic_state *old_state, 47c240906dSJohn Keeping struct drm_crtc *crtc); 48c240906dSJohn Keeping 495ee3229cSRob Clark void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 505ee3229cSRob Clark struct drm_atomic_state *old_state); 515ee3229cSRob Clark 524c18d301SDaniel Vetter void 534c18d301SDaniel Vetter drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, 544c18d301SDaniel Vetter struct drm_atomic_state *old_state); 554c18d301SDaniel Vetter 561af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 57623369e5SDaniel Vetter struct drm_atomic_state *state); 581af434a9SDaniel Vetter void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 59623369e5SDaniel Vetter struct drm_atomic_state *old_state); 60c2fcd274SDaniel Vetter 61c2fcd274SDaniel Vetter int drm_atomic_helper_prepare_planes(struct drm_device *dev, 62c2fcd274SDaniel Vetter struct drm_atomic_state *state); 63c2fcd274SDaniel Vetter void drm_atomic_helper_commit_planes(struct drm_device *dev, 64aef9dbb8SDaniel Vetter struct drm_atomic_state *state, 65aef9dbb8SDaniel Vetter bool active_only); 66c2fcd274SDaniel Vetter void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 67c2fcd274SDaniel Vetter struct drm_atomic_state *old_state); 68de28d021SMaarten Lankhorst void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); 696753ba97SJyri Sarha void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc, 706753ba97SJyri Sarha bool atomic); 71c2fcd274SDaniel Vetter 72c2fcd274SDaniel Vetter void drm_atomic_helper_swap_state(struct drm_device *dev, 73c2fcd274SDaniel Vetter struct drm_atomic_state *state); 74c2fcd274SDaniel Vetter 75042652edSDaniel Vetter /* implementations for legacy interfaces */ 76042652edSDaniel Vetter int drm_atomic_helper_update_plane(struct drm_plane *plane, 77042652edSDaniel Vetter struct drm_crtc *crtc, 78042652edSDaniel Vetter struct drm_framebuffer *fb, 79042652edSDaniel Vetter int crtc_x, int crtc_y, 80042652edSDaniel Vetter unsigned int crtc_w, unsigned int crtc_h, 81042652edSDaniel Vetter uint32_t src_x, uint32_t src_y, 82042652edSDaniel Vetter uint32_t src_w, uint32_t src_h); 83042652edSDaniel Vetter int drm_atomic_helper_disable_plane(struct drm_plane *plane); 84bbb1e524SRob Clark int __drm_atomic_helper_disable_plane(struct drm_plane *plane, 85bbb1e524SRob Clark struct drm_plane_state *plane_state); 86042652edSDaniel Vetter int drm_atomic_helper_set_config(struct drm_mode_set *set); 87bbb1e524SRob Clark int __drm_atomic_helper_set_config(struct drm_mode_set *set, 88bbb1e524SRob Clark struct drm_atomic_state *state); 89042652edSDaniel Vetter 9014942760SThierry Reding int drm_atomic_helper_disable_all(struct drm_device *dev, 9114942760SThierry Reding struct drm_modeset_acquire_ctx *ctx); 9214942760SThierry Reding struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); 9314942760SThierry Reding int drm_atomic_helper_resume(struct drm_device *dev, 9414942760SThierry Reding struct drm_atomic_state *state); 9514942760SThierry Reding 96042652edSDaniel Vetter int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, 97042652edSDaniel Vetter struct drm_property *property, 98042652edSDaniel Vetter uint64_t val); 99042652edSDaniel Vetter int drm_atomic_helper_plane_set_property(struct drm_plane *plane, 100042652edSDaniel Vetter struct drm_property *property, 101042652edSDaniel Vetter uint64_t val); 102042652edSDaniel Vetter int drm_atomic_helper_connector_set_property(struct drm_connector *connector, 103042652edSDaniel Vetter struct drm_property *property, 104042652edSDaniel Vetter uint64_t val); 1058bc0f312SDaniel Vetter int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 1068bc0f312SDaniel Vetter struct drm_framebuffer *fb, 1078bc0f312SDaniel Vetter struct drm_pending_vblank_event *event, 1088bc0f312SDaniel Vetter uint32_t flags); 1099a69a9acSMaarten Lankhorst int drm_atomic_helper_connector_dpms(struct drm_connector *connector, 110b486e0e6SDaniel Vetter int mode); 1118bc0f312SDaniel Vetter 112d461701cSDaniel Vetter /* default implementations for state handling */ 113d461701cSDaniel Vetter void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 114f5e7840bSThierry Reding void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 115f5e7840bSThierry Reding struct drm_crtc_state *state); 116d461701cSDaniel Vetter struct drm_crtc_state * 117d461701cSDaniel Vetter drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 118f5e7840bSThierry Reding void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 119f5e7840bSThierry Reding struct drm_crtc_state *state); 120d461701cSDaniel Vetter void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 121d461701cSDaniel Vetter struct drm_crtc_state *state); 122d461701cSDaniel Vetter 123d461701cSDaniel Vetter void drm_atomic_helper_plane_reset(struct drm_plane *plane); 124f5e7840bSThierry Reding void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 125f5e7840bSThierry Reding struct drm_plane_state *state); 126d461701cSDaniel Vetter struct drm_plane_state * 127d461701cSDaniel Vetter drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 128f5e7840bSThierry Reding void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 129f5e7840bSThierry Reding struct drm_plane_state *state); 130d461701cSDaniel Vetter void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 131d461701cSDaniel Vetter struct drm_plane_state *state); 132d461701cSDaniel Vetter 1334cd39917SMaarten Lankhorst void __drm_atomic_helper_connector_reset(struct drm_connector *connector, 1344cd39917SMaarten Lankhorst struct drm_connector_state *conn_state); 135d461701cSDaniel Vetter void drm_atomic_helper_connector_reset(struct drm_connector *connector); 136f5e7840bSThierry Reding void 137f5e7840bSThierry Reding __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 138f5e7840bSThierry Reding struct drm_connector_state *state); 139d461701cSDaniel Vetter struct drm_connector_state * 140d461701cSDaniel Vetter drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 141397fd77cSThierry Reding struct drm_atomic_state * 142397fd77cSThierry Reding drm_atomic_helper_duplicate_state(struct drm_device *dev, 143397fd77cSThierry Reding struct drm_modeset_acquire_ctx *ctx); 144f5e7840bSThierry Reding void 145f5e7840bSThierry Reding __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 146f5e7840bSThierry Reding struct drm_connector_state *state); 147d461701cSDaniel Vetter void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 148d461701cSDaniel Vetter struct drm_connector_state *state); 1495488dc16SLionel Landwerlin void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, 1505488dc16SLionel Landwerlin u16 *red, u16 *green, u16 *blue, 1515488dc16SLionel Landwerlin uint32_t start, uint32_t size); 152d461701cSDaniel Vetter 153dd275956SRob Clark /** 154dd275956SRob Clark * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 155dd275956SRob Clark * @plane: the loop cursor 156dd275956SRob Clark * @crtc: the crtc whose planes are iterated 157dd275956SRob Clark * 158dd275956SRob Clark * This iterates over the current state, useful (for example) when applying 159dd275956SRob Clark * atomic state after it has been checked and swapped. To iterate over the 160dd275956SRob Clark * planes which *will* be attached (for ->atomic_check()) see 161dd275956SRob Clark * drm_crtc_for_each_pending_plane() 162dd275956SRob Clark */ 163dd275956SRob Clark #define drm_atomic_crtc_for_each_plane(plane, crtc) \ 164dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 165dd275956SRob Clark 166dd275956SRob Clark /** 167dd275956SRob Clark * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 168dd275956SRob Clark * @plane: the loop cursor 169dd275956SRob Clark * @crtc_state: the incoming crtc-state 170dd275956SRob Clark * 171dd275956SRob Clark * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 172dd275956SRob Clark * attached if the specified state is applied. Useful during (for example) 173dd275956SRob Clark * ->atomic_check() operations, to validate the incoming state 174dd275956SRob Clark */ 175dd275956SRob Clark #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 176dd275956SRob Clark drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 177042652edSDaniel Vetter 178407b8bd9SThierry Reding /* 179407b8bd9SThierry Reding * drm_atomic_plane_disabling - check whether a plane is being disabled 180407b8bd9SThierry Reding * @plane: plane object 181407b8bd9SThierry Reding * @old_state: previous atomic state 182407b8bd9SThierry Reding * 183407b8bd9SThierry Reding * Checks the atomic state of a plane to determine whether it's being disabled 184407b8bd9SThierry Reding * or not. This also WARNs if it detects an invalid state (both CRTC and FB 185407b8bd9SThierry Reding * need to either both be NULL or both be non-NULL). 186407b8bd9SThierry Reding * 187407b8bd9SThierry Reding * RETURNS: 188407b8bd9SThierry Reding * True if the plane is being disabled, false otherwise. 189407b8bd9SThierry Reding */ 190407b8bd9SThierry Reding static inline bool 191407b8bd9SThierry Reding drm_atomic_plane_disabling(struct drm_plane *plane, 192407b8bd9SThierry Reding struct drm_plane_state *old_state) 193407b8bd9SThierry Reding { 194407b8bd9SThierry Reding /* 195407b8bd9SThierry Reding * When disabling a plane, CRTC and FB should always be NULL together. 196407b8bd9SThierry Reding * Anything else should be considered a bug in the atomic core, so we 197407b8bd9SThierry Reding * gently warn about it. 198407b8bd9SThierry Reding */ 199407b8bd9SThierry Reding WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || 200407b8bd9SThierry Reding (plane->state->crtc != NULL && plane->state->fb == NULL)); 201407b8bd9SThierry Reding 202407b8bd9SThierry Reding /* 203407b8bd9SThierry Reding * When using the transitional helpers, old_state may be NULL. If so, 204407b8bd9SThierry Reding * we know nothing about the current state and have to assume that it 205407b8bd9SThierry Reding * might be enabled. 206407b8bd9SThierry Reding * 207407b8bd9SThierry Reding * When using the atomic helpers, old_state won't be NULL. Therefore 208407b8bd9SThierry Reding * this check assumes that either the driver will have reconstructed 209407b8bd9SThierry Reding * the correct state in ->reset() or that the driver will have taken 210407b8bd9SThierry Reding * appropriate measures to disable all planes. 211407b8bd9SThierry Reding */ 212407b8bd9SThierry Reding return (!old_state || old_state->crtc) && !plane->state->crtc; 213407b8bd9SThierry Reding } 214407b8bd9SThierry Reding 215c2fcd274SDaniel Vetter #endif /* DRM_ATOMIC_HELPER_H_ */ 216