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 (drm_lease_held(file_priv, plane->base.id)) {
 483                         if (count < plane_resp->count_planes &&
 484                             put_user(plane->base.id, plane_ptr + count))
 485                                 return -EFAULT;
 486                         count++;
 487                 }
 488         }
 489         plane_resp->count_planes = count;
 490
 491         return 0;
 492 }
 493
 494 int drm_mode_getplane(struct drm_device *dev, void *data,
 495                       struct drm_file *file_priv)
 496 {
 497         struct drm_mode_get_plane *plane_resp = data;
 498         struct drm_plane *plane;
 499         uint32_t __user *format_ptr;
 500
 501         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 502                 return -EINVAL;
 503
 504         plane = drm_plane_find(dev, file_priv, plane_resp->plane_id);
 505         if (!plane)
 506                 return -ENOENT;
 507
 508         drm_modeset_lock(&plane->mutex, NULL);
 509         if (plane->state && plane->state->crtc && drm_lease_held(file_priv, plane->state->crtc->base.id))
 510                 plane_resp->crtc_id = plane->state->crtc->base.id;
 511         else if (!plane->state && plane->crtc && drm_lease_held(file_priv, plane->crtc->base.id))
 512                 plane_resp->crtc_id = plane->crtc->base.id;
 513         else
 514                 plane_resp->crtc_id = 0;
 515
 516         if (plane->state && plane->state->fb)
 517                 plane_resp->fb_id = plane->state->fb->base.id;
 518         else if (!plane->state && plane->fb)
 519                 plane_resp->fb_id = plane->fb->base.id;
 520         else
 521                 plane_resp->fb_id = 0;
 522         drm_modeset_unlock(&plane->mutex);
 523
 524         plane_resp->plane_id = plane->base.id;
 525         plane_resp->possible_crtcs = drm_lease_filter_crtcs(file_priv,
 526                                                             plane->possible_crtcs);
 527
 528         plane_resp->gamma_size = 0;
 529
 530         /*
 531          * This ioctl is called twice, once to determine how much space is
 532          * needed, and the 2nd time to fill it.
 533          */
 534         if (plane->format_count &&
 535             (plane_resp->count_format_types >= plane->format_count)) {
 536                 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
 537                 if (copy_to_user(format_ptr,
 538                                  plane->format_types,
 539                                  sizeof(uint32_t) * plane->format_count)) {
 540                         return -EFAULT;
 541                 }
 542         }
 543         plane_resp->count_format_types = plane->format_count;
 544
 545         return 0;
 546 }
 547
 548 int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
 549 {
 550         unsigned int i;
 551
 552         for (i = 0; i < plane->format_count; i++) {
 553                 if (format == plane->format_types[i])
 554                         return 0;
 555         }
 556
 557         return -EINVAL;
 558 }
 559
 560 /*
 561  * setplane_internal - setplane handler for internal callers
 562  *
 563  * Note that we assume an extra reference has already been taken on fb.  If the
 564  * update fails, this reference will be dropped before return; if it succeeds,
 565  * the previous framebuffer (if any) will be unreferenced instead.
 566  *
 567  * src_{x,y,w,h} are provided in 16.16 fixed point format
 568  */
 569 static int __setplane_internal(struct drm_plane *plane,
 570                                struct drm_crtc *crtc,
 571                                struct drm_framebuffer *fb,
 572                                int32_t crtc_x, int32_t crtc_y,
 573                                uint32_t crtc_w, uint32_t crtc_h,
 574                                /* src_{x,y,w,h} values are 16.16 fixed point */
 575                                uint32_t src_x, uint32_t src_y,
 576                                uint32_t src_w, uint32_t src_h,
 577                                struct drm_modeset_acquire_ctx *ctx)
 578 {
 579         int ret = 0;
 580
 581         /* No fb means shut it down */
 582         if (!fb) {
 583                 plane->old_fb = plane->fb;
 584                 ret = plane->funcs->disable_plane(plane, ctx);
 585                 if (!ret) {
 586                         plane->crtc = NULL;
 587                         plane->fb = NULL;
 588                 } else {
 589                         plane->old_fb = NULL;
 590                 }
 591                 goto out;
 592         }
 593
 594         /* Check whether this plane is usable on this CRTC */
 595         if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
 596                 DRM_DEBUG_KMS("Invalid crtc for plane\n");
 597                 ret = -EINVAL;
 598                 goto out;
 599         }
 600
 601         /* Check whether this plane supports the fb pixel format. */
 602         ret = drm_plane_check_pixel_format(plane, fb->format->format);
 603         if (ret) {
 604                 struct drm_format_name_buf format_name;
 605                 DRM_DEBUG_KMS("Invalid pixel format %s\n",
 606                               drm_get_format_name(fb->format->format,
 607                                                   &format_name));
 608                 goto out;
 609         }
 610
 611         /* Give drivers some help against integer overflows */
 612         if (crtc_w > INT_MAX ||
 613             crtc_x > INT_MAX - (int32_t) crtc_w ||
 614             crtc_h > INT_MAX ||
 615             crtc_y > INT_MAX - (int32_t) crtc_h) {
 616                 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
 617                               crtc_w, crtc_h, crtc_x, crtc_y);
 618                 ret = -ERANGE;
 619                 goto out;
 620         }
 621
 622         ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb);
 623         if (ret)
 624                 goto out;
 625
 626         plane->old_fb = plane->fb;
 627         ret = plane->funcs->update_plane(plane, crtc, fb,
 628                                          crtc_x, crtc_y, crtc_w, crtc_h,
 629                                          src_x, src_y, src_w, src_h, ctx);
 630         if (!ret) {
 631                 plane->crtc = crtc;
 632                 plane->fb = fb;
 633                 fb = NULL;
 634         } else {
 635                 plane->old_fb = NULL;
 636         }
 637
 638 out:
 639         if (fb)
 640                 drm_framebuffer_put(fb);
 641         if (plane->old_fb)
 642                 drm_framebuffer_put(plane->old_fb);
 643         plane->old_fb = NULL;
 644
 645         return ret;
 646 }
 647
 648 static int setplane_internal(struct drm_plane *plane,
 649                              struct drm_crtc *crtc,
 650                              struct drm_framebuffer *fb,
 651                              int32_t crtc_x, int32_t crtc_y,
 652                              uint32_t crtc_w, uint32_t crtc_h,
 653                              /* src_{x,y,w,h} values are 16.16 fixed point */
 654                              uint32_t src_x, uint32_t src_y,
 655                              uint32_t src_w, uint32_t src_h)
 656 {
 657         struct drm_modeset_acquire_ctx ctx;
 658         int ret;
 659
 660         drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
 661 retry:
 662         ret = drm_modeset_lock_all_ctx(plane->dev, &ctx);
 663         if (ret)
 664                 goto fail;
 665         ret = __setplane_internal(plane, crtc, fb,
 666                                   crtc_x, crtc_y, crtc_w, crtc_h,
 667                                   src_x, src_y, src_w, src_h, &ctx);
 668
 669 fail:
 670         if (ret == -EDEADLK) {
 671                 ret = drm_modeset_backoff(&ctx);
 672                 if (!ret)
 673                         goto retry;
 674         }
 675         drm_modeset_drop_locks(&ctx);
 676         drm_modeset_acquire_fini(&ctx);
 677
 678         return ret;
 679 }
 680
 681 int drm_mode_setplane(struct drm_device *dev, void *data,
 682                       struct drm_file *file_priv)
 683 {
 684         struct drm_mode_set_plane *plane_req = data;
 685         struct drm_plane *plane;
 686         struct drm_crtc *crtc = NULL;
 687         struct drm_framebuffer *fb = NULL;
 688
 689         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 690                 return -EINVAL;
 691
 692         /*
 693          * First, find the plane, crtc, and fb objects.  If not available,
 694          * we don't bother to call the driver.
 695          */
 696         plane = drm_plane_find(dev, file_priv, plane_req->plane_id);
 697         if (!plane) {
 698                 DRM_DEBUG_KMS("Unknown plane ID %d\n",
 699                               plane_req->plane_id);
 700                 return -ENOENT;
 701         }
 702
 703         if (plane_req->fb_id) {
 704                 fb = drm_framebuffer_lookup(dev, file_priv, plane_req->fb_id);
 705                 if (!fb) {
 706                         DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
 707                                       plane_req->fb_id);
 708                         return -ENOENT;
 709                 }
 710
 711                 crtc = drm_crtc_find(dev, file_priv, plane_req->crtc_id);
 712                 if (!crtc) {
 713                         drm_framebuffer_put(fb);
 714                         DRM_DEBUG_KMS("Unknown crtc ID %d\n",
 715                                       plane_req->crtc_id);
 716                         return -ENOENT;
 717                 }
 718         }
 719
 720         /*
 721          * setplane_internal will take care of deref'ing either the old or new
 722          * framebuffer depending on success.
 723          */
 724         return setplane_internal(plane, crtc, fb,
 725                                  plane_req->crtc_x, plane_req->crtc_y,
 726                                  plane_req->crtc_w, plane_req->crtc_h,
 727                                  plane_req->src_x, plane_req->src_y,
 728                                  plane_req->src_w, plane_req->src_h);
 729 }
 730
 731 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
 732                                      struct drm_mode_cursor2 *req,
 733                                      struct drm_file *file_priv,
 734                                      struct drm_modeset_acquire_ctx *ctx)
 735 {
 736         struct drm_device *dev = crtc->dev;
 737         struct drm_framebuffer *fb = NULL;
 738         struct drm_mode_fb_cmd2 fbreq = {
 739                 .width = req->width,
 740                 .height = req->height,
 741                 .pixel_format = DRM_FORMAT_ARGB8888,
 742                 .pitches = { req->width * 4 },
 743                 .handles = { req->handle },
 744         };
 745         int32_t crtc_x, crtc_y;
 746         uint32_t crtc_w = 0, crtc_h = 0;
 747         uint32_t src_w = 0, src_h = 0;
 748         int ret = 0;
 749
 750         BUG_ON(!crtc->cursor);
 751         WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
 752
 753         /*
 754          * Obtain fb we'll be using (either new or existing) and take an extra
 755          * reference to it if fb != null.  setplane will take care of dropping
 756          * the reference if the plane update fails.
 757          */
 758         if (req->flags & DRM_MODE_CURSOR_BO) {
 759                 if (req->handle) {
 760                         fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv);
 761                         if (IS_ERR(fb)) {
 762                                 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
 763                                 return PTR_ERR(fb);
 764                         }
 765                         fb->hot_x = req->hot_x;
 766                         fb->hot_y = req->hot_y;
 767                 } else {
 768                         fb = NULL;
 769                 }
 770         } else {
 771                 fb = crtc->cursor->fb;
 772                 if (fb)
 773                         drm_framebuffer_get(fb);
 774         }
 775
 776         if (req->flags & DRM_MODE_CURSOR_MOVE) {
 777                 crtc_x = req->x;
 778                 crtc_y = req->y;
 779         } else {
 780                 crtc_x = crtc->cursor_x;
 781                 crtc_y = crtc->cursor_y;
 782         }
 783
 784         if (fb) {
 785                 crtc_w = fb->width;
 786                 crtc_h = fb->height;
 787                 src_w = fb->width << 16;
 788                 src_h = fb->height << 16;
 789         }
 790
 791         /*
 792          * setplane_internal will take care of deref'ing either the old or new
 793          * framebuffer depending on success.
 794          */
 795         ret = __setplane_internal(crtc->cursor, crtc, fb,
 796                                 crtc_x, crtc_y, crtc_w, crtc_h,
 797                                 0, 0, src_w, src_h, ctx);
 798
 799         /* Update successful; save new cursor position, if necessary */
 800         if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
 801                 crtc->cursor_x = req->x;
 802                 crtc->cursor_y = req->y;
 803         }
 804
 805         return ret;
 806 }
 807
 808 static int drm_mode_cursor_common(struct drm_device *dev,
 809                                   struct drm_mode_cursor2 *req,
 810                                   struct drm_file *file_priv)
 811 {
 812         struct drm_crtc *crtc;
 813         struct drm_modeset_acquire_ctx ctx;
 814         int ret = 0;
 815
 816         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 817                 return -EINVAL;
 818
 819         if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
 820                 return -EINVAL;
 821
 822         crtc = drm_crtc_find(dev, file_priv, req->crtc_id);
 823         if (!crtc) {
 824                 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
 825                 return -ENOENT;
 826         }
 827
 828         drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
 829 retry:
 830         ret = drm_modeset_lock(&crtc->mutex, &ctx);
 831         if (ret)
 832                 goto out;
 833         /*
 834          * If this crtc has a universal cursor plane, call that plane's update
 835          * handler rather than using legacy cursor handlers.
 836          */
 837         if (crtc->cursor) {
 838                 ret = drm_modeset_lock(&crtc->cursor->mutex, &ctx);
 839                 if (ret)
 840                         goto out;
 841
 842                 ret = drm_mode_cursor_universal(crtc, req, file_priv, &ctx);
 843                 goto out;
 844         }
 845
 846         if (req->flags & DRM_MODE_CURSOR_BO) {
 847                 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
 848                         ret = -ENXIO;
 849                         goto out;
 850                 }
 851                 /* Turns off the cursor if handle is 0 */
 852                 if (crtc->funcs->cursor_set2)
 853                         ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
 854                                                       req->width, req->height, req->hot_x, req->hot_y);
 855                 else
 856                         ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
 857                                                       req->width, req->height);
 858         }
 859
 860         if (req->flags & DRM_MODE_CURSOR_MOVE) {
 861                 if (crtc->funcs->cursor_move) {
 862                         ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
 863                 } else {
 864                         ret = -EFAULT;
 865                         goto out;
 866                 }
 867         }
 868 out:
 869         if (ret == -EDEADLK) {
 870                 ret = drm_modeset_backoff(&ctx);
 871                 if (!ret)
 872                         goto retry;
 873         }
 874
 875         drm_modeset_drop_locks(&ctx);
 876         drm_modeset_acquire_fini(&ctx);
 877
 878         return ret;
 879
 880 }
 881
 882
 883 int drm_mode_cursor_ioctl(struct drm_device *dev,
 884                           void *data, struct drm_file *file_priv)
 885 {
 886         struct drm_mode_cursor *req = data;
 887         struct drm_mode_cursor2 new_req;
 888
 889         memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
 890         new_req.hot_x = new_req.hot_y = 0;
 891
 892         return drm_mode_cursor_common(dev, &new_req, file_priv);
 893 }
 894
 895 /*
 896  * Set the cursor configuration based on user request. This implements the 2nd
 897  * version of the cursor ioctl, which allows userspace to additionally specify
 898  * the hotspot of the pointer.
 899  */
 900 int drm_mode_cursor2_ioctl(struct drm_device *dev,
 901                            void *data, struct drm_file *file_priv)
 902 {
 903         struct drm_mode_cursor2 *req = data;
 904
 905         return drm_mode_cursor_common(dev, req, file_priv);
 906 }
 907
 908 int drm_mode_page_flip_ioctl(struct drm_device *dev,
 909                              void *data, struct drm_file *file_priv)
 910 {
 911         struct drm_mode_crtc_page_flip_target *page_flip = data;
 912         struct drm_crtc *crtc;
 913         struct drm_framebuffer *fb = NULL;
 914         struct drm_pending_vblank_event *e = NULL;
 915         u32 target_vblank = page_flip->sequence;
 916         struct drm_modeset_acquire_ctx ctx;
 917         int ret = -EINVAL;
 918
 919         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 920                 return -EINVAL;
 921
 922         if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS)
 923                 return -EINVAL;
 924
 925         if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET))
 926                 return -EINVAL;
 927
 928         /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
 929          * can be specified
 930          */
 931         if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET)
 932                 return -EINVAL;
 933
 934         if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
 935                 return -EINVAL;
 936
 937         crtc = drm_crtc_find(dev, file_priv, page_flip->crtc_id);
 938         if (!crtc)
 939                 return -ENOENT;
 940
 941         if (crtc->funcs->page_flip_target) {
 942                 u32 current_vblank;
 943                 int r;
 944
 945                 r = drm_crtc_vblank_get(crtc);
 946                 if (r)
 947                         return r;
 948
 949                 current_vblank = drm_crtc_vblank_count(crtc);
 950
 951                 switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) {
 952                 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE:
 953                         if ((int)(target_vblank - current_vblank) > 1) {
 954                                 DRM_DEBUG("Invalid absolute flip target %u, "
 955                                           "must be <= %u\n", target_vblank,
 956                                           current_vblank + 1);
 957                                 drm_crtc_vblank_put(crtc);
 958                                 return -EINVAL;
 959                         }
 960                         break;
 961                 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE:
 962                         if (target_vblank != 0 && target_vblank != 1) {
 963                                 DRM_DEBUG("Invalid relative flip target %u, "
 964                                           "must be 0 or 1\n", target_vblank);
 965                                 drm_crtc_vblank_put(crtc);
 966                                 return -EINVAL;
 967                         }
 968                         target_vblank += current_vblank;
 969                         break;
 970                 default:
 971                         target_vblank = current_vblank +
 972                                 !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC);
 973                         break;
 974                 }
 975         } else if (crtc->funcs->page_flip == NULL ||
 976                    (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) {
 977                 return -EINVAL;
 978         }
 979
 980         drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
 981 retry:
 982         ret = drm_modeset_lock(&crtc->mutex, &ctx);
 983         if (ret)
 984                 goto out;
 985         ret = drm_modeset_lock(&crtc->primary->mutex, &ctx);
 986         if (ret)
 987                 goto out;
 988
 989         if (crtc->primary->fb == NULL) {
 990                 /* The framebuffer is currently unbound, presumably
 991                  * due to a hotplug event, that userspace has not
 992                  * yet discovered.
 993                  */
 994                 ret = -EBUSY;
 995                 goto out;
 996         }
 997
 998         fb = drm_framebuffer_lookup(dev, file_priv, page_flip->fb_id);
 999         if (!fb) {
1000                 ret = -ENOENT;
1001                 goto out;
1002         }
1003
1004         if (crtc->state) {
1005                 const struct drm_plane_state *state = crtc->primary->state;
1006
1007                 ret = drm_framebuffer_check_src_coords(state->src_x,
1008                                                        state->src_y,
1009                                                        state->src_w,
1010                                                        state->src_h,
1011                                                        fb);
1012         } else {
1013                 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
1014         }
1015         if (ret)
1016                 goto out;
1017
1018         if (crtc->primary->fb->format != fb->format) {
1019                 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
1020                 ret = -EINVAL;
1021                 goto out;
1022         }
1023
1024         if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1025                 e = kzalloc(sizeof *e, GFP_KERNEL);
1026                 if (!e) {
1027                         ret = -ENOMEM;
1028                         goto out;
1029                 }
1030                 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1031                 e->event.base.length = sizeof(e->event);
1032                 e->event.vbl.user_data = page_flip->user_data;
1033                 ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
1034                 if (ret) {
1035                         kfree(e);
1036                         e = NULL;
1037                         goto out;
1038                 }
1039         }
1040
1041         crtc->primary->old_fb = crtc->primary->fb;
1042         if (crtc->funcs->page_flip_target)
1043                 ret = crtc->funcs->page_flip_target(crtc, fb, e,
1044                                                     page_flip->flags,
1045                                                     target_vblank,
1046                                                     &ctx);
1047         else
1048                 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags,
1049                                              &ctx);
1050         if (ret) {
1051                 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT)
1052                         drm_event_cancel_free(dev, &e->base);
1053                 /* Keep the old fb, don't unref it. */
1054                 crtc->primary->old_fb = NULL;
1055         } else {
1056                 crtc->primary->fb = fb;
1057                 /* Unref only the old framebuffer. */
1058                 fb = NULL;
1059         }
1060
1061 out:
1062         if (fb)
1063                 drm_framebuffer_put(fb);
1064         if (crtc->primary->old_fb)
1065                 drm_framebuffer_put(crtc->primary->old_fb);
1066         crtc->primary->old_fb = NULL;
1067
1068         if (ret == -EDEADLK) {
1069                 ret = drm_modeset_backoff(&ctx);
1070                 if (!ret)
1071                         goto retry;
1072         }
1073
1074         drm_modeset_drop_locks(&ctx);
1075         drm_modeset_acquire_fini(&ctx);
1076
1077         if (ret && crtc->funcs->page_flip_target)
1078                 drm_crtc_vblank_put(crtc);
1079
1080         return ret;
1081 }