drivers/gpu/drm/drm_plane.c

   1 /*
   2  * Copyright (c) 2016 Intel Corporation
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that copyright
   7  * notice and this permission notice appear in supporting documentation, and
   8  * that the name of the copyright holders not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  The copyright holders make no representations
  11  * about the suitability of this software for any purpose.  It is provided "as
  12  * is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20  * OF THIS SOFTWARE.
  21  */
  22
  23 #include <linux/slab.h>
  24 #include <linux/uaccess.h>
  25
  26 #include <drm/drm_plane.h>
  27 #include <drm/drm_drv.h>
  28 #include <drm/drm_print.h>
  29 #include <drm/drm_framebuffer.h>
  30 #include <drm/drm_file.h>
  31 #include <drm/drm_crtc.h>
  32 #include <drm/drm_fourcc.h>
  33 #include <drm/drm_managed.h>
  34 #include <drm/drm_vblank.h>
  35
  36 #include "drm_crtc_internal.h"
  37
  38 /**
  39  * DOC: overview
  40  *
  41  * A plane represents an image source that can be blended with or overlayed on
  42  * top of a CRTC during the scanout process. Planes take their input data from a
  43  * &drm_framebuffer object. The plane itself specifies the cropping and scaling
  44  * of that image, and where it is placed on the visible area of a display
  45  * pipeline, represented by &drm_crtc. A plane can also have additional
  46  * properties that specify how the pixels are positioned and blended, like
  47  * rotation or Z-position. All these properties are stored in &drm_plane_state.
  48  *
  49  * To create a plane, a KMS drivers allocates and zeroes an instances of
  50  * &struct drm_plane (possibly as part of a larger structure) and registers it
  51  * with a call to drm_universal_plane_init().
  52  *
  53  * Each plane has a type, see enum drm_plane_type. A plane can be compatible
  54  * with multiple CRTCs, see &drm_plane.possible_crtcs.
  55  *
  56  * Each CRTC must have a unique primary plane userspace can attach to enable
  57  * the CRTC. In other words, userspace must be able to attach a different
  58  * primary plane to each CRTC at the same time. Primary planes can still be
  59  * compatible with multiple CRTCs. There must be exactly as many primary planes
  60  * as there are CRTCs.
  61  *
  62  * Legacy uAPI doesn't expose the primary and cursor planes directly. DRM core
  63  * relies on the driver to set the primary and optionally the cursor plane used
  64  * for legacy IOCTLs. This is done by calling drm_crtc_init_with_planes(). All
  65  * drivers must provide one primary plane per CRTC to avoid surprising legacy
  66  * userspace too much.
  67  */
  68
  69 /**
  70  * DOC: standard plane properties
  71  *
  72  * DRM planes have a few standardized properties:
  73  *
  74  * type:
  75  *     Immutable property describing the type of the plane.
  76  *
  77  *     For user-space which has enabled the &DRM_CLIENT_CAP_ATOMIC capability,
  78  *     the plane type is just a hint and is mostly superseded by atomic
  79  *     test-only commits. The type hint can still be used to come up more
  80  *     easily with a plane configuration accepted by the driver.
  81  *
  82  *     The value of this property can be one of the following:
  83  *
  84  *     "Primary":
  85  *         To light up a CRTC, attaching a primary plane is the most likely to
  86  *         work if it covers the whole CRTC and doesn't have scaling or
  87  *         cropping set up.
  88  *
  89  *         Drivers may support more features for the primary plane, user-space
  90  *         can find out with test-only atomic commits.
  91  *
  92  *         Some primary planes are implicitly used by the kernel in the legacy
  93  *         IOCTLs &DRM_IOCTL_MODE_SETCRTC and &DRM_IOCTL_MODE_PAGE_FLIP.
  94  *         Therefore user-space must not mix explicit usage of any primary
  95  *         plane (e.g. through an atomic commit) with these legacy IOCTLs.
  96  *
  97  *     "Cursor":
  98  *         To enable this plane, using a framebuffer configured without scaling
  99  *         or cropping and with the following properties is the most likely to
 100  *         work:
 101  *
 102  *         - If the driver provides the capabilities &DRM_CAP_CURSOR_WIDTH and
 103  *           &DRM_CAP_CURSOR_HEIGHT, create the framebuffer with this size.
 104  *           Otherwise, create a framebuffer with the size 64x64.
 105  *         - If the driver doesn't support modifiers, create a framebuffer with
 106  *           a linear layout. Otherwise, use the IN_FORMATS plane property.
 107  *
 108  *         Drivers may support more features for the cursor plane, user-space
 109  *         can find out with test-only atomic commits.
 110  *
 111  *         Some cursor planes are implicitly used by the kernel in the legacy
 112  *         IOCTLs &DRM_IOCTL_MODE_CURSOR and &DRM_IOCTL_MODE_CURSOR2.
 113  *         Therefore user-space must not mix explicit usage of any cursor
 114  *         plane (e.g. through an atomic commit) with these legacy IOCTLs.
 115  *
 116  *         Some drivers may support cursors even if no cursor plane is exposed.
 117  *         In this case, the legacy cursor IOCTLs can be used to configure the
 118  *         cursor.
 119  *
 120  *     "Overlay":
 121  *         Neither primary nor cursor.
 122  *
 123  *         Overlay planes are the only planes exposed when the
 124  *         &DRM_CLIENT_CAP_UNIVERSAL_PLANES capability is disabled.
 125  *
 126  * IN_FORMATS:
 127  *     Blob property which contains the set of buffer format and modifier
 128  *     pairs supported by this plane. The blob is a struct
 129  *     drm_format_modifier_blob. Without this property the plane doesn't
 130  *     support buffers with modifiers. Userspace cannot change this property.
 131  */
 132
 133 static unsigned int drm_num_planes(struct drm_device *dev)
 134 {
 135         unsigned int num = 0;
 136         struct drm_plane *tmp;
 137
 138         drm_for_each_plane(tmp, dev) {
 139                 num++;
 140         }
 141
 142         return num;
 143 }
 144
 145 static inline u32 *
 146 formats_ptr(struct drm_format_modifier_blob *blob)
 147 {
 148         return (u32 *)(((char *)blob) + blob->formats_offset);
 149 }
 150
 151 static inline struct drm_format_modifier *
 152 modifiers_ptr(struct drm_format_modifier_blob *blob)
 153 {
 154         return (struct drm_format_modifier *)(((char *)blob) + blob->modifiers_offset);
 155 }
 156
 157 static int create_in_format_blob(struct drm_device *dev, struct drm_plane *plane)
 158 {
 159         const struct drm_mode_config *config = &dev->mode_config;
 160         struct drm_property_blob *blob;
 161         struct drm_format_modifier *mod;
 162         size_t blob_size, formats_size, modifiers_size;
 163         struct drm_format_modifier_blob *blob_data;
 164         unsigned int i, j;
 165
 166         formats_size = sizeof(__u32) * plane->format_count;
 167         if (WARN_ON(!formats_size)) {
 168                 /* 0 formats are never expected */
 169                 return 0;
 170         }
 171
 172         modifiers_size =
 173                 sizeof(struct drm_format_modifier) * plane->modifier_count;
 174
 175         blob_size = sizeof(struct drm_format_modifier_blob);
 176         /* Modifiers offset is a pointer to a struct with a 64 bit field so it
 177          * should be naturally aligned to 8B.
 178          */
 179         BUILD_BUG_ON(sizeof(struct drm_format_modifier_blob) % 8);
 180         blob_size += ALIGN(formats_size, 8);
 181         blob_size += modifiers_size;
 182
 183         blob = drm_property_create_blob(dev, blob_size, NULL);
 184         if (IS_ERR(blob))
 185                 return -1;
 186
 187         blob_data = blob->data;
 188         blob_data->version = FORMAT_BLOB_CURRENT;
 189         blob_data->count_formats = plane->format_count;
 190         blob_data->formats_offset = sizeof(struct drm_format_modifier_blob);
 191         blob_data->count_modifiers = plane->modifier_count;
 192
 193         blob_data->modifiers_offset =
 194                 ALIGN(blob_data->formats_offset + formats_size, 8);
 195
 196         memcpy(formats_ptr(blob_data), plane->format_types, formats_size);
 197
 198         /* If we can't determine support, just bail */
 199         if (!plane->funcs->format_mod_supported)
 200                 goto done;
 201
 202         mod = modifiers_ptr(blob_data);
 203         for (i = 0; i < plane->modifier_count; i++) {
 204                 for (j = 0; j < plane->format_count; j++) {
 205                         if (plane->funcs->format_mod_supported(plane,
 206                                                                plane->format_types[j],
 207                                                                plane->modifiers[i])) {
 208
 209                                 mod->formats |= 1ULL << j;
 210                         }
 211                 }
 212
 213                 mod->modifier = plane->modifiers[i];
 214                 mod->offset = 0;
 215                 mod->pad = 0;
 216                 mod++;
 217         }
 218
 219 done:
 220         drm_object_attach_property(&plane->base, config->modifiers_property,
 221                                    blob->base.id);
 222
 223         return 0;
 224 }
 225
 226 __printf(9, 0)
 227 static int __drm_universal_plane_init(struct drm_device *dev,
 228                                       struct drm_plane *plane,
 229                                       uint32_t possible_crtcs,
 230                                       const struct drm_plane_funcs *funcs,
 231                                       const uint32_t *formats,
 232                                       unsigned int format_count,
 233                                       const uint64_t *format_modifiers,
 234                                       enum drm_plane_type type,
 235                                       const char *name, va_list ap)
 236 {
 237         struct drm_mode_config *config = &dev->mode_config;
 238         unsigned int format_modifier_count = 0;
 239         int ret;
 240
 241         /* plane index is used with 32bit bitmasks */
 242         if (WARN_ON(config->num_total_plane >= 32))
 243                 return -EINVAL;
 244
 245         WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
 246                 (!funcs->atomic_destroy_state ||
 247                  !funcs->atomic_duplicate_state));
 248
 249         ret = drm_mode_object_add(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
 250         if (ret)
 251                 return ret;
 252
 253         drm_modeset_lock_init(&plane->mutex);
 254
 255         plane->base.properties = &plane->properties;
 256         plane->dev = dev;
 257         plane->funcs = funcs;
 258         plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
 259                                             GFP_KERNEL);
 260         if (!plane->format_types) {
 261                 DRM_DEBUG_KMS("out of memory when allocating plane\n");
 262                 drm_mode_object_unregister(dev, &plane->base);
 263                 return -ENOMEM;
 264         }
 265
 266         /*
 267          * First driver to need more than 64 formats needs to fix this. Each
 268          * format is encoded as a bit and the current code only supports a u64.
 269          */
 270         if (WARN_ON(format_count > 64))
 271                 return -EINVAL;
 272
 273         if (format_modifiers) {
 274                 const uint64_t *temp_modifiers = format_modifiers;
 275
 276                 while (*temp_modifiers++ != DRM_FORMAT_MOD_INVALID)
 277                         format_modifier_count++;
 278         }
 279
 280         if (format_modifier_count)
 281                 config->allow_fb_modifiers = true;
 282
 283         plane->modifier_count = format_modifier_count;
 284         plane->modifiers = kmalloc_array(format_modifier_count,
 285                                          sizeof(format_modifiers[0]),
 286                                          GFP_KERNEL);
 287
 288         if (format_modifier_count && !plane->modifiers) {
 289                 DRM_DEBUG_KMS("out of memory when allocating plane\n");
 290                 kfree(plane->format_types);
 291                 drm_mode_object_unregister(dev, &plane->base);
 292                 return -ENOMEM;
 293         }
 294
 295         if (name) {
 296                 plane->name = kvasprintf(GFP_KERNEL, name, ap);
 297         } else {
 298                 plane->name = kasprintf(GFP_KERNEL, "plane-%d",
 299                                         drm_num_planes(dev));
 300         }
 301         if (!plane->name) {
 302                 kfree(plane->format_types);
 303                 kfree(plane->modifiers);
 304                 drm_mode_object_unregister(dev, &plane->base);
 305                 return -ENOMEM;
 306         }
 307
 308         memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
 309         plane->format_count = format_count;
 310         memcpy(plane->modifiers, format_modifiers,
 311                format_modifier_count * sizeof(format_modifiers[0]));
 312         plane->possible_crtcs = possible_crtcs;
 313         plane->type = type;
 314
 315         list_add_tail(&plane->head, &config->plane_list);
 316         plane->index = config->num_total_plane++;
 317
 318         drm_object_attach_property(&plane->base,
 319                                    config->plane_type_property,
 320                                    plane->type);
 321
 322         if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
 323                 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
 324                 drm_object_attach_property(&plane->base, config->prop_in_fence_fd, -1);
 325                 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
 326                 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
 327                 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
 328                 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
 329                 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
 330                 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
 331                 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
 332                 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
 333                 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
 334         }
 335
 336         if (config->allow_fb_modifiers)
 337                 create_in_format_blob(dev, plane);
 338
 339         return 0;
 340 }
 341
 342 /**
 343  * drm_universal_plane_init - Initialize a new universal plane object
 344  * @dev: DRM device
 345  * @plane: plane object to init
 346  * @possible_crtcs: bitmask of possible CRTCs
 347  * @funcs: callbacks for the new plane
 348  * @formats: array of supported formats (DRM_FORMAT\_\*)
 349  * @format_count: number of elements in @formats
 350  * @format_modifiers: array of struct drm_format modifiers terminated by
 351  *                    DRM_FORMAT_MOD_INVALID
 352  * @type: type of plane (overlay, primary, cursor)
 353  * @name: printf style format string for the plane name, or NULL for default name
 354  *
 355  * Initializes a plane object of type @type. The &drm_plane_funcs.destroy hook
 356  * should call drm_plane_cleanup() and kfree() the plane structure. The plane
 357  * structure should not be allocated with devm_kzalloc().
 358  *
 359  * Note: consider using drmm_universal_plane_alloc() instead of
 360  * drm_universal_plane_init() to let the DRM managed resource infrastructure
 361  * take care of cleanup and deallocation.
 362  *
 363  * Returns:
 364  * Zero on success, error code on failure.
 365  */
 366 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
 367                              uint32_t possible_crtcs,
 368                              const struct drm_plane_funcs *funcs,
 369                              const uint32_t *formats, unsigned int format_count,
 370                              const uint64_t *format_modifiers,
 371                              enum drm_plane_type type,
 372                              const char *name, ...)
 373 {
 374         va_list ap;
 375         int ret;
 376
 377         WARN_ON(!funcs->destroy);
 378
 379         va_start(ap, name);
 380         ret = __drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
 381                                          formats, format_count, format_modifiers,
 382                                          type, name, ap);
 383         va_end(ap);
 384         return ret;
 385 }
 386 EXPORT_SYMBOL(drm_universal_plane_init);
 387
 388 static void drmm_universal_plane_alloc_release(struct drm_device *dev, void *ptr)
 389 {
 390         struct drm_plane *plane = ptr;
 391
 392         if (WARN_ON(!plane->dev))
 393                 return;
 394
 395         drm_plane_cleanup(plane);
 396 }
 397
 398 void *__drmm_universal_plane_alloc(struct drm_device *dev, size_t size,
 399                                    size_t offset, uint32_t possible_crtcs,
 400                                    const struct drm_plane_funcs *funcs,
 401                                    const uint32_t *formats, unsigned int format_count,
 402                                    const uint64_t *format_modifiers,
 403                                    enum drm_plane_type type,
 404                                    const char *name, ...)
 405 {
 406         void *container;
 407         struct drm_plane *plane;
 408         va_list ap;
 409         int ret;
 410
 411         if (WARN_ON(!funcs || funcs->destroy))
 412                 return ERR_PTR(-EINVAL);
 413
 414         container = drmm_kzalloc(dev, size, GFP_KERNEL);
 415         if (!container)
 416                 return ERR_PTR(-ENOMEM);
 417
 418         plane = container + offset;
 419
 420         va_start(ap, name);
 421         ret = __drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
 422                                          formats, format_count, format_modifiers,
 423                                          type, name, ap);
 424         va_end(ap);
 425         if (ret)
 426                 return ERR_PTR(ret);
 427
 428         ret = drmm_add_action_or_reset(dev, drmm_universal_plane_alloc_release,
 429                                        plane);
 430         if (ret)
 431                 return ERR_PTR(ret);
 432
 433         return container;
 434 }
 435 EXPORT_SYMBOL(__drmm_universal_plane_alloc);
 436
 437 int drm_plane_register_all(struct drm_device *dev)
 438 {
 439         unsigned int num_planes = 0;
 440         unsigned int num_zpos = 0;
 441         struct drm_plane *plane;
 442         int ret = 0;
 443
 444         drm_for_each_plane(plane, dev) {
 445                 if (plane->funcs->late_register)
 446                         ret = plane->funcs->late_register(plane);
 447                 if (ret)
 448                         return ret;
 449
 450                 if (plane->zpos_property)
 451                         num_zpos++;
 452                 num_planes++;
 453         }
 454
 455         drm_WARN(dev, num_zpos && num_planes != num_zpos,
 456                  "Mixing planes with and without zpos property is invalid\n");
 457
 458         return 0;
 459 }
 460
 461 void drm_plane_unregister_all(struct drm_device *dev)
 462 {
 463         struct drm_plane *plane;
 464
 465         drm_for_each_plane(plane, dev) {
 466                 if (plane->funcs->early_unregister)
 467                         plane->funcs->early_unregister(plane);
 468         }
 469 }
 470
 471 /**
 472  * drm_plane_init - Initialize a legacy plane
 473  * @dev: DRM device
 474  * @plane: plane object to init
 475  * @possible_crtcs: bitmask of possible CRTCs
 476  * @funcs: callbacks for the new plane
 477  * @formats: array of supported formats (DRM_FORMAT\_\*)
 478  * @format_count: number of elements in @formats
 479  * @is_primary: plane type (primary vs overlay)
 480  *
 481  * Legacy API to initialize a DRM plane.
 482  *
 483  * New drivers should call drm_universal_plane_init() instead.
 484  *
 485  * Returns:
 486  * Zero on success, error code on failure.
 487  */
 488 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
 489                    uint32_t possible_crtcs,
 490                    const struct drm_plane_funcs *funcs,
 491                    const uint32_t *formats, unsigned int format_count,
 492                    bool is_primary)
 493 {
 494         enum drm_plane_type type;
 495
 496         type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
 497         return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
 498                                         formats, format_count,
 499                                         NULL, type, NULL);
 500 }
 501 EXPORT_SYMBOL(drm_plane_init);
 502
 503 /**
 504  * drm_plane_cleanup - Clean up the core plane usage
 505  * @plane: plane to cleanup
 506  *
 507  * This function cleans up @plane and removes it from the DRM mode setting
 508  * core. Note that the function does *not* free the plane structure itself,
 509  * this is the responsibility of the caller.
 510  */
 511 void drm_plane_cleanup(struct drm_plane *plane)
 512 {
 513         struct drm_device *dev = plane->dev;
 514
 515         drm_modeset_lock_fini(&plane->mutex);
 516
 517         kfree(plane->format_types);
 518         kfree(plane->modifiers);
 519         drm_mode_object_unregister(dev, &plane->base);
 520
 521         BUG_ON(list_empty(&plane->head));
 522
 523         /* Note that the plane_list is considered to be static; should we
 524          * remove the drm_plane at runtime we would have to decrement all
 525          * the indices on the drm_plane after us in the plane_list.
 526          */
 527
 528         list_del(&plane->head);
 529         dev->mode_config.num_total_plane--;
 530
 531         WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
 532         if (plane->state && plane->funcs->atomic_destroy_state)
 533                 plane->funcs->atomic_destroy_state(plane, plane->state);
 534
 535         kfree(plane->name);
 536
 537         memset(plane, 0, sizeof(*plane));
 538 }
 539 EXPORT_SYMBOL(drm_plane_cleanup);
 540
 541 /**
 542  * drm_plane_from_index - find the registered plane at an index
 543  * @dev: DRM device
 544  * @idx: index of registered plane to find for
 545  *
 546  * Given a plane index, return the registered plane from DRM device's
 547  * list of planes with matching index. This is the inverse of drm_plane_index().
 548  */
 549 struct drm_plane *
 550 drm_plane_from_index(struct drm_device *dev, int idx)
 551 {
 552         struct drm_plane *plane;
 553
 554         drm_for_each_plane(plane, dev)
 555                 if (idx == plane->index)
 556                         return plane;
 557
 558         return NULL;
 559 }
 560 EXPORT_SYMBOL(drm_plane_from_index);
 561
 562 /**
 563  * drm_plane_force_disable - Forcibly disable a plane
 564  * @plane: plane to disable
 565  *
 566  * Forces the plane to be disabled.
 567  *
 568  * Used when the plane's current framebuffer is destroyed,
 569  * and when restoring fbdev mode.
 570  *
 571  * Note that this function is not suitable for atomic drivers, since it doesn't
 572  * wire through the lock acquisition context properly and hence can't handle
 573  * retries or driver private locks. You probably want to use
 574  * drm_atomic_helper_disable_plane() or
 575  * drm_atomic_helper_disable_planes_on_crtc() instead.
 576  */
 577 void drm_plane_force_disable(struct drm_plane *plane)
 578 {
 579         int ret;
 580
 581         if (!plane->fb)
 582                 return;
 583
 584         WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
 585
 586         plane->old_fb = plane->fb;
 587         ret = plane->funcs->disable_plane(plane, NULL);
 588         if (ret) {
 589                 DRM_ERROR("failed to disable plane with busy fb\n");
 590                 plane->old_fb = NULL;
 591                 return;
 592         }
 593         /* disconnect the plane from the fb and crtc: */
 594         drm_framebuffer_put(plane->old_fb);
 595         plane->old_fb = NULL;
 596         plane->fb = NULL;
 597         plane->crtc = NULL;
 598 }
 599 EXPORT_SYMBOL(drm_plane_force_disable);
 600
 601 /**
 602  * drm_mode_plane_set_obj_prop - set the value of a property
 603  * @plane: drm plane object to set property value for
 604  * @property: property to set
 605  * @value: value the property should be set to
 606  *
 607  * This functions sets a given property on a given plane object. This function
 608  * calls the driver's ->set_property callback and changes the software state of
 609  * the property if the callback succeeds.
 610  *
 611  * Returns:
 612  * Zero on success, error code on failure.
 613  */
 614 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
 615                                 struct drm_property *property,
 616                                 uint64_t value)
 617 {
 618         int ret = -EINVAL;
 619         struct drm_mode_object *obj = &plane->base;
 620
 621         if (plane->funcs->set_property)
 622                 ret = plane->funcs->set_property(plane, property, value);
 623         if (!ret)
 624                 drm_object_property_set_value(obj, property, value);
 625
 626         return ret;
 627 }
 628 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
 629
 630 int drm_mode_getplane_res(struct drm_device *dev, void *data,
 631                           struct drm_file *file_priv)
 632 {
 633         struct drm_mode_get_plane_res *plane_resp = data;
 634         struct drm_plane *plane;
 635         uint32_t __user *plane_ptr;
 636         int count = 0;
 637
 638         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 639                 return -EOPNOTSUPP;
 640
 641         plane_ptr = u64_to_user_ptr(plane_resp->plane_id_ptr);
 642
 643         /*
 644          * This ioctl is called twice, once to determine how much space is
 645          * needed, and the 2nd time to fill it.
 646          */
 647         drm_for_each_plane(plane, dev) {
 648                 /*
 649                  * Unless userspace set the 'universal planes'
 650                  * capability bit, only advertise overlays.
 651                  */
 652                 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
 653                     !file_priv->universal_planes)
 654                         continue;
 655
 656                 if (drm_lease_held(file_priv, plane->base.id)) {
 657                         if (count < plane_resp->count_planes &&
 658                             put_user(plane->base.id, plane_ptr + count))
 659                                 return -EFAULT;
 660                         count++;
 661                 }
 662         }
 663         plane_resp->count_planes = count;
 664
 665         return 0;
 666 }
 667
 668 int drm_mode_getplane(struct drm_device *dev, void *data,
 669                       struct drm_file *file_priv)
 670 {
 671         struct drm_mode_get_plane *plane_resp = data;
 672         struct drm_plane *plane;
 673         uint32_t __user *format_ptr;
 674
 675         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 676                 return -EOPNOTSUPP;
 677
 678         plane = drm_plane_find(dev, file_priv, plane_resp->plane_id);
 679         if (!plane)
 680                 return -ENOENT;
 681
 682         drm_modeset_lock(&plane->mutex, NULL);
 683         if (plane->state && plane->state->crtc && drm_lease_held(file_priv, plane->state->crtc->base.id))
 684                 plane_resp->crtc_id = plane->state->crtc->base.id;
 685         else if (!plane->state && plane->crtc && drm_lease_held(file_priv, plane->crtc->base.id))
 686                 plane_resp->crtc_id = plane->crtc->base.id;
 687         else
 688                 plane_resp->crtc_id = 0;
 689
 690         if (plane->state && plane->state->fb)
 691                 plane_resp->fb_id = plane->state->fb->base.id;
 692         else if (!plane->state && plane->fb)
 693                 plane_resp->fb_id = plane->fb->base.id;
 694         else
 695                 plane_resp->fb_id = 0;
 696         drm_modeset_unlock(&plane->mutex);
 697
 698         plane_resp->plane_id = plane->base.id;
 699         plane_resp->possible_crtcs = drm_lease_filter_crtcs(file_priv,
 700                                                             plane->possible_crtcs);
 701
 702         plane_resp->gamma_size = 0;
 703
 704         /*
 705          * This ioctl is called twice, once to determine how much space is
 706          * needed, and the 2nd time to fill it.
 707          */
 708         if (plane->format_count &&
 709             (plane_resp->count_format_types >= plane->format_count)) {
 710                 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
 711                 if (copy_to_user(format_ptr,
 712                                  plane->format_types,
 713                                  sizeof(uint32_t) * plane->format_count)) {
 714                         return -EFAULT;
 715                 }
 716         }
 717         plane_resp->count_format_types = plane->format_count;
 718
 719         return 0;
 720 }
 721
 722 int drm_plane_check_pixel_format(struct drm_plane *plane,
 723                                  u32 format, u64 modifier)
 724 {
 725         unsigned int i;
 726
 727         for (i = 0; i < plane->format_count; i++) {
 728                 if (format == plane->format_types[i])
 729                         break;
 730         }
 731         if (i == plane->format_count)
 732                 return -EINVAL;
 733
 734         if (plane->funcs->format_mod_supported) {
 735                 if (!plane->funcs->format_mod_supported(plane, format, modifier))
 736                         return -EINVAL;
 737         } else {
 738                 if (!plane->modifier_count)
 739                         return 0;
 740
 741                 for (i = 0; i < plane->modifier_count; i++) {
 742                         if (modifier == plane->modifiers[i])
 743                                 break;
 744                 }
 745                 if (i == plane->modifier_count)
 746                         return -EINVAL;
 747         }
 748
 749         return 0;
 750 }
 751
 752 static int __setplane_check(struct drm_plane *plane,
 753                             struct drm_crtc *crtc,
 754                             struct drm_framebuffer *fb,
 755                             int32_t crtc_x, int32_t crtc_y,
 756                             uint32_t crtc_w, uint32_t crtc_h,
 757                             uint32_t src_x, uint32_t src_y,
 758                             uint32_t src_w, uint32_t src_h)
 759 {
 760         int ret;
 761
 762         /* Check whether this plane is usable on this CRTC */
 763         if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
 764                 DRM_DEBUG_KMS("Invalid crtc for plane\n");
 765                 return -EINVAL;
 766         }
 767
 768         /* Check whether this plane supports the fb pixel format. */
 769         ret = drm_plane_check_pixel_format(plane, fb->format->format,
 770                                            fb->modifier);
 771         if (ret) {
 772                 DRM_DEBUG_KMS("Invalid pixel format %p4cc, modifier 0x%llx\n",
 773                               &fb->format->format, fb->modifier);
 774                 return ret;
 775         }
 776
 777         /* Give drivers some help against integer overflows */
 778         if (crtc_w > INT_MAX ||
 779             crtc_x > INT_MAX - (int32_t) crtc_w ||
 780             crtc_h > INT_MAX ||
 781             crtc_y > INT_MAX - (int32_t) crtc_h) {
 782                 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
 783                               crtc_w, crtc_h, crtc_x, crtc_y);
 784                 return -ERANGE;
 785         }
 786
 787         ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb);
 788         if (ret)
 789                 return ret;
 790
 791         return 0;
 792 }
 793
 794 /**
 795  * drm_any_plane_has_format - Check whether any plane supports this format and modifier combination
 796  * @dev: DRM device
 797  * @format: pixel format (DRM_FORMAT_*)
 798  * @modifier: data layout modifier
 799  *
 800  * Returns:
 801  * Whether at least one plane supports the specified format and modifier combination.
 802  */
 803 bool drm_any_plane_has_format(struct drm_device *dev,
 804                               u32 format, u64 modifier)
 805 {
 806         struct drm_plane *plane;
 807
 808         drm_for_each_plane(plane, dev) {
 809                 if (drm_plane_check_pixel_format(plane, format, modifier) == 0)
 810                         return true;
 811         }
 812
 813         return false;
 814 }
 815 EXPORT_SYMBOL(drm_any_plane_has_format);
 816
 817 /*
 818  * __setplane_internal - setplane handler for internal callers
 819  *
 820  * This function will take a reference on the new fb for the plane
 821  * on success.
 822  *
 823  * src_{x,y,w,h} are provided in 16.16 fixed point format
 824  */
 825 static int __setplane_internal(struct drm_plane *plane,
 826                                struct drm_crtc *crtc,
 827                                struct drm_framebuffer *fb,
 828                                int32_t crtc_x, int32_t crtc_y,
 829                                uint32_t crtc_w, uint32_t crtc_h,
 830                                /* src_{x,y,w,h} values are 16.16 fixed point */
 831                                uint32_t src_x, uint32_t src_y,
 832                                uint32_t src_w, uint32_t src_h,
 833                                struct drm_modeset_acquire_ctx *ctx)
 834 {
 835         int ret = 0;
 836
 837         WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
 838
 839         /* No fb means shut it down */
 840         if (!fb) {
 841                 plane->old_fb = plane->fb;
 842                 ret = plane->funcs->disable_plane(plane, ctx);
 843                 if (!ret) {
 844                         plane->crtc = NULL;
 845                         plane->fb = NULL;
 846                 } else {
 847                         plane->old_fb = NULL;
 848                 }
 849                 goto out;
 850         }
 851
 852         ret = __setplane_check(plane, crtc, fb,
 853                                crtc_x, crtc_y, crtc_w, crtc_h,
 854                                src_x, src_y, src_w, src_h);
 855         if (ret)
 856                 goto out;
 857
 858         plane->old_fb = plane->fb;
 859         ret = plane->funcs->update_plane(plane, crtc, fb,
 860                                          crtc_x, crtc_y, crtc_w, crtc_h,
 861                                          src_x, src_y, src_w, src_h, ctx);
 862         if (!ret) {
 863                 plane->crtc = crtc;
 864                 plane->fb = fb;
 865                 drm_framebuffer_get(plane->fb);
 866         } else {
 867                 plane->old_fb = NULL;
 868         }
 869
 870 out:
 871         if (plane->old_fb)
 872                 drm_framebuffer_put(plane->old_fb);
 873         plane->old_fb = NULL;
 874
 875         return ret;
 876 }
 877
 878 static int __setplane_atomic(struct drm_plane *plane,
 879                              struct drm_crtc *crtc,
 880                              struct drm_framebuffer *fb,
 881                              int32_t crtc_x, int32_t crtc_y,
 882                              uint32_t crtc_w, uint32_t crtc_h,
 883                              uint32_t src_x, uint32_t src_y,
 884                              uint32_t src_w, uint32_t src_h,
 885                              struct drm_modeset_acquire_ctx *ctx)
 886 {
 887         int ret;
 888
 889         WARN_ON(!drm_drv_uses_atomic_modeset(plane->dev));
 890
 891         /* No fb means shut it down */
 892         if (!fb)
 893                 return plane->funcs->disable_plane(plane, ctx);
 894
 895         /*
 896          * FIXME: This is redundant with drm_atomic_plane_check(),
 897          * but the legacy cursor/"async" .update_plane() tricks
 898          * don't call that so we still need this here. Should remove
 899          * this when all .update_plane() implementations have been
 900          * fixed to call drm_atomic_plane_check().
 901          */
 902         ret = __setplane_check(plane, crtc, fb,
 903                                crtc_x, crtc_y, crtc_w, crtc_h,
 904                                src_x, src_y, src_w, src_h);
 905         if (ret)
 906                 return ret;
 907
 908         return plane->funcs->update_plane(plane, crtc, fb,
 909                                           crtc_x, crtc_y, crtc_w, crtc_h,
 910                                           src_x, src_y, src_w, src_h, ctx);
 911 }
 912
 913 static int setplane_internal(struct drm_plane *plane,
 914                              struct drm_crtc *crtc,
 915                              struct drm_framebuffer *fb,
 916                              int32_t crtc_x, int32_t crtc_y,
 917                              uint32_t crtc_w, uint32_t crtc_h,
 918                              /* src_{x,y,w,h} values are 16.16 fixed point */
 919                              uint32_t src_x, uint32_t src_y,
 920                              uint32_t src_w, uint32_t src_h)
 921 {
 922         struct drm_modeset_acquire_ctx ctx;
 923         int ret;
 924
 925         DRM_MODESET_LOCK_ALL_BEGIN(plane->dev, ctx,
 926                                    DRM_MODESET_ACQUIRE_INTERRUPTIBLE, ret);
 927
 928         if (drm_drv_uses_atomic_modeset(plane->dev))
 929                 ret = __setplane_atomic(plane, crtc, fb,
 930                                         crtc_x, crtc_y, crtc_w, crtc_h,
 931                                         src_x, src_y, src_w, src_h, &ctx);
 932         else
 933                 ret = __setplane_internal(plane, crtc, fb,
 934                                           crtc_x, crtc_y, crtc_w, crtc_h,
 935                                           src_x, src_y, src_w, src_h, &ctx);
 936
 937         DRM_MODESET_LOCK_ALL_END(plane->dev, ctx, ret);
 938
 939         return ret;
 940 }
 941
 942 int drm_mode_setplane(struct drm_device *dev, void *data,
 943                       struct drm_file *file_priv)
 944 {
 945         struct drm_mode_set_plane *plane_req = data;
 946         struct drm_plane *plane;
 947         struct drm_crtc *crtc = NULL;
 948         struct drm_framebuffer *fb = NULL;
 949         int ret;
 950
 951         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 952                 return -EOPNOTSUPP;
 953
 954         /*
 955          * First, find the plane, crtc, and fb objects.  If not available,
 956          * we don't bother to call the driver.
 957          */
 958         plane = drm_plane_find(dev, file_priv, plane_req->plane_id);
 959         if (!plane) {
 960                 DRM_DEBUG_KMS("Unknown plane ID %d\n",
 961                               plane_req->plane_id);
 962                 return -ENOENT;
 963         }
 964
 965         if (plane_req->fb_id) {
 966                 fb = drm_framebuffer_lookup(dev, file_priv, plane_req->fb_id);
 967                 if (!fb) {
 968                         DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
 969                                       plane_req->fb_id);
 970                         return -ENOENT;
 971                 }
 972
 973                 crtc = drm_crtc_find(dev, file_priv, plane_req->crtc_id);
 974                 if (!crtc) {
 975                         drm_framebuffer_put(fb);
 976                         DRM_DEBUG_KMS("Unknown crtc ID %d\n",
 977                                       plane_req->crtc_id);
 978                         return -ENOENT;
 979                 }
 980         }
 981
 982         ret = setplane_internal(plane, crtc, fb,
 983                                 plane_req->crtc_x, plane_req->crtc_y,
 984                                 plane_req->crtc_w, plane_req->crtc_h,
 985                                 plane_req->src_x, plane_req->src_y,
 986                                 plane_req->src_w, plane_req->src_h);
 987
 988         if (fb)
 989                 drm_framebuffer_put(fb);
 990
 991         return ret;
 992 }
 993
 994 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
 995                                      struct drm_mode_cursor2 *req,
 996                                      struct drm_file *file_priv,
 997                                      struct drm_modeset_acquire_ctx *ctx)
 998 {
 999         struct drm_device *dev = crtc->dev;
1000         struct drm_plane *plane = crtc->cursor;
1001         struct drm_framebuffer *fb = NULL;
1002         struct drm_mode_fb_cmd2 fbreq = {
1003                 .width = req->width,
1004                 .height = req->height,
1005                 .pixel_format = DRM_FORMAT_ARGB8888,
1006                 .pitches = { req->width * 4 },
1007                 .handles = { req->handle },
1008         };
1009         int32_t crtc_x, crtc_y;
1010         uint32_t crtc_w = 0, crtc_h = 0;
1011         uint32_t src_w = 0, src_h = 0;
1012         int ret = 0;
1013
1014         BUG_ON(!plane);
1015         WARN_ON(plane->crtc != crtc && plane->crtc != NULL);
1016
1017         /*
1018          * Obtain fb we'll be using (either new or existing) and take an extra
1019          * reference to it if fb != null.  setplane will take care of dropping
1020          * the reference if the plane update fails.
1021          */
1022         if (req->flags & DRM_MODE_CURSOR_BO) {
1023                 if (req->handle) {
1024                         fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv);
1025                         if (IS_ERR(fb)) {
1026                                 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
1027                                 return PTR_ERR(fb);
1028                         }
1029
1030                         fb->hot_x = req->hot_x;
1031                         fb->hot_y = req->hot_y;
1032                 } else {
1033                         fb = NULL;
1034                 }
1035         } else {
1036                 if (plane->state)
1037                         fb = plane->state->fb;
1038                 else
1039                         fb = plane->fb;
1040
1041                 if (fb)
1042                         drm_framebuffer_get(fb);
1043         }
1044
1045         if (req->flags & DRM_MODE_CURSOR_MOVE) {
1046                 crtc_x = req->x;
1047                 crtc_y = req->y;
1048         } else {
1049                 crtc_x = crtc->cursor_x;
1050                 crtc_y = crtc->cursor_y;
1051         }
1052
1053         if (fb) {
1054                 crtc_w = fb->width;
1055                 crtc_h = fb->height;
1056                 src_w = fb->width << 16;
1057                 src_h = fb->height << 16;
1058         }
1059
1060         if (drm_drv_uses_atomic_modeset(dev))
1061                 ret = __setplane_atomic(plane, crtc, fb,
1062                                         crtc_x, crtc_y, crtc_w, crtc_h,
1063                                         0, 0, src_w, src_h, ctx);
1064         else
1065                 ret = __setplane_internal(plane, crtc, fb,
1066                                           crtc_x, crtc_y, crtc_w, crtc_h,
1067                                           0, 0, src_w, src_h, ctx);
1068
1069         if (fb)
1070                 drm_framebuffer_put(fb);
1071
1072         /* Update successful; save new cursor position, if necessary */
1073         if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
1074                 crtc->cursor_x = req->x;
1075                 crtc->cursor_y = req->y;
1076         }
1077
1078         return ret;
1079 }
1080
1081 static int drm_mode_cursor_common(struct drm_device *dev,
1082                                   struct drm_mode_cursor2 *req,
1083                                   struct drm_file *file_priv)
1084 {
1085         struct drm_crtc *crtc;
1086         struct drm_modeset_acquire_ctx ctx;
1087         int ret = 0;
1088
1089         if (!drm_core_check_feature(dev, DRIVER_MODESET))
1090                 return -EOPNOTSUPP;
1091
1092         if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
1093                 return -EINVAL;
1094
1095         crtc = drm_crtc_find(dev, file_priv, req->crtc_id);
1096         if (!crtc) {
1097                 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
1098                 return -ENOENT;
1099         }
1100
1101         drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
1102 retry:
1103         ret = drm_modeset_lock(&crtc->mutex, &ctx);
1104         if (ret)
1105                 goto out;
1106         /*
1107          * If this crtc has a universal cursor plane, call that plane's update
1108          * handler rather than using legacy cursor handlers.
1109          */
1110         if (crtc->cursor) {
1111                 ret = drm_modeset_lock(&crtc->cursor->mutex, &ctx);
1112                 if (ret)
1113                         goto out;
1114
1115                 if (!drm_lease_held(file_priv, crtc->cursor->base.id)) {
1116                         ret = -EACCES;
1117                         goto out;
1118                 }
1119
1120                 ret = drm_mode_cursor_universal(crtc, req, file_priv, &ctx);
1121                 goto out;
1122         }
1123
1124         if (req->flags & DRM_MODE_CURSOR_BO) {
1125                 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
1126                         ret = -ENXIO;
1127                         goto out;
1128                 }
1129                 /* Turns off the cursor if handle is 0 */
1130                 if (crtc->funcs->cursor_set2)
1131                         ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
1132                                                       req->width, req->height, req->hot_x, req->hot_y);
1133                 else
1134                         ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
1135                                                       req->width, req->height);
1136         }
1137
1138         if (req->flags & DRM_MODE_CURSOR_MOVE) {
1139                 if (crtc->funcs->cursor_move) {
1140                         ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
1141                 } else {
1142                         ret = -EFAULT;
1143                         goto out;
1144                 }
1145         }
1146 out:
1147         if (ret == -EDEADLK) {
1148                 ret = drm_modeset_backoff(&ctx);
1149                 if (!ret)
1150                         goto retry;
1151         }
1152
1153         drm_modeset_drop_locks(&ctx);
1154         drm_modeset_acquire_fini(&ctx);
1155
1156         return ret;
1157
1158 }
1159
1160
1161 int drm_mode_cursor_ioctl(struct drm_device *dev,
1162                           void *data, struct drm_file *file_priv)
1163 {
1164         struct drm_mode_cursor *req = data;
1165         struct drm_mode_cursor2 new_req;
1166
1167         memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
1168         new_req.hot_x = new_req.hot_y = 0;
1169
1170         return drm_mode_cursor_common(dev, &new_req, file_priv);
1171 }
1172
1173 /*
1174  * Set the cursor configuration based on user request. This implements the 2nd
1175  * version of the cursor ioctl, which allows userspace to additionally specify
1176  * the hotspot of the pointer.
1177  */
1178 int drm_mode_cursor2_ioctl(struct drm_device *dev,
1179                            void *data, struct drm_file *file_priv)
1180 {
1181         struct drm_mode_cursor2 *req = data;
1182
1183         return drm_mode_cursor_common(dev, req, file_priv);
1184 }
1185
1186 int drm_mode_page_flip_ioctl(struct drm_device *dev,
1187                              void *data, struct drm_file *file_priv)
1188 {
1189         struct drm_mode_crtc_page_flip_target *page_flip = data;
1190         struct drm_crtc *crtc;
1191         struct drm_plane *plane;
1192         struct drm_framebuffer *fb = NULL, *old_fb;
1193         struct drm_pending_vblank_event *e = NULL;
1194         u32 target_vblank = page_flip->sequence;
1195         struct drm_modeset_acquire_ctx ctx;
1196         int ret = -EINVAL;
1197
1198         if (!drm_core_check_feature(dev, DRIVER_MODESET))
1199                 return -EOPNOTSUPP;
1200
1201         if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS)
1202                 return -EINVAL;
1203
1204         if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET))
1205                 return -EINVAL;
1206
1207         /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
1208          * can be specified
1209          */
1210         if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET)
1211                 return -EINVAL;
1212
1213         if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
1214                 return -EINVAL;
1215
1216         crtc = drm_crtc_find(dev, file_priv, page_flip->crtc_id);
1217         if (!crtc)
1218                 return -ENOENT;
1219
1220         plane = crtc->primary;
1221
1222         if (!drm_lease_held(file_priv, plane->base.id))
1223                 return -EACCES;
1224
1225         if (crtc->funcs->page_flip_target) {
1226                 u32 current_vblank;
1227                 int r;
1228
1229                 r = drm_crtc_vblank_get(crtc);
1230                 if (r)
1231                         return r;
1232
1233                 current_vblank = (u32)drm_crtc_vblank_count(crtc);
1234
1235                 switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) {
1236                 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE:
1237                         if ((int)(target_vblank - current_vblank) > 1) {
1238                                 DRM_DEBUG("Invalid absolute flip target %u, "
1239                                           "must be <= %u\n", target_vblank,
1240                                           current_vblank + 1);
1241                                 drm_crtc_vblank_put(crtc);
1242                                 return -EINVAL;
1243                         }
1244                         break;
1245                 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE:
1246                         if (target_vblank != 0 && target_vblank != 1) {
1247                                 DRM_DEBUG("Invalid relative flip target %u, "
1248                                           "must be 0 or 1\n", target_vblank);
1249                                 drm_crtc_vblank_put(crtc);
1250                                 return -EINVAL;
1251                         }
1252                         target_vblank += current_vblank;
1253                         break;
1254                 default:
1255                         target_vblank = current_vblank +
1256                                 !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC);
1257                         break;
1258                 }
1259         } else if (crtc->funcs->page_flip == NULL ||
1260                    (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) {
1261                 return -EINVAL;
1262         }
1263
1264         drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
1265 retry:
1266         ret = drm_modeset_lock(&crtc->mutex, &ctx);
1267         if (ret)
1268                 goto out;
1269         ret = drm_modeset_lock(&plane->mutex, &ctx);
1270         if (ret)
1271                 goto out;
1272
1273         if (plane->state)
1274                 old_fb = plane->state->fb;
1275         else
1276                 old_fb = plane->fb;
1277
1278         if (old_fb == NULL) {
1279                 /* The framebuffer is currently unbound, presumably
1280                  * due to a hotplug event, that userspace has not
1281                  * yet discovered.
1282                  */
1283                 ret = -EBUSY;
1284                 goto out;
1285         }
1286
1287         fb = drm_framebuffer_lookup(dev, file_priv, page_flip->fb_id);
1288         if (!fb) {
1289                 ret = -ENOENT;
1290                 goto out;
1291         }
1292
1293         if (plane->state) {
1294                 const struct drm_plane_state *state = plane->state;
1295
1296                 ret = drm_framebuffer_check_src_coords(state->src_x,
1297                                                        state->src_y,
1298                                                        state->src_w,
1299                                                        state->src_h,
1300                                                        fb);
1301         } else {
1302                 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y,
1303                                               &crtc->mode, fb);
1304         }
1305         if (ret)
1306                 goto out;
1307
1308         /*
1309          * Only check the FOURCC format code, excluding modifiers. This is
1310          * enough for all legacy drivers. Atomic drivers have their own
1311          * checks in their ->atomic_check implementation, which will
1312          * return -EINVAL if any hw or driver constraint is violated due
1313          * to modifier changes.
1314          */
1315         if (old_fb->format->format != fb->format->format) {
1316                 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
1317                 ret = -EINVAL;
1318                 goto out;
1319         }
1320
1321         if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1322                 e = kzalloc(sizeof *e, GFP_KERNEL);
1323                 if (!e) {
1324                         ret = -ENOMEM;
1325                         goto out;
1326                 }
1327
1328                 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1329                 e->event.base.length = sizeof(e->event);
1330                 e->event.vbl.user_data = page_flip->user_data;
1331                 e->event.vbl.crtc_id = crtc->base.id;
1332
1333                 ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
1334                 if (ret) {
1335                         kfree(e);
1336                         e = NULL;
1337                         goto out;
1338                 }
1339         }
1340
1341         plane->old_fb = plane->fb;
1342         if (crtc->funcs->page_flip_target)
1343                 ret = crtc->funcs->page_flip_target(crtc, fb, e,
1344                                                     page_flip->flags,
1345                                                     target_vblank,
1346                                                     &ctx);
1347         else
1348                 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags,
1349                                              &ctx);
1350         if (ret) {
1351                 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT)
1352                         drm_event_cancel_free(dev, &e->base);
1353                 /* Keep the old fb, don't unref it. */
1354                 plane->old_fb = NULL;
1355         } else {
1356                 if (!plane->state) {
1357                         plane->fb = fb;
1358                         drm_framebuffer_get(fb);
1359                 }
1360         }
1361
1362 out:
1363         if (fb)
1364                 drm_framebuffer_put(fb);
1365         if (plane->old_fb)
1366                 drm_framebuffer_put(plane->old_fb);
1367         plane->old_fb = NULL;
1368
1369         if (ret == -EDEADLK) {
1370                 ret = drm_modeset_backoff(&ctx);
1371                 if (!ret)
1372                         goto retry;
1373         }
1374
1375         drm_modeset_drop_locks(&ctx);
1376         drm_modeset_acquire_fini(&ctx);
1377
1378         if (ret && crtc->funcs->page_flip_target)
1379                 drm_crtc_vblank_put(crtc);
1380
1381         return ret;
1382 }
1383
1384 struct drm_property *
1385 drm_create_scaling_filter_prop(struct drm_device *dev,
1386                                unsigned int supported_filters)
1387 {
1388         struct drm_property *prop;
1389         static const struct drm_prop_enum_list props[] = {
1390                 { DRM_SCALING_FILTER_DEFAULT, "Default" },
1391                 { DRM_SCALING_FILTER_NEAREST_NEIGHBOR, "Nearest Neighbor" },
1392         };
1393         unsigned int valid_mode_mask = BIT(DRM_SCALING_FILTER_DEFAULT) |
1394                                        BIT(DRM_SCALING_FILTER_NEAREST_NEIGHBOR);
1395         int i;
1396
1397         if (WARN_ON((supported_filters & ~valid_mode_mask) ||
1398                     ((supported_filters & BIT(DRM_SCALING_FILTER_DEFAULT)) == 0)))
1399                 return ERR_PTR(-EINVAL);
1400
1401         prop = drm_property_create(dev, DRM_MODE_PROP_ENUM,
1402                                    "SCALING_FILTER",
1403                                    hweight32(supported_filters));
1404         if (!prop)
1405                 return ERR_PTR(-ENOMEM);
1406
1407         for (i = 0; i < ARRAY_SIZE(props); i++) {
1408                 int ret;
1409
1410                 if (!(BIT(props[i].type) & supported_filters))
1411                         continue;
1412
1413                 ret = drm_property_add_enum(prop, props[i].type,
1414                                             props[i].name);
1415
1416                 if (ret) {
1417                         drm_property_destroy(dev, prop);
1418
1419                         return ERR_PTR(ret);
1420                 }
1421         }
1422
1423         return prop;
1424 }
1425
1426 /**
1427  * drm_plane_create_scaling_filter_property - create a new scaling filter
1428  * property
1429  *
1430  * @plane: drm plane
1431  * @supported_filters: bitmask of supported scaling filters, must include
1432  *                     BIT(DRM_SCALING_FILTER_DEFAULT).
1433  *
1434  * This function lets driver to enable the scaling filter property on a given
1435  * plane.
1436  *
1437  * RETURNS:
1438  * Zero for success or -errno
1439  */
1440 int drm_plane_create_scaling_filter_property(struct drm_plane *plane,
1441                                              unsigned int supported_filters)
1442 {
1443         struct drm_property *prop =
1444                 drm_create_scaling_filter_prop(plane->dev, supported_filters);
1445
1446         if (IS_ERR(prop))
1447                 return PTR_ERR(prop);
1448
1449         drm_object_attach_property(&plane->base, prop,
1450                                    DRM_SCALING_FILTER_DEFAULT);
1451         plane->scaling_filter_property = prop;
1452
1453         return 0;
1454 }
1455 EXPORT_SYMBOL(drm_plane_create_scaling_filter_property);