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>
32 #include <drm/drm_util.h>
35 * struct drm_crtc_commit - track modeset commits on a CRTC
37 * This structure is used to track pending modeset changes and atomic commit on
38 * a per-CRTC basis. Since updating the list should never block this structure
39 * is reference counted to allow waiters to safely wait on an event to complete,
40 * without holding any locks.
42 * It has 3 different events in total to allow a fine-grained synchronization
43 * between outstanding updates::
45 * atomic commit thread hardware
47 * write new state into hardware ----> ...
49 * switch to new state on next
52 * wait for buffers to show up ...
54 * ... send completion irq
55 * irq handler signals flip_done
60 * wait for flip_done <----
61 * clean up atomic state
63 * The important bit to know is that cleanup_done is the terminal event, but the
64 * ordering between flip_done and hw_done is entirely up to the specific driver
65 * and modeset state change.
67 * For an implementation of how to use this look at
68 * drm_atomic_helper_setup_commit() from the atomic helper library.
70 struct drm_crtc_commit {
74 * DRM CRTC for this commit.
76 struct drm_crtc *crtc;
81 * Reference count for this structure. Needed to allow blocking on
82 * completions without the risk of the completion disappearing
90 * Will be signaled when the hardware has flipped to the new set of
91 * buffers. Signals at the same time as when the drm event for this
92 * commit is sent to userspace, or when an out-fence is singalled. Note
93 * that for most hardware, in most cases this happens after @hw_done is
96 struct completion flip_done;
101 * Will be signalled when all hw register changes for this commit have
102 * been written out. Especially when disabling a pipe this can be much
103 * later than than @flip_done, since that can signal already when the
104 * screen goes black, whereas to fully shut down a pipe more register
107 * Note that this does not need to include separately reference-counted
108 * resources like backing storage buffer pinning, or runtime pm
111 struct completion hw_done;
116 * Will be signalled after old buffers have been cleaned up by calling
117 * drm_atomic_helper_cleanup_planes(). Since this can only happen after
118 * a vblank wait completed it might be a bit later. This completion is
119 * useful to throttle updates and avoid hardware updates getting ahead
120 * of the buffer cleanup too much.
122 struct completion cleanup_done;
127 * Entry on the per-CRTC &drm_crtc.commit_list. Protected by
128 * $drm_crtc.commit_lock.
130 struct list_head commit_entry;
135 * &drm_pending_vblank_event pointer to clean up private events.
137 struct drm_pending_vblank_event *event;
142 * A flag that's set after drm_atomic_helper_setup_commit() takes a
143 * second reference for the completion of $drm_crtc_state.event. It's
144 * used by the free code to remove the second reference if commit fails.
146 bool abort_completion;
149 struct __drm_planes_state {
150 struct drm_plane *ptr;
151 struct drm_plane_state *state, *old_state, *new_state;
154 struct __drm_crtcs_state {
155 struct drm_crtc *ptr;
156 struct drm_crtc_state *state, *old_state, *new_state;
161 * A reference to the CRTC commit object that is kept for use by
162 * drm_atomic_helper_wait_for_flip_done() after
163 * drm_atomic_helper_commit_hw_done() is called. This ensures that a
164 * concurrent commit won't free a commit object that is still in use.
166 struct drm_crtc_commit *commit;
168 s32 __user *out_fence_ptr;
169 u64 last_vblank_count;
172 struct __drm_connnectors_state {
173 struct drm_connector *ptr;
174 struct drm_connector_state *state, *old_state, *new_state;
178 * User-provided pointer which the kernel uses to return a sync_file
179 * file descriptor. Used by writeback connectors to signal completion of
182 s32 __user *out_fence_ptr;
185 struct drm_private_obj;
186 struct drm_private_state;
189 * struct drm_private_state_funcs - atomic state functions for private objects
191 * These hooks are used by atomic helpers to create, swap and destroy states of
192 * private objects. The structure itself is used as a vtable to identify the
193 * associated private object type. Each private object type that needs to be
194 * added to the atomic states is expected to have an implementation of these
195 * hooks and pass a pointer to its drm_private_state_funcs struct to
196 * drm_atomic_get_private_obj_state().
198 struct drm_private_state_funcs {
200 * @atomic_duplicate_state:
202 * Duplicate the current state of the private object and return it. It
203 * is an error to call this before obj->state has been initialized.
207 * Duplicated atomic state or NULL when obj->state is not
208 * initialized or allocation failed.
210 struct drm_private_state *(*atomic_duplicate_state)(struct drm_private_obj *obj);
213 * @atomic_destroy_state:
215 * Frees the private object state created with @atomic_duplicate_state.
217 void (*atomic_destroy_state)(struct drm_private_obj *obj,
218 struct drm_private_state *state);
222 * struct drm_private_obj - base struct for driver private atomic object
224 * A driver private object is initialized by calling
225 * drm_atomic_private_obj_init() and cleaned up by calling
226 * drm_atomic_private_obj_fini().
228 * Currently only tracks the state update functions and the opaque driver
229 * private state itself, but in the future might also track which
230 * &drm_modeset_lock is required to duplicate and update this object's state.
232 * All private objects must be initialized before the DRM device they are
233 * attached to is registered to the DRM subsystem (call to drm_dev_register())
234 * and should stay around until this DRM device is unregistered (call to
235 * drm_dev_unregister()). In other words, private objects lifetime is tied
236 * to the DRM device lifetime. This implies that:
238 * 1/ all calls to drm_atomic_private_obj_init() must be done before calling
240 * 2/ all calls to drm_atomic_private_obj_fini() must be done after calling
241 * drm_dev_unregister()
243 struct drm_private_obj {
245 * @head: List entry used to attach a private object to a &drm_device
246 * (queued to &drm_mode_config.privobj_list).
248 struct list_head head;
251 * @lock: Modeset lock to protect the state object.
253 struct drm_modeset_lock lock;
256 * @state: Current atomic state for this driver private object.
258 struct drm_private_state *state;
263 * Functions to manipulate the state of this driver private object, see
264 * &drm_private_state_funcs.
266 const struct drm_private_state_funcs *funcs;
270 * drm_for_each_privobj() - private object iterator
272 * @privobj: pointer to the current private object. Updated after each
274 * @dev: the DRM device we want get private objects from
276 * Allows one to iterate over all private objects attached to @dev
278 #define drm_for_each_privobj(privobj, dev) \
279 list_for_each_entry(privobj, &(dev)->mode_config.privobj_list, head)
282 * struct drm_private_state - base struct for driver private object state
283 * @state: backpointer to global drm_atomic_state
285 * Currently only contains a backpointer to the overall atomic update, but in
286 * the future also might hold synchronization information similar to e.g.
289 struct drm_private_state {
290 struct drm_atomic_state *state;
293 struct __drm_private_objs_state {
294 struct drm_private_obj *ptr;
295 struct drm_private_state *state, *old_state, *new_state;
299 * struct drm_atomic_state - the global state object for atomic updates
300 * @ref: count of all references to this state (will not be freed until zero)
301 * @dev: parent DRM device
302 * @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics
303 * @async_update: hint for asynchronous plane update
304 * @planes: pointer to array of structures with per-plane data
305 * @crtcs: pointer to array of CRTC pointers
306 * @num_connector: size of the @connectors and @connector_states arrays
307 * @connectors: pointer to array of structures with per-connector data
308 * @num_private_objs: size of the @private_objs array
309 * @private_objs: pointer to array of private object pointers
310 * @acquire_ctx: acquire context for this atomic modeset state update
312 * States are added to an atomic update by calling drm_atomic_get_crtc_state(),
313 * drm_atomic_get_plane_state(), drm_atomic_get_connector_state(), or for
314 * private state structures, drm_atomic_get_private_obj_state().
316 struct drm_atomic_state {
319 struct drm_device *dev;
324 * Allow full modeset. This is used by the ATOMIC IOCTL handler to
325 * implement the DRM_MODE_ATOMIC_ALLOW_MODESET flag. Drivers should
326 * never consult this flag, instead looking at the output of
327 * drm_atomic_crtc_needs_modeset().
329 bool allow_modeset : 1;
330 bool legacy_cursor_update : 1;
331 bool async_update : 1;
335 * Indicates whether or not this atomic state was duplicated using
336 * drm_atomic_helper_duplicate_state(). Drivers and atomic helpers
337 * should use this to fixup normal inconsistencies in duplicated
341 struct __drm_planes_state *planes;
342 struct __drm_crtcs_state *crtcs;
344 struct __drm_connnectors_state *connectors;
345 int num_private_objs;
346 struct __drm_private_objs_state *private_objs;
348 struct drm_modeset_acquire_ctx *acquire_ctx;
353 * Used for signaling unbound planes/connectors.
354 * When a connector or plane is not bound to any CRTC, it's still important
355 * to preserve linearity to prevent the atomic states from being freed to early.
357 * This commit (if set) is not bound to any crtc, but will be completed when
358 * drm_atomic_helper_commit_hw_done() is called.
360 struct drm_crtc_commit *fake_commit;
365 * Work item which can be used by the driver or helpers to execute the
366 * commit without blocking.
368 struct work_struct commit_work;
371 void __drm_crtc_commit_free(struct kref *kref);
374 * drm_crtc_commit_get - acquire a reference to the CRTC commit
375 * @commit: CRTC commit
377 * Increases the reference of @commit.
380 * The pointer to @commit, with reference increased.
382 static inline struct drm_crtc_commit *drm_crtc_commit_get(struct drm_crtc_commit *commit)
384 kref_get(&commit->ref);
389 * drm_crtc_commit_put - release a reference to the CRTC commmit
390 * @commit: CRTC commit
392 * This releases a reference to @commit which is freed after removing the
393 * final reference. No locking required and callable from any context.
395 static inline void drm_crtc_commit_put(struct drm_crtc_commit *commit)
397 kref_put(&commit->ref, __drm_crtc_commit_free);
400 struct drm_atomic_state * __must_check
401 drm_atomic_state_alloc(struct drm_device *dev);
402 void drm_atomic_state_clear(struct drm_atomic_state *state);
405 * drm_atomic_state_get - acquire a reference to the atomic state
406 * @state: The atomic state
408 * Returns a new reference to the @state
410 static inline struct drm_atomic_state *
411 drm_atomic_state_get(struct drm_atomic_state *state)
413 kref_get(&state->ref);
417 void __drm_atomic_state_free(struct kref *ref);
420 * drm_atomic_state_put - release a reference to the atomic state
421 * @state: The atomic state
423 * This releases a reference to @state which is freed after removing the
424 * final reference. No locking required and callable from any context.
426 static inline void drm_atomic_state_put(struct drm_atomic_state *state)
428 kref_put(&state->ref, __drm_atomic_state_free);
432 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state);
433 void drm_atomic_state_default_clear(struct drm_atomic_state *state);
434 void drm_atomic_state_default_release(struct drm_atomic_state *state);
436 struct drm_crtc_state * __must_check
437 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
438 struct drm_crtc *crtc);
439 struct drm_plane_state * __must_check
440 drm_atomic_get_plane_state(struct drm_atomic_state *state,
441 struct drm_plane *plane);
442 struct drm_connector_state * __must_check
443 drm_atomic_get_connector_state(struct drm_atomic_state *state,
444 struct drm_connector *connector);
446 void drm_atomic_private_obj_init(struct drm_device *dev,
447 struct drm_private_obj *obj,
448 struct drm_private_state *state,
449 const struct drm_private_state_funcs *funcs);
450 void drm_atomic_private_obj_fini(struct drm_private_obj *obj);
452 struct drm_private_state * __must_check
453 drm_atomic_get_private_obj_state(struct drm_atomic_state *state,
454 struct drm_private_obj *obj);
455 struct drm_private_state *
456 drm_atomic_get_old_private_obj_state(struct drm_atomic_state *state,
457 struct drm_private_obj *obj);
458 struct drm_private_state *
459 drm_atomic_get_new_private_obj_state(struct drm_atomic_state *state,
460 struct drm_private_obj *obj);
463 * drm_atomic_get_existing_crtc_state - get crtc state, if it exists
464 * @state: global atomic state object
465 * @crtc: crtc to grab
467 * This function returns the crtc state for the given crtc, or NULL
468 * if the crtc is not part of the global atomic state.
470 * This function is deprecated, @drm_atomic_get_old_crtc_state or
471 * @drm_atomic_get_new_crtc_state should be used instead.
473 static inline struct drm_crtc_state *
474 drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state,
475 struct drm_crtc *crtc)
477 return state->crtcs[drm_crtc_index(crtc)].state;
481 * drm_atomic_get_old_crtc_state - get old crtc state, if it exists
482 * @state: global atomic state object
483 * @crtc: crtc to grab
485 * This function returns the old crtc state for the given crtc, or
486 * NULL if the crtc is not part of the global atomic state.
488 static inline struct drm_crtc_state *
489 drm_atomic_get_old_crtc_state(struct drm_atomic_state *state,
490 struct drm_crtc *crtc)
492 return state->crtcs[drm_crtc_index(crtc)].old_state;
495 * drm_atomic_get_new_crtc_state - get new crtc state, if it exists
496 * @state: global atomic state object
497 * @crtc: crtc to grab
499 * This function returns the new crtc state for the given crtc, or
500 * NULL if the crtc is not part of the global atomic state.
502 static inline struct drm_crtc_state *
503 drm_atomic_get_new_crtc_state(struct drm_atomic_state *state,
504 struct drm_crtc *crtc)
506 return state->crtcs[drm_crtc_index(crtc)].new_state;
510 * drm_atomic_get_existing_plane_state - get plane state, if it exists
511 * @state: global atomic state object
512 * @plane: plane to grab
514 * This function returns the plane state for the given plane, or NULL
515 * if the plane is not part of the global atomic state.
517 * This function is deprecated, @drm_atomic_get_old_plane_state or
518 * @drm_atomic_get_new_plane_state should be used instead.
520 static inline struct drm_plane_state *
521 drm_atomic_get_existing_plane_state(struct drm_atomic_state *state,
522 struct drm_plane *plane)
524 return state->planes[drm_plane_index(plane)].state;
528 * drm_atomic_get_old_plane_state - get plane state, if it exists
529 * @state: global atomic state object
530 * @plane: plane to grab
532 * This function returns the old plane state for the given plane, or
533 * NULL if the plane is not part of the global atomic state.
535 static inline struct drm_plane_state *
536 drm_atomic_get_old_plane_state(struct drm_atomic_state *state,
537 struct drm_plane *plane)
539 return state->planes[drm_plane_index(plane)].old_state;
543 * drm_atomic_get_new_plane_state - get plane state, if it exists
544 * @state: global atomic state object
545 * @plane: plane to grab
547 * This function returns the new plane state for the given plane, or
548 * NULL if the plane is not part of the global atomic state.
550 static inline struct drm_plane_state *
551 drm_atomic_get_new_plane_state(struct drm_atomic_state *state,
552 struct drm_plane *plane)
554 return state->planes[drm_plane_index(plane)].new_state;
558 * drm_atomic_get_existing_connector_state - get connector state, if it exists
559 * @state: global atomic state object
560 * @connector: connector to grab
562 * This function returns the connector state for the given connector,
563 * or NULL if the connector is not part of the global atomic state.
565 * This function is deprecated, @drm_atomic_get_old_connector_state or
566 * @drm_atomic_get_new_connector_state should be used instead.
568 static inline struct drm_connector_state *
569 drm_atomic_get_existing_connector_state(struct drm_atomic_state *state,
570 struct drm_connector *connector)
572 int index = drm_connector_index(connector);
574 if (index >= state->num_connector)
577 return state->connectors[index].state;
581 * drm_atomic_get_old_connector_state - get connector state, if it exists
582 * @state: global atomic state object
583 * @connector: connector to grab
585 * This function returns the old connector state for the given connector,
586 * or NULL if the connector is not part of the global atomic state.
588 static inline struct drm_connector_state *
589 drm_atomic_get_old_connector_state(struct drm_atomic_state *state,
590 struct drm_connector *connector)
592 int index = drm_connector_index(connector);
594 if (index >= state->num_connector)
597 return state->connectors[index].old_state;
601 * drm_atomic_get_new_connector_state - get connector state, if it exists
602 * @state: global atomic state object
603 * @connector: connector to grab
605 * This function returns the new connector state for the given connector,
606 * or NULL if the connector is not part of the global atomic state.
608 static inline struct drm_connector_state *
609 drm_atomic_get_new_connector_state(struct drm_atomic_state *state,
610 struct drm_connector *connector)
612 int index = drm_connector_index(connector);
614 if (index >= state->num_connector)
617 return state->connectors[index].new_state;
621 * __drm_atomic_get_current_plane_state - get current plane state
622 * @state: global atomic state object
623 * @plane: plane to grab
625 * This function returns the plane state for the given plane, either from
626 * @state, or if the plane isn't part of the atomic state update, from @plane.
627 * This is useful in atomic check callbacks, when drivers need to peek at, but
628 * not change, state of other planes, since it avoids threading an error code
629 * back up the call chain.
633 * Note that this function is in general unsafe since it doesn't check for the
634 * required locking for access state structures. Drivers must ensure that it is
635 * safe to access the returned state structure through other means. One common
636 * example is when planes are fixed to a single CRTC, and the driver knows that
637 * the CRTC lock is held already. In that case holding the CRTC lock gives a
638 * read-lock on all planes connected to that CRTC. But if planes can be
639 * reassigned things get more tricky. In that case it's better to use
640 * drm_atomic_get_plane_state and wire up full error handling.
644 * Read-only pointer to the current plane state.
646 static inline const struct drm_plane_state *
647 __drm_atomic_get_current_plane_state(struct drm_atomic_state *state,
648 struct drm_plane *plane)
650 if (state->planes[drm_plane_index(plane)].state)
651 return state->planes[drm_plane_index(plane)].state;
657 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
658 struct drm_crtc *crtc);
660 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
661 struct drm_crtc *crtc);
663 int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
664 int __must_check drm_atomic_commit(struct drm_atomic_state *state);
665 int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state);
667 void drm_state_dump(struct drm_device *dev, struct drm_printer *p);
670 * for_each_oldnew_connector_in_state - iterate over all connectors in an atomic update
671 * @__state: &struct drm_atomic_state pointer
672 * @connector: &struct drm_connector iteration cursor
673 * @old_connector_state: &struct drm_connector_state iteration cursor for the
675 * @new_connector_state: &struct drm_connector_state iteration cursor for the
677 * @__i: int iteration cursor, for macro-internal use
679 * This iterates over all connectors in an atomic update, tracking both old and
680 * new state. This is useful in places where the state delta needs to be
681 * considered, for example in atomic check functions.
683 #define for_each_oldnew_connector_in_state(__state, connector, old_connector_state, new_connector_state, __i) \
685 (__i) < (__state)->num_connector; \
687 for_each_if ((__state)->connectors[__i].ptr && \
688 ((connector) = (__state)->connectors[__i].ptr, \
689 (old_connector_state) = (__state)->connectors[__i].old_state, \
690 (new_connector_state) = (__state)->connectors[__i].new_state, 1))
693 * for_each_old_connector_in_state - iterate over all connectors in an atomic update
694 * @__state: &struct drm_atomic_state pointer
695 * @connector: &struct drm_connector iteration cursor
696 * @old_connector_state: &struct drm_connector_state iteration cursor for the
698 * @__i: int iteration cursor, for macro-internal use
700 * This iterates over all connectors in an atomic update, tracking only the old
701 * state. This is useful in disable functions, where we need the old state the
702 * hardware is still in.
704 #define for_each_old_connector_in_state(__state, connector, old_connector_state, __i) \
706 (__i) < (__state)->num_connector; \
708 for_each_if ((__state)->connectors[__i].ptr && \
709 ((connector) = (__state)->connectors[__i].ptr, \
710 (old_connector_state) = (__state)->connectors[__i].old_state, 1))
713 * for_each_new_connector_in_state - iterate over all connectors in an atomic update
714 * @__state: &struct drm_atomic_state pointer
715 * @connector: &struct drm_connector iteration cursor
716 * @new_connector_state: &struct drm_connector_state iteration cursor for the
718 * @__i: int iteration cursor, for macro-internal use
720 * This iterates over all connectors in an atomic update, tracking only the new
721 * state. This is useful in enable functions, where we need the new state the
722 * hardware should be in when the atomic commit operation has completed.
724 #define for_each_new_connector_in_state(__state, connector, new_connector_state, __i) \
726 (__i) < (__state)->num_connector; \
728 for_each_if ((__state)->connectors[__i].ptr && \
729 ((connector) = (__state)->connectors[__i].ptr, \
730 (new_connector_state) = (__state)->connectors[__i].new_state, 1))
733 * for_each_oldnew_crtc_in_state - iterate over all CRTCs in an atomic update
734 * @__state: &struct drm_atomic_state pointer
735 * @crtc: &struct drm_crtc iteration cursor
736 * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
737 * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
738 * @__i: int iteration cursor, for macro-internal use
740 * This iterates over all CRTCs in an atomic update, tracking both old and
741 * new state. This is useful in places where the state delta needs to be
742 * considered, for example in atomic check functions.
744 #define for_each_oldnew_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \
746 (__i) < (__state)->dev->mode_config.num_crtc; \
748 for_each_if ((__state)->crtcs[__i].ptr && \
749 ((crtc) = (__state)->crtcs[__i].ptr, \
750 (old_crtc_state) = (__state)->crtcs[__i].old_state, \
751 (new_crtc_state) = (__state)->crtcs[__i].new_state, 1))
754 * for_each_old_crtc_in_state - iterate over all CRTCs in an atomic update
755 * @__state: &struct drm_atomic_state pointer
756 * @crtc: &struct drm_crtc iteration cursor
757 * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
758 * @__i: int iteration cursor, for macro-internal use
760 * This iterates over all CRTCs in an atomic update, tracking only the old
761 * state. This is useful in disable functions, where we need the old state the
762 * hardware is still in.
764 #define for_each_old_crtc_in_state(__state, crtc, old_crtc_state, __i) \
766 (__i) < (__state)->dev->mode_config.num_crtc; \
768 for_each_if ((__state)->crtcs[__i].ptr && \
769 ((crtc) = (__state)->crtcs[__i].ptr, \
770 (old_crtc_state) = (__state)->crtcs[__i].old_state, 1))
773 * for_each_new_crtc_in_state - iterate over all CRTCs in an atomic update
774 * @__state: &struct drm_atomic_state pointer
775 * @crtc: &struct drm_crtc iteration cursor
776 * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
777 * @__i: int iteration cursor, for macro-internal use
779 * This iterates over all CRTCs in an atomic update, tracking only the new
780 * state. This is useful in enable functions, where we need the new state the
781 * hardware should be in when the atomic commit operation has completed.
783 #define for_each_new_crtc_in_state(__state, crtc, new_crtc_state, __i) \
785 (__i) < (__state)->dev->mode_config.num_crtc; \
787 for_each_if ((__state)->crtcs[__i].ptr && \
788 ((crtc) = (__state)->crtcs[__i].ptr, \
789 (new_crtc_state) = (__state)->crtcs[__i].new_state, 1))
792 * for_each_oldnew_plane_in_state - iterate over all planes in an atomic update
793 * @__state: &struct drm_atomic_state pointer
794 * @plane: &struct drm_plane iteration cursor
795 * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
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 both old and
800 * new state. This is useful in places where the state delta needs to be
801 * considered, for example in atomic check functions.
803 #define for_each_oldnew_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \
805 (__i) < (__state)->dev->mode_config.num_total_plane; \
807 for_each_if ((__state)->planes[__i].ptr && \
808 ((plane) = (__state)->planes[__i].ptr, \
809 (old_plane_state) = (__state)->planes[__i].old_state,\
810 (new_plane_state) = (__state)->planes[__i].new_state, 1))
813 * for_each_oldnew_plane_in_state_reverse - iterate over all planes in an atomic
814 * update in reverse order
815 * @__state: &struct drm_atomic_state pointer
816 * @plane: &struct drm_plane iteration cursor
817 * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
818 * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
819 * @__i: int iteration cursor, for macro-internal use
821 * This iterates over all planes in an atomic update in reverse order,
822 * tracking both old and new state. This is useful in places where the
823 * state delta needs to be considered, for example in atomic check functions.
825 #define for_each_oldnew_plane_in_state_reverse(__state, plane, old_plane_state, new_plane_state, __i) \
826 for ((__i) = ((__state)->dev->mode_config.num_total_plane - 1); \
829 for_each_if ((__state)->planes[__i].ptr && \
830 ((plane) = (__state)->planes[__i].ptr, \
831 (old_plane_state) = (__state)->planes[__i].old_state,\
832 (new_plane_state) = (__state)->planes[__i].new_state, 1))
835 * for_each_old_plane_in_state - iterate over all planes in an atomic update
836 * @__state: &struct drm_atomic_state pointer
837 * @plane: &struct drm_plane iteration cursor
838 * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
839 * @__i: int iteration cursor, for macro-internal use
841 * This iterates over all planes in an atomic update, tracking only the old
842 * state. This is useful in disable functions, where we need the old state the
843 * hardware is still in.
845 #define for_each_old_plane_in_state(__state, plane, old_plane_state, __i) \
847 (__i) < (__state)->dev->mode_config.num_total_plane; \
849 for_each_if ((__state)->planes[__i].ptr && \
850 ((plane) = (__state)->planes[__i].ptr, \
851 (old_plane_state) = (__state)->planes[__i].old_state, 1))
853 * for_each_new_plane_in_state - iterate over all planes in an atomic update
854 * @__state: &struct drm_atomic_state pointer
855 * @plane: &struct drm_plane iteration cursor
856 * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
857 * @__i: int iteration cursor, for macro-internal use
859 * This iterates over all planes in an atomic update, tracking only the new
860 * state. This is useful in enable functions, where we need the new state the
861 * hardware should be in when the atomic commit operation has completed.
863 #define for_each_new_plane_in_state(__state, plane, new_plane_state, __i) \
865 (__i) < (__state)->dev->mode_config.num_total_plane; \
867 for_each_if ((__state)->planes[__i].ptr && \
868 ((plane) = (__state)->planes[__i].ptr, \
869 (new_plane_state) = (__state)->planes[__i].new_state, 1))
872 * for_each_oldnew_private_obj_in_state - iterate over all private objects in an atomic update
873 * @__state: &struct drm_atomic_state pointer
874 * @obj: &struct drm_private_obj iteration cursor
875 * @old_obj_state: &struct drm_private_state iteration cursor for the old state
876 * @new_obj_state: &struct drm_private_state iteration cursor for the new state
877 * @__i: int iteration cursor, for macro-internal use
879 * This iterates over all private objects in an atomic update, tracking both
880 * old and new state. This is useful in places where the state delta needs
881 * to be considered, for example in atomic check functions.
883 #define for_each_oldnew_private_obj_in_state(__state, obj, old_obj_state, new_obj_state, __i) \
885 (__i) < (__state)->num_private_objs && \
886 ((obj) = (__state)->private_objs[__i].ptr, \
887 (old_obj_state) = (__state)->private_objs[__i].old_state, \
888 (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
892 * for_each_old_private_obj_in_state - iterate over all private objects in an atomic update
893 * @__state: &struct drm_atomic_state pointer
894 * @obj: &struct drm_private_obj iteration cursor
895 * @old_obj_state: &struct drm_private_state iteration cursor for the old state
896 * @__i: int iteration cursor, for macro-internal use
898 * This iterates over all private objects in an atomic update, tracking only
899 * the old state. This is useful in disable functions, where we need the old
900 * state the hardware is still in.
902 #define for_each_old_private_obj_in_state(__state, obj, old_obj_state, __i) \
904 (__i) < (__state)->num_private_objs && \
905 ((obj) = (__state)->private_objs[__i].ptr, \
906 (old_obj_state) = (__state)->private_objs[__i].old_state, 1); \
910 * for_each_new_private_obj_in_state - iterate over all private objects in an atomic update
911 * @__state: &struct drm_atomic_state pointer
912 * @obj: &struct drm_private_obj iteration cursor
913 * @new_obj_state: &struct drm_private_state iteration cursor for the new state
914 * @__i: int iteration cursor, for macro-internal use
916 * This iterates over all private objects in an atomic update, tracking only
917 * the new state. This is useful in enable functions, where we need the new state the
918 * hardware should be in when the atomic commit operation has completed.
920 #define for_each_new_private_obj_in_state(__state, obj, new_obj_state, __i) \
922 (__i) < (__state)->num_private_objs && \
923 ((obj) = (__state)->private_objs[__i].ptr, \
924 (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
928 * drm_atomic_crtc_needs_modeset - compute combined modeset need
929 * @state: &drm_crtc_state for the CRTC
931 * To give drivers flexibility &struct drm_crtc_state has 3 booleans to track
932 * whether the state CRTC changed enough to need a full modeset cycle:
933 * mode_changed, active_changed and connectors_changed. This helper simply
934 * combines these three to compute the overall need for a modeset for @state.
936 * The atomic helper code sets these booleans, but drivers can and should
937 * change them appropriately to accurately represent whether a modeset is
938 * really needed. In general, drivers should avoid full modesets whenever
941 * For example if the CRTC mode has changed, and the hardware is able to enact
942 * the requested mode change without going through a full modeset, the driver
943 * should clear mode_changed in its &drm_mode_config_funcs.atomic_check
947 drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state)
949 return state->mode_changed || state->active_changed ||
950 state->connectors_changed;
953 #endif /* DRM_ATOMIC_H_ */