drivers/gpu/drm/drm_atomic.c

   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
  29 #include <drm/drmP.h>
  30 #include <drm/drm_atomic.h>
  31 #include <drm/drm_mode.h>
  32 #include <drm/drm_plane_helper.h>
  33
  34 #include "drm_crtc_internal.h"
  35
  36 static void crtc_commit_free(struct kref *kref)
  37 {
  38         struct drm_crtc_commit *commit =
  39                 container_of(kref, struct drm_crtc_commit, ref);
  40
  41         kfree(commit);
  42 }
  43
  44 void drm_crtc_commit_put(struct drm_crtc_commit *commit)
  45 {
  46         kref_put(&commit->ref, crtc_commit_free);
  47 }
  48 EXPORT_SYMBOL(drm_crtc_commit_put);
  49
  50 /**
  51  * drm_atomic_state_default_release -
  52  * release memory initialized by drm_atomic_state_init
  53  * @state: atomic state
  54  *
  55  * Free all the memory allocated by drm_atomic_state_init.
  56  * This is useful for drivers that subclass the atomic state.
  57  */
  58 void drm_atomic_state_default_release(struct drm_atomic_state *state)
  59 {
  60         kfree(state->connectors);
  61         kfree(state->crtcs);
  62         kfree(state->planes);
  63 }
  64 EXPORT_SYMBOL(drm_atomic_state_default_release);
  65
  66 /**
  67  * drm_atomic_state_init - init new atomic state
  68  * @dev: DRM device
  69  * @state: atomic state
  70  *
  71  * Default implementation for filling in a new atomic state.
  72  * This is useful for drivers that subclass the atomic state.
  73  */
  74 int
  75 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state)
  76 {
  77         /* TODO legacy paths should maybe do a better job about
  78          * setting this appropriately?
  79          */
  80         state->allow_modeset = true;
  81
  82         state->crtcs = kcalloc(dev->mode_config.num_crtc,
  83                                sizeof(*state->crtcs), GFP_KERNEL);
  84         if (!state->crtcs)
  85                 goto fail;
  86         state->planes = kcalloc(dev->mode_config.num_total_plane,
  87                                 sizeof(*state->planes), GFP_KERNEL);
  88         if (!state->planes)
  89                 goto fail;
  90
  91         state->dev = dev;
  92
  93         DRM_DEBUG_ATOMIC("Allocated atomic state %p\n", state);
  94
  95         return 0;
  96 fail:
  97         drm_atomic_state_default_release(state);
  98         return -ENOMEM;
  99 }
 100 EXPORT_SYMBOL(drm_atomic_state_init);
 101
 102 /**
 103  * drm_atomic_state_alloc - allocate atomic state
 104  * @dev: DRM device
 105  *
 106  * This allocates an empty atomic state to track updates.
 107  */
 108 struct drm_atomic_state *
 109 drm_atomic_state_alloc(struct drm_device *dev)
 110 {
 111         struct drm_mode_config *config = &dev->mode_config;
 112         struct drm_atomic_state *state;
 113
 114         if (!config->funcs->atomic_state_alloc) {
 115                 state = kzalloc(sizeof(*state), GFP_KERNEL);
 116                 if (!state)
 117                         return NULL;
 118                 if (drm_atomic_state_init(dev, state) < 0) {
 119                         kfree(state);
 120                         return NULL;
 121                 }
 122                 return state;
 123         }
 124
 125         return config->funcs->atomic_state_alloc(dev);
 126 }
 127 EXPORT_SYMBOL(drm_atomic_state_alloc);
 128
 129 /**
 130  * drm_atomic_state_default_clear - clear base atomic state
 131  * @state: atomic state
 132  *
 133  * Default implementation for clearing atomic state.
 134  * This is useful for drivers that subclass the atomic state.
 135  */
 136 void drm_atomic_state_default_clear(struct drm_atomic_state *state)
 137 {
 138         struct drm_device *dev = state->dev;
 139         struct drm_mode_config *config = &dev->mode_config;
 140         int i;
 141
 142         DRM_DEBUG_ATOMIC("Clearing atomic state %p\n", state);
 143
 144         for (i = 0; i < state->num_connector; i++) {
 145                 struct drm_connector *connector = state->connectors[i].ptr;
 146
 147                 if (!connector)
 148                         continue;
 149
 150                 connector->funcs->atomic_destroy_state(connector,
 151                                                        state->connectors[i].state);
 152                 state->connectors[i].ptr = NULL;
 153                 state->connectors[i].state = NULL;
 154                 drm_connector_unreference(connector);
 155         }
 156
 157         for (i = 0; i < config->num_crtc; i++) {
 158                 struct drm_crtc *crtc = state->crtcs[i].ptr;
 159
 160                 if (!crtc)
 161                         continue;
 162
 163                 crtc->funcs->atomic_destroy_state(crtc,
 164                                                   state->crtcs[i].state);
 165
 166                 if (state->crtcs[i].commit) {
 167                         kfree(state->crtcs[i].commit->event);
 168                         state->crtcs[i].commit->event = NULL;
 169                         drm_crtc_commit_put(state->crtcs[i].commit);
 170                 }
 171
 172                 state->crtcs[i].commit = NULL;
 173                 state->crtcs[i].ptr = NULL;
 174                 state->crtcs[i].state = NULL;
 175         }
 176
 177         for (i = 0; i < config->num_total_plane; i++) {
 178                 struct drm_plane *plane = state->planes[i].ptr;
 179
 180                 if (!plane)
 181                         continue;
 182
 183                 plane->funcs->atomic_destroy_state(plane,
 184                                                    state->planes[i].state);
 185                 state->planes[i].ptr = NULL;
 186                 state->planes[i].state = NULL;
 187         }
 188 }
 189 EXPORT_SYMBOL(drm_atomic_state_default_clear);
 190
 191 /**
 192  * drm_atomic_state_clear - clear state object
 193  * @state: atomic state
 194  *
 195  * When the w/w mutex algorithm detects a deadlock we need to back off and drop
 196  * all locks. So someone else could sneak in and change the current modeset
 197  * configuration. Which means that all the state assembled in @state is no
 198  * longer an atomic update to the current state, but to some arbitrary earlier
 199  * state. Which could break assumptions the driver's ->atomic_check likely
 200  * relies on.
 201  *
 202  * Hence we must clear all cached state and completely start over, using this
 203  * function.
 204  */
 205 void drm_atomic_state_clear(struct drm_atomic_state *state)
 206 {
 207         struct drm_device *dev = state->dev;
 208         struct drm_mode_config *config = &dev->mode_config;
 209
 210         if (config->funcs->atomic_state_clear)
 211                 config->funcs->atomic_state_clear(state);
 212         else
 213                 drm_atomic_state_default_clear(state);
 214 }
 215 EXPORT_SYMBOL(drm_atomic_state_clear);
 216
 217 /**
 218  * drm_atomic_state_free - free all memory for an atomic state
 219  * @state: atomic state to deallocate
 220  *
 221  * This frees all memory associated with an atomic state, including all the
 222  * per-object state for planes, crtcs and connectors.
 223  */
 224 void drm_atomic_state_free(struct drm_atomic_state *state)
 225 {
 226         struct drm_device *dev;
 227         struct drm_mode_config *config;
 228
 229         if (!state)
 230                 return;
 231
 232         dev = state->dev;
 233         config = &dev->mode_config;
 234
 235         drm_atomic_state_clear(state);
 236
 237         DRM_DEBUG_ATOMIC("Freeing atomic state %p\n", state);
 238
 239         if (config->funcs->atomic_state_free) {
 240                 config->funcs->atomic_state_free(state);
 241         } else {
 242                 drm_atomic_state_default_release(state);
 243                 kfree(state);
 244         }
 245 }
 246 EXPORT_SYMBOL(drm_atomic_state_free);
 247
 248 /**
 249  * drm_atomic_get_crtc_state - get crtc state
 250  * @state: global atomic state object
 251  * @crtc: crtc to get state object for
 252  *
 253  * This function returns the crtc state for the given crtc, allocating it if
 254  * needed. It will also grab the relevant crtc lock to make sure that the state
 255  * is consistent.
 256  *
 257  * Returns:
 258  *
 259  * Either the allocated state or the error code encoded into the pointer. When
 260  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
 261  * entire atomic sequence must be restarted. All other errors are fatal.
 262  */
 263 struct drm_crtc_state *
 264 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
 265                           struct drm_crtc *crtc)
 266 {
 267         int ret, index = drm_crtc_index(crtc);
 268         struct drm_crtc_state *crtc_state;
 269
 270         WARN_ON(!state->acquire_ctx);
 271
 272         crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
 273         if (crtc_state)
 274                 return crtc_state;
 275
 276         ret = drm_modeset_lock(&crtc->mutex, state->acquire_ctx);
 277         if (ret)
 278                 return ERR_PTR(ret);
 279
 280         crtc_state = crtc->funcs->atomic_duplicate_state(crtc);
 281         if (!crtc_state)
 282                 return ERR_PTR(-ENOMEM);
 283
 284         state->crtcs[index].state = crtc_state;
 285         state->crtcs[index].ptr = crtc;
 286         crtc_state->state = state;
 287
 288         DRM_DEBUG_ATOMIC("Added [CRTC:%d:%s] %p state to %p\n",
 289                          crtc->base.id, crtc->name, crtc_state, state);
 290
 291         return crtc_state;
 292 }
 293 EXPORT_SYMBOL(drm_atomic_get_crtc_state);
 294
 295 /**
 296  * drm_atomic_set_mode_for_crtc - set mode for CRTC
 297  * @state: the CRTC whose incoming state to update
 298  * @mode: kernel-internal mode to use for the CRTC, or NULL to disable
 299  *
 300  * Set a mode (originating from the kernel) on the desired CRTC state. Does
 301  * not change any other state properties, including enable, active, or
 302  * mode_changed.
 303  *
 304  * RETURNS:
 305  * Zero on success, error code on failure. Cannot return -EDEADLK.
 306  */
 307 int drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
 308                                  struct drm_display_mode *mode)
 309 {
 310         struct drm_mode_modeinfo umode;
 311
 312         /* Early return for no change. */
 313         if (mode && memcmp(&state->mode, mode, sizeof(*mode)) == 0)
 314                 return 0;
 315
 316         drm_property_unreference_blob(state->mode_blob);
 317         state->mode_blob = NULL;
 318
 319         if (mode) {
 320                 drm_mode_convert_to_umode(&umode, mode);
 321                 state->mode_blob =
 322                         drm_property_create_blob(state->crtc->dev,
 323                                                  sizeof(umode),
 324                                                  &umode);
 325                 if (IS_ERR(state->mode_blob))
 326                         return PTR_ERR(state->mode_blob);
 327
 328                 drm_mode_copy(&state->mode, mode);
 329                 state->enable = true;
 330                 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
 331                                  mode->name, state);
 332         } else {
 333                 memset(&state->mode, 0, sizeof(state->mode));
 334                 state->enable = false;
 335                 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
 336                                  state);
 337         }
 338
 339         return 0;
 340 }
 341 EXPORT_SYMBOL(drm_atomic_set_mode_for_crtc);
 342
 343 /**
 344  * drm_atomic_set_mode_prop_for_crtc - set mode for CRTC
 345  * @state: the CRTC whose incoming state to update
 346  * @blob: pointer to blob property to use for mode
 347  *
 348  * Set a mode (originating from a blob property) on the desired CRTC state.
 349  * This function will take a reference on the blob property for the CRTC state,
 350  * and release the reference held on the state's existing mode property, if any
 351  * was set.
 352  *
 353  * RETURNS:
 354  * Zero on success, error code on failure. Cannot return -EDEADLK.
 355  */
 356 int drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
 357                                       struct drm_property_blob *blob)
 358 {
 359         if (blob == state->mode_blob)
 360                 return 0;
 361
 362         drm_property_unreference_blob(state->mode_blob);
 363         state->mode_blob = NULL;
 364
 365         memset(&state->mode, 0, sizeof(state->mode));
 366
 367         if (blob) {
 368                 if (blob->length != sizeof(struct drm_mode_modeinfo) ||
 369                     drm_mode_convert_umode(&state->mode,
 370                                            (const struct drm_mode_modeinfo *)
 371                                             blob->data))
 372                         return -EINVAL;
 373
 374                 state->mode_blob = drm_property_reference_blob(blob);
 375                 state->enable = true;
 376                 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
 377                                  state->mode.name, state);
 378         } else {
 379                 state->enable = false;
 380                 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
 381                                  state);
 382         }
 383
 384         return 0;
 385 }
 386 EXPORT_SYMBOL(drm_atomic_set_mode_prop_for_crtc);
 387
 388 /**
 389  * drm_atomic_replace_property_blob - replace a blob property
 390  * @blob: a pointer to the member blob to be replaced
 391  * @new_blob: the new blob to replace with
 392  * @replaced: whether the blob has been replaced
 393  *
 394  * RETURNS:
 395  * Zero on success, error code on failure
 396  */
 397 static void
 398 drm_atomic_replace_property_blob(struct drm_property_blob **blob,
 399                                  struct drm_property_blob *new_blob,
 400                                  bool *replaced)
 401 {
 402         struct drm_property_blob *old_blob = *blob;
 403
 404         if (old_blob == new_blob)
 405                 return;
 406
 407         drm_property_unreference_blob(old_blob);
 408         if (new_blob)
 409                 drm_property_reference_blob(new_blob);
 410         *blob = new_blob;
 411         *replaced = true;
 412
 413         return;
 414 }
 415
 416 static int
 417 drm_atomic_replace_property_blob_from_id(struct drm_crtc *crtc,
 418                                          struct drm_property_blob **blob,
 419                                          uint64_t blob_id,
 420                                          ssize_t expected_size,
 421                                          bool *replaced)
 422 {
 423         struct drm_device *dev = crtc->dev;
 424         struct drm_property_blob *new_blob = NULL;
 425
 426         if (blob_id != 0) {
 427                 new_blob = drm_property_lookup_blob(dev, blob_id);
 428                 if (new_blob == NULL)
 429                         return -EINVAL;
 430                 if (expected_size > 0 && expected_size != new_blob->length)
 431                         return -EINVAL;
 432         }
 433
 434         drm_atomic_replace_property_blob(blob, new_blob, replaced);
 435
 436         return 0;
 437 }
 438
 439 /**
 440  * drm_atomic_crtc_set_property - set property on CRTC
 441  * @crtc: the drm CRTC to set a property on
 442  * @state: the state object to update with the new property value
 443  * @property: the property to set
 444  * @val: the new property value
 445  *
 446  * Use this instead of calling crtc->atomic_set_property directly.
 447  * This function handles generic/core properties and calls out to
 448  * driver's ->atomic_set_property() for driver properties.  To ensure
 449  * consistent behavior you must call this function rather than the
 450  * driver hook directly.
 451  *
 452  * RETURNS:
 453  * Zero on success, error code on failure
 454  */
 455 int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
 456                 struct drm_crtc_state *state, struct drm_property *property,
 457                 uint64_t val)
 458 {
 459         struct drm_device *dev = crtc->dev;
 460         struct drm_mode_config *config = &dev->mode_config;
 461         bool replaced = false;
 462         int ret;
 463
 464         if (property == config->prop_active)
 465                 state->active = val;
 466         else if (property == config->prop_mode_id) {
 467                 struct drm_property_blob *mode =
 468                         drm_property_lookup_blob(dev, val);
 469                 ret = drm_atomic_set_mode_prop_for_crtc(state, mode);
 470                 drm_property_unreference_blob(mode);
 471                 return ret;
 472         } else if (property == config->degamma_lut_property) {
 473                 ret = drm_atomic_replace_property_blob_from_id(crtc,
 474                                         &state->degamma_lut,
 475                                         val,
 476                                         -1,
 477                                         &replaced);
 478                 state->color_mgmt_changed |= replaced;
 479                 return ret;
 480         } else if (property == config->ctm_property) {
 481                 ret = drm_atomic_replace_property_blob_from_id(crtc,
 482                                         &state->ctm,
 483                                         val,
 484                                         sizeof(struct drm_color_ctm),
 485                                         &replaced);
 486                 state->color_mgmt_changed |= replaced;
 487                 return ret;
 488         } else if (property == config->gamma_lut_property) {
 489                 ret = drm_atomic_replace_property_blob_from_id(crtc,
 490                                         &state->gamma_lut,
 491                                         val,
 492                                         -1,
 493                                         &replaced);
 494                 state->color_mgmt_changed |= replaced;
 495                 return ret;
 496         } else if (crtc->funcs->atomic_set_property)
 497                 return crtc->funcs->atomic_set_property(crtc, state, property, val);
 498         else
 499                 return -EINVAL;
 500
 501         return 0;
 502 }
 503 EXPORT_SYMBOL(drm_atomic_crtc_set_property);
 504
 505 /**
 506  * drm_atomic_crtc_get_property - get property value from CRTC state
 507  * @crtc: the drm CRTC to set a property on
 508  * @state: the state object to get the property value from
 509  * @property: the property to set
 510  * @val: return location for the property value
 511  *
 512  * This function handles generic/core properties and calls out to
 513  * driver's ->atomic_get_property() for driver properties.  To ensure
 514  * consistent behavior you must call this function rather than the
 515  * driver hook directly.
 516  *
 517  * RETURNS:
 518  * Zero on success, error code on failure
 519  */
 520 static int
 521 drm_atomic_crtc_get_property(struct drm_crtc *crtc,
 522                 const struct drm_crtc_state *state,
 523                 struct drm_property *property, uint64_t *val)
 524 {
 525         struct drm_device *dev = crtc->dev;
 526         struct drm_mode_config *config = &dev->mode_config;
 527
 528         if (property == config->prop_active)
 529                 *val = state->active;
 530         else if (property == config->prop_mode_id)
 531                 *val = (state->mode_blob) ? state->mode_blob->base.id : 0;
 532         else if (property == config->degamma_lut_property)
 533                 *val = (state->degamma_lut) ? state->degamma_lut->base.id : 0;
 534         else if (property == config->ctm_property)
 535                 *val = (state->ctm) ? state->ctm->base.id : 0;
 536         else if (property == config->gamma_lut_property)
 537                 *val = (state->gamma_lut) ? state->gamma_lut->base.id : 0;
 538         else if (crtc->funcs->atomic_get_property)
 539                 return crtc->funcs->atomic_get_property(crtc, state, property, val);
 540         else
 541                 return -EINVAL;
 542
 543         return 0;
 544 }
 545
 546 /**
 547  * drm_atomic_crtc_check - check crtc state
 548  * @crtc: crtc to check
 549  * @state: crtc state to check
 550  *
 551  * Provides core sanity checks for crtc state.
 552  *
 553  * RETURNS:
 554  * Zero on success, error code on failure
 555  */
 556 static int drm_atomic_crtc_check(struct drm_crtc *crtc,
 557                 struct drm_crtc_state *state)
 558 {
 559         /* NOTE: we explicitly don't enforce constraints such as primary
 560          * layer covering entire screen, since that is something we want
 561          * to allow (on hw that supports it).  For hw that does not, it
 562          * should be checked in driver's crtc->atomic_check() vfunc.
 563          *
 564          * TODO: Add generic modeset state checks once we support those.
 565          */
 566
 567         if (state->active && !state->enable) {
 568                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active without enabled\n",
 569                                  crtc->base.id, crtc->name);
 570                 return -EINVAL;
 571         }
 572
 573         /* The state->enable vs. state->mode_blob checks can be WARN_ON,
 574          * as this is a kernel-internal detail that userspace should never
 575          * be able to trigger. */
 576         if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
 577             WARN_ON(state->enable && !state->mode_blob)) {
 578                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled without mode blob\n",
 579                                  crtc->base.id, crtc->name);
 580                 return -EINVAL;
 581         }
 582
 583         if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
 584             WARN_ON(!state->enable && state->mode_blob)) {
 585                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled with mode blob\n",
 586                                  crtc->base.id, crtc->name);
 587                 return -EINVAL;
 588         }
 589
 590         /*
 591          * Reject event generation for when a CRTC is off and stays off.
 592          * It wouldn't be hard to implement this, but userspace has a track
 593          * record of happily burning through 100% cpu (or worse, crash) when the
 594          * display pipe is suspended. To avoid all that fun just reject updates
 595          * that ask for events since likely that indicates a bug in the
 596          * compositor's drawing loop. This is consistent with the vblank IOCTL
 597          * and legacy page_flip IOCTL which also reject service on a disabled
 598          * pipe.
 599          */
 600         if (state->event && !state->active && !crtc->state->active) {
 601                 DRM_DEBUG_ATOMIC("[CRTC:%d] requesting event but off\n",
 602                                  crtc->base.id);
 603                 return -EINVAL;
 604         }
 605
 606         return 0;
 607 }
 608
 609 /**
 610  * drm_atomic_get_plane_state - get plane state
 611  * @state: global atomic state object
 612  * @plane: plane to get state object for
 613  *
 614  * This function returns the plane state for the given plane, allocating it if
 615  * needed. It will also grab the relevant plane lock to make sure that the state
 616  * is consistent.
 617  *
 618  * Returns:
 619  *
 620  * Either the allocated state or the error code encoded into the pointer. When
 621  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
 622  * entire atomic sequence must be restarted. All other errors are fatal.
 623  */
 624 struct drm_plane_state *
 625 drm_atomic_get_plane_state(struct drm_atomic_state *state,
 626                           struct drm_plane *plane)
 627 {
 628         int ret, index = drm_plane_index(plane);
 629         struct drm_plane_state *plane_state;
 630
 631         WARN_ON(!state->acquire_ctx);
 632
 633         plane_state = drm_atomic_get_existing_plane_state(state, plane);
 634         if (plane_state)
 635                 return plane_state;
 636
 637         ret = drm_modeset_lock(&plane->mutex, state->acquire_ctx);
 638         if (ret)
 639                 return ERR_PTR(ret);
 640
 641         plane_state = plane->funcs->atomic_duplicate_state(plane);
 642         if (!plane_state)
 643                 return ERR_PTR(-ENOMEM);
 644
 645         state->planes[index].state = plane_state;
 646         state->planes[index].ptr = plane;
 647         plane_state->state = state;
 648
 649         DRM_DEBUG_ATOMIC("Added [PLANE:%d:%s] %p state to %p\n",
 650                          plane->base.id, plane->name, plane_state, state);
 651
 652         if (plane_state->crtc) {
 653                 struct drm_crtc_state *crtc_state;
 654
 655                 crtc_state = drm_atomic_get_crtc_state(state,
 656                                                        plane_state->crtc);
 657                 if (IS_ERR(crtc_state))
 658                         return ERR_CAST(crtc_state);
 659         }
 660
 661         return plane_state;
 662 }
 663 EXPORT_SYMBOL(drm_atomic_get_plane_state);
 664
 665 /**
 666  * drm_atomic_plane_set_property - set property on plane
 667  * @plane: the drm plane to set a property on
 668  * @state: the state object to update with the new property value
 669  * @property: the property to set
 670  * @val: the new property value
 671  *
 672  * Use this instead of calling plane->atomic_set_property directly.
 673  * This function handles generic/core properties and calls out to
 674  * driver's ->atomic_set_property() for driver properties.  To ensure
 675  * consistent behavior you must call this function rather than the
 676  * driver hook directly.
 677  *
 678  * RETURNS:
 679  * Zero on success, error code on failure
 680  */
 681 int drm_atomic_plane_set_property(struct drm_plane *plane,
 682                 struct drm_plane_state *state, struct drm_property *property,
 683                 uint64_t val)
 684 {
 685         struct drm_device *dev = plane->dev;
 686         struct drm_mode_config *config = &dev->mode_config;
 687
 688         if (property == config->prop_fb_id) {
 689                 struct drm_framebuffer *fb = drm_framebuffer_lookup(dev, val);
 690                 drm_atomic_set_fb_for_plane(state, fb);
 691                 if (fb)
 692                         drm_framebuffer_unreference(fb);
 693         } else if (property == config->prop_crtc_id) {
 694                 struct drm_crtc *crtc = drm_crtc_find(dev, val);
 695                 return drm_atomic_set_crtc_for_plane(state, crtc);
 696         } else if (property == config->prop_crtc_x) {
 697                 state->crtc_x = U642I64(val);
 698         } else if (property == config->prop_crtc_y) {
 699                 state->crtc_y = U642I64(val);
 700         } else if (property == config->prop_crtc_w) {
 701                 state->crtc_w = val;
 702         } else if (property == config->prop_crtc_h) {
 703                 state->crtc_h = val;
 704         } else if (property == config->prop_src_x) {
 705                 state->src_x = val;
 706         } else if (property == config->prop_src_y) {
 707                 state->src_y = val;
 708         } else if (property == config->prop_src_w) {
 709                 state->src_w = val;
 710         } else if (property == config->prop_src_h) {
 711                 state->src_h = val;
 712         } else if (property == config->rotation_property) {
 713                 state->rotation = val;
 714         } else if (property == plane->zpos_property) {
 715                 state->zpos = val;
 716         } else if (plane->funcs->atomic_set_property) {
 717                 return plane->funcs->atomic_set_property(plane, state,
 718                                 property, val);
 719         } else {
 720                 return -EINVAL;
 721         }
 722
 723         return 0;
 724 }
 725 EXPORT_SYMBOL(drm_atomic_plane_set_property);
 726
 727 /**
 728  * drm_atomic_plane_get_property - get property value from plane state
 729  * @plane: the drm plane to set a property on
 730  * @state: the state object to get the property value from
 731  * @property: the property to set
 732  * @val: return location for the property value
 733  *
 734  * This function handles generic/core properties and calls out to
 735  * driver's ->atomic_get_property() for driver properties.  To ensure
 736  * consistent behavior you must call this function rather than the
 737  * driver hook directly.
 738  *
 739  * RETURNS:
 740  * Zero on success, error code on failure
 741  */
 742 static int
 743 drm_atomic_plane_get_property(struct drm_plane *plane,
 744                 const struct drm_plane_state *state,
 745                 struct drm_property *property, uint64_t *val)
 746 {
 747         struct drm_device *dev = plane->dev;
 748         struct drm_mode_config *config = &dev->mode_config;
 749
 750         if (property == config->prop_fb_id) {
 751                 *val = (state->fb) ? state->fb->base.id : 0;
 752         } else if (property == config->prop_crtc_id) {
 753                 *val = (state->crtc) ? state->crtc->base.id : 0;
 754         } else if (property == config->prop_crtc_x) {
 755                 *val = I642U64(state->crtc_x);
 756         } else if (property == config->prop_crtc_y) {
 757                 *val = I642U64(state->crtc_y);
 758         } else if (property == config->prop_crtc_w) {
 759                 *val = state->crtc_w;
 760         } else if (property == config->prop_crtc_h) {
 761                 *val = state->crtc_h;
 762         } else if (property == config->prop_src_x) {
 763                 *val = state->src_x;
 764         } else if (property == config->prop_src_y) {
 765                 *val = state->src_y;
 766         } else if (property == config->prop_src_w) {
 767                 *val = state->src_w;
 768         } else if (property == config->prop_src_h) {
 769                 *val = state->src_h;
 770         } else if (property == config->rotation_property) {
 771                 *val = state->rotation;
 772         } else if (property == plane->zpos_property) {
 773                 *val = state->zpos;
 774         } else if (plane->funcs->atomic_get_property) {
 775                 return plane->funcs->atomic_get_property(plane, state, property, val);
 776         } else {
 777                 return -EINVAL;
 778         }
 779
 780         return 0;
 781 }
 782
 783 static bool
 784 plane_switching_crtc(struct drm_atomic_state *state,
 785                      struct drm_plane *plane,
 786                      struct drm_plane_state *plane_state)
 787 {
 788         if (!plane->state->crtc || !plane_state->crtc)
 789                 return false;
 790
 791         if (plane->state->crtc == plane_state->crtc)
 792                 return false;
 793
 794         /* This could be refined, but currently there's no helper or driver code
 795          * to implement direct switching of active planes nor userspace to take
 796          * advantage of more direct plane switching without the intermediate
 797          * full OFF state.
 798          */
 799         return true;
 800 }
 801
 802 /**
 803  * drm_atomic_plane_check - check plane state
 804  * @plane: plane to check
 805  * @state: plane state to check
 806  *
 807  * Provides core sanity checks for plane state.
 808  *
 809  * RETURNS:
 810  * Zero on success, error code on failure
 811  */
 812 static int drm_atomic_plane_check(struct drm_plane *plane,
 813                 struct drm_plane_state *state)
 814 {
 815         unsigned int fb_width, fb_height;
 816         int ret;
 817
 818         /* either *both* CRTC and FB must be set, or neither */
 819         if (WARN_ON(state->crtc && !state->fb)) {
 820                 DRM_DEBUG_ATOMIC("CRTC set but no FB\n");
 821                 return -EINVAL;
 822         } else if (WARN_ON(state->fb && !state->crtc)) {
 823                 DRM_DEBUG_ATOMIC("FB set but no CRTC\n");
 824                 return -EINVAL;
 825         }
 826
 827         /* if disabled, we don't care about the rest of the state: */
 828         if (!state->crtc)
 829                 return 0;
 830
 831         /* Check whether this plane is usable on this CRTC */
 832         if (!(plane->possible_crtcs & drm_crtc_mask(state->crtc))) {
 833                 DRM_DEBUG_ATOMIC("Invalid crtc for plane\n");
 834                 return -EINVAL;
 835         }
 836
 837         /* Check whether this plane supports the fb pixel format. */
 838         ret = drm_plane_check_pixel_format(plane, state->fb->pixel_format);
 839         if (ret) {
 840                 char *format_name = drm_get_format_name(state->fb->pixel_format);
 841                 DRM_DEBUG_ATOMIC("Invalid pixel format %s\n", format_name);
 842                 kfree(format_name);
 843                 return ret;
 844         }
 845
 846         /* Give drivers some help against integer overflows */
 847         if (state->crtc_w > INT_MAX ||
 848             state->crtc_x > INT_MAX - (int32_t) state->crtc_w ||
 849             state->crtc_h > INT_MAX ||
 850             state->crtc_y > INT_MAX - (int32_t) state->crtc_h) {
 851                 DRM_DEBUG_ATOMIC("Invalid CRTC coordinates %ux%u+%d+%d\n",
 852                                  state->crtc_w, state->crtc_h,
 853                                  state->crtc_x, state->crtc_y);
 854                 return -ERANGE;
 855         }
 856
 857         fb_width = state->fb->width << 16;
 858         fb_height = state->fb->height << 16;
 859
 860         /* Make sure source coordinates are inside the fb. */
 861         if (state->src_w > fb_width ||
 862             state->src_x > fb_width - state->src_w ||
 863             state->src_h > fb_height ||
 864             state->src_y > fb_height - state->src_h) {
 865                 DRM_DEBUG_ATOMIC("Invalid source coordinates "
 866                                  "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
 867                                  state->src_w >> 16, ((state->src_w & 0xffff) * 15625) >> 10,
 868                                  state->src_h >> 16, ((state->src_h & 0xffff) * 15625) >> 10,
 869                                  state->src_x >> 16, ((state->src_x & 0xffff) * 15625) >> 10,
 870                                  state->src_y >> 16, ((state->src_y & 0xffff) * 15625) >> 10);
 871                 return -ENOSPC;
 872         }
 873
 874         if (plane_switching_crtc(state->state, plane, state)) {
 875                 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] switching CRTC directly\n",
 876                                  plane->base.id, plane->name);
 877                 return -EINVAL;
 878         }
 879
 880         return 0;
 881 }
 882
 883 /**
 884  * drm_atomic_get_connector_state - get connector state
 885  * @state: global atomic state object
 886  * @connector: connector to get state object for
 887  *
 888  * This function returns the connector state for the given connector,
 889  * allocating it if needed. It will also grab the relevant connector lock to
 890  * make sure that the state is consistent.
 891  *
 892  * Returns:
 893  *
 894  * Either the allocated state or the error code encoded into the pointer. When
 895  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
 896  * entire atomic sequence must be restarted. All other errors are fatal.
 897  */
 898 struct drm_connector_state *
 899 drm_atomic_get_connector_state(struct drm_atomic_state *state,
 900                           struct drm_connector *connector)
 901 {
 902         int ret, index;
 903         struct drm_mode_config *config = &connector->dev->mode_config;
 904         struct drm_connector_state *connector_state;
 905
 906         WARN_ON(!state->acquire_ctx);
 907
 908         ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
 909         if (ret)
 910                 return ERR_PTR(ret);
 911
 912         index = drm_connector_index(connector);
 913
 914         if (index >= state->num_connector) {
 915                 struct __drm_connnectors_state *c;
 916                 int alloc = max(index + 1, config->num_connector);
 917
 918                 c = krealloc(state->connectors, alloc * sizeof(*state->connectors), GFP_KERNEL);
 919                 if (!c)
 920                         return ERR_PTR(-ENOMEM);
 921
 922                 state->connectors = c;
 923                 memset(&state->connectors[state->num_connector], 0,
 924                        sizeof(*state->connectors) * (alloc - state->num_connector));
 925
 926                 state->num_connector = alloc;
 927         }
 928
 929         if (state->connectors[index].state)
 930                 return state->connectors[index].state;
 931
 932         connector_state = connector->funcs->atomic_duplicate_state(connector);
 933         if (!connector_state)
 934                 return ERR_PTR(-ENOMEM);
 935
 936         drm_connector_reference(connector);
 937         state->connectors[index].state = connector_state;
 938         state->connectors[index].ptr = connector;
 939         connector_state->state = state;
 940
 941         DRM_DEBUG_ATOMIC("Added [CONNECTOR:%d] %p state to %p\n",
 942                          connector->base.id, connector_state, state);
 943
 944         if (connector_state->crtc) {
 945                 struct drm_crtc_state *crtc_state;
 946
 947                 crtc_state = drm_atomic_get_crtc_state(state,
 948                                                        connector_state->crtc);
 949                 if (IS_ERR(crtc_state))
 950                         return ERR_CAST(crtc_state);
 951         }
 952
 953         return connector_state;
 954 }
 955 EXPORT_SYMBOL(drm_atomic_get_connector_state);
 956
 957 /**
 958  * drm_atomic_connector_set_property - set property on connector.
 959  * @connector: the drm connector to set a property on
 960  * @state: the state object to update with the new property value
 961  * @property: the property to set
 962  * @val: the new property value
 963  *
 964  * Use this instead of calling connector->atomic_set_property directly.
 965  * This function handles generic/core properties and calls out to
 966  * driver's ->atomic_set_property() for driver properties.  To ensure
 967  * consistent behavior you must call this function rather than the
 968  * driver hook directly.
 969  *
 970  * RETURNS:
 971  * Zero on success, error code on failure
 972  */
 973 int drm_atomic_connector_set_property(struct drm_connector *connector,
 974                 struct drm_connector_state *state, struct drm_property *property,
 975                 uint64_t val)
 976 {
 977         struct drm_device *dev = connector->dev;
 978         struct drm_mode_config *config = &dev->mode_config;
 979
 980         if (property == config->prop_crtc_id) {
 981                 struct drm_crtc *crtc = drm_crtc_find(dev, val);
 982                 return drm_atomic_set_crtc_for_connector(state, crtc);
 983         } else if (property == config->dpms_property) {
 984                 /* setting DPMS property requires special handling, which
 985                  * is done in legacy setprop path for us.  Disallow (for
 986                  * now?) atomic writes to DPMS property:
 987                  */
 988                 return -EINVAL;
 989         } else if (connector->funcs->atomic_set_property) {
 990                 return connector->funcs->atomic_set_property(connector,
 991                                 state, property, val);
 992         } else {
 993                 return -EINVAL;
 994         }
 995 }
 996 EXPORT_SYMBOL(drm_atomic_connector_set_property);
 997
 998 /**
 999  * drm_atomic_connector_get_property - get property value from connector state
1000  * @connector: the drm connector to set a property on
1001  * @state: the state object to get the property value from
1002  * @property: the property to set
1003  * @val: return location for the property value
1004  *
1005  * This function handles generic/core properties and calls out to
1006  * driver's ->atomic_get_property() for driver properties.  To ensure
1007  * consistent behavior you must call this function rather than the
1008  * driver hook directly.
1009  *
1010  * RETURNS:
1011  * Zero on success, error code on failure
1012  */
1013 static int
1014 drm_atomic_connector_get_property(struct drm_connector *connector,
1015                 const struct drm_connector_state *state,
1016                 struct drm_property *property, uint64_t *val)
1017 {
1018         struct drm_device *dev = connector->dev;
1019         struct drm_mode_config *config = &dev->mode_config;
1020
1021         if (property == config->prop_crtc_id) {
1022                 *val = (state->crtc) ? state->crtc->base.id : 0;
1023         } else if (property == config->dpms_property) {
1024                 *val = connector->dpms;
1025         } else if (connector->funcs->atomic_get_property) {
1026                 return connector->funcs->atomic_get_property(connector,
1027                                 state, property, val);
1028         } else {
1029                 return -EINVAL;
1030         }
1031
1032         return 0;
1033 }
1034
1035 int drm_atomic_get_property(struct drm_mode_object *obj,
1036                 struct drm_property *property, uint64_t *val)
1037 {
1038         struct drm_device *dev = property->dev;
1039         int ret;
1040
1041         switch (obj->type) {
1042         case DRM_MODE_OBJECT_CONNECTOR: {
1043                 struct drm_connector *connector = obj_to_connector(obj);
1044                 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
1045                 ret = drm_atomic_connector_get_property(connector,
1046                                 connector->state, property, val);
1047                 break;
1048         }
1049         case DRM_MODE_OBJECT_CRTC: {
1050                 struct drm_crtc *crtc = obj_to_crtc(obj);
1051                 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
1052                 ret = drm_atomic_crtc_get_property(crtc,
1053                                 crtc->state, property, val);
1054                 break;
1055         }
1056         case DRM_MODE_OBJECT_PLANE: {
1057                 struct drm_plane *plane = obj_to_plane(obj);
1058                 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
1059                 ret = drm_atomic_plane_get_property(plane,
1060                                 plane->state, property, val);
1061                 break;
1062         }
1063         default:
1064                 ret = -EINVAL;
1065                 break;
1066         }
1067
1068         return ret;
1069 }
1070
1071 /**
1072  * drm_atomic_set_crtc_for_plane - set crtc for plane
1073  * @plane_state: the plane whose incoming state to update
1074  * @crtc: crtc to use for the plane
1075  *
1076  * Changing the assigned crtc for a plane requires us to grab the lock and state
1077  * for the new crtc, as needed. This function takes care of all these details
1078  * besides updating the pointer in the state object itself.
1079  *
1080  * Returns:
1081  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1082  * then the w/w mutex code has detected a deadlock and the entire atomic
1083  * sequence must be restarted. All other errors are fatal.
1084  */
1085 int
1086 drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
1087                               struct drm_crtc *crtc)
1088 {
1089         struct drm_plane *plane = plane_state->plane;
1090         struct drm_crtc_state *crtc_state;
1091
1092         if (plane_state->crtc) {
1093                 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1094                                                        plane_state->crtc);
1095                 if (WARN_ON(IS_ERR(crtc_state)))
1096                         return PTR_ERR(crtc_state);
1097
1098                 crtc_state->plane_mask &= ~(1 << drm_plane_index(plane));
1099         }
1100
1101         plane_state->crtc = crtc;
1102
1103         if (crtc) {
1104                 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1105                                                        crtc);
1106                 if (IS_ERR(crtc_state))
1107                         return PTR_ERR(crtc_state);
1108                 crtc_state->plane_mask |= (1 << drm_plane_index(plane));
1109         }
1110
1111         if (crtc)
1112                 DRM_DEBUG_ATOMIC("Link plane state %p to [CRTC:%d:%s]\n",
1113                                  plane_state, crtc->base.id, crtc->name);
1114         else
1115                 DRM_DEBUG_ATOMIC("Link plane state %p to [NOCRTC]\n",
1116                                  plane_state);
1117
1118         return 0;
1119 }
1120 EXPORT_SYMBOL(drm_atomic_set_crtc_for_plane);
1121
1122 /**
1123  * drm_atomic_set_fb_for_plane - set framebuffer for plane
1124  * @plane_state: atomic state object for the plane
1125  * @fb: fb to use for the plane
1126  *
1127  * Changing the assigned framebuffer for a plane requires us to grab a reference
1128  * to the new fb and drop the reference to the old fb, if there is one. This
1129  * function takes care of all these details besides updating the pointer in the
1130  * state object itself.
1131  */
1132 void
1133 drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
1134                             struct drm_framebuffer *fb)
1135 {
1136         if (plane_state->fb)
1137                 drm_framebuffer_unreference(plane_state->fb);
1138         if (fb)
1139                 drm_framebuffer_reference(fb);
1140         plane_state->fb = fb;
1141
1142         if (fb)
1143                 DRM_DEBUG_ATOMIC("Set [FB:%d] for plane state %p\n",
1144                                  fb->base.id, plane_state);
1145         else
1146                 DRM_DEBUG_ATOMIC("Set [NOFB] for plane state %p\n",
1147                                  plane_state);
1148 }
1149 EXPORT_SYMBOL(drm_atomic_set_fb_for_plane);
1150
1151 /**
1152  * drm_atomic_set_crtc_for_connector - set crtc for connector
1153  * @conn_state: atomic state object for the connector
1154  * @crtc: crtc to use for the connector
1155  *
1156  * Changing the assigned crtc for a connector requires us to grab the lock and
1157  * state for the new crtc, as needed. This function takes care of all these
1158  * details besides updating the pointer in the state object itself.
1159  *
1160  * Returns:
1161  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1162  * then the w/w mutex code has detected a deadlock and the entire atomic
1163  * sequence must be restarted. All other errors are fatal.
1164  */
1165 int
1166 drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
1167                                   struct drm_crtc *crtc)
1168 {
1169         struct drm_crtc_state *crtc_state;
1170
1171         if (conn_state->crtc == crtc)
1172                 return 0;
1173
1174         if (conn_state->crtc) {
1175                 crtc_state = drm_atomic_get_existing_crtc_state(conn_state->state,
1176                                                                 conn_state->crtc);
1177
1178                 crtc_state->connector_mask &=
1179                         ~(1 << drm_connector_index(conn_state->connector));
1180
1181                 drm_connector_unreference(conn_state->connector);
1182                 conn_state->crtc = NULL;
1183         }
1184
1185         if (crtc) {
1186                 crtc_state = drm_atomic_get_crtc_state(conn_state->state, crtc);
1187                 if (IS_ERR(crtc_state))
1188                         return PTR_ERR(crtc_state);
1189
1190                 crtc_state->connector_mask |=
1191                         1 << drm_connector_index(conn_state->connector);
1192
1193                 drm_connector_reference(conn_state->connector);
1194                 conn_state->crtc = crtc;
1195
1196                 DRM_DEBUG_ATOMIC("Link connector state %p to [CRTC:%d:%s]\n",
1197                                  conn_state, crtc->base.id, crtc->name);
1198         } else {
1199                 DRM_DEBUG_ATOMIC("Link connector state %p to [NOCRTC]\n",
1200                                  conn_state);
1201         }
1202
1203         return 0;
1204 }
1205 EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector);
1206
1207 /**
1208  * drm_atomic_add_affected_connectors - add connectors for crtc
1209  * @state: atomic state
1210  * @crtc: DRM crtc
1211  *
1212  * This function walks the current configuration and adds all connectors
1213  * currently using @crtc to the atomic configuration @state. Note that this
1214  * function must acquire the connection mutex. This can potentially cause
1215  * unneeded seralization if the update is just for the planes on one crtc. Hence
1216  * drivers and helpers should only call this when really needed (e.g. when a
1217  * full modeset needs to happen due to some change).
1218  *
1219  * Returns:
1220  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1221  * then the w/w mutex code has detected a deadlock and the entire atomic
1222  * sequence must be restarted. All other errors are fatal.
1223  */
1224 int
1225 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
1226                                    struct drm_crtc *crtc)
1227 {
1228         struct drm_mode_config *config = &state->dev->mode_config;
1229         struct drm_connector *connector;
1230         struct drm_connector_state *conn_state;
1231         int ret;
1232
1233         ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
1234         if (ret)
1235                 return ret;
1236
1237         DRM_DEBUG_ATOMIC("Adding all current connectors for [CRTC:%d:%s] to %p\n",
1238                          crtc->base.id, crtc->name, state);
1239
1240         /*
1241          * Changed connectors are already in @state, so only need to look at the
1242          * current configuration.
1243          */
1244         drm_for_each_connector(connector, state->dev) {
1245                 if (connector->state->crtc != crtc)
1246                         continue;
1247
1248                 conn_state = drm_atomic_get_connector_state(state, connector);
1249                 if (IS_ERR(conn_state))
1250                         return PTR_ERR(conn_state);
1251         }
1252
1253         return 0;
1254 }
1255 EXPORT_SYMBOL(drm_atomic_add_affected_connectors);
1256
1257 /**
1258  * drm_atomic_add_affected_planes - add planes for crtc
1259  * @state: atomic state
1260  * @crtc: DRM crtc
1261  *
1262  * This function walks the current configuration and adds all planes
1263  * currently used by @crtc to the atomic configuration @state. This is useful
1264  * when an atomic commit also needs to check all currently enabled plane on
1265  * @crtc, e.g. when changing the mode. It's also useful when re-enabling a CRTC
1266  * to avoid special code to force-enable all planes.
1267  *
1268  * Since acquiring a plane state will always also acquire the w/w mutex of the
1269  * current CRTC for that plane (if there is any) adding all the plane states for
1270  * a CRTC will not reduce parallism of atomic updates.
1271  *
1272  * Returns:
1273  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1274  * then the w/w mutex code has detected a deadlock and the entire atomic
1275  * sequence must be restarted. All other errors are fatal.
1276  */
1277 int
1278 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
1279                                struct drm_crtc *crtc)
1280 {
1281         struct drm_plane *plane;
1282
1283         WARN_ON(!drm_atomic_get_existing_crtc_state(state, crtc));
1284
1285         drm_for_each_plane_mask(plane, state->dev, crtc->state->plane_mask) {
1286                 struct drm_plane_state *plane_state =
1287                         drm_atomic_get_plane_state(state, plane);
1288
1289                 if (IS_ERR(plane_state))
1290                         return PTR_ERR(plane_state);
1291         }
1292         return 0;
1293 }
1294 EXPORT_SYMBOL(drm_atomic_add_affected_planes);
1295
1296 /**
1297  * drm_atomic_legacy_backoff - locking backoff for legacy ioctls
1298  * @state: atomic state
1299  *
1300  * This function should be used by legacy entry points which don't understand
1301  * -EDEADLK semantics. For simplicity this one will grab all modeset locks after
1302  * the slowpath completed.
1303  */
1304 void drm_atomic_legacy_backoff(struct drm_atomic_state *state)
1305 {
1306         struct drm_device *dev = state->dev;
1307         unsigned crtc_mask = 0;
1308         struct drm_crtc *crtc;
1309         int ret;
1310         bool global = false;
1311
1312         drm_for_each_crtc(crtc, dev) {
1313                 if (crtc->acquire_ctx != state->acquire_ctx)
1314                         continue;
1315
1316                 crtc_mask |= drm_crtc_mask(crtc);
1317                 crtc->acquire_ctx = NULL;
1318         }
1319
1320         if (WARN_ON(dev->mode_config.acquire_ctx == state->acquire_ctx)) {
1321                 global = true;
1322
1323                 dev->mode_config.acquire_ctx = NULL;
1324         }
1325
1326 retry:
1327         drm_modeset_backoff(state->acquire_ctx);
1328
1329         ret = drm_modeset_lock_all_ctx(dev, state->acquire_ctx);
1330         if (ret)
1331                 goto retry;
1332
1333         drm_for_each_crtc(crtc, dev)
1334                 if (drm_crtc_mask(crtc) & crtc_mask)
1335                         crtc->acquire_ctx = state->acquire_ctx;
1336
1337         if (global)
1338                 dev->mode_config.acquire_ctx = state->acquire_ctx;
1339 }
1340 EXPORT_SYMBOL(drm_atomic_legacy_backoff);
1341
1342 /**
1343  * drm_atomic_check_only - check whether a given config would work
1344  * @state: atomic configuration to check
1345  *
1346  * Note that this function can return -EDEADLK if the driver needed to acquire
1347  * more locks but encountered a deadlock. The caller must then do the usual w/w
1348  * backoff dance and restart. All other errors are fatal.
1349  *
1350  * Returns:
1351  * 0 on success, negative error code on failure.
1352  */
1353 int drm_atomic_check_only(struct drm_atomic_state *state)
1354 {
1355         struct drm_device *dev = state->dev;
1356         struct drm_mode_config *config = &dev->mode_config;
1357         struct drm_plane *plane;
1358         struct drm_plane_state *plane_state;
1359         struct drm_crtc *crtc;
1360         struct drm_crtc_state *crtc_state;
1361         int i, ret = 0;
1362
1363         DRM_DEBUG_ATOMIC("checking %p\n", state);
1364
1365         for_each_plane_in_state(state, plane, plane_state, i) {
1366                 ret = drm_atomic_plane_check(plane, plane_state);
1367                 if (ret) {
1368                         DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic core check failed\n",
1369                                          plane->base.id, plane->name);
1370                         return ret;
1371                 }
1372         }
1373
1374         for_each_crtc_in_state(state, crtc, crtc_state, i) {
1375                 ret = drm_atomic_crtc_check(crtc, crtc_state);
1376                 if (ret) {
1377                         DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic core check failed\n",
1378                                          crtc->base.id, crtc->name);
1379                         return ret;
1380                 }
1381         }
1382
1383         if (config->funcs->atomic_check)
1384                 ret = config->funcs->atomic_check(state->dev, state);
1385
1386         if (!state->allow_modeset) {
1387                 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1388                         if (drm_atomic_crtc_needs_modeset(crtc_state)) {
1389                                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] requires full modeset\n",
1390                                                  crtc->base.id, crtc->name);
1391                                 return -EINVAL;
1392                         }
1393                 }
1394         }
1395
1396         return ret;
1397 }
1398 EXPORT_SYMBOL(drm_atomic_check_only);
1399
1400 /**
1401  * drm_atomic_commit - commit configuration atomically
1402  * @state: atomic configuration to check
1403  *
1404  * Note that this function can return -EDEADLK if the driver needed to acquire
1405  * more locks but encountered a deadlock. The caller must then do the usual w/w
1406  * backoff dance and restart. All other errors are fatal.
1407  *
1408  * Also note that on successful execution ownership of @state is transferred
1409  * from the caller of this function to the function itself. The caller must not
1410  * free or in any other way access @state. If the function fails then the caller
1411  * must clean up @state itself.
1412  *
1413  * Returns:
1414  * 0 on success, negative error code on failure.
1415  */
1416 int drm_atomic_commit(struct drm_atomic_state *state)
1417 {
1418         struct drm_mode_config *config = &state->dev->mode_config;
1419         int ret;
1420
1421         ret = drm_atomic_check_only(state);
1422         if (ret)
1423                 return ret;
1424
1425         DRM_DEBUG_ATOMIC("commiting %p\n", state);
1426
1427         return config->funcs->atomic_commit(state->dev, state, false);
1428 }
1429 EXPORT_SYMBOL(drm_atomic_commit);
1430
1431 /**
1432  * drm_atomic_nonblocking_commit - atomic&nonblocking configuration commit
1433  * @state: atomic configuration to check
1434  *
1435  * Note that this function can return -EDEADLK if the driver needed to acquire
1436  * more locks but encountered a deadlock. The caller must then do the usual w/w
1437  * backoff dance and restart. All other errors are fatal.
1438  *
1439  * Also note that on successful execution ownership of @state is transferred
1440  * from the caller of this function to the function itself. The caller must not
1441  * free or in any other way access @state. If the function fails then the caller
1442  * must clean up @state itself.
1443  *
1444  * Returns:
1445  * 0 on success, negative error code on failure.
1446  */
1447 int drm_atomic_nonblocking_commit(struct drm_atomic_state *state)
1448 {
1449         struct drm_mode_config *config = &state->dev->mode_config;
1450         int ret;
1451
1452         ret = drm_atomic_check_only(state);
1453         if (ret)
1454                 return ret;
1455
1456         DRM_DEBUG_ATOMIC("commiting %p nonblocking\n", state);
1457
1458         return config->funcs->atomic_commit(state->dev, state, true);
1459 }
1460 EXPORT_SYMBOL(drm_atomic_nonblocking_commit);
1461
1462 /*
1463  * The big monstor ioctl
1464  */
1465
1466 static struct drm_pending_vblank_event *create_vblank_event(
1467                 struct drm_device *dev, struct drm_file *file_priv,
1468                 struct fence *fence, uint64_t user_data)
1469 {
1470         struct drm_pending_vblank_event *e = NULL;
1471         int ret;
1472
1473         e = kzalloc(sizeof *e, GFP_KERNEL);
1474         if (!e)
1475                 return NULL;
1476
1477         e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1478         e->event.base.length = sizeof(e->event);
1479         e->event.user_data = user_data;
1480
1481         if (file_priv) {
1482                 ret = drm_event_reserve_init(dev, file_priv, &e->base,
1483                                              &e->event.base);
1484                 if (ret) {
1485                         kfree(e);
1486                         return NULL;
1487                 }
1488         }
1489
1490         e->base.fence = fence;
1491
1492         return e;
1493 }
1494
1495 static int atomic_set_prop(struct drm_atomic_state *state,
1496                 struct drm_mode_object *obj, struct drm_property *prop,
1497                 uint64_t prop_value)
1498 {
1499         struct drm_mode_object *ref;
1500         int ret;
1501
1502         if (!drm_property_change_valid_get(prop, prop_value, &ref))
1503                 return -EINVAL;
1504
1505         switch (obj->type) {
1506         case DRM_MODE_OBJECT_CONNECTOR: {
1507                 struct drm_connector *connector = obj_to_connector(obj);
1508                 struct drm_connector_state *connector_state;
1509
1510                 connector_state = drm_atomic_get_connector_state(state, connector);
1511                 if (IS_ERR(connector_state)) {
1512                         ret = PTR_ERR(connector_state);
1513                         break;
1514                 }
1515
1516                 ret = drm_atomic_connector_set_property(connector,
1517                                 connector_state, prop, prop_value);
1518                 break;
1519         }
1520         case DRM_MODE_OBJECT_CRTC: {
1521                 struct drm_crtc *crtc = obj_to_crtc(obj);
1522                 struct drm_crtc_state *crtc_state;
1523
1524                 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1525                 if (IS_ERR(crtc_state)) {
1526                         ret = PTR_ERR(crtc_state);
1527                         break;
1528                 }
1529
1530                 ret = drm_atomic_crtc_set_property(crtc,
1531                                 crtc_state, prop, prop_value);
1532                 break;
1533         }
1534         case DRM_MODE_OBJECT_PLANE: {
1535                 struct drm_plane *plane = obj_to_plane(obj);
1536                 struct drm_plane_state *plane_state;
1537
1538                 plane_state = drm_atomic_get_plane_state(state, plane);
1539                 if (IS_ERR(plane_state)) {
1540                         ret = PTR_ERR(plane_state);
1541                         break;
1542                 }
1543
1544                 ret = drm_atomic_plane_set_property(plane,
1545                                 plane_state, prop, prop_value);
1546                 break;
1547         }
1548         default:
1549                 ret = -EINVAL;
1550                 break;
1551         }
1552
1553         drm_property_change_valid_put(prop, ref);
1554         return ret;
1555 }
1556
1557 /**
1558  * drm_atomic_clean_old_fb -- Unset old_fb pointers and set plane->fb pointers.
1559  *
1560  * @dev: drm device to check.
1561  * @plane_mask: plane mask for planes that were updated.
1562  * @ret: return value, can be -EDEADLK for a retry.
1563  *
1564  * Before doing an update plane->old_fb is set to plane->fb,
1565  * but before dropping the locks old_fb needs to be set to NULL
1566  * and plane->fb updated. This is a common operation for each
1567  * atomic update, so this call is split off as a helper.
1568  */
1569 void drm_atomic_clean_old_fb(struct drm_device *dev,
1570                              unsigned plane_mask,
1571                              int ret)
1572 {
1573         struct drm_plane *plane;
1574
1575         /* if succeeded, fixup legacy plane crtc/fb ptrs before dropping
1576          * locks (ie. while it is still safe to deref plane->state).  We
1577          * need to do this here because the driver entry points cannot
1578          * distinguish between legacy and atomic ioctls.
1579          */
1580         drm_for_each_plane_mask(plane, dev, plane_mask) {
1581                 if (ret == 0) {
1582                         struct drm_framebuffer *new_fb = plane->state->fb;
1583                         if (new_fb)
1584                                 drm_framebuffer_reference(new_fb);
1585                         plane->fb = new_fb;
1586                         plane->crtc = plane->state->crtc;
1587
1588                         if (plane->old_fb)
1589                                 drm_framebuffer_unreference(plane->old_fb);
1590                 }
1591                 plane->old_fb = NULL;
1592         }
1593 }
1594 EXPORT_SYMBOL(drm_atomic_clean_old_fb);
1595
1596 int drm_mode_atomic_ioctl(struct drm_device *dev,
1597                           void *data, struct drm_file *file_priv)
1598 {
1599         struct drm_mode_atomic *arg = data;
1600         uint32_t __user *objs_ptr = (uint32_t __user *)(unsigned long)(arg->objs_ptr);
1601         uint32_t __user *count_props_ptr = (uint32_t __user *)(unsigned long)(arg->count_props_ptr);
1602         uint32_t __user *props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
1603         uint64_t __user *prop_values_ptr = (uint64_t __user *)(unsigned long)(arg->prop_values_ptr);
1604         unsigned int copied_objs, copied_props;
1605         struct drm_atomic_state *state;
1606         struct drm_modeset_acquire_ctx ctx;
1607         struct drm_plane *plane;
1608         struct drm_crtc *crtc;
1609         struct drm_crtc_state *crtc_state;
1610         unsigned plane_mask;
1611         int ret = 0;
1612         unsigned int i, j;
1613
1614         /* disallow for drivers not supporting atomic: */
1615         if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1616                 return -EINVAL;
1617
1618         /* disallow for userspace that has not enabled atomic cap (even
1619          * though this may be a bit overkill, since legacy userspace
1620          * wouldn't know how to call this ioctl)
1621          */
1622         if (!file_priv->atomic)
1623                 return -EINVAL;
1624
1625         if (arg->flags & ~DRM_MODE_ATOMIC_FLAGS)
1626                 return -EINVAL;
1627
1628         if (arg->reserved)
1629                 return -EINVAL;
1630
1631         if ((arg->flags & DRM_MODE_PAGE_FLIP_ASYNC) &&
1632                         !dev->mode_config.async_page_flip)
1633                 return -EINVAL;
1634
1635         /* can't test and expect an event at the same time. */
1636         if ((arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) &&
1637                         (arg->flags & DRM_MODE_PAGE_FLIP_EVENT))
1638                 return -EINVAL;
1639
1640         drm_modeset_acquire_init(&ctx, 0);
1641
1642         state = drm_atomic_state_alloc(dev);
1643         if (!state)
1644                 return -ENOMEM;
1645
1646         state->acquire_ctx = &ctx;
1647         state->allow_modeset = !!(arg->flags & DRM_MODE_ATOMIC_ALLOW_MODESET);
1648
1649 retry:
1650         plane_mask = 0;
1651         copied_objs = 0;
1652         copied_props = 0;
1653
1654         for (i = 0; i < arg->count_objs; i++) {
1655                 uint32_t obj_id, count_props;
1656                 struct drm_mode_object *obj;
1657
1658                 if (get_user(obj_id, objs_ptr + copied_objs)) {
1659                         ret = -EFAULT;
1660                         goto out;
1661                 }
1662
1663                 obj = drm_mode_object_find(dev, obj_id, DRM_MODE_OBJECT_ANY);
1664                 if (!obj) {
1665                         ret = -ENOENT;
1666                         goto out;
1667                 }
1668
1669                 if (!obj->properties) {
1670                         drm_mode_object_unreference(obj);
1671                         ret = -ENOENT;
1672                         goto out;
1673                 }
1674
1675                 if (get_user(count_props, count_props_ptr + copied_objs)) {
1676                         drm_mode_object_unreference(obj);
1677                         ret = -EFAULT;
1678                         goto out;
1679                 }
1680
1681                 copied_objs++;
1682
1683                 for (j = 0; j < count_props; j++) {
1684                         uint32_t prop_id;
1685                         uint64_t prop_value;
1686                         struct drm_property *prop;
1687
1688                         if (get_user(prop_id, props_ptr + copied_props)) {
1689                                 drm_mode_object_unreference(obj);
1690                                 ret = -EFAULT;
1691                                 goto out;
1692                         }
1693
1694                         prop = drm_mode_obj_find_prop_id(obj, prop_id);
1695                         if (!prop) {
1696                                 drm_mode_object_unreference(obj);
1697                                 ret = -ENOENT;
1698                                 goto out;
1699                         }
1700
1701                         if (copy_from_user(&prop_value,
1702                                            prop_values_ptr + copied_props,
1703                                            sizeof(prop_value))) {
1704                                 drm_mode_object_unreference(obj);
1705                                 ret = -EFAULT;
1706                                 goto out;
1707                         }
1708
1709                         ret = atomic_set_prop(state, obj, prop, prop_value);
1710                         if (ret) {
1711                                 drm_mode_object_unreference(obj);
1712                                 goto out;
1713                         }
1714
1715                         copied_props++;
1716                 }
1717
1718                 if (obj->type == DRM_MODE_OBJECT_PLANE && count_props &&
1719                     !(arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)) {
1720                         plane = obj_to_plane(obj);
1721                         plane_mask |= (1 << drm_plane_index(plane));
1722                         plane->old_fb = plane->fb;
1723                 }
1724                 drm_mode_object_unreference(obj);
1725         }
1726
1727         if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1728                 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1729                         struct drm_pending_vblank_event *e;
1730
1731                         e = create_vblank_event(dev, file_priv, NULL,
1732                                                 arg->user_data);
1733                         if (!e) {
1734                                 ret = -ENOMEM;
1735                                 goto out;
1736                         }
1737
1738                         crtc_state->event = e;
1739                 }
1740         }
1741
1742         if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) {
1743                 /*
1744                  * Unlike commit, check_only does not clean up state.
1745                  * Below we call drm_atomic_state_free for it.
1746                  */
1747                 ret = drm_atomic_check_only(state);
1748         } else if (arg->flags & DRM_MODE_ATOMIC_NONBLOCK) {
1749                 ret = drm_atomic_nonblocking_commit(state);
1750         } else {
1751                 ret = drm_atomic_commit(state);
1752         }
1753
1754 out:
1755         drm_atomic_clean_old_fb(dev, plane_mask, ret);
1756
1757         if (ret && arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1758                 /*
1759                  * TEST_ONLY and PAGE_FLIP_EVENT are mutually exclusive,
1760                  * if they weren't, this code should be called on success
1761                  * for TEST_ONLY too.
1762                  */
1763
1764                 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1765                         if (!crtc_state->event)
1766                                 continue;
1767
1768                         drm_event_cancel_free(dev, &crtc_state->event->base);
1769                 }
1770         }
1771
1772         if (ret == -EDEADLK) {
1773                 drm_atomic_state_clear(state);
1774                 drm_modeset_backoff(&ctx);
1775                 goto retry;
1776         }
1777
1778         if (ret || arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)
1779                 drm_atomic_state_free(state);
1780
1781         drm_modeset_drop_locks(&ctx);
1782         drm_modeset_acquire_fini(&ctx);
1783
1784         return ret;
1785 }