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 = (struct drm_format_modifier_blob *)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         ret = drm_mode_object_add(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
 177         if (ret)
 178                 return ret;
 179
 180         drm_modeset_lock_init(&plane->mutex);
 181
 182         plane->base.properties = &plane->properties;
 183         plane->dev = dev;
 184         plane->funcs = funcs;
 185         plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
 186                                             GFP_KERNEL);
 187         if (!plane->format_types) {
 188                 DRM_DEBUG_KMS("out of memory when allocating plane\n");
 189                 drm_mode_object_unregister(dev, &plane->base);
 190                 return -ENOMEM;
 191         }
 192
 193         /*
 194          * First driver to need more than 64 formats needs to fix this. Each
 195          * format is encoded as a bit and the current code only supports a u64.
 196          */
 197         if (WARN_ON(format_count > 64))
 198                 return -EINVAL;
 199
 200         if (format_modifiers) {
 201                 const uint64_t *temp_modifiers = format_modifiers;
 202                 while (*temp_modifiers++ != DRM_FORMAT_MOD_INVALID)
 203                         format_modifier_count++;
 204         }
 205
 206         plane->modifier_count = format_modifier_count;
 207         plane->modifiers = kmalloc_array(format_modifier_count,
 208                                          sizeof(format_modifiers[0]),
 209                                          GFP_KERNEL);
 210
 211         if (format_modifier_count && !plane->modifiers) {
 212                 DRM_DEBUG_KMS("out of memory when allocating plane\n");
 213                 kfree(plane->format_types);
 214                 drm_mode_object_unregister(dev, &plane->base);
 215                 return -ENOMEM;
 216         }
 217
 218         if (name) {
 219                 va_list ap;
 220
 221                 va_start(ap, name);
 222                 plane->name = kvasprintf(GFP_KERNEL, name, ap);
 223                 va_end(ap);
 224         } else {
 225                 plane->name = kasprintf(GFP_KERNEL, "plane-%d",
 226                                         drm_num_planes(dev));
 227         }
 228         if (!plane->name) {
 229                 kfree(plane->format_types);
 230                 kfree(plane->modifiers);
 231                 drm_mode_object_unregister(dev, &plane->base);
 232                 return -ENOMEM;
 233         }
 234
 235         memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
 236         plane->format_count = format_count;
 237         memcpy(plane->modifiers, format_modifiers,
 238                format_modifier_count * sizeof(format_modifiers[0]));
 239         plane->possible_crtcs = possible_crtcs;
 240         plane->type = type;
 241
 242         list_add_tail(&plane->head, &config->plane_list);
 243         plane->index = config->num_total_plane++;
 244
 245         drm_object_attach_property(&plane->base,
 246                                    config->plane_type_property,
 247                                    plane->type);
 248
 249         if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
 250                 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
 251                 drm_object_attach_property(&plane->base, config->prop_in_fence_fd, -1);
 252                 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
 253                 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
 254                 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
 255                 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
 256                 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
 257                 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
 258                 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
 259                 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
 260                 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
 261         }
 262
 263         if (config->allow_fb_modifiers)
 264                 create_in_format_blob(dev, plane);
 265
 266         return 0;
 267 }
 268 EXPORT_SYMBOL(drm_universal_plane_init);
 269
 270 int drm_plane_register_all(struct drm_device *dev)
 271 {
 272         struct drm_plane *plane;
 273         int ret = 0;
 274
 275         drm_for_each_plane(plane, dev) {
 276                 if (plane->funcs->late_register)
 277                         ret = plane->funcs->late_register(plane);
 278                 if (ret)
 279                         return ret;
 280         }
 281
 282         return 0;
 283 }
 284
 285 void drm_plane_unregister_all(struct drm_device *dev)
 286 {
 287         struct drm_plane *plane;
 288
 289         drm_for_each_plane(plane, dev) {
 290                 if (plane->funcs->early_unregister)
 291                         plane->funcs->early_unregister(plane);
 292         }
 293 }
 294
 295 /**
 296  * drm_plane_init - Initialize a legacy plane
 297  * @dev: DRM device
 298  * @plane: plane object to init
 299  * @possible_crtcs: bitmask of possible CRTCs
 300  * @funcs: callbacks for the new plane
 301  * @formats: array of supported formats (DRM_FORMAT\_\*)
 302  * @format_count: number of elements in @formats
 303  * @is_primary: plane type (primary vs overlay)
 304  *
 305  * Legacy API to initialize a DRM plane.
 306  *
 307  * New drivers should call drm_universal_plane_init() instead.
 308  *
 309  * Returns:
 310  * Zero on success, error code on failure.
 311  */
 312 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
 313                    uint32_t possible_crtcs,
 314                    const struct drm_plane_funcs *funcs,
 315                    const uint32_t *formats, unsigned int format_count,
 316                    bool is_primary)
 317 {
 318         enum drm_plane_type type;
 319
 320         type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
 321         return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
 322                                         formats, format_count,
 323                                         NULL, type, NULL);
 324 }
 325 EXPORT_SYMBOL(drm_plane_init);
 326
 327 /**
 328  * drm_plane_cleanup - Clean up the core plane usage
 329  * @plane: plane to cleanup
 330  *
 331  * This function cleans up @plane and removes it from the DRM mode setting
 332  * core. Note that the function does *not* free the plane structure itself,
 333  * this is the responsibility of the caller.
 334  */
 335 void drm_plane_cleanup(struct drm_plane *plane)
 336 {
 337         struct drm_device *dev = plane->dev;
 338
 339         drm_modeset_lock_fini(&plane->mutex);
 340
 341         kfree(plane->format_types);
 342         kfree(plane->modifiers);
 343         drm_mode_object_unregister(dev, &plane->base);
 344
 345         BUG_ON(list_empty(&plane->head));
 346
 347         /* Note that the plane_list is considered to be static; should we
 348          * remove the drm_plane at runtime we would have to decrement all
 349          * the indices on the drm_plane after us in the plane_list.
 350          */
 351
 352         list_del(&plane->head);
 353         dev->mode_config.num_total_plane--;
 354
 355         WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
 356         if (plane->state && plane->funcs->atomic_destroy_state)
 357                 plane->funcs->atomic_destroy_state(plane, plane->state);
 358
 359         kfree(plane->name);
 360
 361         memset(plane, 0, sizeof(*plane));
 362 }
 363 EXPORT_SYMBOL(drm_plane_cleanup);
 364
 365 /**
 366  * drm_plane_from_index - find the registered plane at an index
 367  * @dev: DRM device
 368  * @idx: index of registered plane to find for
 369  *
 370  * Given a plane index, return the registered plane from DRM device's
 371  * list of planes with matching index. This is the inverse of drm_plane_index().
 372  */
 373 struct drm_plane *
 374 drm_plane_from_index(struct drm_device *dev, int idx)
 375 {
 376         struct drm_plane *plane;
 377
 378         drm_for_each_plane(plane, dev)
 379                 if (idx == plane->index)
 380                         return plane;
 381
 382         return NULL;
 383 }
 384 EXPORT_SYMBOL(drm_plane_from_index);
 385
 386 /**
 387  * drm_plane_force_disable - Forcibly disable a plane
 388  * @plane: plane to disable
 389  *
 390  * Forces the plane to be disabled.
 391  *
 392  * Used when the plane's current framebuffer is destroyed,
 393  * and when restoring fbdev mode.
 394  *
 395  * Note that this function is not suitable for atomic drivers, since it doesn't
 396  * wire through the lock acquisition context properly and hence can't handle
 397  * retries or driver private locks. You probably want to use
 398  * drm_atomic_helper_disable_plane() or
 399  * drm_atomic_helper_disable_planes_on_crtc() instead.
 400  */
 401 void drm_plane_force_disable(struct drm_plane *plane)
 402 {
 403         int ret;
 404
 405         if (!plane->fb)
 406                 return;
 407
 408         WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
 409
 410         plane->old_fb = plane->fb;
 411         ret = plane->funcs->disable_plane(plane, NULL);
 412         if (ret) {
 413                 DRM_ERROR("failed to disable plane with busy fb\n");
 414                 plane->old_fb = NULL;
 415                 return;
 416         }
 417         /* disconnect the plane from the fb and crtc: */
 418         drm_framebuffer_put(plane->old_fb);
 419         plane->old_fb = NULL;
 420         plane->fb = NULL;
 421         plane->crtc = NULL;
 422 }
 423 EXPORT_SYMBOL(drm_plane_force_disable);
 424
 425 /**
 426  * drm_mode_plane_set_obj_prop - set the value of a property
 427  * @plane: drm plane object to set property value for
 428  * @property: property to set
 429  * @value: value the property should be set to
 430  *
 431  * This functions sets a given property on a given plane object. This function
 432  * calls the driver's ->set_property callback and changes the software state of
 433  * the property if the callback succeeds.
 434  *
 435  * Returns:
 436  * Zero on success, error code on failure.
 437  */
 438 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
 439                                 struct drm_property *property,
 440                                 uint64_t value)
 441 {
 442         int ret = -EINVAL;
 443         struct drm_mode_object *obj = &plane->base;
 444
 445         if (plane->funcs->set_property)
 446                 ret = plane->funcs->set_property(plane, property, value);
 447         if (!ret)
 448                 drm_object_property_set_value(obj, property, value);
 449
 450         return ret;
 451 }
 452 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
 453
 454 int drm_mode_getplane_res(struct drm_device *dev, void *data,
 455                           struct drm_file *file_priv)
 456 {
 457         struct drm_mode_get_plane_res *plane_resp = data;
 458         struct drm_mode_config *config;
 459         struct drm_plane *plane;
 460         uint32_t __user *plane_ptr;
 461         int count = 0;
 462
 463         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 464                 return -EINVAL;
 465
 466         config = &dev->mode_config;
 467         plane_ptr = u64_to_user_ptr(plane_resp->plane_id_ptr);
 468
 469         /*
 470          * This ioctl is called twice, once to determine how much space is
 471          * needed, and the 2nd time to fill it.
 472          */
 473         drm_for_each_plane(plane, dev) {
 474                 /*
 475                  * Unless userspace set the 'universal planes'
 476                  * capability bit, only advertise overlays.
 477                  */
 478                 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
 479                     !file_priv->universal_planes)
 480                         continue;
 481
 482                 if (count < plane_resp->count_planes &&
 483                     put_user(plane->base.id, plane_ptr + count))
 484                         return -EFAULT;
 485                 count++;
 486         }
 487         plane_resp->count_planes = count;
 488
 489         return 0;
 490 }
 491
 492 int drm_mode_getplane(struct drm_device *dev, void *data,
 493                       struct drm_file *file_priv)
 494 {
 495         struct drm_mode_get_plane *plane_resp = data;
 496         struct drm_plane *plane;
 497         uint32_t __user *format_ptr;
 498
 499         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 500                 return -EINVAL;
 501
 502         plane = drm_plane_find(dev, file_priv, plane_resp->plane_id);
 503         if (!plane)
 504                 return -ENOENT;
 505
 506         drm_modeset_lock(&plane->mutex, NULL);
 507         if (plane->state && plane->state->crtc)
 508                 plane_resp->crtc_id = plane->state->crtc->base.id;
 509         else if (!plane->state && plane->crtc)
 510                 plane_resp->crtc_id = plane->crtc->base.id;
 511         else
 512                 plane_resp->crtc_id = 0;
 513
 514         if (plane->state && plane->state->fb)
 515                 plane_resp->fb_id = plane->state->fb->base.id;
 516         else if (!plane->state && plane->fb)
 517                 plane_resp->fb_id = plane->fb->base.id;
 518         else
 519                 plane_resp->fb_id = 0;
 520         drm_modeset_unlock(&plane->mutex);
 521
 522         plane_resp->plane_id = plane->base.id;
 523         plane_resp->possible_crtcs = plane->possible_crtcs;
 524         plane_resp->gamma_size = 0;
 525
 526         /*
 527          * This ioctl is called twice, once to determine how much space is
 528          * needed, and the 2nd time to fill it.
 529          */
 530         if (plane->format_count &&
 531             (plane_resp->count_format_types >= plane->format_count)) {
 532                 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
 533                 if (copy_to_user(format_ptr,
 534                                  plane->format_types,
 535                                  sizeof(uint32_t) * plane->format_count)) {
 536                         return -EFAULT;
 537                 }
 538         }
 539         plane_resp->count_format_types = plane->format_count;
 540
 541         return 0;
 542 }
 543
 544 int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
 545 {
 546         unsigned int i;
 547
 548         for (i = 0; i < plane->format_count; i++) {
 549                 if (format == plane->format_types[i])
 550                         return 0;
 551         }
 552
 553         return -EINVAL;
 554 }
 555
 556 /*
 557  * setplane_internal - setplane handler for internal callers
 558  *
 559  * Note that we assume an extra reference has already been taken on fb.  If the
 560  * update fails, this reference will be dropped before return; if it succeeds,
 561  * the previous framebuffer (if any) will be unreferenced instead.
 562  *
 563  * src_{x,y,w,h} are provided in 16.16 fixed point format
 564  */
 565 static int __setplane_internal(struct drm_plane *plane,
 566                                struct drm_crtc *crtc,
 567                                struct drm_framebuffer *fb,
 568                                int32_t crtc_x, int32_t crtc_y,
 569                                uint32_t crtc_w, uint32_t crtc_h,
 570                                /* src_{x,y,w,h} values are 16.16 fixed point */
 571                                uint32_t src_x, uint32_t src_y,
 572                                uint32_t src_w, uint32_t src_h,
 573                                struct drm_modeset_acquire_ctx *ctx)
 574 {
 575         int ret = 0;
 576
 577         /* No fb means shut it down */
 578         if (!fb) {
 579                 plane->old_fb = plane->fb;
 580                 ret = plane->funcs->disable_plane(plane, ctx);
 581                 if (!ret) {
 582                         plane->crtc = NULL;
 583                         plane->fb = NULL;
 584                 } else {
 585                         plane->old_fb = NULL;
 586                 }
 587                 goto out;
 588         }
 589
 590         /* Check whether this plane is usable on this CRTC */
 591         if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
 592                 DRM_DEBUG_KMS("Invalid crtc for plane\n");
 593                 ret = -EINVAL;
 594                 goto out;
 595         }
 596
 597         /* Check whether this plane supports the fb pixel format. */
 598         ret = drm_plane_check_pixel_format(plane, fb->format->format);
 599         if (ret) {
 600                 struct drm_format_name_buf format_name;
 601                 DRM_DEBUG_KMS("Invalid pixel format %s\n",
 602                               drm_get_format_name(fb->format->format,
 603                                                   &format_name));
 604                 goto out;
 605         }
 606
 607         /* Give drivers some help against integer overflows */
 608         if (crtc_w > INT_MAX ||
 609             crtc_x > INT_MAX - (int32_t) crtc_w ||
 610             crtc_h > INT_MAX ||
 611             crtc_y > INT_MAX - (int32_t) crtc_h) {
 612                 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
 613                               crtc_w, crtc_h, crtc_x, crtc_y);
 614                 ret = -ERANGE;
 615                 goto out;
 616         }
 617
 618         ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb);
 619         if (ret)
 620                 goto out;
 621
 622         plane->old_fb = plane->fb;
 623         ret = plane->funcs->update_plane(plane, crtc, fb,
 624                                          crtc_x, crtc_y, crtc_w, crtc_h,
 625                                          src_x, src_y, src_w, src_h, ctx);
 626         if (!ret) {
 627                 plane->crtc = crtc;
 628                 plane->fb = fb;
 629                 fb = NULL;
 630         } else {
 631                 plane->old_fb = NULL;
 632         }
 633
 634 out:
 635         if (fb)
 636                 drm_framebuffer_put(fb);
 637         if (plane->old_fb)
 638                 drm_framebuffer_put(plane->old_fb);
 639         plane->old_fb = NULL;
 640
 641         return ret;
 642 }
 643
 644 static int setplane_internal(struct drm_plane *plane,
 645                              struct drm_crtc *crtc,
 646                              struct drm_framebuffer *fb,
 647                              int32_t crtc_x, int32_t crtc_y,
 648                              uint32_t crtc_w, uint32_t crtc_h,
 649                              /* src_{x,y,w,h} values are 16.16 fixed point */
 650                              uint32_t src_x, uint32_t src_y,
 651                              uint32_t src_w, uint32_t src_h)
 652 {
 653         struct drm_modeset_acquire_ctx ctx;
 654         int ret;
 655
 656         drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
 657 retry:
 658         ret = drm_modeset_lock_all_ctx(plane->dev, &ctx);
 659         if (ret)
 660                 goto fail;
 661         ret = __setplane_internal(plane, crtc, fb,
 662                                   crtc_x, crtc_y, crtc_w, crtc_h,
 663                                   src_x, src_y, src_w, src_h, &ctx);
 664
 665 fail:
 666         if (ret == -EDEADLK) {
 667                 ret = drm_modeset_backoff(&ctx);
 668                 if (!ret)
 669                         goto retry;
 670         }
 671         drm_modeset_drop_locks(&ctx);
 672         drm_modeset_acquire_fini(&ctx);
 673
 674         return ret;
 675 }
 676
 677 int drm_mode_setplane(struct drm_device *dev, void *data,
 678                       struct drm_file *file_priv)
 679 {
 680         struct drm_mode_set_plane *plane_req = data;
 681         struct drm_plane *plane;
 682         struct drm_crtc *crtc = NULL;
 683         struct drm_framebuffer *fb = NULL;
 684
 685         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 686                 return -EINVAL;
 687
 688         /*
 689          * First, find the plane, crtc, and fb objects.  If not available,
 690          * we don't bother to call the driver.
 691          */
 692         plane = drm_plane_find(dev, file_priv, plane_req->plane_id);
 693         if (!plane) {
 694                 DRM_DEBUG_KMS("Unknown plane ID %d\n",
 695                               plane_req->plane_id);
 696                 return -ENOENT;
 697         }
 698
 699         if (plane_req->fb_id) {
 700                 fb = drm_framebuffer_lookup(dev, file_priv, plane_req->fb_id);
 701                 if (!fb) {
 702                         DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
 703                                       plane_req->fb_id);
 704                         return -ENOENT;
 705                 }
 706
 707                 crtc = drm_crtc_find(dev, file_priv, plane_req->crtc_id);
 708                 if (!crtc) {
 709                         drm_framebuffer_put(fb);
 710                         DRM_DEBUG_KMS("Unknown crtc ID %d\n",
 711                                       plane_req->crtc_id);
 712                         return -ENOENT;
 713                 }
 714         }
 715
 716         /*
 717          * setplane_internal will take care of deref'ing either the old or new
 718          * framebuffer depending on success.
 719          */
 720         return setplane_internal(plane, crtc, fb,
 721                                  plane_req->crtc_x, plane_req->crtc_y,
 722                                  plane_req->crtc_w, plane_req->crtc_h,
 723                                  plane_req->src_x, plane_req->src_y,
 724                                  plane_req->src_w, plane_req->src_h);
 725 }
 726
 727 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
 728                                      struct drm_mode_cursor2 *req,
 729                                      struct drm_file *file_priv,
 730                                      struct drm_modeset_acquire_ctx *ctx)
 731 {
 732         struct drm_device *dev = crtc->dev;
 733         struct drm_framebuffer *fb = NULL;
 734         struct drm_mode_fb_cmd2 fbreq = {
 735                 .width = req->width,
 736                 .height = req->height,
 737                 .pixel_format = DRM_FORMAT_ARGB8888,
 738                 .pitches = { req->width * 4 },
 739                 .handles = { req->handle },
 740         };
 741         int32_t crtc_x, crtc_y;
 742         uint32_t crtc_w = 0, crtc_h = 0;
 743         uint32_t src_w = 0, src_h = 0;
 744         int ret = 0;
 745
 746         BUG_ON(!crtc->cursor);
 747         WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
 748
 749         /*
 750          * Obtain fb we'll be using (either new or existing) and take an extra
 751          * reference to it if fb != null.  setplane will take care of dropping
 752          * the reference if the plane update fails.
 753          */
 754         if (req->flags & DRM_MODE_CURSOR_BO) {
 755                 if (req->handle) {
 756                         fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv);
 757                         if (IS_ERR(fb)) {
 758                                 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
 759                                 return PTR_ERR(fb);
 760                         }
 761                         fb->hot_x = req->hot_x;
 762                         fb->hot_y = req->hot_y;
 763                 } else {
 764                         fb = NULL;
 765                 }
 766         } else {
 767                 fb = crtc->cursor->fb;
 768                 if (fb)
 769                         drm_framebuffer_get(fb);
 770         }
 771
 772         if (req->flags & DRM_MODE_CURSOR_MOVE) {
 773                 crtc_x = req->x;
 774                 crtc_y = req->y;
 775         } else {
 776                 crtc_x = crtc->cursor_x;
 777                 crtc_y = crtc->cursor_y;
 778         }
 779
 780         if (fb) {
 781                 crtc_w = fb->width;
 782                 crtc_h = fb->height;
 783                 src_w = fb->width << 16;
 784                 src_h = fb->height << 16;
 785         }
 786
 787         /*
 788          * setplane_internal will take care of deref'ing either the old or new
 789          * framebuffer depending on success.
 790          */
 791         ret = __setplane_internal(crtc->cursor, crtc, fb,
 792                                 crtc_x, crtc_y, crtc_w, crtc_h,
 793                                 0, 0, src_w, src_h, ctx);
 794
 795         /* Update successful; save new cursor position, if necessary */
 796         if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
 797                 crtc->cursor_x = req->x;
 798                 crtc->cursor_y = req->y;
 799         }
 800
 801         return ret;
 802 }
 803
 804 static int drm_mode_cursor_common(struct drm_device *dev,
 805                                   struct drm_mode_cursor2 *req,
 806                                   struct drm_file *file_priv)
 807 {
 808         struct drm_crtc *crtc;
 809         struct drm_modeset_acquire_ctx ctx;
 810         int ret = 0;
 811
 812         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 813                 return -EINVAL;
 814
 815         if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
 816                 return -EINVAL;
 817
 818         crtc = drm_crtc_find(dev, file_priv, req->crtc_id);
 819         if (!crtc) {
 820                 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
 821                 return -ENOENT;
 822         }
 823
 824         drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
 825 retry:
 826         ret = drm_modeset_lock(&crtc->mutex, &ctx);
 827         if (ret)
 828                 goto out;
 829         /*
 830          * If this crtc has a universal cursor plane, call that plane's update
 831          * handler rather than using legacy cursor handlers.
 832          */
 833         if (crtc->cursor) {
 834                 ret = drm_modeset_lock(&crtc->cursor->mutex, &ctx);
 835                 if (ret)
 836                         goto out;
 837
 838                 ret = drm_mode_cursor_universal(crtc, req, file_priv, &ctx);
 839                 goto out;
 840         }
 841
 842         if (req->flags & DRM_MODE_CURSOR_BO) {
 843                 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
 844                         ret = -ENXIO;
 845                         goto out;
 846                 }
 847                 /* Turns off the cursor if handle is 0 */
 848                 if (crtc->funcs->cursor_set2)
 849                         ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
 850                                                       req->width, req->height, req->hot_x, req->hot_y);
 851                 else
 852                         ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
 853                                                       req->width, req->height);
 854         }
 855
 856         if (req->flags & DRM_MODE_CURSOR_MOVE) {
 857                 if (crtc->funcs->cursor_move) {
 858                         ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
 859                 } else {
 860                         ret = -EFAULT;
 861                         goto out;
 862                 }
 863         }
 864 out:
 865         if (ret == -EDEADLK) {
 866                 ret = drm_modeset_backoff(&ctx);
 867                 if (!ret)
 868                         goto retry;
 869         }
 870
 871         drm_modeset_drop_locks(&ctx);
 872         drm_modeset_acquire_fini(&ctx);
 873
 874         return ret;
 875
 876 }
 877
 878
 879 int drm_mode_cursor_ioctl(struct drm_device *dev,
 880                           void *data, struct drm_file *file_priv)
 881 {
 882         struct drm_mode_cursor *req = data;
 883         struct drm_mode_cursor2 new_req;
 884
 885         memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
 886         new_req.hot_x = new_req.hot_y = 0;
 887
 888         return drm_mode_cursor_common(dev, &new_req, file_priv);
 889 }
 890
 891 /*
 892  * Set the cursor configuration based on user request. This implements the 2nd
 893  * version of the cursor ioctl, which allows userspace to additionally specify
 894  * the hotspot of the pointer.
 895  */
 896 int drm_mode_cursor2_ioctl(struct drm_device *dev,
 897                            void *data, struct drm_file *file_priv)
 898 {
 899         struct drm_mode_cursor2 *req = data;
 900
 901         return drm_mode_cursor_common(dev, req, file_priv);
 902 }
 903
 904 int drm_mode_page_flip_ioctl(struct drm_device *dev,
 905                              void *data, struct drm_file *file_priv)
 906 {
 907         struct drm_mode_crtc_page_flip_target *page_flip = data;
 908         struct drm_crtc *crtc;
 909         struct drm_framebuffer *fb = NULL;
 910         struct drm_pending_vblank_event *e = NULL;
 911         u32 target_vblank = page_flip->sequence;
 912         struct drm_modeset_acquire_ctx ctx;
 913         int ret = -EINVAL;
 914
 915         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 916                 return -EINVAL;
 917
 918         if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS)
 919                 return -EINVAL;
 920
 921         if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET))
 922                 return -EINVAL;
 923
 924         /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
 925          * can be specified
 926          */
 927         if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET)
 928                 return -EINVAL;
 929
 930         if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
 931                 return -EINVAL;
 932
 933         crtc = drm_crtc_find(dev, file_priv, page_flip->crtc_id);
 934         if (!crtc)
 935                 return -ENOENT;
 936
 937         if (crtc->funcs->page_flip_target) {
 938                 u32 current_vblank;
 939                 int r;
 940
 941                 r = drm_crtc_vblank_get(crtc);
 942                 if (r)
 943                         return r;
 944
 945                 current_vblank = drm_crtc_vblank_count(crtc);
 946
 947                 switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) {
 948                 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE:
 949                         if ((int)(target_vblank - current_vblank) > 1) {
 950                                 DRM_DEBUG("Invalid absolute flip target %u, "
 951                                           "must be <= %u\n", target_vblank,
 952                                           current_vblank + 1);
 953                                 drm_crtc_vblank_put(crtc);
 954                                 return -EINVAL;
 955                         }
 956                         break;
 957                 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE:
 958                         if (target_vblank != 0 && target_vblank != 1) {
 959                                 DRM_DEBUG("Invalid relative flip target %u, "
 960                                           "must be 0 or 1\n", target_vblank);
 961                                 drm_crtc_vblank_put(crtc);
 962                                 return -EINVAL;
 963                         }
 964                         target_vblank += current_vblank;
 965                         break;
 966                 default:
 967                         target_vblank = current_vblank +
 968                                 !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC);
 969                         break;
 970                 }
 971         } else if (crtc->funcs->page_flip == NULL ||
 972                    (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) {
 973                 return -EINVAL;
 974         }
 975
 976         drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
 977 retry:
 978         ret = drm_modeset_lock(&crtc->mutex, &ctx);
 979         if (ret)
 980                 goto out;
 981         ret = drm_modeset_lock(&crtc->primary->mutex, &ctx);
 982         if (ret)
 983                 goto out;
 984
 985         if (crtc->primary->fb == NULL) {
 986                 /* The framebuffer is currently unbound, presumably
 987                  * due to a hotplug event, that userspace has not
 988                  * yet discovered.
 989                  */
 990                 ret = -EBUSY;
 991                 goto out;
 992         }
 993
 994         fb = drm_framebuffer_lookup(dev, file_priv, page_flip->fb_id);
 995         if (!fb) {
 996                 ret = -ENOENT;
 997                 goto out;
 998         }
 999
1000         if (crtc->state) {
1001                 const struct drm_plane_state *state = crtc->primary->state;
1002
1003                 ret = drm_framebuffer_check_src_coords(state->src_x,
1004                                                        state->src_y,
1005                                                        state->src_w,
1006                                                        state->src_h,
1007                                                        fb);
1008         } else {
1009                 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
1010         }
1011         if (ret)
1012                 goto out;
1013
1014         if (crtc->primary->fb->format != fb->format) {
1015                 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
1016                 ret = -EINVAL;
1017                 goto out;
1018         }
1019
1020         if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1021                 e = kzalloc(sizeof *e, GFP_KERNEL);
1022                 if (!e) {
1023                         ret = -ENOMEM;
1024                         goto out;
1025                 }
1026                 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1027                 e->event.base.length = sizeof(e->event);
1028                 e->event.user_data = page_flip->user_data;
1029                 ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
1030                 if (ret) {
1031                         kfree(e);
1032                         e = NULL;
1033                         goto out;
1034                 }
1035         }
1036
1037         crtc->primary->old_fb = crtc->primary->fb;
1038         if (crtc->funcs->page_flip_target)
1039                 ret = crtc->funcs->page_flip_target(crtc, fb, e,
1040                                                     page_flip->flags,
1041                                                     target_vblank,
1042                                                     &ctx);
1043         else
1044                 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags,
1045                                              &ctx);
1046         if (ret) {
1047                 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT)
1048                         drm_event_cancel_free(dev, &e->base);
1049                 /* Keep the old fb, don't unref it. */
1050                 crtc->primary->old_fb = NULL;
1051         } else {
1052                 crtc->primary->fb = fb;
1053                 /* Unref only the old framebuffer. */
1054                 fb = NULL;
1055         }
1056
1057 out:
1058         if (fb)
1059                 drm_framebuffer_put(fb);
1060         if (crtc->primary->old_fb)
1061                 drm_framebuffer_put(crtc->primary->old_fb);
1062         crtc->primary->old_fb = NULL;
1063
1064         if (ret == -EDEADLK) {
1065                 ret = drm_modeset_backoff(&ctx);
1066                 if (!ret)
1067                         goto retry;
1068         }
1069
1070         drm_modeset_drop_locks(&ctx);
1071         drm_modeset_acquire_fini(&ctx);
1072
1073         if (ret && crtc->funcs->page_flip_target)
1074                 drm_crtc_vblank_put(crtc);
1075
1076         return ret;
1077 }