]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/drm/drm_atomic.h
2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
31 #include <drm/drm_crtc.h>
34 * struct drm_crtc_commit - track modeset commits on a CRTC
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.
41 * It has 3 different events in total to allow a fine-grained synchronization
42 * between outstanding updates::
44 * atomic commit thread hardware
46 * write new state into hardware ----> ...
48 * switch to new state on next
51 * wait for buffers to show up ...
53 * ... send completion irq
54 * irq handler signals flip_done
59 * wait for flip_done <----
60 * clean up atomic state
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.
66 * For an implementation of how to use this look at
67 * drm_atomic_helper_setup_commit() from the atomic helper library.
69 struct drm_crtc_commit
{
73 * DRM CRTC for this commit.
75 struct drm_crtc
*crtc
;
80 * Reference count for this structure. Needed to allow blocking on
81 * completions without the risk of the completion disappearing
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
95 struct completion flip_done
;
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
106 * Note that this does not need to include separately reference-counted
107 * resources like backing storage buffer pinning, or runtime pm
110 struct completion hw_done
;
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.
121 struct completion cleanup_done
;
126 * Entry on the per-CRTC &drm_crtc.commit_list. Protected by
127 * $drm_crtc.commit_lock.
129 struct list_head commit_entry
;
134 * &drm_pending_vblank_event pointer to clean up private events.
136 struct drm_pending_vblank_event
*event
;
139 struct __drm_planes_state
{
140 struct drm_plane
*ptr
;
141 struct drm_plane_state
*state
, *old_state
, *new_state
;
144 struct __drm_crtcs_state
{
145 struct drm_crtc
*ptr
;
146 struct drm_crtc_state
*state
, *old_state
, *new_state
;
147 struct drm_crtc_commit
*commit
;
148 s32 __user
*out_fence_ptr
;
149 unsigned last_vblank_count
;
152 struct __drm_connnectors_state
{
153 struct drm_connector
*ptr
;
154 struct drm_connector_state
*state
, *old_state
, *new_state
;
158 * struct drm_private_state_funcs - atomic state functions for private objects
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().
167 struct drm_private_state_funcs
{
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.
176 * Duplicated atomic state or NULL when obj->state is not
177 * initialized or allocation failed.
179 void *(*duplicate_state
)(struct drm_atomic_state
*state
, void *obj
);
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
188 void (*swap_state
)(void *obj
, void **obj_state_ptr
);
193 * Frees the private object state created with @duplicate_state.
195 void (*destroy_state
)(void *obj_state
);
198 struct __drm_private_objs_state
{
201 const struct drm_private_state_funcs
*funcs
;
205 * struct drm_atomic_state - the global state object for atomic updates
206 * @ref: count of all references to this state (will not be freed until zero)
207 * @dev: parent DRM device
208 * @allow_modeset: allow full modeset
209 * @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics
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
214 * @num_private_objs: size of the @private_objs array
215 * @private_objs: pointer to array of private object pointers
216 * @acquire_ctx: acquire context for this atomic modeset state update
218 struct drm_atomic_state
{
221 struct drm_device
*dev
;
222 bool allow_modeset
: 1;
223 bool legacy_cursor_update
: 1;
224 struct __drm_planes_state
*planes
;
225 struct __drm_crtcs_state
*crtcs
;
227 struct __drm_connnectors_state
*connectors
;
228 int num_private_objs
;
229 struct __drm_private_objs_state
*private_objs
;
231 struct drm_modeset_acquire_ctx
*acquire_ctx
;
236 * Work item which can be used by the driver or helpers to execute the
237 * commit without blocking.
239 struct work_struct commit_work
;
242 void __drm_crtc_commit_free(struct kref
*kref
);
245 * drm_crtc_commit_get - acquire a reference to the CRTC commit
246 * @commit: CRTC commit
248 * Increases the reference of @commit.
250 static inline void drm_crtc_commit_get(struct drm_crtc_commit
*commit
)
252 kref_get(&commit
->ref
);
256 * drm_crtc_commit_put - release a reference to the CRTC commmit
257 * @commit: CRTC commit
259 * This releases a reference to @commit which is freed after removing the
260 * final reference. No locking required and callable from any context.
262 static inline void drm_crtc_commit_put(struct drm_crtc_commit
*commit
)
264 kref_put(&commit
->ref
, __drm_crtc_commit_free
);
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
);
272 * drm_atomic_state_get - acquire a reference to the atomic state
273 * @state: The atomic state
275 * Returns a new reference to the @state
277 static inline struct drm_atomic_state
*
278 drm_atomic_state_get(struct drm_atomic_state
*state
)
280 kref_get(&state
->ref
);
284 void __drm_atomic_state_free(struct kref
*ref
);
287 * drm_atomic_state_put - release a reference to the atomic state
288 * @state: The atomic state
290 * This releases a reference to @state which is freed after removing the
291 * final reference. No locking required and callable from any context.
293 static inline void drm_atomic_state_put(struct drm_atomic_state
*state
)
295 kref_put(&state
->ref
, __drm_atomic_state_free
);
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
);
303 struct drm_crtc_state
* __must_check
304 drm_atomic_get_crtc_state(struct drm_atomic_state
*state
,
305 struct drm_crtc
*crtc
);
306 int drm_atomic_crtc_set_property(struct drm_crtc
*crtc
,
307 struct drm_crtc_state
*state
, struct drm_property
*property
,
309 struct drm_plane_state
* __must_check
310 drm_atomic_get_plane_state(struct drm_atomic_state
*state
,
311 struct drm_plane
*plane
);
312 int drm_atomic_plane_set_property(struct drm_plane
*plane
,
313 struct drm_plane_state
*state
, struct drm_property
*property
,
315 struct drm_connector_state
* __must_check
316 drm_atomic_get_connector_state(struct drm_atomic_state
*state
,
317 struct drm_connector
*connector
);
318 int drm_atomic_connector_set_property(struct drm_connector
*connector
,
319 struct drm_connector_state
*state
, struct drm_property
*property
,
323 drm_atomic_get_private_obj_state(struct drm_atomic_state
*state
,
325 const struct drm_private_state_funcs
*funcs
);
328 * drm_atomic_get_existing_crtc_state - get crtc state, if it exists
329 * @state: global atomic state object
330 * @crtc: crtc to grab
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.
335 * This function is deprecated, @drm_atomic_get_old_crtc_state or
336 * @drm_atomic_get_new_crtc_state should be used instead.
338 static inline struct drm_crtc_state
*
339 drm_atomic_get_existing_crtc_state(struct drm_atomic_state
*state
,
340 struct drm_crtc
*crtc
)
342 return state
->crtcs
[drm_crtc_index(crtc
)].state
;
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
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.
353 static inline struct drm_crtc_state
*
354 drm_atomic_get_old_crtc_state(struct drm_atomic_state
*state
,
355 struct drm_crtc
*crtc
)
357 return state
->crtcs
[drm_crtc_index(crtc
)].old_state
;
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
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.
367 static inline struct drm_crtc_state
*
368 drm_atomic_get_new_crtc_state(struct drm_atomic_state
*state
,
369 struct drm_crtc
*crtc
)
371 return state
->crtcs
[drm_crtc_index(crtc
)].new_state
;
375 * drm_atomic_get_existing_plane_state - get plane state, if it exists
376 * @state: global atomic state object
377 * @plane: plane to grab
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.
382 * This function is deprecated, @drm_atomic_get_old_plane_state or
383 * @drm_atomic_get_new_plane_state should be used instead.
385 static inline struct drm_plane_state
*
386 drm_atomic_get_existing_plane_state(struct drm_atomic_state
*state
,
387 struct drm_plane
*plane
)
389 return state
->planes
[drm_plane_index(plane
)].state
;
393 * drm_atomic_get_old_plane_state - get plane state, if it exists
394 * @state: global atomic state object
395 * @plane: plane to grab
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.
400 static inline struct drm_plane_state
*
401 drm_atomic_get_old_plane_state(struct drm_atomic_state
*state
,
402 struct drm_plane
*plane
)
404 return state
->planes
[drm_plane_index(plane
)].old_state
;
408 * drm_atomic_get_new_plane_state - get plane state, if it exists
409 * @state: global atomic state object
410 * @plane: plane to grab
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.
415 static inline struct drm_plane_state
*
416 drm_atomic_get_new_plane_state(struct drm_atomic_state
*state
,
417 struct drm_plane
*plane
)
419 return state
->planes
[drm_plane_index(plane
)].new_state
;
423 * drm_atomic_get_existing_connector_state - get connector state, if it exists
424 * @state: global atomic state object
425 * @connector: connector to grab
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.
430 * This function is deprecated, @drm_atomic_get_old_connector_state or
431 * @drm_atomic_get_new_connector_state should be used instead.
433 static inline struct drm_connector_state
*
434 drm_atomic_get_existing_connector_state(struct drm_atomic_state
*state
,
435 struct drm_connector
*connector
)
437 int index
= drm_connector_index(connector
);
439 if (index
>= state
->num_connector
)
442 return state
->connectors
[index
].state
;
446 * drm_atomic_get_old_connector_state - get connector state, if it exists
447 * @state: global atomic state object
448 * @connector: connector to grab
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.
453 static inline struct drm_connector_state
*
454 drm_atomic_get_old_connector_state(struct drm_atomic_state
*state
,
455 struct drm_connector
*connector
)
457 int index
= drm_connector_index(connector
);
459 if (index
>= state
->num_connector
)
462 return state
->connectors
[index
].old_state
;
466 * drm_atomic_get_new_connector_state - get connector state, if it exists
467 * @state: global atomic state object
468 * @connector: connector to grab
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.
473 static inline struct drm_connector_state
*
474 drm_atomic_get_new_connector_state(struct drm_atomic_state
*state
,
475 struct drm_connector
*connector
)
477 int index
= drm_connector_index(connector
);
479 if (index
>= state
->num_connector
)
482 return state
->connectors
[index
].new_state
;
486 * __drm_atomic_get_current_plane_state - get current plane state
487 * @state: global atomic state object
488 * @plane: plane to grab
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.
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
500 * safe to access the returned state structure through other means. One common
501 * example is when planes are fixed to a single CRTC, and the driver knows that
502 * the CRTC lock is held already. In that case holding the CRTC lock gives a
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.
509 * Read-only pointer to the current plane state.
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
)
515 if (state
->planes
[drm_plane_index(plane
)].state
)
516 return state
->planes
[drm_plane_index(plane
)].state
;
522 drm_atomic_set_mode_for_crtc(struct drm_crtc_state
*state
,
523 const struct drm_display_mode
*mode
);
525 drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state
*state
,
526 struct drm_property_blob
*blob
);
528 drm_atomic_set_crtc_for_plane(struct drm_plane_state
*plane_state
,
529 struct drm_crtc
*crtc
);
530 void drm_atomic_set_fb_for_plane(struct drm_plane_state
*plane_state
,
531 struct drm_framebuffer
*fb
);
532 void drm_atomic_set_fence_for_plane(struct drm_plane_state
*plane_state
,
533 struct dma_fence
*fence
);
535 drm_atomic_set_crtc_for_connector(struct drm_connector_state
*conn_state
,
536 struct drm_crtc
*crtc
);
538 drm_atomic_add_affected_connectors(struct drm_atomic_state
*state
,
539 struct drm_crtc
*crtc
);
541 drm_atomic_add_affected_planes(struct drm_atomic_state
*state
,
542 struct drm_crtc
*crtc
);
544 void drm_atomic_legacy_backoff(struct drm_atomic_state
*state
);
547 drm_atomic_clean_old_fb(struct drm_device
*dev
, unsigned plane_mask
, int ret
);
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
);
551 int __must_check
drm_atomic_nonblocking_commit(struct drm_atomic_state
*state
);
553 void drm_state_dump(struct drm_device
*dev
, struct drm_printer
*p
);
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
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.
569 * Replace all usage of this with one of the explicit iterators below and then
572 #define for_each_connector_in_state(__state, connector, connector_state, __i) \
574 (__i) < (__state)->num_connector && \
575 ((connector) = (__state)->connectors[__i].ptr, \
576 (connector_state) = (__state)->connectors[__i].state, 1); \
578 for_each_if (connector)
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
586 * @new_connector_state: &struct drm_connector_state iteration cursor for the
588 * @__i: int iteration cursor, for macro-internal use
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.
594 #define for_each_oldnew_connector_in_state(__state, connector, old_connector_state, new_connector_state, __i) \
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); \
601 for_each_if (connector)
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
609 * @__i: int iteration cursor, for macro-internal use
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.
615 #define for_each_old_connector_in_state(__state, connector, old_connector_state, __i) \
617 (__i) < (__state)->num_connector && \
618 ((connector) = (__state)->connectors[__i].ptr, \
619 (old_connector_state) = (__state)->connectors[__i].old_state, 1); \
621 for_each_if (connector)
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
629 * @__i: int iteration cursor, for macro-internal use
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.
635 #define for_each_new_connector_in_state(__state, connector, new_connector_state, __i) \
637 (__i) < (__state)->num_connector && \
638 ((connector) = (__state)->connectors[__i].ptr, \
639 (new_connector_state) = (__state)->connectors[__i].new_state, 1); \
641 for_each_if (connector)
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
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.
657 * Replace all usage of this with one of the explicit iterators below and then
660 #define for_each_crtc_in_state(__state, crtc, crtc_state, __i) \
662 (__i) < (__state)->dev->mode_config.num_crtc && \
663 ((crtc) = (__state)->crtcs[__i].ptr, \
664 (crtc_state) = (__state)->crtcs[__i].state, 1); \
666 for_each_if (crtc_state)
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
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.
680 #define for_each_oldnew_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \
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); \
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
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.
700 #define for_each_old_crtc_in_state(__state, crtc, old_crtc_state, __i) \
702 (__i) < (__state)->dev->mode_config.num_crtc && \
703 ((crtc) = (__state)->crtcs[__i].ptr, \
704 (old_crtc_state) = (__state)->crtcs[__i].old_state, 1); \
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
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.
719 #define for_each_new_crtc_in_state(__state, crtc, new_crtc_state, __i) \
721 (__i) < (__state)->dev->mode_config.num_crtc && \
722 ((crtc) = (__state)->crtcs[__i].ptr, \
723 (new_crtc_state) = (__state)->crtcs[__i].new_state, 1); \
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
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.
741 * Replace all usage of this with one of the explicit iterators below and then
744 #define for_each_plane_in_state(__state, plane, plane_state, __i) \
746 (__i) < (__state)->dev->mode_config.num_total_plane && \
747 ((plane) = (__state)->planes[__i].ptr, \
748 (plane_state) = (__state)->planes[__i].state, 1); \
750 for_each_if (plane_state)
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
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.
764 #define for_each_oldnew_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \
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); \
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
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.
784 #define for_each_old_plane_in_state(__state, plane, old_plane_state, __i) \
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); \
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
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.
803 #define for_each_new_plane_in_state(__state, plane, new_plane_state, __i) \
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); \
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
819 * This macro iterates over the array containing private object data in atomic
822 #define __for_each_private_obj(__state, obj, obj_state, __i, __funcs) \
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, \
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
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
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
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)
851 * drm_atomic_crtc_needs_modeset - compute combined modeset need
852 * @state: &drm_crtc_state for the CRTC
854 * To give drivers flexibility &struct drm_crtc_state has 3 booleans to track
855 * whether the state CRTC changed enough to need a full modeset cycle:
856 * planes_changed, mode_changed and active_changed. This helper simply
857 * combines these three to compute the overall need for a modeset for @state.
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
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
866 * should clear mode_changed in its &drm_mode_config_funcs.atomic_check
870 drm_atomic_crtc_needs_modeset(const struct drm_crtc_state
*state
)
872 return state
->mode_changed
|| state
->active_changed
||
873 state
->connectors_changed
;
876 #endif /* DRM_ATOMIC_H_ */