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         s32 __user *out_fence_ptr;
 158         u64 last_vblank_count;
 159 };
 160
 161 struct __drm_connnectors_state {
 162         struct drm_connector *ptr;
 163         struct drm_connector_state *state, *old_state, *new_state;
 164         /**
 165          * @out_fence_ptr:
 166          *
 167          * User-provided pointer which the kernel uses to return a sync_file
 168          * file descriptor. Used by writeback connectors to signal completion of
 169          * the writeback.
 170          */
 171         s32 __user *out_fence_ptr;
 172 };
 173
 174 struct drm_private_obj;
 175 struct drm_private_state;
 176
 177 /**
 178  * struct drm_private_state_funcs - atomic state functions for private objects
 179  *
 180  * These hooks are used by atomic helpers to create, swap and destroy states of
 181  * private objects. The structure itself is used as a vtable to identify the
 182  * associated private object type. Each private object type that needs to be
 183  * added to the atomic states is expected to have an implementation of these
 184  * hooks and pass a pointer to it's drm_private_state_funcs struct to
 185  * drm_atomic_get_private_obj_state().
 186  */
 187 struct drm_private_state_funcs {
 188         /**
 189          * @atomic_duplicate_state:
 190          *
 191          * Duplicate the current state of the private object and return it. It
 192          * is an error to call this before obj->state has been initialized.
 193          *
 194          * RETURNS:
 195          *
 196          * Duplicated atomic state or NULL when obj->state is not
 197          * initialized or allocation failed.
 198          */
 199         struct drm_private_state *(*atomic_duplicate_state)(struct drm_private_obj *obj);
 200
 201         /**
 202          * @atomic_destroy_state:
 203          *
 204          * Frees the private object state created with @atomic_duplicate_state.
 205          */
 206         void (*atomic_destroy_state)(struct drm_private_obj *obj,
 207                                      struct drm_private_state *state);
 208 };
 209
 210 /**
 211  * struct drm_private_obj - base struct for driver private atomic object
 212  *
 213  * A driver private object is initialized by calling
 214  * drm_atomic_private_obj_init() and cleaned up by calling
 215  * drm_atomic_private_obj_fini().
 216  *
 217  * Currently only tracks the state update functions and the opaque driver
 218  * private state itself, but in the future might also track which
 219  * &drm_modeset_lock is required to duplicate and update this object's state.
 220  */
 221 struct drm_private_obj {
 222         /**
 223          * @state: Current atomic state for this driver private object.
 224          */
 225         struct drm_private_state *state;
 226
 227         /**
 228          * @funcs:
 229          *
 230          * Functions to manipulate the state of this driver private object, see
 231          * &drm_private_state_funcs.
 232          */
 233         const struct drm_private_state_funcs *funcs;
 234 };
 235
 236 /**
 237  * struct drm_private_state - base struct for driver private object state
 238  * @state: backpointer to global drm_atomic_state
 239  *
 240  * Currently only contains a backpointer to the overall atomic update, but in
 241  * the future also might hold synchronization information similar to e.g.
 242  * &drm_crtc.commit.
 243  */
 244 struct drm_private_state {
 245         struct drm_atomic_state *state;
 246 };
 247
 248 struct __drm_private_objs_state {
 249         struct drm_private_obj *ptr;
 250         struct drm_private_state *state, *old_state, *new_state;
 251 };
 252
 253 /**
 254  * struct drm_atomic_state - the global state object for atomic updates
 255  * @ref: count of all references to this state (will not be freed until zero)
 256  * @dev: parent DRM device
 257  * @allow_modeset: allow full modeset
 258  * @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics
 259  * @async_update: hint for asynchronous plane update
 260  * @planes: pointer to array of structures with per-plane data
 261  * @crtcs: pointer to array of CRTC pointers
 262  * @num_connector: size of the @connectors and @connector_states arrays
 263  * @connectors: pointer to array of structures with per-connector data
 264  * @num_private_objs: size of the @private_objs array
 265  * @private_objs: pointer to array of private object pointers
 266  * @acquire_ctx: acquire context for this atomic modeset state update
 267  *
 268  * States are added to an atomic update by calling drm_atomic_get_crtc_state(),
 269  * drm_atomic_get_plane_state(), drm_atomic_get_connector_state(), or for
 270  * private state structures, drm_atomic_get_private_obj_state().
 271  */
 272 struct drm_atomic_state {
 273         struct kref ref;
 274
 275         struct drm_device *dev;
 276         bool allow_modeset : 1;
 277         bool legacy_cursor_update : 1;
 278         bool async_update : 1;
 279         struct __drm_planes_state *planes;
 280         struct __drm_crtcs_state *crtcs;
 281         int num_connector;
 282         struct __drm_connnectors_state *connectors;
 283         int num_private_objs;
 284         struct __drm_private_objs_state *private_objs;
 285
 286         struct drm_modeset_acquire_ctx *acquire_ctx;
 287
 288         /**
 289          * @fake_commit:
 290          *
 291          * Used for signaling unbound planes/connectors.
 292          * When a connector or plane is not bound to any CRTC, it's still important
 293          * to preserve linearity to prevent the atomic states from being freed to early.
 294          *
 295          * This commit (if set) is not bound to any crtc, but will be completed when
 296          * drm_atomic_helper_commit_hw_done() is called.
 297          */
 298         struct drm_crtc_commit *fake_commit;
 299
 300         /**
 301          * @commit_work:
 302          *
 303          * Work item which can be used by the driver or helpers to execute the
 304          * commit without blocking.
 305          */
 306         struct work_struct commit_work;
 307 };
 308
 309 void __drm_crtc_commit_free(struct kref *kref);
 310
 311 /**
 312  * drm_crtc_commit_get - acquire a reference to the CRTC commit
 313  * @commit: CRTC commit
 314  *
 315  * Increases the reference of @commit.
 316  *
 317  * Returns:
 318  * The pointer to @commit, with reference increased.
 319  */
 320 static inline struct drm_crtc_commit *drm_crtc_commit_get(struct drm_crtc_commit *commit)
 321 {
 322         kref_get(&commit->ref);
 323         return commit;
 324 }
 325
 326 /**
 327  * drm_crtc_commit_put - release a reference to the CRTC commmit
 328  * @commit: CRTC commit
 329  *
 330  * This releases a reference to @commit which is freed after removing the
 331  * final reference. No locking required and callable from any context.
 332  */
 333 static inline void drm_crtc_commit_put(struct drm_crtc_commit *commit)
 334 {
 335         kref_put(&commit->ref, __drm_crtc_commit_free);
 336 }
 337
 338 struct drm_atomic_state * __must_check
 339 drm_atomic_state_alloc(struct drm_device *dev);
 340 void drm_atomic_state_clear(struct drm_atomic_state *state);
 341
 342 /**
 343  * drm_atomic_state_get - acquire a reference to the atomic state
 344  * @state: The atomic state
 345  *
 346  * Returns a new reference to the @state
 347  */
 348 static inline struct drm_atomic_state *
 349 drm_atomic_state_get(struct drm_atomic_state *state)
 350 {
 351         kref_get(&state->ref);
 352         return state;
 353 }
 354
 355 void __drm_atomic_state_free(struct kref *ref);
 356
 357 /**
 358  * drm_atomic_state_put - release a reference to the atomic state
 359  * @state: The atomic state
 360  *
 361  * This releases a reference to @state which is freed after removing the
 362  * final reference. No locking required and callable from any context.
 363  */
 364 static inline void drm_atomic_state_put(struct drm_atomic_state *state)
 365 {
 366         kref_put(&state->ref, __drm_atomic_state_free);
 367 }
 368
 369 int  __must_check
 370 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state);
 371 void drm_atomic_state_default_clear(struct drm_atomic_state *state);
 372 void drm_atomic_state_default_release(struct drm_atomic_state *state);
 373
 374 struct drm_crtc_state * __must_check
 375 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
 376                           struct drm_crtc *crtc);
 377 int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
 378                 struct drm_crtc_state *state, struct drm_property *property,
 379                 uint64_t val);
 380 struct drm_plane_state * __must_check
 381 drm_atomic_get_plane_state(struct drm_atomic_state *state,
 382                            struct drm_plane *plane);
 383 struct drm_connector_state * __must_check
 384 drm_atomic_get_connector_state(struct drm_atomic_state *state,
 385                                struct drm_connector *connector);
 386
 387 void drm_atomic_private_obj_init(struct drm_private_obj *obj,
 388                                  struct drm_private_state *state,
 389                                  const struct drm_private_state_funcs *funcs);
 390 void drm_atomic_private_obj_fini(struct drm_private_obj *obj);
 391
 392 struct drm_private_state * __must_check
 393 drm_atomic_get_private_obj_state(struct drm_atomic_state *state,
 394                                  struct drm_private_obj *obj);
 395
 396 /**
 397  * drm_atomic_get_existing_crtc_state - get crtc state, if it exists
 398  * @state: global atomic state object
 399  * @crtc: crtc to grab
 400  *
 401  * This function returns the crtc state for the given crtc, or NULL
 402  * if the crtc is not part of the global atomic state.
 403  *
 404  * This function is deprecated, @drm_atomic_get_old_crtc_state or
 405  * @drm_atomic_get_new_crtc_state should be used instead.
 406  */
 407 static inline struct drm_crtc_state *
 408 drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state,
 409                                    struct drm_crtc *crtc)
 410 {
 411         return state->crtcs[drm_crtc_index(crtc)].state;
 412 }
 413
 414 /**
 415  * drm_atomic_get_old_crtc_state - get old crtc state, if it exists
 416  * @state: global atomic state object
 417  * @crtc: crtc to grab
 418  *
 419  * This function returns the old crtc state for the given crtc, or
 420  * NULL if the crtc is not part of the global atomic state.
 421  */
 422 static inline struct drm_crtc_state *
 423 drm_atomic_get_old_crtc_state(struct drm_atomic_state *state,
 424                               struct drm_crtc *crtc)
 425 {
 426         return state->crtcs[drm_crtc_index(crtc)].old_state;
 427 }
 428 /**
 429  * drm_atomic_get_new_crtc_state - get new crtc state, if it exists
 430  * @state: global atomic state object
 431  * @crtc: crtc to grab
 432  *
 433  * This function returns the new crtc state for the given crtc, or
 434  * NULL if the crtc is not part of the global atomic state.
 435  */
 436 static inline struct drm_crtc_state *
 437 drm_atomic_get_new_crtc_state(struct drm_atomic_state *state,
 438                               struct drm_crtc *crtc)
 439 {
 440         return state->crtcs[drm_crtc_index(crtc)].new_state;
 441 }
 442
 443 /**
 444  * drm_atomic_get_existing_plane_state - get plane state, if it exists
 445  * @state: global atomic state object
 446  * @plane: plane to grab
 447  *
 448  * This function returns the plane state for the given plane, or NULL
 449  * if the plane is not part of the global atomic state.
 450  *
 451  * This function is deprecated, @drm_atomic_get_old_plane_state or
 452  * @drm_atomic_get_new_plane_state should be used instead.
 453  */
 454 static inline struct drm_plane_state *
 455 drm_atomic_get_existing_plane_state(struct drm_atomic_state *state,
 456                                     struct drm_plane *plane)
 457 {
 458         return state->planes[drm_plane_index(plane)].state;
 459 }
 460
 461 /**
 462  * drm_atomic_get_old_plane_state - get plane state, if it exists
 463  * @state: global atomic state object
 464  * @plane: plane to grab
 465  *
 466  * This function returns the old plane state for the given plane, or
 467  * NULL if the plane is not part of the global atomic state.
 468  */
 469 static inline struct drm_plane_state *
 470 drm_atomic_get_old_plane_state(struct drm_atomic_state *state,
 471                                struct drm_plane *plane)
 472 {
 473         return state->planes[drm_plane_index(plane)].old_state;
 474 }
 475
 476 /**
 477  * drm_atomic_get_new_plane_state - get plane state, if it exists
 478  * @state: global atomic state object
 479  * @plane: plane to grab
 480  *
 481  * This function returns the new plane state for the given plane, or
 482  * NULL if the plane is not part of the global atomic state.
 483  */
 484 static inline struct drm_plane_state *
 485 drm_atomic_get_new_plane_state(struct drm_atomic_state *state,
 486                                struct drm_plane *plane)
 487 {
 488         return state->planes[drm_plane_index(plane)].new_state;
 489 }
 490
 491 /**
 492  * drm_atomic_get_existing_connector_state - get connector state, if it exists
 493  * @state: global atomic state object
 494  * @connector: connector to grab
 495  *
 496  * This function returns the connector state for the given connector,
 497  * or NULL if the connector is not part of the global atomic state.
 498  *
 499  * This function is deprecated, @drm_atomic_get_old_connector_state or
 500  * @drm_atomic_get_new_connector_state should be used instead.
 501  */
 502 static inline struct drm_connector_state *
 503 drm_atomic_get_existing_connector_state(struct drm_atomic_state *state,
 504                                         struct drm_connector *connector)
 505 {
 506         int index = drm_connector_index(connector);
 507
 508         if (index >= state->num_connector)
 509                 return NULL;
 510
 511         return state->connectors[index].state;
 512 }
 513
 514 /**
 515  * drm_atomic_get_old_connector_state - get connector state, if it exists
 516  * @state: global atomic state object
 517  * @connector: connector to grab
 518  *
 519  * This function returns the old connector state for the given connector,
 520  * or NULL if the connector is not part of the global atomic state.
 521  */
 522 static inline struct drm_connector_state *
 523 drm_atomic_get_old_connector_state(struct drm_atomic_state *state,
 524                                    struct drm_connector *connector)
 525 {
 526         int index = drm_connector_index(connector);
 527
 528         if (index >= state->num_connector)
 529                 return NULL;
 530
 531         return state->connectors[index].old_state;
 532 }
 533
 534 /**
 535  * drm_atomic_get_new_connector_state - get connector state, if it exists
 536  * @state: global atomic state object
 537  * @connector: connector to grab
 538  *
 539  * This function returns the new connector state for the given connector,
 540  * or NULL if the connector is not part of the global atomic state.
 541  */
 542 static inline struct drm_connector_state *
 543 drm_atomic_get_new_connector_state(struct drm_atomic_state *state,
 544                                    struct drm_connector *connector)
 545 {
 546         int index = drm_connector_index(connector);
 547
 548         if (index >= state->num_connector)
 549                 return NULL;
 550
 551         return state->connectors[index].new_state;
 552 }
 553
 554 /**
 555  * __drm_atomic_get_current_plane_state - get current plane state
 556  * @state: global atomic state object
 557  * @plane: plane to grab
 558  *
 559  * This function returns the plane state for the given plane, either from
 560  * @state, or if the plane isn't part of the atomic state update, from @plane.
 561  * This is useful in atomic check callbacks, when drivers need to peek at, but
 562  * not change, state of other planes, since it avoids threading an error code
 563  * back up the call chain.
 564  *
 565  * WARNING:
 566  *
 567  * Note that this function is in general unsafe since it doesn't check for the
 568  * required locking for access state structures. Drivers must ensure that it is
 569  * safe to access the returned state structure through other means. One common
 570  * example is when planes are fixed to a single CRTC, and the driver knows that
 571  * the CRTC lock is held already. In that case holding the CRTC lock gives a
 572  * read-lock on all planes connected to that CRTC. But if planes can be
 573  * reassigned things get more tricky. In that case it's better to use
 574  * drm_atomic_get_plane_state and wire up full error handling.
 575  *
 576  * Returns:
 577  *
 578  * Read-only pointer to the current plane state.
 579  */
 580 static inline const struct drm_plane_state *
 581 __drm_atomic_get_current_plane_state(struct drm_atomic_state *state,
 582                                      struct drm_plane *plane)
 583 {
 584         if (state->planes[drm_plane_index(plane)].state)
 585                 return state->planes[drm_plane_index(plane)].state;
 586
 587         return plane->state;
 588 }
 589
 590 int __must_check
 591 drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
 592                              const struct drm_display_mode *mode);
 593 int __must_check
 594 drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
 595                                   struct drm_property_blob *blob);
 596 int __must_check
 597 drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
 598                               struct drm_crtc *crtc);
 599 void drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
 600                                  struct drm_framebuffer *fb);
 601 void drm_atomic_set_fence_for_plane(struct drm_plane_state *plane_state,
 602                                     struct dma_fence *fence);
 603 int __must_check
 604 drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
 605                                   struct drm_crtc *crtc);
 606 int drm_atomic_set_writeback_fb_for_connector(
 607                 struct drm_connector_state *conn_state,
 608                 struct drm_framebuffer *fb);
 609 int __must_check
 610 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
 611                                    struct drm_crtc *crtc);
 612 int __must_check
 613 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
 614                                struct drm_crtc *crtc);
 615
 616 int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
 617 int __must_check drm_atomic_commit(struct drm_atomic_state *state);
 618 int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state);
 619
 620 void drm_state_dump(struct drm_device *dev, struct drm_printer *p);
 621
 622 /**
 623  * for_each_oldnew_connector_in_state - iterate over all connectors in an atomic update
 624  * @__state: &struct drm_atomic_state pointer
 625  * @connector: &struct drm_connector iteration cursor
 626  * @old_connector_state: &struct drm_connector_state iteration cursor for the
 627  *      old state
 628  * @new_connector_state: &struct drm_connector_state iteration cursor for the
 629  *      new state
 630  * @__i: int iteration cursor, for macro-internal use
 631  *
 632  * This iterates over all connectors in an atomic update, tracking both old and
 633  * new state. This is useful in places where the state delta needs to be
 634  * considered, for example in atomic check functions.
 635  */
 636 #define for_each_oldnew_connector_in_state(__state, connector, old_connector_state, new_connector_state, __i) \
 637         for ((__i) = 0;                                                         \
 638              (__i) < (__state)->num_connector;                                  \
 639              (__i)++)                                                           \
 640                 for_each_if ((__state)->connectors[__i].ptr &&                  \
 641                              ((connector) = (__state)->connectors[__i].ptr,     \
 642                              (old_connector_state) = (__state)->connectors[__i].old_state,      \
 643                              (new_connector_state) = (__state)->connectors[__i].new_state, 1))
 644
 645 /**
 646  * for_each_old_connector_in_state - iterate over all connectors in an atomic update
 647  * @__state: &struct drm_atomic_state pointer
 648  * @connector: &struct drm_connector iteration cursor
 649  * @old_connector_state: &struct drm_connector_state iteration cursor for the
 650  *      old state
 651  * @__i: int iteration cursor, for macro-internal use
 652  *
 653  * This iterates over all connectors in an atomic update, tracking only the old
 654  * state. This is useful in disable functions, where we need the old state the
 655  * hardware is still in.
 656  */
 657 #define for_each_old_connector_in_state(__state, connector, old_connector_state, __i) \
 658         for ((__i) = 0;                                                         \
 659              (__i) < (__state)->num_connector;                                  \
 660              (__i)++)                                                           \
 661                 for_each_if ((__state)->connectors[__i].ptr &&                  \
 662                              ((connector) = (__state)->connectors[__i].ptr,     \
 663                              (old_connector_state) = (__state)->connectors[__i].old_state, 1))
 664
 665 /**
 666  * for_each_new_connector_in_state - iterate over all connectors in an atomic update
 667  * @__state: &struct drm_atomic_state pointer
 668  * @connector: &struct drm_connector iteration cursor
 669  * @new_connector_state: &struct drm_connector_state iteration cursor for the
 670  *      new state
 671  * @__i: int iteration cursor, for macro-internal use
 672  *
 673  * This iterates over all connectors in an atomic update, tracking only the new
 674  * state. This is useful in enable functions, where we need the new state the
 675  * hardware should be in when the atomic commit operation has completed.
 676  */
 677 #define for_each_new_connector_in_state(__state, connector, new_connector_state, __i) \
 678         for ((__i) = 0;                                                         \
 679              (__i) < (__state)->num_connector;                                  \
 680              (__i)++)                                                           \
 681                 for_each_if ((__state)->connectors[__i].ptr &&                  \
 682                              ((connector) = (__state)->connectors[__i].ptr,     \
 683                              (new_connector_state) = (__state)->connectors[__i].new_state, 1))
 684
 685 /**
 686  * for_each_oldnew_crtc_in_state - iterate over all CRTCs in an atomic update
 687  * @__state: &struct drm_atomic_state pointer
 688  * @crtc: &struct drm_crtc iteration cursor
 689  * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
 690  * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
 691  * @__i: int iteration cursor, for macro-internal use
 692  *
 693  * This iterates over all CRTCs in an atomic update, tracking both old and
 694  * new state. This is useful in places where the state delta needs to be
 695  * considered, for example in atomic check functions.
 696  */
 697 #define for_each_oldnew_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \
 698         for ((__i) = 0;                                                 \
 699              (__i) < (__state)->dev->mode_config.num_crtc;              \
 700              (__i)++)                                                   \
 701                 for_each_if ((__state)->crtcs[__i].ptr &&               \
 702                              ((crtc) = (__state)->crtcs[__i].ptr,       \
 703                              (old_crtc_state) = (__state)->crtcs[__i].old_state, \
 704                              (new_crtc_state) = (__state)->crtcs[__i].new_state, 1))
 705
 706 /**
 707  * for_each_old_crtc_in_state - iterate over all CRTCs in an atomic update
 708  * @__state: &struct drm_atomic_state pointer
 709  * @crtc: &struct drm_crtc iteration cursor
 710  * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
 711  * @__i: int iteration cursor, for macro-internal use
 712  *
 713  * This iterates over all CRTCs in an atomic update, tracking only the old
 714  * state. This is useful in disable functions, where we need the old state the
 715  * hardware is still in.
 716  */
 717 #define for_each_old_crtc_in_state(__state, crtc, old_crtc_state, __i)  \
 718         for ((__i) = 0;                                                 \
 719              (__i) < (__state)->dev->mode_config.num_crtc;              \
 720              (__i)++)                                                   \
 721                 for_each_if ((__state)->crtcs[__i].ptr &&               \
 722                              ((crtc) = (__state)->crtcs[__i].ptr,       \
 723                              (old_crtc_state) = (__state)->crtcs[__i].old_state, 1))
 724
 725 /**
 726  * for_each_new_crtc_in_state - iterate over all CRTCs in an atomic update
 727  * @__state: &struct drm_atomic_state pointer
 728  * @crtc: &struct drm_crtc iteration cursor
 729  * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
 730  * @__i: int iteration cursor, for macro-internal use
 731  *
 732  * This iterates over all CRTCs in an atomic update, tracking only the new
 733  * state. This is useful in enable functions, where we need the new state the
 734  * hardware should be in when the atomic commit operation has completed.
 735  */
 736 #define for_each_new_crtc_in_state(__state, crtc, new_crtc_state, __i)  \
 737         for ((__i) = 0;                                                 \
 738              (__i) < (__state)->dev->mode_config.num_crtc;              \
 739              (__i)++)                                                   \
 740                 for_each_if ((__state)->crtcs[__i].ptr &&               \
 741                              ((crtc) = (__state)->crtcs[__i].ptr,       \
 742                              (new_crtc_state) = (__state)->crtcs[__i].new_state, 1))
 743
 744 /**
 745  * for_each_oldnew_plane_in_state - iterate over all planes in an atomic update
 746  * @__state: &struct drm_atomic_state pointer
 747  * @plane: &struct drm_plane iteration cursor
 748  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
 749  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
 750  * @__i: int iteration cursor, for macro-internal use
 751  *
 752  * This iterates over all planes in an atomic update, tracking both old and
 753  * new state. This is useful in places where the state delta needs to be
 754  * considered, for example in atomic check functions.
 755  */
 756 #define for_each_oldnew_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \
 757         for ((__i) = 0;                                                 \
 758              (__i) < (__state)->dev->mode_config.num_total_plane;       \
 759              (__i)++)                                                   \
 760                 for_each_if ((__state)->planes[__i].ptr &&              \
 761                              ((plane) = (__state)->planes[__i].ptr,     \
 762                               (old_plane_state) = (__state)->planes[__i].old_state,\
 763                               (new_plane_state) = (__state)->planes[__i].new_state, 1))
 764
 765 /**
 766  * for_each_oldnew_plane_in_state_reverse - iterate over all planes in an atomic
 767  * update in reverse order
 768  * @__state: &struct drm_atomic_state pointer
 769  * @plane: &struct drm_plane iteration cursor
 770  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
 771  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
 772  * @__i: int iteration cursor, for macro-internal use
 773  *
 774  * This iterates over all planes in an atomic update in reverse order,
 775  * tracking both old and  new state. This is useful in places where the
 776  * state delta needs to be considered, for example in atomic check functions.
 777  */
 778 #define for_each_oldnew_plane_in_state_reverse(__state, plane, old_plane_state, new_plane_state, __i) \
 779         for ((__i) = ((__state)->dev->mode_config.num_total_plane - 1); \
 780              (__i) >= 0;                                                \
 781              (__i)--)                                                   \
 782                 for_each_if ((__state)->planes[__i].ptr &&              \
 783                              ((plane) = (__state)->planes[__i].ptr,     \
 784                               (old_plane_state) = (__state)->planes[__i].old_state,\
 785                               (new_plane_state) = (__state)->planes[__i].new_state, 1))
 786
 787 /**
 788  * for_each_old_plane_in_state - iterate over all planes in an atomic update
 789  * @__state: &struct drm_atomic_state pointer
 790  * @plane: &struct drm_plane iteration cursor
 791  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
 792  * @__i: int iteration cursor, for macro-internal use
 793  *
 794  * This iterates over all planes in an atomic update, tracking only the old
 795  * state. This is useful in disable functions, where we need the old state the
 796  * hardware is still in.
 797  */
 798 #define for_each_old_plane_in_state(__state, plane, old_plane_state, __i) \
 799         for ((__i) = 0;                                                 \
 800              (__i) < (__state)->dev->mode_config.num_total_plane;       \
 801              (__i)++)                                                   \
 802                 for_each_if ((__state)->planes[__i].ptr &&              \
 803                              ((plane) = (__state)->planes[__i].ptr,     \
 804                               (old_plane_state) = (__state)->planes[__i].old_state, 1))
 805 /**
 806  * for_each_new_plane_in_state - iterate over all planes in an atomic update
 807  * @__state: &struct drm_atomic_state pointer
 808  * @plane: &struct drm_plane iteration cursor
 809  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
 810  * @__i: int iteration cursor, for macro-internal use
 811  *
 812  * This iterates over all planes in an atomic update, tracking only the new
 813  * state. This is useful in enable functions, where we need the new state the
 814  * hardware should be in when the atomic commit operation has completed.
 815  */
 816 #define for_each_new_plane_in_state(__state, plane, new_plane_state, __i) \
 817         for ((__i) = 0;                                                 \
 818              (__i) < (__state)->dev->mode_config.num_total_plane;       \
 819              (__i)++)                                                   \
 820                 for_each_if ((__state)->planes[__i].ptr &&              \
 821                              ((plane) = (__state)->planes[__i].ptr,     \
 822                               (new_plane_state) = (__state)->planes[__i].new_state, 1))
 823
 824 /**
 825  * for_each_oldnew_private_obj_in_state - iterate over all private objects in an atomic update
 826  * @__state: &struct drm_atomic_state pointer
 827  * @obj: &struct drm_private_obj iteration cursor
 828  * @old_obj_state: &struct drm_private_state iteration cursor for the old state
 829  * @new_obj_state: &struct drm_private_state iteration cursor for the new state
 830  * @__i: int iteration cursor, for macro-internal use
 831  *
 832  * This iterates over all private objects in an atomic update, tracking both
 833  * old and new state. This is useful in places where the state delta needs
 834  * to be considered, for example in atomic check functions.
 835  */
 836 #define for_each_oldnew_private_obj_in_state(__state, obj, old_obj_state, new_obj_state, __i) \
 837         for ((__i) = 0; \
 838              (__i) < (__state)->num_private_objs && \
 839                      ((obj) = (__state)->private_objs[__i].ptr, \
 840                       (old_obj_state) = (__state)->private_objs[__i].old_state, \
 841                       (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
 842              (__i)++)
 843
 844 /**
 845  * for_each_old_private_obj_in_state - iterate over all private objects in an atomic update
 846  * @__state: &struct drm_atomic_state pointer
 847  * @obj: &struct drm_private_obj iteration cursor
 848  * @old_obj_state: &struct drm_private_state iteration cursor for the old state
 849  * @__i: int iteration cursor, for macro-internal use
 850  *
 851  * This iterates over all private objects in an atomic update, tracking only
 852  * the old state. This is useful in disable functions, where we need the old
 853  * state the hardware is still in.
 854  */
 855 #define for_each_old_private_obj_in_state(__state, obj, old_obj_state, __i) \
 856         for ((__i) = 0; \
 857              (__i) < (__state)->num_private_objs && \
 858                      ((obj) = (__state)->private_objs[__i].ptr, \
 859                       (old_obj_state) = (__state)->private_objs[__i].old_state, 1); \
 860              (__i)++)
 861
 862 /**
 863  * for_each_new_private_obj_in_state - iterate over all private objects in an atomic update
 864  * @__state: &struct drm_atomic_state pointer
 865  * @obj: &struct drm_private_obj iteration cursor
 866  * @new_obj_state: &struct drm_private_state iteration cursor for the new state
 867  * @__i: int iteration cursor, for macro-internal use
 868  *
 869  * This iterates over all private objects in an atomic update, tracking only
 870  * the new state. This is useful in enable functions, where we need the new state the
 871  * hardware should be in when the atomic commit operation has completed.
 872  */
 873 #define for_each_new_private_obj_in_state(__state, obj, new_obj_state, __i) \
 874         for ((__i) = 0; \
 875              (__i) < (__state)->num_private_objs && \
 876                      ((obj) = (__state)->private_objs[__i].ptr, \
 877                       (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
 878              (__i)++)
 879
 880 /**
 881  * drm_atomic_crtc_needs_modeset - compute combined modeset need
 882  * @state: &drm_crtc_state for the CRTC
 883  *
 884  * To give drivers flexibility &struct drm_crtc_state has 3 booleans to track
 885  * whether the state CRTC changed enough to need a full modeset cycle:
 886  * mode_changed, active_changed and connectors_changed. This helper simply
 887  * combines these three to compute the overall need for a modeset for @state.
 888  *
 889  * The atomic helper code sets these booleans, but drivers can and should
 890  * change them appropriately to accurately represent whether a modeset is
 891  * really needed. In general, drivers should avoid full modesets whenever
 892  * possible.
 893  *
 894  * For example if the CRTC mode has changed, and the hardware is able to enact
 895  * the requested mode change without going through a full modeset, the driver
 896  * should clear mode_changed in its &drm_mode_config_funcs.atomic_check
 897  * implementation.
 898  */
 899 static inline bool
 900 drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state)
 901 {
 902         return state->mode_changed || state->active_changed ||
 903                state->connectors_changed;
 904 }
 905
 906 #endif /* DRM_ATOMIC_H_ */