Commit | Line | Data |
---|---|---|
c2fcd274 DV |
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 | ||
0254951d | 31 | #include <drm/drm_crtc.h> |
1de72faf DV |
32 | #include <drm/drm_modeset_helper_vtables.h> |
33 | #include <drm/drm_modeset_helper.h> | |
0254951d | 34 | |
bbb1e524 | 35 | struct drm_atomic_state; |
a4370c77 VS |
36 | struct drm_private_obj; |
37 | struct drm_private_state; | |
bbb1e524 | 38 | |
d9b13620 DV |
39 | int drm_atomic_helper_check_modeset(struct drm_device *dev, |
40 | struct drm_atomic_state *state); | |
a01cb8ba VS |
41 | int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state, |
42 | const struct drm_crtc_state *crtc_state, | |
a01cb8ba VS |
43 | int min_scale, |
44 | int max_scale, | |
45 | bool can_position, | |
46 | bool can_update_disabled); | |
d9b13620 DV |
47 | int drm_atomic_helper_check_planes(struct drm_device *dev, |
48 | struct drm_atomic_state *state); | |
c2fcd274 DV |
49 | int drm_atomic_helper_check(struct drm_device *dev, |
50 | struct drm_atomic_state *state); | |
9f2a7950 | 51 | void drm_atomic_helper_commit_tail(struct drm_atomic_state *state); |
81a099ac | 52 | void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state); |
623369e5 DV |
53 | int drm_atomic_helper_commit(struct drm_device *dev, |
54 | struct drm_atomic_state *state, | |
286dbb8d | 55 | bool nonblock); |
fef9df8b GP |
56 | int drm_atomic_helper_async_check(struct drm_device *dev, |
57 | struct drm_atomic_state *state); | |
58 | void drm_atomic_helper_async_commit(struct drm_device *dev, | |
59 | struct drm_atomic_state *state); | |
623369e5 | 60 | |
f6ce410a GP |
61 | int drm_atomic_helper_wait_for_fences(struct drm_device *dev, |
62 | struct drm_atomic_state *state, | |
63 | bool pre_swap); | |
c240906d | 64 | |
5ee3229c RC |
65 | void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, |
66 | struct drm_atomic_state *old_state); | |
67 | ||
01086487 BB |
68 | void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev, |
69 | struct drm_atomic_state *old_state); | |
70 | ||
4c18d301 DV |
71 | void |
72 | drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, | |
73 | struct drm_atomic_state *old_state); | |
74 | ||
1af434a9 DV |
75 | void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, |
76 | struct drm_atomic_state *state); | |
77 | void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, | |
623369e5 | 78 | struct drm_atomic_state *old_state); |
c2fcd274 DV |
79 | |
80 | int drm_atomic_helper_prepare_planes(struct drm_device *dev, | |
81 | struct drm_atomic_state *state); | |
2b58e98d LY |
82 | |
83 | #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0) | |
84 | #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1) | |
85 | ||
c2fcd274 | 86 | void drm_atomic_helper_commit_planes(struct drm_device *dev, |
aef9dbb8 | 87 | struct drm_atomic_state *state, |
2b58e98d | 88 | uint32_t flags); |
c2fcd274 DV |
89 | void drm_atomic_helper_cleanup_planes(struct drm_device *dev, |
90 | struct drm_atomic_state *old_state); | |
de28d021 | 91 | void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); |
28500291 LY |
92 | void |
93 | drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state, | |
94 | bool atomic); | |
c2fcd274 | 95 | |
8a39374e ML |
96 | int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state, |
97 | bool stall); | |
c2fcd274 | 98 | |
a095caa7 DV |
99 | /* nonblocking commit helpers */ |
100 | int drm_atomic_helper_setup_commit(struct drm_atomic_state *state, | |
101 | bool nonblock); | |
102 | void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state); | |
b25c60af | 103 | void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state); |
a095caa7 DV |
104 | void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state); |
105 | void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state); | |
106 | ||
042652ed DV |
107 | /* implementations for legacy interfaces */ |
108 | int drm_atomic_helper_update_plane(struct drm_plane *plane, | |
109 | struct drm_crtc *crtc, | |
110 | struct drm_framebuffer *fb, | |
111 | int crtc_x, int crtc_y, | |
112 | unsigned int crtc_w, unsigned int crtc_h, | |
113 | uint32_t src_x, uint32_t src_y, | |
34a2ab5e DV |
114 | uint32_t src_w, uint32_t src_h, |
115 | struct drm_modeset_acquire_ctx *ctx); | |
19315294 DV |
116 | int drm_atomic_helper_disable_plane(struct drm_plane *plane, |
117 | struct drm_modeset_acquire_ctx *ctx); | |
bbb1e524 RC |
118 | int __drm_atomic_helper_disable_plane(struct drm_plane *plane, |
119 | struct drm_plane_state *plane_state); | |
a4eff9aa DV |
120 | int drm_atomic_helper_set_config(struct drm_mode_set *set, |
121 | struct drm_modeset_acquire_ctx *ctx); | |
bbb1e524 RC |
122 | int __drm_atomic_helper_set_config(struct drm_mode_set *set, |
123 | struct drm_atomic_state *state); | |
042652ed | 124 | |
14942760 TR |
125 | int drm_atomic_helper_disable_all(struct drm_device *dev, |
126 | struct drm_modeset_acquire_ctx *ctx); | |
18dddadc | 127 | void drm_atomic_helper_shutdown(struct drm_device *dev); |
14942760 | 128 | struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev); |
581e49fe ML |
129 | int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state, |
130 | struct drm_modeset_acquire_ctx *ctx); | |
14942760 TR |
131 | int drm_atomic_helper_resume(struct drm_device *dev, |
132 | struct drm_atomic_state *state); | |
133 | ||
8bc0f312 DV |
134 | int drm_atomic_helper_page_flip(struct drm_crtc *crtc, |
135 | struct drm_framebuffer *fb, | |
136 | struct drm_pending_vblank_event *event, | |
41292b1f DV |
137 | uint32_t flags, |
138 | struct drm_modeset_acquire_ctx *ctx); | |
f869a6ec AG |
139 | int drm_atomic_helper_page_flip_target( |
140 | struct drm_crtc *crtc, | |
141 | struct drm_framebuffer *fb, | |
142 | struct drm_pending_vblank_event *event, | |
143 | uint32_t flags, | |
41292b1f DV |
144 | uint32_t target, |
145 | struct drm_modeset_acquire_ctx *ctx); | |
9ecb5498 NT |
146 | struct drm_encoder * |
147 | drm_atomic_helper_best_encoder(struct drm_connector *connector); | |
8bc0f312 | 148 | |
d461701c DV |
149 | /* default implementations for state handling */ |
150 | void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); | |
f5e7840b TR |
151 | void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, |
152 | struct drm_crtc_state *state); | |
d461701c DV |
153 | struct drm_crtc_state * |
154 | drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); | |
ec2dc6a0 | 155 | void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state); |
d461701c DV |
156 | void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, |
157 | struct drm_crtc_state *state); | |
158 | ||
7f4de521 AG |
159 | void __drm_atomic_helper_plane_reset(struct drm_plane *plane, |
160 | struct drm_plane_state *state); | |
d461701c | 161 | void drm_atomic_helper_plane_reset(struct drm_plane *plane); |
f5e7840b TR |
162 | void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, |
163 | struct drm_plane_state *state); | |
d461701c DV |
164 | struct drm_plane_state * |
165 | drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); | |
2f701695 | 166 | void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state); |
d461701c DV |
167 | void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, |
168 | struct drm_plane_state *state); | |
169 | ||
4cd39917 ML |
170 | void __drm_atomic_helper_connector_reset(struct drm_connector *connector, |
171 | struct drm_connector_state *conn_state); | |
d461701c | 172 | void drm_atomic_helper_connector_reset(struct drm_connector *connector); |
f5e7840b TR |
173 | void |
174 | __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, | |
175 | struct drm_connector_state *state); | |
d461701c DV |
176 | struct drm_connector_state * |
177 | drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); | |
397fd77c TR |
178 | struct drm_atomic_state * |
179 | drm_atomic_helper_duplicate_state(struct drm_device *dev, | |
180 | struct drm_modeset_acquire_ctx *ctx); | |
f5e7840b | 181 | void |
fabd9106 | 182 | __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state); |
d461701c DV |
183 | void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, |
184 | struct drm_connector_state *state); | |
7ea77283 ML |
185 | int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, |
186 | u16 *red, u16 *green, u16 *blue, | |
6d124ff8 DV |
187 | uint32_t size, |
188 | struct drm_modeset_acquire_ctx *ctx); | |
a4370c77 VS |
189 | void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj *obj, |
190 | struct drm_private_state *state); | |
d461701c | 191 | |
dd275956 RC |
192 | /** |
193 | * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC | |
194 | * @plane: the loop cursor | |
195 | * @crtc: the crtc whose planes are iterated | |
196 | * | |
197 | * This iterates over the current state, useful (for example) when applying | |
198 | * atomic state after it has been checked and swapped. To iterate over the | |
6806cdf9 DV |
199 | * planes which *will* be attached (more useful in code called from |
200 | * &drm_mode_config_funcs.atomic_check) see | |
5c0be3f1 | 201 | * drm_atomic_crtc_state_for_each_plane(). |
dd275956 RC |
202 | */ |
203 | #define drm_atomic_crtc_for_each_plane(plane, crtc) \ | |
204 | drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) | |
205 | ||
206 | /** | |
207 | * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state | |
208 | * @plane: the loop cursor | |
209 | * @crtc_state: the incoming crtc-state | |
210 | * | |
211 | * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be | |
6806cdf9 DV |
212 | * attached if the specified state is applied. Useful during for example |
213 | * in code called from &drm_mode_config_funcs.atomic_check operations, to | |
214 | * validate the incoming state. | |
dd275956 RC |
215 | */ |
216 | #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ | |
217 | drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) | |
042652ed | 218 | |
2f196b7c DV |
219 | /** |
220 | * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state | |
221 | * @plane: the loop cursor | |
222 | * @plane_state: loop cursor for the plane's state, must be const | |
223 | * @crtc_state: the incoming crtc-state | |
224 | * | |
225 | * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be | |
6806cdf9 DV |
226 | * attached if the specified state is applied. Useful during for example |
227 | * in code called from &drm_mode_config_funcs.atomic_check operations, to | |
228 | * validate the incoming state. | |
2f196b7c DV |
229 | * |
230 | * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a | |
231 | * const plane_state. This is useful when a driver just wants to peek at other | |
232 | * active planes on this crtc, but does not need to change it. | |
233 | */ | |
234 | #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ | |
235 | drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \ | |
236 | for_each_if ((plane_state = \ | |
237 | __drm_atomic_get_current_plane_state((crtc_state)->state, \ | |
238 | plane))) | |
239 | ||
51ffa12d | 240 | /** |
407b8bd9 | 241 | * drm_atomic_plane_disabling - check whether a plane is being disabled |
51ffa12d ML |
242 | * @old_plane_state: old atomic plane state |
243 | * @new_plane_state: new atomic plane state | |
407b8bd9 TR |
244 | * |
245 | * Checks the atomic state of a plane to determine whether it's being disabled | |
246 | * or not. This also WARNs if it detects an invalid state (both CRTC and FB | |
247 | * need to either both be NULL or both be non-NULL). | |
248 | * | |
249 | * RETURNS: | |
250 | * True if the plane is being disabled, false otherwise. | |
251 | */ | |
252 | static inline bool | |
51ffa12d ML |
253 | drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state, |
254 | struct drm_plane_state *new_plane_state) | |
407b8bd9 TR |
255 | { |
256 | /* | |
257 | * When disabling a plane, CRTC and FB should always be NULL together. | |
258 | * Anything else should be considered a bug in the atomic core, so we | |
259 | * gently warn about it. | |
260 | */ | |
51ffa12d ML |
261 | WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) || |
262 | (new_plane_state->crtc != NULL && new_plane_state->fb == NULL)); | |
407b8bd9 | 263 | |
51ffa12d | 264 | return old_plane_state->crtc && !new_plane_state->crtc; |
407b8bd9 TR |
265 | } |
266 | ||
c2fcd274 | 267 | #endif /* DRM_ATOMIC_HELPER_H_ */ |