include/drm/drm_atomic.h

   1 /*
   2  * Copyright (C) 2014 Red Hat
   3  * Copyright (C) 2014 Intel Corp.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  19  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  20  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  21  * OTHER DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  * Rob Clark <robdclark@gmail.com>
  25  * Daniel Vetter <daniel.vetter@ffwll.ch>
  26  */
  27
  28 #ifndef DRM_ATOMIC_H_
  29 #define DRM_ATOMIC_H_
  30
  31 #include <drm/drm_crtc.h>
  32 #include <drm/drm_util.h>
  33
  34 /**
  35  * struct drm_crtc_commit - track modeset commits on a CRTC
  36  *
  37  * This structure is used to track pending modeset changes and atomic commit on
  38  * a per-CRTC basis. Since updating the list should never block this structure
  39  * is reference counted to allow waiters to safely wait on an event to complete,
  40  * without holding any locks.
  41  *
  42  * It has 3 different events in total to allow a fine-grained synchronization
  43  * between outstanding updates::
  44  *
  45  *      atomic commit thread                    hardware
  46  *
  47  *      write new state into hardware   ---->   ...
  48  *      signal hw_done
  49  *                                              switch to new state on next
  50  *      ...                                     v/hblank
  51  *
  52  *      wait for buffers to show up             ...
  53  *
  54  *      ...                                     send completion irq
  55  *                                              irq handler signals flip_done
  56  *      cleanup old buffers
  57  *
  58  *      signal cleanup_done
  59  *
  60  *      wait for flip_done              <----
  61  *      clean up atomic state
  62  *
  63  * The important bit to know is that cleanup_done is the terminal event, but the
  64  * ordering between flip_done and hw_done is entirely up to the specific driver
  65  * and modeset state change.
  66  *
  67  * For an implementation of how to use this look at
  68  * drm_atomic_helper_setup_commit() from the atomic helper library.
  69  */
  70 struct drm_crtc_commit {
  71         /**
  72          * @crtc:
  73          *
  74          * DRM CRTC for this commit.
  75          */
  76         struct drm_crtc *crtc;
  77
  78         /**
  79          * @ref:
  80          *
  81          * Reference count for this structure. Needed to allow blocking on
  82          * completions without the risk of the completion disappearing
  83          * meanwhile.
  84          */
  85         struct kref ref;
  86
  87         /**
  88          * @flip_done:
  89          *
  90          * Will be signaled when the hardware has flipped to the new set of
  91          * buffers. Signals at the same time as when the drm event for this
  92          * commit is sent to userspace, or when an out-fence is singalled. Note
  93          * that for most hardware, in most cases this happens after @hw_done is
  94          * signalled.
  95          */
  96         struct completion flip_done;
  97
  98         /**
  99          * @hw_done:
 100          *
 101          * Will be signalled when all hw register changes for this commit have
 102          * been written out. Especially when disabling a pipe this can be much
 103          * later than than @flip_done, since that can signal already when the
 104          * screen goes black, whereas to fully shut down a pipe more register
 105          * I/O is required.
 106          *
 107          * Note that this does not need to include separately reference-counted
 108          * resources like backing storage buffer pinning, or runtime pm
 109          * management.
 110          */
 111         struct completion hw_done;
 112
 113         /**
 114          * @cleanup_done:
 115          *
 116          * Will be signalled after old buffers have been cleaned up by calling
 117          * drm_atomic_helper_cleanup_planes(). Since this can only happen after
 118          * a vblank wait completed it might be a bit later. This completion is
 119          * useful to throttle updates and avoid hardware updates getting ahead
 120          * of the buffer cleanup too much.
 121          */
 122         struct completion cleanup_done;
 123
 124         /**
 125          * @commit_entry:
 126          *
 127          * Entry on the per-CRTC &drm_crtc.commit_list. Protected by
 128          * $drm_crtc.commit_lock.
 129          */
 130         struct list_head commit_entry;
 131
 132         /**
 133          * @event:
 134          *
 135          * &drm_pending_vblank_event pointer to clean up private events.
 136          */
 137         struct drm_pending_vblank_event *event;
 138
 139         /**
 140          * @abort_completion:
 141          *
 142          * A flag that's set after drm_atomic_helper_setup_commit takes a second
 143          * reference for the completion of $drm_crtc_state.event. It's used by
 144          * the free code to remove the second reference if commit fails.
 145          */
 146         bool abort_completion;
 147 };
 148
 149 struct __drm_planes_state {
 150         struct drm_plane *ptr;
 151         struct drm_plane_state *state, *old_state, *new_state;
 152 };
 153
 154 struct __drm_crtcs_state {
 155         struct drm_crtc *ptr;
 156         struct drm_crtc_state *state, *old_state, *new_state;
 157
 158         /**
 159          * @commit:
 160          *
 161          * A reference to the CRTC commit object that is kept for use by
 162          * drm_atomic_helper_wait_for_flip_done() after
 163          * drm_atomic_helper_commit_hw_done() is called. This ensures that a
 164          * concurrent commit won't free a commit object that is still in use.
 165          */
 166         struct drm_crtc_commit *commit;
 167
 168         s32 __user *out_fence_ptr;
 169         u64 last_vblank_count;
 170 };
 171
 172 struct __drm_connnectors_state {
 173         struct drm_connector *ptr;
 174         struct drm_connector_state *state, *old_state, *new_state;
 175         /**
 176          * @out_fence_ptr:
 177          *
 178          * User-provided pointer which the kernel uses to return a sync_file
 179          * file descriptor. Used by writeback connectors to signal completion of
 180          * the writeback.
 181          */
 182         s32 __user *out_fence_ptr;
 183 };
 184
 185 struct drm_private_obj;
 186 struct drm_private_state;
 187
 188 /**
 189  * struct drm_private_state_funcs - atomic state functions for private objects
 190  *
 191  * These hooks are used by atomic helpers to create, swap and destroy states of
 192  * private objects. The structure itself is used as a vtable to identify the
 193  * associated private object type. Each private object type that needs to be
 194  * added to the atomic states is expected to have an implementation of these
 195  * hooks and pass a pointer to it's drm_private_state_funcs struct to
 196  * drm_atomic_get_private_obj_state().
 197  */
 198 struct drm_private_state_funcs {
 199         /**
 200          * @atomic_duplicate_state:
 201          *
 202          * Duplicate the current state of the private object and return it. It
 203          * is an error to call this before obj->state has been initialized.
 204          *
 205          * RETURNS:
 206          *
 207          * Duplicated atomic state or NULL when obj->state is not
 208          * initialized or allocation failed.
 209          */
 210         struct drm_private_state *(*atomic_duplicate_state)(struct drm_private_obj *obj);
 211
 212         /**
 213          * @atomic_destroy_state:
 214          *
 215          * Frees the private object state created with @atomic_duplicate_state.
 216          */
 217         void (*atomic_destroy_state)(struct drm_private_obj *obj,
 218                                      struct drm_private_state *state);
 219 };
 220
 221 /**
 222  * struct drm_private_obj - base struct for driver private atomic object
 223  *
 224  * A driver private object is initialized by calling
 225  * drm_atomic_private_obj_init() and cleaned up by calling
 226  * drm_atomic_private_obj_fini().
 227  *
 228  * Currently only tracks the state update functions and the opaque driver
 229  * private state itself, but in the future might also track which
 230  * &drm_modeset_lock is required to duplicate and update this object's state.
 231  */
 232 struct drm_private_obj {
 233         /**
 234          * @state: Current atomic state for this driver private object.
 235          */
 236         struct drm_private_state *state;
 237
 238         /**
 239          * @funcs:
 240          *
 241          * Functions to manipulate the state of this driver private object, see
 242          * &drm_private_state_funcs.
 243          */
 244         const struct drm_private_state_funcs *funcs;
 245 };
 246
 247 /**
 248  * struct drm_private_state - base struct for driver private object state
 249  * @state: backpointer to global drm_atomic_state
 250  *
 251  * Currently only contains a backpointer to the overall atomic update, but in
 252  * the future also might hold synchronization information similar to e.g.
 253  * &drm_crtc.commit.
 254  */
 255 struct drm_private_state {
 256         struct drm_atomic_state *state;
 257 };
 258
 259 struct __drm_private_objs_state {
 260         struct drm_private_obj *ptr;
 261         struct drm_private_state *state, *old_state, *new_state;
 262 };
 263
 264 /**
 265  * struct drm_atomic_state - the global state object for atomic updates
 266  * @ref: count of all references to this state (will not be freed until zero)
 267  * @dev: parent DRM device
 268  * @allow_modeset: allow full modeset
 269  * @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics
 270  * @async_update: hint for asynchronous plane update
 271  * @planes: pointer to array of structures with per-plane data
 272  * @crtcs: pointer to array of CRTC pointers
 273  * @num_connector: size of the @connectors and @connector_states arrays
 274  * @connectors: pointer to array of structures with per-connector data
 275  * @num_private_objs: size of the @private_objs array
 276  * @private_objs: pointer to array of private object pointers
 277  * @acquire_ctx: acquire context for this atomic modeset state update
 278  *
 279  * States are added to an atomic update by calling drm_atomic_get_crtc_state(),
 280  * drm_atomic_get_plane_state(), drm_atomic_get_connector_state(), or for
 281  * private state structures, drm_atomic_get_private_obj_state().
 282  */
 283 struct drm_atomic_state {
 284         struct kref ref;
 285
 286         struct drm_device *dev;
 287         bool allow_modeset : 1;
 288         bool legacy_cursor_update : 1;
 289         bool async_update : 1;
 290         struct __drm_planes_state *planes;
 291         struct __drm_crtcs_state *crtcs;
 292         int num_connector;
 293         struct __drm_connnectors_state *connectors;
 294         int num_private_objs;
 295         struct __drm_private_objs_state *private_objs;
 296
 297         struct drm_modeset_acquire_ctx *acquire_ctx;
 298
 299         /**
 300          * @fake_commit:
 301          *
 302          * Used for signaling unbound planes/connectors.
 303          * When a connector or plane is not bound to any CRTC, it's still important
 304          * to preserve linearity to prevent the atomic states from being freed to early.
 305          *
 306          * This commit (if set) is not bound to any crtc, but will be completed when
 307          * drm_atomic_helper_commit_hw_done() is called.
 308          */
 309         struct drm_crtc_commit *fake_commit;
 310
 311         /**
 312          * @commit_work:
 313          *
 314          * Work item which can be used by the driver or helpers to execute the
 315          * commit without blocking.
 316          */
 317         struct work_struct commit_work;
 318 };
 319
 320 void __drm_crtc_commit_free(struct kref *kref);
 321
 322 /**
 323  * drm_crtc_commit_get - acquire a reference to the CRTC commit
 324  * @commit: CRTC commit
 325  *
 326  * Increases the reference of @commit.
 327  *
 328  * Returns:
 329  * The pointer to @commit, with reference increased.
 330  */
 331 static inline struct drm_crtc_commit *drm_crtc_commit_get(struct drm_crtc_commit *commit)
 332 {
 333         kref_get(&commit->ref);
 334         return commit;
 335 }
 336
 337 /**
 338  * drm_crtc_commit_put - release a reference to the CRTC commmit
 339  * @commit: CRTC commit
 340  *
 341  * This releases a reference to @commit which is freed after removing the
 342  * final reference. No locking required and callable from any context.
 343  */
 344 static inline void drm_crtc_commit_put(struct drm_crtc_commit *commit)
 345 {
 346         kref_put(&commit->ref, __drm_crtc_commit_free);
 347 }
 348
 349 struct drm_atomic_state * __must_check
 350 drm_atomic_state_alloc(struct drm_device *dev);
 351 void drm_atomic_state_clear(struct drm_atomic_state *state);
 352
 353 /**
 354  * drm_atomic_state_get - acquire a reference to the atomic state
 355  * @state: The atomic state
 356  *
 357  * Returns a new reference to the @state
 358  */
 359 static inline struct drm_atomic_state *
 360 drm_atomic_state_get(struct drm_atomic_state *state)
 361 {
 362         kref_get(&state->ref);
 363         return state;
 364 }
 365
 366 void __drm_atomic_state_free(struct kref *ref);
 367
 368 /**
 369  * drm_atomic_state_put - release a reference to the atomic state
 370  * @state: The atomic state
 371  *
 372  * This releases a reference to @state which is freed after removing the
 373  * final reference. No locking required and callable from any context.
 374  */
 375 static inline void drm_atomic_state_put(struct drm_atomic_state *state)
 376 {
 377         kref_put(&state->ref, __drm_atomic_state_free);
 378 }
 379
 380 int  __must_check
 381 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state);
 382 void drm_atomic_state_default_clear(struct drm_atomic_state *state);
 383 void drm_atomic_state_default_release(struct drm_atomic_state *state);
 384
 385 struct drm_crtc_state * __must_check
 386 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
 387                           struct drm_crtc *crtc);
 388 struct drm_plane_state * __must_check
 389 drm_atomic_get_plane_state(struct drm_atomic_state *state,
 390                            struct drm_plane *plane);
 391 struct drm_connector_state * __must_check
 392 drm_atomic_get_connector_state(struct drm_atomic_state *state,
 393                                struct drm_connector *connector);
 394
 395 void drm_atomic_private_obj_init(struct drm_private_obj *obj,
 396                                  struct drm_private_state *state,
 397                                  const struct drm_private_state_funcs *funcs);
 398 void drm_atomic_private_obj_fini(struct drm_private_obj *obj);
 399
 400 struct drm_private_state * __must_check
 401 drm_atomic_get_private_obj_state(struct drm_atomic_state *state,
 402                                  struct drm_private_obj *obj);
 403
 404 /**
 405  * drm_atomic_get_existing_crtc_state - get crtc state, if it exists
 406  * @state: global atomic state object
 407  * @crtc: crtc to grab
 408  *
 409  * This function returns the crtc state for the given crtc, or NULL
 410  * if the crtc is not part of the global atomic state.
 411  *
 412  * This function is deprecated, @drm_atomic_get_old_crtc_state or
 413  * @drm_atomic_get_new_crtc_state should be used instead.
 414  */
 415 static inline struct drm_crtc_state *
 416 drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state,
 417                                    struct drm_crtc *crtc)
 418 {
 419         return state->crtcs[drm_crtc_index(crtc)].state;
 420 }
 421
 422 /**
 423  * drm_atomic_get_old_crtc_state - get old crtc state, if it exists
 424  * @state: global atomic state object
 425  * @crtc: crtc to grab
 426  *
 427  * This function returns the old crtc state for the given crtc, or
 428  * NULL if the crtc is not part of the global atomic state.
 429  */
 430 static inline struct drm_crtc_state *
 431 drm_atomic_get_old_crtc_state(struct drm_atomic_state *state,
 432                               struct drm_crtc *crtc)
 433 {
 434         return state->crtcs[drm_crtc_index(crtc)].old_state;
 435 }
 436 /**
 437  * drm_atomic_get_new_crtc_state - get new crtc state, if it exists
 438  * @state: global atomic state object
 439  * @crtc: crtc to grab
 440  *
 441  * This function returns the new crtc state for the given crtc, or
 442  * NULL if the crtc is not part of the global atomic state.
 443  */
 444 static inline struct drm_crtc_state *
 445 drm_atomic_get_new_crtc_state(struct drm_atomic_state *state,
 446                               struct drm_crtc *crtc)
 447 {
 448         return state->crtcs[drm_crtc_index(crtc)].new_state;
 449 }
 450
 451 /**
 452  * drm_atomic_get_existing_plane_state - get plane state, if it exists
 453  * @state: global atomic state object
 454  * @plane: plane to grab
 455  *
 456  * This function returns the plane state for the given plane, or NULL
 457  * if the plane is not part of the global atomic state.
 458  *
 459  * This function is deprecated, @drm_atomic_get_old_plane_state or
 460  * @drm_atomic_get_new_plane_state should be used instead.
 461  */
 462 static inline struct drm_plane_state *
 463 drm_atomic_get_existing_plane_state(struct drm_atomic_state *state,
 464                                     struct drm_plane *plane)
 465 {
 466         return state->planes[drm_plane_index(plane)].state;
 467 }
 468
 469 /**
 470  * drm_atomic_get_old_plane_state - get plane state, if it exists
 471  * @state: global atomic state object
 472  * @plane: plane to grab
 473  *
 474  * This function returns the old plane state for the given plane, or
 475  * NULL if the plane is not part of the global atomic state.
 476  */
 477 static inline struct drm_plane_state *
 478 drm_atomic_get_old_plane_state(struct drm_atomic_state *state,
 479                                struct drm_plane *plane)
 480 {
 481         return state->planes[drm_plane_index(plane)].old_state;
 482 }
 483
 484 /**
 485  * drm_atomic_get_new_plane_state - get plane state, if it exists
 486  * @state: global atomic state object
 487  * @plane: plane to grab
 488  *
 489  * This function returns the new plane state for the given plane, or
 490  * NULL if the plane is not part of the global atomic state.
 491  */
 492 static inline struct drm_plane_state *
 493 drm_atomic_get_new_plane_state(struct drm_atomic_state *state,
 494                                struct drm_plane *plane)
 495 {
 496         return state->planes[drm_plane_index(plane)].new_state;
 497 }
 498
 499 /**
 500  * drm_atomic_get_existing_connector_state - get connector state, if it exists
 501  * @state: global atomic state object
 502  * @connector: connector to grab
 503  *
 504  * This function returns the connector state for the given connector,
 505  * or NULL if the connector is not part of the global atomic state.
 506  *
 507  * This function is deprecated, @drm_atomic_get_old_connector_state or
 508  * @drm_atomic_get_new_connector_state should be used instead.
 509  */
 510 static inline struct drm_connector_state *
 511 drm_atomic_get_existing_connector_state(struct drm_atomic_state *state,
 512                                         struct drm_connector *connector)
 513 {
 514         int index = drm_connector_index(connector);
 515
 516         if (index >= state->num_connector)
 517                 return NULL;
 518
 519         return state->connectors[index].state;
 520 }
 521
 522 /**
 523  * drm_atomic_get_old_connector_state - get connector state, if it exists
 524  * @state: global atomic state object
 525  * @connector: connector to grab
 526  *
 527  * This function returns the old connector state for the given connector,
 528  * or NULL if the connector is not part of the global atomic state.
 529  */
 530 static inline struct drm_connector_state *
 531 drm_atomic_get_old_connector_state(struct drm_atomic_state *state,
 532                                    struct drm_connector *connector)
 533 {
 534         int index = drm_connector_index(connector);
 535
 536         if (index >= state->num_connector)
 537                 return NULL;
 538
 539         return state->connectors[index].old_state;
 540 }
 541
 542 /**
 543  * drm_atomic_get_new_connector_state - get connector state, if it exists
 544  * @state: global atomic state object
 545  * @connector: connector to grab
 546  *
 547  * This function returns the new connector state for the given connector,
 548  * or NULL if the connector is not part of the global atomic state.
 549  */
 550 static inline struct drm_connector_state *
 551 drm_atomic_get_new_connector_state(struct drm_atomic_state *state,
 552                                    struct drm_connector *connector)
 553 {
 554         int index = drm_connector_index(connector);
 555
 556         if (index >= state->num_connector)
 557                 return NULL;
 558
 559         return state->connectors[index].new_state;
 560 }
 561
 562 /**
 563  * __drm_atomic_get_current_plane_state - get current plane state
 564  * @state: global atomic state object
 565  * @plane: plane to grab
 566  *
 567  * This function returns the plane state for the given plane, either from
 568  * @state, or if the plane isn't part of the atomic state update, from @plane.
 569  * This is useful in atomic check callbacks, when drivers need to peek at, but
 570  * not change, state of other planes, since it avoids threading an error code
 571  * back up the call chain.
 572  *
 573  * WARNING:
 574  *
 575  * Note that this function is in general unsafe since it doesn't check for the
 576  * required locking for access state structures. Drivers must ensure that it is
 577  * safe to access the returned state structure through other means. One common
 578  * example is when planes are fixed to a single CRTC, and the driver knows that
 579  * the CRTC lock is held already. In that case holding the CRTC lock gives a
 580  * read-lock on all planes connected to that CRTC. But if planes can be
 581  * reassigned things get more tricky. In that case it's better to use
 582  * drm_atomic_get_plane_state and wire up full error handling.
 583  *
 584  * Returns:
 585  *
 586  * Read-only pointer to the current plane state.
 587  */
 588 static inline const struct drm_plane_state *
 589 __drm_atomic_get_current_plane_state(struct drm_atomic_state *state,
 590                                      struct drm_plane *plane)
 591 {
 592         if (state->planes[drm_plane_index(plane)].state)
 593                 return state->planes[drm_plane_index(plane)].state;
 594
 595         return plane->state;
 596 }
 597
 598 int __must_check
 599 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
 600                                    struct drm_crtc *crtc);
 601 int __must_check
 602 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
 603                                struct drm_crtc *crtc);
 604
 605 int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
 606 int __must_check drm_atomic_commit(struct drm_atomic_state *state);
 607 int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state);
 608
 609 void drm_state_dump(struct drm_device *dev, struct drm_printer *p);
 610
 611 /**
 612  * for_each_oldnew_connector_in_state - iterate over all connectors in an atomic update
 613  * @__state: &struct drm_atomic_state pointer
 614  * @connector: &struct drm_connector iteration cursor
 615  * @old_connector_state: &struct drm_connector_state iteration cursor for the
 616  *      old state
 617  * @new_connector_state: &struct drm_connector_state iteration cursor for the
 618  *      new state
 619  * @__i: int iteration cursor, for macro-internal use
 620  *
 621  * This iterates over all connectors in an atomic update, tracking both old and
 622  * new state. This is useful in places where the state delta needs to be
 623  * considered, for example in atomic check functions.
 624  */
 625 #define for_each_oldnew_connector_in_state(__state, connector, old_connector_state, new_connector_state, __i) \
 626         for ((__i) = 0;                                                         \
 627              (__i) < (__state)->num_connector;                                  \
 628              (__i)++)                                                           \
 629                 for_each_if ((__state)->connectors[__i].ptr &&                  \
 630                              ((connector) = (__state)->connectors[__i].ptr,     \
 631                              (old_connector_state) = (__state)->connectors[__i].old_state,      \
 632                              (new_connector_state) = (__state)->connectors[__i].new_state, 1))
 633
 634 /**
 635  * for_each_old_connector_in_state - iterate over all connectors in an atomic update
 636  * @__state: &struct drm_atomic_state pointer
 637  * @connector: &struct drm_connector iteration cursor
 638  * @old_connector_state: &struct drm_connector_state iteration cursor for the
 639  *      old state
 640  * @__i: int iteration cursor, for macro-internal use
 641  *
 642  * This iterates over all connectors in an atomic update, tracking only the old
 643  * state. This is useful in disable functions, where we need the old state the
 644  * hardware is still in.
 645  */
 646 #define for_each_old_connector_in_state(__state, connector, old_connector_state, __i) \
 647         for ((__i) = 0;                                                         \
 648              (__i) < (__state)->num_connector;                                  \
 649              (__i)++)                                                           \
 650                 for_each_if ((__state)->connectors[__i].ptr &&                  \
 651                              ((connector) = (__state)->connectors[__i].ptr,     \
 652                              (old_connector_state) = (__state)->connectors[__i].old_state, 1))
 653
 654 /**
 655  * for_each_new_connector_in_state - iterate over all connectors in an atomic update
 656  * @__state: &struct drm_atomic_state pointer
 657  * @connector: &struct drm_connector iteration cursor
 658  * @new_connector_state: &struct drm_connector_state iteration cursor for the
 659  *      new state
 660  * @__i: int iteration cursor, for macro-internal use
 661  *
 662  * This iterates over all connectors in an atomic update, tracking only the new
 663  * state. This is useful in enable functions, where we need the new state the
 664  * hardware should be in when the atomic commit operation has completed.
 665  */
 666 #define for_each_new_connector_in_state(__state, connector, new_connector_state, __i) \
 667         for ((__i) = 0;                                                         \
 668              (__i) < (__state)->num_connector;                                  \
 669              (__i)++)                                                           \
 670                 for_each_if ((__state)->connectors[__i].ptr &&                  \
 671                              ((connector) = (__state)->connectors[__i].ptr,     \
 672                              (new_connector_state) = (__state)->connectors[__i].new_state, 1))
 673
 674 /**
 675  * for_each_oldnew_crtc_in_state - iterate over all CRTCs in an atomic update
 676  * @__state: &struct drm_atomic_state pointer
 677  * @crtc: &struct drm_crtc iteration cursor
 678  * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
 679  * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
 680  * @__i: int iteration cursor, for macro-internal use
 681  *
 682  * This iterates over all CRTCs in an atomic update, tracking both old and
 683  * new state. This is useful in places where the state delta needs to be
 684  * considered, for example in atomic check functions.
 685  */
 686 #define for_each_oldnew_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \
 687         for ((__i) = 0;                                                 \
 688              (__i) < (__state)->dev->mode_config.num_crtc;              \
 689              (__i)++)                                                   \
 690                 for_each_if ((__state)->crtcs[__i].ptr &&               \
 691                              ((crtc) = (__state)->crtcs[__i].ptr,       \
 692                              (old_crtc_state) = (__state)->crtcs[__i].old_state, \
 693                              (new_crtc_state) = (__state)->crtcs[__i].new_state, 1))
 694
 695 /**
 696  * for_each_old_crtc_in_state - iterate over all CRTCs in an atomic update
 697  * @__state: &struct drm_atomic_state pointer
 698  * @crtc: &struct drm_crtc iteration cursor
 699  * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
 700  * @__i: int iteration cursor, for macro-internal use
 701  *
 702  * This iterates over all CRTCs in an atomic update, tracking only the old
 703  * state. This is useful in disable functions, where we need the old state the
 704  * hardware is still in.
 705  */
 706 #define for_each_old_crtc_in_state(__state, crtc, old_crtc_state, __i)  \
 707         for ((__i) = 0;                                                 \
 708              (__i) < (__state)->dev->mode_config.num_crtc;              \
 709              (__i)++)                                                   \
 710                 for_each_if ((__state)->crtcs[__i].ptr &&               \
 711                              ((crtc) = (__state)->crtcs[__i].ptr,       \
 712                              (old_crtc_state) = (__state)->crtcs[__i].old_state, 1))
 713
 714 /**
 715  * for_each_new_crtc_in_state - iterate over all CRTCs in an atomic update
 716  * @__state: &struct drm_atomic_state pointer
 717  * @crtc: &struct drm_crtc iteration cursor
 718  * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
 719  * @__i: int iteration cursor, for macro-internal use
 720  *
 721  * This iterates over all CRTCs in an atomic update, tracking only the new
 722  * state. This is useful in enable functions, where we need the new state the
 723  * hardware should be in when the atomic commit operation has completed.
 724  */
 725 #define for_each_new_crtc_in_state(__state, crtc, new_crtc_state, __i)  \
 726         for ((__i) = 0;                                                 \
 727              (__i) < (__state)->dev->mode_config.num_crtc;              \
 728              (__i)++)                                                   \
 729                 for_each_if ((__state)->crtcs[__i].ptr &&               \
 730                              ((crtc) = (__state)->crtcs[__i].ptr,       \
 731                              (new_crtc_state) = (__state)->crtcs[__i].new_state, 1))
 732
 733 /**
 734  * for_each_oldnew_plane_in_state - iterate over all planes in an atomic update
 735  * @__state: &struct drm_atomic_state pointer
 736  * @plane: &struct drm_plane iteration cursor
 737  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
 738  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
 739  * @__i: int iteration cursor, for macro-internal use
 740  *
 741  * This iterates over all planes in an atomic update, tracking both old and
 742  * new state. This is useful in places where the state delta needs to be
 743  * considered, for example in atomic check functions.
 744  */
 745 #define for_each_oldnew_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \
 746         for ((__i) = 0;                                                 \
 747              (__i) < (__state)->dev->mode_config.num_total_plane;       \
 748              (__i)++)                                                   \
 749                 for_each_if ((__state)->planes[__i].ptr &&              \
 750                              ((plane) = (__state)->planes[__i].ptr,     \
 751                               (old_plane_state) = (__state)->planes[__i].old_state,\
 752                               (new_plane_state) = (__state)->planes[__i].new_state, 1))
 753
 754 /**
 755  * for_each_oldnew_plane_in_state_reverse - iterate over all planes in an atomic
 756  * update in reverse order
 757  * @__state: &struct drm_atomic_state pointer
 758  * @plane: &struct drm_plane iteration cursor
 759  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
 760  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
 761  * @__i: int iteration cursor, for macro-internal use
 762  *
 763  * This iterates over all planes in an atomic update in reverse order,
 764  * tracking both old and  new state. This is useful in places where the
 765  * state delta needs to be considered, for example in atomic check functions.
 766  */
 767 #define for_each_oldnew_plane_in_state_reverse(__state, plane, old_plane_state, new_plane_state, __i) \
 768         for ((__i) = ((__state)->dev->mode_config.num_total_plane - 1); \
 769              (__i) >= 0;                                                \
 770              (__i)--)                                                   \
 771                 for_each_if ((__state)->planes[__i].ptr &&              \
 772                              ((plane) = (__state)->planes[__i].ptr,     \
 773                               (old_plane_state) = (__state)->planes[__i].old_state,\
 774                               (new_plane_state) = (__state)->planes[__i].new_state, 1))
 775
 776 /**
 777  * for_each_old_plane_in_state - iterate over all planes in an atomic update
 778  * @__state: &struct drm_atomic_state pointer
 779  * @plane: &struct drm_plane iteration cursor
 780  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
 781  * @__i: int iteration cursor, for macro-internal use
 782  *
 783  * This iterates over all planes in an atomic update, tracking only the old
 784  * state. This is useful in disable functions, where we need the old state the
 785  * hardware is still in.
 786  */
 787 #define for_each_old_plane_in_state(__state, plane, old_plane_state, __i) \
 788         for ((__i) = 0;                                                 \
 789              (__i) < (__state)->dev->mode_config.num_total_plane;       \
 790              (__i)++)                                                   \
 791                 for_each_if ((__state)->planes[__i].ptr &&              \
 792                              ((plane) = (__state)->planes[__i].ptr,     \
 793                               (old_plane_state) = (__state)->planes[__i].old_state, 1))
 794 /**
 795  * for_each_new_plane_in_state - iterate over all planes in an atomic update
 796  * @__state: &struct drm_atomic_state pointer
 797  * @plane: &struct drm_plane iteration cursor
 798  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
 799  * @__i: int iteration cursor, for macro-internal use
 800  *
 801  * This iterates over all planes in an atomic update, tracking only the new
 802  * state. This is useful in enable functions, where we need the new state the
 803  * hardware should be in when the atomic commit operation has completed.
 804  */
 805 #define for_each_new_plane_in_state(__state, plane, new_plane_state, __i) \
 806         for ((__i) = 0;                                                 \
 807              (__i) < (__state)->dev->mode_config.num_total_plane;       \
 808              (__i)++)                                                   \
 809                 for_each_if ((__state)->planes[__i].ptr &&              \
 810                              ((plane) = (__state)->planes[__i].ptr,     \
 811                               (new_plane_state) = (__state)->planes[__i].new_state, 1))
 812
 813 /**
 814  * for_each_oldnew_private_obj_in_state - iterate over all private objects in an atomic update
 815  * @__state: &struct drm_atomic_state pointer
 816  * @obj: &struct drm_private_obj iteration cursor
 817  * @old_obj_state: &struct drm_private_state iteration cursor for the old state
 818  * @new_obj_state: &struct drm_private_state iteration cursor for the new state
 819  * @__i: int iteration cursor, for macro-internal use
 820  *
 821  * This iterates over all private objects in an atomic update, tracking both
 822  * old and new state. This is useful in places where the state delta needs
 823  * to be considered, for example in atomic check functions.
 824  */
 825 #define for_each_oldnew_private_obj_in_state(__state, obj, old_obj_state, new_obj_state, __i) \
 826         for ((__i) = 0; \
 827              (__i) < (__state)->num_private_objs && \
 828                      ((obj) = (__state)->private_objs[__i].ptr, \
 829                       (old_obj_state) = (__state)->private_objs[__i].old_state, \
 830                       (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
 831              (__i)++)
 832
 833 /**
 834  * for_each_old_private_obj_in_state - iterate over all private objects in an atomic update
 835  * @__state: &struct drm_atomic_state pointer
 836  * @obj: &struct drm_private_obj iteration cursor
 837  * @old_obj_state: &struct drm_private_state iteration cursor for the old state
 838  * @__i: int iteration cursor, for macro-internal use
 839  *
 840  * This iterates over all private objects in an atomic update, tracking only
 841  * the old state. This is useful in disable functions, where we need the old
 842  * state the hardware is still in.
 843  */
 844 #define for_each_old_private_obj_in_state(__state, obj, old_obj_state, __i) \
 845         for ((__i) = 0; \
 846              (__i) < (__state)->num_private_objs && \
 847                      ((obj) = (__state)->private_objs[__i].ptr, \
 848                       (old_obj_state) = (__state)->private_objs[__i].old_state, 1); \
 849              (__i)++)
 850
 851 /**
 852  * for_each_new_private_obj_in_state - iterate over all private objects in an atomic update
 853  * @__state: &struct drm_atomic_state pointer
 854  * @obj: &struct drm_private_obj iteration cursor
 855  * @new_obj_state: &struct drm_private_state iteration cursor for the new state
 856  * @__i: int iteration cursor, for macro-internal use
 857  *
 858  * This iterates over all private objects in an atomic update, tracking only
 859  * the new state. This is useful in enable functions, where we need the new state the
 860  * hardware should be in when the atomic commit operation has completed.
 861  */
 862 #define for_each_new_private_obj_in_state(__state, obj, new_obj_state, __i) \
 863         for ((__i) = 0; \
 864              (__i) < (__state)->num_private_objs && \
 865                      ((obj) = (__state)->private_objs[__i].ptr, \
 866                       (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
 867              (__i)++)
 868
 869 /**
 870  * drm_atomic_crtc_needs_modeset - compute combined modeset need
 871  * @state: &drm_crtc_state for the CRTC
 872  *
 873  * To give drivers flexibility &struct drm_crtc_state has 3 booleans to track
 874  * whether the state CRTC changed enough to need a full modeset cycle:
 875  * mode_changed, active_changed and connectors_changed. This helper simply
 876  * combines these three to compute the overall need for a modeset for @state.
 877  *
 878  * The atomic helper code sets these booleans, but drivers can and should
 879  * change them appropriately to accurately represent whether a modeset is
 880  * really needed. In general, drivers should avoid full modesets whenever
 881  * possible.
 882  *
 883  * For example if the CRTC mode has changed, and the hardware is able to enact
 884  * the requested mode change without going through a full modeset, the driver
 885  * should clear mode_changed in its &drm_mode_config_funcs.atomic_check
 886  * implementation.
 887  */
 888 static inline bool
 889 drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state)
 890 {
 891         return state->mode_changed || state->active_changed ||
 892                state->connectors_changed;
 893 }
 894
 895 #endif /* DRM_ATOMIC_H_ */