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 
31 #include <drm/drm_crtc.h>
32 #include <drm/drm_util.h>
33 
34 /**
35  * struct drm_crtc_commit - track modeset commits on a CRTC
36  *
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.
41  *
42  * It has 3 different events in total to allow a fine-grained synchronization
43  * between outstanding updates::
44  *
45  *	atomic commit thread			hardware
46  *
47  * 	write new state into hardware	---->	...
48  * 	signal hw_done
49  * 						switch to new state on next
50  * 	...					v/hblank
51  *
52  *	wait for buffers to show up		...
53  *
54  *	...					send completion irq
55  *						irq handler signals flip_done
56  *	cleanup old buffers
57  *
58  * 	signal cleanup_done
59  *
60  * 	wait for flip_done		<----
61  * 	clean up atomic state
62  *
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.
66  *
67  * For an implementation of how to use this look at
68  * drm_atomic_helper_setup_commit() from the atomic helper library.
69  *
70  * See also drm_crtc_commit_wait().
71  */
72 struct drm_crtc_commit {
73 	/**
74 	 * @crtc:
75 	 *
76 	 * DRM CRTC for this commit.
77 	 */
78 	struct drm_crtc *crtc;
79 
80 	/**
81 	 * @ref:
82 	 *
83 	 * Reference count for this structure. Needed to allow blocking on
84 	 * completions without the risk of the completion disappearing
85 	 * meanwhile.
86 	 */
87 	struct kref ref;
88 
89 	/**
90 	 * @flip_done:
91 	 *
92 	 * Will be signaled when the hardware has flipped to the new set of
93 	 * buffers. Signals at the same time as when the drm event for this
94 	 * commit is sent to userspace, or when an out-fence is singalled. Note
95 	 * that for most hardware, in most cases this happens after @hw_done is
96 	 * signalled.
97 	 *
98 	 * Completion of this stage is signalled implicitly by calling
99 	 * drm_crtc_send_vblank_event() on &drm_crtc_state.event.
100 	 */
101 	struct completion flip_done;
102 
103 	/**
104 	 * @hw_done:
105 	 *
106 	 * Will be signalled when all hw register changes for this commit have
107 	 * been written out. Especially when disabling a pipe this can be much
108 	 * later than @flip_done, since that can signal already when the
109 	 * screen goes black, whereas to fully shut down a pipe more register
110 	 * I/O is required.
111 	 *
112 	 * Note that this does not need to include separately reference-counted
113 	 * resources like backing storage buffer pinning, or runtime pm
114 	 * management.
115 	 *
116 	 * Drivers should call drm_atomic_helper_commit_hw_done() to signal
117 	 * completion of this stage.
118 	 */
119 	struct completion hw_done;
120 
121 	/**
122 	 * @cleanup_done:
123 	 *
124 	 * Will be signalled after old buffers have been cleaned up by calling
125 	 * drm_atomic_helper_cleanup_planes(). Since this can only happen after
126 	 * a vblank wait completed it might be a bit later. This completion is
127 	 * useful to throttle updates and avoid hardware updates getting ahead
128 	 * of the buffer cleanup too much.
129 	 *
130 	 * Drivers should call drm_atomic_helper_commit_cleanup_done() to signal
131 	 * completion of this stage.
132 	 */
133 	struct completion cleanup_done;
134 
135 	/**
136 	 * @commit_entry:
137 	 *
138 	 * Entry on the per-CRTC &drm_crtc.commit_list. Protected by
139 	 * $drm_crtc.commit_lock.
140 	 */
141 	struct list_head commit_entry;
142 
143 	/**
144 	 * @event:
145 	 *
146 	 * &drm_pending_vblank_event pointer to clean up private events.
147 	 */
148 	struct drm_pending_vblank_event *event;
149 
150 	/**
151 	 * @abort_completion:
152 	 *
153 	 * A flag that's set after drm_atomic_helper_setup_commit() takes a
154 	 * second reference for the completion of $drm_crtc_state.event. It's
155 	 * used by the free code to remove the second reference if commit fails.
156 	 */
157 	bool abort_completion;
158 };
159 
160 struct __drm_planes_state {
161 	struct drm_plane *ptr;
162 	struct drm_plane_state *state, *old_state, *new_state;
163 };
164 
165 struct __drm_crtcs_state {
166 	struct drm_crtc *ptr;
167 	struct drm_crtc_state *state, *old_state, *new_state;
168 
169 	/**
170 	 * @commit:
171 	 *
172 	 * A reference to the CRTC commit object that is kept for use by
173 	 * drm_atomic_helper_wait_for_flip_done() after
174 	 * drm_atomic_helper_commit_hw_done() is called. This ensures that a
175 	 * concurrent commit won't free a commit object that is still in use.
176 	 */
177 	struct drm_crtc_commit *commit;
178 
179 	s32 __user *out_fence_ptr;
180 	u64 last_vblank_count;
181 };
182 
183 struct __drm_connnectors_state {
184 	struct drm_connector *ptr;
185 	struct drm_connector_state *state, *old_state, *new_state;
186 	/**
187 	 * @out_fence_ptr:
188 	 *
189 	 * User-provided pointer which the kernel uses to return a sync_file
190 	 * file descriptor. Used by writeback connectors to signal completion of
191 	 * the writeback.
192 	 */
193 	s32 __user *out_fence_ptr;
194 };
195 
196 struct drm_private_obj;
197 struct drm_private_state;
198 
199 /**
200  * struct drm_private_state_funcs - atomic state functions for private objects
201  *
202  * These hooks are used by atomic helpers to create, swap and destroy states of
203  * private objects. The structure itself is used as a vtable to identify the
204  * associated private object type. Each private object type that needs to be
205  * added to the atomic states is expected to have an implementation of these
206  * hooks and pass a pointer to its drm_private_state_funcs struct to
207  * drm_atomic_get_private_obj_state().
208  */
209 struct drm_private_state_funcs {
210 	/**
211 	 * @atomic_duplicate_state:
212 	 *
213 	 * Duplicate the current state of the private object and return it. It
214 	 * is an error to call this before obj->state has been initialized.
215 	 *
216 	 * RETURNS:
217 	 *
218 	 * Duplicated atomic state or NULL when obj->state is not
219 	 * initialized or allocation failed.
220 	 */
221 	struct drm_private_state *(*atomic_duplicate_state)(struct drm_private_obj *obj);
222 
223 	/**
224 	 * @atomic_destroy_state:
225 	 *
226 	 * Frees the private object state created with @atomic_duplicate_state.
227 	 */
228 	void (*atomic_destroy_state)(struct drm_private_obj *obj,
229 				     struct drm_private_state *state);
230 
231 	/**
232 	 * @atomic_print_state:
233 	 *
234 	 * If driver subclasses &struct drm_private_state, it should implement
235 	 * this optional hook for printing additional driver specific state.
236 	 *
237 	 * Do not call this directly, use drm_atomic_private_obj_print_state()
238 	 * instead.
239 	 */
240 	void (*atomic_print_state)(struct drm_printer *p,
241 				   const struct drm_private_state *state);
242 };
243 
244 /**
245  * struct drm_private_obj - base struct for driver private atomic object
246  *
247  * A driver private object is initialized by calling
248  * drm_atomic_private_obj_init() and cleaned up by calling
249  * drm_atomic_private_obj_fini().
250  *
251  * Currently only tracks the state update functions and the opaque driver
252  * private state itself, but in the future might also track which
253  * &drm_modeset_lock is required to duplicate and update this object's state.
254  *
255  * All private objects must be initialized before the DRM device they are
256  * attached to is registered to the DRM subsystem (call to drm_dev_register())
257  * and should stay around until this DRM device is unregistered (call to
258  * drm_dev_unregister()). In other words, private objects lifetime is tied
259  * to the DRM device lifetime. This implies that:
260  *
261  * 1/ all calls to drm_atomic_private_obj_init() must be done before calling
262  *    drm_dev_register()
263  * 2/ all calls to drm_atomic_private_obj_fini() must be done after calling
264  *    drm_dev_unregister()
265  *
266  * If that private object is used to store a state shared by multiple
267  * CRTCs, proper care must be taken to ensure that non-blocking commits are
268  * properly ordered to avoid a use-after-free issue.
269  *
270  * Indeed, assuming a sequence of two non-blocking &drm_atomic_commit on two
271  * different &drm_crtc using different &drm_plane and &drm_connector, so with no
272  * resources shared, there's no guarantee on which commit is going to happen
273  * first. However, the second &drm_atomic_commit will consider the first
274  * &drm_private_obj its old state, and will be in charge of freeing it whenever
275  * the second &drm_atomic_commit is done.
276  *
277  * If the first &drm_atomic_commit happens after it, it will consider its
278  * &drm_private_obj the new state and will be likely to access it, resulting in
279  * an access to a freed memory region. Drivers should store (and get a reference
280  * to) the &drm_crtc_commit structure in our private state in
281  * &drm_mode_config_helper_funcs.atomic_commit_setup, and then wait for that
282  * commit to complete as the first step of
283  * &drm_mode_config_helper_funcs.atomic_commit_tail, similar to
284  * drm_atomic_helper_wait_for_dependencies().
285  */
286 struct drm_private_obj {
287 	/**
288 	 * @head: List entry used to attach a private object to a &drm_device
289 	 * (queued to &drm_mode_config.privobj_list).
290 	 */
291 	struct list_head head;
292 
293 	/**
294 	 * @lock: Modeset lock to protect the state object.
295 	 */
296 	struct drm_modeset_lock lock;
297 
298 	/**
299 	 * @state: Current atomic state for this driver private object.
300 	 */
301 	struct drm_private_state *state;
302 
303 	/**
304 	 * @funcs:
305 	 *
306 	 * Functions to manipulate the state of this driver private object, see
307 	 * &drm_private_state_funcs.
308 	 */
309 	const struct drm_private_state_funcs *funcs;
310 };
311 
312 /**
313  * drm_for_each_privobj() - private object iterator
314  *
315  * @privobj: pointer to the current private object. Updated after each
316  *	     iteration
317  * @dev: the DRM device we want get private objects from
318  *
319  * Allows one to iterate over all private objects attached to @dev
320  */
321 #define drm_for_each_privobj(privobj, dev) \
322 	list_for_each_entry(privobj, &(dev)->mode_config.privobj_list, head)
323 
324 /**
325  * struct drm_private_state - base struct for driver private object state
326  *
327  * Currently only contains a backpointer to the overall atomic update,
328  * and the relevant private object but in the future also might hold
329  * synchronization information similar to e.g. &drm_crtc.commit.
330  */
331 struct drm_private_state {
332 	/**
333 	 * @state: backpointer to global drm_atomic_state
334 	 */
335 	struct drm_atomic_state *state;
336 
337 	/**
338 	 * @obj: backpointer to the private object
339 	 */
340 	struct drm_private_obj *obj;
341 };
342 
343 struct __drm_private_objs_state {
344 	struct drm_private_obj *ptr;
345 	struct drm_private_state *state, *old_state, *new_state;
346 };
347 
348 /**
349  * struct drm_atomic_state - Atomic commit structure
350  *
351  * This structure is the kernel counterpart of @drm_mode_atomic and represents
352  * an atomic commit that transitions from an old to a new display state. It
353  * contains all the objects affected by the atomic commit and both the new
354  * state structures and pointers to the old state structures for
355  * these.
356  *
357  * States are added to an atomic update by calling drm_atomic_get_crtc_state(),
358  * drm_atomic_get_plane_state(), drm_atomic_get_connector_state(), or for
359  * private state structures, drm_atomic_get_private_obj_state().
360  *
361  * NOTE: struct drm_atomic_state first started as a single collection of
362  * entities state pointers (drm_plane_state, drm_crtc_state, etc.).
363  *
364  * At atomic_check time, you could get the state about to be committed
365  * from drm_atomic_state, and the one currently running from the
366  * entities state pointer (drm_crtc.state, for example). After the call
367  * to drm_atomic_helper_swap_state(), the entities state pointer would
368  * contain the state previously checked, and the drm_atomic_state
369  * structure the old state.
370  *
371  * Over time, and in order to avoid confusion, drm_atomic_state has
372  * grown to have both the old state (ie, the state we replace) and the
373  * new state (ie, the state we want to apply). Those names are stable
374  * during the commit process, which makes it easier to reason about.
375  *
376  * You can still find some traces of that evolution through some hooks
377  * or callbacks taking a drm_atomic_state parameter called names like
378  * "old_state". This doesn't necessarily mean that the previous
379  * drm_atomic_state is passed, but rather that this used to be the state
380  * collection we were replacing after drm_atomic_helper_swap_state(),
381  * but the variable name was never updated.
382  *
383  * Some atomic operations implementations followed a similar process. We
384  * first started to pass the entity state only. However, it was pretty
385  * cumbersome for drivers, and especially CRTCs, to retrieve the states
386  * of other components. Thus, we switched to passing the whole
387  * drm_atomic_state as a parameter to those operations. Similarly, the
388  * transition isn't complete yet, and one might still find atomic
389  * operations taking a drm_atomic_state pointer, or a component state
390  * pointer. The former is the preferred form.
391  */
392 struct drm_atomic_state {
393 	/**
394 	 * @ref:
395 	 *
396 	 * Count of all references to this update (will not be freed until zero).
397 	 */
398 	struct kref ref;
399 
400 	/**
401 	 * @dev: Parent DRM Device.
402 	 */
403 	struct drm_device *dev;
404 
405 	/**
406 	 * @allow_modeset:
407 	 *
408 	 * Allow full modeset. This is used by the ATOMIC IOCTL handler to
409 	 * implement the DRM_MODE_ATOMIC_ALLOW_MODESET flag. Drivers should
410 	 * generally not consult this flag, but instead look at the output of
411 	 * drm_atomic_crtc_needs_modeset(). The detailed rules are:
412 	 *
413 	 * - Drivers must not consult @allow_modeset in the atomic commit path.
414 	 *   Use drm_atomic_crtc_needs_modeset() instead.
415 	 *
416 	 * - Drivers must consult @allow_modeset before adding unrelated struct
417 	 *   drm_crtc_state to this commit by calling
418 	 *   drm_atomic_get_crtc_state(). See also the warning in the
419 	 *   documentation for that function.
420 	 *
421 	 * - Drivers must never change this flag, it is under the exclusive
422 	 *   control of userspace.
423 	 *
424 	 * - Drivers may consult @allow_modeset in the atomic check path, if
425 	 *   they have the choice between an optimal hardware configuration
426 	 *   which requires a modeset, and a less optimal configuration which
427 	 *   can be committed without a modeset. An example would be suboptimal
428 	 *   scanout FIFO allocation resulting in increased idle power
429 	 *   consumption. This allows userspace to avoid flickering and delays
430 	 *   for the normal composition loop at reasonable cost.
431 	 */
432 	bool allow_modeset : 1;
433 	/**
434 	 * @legacy_cursor_update:
435 	 *
436 	 * Hint to enforce legacy cursor IOCTL semantics.
437 	 *
438 	 * WARNING: This is thoroughly broken and pretty much impossible to
439 	 * implement correctly. Drivers must ignore this and should instead
440 	 * implement &drm_plane_helper_funcs.atomic_async_check and
441 	 * &drm_plane_helper_funcs.atomic_async_commit hooks. New users of this
442 	 * flag are not allowed.
443 	 */
444 	bool legacy_cursor_update : 1;
445 
446 	/**
447 	 * @async_update: hint for asynchronous plane update
448 	 */
449 	bool async_update : 1;
450 
451 	/**
452 	 * @duplicated:
453 	 *
454 	 * Indicates whether or not this atomic state was duplicated using
455 	 * drm_atomic_helper_duplicate_state(). Drivers and atomic helpers
456 	 * should use this to fixup normal  inconsistencies in duplicated
457 	 * states.
458 	 */
459 	bool duplicated : 1;
460 
461 	/**
462 	 * @planes:
463 	 *
464 	 * Pointer to array of @drm_plane and @drm_plane_state part of this
465 	 * update.
466 	 */
467 	struct __drm_planes_state *planes;
468 
469 	/**
470 	 * @crtcs:
471 	 *
472 	 * Pointer to array of @drm_crtc and @drm_crtc_state part of this
473 	 * update.
474 	 */
475 	struct __drm_crtcs_state *crtcs;
476 
477 	/**
478 	 * @num_connector: size of the @connectors array
479 	 */
480 	int num_connector;
481 
482 	/**
483 	 * @connectors:
484 	 *
485 	 * Pointer to array of @drm_connector and @drm_connector_state part of
486 	 * this update.
487 	 */
488 	struct __drm_connnectors_state *connectors;
489 
490 	/**
491 	 * @num_private_objs: size of the @private_objs array
492 	 */
493 	int num_private_objs;
494 
495 	/**
496 	 * @private_objs:
497 	 *
498 	 * Pointer to array of @drm_private_obj and @drm_private_obj_state part
499 	 * of this update.
500 	 */
501 	struct __drm_private_objs_state *private_objs;
502 
503 	/**
504 	 * @acquire_ctx: acquire context for this atomic modeset state update
505 	 */
506 	struct drm_modeset_acquire_ctx *acquire_ctx;
507 
508 	/**
509 	 * @fake_commit:
510 	 *
511 	 * Used for signaling unbound planes/connectors.
512 	 * When a connector or plane is not bound to any CRTC, it's still important
513 	 * to preserve linearity to prevent the atomic states from being freed too early.
514 	 *
515 	 * This commit (if set) is not bound to any CRTC, but will be completed when
516 	 * drm_atomic_helper_commit_hw_done() is called.
517 	 */
518 	struct drm_crtc_commit *fake_commit;
519 
520 	/**
521 	 * @commit_work:
522 	 *
523 	 * Work item which can be used by the driver or helpers to execute the
524 	 * commit without blocking.
525 	 */
526 	struct work_struct commit_work;
527 };
528 
529 void __drm_crtc_commit_free(struct kref *kref);
530 
531 /**
532  * drm_crtc_commit_get - acquire a reference to the CRTC commit
533  * @commit: CRTC commit
534  *
535  * Increases the reference of @commit.
536  *
537  * Returns:
538  * The pointer to @commit, with reference increased.
539  */
drm_crtc_commit_get(struct drm_crtc_commit * commit)540 static inline struct drm_crtc_commit *drm_crtc_commit_get(struct drm_crtc_commit *commit)
541 {
542 	kref_get(&commit->ref);
543 	return commit;
544 }
545 
546 /**
547  * drm_crtc_commit_put - release a reference to the CRTC commmit
548  * @commit: CRTC commit
549  *
550  * This releases a reference to @commit which is freed after removing the
551  * final reference. No locking required and callable from any context.
552  */
drm_crtc_commit_put(struct drm_crtc_commit * commit)553 static inline void drm_crtc_commit_put(struct drm_crtc_commit *commit)
554 {
555 	kref_put(&commit->ref, __drm_crtc_commit_free);
556 }
557 
558 int drm_crtc_commit_wait(struct drm_crtc_commit *commit);
559 
560 struct drm_atomic_state * __must_check
561 drm_atomic_state_alloc(struct drm_device *dev);
562 void drm_atomic_state_clear(struct drm_atomic_state *state);
563 
564 /**
565  * drm_atomic_state_get - acquire a reference to the atomic state
566  * @state: The atomic state
567  *
568  * Returns a new reference to the @state
569  */
570 static inline struct drm_atomic_state *
drm_atomic_state_get(struct drm_atomic_state * state)571 drm_atomic_state_get(struct drm_atomic_state *state)
572 {
573 	kref_get(&state->ref);
574 	return state;
575 }
576 
577 void __drm_atomic_state_free(struct kref *ref);
578 
579 /**
580  * drm_atomic_state_put - release a reference to the atomic state
581  * @state: The atomic state
582  *
583  * This releases a reference to @state which is freed after removing the
584  * final reference. No locking required and callable from any context.
585  */
drm_atomic_state_put(struct drm_atomic_state * state)586 static inline void drm_atomic_state_put(struct drm_atomic_state *state)
587 {
588 	kref_put(&state->ref, __drm_atomic_state_free);
589 }
590 
591 int  __must_check
592 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state);
593 void drm_atomic_state_default_clear(struct drm_atomic_state *state);
594 void drm_atomic_state_default_release(struct drm_atomic_state *state);
595 
596 struct drm_crtc_state * __must_check
597 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
598 			  struct drm_crtc *crtc);
599 struct drm_plane_state * __must_check
600 drm_atomic_get_plane_state(struct drm_atomic_state *state,
601 			   struct drm_plane *plane);
602 struct drm_connector_state * __must_check
603 drm_atomic_get_connector_state(struct drm_atomic_state *state,
604 			       struct drm_connector *connector);
605 
606 void drm_atomic_private_obj_init(struct drm_device *dev,
607 				 struct drm_private_obj *obj,
608 				 struct drm_private_state *state,
609 				 const struct drm_private_state_funcs *funcs);
610 void drm_atomic_private_obj_fini(struct drm_private_obj *obj);
611 
612 struct drm_private_state * __must_check
613 drm_atomic_get_private_obj_state(struct drm_atomic_state *state,
614 				 struct drm_private_obj *obj);
615 struct drm_private_state *
616 drm_atomic_get_old_private_obj_state(const struct drm_atomic_state *state,
617 				     struct drm_private_obj *obj);
618 struct drm_private_state *
619 drm_atomic_get_new_private_obj_state(const struct drm_atomic_state *state,
620 				     struct drm_private_obj *obj);
621 
622 struct drm_connector *
623 drm_atomic_get_old_connector_for_encoder(const struct drm_atomic_state *state,
624 					 struct drm_encoder *encoder);
625 struct drm_connector *
626 drm_atomic_get_new_connector_for_encoder(const struct drm_atomic_state *state,
627 					 struct drm_encoder *encoder);
628 
629 struct drm_crtc *
630 drm_atomic_get_old_crtc_for_encoder(struct drm_atomic_state *state,
631 					 struct drm_encoder *encoder);
632 struct drm_crtc *
633 drm_atomic_get_new_crtc_for_encoder(struct drm_atomic_state *state,
634 					 struct drm_encoder *encoder);
635 
636 /**
637  * drm_atomic_get_existing_crtc_state - get CRTC state, if it exists
638  * @state: global atomic state object
639  * @crtc: CRTC to grab
640  *
641  * This function returns the CRTC state for the given CRTC, or NULL
642  * if the CRTC is not part of the global atomic state.
643  *
644  * This function is deprecated, @drm_atomic_get_old_crtc_state or
645  * @drm_atomic_get_new_crtc_state should be used instead.
646  */
647 static inline struct drm_crtc_state *
drm_atomic_get_existing_crtc_state(const struct drm_atomic_state * state,struct drm_crtc * crtc)648 drm_atomic_get_existing_crtc_state(const struct drm_atomic_state *state,
649 				   struct drm_crtc *crtc)
650 {
651 	return state->crtcs[drm_crtc_index(crtc)].state;
652 }
653 
654 /**
655  * drm_atomic_get_old_crtc_state - get old CRTC state, if it exists
656  * @state: global atomic state object
657  * @crtc: CRTC to grab
658  *
659  * This function returns the old CRTC state for the given CRTC, or
660  * NULL if the CRTC is not part of the global atomic state.
661  */
662 static inline struct drm_crtc_state *
drm_atomic_get_old_crtc_state(const struct drm_atomic_state * state,struct drm_crtc * crtc)663 drm_atomic_get_old_crtc_state(const struct drm_atomic_state *state,
664 			      struct drm_crtc *crtc)
665 {
666 	return state->crtcs[drm_crtc_index(crtc)].old_state;
667 }
668 /**
669  * drm_atomic_get_new_crtc_state - get new CRTC state, if it exists
670  * @state: global atomic state object
671  * @crtc: CRTC to grab
672  *
673  * This function returns the new CRTC state for the given CRTC, or
674  * NULL if the CRTC is not part of the global atomic state.
675  */
676 static inline struct drm_crtc_state *
drm_atomic_get_new_crtc_state(const struct drm_atomic_state * state,struct drm_crtc * crtc)677 drm_atomic_get_new_crtc_state(const struct drm_atomic_state *state,
678 			      struct drm_crtc *crtc)
679 {
680 	return state->crtcs[drm_crtc_index(crtc)].new_state;
681 }
682 
683 /**
684  * drm_atomic_get_existing_plane_state - get plane state, if it exists
685  * @state: global atomic state object
686  * @plane: plane to grab
687  *
688  * This function returns the plane state for the given plane, or NULL
689  * if the plane is not part of the global atomic state.
690  *
691  * This function is deprecated, @drm_atomic_get_old_plane_state or
692  * @drm_atomic_get_new_plane_state should be used instead.
693  */
694 static inline struct drm_plane_state *
drm_atomic_get_existing_plane_state(const struct drm_atomic_state * state,struct drm_plane * plane)695 drm_atomic_get_existing_plane_state(const struct drm_atomic_state *state,
696 				    struct drm_plane *plane)
697 {
698 	return state->planes[drm_plane_index(plane)].state;
699 }
700 
701 /**
702  * drm_atomic_get_old_plane_state - get plane state, if it exists
703  * @state: global atomic state object
704  * @plane: plane to grab
705  *
706  * This function returns the old plane state for the given plane, or
707  * NULL if the plane is not part of the global atomic state.
708  */
709 static inline struct drm_plane_state *
drm_atomic_get_old_plane_state(const struct drm_atomic_state * state,struct drm_plane * plane)710 drm_atomic_get_old_plane_state(const struct drm_atomic_state *state,
711 			       struct drm_plane *plane)
712 {
713 	return state->planes[drm_plane_index(plane)].old_state;
714 }
715 
716 /**
717  * drm_atomic_get_new_plane_state - get plane state, if it exists
718  * @state: global atomic state object
719  * @plane: plane to grab
720  *
721  * This function returns the new plane state for the given plane, or
722  * NULL if the plane is not part of the global atomic state.
723  */
724 static inline struct drm_plane_state *
drm_atomic_get_new_plane_state(const struct drm_atomic_state * state,struct drm_plane * plane)725 drm_atomic_get_new_plane_state(const struct drm_atomic_state *state,
726 			       struct drm_plane *plane)
727 {
728 	return state->planes[drm_plane_index(plane)].new_state;
729 }
730 
731 /**
732  * drm_atomic_get_existing_connector_state - get connector state, if it exists
733  * @state: global atomic state object
734  * @connector: connector to grab
735  *
736  * This function returns the connector state for the given connector,
737  * or NULL if the connector is not part of the global atomic state.
738  *
739  * This function is deprecated, @drm_atomic_get_old_connector_state or
740  * @drm_atomic_get_new_connector_state should be used instead.
741  */
742 static inline struct drm_connector_state *
drm_atomic_get_existing_connector_state(const struct drm_atomic_state * state,struct drm_connector * connector)743 drm_atomic_get_existing_connector_state(const struct drm_atomic_state *state,
744 					struct drm_connector *connector)
745 {
746 	int index = drm_connector_index(connector);
747 
748 	if (index >= state->num_connector)
749 		return NULL;
750 
751 	return state->connectors[index].state;
752 }
753 
754 /**
755  * drm_atomic_get_old_connector_state - get connector state, if it exists
756  * @state: global atomic state object
757  * @connector: connector to grab
758  *
759  * This function returns the old connector state for the given connector,
760  * or NULL if the connector is not part of the global atomic state.
761  */
762 static inline struct drm_connector_state *
drm_atomic_get_old_connector_state(const struct drm_atomic_state * state,struct drm_connector * connector)763 drm_atomic_get_old_connector_state(const struct drm_atomic_state *state,
764 				   struct drm_connector *connector)
765 {
766 	int index = drm_connector_index(connector);
767 
768 	if (index >= state->num_connector)
769 		return NULL;
770 
771 	return state->connectors[index].old_state;
772 }
773 
774 /**
775  * drm_atomic_get_new_connector_state - get connector state, if it exists
776  * @state: global atomic state object
777  * @connector: connector to grab
778  *
779  * This function returns the new connector state for the given connector,
780  * or NULL if the connector is not part of the global atomic state.
781  */
782 static inline struct drm_connector_state *
drm_atomic_get_new_connector_state(const struct drm_atomic_state * state,struct drm_connector * connector)783 drm_atomic_get_new_connector_state(const struct drm_atomic_state *state,
784 				   struct drm_connector *connector)
785 {
786 	int index = drm_connector_index(connector);
787 
788 	if (index >= state->num_connector)
789 		return NULL;
790 
791 	return state->connectors[index].new_state;
792 }
793 
794 /**
795  * __drm_atomic_get_current_plane_state - get current plane state
796  * @state: global atomic state object
797  * @plane: plane to grab
798  *
799  * This function returns the plane state for the given plane, either from
800  * @state, or if the plane isn't part of the atomic state update, from @plane.
801  * This is useful in atomic check callbacks, when drivers need to peek at, but
802  * not change, state of other planes, since it avoids threading an error code
803  * back up the call chain.
804  *
805  * WARNING:
806  *
807  * Note that this function is in general unsafe since it doesn't check for the
808  * required locking for access state structures. Drivers must ensure that it is
809  * safe to access the returned state structure through other means. One common
810  * example is when planes are fixed to a single CRTC, and the driver knows that
811  * the CRTC lock is held already. In that case holding the CRTC lock gives a
812  * read-lock on all planes connected to that CRTC. But if planes can be
813  * reassigned things get more tricky. In that case it's better to use
814  * drm_atomic_get_plane_state and wire up full error handling.
815  *
816  * Returns:
817  *
818  * Read-only pointer to the current plane state.
819  */
820 static inline const struct drm_plane_state *
__drm_atomic_get_current_plane_state(const struct drm_atomic_state * state,struct drm_plane * plane)821 __drm_atomic_get_current_plane_state(const struct drm_atomic_state *state,
822 				     struct drm_plane *plane)
823 {
824 	if (state->planes[drm_plane_index(plane)].state)
825 		return state->planes[drm_plane_index(plane)].state;
826 
827 	return plane->state;
828 }
829 
830 int __must_check
831 drm_atomic_add_encoder_bridges(struct drm_atomic_state *state,
832 			       struct drm_encoder *encoder);
833 int __must_check
834 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
835 				   struct drm_crtc *crtc);
836 int __must_check
837 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
838 			       struct drm_crtc *crtc);
839 
840 int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
841 int __must_check drm_atomic_commit(struct drm_atomic_state *state);
842 int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state);
843 
844 void drm_state_dump(struct drm_device *dev, struct drm_printer *p);
845 
846 /**
847  * for_each_oldnew_connector_in_state - iterate over all connectors in an atomic update
848  * @__state: &struct drm_atomic_state pointer
849  * @connector: &struct drm_connector iteration cursor
850  * @old_connector_state: &struct drm_connector_state iteration cursor for the
851  * 	old state
852  * @new_connector_state: &struct drm_connector_state iteration cursor for the
853  * 	new state
854  * @__i: int iteration cursor, for macro-internal use
855  *
856  * This iterates over all connectors in an atomic update, tracking both old and
857  * new state. This is useful in places where the state delta needs to be
858  * considered, for example in atomic check functions.
859  */
860 #define for_each_oldnew_connector_in_state(__state, connector, old_connector_state, new_connector_state, __i) \
861 	for ((__i) = 0;								\
862 	     (__i) < (__state)->num_connector;					\
863 	     (__i)++)								\
864 		for_each_if ((__state)->connectors[__i].ptr &&			\
865 			     ((connector) = (__state)->connectors[__i].ptr,	\
866 			     (void)(connector) /* Only to avoid unused-but-set-variable warning */, \
867 			     (old_connector_state) = (__state)->connectors[__i].old_state,	\
868 			     (new_connector_state) = (__state)->connectors[__i].new_state, 1))
869 
870 /**
871  * for_each_old_connector_in_state - iterate over all connectors in an atomic update
872  * @__state: &struct drm_atomic_state pointer
873  * @connector: &struct drm_connector iteration cursor
874  * @old_connector_state: &struct drm_connector_state iteration cursor for the
875  * 	old state
876  * @__i: int iteration cursor, for macro-internal use
877  *
878  * This iterates over all connectors in an atomic update, tracking only the old
879  * state. This is useful in disable functions, where we need the old state the
880  * hardware is still in.
881  */
882 #define for_each_old_connector_in_state(__state, connector, old_connector_state, __i) \
883 	for ((__i) = 0;								\
884 	     (__i) < (__state)->num_connector;					\
885 	     (__i)++)								\
886 		for_each_if ((__state)->connectors[__i].ptr &&			\
887 			     ((connector) = (__state)->connectors[__i].ptr,	\
888 			     (void)(connector) /* Only to avoid unused-but-set-variable warning */, \
889 			     (old_connector_state) = (__state)->connectors[__i].old_state, 1))
890 
891 /**
892  * for_each_new_connector_in_state - iterate over all connectors in an atomic update
893  * @__state: &struct drm_atomic_state pointer
894  * @connector: &struct drm_connector iteration cursor
895  * @new_connector_state: &struct drm_connector_state iteration cursor for the
896  * 	new state
897  * @__i: int iteration cursor, for macro-internal use
898  *
899  * This iterates over all connectors in an atomic update, tracking only the new
900  * state. This is useful in enable functions, where we need the new state the
901  * hardware should be in when the atomic commit operation has completed.
902  */
903 #define for_each_new_connector_in_state(__state, connector, new_connector_state, __i) \
904 	for ((__i) = 0;								\
905 	     (__i) < (__state)->num_connector;					\
906 	     (__i)++)								\
907 		for_each_if ((__state)->connectors[__i].ptr &&			\
908 			     ((connector) = (__state)->connectors[__i].ptr,	\
909 			     (void)(connector) /* Only to avoid unused-but-set-variable warning */, \
910 			     (new_connector_state) = (__state)->connectors[__i].new_state, \
911 			     (void)(new_connector_state) /* Only to avoid unused-but-set-variable warning */, 1))
912 
913 /**
914  * for_each_oldnew_crtc_in_state - iterate over all CRTCs in an atomic update
915  * @__state: &struct drm_atomic_state pointer
916  * @crtc: &struct drm_crtc iteration cursor
917  * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
918  * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
919  * @__i: int iteration cursor, for macro-internal use
920  *
921  * This iterates over all CRTCs in an atomic update, tracking both old and
922  * new state. This is useful in places where the state delta needs to be
923  * considered, for example in atomic check functions.
924  */
925 #define for_each_oldnew_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \
926 	for ((__i) = 0;							\
927 	     (__i) < (__state)->dev->mode_config.num_crtc;		\
928 	     (__i)++)							\
929 		for_each_if ((__state)->crtcs[__i].ptr &&		\
930 			     ((crtc) = (__state)->crtcs[__i].ptr,	\
931 			      (void)(crtc) /* Only to avoid unused-but-set-variable warning */, \
932 			     (old_crtc_state) = (__state)->crtcs[__i].old_state, \
933 			     (void)(old_crtc_state) /* Only to avoid unused-but-set-variable warning */, \
934 			     (new_crtc_state) = (__state)->crtcs[__i].new_state, \
935 			     (void)(new_crtc_state) /* Only to avoid unused-but-set-variable warning */, 1))
936 
937 /**
938  * for_each_old_crtc_in_state - iterate over all CRTCs in an atomic update
939  * @__state: &struct drm_atomic_state pointer
940  * @crtc: &struct drm_crtc iteration cursor
941  * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
942  * @__i: int iteration cursor, for macro-internal use
943  *
944  * This iterates over all CRTCs in an atomic update, tracking only the old
945  * state. This is useful in disable functions, where we need the old state the
946  * hardware is still in.
947  */
948 #define for_each_old_crtc_in_state(__state, crtc, old_crtc_state, __i)	\
949 	for ((__i) = 0;							\
950 	     (__i) < (__state)->dev->mode_config.num_crtc;		\
951 	     (__i)++)							\
952 		for_each_if ((__state)->crtcs[__i].ptr &&		\
953 			     ((crtc) = (__state)->crtcs[__i].ptr,	\
954 			     (void)(crtc) /* Only to avoid unused-but-set-variable warning */, \
955 			     (old_crtc_state) = (__state)->crtcs[__i].old_state, 1))
956 
957 /**
958  * for_each_new_crtc_in_state - iterate over all CRTCs in an atomic update
959  * @__state: &struct drm_atomic_state pointer
960  * @crtc: &struct drm_crtc iteration cursor
961  * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
962  * @__i: int iteration cursor, for macro-internal use
963  *
964  * This iterates over all CRTCs in an atomic update, tracking only the new
965  * state. This is useful in enable functions, where we need the new state the
966  * hardware should be in when the atomic commit operation has completed.
967  */
968 #define for_each_new_crtc_in_state(__state, crtc, new_crtc_state, __i)	\
969 	for ((__i) = 0;							\
970 	     (__i) < (__state)->dev->mode_config.num_crtc;		\
971 	     (__i)++)							\
972 		for_each_if ((__state)->crtcs[__i].ptr &&		\
973 			     ((crtc) = (__state)->crtcs[__i].ptr,	\
974 			     (void)(crtc) /* Only to avoid unused-but-set-variable warning */, \
975 			     (new_crtc_state) = (__state)->crtcs[__i].new_state, \
976 			     (void)(new_crtc_state) /* Only to avoid unused-but-set-variable warning */, 1))
977 
978 /**
979  * for_each_oldnew_plane_in_state - iterate over all planes in an atomic update
980  * @__state: &struct drm_atomic_state pointer
981  * @plane: &struct drm_plane iteration cursor
982  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
983  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
984  * @__i: int iteration cursor, for macro-internal use
985  *
986  * This iterates over all planes in an atomic update, tracking both old and
987  * new state. This is useful in places where the state delta needs to be
988  * considered, for example in atomic check functions.
989  */
990 #define for_each_oldnew_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \
991 	for ((__i) = 0;							\
992 	     (__i) < (__state)->dev->mode_config.num_total_plane;	\
993 	     (__i)++)							\
994 		for_each_if ((__state)->planes[__i].ptr &&		\
995 			     ((plane) = (__state)->planes[__i].ptr,	\
996 			      (void)(plane) /* Only to avoid unused-but-set-variable warning */, \
997 			      (old_plane_state) = (__state)->planes[__i].old_state,\
998 			      (new_plane_state) = (__state)->planes[__i].new_state, 1))
999 
1000 /**
1001  * for_each_oldnew_plane_in_state_reverse - iterate over all planes in an atomic
1002  * update in reverse order
1003  * @__state: &struct drm_atomic_state pointer
1004  * @plane: &struct drm_plane iteration cursor
1005  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
1006  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
1007  * @__i: int iteration cursor, for macro-internal use
1008  *
1009  * This iterates over all planes in an atomic update in reverse order,
1010  * tracking both old and  new state. This is useful in places where the
1011  * state delta needs to be considered, for example in atomic check functions.
1012  */
1013 #define for_each_oldnew_plane_in_state_reverse(__state, plane, old_plane_state, new_plane_state, __i) \
1014 	for ((__i) = ((__state)->dev->mode_config.num_total_plane - 1);	\
1015 	     (__i) >= 0;						\
1016 	     (__i)--)							\
1017 		for_each_if ((__state)->planes[__i].ptr &&		\
1018 			     ((plane) = (__state)->planes[__i].ptr,	\
1019 			      (old_plane_state) = (__state)->planes[__i].old_state,\
1020 			      (new_plane_state) = (__state)->planes[__i].new_state, 1))
1021 
1022 /**
1023  * for_each_new_plane_in_state_reverse - other than only tracking new state,
1024  * it's the same as for_each_oldnew_plane_in_state_reverse
1025  * @__state: &struct drm_atomic_state pointer
1026  * @plane: &struct drm_plane iteration cursor
1027  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
1028  * @__i: int iteration cursor, for macro-internal use
1029  */
1030 #define for_each_new_plane_in_state_reverse(__state, plane, new_plane_state, __i) \
1031 	for ((__i) = ((__state)->dev->mode_config.num_total_plane - 1);	\
1032 	     (__i) >= 0;						\
1033 	     (__i)--)							\
1034 		for_each_if ((__state)->planes[__i].ptr &&		\
1035 			     ((plane) = (__state)->planes[__i].ptr,	\
1036 			      (new_plane_state) = (__state)->planes[__i].new_state, 1))
1037 
1038 /**
1039  * for_each_old_plane_in_state - iterate over all planes in an atomic update
1040  * @__state: &struct drm_atomic_state pointer
1041  * @plane: &struct drm_plane iteration cursor
1042  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
1043  * @__i: int iteration cursor, for macro-internal use
1044  *
1045  * This iterates over all planes in an atomic update, tracking only the old
1046  * state. This is useful in disable functions, where we need the old state the
1047  * hardware is still in.
1048  */
1049 #define for_each_old_plane_in_state(__state, plane, old_plane_state, __i) \
1050 	for ((__i) = 0;							\
1051 	     (__i) < (__state)->dev->mode_config.num_total_plane;	\
1052 	     (__i)++)							\
1053 		for_each_if ((__state)->planes[__i].ptr &&		\
1054 			     ((plane) = (__state)->planes[__i].ptr,	\
1055 			      (old_plane_state) = (__state)->planes[__i].old_state, 1))
1056 /**
1057  * for_each_new_plane_in_state - iterate over all planes in an atomic update
1058  * @__state: &struct drm_atomic_state pointer
1059  * @plane: &struct drm_plane iteration cursor
1060  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
1061  * @__i: int iteration cursor, for macro-internal use
1062  *
1063  * This iterates over all planes in an atomic update, tracking only the new
1064  * state. This is useful in enable functions, where we need the new state the
1065  * hardware should be in when the atomic commit operation has completed.
1066  */
1067 #define for_each_new_plane_in_state(__state, plane, new_plane_state, __i) \
1068 	for ((__i) = 0;							\
1069 	     (__i) < (__state)->dev->mode_config.num_total_plane;	\
1070 	     (__i)++)							\
1071 		for_each_if ((__state)->planes[__i].ptr &&		\
1072 			     ((plane) = (__state)->planes[__i].ptr,	\
1073 			      (void)(plane) /* Only to avoid unused-but-set-variable warning */, \
1074 			      (new_plane_state) = (__state)->planes[__i].new_state, \
1075 			      (void)(new_plane_state) /* Only to avoid unused-but-set-variable warning */, 1))
1076 
1077 /**
1078  * for_each_oldnew_private_obj_in_state - iterate over all private objects in an atomic update
1079  * @__state: &struct drm_atomic_state pointer
1080  * @obj: &struct drm_private_obj iteration cursor
1081  * @old_obj_state: &struct drm_private_state iteration cursor for the old state
1082  * @new_obj_state: &struct drm_private_state iteration cursor for the new state
1083  * @__i: int iteration cursor, for macro-internal use
1084  *
1085  * This iterates over all private objects in an atomic update, tracking both
1086  * old and new state. This is useful in places where the state delta needs
1087  * to be considered, for example in atomic check functions.
1088  */
1089 #define for_each_oldnew_private_obj_in_state(__state, obj, old_obj_state, new_obj_state, __i) \
1090 	for ((__i) = 0; \
1091 	     (__i) < (__state)->num_private_objs && \
1092 		     ((obj) = (__state)->private_objs[__i].ptr, \
1093 		      (old_obj_state) = (__state)->private_objs[__i].old_state,	\
1094 		      (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
1095 	     (__i)++)
1096 
1097 /**
1098  * for_each_old_private_obj_in_state - iterate over all private objects in an atomic update
1099  * @__state: &struct drm_atomic_state pointer
1100  * @obj: &struct drm_private_obj iteration cursor
1101  * @old_obj_state: &struct drm_private_state iteration cursor for the old state
1102  * @__i: int iteration cursor, for macro-internal use
1103  *
1104  * This iterates over all private objects in an atomic update, tracking only
1105  * the old state. This is useful in disable functions, where we need the old
1106  * state the hardware is still in.
1107  */
1108 #define for_each_old_private_obj_in_state(__state, obj, old_obj_state, __i) \
1109 	for ((__i) = 0; \
1110 	     (__i) < (__state)->num_private_objs && \
1111 		     ((obj) = (__state)->private_objs[__i].ptr, \
1112 		      (old_obj_state) = (__state)->private_objs[__i].old_state, 1); \
1113 	     (__i)++)
1114 
1115 /**
1116  * for_each_new_private_obj_in_state - iterate over all private objects in an atomic update
1117  * @__state: &struct drm_atomic_state pointer
1118  * @obj: &struct drm_private_obj iteration cursor
1119  * @new_obj_state: &struct drm_private_state iteration cursor for the new state
1120  * @__i: int iteration cursor, for macro-internal use
1121  *
1122  * This iterates over all private objects in an atomic update, tracking only
1123  * the new state. This is useful in enable functions, where we need the new state the
1124  * hardware should be in when the atomic commit operation has completed.
1125  */
1126 #define for_each_new_private_obj_in_state(__state, obj, new_obj_state, __i) \
1127 	for ((__i) = 0; \
1128 	     (__i) < (__state)->num_private_objs && \
1129 		     ((obj) = (__state)->private_objs[__i].ptr, \
1130 		      (void)(obj) /* Only to avoid unused-but-set-variable warning */, \
1131 		      (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
1132 	     (__i)++)
1133 
1134 /**
1135  * drm_atomic_crtc_needs_modeset - compute combined modeset need
1136  * @state: &drm_crtc_state for the CRTC
1137  *
1138  * To give drivers flexibility &struct drm_crtc_state has 3 booleans to track
1139  * whether the state CRTC changed enough to need a full modeset cycle:
1140  * mode_changed, active_changed and connectors_changed. This helper simply
1141  * combines these three to compute the overall need for a modeset for @state.
1142  *
1143  * The atomic helper code sets these booleans, but drivers can and should
1144  * change them appropriately to accurately represent whether a modeset is
1145  * really needed. In general, drivers should avoid full modesets whenever
1146  * possible.
1147  *
1148  * For example if the CRTC mode has changed, and the hardware is able to enact
1149  * the requested mode change without going through a full modeset, the driver
1150  * should clear mode_changed in its &drm_mode_config_funcs.atomic_check
1151  * implementation.
1152  */
1153 static inline bool
drm_atomic_crtc_needs_modeset(const struct drm_crtc_state * state)1154 drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state)
1155 {
1156 	return state->mode_changed || state->active_changed ||
1157 	       state->connectors_changed;
1158 }
1159 
1160 /**
1161  * drm_atomic_crtc_effectively_active - compute whether CRTC is actually active
1162  * @state: &drm_crtc_state for the CRTC
1163  *
1164  * When in self refresh mode, the crtc_state->active value will be false, since
1165  * the CRTC is off. However in some cases we're interested in whether the CRTC
1166  * is active, or effectively active (ie: it's connected to an active display).
1167  * In these cases, use this function instead of just checking active.
1168  */
1169 static inline bool
drm_atomic_crtc_effectively_active(const struct drm_crtc_state * state)1170 drm_atomic_crtc_effectively_active(const struct drm_crtc_state *state)
1171 {
1172 	return state->active || state->self_refresh_active;
1173 }
1174 
1175 /**
1176  * struct drm_bus_cfg - bus configuration
1177  *
1178  * This structure stores the configuration of a physical bus between two
1179  * components in an output pipeline, usually between two bridges, an encoder
1180  * and a bridge, or a bridge and a connector.
1181  *
1182  * The bus configuration is stored in &drm_bridge_state separately for the
1183  * input and output buses, as seen from the point of view of each bridge. The
1184  * bus configuration of a bridge output is usually identical to the
1185  * configuration of the next bridge's input, but may differ if the signals are
1186  * modified between the two bridges, for instance by an inverter on the board.
1187  * The input and output configurations of a bridge may differ if the bridge
1188  * modifies the signals internally, for instance by performing format
1189  * conversion, or modifying signals polarities.
1190  */
1191 struct drm_bus_cfg {
1192 	/**
1193 	 * @format: format used on this bus (one of the MEDIA_BUS_FMT_* format)
1194 	 *
1195 	 * This field should not be directly modified by drivers
1196 	 * (drm_atomic_bridge_chain_select_bus_fmts() takes care of the bus
1197 	 * format negotiation).
1198 	 */
1199 	u32 format;
1200 
1201 	/**
1202 	 * @flags: DRM_BUS_* flags used on this bus
1203 	 */
1204 	u32 flags;
1205 };
1206 
1207 /**
1208  * struct drm_bridge_state - Atomic bridge state object
1209  */
1210 struct drm_bridge_state {
1211 	/**
1212 	 * @base: inherit from &drm_private_state
1213 	 */
1214 	struct drm_private_state base;
1215 
1216 	/**
1217 	 * @bridge: the bridge this state refers to
1218 	 */
1219 	struct drm_bridge *bridge;
1220 
1221 	/**
1222 	 * @input_bus_cfg: input bus configuration
1223 	 */
1224 	struct drm_bus_cfg input_bus_cfg;
1225 
1226 	/**
1227 	 * @output_bus_cfg: output bus configuration
1228 	 */
1229 	struct drm_bus_cfg output_bus_cfg;
1230 };
1231 
1232 static inline struct drm_bridge_state *
drm_priv_to_bridge_state(struct drm_private_state * priv)1233 drm_priv_to_bridge_state(struct drm_private_state *priv)
1234 {
1235 	return container_of(priv, struct drm_bridge_state, base);
1236 }
1237 
1238 struct drm_bridge_state *
1239 drm_atomic_get_bridge_state(struct drm_atomic_state *state,
1240 			    struct drm_bridge *bridge);
1241 struct drm_bridge_state *
1242 drm_atomic_get_old_bridge_state(const struct drm_atomic_state *state,
1243 				struct drm_bridge *bridge);
1244 struct drm_bridge_state *
1245 drm_atomic_get_new_bridge_state(const struct drm_atomic_state *state,
1246 				struct drm_bridge *bridge);
1247 
1248 #endif /* DRM_ATOMIC_H_ */
1249