~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/drm/drm_atomic.h

Version: ~ [ linux-6.12-rc7 ] ~ [ linux-6.11.7 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.60 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.116 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.171 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.229 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.285 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.323 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.12 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

Diff markup

Differences between /include/drm/drm_atomic.h (Version linux-6.12-rc7) and /include/drm/drm_atomic.h (Version linux-6.8.12)


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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php