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