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_vblank.h>
  34
  35 #include "drm_crtc_internal.h"
  36
  37 /**
  38  * DOC: overview
  39  *
  40  * A plane represents an image source that can be blended with or overlayed on
  41  * top of a CRTC during the scanout process. Planes take their input data from a
  42  * &drm_framebuffer object. The plane itself specifies the cropping and scaling
  43  * of that image, and where it is placed on the visible are of a display
  44  * pipeline, represented by &drm_crtc. A plane can also have additional
  45  * properties that specify how the pixels are positioned and blended, like
  46  * rotation or Z-position. All these properties are stored in &drm_plane_state.
  47  *
  48  * To create a plane, a KMS drivers allocates and zeroes an instances of
  49  * &struct drm_plane (possibly as part of a larger structure) and registers it
  50  * with a call to drm_universal_plane_init().
  51  *
  52  * Cursor and overlay planes are optional. All drivers should provide one
  53  * primary plane per CRTC to avoid surprising userspace too much. See enum
  54  * drm_plane_type for a more in-depth discussion of these special uapi-relevant
  55  * plane types. Special planes are associated with their CRTC by calling
  56  * drm_crtc_init_with_planes().
  57  *
  58  * The type of a plane is exposed in the immutable "type" enumeration property,
  59  * which has one of the following values: "Overlay", "Primary", "Cursor".
  60  */
  61
  62 static unsigned int drm_num_planes(struct drm_device *dev)
  63 {
  64         unsigned int num = 0;
  65         struct drm_plane *tmp;
  66
  67         drm_for_each_plane(tmp, dev) {
  68                 num++;
  69         }
  70
  71         return num;
  72 }
  73
  74 static inline u32 *
  75 formats_ptr(struct drm_format_modifier_blob *blob)
  76 {
  77         return (u32 *)(((char *)blob) + blob->formats_offset);
  78 }
  79
  80 static inline struct drm_format_modifier *
  81 modifiers_ptr(struct drm_format_modifier_blob *blob)
  82 {
  83         return (struct drm_format_modifier *)(((char *)blob) + blob->modifiers_offset);
  84 }
  85
  86 static int create_in_format_blob(struct drm_device *dev, struct drm_plane *plane)
  87 {
  88         const struct drm_mode_config *config = &dev->mode_config;
  89         struct drm_property_blob *blob;
  90         struct drm_format_modifier *mod;
  91         size_t blob_size, formats_size, modifiers_size;
  92         struct drm_format_modifier_blob *blob_data;
  93         unsigned int i, j;
  94
  95         formats_size = sizeof(__u32) * plane->format_count;
  96         if (WARN_ON(!formats_size)) {
  97                 /* 0 formats are never expected */
  98                 return 0;
  99         }
 100
 101         modifiers_size =
 102                 sizeof(struct drm_format_modifier) * plane->modifier_count;
 103
 104         blob_size = sizeof(struct drm_format_modifier_blob);
 105         /* Modifiers offset is a pointer to a struct with a 64 bit field so it
 106          * should be naturally aligned to 8B.
 107          */
 108         BUILD_BUG_ON(sizeof(struct drm_format_modifier_blob) % 8);
 109         blob_size += ALIGN(formats_size, 8);
 110         blob_size += modifiers_size;
 111
 112         blob = drm_property_create_blob(dev, blob_size, NULL);
 113         if (IS_ERR(blob))
 114                 return -1;
 115
 116         blob_data = blob->data;
 117         blob_data->version = FORMAT_BLOB_CURRENT;
 118         blob_data->count_formats = plane->format_count;
 119         blob_data->formats_offset = sizeof(struct drm_format_modifier_blob);
 120         blob_data->count_modifiers = plane->modifier_count;
 121
 122         blob_data->modifiers_offset =
 123                 ALIGN(blob_data->formats_offset + formats_size, 8);
 124
 125         memcpy(formats_ptr(blob_data), plane->format_types, formats_size);
 126
 127         /* If we can't determine support, just bail */
 128         if (!plane->funcs->format_mod_supported)
 129                 goto done;
 130
 131         mod = modifiers_ptr(blob_data);
 132         for (i = 0; i < plane->modifier_count; i++) {
 133                 for (j = 0; j < plane->format_count; j++) {
 134                         if (plane->funcs->format_mod_supported(plane,
 135                                                                plane->format_types[j],
 136                                                                plane->modifiers[i])) {
 137
 138                                 mod->formats |= 1ULL << j;
 139                         }
 140                 }
 141
 142                 mod->modifier = plane->modifiers[i];
 143                 mod->offset = 0;
 144                 mod->pad = 0;
 145                 mod++;
 146         }
 147
 148 done:
 149         drm_object_attach_property(&plane->base, config->modifiers_property,
 150                                    blob->base.id);
 151
 152         return 0;
 153 }
 154
 155 /**
 156  * drm_universal_plane_init - Initialize a new universal plane object
 157  * @dev: DRM device
 158  * @plane: plane object to init
 159  * @possible_crtcs: bitmask of possible CRTCs
 160  * @funcs: callbacks for the new plane
 161  * @formats: array of supported formats (DRM_FORMAT\_\*)
 162  * @format_count: number of elements in @formats
 163  * @format_modifiers: array of struct drm_format modifiers terminated by
 164  *                    DRM_FORMAT_MOD_INVALID
 165  * @type: type of plane (overlay, primary, cursor)
 166  * @name: printf style format string for the plane name, or NULL for default name
 167  *
 168  * Initializes a plane object of type @type.
 169  *
 170  * Returns:
 171  * Zero on success, error code on failure.
 172  */
 173 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
 174                              uint32_t possible_crtcs,
 175                              const struct drm_plane_funcs *funcs,
 176                              const uint32_t *formats, unsigned int format_count,
 177                              const uint64_t *format_modifiers,
 178                              enum drm_plane_type type,
 179                              const char *name, ...)
 180 {
 181         struct drm_mode_config *config = &dev->mode_config;
 182         unsigned int format_modifier_count = 0;
 183         int ret;
 184
 185         /* plane index is used with 32bit bitmasks */
 186         if (WARN_ON(config->num_total_plane >= 32))
 187                 return -EINVAL;
 188
 189         WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
 190                 (!funcs->atomic_destroy_state ||
 191                  !funcs->atomic_duplicate_state));
 192
 193         ret = drm_mode_object_add(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
 194         if (ret)
 195                 return ret;
 196
 197         drm_modeset_lock_init(&plane->mutex);
 198
 199         plane->base.properties = &plane->properties;
 200         plane->dev = dev;
 201         plane->funcs = funcs;
 202         plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
 203                                             GFP_KERNEL);
 204         if (!plane->format_types) {
 205                 DRM_DEBUG_KMS("out of memory when allocating plane\n");
 206                 drm_mode_object_unregister(dev, &plane->base);
 207                 return -ENOMEM;
 208         }
 209
 210         /*
 211          * First driver to need more than 64 formats needs to fix this. Each
 212          * format is encoded as a bit and the current code only supports a u64.
 213          */
 214         if (WARN_ON(format_count > 64))
 215                 return -EINVAL;
 216
 217         if (format_modifiers) {
 218                 const uint64_t *temp_modifiers = format_modifiers;
 219                 while (*temp_modifiers++ != DRM_FORMAT_MOD_INVALID)
 220                         format_modifier_count++;
 221         }
 222
 223         if (format_modifier_count)
 224                 config->allow_fb_modifiers = true;
 225
 226         plane->modifier_count = format_modifier_count;
 227         plane->modifiers = kmalloc_array(format_modifier_count,
 228                                          sizeof(format_modifiers[0]),
 229                                          GFP_KERNEL);
 230
 231         if (format_modifier_count && !plane->modifiers) {
 232                 DRM_DEBUG_KMS("out of memory when allocating plane\n");
 233                 kfree(plane->format_types);
 234                 drm_mode_object_unregister(dev, &plane->base);
 235                 return -ENOMEM;
 236         }
 237
 238         if (name) {
 239                 va_list ap;
 240
 241                 va_start(ap, name);
 242                 plane->name = kvasprintf(GFP_KERNEL, name, ap);
 243                 va_end(ap);
 244         } else {
 245                 plane->name = kasprintf(GFP_KERNEL, "plane-%d",
 246                                         drm_num_planes(dev));
 247         }
 248         if (!plane->name) {
 249                 kfree(plane->format_types);
 250                 kfree(plane->modifiers);
 251                 drm_mode_object_unregister(dev, &plane->base);
 252                 return -ENOMEM;
 253         }
 254
 255         memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
 256         plane->format_count = format_count;
 257         memcpy(plane->modifiers, format_modifiers,
 258                format_modifier_count * sizeof(format_modifiers[0]));
 259         plane->possible_crtcs = possible_crtcs;
 260         plane->type = type;
 261
 262         list_add_tail(&plane->head, &config->plane_list);
 263         plane->index = config->num_total_plane++;
 264
 265         drm_object_attach_property(&plane->base,
 266                                    config->plane_type_property,
 267                                    plane->type);
 268
 269         if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
 270                 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
 271                 drm_object_attach_property(&plane->base, config->prop_in_fence_fd, -1);
 272                 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
 273                 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
 274                 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
 275                 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
 276                 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
 277                 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
 278                 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
 279                 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
 280                 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
 281         }
 282
 283         if (config->allow_fb_modifiers)
 284                 create_in_format_blob(dev, plane);
 285
 286         return 0;
 287 }
 288 EXPORT_SYMBOL(drm_universal_plane_init);
 289
 290 int drm_plane_register_all(struct drm_device *dev)
 291 {
 292         unsigned int num_planes = 0;
 293         unsigned int num_zpos = 0;
 294         struct drm_plane *plane;
 295         int ret = 0;
 296
 297         drm_for_each_plane(plane, dev) {
 298                 if (plane->funcs->late_register)
 299                         ret = plane->funcs->late_register(plane);
 300                 if (ret)
 301                         return ret;
 302
 303                 if (plane->zpos_property)
 304                         num_zpos++;
 305                 num_planes++;
 306         }
 307
 308         drm_WARN(dev, num_zpos && num_planes != num_zpos,
 309                  "Mixing planes with and without zpos property is invalid\n");
 310
 311         return 0;
 312 }
 313
 314 void drm_plane_unregister_all(struct drm_device *dev)
 315 {
 316         struct drm_plane *plane;
 317
 318         drm_for_each_plane(plane, dev) {
 319                 if (plane->funcs->early_unregister)
 320                         plane->funcs->early_unregister(plane);
 321         }
 322 }
 323
 324 /**
 325  * drm_plane_init - Initialize a legacy plane
 326  * @dev: DRM device
 327  * @plane: plane object to init
 328  * @possible_crtcs: bitmask of possible CRTCs
 329  * @funcs: callbacks for the new plane
 330  * @formats: array of supported formats (DRM_FORMAT\_\*)
 331  * @format_count: number of elements in @formats
 332  * @is_primary: plane type (primary vs overlay)
 333  *
 334  * Legacy API to initialize a DRM plane.
 335  *
 336  * New drivers should call drm_universal_plane_init() instead.
 337  *
 338  * Returns:
 339  * Zero on success, error code on failure.
 340  */
 341 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
 342                    uint32_t possible_crtcs,
 343                    const struct drm_plane_funcs *funcs,
 344                    const uint32_t *formats, unsigned int format_count,
 345                    bool is_primary)
 346 {
 347         enum drm_plane_type type;
 348
 349         type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
 350         return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
 351                                         formats, format_count,
 352                                         NULL, type, NULL);
 353 }
 354 EXPORT_SYMBOL(drm_plane_init);
 355
 356 /**
 357  * drm_plane_cleanup - Clean up the core plane usage
 358  * @plane: plane to cleanup
 359  *
 360  * This function cleans up @plane and removes it from the DRM mode setting
 361  * core. Note that the function does *not* free the plane structure itself,
 362  * this is the responsibility of the caller.
 363  */
 364 void drm_plane_cleanup(struct drm_plane *plane)
 365 {
 366         struct drm_device *dev = plane->dev;
 367
 368         drm_modeset_lock_fini(&plane->mutex);
 369
 370         kfree(plane->format_types);
 371         kfree(plane->modifiers);
 372         drm_mode_object_unregister(dev, &plane->base);
 373
 374         BUG_ON(list_empty(&plane->head));
 375
 376         /* Note that the plane_list is considered to be static; should we
 377          * remove the drm_plane at runtime we would have to decrement all
 378          * the indices on the drm_plane after us in the plane_list.
 379          */
 380
 381         list_del(&plane->head);
 382         dev->mode_config.num_total_plane--;
 383
 384         WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
 385         if (plane->state && plane->funcs->atomic_destroy_state)
 386                 plane->funcs->atomic_destroy_state(plane, plane->state);
 387
 388         kfree(plane->name);
 389
 390         memset(plane, 0, sizeof(*plane));
 391 }
 392 EXPORT_SYMBOL(drm_plane_cleanup);
 393
 394 /**
 395  * drm_plane_from_index - find the registered plane at an index
 396  * @dev: DRM device
 397  * @idx: index of registered plane to find for
 398  *
 399  * Given a plane index, return the registered plane from DRM device's
 400  * list of planes with matching index. This is the inverse of drm_plane_index().
 401  */
 402 struct drm_plane *
 403 drm_plane_from_index(struct drm_device *dev, int idx)
 404 {
 405         struct drm_plane *plane;
 406
 407         drm_for_each_plane(plane, dev)
 408                 if (idx == plane->index)
 409                         return plane;
 410
 411         return NULL;
 412 }
 413 EXPORT_SYMBOL(drm_plane_from_index);
 414
 415 /**
 416  * drm_plane_force_disable - Forcibly disable a plane
 417  * @plane: plane to disable
 418  *
 419  * Forces the plane to be disabled.
 420  *
 421  * Used when the plane's current framebuffer is destroyed,
 422  * and when restoring fbdev mode.
 423  *
 424  * Note that this function is not suitable for atomic drivers, since it doesn't
 425  * wire through the lock acquisition context properly and hence can't handle
 426  * retries or driver private locks. You probably want to use
 427  * drm_atomic_helper_disable_plane() or
 428  * drm_atomic_helper_disable_planes_on_crtc() instead.
 429  */
 430 void drm_plane_force_disable(struct drm_plane *plane)
 431 {
 432         int ret;
 433
 434         if (!plane->fb)
 435                 return;
 436
 437         WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
 438
 439         plane->old_fb = plane->fb;
 440         ret = plane->funcs->disable_plane(plane, NULL);
 441         if (ret) {
 442                 DRM_ERROR("failed to disable plane with busy fb\n");
 443                 plane->old_fb = NULL;
 444                 return;
 445         }
 446         /* disconnect the plane from the fb and crtc: */
 447         drm_framebuffer_put(plane->old_fb);
 448         plane->old_fb = NULL;
 449         plane->fb = NULL;
 450         plane->crtc = NULL;
 451 }
 452 EXPORT_SYMBOL(drm_plane_force_disable);
 453
 454 /**
 455  * drm_mode_plane_set_obj_prop - set the value of a property
 456  * @plane: drm plane object to set property value for
 457  * @property: property to set
 458  * @value: value the property should be set to
 459  *
 460  * This functions sets a given property on a given plane object. This function
 461  * calls the driver's ->set_property callback and changes the software state of
 462  * the property if the callback succeeds.
 463  *
 464  * Returns:
 465  * Zero on success, error code on failure.
 466  */
 467 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
 468                                 struct drm_property *property,
 469                                 uint64_t value)
 470 {
 471         int ret = -EINVAL;
 472         struct drm_mode_object *obj = &plane->base;
 473
 474         if (plane->funcs->set_property)
 475                 ret = plane->funcs->set_property(plane, property, value);
 476         if (!ret)
 477                 drm_object_property_set_value(obj, property, value);
 478
 479         return ret;
 480 }
 481 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
 482
 483 int drm_mode_getplane_res(struct drm_device *dev, void *data,
 484                           struct drm_file *file_priv)
 485 {
 486         struct drm_mode_get_plane_res *plane_resp = data;
 487         struct drm_plane *plane;
 488         uint32_t __user *plane_ptr;
 489         int count = 0;
 490
 491         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 492                 return -EOPNOTSUPP;
 493
 494         plane_ptr = u64_to_user_ptr(plane_resp->plane_id_ptr);
 495
 496         /*
 497          * This ioctl is called twice, once to determine how much space is
 498          * needed, and the 2nd time to fill it.
 499          */
 500         drm_for_each_plane(plane, dev) {
 501                 /*
 502                  * Unless userspace set the 'universal planes'
 503                  * capability bit, only advertise overlays.
 504                  */
 505                 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
 506                     !file_priv->universal_planes)
 507                         continue;
 508
 509                 if (drm_lease_held(file_priv, plane->base.id)) {
 510                         if (count < plane_resp->count_planes &&
 511                             put_user(plane->base.id, plane_ptr + count))
 512                                 return -EFAULT;
 513                         count++;
 514                 }
 515         }
 516         plane_resp->count_planes = count;
 517
 518         return 0;
 519 }
 520
 521 int drm_mode_getplane(struct drm_device *dev, void *data,
 522                       struct drm_file *file_priv)
 523 {
 524         struct drm_mode_get_plane *plane_resp = data;
 525         struct drm_plane *plane;
 526         uint32_t __user *format_ptr;
 527
 528         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 529                 return -EOPNOTSUPP;
 530
 531         plane = drm_plane_find(dev, file_priv, plane_resp->plane_id);
 532         if (!plane)
 533                 return -ENOENT;
 534
 535         drm_modeset_lock(&plane->mutex, NULL);
 536         if (plane->state && plane->state->crtc && drm_lease_held(file_priv, plane->state->crtc->base.id))
 537                 plane_resp->crtc_id = plane->state->crtc->base.id;
 538         else if (!plane->state && plane->crtc && drm_lease_held(file_priv, plane->crtc->base.id))
 539                 plane_resp->crtc_id = plane->crtc->base.id;
 540         else
 541                 plane_resp->crtc_id = 0;
 542
 543         if (plane->state && plane->state->fb)
 544                 plane_resp->fb_id = plane->state->fb->base.id;
 545         else if (!plane->state && plane->fb)
 546                 plane_resp->fb_id = plane->fb->base.id;
 547         else
 548                 plane_resp->fb_id = 0;
 549         drm_modeset_unlock(&plane->mutex);
 550
 551         plane_resp->plane_id = plane->base.id;
 552         plane_resp->possible_crtcs = drm_lease_filter_crtcs(file_priv,
 553                                                             plane->possible_crtcs);
 554
 555         plane_resp->gamma_size = 0;
 556
 557         /*
 558          * This ioctl is called twice, once to determine how much space is
 559          * needed, and the 2nd time to fill it.
 560          */
 561         if (plane->format_count &&
 562             (plane_resp->count_format_types >= plane->format_count)) {
 563                 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
 564                 if (copy_to_user(format_ptr,
 565                                  plane->format_types,
 566                                  sizeof(uint32_t) * plane->format_count)) {
 567                         return -EFAULT;
 568                 }
 569         }
 570         plane_resp->count_format_types = plane->format_count;
 571
 572         return 0;
 573 }
 574
 575 int drm_plane_check_pixel_format(struct drm_plane *plane,
 576                                  u32 format, u64 modifier)
 577 {
 578         unsigned int i;
 579
 580         for (i = 0; i < plane->format_count; i++) {
 581                 if (format == plane->format_types[i])
 582                         break;
 583         }
 584         if (i == plane->format_count)
 585                 return -EINVAL;
 586
 587         if (plane->funcs->format_mod_supported) {
 588                 if (!plane->funcs->format_mod_supported(plane, format, modifier))
 589                         return -EINVAL;
 590         } else {
 591                 if (!plane->modifier_count)
 592                         return 0;
 593
 594                 for (i = 0; i < plane->modifier_count; i++) {
 595                         if (modifier == plane->modifiers[i])
 596                                 break;
 597                 }
 598                 if (i == plane->modifier_count)
 599                         return -EINVAL;
 600         }
 601
 602         return 0;
 603 }
 604
 605 static int __setplane_check(struct drm_plane *plane,
 606                             struct drm_crtc *crtc,
 607                             struct drm_framebuffer *fb,
 608                             int32_t crtc_x, int32_t crtc_y,
 609                             uint32_t crtc_w, uint32_t crtc_h,
 610                             uint32_t src_x, uint32_t src_y,
 611                             uint32_t src_w, uint32_t src_h)
 612 {
 613         int ret;
 614
 615         /* Check whether this plane is usable on this CRTC */
 616         if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
 617                 DRM_DEBUG_KMS("Invalid crtc for plane\n");
 618                 return -EINVAL;
 619         }
 620
 621         /* Check whether this plane supports the fb pixel format. */
 622         ret = drm_plane_check_pixel_format(plane, fb->format->format,
 623                                            fb->modifier);
 624         if (ret) {
 625                 struct drm_format_name_buf format_name;
 626
 627                 DRM_DEBUG_KMS("Invalid pixel format %s, modifier 0x%llx\n",
 628                               drm_get_format_name(fb->format->format,
 629                                                   &format_name),
 630                               fb->modifier);
 631                 return ret;
 632         }
 633
 634         /* Give drivers some help against integer overflows */
 635         if (crtc_w > INT_MAX ||
 636             crtc_x > INT_MAX - (int32_t) crtc_w ||
 637             crtc_h > INT_MAX ||
 638             crtc_y > INT_MAX - (int32_t) crtc_h) {
 639                 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
 640                               crtc_w, crtc_h, crtc_x, crtc_y);
 641                 return -ERANGE;
 642         }
 643
 644         ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb);
 645         if (ret)
 646                 return ret;
 647
 648         return 0;
 649 }
 650
 651 /**
 652  * drm_any_plane_has_format - Check whether any plane supports this format and modifier combination
 653  * @dev: DRM device
 654  * @format: pixel format (DRM_FORMAT_*)
 655  * @modifier: data layout modifier
 656  *
 657  * Returns:
 658  * Whether at least one plane supports the specified format and modifier combination.
 659  */
 660 bool drm_any_plane_has_format(struct drm_device *dev,
 661                               u32 format, u64 modifier)
 662 {
 663         struct drm_plane *plane;
 664
 665         drm_for_each_plane(plane, dev) {
 666                 if (drm_plane_check_pixel_format(plane, format, modifier) == 0)
 667                         return true;
 668         }
 669
 670         return false;
 671 }
 672 EXPORT_SYMBOL(drm_any_plane_has_format);
 673
 674 /*
 675  * __setplane_internal - setplane handler for internal callers
 676  *
 677  * This function will take a reference on the new fb for the plane
 678  * on success.
 679  *
 680  * src_{x,y,w,h} are provided in 16.16 fixed point format
 681  */
 682 static int __setplane_internal(struct drm_plane *plane,
 683                                struct drm_crtc *crtc,
 684                                struct drm_framebuffer *fb,
 685                                int32_t crtc_x, int32_t crtc_y,
 686                                uint32_t crtc_w, uint32_t crtc_h,
 687                                /* src_{x,y,w,h} values are 16.16 fixed point */
 688                                uint32_t src_x, uint32_t src_y,
 689                                uint32_t src_w, uint32_t src_h,
 690                                struct drm_modeset_acquire_ctx *ctx)
 691 {
 692         int ret = 0;
 693
 694         WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
 695
 696         /* No fb means shut it down */
 697         if (!fb) {
 698                 plane->old_fb = plane->fb;
 699                 ret = plane->funcs->disable_plane(plane, ctx);
 700                 if (!ret) {
 701                         plane->crtc = NULL;
 702                         plane->fb = NULL;
 703                 } else {
 704                         plane->old_fb = NULL;
 705                 }
 706                 goto out;
 707         }
 708
 709         ret = __setplane_check(plane, crtc, fb,
 710                                crtc_x, crtc_y, crtc_w, crtc_h,
 711                                src_x, src_y, src_w, src_h);
 712         if (ret)
 713                 goto out;
 714
 715         plane->old_fb = plane->fb;
 716         ret = plane->funcs->update_plane(plane, crtc, fb,
 717                                          crtc_x, crtc_y, crtc_w, crtc_h,
 718                                          src_x, src_y, src_w, src_h, ctx);
 719         if (!ret) {
 720                 plane->crtc = crtc;
 721                 plane->fb = fb;
 722                 drm_framebuffer_get(plane->fb);
 723         } else {
 724                 plane->old_fb = NULL;
 725         }
 726
 727 out:
 728         if (plane->old_fb)
 729                 drm_framebuffer_put(plane->old_fb);
 730         plane->old_fb = NULL;
 731
 732         return ret;
 733 }
 734
 735 static int __setplane_atomic(struct drm_plane *plane,
 736                              struct drm_crtc *crtc,
 737                              struct drm_framebuffer *fb,
 738                              int32_t crtc_x, int32_t crtc_y,
 739                              uint32_t crtc_w, uint32_t crtc_h,
 740                              uint32_t src_x, uint32_t src_y,
 741                              uint32_t src_w, uint32_t src_h,
 742                              struct drm_modeset_acquire_ctx *ctx)
 743 {
 744         int ret;
 745
 746         WARN_ON(!drm_drv_uses_atomic_modeset(plane->dev));
 747
 748         /* No fb means shut it down */
 749         if (!fb)
 750                 return plane->funcs->disable_plane(plane, ctx);
 751
 752         /*
 753          * FIXME: This is redundant with drm_atomic_plane_check(),
 754          * but the legacy cursor/"async" .update_plane() tricks
 755          * don't call that so we still need this here. Should remove
 756          * this when all .update_plane() implementations have been
 757          * fixed to call drm_atomic_plane_check().
 758          */
 759         ret = __setplane_check(plane, crtc, fb,
 760                                crtc_x, crtc_y, crtc_w, crtc_h,
 761                                src_x, src_y, src_w, src_h);
 762         if (ret)
 763                 return ret;
 764
 765         return plane->funcs->update_plane(plane, crtc, fb,
 766                                           crtc_x, crtc_y, crtc_w, crtc_h,
 767                                           src_x, src_y, src_w, src_h, ctx);
 768 }
 769
 770 static int setplane_internal(struct drm_plane *plane,
 771                              struct drm_crtc *crtc,
 772                              struct drm_framebuffer *fb,
 773                              int32_t crtc_x, int32_t crtc_y,
 774                              uint32_t crtc_w, uint32_t crtc_h,
 775                              /* src_{x,y,w,h} values are 16.16 fixed point */
 776                              uint32_t src_x, uint32_t src_y,
 777                              uint32_t src_w, uint32_t src_h)
 778 {
 779         struct drm_modeset_acquire_ctx ctx;
 780         int ret;
 781
 782         DRM_MODESET_LOCK_ALL_BEGIN(plane->dev, ctx,
 783                                    DRM_MODESET_ACQUIRE_INTERRUPTIBLE, ret);
 784
 785         if (drm_drv_uses_atomic_modeset(plane->dev))
 786                 ret = __setplane_atomic(plane, crtc, fb,
 787                                         crtc_x, crtc_y, crtc_w, crtc_h,
 788                                         src_x, src_y, src_w, src_h, &ctx);
 789         else
 790                 ret = __setplane_internal(plane, crtc, fb,
 791                                           crtc_x, crtc_y, crtc_w, crtc_h,
 792                                           src_x, src_y, src_w, src_h, &ctx);
 793
 794         DRM_MODESET_LOCK_ALL_END(ctx, ret);
 795
 796         return ret;
 797 }
 798
 799 int drm_mode_setplane(struct drm_device *dev, void *data,
 800                       struct drm_file *file_priv)
 801 {
 802         struct drm_mode_set_plane *plane_req = data;
 803         struct drm_plane *plane;
 804         struct drm_crtc *crtc = NULL;
 805         struct drm_framebuffer *fb = NULL;
 806         int ret;
 807
 808         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 809                 return -EOPNOTSUPP;
 810
 811         /*
 812          * First, find the plane, crtc, and fb objects.  If not available,
 813          * we don't bother to call the driver.
 814          */
 815         plane = drm_plane_find(dev, file_priv, plane_req->plane_id);
 816         if (!plane) {
 817                 DRM_DEBUG_KMS("Unknown plane ID %d\n",
 818                               plane_req->plane_id);
 819                 return -ENOENT;
 820         }
 821
 822         if (plane_req->fb_id) {
 823                 fb = drm_framebuffer_lookup(dev, file_priv, plane_req->fb_id);
 824                 if (!fb) {
 825                         DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
 826                                       plane_req->fb_id);
 827                         return -ENOENT;
 828                 }
 829
 830                 crtc = drm_crtc_find(dev, file_priv, plane_req->crtc_id);
 831                 if (!crtc) {
 832                         drm_framebuffer_put(fb);
 833                         DRM_DEBUG_KMS("Unknown crtc ID %d\n",
 834                                       plane_req->crtc_id);
 835                         return -ENOENT;
 836                 }
 837         }
 838
 839         ret = setplane_internal(plane, crtc, fb,
 840                                 plane_req->crtc_x, plane_req->crtc_y,
 841                                 plane_req->crtc_w, plane_req->crtc_h,
 842                                 plane_req->src_x, plane_req->src_y,
 843                                 plane_req->src_w, plane_req->src_h);
 844
 845         if (fb)
 846                 drm_framebuffer_put(fb);
 847
 848         return ret;
 849 }
 850
 851 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
 852                                      struct drm_mode_cursor2 *req,
 853                                      struct drm_file *file_priv,
 854                                      struct drm_modeset_acquire_ctx *ctx)
 855 {
 856         struct drm_device *dev = crtc->dev;
 857         struct drm_plane *plane = crtc->cursor;
 858         struct drm_framebuffer *fb = NULL;
 859         struct drm_mode_fb_cmd2 fbreq = {
 860                 .width = req->width,
 861                 .height = req->height,
 862                 .pixel_format = DRM_FORMAT_ARGB8888,
 863                 .pitches = { req->width * 4 },
 864                 .handles = { req->handle },
 865         };
 866         int32_t crtc_x, crtc_y;
 867         uint32_t crtc_w = 0, crtc_h = 0;
 868         uint32_t src_w = 0, src_h = 0;
 869         int ret = 0;
 870
 871         BUG_ON(!plane);
 872         WARN_ON(plane->crtc != crtc && plane->crtc != NULL);
 873
 874         /*
 875          * Obtain fb we'll be using (either new or existing) and take an extra
 876          * reference to it if fb != null.  setplane will take care of dropping
 877          * the reference if the plane update fails.
 878          */
 879         if (req->flags & DRM_MODE_CURSOR_BO) {
 880                 if (req->handle) {
 881                         fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv);
 882                         if (IS_ERR(fb)) {
 883                                 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
 884                                 return PTR_ERR(fb);
 885                         }
 886
 887                         fb->hot_x = req->hot_x;
 888                         fb->hot_y = req->hot_y;
 889                 } else {
 890                         fb = NULL;
 891                 }
 892         } else {
 893                 if (plane->state)
 894                         fb = plane->state->fb;
 895                 else
 896                         fb = plane->fb;
 897
 898                 if (fb)
 899                         drm_framebuffer_get(fb);
 900         }
 901
 902         if (req->flags & DRM_MODE_CURSOR_MOVE) {
 903                 crtc_x = req->x;
 904                 crtc_y = req->y;
 905         } else {
 906                 crtc_x = crtc->cursor_x;
 907                 crtc_y = crtc->cursor_y;
 908         }
 909
 910         if (fb) {
 911                 crtc_w = fb->width;
 912                 crtc_h = fb->height;
 913                 src_w = fb->width << 16;
 914                 src_h = fb->height << 16;
 915         }
 916
 917         if (drm_drv_uses_atomic_modeset(dev))
 918                 ret = __setplane_atomic(plane, crtc, fb,
 919                                         crtc_x, crtc_y, crtc_w, crtc_h,
 920                                         0, 0, src_w, src_h, ctx);
 921         else
 922                 ret = __setplane_internal(plane, crtc, fb,
 923                                           crtc_x, crtc_y, crtc_w, crtc_h,
 924                                           0, 0, src_w, src_h, ctx);
 925
 926         if (fb)
 927                 drm_framebuffer_put(fb);
 928
 929         /* Update successful; save new cursor position, if necessary */
 930         if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
 931                 crtc->cursor_x = req->x;
 932                 crtc->cursor_y = req->y;
 933         }
 934
 935         return ret;
 936 }
 937
 938 static int drm_mode_cursor_common(struct drm_device *dev,
 939                                   struct drm_mode_cursor2 *req,
 940                                   struct drm_file *file_priv)
 941 {
 942         struct drm_crtc *crtc;
 943         struct drm_modeset_acquire_ctx ctx;
 944         int ret = 0;
 945
 946         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 947                 return -EOPNOTSUPP;
 948
 949         if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
 950                 return -EINVAL;
 951
 952         crtc = drm_crtc_find(dev, file_priv, req->crtc_id);
 953         if (!crtc) {
 954                 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
 955                 return -ENOENT;
 956         }
 957
 958         drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
 959 retry:
 960         ret = drm_modeset_lock(&crtc->mutex, &ctx);
 961         if (ret)
 962                 goto out;
 963         /*
 964          * If this crtc has a universal cursor plane, call that plane's update
 965          * handler rather than using legacy cursor handlers.
 966          */
 967         if (crtc->cursor) {
 968                 ret = drm_modeset_lock(&crtc->cursor->mutex, &ctx);
 969                 if (ret)
 970                         goto out;
 971
 972                 if (!drm_lease_held(file_priv, crtc->cursor->base.id)) {
 973                         ret = -EACCES;
 974                         goto out;
 975                 }
 976
 977                 ret = drm_mode_cursor_universal(crtc, req, file_priv, &ctx);
 978                 goto out;
 979         }
 980
 981         if (req->flags & DRM_MODE_CURSOR_BO) {
 982                 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
 983                         ret = -ENXIO;
 984                         goto out;
 985                 }
 986                 /* Turns off the cursor if handle is 0 */
 987                 if (crtc->funcs->cursor_set2)
 988                         ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
 989                                                       req->width, req->height, req->hot_x, req->hot_y);
 990                 else
 991                         ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
 992                                                       req->width, req->height);
 993         }
 994
 995         if (req->flags & DRM_MODE_CURSOR_MOVE) {
 996                 if (crtc->funcs->cursor_move) {
 997                         ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
 998                 } else {
 999                         ret = -EFAULT;
1000                         goto out;
1001                 }
1002         }
1003 out:
1004         if (ret == -EDEADLK) {
1005                 ret = drm_modeset_backoff(&ctx);
1006                 if (!ret)
1007                         goto retry;
1008         }
1009
1010         drm_modeset_drop_locks(&ctx);
1011         drm_modeset_acquire_fini(&ctx);
1012
1013         return ret;
1014
1015 }
1016
1017
1018 int drm_mode_cursor_ioctl(struct drm_device *dev,
1019                           void *data, struct drm_file *file_priv)
1020 {
1021         struct drm_mode_cursor *req = data;
1022         struct drm_mode_cursor2 new_req;
1023
1024         memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
1025         new_req.hot_x = new_req.hot_y = 0;
1026
1027         return drm_mode_cursor_common(dev, &new_req, file_priv);
1028 }
1029
1030 /*
1031  * Set the cursor configuration based on user request. This implements the 2nd
1032  * version of the cursor ioctl, which allows userspace to additionally specify
1033  * the hotspot of the pointer.
1034  */
1035 int drm_mode_cursor2_ioctl(struct drm_device *dev,
1036                            void *data, struct drm_file *file_priv)
1037 {
1038         struct drm_mode_cursor2 *req = data;
1039
1040         return drm_mode_cursor_common(dev, req, file_priv);
1041 }
1042
1043 int drm_mode_page_flip_ioctl(struct drm_device *dev,
1044                              void *data, struct drm_file *file_priv)
1045 {
1046         struct drm_mode_crtc_page_flip_target *page_flip = data;
1047         struct drm_crtc *crtc;
1048         struct drm_plane *plane;
1049         struct drm_framebuffer *fb = NULL, *old_fb;
1050         struct drm_pending_vblank_event *e = NULL;
1051         u32 target_vblank = page_flip->sequence;
1052         struct drm_modeset_acquire_ctx ctx;
1053         int ret = -EINVAL;
1054
1055         if (!drm_core_check_feature(dev, DRIVER_MODESET))
1056                 return -EOPNOTSUPP;
1057
1058         if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS)
1059                 return -EINVAL;
1060
1061         if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET))
1062                 return -EINVAL;
1063
1064         /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
1065          * can be specified
1066          */
1067         if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET)
1068                 return -EINVAL;
1069
1070         if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
1071                 return -EINVAL;
1072
1073         crtc = drm_crtc_find(dev, file_priv, page_flip->crtc_id);
1074         if (!crtc)
1075                 return -ENOENT;
1076
1077         plane = crtc->primary;
1078
1079         if (!drm_lease_held(file_priv, plane->base.id))
1080                 return -EACCES;
1081
1082         if (crtc->funcs->page_flip_target) {
1083                 u32 current_vblank;
1084                 int r;
1085
1086                 r = drm_crtc_vblank_get(crtc);
1087                 if (r)
1088                         return r;
1089
1090                 current_vblank = (u32)drm_crtc_vblank_count(crtc);
1091
1092                 switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) {
1093                 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE:
1094                         if ((int)(target_vblank - current_vblank) > 1) {
1095                                 DRM_DEBUG("Invalid absolute flip target %u, "
1096                                           "must be <= %u\n", target_vblank,
1097                                           current_vblank + 1);
1098                                 drm_crtc_vblank_put(crtc);
1099                                 return -EINVAL;
1100                         }
1101                         break;
1102                 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE:
1103                         if (target_vblank != 0 && target_vblank != 1) {
1104                                 DRM_DEBUG("Invalid relative flip target %u, "
1105                                           "must be 0 or 1\n", target_vblank);
1106                                 drm_crtc_vblank_put(crtc);
1107                                 return -EINVAL;
1108                         }
1109                         target_vblank += current_vblank;
1110                         break;
1111                 default:
1112                         target_vblank = current_vblank +
1113                                 !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC);
1114                         break;
1115                 }
1116         } else if (crtc->funcs->page_flip == NULL ||
1117                    (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) {
1118                 return -EINVAL;
1119         }
1120
1121         drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
1122 retry:
1123         ret = drm_modeset_lock(&crtc->mutex, &ctx);
1124         if (ret)
1125                 goto out;
1126         ret = drm_modeset_lock(&plane->mutex, &ctx);
1127         if (ret)
1128                 goto out;
1129
1130         if (plane->state)
1131                 old_fb = plane->state->fb;
1132         else
1133                 old_fb = plane->fb;
1134
1135         if (old_fb == NULL) {
1136                 /* The framebuffer is currently unbound, presumably
1137                  * due to a hotplug event, that userspace has not
1138                  * yet discovered.
1139                  */
1140                 ret = -EBUSY;
1141                 goto out;
1142         }
1143
1144         fb = drm_framebuffer_lookup(dev, file_priv, page_flip->fb_id);
1145         if (!fb) {
1146                 ret = -ENOENT;
1147                 goto out;
1148         }
1149
1150         if (plane->state) {
1151                 const struct drm_plane_state *state = plane->state;
1152
1153                 ret = drm_framebuffer_check_src_coords(state->src_x,
1154                                                        state->src_y,
1155                                                        state->src_w,
1156                                                        state->src_h,
1157                                                        fb);
1158         } else {
1159                 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y,
1160                                               &crtc->mode, fb);
1161         }
1162         if (ret)
1163                 goto out;
1164
1165         if (old_fb->format != fb->format) {
1166                 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
1167                 ret = -EINVAL;
1168                 goto out;
1169         }
1170
1171         if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1172                 e = kzalloc(sizeof *e, GFP_KERNEL);
1173                 if (!e) {
1174                         ret = -ENOMEM;
1175                         goto out;
1176                 }
1177
1178                 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1179                 e->event.base.length = sizeof(e->event);
1180                 e->event.vbl.user_data = page_flip->user_data;
1181                 e->event.vbl.crtc_id = crtc->base.id;
1182
1183                 ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
1184                 if (ret) {
1185                         kfree(e);
1186                         e = NULL;
1187                         goto out;
1188                 }
1189         }
1190
1191         plane->old_fb = plane->fb;
1192         if (crtc->funcs->page_flip_target)
1193                 ret = crtc->funcs->page_flip_target(crtc, fb, e,
1194                                                     page_flip->flags,
1195                                                     target_vblank,
1196                                                     &ctx);
1197         else
1198                 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags,
1199                                              &ctx);
1200         if (ret) {
1201                 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT)
1202                         drm_event_cancel_free(dev, &e->base);
1203                 /* Keep the old fb, don't unref it. */
1204                 plane->old_fb = NULL;
1205         } else {
1206                 if (!plane->state) {
1207                         plane->fb = fb;
1208                         drm_framebuffer_get(fb);
1209                 }
1210         }
1211
1212 out:
1213         if (fb)
1214                 drm_framebuffer_put(fb);
1215         if (plane->old_fb)
1216                 drm_framebuffer_put(plane->old_fb);
1217         plane->old_fb = NULL;
1218
1219         if (ret == -EDEADLK) {
1220                 ret = drm_modeset_backoff(&ctx);
1221                 if (!ret)
1222                         goto retry;
1223         }
1224
1225         drm_modeset_drop_locks(&ctx);
1226         drm_modeset_acquire_fini(&ctx);
1227
1228         if (ret && crtc->funcs->page_flip_target)
1229                 drm_crtc_vblank_put(crtc);
1230
1231         return ret;
1232 }