drivers/gpu/drm/drm_atomic_helper.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 #include <drm/drmP.h>
  29 #include <drm/drm_atomic.h>
  30 #include <drm/drm_plane_helper.h>
  31 #include <drm/drm_crtc_helper.h>
  32 #include <drm/drm_atomic_helper.h>
  33 #include <linux/fence.h>
  34
  35 /**
  36  * DOC: overview
  37  *
  38  * This helper library provides implementations of check and commit functions on
  39  * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
  40  * also provides convenience implementations for the atomic state handling
  41  * callbacks for drivers which don't need to subclass the drm core structures to
  42  * add their own additional internal state.
  43  *
  44  * This library also provides default implementations for the check callback in
  45  * drm_atomic_helper_check and for the commit callback with
  46  * drm_atomic_helper_commit. But the individual stages and callbacks are expose
  47  * to allow drivers to mix and match and e.g. use the plane helpers only
  48  * together with a driver private modeset implementation.
  49  *
  50  * This library also provides implementations for all the legacy driver
  51  * interfaces on top of the atomic interface. See drm_atomic_helper_set_config,
  52  * drm_atomic_helper_disable_plane, drm_atomic_helper_disable_plane and the
  53  * various functions to implement set_property callbacks. New drivers must not
  54  * implement these functions themselves but must use the provided helpers.
  55  */
  56 static void
  57 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
  58                                 struct drm_plane_state *plane_state,
  59                                 struct drm_plane *plane)
  60 {
  61         struct drm_crtc_state *crtc_state;
  62
  63         if (plane->state->crtc) {
  64                 crtc_state = state->crtc_states[drm_crtc_index(plane->state->crtc)];
  65
  66                 if (WARN_ON(!crtc_state))
  67                         return;
  68
  69                 crtc_state->planes_changed = true;
  70         }
  71
  72         if (plane_state->crtc) {
  73                 crtc_state =
  74                         state->crtc_states[drm_crtc_index(plane_state->crtc)];
  75
  76                 if (WARN_ON(!crtc_state))
  77                         return;
  78
  79                 crtc_state->planes_changed = true;
  80         }
  81 }
  82
  83 static struct drm_crtc *
  84 get_current_crtc_for_encoder(struct drm_device *dev,
  85                              struct drm_encoder *encoder)
  86 {
  87         struct drm_mode_config *config = &dev->mode_config;
  88         struct drm_connector *connector;
  89
  90         WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
  91
  92         list_for_each_entry(connector, &config->connector_list, head) {
  93                 if (connector->state->best_encoder != encoder)
  94                         continue;
  95
  96                 return connector->state->crtc;
  97         }
  98
  99         return NULL;
 100 }
 101
 102 static int
 103 steal_encoder(struct drm_atomic_state *state,
 104               struct drm_encoder *encoder,
 105               struct drm_crtc *encoder_crtc)
 106 {
 107         struct drm_mode_config *config = &state->dev->mode_config;
 108         struct drm_crtc_state *crtc_state;
 109         struct drm_connector *connector;
 110         struct drm_connector_state *connector_state;
 111         int ret;
 112
 113         /*
 114          * We can only steal an encoder coming from a connector, which means we
 115          * must already hold the connection_mutex.
 116          */
 117         WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
 118
 119         DRM_DEBUG_KMS("[ENCODER:%d:%s] in use on [CRTC:%d], stealing it\n",
 120                       encoder->base.id, encoder->name,
 121                       encoder_crtc->base.id);
 122
 123         crtc_state = drm_atomic_get_crtc_state(state, encoder_crtc);
 124         if (IS_ERR(crtc_state))
 125                 return PTR_ERR(crtc_state);
 126
 127         crtc_state->mode_changed = true;
 128
 129         list_for_each_entry(connector, &config->connector_list, head) {
 130                 if (connector->state->best_encoder != encoder)
 131                         continue;
 132
 133                 DRM_DEBUG_KMS("Stealing encoder from [CONNECTOR:%d:%s]\n",
 134                               connector->base.id,
 135                               connector->name);
 136
 137                 connector_state = drm_atomic_get_connector_state(state,
 138                                                                  connector);
 139                 if (IS_ERR(connector_state))
 140                         return PTR_ERR(connector_state);
 141
 142                 ret = drm_atomic_set_crtc_for_connector(connector_state, NULL);
 143                 if (ret)
 144                         return ret;
 145                 connector_state->best_encoder = NULL;
 146         }
 147
 148         return 0;
 149 }
 150
 151 static int
 152 update_connector_routing(struct drm_atomic_state *state, int conn_idx)
 153 {
 154         struct drm_connector_helper_funcs *funcs;
 155         struct drm_encoder *new_encoder;
 156         struct drm_crtc *encoder_crtc;
 157         struct drm_connector *connector;
 158         struct drm_connector_state *connector_state;
 159         struct drm_crtc_state *crtc_state;
 160         int idx, ret;
 161
 162         connector = state->connectors[conn_idx];
 163         connector_state = state->connector_states[conn_idx];
 164
 165         if (!connector)
 166                 return 0;
 167
 168         DRM_DEBUG_KMS("Updating routing for [CONNECTOR:%d:%s]\n",
 169                         connector->base.id,
 170                         connector->name);
 171
 172         if (connector->state->crtc != connector_state->crtc) {
 173                 if (connector->state->crtc) {
 174                         idx = drm_crtc_index(connector->state->crtc);
 175
 176                         crtc_state = state->crtc_states[idx];
 177                         crtc_state->mode_changed = true;
 178                 }
 179
 180                 if (connector_state->crtc) {
 181                         idx = drm_crtc_index(connector_state->crtc);
 182
 183                         crtc_state = state->crtc_states[idx];
 184                         crtc_state->mode_changed = true;
 185                 }
 186         }
 187
 188         if (!connector_state->crtc) {
 189                 DRM_DEBUG_KMS("Disabling [CONNECTOR:%d:%s]\n",
 190                                 connector->base.id,
 191                                 connector->name);
 192
 193                 connector_state->best_encoder = NULL;
 194
 195                 return 0;
 196         }
 197
 198         funcs = connector->helper_private;
 199         new_encoder = funcs->best_encoder(connector);
 200
 201         if (!new_encoder) {
 202                 DRM_DEBUG_KMS("No suitable encoder found for [CONNECTOR:%d:%s]\n",
 203                               connector->base.id,
 204                               connector->name);
 205                 return -EINVAL;
 206         }
 207
 208         if (new_encoder == connector_state->best_encoder) {
 209                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d]\n",
 210                               connector->base.id,
 211                               connector->name,
 212                               new_encoder->base.id,
 213                               new_encoder->name,
 214                               connector_state->crtc->base.id);
 215
 216                 return 0;
 217         }
 218
 219         encoder_crtc = get_current_crtc_for_encoder(state->dev,
 220                                                     new_encoder);
 221
 222         if (encoder_crtc) {
 223                 ret = steal_encoder(state, new_encoder, encoder_crtc);
 224                 if (ret) {
 225                         DRM_DEBUG_KMS("Encoder stealing failed for [CONNECTOR:%d:%s]\n",
 226                                       connector->base.id,
 227                                       connector->name);
 228                         return ret;
 229                 }
 230         }
 231
 232         connector_state->best_encoder = new_encoder;
 233         idx = drm_crtc_index(connector_state->crtc);
 234
 235         crtc_state = state->crtc_states[idx];
 236         crtc_state->mode_changed = true;
 237
 238         DRM_DEBUG_KMS("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d]\n",
 239                       connector->base.id,
 240                       connector->name,
 241                       new_encoder->base.id,
 242                       new_encoder->name,
 243                       connector_state->crtc->base.id);
 244
 245         return 0;
 246 }
 247
 248 static int
 249 mode_fixup(struct drm_atomic_state *state)
 250 {
 251         int ncrtcs = state->dev->mode_config.num_crtc;
 252         struct drm_crtc_state *crtc_state;
 253         struct drm_connector_state *conn_state;
 254         int i;
 255         bool ret;
 256
 257         for (i = 0; i < ncrtcs; i++) {
 258                 crtc_state = state->crtc_states[i];
 259
 260                 if (!crtc_state || !crtc_state->mode_changed)
 261                         continue;
 262
 263                 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
 264         }
 265
 266         for (i = 0; i < state->num_connector; i++) {
 267                 struct drm_encoder_helper_funcs *funcs;
 268                 struct drm_encoder *encoder;
 269
 270                 conn_state = state->connector_states[i];
 271
 272                 if (!conn_state)
 273                         continue;
 274
 275                 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
 276
 277                 if (!conn_state->crtc || !conn_state->best_encoder)
 278                         continue;
 279
 280                 crtc_state =
 281                         state->crtc_states[drm_crtc_index(conn_state->crtc)];
 282
 283                 /*
 284                  * Each encoder has at most one connector (since we always steal
 285                  * it away), so we won't call ->mode_fixup twice.
 286                  */
 287                 encoder = conn_state->best_encoder;
 288                 funcs = encoder->helper_private;
 289
 290                 if (encoder->bridge && encoder->bridge->funcs->mode_fixup) {
 291                         ret = encoder->bridge->funcs->mode_fixup(
 292                                         encoder->bridge, &crtc_state->mode,
 293                                         &crtc_state->adjusted_mode);
 294                         if (!ret) {
 295                                 DRM_DEBUG_KMS("Bridge fixup failed\n");
 296                                 return -EINVAL;
 297                         }
 298                 }
 299
 300                 if (funcs->atomic_check) {
 301                         ret = funcs->atomic_check(encoder, crtc_state,
 302                                                   conn_state);
 303                         if (ret) {
 304                                 DRM_DEBUG_KMS("[ENCODER:%d:%s] check failed\n",
 305                                               encoder->base.id, encoder->name);
 306                                 return ret;
 307                         }
 308                 } else {
 309                         ret = funcs->mode_fixup(encoder, &crtc_state->mode,
 310                                                 &crtc_state->adjusted_mode);
 311                         if (!ret) {
 312                                 DRM_DEBUG_KMS("[ENCODER:%d:%s] fixup failed\n",
 313                                               encoder->base.id, encoder->name);
 314                                 return -EINVAL;
 315                         }
 316                 }
 317         }
 318
 319         for (i = 0; i < ncrtcs; i++) {
 320                 struct drm_crtc_helper_funcs *funcs;
 321                 struct drm_crtc *crtc;
 322
 323                 crtc_state = state->crtc_states[i];
 324                 crtc = state->crtcs[i];
 325
 326                 if (!crtc_state || !crtc_state->mode_changed)
 327                         continue;
 328
 329                 funcs = crtc->helper_private;
 330                 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
 331                                         &crtc_state->adjusted_mode);
 332                 if (!ret) {
 333                         DRM_DEBUG_KMS("[CRTC:%d] fixup failed\n",
 334                                       crtc->base.id);
 335                         return -EINVAL;
 336                 }
 337         }
 338
 339         return 0;
 340 }
 341
 342 static bool
 343 needs_modeset(struct drm_crtc_state *state)
 344 {
 345         return state->mode_changed || state->active_changed;
 346 }
 347
 348 /**
 349  * drm_atomic_helper_check - validate state object for modeset changes
 350  * @dev: DRM device
 351  * @state: the driver state object
 352  *
 353  * Check the state object to see if the requested state is physically possible.
 354  * This does all the crtc and connector related computations for an atomic
 355  * update. It computes and updates crtc_state->mode_changed, adds any additional
 356  * connectors needed for full modesets and calls down into ->mode_fixup
 357  * functions of the driver backend.
 358  *
 359  * IMPORTANT:
 360  *
 361  * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
 362  * plane update can't be done without a full modeset) _must_ call this function
 363  * afterwards after that change. It is permitted to call this function multiple
 364  * times for the same update, e.g. when the ->atomic_check functions depend upon
 365  * the adjusted dotclock for fifo space allocation and watermark computation.
 366  *
 367  * RETURNS
 368  * Zero for success or -errno
 369  */
 370 int
 371 drm_atomic_helper_check_modeset(struct drm_device *dev,
 372                                 struct drm_atomic_state *state)
 373 {
 374         int ncrtcs = dev->mode_config.num_crtc;
 375         struct drm_crtc *crtc;
 376         struct drm_crtc_state *crtc_state;
 377         int i, ret;
 378
 379         for (i = 0; i < ncrtcs; i++) {
 380                 crtc = state->crtcs[i];
 381                 crtc_state = state->crtc_states[i];
 382
 383                 if (!crtc)
 384                         continue;
 385
 386                 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
 387                         DRM_DEBUG_KMS("[CRTC:%d] mode changed\n",
 388                                       crtc->base.id);
 389                         crtc_state->mode_changed = true;
 390                 }
 391
 392                 if (crtc->state->enable != crtc_state->enable) {
 393                         DRM_DEBUG_KMS("[CRTC:%d] enable changed\n",
 394                                       crtc->base.id);
 395                         crtc_state->mode_changed = true;
 396                 }
 397         }
 398
 399         for (i = 0; i < state->num_connector; i++) {
 400                 /*
 401                  * This only sets crtc->mode_changed for routing changes,
 402                  * drivers must set crtc->mode_changed themselves when connector
 403                  * properties need to be updated.
 404                  */
 405                 ret = update_connector_routing(state, i);
 406                 if (ret)
 407                         return ret;
 408         }
 409
 410         /*
 411          * After all the routing has been prepared we need to add in any
 412          * connector which is itself unchanged, but who's crtc changes it's
 413          * configuration. This must be done before calling mode_fixup in case a
 414          * crtc only changed its mode but has the same set of connectors.
 415          */
 416         for (i = 0; i < ncrtcs; i++) {
 417                 int num_connectors;
 418
 419                 crtc = state->crtcs[i];
 420                 crtc_state = state->crtc_states[i];
 421
 422                 if (!crtc)
 423                         continue;
 424
 425                 /*
 426                  * We must set ->active_changed after walking connectors for
 427                  * otherwise an update that only changes active would result in
 428                  * a full modeset because update_connector_routing force that.
 429                  */
 430                 if (crtc->state->active != crtc_state->active) {
 431                         DRM_DEBUG_KMS("[CRTC:%d] active changed\n",
 432                                       crtc->base.id);
 433                         crtc_state->active_changed = true;
 434                 }
 435
 436                 if (!needs_modeset(crtc_state))
 437                         continue;
 438
 439                 DRM_DEBUG_KMS("[CRTC:%d] needs all connectors, enable: %c, active: %c\n",
 440                               crtc->base.id,
 441                               crtc_state->enable ? 'y' : 'n',
 442                               crtc_state->active ? 'y' : 'n');
 443
 444                 ret = drm_atomic_add_affected_connectors(state, crtc);
 445                 if (ret != 0)
 446                         return ret;
 447
 448                 num_connectors = drm_atomic_connectors_for_crtc(state,
 449                                                                 crtc);
 450
 451                 if (crtc_state->enable != !!num_connectors) {
 452                         DRM_DEBUG_KMS("[CRTC:%d] enabled/connectors mismatch\n",
 453                                       crtc->base.id);
 454
 455                         return -EINVAL;
 456                 }
 457         }
 458
 459         return mode_fixup(state);
 460 }
 461 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
 462
 463 /**
 464  * drm_atomic_helper_check - validate state object for modeset changes
 465  * @dev: DRM device
 466  * @state: the driver state object
 467  *
 468  * Check the state object to see if the requested state is physically possible.
 469  * This does all the plane update related checks using by calling into the
 470  * ->atomic_check hooks provided by the driver.
 471  *
 472  * RETURNS
 473  * Zero for success or -errno
 474  */
 475 int
 476 drm_atomic_helper_check_planes(struct drm_device *dev,
 477                                struct drm_atomic_state *state)
 478 {
 479         int nplanes = dev->mode_config.num_total_plane;
 480         int ncrtcs = dev->mode_config.num_crtc;
 481         int i, ret = 0;
 482
 483         for (i = 0; i < nplanes; i++) {
 484                 struct drm_plane_helper_funcs *funcs;
 485                 struct drm_plane *plane = state->planes[i];
 486                 struct drm_plane_state *plane_state = state->plane_states[i];
 487
 488                 if (!plane)
 489                         continue;
 490
 491                 funcs = plane->helper_private;
 492
 493                 drm_atomic_helper_plane_changed(state, plane_state, plane);
 494
 495                 if (!funcs || !funcs->atomic_check)
 496                         continue;
 497
 498                 ret = funcs->atomic_check(plane, plane_state);
 499                 if (ret) {
 500                         DRM_DEBUG_KMS("[PLANE:%d] atomic driver check failed\n",
 501                                       plane->base.id);
 502                         return ret;
 503                 }
 504         }
 505
 506         for (i = 0; i < ncrtcs; i++) {
 507                 struct drm_crtc_helper_funcs *funcs;
 508                 struct drm_crtc *crtc = state->crtcs[i];
 509
 510                 if (!crtc)
 511                         continue;
 512
 513                 funcs = crtc->helper_private;
 514
 515                 if (!funcs || !funcs->atomic_check)
 516                         continue;
 517
 518                 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
 519                 if (ret) {
 520                         DRM_DEBUG_KMS("[CRTC:%d] atomic driver check failed\n",
 521                                       crtc->base.id);
 522                         return ret;
 523                 }
 524         }
 525
 526         return ret;
 527 }
 528 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
 529
 530 /**
 531  * drm_atomic_helper_check - validate state object
 532  * @dev: DRM device
 533  * @state: the driver state object
 534  *
 535  * Check the state object to see if the requested state is physically possible.
 536  * Only crtcs and planes have check callbacks, so for any additional (global)
 537  * checking that a driver needs it can simply wrap that around this function.
 538  * Drivers without such needs can directly use this as their ->atomic_check()
 539  * callback.
 540  *
 541  * This just wraps the two parts of the state checking for planes and modeset
 542  * state in the default order: First it calls drm_atomic_helper_check_modeset()
 543  * and then drm_atomic_helper_check_planes(). The assumption is that the
 544  * ->atomic_check functions depend upon an updated adjusted_mode.clock to
 545  * e.g. properly compute watermarks.
 546  *
 547  * RETURNS
 548  * Zero for success or -errno
 549  */
 550 int drm_atomic_helper_check(struct drm_device *dev,
 551                             struct drm_atomic_state *state)
 552 {
 553         int ret;
 554
 555         ret = drm_atomic_helper_check_modeset(dev, state);
 556         if (ret)
 557                 return ret;
 558
 559         ret = drm_atomic_helper_check_planes(dev, state);
 560         if (ret)
 561                 return ret;
 562
 563         return ret;
 564 }
 565 EXPORT_SYMBOL(drm_atomic_helper_check);
 566
 567 static void
 568 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
 569 {
 570         int ncrtcs = old_state->dev->mode_config.num_crtc;
 571         int i;
 572
 573         for (i = 0; i < old_state->num_connector; i++) {
 574                 struct drm_connector_state *old_conn_state;
 575                 struct drm_connector *connector;
 576                 struct drm_encoder_helper_funcs *funcs;
 577                 struct drm_encoder *encoder;
 578                 struct drm_crtc_state *old_crtc_state;
 579
 580                 old_conn_state = old_state->connector_states[i];
 581                 connector = old_state->connectors[i];
 582
 583                 /* Shut down everything that's in the changeset and currently
 584                  * still on. So need to check the old, saved state. */
 585                 if (!old_conn_state || !old_conn_state->crtc)
 586                         continue;
 587
 588                 old_crtc_state = old_state->crtc_states[drm_crtc_index(old_conn_state->crtc)];
 589
 590                 if (!old_crtc_state->active)
 591                         continue;
 592
 593                 encoder = old_conn_state->best_encoder;
 594
 595                 /* We shouldn't get this far if we didn't previously have
 596                  * an encoder.. but WARN_ON() rather than explode.
 597                  */
 598                 if (WARN_ON(!encoder))
 599                         continue;
 600
 601                 funcs = encoder->helper_private;
 602
 603                 DRM_DEBUG_KMS("disabling [ENCODER:%d:%s]\n",
 604                               encoder->base.id, encoder->name);
 605
 606                 /*
 607                  * Each encoder has at most one connector (since we always steal
 608                  * it away), so we won't call call disable hooks twice.
 609                  */
 610                 if (encoder->bridge)
 611                         encoder->bridge->funcs->disable(encoder->bridge);
 612
 613                 /* Right function depends upon target state. */
 614                 if (connector->state->crtc && funcs->prepare)
 615                         funcs->prepare(encoder);
 616                 else if (funcs->disable)
 617                         funcs->disable(encoder);
 618                 else
 619                         funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
 620
 621                 if (encoder->bridge)
 622                         encoder->bridge->funcs->post_disable(encoder->bridge);
 623         }
 624
 625         for (i = 0; i < ncrtcs; i++) {
 626                 struct drm_crtc_helper_funcs *funcs;
 627                 struct drm_crtc *crtc;
 628                 struct drm_crtc_state *old_crtc_state;
 629
 630                 crtc = old_state->crtcs[i];
 631                 old_crtc_state = old_state->crtc_states[i];
 632
 633                 /* Shut down everything that needs a full modeset. */
 634                 if (!crtc || !needs_modeset(crtc->state))
 635                         continue;
 636
 637                 if (!old_crtc_state->active)
 638                         continue;
 639
 640                 funcs = crtc->helper_private;
 641
 642                 DRM_DEBUG_KMS("disabling [CRTC:%d]\n",
 643                               crtc->base.id);
 644
 645
 646                 /* Right function depends upon target state. */
 647                 if (crtc->state->enable && funcs->prepare)
 648                         funcs->prepare(crtc);
 649                 else if (funcs->disable)
 650                         funcs->disable(crtc);
 651                 else
 652                         funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
 653         }
 654 }
 655
 656 static void
 657 set_routing_links(struct drm_device *dev, struct drm_atomic_state *old_state)
 658 {
 659         int ncrtcs = old_state->dev->mode_config.num_crtc;
 660         int i;
 661
 662         /* clear out existing links */
 663         for (i = 0; i < old_state->num_connector; i++) {
 664                 struct drm_connector *connector;
 665
 666                 connector = old_state->connectors[i];
 667
 668                 if (!connector || !connector->encoder)
 669                         continue;
 670
 671                 WARN_ON(!connector->encoder->crtc);
 672
 673                 connector->encoder->crtc = NULL;
 674                 connector->encoder = NULL;
 675         }
 676
 677         /* set new links */
 678         for (i = 0; i < old_state->num_connector; i++) {
 679                 struct drm_connector *connector;
 680
 681                 connector = old_state->connectors[i];
 682
 683                 if (!connector || !connector->state->crtc)
 684                         continue;
 685
 686                 if (WARN_ON(!connector->state->best_encoder))
 687                         continue;
 688
 689                 connector->encoder = connector->state->best_encoder;
 690                 connector->encoder->crtc = connector->state->crtc;
 691         }
 692
 693         /* set legacy state in the crtc structure */
 694         for (i = 0; i < ncrtcs; i++) {
 695                 struct drm_crtc *crtc;
 696
 697                 crtc = old_state->crtcs[i];
 698
 699                 if (!crtc)
 700                         continue;
 701
 702                 crtc->mode = crtc->state->mode;
 703                 crtc->enabled = crtc->state->enable;
 704                 crtc->x = crtc->primary->state->src_x >> 16;
 705                 crtc->y = crtc->primary->state->src_y >> 16;
 706         }
 707 }
 708
 709 static void
 710 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
 711 {
 712         int ncrtcs = old_state->dev->mode_config.num_crtc;
 713         int i;
 714
 715         for (i = 0; i < ncrtcs; i++) {
 716                 struct drm_crtc_helper_funcs *funcs;
 717                 struct drm_crtc *crtc;
 718
 719                 crtc = old_state->crtcs[i];
 720
 721                 if (!crtc || !crtc->state->mode_changed)
 722                         continue;
 723
 724                 funcs = crtc->helper_private;
 725
 726                 if (crtc->state->enable) {
 727                         DRM_DEBUG_KMS("modeset on [CRTC:%d]\n",
 728                                       crtc->base.id);
 729
 730                         funcs->mode_set_nofb(crtc);
 731                 }
 732         }
 733
 734         for (i = 0; i < old_state->num_connector; i++) {
 735                 struct drm_connector *connector;
 736                 struct drm_crtc_state *new_crtc_state;
 737                 struct drm_encoder_helper_funcs *funcs;
 738                 struct drm_encoder *encoder;
 739                 struct drm_display_mode *mode, *adjusted_mode;
 740
 741                 connector = old_state->connectors[i];
 742
 743                 if (!connector || !connector->state->best_encoder)
 744                         continue;
 745
 746                 encoder = connector->state->best_encoder;
 747                 funcs = encoder->helper_private;
 748                 new_crtc_state = connector->state->crtc->state;
 749                 mode = &new_crtc_state->mode;
 750                 adjusted_mode = &new_crtc_state->adjusted_mode;
 751
 752                 if (!new_crtc_state->mode_changed)
 753                         continue;
 754
 755                 DRM_DEBUG_KMS("modeset on [ENCODER:%d:%s]\n",
 756                               encoder->base.id, encoder->name);
 757
 758                 /*
 759                  * Each encoder has at most one connector (since we always steal
 760                  * it away), so we won't call call mode_set hooks twice.
 761                  */
 762                 funcs->mode_set(encoder, mode, adjusted_mode);
 763
 764                 if (encoder->bridge && encoder->bridge->funcs->mode_set)
 765                         encoder->bridge->funcs->mode_set(encoder->bridge,
 766                                                          mode, adjusted_mode);
 767         }
 768 }
 769
 770 /**
 771  * drm_atomic_helper_commit_pre_planes - modeset commit before plane updates
 772  * @dev: DRM device
 773  * @state: atomic state
 774  *
 775  * This function commits the modeset changes that need to be committed before
 776  * updating planes. It shuts down all the outputs that need to be shut down and
 777  * prepares them (if required) with the new mode.
 778  */
 779 void drm_atomic_helper_commit_pre_planes(struct drm_device *dev,
 780                                          struct drm_atomic_state *state)
 781 {
 782         disable_outputs(dev, state);
 783         set_routing_links(dev, state);
 784         crtc_set_mode(dev, state);
 785 }
 786 EXPORT_SYMBOL(drm_atomic_helper_commit_pre_planes);
 787
 788 /**
 789  * drm_atomic_helper_commit_post_planes - modeset commit after plane updates
 790  * @dev: DRM device
 791  * @old_state: atomic state object with old state structures
 792  *
 793  * This function commits the modeset changes that need to be committed after
 794  * updating planes: It enables all the outputs with the new configuration which
 795  * had to be turned off for the update.
 796  */
 797 void drm_atomic_helper_commit_post_planes(struct drm_device *dev,
 798                                           struct drm_atomic_state *old_state)
 799 {
 800         int ncrtcs = old_state->dev->mode_config.num_crtc;
 801         int i;
 802
 803         for (i = 0; i < ncrtcs; i++) {
 804                 struct drm_crtc_helper_funcs *funcs;
 805                 struct drm_crtc *crtc;
 806
 807                 crtc = old_state->crtcs[i];
 808
 809                 /* Need to filter out CRTCs where only planes change. */
 810                 if (!crtc || !needs_modeset(crtc->state))
 811                         continue;
 812
 813                 if (!crtc->state->active)
 814                         continue;
 815
 816                 funcs = crtc->helper_private;
 817
 818                 if (crtc->state->enable) {
 819                         DRM_DEBUG_KMS("enabling [CRTC:%d]\n",
 820                                       crtc->base.id);
 821
 822                         if (funcs->enable)
 823                                 funcs->enable(crtc);
 824                         else
 825                                 funcs->commit(crtc);
 826                 }
 827         }
 828
 829         for (i = 0; i < old_state->num_connector; i++) {
 830                 struct drm_connector *connector;
 831                 struct drm_encoder_helper_funcs *funcs;
 832                 struct drm_encoder *encoder;
 833
 834                 connector = old_state->connectors[i];
 835
 836                 if (!connector || !connector->state->best_encoder)
 837                         continue;
 838
 839                 if (!connector->state->crtc->state->active)
 840                         continue;
 841
 842                 encoder = connector->state->best_encoder;
 843                 funcs = encoder->helper_private;
 844
 845                 DRM_DEBUG_KMS("enabling [ENCODER:%d:%s]\n",
 846                               encoder->base.id, encoder->name);
 847
 848                 /*
 849                  * Each encoder has at most one connector (since we always steal
 850                  * it away), so we won't call call enable hooks twice.
 851                  */
 852                 if (encoder->bridge)
 853                         encoder->bridge->funcs->pre_enable(encoder->bridge);
 854
 855                 if (funcs->enable)
 856                         funcs->enable(encoder);
 857                 else
 858                         funcs->commit(encoder);
 859
 860                 if (encoder->bridge)
 861                         encoder->bridge->funcs->enable(encoder->bridge);
 862         }
 863 }
 864 EXPORT_SYMBOL(drm_atomic_helper_commit_post_planes);
 865
 866 static void wait_for_fences(struct drm_device *dev,
 867                             struct drm_atomic_state *state)
 868 {
 869         int nplanes = dev->mode_config.num_total_plane;
 870         int i;
 871
 872         for (i = 0; i < nplanes; i++) {
 873                 struct drm_plane *plane = state->planes[i];
 874
 875                 if (!plane || !plane->state->fence)
 876                         continue;
 877
 878                 WARN_ON(!plane->state->fb);
 879
 880                 fence_wait(plane->state->fence, false);
 881                 fence_put(plane->state->fence);
 882                 plane->state->fence = NULL;
 883         }
 884 }
 885
 886 static bool framebuffer_changed(struct drm_device *dev,
 887                                 struct drm_atomic_state *old_state,
 888                                 struct drm_crtc *crtc)
 889 {
 890         struct drm_plane *plane;
 891         struct drm_plane_state *old_plane_state;
 892         int nplanes = old_state->dev->mode_config.num_total_plane;
 893         int i;
 894
 895         for (i = 0; i < nplanes; i++) {
 896                 plane = old_state->planes[i];
 897                 old_plane_state = old_state->plane_states[i];
 898
 899                 if (!plane)
 900                         continue;
 901
 902                 if (plane->state->crtc != crtc &&
 903                     old_plane_state->crtc != crtc)
 904                         continue;
 905
 906                 if (plane->state->fb != old_plane_state->fb)
 907                         return true;
 908         }
 909
 910         return false;
 911 }
 912
 913 /**
 914  * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
 915  * @dev: DRM device
 916  * @old_state: atomic state object with old state structures
 917  *
 918  * Helper to, after atomic commit, wait for vblanks on all effected
 919  * crtcs (ie. before cleaning up old framebuffers using
 920  * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
 921  * framebuffers have actually changed to optimize for the legacy cursor and
 922  * plane update use-case.
 923  */
 924 void
 925 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
 926                 struct drm_atomic_state *old_state)
 927 {
 928         struct drm_crtc *crtc;
 929         struct drm_crtc_state *old_crtc_state;
 930         int ncrtcs = old_state->dev->mode_config.num_crtc;
 931         int i, ret;
 932
 933         for (i = 0; i < ncrtcs; i++) {
 934                 crtc = old_state->crtcs[i];
 935                 old_crtc_state = old_state->crtc_states[i];
 936
 937                 if (!crtc)
 938                         continue;
 939
 940                 /* No one cares about the old state, so abuse it for tracking
 941                  * and store whether we hold a vblank reference (and should do a
 942                  * vblank wait) in the ->enable boolean. */
 943                 old_crtc_state->enable = false;
 944
 945                 if (!crtc->state->enable)
 946                         continue;
 947
 948                 /* Legacy cursor ioctls are completely unsynced, and userspace
 949                  * relies on that (by doing tons of cursor updates). */
 950                 if (old_state->legacy_cursor_update)
 951                         continue;
 952
 953                 if (!framebuffer_changed(dev, old_state, crtc))
 954                         continue;
 955
 956                 ret = drm_crtc_vblank_get(crtc);
 957                 if (ret != 0)
 958                         continue;
 959
 960                 old_crtc_state->enable = true;
 961                 old_crtc_state->last_vblank_count = drm_vblank_count(dev, i);
 962         }
 963
 964         for (i = 0; i < ncrtcs; i++) {
 965                 crtc = old_state->crtcs[i];
 966                 old_crtc_state = old_state->crtc_states[i];
 967
 968                 if (!crtc || !old_crtc_state->enable)
 969                         continue;
 970
 971                 ret = wait_event_timeout(dev->vblank[i].queue,
 972                                 old_crtc_state->last_vblank_count !=
 973                                         drm_vblank_count(dev, i),
 974                                 msecs_to_jiffies(50));
 975
 976                 drm_crtc_vblank_put(crtc);
 977         }
 978 }
 979 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
 980
 981 /**
 982  * drm_atomic_helper_commit - commit validated state object
 983  * @dev: DRM device
 984  * @state: the driver state object
 985  * @async: asynchronous commit
 986  *
 987  * This function commits a with drm_atomic_helper_check() pre-validated state
 988  * object. This can still fail when e.g. the framebuffer reservation fails. For
 989  * now this doesn't implement asynchronous commits.
 990  *
 991  * RETURNS
 992  * Zero for success or -errno.
 993  */
 994 int drm_atomic_helper_commit(struct drm_device *dev,
 995                              struct drm_atomic_state *state,
 996                              bool async)
 997 {
 998         int ret;
 999
1000         if (async)
1001                 return -EBUSY;
1002
1003         ret = drm_atomic_helper_prepare_planes(dev, state);
1004         if (ret)
1005                 return ret;
1006
1007         /*
1008          * This is the point of no return - everything below never fails except
1009          * when the hw goes bonghits. Which means we can commit the new state on
1010          * the software side now.
1011          */
1012
1013         drm_atomic_helper_swap_state(dev, state);
1014
1015         /*
1016          * Everything below can be run asynchronously without the need to grab
1017          * any modeset locks at all under one conditions: It must be guaranteed
1018          * that the asynchronous work has either been cancelled (if the driver
1019          * supports it, which at least requires that the framebuffers get
1020          * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1021          * before the new state gets committed on the software side with
1022          * drm_atomic_helper_swap_state().
1023          *
1024          * This scheme allows new atomic state updates to be prepared and
1025          * checked in parallel to the asynchronous completion of the previous
1026          * update. Which is important since compositors need to figure out the
1027          * composition of the next frame right after having submitted the
1028          * current layout.
1029          */
1030
1031         wait_for_fences(dev, state);
1032
1033         drm_atomic_helper_commit_pre_planes(dev, state);
1034
1035         drm_atomic_helper_commit_planes(dev, state);
1036
1037         drm_atomic_helper_commit_post_planes(dev, state);
1038
1039         drm_atomic_helper_wait_for_vblanks(dev, state);
1040
1041         drm_atomic_helper_cleanup_planes(dev, state);
1042
1043         drm_atomic_state_free(state);
1044
1045         return 0;
1046 }
1047 EXPORT_SYMBOL(drm_atomic_helper_commit);
1048
1049 /**
1050  * DOC: implementing async commit
1051  *
1052  * For now the atomic helpers don't support async commit directly. If there is
1053  * real need it could be added though, using the dma-buf fence infrastructure
1054  * for generic synchronization with outstanding rendering.
1055  *
1056  * For now drivers have to implement async commit themselves, with the following
1057  * sequence being the recommended one:
1058  *
1059  * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1060  * which commit needs to call which can fail, so we want to run it first and
1061  * synchronously.
1062  *
1063  * 2. Synchronize with any outstanding asynchronous commit worker threads which
1064  * might be affected the new state update. This can be done by either cancelling
1065  * or flushing the work items, depending upon whether the driver can deal with
1066  * cancelled updates. Note that it is important to ensure that the framebuffer
1067  * cleanup is still done when cancelling.
1068  *
1069  * For sufficient parallelism it is recommended to have a work item per crtc
1070  * (for updates which don't touch global state) and a global one. Then we only
1071  * need to synchronize with the crtc work items for changed crtcs and the global
1072  * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1073  *
1074  * 3. The software state is updated synchronously with
1075  * drm_atomic_helper_swap_state. Doing this under the protection of all modeset
1076  * locks means concurrent callers never see inconsistent state. And doing this
1077  * while it's guaranteed that no relevant async worker runs means that async
1078  * workers do not need grab any locks. Actually they must not grab locks, for
1079  * otherwise the work flushing will deadlock.
1080  *
1081  * 4. Schedule a work item to do all subsequent steps, using the split-out
1082  * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1083  * then cleaning up the framebuffers after the old framebuffer is no longer
1084  * being displayed.
1085  */
1086
1087 /**
1088  * drm_atomic_helper_prepare_planes - prepare plane resources after commit
1089  * @dev: DRM device
1090  * @state: atomic state object with old state structures
1091  *
1092  * This function prepares plane state, specifically framebuffers, for the new
1093  * configuration. If any failure is encountered this function will call
1094  * ->cleanup_fb on any already successfully prepared framebuffer.
1095  *
1096  * Returns:
1097  * 0 on success, negative error code on failure.
1098  */
1099 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1100                                      struct drm_atomic_state *state)
1101 {
1102         int nplanes = dev->mode_config.num_total_plane;
1103         int ret, i;
1104
1105         for (i = 0; i < nplanes; i++) {
1106                 struct drm_plane_helper_funcs *funcs;
1107                 struct drm_plane *plane = state->planes[i];
1108                 struct drm_framebuffer *fb;
1109
1110                 if (!plane)
1111                         continue;
1112
1113                 funcs = plane->helper_private;
1114
1115                 fb = state->plane_states[i]->fb;
1116
1117                 if (fb && funcs->prepare_fb) {
1118                         ret = funcs->prepare_fb(plane, fb);
1119                         if (ret)
1120                                 goto fail;
1121                 }
1122         }
1123
1124         return 0;
1125
1126 fail:
1127         for (i--; i >= 0; i--) {
1128                 struct drm_plane_helper_funcs *funcs;
1129                 struct drm_plane *plane = state->planes[i];
1130                 struct drm_framebuffer *fb;
1131
1132                 if (!plane)
1133                         continue;
1134
1135                 funcs = plane->helper_private;
1136
1137                 fb = state->plane_states[i]->fb;
1138
1139                 if (fb && funcs->cleanup_fb)
1140                         funcs->cleanup_fb(plane, fb);
1141
1142         }
1143
1144         return ret;
1145 }
1146 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1147
1148 /**
1149  * drm_atomic_helper_commit_planes - commit plane state
1150  * @dev: DRM device
1151  * @old_state: atomic state object with old state structures
1152  *
1153  * This function commits the new plane state using the plane and atomic helper
1154  * functions for planes and crtcs. It assumes that the atomic state has already
1155  * been pushed into the relevant object state pointers, since this step can no
1156  * longer fail.
1157  *
1158  * It still requires the global state object @old_state to know which planes and
1159  * crtcs need to be updated though.
1160  */
1161 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1162                                      struct drm_atomic_state *old_state)
1163 {
1164         int nplanes = dev->mode_config.num_total_plane;
1165         int ncrtcs = dev->mode_config.num_crtc;
1166         int i;
1167
1168         for (i = 0; i < ncrtcs; i++) {
1169                 struct drm_crtc_helper_funcs *funcs;
1170                 struct drm_crtc *crtc = old_state->crtcs[i];
1171
1172                 if (!crtc)
1173                         continue;
1174
1175                 funcs = crtc->helper_private;
1176
1177                 if (!funcs || !funcs->atomic_begin)
1178                         continue;
1179
1180                 funcs->atomic_begin(crtc);
1181         }
1182
1183         for (i = 0; i < nplanes; i++) {
1184                 struct drm_plane_helper_funcs *funcs;
1185                 struct drm_plane *plane = old_state->planes[i];
1186                 struct drm_plane_state *old_plane_state;
1187
1188                 if (!plane)
1189                         continue;
1190
1191                 funcs = plane->helper_private;
1192
1193                 if (!funcs)
1194                         continue;
1195
1196                 old_plane_state = old_state->plane_states[i];
1197
1198                 /*
1199                  * Special-case disabling the plane if drivers support it.
1200                  */
1201                 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1202                     funcs->atomic_disable)
1203                         funcs->atomic_disable(plane, old_plane_state);
1204                 else
1205                         funcs->atomic_update(plane, old_plane_state);
1206         }
1207
1208         for (i = 0; i < ncrtcs; i++) {
1209                 struct drm_crtc_helper_funcs *funcs;
1210                 struct drm_crtc *crtc = old_state->crtcs[i];
1211
1212                 if (!crtc)
1213                         continue;
1214
1215                 funcs = crtc->helper_private;
1216
1217                 if (!funcs || !funcs->atomic_flush)
1218                         continue;
1219
1220                 funcs->atomic_flush(crtc);
1221         }
1222 }
1223 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1224
1225 /**
1226  * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1227  * @dev: DRM device
1228  * @old_state: atomic state object with old state structures
1229  *
1230  * This function cleans up plane state, specifically framebuffers, from the old
1231  * configuration. Hence the old configuration must be perserved in @old_state to
1232  * be able to call this function.
1233  *
1234  * This function must also be called on the new state when the atomic update
1235  * fails at any point after calling drm_atomic_helper_prepare_planes().
1236  */
1237 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1238                                       struct drm_atomic_state *old_state)
1239 {
1240         int nplanes = dev->mode_config.num_total_plane;
1241         int i;
1242
1243         for (i = 0; i < nplanes; i++) {
1244                 struct drm_plane_helper_funcs *funcs;
1245                 struct drm_plane *plane = old_state->planes[i];
1246                 struct drm_framebuffer *old_fb;
1247
1248                 if (!plane)
1249                         continue;
1250
1251                 funcs = plane->helper_private;
1252
1253                 old_fb = old_state->plane_states[i]->fb;
1254
1255                 if (old_fb && funcs->cleanup_fb)
1256                         funcs->cleanup_fb(plane, old_fb);
1257         }
1258 }
1259 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1260
1261 /**
1262  * drm_atomic_helper_swap_state - store atomic state into current sw state
1263  * @dev: DRM device
1264  * @state: atomic state
1265  *
1266  * This function stores the atomic state into the current state pointers in all
1267  * driver objects. It should be called after all failing steps have been done
1268  * and succeeded, but before the actual hardware state is committed.
1269  *
1270  * For cleanup and error recovery the current state for all changed objects will
1271  * be swaped into @state.
1272  *
1273  * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1274  *
1275  * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1276  *
1277  * 2. Do any other steps that might fail.
1278  *
1279  * 3. Put the staged state into the current state pointers with this function.
1280  *
1281  * 4. Actually commit the hardware state.
1282  *
1283  * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3
1284  * contains the old state. Also do any other cleanup required with that state.
1285  */
1286 void drm_atomic_helper_swap_state(struct drm_device *dev,
1287                                   struct drm_atomic_state *state)
1288 {
1289         int i;
1290
1291         for (i = 0; i < dev->mode_config.num_connector; i++) {
1292                 struct drm_connector *connector = state->connectors[i];
1293
1294                 if (!connector)
1295                         continue;
1296
1297                 connector->state->state = state;
1298                 swap(state->connector_states[i], connector->state);
1299                 connector->state->state = NULL;
1300         }
1301
1302         for (i = 0; i < dev->mode_config.num_crtc; i++) {
1303                 struct drm_crtc *crtc = state->crtcs[i];
1304
1305                 if (!crtc)
1306                         continue;
1307
1308                 crtc->state->state = state;
1309                 swap(state->crtc_states[i], crtc->state);
1310                 crtc->state->state = NULL;
1311         }
1312
1313         for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1314                 struct drm_plane *plane = state->planes[i];
1315
1316                 if (!plane)
1317                         continue;
1318
1319                 plane->state->state = state;
1320                 swap(state->plane_states[i], plane->state);
1321                 plane->state->state = NULL;
1322         }
1323 }
1324 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1325
1326 /**
1327  * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1328  * @plane: plane object to update
1329  * @crtc: owning CRTC of owning plane
1330  * @fb: framebuffer to flip onto plane
1331  * @crtc_x: x offset of primary plane on crtc
1332  * @crtc_y: y offset of primary plane on crtc
1333  * @crtc_w: width of primary plane rectangle on crtc
1334  * @crtc_h: height of primary plane rectangle on crtc
1335  * @src_x: x offset of @fb for panning
1336  * @src_y: y offset of @fb for panning
1337  * @src_w: width of source rectangle in @fb
1338  * @src_h: height of source rectangle in @fb
1339  *
1340  * Provides a default plane update handler using the atomic driver interface.
1341  *
1342  * RETURNS:
1343  * Zero on success, error code on failure
1344  */
1345 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1346                                    struct drm_crtc *crtc,
1347                                    struct drm_framebuffer *fb,
1348                                    int crtc_x, int crtc_y,
1349                                    unsigned int crtc_w, unsigned int crtc_h,
1350                                    uint32_t src_x, uint32_t src_y,
1351                                    uint32_t src_w, uint32_t src_h)
1352 {
1353         struct drm_atomic_state *state;
1354         struct drm_plane_state *plane_state;
1355         int ret = 0;
1356
1357         state = drm_atomic_state_alloc(plane->dev);
1358         if (!state)
1359                 return -ENOMEM;
1360
1361         state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1362 retry:
1363         plane_state = drm_atomic_get_plane_state(state, plane);
1364         if (IS_ERR(plane_state)) {
1365                 ret = PTR_ERR(plane_state);
1366                 goto fail;
1367         }
1368
1369         ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1370         if (ret != 0)
1371                 goto fail;
1372         drm_atomic_set_fb_for_plane(plane_state, fb);
1373         plane_state->crtc_x = crtc_x;
1374         plane_state->crtc_y = crtc_y;
1375         plane_state->crtc_h = crtc_h;
1376         plane_state->crtc_w = crtc_w;
1377         plane_state->src_x = src_x;
1378         plane_state->src_y = src_y;
1379         plane_state->src_h = src_h;
1380         plane_state->src_w = src_w;
1381
1382         ret = drm_atomic_commit(state);
1383         if (ret != 0)
1384                 goto fail;
1385
1386         if (plane == crtc->cursor)
1387                 state->legacy_cursor_update = true;
1388
1389         /* Driver takes ownership of state on successful commit. */
1390         return 0;
1391 fail:
1392         if (ret == -EDEADLK)
1393                 goto backoff;
1394
1395         drm_atomic_state_free(state);
1396
1397         return ret;
1398 backoff:
1399         drm_atomic_state_clear(state);
1400         drm_atomic_legacy_backoff(state);
1401
1402         /*
1403          * Someone might have exchanged the framebuffer while we dropped locks
1404          * in the backoff code. We need to fix up the fb refcount tracking the
1405          * core does for us.
1406          */
1407         plane->old_fb = plane->fb;
1408
1409         goto retry;
1410 }
1411 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1412
1413 /**
1414  * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1415  * @plane: plane to disable
1416  *
1417  * Provides a default plane disable handler using the atomic driver interface.
1418  *
1419  * RETURNS:
1420  * Zero on success, error code on failure
1421  */
1422 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1423 {
1424         struct drm_atomic_state *state;
1425         struct drm_plane_state *plane_state;
1426         int ret = 0;
1427
1428         /*
1429          * FIXME: Without plane->crtc set we can't get at the implicit legacy
1430          * acquire context. The real fix will be to wire the acquire ctx through
1431          * everywhere we need it, but meanwhile prevent chaos by just skipping
1432          * this noop. The critical case is the cursor ioctls which a) only grab
1433          * crtc/cursor-plane locks (so we need the crtc to get at the right
1434          * acquire context) and b) can try to disable the plane multiple times.
1435          */
1436         if (!plane->crtc)
1437                 return 0;
1438
1439         state = drm_atomic_state_alloc(plane->dev);
1440         if (!state)
1441                 return -ENOMEM;
1442
1443         state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1444 retry:
1445         plane_state = drm_atomic_get_plane_state(state, plane);
1446         if (IS_ERR(plane_state)) {
1447                 ret = PTR_ERR(plane_state);
1448                 goto fail;
1449         }
1450
1451         ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1452         if (ret != 0)
1453                 goto fail;
1454         drm_atomic_set_fb_for_plane(plane_state, NULL);
1455         plane_state->crtc_x = 0;
1456         plane_state->crtc_y = 0;
1457         plane_state->crtc_h = 0;
1458         plane_state->crtc_w = 0;
1459         plane_state->src_x = 0;
1460         plane_state->src_y = 0;
1461         plane_state->src_h = 0;
1462         plane_state->src_w = 0;
1463
1464         if (plane == plane->crtc->cursor)
1465                 state->legacy_cursor_update = true;
1466
1467         ret = drm_atomic_commit(state);
1468         if (ret != 0)
1469                 goto fail;
1470
1471         /* Driver takes ownership of state on successful commit. */
1472         return 0;
1473 fail:
1474         if (ret == -EDEADLK)
1475                 goto backoff;
1476
1477         drm_atomic_state_free(state);
1478
1479         return ret;
1480 backoff:
1481         drm_atomic_state_clear(state);
1482         drm_atomic_legacy_backoff(state);
1483
1484         /*
1485          * Someone might have exchanged the framebuffer while we dropped locks
1486          * in the backoff code. We need to fix up the fb refcount tracking the
1487          * core does for us.
1488          */
1489         plane->old_fb = plane->fb;
1490
1491         goto retry;
1492 }
1493 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1494
1495 static int update_output_state(struct drm_atomic_state *state,
1496                                struct drm_mode_set *set)
1497 {
1498         struct drm_device *dev = set->crtc->dev;
1499         struct drm_connector_state *conn_state;
1500         int ncrtcs = state->dev->mode_config.num_crtc;
1501         int ret, i, j;
1502
1503         ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1504                                state->acquire_ctx);
1505         if (ret)
1506                 return ret;
1507
1508         /* First grab all affected connector/crtc states. */
1509         for (i = 0; i < set->num_connectors; i++) {
1510                 conn_state = drm_atomic_get_connector_state(state,
1511                                                             set->connectors[i]);
1512                 if (IS_ERR(conn_state))
1513                         return PTR_ERR(conn_state);
1514         }
1515
1516         for (i = 0; i < ncrtcs; i++) {
1517                 struct drm_crtc *crtc = state->crtcs[i];
1518
1519                 if (!crtc)
1520                         continue;
1521
1522                 ret = drm_atomic_add_affected_connectors(state, crtc);
1523                 if (ret)
1524                         return ret;
1525         }
1526
1527         /* Then recompute connector->crtc links and crtc enabling state. */
1528         for (i = 0; i < state->num_connector; i++) {
1529                 struct drm_connector *connector;
1530
1531                 connector = state->connectors[i];
1532                 conn_state = state->connector_states[i];
1533
1534                 if (!connector)
1535                         continue;
1536
1537                 if (conn_state->crtc == set->crtc) {
1538                         ret = drm_atomic_set_crtc_for_connector(conn_state,
1539                                                                 NULL);
1540                         if (ret)
1541                                 return ret;
1542                 }
1543
1544                 for (j = 0; j < set->num_connectors; j++) {
1545                         if (set->connectors[j] == connector) {
1546                                 ret = drm_atomic_set_crtc_for_connector(conn_state,
1547                                                                         set->crtc);
1548                                 if (ret)
1549                                         return ret;
1550                                 break;
1551                         }
1552                 }
1553         }
1554
1555         for (i = 0; i < ncrtcs; i++) {
1556                 struct drm_crtc *crtc = state->crtcs[i];
1557                 struct drm_crtc_state *crtc_state = state->crtc_states[i];
1558
1559                 if (!crtc)
1560                         continue;
1561
1562                 /* Don't update ->enable for the CRTC in the set_config request,
1563                  * since a mismatch would indicate a bug in the upper layers.
1564                  * The actual modeset code later on will catch any
1565                  * inconsistencies here. */
1566                 if (crtc == set->crtc)
1567                         continue;
1568
1569                 crtc_state->enable =
1570                         drm_atomic_connectors_for_crtc(state, crtc);
1571         }
1572
1573         return 0;
1574 }
1575
1576 /**
1577  * drm_atomic_helper_set_config - set a new config from userspace
1578  * @set: mode set configuration
1579  *
1580  * Provides a default crtc set_config handler using the atomic driver interface.
1581  *
1582  * Returns:
1583  * Returns 0 on success, negative errno numbers on failure.
1584  */
1585 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1586 {
1587         struct drm_atomic_state *state;
1588         struct drm_crtc *crtc = set->crtc;
1589         struct drm_crtc_state *crtc_state;
1590         struct drm_plane_state *primary_state;
1591         int ret = 0;
1592
1593         state = drm_atomic_state_alloc(crtc->dev);
1594         if (!state)
1595                 return -ENOMEM;
1596
1597         state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1598 retry:
1599         crtc_state = drm_atomic_get_crtc_state(state, crtc);
1600         if (IS_ERR(crtc_state)) {
1601                 ret = PTR_ERR(crtc_state);
1602                 goto fail;
1603         }
1604
1605         primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1606         if (IS_ERR(primary_state)) {
1607                 ret = PTR_ERR(primary_state);
1608                 goto fail;
1609         }
1610
1611         if (!set->mode) {
1612                 WARN_ON(set->fb);
1613                 WARN_ON(set->num_connectors);
1614
1615                 crtc_state->enable = false;
1616                 crtc_state->active = false;
1617
1618                 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1619                 if (ret != 0)
1620                         goto fail;
1621
1622                 drm_atomic_set_fb_for_plane(primary_state, NULL);
1623
1624                 goto commit;
1625         }
1626
1627         WARN_ON(!set->fb);
1628         WARN_ON(!set->num_connectors);
1629
1630         crtc_state->enable = true;
1631         crtc_state->active = true;
1632         drm_mode_copy(&crtc_state->mode, set->mode);
1633
1634         ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1635         if (ret != 0)
1636                 goto fail;
1637         drm_atomic_set_fb_for_plane(primary_state, set->fb);
1638         primary_state->crtc_x = 0;
1639         primary_state->crtc_y = 0;
1640         primary_state->crtc_h = set->mode->vdisplay;
1641         primary_state->crtc_w = set->mode->hdisplay;
1642         primary_state->src_x = set->x << 16;
1643         primary_state->src_y = set->y << 16;
1644         primary_state->src_h = set->mode->vdisplay << 16;
1645         primary_state->src_w = set->mode->hdisplay << 16;
1646
1647 commit:
1648         ret = update_output_state(state, set);
1649         if (ret)
1650                 goto fail;
1651
1652         ret = drm_atomic_commit(state);
1653         if (ret != 0)
1654                 goto fail;
1655
1656         /* Driver takes ownership of state on successful commit. */
1657         return 0;
1658 fail:
1659         if (ret == -EDEADLK)
1660                 goto backoff;
1661
1662         drm_atomic_state_free(state);
1663
1664         return ret;
1665 backoff:
1666         drm_atomic_state_clear(state);
1667         drm_atomic_legacy_backoff(state);
1668
1669         /*
1670          * Someone might have exchanged the framebuffer while we dropped locks
1671          * in the backoff code. We need to fix up the fb refcount tracking the
1672          * core does for us.
1673          */
1674         crtc->primary->old_fb = crtc->primary->fb;
1675
1676         goto retry;
1677 }
1678 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1679
1680 /**
1681  * drm_atomic_helper_crtc_set_property - helper for crtc prorties
1682  * @crtc: DRM crtc
1683  * @property: DRM property
1684  * @val: value of property
1685  *
1686  * Provides a default plane disablle handler using the atomic driver interface.
1687  *
1688  * RETURNS:
1689  * Zero on success, error code on failure
1690  */
1691 int
1692 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
1693                                     struct drm_property *property,
1694                                     uint64_t val)
1695 {
1696         struct drm_atomic_state *state;
1697         struct drm_crtc_state *crtc_state;
1698         int ret = 0;
1699
1700         state = drm_atomic_state_alloc(crtc->dev);
1701         if (!state)
1702                 return -ENOMEM;
1703
1704         /* ->set_property is always called with all locks held. */
1705         state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
1706 retry:
1707         crtc_state = drm_atomic_get_crtc_state(state, crtc);
1708         if (IS_ERR(crtc_state)) {
1709                 ret = PTR_ERR(crtc_state);
1710                 goto fail;
1711         }
1712
1713         ret = drm_atomic_crtc_set_property(crtc, crtc_state,
1714                         property, val);
1715         if (ret)
1716                 goto fail;
1717
1718         ret = drm_atomic_commit(state);
1719         if (ret != 0)
1720                 goto fail;
1721
1722         /* Driver takes ownership of state on successful commit. */
1723         return 0;
1724 fail:
1725         if (ret == -EDEADLK)
1726                 goto backoff;
1727
1728         drm_atomic_state_free(state);
1729
1730         return ret;
1731 backoff:
1732         drm_atomic_state_clear(state);
1733         drm_atomic_legacy_backoff(state);
1734
1735         goto retry;
1736 }
1737 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
1738
1739 /**
1740  * drm_atomic_helper_plane_set_property - helper for plane prorties
1741  * @plane: DRM plane
1742  * @property: DRM property
1743  * @val: value of property
1744  *
1745  * Provides a default plane disable handler using the atomic driver interface.
1746  *
1747  * RETURNS:
1748  * Zero on success, error code on failure
1749  */
1750 int
1751 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
1752                                     struct drm_property *property,
1753                                     uint64_t val)
1754 {
1755         struct drm_atomic_state *state;
1756         struct drm_plane_state *plane_state;
1757         int ret = 0;
1758
1759         state = drm_atomic_state_alloc(plane->dev);
1760         if (!state)
1761                 return -ENOMEM;
1762
1763         /* ->set_property is always called with all locks held. */
1764         state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
1765 retry:
1766         plane_state = drm_atomic_get_plane_state(state, plane);
1767         if (IS_ERR(plane_state)) {
1768                 ret = PTR_ERR(plane_state);
1769                 goto fail;
1770         }
1771
1772         ret = drm_atomic_plane_set_property(plane, plane_state,
1773                         property, val);
1774         if (ret)
1775                 goto fail;
1776
1777         ret = drm_atomic_commit(state);
1778         if (ret != 0)
1779                 goto fail;
1780
1781         /* Driver takes ownership of state on successful commit. */
1782         return 0;
1783 fail:
1784         if (ret == -EDEADLK)
1785                 goto backoff;
1786
1787         drm_atomic_state_free(state);
1788
1789         return ret;
1790 backoff:
1791         drm_atomic_state_clear(state);
1792         drm_atomic_legacy_backoff(state);
1793
1794         goto retry;
1795 }
1796 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
1797
1798 /**
1799  * drm_atomic_helper_connector_set_property - helper for connector prorties
1800  * @connector: DRM connector
1801  * @property: DRM property
1802  * @val: value of property
1803  *
1804  * Provides a default plane disablle handler using the atomic driver interface.
1805  *
1806  * RETURNS:
1807  * Zero on success, error code on failure
1808  */
1809 int
1810 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
1811                                     struct drm_property *property,
1812                                     uint64_t val)
1813 {
1814         struct drm_atomic_state *state;
1815         struct drm_connector_state *connector_state;
1816         int ret = 0;
1817
1818         state = drm_atomic_state_alloc(connector->dev);
1819         if (!state)
1820                 return -ENOMEM;
1821
1822         /* ->set_property is always called with all locks held. */
1823         state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
1824 retry:
1825         connector_state = drm_atomic_get_connector_state(state, connector);
1826         if (IS_ERR(connector_state)) {
1827                 ret = PTR_ERR(connector_state);
1828                 goto fail;
1829         }
1830
1831         ret = drm_atomic_connector_set_property(connector, connector_state,
1832                         property, val);
1833         if (ret)
1834                 goto fail;
1835
1836         ret = drm_atomic_commit(state);
1837         if (ret != 0)
1838                 goto fail;
1839
1840         /* Driver takes ownership of state on successful commit. */
1841         return 0;
1842 fail:
1843         if (ret == -EDEADLK)
1844                 goto backoff;
1845
1846         drm_atomic_state_free(state);
1847
1848         return ret;
1849 backoff:
1850         drm_atomic_state_clear(state);
1851         drm_atomic_legacy_backoff(state);
1852
1853         goto retry;
1854 }
1855 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
1856
1857 /**
1858  * drm_atomic_helper_page_flip - execute a legacy page flip
1859  * @crtc: DRM crtc
1860  * @fb: DRM framebuffer
1861  * @event: optional DRM event to signal upon completion
1862  * @flags: flip flags for non-vblank sync'ed updates
1863  *
1864  * Provides a default page flip implementation using the atomic driver interface.
1865  *
1866  * Note that for now so called async page flips (i.e. updates which are not
1867  * synchronized to vblank) are not supported, since the atomic interfaces have
1868  * no provisions for this yet.
1869  *
1870  * Returns:
1871  * Returns 0 on success, negative errno numbers on failure.
1872  */
1873 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
1874                                 struct drm_framebuffer *fb,
1875                                 struct drm_pending_vblank_event *event,
1876                                 uint32_t flags)
1877 {
1878         struct drm_plane *plane = crtc->primary;
1879         struct drm_atomic_state *state;
1880         struct drm_plane_state *plane_state;
1881         struct drm_crtc_state *crtc_state;
1882         int ret = 0;
1883
1884         if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
1885                 return -EINVAL;
1886
1887         state = drm_atomic_state_alloc(plane->dev);
1888         if (!state)
1889                 return -ENOMEM;
1890
1891         state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1892 retry:
1893         crtc_state = drm_atomic_get_crtc_state(state, crtc);
1894         if (IS_ERR(crtc_state)) {
1895                 ret = PTR_ERR(crtc_state);
1896                 goto fail;
1897         }
1898         crtc_state->event = event;
1899
1900         plane_state = drm_atomic_get_plane_state(state, plane);
1901         if (IS_ERR(plane_state)) {
1902                 ret = PTR_ERR(plane_state);
1903                 goto fail;
1904         }
1905
1906         ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1907         if (ret != 0)
1908                 goto fail;
1909         drm_atomic_set_fb_for_plane(plane_state, fb);
1910
1911         ret = drm_atomic_async_commit(state);
1912         if (ret != 0)
1913                 goto fail;
1914
1915         /* TODO: ->page_flip is the only driver callback where the core
1916          * doesn't update plane->fb. For now patch it up here. */
1917         plane->fb = plane->state->fb;
1918
1919         /* Driver takes ownership of state on successful async commit. */
1920         return 0;
1921 fail:
1922         if (ret == -EDEADLK)
1923                 goto backoff;
1924
1925         drm_atomic_state_free(state);
1926
1927         return ret;
1928 backoff:
1929         drm_atomic_state_clear(state);
1930         drm_atomic_legacy_backoff(state);
1931
1932         /*
1933          * Someone might have exchanged the framebuffer while we dropped locks
1934          * in the backoff code. We need to fix up the fb refcount tracking the
1935          * core does for us.
1936          */
1937         plane->old_fb = plane->fb;
1938
1939         goto retry;
1940 }
1941 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
1942
1943 /**
1944  * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
1945  * @connector: affected connector
1946  * @mode: DPMS mode
1947  *
1948  * This is the main helper function provided by the atomic helper framework for
1949  * implementing the legacy DPMS connector interface. It computes the new desired
1950  * ->active state for the corresponding CRTC (if the connector is enabled) and
1951  *  updates it.
1952  */
1953 void drm_atomic_helper_connector_dpms(struct drm_connector *connector,
1954                                       int mode)
1955 {
1956         struct drm_mode_config *config = &connector->dev->mode_config;
1957         struct drm_atomic_state *state;
1958         struct drm_crtc_state *crtc_state;
1959         struct drm_crtc *crtc;
1960         struct drm_connector *tmp_connector;
1961         int ret;
1962         bool active = false;
1963
1964         if (mode != DRM_MODE_DPMS_ON)
1965                 mode = DRM_MODE_DPMS_OFF;
1966
1967         connector->dpms = mode;
1968         crtc = connector->state->crtc;
1969
1970         if (!crtc)
1971                 return;
1972
1973         /* FIXME: ->dpms has no return value so can't forward the -ENOMEM. */
1974         state = drm_atomic_state_alloc(connector->dev);
1975         if (!state)
1976                 return;
1977
1978         state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1979 retry:
1980         crtc_state = drm_atomic_get_crtc_state(state, crtc);
1981         if (IS_ERR(crtc_state))
1982                 return;
1983
1984         WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
1985
1986         list_for_each_entry(tmp_connector, &config->connector_list, head) {
1987                 if (connector->state->crtc != crtc)
1988                         continue;
1989
1990                 if (connector->dpms == DRM_MODE_DPMS_ON) {
1991                         active = true;
1992                         break;
1993                 }
1994         }
1995         crtc_state->active = active;
1996
1997         ret = drm_atomic_commit(state);
1998         if (ret != 0)
1999                 goto fail;
2000
2001         /* Driver takes ownership of state on successful async commit. */
2002         return;
2003 fail:
2004         if (ret == -EDEADLK)
2005                 goto backoff;
2006
2007         drm_atomic_state_free(state);
2008
2009         WARN(1, "Driver bug: Changing ->active failed with ret=%i\n", ret);
2010
2011         return;
2012 backoff:
2013         drm_atomic_state_clear(state);
2014         drm_atomic_legacy_backoff(state);
2015
2016         goto retry;
2017 }
2018 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2019
2020 /**
2021  * DOC: atomic state reset and initialization
2022  *
2023  * Both the drm core and the atomic helpers assume that there is always the full
2024  * and correct atomic software state for all connectors, CRTCs and planes
2025  * available. Which is a bit a problem on driver load and also after system
2026  * suspend. One way to solve this is to have a hardware state read-out
2027  * infrastructure which reconstructs the full software state (e.g. the i915
2028  * driver).
2029  *
2030  * The simpler solution is to just reset the software state to everything off,
2031  * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2032  * the atomic helpers provide default reset implementations for all hooks.
2033  */
2034
2035 /**
2036  * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2037  * @crtc: drm CRTC
2038  *
2039  * Resets the atomic state for @crtc by freeing the state pointer (which might
2040  * be NULL, e.g. at driver load time) and allocating a new empty state object.
2041  */
2042 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2043 {
2044         kfree(crtc->state);
2045         crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2046
2047         if (crtc->state)
2048                 crtc->state->crtc = crtc;
2049 }
2050 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2051
2052 /**
2053  * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2054  * @crtc: drm CRTC
2055  *
2056  * Default CRTC state duplicate hook for drivers which don't have their own
2057  * subclassed CRTC state structure.
2058  */
2059 struct drm_crtc_state *
2060 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2061 {
2062         struct drm_crtc_state *state;
2063
2064         if (WARN_ON(!crtc->state))
2065                 return NULL;
2066
2067         state = kmemdup(crtc->state, sizeof(*crtc->state), GFP_KERNEL);
2068
2069         if (state) {
2070                 state->mode_changed = false;
2071                 state->active_changed = false;
2072                 state->planes_changed = false;
2073                 state->event = NULL;
2074         }
2075
2076         return state;
2077 }
2078 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2079
2080 /**
2081  * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2082  * @crtc: drm CRTC
2083  * @state: CRTC state object to release
2084  *
2085  * Default CRTC state destroy hook for drivers which don't have their own
2086  * subclassed CRTC state structure.
2087  */
2088 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2089                                           struct drm_crtc_state *state)
2090 {
2091         kfree(state);
2092 }
2093 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2094
2095 /**
2096  * drm_atomic_helper_plane_reset - default ->reset hook for planes
2097  * @plane: drm plane
2098  *
2099  * Resets the atomic state for @plane by freeing the state pointer (which might
2100  * be NULL, e.g. at driver load time) and allocating a new empty state object.
2101  */
2102 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2103 {
2104         if (plane->state && plane->state->fb)
2105                 drm_framebuffer_unreference(plane->state->fb);
2106
2107         kfree(plane->state);
2108         plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2109
2110         if (plane->state)
2111                 plane->state->plane = plane;
2112 }
2113 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2114
2115 /**
2116  * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2117  * @plane: drm plane
2118  *
2119  * Default plane state duplicate hook for drivers which don't have their own
2120  * subclassed plane state structure.
2121  */
2122 struct drm_plane_state *
2123 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2124 {
2125         struct drm_plane_state *state;
2126
2127         if (WARN_ON(!plane->state))
2128                 return NULL;
2129
2130         state = kmemdup(plane->state, sizeof(*plane->state), GFP_KERNEL);
2131
2132         if (state && state->fb)
2133                 drm_framebuffer_reference(state->fb);
2134
2135         return state;
2136 }
2137 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2138
2139 /**
2140  * drm_atomic_helper_plane_destroy_state - default state destroy hook
2141  * @plane: drm plane
2142  * @state: plane state object to release
2143  *
2144  * Default plane state destroy hook for drivers which don't have their own
2145  * subclassed plane state structure.
2146  */
2147 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2148                                            struct drm_plane_state *state)
2149 {
2150         if (state->fb)
2151                 drm_framebuffer_unreference(state->fb);
2152
2153         kfree(state);
2154 }
2155 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2156
2157 /**
2158  * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2159  * @connector: drm connector
2160  *
2161  * Resets the atomic state for @connector by freeing the state pointer (which
2162  * might be NULL, e.g. at driver load time) and allocating a new empty state
2163  * object.
2164  */
2165 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2166 {
2167         kfree(connector->state);
2168         connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
2169
2170         if (connector->state)
2171                 connector->state->connector = connector;
2172 }
2173 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2174
2175 /**
2176  * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2177  * @connector: drm connector
2178  *
2179  * Default connector state duplicate hook for drivers which don't have their own
2180  * subclassed connector state structure.
2181  */
2182 struct drm_connector_state *
2183 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2184 {
2185         if (WARN_ON(!connector->state))
2186                 return NULL;
2187
2188         return kmemdup(connector->state, sizeof(*connector->state), GFP_KERNEL);
2189 }
2190 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2191
2192 /**
2193  * drm_atomic_helper_connector_destroy_state - default state destroy hook
2194  * @connector: drm connector
2195  * @state: connector state object to release
2196  *
2197  * Default connector state destroy hook for drivers which don't have their own
2198  * subclassed connector state structure.
2199  */
2200 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2201                                           struct drm_connector_state *state)
2202 {
2203         kfree(state);
2204 }
2205 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);