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          * Completion of this stage is signalled implicitly by calling
  97          * drm_crtc_send_vblank_event() on &drm_crtc_state.event.
  98          */
  99         struct completion flip_done;
 100
 101         /**
 102          * @hw_done:
 103          *
 104          * Will be signalled when all hw register changes for this commit have
 105          * been written out. Especially when disabling a pipe this can be much
 106          * later than @flip_done, since that can signal already when the
 107          * screen goes black, whereas to fully shut down a pipe more register
 108          * I/O is required.
 109          *
 110          * Note that this does not need to include separately reference-counted
 111          * resources like backing storage buffer pinning, or runtime pm
 112          * management.
 113          *
 114          * Drivers should call drm_atomic_helper_commit_hw_done() to signal
 115          * completion of this stage.
 116          */
 117         struct completion hw_done;
 118
 119         /**
 120          * @cleanup_done:
 121          *
 122          * Will be signalled after old buffers have been cleaned up by calling
 123          * drm_atomic_helper_cleanup_planes(). Since this can only happen after
 124          * a vblank wait completed it might be a bit later. This completion is
 125          * useful to throttle updates and avoid hardware updates getting ahead
 126          * of the buffer cleanup too much.
 127          *
 128          * Drivers should call drm_atomic_helper_commit_cleanup_done() to signal
 129          * completion of this stage.
 130          */
 131         struct completion cleanup_done;
 132
 133         /**
 134          * @commit_entry:
 135          *
 136          * Entry on the per-CRTC &drm_crtc.commit_list. Protected by
 137          * $drm_crtc.commit_lock.
 138          */
 139         struct list_head commit_entry;
 140
 141         /**
 142          * @event:
 143          *
 144          * &drm_pending_vblank_event pointer to clean up private events.
 145          */
 146         struct drm_pending_vblank_event *event;
 147
 148         /**
 149          * @abort_completion:
 150          *
 151          * A flag that's set after drm_atomic_helper_setup_commit() takes a
 152          * second reference for the completion of $drm_crtc_state.event. It's
 153          * used by the free code to remove the second reference if commit fails.
 154          */
 155         bool abort_completion;
 156 };
 157
 158 struct __drm_planes_state {
 159         struct drm_plane *ptr;
 160         struct drm_plane_state *state, *old_state, *new_state;
 161 };
 162
 163 struct __drm_crtcs_state {
 164         struct drm_crtc *ptr;
 165         struct drm_crtc_state *state, *old_state, *new_state;
 166
 167         /**
 168          * @commit:
 169          *
 170          * A reference to the CRTC commit object that is kept for use by
 171          * drm_atomic_helper_wait_for_flip_done() after
 172          * drm_atomic_helper_commit_hw_done() is called. This ensures that a
 173          * concurrent commit won't free a commit object that is still in use.
 174          */
 175         struct drm_crtc_commit *commit;
 176
 177         s32 __user *out_fence_ptr;
 178         u64 last_vblank_count;
 179 };
 180
 181 struct __drm_connnectors_state {
 182         struct drm_connector *ptr;
 183         struct drm_connector_state *state, *old_state, *new_state;
 184         /**
 185          * @out_fence_ptr:
 186          *
 187          * User-provided pointer which the kernel uses to return a sync_file
 188          * file descriptor. Used by writeback connectors to signal completion of
 189          * the writeback.
 190          */
 191         s32 __user *out_fence_ptr;
 192 };
 193
 194 struct drm_private_obj;
 195 struct drm_private_state;
 196
 197 /**
 198  * struct drm_private_state_funcs - atomic state functions for private objects
 199  *
 200  * These hooks are used by atomic helpers to create, swap and destroy states of
 201  * private objects. The structure itself is used as a vtable to identify the
 202  * associated private object type. Each private object type that needs to be
 203  * added to the atomic states is expected to have an implementation of these
 204  * hooks and pass a pointer to its drm_private_state_funcs struct to
 205  * drm_atomic_get_private_obj_state().
 206  */
 207 struct drm_private_state_funcs {
 208         /**
 209          * @atomic_duplicate_state:
 210          *
 211          * Duplicate the current state of the private object and return it. It
 212          * is an error to call this before obj->state has been initialized.
 213          *
 214          * RETURNS:
 215          *
 216          * Duplicated atomic state or NULL when obj->state is not
 217          * initialized or allocation failed.
 218          */
 219         struct drm_private_state *(*atomic_duplicate_state)(struct drm_private_obj *obj);
 220
 221         /**
 222          * @atomic_destroy_state:
 223          *
 224          * Frees the private object state created with @atomic_duplicate_state.
 225          */
 226         void (*atomic_destroy_state)(struct drm_private_obj *obj,
 227                                      struct drm_private_state *state);
 228 };
 229
 230 /**
 231  * struct drm_private_obj - base struct for driver private atomic object
 232  *
 233  * A driver private object is initialized by calling
 234  * drm_atomic_private_obj_init() and cleaned up by calling
 235  * drm_atomic_private_obj_fini().
 236  *
 237  * Currently only tracks the state update functions and the opaque driver
 238  * private state itself, but in the future might also track which
 239  * &drm_modeset_lock is required to duplicate and update this object's state.
 240  *
 241  * All private objects must be initialized before the DRM device they are
 242  * attached to is registered to the DRM subsystem (call to drm_dev_register())
 243  * and should stay around until this DRM device is unregistered (call to
 244  * drm_dev_unregister()). In other words, private objects lifetime is tied
 245  * to the DRM device lifetime. This implies that:
 246  *
 247  * 1/ all calls to drm_atomic_private_obj_init() must be done before calling
 248  *    drm_dev_register()
 249  * 2/ all calls to drm_atomic_private_obj_fini() must be done after calling
 250  *    drm_dev_unregister()
 251  */
 252 struct drm_private_obj {
 253         /**
 254          * @head: List entry used to attach a private object to a &drm_device
 255          * (queued to &drm_mode_config.privobj_list).
 256          */
 257         struct list_head head;
 258
 259         /**
 260          * @lock: Modeset lock to protect the state object.
 261          */
 262         struct drm_modeset_lock lock;
 263
 264         /**
 265          * @state: Current atomic state for this driver private object.
 266          */
 267         struct drm_private_state *state;
 268
 269         /**
 270          * @funcs:
 271          *
 272          * Functions to manipulate the state of this driver private object, see
 273          * &drm_private_state_funcs.
 274          */
 275         const struct drm_private_state_funcs *funcs;
 276 };
 277
 278 /**
 279  * drm_for_each_privobj() - private object iterator
 280  *
 281  * @privobj: pointer to the current private object. Updated after each
 282  *           iteration
 283  * @dev: the DRM device we want get private objects from
 284  *
 285  * Allows one to iterate over all private objects attached to @dev
 286  */
 287 #define drm_for_each_privobj(privobj, dev) \
 288         list_for_each_entry(privobj, &(dev)->mode_config.privobj_list, head)
 289
 290 /**
 291  * struct drm_private_state - base struct for driver private object state
 292  * @state: backpointer to global drm_atomic_state
 293  *
 294  * Currently only contains a backpointer to the overall atomic update, but in
 295  * the future also might hold synchronization information similar to e.g.
 296  * &drm_crtc.commit.
 297  */
 298 struct drm_private_state {
 299         struct drm_atomic_state *state;
 300 };
 301
 302 struct __drm_private_objs_state {
 303         struct drm_private_obj *ptr;
 304         struct drm_private_state *state, *old_state, *new_state;
 305 };
 306
 307 /**
 308  * struct drm_atomic_state - the global state object for atomic updates
 309  * @ref: count of all references to this state (will not be freed until zero)
 310  * @dev: parent DRM device
 311  * @async_update: hint for asynchronous plane update
 312  * @planes: pointer to array of structures with per-plane data
 313  * @crtcs: pointer to array of CRTC pointers
 314  * @num_connector: size of the @connectors and @connector_states arrays
 315  * @connectors: pointer to array of structures with per-connector data
 316  * @num_private_objs: size of the @private_objs array
 317  * @private_objs: pointer to array of private object pointers
 318  * @acquire_ctx: acquire context for this atomic modeset state update
 319  *
 320  * States are added to an atomic update by calling drm_atomic_get_crtc_state(),
 321  * drm_atomic_get_plane_state(), drm_atomic_get_connector_state(), or for
 322  * private state structures, drm_atomic_get_private_obj_state().
 323  */
 324 struct drm_atomic_state {
 325         struct kref ref;
 326
 327         struct drm_device *dev;
 328
 329         /**
 330          * @allow_modeset:
 331          *
 332          * Allow full modeset. This is used by the ATOMIC IOCTL handler to
 333          * implement the DRM_MODE_ATOMIC_ALLOW_MODESET flag. Drivers should
 334          * never consult this flag, instead looking at the output of
 335          * drm_atomic_crtc_needs_modeset().
 336          */
 337         bool allow_modeset : 1;
 338         /**
 339          * @legacy_cursor_update:
 340          *
 341          * Hint to enforce legacy cursor IOCTL semantics.
 342          *
 343          * WARNING: This is thoroughly broken and pretty much impossible to
 344          * implement correctly. Drivers must ignore this and should instead
 345          * implement &drm_plane_helper_funcs.atomic_async_check and
 346          * &drm_plane_helper_funcs.atomic_async_commit hooks. New users of this
 347          * flag are not allowed.
 348          */
 349         bool legacy_cursor_update : 1;
 350         bool async_update : 1;
 351         /**
 352          * @duplicated:
 353          *
 354          * Indicates whether or not this atomic state was duplicated using
 355          * drm_atomic_helper_duplicate_state(). Drivers and atomic helpers
 356          * should use this to fixup normal  inconsistencies in duplicated
 357          * states.
 358          */
 359         bool duplicated : 1;
 360         struct __drm_planes_state *planes;
 361         struct __drm_crtcs_state *crtcs;
 362         int num_connector;
 363         struct __drm_connnectors_state *connectors;
 364         int num_private_objs;
 365         struct __drm_private_objs_state *private_objs;
 366
 367         struct drm_modeset_acquire_ctx *acquire_ctx;
 368
 369         /**
 370          * @fake_commit:
 371          *
 372          * Used for signaling unbound planes/connectors.
 373          * When a connector or plane is not bound to any CRTC, it's still important
 374          * to preserve linearity to prevent the atomic states from being freed to early.
 375          *
 376          * This commit (if set) is not bound to any CRTC, but will be completed when
 377          * drm_atomic_helper_commit_hw_done() is called.
 378          */
 379         struct drm_crtc_commit *fake_commit;
 380
 381         /**
 382          * @commit_work:
 383          *
 384          * Work item which can be used by the driver or helpers to execute the
 385          * commit without blocking.
 386          */
 387         struct work_struct commit_work;
 388 };
 389
 390 void __drm_crtc_commit_free(struct kref *kref);
 391
 392 /**
 393  * drm_crtc_commit_get - acquire a reference to the CRTC commit
 394  * @commit: CRTC commit
 395  *
 396  * Increases the reference of @commit.
 397  *
 398  * Returns:
 399  * The pointer to @commit, with reference increased.
 400  */
 401 static inline struct drm_crtc_commit *drm_crtc_commit_get(struct drm_crtc_commit *commit)
 402 {
 403         kref_get(&commit->ref);
 404         return commit;
 405 }
 406
 407 /**
 408  * drm_crtc_commit_put - release a reference to the CRTC commmit
 409  * @commit: CRTC commit
 410  *
 411  * This releases a reference to @commit which is freed after removing the
 412  * final reference. No locking required and callable from any context.
 413  */
 414 static inline void drm_crtc_commit_put(struct drm_crtc_commit *commit)
 415 {
 416         kref_put(&commit->ref, __drm_crtc_commit_free);
 417 }
 418
 419 struct drm_atomic_state * __must_check
 420 drm_atomic_state_alloc(struct drm_device *dev);
 421 void drm_atomic_state_clear(struct drm_atomic_state *state);
 422
 423 /**
 424  * drm_atomic_state_get - acquire a reference to the atomic state
 425  * @state: The atomic state
 426  *
 427  * Returns a new reference to the @state
 428  */
 429 static inline struct drm_atomic_state *
 430 drm_atomic_state_get(struct drm_atomic_state *state)
 431 {
 432         kref_get(&state->ref);
 433         return state;
 434 }
 435
 436 void __drm_atomic_state_free(struct kref *ref);
 437
 438 /**
 439  * drm_atomic_state_put - release a reference to the atomic state
 440  * @state: The atomic state
 441  *
 442  * This releases a reference to @state which is freed after removing the
 443  * final reference. No locking required and callable from any context.
 444  */
 445 static inline void drm_atomic_state_put(struct drm_atomic_state *state)
 446 {
 447         kref_put(&state->ref, __drm_atomic_state_free);
 448 }
 449
 450 int  __must_check
 451 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state);
 452 void drm_atomic_state_default_clear(struct drm_atomic_state *state);
 453 void drm_atomic_state_default_release(struct drm_atomic_state *state);
 454
 455 struct drm_crtc_state * __must_check
 456 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
 457                           struct drm_crtc *crtc);
 458 struct drm_plane_state * __must_check
 459 drm_atomic_get_plane_state(struct drm_atomic_state *state,
 460                            struct drm_plane *plane);
 461 struct drm_connector_state * __must_check
 462 drm_atomic_get_connector_state(struct drm_atomic_state *state,
 463                                struct drm_connector *connector);
 464
 465 void drm_atomic_private_obj_init(struct drm_device *dev,
 466                                  struct drm_private_obj *obj,
 467                                  struct drm_private_state *state,
 468                                  const struct drm_private_state_funcs *funcs);
 469 void drm_atomic_private_obj_fini(struct drm_private_obj *obj);
 470
 471 struct drm_private_state * __must_check
 472 drm_atomic_get_private_obj_state(struct drm_atomic_state *state,
 473                                  struct drm_private_obj *obj);
 474 struct drm_private_state *
 475 drm_atomic_get_old_private_obj_state(struct drm_atomic_state *state,
 476                                      struct drm_private_obj *obj);
 477 struct drm_private_state *
 478 drm_atomic_get_new_private_obj_state(struct drm_atomic_state *state,
 479                                      struct drm_private_obj *obj);
 480
 481 struct drm_connector *
 482 drm_atomic_get_old_connector_for_encoder(struct drm_atomic_state *state,
 483                                          struct drm_encoder *encoder);
 484 struct drm_connector *
 485 drm_atomic_get_new_connector_for_encoder(struct drm_atomic_state *state,
 486                                          struct drm_encoder *encoder);
 487
 488 /**
 489  * drm_atomic_get_existing_crtc_state - get CRTC state, if it exists
 490  * @state: global atomic state object
 491  * @crtc: CRTC to grab
 492  *
 493  * This function returns the CRTC state for the given CRTC, or NULL
 494  * if the CRTC is not part of the global atomic state.
 495  *
 496  * This function is deprecated, @drm_atomic_get_old_crtc_state or
 497  * @drm_atomic_get_new_crtc_state should be used instead.
 498  */
 499 static inline struct drm_crtc_state *
 500 drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state,
 501                                    struct drm_crtc *crtc)
 502 {
 503         return state->crtcs[drm_crtc_index(crtc)].state;
 504 }
 505
 506 /**
 507  * drm_atomic_get_old_crtc_state - get old CRTC state, if it exists
 508  * @state: global atomic state object
 509  * @crtc: CRTC to grab
 510  *
 511  * This function returns the old CRTC state for the given CRTC, or
 512  * NULL if the CRTC is not part of the global atomic state.
 513  */
 514 static inline struct drm_crtc_state *
 515 drm_atomic_get_old_crtc_state(struct drm_atomic_state *state,
 516                               struct drm_crtc *crtc)
 517 {
 518         return state->crtcs[drm_crtc_index(crtc)].old_state;
 519 }
 520 /**
 521  * drm_atomic_get_new_crtc_state - get new CRTC state, if it exists
 522  * @state: global atomic state object
 523  * @crtc: CRTC to grab
 524  *
 525  * This function returns the new CRTC state for the given CRTC, or
 526  * NULL if the CRTC is not part of the global atomic state.
 527  */
 528 static inline struct drm_crtc_state *
 529 drm_atomic_get_new_crtc_state(struct drm_atomic_state *state,
 530                               struct drm_crtc *crtc)
 531 {
 532         return state->crtcs[drm_crtc_index(crtc)].new_state;
 533 }
 534
 535 /**
 536  * drm_atomic_get_existing_plane_state - get plane state, if it exists
 537  * @state: global atomic state object
 538  * @plane: plane to grab
 539  *
 540  * This function returns the plane state for the given plane, or NULL
 541  * if the plane is not part of the global atomic state.
 542  *
 543  * This function is deprecated, @drm_atomic_get_old_plane_state or
 544  * @drm_atomic_get_new_plane_state should be used instead.
 545  */
 546 static inline struct drm_plane_state *
 547 drm_atomic_get_existing_plane_state(struct drm_atomic_state *state,
 548                                     struct drm_plane *plane)
 549 {
 550         return state->planes[drm_plane_index(plane)].state;
 551 }
 552
 553 /**
 554  * drm_atomic_get_old_plane_state - get plane state, if it exists
 555  * @state: global atomic state object
 556  * @plane: plane to grab
 557  *
 558  * This function returns the old plane state for the given plane, or
 559  * NULL if the plane is not part of the global atomic state.
 560  */
 561 static inline struct drm_plane_state *
 562 drm_atomic_get_old_plane_state(struct drm_atomic_state *state,
 563                                struct drm_plane *plane)
 564 {
 565         return state->planes[drm_plane_index(plane)].old_state;
 566 }
 567
 568 /**
 569  * drm_atomic_get_new_plane_state - get plane state, if it exists
 570  * @state: global atomic state object
 571  * @plane: plane to grab
 572  *
 573  * This function returns the new plane state for the given plane, or
 574  * NULL if the plane is not part of the global atomic state.
 575  */
 576 static inline struct drm_plane_state *
 577 drm_atomic_get_new_plane_state(struct drm_atomic_state *state,
 578                                struct drm_plane *plane)
 579 {
 580         return state->planes[drm_plane_index(plane)].new_state;
 581 }
 582
 583 /**
 584  * drm_atomic_get_existing_connector_state - get connector state, if it exists
 585  * @state: global atomic state object
 586  * @connector: connector to grab
 587  *
 588  * This function returns the connector state for the given connector,
 589  * or NULL if the connector is not part of the global atomic state.
 590  *
 591  * This function is deprecated, @drm_atomic_get_old_connector_state or
 592  * @drm_atomic_get_new_connector_state should be used instead.
 593  */
 594 static inline struct drm_connector_state *
 595 drm_atomic_get_existing_connector_state(struct drm_atomic_state *state,
 596                                         struct drm_connector *connector)
 597 {
 598         int index = drm_connector_index(connector);
 599
 600         if (index >= state->num_connector)
 601                 return NULL;
 602
 603         return state->connectors[index].state;
 604 }
 605
 606 /**
 607  * drm_atomic_get_old_connector_state - get connector state, if it exists
 608  * @state: global atomic state object
 609  * @connector: connector to grab
 610  *
 611  * This function returns the old connector state for the given connector,
 612  * or NULL if the connector is not part of the global atomic state.
 613  */
 614 static inline struct drm_connector_state *
 615 drm_atomic_get_old_connector_state(struct drm_atomic_state *state,
 616                                    struct drm_connector *connector)
 617 {
 618         int index = drm_connector_index(connector);
 619
 620         if (index >= state->num_connector)
 621                 return NULL;
 622
 623         return state->connectors[index].old_state;
 624 }
 625
 626 /**
 627  * drm_atomic_get_new_connector_state - get connector state, if it exists
 628  * @state: global atomic state object
 629  * @connector: connector to grab
 630  *
 631  * This function returns the new connector state for the given connector,
 632  * or NULL if the connector is not part of the global atomic state.
 633  */
 634 static inline struct drm_connector_state *
 635 drm_atomic_get_new_connector_state(struct drm_atomic_state *state,
 636                                    struct drm_connector *connector)
 637 {
 638         int index = drm_connector_index(connector);
 639
 640         if (index >= state->num_connector)
 641                 return NULL;
 642
 643         return state->connectors[index].new_state;
 644 }
 645
 646 /**
 647  * __drm_atomic_get_current_plane_state - get current plane state
 648  * @state: global atomic state object
 649  * @plane: plane to grab
 650  *
 651  * This function returns the plane state for the given plane, either from
 652  * @state, or if the plane isn't part of the atomic state update, from @plane.
 653  * This is useful in atomic check callbacks, when drivers need to peek at, but
 654  * not change, state of other planes, since it avoids threading an error code
 655  * back up the call chain.
 656  *
 657  * WARNING:
 658  *
 659  * Note that this function is in general unsafe since it doesn't check for the
 660  * required locking for access state structures. Drivers must ensure that it is
 661  * safe to access the returned state structure through other means. One common
 662  * example is when planes are fixed to a single CRTC, and the driver knows that
 663  * the CRTC lock is held already. In that case holding the CRTC lock gives a
 664  * read-lock on all planes connected to that CRTC. But if planes can be
 665  * reassigned things get more tricky. In that case it's better to use
 666  * drm_atomic_get_plane_state and wire up full error handling.
 667  *
 668  * Returns:
 669  *
 670  * Read-only pointer to the current plane state.
 671  */
 672 static inline const struct drm_plane_state *
 673 __drm_atomic_get_current_plane_state(struct drm_atomic_state *state,
 674                                      struct drm_plane *plane)
 675 {
 676         if (state->planes[drm_plane_index(plane)].state)
 677                 return state->planes[drm_plane_index(plane)].state;
 678
 679         return plane->state;
 680 }
 681
 682 int __must_check
 683 drm_atomic_add_encoder_bridges(struct drm_atomic_state *state,
 684                                struct drm_encoder *encoder);
 685 int __must_check
 686 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
 687                                    struct drm_crtc *crtc);
 688 int __must_check
 689 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
 690                                struct drm_crtc *crtc);
 691
 692 int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
 693 int __must_check drm_atomic_commit(struct drm_atomic_state *state);
 694 int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state);
 695
 696 void drm_state_dump(struct drm_device *dev, struct drm_printer *p);
 697
 698 /**
 699  * for_each_oldnew_connector_in_state - iterate over all connectors in an atomic update
 700  * @__state: &struct drm_atomic_state pointer
 701  * @connector: &struct drm_connector iteration cursor
 702  * @old_connector_state: &struct drm_connector_state iteration cursor for the
 703  *      old state
 704  * @new_connector_state: &struct drm_connector_state iteration cursor for the
 705  *      new state
 706  * @__i: int iteration cursor, for macro-internal use
 707  *
 708  * This iterates over all connectors in an atomic update, tracking both old and
 709  * new state. This is useful in places where the state delta needs to be
 710  * considered, for example in atomic check functions.
 711  */
 712 #define for_each_oldnew_connector_in_state(__state, connector, old_connector_state, new_connector_state, __i) \
 713         for ((__i) = 0;                                                         \
 714              (__i) < (__state)->num_connector;                                  \
 715              (__i)++)                                                           \
 716                 for_each_if ((__state)->connectors[__i].ptr &&                  \
 717                              ((connector) = (__state)->connectors[__i].ptr,     \
 718                              (void)(connector) /* Only to avoid unused-but-set-variable warning */, \
 719                              (old_connector_state) = (__state)->connectors[__i].old_state,      \
 720                              (new_connector_state) = (__state)->connectors[__i].new_state, 1))
 721
 722 /**
 723  * for_each_old_connector_in_state - iterate over all connectors in an atomic update
 724  * @__state: &struct drm_atomic_state pointer
 725  * @connector: &struct drm_connector iteration cursor
 726  * @old_connector_state: &struct drm_connector_state iteration cursor for the
 727  *      old state
 728  * @__i: int iteration cursor, for macro-internal use
 729  *
 730  * This iterates over all connectors in an atomic update, tracking only the old
 731  * state. This is useful in disable functions, where we need the old state the
 732  * hardware is still in.
 733  */
 734 #define for_each_old_connector_in_state(__state, connector, old_connector_state, __i) \
 735         for ((__i) = 0;                                                         \
 736              (__i) < (__state)->num_connector;                                  \
 737              (__i)++)                                                           \
 738                 for_each_if ((__state)->connectors[__i].ptr &&                  \
 739                              ((connector) = (__state)->connectors[__i].ptr,     \
 740                              (void)(connector) /* Only to avoid unused-but-set-variable warning */, \
 741                              (old_connector_state) = (__state)->connectors[__i].old_state, 1))
 742
 743 /**
 744  * for_each_new_connector_in_state - iterate over all connectors in an atomic update
 745  * @__state: &struct drm_atomic_state pointer
 746  * @connector: &struct drm_connector iteration cursor
 747  * @new_connector_state: &struct drm_connector_state iteration cursor for the
 748  *      new state
 749  * @__i: int iteration cursor, for macro-internal use
 750  *
 751  * This iterates over all connectors in an atomic update, tracking only the new
 752  * state. This is useful in enable functions, where we need the new state the
 753  * hardware should be in when the atomic commit operation has completed.
 754  */
 755 #define for_each_new_connector_in_state(__state, connector, new_connector_state, __i) \
 756         for ((__i) = 0;                                                         \
 757              (__i) < (__state)->num_connector;                                  \
 758              (__i)++)                                                           \
 759                 for_each_if ((__state)->connectors[__i].ptr &&                  \
 760                              ((connector) = (__state)->connectors[__i].ptr,     \
 761                              (void)(connector) /* Only to avoid unused-but-set-variable warning */, \
 762                              (new_connector_state) = (__state)->connectors[__i].new_state, \
 763                              (void)(new_connector_state) /* Only to avoid unused-but-set-variable warning */, 1))
 764
 765 /**
 766  * for_each_oldnew_crtc_in_state - iterate over all CRTCs in an atomic update
 767  * @__state: &struct drm_atomic_state pointer
 768  * @crtc: &struct drm_crtc iteration cursor
 769  * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
 770  * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
 771  * @__i: int iteration cursor, for macro-internal use
 772  *
 773  * This iterates over all CRTCs in an atomic update, tracking both old and
 774  * new state. This is useful in places where the state delta needs to be
 775  * considered, for example in atomic check functions.
 776  */
 777 #define for_each_oldnew_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \
 778         for ((__i) = 0;                                                 \
 779              (__i) < (__state)->dev->mode_config.num_crtc;              \
 780              (__i)++)                                                   \
 781                 for_each_if ((__state)->crtcs[__i].ptr &&               \
 782                              ((crtc) = (__state)->crtcs[__i].ptr,       \
 783                               (void)(crtc) /* Only to avoid unused-but-set-variable warning */, \
 784                              (old_crtc_state) = (__state)->crtcs[__i].old_state, \
 785                              (void)(old_crtc_state) /* Only to avoid unused-but-set-variable warning */, \
 786                              (new_crtc_state) = (__state)->crtcs[__i].new_state, \
 787                              (void)(new_crtc_state) /* Only to avoid unused-but-set-variable warning */, 1))
 788
 789 /**
 790  * for_each_old_crtc_in_state - iterate over all CRTCs in an atomic update
 791  * @__state: &struct drm_atomic_state pointer
 792  * @crtc: &struct drm_crtc iteration cursor
 793  * @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state
 794  * @__i: int iteration cursor, for macro-internal use
 795  *
 796  * This iterates over all CRTCs in an atomic update, tracking only the old
 797  * state. This is useful in disable functions, where we need the old state the
 798  * hardware is still in.
 799  */
 800 #define for_each_old_crtc_in_state(__state, crtc, old_crtc_state, __i)  \
 801         for ((__i) = 0;                                                 \
 802              (__i) < (__state)->dev->mode_config.num_crtc;              \
 803              (__i)++)                                                   \
 804                 for_each_if ((__state)->crtcs[__i].ptr &&               \
 805                              ((crtc) = (__state)->crtcs[__i].ptr,       \
 806                              (void)(crtc) /* Only to avoid unused-but-set-variable warning */, \
 807                              (old_crtc_state) = (__state)->crtcs[__i].old_state, 1))
 808
 809 /**
 810  * for_each_new_crtc_in_state - iterate over all CRTCs in an atomic update
 811  * @__state: &struct drm_atomic_state pointer
 812  * @crtc: &struct drm_crtc iteration cursor
 813  * @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state
 814  * @__i: int iteration cursor, for macro-internal use
 815  *
 816  * This iterates over all CRTCs in an atomic update, tracking only the new
 817  * state. This is useful in enable functions, where we need the new state the
 818  * hardware should be in when the atomic commit operation has completed.
 819  */
 820 #define for_each_new_crtc_in_state(__state, crtc, new_crtc_state, __i)  \
 821         for ((__i) = 0;                                                 \
 822              (__i) < (__state)->dev->mode_config.num_crtc;              \
 823              (__i)++)                                                   \
 824                 for_each_if ((__state)->crtcs[__i].ptr &&               \
 825                              ((crtc) = (__state)->crtcs[__i].ptr,       \
 826                              (void)(crtc) /* Only to avoid unused-but-set-variable warning */, \
 827                              (new_crtc_state) = (__state)->crtcs[__i].new_state, \
 828                              (void)(new_crtc_state) /* Only to avoid unused-but-set-variable warning */, 1))
 829
 830 /**
 831  * for_each_oldnew_plane_in_state - iterate over all planes in an atomic update
 832  * @__state: &struct drm_atomic_state pointer
 833  * @plane: &struct drm_plane iteration cursor
 834  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
 835  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
 836  * @__i: int iteration cursor, for macro-internal use
 837  *
 838  * This iterates over all planes in an atomic update, tracking both old and
 839  * new state. This is useful in places where the state delta needs to be
 840  * considered, for example in atomic check functions.
 841  */
 842 #define for_each_oldnew_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \
 843         for ((__i) = 0;                                                 \
 844              (__i) < (__state)->dev->mode_config.num_total_plane;       \
 845              (__i)++)                                                   \
 846                 for_each_if ((__state)->planes[__i].ptr &&              \
 847                              ((plane) = (__state)->planes[__i].ptr,     \
 848                               (void)(plane) /* Only to avoid unused-but-set-variable warning */, \
 849                               (old_plane_state) = (__state)->planes[__i].old_state,\
 850                               (new_plane_state) = (__state)->planes[__i].new_state, 1))
 851
 852 /**
 853  * for_each_oldnew_plane_in_state_reverse - iterate over all planes in an atomic
 854  * update in reverse order
 855  * @__state: &struct drm_atomic_state pointer
 856  * @plane: &struct drm_plane iteration cursor
 857  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
 858  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
 859  * @__i: int iteration cursor, for macro-internal use
 860  *
 861  * This iterates over all planes in an atomic update in reverse order,
 862  * tracking both old and  new state. This is useful in places where the
 863  * state delta needs to be considered, for example in atomic check functions.
 864  */
 865 #define for_each_oldnew_plane_in_state_reverse(__state, plane, old_plane_state, new_plane_state, __i) \
 866         for ((__i) = ((__state)->dev->mode_config.num_total_plane - 1); \
 867              (__i) >= 0;                                                \
 868              (__i)--)                                                   \
 869                 for_each_if ((__state)->planes[__i].ptr &&              \
 870                              ((plane) = (__state)->planes[__i].ptr,     \
 871                               (old_plane_state) = (__state)->planes[__i].old_state,\
 872                               (new_plane_state) = (__state)->planes[__i].new_state, 1))
 873
 874 /**
 875  * for_each_old_plane_in_state - iterate over all planes in an atomic update
 876  * @__state: &struct drm_atomic_state pointer
 877  * @plane: &struct drm_plane iteration cursor
 878  * @old_plane_state: &struct drm_plane_state iteration cursor for the old state
 879  * @__i: int iteration cursor, for macro-internal use
 880  *
 881  * This iterates over all planes in an atomic update, tracking only the old
 882  * state. This is useful in disable functions, where we need the old state the
 883  * hardware is still in.
 884  */
 885 #define for_each_old_plane_in_state(__state, plane, old_plane_state, __i) \
 886         for ((__i) = 0;                                                 \
 887              (__i) < (__state)->dev->mode_config.num_total_plane;       \
 888              (__i)++)                                                   \
 889                 for_each_if ((__state)->planes[__i].ptr &&              \
 890                              ((plane) = (__state)->planes[__i].ptr,     \
 891                               (old_plane_state) = (__state)->planes[__i].old_state, 1))
 892 /**
 893  * for_each_new_plane_in_state - iterate over all planes in an atomic update
 894  * @__state: &struct drm_atomic_state pointer
 895  * @plane: &struct drm_plane iteration cursor
 896  * @new_plane_state: &struct drm_plane_state iteration cursor for the new state
 897  * @__i: int iteration cursor, for macro-internal use
 898  *
 899  * This iterates over all planes in an atomic update, tracking only the new
 900  * state. This is useful in enable functions, where we need the new state the
 901  * hardware should be in when the atomic commit operation has completed.
 902  */
 903 #define for_each_new_plane_in_state(__state, plane, new_plane_state, __i) \
 904         for ((__i) = 0;                                                 \
 905              (__i) < (__state)->dev->mode_config.num_total_plane;       \
 906              (__i)++)                                                   \
 907                 for_each_if ((__state)->planes[__i].ptr &&              \
 908                              ((plane) = (__state)->planes[__i].ptr,     \
 909                               (void)(plane) /* Only to avoid unused-but-set-variable warning */, \
 910                               (new_plane_state) = (__state)->planes[__i].new_state, \
 911                               (void)(new_plane_state) /* Only to avoid unused-but-set-variable warning */, 1))
 912
 913 /**
 914  * for_each_oldnew_private_obj_in_state - iterate over all private objects in an atomic update
 915  * @__state: &struct drm_atomic_state pointer
 916  * @obj: &struct drm_private_obj iteration cursor
 917  * @old_obj_state: &struct drm_private_state iteration cursor for the old state
 918  * @new_obj_state: &struct drm_private_state iteration cursor for the new state
 919  * @__i: int iteration cursor, for macro-internal use
 920  *
 921  * This iterates over all private objects in an atomic update, tracking both
 922  * old and new state. This is useful in places where the state delta needs
 923  * to be considered, for example in atomic check functions.
 924  */
 925 #define for_each_oldnew_private_obj_in_state(__state, obj, old_obj_state, new_obj_state, __i) \
 926         for ((__i) = 0; \
 927              (__i) < (__state)->num_private_objs && \
 928                      ((obj) = (__state)->private_objs[__i].ptr, \
 929                       (old_obj_state) = (__state)->private_objs[__i].old_state, \
 930                       (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
 931              (__i)++)
 932
 933 /**
 934  * for_each_old_private_obj_in_state - iterate over all private objects in an atomic update
 935  * @__state: &struct drm_atomic_state pointer
 936  * @obj: &struct drm_private_obj iteration cursor
 937  * @old_obj_state: &struct drm_private_state iteration cursor for the old state
 938  * @__i: int iteration cursor, for macro-internal use
 939  *
 940  * This iterates over all private objects in an atomic update, tracking only
 941  * the old state. This is useful in disable functions, where we need the old
 942  * state the hardware is still in.
 943  */
 944 #define for_each_old_private_obj_in_state(__state, obj, old_obj_state, __i) \
 945         for ((__i) = 0; \
 946              (__i) < (__state)->num_private_objs && \
 947                      ((obj) = (__state)->private_objs[__i].ptr, \
 948                       (old_obj_state) = (__state)->private_objs[__i].old_state, 1); \
 949              (__i)++)
 950
 951 /**
 952  * for_each_new_private_obj_in_state - iterate over all private objects in an atomic update
 953  * @__state: &struct drm_atomic_state pointer
 954  * @obj: &struct drm_private_obj iteration cursor
 955  * @new_obj_state: &struct drm_private_state iteration cursor for the new state
 956  * @__i: int iteration cursor, for macro-internal use
 957  *
 958  * This iterates over all private objects in an atomic update, tracking only
 959  * the new state. This is useful in enable functions, where we need the new state the
 960  * hardware should be in when the atomic commit operation has completed.
 961  */
 962 #define for_each_new_private_obj_in_state(__state, obj, new_obj_state, __i) \
 963         for ((__i) = 0; \
 964              (__i) < (__state)->num_private_objs && \
 965                      ((obj) = (__state)->private_objs[__i].ptr, \
 966                       (new_obj_state) = (__state)->private_objs[__i].new_state, 1); \
 967              (__i)++)
 968
 969 /**
 970  * drm_atomic_crtc_needs_modeset - compute combined modeset need
 971  * @state: &drm_crtc_state for the CRTC
 972  *
 973  * To give drivers flexibility &struct drm_crtc_state has 3 booleans to track
 974  * whether the state CRTC changed enough to need a full modeset cycle:
 975  * mode_changed, active_changed and connectors_changed. This helper simply
 976  * combines these three to compute the overall need for a modeset for @state.
 977  *
 978  * The atomic helper code sets these booleans, but drivers can and should
 979  * change them appropriately to accurately represent whether a modeset is
 980  * really needed. In general, drivers should avoid full modesets whenever
 981  * possible.
 982  *
 983  * For example if the CRTC mode has changed, and the hardware is able to enact
 984  * the requested mode change without going through a full modeset, the driver
 985  * should clear mode_changed in its &drm_mode_config_funcs.atomic_check
 986  * implementation.
 987  */
 988 static inline bool
 989 drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state)
 990 {
 991         return state->mode_changed || state->active_changed ||
 992                state->connectors_changed;
 993 }
 994
 995 /**
 996  * drm_atomic_crtc_effectively_active - compute whether CRTC is actually active
 997  * @state: &drm_crtc_state for the CRTC
 998  *
 999  * When in self refresh mode, the crtc_state->active value will be false, since
1000  * the CRTC is off. However in some cases we're interested in whether the CRTC
1001  * is active, or effectively active (ie: it's connected to an active display).
1002  * In these cases, use this function instead of just checking active.
1003  */
1004 static inline bool
1005 drm_atomic_crtc_effectively_active(const struct drm_crtc_state *state)
1006 {
1007         return state->active || state->self_refresh_active;
1008 }
1009
1010 /**
1011  * struct drm_bus_cfg - bus configuration
1012  *
1013  * This structure stores the configuration of a physical bus between two
1014  * components in an output pipeline, usually between two bridges, an encoder
1015  * and a bridge, or a bridge and a connector.
1016  *
1017  * The bus configuration is stored in &drm_bridge_state separately for the
1018  * input and output buses, as seen from the point of view of each bridge. The
1019  * bus configuration of a bridge output is usually identical to the
1020  * configuration of the next bridge's input, but may differ if the signals are
1021  * modified between the two bridges, for instance by an inverter on the board.
1022  * The input and output configurations of a bridge may differ if the bridge
1023  * modifies the signals internally, for instance by performing format
1024  * conversion, or modifying signals polarities.
1025  */
1026 struct drm_bus_cfg {
1027         /**
1028          * @format: format used on this bus (one of the MEDIA_BUS_FMT_* format)
1029          *
1030          * This field should not be directly modified by drivers
1031          * (drm_atomic_bridge_chain_select_bus_fmts() takes care of the bus
1032          * format negotiation).
1033          */
1034         u32 format;
1035
1036         /**
1037          * @flags: DRM_BUS_* flags used on this bus
1038          */
1039         u32 flags;
1040 };
1041
1042 /**
1043  * struct drm_bridge_state - Atomic bridge state object
1044  */
1045 struct drm_bridge_state {
1046         /**
1047          * @base: inherit from &drm_private_state
1048          */
1049         struct drm_private_state base;
1050
1051         /**
1052          * @bridge: the bridge this state refers to
1053          */
1054         struct drm_bridge *bridge;
1055
1056         /**
1057          * @input_bus_cfg: input bus configuration
1058          */
1059         struct drm_bus_cfg input_bus_cfg;
1060
1061         /**
1062          * @output_bus_cfg: input bus configuration
1063          */
1064         struct drm_bus_cfg output_bus_cfg;
1065 };
1066
1067 static inline struct drm_bridge_state *
1068 drm_priv_to_bridge_state(struct drm_private_state *priv)
1069 {
1070         return container_of(priv, struct drm_bridge_state, base);
1071 }
1072
1073 struct drm_bridge_state *
1074 drm_atomic_get_bridge_state(struct drm_atomic_state *state,
1075                             struct drm_bridge *bridge);
1076 struct drm_bridge_state *
1077 drm_atomic_get_old_bridge_state(struct drm_atomic_state *state,
1078                                 struct drm_bridge *bridge);
1079 struct drm_bridge_state *
1080 drm_atomic_get_new_bridge_state(struct drm_atomic_state *state,
1081                                 struct drm_bridge *bridge);
1082
1083 #endif /* DRM_ATOMIC_H_ */