Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 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 | |
Thierry Reding | 0254951 | 2014-11-25 12:09:47 +0100 | [diff] [blame] | 31 | #include <drm/drm_crtc.h> |
Daniel Vetter | 1de72fa | 2016-08-12 22:48:39 +0200 | [diff] [blame] | 32 | #include <drm/drm_modeset_helper_vtables.h> |
| 33 | #include <drm/drm_modeset_helper.h> |
Thierry Reding | 0254951 | 2014-11-25 12:09:47 +0100 | [diff] [blame] | 34 | |
Rob Clark | bbb1e52 | 2015-08-25 15:35:58 -0400 | [diff] [blame] | 35 | struct drm_atomic_state; |
| 36 | |
Daniel Vetter | d9b1362 | 2014-11-26 16:57:41 +0100 | [diff] [blame] | 37 | int drm_atomic_helper_check_modeset(struct drm_device *dev, |
| 38 | struct drm_atomic_state *state); |
| 39 | int drm_atomic_helper_check_planes(struct drm_device *dev, |
| 40 | struct drm_atomic_state *state); |
Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 41 | int drm_atomic_helper_check(struct drm_device *dev, |
| 42 | struct drm_atomic_state *state); |
Daniel Vetter | 9f2a795 | 2016-06-08 14:19:02 +0200 | [diff] [blame] | 43 | void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); |
Daniel Vetter | 623369e | 2014-09-16 17:50:47 +0200 | [diff] [blame] | 44 | int drm_atomic_helper_commit(struct drm_device *dev, |
| 45 | struct drm_atomic_state *state, |
Maarten Lankhorst | 286dbb8 | 2016-04-26 16:11:34 +0200 | [diff] [blame] | 46 | bool nonblock); |
Daniel Vetter | 623369e | 2014-09-16 17:50:47 +0200 | [diff] [blame] | 47 | |
Gustavo Padovan | f6ce410 | 2016-09-12 16:08:11 -0300 | [diff] [blame] | 48 | int drm_atomic_helper_wait_for_fences(struct drm_device *dev, |
| 49 | struct drm_atomic_state *state, |
| 50 | bool pre_swap); |
John Keeping | c240906 | 2016-01-19 10:46:58 +0000 | [diff] [blame] | 51 | |
Rob Clark | 5ee3229 | 2014-11-11 19:38:59 -0500 | [diff] [blame] | 52 | void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, |
| 53 | struct drm_atomic_state *old_state); |
| 54 | |
Daniel Vetter | 4c18d30 | 2015-05-12 15:27:37 +0200 | [diff] [blame] | 55 | void |
| 56 | drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, |
| 57 | struct drm_atomic_state *old_state); |
| 58 | |
Daniel Vetter | 1af434a | 2015-02-22 12:24:19 +0100 | [diff] [blame] | 59 | void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, |
| 60 | struct drm_atomic_state *state); |
| 61 | void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, |
Daniel Vetter | 623369e | 2014-09-16 17:50:47 +0200 | [diff] [blame] | 62 | struct drm_atomic_state *old_state); |
Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 63 | |
| 64 | int drm_atomic_helper_prepare_planes(struct drm_device *dev, |
| 65 | struct drm_atomic_state *state); |
Liu Ying | 2b58e98 | 2016-08-29 17:12:03 +0800 | [diff] [blame] | 66 | |
| 67 | #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) |
| 68 | #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) |
| 69 | |
Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 70 | void drm_atomic_helper_commit_planes(struct drm_device *dev, |
Daniel Vetter | aef9dbb | 2015-09-08 12:02:07 +0200 | [diff] [blame] | 71 | struct drm_atomic_state *state, |
Liu Ying | 2b58e98 | 2016-08-29 17:12:03 +0800 | [diff] [blame] | 72 | uint32_t flags); |
Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 73 | void drm_atomic_helper_cleanup_planes(struct drm_device *dev, |
| 74 | struct drm_atomic_state *old_state); |
Maarten Lankhorst | de28d02 | 2015-05-19 16:41:01 +0200 | [diff] [blame] | 75 | void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); |
Liu Ying | 2850029 | 2016-08-26 15:30:39 +0800 | [diff] [blame] | 76 | void |
| 77 | drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, |
| 78 | bool atomic); |
Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 79 | |
Daniel Vetter | 5e84c26 | 2016-06-10 00:06:32 +0200 | [diff] [blame] | 80 | void drm_atomic_helper_swap_state(struct drm_atomic_state *state, |
| 81 | bool stall); |
Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 82 | |
Daniel Vetter | a095caa | 2016-06-08 17:15:36 +0200 | [diff] [blame] | 83 | /* nonblocking commit helpers */ |
| 84 | int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, |
| 85 | bool nonblock); |
| 86 | void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); |
| 87 | void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); |
| 88 | void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); |
| 89 | |
Daniel Vetter | 042652e | 2014-07-27 13:46:52 +0200 | [diff] [blame] | 90 | /* implementations for legacy interfaces */ |
| 91 | int drm_atomic_helper_update_plane(struct drm_plane *plane, |
| 92 | struct drm_crtc *crtc, |
| 93 | struct drm_framebuffer *fb, |
| 94 | int crtc_x, int crtc_y, |
| 95 | unsigned int crtc_w, unsigned int crtc_h, |
| 96 | uint32_t src_x, uint32_t src_y, |
| 97 | uint32_t src_w, uint32_t src_h); |
| 98 | int drm_atomic_helper_disable_plane(struct drm_plane *plane); |
Rob Clark | bbb1e52 | 2015-08-25 15:35:58 -0400 | [diff] [blame] | 99 | int __drm_atomic_helper_disable_plane(struct drm_plane *plane, |
| 100 | struct drm_plane_state *plane_state); |
Daniel Vetter | 042652e | 2014-07-27 13:46:52 +0200 | [diff] [blame] | 101 | int drm_atomic_helper_set_config(struct drm_mode_set *set); |
Rob Clark | bbb1e52 | 2015-08-25 15:35:58 -0400 | [diff] [blame] | 102 | int __drm_atomic_helper_set_config(struct drm_mode_set *set, |
| 103 | struct drm_atomic_state *state); |
Daniel Vetter | 042652e | 2014-07-27 13:46:52 +0200 | [diff] [blame] | 104 | |
Thierry Reding | 1494276 | 2015-12-02 17:50:04 +0100 | [diff] [blame] | 105 | int drm_atomic_helper_disable_all(struct drm_device *dev, |
| 106 | struct drm_modeset_acquire_ctx *ctx); |
| 107 | struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); |
| 108 | int drm_atomic_helper_resume(struct drm_device *dev, |
| 109 | struct drm_atomic_state *state); |
| 110 | |
Daniel Vetter | 042652e | 2014-07-27 13:46:52 +0200 | [diff] [blame] | 111 | int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, |
| 112 | struct drm_property *property, |
| 113 | uint64_t val); |
| 114 | int drm_atomic_helper_plane_set_property(struct drm_plane *plane, |
| 115 | struct drm_property *property, |
| 116 | uint64_t val); |
| 117 | int drm_atomic_helper_connector_set_property(struct drm_connector *connector, |
| 118 | struct drm_property *property, |
| 119 | uint64_t val); |
Daniel Vetter | 8bc0f31 | 2014-07-27 18:42:37 +0200 | [diff] [blame] | 120 | int drm_atomic_helper_page_flip(struct drm_crtc *crtc, |
| 121 | struct drm_framebuffer *fb, |
| 122 | struct drm_pending_vblank_event *event, |
| 123 | uint32_t flags); |
Andrey Grodzovsky | f869a6e | 2017-01-06 15:39:40 -0500 | [diff] [blame^] | 124 | int drm_atomic_helper_page_flip_target( |
| 125 | struct drm_crtc *crtc, |
| 126 | struct drm_framebuffer *fb, |
| 127 | struct drm_pending_vblank_event *event, |
| 128 | uint32_t flags, |
| 129 | uint32_t target); |
Maarten Lankhorst | 9a69a9a | 2015-07-21 11:34:55 +0200 | [diff] [blame] | 130 | int drm_atomic_helper_connector_dpms(struct drm_connector *connector, |
| 131 | int mode); |
Noralf Trønnes | 9ecb549 | 2016-05-11 18:09:21 +0200 | [diff] [blame] | 132 | struct drm_encoder * |
| 133 | drm_atomic_helper_best_encoder(struct drm_connector *connector); |
Daniel Vetter | 8bc0f31 | 2014-07-27 18:42:37 +0200 | [diff] [blame] | 134 | |
Daniel Vetter | d461701 | 2014-11-03 15:56:43 +0100 | [diff] [blame] | 135 | /* default implementations for state handling */ |
| 136 | void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); |
Thierry Reding | f5e7840 | 2015-01-28 14:54:32 +0100 | [diff] [blame] | 137 | void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, |
| 138 | struct drm_crtc_state *state); |
Daniel Vetter | d461701 | 2014-11-03 15:56:43 +0100 | [diff] [blame] | 139 | struct drm_crtc_state * |
| 140 | drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); |
Daniel Vetter | ec2dc6a | 2016-05-09 16:34:09 +0200 | [diff] [blame] | 141 | void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state); |
Daniel Vetter | d461701 | 2014-11-03 15:56:43 +0100 | [diff] [blame] | 142 | void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, |
| 143 | struct drm_crtc_state *state); |
| 144 | |
| 145 | void drm_atomic_helper_plane_reset(struct drm_plane *plane); |
Thierry Reding | f5e7840 | 2015-01-28 14:54:32 +0100 | [diff] [blame] | 146 | void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, |
| 147 | struct drm_plane_state *state); |
Daniel Vetter | d461701 | 2014-11-03 15:56:43 +0100 | [diff] [blame] | 148 | struct drm_plane_state * |
| 149 | drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); |
Daniel Vetter | 2f70169 | 2016-05-09 16:34:10 +0200 | [diff] [blame] | 150 | void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state); |
Daniel Vetter | d461701 | 2014-11-03 15:56:43 +0100 | [diff] [blame] | 151 | void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, |
| 152 | struct drm_plane_state *state); |
| 153 | |
Maarten Lankhorst | 4cd3991 | 2016-01-04 12:53:16 +0100 | [diff] [blame] | 154 | void __drm_atomic_helper_connector_reset(struct drm_connector *connector, |
| 155 | struct drm_connector_state *conn_state); |
Daniel Vetter | d461701 | 2014-11-03 15:56:43 +0100 | [diff] [blame] | 156 | void drm_atomic_helper_connector_reset(struct drm_connector *connector); |
Thierry Reding | f5e7840 | 2015-01-28 14:54:32 +0100 | [diff] [blame] | 157 | void |
| 158 | __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, |
| 159 | struct drm_connector_state *state); |
Daniel Vetter | d461701 | 2014-11-03 15:56:43 +0100 | [diff] [blame] | 160 | struct drm_connector_state * |
| 161 | drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); |
Thierry Reding | 397fd77 | 2015-09-08 15:00:45 +0200 | [diff] [blame] | 162 | struct drm_atomic_state * |
| 163 | drm_atomic_helper_duplicate_state(struct drm_device *dev, |
| 164 | struct drm_modeset_acquire_ctx *ctx); |
Thierry Reding | f5e7840 | 2015-01-28 14:54:32 +0100 | [diff] [blame] | 165 | void |
Daniel Vetter | fabd910 | 2016-05-09 16:34:11 +0200 | [diff] [blame] | 166 | __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state); |
Daniel Vetter | d461701 | 2014-11-03 15:56:43 +0100 | [diff] [blame] | 167 | void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, |
| 168 | struct drm_connector_state *state); |
Maarten Lankhorst | 7ea7728 | 2016-06-07 12:49:30 +0200 | [diff] [blame] | 169 | int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, |
| 170 | u16 *red, u16 *green, u16 *blue, |
| 171 | uint32_t size); |
Daniel Vetter | d461701 | 2014-11-03 15:56:43 +0100 | [diff] [blame] | 172 | |
Rob Clark | dd27595 | 2014-11-25 20:29:46 -0500 | [diff] [blame] | 173 | /** |
| 174 | * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC |
| 175 | * @plane: the loop cursor |
| 176 | * @crtc: the crtc whose planes are iterated |
| 177 | * |
| 178 | * This iterates over the current state, useful (for example) when applying |
| 179 | * atomic state after it has been checked and swapped. To iterate over the |
| 180 | * planes which *will* be attached (for ->atomic_check()) see |
Liviu Dudau | 5c0be3f | 2016-06-10 16:03:25 +0100 | [diff] [blame] | 181 | * drm_atomic_crtc_state_for_each_plane(). |
Rob Clark | dd27595 | 2014-11-25 20:29:46 -0500 | [diff] [blame] | 182 | */ |
| 183 | #define drm_atomic_crtc_for_each_plane(plane, crtc) \ |
| 184 | drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) |
| 185 | |
| 186 | /** |
| 187 | * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state |
| 188 | * @plane: the loop cursor |
| 189 | * @crtc_state: the incoming crtc-state |
| 190 | * |
| 191 | * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be |
| 192 | * attached if the specified state is applied. Useful during (for example) |
Daniel Vetter | 2f196b7 | 2016-06-02 16:21:44 +0200 | [diff] [blame] | 193 | * ->atomic_check() operations, to validate the incoming state. |
Rob Clark | dd27595 | 2014-11-25 20:29:46 -0500 | [diff] [blame] | 194 | */ |
| 195 | #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ |
| 196 | drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) |
Daniel Vetter | 042652e | 2014-07-27 13:46:52 +0200 | [diff] [blame] | 197 | |
Daniel Vetter | 2f196b7 | 2016-06-02 16:21:44 +0200 | [diff] [blame] | 198 | /** |
| 199 | * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state |
| 200 | * @plane: the loop cursor |
| 201 | * @plane_state: loop cursor for the plane's state, must be const |
| 202 | * @crtc_state: the incoming crtc-state |
| 203 | * |
| 204 | * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be |
| 205 | * attached if the specified state is applied. Useful during (for example) |
| 206 | * ->atomic_check() operations, to validate the incoming state. |
| 207 | * |
| 208 | * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a |
| 209 | * const plane_state. This is useful when a driver just wants to peek at other |
| 210 | * active planes on this crtc, but does not need to change it. |
| 211 | */ |
| 212 | #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ |
| 213 | drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ |
| 214 | for_each_if ((plane_state = \ |
| 215 | __drm_atomic_get_current_plane_state((crtc_state)->state, \ |
| 216 | plane))) |
| 217 | |
Thierry Reding | 407b8bd | 2014-11-20 12:05:50 +0100 | [diff] [blame] | 218 | /* |
| 219 | * drm_atomic_plane_disabling - check whether a plane is being disabled |
| 220 | * @plane: plane object |
| 221 | * @old_state: previous atomic state |
| 222 | * |
| 223 | * Checks the atomic state of a plane to determine whether it's being disabled |
| 224 | * or not. This also WARNs if it detects an invalid state (both CRTC and FB |
| 225 | * need to either both be NULL or both be non-NULL). |
| 226 | * |
| 227 | * RETURNS: |
| 228 | * True if the plane is being disabled, false otherwise. |
| 229 | */ |
| 230 | static inline bool |
| 231 | drm_atomic_plane_disabling(struct drm_plane *plane, |
| 232 | struct drm_plane_state *old_state) |
| 233 | { |
| 234 | /* |
| 235 | * When disabling a plane, CRTC and FB should always be NULL together. |
| 236 | * Anything else should be considered a bug in the atomic core, so we |
| 237 | * gently warn about it. |
| 238 | */ |
| 239 | WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || |
| 240 | (plane->state->crtc != NULL && plane->state->fb == NULL)); |
| 241 | |
| 242 | /* |
| 243 | * When using the transitional helpers, old_state may be NULL. If so, |
| 244 | * we know nothing about the current state and have to assume that it |
| 245 | * might be enabled. |
| 246 | * |
| 247 | * When using the atomic helpers, old_state won't be NULL. Therefore |
| 248 | * this check assumes that either the driver will have reconstructed |
| 249 | * the correct state in ->reset() or that the driver will have taken |
| 250 | * appropriate measures to disable all planes. |
| 251 | */ |
| 252 | return (!old_state || old_state->crtc) && !plane->state->crtc; |
| 253 | } |
| 254 | |
Daniel Vetter | c2fcd27 | 2014-11-05 00:14:14 +0100 | [diff] [blame] | 255 | #endif /* DRM_ATOMIC_HELPER_H_ */ |