| 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 | |
| 33 | struct drm_atomic_state; |
| 34 | |
| 35 | int drm_atomic_helper_check_modeset(struct drm_device *dev, |
| 36 | struct drm_atomic_state *state); |
| 37 | int drm_atomic_helper_check_planes(struct drm_device *dev, |
| 38 | struct drm_atomic_state *state); |
| 39 | int drm_atomic_helper_check(struct drm_device *dev, |
| 40 | struct drm_atomic_state *state); |
| 41 | int drm_atomic_helper_commit(struct drm_device *dev, |
| 42 | struct drm_atomic_state *state, |
| 43 | bool async); |
| 44 | |
| 45 | void drm_atomic_helper_wait_for_fences(struct drm_device *dev, |
| 46 | struct drm_atomic_state *state); |
| 47 | bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev, |
| 48 | struct drm_atomic_state *old_state, |
| 49 | struct drm_crtc *crtc); |
| 50 | |
| 51 | void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, |
| 52 | struct drm_atomic_state *old_state); |
| 53 | |
| 54 | void |
| 55 | drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, |
| 56 | struct drm_atomic_state *old_state); |
| 57 | |
| 58 | void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, |
| 59 | struct drm_atomic_state *state); |
| 60 | void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, |
| 61 | struct drm_atomic_state *old_state); |
| 62 | |
| 63 | int drm_atomic_helper_prepare_planes(struct drm_device *dev, |
| 64 | struct drm_atomic_state *state); |
| 65 | void drm_atomic_helper_commit_planes(struct drm_device *dev, |
| 66 | struct drm_atomic_state *state, |
| 67 | bool active_only); |
| 68 | void drm_atomic_helper_cleanup_planes(struct drm_device *dev, |
| 69 | struct drm_atomic_state *old_state); |
| 70 | void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); |
| 71 | void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc, |
| 72 | bool atomic); |
| 73 | |
| 74 | void drm_atomic_helper_swap_state(struct drm_device *dev, |
| 75 | struct drm_atomic_state *state); |
| 76 | |
| 77 | /* implementations for legacy interfaces */ |
| 78 | int drm_atomic_helper_update_plane(struct drm_plane *plane, |
| 79 | struct drm_crtc *crtc, |
| 80 | struct drm_framebuffer *fb, |
| 81 | int crtc_x, int crtc_y, |
| 82 | unsigned int crtc_w, unsigned int crtc_h, |
| 83 | uint32_t src_x, uint32_t src_y, |
| 84 | uint32_t src_w, uint32_t src_h); |
| 85 | int drm_atomic_helper_disable_plane(struct drm_plane *plane); |
| 86 | int __drm_atomic_helper_disable_plane(struct drm_plane *plane, |
| 87 | struct drm_plane_state *plane_state); |
| 88 | int drm_atomic_helper_set_config(struct drm_mode_set *set); |
| 89 | int __drm_atomic_helper_set_config(struct drm_mode_set *set, |
| 90 | struct drm_atomic_state *state); |
| 91 | |
| 92 | int drm_atomic_helper_disable_all(struct drm_device *dev, |
| 93 | struct drm_modeset_acquire_ctx *ctx); |
| 94 | struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); |
| 95 | int drm_atomic_helper_resume(struct drm_device *dev, |
| 96 | struct drm_atomic_state *state); |
| 97 | |
| 98 | int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, |
| 99 | struct drm_property *property, |
| 100 | uint64_t val); |
| 101 | int drm_atomic_helper_plane_set_property(struct drm_plane *plane, |
| 102 | struct drm_property *property, |
| 103 | uint64_t val); |
| 104 | int drm_atomic_helper_connector_set_property(struct drm_connector *connector, |
| 105 | struct drm_property *property, |
| 106 | uint64_t val); |
| 107 | int drm_atomic_helper_page_flip(struct drm_crtc *crtc, |
| 108 | struct drm_framebuffer *fb, |
| 109 | struct drm_pending_vblank_event *event, |
| 110 | uint32_t flags); |
| 111 | int drm_atomic_helper_connector_dpms(struct drm_connector *connector, |
| 112 | int mode); |
| 113 | |
| 114 | /* default implementations for state handling */ |
| 115 | void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); |
| 116 | void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, |
| 117 | struct drm_crtc_state *state); |
| 118 | struct drm_crtc_state * |
| 119 | drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); |
| 120 | void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, |
| 121 | struct drm_crtc_state *state); |
| 122 | void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, |
| 123 | struct drm_crtc_state *state); |
| 124 | |
| 125 | void drm_atomic_helper_plane_reset(struct drm_plane *plane); |
| 126 | void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, |
| 127 | struct drm_plane_state *state); |
| 128 | struct drm_plane_state * |
| 129 | drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); |
| 130 | void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, |
| 131 | struct drm_plane_state *state); |
| 132 | void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, |
| 133 | struct drm_plane_state *state); |
| 134 | |
| 135 | void __drm_atomic_helper_connector_reset(struct drm_connector *connector, |
| 136 | struct drm_connector_state *conn_state); |
| 137 | void drm_atomic_helper_connector_reset(struct drm_connector *connector); |
| 138 | void |
| 139 | __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, |
| 140 | struct drm_connector_state *state); |
| 141 | struct drm_connector_state * |
| 142 | drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); |
| 143 | struct drm_atomic_state * |
| 144 | drm_atomic_helper_duplicate_state(struct drm_device *dev, |
| 145 | struct drm_modeset_acquire_ctx *ctx); |
| 146 | void |
| 147 | __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, |
| 148 | struct drm_connector_state *state); |
| 149 | void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, |
| 150 | struct drm_connector_state *state); |
| 151 | void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, |
| 152 | u16 *red, u16 *green, u16 *blue, |
| 153 | uint32_t start, uint32_t size); |
| 154 | |
| 155 | /** |
| 156 | * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC |
| 157 | * @plane: the loop cursor |
| 158 | * @crtc: the crtc whose planes are iterated |
| 159 | * |
| 160 | * This iterates over the current state, useful (for example) when applying |
| 161 | * atomic state after it has been checked and swapped. To iterate over the |
| 162 | * planes which *will* be attached (for ->atomic_check()) see |
| 163 | * drm_crtc_for_each_pending_plane() |
| 164 | */ |
| 165 | #define drm_atomic_crtc_for_each_plane(plane, crtc) \ |
| 166 | drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) |
| 167 | |
| 168 | /** |
| 169 | * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state |
| 170 | * @plane: the loop cursor |
| 171 | * @crtc_state: the incoming crtc-state |
| 172 | * |
| 173 | * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be |
| 174 | * attached if the specified state is applied. Useful during (for example) |
| 175 | * ->atomic_check() operations, to validate the incoming state |
| 176 | */ |
| 177 | #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ |
| 178 | drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) |
| 179 | |
| 180 | /* |
| 181 | * drm_atomic_plane_disabling - check whether a plane is being disabled |
| 182 | * @plane: plane object |
| 183 | * @old_state: previous atomic state |
| 184 | * |
| 185 | * Checks the atomic state of a plane to determine whether it's being disabled |
| 186 | * or not. This also WARNs if it detects an invalid state (both CRTC and FB |
| 187 | * need to either both be NULL or both be non-NULL). |
| 188 | * |
| 189 | * RETURNS: |
| 190 | * True if the plane is being disabled, false otherwise. |
| 191 | */ |
| 192 | static inline bool |
| 193 | drm_atomic_plane_disabling(struct drm_plane *plane, |
| 194 | struct drm_plane_state *old_state) |
| 195 | { |
| 196 | /* |
| 197 | * When disabling a plane, CRTC and FB should always be NULL together. |
| 198 | * Anything else should be considered a bug in the atomic core, so we |
| 199 | * gently warn about it. |
| 200 | */ |
| 201 | WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || |
| 202 | (plane->state->crtc != NULL && plane->state->fb == NULL)); |
| 203 | |
| 204 | /* |
| 205 | * When using the transitional helpers, old_state may be NULL. If so, |
| 206 | * we know nothing about the current state and have to assume that it |
| 207 | * might be enabled. |
| 208 | * |
| 209 | * When using the atomic helpers, old_state won't be NULL. Therefore |
| 210 | * this check assumes that either the driver will have reconstructed |
| 211 | * the correct state in ->reset() or that the driver will have taken |
| 212 | * appropriate measures to disable all planes. |
| 213 | */ |
| 214 | return (!old_state || old_state->crtc) && !plane->state->crtc; |
| 215 | } |
| 216 | |
| 217 | #endif /* DRM_ATOMIC_HELPER_H_ */ |