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