1/* 2 * Copyright (C) 2014 Red Hat 3 * Copyright (C) 2014 Intel Corp. 4 * 5 * Permission is hereby granted, free of charge, to any person obtaining a 6 * copy of this software and associated documentation files (the "Software"), 7 * to deal in the Software without restriction, including without limitation 8 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 9 * and/or sell copies of the Software, and to permit persons to whom the 10 * Software is furnished to do so, subject to the following conditions: 11 * 12 * The above copyright notice and this permission notice shall be included in 13 * all copies or substantial portions of the Software. 14 * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR 19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 21 * OTHER DEALINGS IN THE SOFTWARE. 22 * 23 * Authors: 24 * Rob Clark <robdclark@gmail.com> 25 * Daniel Vetter <daniel.vetter@ffwll.ch> 26 */ 27 28#ifndef DRM_ATOMIC_HELPER_H_ 29#define DRM_ATOMIC_HELPER_H_ 30 31#include <drm/drm_crtc.h> 32 33int drm_atomic_helper_check_modeset(struct drm_device *dev, 34 struct drm_atomic_state *state); 35int drm_atomic_helper_check_planes(struct drm_device *dev, 36 struct drm_atomic_state *state); 37int drm_atomic_helper_check(struct drm_device *dev, 38 struct drm_atomic_state *state); 39int drm_atomic_helper_commit(struct drm_device *dev, 40 struct drm_atomic_state *state, 41 bool async); 42 43void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, 44 struct drm_atomic_state *old_state); 45 46void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, 47 struct drm_atomic_state *state); 48void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, 49 struct drm_atomic_state *old_state); 50 51int drm_atomic_helper_prepare_planes(struct drm_device *dev, 52 struct drm_atomic_state *state); 53void drm_atomic_helper_commit_planes(struct drm_device *dev, 54 struct drm_atomic_state *state); 55void drm_atomic_helper_cleanup_planes(struct drm_device *dev, 56 struct drm_atomic_state *old_state); 57 58void drm_atomic_helper_swap_state(struct drm_device *dev, 59 struct drm_atomic_state *state); 60 61/* implementations for legacy interfaces */ 62int drm_atomic_helper_update_plane(struct drm_plane *plane, 63 struct drm_crtc *crtc, 64 struct drm_framebuffer *fb, 65 int crtc_x, int crtc_y, 66 unsigned int crtc_w, unsigned int crtc_h, 67 uint32_t src_x, uint32_t src_y, 68 uint32_t src_w, uint32_t src_h); 69int drm_atomic_helper_disable_plane(struct drm_plane *plane); 70int drm_atomic_helper_set_config(struct drm_mode_set *set); 71 72int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, 73 struct drm_property *property, 74 uint64_t val); 75int drm_atomic_helper_plane_set_property(struct drm_plane *plane, 76 struct drm_property *property, 77 uint64_t val); 78int drm_atomic_helper_connector_set_property(struct drm_connector *connector, 79 struct drm_property *property, 80 uint64_t val); 81int drm_atomic_helper_page_flip(struct drm_crtc *crtc, 82 struct drm_framebuffer *fb, 83 struct drm_pending_vblank_event *event, 84 uint32_t flags); 85void drm_atomic_helper_connector_dpms(struct drm_connector *connector, 86 int mode); 87 88/* default implementations for state handling */ 89void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); 90void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, 91 struct drm_crtc_state *state); 92struct drm_crtc_state * 93drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); 94void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 95 struct drm_crtc_state *state); 96void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, 97 struct drm_crtc_state *state); 98 99void drm_atomic_helper_plane_reset(struct drm_plane *plane); 100void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, 101 struct drm_plane_state *state); 102struct drm_plane_state * 103drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); 104void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 105 struct drm_plane_state *state); 106void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, 107 struct drm_plane_state *state); 108 109void drm_atomic_helper_connector_reset(struct drm_connector *connector); 110void 111__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, 112 struct drm_connector_state *state); 113struct drm_connector_state * 114drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); 115void 116__drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 117 struct drm_connector_state *state); 118void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, 119 struct drm_connector_state *state); 120 121/** 122 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 123 * @plane: the loop cursor 124 * @crtc: the crtc whose planes are iterated 125 * 126 * This iterates over the current state, useful (for example) when applying 127 * atomic state after it has been checked and swapped. To iterate over the 128 * planes which *will* be attached (for ->atomic_check()) see 129 * drm_crtc_for_each_pending_plane() 130 */ 131#define drm_atomic_crtc_for_each_plane(plane, crtc) \ 132 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) 133 134/** 135 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 136 * @plane: the loop cursor 137 * @crtc_state: the incoming crtc-state 138 * 139 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 140 * attached if the specified state is applied. Useful during (for example) 141 * ->atomic_check() operations, to validate the incoming state 142 */ 143#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ 144 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) 145 146/* 147 * drm_atomic_plane_disabling - check whether a plane is being disabled 148 * @plane: plane object 149 * @old_state: previous atomic state 150 * 151 * Checks the atomic state of a plane to determine whether it's being disabled 152 * or not. This also WARNs if it detects an invalid state (both CRTC and FB 153 * need to either both be NULL or both be non-NULL). 154 * 155 * RETURNS: 156 * True if the plane is being disabled, false otherwise. 157 */ 158static inline bool 159drm_atomic_plane_disabling(struct drm_plane *plane, 160 struct drm_plane_state *old_state) 161{ 162 /* 163 * When disabling a plane, CRTC and FB should always be NULL together. 164 * Anything else should be considered a bug in the atomic core, so we 165 * gently warn about it. 166 */ 167 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || 168 (plane->state->crtc != NULL && plane->state->fb == NULL)); 169 170 /* 171 * When using the transitional helpers, old_state may be NULL. If so, 172 * we know nothing about the current state and have to assume that it 173 * might be enabled. 174 * 175 * When using the atomic helpers, old_state won't be NULL. Therefore 176 * this check assumes that either the driver will have reconstructed 177 * the correct state in ->reset() or that the driver will have taken 178 * appropriate measures to disable all planes. 179 */ 180 return (!old_state || old_state->crtc) && !plane->state->crtc; 181} 182 183#endif /* DRM_ATOMIC_HELPER_H_ */ 184