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