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
  62 /*
  63  * This is the minimal list of formats that seem to be safe for modeset use
  64  * with all current DRM drivers.  Most hardware can actually support more
  65  * formats than this and drivers may specify a more accurate list when
  66  * creating the primary plane.  However drivers that still call
  67  * drm_plane_init() will use this minimal format list as the default.
  68  */
  69 static const uint32_t safe_modeset_formats[] = {
  70         DRM_FORMAT_XRGB8888,
  71         DRM_FORMAT_ARGB8888,
  72 };
  73
  74 /*
  75  * Returns the connectors currently associated with a CRTC.  This function
  76  * should be called twice:  once with a NULL connector list to retrieve
  77  * the list size, and once with the properly allocated list to be filled in.
  78  */
  79 static int get_connectors_for_crtc(struct drm_crtc *crtc,
  80                                    struct drm_connector **connector_list,
  81                                    int num_connectors)
  82 {
  83         struct drm_device *dev = crtc->dev;
  84         struct drm_connector *connector;
  85         int count = 0;
  86
  87         /*
  88          * Note: Once we change the plane hooks to more fine-grained locking we
  89          * need to grab the connection_mutex here to be able to make these
  90          * checks.
  91          */
  92         WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
  93
  94         list_for_each_entry(connector, &dev->mode_config.connector_list, head)
  95                 if (connector->encoder && connector->encoder->crtc == crtc) {
  96                         if (connector_list != NULL && count < num_connectors)
  97                                 *(connector_list++) = connector;
  98
  99                         count++;
 100                 }
 101
 102         return count;
 103 }
 104
 105 /**
 106  * drm_plane_helper_check_update() - Check plane update for validity
 107  * @plane: plane object to update
 108  * @crtc: owning CRTC of owning plane
 109  * @fb: framebuffer to flip onto plane
 110  * @src: source coordinates in 16.16 fixed point
 111  * @dest: integer destination coordinates
 112  * @clip: integer clipping coordinates
 113  * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
 114  * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
 115  * @can_position: is it legal to position the plane such that it
 116  *                doesn't cover the entire crtc?  This will generally
 117  *                only be false for primary planes.
 118  * @can_update_disabled: can the plane be updated while the crtc
 119  *                       is disabled?
 120  * @visible: output parameter indicating whether plane is still visible after
 121  *           clipping
 122  *
 123  * Checks that a desired plane update is valid.  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_update(struct drm_plane *plane,
 132                                     struct drm_crtc *crtc,
 133                                     struct drm_framebuffer *fb,
 134                                     struct drm_rect *src,
 135                                     struct drm_rect *dest,
 136                                     const struct drm_rect *clip,
 137                                     int min_scale,
 138                                     int max_scale,
 139                                     bool can_position,
 140                                     bool can_update_disabled,
 141                                     bool *visible)
 142 {
 143         int hscale, vscale;
 144
 145         if (!fb) {
 146                 *visible = false;
 147                 return 0;
 148         }
 149
 150         /* crtc should only be NULL when disabling (i.e., !fb) */
 151         if (WARN_ON(!crtc)) {
 152                 *visible = false;
 153                 return 0;
 154         }
 155
 156         if (!crtc->enabled && !can_update_disabled) {
 157                 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
 158                 return -EINVAL;
 159         }
 160
 161         /* Check scaling */
 162         hscale = drm_rect_calc_hscale(src, dest, min_scale, max_scale);
 163         vscale = drm_rect_calc_vscale(src, dest, min_scale, max_scale);
 164         if (hscale < 0 || vscale < 0) {
 165                 DRM_DEBUG_KMS("Invalid scaling of plane\n");
 166                 return -ERANGE;
 167         }
 168
 169         *visible = drm_rect_clip_scaled(src, dest, clip, hscale, vscale);
 170         if (!*visible)
 171                 /*
 172                  * Plane isn't visible; some drivers can handle this
 173                  * so we just return success here.  Drivers that can't
 174                  * (including those that use the primary plane helper's
 175                  * update function) will return an error from their
 176                  * update_plane handler.
 177                  */
 178                 return 0;
 179
 180         if (!can_position && !drm_rect_equals(dest, clip)) {
 181                 DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
 182                 return -EINVAL;
 183         }
 184
 185         return 0;
 186 }
 187 EXPORT_SYMBOL(drm_plane_helper_check_update);
 188
 189 /**
 190  * drm_primary_helper_update() - Helper for primary plane update
 191  * @plane: plane object to update
 192  * @crtc: owning CRTC of owning plane
 193  * @fb: framebuffer to flip onto plane
 194  * @crtc_x: x offset of primary plane on crtc
 195  * @crtc_y: y offset of primary plane on crtc
 196  * @crtc_w: width of primary plane rectangle on crtc
 197  * @crtc_h: height of primary plane rectangle on crtc
 198  * @src_x: x offset of @fb for panning
 199  * @src_y: y offset of @fb for panning
 200  * @src_w: width of source rectangle in @fb
 201  * @src_h: height of source rectangle in @fb
 202  *
 203  * Provides a default plane update handler for primary planes.  This is handler
 204  * is called in response to a userspace SetPlane operation on the plane with a
 205  * non-NULL framebuffer.  We call the driver's modeset handler to update the
 206  * framebuffer.
 207  *
 208  * SetPlane() on a primary plane of a disabled CRTC is not supported, and will
 209  * return an error.
 210  *
 211  * Note that we make some assumptions about hardware limitations that may not be
 212  * true for all hardware --
 213  *   1) Primary plane cannot be repositioned.
 214  *   2) Primary plane cannot be scaled.
 215  *   3) Primary plane must cover the entire CRTC.
 216  *   4) Subpixel positioning is not supported.
 217  * Drivers for hardware that don't have these restrictions can provide their
 218  * own implementation rather than using this helper.
 219  *
 220  * RETURNS:
 221  * Zero on success, error code on failure
 222  */
 223 int drm_primary_helper_update(struct drm_plane *plane, struct drm_crtc *crtc,
 224                               struct drm_framebuffer *fb,
 225                               int crtc_x, int crtc_y,
 226                               unsigned int crtc_w, unsigned int crtc_h,
 227                               uint32_t src_x, uint32_t src_y,
 228                               uint32_t src_w, uint32_t src_h)
 229 {
 230         struct drm_mode_set set = {
 231                 .crtc = crtc,
 232                 .fb = fb,
 233                 .mode = &crtc->mode,
 234                 .x = src_x >> 16,
 235                 .y = src_y >> 16,
 236         };
 237         struct drm_rect src = {
 238                 .x1 = src_x,
 239                 .y1 = src_y,
 240                 .x2 = src_x + src_w,
 241                 .y2 = src_y + src_h,
 242         };
 243         struct drm_rect dest = {
 244                 .x1 = crtc_x,
 245                 .y1 = crtc_y,
 246                 .x2 = crtc_x + crtc_w,
 247                 .y2 = crtc_y + crtc_h,
 248         };
 249         const struct drm_rect clip = {
 250                 .x2 = crtc->mode.hdisplay,
 251                 .y2 = crtc->mode.vdisplay,
 252         };
 253         struct drm_connector **connector_list;
 254         int num_connectors, ret;
 255         bool visible;
 256
 257         ret = drm_plane_helper_check_update(plane, crtc, fb,
 258                                             &src, &dest, &clip,
 259                                             DRM_PLANE_HELPER_NO_SCALING,
 260                                             DRM_PLANE_HELPER_NO_SCALING,
 261                                             false, false, &visible);
 262         if (ret)
 263                 return ret;
 264
 265         if (!visible)
 266                 /*
 267                  * Primary plane isn't visible.  Note that unless a driver
 268                  * provides their own disable function, this will just
 269                  * wind up returning -EINVAL to userspace.
 270                  */
 271                 return plane->funcs->disable_plane(plane);
 272
 273         /* Find current connectors for CRTC */
 274         num_connectors = get_connectors_for_crtc(crtc, NULL, 0);
 275         BUG_ON(num_connectors == 0);
 276         connector_list = kzalloc(num_connectors * sizeof(*connector_list),
 277                                  GFP_KERNEL);
 278         if (!connector_list)
 279                 return -ENOMEM;
 280         get_connectors_for_crtc(crtc, connector_list, num_connectors);
 281
 282         set.connectors = connector_list;
 283         set.num_connectors = num_connectors;
 284
 285         /*
 286          * We call set_config() directly here rather than using
 287          * drm_mode_set_config_internal.  We're reprogramming the same
 288          * connectors that were already in use, so we shouldn't need the extra
 289          * cross-CRTC fb refcounting to accomodate stealing connectors.
 290          * drm_mode_setplane() already handles the basic refcounting for the
 291          * framebuffers involved in this operation.
 292          */
 293         ret = crtc->funcs->set_config(&set);
 294
 295         kfree(connector_list);
 296         return ret;
 297 }
 298 EXPORT_SYMBOL(drm_primary_helper_update);
 299
 300 /**
 301  * drm_primary_helper_disable() - Helper for primary plane disable
 302  * @plane: plane to disable
 303  *
 304  * Provides a default plane disable handler for primary planes.  This is handler
 305  * is called in response to a userspace SetPlane operation on the plane with a
 306  * NULL framebuffer parameter.  It unconditionally fails the disable call with
 307  * -EINVAL the only way to disable the primary plane without driver support is
 308  * to disable the entier CRTC. Which does not match the plane ->disable hook.
 309  *
 310  * Note that some hardware may be able to disable the primary plane without
 311  * disabling the whole CRTC.  Drivers for such hardware should provide their
 312  * own disable handler that disables just the primary plane (and they'll likely
 313  * need to provide their own update handler as well to properly re-enable a
 314  * disabled primary plane).
 315  *
 316  * RETURNS:
 317  * Unconditionally returns -EINVAL.
 318  */
 319 int drm_primary_helper_disable(struct drm_plane *plane)
 320 {
 321         return -EINVAL;
 322 }
 323 EXPORT_SYMBOL(drm_primary_helper_disable);
 324
 325 /**
 326  * drm_primary_helper_destroy() - Helper for primary plane destruction
 327  * @plane: plane to destroy
 328  *
 329  * Provides a default plane destroy handler for primary planes.  This handler
 330  * is called during CRTC destruction.  We disable the primary plane, remove
 331  * it from the DRM plane list, and deallocate the plane structure.
 332  */
 333 void drm_primary_helper_destroy(struct drm_plane *plane)
 334 {
 335         drm_plane_cleanup(plane);
 336         kfree(plane);
 337 }
 338 EXPORT_SYMBOL(drm_primary_helper_destroy);
 339
 340 const struct drm_plane_funcs drm_primary_helper_funcs = {
 341         .update_plane = drm_primary_helper_update,
 342         .disable_plane = drm_primary_helper_disable,
 343         .destroy = drm_primary_helper_destroy,
 344 };
 345 EXPORT_SYMBOL(drm_primary_helper_funcs);
 346
 347 /**
 348  * drm_primary_helper_create_plane() - Create a generic primary plane
 349  * @dev: drm device
 350  * @formats: pixel formats supported, or NULL for a default safe list
 351  * @num_formats: size of @formats; ignored if @formats is NULL
 352  *
 353  * Allocates and initializes a primary plane that can be used with the primary
 354  * plane helpers.  Drivers that wish to use driver-specific plane structures or
 355  * provide custom handler functions may perform their own allocation and
 356  * initialization rather than calling this function.
 357  */
 358 struct drm_plane *drm_primary_helper_create_plane(struct drm_device *dev,
 359                                                   const uint32_t *formats,
 360                                                   int num_formats)
 361 {
 362         struct drm_plane *primary;
 363         int ret;
 364
 365         primary = kzalloc(sizeof(*primary), GFP_KERNEL);
 366         if (primary == NULL) {
 367                 DRM_DEBUG_KMS("Failed to allocate primary plane\n");
 368                 return NULL;
 369         }
 370
 371         if (formats == NULL) {
 372                 formats = safe_modeset_formats;
 373                 num_formats = ARRAY_SIZE(safe_modeset_formats);
 374         }
 375
 376         /* possible_crtc's will be filled in later by crtc_init */
 377         ret = drm_universal_plane_init(dev, primary, 0,
 378                                        &drm_primary_helper_funcs,
 379                                        formats, num_formats,
 380                                        DRM_PLANE_TYPE_PRIMARY);
 381         if (ret) {
 382                 kfree(primary);
 383                 primary = NULL;
 384         }
 385
 386         return primary;
 387 }
 388 EXPORT_SYMBOL(drm_primary_helper_create_plane);
 389
 390 /**
 391  * drm_crtc_init - Legacy CRTC initialization function
 392  * @dev: DRM device
 393  * @crtc: CRTC object to init
 394  * @funcs: callbacks for the new CRTC
 395  *
 396  * Initialize a CRTC object with a default helper-provided primary plane and no
 397  * cursor plane.
 398  *
 399  * Returns:
 400  * Zero on success, error code on failure.
 401  */
 402 int drm_crtc_init(struct drm_device *dev, struct drm_crtc *crtc,
 403                   const struct drm_crtc_funcs *funcs)
 404 {
 405         struct drm_plane *primary;
 406
 407         primary = drm_primary_helper_create_plane(dev, NULL, 0);
 408         return drm_crtc_init_with_planes(dev, crtc, primary, NULL, funcs);
 409 }
 410 EXPORT_SYMBOL(drm_crtc_init);
 411
 412 int drm_plane_helper_commit(struct drm_plane *plane,
 413                             struct drm_plane_state *plane_state,
 414                             struct drm_framebuffer *old_fb)
 415 {
 416         struct drm_plane_helper_funcs *plane_funcs;
 417         struct drm_crtc *crtc[2];
 418         struct drm_crtc_helper_funcs *crtc_funcs[2];
 419         int i, ret = 0;
 420
 421         plane_funcs = plane->helper_private;
 422
 423         /* Since this is a transitional helper we can't assume that plane->state
 424          * is always valid. Hence we need to use plane->crtc instead of
 425          * plane->state->crtc as the old crtc. */
 426         crtc[0] = plane->crtc;
 427         crtc[1] = crtc[0] != plane_state->crtc ? plane_state->crtc : NULL;
 428
 429         for (i = 0; i < 2; i++)
 430                 crtc_funcs[i] = crtc[i] ? crtc[i]->helper_private : NULL;
 431
 432         if (plane_funcs->atomic_check) {
 433                 ret = plane_funcs->atomic_check(plane, plane_state);
 434                 if (ret)
 435                         goto out;
 436         }
 437
 438         if (plane_funcs->prepare_fb && plane_state->fb &&
 439             plane_state->fb != old_fb) {
 440                 ret = plane_funcs->prepare_fb(plane, plane_state->fb);
 441                 if (ret)
 442                         goto out;
 443         }
 444
 445         /* Point of no return, commit sw state. */
 446         swap(plane->state, plane_state);
 447
 448         for (i = 0; i < 2; i++) {
 449                 if (crtc_funcs[i] && crtc_funcs[i]->atomic_begin)
 450                         crtc_funcs[i]->atomic_begin(crtc[i]);
 451         }
 452
 453         /*
 454          * Drivers may optionally implement the ->atomic_disable callback, so
 455          * special-case that here.
 456          */
 457         if (drm_atomic_plane_disabling(plane, plane_state) &&
 458             plane_funcs->atomic_disable)
 459                 plane_funcs->atomic_disable(plane, plane_state);
 460         else
 461                 plane_funcs->atomic_update(plane, plane_state);
 462
 463         for (i = 0; i < 2; i++) {
 464                 if (crtc_funcs[i] && crtc_funcs[i]->atomic_flush)
 465                         crtc_funcs[i]->atomic_flush(crtc[i]);
 466         }
 467
 468         /*
 469          * If we only moved the plane and didn't change fb's, there's no need to
 470          * wait for vblank.
 471          */
 472         if (plane->state->fb == old_fb)
 473                 goto out;
 474
 475         for (i = 0; i < 2; i++) {
 476                 if (!crtc[i])
 477                         continue;
 478
 479                 /* There's no other way to figure out whether the crtc is running. */
 480                 ret = drm_crtc_vblank_get(crtc[i]);
 481                 if (ret == 0) {
 482                         drm_crtc_wait_one_vblank(crtc[i]);
 483                         drm_crtc_vblank_put(crtc[i]);
 484                 }
 485
 486                 ret = 0;
 487         }
 488
 489         if (plane_funcs->cleanup_fb && old_fb)
 490                 plane_funcs->cleanup_fb(plane, old_fb);
 491 out:
 492         if (plane_state) {
 493                 if (plane->funcs->atomic_destroy_state)
 494                         plane->funcs->atomic_destroy_state(plane, plane_state);
 495                 else
 496                         drm_atomic_helper_plane_destroy_state(plane, plane_state);
 497         }
 498
 499         return ret;
 500 }
 501
 502 /**
 503  * drm_plane_helper_update() - Transitional helper for plane update
 504  * @plane: plane object to update
 505  * @crtc: owning CRTC of owning plane
 506  * @fb: framebuffer to flip onto plane
 507  * @crtc_x: x offset of primary plane on crtc
 508  * @crtc_y: y offset of primary plane on crtc
 509  * @crtc_w: width of primary plane rectangle on crtc
 510  * @crtc_h: height of primary plane rectangle on crtc
 511  * @src_x: x offset of @fb for panning
 512  * @src_y: y offset of @fb for panning
 513  * @src_w: width of source rectangle in @fb
 514  * @src_h: height of source rectangle in @fb
 515  *
 516  * Provides a default plane update handler using the atomic plane update
 517  * functions. It is fully left to the driver to check plane constraints and
 518  * handle corner-cases like a fully occluded or otherwise invisible plane.
 519  *
 520  * This is useful for piecewise transitioning of a driver to the atomic helpers.
 521  *
 522  * RETURNS:
 523  * Zero on success, error code on failure
 524  */
 525 int drm_plane_helper_update(struct drm_plane *plane, struct drm_crtc *crtc,
 526                             struct drm_framebuffer *fb,
 527                             int crtc_x, int crtc_y,
 528                             unsigned int crtc_w, unsigned int crtc_h,
 529                             uint32_t src_x, uint32_t src_y,
 530                             uint32_t src_w, uint32_t src_h)
 531 {
 532         struct drm_plane_state *plane_state;
 533
 534         if (plane->funcs->atomic_duplicate_state)
 535                 plane_state = plane->funcs->atomic_duplicate_state(plane);
 536         else if (plane->state)
 537                 plane_state = drm_atomic_helper_plane_duplicate_state(plane);
 538         else
 539                 plane_state = kzalloc(sizeof(*plane_state), GFP_KERNEL);
 540         if (!plane_state)
 541                 return -ENOMEM;
 542         plane_state->plane = plane;
 543
 544         plane_state->crtc = crtc;
 545         drm_atomic_set_fb_for_plane(plane_state, fb);
 546         plane_state->crtc_x = crtc_x;
 547         plane_state->crtc_y = crtc_y;
 548         plane_state->crtc_h = crtc_h;
 549         plane_state->crtc_w = crtc_w;
 550         plane_state->src_x = src_x;
 551         plane_state->src_y = src_y;
 552         plane_state->src_h = src_h;
 553         plane_state->src_w = src_w;
 554
 555         return drm_plane_helper_commit(plane, plane_state, plane->fb);
 556 }
 557 EXPORT_SYMBOL(drm_plane_helper_update);
 558
 559 /**
 560  * drm_plane_helper_disable() - Transitional helper for plane disable
 561  * @plane: plane to disable
 562  *
 563  * Provides a default plane disable handler using the atomic plane update
 564  * functions. It is fully left to the driver to check plane constraints and
 565  * handle corner-cases like a fully occluded or otherwise invisible plane.
 566  *
 567  * This is useful for piecewise transitioning of a driver to the atomic helpers.
 568  *
 569  * RETURNS:
 570  * Zero on success, error code on failure
 571  */
 572 int drm_plane_helper_disable(struct drm_plane *plane)
 573 {
 574         struct drm_plane_state *plane_state;
 575
 576         /* crtc helpers love to call disable functions for already disabled hw
 577          * functions. So cope with that. */
 578         if (!plane->crtc)
 579                 return 0;
 580
 581         if (plane->funcs->atomic_duplicate_state)
 582                 plane_state = plane->funcs->atomic_duplicate_state(plane);
 583         else if (plane->state)
 584                 plane_state = drm_atomic_helper_plane_duplicate_state(plane);
 585         else
 586                 plane_state = kzalloc(sizeof(*plane_state), GFP_KERNEL);
 587         if (!plane_state)
 588                 return -ENOMEM;
 589         plane_state->plane = plane;
 590
 591         plane_state->crtc = NULL;
 592         drm_atomic_set_fb_for_plane(plane_state, NULL);
 593
 594         return drm_plane_helper_commit(plane, plane_state, plane->fb);
 595 }
 596 EXPORT_SYMBOL(drm_plane_helper_disable);