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