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_ATOMIC("[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_ATOMIC("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_ATOMIC("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_ATOMIC("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_ATOMIC("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_ATOMIC("[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_ATOMIC("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_ATOMIC("[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_ATOMIC("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_ATOMIC("[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_ATOMIC("[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_ATOMIC("[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_ATOMIC("[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_ATOMIC("[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_ATOMIC("[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_ATOMIC("[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_ATOMIC("[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_ATOMIC("[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_ATOMIC("[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_ATOMIC("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_ATOMIC("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 && funcs->mode_set_nofb) {
 727                         DRM_DEBUG_ATOMIC("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_ATOMIC("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                 if (funcs->mode_set)
 763                         funcs->mode_set(encoder, mode, adjusted_mode);
 764
 765                 if (encoder->bridge && encoder->bridge->funcs->mode_set)
 766                         encoder->bridge->funcs->mode_set(encoder->bridge,
 767                                                          mode, adjusted_mode);
 768         }
 769 }
 770
 771 /**
 772  * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
 773  * @dev: DRM device
 774  * @old_state: atomic state object with old state structures
 775  *
 776  * This function shuts down all the outputs that need to be shut down and
 777  * prepares them (if required) with the new mode.
 778  *
 779  * For compatability with legacy crtc helpers this should be called before
 780  * drm_atomic_helper_commit_planes(), which is what the default commit function
 781  * does. But drivers with different needs can group the modeset commits together
 782  * and do the plane commits at the end. This is useful for drivers doing runtime
 783  * PM since planes updates then only happen when the CRTC is actually enabled.
 784  */
 785 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
 786                                                struct drm_atomic_state *old_state)
 787 {
 788         disable_outputs(dev, old_state);
 789         set_routing_links(dev, old_state);
 790         crtc_set_mode(dev, old_state);
 791 }
 792 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
 793
 794 /**
 795  * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
 796  * @dev: DRM device
 797  * @old_state: atomic state object with old state structures
 798  *
 799  * This function enables all the outputs with the new configuration which had to
 800  * be turned off for the update.
 801  *
 802  * For compatability with legacy crtc helpers this should be called after
 803  * drm_atomic_helper_commit_planes(), which is what the default commit function
 804  * does. But drivers with different needs can group the modeset commits together
 805  * and do the plane commits at the end. This is useful for drivers doing runtime
 806  * PM since planes updates then only happen when the CRTC is actually enabled.
 807  */
 808 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
 809                                               struct drm_atomic_state *old_state)
 810 {
 811         int ncrtcs = old_state->dev->mode_config.num_crtc;
 812         int i;
 813
 814         for (i = 0; i < ncrtcs; i++) {
 815                 struct drm_crtc_helper_funcs *funcs;
 816                 struct drm_crtc *crtc;
 817
 818                 crtc = old_state->crtcs[i];
 819
 820                 /* Need to filter out CRTCs where only planes change. */
 821                 if (!crtc || !needs_modeset(crtc->state))
 822                         continue;
 823
 824                 if (!crtc->state->active)
 825                         continue;
 826
 827                 funcs = crtc->helper_private;
 828
 829                 if (crtc->state->enable) {
 830                         DRM_DEBUG_ATOMIC("enabling [CRTC:%d]\n",
 831                                          crtc->base.id);
 832
 833                         if (funcs->enable)
 834                                 funcs->enable(crtc);
 835                         else
 836                                 funcs->commit(crtc);
 837                 }
 838         }
 839
 840         for (i = 0; i < old_state->num_connector; i++) {
 841                 struct drm_connector *connector;
 842                 struct drm_encoder_helper_funcs *funcs;
 843                 struct drm_encoder *encoder;
 844
 845                 connector = old_state->connectors[i];
 846
 847                 if (!connector || !connector->state->best_encoder)
 848                         continue;
 849
 850                 if (!connector->state->crtc->state->active)
 851                         continue;
 852
 853                 encoder = connector->state->best_encoder;
 854                 funcs = encoder->helper_private;
 855
 856                 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
 857                                  encoder->base.id, encoder->name);
 858
 859                 /*
 860                  * Each encoder has at most one connector (since we always steal
 861                  * it away), so we won't call call enable hooks twice.
 862                  */
 863                 if (encoder->bridge)
 864                         encoder->bridge->funcs->pre_enable(encoder->bridge);
 865
 866                 if (funcs->enable)
 867                         funcs->enable(encoder);
 868                 else
 869                         funcs->commit(encoder);
 870
 871                 if (encoder->bridge)
 872                         encoder->bridge->funcs->enable(encoder->bridge);
 873         }
 874 }
 875 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
 876
 877 static void wait_for_fences(struct drm_device *dev,
 878                             struct drm_atomic_state *state)
 879 {
 880         int nplanes = dev->mode_config.num_total_plane;
 881         int i;
 882
 883         for (i = 0; i < nplanes; i++) {
 884                 struct drm_plane *plane = state->planes[i];
 885
 886                 if (!plane || !plane->state->fence)
 887                         continue;
 888
 889                 WARN_ON(!plane->state->fb);
 890
 891                 fence_wait(plane->state->fence, false);
 892                 fence_put(plane->state->fence);
 893                 plane->state->fence = NULL;
 894         }
 895 }
 896
 897 static bool framebuffer_changed(struct drm_device *dev,
 898                                 struct drm_atomic_state *old_state,
 899                                 struct drm_crtc *crtc)
 900 {
 901         struct drm_plane *plane;
 902         struct drm_plane_state *old_plane_state;
 903         int nplanes = old_state->dev->mode_config.num_total_plane;
 904         int i;
 905
 906         for (i = 0; i < nplanes; i++) {
 907                 plane = old_state->planes[i];
 908                 old_plane_state = old_state->plane_states[i];
 909
 910                 if (!plane)
 911                         continue;
 912
 913                 if (plane->state->crtc != crtc &&
 914                     old_plane_state->crtc != crtc)
 915                         continue;
 916
 917                 if (plane->state->fb != old_plane_state->fb)
 918                         return true;
 919         }
 920
 921         return false;
 922 }
 923
 924 /**
 925  * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
 926  * @dev: DRM device
 927  * @old_state: atomic state object with old state structures
 928  *
 929  * Helper to, after atomic commit, wait for vblanks on all effected
 930  * crtcs (ie. before cleaning up old framebuffers using
 931  * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
 932  * framebuffers have actually changed to optimize for the legacy cursor and
 933  * plane update use-case.
 934  */
 935 void
 936 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
 937                 struct drm_atomic_state *old_state)
 938 {
 939         struct drm_crtc *crtc;
 940         struct drm_crtc_state *old_crtc_state;
 941         int ncrtcs = old_state->dev->mode_config.num_crtc;
 942         int i, ret;
 943
 944         for (i = 0; i < ncrtcs; i++) {
 945                 crtc = old_state->crtcs[i];
 946                 old_crtc_state = old_state->crtc_states[i];
 947
 948                 if (!crtc)
 949                         continue;
 950
 951                 /* No one cares about the old state, so abuse it for tracking
 952                  * and store whether we hold a vblank reference (and should do a
 953                  * vblank wait) in the ->enable boolean. */
 954                 old_crtc_state->enable = false;
 955
 956                 if (!crtc->state->enable)
 957                         continue;
 958
 959                 /* Legacy cursor ioctls are completely unsynced, and userspace
 960                  * relies on that (by doing tons of cursor updates). */
 961                 if (old_state->legacy_cursor_update)
 962                         continue;
 963
 964                 if (!framebuffer_changed(dev, old_state, crtc))
 965                         continue;
 966
 967                 ret = drm_crtc_vblank_get(crtc);
 968                 if (ret != 0)
 969                         continue;
 970
 971                 old_crtc_state->enable = true;
 972                 old_crtc_state->last_vblank_count = drm_vblank_count(dev, i);
 973         }
 974
 975         for (i = 0; i < ncrtcs; i++) {
 976                 crtc = old_state->crtcs[i];
 977                 old_crtc_state = old_state->crtc_states[i];
 978
 979                 if (!crtc || !old_crtc_state->enable)
 980                         continue;
 981
 982                 ret = wait_event_timeout(dev->vblank[i].queue,
 983                                 old_crtc_state->last_vblank_count !=
 984                                         drm_vblank_count(dev, i),
 985                                 msecs_to_jiffies(50));
 986
 987                 drm_crtc_vblank_put(crtc);
 988         }
 989 }
 990 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
 991
 992 /**
 993  * drm_atomic_helper_commit - commit validated state object
 994  * @dev: DRM device
 995  * @state: the driver state object
 996  * @async: asynchronous commit
 997  *
 998  * This function commits a with drm_atomic_helper_check() pre-validated state
 999  * object. This can still fail when e.g. the framebuffer reservation fails. For
1000  * now this doesn't implement asynchronous commits.
1001  *
1002  * RETURNS
1003  * Zero for success or -errno.
1004  */
1005 int drm_atomic_helper_commit(struct drm_device *dev,
1006                              struct drm_atomic_state *state,
1007                              bool async)
1008 {
1009         int ret;
1010
1011         if (async)
1012                 return -EBUSY;
1013
1014         ret = drm_atomic_helper_prepare_planes(dev, state);
1015         if (ret)
1016                 return ret;
1017
1018         /*
1019          * This is the point of no return - everything below never fails except
1020          * when the hw goes bonghits. Which means we can commit the new state on
1021          * the software side now.
1022          */
1023
1024         drm_atomic_helper_swap_state(dev, state);
1025
1026         /*
1027          * Everything below can be run asynchronously without the need to grab
1028          * any modeset locks at all under one conditions: It must be guaranteed
1029          * that the asynchronous work has either been cancelled (if the driver
1030          * supports it, which at least requires that the framebuffers get
1031          * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1032          * before the new state gets committed on the software side with
1033          * drm_atomic_helper_swap_state().
1034          *
1035          * This scheme allows new atomic state updates to be prepared and
1036          * checked in parallel to the asynchronous completion of the previous
1037          * update. Which is important since compositors need to figure out the
1038          * composition of the next frame right after having submitted the
1039          * current layout.
1040          */
1041
1042         wait_for_fences(dev, state);
1043
1044         drm_atomic_helper_commit_modeset_disables(dev, state);
1045
1046         drm_atomic_helper_commit_planes(dev, state);
1047
1048         drm_atomic_helper_commit_modeset_enables(dev, state);
1049
1050         drm_atomic_helper_wait_for_vblanks(dev, state);
1051
1052         drm_atomic_helper_cleanup_planes(dev, state);
1053
1054         drm_atomic_state_free(state);
1055
1056         return 0;
1057 }
1058 EXPORT_SYMBOL(drm_atomic_helper_commit);
1059
1060 /**
1061  * DOC: implementing async commit
1062  *
1063  * For now the atomic helpers don't support async commit directly. If there is
1064  * real need it could be added though, using the dma-buf fence infrastructure
1065  * for generic synchronization with outstanding rendering.
1066  *
1067  * For now drivers have to implement async commit themselves, with the following
1068  * sequence being the recommended one:
1069  *
1070  * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1071  * which commit needs to call which can fail, so we want to run it first and
1072  * synchronously.
1073  *
1074  * 2. Synchronize with any outstanding asynchronous commit worker threads which
1075  * might be affected the new state update. This can be done by either cancelling
1076  * or flushing the work items, depending upon whether the driver can deal with
1077  * cancelled updates. Note that it is important to ensure that the framebuffer
1078  * cleanup is still done when cancelling.
1079  *
1080  * For sufficient parallelism it is recommended to have a work item per crtc
1081  * (for updates which don't touch global state) and a global one. Then we only
1082  * need to synchronize with the crtc work items for changed crtcs and the global
1083  * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1084  *
1085  * 3. The software state is updated synchronously with
1086  * drm_atomic_helper_swap_state. Doing this under the protection of all modeset
1087  * locks means concurrent callers never see inconsistent state. And doing this
1088  * while it's guaranteed that no relevant async worker runs means that async
1089  * workers do not need grab any locks. Actually they must not grab locks, for
1090  * otherwise the work flushing will deadlock.
1091  *
1092  * 4. Schedule a work item to do all subsequent steps, using the split-out
1093  * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1094  * then cleaning up the framebuffers after the old framebuffer is no longer
1095  * being displayed.
1096  */
1097
1098 /**
1099  * drm_atomic_helper_prepare_planes - prepare plane resources after commit
1100  * @dev: DRM device
1101  * @state: atomic state object with old state structures
1102  *
1103  * This function prepares plane state, specifically framebuffers, for the new
1104  * configuration. If any failure is encountered this function will call
1105  * ->cleanup_fb on any already successfully prepared framebuffer.
1106  *
1107  * Returns:
1108  * 0 on success, negative error code on failure.
1109  */
1110 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1111                                      struct drm_atomic_state *state)
1112 {
1113         int nplanes = dev->mode_config.num_total_plane;
1114         int ret, i;
1115
1116         for (i = 0; i < nplanes; i++) {
1117                 struct drm_plane_helper_funcs *funcs;
1118                 struct drm_plane *plane = state->planes[i];
1119                 struct drm_framebuffer *fb;
1120
1121                 if (!plane)
1122                         continue;
1123
1124                 funcs = plane->helper_private;
1125
1126                 fb = state->plane_states[i]->fb;
1127
1128                 if (fb && funcs->prepare_fb) {
1129                         ret = funcs->prepare_fb(plane, fb);
1130                         if (ret)
1131                                 goto fail;
1132                 }
1133         }
1134
1135         return 0;
1136
1137 fail:
1138         for (i--; i >= 0; i--) {
1139                 struct drm_plane_helper_funcs *funcs;
1140                 struct drm_plane *plane = state->planes[i];
1141                 struct drm_framebuffer *fb;
1142
1143                 if (!plane)
1144                         continue;
1145
1146                 funcs = plane->helper_private;
1147
1148                 fb = state->plane_states[i]->fb;
1149
1150                 if (fb && funcs->cleanup_fb)
1151                         funcs->cleanup_fb(plane, fb);
1152
1153         }
1154
1155         return ret;
1156 }
1157 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1158
1159 /**
1160  * drm_atomic_helper_commit_planes - commit plane state
1161  * @dev: DRM device
1162  * @old_state: atomic state object with old state structures
1163  *
1164  * This function commits the new plane state using the plane and atomic helper
1165  * functions for planes and crtcs. It assumes that the atomic state has already
1166  * been pushed into the relevant object state pointers, since this step can no
1167  * longer fail.
1168  *
1169  * It still requires the global state object @old_state to know which planes and
1170  * crtcs need to be updated though.
1171  */
1172 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1173                                      struct drm_atomic_state *old_state)
1174 {
1175         int nplanes = dev->mode_config.num_total_plane;
1176         int ncrtcs = dev->mode_config.num_crtc;
1177         int i;
1178
1179         for (i = 0; i < ncrtcs; i++) {
1180                 struct drm_crtc_helper_funcs *funcs;
1181                 struct drm_crtc *crtc = old_state->crtcs[i];
1182
1183                 if (!crtc)
1184                         continue;
1185
1186                 funcs = crtc->helper_private;
1187
1188                 if (!funcs || !funcs->atomic_begin)
1189                         continue;
1190
1191                 funcs->atomic_begin(crtc);
1192         }
1193
1194         for (i = 0; i < nplanes; i++) {
1195                 struct drm_plane_helper_funcs *funcs;
1196                 struct drm_plane *plane = old_state->planes[i];
1197                 struct drm_plane_state *old_plane_state;
1198
1199                 if (!plane)
1200                         continue;
1201
1202                 funcs = plane->helper_private;
1203
1204                 if (!funcs)
1205                         continue;
1206
1207                 old_plane_state = old_state->plane_states[i];
1208
1209                 /*
1210                  * Special-case disabling the plane if drivers support it.
1211                  */
1212                 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1213                     funcs->atomic_disable)
1214                         funcs->atomic_disable(plane, old_plane_state);
1215                 else
1216                         funcs->atomic_update(plane, old_plane_state);
1217         }
1218
1219         for (i = 0; i < ncrtcs; i++) {
1220                 struct drm_crtc_helper_funcs *funcs;
1221                 struct drm_crtc *crtc = old_state->crtcs[i];
1222
1223                 if (!crtc)
1224                         continue;
1225
1226                 funcs = crtc->helper_private;
1227
1228                 if (!funcs || !funcs->atomic_flush)
1229                         continue;
1230
1231                 funcs->atomic_flush(crtc);
1232         }
1233 }
1234 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1235
1236 /**
1237  * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1238  * @dev: DRM device
1239  * @old_state: atomic state object with old state structures
1240  *
1241  * This function cleans up plane state, specifically framebuffers, from the old
1242  * configuration. Hence the old configuration must be perserved in @old_state to
1243  * be able to call this function.
1244  *
1245  * This function must also be called on the new state when the atomic update
1246  * fails at any point after calling drm_atomic_helper_prepare_planes().
1247  */
1248 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1249                                       struct drm_atomic_state *old_state)
1250 {
1251         int nplanes = dev->mode_config.num_total_plane;
1252         int i;
1253
1254         for (i = 0; i < nplanes; i++) {
1255                 struct drm_plane_helper_funcs *funcs;
1256                 struct drm_plane *plane = old_state->planes[i];
1257                 struct drm_framebuffer *old_fb;
1258
1259                 if (!plane)
1260                         continue;
1261
1262                 funcs = plane->helper_private;
1263
1264                 old_fb = old_state->plane_states[i]->fb;
1265
1266                 if (old_fb && funcs->cleanup_fb)
1267                         funcs->cleanup_fb(plane, old_fb);
1268         }
1269 }
1270 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1271
1272 /**
1273  * drm_atomic_helper_swap_state - store atomic state into current sw state
1274  * @dev: DRM device
1275  * @state: atomic state
1276  *
1277  * This function stores the atomic state into the current state pointers in all
1278  * driver objects. It should be called after all failing steps have been done
1279  * and succeeded, but before the actual hardware state is committed.
1280  *
1281  * For cleanup and error recovery the current state for all changed objects will
1282  * be swaped into @state.
1283  *
1284  * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1285  *
1286  * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1287  *
1288  * 2. Do any other steps that might fail.
1289  *
1290  * 3. Put the staged state into the current state pointers with this function.
1291  *
1292  * 4. Actually commit the hardware state.
1293  *
1294  * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3
1295  * contains the old state. Also do any other cleanup required with that state.
1296  */
1297 void drm_atomic_helper_swap_state(struct drm_device *dev,
1298                                   struct drm_atomic_state *state)
1299 {
1300         int i;
1301
1302         for (i = 0; i < dev->mode_config.num_connector; i++) {
1303                 struct drm_connector *connector = state->connectors[i];
1304
1305                 if (!connector)
1306                         continue;
1307
1308                 connector->state->state = state;
1309                 swap(state->connector_states[i], connector->state);
1310                 connector->state->state = NULL;
1311         }
1312
1313         for (i = 0; i < dev->mode_config.num_crtc; i++) {
1314                 struct drm_crtc *crtc = state->crtcs[i];
1315
1316                 if (!crtc)
1317                         continue;
1318
1319                 crtc->state->state = state;
1320                 swap(state->crtc_states[i], crtc->state);
1321                 crtc->state->state = NULL;
1322         }
1323
1324         for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1325                 struct drm_plane *plane = state->planes[i];
1326
1327                 if (!plane)
1328                         continue;
1329
1330                 plane->state->state = state;
1331                 swap(state->plane_states[i], plane->state);
1332                 plane->state->state = NULL;
1333         }
1334 }
1335 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1336
1337 /**
1338  * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1339  * @plane: plane object to update
1340  * @crtc: owning CRTC of owning plane
1341  * @fb: framebuffer to flip onto plane
1342  * @crtc_x: x offset of primary plane on crtc
1343  * @crtc_y: y offset of primary plane on crtc
1344  * @crtc_w: width of primary plane rectangle on crtc
1345  * @crtc_h: height of primary plane rectangle on crtc
1346  * @src_x: x offset of @fb for panning
1347  * @src_y: y offset of @fb for panning
1348  * @src_w: width of source rectangle in @fb
1349  * @src_h: height of source rectangle in @fb
1350  *
1351  * Provides a default plane update handler using the atomic driver interface.
1352  *
1353  * RETURNS:
1354  * Zero on success, error code on failure
1355  */
1356 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1357                                    struct drm_crtc *crtc,
1358                                    struct drm_framebuffer *fb,
1359                                    int crtc_x, int crtc_y,
1360                                    unsigned int crtc_w, unsigned int crtc_h,
1361                                    uint32_t src_x, uint32_t src_y,
1362                                    uint32_t src_w, uint32_t src_h)
1363 {
1364         struct drm_atomic_state *state;
1365         struct drm_plane_state *plane_state;
1366         int ret = 0;
1367
1368         state = drm_atomic_state_alloc(plane->dev);
1369         if (!state)
1370                 return -ENOMEM;
1371
1372         state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1373 retry:
1374         plane_state = drm_atomic_get_plane_state(state, plane);
1375         if (IS_ERR(plane_state)) {
1376                 ret = PTR_ERR(plane_state);
1377                 goto fail;
1378         }
1379
1380         ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1381         if (ret != 0)
1382                 goto fail;
1383         drm_atomic_set_fb_for_plane(plane_state, fb);
1384         plane_state->crtc_x = crtc_x;
1385         plane_state->crtc_y = crtc_y;
1386         plane_state->crtc_h = crtc_h;
1387         plane_state->crtc_w = crtc_w;
1388         plane_state->src_x = src_x;
1389         plane_state->src_y = src_y;
1390         plane_state->src_h = src_h;
1391         plane_state->src_w = src_w;
1392
1393         ret = drm_atomic_commit(state);
1394         if (ret != 0)
1395                 goto fail;
1396
1397         if (plane == crtc->cursor)
1398                 state->legacy_cursor_update = true;
1399
1400         /* Driver takes ownership of state on successful commit. */
1401         return 0;
1402 fail:
1403         if (ret == -EDEADLK)
1404                 goto backoff;
1405
1406         drm_atomic_state_free(state);
1407
1408         return ret;
1409 backoff:
1410         drm_atomic_state_clear(state);
1411         drm_atomic_legacy_backoff(state);
1412
1413         /*
1414          * Someone might have exchanged the framebuffer while we dropped locks
1415          * in the backoff code. We need to fix up the fb refcount tracking the
1416          * core does for us.
1417          */
1418         plane->old_fb = plane->fb;
1419
1420         goto retry;
1421 }
1422 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1423
1424 /**
1425  * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1426  * @plane: plane to disable
1427  *
1428  * Provides a default plane disable handler using the atomic driver interface.
1429  *
1430  * RETURNS:
1431  * Zero on success, error code on failure
1432  */
1433 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1434 {
1435         struct drm_atomic_state *state;
1436         struct drm_plane_state *plane_state;
1437         int ret = 0;
1438
1439         /*
1440          * FIXME: Without plane->crtc set we can't get at the implicit legacy
1441          * acquire context. The real fix will be to wire the acquire ctx through
1442          * everywhere we need it, but meanwhile prevent chaos by just skipping
1443          * this noop. The critical case is the cursor ioctls which a) only grab
1444          * crtc/cursor-plane locks (so we need the crtc to get at the right
1445          * acquire context) and b) can try to disable the plane multiple times.
1446          */
1447         if (!plane->crtc)
1448                 return 0;
1449
1450         state = drm_atomic_state_alloc(plane->dev);
1451         if (!state)
1452                 return -ENOMEM;
1453
1454         state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1455 retry:
1456         plane_state = drm_atomic_get_plane_state(state, plane);
1457         if (IS_ERR(plane_state)) {
1458                 ret = PTR_ERR(plane_state);
1459                 goto fail;
1460         }
1461
1462         ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1463         if (ret != 0)
1464                 goto fail;
1465         drm_atomic_set_fb_for_plane(plane_state, NULL);
1466         plane_state->crtc_x = 0;
1467         plane_state->crtc_y = 0;
1468         plane_state->crtc_h = 0;
1469         plane_state->crtc_w = 0;
1470         plane_state->src_x = 0;
1471         plane_state->src_y = 0;
1472         plane_state->src_h = 0;
1473         plane_state->src_w = 0;
1474
1475         if (plane == plane->crtc->cursor)
1476                 state->legacy_cursor_update = true;
1477
1478         ret = drm_atomic_commit(state);
1479         if (ret != 0)
1480                 goto fail;
1481
1482         /* Driver takes ownership of state on successful commit. */
1483         return 0;
1484 fail:
1485         if (ret == -EDEADLK)
1486                 goto backoff;
1487
1488         drm_atomic_state_free(state);
1489
1490         return ret;
1491 backoff:
1492         drm_atomic_state_clear(state);
1493         drm_atomic_legacy_backoff(state);
1494
1495         /*
1496          * Someone might have exchanged the framebuffer while we dropped locks
1497          * in the backoff code. We need to fix up the fb refcount tracking the
1498          * core does for us.
1499          */
1500         plane->old_fb = plane->fb;
1501
1502         goto retry;
1503 }
1504 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1505
1506 static int update_output_state(struct drm_atomic_state *state,
1507                                struct drm_mode_set *set)
1508 {
1509         struct drm_device *dev = set->crtc->dev;
1510         struct drm_connector_state *conn_state;
1511         int ncrtcs = state->dev->mode_config.num_crtc;
1512         int ret, i, j;
1513
1514         ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1515                                state->acquire_ctx);
1516         if (ret)
1517                 return ret;
1518
1519         /* First grab all affected connector/crtc states. */
1520         for (i = 0; i < set->num_connectors; i++) {
1521                 conn_state = drm_atomic_get_connector_state(state,
1522                                                             set->connectors[i]);
1523                 if (IS_ERR(conn_state))
1524                         return PTR_ERR(conn_state);
1525         }
1526
1527         for (i = 0; i < ncrtcs; i++) {
1528                 struct drm_crtc *crtc = state->crtcs[i];
1529
1530                 if (!crtc)
1531                         continue;
1532
1533                 ret = drm_atomic_add_affected_connectors(state, crtc);
1534                 if (ret)
1535                         return ret;
1536         }
1537
1538         /* Then recompute connector->crtc links and crtc enabling state. */
1539         for (i = 0; i < state->num_connector; i++) {
1540                 struct drm_connector *connector;
1541
1542                 connector = state->connectors[i];
1543                 conn_state = state->connector_states[i];
1544
1545                 if (!connector)
1546                         continue;
1547
1548                 if (conn_state->crtc == set->crtc) {
1549                         ret = drm_atomic_set_crtc_for_connector(conn_state,
1550                                                                 NULL);
1551                         if (ret)
1552                                 return ret;
1553                 }
1554
1555                 for (j = 0; j < set->num_connectors; j++) {
1556                         if (set->connectors[j] == connector) {
1557                                 ret = drm_atomic_set_crtc_for_connector(conn_state,
1558                                                                         set->crtc);
1559                                 if (ret)
1560                                         return ret;
1561                                 break;
1562                         }
1563                 }
1564         }
1565
1566         for (i = 0; i < ncrtcs; i++) {
1567                 struct drm_crtc *crtc = state->crtcs[i];
1568                 struct drm_crtc_state *crtc_state = state->crtc_states[i];
1569
1570                 if (!crtc)
1571                         continue;
1572
1573                 /* Don't update ->enable for the CRTC in the set_config request,
1574                  * since a mismatch would indicate a bug in the upper layers.
1575                  * The actual modeset code later on will catch any
1576                  * inconsistencies here. */
1577                 if (crtc == set->crtc)
1578                         continue;
1579
1580                 crtc_state->enable =
1581                         drm_atomic_connectors_for_crtc(state, crtc);
1582         }
1583
1584         return 0;
1585 }
1586
1587 /**
1588  * drm_atomic_helper_set_config - set a new config from userspace
1589  * @set: mode set configuration
1590  *
1591  * Provides a default crtc set_config handler using the atomic driver interface.
1592  *
1593  * Returns:
1594  * Returns 0 on success, negative errno numbers on failure.
1595  */
1596 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1597 {
1598         struct drm_atomic_state *state;
1599         struct drm_crtc *crtc = set->crtc;
1600         struct drm_crtc_state *crtc_state;
1601         struct drm_plane_state *primary_state;
1602         int ret = 0;
1603
1604         state = drm_atomic_state_alloc(crtc->dev);
1605         if (!state)
1606                 return -ENOMEM;
1607
1608         state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1609 retry:
1610         crtc_state = drm_atomic_get_crtc_state(state, crtc);
1611         if (IS_ERR(crtc_state)) {
1612                 ret = PTR_ERR(crtc_state);
1613                 goto fail;
1614         }
1615
1616         primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1617         if (IS_ERR(primary_state)) {
1618                 ret = PTR_ERR(primary_state);
1619                 goto fail;
1620         }
1621
1622         if (!set->mode) {
1623                 WARN_ON(set->fb);
1624                 WARN_ON(set->num_connectors);
1625
1626                 crtc_state->enable = false;
1627                 crtc_state->active = false;
1628
1629                 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1630                 if (ret != 0)
1631                         goto fail;
1632
1633                 drm_atomic_set_fb_for_plane(primary_state, NULL);
1634
1635                 goto commit;
1636         }
1637
1638         WARN_ON(!set->fb);
1639         WARN_ON(!set->num_connectors);
1640
1641         crtc_state->enable = true;
1642         crtc_state->active = true;
1643         drm_mode_copy(&crtc_state->mode, set->mode);
1644
1645         ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1646         if (ret != 0)
1647                 goto fail;
1648         drm_atomic_set_fb_for_plane(primary_state, set->fb);
1649         primary_state->crtc_x = 0;
1650         primary_state->crtc_y = 0;
1651         primary_state->crtc_h = set->mode->vdisplay;
1652         primary_state->crtc_w = set->mode->hdisplay;
1653         primary_state->src_x = set->x << 16;
1654         primary_state->src_y = set->y << 16;
1655         primary_state->src_h = set->mode->vdisplay << 16;
1656         primary_state->src_w = set->mode->hdisplay << 16;
1657
1658 commit:
1659         ret = update_output_state(state, set);
1660         if (ret)
1661                 goto fail;
1662
1663         ret = drm_atomic_commit(state);
1664         if (ret != 0)
1665                 goto fail;
1666
1667         /* Driver takes ownership of state on successful commit. */
1668         return 0;
1669 fail:
1670         if (ret == -EDEADLK)
1671                 goto backoff;
1672
1673         drm_atomic_state_free(state);
1674
1675         return ret;
1676 backoff:
1677         drm_atomic_state_clear(state);
1678         drm_atomic_legacy_backoff(state);
1679
1680         /*
1681          * Someone might have exchanged the framebuffer while we dropped locks
1682          * in the backoff code. We need to fix up the fb refcount tracking the
1683          * core does for us.
1684          */
1685         crtc->primary->old_fb = crtc->primary->fb;
1686
1687         goto retry;
1688 }
1689 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1690
1691 /**
1692  * drm_atomic_helper_crtc_set_property - helper for crtc properties
1693  * @crtc: DRM crtc
1694  * @property: DRM property
1695  * @val: value of property
1696  *
1697  * Provides a default crtc set_property handler using the atomic driver
1698  * interface.
1699  *
1700  * RETURNS:
1701  * Zero on success, error code on failure
1702  */
1703 int
1704 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
1705                                     struct drm_property *property,
1706                                     uint64_t val)
1707 {
1708         struct drm_atomic_state *state;
1709         struct drm_crtc_state *crtc_state;
1710         int ret = 0;
1711
1712         state = drm_atomic_state_alloc(crtc->dev);
1713         if (!state)
1714                 return -ENOMEM;
1715
1716         /* ->set_property is always called with all locks held. */
1717         state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
1718 retry:
1719         crtc_state = drm_atomic_get_crtc_state(state, crtc);
1720         if (IS_ERR(crtc_state)) {
1721                 ret = PTR_ERR(crtc_state);
1722                 goto fail;
1723         }
1724
1725         ret = drm_atomic_crtc_set_property(crtc, crtc_state,
1726                         property, val);
1727         if (ret)
1728                 goto fail;
1729
1730         ret = drm_atomic_commit(state);
1731         if (ret != 0)
1732                 goto fail;
1733
1734         /* Driver takes ownership of state on successful commit. */
1735         return 0;
1736 fail:
1737         if (ret == -EDEADLK)
1738                 goto backoff;
1739
1740         drm_atomic_state_free(state);
1741
1742         return ret;
1743 backoff:
1744         drm_atomic_state_clear(state);
1745         drm_atomic_legacy_backoff(state);
1746
1747         goto retry;
1748 }
1749 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
1750
1751 /**
1752  * drm_atomic_helper_plane_set_property - helper for plane properties
1753  * @plane: DRM plane
1754  * @property: DRM property
1755  * @val: value of property
1756  *
1757  * Provides a default plane set_property handler using the atomic driver
1758  * interface.
1759  *
1760  * RETURNS:
1761  * Zero on success, error code on failure
1762  */
1763 int
1764 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
1765                                     struct drm_property *property,
1766                                     uint64_t val)
1767 {
1768         struct drm_atomic_state *state;
1769         struct drm_plane_state *plane_state;
1770         int ret = 0;
1771
1772         state = drm_atomic_state_alloc(plane->dev);
1773         if (!state)
1774                 return -ENOMEM;
1775
1776         /* ->set_property is always called with all locks held. */
1777         state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
1778 retry:
1779         plane_state = drm_atomic_get_plane_state(state, plane);
1780         if (IS_ERR(plane_state)) {
1781                 ret = PTR_ERR(plane_state);
1782                 goto fail;
1783         }
1784
1785         ret = drm_atomic_plane_set_property(plane, plane_state,
1786                         property, val);
1787         if (ret)
1788                 goto fail;
1789
1790         ret = drm_atomic_commit(state);
1791         if (ret != 0)
1792                 goto fail;
1793
1794         /* Driver takes ownership of state on successful commit. */
1795         return 0;
1796 fail:
1797         if (ret == -EDEADLK)
1798                 goto backoff;
1799
1800         drm_atomic_state_free(state);
1801
1802         return ret;
1803 backoff:
1804         drm_atomic_state_clear(state);
1805         drm_atomic_legacy_backoff(state);
1806
1807         goto retry;
1808 }
1809 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
1810
1811 /**
1812  * drm_atomic_helper_connector_set_property - helper for connector properties
1813  * @connector: DRM connector
1814  * @property: DRM property
1815  * @val: value of property
1816  *
1817  * Provides a default connector set_property handler using the atomic driver
1818  * interface.
1819  *
1820  * RETURNS:
1821  * Zero on success, error code on failure
1822  */
1823 int
1824 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
1825                                     struct drm_property *property,
1826                                     uint64_t val)
1827 {
1828         struct drm_atomic_state *state;
1829         struct drm_connector_state *connector_state;
1830         int ret = 0;
1831
1832         state = drm_atomic_state_alloc(connector->dev);
1833         if (!state)
1834                 return -ENOMEM;
1835
1836         /* ->set_property is always called with all locks held. */
1837         state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
1838 retry:
1839         connector_state = drm_atomic_get_connector_state(state, connector);
1840         if (IS_ERR(connector_state)) {
1841                 ret = PTR_ERR(connector_state);
1842                 goto fail;
1843         }
1844
1845         ret = drm_atomic_connector_set_property(connector, connector_state,
1846                         property, val);
1847         if (ret)
1848                 goto fail;
1849
1850         ret = drm_atomic_commit(state);
1851         if (ret != 0)
1852                 goto fail;
1853
1854         /* Driver takes ownership of state on successful commit. */
1855         return 0;
1856 fail:
1857         if (ret == -EDEADLK)
1858                 goto backoff;
1859
1860         drm_atomic_state_free(state);
1861
1862         return ret;
1863 backoff:
1864         drm_atomic_state_clear(state);
1865         drm_atomic_legacy_backoff(state);
1866
1867         goto retry;
1868 }
1869 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
1870
1871 /**
1872  * drm_atomic_helper_page_flip - execute a legacy page flip
1873  * @crtc: DRM crtc
1874  * @fb: DRM framebuffer
1875  * @event: optional DRM event to signal upon completion
1876  * @flags: flip flags for non-vblank sync'ed updates
1877  *
1878  * Provides a default page flip implementation using the atomic driver interface.
1879  *
1880  * Note that for now so called async page flips (i.e. updates which are not
1881  * synchronized to vblank) are not supported, since the atomic interfaces have
1882  * no provisions for this yet.
1883  *
1884  * Returns:
1885  * Returns 0 on success, negative errno numbers on failure.
1886  */
1887 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
1888                                 struct drm_framebuffer *fb,
1889                                 struct drm_pending_vblank_event *event,
1890                                 uint32_t flags)
1891 {
1892         struct drm_plane *plane = crtc->primary;
1893         struct drm_atomic_state *state;
1894         struct drm_plane_state *plane_state;
1895         struct drm_crtc_state *crtc_state;
1896         int ret = 0;
1897
1898         if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
1899                 return -EINVAL;
1900
1901         state = drm_atomic_state_alloc(plane->dev);
1902         if (!state)
1903                 return -ENOMEM;
1904
1905         state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1906 retry:
1907         crtc_state = drm_atomic_get_crtc_state(state, crtc);
1908         if (IS_ERR(crtc_state)) {
1909                 ret = PTR_ERR(crtc_state);
1910                 goto fail;
1911         }
1912         crtc_state->event = event;
1913
1914         plane_state = drm_atomic_get_plane_state(state, plane);
1915         if (IS_ERR(plane_state)) {
1916                 ret = PTR_ERR(plane_state);
1917                 goto fail;
1918         }
1919
1920         ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1921         if (ret != 0)
1922                 goto fail;
1923         drm_atomic_set_fb_for_plane(plane_state, fb);
1924
1925         ret = drm_atomic_async_commit(state);
1926         if (ret != 0)
1927                 goto fail;
1928
1929         /* TODO: ->page_flip is the only driver callback where the core
1930          * doesn't update plane->fb. For now patch it up here. */
1931         plane->fb = plane->state->fb;
1932
1933         /* Driver takes ownership of state on successful async commit. */
1934         return 0;
1935 fail:
1936         if (ret == -EDEADLK)
1937                 goto backoff;
1938
1939         drm_atomic_state_free(state);
1940
1941         return ret;
1942 backoff:
1943         drm_atomic_state_clear(state);
1944         drm_atomic_legacy_backoff(state);
1945
1946         /*
1947          * Someone might have exchanged the framebuffer while we dropped locks
1948          * in the backoff code. We need to fix up the fb refcount tracking the
1949          * core does for us.
1950          */
1951         plane->old_fb = plane->fb;
1952
1953         goto retry;
1954 }
1955 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
1956
1957 /**
1958  * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
1959  * @connector: affected connector
1960  * @mode: DPMS mode
1961  *
1962  * This is the main helper function provided by the atomic helper framework for
1963  * implementing the legacy DPMS connector interface. It computes the new desired
1964  * ->active state for the corresponding CRTC (if the connector is enabled) and
1965  *  updates it.
1966  */
1967 void drm_atomic_helper_connector_dpms(struct drm_connector *connector,
1968                                       int mode)
1969 {
1970         struct drm_mode_config *config = &connector->dev->mode_config;
1971         struct drm_atomic_state *state;
1972         struct drm_crtc_state *crtc_state;
1973         struct drm_crtc *crtc;
1974         struct drm_connector *tmp_connector;
1975         int ret;
1976         bool active = false;
1977
1978         if (mode != DRM_MODE_DPMS_ON)
1979                 mode = DRM_MODE_DPMS_OFF;
1980
1981         connector->dpms = mode;
1982         crtc = connector->state->crtc;
1983
1984         if (!crtc)
1985                 return;
1986
1987         /* FIXME: ->dpms has no return value so can't forward the -ENOMEM. */
1988         state = drm_atomic_state_alloc(connector->dev);
1989         if (!state)
1990                 return;
1991
1992         state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1993 retry:
1994         crtc_state = drm_atomic_get_crtc_state(state, crtc);
1995         if (IS_ERR(crtc_state))
1996                 return;
1997
1998         WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
1999
2000         list_for_each_entry(tmp_connector, &config->connector_list, head) {
2001                 if (connector->state->crtc != crtc)
2002                         continue;
2003
2004                 if (connector->dpms == DRM_MODE_DPMS_ON) {
2005                         active = true;
2006                         break;
2007                 }
2008         }
2009         crtc_state->active = active;
2010
2011         ret = drm_atomic_commit(state);
2012         if (ret != 0)
2013                 goto fail;
2014
2015         /* Driver takes ownership of state on successful async commit. */
2016         return;
2017 fail:
2018         if (ret == -EDEADLK)
2019                 goto backoff;
2020
2021         drm_atomic_state_free(state);
2022
2023         WARN(1, "Driver bug: Changing ->active failed with ret=%i\n", ret);
2024
2025         return;
2026 backoff:
2027         drm_atomic_state_clear(state);
2028         drm_atomic_legacy_backoff(state);
2029
2030         goto retry;
2031 }
2032 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2033
2034 /**
2035  * DOC: atomic state reset and initialization
2036  *
2037  * Both the drm core and the atomic helpers assume that there is always the full
2038  * and correct atomic software state for all connectors, CRTCs and planes
2039  * available. Which is a bit a problem on driver load and also after system
2040  * suspend. One way to solve this is to have a hardware state read-out
2041  * infrastructure which reconstructs the full software state (e.g. the i915
2042  * driver).
2043  *
2044  * The simpler solution is to just reset the software state to everything off,
2045  * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2046  * the atomic helpers provide default reset implementations for all hooks.
2047  */
2048
2049 /**
2050  * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2051  * @crtc: drm CRTC
2052  *
2053  * Resets the atomic state for @crtc by freeing the state pointer (which might
2054  * be NULL, e.g. at driver load time) and allocating a new empty state object.
2055  */
2056 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2057 {
2058         kfree(crtc->state);
2059         crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2060
2061         if (crtc->state)
2062                 crtc->state->crtc = crtc;
2063 }
2064 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2065
2066 /**
2067  * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2068  * @crtc: drm CRTC
2069  *
2070  * Default CRTC state duplicate hook for drivers which don't have their own
2071  * subclassed CRTC state structure.
2072  */
2073 struct drm_crtc_state *
2074 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2075 {
2076         struct drm_crtc_state *state;
2077
2078         if (WARN_ON(!crtc->state))
2079                 return NULL;
2080
2081         state = kmemdup(crtc->state, sizeof(*crtc->state), GFP_KERNEL);
2082
2083         if (state) {
2084                 state->mode_changed = false;
2085                 state->active_changed = false;
2086                 state->planes_changed = false;
2087                 state->event = NULL;
2088         }
2089
2090         return state;
2091 }
2092 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2093
2094 /**
2095  * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2096  * @crtc: drm CRTC
2097  * @state: CRTC state object to release
2098  *
2099  * Default CRTC state destroy hook for drivers which don't have their own
2100  * subclassed CRTC state structure.
2101  */
2102 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2103                                           struct drm_crtc_state *state)
2104 {
2105         kfree(state);
2106 }
2107 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2108
2109 /**
2110  * drm_atomic_helper_plane_reset - default ->reset hook for planes
2111  * @plane: drm plane
2112  *
2113  * Resets the atomic state for @plane by freeing the state pointer (which might
2114  * be NULL, e.g. at driver load time) and allocating a new empty state object.
2115  */
2116 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2117 {
2118         if (plane->state && plane->state->fb)
2119                 drm_framebuffer_unreference(plane->state->fb);
2120
2121         kfree(plane->state);
2122         plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2123
2124         if (plane->state)
2125                 plane->state->plane = plane;
2126 }
2127 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2128
2129 /**
2130  * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2131  * @plane: drm plane
2132  *
2133  * Default plane state duplicate hook for drivers which don't have their own
2134  * subclassed plane state structure.
2135  */
2136 struct drm_plane_state *
2137 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2138 {
2139         struct drm_plane_state *state;
2140
2141         if (WARN_ON(!plane->state))
2142                 return NULL;
2143
2144         state = kmemdup(plane->state, sizeof(*plane->state), GFP_KERNEL);
2145
2146         if (state && state->fb)
2147                 drm_framebuffer_reference(state->fb);
2148
2149         return state;
2150 }
2151 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2152
2153 /**
2154  * drm_atomic_helper_plane_destroy_state - default state destroy hook
2155  * @plane: drm plane
2156  * @state: plane state object to release
2157  *
2158  * Default plane state destroy hook for drivers which don't have their own
2159  * subclassed plane state structure.
2160  */
2161 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2162                                            struct drm_plane_state *state)
2163 {
2164         if (state->fb)
2165                 drm_framebuffer_unreference(state->fb);
2166
2167         kfree(state);
2168 }
2169 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2170
2171 /**
2172  * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2173  * @connector: drm connector
2174  *
2175  * Resets the atomic state for @connector by freeing the state pointer (which
2176  * might be NULL, e.g. at driver load time) and allocating a new empty state
2177  * object.
2178  */
2179 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2180 {
2181         kfree(connector->state);
2182         connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
2183
2184         if (connector->state)
2185                 connector->state->connector = connector;
2186 }
2187 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2188
2189 /**
2190  * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2191  * @connector: drm connector
2192  *
2193  * Default connector state duplicate hook for drivers which don't have their own
2194  * subclassed connector state structure.
2195  */
2196 struct drm_connector_state *
2197 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2198 {
2199         if (WARN_ON(!connector->state))
2200                 return NULL;
2201
2202         return kmemdup(connector->state, sizeof(*connector->state), GFP_KERNEL);
2203 }
2204 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2205
2206 /**
2207  * drm_atomic_helper_connector_destroy_state - default state destroy hook
2208  * @connector: drm connector
2209  * @state: connector state object to release
2210  *
2211  * Default connector state destroy hook for drivers which don't have their own
2212  * subclassed connector state structure.
2213  */
2214 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2215                                           struct drm_connector_state *state)
2216 {
2217         kfree(state);
2218 }
2219 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);