Commit | Line | Data |
---|---|---|
cc4ceb48 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_H_ | |
29 | #define DRM_ATOMIC_H_ | |
30 | ||
37cc0148 TR |
31 | #include <drm/drm_crtc.h> |
32 | ||
43968d7b DV |
33 | /** |
34 | * struct drm_crtc_commit - track modeset commits on a CRTC | |
35 | * | |
36 | * This structure is used to track pending modeset changes and atomic commit on | |
37 | * a per-CRTC basis. Since updating the list should never block this structure | |
38 | * is reference counted to allow waiters to safely wait on an event to complete, | |
39 | * without holding any locks. | |
40 | * | |
41 | * It has 3 different events in total to allow a fine-grained synchronization | |
42 | * between outstanding updates:: | |
43 | * | |
44 | * atomic commit thread hardware | |
45 | * | |
46 | * write new state into hardware ----> ... | |
47 | * signal hw_done | |
48 | * switch to new state on next | |
49 | * ... v/hblank | |
50 | * | |
51 | * wait for buffers to show up ... | |
52 | * | |
53 | * ... send completion irq | |
54 | * irq handler signals flip_done | |
55 | * cleanup old buffers | |
56 | * | |
57 | * signal cleanup_done | |
58 | * | |
59 | * wait for flip_done <---- | |
60 | * clean up atomic state | |
61 | * | |
62 | * The important bit to know is that cleanup_done is the terminal event, but the | |
63 | * ordering between flip_done and hw_done is entirely up to the specific driver | |
64 | * and modeset state change. | |
65 | * | |
66 | * For an implementation of how to use this look at | |
67 | * drm_atomic_helper_setup_commit() from the atomic helper library. | |
68 | */ | |
69 | struct drm_crtc_commit { | |
70 | /** | |
71 | * @crtc: | |
72 | * | |
73 | * DRM CRTC for this commit. | |
74 | */ | |
75 | struct drm_crtc *crtc; | |
76 | ||
77 | /** | |
78 | * @ref: | |
79 | * | |
80 | * Reference count for this structure. Needed to allow blocking on | |
81 | * completions without the risk of the completion disappearing | |
82 | * meanwhile. | |
83 | */ | |
84 | struct kref ref; | |
85 | ||
86 | /** | |
87 | * @flip_done: | |
88 | * | |
89 | * Will be signaled when the hardware has flipped to the new set of | |
90 | * buffers. Signals at the same time as when the drm event for this | |
91 | * commit is sent to userspace, or when an out-fence is singalled. Note | |
92 | * that for most hardware, in most cases this happens after @hw_done is | |
93 | * signalled. | |
94 | */ | |
95 | struct completion flip_done; | |
96 | ||
97 | /** | |
98 | * @hw_done: | |
99 | * | |
100 | * Will be signalled when all hw register changes for this commit have | |
101 | * been written out. Especially when disabling a pipe this can be much | |
102 | * later than than @flip_done, since that can signal already when the | |
103 | * screen goes black, whereas to fully shut down a pipe more register | |
104 | * I/O is required. | |
105 | * | |
106 | * Note that this does not need to include separately reference-counted | |
107 | * resources like backing storage buffer pinning, or runtime pm | |
108 | * management. | |
109 | */ | |
110 | struct completion hw_done; | |
111 | ||
112 | /** | |
113 | * @cleanup_done: | |
114 | * | |
115 | * Will be signalled after old buffers have been cleaned up by calling | |
116 | * drm_atomic_helper_cleanup_planes(). Since this can only happen after | |
117 | * a vblank wait completed it might be a bit later. This completion is | |
118 | * useful to throttle updates and avoid hardware updates getting ahead | |
119 | * of the buffer cleanup too much. | |
120 | */ | |
121 | struct completion cleanup_done; | |
122 | ||
123 | /** | |
124 | * @commit_entry: | |
125 | * | |
d574528a DV |
126 | * Entry on the per-CRTC &drm_crtc.commit_list. Protected by |
127 | * $drm_crtc.commit_lock. | |
43968d7b DV |
128 | */ |
129 | struct list_head commit_entry; | |
130 | ||
131 | /** | |
132 | * @event: | |
133 | * | |
134 | * &drm_pending_vblank_event pointer to clean up private events. | |
135 | */ | |
136 | struct drm_pending_vblank_event *event; | |
137 | }; | |
138 | ||
139 | struct __drm_planes_state { | |
140 | struct drm_plane *ptr; | |
581e49fe | 141 | struct drm_plane_state *state, *old_state, *new_state; |
43968d7b DV |
142 | }; |
143 | ||
144 | struct __drm_crtcs_state { | |
145 | struct drm_crtc *ptr; | |
581e49fe | 146 | struct drm_crtc_state *state, *old_state, *new_state; |
43968d7b | 147 | struct drm_crtc_commit *commit; |
7e9081c5 | 148 | s32 __user *out_fence_ptr; |
bdc57146 | 149 | unsigned last_vblank_count; |
43968d7b DV |
150 | }; |
151 | ||
152 | struct __drm_connnectors_state { | |
153 | struct drm_connector *ptr; | |
581e49fe | 154 | struct drm_connector_state *state, *old_state, *new_state; |
43968d7b DV |
155 | }; |
156 | ||
b430c27a PD |
157 | /** |
158 | * struct drm_private_state_funcs - atomic state functions for private objects | |
159 | * | |
160 | * These hooks are used by atomic helpers to create, swap and destroy states of | |
161 | * private objects. The structure itself is used as a vtable to identify the | |
162 | * associated private object type. Each private object type that needs to be | |
163 | * added to the atomic states is expected to have an implementation of these | |
164 | * hooks and pass a pointer to it's drm_private_state_funcs struct to | |
165 | * drm_atomic_get_private_obj_state(). | |
166 | */ | |
167 | struct drm_private_state_funcs { | |
168 | /** | |
169 | * @duplicate_state: | |
170 | * | |
171 | * Duplicate the current state of the private object and return it. It | |
172 | * is an error to call this before obj->state has been initialized. | |
173 | * | |
174 | * RETURNS: | |
175 | * | |
176 | * Duplicated atomic state or NULL when obj->state is not | |
177 | * initialized or allocation failed. | |
178 | */ | |
179 | void *(*duplicate_state)(struct drm_atomic_state *state, void *obj); | |
180 | ||
181 | /** | |
182 | * @swap_state: | |
183 | * | |
184 | * This function swaps the existing state of a private object @obj with | |
185 | * it's newly created state, the pointer to which is passed as | |
186 | * @obj_state_ptr. | |
187 | */ | |
188 | void (*swap_state)(void *obj, void **obj_state_ptr); | |
189 | ||
190 | /** | |
191 | * @destroy_state: | |
192 | * | |
193 | * Frees the private object state created with @duplicate_state. | |
194 | */ | |
195 | void (*destroy_state)(void *obj_state); | |
196 | }; | |
197 | ||
198 | struct __drm_private_objs_state { | |
199 | void *obj; | |
200 | void *obj_state; | |
201 | const struct drm_private_state_funcs *funcs; | |
202 | }; | |
203 | ||
43968d7b DV |
204 | /** |
205 | * struct drm_atomic_state - the global state object for atomic updates | |
0853695c | 206 | * @ref: count of all references to this state (will not be freed until zero) |
43968d7b DV |
207 | * @dev: parent DRM device |
208 | * @allow_modeset: allow full modeset | |
209 | * @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics | |
43968d7b DV |
210 | * @planes: pointer to array of structures with per-plane data |
211 | * @crtcs: pointer to array of CRTC pointers | |
212 | * @num_connector: size of the @connectors and @connector_states arrays | |
213 | * @connectors: pointer to array of structures with per-connector data | |
b430c27a PD |
214 | * @num_private_objs: size of the @private_objs array |
215 | * @private_objs: pointer to array of private object pointers | |
43968d7b DV |
216 | * @acquire_ctx: acquire context for this atomic modeset state update |
217 | */ | |
218 | struct drm_atomic_state { | |
0853695c CW |
219 | struct kref ref; |
220 | ||
43968d7b DV |
221 | struct drm_device *dev; |
222 | bool allow_modeset : 1; | |
223 | bool legacy_cursor_update : 1; | |
43968d7b DV |
224 | struct __drm_planes_state *planes; |
225 | struct __drm_crtcs_state *crtcs; | |
226 | int num_connector; | |
227 | struct __drm_connnectors_state *connectors; | |
b430c27a PD |
228 | int num_private_objs; |
229 | struct __drm_private_objs_state *private_objs; | |
43968d7b DV |
230 | |
231 | struct drm_modeset_acquire_ctx *acquire_ctx; | |
232 | ||
233 | /** | |
234 | * @commit_work: | |
235 | * | |
236 | * Work item which can be used by the driver or helpers to execute the | |
237 | * commit without blocking. | |
238 | */ | |
239 | struct work_struct commit_work; | |
240 | }; | |
241 | ||
b3ba3f6f DV |
242 | void __drm_crtc_commit_free(struct kref *kref); |
243 | ||
244 | /** | |
245 | * drm_crtc_commit_get - acquire a reference to the CRTC commit | |
246 | * @commit: CRTC commit | |
247 | * | |
248 | * Increases the reference of @commit. | |
249 | */ | |
3b24f7d6 DV |
250 | static inline void drm_crtc_commit_get(struct drm_crtc_commit *commit) |
251 | { | |
252 | kref_get(&commit->ref); | |
253 | } | |
254 | ||
b3ba3f6f DV |
255 | /** |
256 | * drm_crtc_commit_put - release a reference to the CRTC commmit | |
257 | * @commit: CRTC commit | |
258 | * | |
259 | * This releases a reference to @commit which is freed after removing the | |
260 | * final reference. No locking required and callable from any context. | |
261 | */ | |
262 | static inline void drm_crtc_commit_put(struct drm_crtc_commit *commit) | |
263 | { | |
264 | kref_put(&commit->ref, __drm_crtc_commit_free); | |
265 | } | |
266 | ||
cc4ceb48 DV |
267 | struct drm_atomic_state * __must_check |
268 | drm_atomic_state_alloc(struct drm_device *dev); | |
269 | void drm_atomic_state_clear(struct drm_atomic_state *state); | |
0853695c CW |
270 | |
271 | /** | |
272 | * drm_atomic_state_get - acquire a reference to the atomic state | |
273 | * @state: The atomic state | |
274 | * | |
275 | * Returns a new reference to the @state | |
276 | */ | |
277 | static inline struct drm_atomic_state * | |
278 | drm_atomic_state_get(struct drm_atomic_state *state) | |
279 | { | |
280 | kref_get(&state->ref); | |
281 | return state; | |
282 | } | |
283 | ||
284 | void __drm_atomic_state_free(struct kref *ref); | |
285 | ||
286 | /** | |
287 | * drm_atomic_state_put - release a reference to the atomic state | |
288 | * @state: The atomic state | |
289 | * | |
290 | * This releases a reference to @state which is freed after removing the | |
291 | * final reference. No locking required and callable from any context. | |
292 | */ | |
293 | static inline void drm_atomic_state_put(struct drm_atomic_state *state) | |
294 | { | |
295 | kref_put(&state->ref, __drm_atomic_state_free); | |
296 | } | |
036ef573 ML |
297 | |
298 | int __must_check | |
299 | drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state); | |
300 | void drm_atomic_state_default_clear(struct drm_atomic_state *state); | |
301 | void drm_atomic_state_default_release(struct drm_atomic_state *state); | |
cc4ceb48 DV |
302 | |
303 | struct drm_crtc_state * __must_check | |
304 | drm_atomic_get_crtc_state(struct drm_atomic_state *state, | |
305 | struct drm_crtc *crtc); | |
40ecc694 RC |
306 | int drm_atomic_crtc_set_property(struct drm_crtc *crtc, |
307 | struct drm_crtc_state *state, struct drm_property *property, | |
308 | uint64_t val); | |
cc4ceb48 DV |
309 | struct drm_plane_state * __must_check |
310 | drm_atomic_get_plane_state(struct drm_atomic_state *state, | |
311 | struct drm_plane *plane); | |
40ecc694 RC |
312 | int drm_atomic_plane_set_property(struct drm_plane *plane, |
313 | struct drm_plane_state *state, struct drm_property *property, | |
314 | uint64_t val); | |
cc4ceb48 DV |
315 | struct drm_connector_state * __must_check |
316 | drm_atomic_get_connector_state(struct drm_atomic_state *state, | |
317 | struct drm_connector *connector); | |
40ecc694 RC |
318 | int drm_atomic_connector_set_property(struct drm_connector *connector, |
319 | struct drm_connector_state *state, struct drm_property *property, | |
320 | uint64_t val); | |
88a48e29 | 321 | |
b430c27a PD |
322 | void * __must_check |
323 | drm_atomic_get_private_obj_state(struct drm_atomic_state *state, | |
324 | void *obj, | |
325 | const struct drm_private_state_funcs *funcs); | |
326 | ||
1b26a5e1 ML |
327 | /** |
328 | * drm_atomic_get_existing_crtc_state - get crtc state, if it exists | |
329 | * @state: global atomic state object | |
330 | * @crtc: crtc to grab | |
331 | * | |
332 | * This function returns the crtc state for the given crtc, or NULL | |
333 | * if the crtc is not part of the global atomic state. | |
2107777c ML |
334 | * |
335 | * This function is deprecated, @drm_atomic_get_old_crtc_state or | |
336 | * @drm_atomic_get_new_crtc_state should be used instead. | |
1b26a5e1 ML |
337 | */ |
338 | static inline struct drm_crtc_state * | |
339 | drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state, | |
340 | struct drm_crtc *crtc) | |
341 | { | |
5d943aa6 | 342 | return state->crtcs[drm_crtc_index(crtc)].state; |
1b26a5e1 ML |
343 | } |
344 | ||
2107777c ML |
345 | /** |
346 | * drm_atomic_get_old_crtc_state - get old crtc state, if it exists | |
347 | * @state: global atomic state object | |
348 | * @crtc: crtc to grab | |
349 | * | |
350 | * This function returns the old crtc state for the given crtc, or | |
351 | * NULL if the crtc is not part of the global atomic state. | |
352 | */ | |
353 | static inline struct drm_crtc_state * | |
354 | drm_atomic_get_old_crtc_state(struct drm_atomic_state *state, | |
355 | struct drm_crtc *crtc) | |
356 | { | |
357 | return state->crtcs[drm_crtc_index(crtc)].old_state; | |
358 | } | |
359 | /** | |
360 | * drm_atomic_get_new_crtc_state - get new crtc state, if it exists | |
361 | * @state: global atomic state object | |
362 | * @crtc: crtc to grab | |
363 | * | |
364 | * This function returns the new crtc state for the given crtc, or | |
365 | * NULL if the crtc is not part of the global atomic state. | |
366 | */ | |
367 | static inline struct drm_crtc_state * | |
368 | drm_atomic_get_new_crtc_state(struct drm_atomic_state *state, | |
369 | struct drm_crtc *crtc) | |
370 | { | |
371 | return state->crtcs[drm_crtc_index(crtc)].new_state; | |
372 | } | |
373 | ||
1b26a5e1 ML |
374 | /** |
375 | * drm_atomic_get_existing_plane_state - get plane state, if it exists | |
376 | * @state: global atomic state object | |
377 | * @plane: plane to grab | |
378 | * | |
379 | * This function returns the plane state for the given plane, or NULL | |
380 | * if the plane is not part of the global atomic state. | |
2107777c ML |
381 | * |
382 | * This function is deprecated, @drm_atomic_get_old_plane_state or | |
383 | * @drm_atomic_get_new_plane_state should be used instead. | |
1b26a5e1 ML |
384 | */ |
385 | static inline struct drm_plane_state * | |
386 | drm_atomic_get_existing_plane_state(struct drm_atomic_state *state, | |
387 | struct drm_plane *plane) | |
388 | { | |
b8b5342b | 389 | return state->planes[drm_plane_index(plane)].state; |
1b26a5e1 ML |
390 | } |
391 | ||
2107777c ML |
392 | /** |
393 | * drm_atomic_get_old_plane_state - get plane state, if it exists | |
394 | * @state: global atomic state object | |
395 | * @plane: plane to grab | |
396 | * | |
397 | * This function returns the old plane state for the given plane, or | |
398 | * NULL if the plane is not part of the global atomic state. | |
399 | */ | |
400 | static inline struct drm_plane_state * | |
401 | drm_atomic_get_old_plane_state(struct drm_atomic_state *state, | |
402 | struct drm_plane *plane) | |
403 | { | |
404 | return state->planes[drm_plane_index(plane)].old_state; | |
405 | } | |
406 | ||
407 | /** | |
408 | * drm_atomic_get_new_plane_state - get plane state, if it exists | |
409 | * @state: global atomic state object | |
410 | * @plane: plane to grab | |
411 | * | |
412 | * This function returns the new plane state for the given plane, or | |
413 | * NULL if the plane is not part of the global atomic state. | |
414 | */ | |
415 | static inline struct drm_plane_state * | |
416 | drm_atomic_get_new_plane_state(struct drm_atomic_state *state, | |
417 | struct drm_plane *plane) | |
418 | { | |
419 | return state->planes[drm_plane_index(plane)].new_state; | |
420 | } | |
421 | ||
1b26a5e1 ML |
422 | /** |
423 | * drm_atomic_get_existing_connector_state - get connector state, if it exists | |
424 | * @state: global atomic state object | |
425 | * @connector: connector to grab | |
426 | * | |
427 | * This function returns the connector state for the given connector, | |
428 | * or NULL if the connector is not part of the global atomic state. | |
2107777c ML |
429 | * |
430 | * This function is deprecated, @drm_atomic_get_old_connector_state or | |
431 | * @drm_atomic_get_new_connector_state should be used instead. | |
1b26a5e1 ML |
432 | */ |
433 | static inline struct drm_connector_state * | |
434 | drm_atomic_get_existing_connector_state(struct drm_atomic_state *state, | |
435 | struct drm_connector *connector) | |
436 | { | |
437 | int index = drm_connector_index(connector); | |
438 | ||
439 | if (index >= state->num_connector) | |
440 | return NULL; | |
441 | ||
63e83c1d | 442 | return state->connectors[index].state; |
1b26a5e1 ML |
443 | } |
444 | ||
2107777c ML |
445 | /** |
446 | * drm_atomic_get_old_connector_state - get connector state, if it exists | |
447 | * @state: global atomic state object | |
448 | * @connector: connector to grab | |
449 | * | |
450 | * This function returns the old connector state for the given connector, | |
451 | * or NULL if the connector is not part of the global atomic state. | |
452 | */ | |
453 | static inline struct drm_connector_state * | |
454 | drm_atomic_get_old_connector_state(struct drm_atomic_state *state, | |
455 | struct drm_connector *connector) | |
456 | { | |
457 | int index = drm_connector_index(connector); | |
458 | ||
459 | if (index >= state->num_connector) | |
460 | return NULL; | |
461 | ||
462 | return state->connectors[index].old_state; | |
463 | } | |
464 | ||
465 | /** | |
466 | * drm_atomic_get_new_connector_state - get connector state, if it exists | |
467 | * @state: global atomic state object | |
468 | * @connector: connector to grab | |
469 | * | |
470 | * This function returns the new connector state for the given connector, | |
471 | * or NULL if the connector is not part of the global atomic state. | |
472 | */ | |
473 | static inline struct drm_connector_state * | |
474 | drm_atomic_get_new_connector_state(struct drm_atomic_state *state, | |
475 | struct drm_connector *connector) | |
476 | { | |
477 | int index = drm_connector_index(connector); | |
478 | ||
479 | if (index >= state->num_connector) | |
480 | return NULL; | |
481 | ||
482 | return state->connectors[index].new_state; | |
483 | } | |
484 | ||
2f196b7c DV |
485 | /** |
486 | * __drm_atomic_get_current_plane_state - get current plane state | |
487 | * @state: global atomic state object | |
488 | * @plane: plane to grab | |
489 | * | |
490 | * This function returns the plane state for the given plane, either from | |
491 | * @state, or if the plane isn't part of the atomic state update, from @plane. | |
492 | * This is useful in atomic check callbacks, when drivers need to peek at, but | |
493 | * not change, state of other planes, since it avoids threading an error code | |
494 | * back up the call chain. | |
495 | * | |
496 | * WARNING: | |
497 | * | |
498 | * Note that this function is in general unsafe since it doesn't check for the | |
499 | * required locking for access state structures. Drivers must ensure that it is | |
60c9e190 | 500 | * safe to access the returned state structure through other means. One common |
2f196b7c | 501 | * example is when planes are fixed to a single CRTC, and the driver knows that |
60c9e190 | 502 | * the CRTC lock is held already. In that case holding the CRTC lock gives a |
2f196b7c DV |
503 | * read-lock on all planes connected to that CRTC. But if planes can be |
504 | * reassigned things get more tricky. In that case it's better to use | |
505 | * drm_atomic_get_plane_state and wire up full error handling. | |
506 | * | |
507 | * Returns: | |
508 | * | |
509 | * Read-only pointer to the current plane state. | |
510 | */ | |
511 | static inline const struct drm_plane_state * | |
512 | __drm_atomic_get_current_plane_state(struct drm_atomic_state *state, | |
513 | struct drm_plane *plane) | |
514 | { | |
b8b5342b DV |
515 | if (state->planes[drm_plane_index(plane)].state) |
516 | return state->planes[drm_plane_index(plane)].state; | |
2f196b7c DV |
517 | |
518 | return plane->state; | |
519 | } | |
520 | ||
819364da DS |
521 | int __must_check |
522 | drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state, | |
91110a4b | 523 | const struct drm_display_mode *mode); |
cc4ceb48 | 524 | int __must_check |
955f3c33 DS |
525 | drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state, |
526 | struct drm_property_blob *blob); | |
527 | int __must_check | |
07cc0ef6 DV |
528 | drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state, |
529 | struct drm_crtc *crtc); | |
321ebf04 DV |
530 | void drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state, |
531 | struct drm_framebuffer *fb); | |
13b55664 GP |
532 | void drm_atomic_set_fence_for_plane(struct drm_plane_state *plane_state, |
533 | struct dma_fence *fence); | |
cc4ceb48 DV |
534 | int __must_check |
535 | drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state, | |
536 | struct drm_crtc *crtc); | |
537 | int __must_check | |
538 | drm_atomic_add_affected_connectors(struct drm_atomic_state *state, | |
539 | struct drm_crtc *crtc); | |
e01e9f75 ML |
540 | int __must_check |
541 | drm_atomic_add_affected_planes(struct drm_atomic_state *state, | |
542 | struct drm_crtc *crtc); | |
543 | ||
cc4ceb48 DV |
544 | void drm_atomic_legacy_backoff(struct drm_atomic_state *state); |
545 | ||
0f45c26f ML |
546 | void |
547 | drm_atomic_clean_old_fb(struct drm_device *dev, unsigned plane_mask, int ret); | |
548 | ||
cc4ceb48 DV |
549 | int __must_check drm_atomic_check_only(struct drm_atomic_state *state); |
550 | int __must_check drm_atomic_commit(struct drm_atomic_state *state); | |
b837ba0a | 551 | int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state); |
cc4ceb48 | 552 | |
6559c901 RC |
553 | void drm_state_dump(struct drm_device *dev, struct drm_printer *p); |
554 | ||
f9a76955 DV |
555 | /** |
556 | * for_each_connector_in_state - iterate over all connectors in an atomic update | |
557 | * @__state: &struct drm_atomic_state pointer | |
558 | * @connector: &struct drm_connector iteration cursor | |
559 | * @connector_state: &struct drm_connector_state iteration cursor | |
560 | * @__i: int iteration cursor, for macro-internal use | |
561 | * | |
562 | * This iterates over all connectors in an atomic update. Note that before the | |
563 | * software state is committed (by calling drm_atomic_helper_swap_state(), this | |
564 | * points to the new state, while afterwards it points to the old state. Due to | |
565 | * this tricky confusion this macro is deprecated. | |
566 | * | |
567 | * FIXME: | |
568 | * | |
569 | * Replace all usage of this with one of the explicit iterators below and then | |
570 | * remove this macro. | |
571 | */ | |
63e83c1d | 572 | #define for_each_connector_in_state(__state, connector, connector_state, __i) \ |
df63b999 | 573 | for ((__i) = 0; \ |
63e83c1d DV |
574 | (__i) < (__state)->num_connector && \ |
575 | ((connector) = (__state)->connectors[__i].ptr, \ | |
576 | (connector_state) = (__state)->connectors[__i].state, 1); \ | |
df63b999 | 577 | (__i)++) \ |
373701b1 | 578 | for_each_if (connector) |
df63b999 | 579 | |
f9a76955 DV |
580 | /** |
581 | * for_each_oldnew_connector_in_state - iterate over all connectors in an atomic update | |
582 | * @__state: &struct drm_atomic_state pointer | |
583 | * @connector: &struct drm_connector iteration cursor | |
584 | * @old_connector_state: &struct drm_connector_state iteration cursor for the | |
585 | * old state | |
586 | * @new_connector_state: &struct drm_connector_state iteration cursor for the | |
587 | * new state | |
588 | * @__i: int iteration cursor, for macro-internal use | |
589 | * | |
590 | * This iterates over all connectors in an atomic update, tracking both old and | |
591 | * new state. This is useful in places where the state delta needs to be | |
592 | * considered, for example in atomic check functions. | |
593 | */ | |
581e49fe ML |
594 | #define for_each_oldnew_connector_in_state(__state, connector, old_connector_state, new_connector_state, __i) \ |
595 | for ((__i) = 0; \ | |
596 | (__i) < (__state)->num_connector && \ | |
597 | ((connector) = (__state)->connectors[__i].ptr, \ | |
598 | (old_connector_state) = (__state)->connectors[__i].old_state, \ | |
599 | (new_connector_state) = (__state)->connectors[__i].new_state, 1); \ | |
600 | (__i)++) \ | |
601 | for_each_if (connector) | |
602 | ||
f9a76955 DV |
603 | /** |
604 | * for_each_old_connector_in_state - iterate over all connectors in an atomic update | |
605 | * @__state: &struct drm_atomic_state pointer | |
606 | * @connector: &struct drm_connector iteration cursor | |
607 | * @old_connector_state: &struct drm_connector_state iteration cursor for the | |
608 | * old state | |
609 | * @__i: int iteration cursor, for macro-internal use | |
610 | * | |
611 | * This iterates over all connectors in an atomic update, tracking only the old | |
612 | * state. This is useful in disable functions, where we need the old state the | |
613 | * hardware is still in. | |
614 | */ | |
581e49fe ML |
615 | #define for_each_old_connector_in_state(__state, connector, old_connector_state, __i) \ |
616 | for ((__i) = 0; \ | |
617 | (__i) < (__state)->num_connector && \ | |
618 | ((connector) = (__state)->connectors[__i].ptr, \ | |
619 | (old_connector_state) = (__state)->connectors[__i].old_state, 1); \ | |
620 | (__i)++) \ | |
621 | for_each_if (connector) | |
622 | ||
f9a76955 DV |
623 | /** |
624 | * for_each_new_connector_in_state - iterate over all connectors in an atomic update | |
625 | * @__state: &struct drm_atomic_state pointer | |
626 | * @connector: &struct drm_connector iteration cursor | |
627 | * @new_connector_state: &struct drm_connector_state iteration cursor for the | |
628 | * new state | |
629 | * @__i: int iteration cursor, for macro-internal use | |
630 | * | |
631 | * This iterates over all connectors in an atomic update, tracking only the new | |
632 | * state. This is useful in enable functions, where we need the new state the | |
633 | * hardware should be in when the atomic commit operation has completed. | |
634 | */ | |
581e49fe ML |
635 | #define for_each_new_connector_in_state(__state, connector, new_connector_state, __i) \ |
636 | for ((__i) = 0; \ | |
637 | (__i) < (__state)->num_connector && \ | |
638 | ((connector) = (__state)->connectors[__i].ptr, \ | |
639 | (new_connector_state) = (__state)->connectors[__i].new_state, 1); \ | |
640 | (__i)++) \ | |
641 | for_each_if (connector) | |
642 | ||
f9a76955 DV |
643 | /** |
644 | * for_each_crtc_in_state - iterate over all connectors in an atomic update | |
645 | * @__state: &struct drm_atomic_state pointer | |
646 | * @crtc: &struct drm_crtc iteration cursor | |
647 | * @crtc_state: &struct drm_crtc_state iteration cursor | |
648 | * @__i: int iteration cursor, for macro-internal use | |
649 | * | |
650 | * This iterates over all CRTCs in an atomic update. Note that before the | |
651 | * software state is committed (by calling drm_atomic_helper_swap_state(), this | |
652 | * points to the new state, while afterwards it points to the old state. Due to | |
653 | * this tricky confusion this macro is deprecated. | |
654 | * | |
655 | * FIXME: | |
656 | * | |
657 | * Replace all usage of this with one of the explicit iterators below and then | |
658 | * remove this macro. | |
659 | */ | |
5d943aa6 | 660 | #define for_each_crtc_in_state(__state, crtc, crtc_state, __i) \ |
df63b999 | 661 | for ((__i) = 0; \ |
5d943aa6 DV |
662 | (__i) < (__state)->dev->mode_config.num_crtc && \ |
663 | ((crtc) = (__state)->crtcs[__i].ptr, \ | |
664 | (crtc_state) = (__state)->crtcs[__i].state, 1); \ | |
df63b999 | 665 | (__i)++) \ |
373701b1 | 666 | for_each_if (crtc_state) |
df63b999 | 667 | |
f9a76955 DV |
668 | /** |
669 | * for_each_oldnew_crtc_in_state - iterate over all CRTCs in an atomic update | |
670 | * @__state: &struct drm_atomic_state pointer | |
671 | * @crtc: &struct drm_crtc iteration cursor | |
672 | * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state | |
673 | * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state | |
674 | * @__i: int iteration cursor, for macro-internal use | |
675 | * | |
676 | * This iterates over all CRTCs in an atomic update, tracking both old and | |
677 | * new state. This is useful in places where the state delta needs to be | |
678 | * considered, for example in atomic check functions. | |
679 | */ | |
581e49fe ML |
680 | #define for_each_oldnew_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \ |
681 | for ((__i) = 0; \ | |
682 | (__i) < (__state)->dev->mode_config.num_crtc && \ | |
683 | ((crtc) = (__state)->crtcs[__i].ptr, \ | |
684 | (old_crtc_state) = (__state)->crtcs[__i].old_state, \ | |
685 | (new_crtc_state) = (__state)->crtcs[__i].new_state, 1); \ | |
686 | (__i)++) \ | |
687 | for_each_if (crtc) | |
688 | ||
f9a76955 DV |
689 | /** |
690 | * for_each_old_crtc_in_state - iterate over all CRTCs in an atomic update | |
691 | * @__state: &struct drm_atomic_state pointer | |
692 | * @crtc: &struct drm_crtc iteration cursor | |
693 | * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state | |
694 | * @__i: int iteration cursor, for macro-internal use | |
695 | * | |
696 | * This iterates over all CRTCs in an atomic update, tracking only the old | |
697 | * state. This is useful in disable functions, where we need the old state the | |
698 | * hardware is still in. | |
699 | */ | |
581e49fe ML |
700 | #define for_each_old_crtc_in_state(__state, crtc, old_crtc_state, __i) \ |
701 | for ((__i) = 0; \ | |
702 | (__i) < (__state)->dev->mode_config.num_crtc && \ | |
703 | ((crtc) = (__state)->crtcs[__i].ptr, \ | |
704 | (old_crtc_state) = (__state)->crtcs[__i].old_state, 1); \ | |
705 | (__i)++) \ | |
706 | for_each_if (crtc) | |
707 | ||
f9a76955 DV |
708 | /** |
709 | * for_each_new_crtc_in_state - iterate over all CRTCs in an atomic update | |
710 | * @__state: &struct drm_atomic_state pointer | |
711 | * @crtc: &struct drm_crtc iteration cursor | |
712 | * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state | |
713 | * @__i: int iteration cursor, for macro-internal use | |
714 | * | |
715 | * This iterates over all CRTCs in an atomic update, tracking only the new | |
716 | * state. This is useful in enable functions, where we need the new state the | |
717 | * hardware should be in when the atomic commit operation has completed. | |
718 | */ | |
581e49fe ML |
719 | #define for_each_new_crtc_in_state(__state, crtc, new_crtc_state, __i) \ |
720 | for ((__i) = 0; \ | |
721 | (__i) < (__state)->dev->mode_config.num_crtc && \ | |
722 | ((crtc) = (__state)->crtcs[__i].ptr, \ | |
723 | (new_crtc_state) = (__state)->crtcs[__i].new_state, 1); \ | |
724 | (__i)++) \ | |
725 | for_each_if (crtc) | |
726 | ||
f9a76955 DV |
727 | /** |
728 | * for_each_plane_in_state - iterate over all planes in an atomic update | |
729 | * @__state: &struct drm_atomic_state pointer | |
730 | * @plane: &struct drm_plane iteration cursor | |
731 | * @plane_state: &struct drm_plane_state iteration cursor | |
732 | * @__i: int iteration cursor, for macro-internal use | |
733 | * | |
734 | * This iterates over all planes in an atomic update. Note that before the | |
735 | * software state is committed (by calling drm_atomic_helper_swap_state(), this | |
736 | * points to the new state, while afterwards it points to the old state. Due to | |
737 | * this tricky confusion this macro is deprecated. | |
738 | * | |
739 | * FIXME: | |
740 | * | |
741 | * Replace all usage of this with one of the explicit iterators below and then | |
742 | * remove this macro. | |
743 | */ | |
b8b5342b | 744 | #define for_each_plane_in_state(__state, plane, plane_state, __i) \ |
60f207a5 | 745 | for ((__i) = 0; \ |
b8b5342b DV |
746 | (__i) < (__state)->dev->mode_config.num_total_plane && \ |
747 | ((plane) = (__state)->planes[__i].ptr, \ | |
748 | (plane_state) = (__state)->planes[__i].state, 1); \ | |
60f207a5 | 749 | (__i)++) \ |
373701b1 | 750 | for_each_if (plane_state) |
081e9c0f | 751 | |
f9a76955 DV |
752 | /** |
753 | * for_each_oldnew_plane_in_state - iterate over all planes in an atomic update | |
754 | * @__state: &struct drm_atomic_state pointer | |
755 | * @plane: &struct drm_plane iteration cursor | |
756 | * @old_plane_state: &struct drm_plane_state iteration cursor for the old state | |
757 | * @new_plane_state: &struct drm_plane_state iteration cursor for the new state | |
758 | * @__i: int iteration cursor, for macro-internal use | |
759 | * | |
760 | * This iterates over all planes in an atomic update, tracking both old and | |
761 | * new state. This is useful in places where the state delta needs to be | |
762 | * considered, for example in atomic check functions. | |
763 | */ | |
581e49fe ML |
764 | #define for_each_oldnew_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \ |
765 | for ((__i) = 0; \ | |
766 | (__i) < (__state)->dev->mode_config.num_total_plane && \ | |
767 | ((plane) = (__state)->planes[__i].ptr, \ | |
768 | (old_plane_state) = (__state)->planes[__i].old_state, \ | |
769 | (new_plane_state) = (__state)->planes[__i].new_state, 1); \ | |
770 | (__i)++) \ | |
771 | for_each_if (plane) | |
772 | ||
f9a76955 DV |
773 | /** |
774 | * for_each_old_plane_in_state - iterate over all planes in an atomic update | |
775 | * @__state: &struct drm_atomic_state pointer | |
776 | * @plane: &struct drm_plane iteration cursor | |
777 | * @old_plane_state: &struct drm_plane_state iteration cursor for the old state | |
778 | * @__i: int iteration cursor, for macro-internal use | |
779 | * | |
780 | * This iterates over all planes in an atomic update, tracking only the old | |
781 | * state. This is useful in disable functions, where we need the old state the | |
782 | * hardware is still in. | |
783 | */ | |
581e49fe ML |
784 | #define for_each_old_plane_in_state(__state, plane, old_plane_state, __i) \ |
785 | for ((__i) = 0; \ | |
786 | (__i) < (__state)->dev->mode_config.num_total_plane && \ | |
787 | ((plane) = (__state)->planes[__i].ptr, \ | |
788 | (old_plane_state) = (__state)->planes[__i].old_state, 1); \ | |
789 | (__i)++) \ | |
790 | for_each_if (plane) | |
791 | ||
f9a76955 DV |
792 | /** |
793 | * for_each_new_plane_in_state - iterate over all planes in an atomic update | |
794 | * @__state: &struct drm_atomic_state pointer | |
795 | * @plane: &struct drm_plane iteration cursor | |
796 | * @new_plane_state: &struct drm_plane_state iteration cursor for the new state | |
797 | * @__i: int iteration cursor, for macro-internal use | |
798 | * | |
799 | * This iterates over all planes in an atomic update, tracking only the new | |
800 | * state. This is useful in enable functions, where we need the new state the | |
801 | * hardware should be in when the atomic commit operation has completed. | |
802 | */ | |
581e49fe ML |
803 | #define for_each_new_plane_in_state(__state, plane, new_plane_state, __i) \ |
804 | for ((__i) = 0; \ | |
805 | (__i) < (__state)->dev->mode_config.num_total_plane && \ | |
806 | ((plane) = (__state)->planes[__i].ptr, \ | |
807 | (new_plane_state) = (__state)->planes[__i].new_state, 1); \ | |
808 | (__i)++) \ | |
809 | for_each_if (plane) | |
810 | ||
b430c27a PD |
811 | /** |
812 | * __for_each_private_obj - iterate over all private objects | |
813 | * @__state: &struct drm_atomic_state pointer | |
814 | * @obj: private object iteration cursor | |
815 | * @obj_state: private object state iteration cursor | |
816 | * @__i: int iteration cursor, for macro-internal use | |
817 | * @__funcs: &struct drm_private_state_funcs iteration cursor | |
818 | * | |
819 | * This macro iterates over the array containing private object data in atomic | |
820 | * state | |
821 | */ | |
822 | #define __for_each_private_obj(__state, obj, obj_state, __i, __funcs) \ | |
823 | for ((__i) = 0; \ | |
824 | (__i) < (__state)->num_private_objs && \ | |
825 | ((obj) = (__state)->private_objs[__i].obj, \ | |
826 | (__funcs) = (__state)->private_objs[__i].funcs, \ | |
827 | (obj_state) = (__state)->private_objs[__i].obj_state, \ | |
828 | 1); \ | |
829 | (__i)++) \ | |
830 | ||
831 | /** | |
832 | * for_each_private_obj - iterate over a specify type of private object | |
833 | * @__state: &struct drm_atomic_state pointer | |
834 | * @obj_funcs: &struct drm_private_state_funcs function table to filter | |
835 | * private objects | |
836 | * @obj: private object iteration cursor | |
837 | * @obj_state: private object state iteration cursor | |
838 | * @__i: int iteration cursor, for macro-internal use | |
839 | * @__funcs: &struct drm_private_state_funcs iteration cursor | |
840 | * | |
841 | * This macro iterates over the private objects state array while filtering the | |
842 | * objects based on the vfunc table that is passed as @obj_funcs. New macros | |
843 | * can be created by passing in the vfunc table associated with a specific | |
844 | * private object. | |
845 | */ | |
846 | #define for_each_private_obj(__state, obj_funcs, obj, obj_state, __i, __funcs) \ | |
847 | __for_each_private_obj(__state, obj, obj_state, __i, __funcs) \ | |
848 | for_each_if (__funcs == obj_funcs) | |
849 | ||
081e9c0f DV |
850 | /** |
851 | * drm_atomic_crtc_needs_modeset - compute combined modeset need | |
852 | * @state: &drm_crtc_state for the CRTC | |
853 | * | |
ea0dd85a | 854 | * To give drivers flexibility &struct drm_crtc_state has 3 booleans to track |
081e9c0f | 855 | * whether the state CRTC changed enough to need a full modeset cycle: |
f9a76955 | 856 | * planes_changed, mode_changed and active_changed. This helper simply |
081e9c0f | 857 | * combines these three to compute the overall need for a modeset for @state. |
d807ed1c BS |
858 | * |
859 | * The atomic helper code sets these booleans, but drivers can and should | |
860 | * change them appropriately to accurately represent whether a modeset is | |
861 | * really needed. In general, drivers should avoid full modesets whenever | |
862 | * possible. | |
863 | * | |
864 | * For example if the CRTC mode has changed, and the hardware is able to enact | |
865 | * the requested mode change without going through a full modeset, the driver | |
d574528a DV |
866 | * should clear mode_changed in its &drm_mode_config_funcs.atomic_check |
867 | * implementation. | |
081e9c0f | 868 | */ |
2465ff62 | 869 | static inline bool |
79b95552 | 870 | drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state) |
2465ff62 | 871 | { |
fc596660 ML |
872 | return state->mode_changed || state->active_changed || |
873 | state->connectors_changed; | |
2465ff62 DV |
874 | } |
875 | ||
cc4ceb48 | 876 | #endif /* DRM_ATOMIC_H_ */ |