Loading...
Note: File does not exist in v3.1.
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 */
70struct drm_crtc_commit {
71 /**
72 * @crtc:
73 *
74 * DRM CRTC for this commit.
75 */
76 struct drm_crtc *crtc;
77
78 /**
79 * @ref:
80 *
81 * Reference count for this structure. Needed to allow blocking on
82 * completions without the risk of the completion disappearing
83 * meanwhile.
84 */
85 struct kref ref;
86
87 /**
88 * @flip_done:
89 *
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
94 * signalled.
95 */
96 struct completion flip_done;
97
98 /**
99 * @hw_done:
100 *
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
105 * I/O is required.
106 *
107 * Note that this does not need to include separately reference-counted
108 * resources like backing storage buffer pinning, or runtime pm
109 * management.
110 */
111 struct completion hw_done;
112
113 /**
114 * @cleanup_done:
115 *
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.
121 */
122 struct completion cleanup_done;
123
124 /**
125 * @commit_entry:
126 *
127 * Entry on the per-CRTC &drm_crtc.commit_list. Protected by
128 * $drm_crtc.commit_lock.
129 */
130 struct list_head commit_entry;
131
132 /**
133 * @event:
134 *
135 * &drm_pending_vblank_event pointer to clean up private events.
136 */
137 struct drm_pending_vblank_event *event;
138
139 /**
140 * @abort_completion:
141 *
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.
145 */
146 bool abort_completion;
147};
148
149struct __drm_planes_state {
150 struct drm_plane *ptr;
151 struct drm_plane_state *state, *old_state, *new_state;
152};
153
154struct __drm_crtcs_state {
155 struct drm_crtc *ptr;
156 struct drm_crtc_state *state, *old_state, *new_state;
157
158 /**
159 * @commit:
160 *
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.
165 */
166 struct drm_crtc_commit *commit;
167
168 s32 __user *out_fence_ptr;
169 u64 last_vblank_count;
170};
171
172struct __drm_connnectors_state {
173 struct drm_connector *ptr;
174 struct drm_connector_state *state, *old_state, *new_state;
175 /**
176 * @out_fence_ptr:
177 *
178 * User-provided pointer which the kernel uses to return a sync_file
179 * file descriptor. Used by writeback connectors to signal completion of
180 * the writeback.
181 */
182 s32 __user *out_fence_ptr;
183};
184
185struct drm_private_obj;
186struct drm_private_state;
187
188/**
189 * struct drm_private_state_funcs - atomic state functions for private objects
190 *
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().
197 */
198struct drm_private_state_funcs {
199 /**
200 * @atomic_duplicate_state:
201 *
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.
204 *
205 * RETURNS:
206 *
207 * Duplicated atomic state or NULL when obj->state is not
208 * initialized or allocation failed.
209 */
210 struct drm_private_state *(*atomic_duplicate_state)(struct drm_private_obj *obj);
211
212 /**
213 * @atomic_destroy_state:
214 *
215 * Frees the private object state created with @atomic_duplicate_state.
216 */
217 void (*atomic_destroy_state)(struct drm_private_obj *obj,
218 struct drm_private_state *state);
219};
220
221/**
222 * struct drm_private_obj - base struct for driver private atomic object
223 *
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().
227 *
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.
231 *
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:
237 *
238 * 1/ all calls to drm_atomic_private_obj_init() must be done before calling
239 * drm_dev_register()
240 * 2/ all calls to drm_atomic_private_obj_fini() must be done after calling
241 * drm_dev_unregister()
242 */
243struct drm_private_obj {
244 /**
245 * @head: List entry used to attach a private object to a &drm_device
246 * (queued to &drm_mode_config.privobj_list).
247 */
248 struct list_head head;
249
250 /**
251 * @lock: Modeset lock to protect the state object.
252 */
253 struct drm_modeset_lock lock;
254
255 /**
256 * @state: Current atomic state for this driver private object.
257 */
258 struct drm_private_state *state;
259
260 /**
261 * @funcs:
262 *
263 * Functions to manipulate the state of this driver private object, see
264 * &drm_private_state_funcs.
265 */
266 const struct drm_private_state_funcs *funcs;
267};
268
269/**
270 * drm_for_each_privobj() - private object iterator
271 *
272 * @privobj: pointer to the current private object. Updated after each
273 * iteration
274 * @dev: the DRM device we want get private objects from
275 *
276 * Allows one to iterate over all private objects attached to @dev
277 */
278#define drm_for_each_privobj(privobj, dev) \
279 list_for_each_entry(privobj, &(dev)->mode_config.privobj_list, head)
280
281/**
282 * struct drm_private_state - base struct for driver private object state
283 * @state: backpointer to global drm_atomic_state
284 *
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.
287 * &drm_crtc.commit.
288 */
289struct drm_private_state {
290 struct drm_atomic_state *state;
291};
292
293struct __drm_private_objs_state {
294 struct drm_private_obj *ptr;
295 struct drm_private_state *state, *old_state, *new_state;
296};
297
298/**
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
311 *
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().
315 */
316struct drm_atomic_state {
317 struct kref ref;
318
319 struct drm_device *dev;
320
321 /**
322 * @allow_modeset:
323 *
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().
328 */
329 bool allow_modeset : 1;
330 bool legacy_cursor_update : 1;
331 bool async_update : 1;
332 /**
333 * @duplicated:
334 *
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
338 * states.
339 */
340 bool duplicated : 1;
341 struct __drm_planes_state *planes;
342 struct __drm_crtcs_state *crtcs;
343 int num_connector;
344 struct __drm_connnectors_state *connectors;
345 int num_private_objs;
346 struct __drm_private_objs_state *private_objs;
347
348 struct drm_modeset_acquire_ctx *acquire_ctx;
349
350 /**
351 * @fake_commit:
352 *
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.
356 *
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.
359 */
360 struct drm_crtc_commit *fake_commit;
361
362 /**
363 * @commit_work:
364 *
365 * Work item which can be used by the driver or helpers to execute the
366 * commit without blocking.
367 */
368 struct work_struct commit_work;
369};
370
371void __drm_crtc_commit_free(struct kref *kref);
372
373/**
374 * drm_crtc_commit_get - acquire a reference to the CRTC commit
375 * @commit: CRTC commit
376 *
377 * Increases the reference of @commit.
378 *
379 * Returns:
380 * The pointer to @commit, with reference increased.
381 */
382static inline struct drm_crtc_commit *drm_crtc_commit_get(struct drm_crtc_commit *commit)
383{
384 kref_get(&commit->ref);
385 return commit;
386}
387
388/**
389 * drm_crtc_commit_put - release a reference to the CRTC commmit
390 * @commit: CRTC commit
391 *
392 * This releases a reference to @commit which is freed after removing the
393 * final reference. No locking required and callable from any context.
394 */
395static inline void drm_crtc_commit_put(struct drm_crtc_commit *commit)
396{
397 kref_put(&commit->ref, __drm_crtc_commit_free);
398}
399
400struct drm_atomic_state * __must_check
401drm_atomic_state_alloc(struct drm_device *dev);
402void drm_atomic_state_clear(struct drm_atomic_state *state);
403
404/**
405 * drm_atomic_state_get - acquire a reference to the atomic state
406 * @state: The atomic state
407 *
408 * Returns a new reference to the @state
409 */
410static inline struct drm_atomic_state *
411drm_atomic_state_get(struct drm_atomic_state *state)
412{
413 kref_get(&state->ref);
414 return state;
415}
416
417void __drm_atomic_state_free(struct kref *ref);
418
419/**
420 * drm_atomic_state_put - release a reference to the atomic state
421 * @state: The atomic state
422 *
423 * This releases a reference to @state which is freed after removing the
424 * final reference. No locking required and callable from any context.
425 */
426static inline void drm_atomic_state_put(struct drm_atomic_state *state)
427{
428 kref_put(&state->ref, __drm_atomic_state_free);
429}
430
431int __must_check
432drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state);
433void drm_atomic_state_default_clear(struct drm_atomic_state *state);
434void drm_atomic_state_default_release(struct drm_atomic_state *state);
435
436struct drm_crtc_state * __must_check
437drm_atomic_get_crtc_state(struct drm_atomic_state *state,
438 struct drm_crtc *crtc);
439struct drm_plane_state * __must_check
440drm_atomic_get_plane_state(struct drm_atomic_state *state,
441 struct drm_plane *plane);
442struct drm_connector_state * __must_check
443drm_atomic_get_connector_state(struct drm_atomic_state *state,
444 struct drm_connector *connector);
445
446void 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);
450void drm_atomic_private_obj_fini(struct drm_private_obj *obj);
451
452struct drm_private_state * __must_check
453drm_atomic_get_private_obj_state(struct drm_atomic_state *state,
454 struct drm_private_obj *obj);
455struct drm_private_state *
456drm_atomic_get_old_private_obj_state(struct drm_atomic_state *state,
457 struct drm_private_obj *obj);
458struct drm_private_state *
459drm_atomic_get_new_private_obj_state(struct drm_atomic_state *state,
460 struct drm_private_obj *obj);
461
462struct drm_connector *
463drm_atomic_get_old_connector_for_encoder(struct drm_atomic_state *state,
464 struct drm_encoder *encoder);
465struct drm_connector *
466drm_atomic_get_new_connector_for_encoder(struct drm_atomic_state *state,
467 struct drm_encoder *encoder);
468
469/**
470 * drm_atomic_get_existing_crtc_state - get crtc state, if it exists
471 * @state: global atomic state object
472 * @crtc: crtc to grab
473 *
474 * This function returns the crtc state for the given crtc, or NULL
475 * if the crtc is not part of the global atomic state.
476 *
477 * This function is deprecated, @drm_atomic_get_old_crtc_state or
478 * @drm_atomic_get_new_crtc_state should be used instead.
479 */
480static inline struct drm_crtc_state *
481drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state,
482 struct drm_crtc *crtc)
483{
484 return state->crtcs[drm_crtc_index(crtc)].state;
485}
486
487/**
488 * drm_atomic_get_old_crtc_state - get old crtc state, if it exists
489 * @state: global atomic state object
490 * @crtc: crtc to grab
491 *
492 * This function returns the old crtc state for the given crtc, or
493 * NULL if the crtc is not part of the global atomic state.
494 */
495static inline struct drm_crtc_state *
496drm_atomic_get_old_crtc_state(struct drm_atomic_state *state,
497 struct drm_crtc *crtc)
498{
499 return state->crtcs[drm_crtc_index(crtc)].old_state;
500}
501/**
502 * drm_atomic_get_new_crtc_state - get new crtc state, if it exists
503 * @state: global atomic state object
504 * @crtc: crtc to grab
505 *
506 * This function returns the new crtc state for the given crtc, or
507 * NULL if the crtc is not part of the global atomic state.
508 */
509static inline struct drm_crtc_state *
510drm_atomic_get_new_crtc_state(struct drm_atomic_state *state,
511 struct drm_crtc *crtc)
512{
513 return state->crtcs[drm_crtc_index(crtc)].new_state;
514}
515
516/**
517 * drm_atomic_get_existing_plane_state - get plane state, if it exists
518 * @state: global atomic state object
519 * @plane: plane to grab
520 *
521 * This function returns the plane state for the given plane, or NULL
522 * if the plane is not part of the global atomic state.
523 *
524 * This function is deprecated, @drm_atomic_get_old_plane_state or
525 * @drm_atomic_get_new_plane_state should be used instead.
526 */
527static inline struct drm_plane_state *
528drm_atomic_get_existing_plane_state(struct drm_atomic_state *state,
529 struct drm_plane *plane)
530{
531 return state->planes[drm_plane_index(plane)].state;
532}
533
534/**
535 * drm_atomic_get_old_plane_state - get plane state, if it exists
536 * @state: global atomic state object
537 * @plane: plane to grab
538 *
539 * This function returns the old plane state for the given plane, or
540 * NULL if the plane is not part of the global atomic state.
541 */
542static inline struct drm_plane_state *
543drm_atomic_get_old_plane_state(struct drm_atomic_state *state,
544 struct drm_plane *plane)
545{
546 return state->planes[drm_plane_index(plane)].old_state;
547}
548
549/**
550 * drm_atomic_get_new_plane_state - get plane state, if it exists
551 * @state: global atomic state object
552 * @plane: plane to grab
553 *
554 * This function returns the new plane state for the given plane, or
555 * NULL if the plane is not part of the global atomic state.
556 */
557static inline struct drm_plane_state *
558drm_atomic_get_new_plane_state(struct drm_atomic_state *state,
559 struct drm_plane *plane)
560{
561 return state->planes[drm_plane_index(plane)].new_state;
562}
563
564/**
565 * drm_atomic_get_existing_connector_state - get connector state, if it exists
566 * @state: global atomic state object
567 * @connector: connector to grab
568 *
569 * This function returns the connector state for the given connector,
570 * or NULL if the connector is not part of the global atomic state.
571 *
572 * This function is deprecated, @drm_atomic_get_old_connector_state or
573 * @drm_atomic_get_new_connector_state should be used instead.
574 */
575static inline struct drm_connector_state *
576drm_atomic_get_existing_connector_state(struct drm_atomic_state *state,
577 struct drm_connector *connector)
578{
579 int index = drm_connector_index(connector);
580
581 if (index >= state->num_connector)
582 return NULL;
583
584 return state->connectors[index].state;
585}
586
587/**
588 * drm_atomic_get_old_connector_state - get connector state, if it exists
589 * @state: global atomic state object
590 * @connector: connector to grab
591 *
592 * This function returns the old connector state for the given connector,
593 * or NULL if the connector is not part of the global atomic state.
594 */
595static inline struct drm_connector_state *
596drm_atomic_get_old_connector_state(struct drm_atomic_state *state,
597 struct drm_connector *connector)
598{
599 int index = drm_connector_index(connector);
600
601 if (index >= state->num_connector)
602 return NULL;
603
604 return state->connectors[index].old_state;
605}
606
607/**
608 * drm_atomic_get_new_connector_state - get connector state, if it exists
609 * @state: global atomic state object
610 * @connector: connector to grab
611 *
612 * This function returns the new connector state for the given connector,
613 * or NULL if the connector is not part of the global atomic state.
614 */
615static inline struct drm_connector_state *
616drm_atomic_get_new_connector_state(struct drm_atomic_state *state,
617 struct drm_connector *connector)
618{
619 int index = drm_connector_index(connector);
620
621 if (index >= state->num_connector)
622 return NULL;
623
624 return state->connectors[index].new_state;
625}
626
627/**
628 * __drm_atomic_get_current_plane_state - get current plane state
629 * @state: global atomic state object
630 * @plane: plane to grab
631 *
632 * This function returns the plane state for the given plane, either from
633 * @state, or if the plane isn't part of the atomic state update, from @plane.
634 * This is useful in atomic check callbacks, when drivers need to peek at, but
635 * not change, state of other planes, since it avoids threading an error code
636 * back up the call chain.
637 *
638 * WARNING:
639 *
640 * Note that this function is in general unsafe since it doesn't check for the
641 * required locking for access state structures. Drivers must ensure that it is
642 * safe to access the returned state structure through other means. One common
643 * example is when planes are fixed to a single CRTC, and the driver knows that
644 * the CRTC lock is held already. In that case holding the CRTC lock gives a
645 * read-lock on all planes connected to that CRTC. But if planes can be
646 * reassigned things get more tricky. In that case it's better to use
647 * drm_atomic_get_plane_state and wire up full error handling.
648 *
649 * Returns:
650 *
651 * Read-only pointer to the current plane state.
652 */
653static inline const struct drm_plane_state *
654__drm_atomic_get_current_plane_state(struct drm_atomic_state *state,
655 struct drm_plane *plane)
656{
657 if (state->planes[drm_plane_index(plane)].state)
658 return state->planes[drm_plane_index(plane)].state;
659
660 return plane->state;
661}
662
663int __must_check
664drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
665 struct drm_crtc *crtc);
666int __must_check
667drm_atomic_add_affected_planes(struct drm_atomic_state *state,
668 struct drm_crtc *crtc);
669
670int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
671int __must_check drm_atomic_commit(struct drm_atomic_state *state);
672int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state);
673
674void drm_state_dump(struct drm_device *dev, struct drm_printer *p);
675
676/**
677 * for_each_oldnew_connector_in_state - iterate over all connectors in an atomic update
678 * @__state: &struct drm_atomic_state pointer
679 * @connector: &struct drm_connector iteration cursor
680 * @old_connector_state: &struct drm_connector_state iteration cursor for the
681 * old state
682 * @new_connector_state: &struct drm_connector_state iteration cursor for the
683 * new state
684 * @__i: int iteration cursor, for macro-internal use
685 *
686 * This iterates over all connectors in an atomic update, tracking both old and
687 * new state. This is useful in places where the state delta needs to be
688 * considered, for example in atomic check functions.
689 */
690#define for_each_oldnew_connector_in_state(__state, connector, old_connector_state, new_connector_state, __i) \
691 for ((__i) = 0; \
692 (__i) < (__state)->num_connector; \
693 (__i)++) \
694 for_each_if ((__state)->connectors[__i].ptr && \
695 ((connector) = (__state)->connectors[__i].ptr, \
696 (old_connector_state) = (__state)->connectors[__i].old_state, \
697 (new_connector_state) = (__state)->connectors[__i].new_state, 1))
698
699/**
700 * for_each_old_connector_in_state - iterate over all connectors in an atomic update
701 * @__state: &struct drm_atomic_state pointer
702 * @connector: &struct drm_connector iteration cursor
703 * @old_connector_state: &struct drm_connector_state iteration cursor for the
704 * old state
705 * @__i: int iteration cursor, for macro-internal use
706 *
707 * This iterates over all connectors in an atomic update, tracking only the old
708 * state. This is useful in disable functions, where we need the old state the
709 * hardware is still in.
710 */
711#define for_each_old_connector_in_state(__state, connector, old_connector_state, __i) \
712 for ((__i) = 0; \
713 (__i) < (__state)->num_connector; \
714 (__i)++) \
715 for_each_if ((__state)->connectors[__i].ptr && \
716 ((connector) = (__state)->connectors[__i].ptr, \
717 (old_connector_state) = (__state)->connectors[__i].old_state, 1))
718
719/**
720 * for_each_new_connector_in_state - iterate over all connectors in an atomic update
721 * @__state: &struct drm_atomic_state pointer
722 * @connector: &struct drm_connector iteration cursor
723 * @new_connector_state: &struct drm_connector_state iteration cursor for the
724 * new state
725 * @__i: int iteration cursor, for macro-internal use
726 *
727 * This iterates over all connectors in an atomic update, tracking only the new
728 * state. This is useful in enable functions, where we need the new state the
729 * hardware should be in when the atomic commit operation has completed.
730 */
731#define for_each_new_connector_in_state(__state, connector, new_connector_state, __i) \
732 for ((__i) = 0; \
733 (__i) < (__state)->num_connector; \
734 (__i)++) \
735 for_each_if ((__state)->connectors[__i].ptr && \
736 ((connector) = (__state)->connectors[__i].ptr, \
737 (new_connector_state) = (__state)->connectors[__i].new_state, 1))
738
739/**
740 * for_each_oldnew_crtc_in_state - iterate over all CRTCs in an atomic update
741 * @__state: &struct drm_atomic_state pointer
742 * @crtc: &struct drm_crtc iteration cursor
743 * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
744 * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
745 * @__i: int iteration cursor, for macro-internal use
746 *
747 * This iterates over all CRTCs in an atomic update, tracking both old and
748 * new state. This is useful in places where the state delta needs to be
749 * considered, for example in atomic check functions.
750 */
751#define for_each_oldnew_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \
752 for ((__i) = 0; \
753 (__i) < (__state)->dev->mode_config.num_crtc; \
754 (__i)++) \
755 for_each_if ((__state)->crtcs[__i].ptr && \
756 ((crtc) = (__state)->crtcs[__i].ptr, \
757 (old_crtc_state) = (__state)->crtcs[__i].old_state, \
758 (new_crtc_state) = (__state)->crtcs[__i].new_state, 1))
759
760/**
761 * for_each_old_crtc_in_state - iterate over all CRTCs in an atomic update
762 * @__state: &struct drm_atomic_state pointer
763 * @crtc: &struct drm_crtc iteration cursor
764 * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
765 * @__i: int iteration cursor, for macro-internal use
766 *
767 * This iterates over all CRTCs in an atomic update, tracking only the old
768 * state. This is useful in disable functions, where we need the old state the
769 * hardware is still in.
770 */
771#define for_each_old_crtc_in_state(__state, crtc, old_crtc_state, __i) \
772 for ((__i) = 0; \
773 (__i) < (__state)->dev->mode_config.num_crtc; \
774 (__i)++) \
775 for_each_if ((__state)->crtcs[__i].ptr && \
776 ((crtc) = (__state)->crtcs[__i].ptr, \
777 (old_crtc_state) = (__state)->crtcs[__i].old_state, 1))
778
779/**
780 * for_each_new_crtc_in_state - iterate over all CRTCs in an atomic update
781 * @__state: &struct drm_atomic_state pointer
782 * @crtc: &struct drm_crtc iteration cursor
783 * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
784 * @__i: int iteration cursor, for macro-internal use
785 *
786 * This iterates over all CRTCs in an atomic update, tracking only the new
787 * state. This is useful in enable functions, where we need the new state the
788 * hardware should be in when the atomic commit operation has completed.
789 */
790#define for_each_new_crtc_in_state(__state, crtc, new_crtc_state, __i) \
791 for ((__i) = 0; \
792 (__i) < (__state)->dev->mode_config.num_crtc; \
793 (__i)++) \
794 for_each_if ((__state)->crtcs[__i].ptr && \
795 ((crtc) = (__state)->crtcs[__i].ptr, \
796 (new_crtc_state) = (__state)->crtcs[__i].new_state, 1))
797
798/**
799 * for_each_oldnew_plane_in_state - iterate over all planes in an atomic update
800 * @__state: &struct drm_atomic_state pointer
801 * @plane: &struct drm_plane iteration cursor
802 * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
803 * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
804 * @__i: int iteration cursor, for macro-internal use
805 *
806 * This iterates over all planes in an atomic update, tracking both old and
807 * new state. This is useful in places where the state delta needs to be
808 * considered, for example in atomic check functions.
809 */
810#define for_each_oldnew_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \
811 for ((__i) = 0; \
812 (__i) < (__state)->dev->mode_config.num_total_plane; \
813 (__i)++) \
814 for_each_if ((__state)->planes[__i].ptr && \
815 ((plane) = (__state)->planes[__i].ptr, \
816 (old_plane_state) = (__state)->planes[__i].old_state,\
817 (new_plane_state) = (__state)->planes[__i].new_state, 1))
818
819/**
820 * for_each_oldnew_plane_in_state_reverse - iterate over all planes in an atomic
821 * update in reverse order
822 * @__state: &struct drm_atomic_state pointer
823 * @plane: &struct drm_plane iteration cursor
824 * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
825 * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
826 * @__i: int iteration cursor, for macro-internal use
827 *
828 * This iterates over all planes in an atomic update in reverse order,
829 * tracking both old and new state. This is useful in places where the
830 * state delta needs to be considered, for example in atomic check functions.
831 */
832#define for_each_oldnew_plane_in_state_reverse(__state, plane, old_plane_state, new_plane_state, __i) \
833 for ((__i) = ((__state)->dev->mode_config.num_total_plane - 1); \
834 (__i) >= 0; \
835 (__i)--) \
836 for_each_if ((__state)->planes[__i].ptr && \
837 ((plane) = (__state)->planes[__i].ptr, \
838 (old_plane_state) = (__state)->planes[__i].old_state,\
839 (new_plane_state) = (__state)->planes[__i].new_state, 1))
840
841/**
842 * for_each_old_plane_in_state - iterate over all planes in an atomic update
843 * @__state: &struct drm_atomic_state pointer
844 * @plane: &struct drm_plane iteration cursor
845 * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
846 * @__i: int iteration cursor, for macro-internal use
847 *
848 * This iterates over all planes in an atomic update, tracking only the old
849 * state. This is useful in disable functions, where we need the old state the
850 * hardware is still in.
851 */
852#define for_each_old_plane_in_state(__state, plane, old_plane_state, __i) \
853 for ((__i) = 0; \
854 (__i) < (__state)->dev->mode_config.num_total_plane; \
855 (__i)++) \
856 for_each_if ((__state)->planes[__i].ptr && \
857 ((plane) = (__state)->planes[__i].ptr, \
858 (old_plane_state) = (__state)->planes[__i].old_state, 1))
859/**
860 * for_each_new_plane_in_state - iterate over all planes in an atomic update
861 * @__state: &struct drm_atomic_state pointer
862 * @plane: &struct drm_plane iteration cursor
863 * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
864 * @__i: int iteration cursor, for macro-internal use
865 *
866 * This iterates over all planes in an atomic update, tracking only the new
867 * state. This is useful in enable functions, where we need the new state the
868 * hardware should be in when the atomic commit operation has completed.
869 */
870#define for_each_new_plane_in_state(__state, plane, new_plane_state, __i) \
871 for ((__i) = 0; \
872 (__i) < (__state)->dev->mode_config.num_total_plane; \
873 (__i)++) \
874 for_each_if ((__state)->planes[__i].ptr && \
875 ((plane) = (__state)->planes[__i].ptr, \
876 (new_plane_state) = (__state)->planes[__i].new_state, 1))
877
878/**
879 * for_each_oldnew_private_obj_in_state - iterate over all private objects in an atomic update
880 * @__state: &struct drm_atomic_state pointer
881 * @obj: &struct drm_private_obj iteration cursor
882 * @old_obj_state: &struct drm_private_state iteration cursor for the old state
883 * @new_obj_state: &struct drm_private_state iteration cursor for the new state
884 * @__i: int iteration cursor, for macro-internal use
885 *
886 * This iterates over all private objects in an atomic update, tracking both
887 * old and new state. This is useful in places where the state delta needs
888 * to be considered, for example in atomic check functions.
889 */
890#define for_each_oldnew_private_obj_in_state(__state, obj, old_obj_state, new_obj_state, __i) \
891 for ((__i) = 0; \
892 (__i) < (__state)->num_private_objs && \
893 ((obj) = (__state)->private_objs[__i].ptr, \
894 (old_obj_state) = (__state)->private_objs[__i].old_state, \
895 (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
896 (__i)++)
897
898/**
899 * for_each_old_private_obj_in_state - iterate over all private objects in an atomic update
900 * @__state: &struct drm_atomic_state pointer
901 * @obj: &struct drm_private_obj iteration cursor
902 * @old_obj_state: &struct drm_private_state iteration cursor for the old state
903 * @__i: int iteration cursor, for macro-internal use
904 *
905 * This iterates over all private objects in an atomic update, tracking only
906 * the old state. This is useful in disable functions, where we need the old
907 * state the hardware is still in.
908 */
909#define for_each_old_private_obj_in_state(__state, obj, old_obj_state, __i) \
910 for ((__i) = 0; \
911 (__i) < (__state)->num_private_objs && \
912 ((obj) = (__state)->private_objs[__i].ptr, \
913 (old_obj_state) = (__state)->private_objs[__i].old_state, 1); \
914 (__i)++)
915
916/**
917 * for_each_new_private_obj_in_state - iterate over all private objects in an atomic update
918 * @__state: &struct drm_atomic_state pointer
919 * @obj: &struct drm_private_obj iteration cursor
920 * @new_obj_state: &struct drm_private_state iteration cursor for the new state
921 * @__i: int iteration cursor, for macro-internal use
922 *
923 * This iterates over all private objects in an atomic update, tracking only
924 * the new state. This is useful in enable functions, where we need the new state the
925 * hardware should be in when the atomic commit operation has completed.
926 */
927#define for_each_new_private_obj_in_state(__state, obj, new_obj_state, __i) \
928 for ((__i) = 0; \
929 (__i) < (__state)->num_private_objs && \
930 ((obj) = (__state)->private_objs[__i].ptr, \
931 (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
932 (__i)++)
933
934/**
935 * drm_atomic_crtc_needs_modeset - compute combined modeset need
936 * @state: &drm_crtc_state for the CRTC
937 *
938 * To give drivers flexibility &struct drm_crtc_state has 3 booleans to track
939 * whether the state CRTC changed enough to need a full modeset cycle:
940 * mode_changed, active_changed and connectors_changed. This helper simply
941 * combines these three to compute the overall need for a modeset for @state.
942 *
943 * The atomic helper code sets these booleans, but drivers can and should
944 * change them appropriately to accurately represent whether a modeset is
945 * really needed. In general, drivers should avoid full modesets whenever
946 * possible.
947 *
948 * For example if the CRTC mode has changed, and the hardware is able to enact
949 * the requested mode change without going through a full modeset, the driver
950 * should clear mode_changed in its &drm_mode_config_funcs.atomic_check
951 * implementation.
952 */
953static inline bool
954drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state)
955{
956 return state->mode_changed || state->active_changed ||
957 state->connectors_changed;
958}
959
960/**
961 * drm_atomic_crtc_effectively_active - compute whether crtc is actually active
962 * @state: &drm_crtc_state for the CRTC
963 *
964 * When in self refresh mode, the crtc_state->active value will be false, since
965 * the crtc is off. However in some cases we're interested in whether the crtc
966 * is active, or effectively active (ie: it's connected to an active display).
967 * In these cases, use this function instead of just checking active.
968 */
969static inline bool
970drm_atomic_crtc_effectively_active(const struct drm_crtc_state *state)
971{
972 return state->active || state->self_refresh_active;
973}
974
975#endif /* DRM_ATOMIC_H_ */