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