drivers/gpu/drm/drm_plane_helper.c

   1 /*
   2  * Copyright (C) 2014 Intel Corporation
   3  *
   4  * DRM universal plane helper functions
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <linux/list.h>
  27 #include <drm/drmP.h>
  28 #include <drm/drm_plane_helper.h>
  29 #include <drm/drm_rect.h>
  30 #include <drm/drm_atomic.h>
  31 #include <drm/drm_crtc_helper.h>
  32 #include <drm/drm_atomic_helper.h>
  33
  34 #define SUBPIXEL_MASK 0xffff
  35
  36 /**
  37  * DOC: overview
  38  *
  39  * This helper library has two parts. The first part has support to implement
  40  * primary plane support on top of the normal CRTC configuration interface.
  41  * Since the legacy ->set_config interface ties the primary plane together with
  42  * the CRTC state this does not allow userspace to disable the primary plane
  43  * itself.  To avoid too much duplicated code use
  44  * drm_plane_helper_check_update() which can be used to enforce the same
  45  * restrictions as primary planes had thus. The default primary plane only
  46  * expose XRBG8888 and ARGB8888 as valid pixel formats for the attached
  47  * framebuffer.
  48  *
  49  * Drivers are highly recommended to implement proper support for primary
  50  * planes, and newly merged drivers must not rely upon these transitional
  51  * helpers.
  52  *
  53  * The second part also implements transitional helpers which allow drivers to
  54  * gradually switch to the atomic helper infrastructure for plane updates. Once
  55  * that switch is complete drivers shouldn't use these any longer, instead using
  56  * the proper legacy implementations for update and disable plane hooks provided
  57  * by the atomic helpers.
  58  *
  59  * Again drivers are strongly urged to switch to the new interfaces.
  60  *
  61  * The plane helpers share the function table structures with other helpers,
  62  * specifically also the atomic helpers. See struct &drm_plane_helper_funcs for
  63  * the details.
  64  */
  65
  66 /*
  67  * This is the minimal list of formats that seem to be safe for modeset use
  68  * with all current DRM drivers.  Most hardware can actually support more
  69  * formats than this and drivers may specify a more accurate list when
  70  * creating the primary plane.  However drivers that still call
  71  * drm_plane_init() will use this minimal format list as the default.
  72  */
  73 static const uint32_t safe_modeset_formats[] = {
  74         DRM_FORMAT_XRGB8888,
  75         DRM_FORMAT_ARGB8888,
  76 };
  77
  78 /*
  79  * Returns the connectors currently associated with a CRTC.  This function
  80  * should be called twice:  once with a NULL connector list to retrieve
  81  * the list size, and once with the properly allocated list to be filled in.
  82  */
  83 static int get_connectors_for_crtc(struct drm_crtc *crtc,
  84                                    struct drm_connector **connector_list,
  85                                    int num_connectors)
  86 {
  87         struct drm_device *dev = crtc->dev;
  88         struct drm_connector *connector;
  89         int count = 0;
  90
  91         /*
  92          * Note: Once we change the plane hooks to more fine-grained locking we
  93          * need to grab the connection_mutex here to be able to make these
  94          * checks.
  95          */
  96         WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
  97
  98         drm_for_each_connector(connector, dev) {
  99                 if (connector->encoder && connector->encoder->crtc == crtc) {
 100                         if (connector_list != NULL && count < num_connectors)
 101                                 *(connector_list++) = connector;
 102
 103                         count++;
 104                 }
 105         }
 106
 107         return count;
 108 }
 109
 110 /**
 111  * drm_plane_helper_check_state() - Check plane state for validity
 112  * @state: plane state to check
 113  * @clip: integer clipping coordinates
 114  * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
 115  * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
 116  * @can_position: is it legal to position the plane such that it
 117  *                doesn't cover the entire crtc?  This will generally
 118  *                only be false for primary planes.
 119  * @can_update_disabled: can the plane be updated while the crtc
 120  *                       is disabled?
 121  *
 122  * Checks that a desired plane update is valid, and updates various
 123  * bits of derived state (clipped coordinates etc.). Drivers that provide
 124  * their own plane handling rather than helper-provided implementations may
 125  * still wish to call this function to avoid duplication of error checking
 126  * code.
 127  *
 128  * RETURNS:
 129  * Zero if update appears valid, error code on failure
 130  */
 131 int drm_plane_helper_check_state(struct drm_plane_state *state,
 132                                  const struct drm_rect *clip,
 133                                  int min_scale,
 134                                  int max_scale,
 135                                  bool can_position,
 136                                  bool can_update_disabled)
 137 {
 138         struct drm_crtc *crtc = state->crtc;
 139         struct drm_framebuffer *fb = state->fb;
 140         struct drm_rect *src = &state->src;
 141         struct drm_rect *dst = &state->dst;
 142         unsigned int rotation = state->rotation;
 143         int hscale, vscale;
 144
 145         src->x1 = state->src_x;
 146         src->y1 = state->src_y;
 147         src->x2 = state->src_x + state->src_w;
 148         src->y2 = state->src_y + state->src_h;
 149
 150         dst->x1 = state->crtc_x;
 151         dst->y1 = state->crtc_y;
 152         dst->x2 = state->crtc_x + state->crtc_w;
 153         dst->y2 = state->crtc_y + state->crtc_h;
 154
 155         if (!fb) {
 156                 state->visible = false;
 157                 return 0;
 158         }
 159
 160         /* crtc should only be NULL when disabling (i.e., !fb) */
 161         if (WARN_ON(!crtc)) {
 162                 state->visible = false;
 163                 return 0;
 164         }
 165
 166         if (!crtc->enabled && !can_update_disabled) {
 167                 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
 168                 return -EINVAL;
 169         }
 170
 171         drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
 172
 173         /* Check scaling */
 174         hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale);
 175         vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale);
 176         if (hscale < 0 || vscale < 0) {
 177                 DRM_DEBUG_KMS("Invalid scaling of plane\n");
 178                 drm_rect_debug_print("src: ", &state->src, true);
 179                 drm_rect_debug_print("dst: ", &state->dst, false);
 180                 return -ERANGE;
 181         }
 182
 183         state->visible = drm_rect_clip_scaled(src, dst, clip, hscale, vscale);
 184
 185         drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
 186
 187         if (!state->visible)
 188                 /*
 189                  * Plane isn't visible; some drivers can handle this
 190                  * so we just return success here.  Drivers that can't
 191                  * (including those that use the primary plane helper's
 192                  * update function) will return an error from their
 193                  * update_plane handler.
 194                  */
 195                 return 0;
 196
 197         if (!can_position && !drm_rect_equals(dst, clip)) {
 198                 DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
 199                 drm_rect_debug_print("dst: ", dst, false);
 200                 drm_rect_debug_print("clip: ", clip, false);
 201                 return -EINVAL;
 202         }
 203
 204         return 0;
 205 }
 206 EXPORT_SYMBOL(drm_plane_helper_check_state);
 207
 208 /**
 209  * drm_plane_helper_check_update() - Check plane update for validity
 210  * @plane: plane object to update
 211  * @crtc: owning CRTC of owning plane
 212  * @fb: framebuffer to flip onto plane
 213  * @src: source coordinates in 16.16 fixed point
 214  * @dest: integer destination coordinates
 215  * @clip: integer clipping coordinates
 216  * @rotation: plane rotation
 217  * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
 218  * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
 219  * @can_position: is it legal to position the plane such that it
 220  *                doesn't cover the entire crtc?  This will generally
 221  *                only be false for primary planes.
 222  * @can_update_disabled: can the plane be updated while the crtc
 223  *                       is disabled?
 224  * @visible: output parameter indicating whether plane is still visible after
 225  *           clipping
 226  *
 227  * Checks that a desired plane update is valid.  Drivers that provide
 228  * their own plane handling rather than helper-provided implementations may
 229  * still wish to call this function to avoid duplication of error checking
 230  * code.
 231  *
 232  * RETURNS:
 233  * Zero if update appears valid, error code on failure
 234  */
 235 int drm_plane_helper_check_update(struct drm_plane *plane,
 236                                   struct drm_crtc *crtc,
 237                                   struct drm_framebuffer *fb,
 238                                   struct drm_rect *src,
 239                                   struct drm_rect *dst,
 240                                   const struct drm_rect *clip,
 241                                   unsigned int rotation,
 242                                   int min_scale,
 243                                   int max_scale,
 244                                   bool can_position,
 245                                   bool can_update_disabled,
 246                                   bool *visible)
 247 {
 248         struct drm_plane_state state = {
 249                 .plane = plane,
 250                 .crtc = crtc,
 251                 .fb = fb,
 252                 .src_x = src->x1,
 253                 .src_y = src->y1,
 254                 .src_w = drm_rect_width(src),
 255                 .src_h = drm_rect_height(src),
 256                 .crtc_x = dst->x1,
 257                 .crtc_y = dst->y1,
 258                 .crtc_w = drm_rect_width(dst),
 259                 .crtc_h = drm_rect_height(dst),
 260                 .rotation = rotation,
 261                 .visible = *visible,
 262         };
 263         int ret;
 264
 265         ret = drm_plane_helper_check_state(&state, clip,
 266                                            min_scale, max_scale,
 267                                            can_position,
 268                                            can_update_disabled);
 269         if (ret)
 270                 return ret;
 271
 272         *src = state.src;
 273         *dst = state.dst;
 274         *visible = state.visible;
 275
 276         return 0;
 277 }
 278 EXPORT_SYMBOL(drm_plane_helper_check_update);
 279
 280 /**
 281  * drm_primary_helper_update() - Helper for primary plane update
 282  * @plane: plane object to update
 283  * @crtc: owning CRTC of owning plane
 284  * @fb: framebuffer to flip onto plane
 285  * @crtc_x: x offset of primary plane on crtc
 286  * @crtc_y: y offset of primary plane on crtc
 287  * @crtc_w: width of primary plane rectangle on crtc
 288  * @crtc_h: height of primary plane rectangle on crtc
 289  * @src_x: x offset of @fb for panning
 290  * @src_y: y offset of @fb for panning
 291  * @src_w: width of source rectangle in @fb
 292  * @src_h: height of source rectangle in @fb
 293  *
 294  * Provides a default plane update handler for primary planes.  This is handler
 295  * is called in response to a userspace SetPlane operation on the plane with a
 296  * non-NULL framebuffer.  We call the driver's modeset handler to update the
 297  * framebuffer.
 298  *
 299  * SetPlane() on a primary plane of a disabled CRTC is not supported, and will
 300  * return an error.
 301  *
 302  * Note that we make some assumptions about hardware limitations that may not be
 303  * true for all hardware --
 304  *
 305  * 1. Primary plane cannot be repositioned.
 306  * 2. Primary plane cannot be scaled.
 307  * 3. Primary plane must cover the entire CRTC.
 308  * 4. Subpixel positioning is not supported.
 309  *
 310  * Drivers for hardware that don't have these restrictions can provide their
 311  * own implementation rather than using this helper.
 312  *
 313  * RETURNS:
 314  * Zero on success, error code on failure
 315  */
 316 int drm_primary_helper_update(struct drm_plane *plane, struct drm_crtc *crtc,
 317                               struct drm_framebuffer *fb,
 318                               int crtc_x, int crtc_y,
 319                               unsigned int crtc_w, unsigned int crtc_h,
 320                               uint32_t src_x, uint32_t src_y,
 321                               uint32_t src_w, uint32_t src_h)
 322 {
 323         struct drm_mode_set set = {
 324                 .crtc = crtc,
 325                 .fb = fb,
 326                 .mode = &crtc->mode,
 327                 .x = src_x >> 16,
 328                 .y = src_y >> 16,
 329         };
 330         struct drm_rect src = {
 331                 .x1 = src_x,
 332                 .y1 = src_y,
 333                 .x2 = src_x + src_w,
 334                 .y2 = src_y + src_h,
 335         };
 336         struct drm_rect dest = {
 337                 .x1 = crtc_x,
 338                 .y1 = crtc_y,
 339                 .x2 = crtc_x + crtc_w,
 340                 .y2 = crtc_y + crtc_h,
 341         };
 342         const struct drm_rect clip = {
 343                 .x2 = crtc->mode.hdisplay,
 344                 .y2 = crtc->mode.vdisplay,
 345         };
 346         struct drm_connector **connector_list;
 347         int num_connectors, ret;
 348         bool visible;
 349
 350         ret = drm_plane_helper_check_update(plane, crtc, fb,
 351                                             &src, &dest, &clip,
 352                                             DRM_ROTATE_0,
 353                                             DRM_PLANE_HELPER_NO_SCALING,
 354                                             DRM_PLANE_HELPER_NO_SCALING,
 355                                             false, false, &visible);
 356         if (ret)
 357                 return ret;
 358
 359         if (!visible)
 360                 /*
 361                  * Primary plane isn't visible.  Note that unless a driver
 362                  * provides their own disable function, this will just
 363                  * wind up returning -EINVAL to userspace.
 364                  */
 365                 return plane->funcs->disable_plane(plane);
 366
 367         /* Find current connectors for CRTC */
 368         num_connectors = get_connectors_for_crtc(crtc, NULL, 0);
 369         BUG_ON(num_connectors == 0);
 370         connector_list = kzalloc(num_connectors * sizeof(*connector_list),
 371                                  GFP_KERNEL);
 372         if (!connector_list)
 373                 return -ENOMEM;
 374         get_connectors_for_crtc(crtc, connector_list, num_connectors);
 375
 376         set.connectors = connector_list;
 377         set.num_connectors = num_connectors;
 378
 379         /*
 380          * We call set_config() directly here rather than using
 381          * drm_mode_set_config_internal.  We're reprogramming the same
 382          * connectors that were already in use, so we shouldn't need the extra
 383          * cross-CRTC fb refcounting to accomodate stealing connectors.
 384          * drm_mode_setplane() already handles the basic refcounting for the
 385          * framebuffers involved in this operation.
 386          */
 387         ret = crtc->funcs->set_config(&set);
 388
 389         kfree(connector_list);
 390         return ret;
 391 }
 392 EXPORT_SYMBOL(drm_primary_helper_update);
 393
 394 /**
 395  * drm_primary_helper_disable() - Helper for primary plane disable
 396  * @plane: plane to disable
 397  *
 398  * Provides a default plane disable handler for primary planes.  This is handler
 399  * is called in response to a userspace SetPlane operation on the plane with a
 400  * NULL framebuffer parameter.  It unconditionally fails the disable call with
 401  * -EINVAL the only way to disable the primary plane without driver support is
 402  * to disable the entier CRTC. Which does not match the plane ->disable hook.
 403  *
 404  * Note that some hardware may be able to disable the primary plane without
 405  * disabling the whole CRTC.  Drivers for such hardware should provide their
 406  * own disable handler that disables just the primary plane (and they'll likely
 407  * need to provide their own update handler as well to properly re-enable a
 408  * disabled primary plane).
 409  *
 410  * RETURNS:
 411  * Unconditionally returns -EINVAL.
 412  */
 413 int drm_primary_helper_disable(struct drm_plane *plane)
 414 {
 415         return -EINVAL;
 416 }
 417 EXPORT_SYMBOL(drm_primary_helper_disable);
 418
 419 /**
 420  * drm_primary_helper_destroy() - Helper for primary plane destruction
 421  * @plane: plane to destroy
 422  *
 423  * Provides a default plane destroy handler for primary planes.  This handler
 424  * is called during CRTC destruction.  We disable the primary plane, remove
 425  * it from the DRM plane list, and deallocate the plane structure.
 426  */
 427 void drm_primary_helper_destroy(struct drm_plane *plane)
 428 {
 429         drm_plane_cleanup(plane);
 430         kfree(plane);
 431 }
 432 EXPORT_SYMBOL(drm_primary_helper_destroy);
 433
 434 const struct drm_plane_funcs drm_primary_helper_funcs = {
 435         .update_plane = drm_primary_helper_update,
 436         .disable_plane = drm_primary_helper_disable,
 437         .destroy = drm_primary_helper_destroy,
 438 };
 439 EXPORT_SYMBOL(drm_primary_helper_funcs);
 440
 441 static struct drm_plane *create_primary_plane(struct drm_device *dev)
 442 {
 443         struct drm_plane *primary;
 444         int ret;
 445
 446         primary = kzalloc(sizeof(*primary), GFP_KERNEL);
 447         if (primary == NULL) {
 448                 DRM_DEBUG_KMS("Failed to allocate primary plane\n");
 449                 return NULL;
 450         }
 451
 452         /*
 453          * Remove the format_default field from drm_plane when dropping
 454          * this helper.
 455          */
 456         primary->format_default = true;
 457
 458         /* possible_crtc's will be filled in later by crtc_init */
 459         ret = drm_universal_plane_init(dev, primary, 0,
 460                                        &drm_primary_helper_funcs,
 461                                        safe_modeset_formats,
 462                                        ARRAY_SIZE(safe_modeset_formats),
 463                                        DRM_PLANE_TYPE_PRIMARY, NULL);
 464         if (ret) {
 465                 kfree(primary);
 466                 primary = NULL;
 467         }
 468
 469         return primary;
 470 }
 471
 472 /**
 473  * drm_crtc_init - Legacy CRTC initialization function
 474  * @dev: DRM device
 475  * @crtc: CRTC object to init
 476  * @funcs: callbacks for the new CRTC
 477  *
 478  * Initialize a CRTC object with a default helper-provided primary plane and no
 479  * cursor plane.
 480  *
 481  * Returns:
 482  * Zero on success, error code on failure.
 483  */
 484 int drm_crtc_init(struct drm_device *dev, struct drm_crtc *crtc,
 485                   const struct drm_crtc_funcs *funcs)
 486 {
 487         struct drm_plane *primary;
 488
 489         primary = create_primary_plane(dev);
 490         return drm_crtc_init_with_planes(dev, crtc, primary, NULL, funcs,
 491                                          NULL);
 492 }
 493 EXPORT_SYMBOL(drm_crtc_init);
 494
 495 int drm_plane_helper_commit(struct drm_plane *plane,
 496                             struct drm_plane_state *plane_state,
 497                             struct drm_framebuffer *old_fb)
 498 {
 499         const struct drm_plane_helper_funcs *plane_funcs;
 500         struct drm_crtc *crtc[2];
 501         const struct drm_crtc_helper_funcs *crtc_funcs[2];
 502         int i, ret = 0;
 503
 504         plane_funcs = plane->helper_private;
 505
 506         /* Since this is a transitional helper we can't assume that plane->state
 507          * is always valid. Hence we need to use plane->crtc instead of
 508          * plane->state->crtc as the old crtc. */
 509         crtc[0] = plane->crtc;
 510         crtc[1] = crtc[0] != plane_state->crtc ? plane_state->crtc : NULL;
 511
 512         for (i = 0; i < 2; i++)
 513                 crtc_funcs[i] = crtc[i] ? crtc[i]->helper_private : NULL;
 514
 515         if (plane_funcs->atomic_check) {
 516                 ret = plane_funcs->atomic_check(plane, plane_state);
 517                 if (ret)
 518                         goto out;
 519         }
 520
 521         if (plane_funcs->prepare_fb && plane_state->fb &&
 522             plane_state->fb != old_fb) {
 523                 ret = plane_funcs->prepare_fb(plane,
 524                                               plane_state);
 525                 if (ret)
 526                         goto out;
 527         }
 528
 529         /* Point of no return, commit sw state. */
 530         swap(plane->state, plane_state);
 531
 532         for (i = 0; i < 2; i++) {
 533                 if (crtc_funcs[i] && crtc_funcs[i]->atomic_begin)
 534                         crtc_funcs[i]->atomic_begin(crtc[i], crtc[i]->state);
 535         }
 536
 537         /*
 538          * Drivers may optionally implement the ->atomic_disable callback, so
 539          * special-case that here.
 540          */
 541         if (drm_atomic_plane_disabling(plane, plane_state) &&
 542             plane_funcs->atomic_disable)
 543                 plane_funcs->atomic_disable(plane, plane_state);
 544         else
 545                 plane_funcs->atomic_update(plane, plane_state);
 546
 547         for (i = 0; i < 2; i++) {
 548                 if (crtc_funcs[i] && crtc_funcs[i]->atomic_flush)
 549                         crtc_funcs[i]->atomic_flush(crtc[i], crtc[i]->state);
 550         }
 551
 552         /*
 553          * If we only moved the plane and didn't change fb's, there's no need to
 554          * wait for vblank.
 555          */
 556         if (plane->state->fb == old_fb)
 557                 goto out;
 558
 559         for (i = 0; i < 2; i++) {
 560                 if (!crtc[i])
 561                         continue;
 562
 563                 if (crtc[i]->cursor == plane)
 564                         continue;
 565
 566                 /* There's no other way to figure out whether the crtc is running. */
 567                 ret = drm_crtc_vblank_get(crtc[i]);
 568                 if (ret == 0) {
 569                         drm_crtc_wait_one_vblank(crtc[i]);
 570                         drm_crtc_vblank_put(crtc[i]);
 571                 }
 572
 573                 ret = 0;
 574         }
 575
 576         if (plane_funcs->cleanup_fb)
 577                 plane_funcs->cleanup_fb(plane, plane_state);
 578 out:
 579         if (plane_state) {
 580                 if (plane->funcs->atomic_destroy_state)
 581                         plane->funcs->atomic_destroy_state(plane, plane_state);
 582                 else
 583                         drm_atomic_helper_plane_destroy_state(plane, plane_state);
 584         }
 585
 586         return ret;
 587 }
 588
 589 /**
 590  * drm_plane_helper_update() - Transitional helper for plane update
 591  * @plane: plane object to update
 592  * @crtc: owning CRTC of owning plane
 593  * @fb: framebuffer to flip onto plane
 594  * @crtc_x: x offset of primary plane on crtc
 595  * @crtc_y: y offset of primary plane on crtc
 596  * @crtc_w: width of primary plane rectangle on crtc
 597  * @crtc_h: height of primary plane rectangle on crtc
 598  * @src_x: x offset of @fb for panning
 599  * @src_y: y offset of @fb for panning
 600  * @src_w: width of source rectangle in @fb
 601  * @src_h: height of source rectangle in @fb
 602  *
 603  * Provides a default plane update handler using the atomic plane update
 604  * functions. It is fully left to the driver to check plane constraints and
 605  * handle corner-cases like a fully occluded or otherwise invisible plane.
 606  *
 607  * This is useful for piecewise transitioning of a driver to the atomic helpers.
 608  *
 609  * RETURNS:
 610  * Zero on success, error code on failure
 611  */
 612 int drm_plane_helper_update(struct drm_plane *plane, struct drm_crtc *crtc,
 613                             struct drm_framebuffer *fb,
 614                             int crtc_x, int crtc_y,
 615                             unsigned int crtc_w, unsigned int crtc_h,
 616                             uint32_t src_x, uint32_t src_y,
 617                             uint32_t src_w, uint32_t src_h)
 618 {
 619         struct drm_plane_state *plane_state;
 620
 621         if (plane->funcs->atomic_duplicate_state)
 622                 plane_state = plane->funcs->atomic_duplicate_state(plane);
 623         else {
 624                 if (!plane->state)
 625                         drm_atomic_helper_plane_reset(plane);
 626
 627                 plane_state = drm_atomic_helper_plane_duplicate_state(plane);
 628         }
 629         if (!plane_state)
 630                 return -ENOMEM;
 631         plane_state->plane = plane;
 632
 633         plane_state->crtc = crtc;
 634         drm_atomic_set_fb_for_plane(plane_state, fb);
 635         plane_state->crtc_x = crtc_x;
 636         plane_state->crtc_y = crtc_y;
 637         plane_state->crtc_h = crtc_h;
 638         plane_state->crtc_w = crtc_w;
 639         plane_state->src_x = src_x;
 640         plane_state->src_y = src_y;
 641         plane_state->src_h = src_h;
 642         plane_state->src_w = src_w;
 643
 644         return drm_plane_helper_commit(plane, plane_state, plane->fb);
 645 }
 646 EXPORT_SYMBOL(drm_plane_helper_update);
 647
 648 /**
 649  * drm_plane_helper_disable() - Transitional helper for plane disable
 650  * @plane: plane to disable
 651  *
 652  * Provides a default plane disable handler using the atomic plane update
 653  * functions. It is fully left to the driver to check plane constraints and
 654  * handle corner-cases like a fully occluded or otherwise invisible plane.
 655  *
 656  * This is useful for piecewise transitioning of a driver to the atomic helpers.
 657  *
 658  * RETURNS:
 659  * Zero on success, error code on failure
 660  */
 661 int drm_plane_helper_disable(struct drm_plane *plane)
 662 {
 663         struct drm_plane_state *plane_state;
 664
 665         /* crtc helpers love to call disable functions for already disabled hw
 666          * functions. So cope with that. */
 667         if (!plane->crtc)
 668                 return 0;
 669
 670         if (plane->funcs->atomic_duplicate_state)
 671                 plane_state = plane->funcs->atomic_duplicate_state(plane);
 672         else {
 673                 if (!plane->state)
 674                         drm_atomic_helper_plane_reset(plane);
 675
 676                 plane_state = drm_atomic_helper_plane_duplicate_state(plane);
 677         }
 678         if (!plane_state)
 679                 return -ENOMEM;
 680         plane_state->plane = plane;
 681
 682         plane_state->crtc = NULL;
 683         drm_atomic_set_fb_for_plane(plane_state, NULL);
 684
 685         return drm_plane_helper_commit(plane, plane_state, plane->fb);
 686 }
 687 EXPORT_SYMBOL(drm_plane_helper_disable);