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