Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[sfrench/cifs-2.6.git] / 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 cpp = info->cpp[i];
199
200                 if (!r->handles[i]) {
201                         DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
202                         return -EINVAL;
203                 }
204
205                 if ((uint64_t) width * cpp > UINT_MAX)
206                         return -ERANGE;
207
208                 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
209                         return -ERANGE;
210
211                 if (r->pitches[i] < width * cpp) {
212                         DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
213                         return -EINVAL;
214                 }
215
216                 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
217                         DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
218                                       r->modifier[i], i);
219                         return -EINVAL;
220                 }
221
222                 if (r->flags & DRM_MODE_FB_MODIFIERS &&
223                     r->modifier[i] != r->modifier[0]) {
224                         DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
225                                       r->modifier[i], i);
226                         return -EINVAL;
227                 }
228
229                 /* modifier specific checks: */
230                 switch (r->modifier[i]) {
231                 case DRM_FORMAT_MOD_SAMSUNG_64_32_TILE:
232                         /* NOTE: the pitch restriction may be lifted later if it turns
233                          * out that no hw has this restriction:
234                          */
235                         if (r->pixel_format != DRM_FORMAT_NV12 ||
236                                         width % 128 || height % 32 ||
237                                         r->pitches[i] % 128) {
238                                 DRM_DEBUG_KMS("bad modifier data for plane %d\n", i);
239                                 return -EINVAL;
240                         }
241                         break;
242
243                 default:
244                         break;
245                 }
246         }
247
248         for (i = info->num_planes; i < 4; i++) {
249                 if (r->modifier[i]) {
250                         DRM_DEBUG_KMS("non-zero modifier for unused plane %d\n", i);
251                         return -EINVAL;
252                 }
253
254                 /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */
255                 if (!(r->flags & DRM_MODE_FB_MODIFIERS))
256                         continue;
257
258                 if (r->handles[i]) {
259                         DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i);
260                         return -EINVAL;
261                 }
262
263                 if (r->pitches[i]) {
264                         DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i);
265                         return -EINVAL;
266                 }
267
268                 if (r->offsets[i]) {
269                         DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i);
270                         return -EINVAL;
271                 }
272         }
273
274         return 0;
275 }
276
277 struct drm_framebuffer *
278 drm_internal_framebuffer_create(struct drm_device *dev,
279                                 const struct drm_mode_fb_cmd2 *r,
280                                 struct drm_file *file_priv)
281 {
282         struct drm_mode_config *config = &dev->mode_config;
283         struct drm_framebuffer *fb;
284         int ret;
285
286         if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
287                 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
288                 return ERR_PTR(-EINVAL);
289         }
290
291         if ((config->min_width > r->width) || (r->width > config->max_width)) {
292                 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
293                           r->width, config->min_width, config->max_width);
294                 return ERR_PTR(-EINVAL);
295         }
296         if ((config->min_height > r->height) || (r->height > config->max_height)) {
297                 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
298                           r->height, config->min_height, config->max_height);
299                 return ERR_PTR(-EINVAL);
300         }
301
302         if (r->flags & DRM_MODE_FB_MODIFIERS &&
303             !dev->mode_config.allow_fb_modifiers) {
304                 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
305                 return ERR_PTR(-EINVAL);
306         }
307
308         ret = framebuffer_check(dev, r);
309         if (ret)
310                 return ERR_PTR(ret);
311
312         fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
313         if (IS_ERR(fb)) {
314                 DRM_DEBUG_KMS("could not create framebuffer\n");
315                 return fb;
316         }
317
318         return fb;
319 }
320
321 /**
322  * drm_mode_addfb2 - add an FB to the graphics configuration
323  * @dev: drm device for the ioctl
324  * @data: data pointer for the ioctl
325  * @file_priv: drm file for the ioctl call
326  *
327  * Add a new FB to the specified CRTC, given a user request with format. This is
328  * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
329  * and uses fourcc codes as pixel format specifiers.
330  *
331  * Called by the user via ioctl.
332  *
333  * Returns:
334  * Zero on success, negative errno on failure.
335  */
336 int drm_mode_addfb2(struct drm_device *dev,
337                     void *data, struct drm_file *file_priv)
338 {
339         struct drm_mode_fb_cmd2 *r = data;
340         struct drm_framebuffer *fb;
341
342         if (!drm_core_check_feature(dev, DRIVER_MODESET))
343                 return -EOPNOTSUPP;
344
345         fb = drm_internal_framebuffer_create(dev, r, file_priv);
346         if (IS_ERR(fb))
347                 return PTR_ERR(fb);
348
349         DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
350         r->fb_id = fb->base.id;
351
352         /* Transfer ownership to the filp for reaping on close */
353         mutex_lock(&file_priv->fbs_lock);
354         list_add(&fb->filp_head, &file_priv->fbs);
355         mutex_unlock(&file_priv->fbs_lock);
356
357         return 0;
358 }
359
360 int drm_mode_addfb2_ioctl(struct drm_device *dev,
361                           void *data, struct drm_file *file_priv)
362 {
363 #ifdef __BIG_ENDIAN
364         if (!dev->mode_config.quirk_addfb_prefer_host_byte_order) {
365                 /*
366                  * Drivers must set the
367                  * quirk_addfb_prefer_host_byte_order quirk to make
368                  * the drm_mode_addfb() compat code work correctly on
369                  * bigendian machines.
370                  *
371                  * If they don't they interpret pixel_format values
372                  * incorrectly for bug compatibility, which in turn
373                  * implies the ADDFB2 ioctl does not work correctly
374                  * then.  So block it to make userspace fallback to
375                  * ADDFB.
376                  */
377                 DRM_DEBUG_KMS("addfb2 broken on bigendian");
378                 return -EOPNOTSUPP;
379         }
380 #endif
381         return drm_mode_addfb2(dev, data, file_priv);
382 }
383
384 struct drm_mode_rmfb_work {
385         struct work_struct work;
386         struct list_head fbs;
387 };
388
389 static void drm_mode_rmfb_work_fn(struct work_struct *w)
390 {
391         struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work);
392
393         while (!list_empty(&arg->fbs)) {
394                 struct drm_framebuffer *fb =
395                         list_first_entry(&arg->fbs, typeof(*fb), filp_head);
396
397                 list_del_init(&fb->filp_head);
398                 drm_framebuffer_remove(fb);
399         }
400 }
401
402 /**
403  * drm_mode_rmfb - remove an FB from the configuration
404  * @dev: drm device
405  * @fb_id: id of framebuffer to remove
406  * @file_priv: drm file
407  *
408  * Remove the specified FB.
409  *
410  * Called by the user via ioctl, or by an in-kernel client.
411  *
412  * Returns:
413  * Zero on success, negative errno on failure.
414  */
415 int drm_mode_rmfb(struct drm_device *dev, u32 fb_id,
416                   struct drm_file *file_priv)
417 {
418         struct drm_framebuffer *fb = NULL;
419         struct drm_framebuffer *fbl = NULL;
420         int found = 0;
421
422         if (!drm_core_check_feature(dev, DRIVER_MODESET))
423                 return -EOPNOTSUPP;
424
425         fb = drm_framebuffer_lookup(dev, file_priv, fb_id);
426         if (!fb)
427                 return -ENOENT;
428
429         mutex_lock(&file_priv->fbs_lock);
430         list_for_each_entry(fbl, &file_priv->fbs, filp_head)
431                 if (fb == fbl)
432                         found = 1;
433         if (!found) {
434                 mutex_unlock(&file_priv->fbs_lock);
435                 goto fail_unref;
436         }
437
438         list_del_init(&fb->filp_head);
439         mutex_unlock(&file_priv->fbs_lock);
440
441         /* drop the reference we picked up in framebuffer lookup */
442         drm_framebuffer_put(fb);
443
444         /*
445          * we now own the reference that was stored in the fbs list
446          *
447          * drm_framebuffer_remove may fail with -EINTR on pending signals,
448          * so run this in a separate stack as there's no way to correctly
449          * handle this after the fb is already removed from the lookup table.
450          */
451         if (drm_framebuffer_read_refcount(fb) > 1) {
452                 struct drm_mode_rmfb_work arg;
453
454                 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
455                 INIT_LIST_HEAD(&arg.fbs);
456                 list_add_tail(&fb->filp_head, &arg.fbs);
457
458                 schedule_work(&arg.work);
459                 flush_work(&arg.work);
460                 destroy_work_on_stack(&arg.work);
461         } else
462                 drm_framebuffer_put(fb);
463
464         return 0;
465
466 fail_unref:
467         drm_framebuffer_put(fb);
468         return -ENOENT;
469 }
470
471 int drm_mode_rmfb_ioctl(struct drm_device *dev,
472                         void *data, struct drm_file *file_priv)
473 {
474         uint32_t *fb_id = data;
475
476         return drm_mode_rmfb(dev, *fb_id, file_priv);
477 }
478
479 /**
480  * drm_mode_getfb - get FB info
481  * @dev: drm device for the ioctl
482  * @data: data pointer for the ioctl
483  * @file_priv: drm file for the ioctl call
484  *
485  * Lookup the FB given its ID and return info about it.
486  *
487  * Called by the user via ioctl.
488  *
489  * Returns:
490  * Zero on success, negative errno on failure.
491  */
492 int drm_mode_getfb(struct drm_device *dev,
493                    void *data, struct drm_file *file_priv)
494 {
495         struct drm_mode_fb_cmd *r = data;
496         struct drm_framebuffer *fb;
497         int ret;
498
499         if (!drm_core_check_feature(dev, DRIVER_MODESET))
500                 return -EOPNOTSUPP;
501
502         fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
503         if (!fb)
504                 return -ENOENT;
505
506         /* Multi-planar framebuffers need getfb2. */
507         if (fb->format->num_planes > 1) {
508                 ret = -EINVAL;
509                 goto out;
510         }
511
512         if (!fb->funcs->create_handle) {
513                 ret = -ENODEV;
514                 goto out;
515         }
516
517         r->height = fb->height;
518         r->width = fb->width;
519         r->depth = fb->format->depth;
520         r->bpp = fb->format->cpp[0] * 8;
521         r->pitch = fb->pitches[0];
522
523         /* GET_FB() is an unprivileged ioctl so we must not return a
524          * buffer-handle to non-master processes! For
525          * backwards-compatibility reasons, we cannot make GET_FB() privileged,
526          * so just return an invalid handle for non-masters.
527          */
528         if (!drm_is_current_master(file_priv) && !capable(CAP_SYS_ADMIN)) {
529                 r->handle = 0;
530                 ret = 0;
531                 goto out;
532         }
533
534         ret = fb->funcs->create_handle(fb, file_priv, &r->handle);
535
536 out:
537         drm_framebuffer_put(fb);
538
539         return ret;
540 }
541
542 /**
543  * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
544  * @dev: drm device for the ioctl
545  * @data: data pointer for the ioctl
546  * @file_priv: drm file for the ioctl call
547  *
548  * Lookup the FB and flush out the damaged area supplied by userspace as a clip
549  * rectangle list. Generic userspace which does frontbuffer rendering must call
550  * this ioctl to flush out the changes on manual-update display outputs, e.g.
551  * usb display-link, mipi manual update panels or edp panel self refresh modes.
552  *
553  * Modesetting drivers which always update the frontbuffer do not need to
554  * implement the corresponding &drm_framebuffer_funcs.dirty callback.
555  *
556  * Called by the user via ioctl.
557  *
558  * Returns:
559  * Zero on success, negative errno on failure.
560  */
561 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
562                            void *data, struct drm_file *file_priv)
563 {
564         struct drm_clip_rect __user *clips_ptr;
565         struct drm_clip_rect *clips = NULL;
566         struct drm_mode_fb_dirty_cmd *r = data;
567         struct drm_framebuffer *fb;
568         unsigned flags;
569         int num_clips;
570         int ret;
571
572         if (!drm_core_check_feature(dev, DRIVER_MODESET))
573                 return -EOPNOTSUPP;
574
575         fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
576         if (!fb)
577                 return -ENOENT;
578
579         num_clips = r->num_clips;
580         clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
581
582         if (!num_clips != !clips_ptr) {
583                 ret = -EINVAL;
584                 goto out_err1;
585         }
586
587         flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
588
589         /* If userspace annotates copy, clips must come in pairs */
590         if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
591                 ret = -EINVAL;
592                 goto out_err1;
593         }
594
595         if (num_clips && clips_ptr) {
596                 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
597                         ret = -EINVAL;
598                         goto out_err1;
599                 }
600                 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
601                 if (!clips) {
602                         ret = -ENOMEM;
603                         goto out_err1;
604                 }
605
606                 ret = copy_from_user(clips, clips_ptr,
607                                      num_clips * sizeof(*clips));
608                 if (ret) {
609                         ret = -EFAULT;
610                         goto out_err2;
611                 }
612         }
613
614         if (fb->funcs->dirty) {
615                 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
616                                        clips, num_clips);
617         } else {
618                 ret = -ENOSYS;
619         }
620
621 out_err2:
622         kfree(clips);
623 out_err1:
624         drm_framebuffer_put(fb);
625
626         return ret;
627 }
628
629 /**
630  * drm_fb_release - remove and free the FBs on this file
631  * @priv: drm file for the ioctl
632  *
633  * Destroy all the FBs associated with @filp.
634  *
635  * Called by the user via ioctl.
636  *
637  * Returns:
638  * Zero on success, negative errno on failure.
639  */
640 void drm_fb_release(struct drm_file *priv)
641 {
642         struct drm_framebuffer *fb, *tfb;
643         struct drm_mode_rmfb_work arg;
644
645         INIT_LIST_HEAD(&arg.fbs);
646
647         /*
648          * When the file gets released that means no one else can access the fb
649          * list any more, so no need to grab fpriv->fbs_lock. And we need to
650          * avoid upsetting lockdep since the universal cursor code adds a
651          * framebuffer while holding mutex locks.
652          *
653          * Note that a real deadlock between fpriv->fbs_lock and the modeset
654          * locks is impossible here since no one else but this function can get
655          * at it any more.
656          */
657         list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
658                 if (drm_framebuffer_read_refcount(fb) > 1) {
659                         list_move_tail(&fb->filp_head, &arg.fbs);
660                 } else {
661                         list_del_init(&fb->filp_head);
662
663                         /* This drops the fpriv->fbs reference. */
664                         drm_framebuffer_put(fb);
665                 }
666         }
667
668         if (!list_empty(&arg.fbs)) {
669                 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
670
671                 schedule_work(&arg.work);
672                 flush_work(&arg.work);
673                 destroy_work_on_stack(&arg.work);
674         }
675 }
676
677 void drm_framebuffer_free(struct kref *kref)
678 {
679         struct drm_framebuffer *fb =
680                         container_of(kref, struct drm_framebuffer, base.refcount);
681         struct drm_device *dev = fb->dev;
682
683         /*
684          * The lookup idr holds a weak reference, which has not necessarily been
685          * removed at this point. Check for that.
686          */
687         drm_mode_object_unregister(dev, &fb->base);
688
689         fb->funcs->destroy(fb);
690 }
691
692 /**
693  * drm_framebuffer_init - initialize a framebuffer
694  * @dev: DRM device
695  * @fb: framebuffer to be initialized
696  * @funcs: ... with these functions
697  *
698  * Allocates an ID for the framebuffer's parent mode object, sets its mode
699  * functions & device file and adds it to the master fd list.
700  *
701  * IMPORTANT:
702  * This functions publishes the fb and makes it available for concurrent access
703  * by other users. Which means by this point the fb _must_ be fully set up -
704  * since all the fb attributes are invariant over its lifetime, no further
705  * locking but only correct reference counting is required.
706  *
707  * Returns:
708  * Zero on success, error code on failure.
709  */
710 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
711                          const struct drm_framebuffer_funcs *funcs)
712 {
713         int ret;
714
715         if (WARN_ON_ONCE(fb->dev != dev || !fb->format))
716                 return -EINVAL;
717
718         INIT_LIST_HEAD(&fb->filp_head);
719
720         fb->funcs = funcs;
721         strcpy(fb->comm, current->comm);
722
723         ret = __drm_mode_object_add(dev, &fb->base, DRM_MODE_OBJECT_FB,
724                                     false, drm_framebuffer_free);
725         if (ret)
726                 goto out;
727
728         mutex_lock(&dev->mode_config.fb_lock);
729         dev->mode_config.num_fb++;
730         list_add(&fb->head, &dev->mode_config.fb_list);
731         mutex_unlock(&dev->mode_config.fb_lock);
732
733         drm_mode_object_register(dev, &fb->base);
734 out:
735         return ret;
736 }
737 EXPORT_SYMBOL(drm_framebuffer_init);
738
739 /**
740  * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
741  * @dev: drm device
742  * @file_priv: drm file to check for lease against.
743  * @id: id of the fb object
744  *
745  * If successful, this grabs an additional reference to the framebuffer -
746  * callers need to make sure to eventually unreference the returned framebuffer
747  * again, using drm_framebuffer_put().
748  */
749 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
750                                                struct drm_file *file_priv,
751                                                uint32_t id)
752 {
753         struct drm_mode_object *obj;
754         struct drm_framebuffer *fb = NULL;
755
756         obj = __drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_FB);
757         if (obj)
758                 fb = obj_to_fb(obj);
759         return fb;
760 }
761 EXPORT_SYMBOL(drm_framebuffer_lookup);
762
763 /**
764  * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
765  * @fb: fb to unregister
766  *
767  * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
768  * those used for fbdev. Note that the caller must hold a reference of it's own,
769  * i.e. the object may not be destroyed through this call (since it'll lead to a
770  * locking inversion).
771  *
772  * NOTE: This function is deprecated. For driver-private framebuffers it is not
773  * recommended to embed a framebuffer struct info fbdev struct, instead, a
774  * framebuffer pointer is preferred and drm_framebuffer_put() should be called
775  * when the framebuffer is to be cleaned up.
776  */
777 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
778 {
779         struct drm_device *dev;
780
781         if (!fb)
782                 return;
783
784         dev = fb->dev;
785
786         /* Mark fb as reaped and drop idr ref. */
787         drm_mode_object_unregister(dev, &fb->base);
788 }
789 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
790
791 /**
792  * drm_framebuffer_cleanup - remove a framebuffer object
793  * @fb: framebuffer to remove
794  *
795  * Cleanup framebuffer. This function is intended to be used from the drivers
796  * &drm_framebuffer_funcs.destroy callback. It can also be used to clean up
797  * driver private framebuffers embedded into a larger structure.
798  *
799  * Note that this function does not remove the fb from active usage - if it is
800  * still used anywhere, hilarity can ensue since userspace could call getfb on
801  * the id and get back -EINVAL. Obviously no concern at driver unload time.
802  *
803  * Also, the framebuffer will not be removed from the lookup idr - for
804  * user-created framebuffers this will happen in in the rmfb ioctl. For
805  * driver-private objects (e.g. for fbdev) drivers need to explicitly call
806  * drm_framebuffer_unregister_private.
807  */
808 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
809 {
810         struct drm_device *dev = fb->dev;
811
812         mutex_lock(&dev->mode_config.fb_lock);
813         list_del(&fb->head);
814         dev->mode_config.num_fb--;
815         mutex_unlock(&dev->mode_config.fb_lock);
816 }
817 EXPORT_SYMBOL(drm_framebuffer_cleanup);
818
819 static int atomic_remove_fb(struct drm_framebuffer *fb)
820 {
821         struct drm_modeset_acquire_ctx ctx;
822         struct drm_device *dev = fb->dev;
823         struct drm_atomic_state *state;
824         struct drm_plane *plane;
825         struct drm_connector *conn;
826         struct drm_connector_state *conn_state;
827         int i, ret;
828         unsigned plane_mask;
829         bool disable_crtcs = false;
830
831 retry_disable:
832         drm_modeset_acquire_init(&ctx, 0);
833
834         state = drm_atomic_state_alloc(dev);
835         if (!state) {
836                 ret = -ENOMEM;
837                 goto out;
838         }
839         state->acquire_ctx = &ctx;
840
841 retry:
842         plane_mask = 0;
843         ret = drm_modeset_lock_all_ctx(dev, &ctx);
844         if (ret)
845                 goto unlock;
846
847         drm_for_each_plane(plane, dev) {
848                 struct drm_plane_state *plane_state;
849
850                 if (plane->state->fb != fb)
851                         continue;
852
853                 plane_state = drm_atomic_get_plane_state(state, plane);
854                 if (IS_ERR(plane_state)) {
855                         ret = PTR_ERR(plane_state);
856                         goto unlock;
857                 }
858
859                 if (disable_crtcs && plane_state->crtc->primary == plane) {
860                         struct drm_crtc_state *crtc_state;
861
862                         crtc_state = drm_atomic_get_existing_crtc_state(state, plane_state->crtc);
863
864                         ret = drm_atomic_add_affected_connectors(state, plane_state->crtc);
865                         if (ret)
866                                 goto unlock;
867
868                         crtc_state->active = false;
869                         ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
870                         if (ret)
871                                 goto unlock;
872                 }
873
874                 drm_atomic_set_fb_for_plane(plane_state, NULL);
875                 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
876                 if (ret)
877                         goto unlock;
878
879                 plane_mask |= drm_plane_mask(plane);
880         }
881
882         /* This list is only filled when disable_crtcs is set. */
883         for_each_new_connector_in_state(state, conn, conn_state, i) {
884                 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
885
886                 if (ret)
887                         goto unlock;
888         }
889
890         if (plane_mask)
891                 ret = drm_atomic_commit(state);
892
893 unlock:
894         if (ret == -EDEADLK) {
895                 drm_atomic_state_clear(state);
896                 drm_modeset_backoff(&ctx);
897                 goto retry;
898         }
899
900         drm_atomic_state_put(state);
901
902 out:
903         drm_modeset_drop_locks(&ctx);
904         drm_modeset_acquire_fini(&ctx);
905
906         if (ret == -EINVAL && !disable_crtcs) {
907                 disable_crtcs = true;
908                 goto retry_disable;
909         }
910
911         return ret;
912 }
913
914 static void legacy_remove_fb(struct drm_framebuffer *fb)
915 {
916         struct drm_device *dev = fb->dev;
917         struct drm_crtc *crtc;
918         struct drm_plane *plane;
919
920         drm_modeset_lock_all(dev);
921         /* remove from any CRTC */
922         drm_for_each_crtc(crtc, dev) {
923                 if (crtc->primary->fb == fb) {
924                         /* should turn off the crtc */
925                         if (drm_crtc_force_disable(crtc))
926                                 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
927                 }
928         }
929
930         drm_for_each_plane(plane, dev) {
931                 if (plane->fb == fb)
932                         drm_plane_force_disable(plane);
933         }
934         drm_modeset_unlock_all(dev);
935 }
936
937 /**
938  * drm_framebuffer_remove - remove and unreference a framebuffer object
939  * @fb: framebuffer to remove
940  *
941  * Scans all the CRTCs and planes in @dev's mode_config.  If they're
942  * using @fb, removes it, setting it to NULL. Then drops the reference to the
943  * passed-in framebuffer. Might take the modeset locks.
944  *
945  * Note that this function optimizes the cleanup away if the caller holds the
946  * last reference to the framebuffer. It is also guaranteed to not take the
947  * modeset locks in this case.
948  */
949 void drm_framebuffer_remove(struct drm_framebuffer *fb)
950 {
951         struct drm_device *dev;
952
953         if (!fb)
954                 return;
955
956         dev = fb->dev;
957
958         WARN_ON(!list_empty(&fb->filp_head));
959
960         /*
961          * drm ABI mandates that we remove any deleted framebuffers from active
962          * useage. But since most sane clients only remove framebuffers they no
963          * longer need, try to optimize this away.
964          *
965          * Since we're holding a reference ourselves, observing a refcount of 1
966          * means that we're the last holder and can skip it. Also, the refcount
967          * can never increase from 1 again, so we don't need any barriers or
968          * locks.
969          *
970          * Note that userspace could try to race with use and instate a new
971          * usage _after_ we've cleared all current ones. End result will be an
972          * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
973          * in this manner.
974          */
975         if (drm_framebuffer_read_refcount(fb) > 1) {
976                 if (drm_drv_uses_atomic_modeset(dev)) {
977                         int ret = atomic_remove_fb(fb);
978                         WARN(ret, "atomic remove_fb failed with %i\n", ret);
979                 } else
980                         legacy_remove_fb(fb);
981         }
982
983         drm_framebuffer_put(fb);
984 }
985 EXPORT_SYMBOL(drm_framebuffer_remove);
986
987 /**
988  * drm_framebuffer_plane_width - width of the plane given the first plane
989  * @width: width of the first plane
990  * @fb: the framebuffer
991  * @plane: plane index
992  *
993  * Returns:
994  * The width of @plane, given that the width of the first plane is @width.
995  */
996 int drm_framebuffer_plane_width(int width,
997                                 const struct drm_framebuffer *fb, int plane)
998 {
999         if (plane >= fb->format->num_planes)
1000                 return 0;
1001
1002         return fb_plane_width(width, fb->format, plane);
1003 }
1004 EXPORT_SYMBOL(drm_framebuffer_plane_width);
1005
1006 /**
1007  * drm_framebuffer_plane_height - height of the plane given the first plane
1008  * @height: height of the first plane
1009  * @fb: the framebuffer
1010  * @plane: plane index
1011  *
1012  * Returns:
1013  * The height of @plane, given that the height of the first plane is @height.
1014  */
1015 int drm_framebuffer_plane_height(int height,
1016                                  const struct drm_framebuffer *fb, int plane)
1017 {
1018         if (plane >= fb->format->num_planes)
1019                 return 0;
1020
1021         return fb_plane_height(height, fb->format, plane);
1022 }
1023 EXPORT_SYMBOL(drm_framebuffer_plane_height);
1024
1025 void drm_framebuffer_print_info(struct drm_printer *p, unsigned int indent,
1026                                 const struct drm_framebuffer *fb)
1027 {
1028         struct drm_format_name_buf format_name;
1029         unsigned int i;
1030
1031         drm_printf_indent(p, indent, "allocated by = %s\n", fb->comm);
1032         drm_printf_indent(p, indent, "refcount=%u\n",
1033                           drm_framebuffer_read_refcount(fb));
1034         drm_printf_indent(p, indent, "format=%s\n",
1035                           drm_get_format_name(fb->format->format, &format_name));
1036         drm_printf_indent(p, indent, "modifier=0x%llx\n", fb->modifier);
1037         drm_printf_indent(p, indent, "size=%ux%u\n", fb->width, fb->height);
1038         drm_printf_indent(p, indent, "layers:\n");
1039
1040         for (i = 0; i < fb->format->num_planes; i++) {
1041                 drm_printf_indent(p, indent + 1, "size[%u]=%dx%d\n", i,
1042                                   drm_framebuffer_plane_width(fb->width, fb, i),
1043                                   drm_framebuffer_plane_height(fb->height, fb, i));
1044                 drm_printf_indent(p, indent + 1, "pitch[%u]=%u\n", i, fb->pitches[i]);
1045                 drm_printf_indent(p, indent + 1, "offset[%u]=%u\n", i, fb->offsets[i]);
1046                 drm_printf_indent(p, indent + 1, "obj[%u]:%s\n", i,
1047                                   fb->obj[i] ? "" : "(null)");
1048                 if (fb->obj[i])
1049                         drm_gem_print_info(p, indent + 2, fb->obj[i]);
1050         }
1051 }
1052
1053 #ifdef CONFIG_DEBUG_FS
1054 static int drm_framebuffer_info(struct seq_file *m, void *data)
1055 {
1056         struct drm_info_node *node = m->private;
1057         struct drm_device *dev = node->minor->dev;
1058         struct drm_printer p = drm_seq_file_printer(m);
1059         struct drm_framebuffer *fb;
1060
1061         mutex_lock(&dev->mode_config.fb_lock);
1062         drm_for_each_fb(fb, dev) {
1063                 drm_printf(&p, "framebuffer[%u]:\n", fb->base.id);
1064                 drm_framebuffer_print_info(&p, 1, fb);
1065         }
1066         mutex_unlock(&dev->mode_config.fb_lock);
1067
1068         return 0;
1069 }
1070
1071 static const struct drm_info_list drm_framebuffer_debugfs_list[] = {
1072         { "framebuffer", drm_framebuffer_info, 0 },
1073 };
1074
1075 int drm_framebuffer_debugfs_init(struct drm_minor *minor)
1076 {
1077         return drm_debugfs_create_files(drm_framebuffer_debugfs_list,
1078                                 ARRAY_SIZE(drm_framebuffer_debugfs_list),
1079                                 minor->debugfs_root, minor);
1080 }
1081 #endif