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