drivers/gpu/drm/drm_framebuffer.c

   1 /*
   2  * Copyright (c) 2016 Intel Corporation
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that copyright
   7  * notice and this permission notice appear in supporting documentation, and
   8  * that the name of the copyright holders not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  The copyright holders make no representations
  11  * about the suitability of this software for any purpose.  It is provided "as
  12  * is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20  * OF THIS SOFTWARE.
  21  */
  22
  23 #include <linux/export.h>
  24 #include <drm/drmP.h>
  25 #include <drm/drm_auth.h>
  26 #include <drm/drm_framebuffer.h>
  27 #include <drm/drm_atomic.h>
  28 #include <drm/drm_atomic_uapi.h>
  29 #include <drm/drm_print.h>
  30
  31 #include "drm_internal.h"
  32 #include "drm_crtc_internal.h"
  33
  34 /**
  35  * DOC: overview
  36  *
  37  * Frame buffers are abstract memory objects that provide a source of pixels to
  38  * scanout to a CRTC. Applications explicitly request the creation of frame
  39  * buffers through the DRM_IOCTL_MODE_ADDFB(2) ioctls and receive an opaque
  40  * handle that can be passed to the KMS CRTC control, plane configuration and
  41  * page flip functions.
  42  *
  43  * Frame buffers rely on the underlying memory manager for allocating backing
  44  * storage. When creating a frame buffer applications pass a memory handle
  45  * (or a list of memory handles for multi-planar formats) through the
  46  * &struct drm_mode_fb_cmd2 argument. For drivers using GEM as their userspace
  47  * buffer management interface this would be a GEM handle.  Drivers are however
  48  * free to use their own backing storage object handles, e.g. vmwgfx directly
  49  * exposes special TTM handles to userspace and so expects TTM handles in the
  50  * create ioctl and not GEM handles.
  51  *
  52  * Framebuffers are tracked with &struct drm_framebuffer. They are published
  53  * using drm_framebuffer_init() - after calling that function userspace can use
  54  * and access the framebuffer object. The helper function
  55  * drm_helper_mode_fill_fb_struct() can be used to pre-fill the required
  56  * metadata fields.
  57  *
  58  * The lifetime of a drm framebuffer is controlled with a reference count,
  59  * drivers can grab additional references with drm_framebuffer_get() and drop
  60  * them again with drm_framebuffer_put(). For driver-private framebuffers for
  61  * which the last reference is never dropped (e.g. for the fbdev framebuffer
  62  * when the struct &struct drm_framebuffer is embedded into the fbdev helper
  63  * struct) drivers can manually clean up a framebuffer at module unload time
  64  * with drm_framebuffer_unregister_private(). But doing this is not
  65  * recommended, and it's better to have a normal free-standing &struct
  66  * drm_framebuffer.
  67  */
  68
  69 int drm_framebuffer_check_src_coords(uint32_t src_x, uint32_t src_y,
  70                                      uint32_t src_w, uint32_t src_h,
  71                                      const struct drm_framebuffer *fb)
  72 {
  73         unsigned int fb_width, fb_height;
  74
  75         fb_width = fb->width << 16;
  76         fb_height = fb->height << 16;
  77
  78         /* Make sure source coordinates are inside the fb. */
  79         if (src_w > fb_width ||
  80             src_x > fb_width - src_w ||
  81             src_h > fb_height ||
  82             src_y > fb_height - src_h) {
  83                 DRM_DEBUG_KMS("Invalid source coordinates "
  84                               "%u.%06ux%u.%06u+%u.%06u+%u.%06u (fb %ux%u)\n",
  85                               src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
  86                               src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
  87                               src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
  88                               src_y >> 16, ((src_y & 0xffff) * 15625) >> 10,
  89                               fb->width, fb->height);
  90                 return -ENOSPC;
  91         }
  92
  93         return 0;
  94 }
  95
  96 /**
  97  * drm_mode_addfb - add an FB to the graphics configuration
  98  * @dev: drm device for the ioctl
  99  * @or: pointer to request structure
 100  * @file_priv: drm file
 101  *
 102  * Add a new FB to the specified CRTC, given a user request. This is the
 103  * original addfb ioctl which only supported RGB formats.
 104  *
 105  * Called by the user via ioctl, or by an in-kernel client.
 106  *
 107  * Returns:
 108  * Zero on success, negative errno on failure.
 109  */
 110 int drm_mode_addfb(struct drm_device *dev, struct drm_mode_fb_cmd *or,
 111                    struct drm_file *file_priv)
 112 {
 113         struct drm_mode_fb_cmd2 r = {};
 114         int ret;
 115
 116         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 117                 return -EOPNOTSUPP;
 118
 119         r.pixel_format = drm_driver_legacy_fb_format(dev, or->bpp, or->depth);
 120         if (r.pixel_format == DRM_FORMAT_INVALID) {
 121                 DRM_DEBUG("bad {bpp:%d, depth:%d}\n", or->bpp, or->depth);
 122                 return -EINVAL;
 123         }
 124
 125         /* convert to new format and call new ioctl */
 126         r.fb_id = or->fb_id;
 127         r.width = or->width;
 128         r.height = or->height;
 129         r.pitches[0] = or->pitch;
 130         r.handles[0] = or->handle;
 131
 132         ret = drm_mode_addfb2(dev, &r, file_priv);
 133         if (ret)
 134                 return ret;
 135
 136         or->fb_id = r.fb_id;
 137
 138         return 0;
 139 }
 140
 141 int drm_mode_addfb_ioctl(struct drm_device *dev,
 142                          void *data, struct drm_file *file_priv)
 143 {
 144         return drm_mode_addfb(dev, data, file_priv);
 145 }
 146
 147 static int fb_plane_width(int width,
 148                           const struct drm_format_info *format, int plane)
 149 {
 150         if (plane == 0)
 151                 return width;
 152
 153         return DIV_ROUND_UP(width, format->hsub);
 154 }
 155
 156 static int fb_plane_height(int height,
 157                            const struct drm_format_info *format, int plane)
 158 {
 159         if (plane == 0)
 160                 return height;
 161
 162         return DIV_ROUND_UP(height, format->vsub);
 163 }
 164
 165 static int framebuffer_check(struct drm_device *dev,
 166                              const struct drm_mode_fb_cmd2 *r)
 167 {
 168         const struct drm_format_info *info;
 169         int i;
 170
 171         /* check if the format is supported at all */
 172         info = __drm_format_info(r->pixel_format);
 173         if (!info) {
 174                 struct drm_format_name_buf format_name;
 175
 176                 DRM_DEBUG_KMS("bad framebuffer format %s\n",
 177                               drm_get_format_name(r->pixel_format,
 178                                                   &format_name));
 179                 return -EINVAL;
 180         }
 181
 182         /* now let the driver pick its own format info */
 183         info = drm_get_format_info(dev, r);
 184
 185         if (r->width == 0) {
 186                 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
 187                 return -EINVAL;
 188         }
 189
 190         if (r->height == 0) {
 191                 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
 192                 return -EINVAL;
 193         }
 194
 195         for (i = 0; i < info->num_planes; i++) {
 196                 unsigned int width = fb_plane_width(r->width, info, i);
 197                 unsigned int height = fb_plane_height(r->height, info, i);
 198                 unsigned int block_size = info->char_per_block[i];
 199                 u64 min_pitch = drm_format_info_min_pitch(info, i, width);
 200
 201                 if (!block_size && (r->modifier[i] == DRM_FORMAT_MOD_LINEAR)) {
 202                         DRM_DEBUG_KMS("Format requires non-linear modifier for plane %d\n", i);
 203                         return -EINVAL;
 204                 }
 205
 206                 if (!r->handles[i]) {
 207                         DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
 208                         return -EINVAL;
 209                 }
 210
 211                 if (min_pitch > UINT_MAX)
 212                         return -ERANGE;
 213
 214                 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
 215                         return -ERANGE;
 216
 217                 if (block_size && r->pitches[i] < min_pitch) {
 218                         DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
 219                         return -EINVAL;
 220                 }
 221
 222                 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
 223                         DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
 224                                       r->modifier[i], i);
 225                         return -EINVAL;
 226                 }
 227
 228                 if (r->flags & DRM_MODE_FB_MODIFIERS &&
 229                     r->modifier[i] != r->modifier[0]) {
 230                         DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
 231                                       r->modifier[i], i);
 232                         return -EINVAL;
 233                 }
 234
 235                 /* modifier specific checks: */
 236                 switch (r->modifier[i]) {
 237                 case DRM_FORMAT_MOD_SAMSUNG_64_32_TILE:
 238                         /* NOTE: the pitch restriction may be lifted later if it turns
 239                          * out that no hw has this restriction:
 240                          */
 241                         if (r->pixel_format != DRM_FORMAT_NV12 ||
 242                                         width % 128 || height % 32 ||
 243                                         r->pitches[i] % 128) {
 244                                 DRM_DEBUG_KMS("bad modifier data for plane %d\n", i);
 245                                 return -EINVAL;
 246                         }
 247                         break;
 248
 249                 default:
 250                         break;
 251                 }
 252         }
 253
 254         for (i = info->num_planes; i < 4; i++) {
 255                 if (r->modifier[i]) {
 256                         DRM_DEBUG_KMS("non-zero modifier for unused plane %d\n", i);
 257                         return -EINVAL;
 258                 }
 259
 260                 /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */
 261                 if (!(r->flags & DRM_MODE_FB_MODIFIERS))
 262                         continue;
 263
 264                 if (r->handles[i]) {
 265                         DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i);
 266                         return -EINVAL;
 267                 }
 268
 269                 if (r->pitches[i]) {
 270                         DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i);
 271                         return -EINVAL;
 272                 }
 273
 274                 if (r->offsets[i]) {
 275                         DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i);
 276                         return -EINVAL;
 277                 }
 278         }
 279
 280         return 0;
 281 }
 282
 283 struct drm_framebuffer *
 284 drm_internal_framebuffer_create(struct drm_device *dev,
 285                                 const struct drm_mode_fb_cmd2 *r,
 286                                 struct drm_file *file_priv)
 287 {
 288         struct drm_mode_config *config = &dev->mode_config;
 289         struct drm_framebuffer *fb;
 290         int ret;
 291
 292         if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
 293                 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
 294                 return ERR_PTR(-EINVAL);
 295         }
 296
 297         if ((config->min_width > r->width) || (r->width > config->max_width)) {
 298                 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
 299                           r->width, config->min_width, config->max_width);
 300                 return ERR_PTR(-EINVAL);
 301         }
 302         if ((config->min_height > r->height) || (r->height > config->max_height)) {
 303                 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
 304                           r->height, config->min_height, config->max_height);
 305                 return ERR_PTR(-EINVAL);
 306         }
 307
 308         if (r->flags & DRM_MODE_FB_MODIFIERS &&
 309             !dev->mode_config.allow_fb_modifiers) {
 310                 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
 311                 return ERR_PTR(-EINVAL);
 312         }
 313
 314         ret = framebuffer_check(dev, r);
 315         if (ret)
 316                 return ERR_PTR(ret);
 317
 318         fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
 319         if (IS_ERR(fb)) {
 320                 DRM_DEBUG_KMS("could not create framebuffer\n");
 321                 return fb;
 322         }
 323
 324         return fb;
 325 }
 326 EXPORT_SYMBOL_FOR_TESTS_ONLY(drm_internal_framebuffer_create);
 327
 328 /**
 329  * drm_mode_addfb2 - add an FB to the graphics configuration
 330  * @dev: drm device for the ioctl
 331  * @data: data pointer for the ioctl
 332  * @file_priv: drm file for the ioctl call
 333  *
 334  * Add a new FB to the specified CRTC, given a user request with format. This is
 335  * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
 336  * and uses fourcc codes as pixel format specifiers.
 337  *
 338  * Called by the user via ioctl.
 339  *
 340  * Returns:
 341  * Zero on success, negative errno on failure.
 342  */
 343 int drm_mode_addfb2(struct drm_device *dev,
 344                     void *data, struct drm_file *file_priv)
 345 {
 346         struct drm_mode_fb_cmd2 *r = data;
 347         struct drm_framebuffer *fb;
 348
 349         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 350                 return -EOPNOTSUPP;
 351
 352         fb = drm_internal_framebuffer_create(dev, r, file_priv);
 353         if (IS_ERR(fb))
 354                 return PTR_ERR(fb);
 355
 356         DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
 357         r->fb_id = fb->base.id;
 358
 359         /* Transfer ownership to the filp for reaping on close */
 360         mutex_lock(&file_priv->fbs_lock);
 361         list_add(&fb->filp_head, &file_priv->fbs);
 362         mutex_unlock(&file_priv->fbs_lock);
 363
 364         return 0;
 365 }
 366
 367 int drm_mode_addfb2_ioctl(struct drm_device *dev,
 368                           void *data, struct drm_file *file_priv)
 369 {
 370 #ifdef __BIG_ENDIAN
 371         if (!dev->mode_config.quirk_addfb_prefer_host_byte_order) {
 372                 /*
 373                  * Drivers must set the
 374                  * quirk_addfb_prefer_host_byte_order quirk to make
 375                  * the drm_mode_addfb() compat code work correctly on
 376                  * bigendian machines.
 377                  *
 378                  * If they don't they interpret pixel_format values
 379                  * incorrectly for bug compatibility, which in turn
 380                  * implies the ADDFB2 ioctl does not work correctly
 381                  * then.  So block it to make userspace fallback to
 382                  * ADDFB.
 383                  */
 384                 DRM_DEBUG_KMS("addfb2 broken on bigendian");
 385                 return -EOPNOTSUPP;
 386         }
 387 #endif
 388         return drm_mode_addfb2(dev, data, file_priv);
 389 }
 390
 391 struct drm_mode_rmfb_work {
 392         struct work_struct work;
 393         struct list_head fbs;
 394 };
 395
 396 static void drm_mode_rmfb_work_fn(struct work_struct *w)
 397 {
 398         struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work);
 399
 400         while (!list_empty(&arg->fbs)) {
 401                 struct drm_framebuffer *fb =
 402                         list_first_entry(&arg->fbs, typeof(*fb), filp_head);
 403
 404                 list_del_init(&fb->filp_head);
 405                 drm_framebuffer_remove(fb);
 406         }
 407 }
 408
 409 /**
 410  * drm_mode_rmfb - remove an FB from the configuration
 411  * @dev: drm device
 412  * @fb_id: id of framebuffer to remove
 413  * @file_priv: drm file
 414  *
 415  * Remove the specified FB.
 416  *
 417  * Called by the user via ioctl, or by an in-kernel client.
 418  *
 419  * Returns:
 420  * Zero on success, negative errno on failure.
 421  */
 422 int drm_mode_rmfb(struct drm_device *dev, u32 fb_id,
 423                   struct drm_file *file_priv)
 424 {
 425         struct drm_framebuffer *fb = NULL;
 426         struct drm_framebuffer *fbl = NULL;
 427         int found = 0;
 428
 429         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 430                 return -EOPNOTSUPP;
 431
 432         fb = drm_framebuffer_lookup(dev, file_priv, fb_id);
 433         if (!fb)
 434                 return -ENOENT;
 435
 436         mutex_lock(&file_priv->fbs_lock);
 437         list_for_each_entry(fbl, &file_priv->fbs, filp_head)
 438                 if (fb == fbl)
 439                         found = 1;
 440         if (!found) {
 441                 mutex_unlock(&file_priv->fbs_lock);
 442                 goto fail_unref;
 443         }
 444
 445         list_del_init(&fb->filp_head);
 446         mutex_unlock(&file_priv->fbs_lock);
 447
 448         /* drop the reference we picked up in framebuffer lookup */
 449         drm_framebuffer_put(fb);
 450
 451         /*
 452          * we now own the reference that was stored in the fbs list
 453          *
 454          * drm_framebuffer_remove may fail with -EINTR on pending signals,
 455          * so run this in a separate stack as there's no way to correctly
 456          * handle this after the fb is already removed from the lookup table.
 457          */
 458         if (drm_framebuffer_read_refcount(fb) > 1) {
 459                 struct drm_mode_rmfb_work arg;
 460
 461                 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
 462                 INIT_LIST_HEAD(&arg.fbs);
 463                 list_add_tail(&fb->filp_head, &arg.fbs);
 464
 465                 schedule_work(&arg.work);
 466                 flush_work(&arg.work);
 467                 destroy_work_on_stack(&arg.work);
 468         } else
 469                 drm_framebuffer_put(fb);
 470
 471         return 0;
 472
 473 fail_unref:
 474         drm_framebuffer_put(fb);
 475         return -ENOENT;
 476 }
 477
 478 int drm_mode_rmfb_ioctl(struct drm_device *dev,
 479                         void *data, struct drm_file *file_priv)
 480 {
 481         uint32_t *fb_id = data;
 482
 483         return drm_mode_rmfb(dev, *fb_id, file_priv);
 484 }
 485
 486 /**
 487  * drm_mode_getfb - get FB info
 488  * @dev: drm device for the ioctl
 489  * @data: data pointer for the ioctl
 490  * @file_priv: drm file for the ioctl call
 491  *
 492  * Lookup the FB given its ID and return info about it.
 493  *
 494  * Called by the user via ioctl.
 495  *
 496  * Returns:
 497  * Zero on success, negative errno on failure.
 498  */
 499 int drm_mode_getfb(struct drm_device *dev,
 500                    void *data, struct drm_file *file_priv)
 501 {
 502         struct drm_mode_fb_cmd *r = data;
 503         struct drm_framebuffer *fb;
 504         int ret;
 505
 506         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 507                 return -EOPNOTSUPP;
 508
 509         fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
 510         if (!fb)
 511                 return -ENOENT;
 512
 513         /* Multi-planar framebuffers need getfb2. */
 514         if (fb->format->num_planes > 1) {
 515                 ret = -EINVAL;
 516                 goto out;
 517         }
 518
 519         if (!fb->funcs->create_handle) {
 520                 ret = -ENODEV;
 521                 goto out;
 522         }
 523
 524         r->height = fb->height;
 525         r->width = fb->width;
 526         r->depth = fb->format->depth;
 527         r->bpp = fb->format->cpp[0] * 8;
 528         r->pitch = fb->pitches[0];
 529
 530         /* GET_FB() is an unprivileged ioctl so we must not return a
 531          * buffer-handle to non-master processes! For
 532          * backwards-compatibility reasons, we cannot make GET_FB() privileged,
 533          * so just return an invalid handle for non-masters.
 534          */
 535         if (!drm_is_current_master(file_priv) && !capable(CAP_SYS_ADMIN)) {
 536                 r->handle = 0;
 537                 ret = 0;
 538                 goto out;
 539         }
 540
 541         ret = fb->funcs->create_handle(fb, file_priv, &r->handle);
 542
 543 out:
 544         drm_framebuffer_put(fb);
 545
 546         return ret;
 547 }
 548
 549 /**
 550  * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
 551  * @dev: drm device for the ioctl
 552  * @data: data pointer for the ioctl
 553  * @file_priv: drm file for the ioctl call
 554  *
 555  * Lookup the FB and flush out the damaged area supplied by userspace as a clip
 556  * rectangle list. Generic userspace which does frontbuffer rendering must call
 557  * this ioctl to flush out the changes on manual-update display outputs, e.g.
 558  * usb display-link, mipi manual update panels or edp panel self refresh modes.
 559  *
 560  * Modesetting drivers which always update the frontbuffer do not need to
 561  * implement the corresponding &drm_framebuffer_funcs.dirty callback.
 562  *
 563  * Called by the user via ioctl.
 564  *
 565  * Returns:
 566  * Zero on success, negative errno on failure.
 567  */
 568 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
 569                            void *data, struct drm_file *file_priv)
 570 {
 571         struct drm_clip_rect __user *clips_ptr;
 572         struct drm_clip_rect *clips = NULL;
 573         struct drm_mode_fb_dirty_cmd *r = data;
 574         struct drm_framebuffer *fb;
 575         unsigned flags;
 576         int num_clips;
 577         int ret;
 578
 579         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 580                 return -EOPNOTSUPP;
 581
 582         fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
 583         if (!fb)
 584                 return -ENOENT;
 585
 586         num_clips = r->num_clips;
 587         clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
 588
 589         if (!num_clips != !clips_ptr) {
 590                 ret = -EINVAL;
 591                 goto out_err1;
 592         }
 593
 594         flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
 595
 596         /* If userspace annotates copy, clips must come in pairs */
 597         if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
 598                 ret = -EINVAL;
 599                 goto out_err1;
 600         }
 601
 602         if (num_clips && clips_ptr) {
 603                 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
 604                         ret = -EINVAL;
 605                         goto out_err1;
 606                 }
 607                 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
 608                 if (!clips) {
 609                         ret = -ENOMEM;
 610                         goto out_err1;
 611                 }
 612
 613                 ret = copy_from_user(clips, clips_ptr,
 614                                      num_clips * sizeof(*clips));
 615                 if (ret) {
 616                         ret = -EFAULT;
 617                         goto out_err2;
 618                 }
 619         }
 620
 621         if (fb->funcs->dirty) {
 622                 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
 623                                        clips, num_clips);
 624         } else {
 625                 ret = -ENOSYS;
 626         }
 627
 628 out_err2:
 629         kfree(clips);
 630 out_err1:
 631         drm_framebuffer_put(fb);
 632
 633         return ret;
 634 }
 635
 636 /**
 637  * drm_fb_release - remove and free the FBs on this file
 638  * @priv: drm file for the ioctl
 639  *
 640  * Destroy all the FBs associated with @filp.
 641  *
 642  * Called by the user via ioctl.
 643  *
 644  * Returns:
 645  * Zero on success, negative errno on failure.
 646  */
 647 void drm_fb_release(struct drm_file *priv)
 648 {
 649         struct drm_framebuffer *fb, *tfb;
 650         struct drm_mode_rmfb_work arg;
 651
 652         INIT_LIST_HEAD(&arg.fbs);
 653
 654         /*
 655          * When the file gets released that means no one else can access the fb
 656          * list any more, so no need to grab fpriv->fbs_lock. And we need to
 657          * avoid upsetting lockdep since the universal cursor code adds a
 658          * framebuffer while holding mutex locks.
 659          *
 660          * Note that a real deadlock between fpriv->fbs_lock and the modeset
 661          * locks is impossible here since no one else but this function can get
 662          * at it any more.
 663          */
 664         list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
 665                 if (drm_framebuffer_read_refcount(fb) > 1) {
 666                         list_move_tail(&fb->filp_head, &arg.fbs);
 667                 } else {
 668                         list_del_init(&fb->filp_head);
 669
 670                         /* This drops the fpriv->fbs reference. */
 671                         drm_framebuffer_put(fb);
 672                 }
 673         }
 674
 675         if (!list_empty(&arg.fbs)) {
 676                 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
 677
 678                 schedule_work(&arg.work);
 679                 flush_work(&arg.work);
 680                 destroy_work_on_stack(&arg.work);
 681         }
 682 }
 683
 684 void drm_framebuffer_free(struct kref *kref)
 685 {
 686         struct drm_framebuffer *fb =
 687                         container_of(kref, struct drm_framebuffer, base.refcount);
 688         struct drm_device *dev = fb->dev;
 689
 690         /*
 691          * The lookup idr holds a weak reference, which has not necessarily been
 692          * removed at this point. Check for that.
 693          */
 694         drm_mode_object_unregister(dev, &fb->base);
 695
 696         fb->funcs->destroy(fb);
 697 }
 698
 699 /**
 700  * drm_framebuffer_init - initialize a framebuffer
 701  * @dev: DRM device
 702  * @fb: framebuffer to be initialized
 703  * @funcs: ... with these functions
 704  *
 705  * Allocates an ID for the framebuffer's parent mode object, sets its mode
 706  * functions & device file and adds it to the master fd list.
 707  *
 708  * IMPORTANT:
 709  * This functions publishes the fb and makes it available for concurrent access
 710  * by other users. Which means by this point the fb _must_ be fully set up -
 711  * since all the fb attributes are invariant over its lifetime, no further
 712  * locking but only correct reference counting is required.
 713  *
 714  * Returns:
 715  * Zero on success, error code on failure.
 716  */
 717 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
 718                          const struct drm_framebuffer_funcs *funcs)
 719 {
 720         int ret;
 721
 722         if (WARN_ON_ONCE(fb->dev != dev || !fb->format))
 723                 return -EINVAL;
 724
 725         INIT_LIST_HEAD(&fb->filp_head);
 726
 727         fb->funcs = funcs;
 728         strcpy(fb->comm, current->comm);
 729
 730         ret = __drm_mode_object_add(dev, &fb->base, DRM_MODE_OBJECT_FB,
 731                                     false, drm_framebuffer_free);
 732         if (ret)
 733                 goto out;
 734
 735         mutex_lock(&dev->mode_config.fb_lock);
 736         dev->mode_config.num_fb++;
 737         list_add(&fb->head, &dev->mode_config.fb_list);
 738         mutex_unlock(&dev->mode_config.fb_lock);
 739
 740         drm_mode_object_register(dev, &fb->base);
 741 out:
 742         return ret;
 743 }
 744 EXPORT_SYMBOL(drm_framebuffer_init);
 745
 746 /**
 747  * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
 748  * @dev: drm device
 749  * @file_priv: drm file to check for lease against.
 750  * @id: id of the fb object
 751  *
 752  * If successful, this grabs an additional reference to the framebuffer -
 753  * callers need to make sure to eventually unreference the returned framebuffer
 754  * again, using drm_framebuffer_put().
 755  */
 756 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
 757                                                struct drm_file *file_priv,
 758                                                uint32_t id)
 759 {
 760         struct drm_mode_object *obj;
 761         struct drm_framebuffer *fb = NULL;
 762
 763         obj = __drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_FB);
 764         if (obj)
 765                 fb = obj_to_fb(obj);
 766         return fb;
 767 }
 768 EXPORT_SYMBOL(drm_framebuffer_lookup);
 769
 770 /**
 771  * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
 772  * @fb: fb to unregister
 773  *
 774  * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
 775  * those used for fbdev. Note that the caller must hold a reference of it's own,
 776  * i.e. the object may not be destroyed through this call (since it'll lead to a
 777  * locking inversion).
 778  *
 779  * NOTE: This function is deprecated. For driver-private framebuffers it is not
 780  * recommended to embed a framebuffer struct info fbdev struct, instead, a
 781  * framebuffer pointer is preferred and drm_framebuffer_put() should be called
 782  * when the framebuffer is to be cleaned up.
 783  */
 784 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
 785 {
 786         struct drm_device *dev;
 787
 788         if (!fb)
 789                 return;
 790
 791         dev = fb->dev;
 792
 793         /* Mark fb as reaped and drop idr ref. */
 794         drm_mode_object_unregister(dev, &fb->base);
 795 }
 796 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
 797
 798 /**
 799  * drm_framebuffer_cleanup - remove a framebuffer object
 800  * @fb: framebuffer to remove
 801  *
 802  * Cleanup framebuffer. This function is intended to be used from the drivers
 803  * &drm_framebuffer_funcs.destroy callback. It can also be used to clean up
 804  * driver private framebuffers embedded into a larger structure.
 805  *
 806  * Note that this function does not remove the fb from active usage - if it is
 807  * still used anywhere, hilarity can ensue since userspace could call getfb on
 808  * the id and get back -EINVAL. Obviously no concern at driver unload time.
 809  *
 810  * Also, the framebuffer will not be removed from the lookup idr - for
 811  * user-created framebuffers this will happen in in the rmfb ioctl. For
 812  * driver-private objects (e.g. for fbdev) drivers need to explicitly call
 813  * drm_framebuffer_unregister_private.
 814  */
 815 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
 816 {
 817         struct drm_device *dev = fb->dev;
 818
 819         mutex_lock(&dev->mode_config.fb_lock);
 820         list_del(&fb->head);
 821         dev->mode_config.num_fb--;
 822         mutex_unlock(&dev->mode_config.fb_lock);
 823 }
 824 EXPORT_SYMBOL(drm_framebuffer_cleanup);
 825
 826 static int atomic_remove_fb(struct drm_framebuffer *fb)
 827 {
 828         struct drm_modeset_acquire_ctx ctx;
 829         struct drm_device *dev = fb->dev;
 830         struct drm_atomic_state *state;
 831         struct drm_plane *plane;
 832         struct drm_connector *conn;
 833         struct drm_connector_state *conn_state;
 834         int i, ret;
 835         unsigned plane_mask;
 836         bool disable_crtcs = false;
 837
 838 retry_disable:
 839         drm_modeset_acquire_init(&ctx, 0);
 840
 841         state = drm_atomic_state_alloc(dev);
 842         if (!state) {
 843                 ret = -ENOMEM;
 844                 goto out;
 845         }
 846         state->acquire_ctx = &ctx;
 847
 848 retry:
 849         plane_mask = 0;
 850         ret = drm_modeset_lock_all_ctx(dev, &ctx);
 851         if (ret)
 852                 goto unlock;
 853
 854         drm_for_each_plane(plane, dev) {
 855                 struct drm_plane_state *plane_state;
 856
 857                 if (plane->state->fb != fb)
 858                         continue;
 859
 860                 plane_state = drm_atomic_get_plane_state(state, plane);
 861                 if (IS_ERR(plane_state)) {
 862                         ret = PTR_ERR(plane_state);
 863                         goto unlock;
 864                 }
 865
 866                 if (disable_crtcs && plane_state->crtc->primary == plane) {
 867                         struct drm_crtc_state *crtc_state;
 868
 869                         crtc_state = drm_atomic_get_existing_crtc_state(state, plane_state->crtc);
 870
 871                         ret = drm_atomic_add_affected_connectors(state, plane_state->crtc);
 872                         if (ret)
 873                                 goto unlock;
 874
 875                         crtc_state->active = false;
 876                         ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
 877                         if (ret)
 878                                 goto unlock;
 879                 }
 880
 881                 drm_atomic_set_fb_for_plane(plane_state, NULL);
 882                 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
 883                 if (ret)
 884                         goto unlock;
 885
 886                 plane_mask |= drm_plane_mask(plane);
 887         }
 888
 889         /* This list is only filled when disable_crtcs is set. */
 890         for_each_new_connector_in_state(state, conn, conn_state, i) {
 891                 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
 892
 893                 if (ret)
 894                         goto unlock;
 895         }
 896
 897         if (plane_mask)
 898                 ret = drm_atomic_commit(state);
 899
 900 unlock:
 901         if (ret == -EDEADLK) {
 902                 drm_atomic_state_clear(state);
 903                 drm_modeset_backoff(&ctx);
 904                 goto retry;
 905         }
 906
 907         drm_atomic_state_put(state);
 908
 909 out:
 910         drm_modeset_drop_locks(&ctx);
 911         drm_modeset_acquire_fini(&ctx);
 912
 913         if (ret == -EINVAL && !disable_crtcs) {
 914                 disable_crtcs = true;
 915                 goto retry_disable;
 916         }
 917
 918         return ret;
 919 }
 920
 921 static void legacy_remove_fb(struct drm_framebuffer *fb)
 922 {
 923         struct drm_device *dev = fb->dev;
 924         struct drm_crtc *crtc;
 925         struct drm_plane *plane;
 926
 927         drm_modeset_lock_all(dev);
 928         /* remove from any CRTC */
 929         drm_for_each_crtc(crtc, dev) {
 930                 if (crtc->primary->fb == fb) {
 931                         /* should turn off the crtc */
 932                         if (drm_crtc_force_disable(crtc))
 933                                 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
 934                 }
 935         }
 936
 937         drm_for_each_plane(plane, dev) {
 938                 if (plane->fb == fb)
 939                         drm_plane_force_disable(plane);
 940         }
 941         drm_modeset_unlock_all(dev);
 942 }
 943
 944 /**
 945  * drm_framebuffer_remove - remove and unreference a framebuffer object
 946  * @fb: framebuffer to remove
 947  *
 948  * Scans all the CRTCs and planes in @dev's mode_config.  If they're
 949  * using @fb, removes it, setting it to NULL. Then drops the reference to the
 950  * passed-in framebuffer. Might take the modeset locks.
 951  *
 952  * Note that this function optimizes the cleanup away if the caller holds the
 953  * last reference to the framebuffer. It is also guaranteed to not take the
 954  * modeset locks in this case.
 955  */
 956 void drm_framebuffer_remove(struct drm_framebuffer *fb)
 957 {
 958         struct drm_device *dev;
 959
 960         if (!fb)
 961                 return;
 962
 963         dev = fb->dev;
 964
 965         WARN_ON(!list_empty(&fb->filp_head));
 966
 967         /*
 968          * drm ABI mandates that we remove any deleted framebuffers from active
 969          * useage. But since most sane clients only remove framebuffers they no
 970          * longer need, try to optimize this away.
 971          *
 972          * Since we're holding a reference ourselves, observing a refcount of 1
 973          * means that we're the last holder and can skip it. Also, the refcount
 974          * can never increase from 1 again, so we don't need any barriers or
 975          * locks.
 976          *
 977          * Note that userspace could try to race with use and instate a new
 978          * usage _after_ we've cleared all current ones. End result will be an
 979          * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
 980          * in this manner.
 981          */
 982         if (drm_framebuffer_read_refcount(fb) > 1) {
 983                 if (drm_drv_uses_atomic_modeset(dev)) {
 984                         int ret = atomic_remove_fb(fb);
 985                         WARN(ret, "atomic remove_fb failed with %i\n", ret);
 986                 } else
 987                         legacy_remove_fb(fb);
 988         }
 989
 990         drm_framebuffer_put(fb);
 991 }
 992 EXPORT_SYMBOL(drm_framebuffer_remove);
 993
 994 /**
 995  * drm_framebuffer_plane_width - width of the plane given the first plane
 996  * @width: width of the first plane
 997  * @fb: the framebuffer
 998  * @plane: plane index
 999  *
1000  * Returns:
1001  * The width of @plane, given that the width of the first plane is @width.
1002  */
1003 int drm_framebuffer_plane_width(int width,
1004                                 const struct drm_framebuffer *fb, int plane)
1005 {
1006         if (plane >= fb->format->num_planes)
1007                 return 0;
1008
1009         return fb_plane_width(width, fb->format, plane);
1010 }
1011 EXPORT_SYMBOL(drm_framebuffer_plane_width);
1012
1013 /**
1014  * drm_framebuffer_plane_height - height of the plane given the first plane
1015  * @height: height of the first plane
1016  * @fb: the framebuffer
1017  * @plane: plane index
1018  *
1019  * Returns:
1020  * The height of @plane, given that the height of the first plane is @height.
1021  */
1022 int drm_framebuffer_plane_height(int height,
1023                                  const struct drm_framebuffer *fb, int plane)
1024 {
1025         if (plane >= fb->format->num_planes)
1026                 return 0;
1027
1028         return fb_plane_height(height, fb->format, plane);
1029 }
1030 EXPORT_SYMBOL(drm_framebuffer_plane_height);
1031
1032 void drm_framebuffer_print_info(struct drm_printer *p, unsigned int indent,
1033                                 const struct drm_framebuffer *fb)
1034 {
1035         struct drm_format_name_buf format_name;
1036         unsigned int i;
1037
1038         drm_printf_indent(p, indent, "allocated by = %s\n", fb->comm);
1039         drm_printf_indent(p, indent, "refcount=%u\n",
1040                           drm_framebuffer_read_refcount(fb));
1041         drm_printf_indent(p, indent, "format=%s\n",
1042                           drm_get_format_name(fb->format->format, &format_name));
1043         drm_printf_indent(p, indent, "modifier=0x%llx\n", fb->modifier);
1044         drm_printf_indent(p, indent, "size=%ux%u\n", fb->width, fb->height);
1045         drm_printf_indent(p, indent, "layers:\n");
1046
1047         for (i = 0; i < fb->format->num_planes; i++) {
1048                 drm_printf_indent(p, indent + 1, "size[%u]=%dx%d\n", i,
1049                                   drm_framebuffer_plane_width(fb->width, fb, i),
1050                                   drm_framebuffer_plane_height(fb->height, fb, i));
1051                 drm_printf_indent(p, indent + 1, "pitch[%u]=%u\n", i, fb->pitches[i]);
1052                 drm_printf_indent(p, indent + 1, "offset[%u]=%u\n", i, fb->offsets[i]);
1053                 drm_printf_indent(p, indent + 1, "obj[%u]:%s\n", i,
1054                                   fb->obj[i] ? "" : "(null)");
1055                 if (fb->obj[i])
1056                         drm_gem_print_info(p, indent + 2, fb->obj[i]);
1057         }
1058 }
1059
1060 #ifdef CONFIG_DEBUG_FS
1061 static int drm_framebuffer_info(struct seq_file *m, void *data)
1062 {
1063         struct drm_info_node *node = m->private;
1064         struct drm_device *dev = node->minor->dev;
1065         struct drm_printer p = drm_seq_file_printer(m);
1066         struct drm_framebuffer *fb;
1067
1068         mutex_lock(&dev->mode_config.fb_lock);
1069         drm_for_each_fb(fb, dev) {
1070                 drm_printf(&p, "framebuffer[%u]:\n", fb->base.id);
1071                 drm_framebuffer_print_info(&p, 1, fb);
1072         }
1073         mutex_unlock(&dev->mode_config.fb_lock);
1074
1075         return 0;
1076 }
1077
1078 static const struct drm_info_list drm_framebuffer_debugfs_list[] = {
1079         { "framebuffer", drm_framebuffer_info, 0 },
1080 };
1081
1082 int drm_framebuffer_debugfs_init(struct drm_minor *minor)
1083 {
1084         return drm_debugfs_create_files(drm_framebuffer_debugfs_list,
1085                                 ARRAY_SIZE(drm_framebuffer_debugfs_list),
1086                                 minor->debugfs_root, minor);
1087 }
1088 #endif