2 * Copyright (c) 2016 Intel Corporation
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.
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
23 #include <linux/export.h>
24 #include <linux/uaccess.h>
26 #include <drm/drm_atomic.h>
27 #include <drm/drm_atomic_uapi.h>
28 #include <drm/drm_auth.h>
29 #include <drm/drm_debugfs.h>
30 #include <drm/drm_drv.h>
31 #include <drm/drm_file.h>
32 #include <drm/drm_fourcc.h>
33 #include <drm/drm_framebuffer.h>
34 #include <drm/drm_gem.h>
35 #include <drm/drm_print.h>
36 #include <drm/drm_util.h>
38 #include "drm_crtc_internal.h"
39 #include "drm_internal.h"
44 * Frame buffers are abstract memory objects that provide a source of pixels to
45 * scanout to a CRTC. Applications explicitly request the creation of frame
46 * buffers through the DRM_IOCTL_MODE_ADDFB(2) ioctls and receive an opaque
47 * handle that can be passed to the KMS CRTC control, plane configuration and
48 * page flip functions.
50 * Frame buffers rely on the underlying memory manager for allocating backing
51 * storage. When creating a frame buffer applications pass a memory handle
52 * (or a list of memory handles for multi-planar formats) through the
53 * &struct drm_mode_fb_cmd2 argument. For drivers using GEM as their userspace
54 * buffer management interface this would be a GEM handle. Drivers are however
55 * free to use their own backing storage object handles, e.g. vmwgfx directly
56 * exposes special TTM handles to userspace and so expects TTM handles in the
57 * create ioctl and not GEM handles.
59 * Framebuffers are tracked with &struct drm_framebuffer. They are published
60 * using drm_framebuffer_init() - after calling that function userspace can use
61 * and access the framebuffer object. The helper function
62 * drm_helper_mode_fill_fb_struct() can be used to pre-fill the required
65 * The lifetime of a drm framebuffer is controlled with a reference count,
66 * drivers can grab additional references with drm_framebuffer_get() and drop
67 * them again with drm_framebuffer_put(). For driver-private framebuffers for
68 * which the last reference is never dropped (e.g. for the fbdev framebuffer
69 * when the struct &struct drm_framebuffer is embedded into the fbdev helper
70 * struct) drivers can manually clean up a framebuffer at module unload time
71 * with drm_framebuffer_unregister_private(). But doing this is not
72 * recommended, and it's better to have a normal free-standing &struct
76 int drm_framebuffer_check_src_coords(uint32_t src_x, uint32_t src_y,
77 uint32_t src_w, uint32_t src_h,
78 const struct drm_framebuffer *fb)
80 unsigned int fb_width, fb_height;
82 fb_width = fb->width << 16;
83 fb_height = fb->height << 16;
85 /* Make sure source coordinates are inside the fb. */
86 if (src_w > fb_width ||
87 src_x > fb_width - src_w ||
89 src_y > fb_height - src_h) {
90 DRM_DEBUG_KMS("Invalid source coordinates "
91 "%u.%06ux%u.%06u+%u.%06u+%u.%06u (fb %ux%u)\n",
92 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
93 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
94 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
95 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10,
96 fb->width, fb->height);
104 * drm_mode_addfb - add an FB to the graphics configuration
105 * @dev: drm device for the ioctl
106 * @or: pointer to request structure
107 * @file_priv: drm file
109 * Add a new FB to the specified CRTC, given a user request. This is the
110 * original addfb ioctl which only supported RGB formats.
112 * Called by the user via ioctl, or by an in-kernel client.
115 * Zero on success, negative errno on failure.
117 int drm_mode_addfb(struct drm_device *dev, struct drm_mode_fb_cmd *or,
118 struct drm_file *file_priv)
120 struct drm_mode_fb_cmd2 r = {};
123 if (!drm_core_check_feature(dev, DRIVER_MODESET))
126 r.pixel_format = drm_driver_legacy_fb_format(dev, or->bpp, or->depth);
127 if (r.pixel_format == DRM_FORMAT_INVALID) {
128 DRM_DEBUG("bad {bpp:%d, depth:%d}\n", or->bpp, or->depth);
132 /* convert to new format and call new ioctl */
135 r.height = or->height;
136 r.pitches[0] = or->pitch;
137 r.handles[0] = or->handle;
139 ret = drm_mode_addfb2(dev, &r, file_priv);
148 int drm_mode_addfb_ioctl(struct drm_device *dev,
149 void *data, struct drm_file *file_priv)
151 return drm_mode_addfb(dev, data, file_priv);
154 static int fb_plane_width(int width,
155 const struct drm_format_info *format, int plane)
160 return DIV_ROUND_UP(width, format->hsub);
163 static int fb_plane_height(int height,
164 const struct drm_format_info *format, int plane)
169 return DIV_ROUND_UP(height, format->vsub);
172 static int framebuffer_check(struct drm_device *dev,
173 const struct drm_mode_fb_cmd2 *r)
175 const struct drm_format_info *info;
178 /* check if the format is supported at all */
179 if (!__drm_format_info(r->pixel_format)) {
180 DRM_DEBUG_KMS("bad framebuffer format %p4cc\n",
186 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
190 if (r->height == 0) {
191 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
195 /* now let the driver pick its own format info */
196 info = drm_get_format_info(dev, r);
198 for (i = 0; i < info->num_planes; i++) {
199 unsigned int width = fb_plane_width(r->width, info, i);
200 unsigned int height = fb_plane_height(r->height, info, i);
201 unsigned int block_size = info->char_per_block[i];
202 u64 min_pitch = drm_format_info_min_pitch(info, i, width);
204 if (!block_size && (r->modifier[i] == DRM_FORMAT_MOD_LINEAR)) {
205 DRM_DEBUG_KMS("Format requires non-linear modifier for plane %d\n", i);
209 if (!r->handles[i]) {
210 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
214 if (min_pitch > UINT_MAX)
217 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
220 if (block_size && r->pitches[i] < min_pitch) {
221 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
225 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
226 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
231 if (r->flags & DRM_MODE_FB_MODIFIERS &&
232 r->modifier[i] != r->modifier[0]) {
233 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
238 /* modifier specific checks: */
239 switch (r->modifier[i]) {
240 case DRM_FORMAT_MOD_SAMSUNG_64_32_TILE:
241 /* NOTE: the pitch restriction may be lifted later if it turns
242 * out that no hw has this restriction:
244 if (r->pixel_format != DRM_FORMAT_NV12 ||
245 width % 128 || height % 32 ||
246 r->pitches[i] % 128) {
247 DRM_DEBUG_KMS("bad modifier data for plane %d\n", i);
257 for (i = info->num_planes; i < 4; i++) {
258 if (r->modifier[i]) {
259 DRM_DEBUG_KMS("non-zero modifier for unused plane %d\n", i);
263 /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */
264 if (!(r->flags & DRM_MODE_FB_MODIFIERS))
268 DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i);
273 DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i);
278 DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i);
286 struct drm_framebuffer *
287 drm_internal_framebuffer_create(struct drm_device *dev,
288 const struct drm_mode_fb_cmd2 *r,
289 struct drm_file *file_priv)
291 struct drm_mode_config *config = &dev->mode_config;
292 struct drm_framebuffer *fb;
295 if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
296 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
297 return ERR_PTR(-EINVAL);
300 if ((config->min_width > r->width) || (r->width > config->max_width)) {
301 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
302 r->width, config->min_width, config->max_width);
303 return ERR_PTR(-EINVAL);
305 if ((config->min_height > r->height) || (r->height > config->max_height)) {
306 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
307 r->height, config->min_height, config->max_height);
308 return ERR_PTR(-EINVAL);
311 if (r->flags & DRM_MODE_FB_MODIFIERS &&
312 dev->mode_config.fb_modifiers_not_supported) {
313 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
314 return ERR_PTR(-EINVAL);
317 ret = framebuffer_check(dev, r);
321 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
323 DRM_DEBUG_KMS("could not create framebuffer\n");
329 EXPORT_SYMBOL_FOR_TESTS_ONLY(drm_internal_framebuffer_create);
332 * drm_mode_addfb2 - add an FB to the graphics configuration
333 * @dev: drm device for the ioctl
334 * @data: data pointer for the ioctl
335 * @file_priv: drm file for the ioctl call
337 * Add a new FB to the specified CRTC, given a user request with format. This is
338 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
339 * and uses fourcc codes as pixel format specifiers.
341 * Called by the user via ioctl.
344 * Zero on success, negative errno on failure.
346 int drm_mode_addfb2(struct drm_device *dev,
347 void *data, struct drm_file *file_priv)
349 struct drm_mode_fb_cmd2 *r = data;
350 struct drm_framebuffer *fb;
352 if (!drm_core_check_feature(dev, DRIVER_MODESET))
355 fb = drm_internal_framebuffer_create(dev, r, file_priv);
359 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
360 r->fb_id = fb->base.id;
362 /* Transfer ownership to the filp for reaping on close */
363 mutex_lock(&file_priv->fbs_lock);
364 list_add(&fb->filp_head, &file_priv->fbs);
365 mutex_unlock(&file_priv->fbs_lock);
370 int drm_mode_addfb2_ioctl(struct drm_device *dev,
371 void *data, struct drm_file *file_priv)
374 if (!dev->mode_config.quirk_addfb_prefer_host_byte_order) {
376 * Drivers must set the
377 * quirk_addfb_prefer_host_byte_order quirk to make
378 * the drm_mode_addfb() compat code work correctly on
379 * bigendian machines.
381 * If they don't they interpret pixel_format values
382 * incorrectly for bug compatibility, which in turn
383 * implies the ADDFB2 ioctl does not work correctly
384 * then. So block it to make userspace fallback to
387 DRM_DEBUG_KMS("addfb2 broken on bigendian");
391 return drm_mode_addfb2(dev, data, file_priv);
394 struct drm_mode_rmfb_work {
395 struct work_struct work;
396 struct list_head fbs;
399 static void drm_mode_rmfb_work_fn(struct work_struct *w)
401 struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work);
403 while (!list_empty(&arg->fbs)) {
404 struct drm_framebuffer *fb =
405 list_first_entry(&arg->fbs, typeof(*fb), filp_head);
408 "Removing [FB:%d] from all active usage due to RMFB ioctl\n",
410 list_del_init(&fb->filp_head);
411 drm_framebuffer_remove(fb);
416 * drm_mode_rmfb - remove an FB from the configuration
418 * @fb_id: id of framebuffer to remove
419 * @file_priv: drm file
421 * Remove the specified FB.
423 * Called by the user via ioctl, or by an in-kernel client.
426 * Zero on success, negative errno on failure.
428 int drm_mode_rmfb(struct drm_device *dev, u32 fb_id,
429 struct drm_file *file_priv)
431 struct drm_framebuffer *fb = NULL;
432 struct drm_framebuffer *fbl = NULL;
435 if (!drm_core_check_feature(dev, DRIVER_MODESET))
438 fb = drm_framebuffer_lookup(dev, file_priv, fb_id);
442 mutex_lock(&file_priv->fbs_lock);
443 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
447 mutex_unlock(&file_priv->fbs_lock);
451 list_del_init(&fb->filp_head);
452 mutex_unlock(&file_priv->fbs_lock);
454 /* drop the reference we picked up in framebuffer lookup */
455 drm_framebuffer_put(fb);
458 * we now own the reference that was stored in the fbs list
460 * drm_framebuffer_remove may fail with -EINTR on pending signals,
461 * so run this in a separate stack as there's no way to correctly
462 * handle this after the fb is already removed from the lookup table.
464 if (drm_framebuffer_read_refcount(fb) > 1) {
465 struct drm_mode_rmfb_work arg;
467 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
468 INIT_LIST_HEAD(&arg.fbs);
469 list_add_tail(&fb->filp_head, &arg.fbs);
471 schedule_work(&arg.work);
472 flush_work(&arg.work);
473 destroy_work_on_stack(&arg.work);
475 drm_framebuffer_put(fb);
480 drm_framebuffer_put(fb);
484 int drm_mode_rmfb_ioctl(struct drm_device *dev,
485 void *data, struct drm_file *file_priv)
487 uint32_t *fb_id = data;
489 return drm_mode_rmfb(dev, *fb_id, file_priv);
493 * drm_mode_getfb - get FB info
494 * @dev: drm device for the ioctl
495 * @data: data pointer for the ioctl
496 * @file_priv: drm file for the ioctl call
498 * Lookup the FB given its ID and return info about it.
500 * Called by the user via ioctl.
503 * Zero on success, negative errno on failure.
505 int drm_mode_getfb(struct drm_device *dev,
506 void *data, struct drm_file *file_priv)
508 struct drm_mode_fb_cmd *r = data;
509 struct drm_framebuffer *fb;
512 if (!drm_core_check_feature(dev, DRIVER_MODESET))
515 fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
519 /* Multi-planar framebuffers need getfb2. */
520 if (fb->format->num_planes > 1) {
525 if (!fb->funcs->create_handle) {
530 r->height = fb->height;
531 r->width = fb->width;
532 r->depth = fb->format->depth;
533 r->bpp = fb->format->cpp[0] * 8;
534 r->pitch = fb->pitches[0];
536 /* GET_FB() is an unprivileged ioctl so we must not return a
537 * buffer-handle to non-master processes! For
538 * backwards-compatibility reasons, we cannot make GET_FB() privileged,
539 * so just return an invalid handle for non-masters.
541 if (!drm_is_current_master(file_priv) && !capable(CAP_SYS_ADMIN)) {
547 ret = fb->funcs->create_handle(fb, file_priv, &r->handle);
550 drm_framebuffer_put(fb);
555 * drm_mode_getfb2_ioctl - get extended FB info
556 * @dev: drm device for the ioctl
557 * @data: data pointer for the ioctl
558 * @file_priv: drm file for the ioctl call
560 * Lookup the FB given its ID and return info about it.
562 * Called by the user via ioctl.
565 * Zero on success, negative errno on failure.
567 int drm_mode_getfb2_ioctl(struct drm_device *dev,
568 void *data, struct drm_file *file_priv)
570 struct drm_mode_fb_cmd2 *r = data;
571 struct drm_framebuffer *fb;
575 if (!drm_core_check_feature(dev, DRIVER_MODESET))
578 fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
582 /* For multi-plane framebuffers, we require the driver to place the
583 * GEM objects directly in the drm_framebuffer. For single-plane
584 * framebuffers, we can fall back to create_handle.
587 (fb->format->num_planes > 1 || !fb->funcs->create_handle)) {
592 r->height = fb->height;
593 r->width = fb->width;
594 r->pixel_format = fb->format->format;
597 if (!dev->mode_config.fb_modifiers_not_supported)
598 r->flags |= DRM_MODE_FB_MODIFIERS;
600 for (i = 0; i < ARRAY_SIZE(r->handles); i++) {
607 for (i = 0; i < fb->format->num_planes; i++) {
608 r->pitches[i] = fb->pitches[i];
609 r->offsets[i] = fb->offsets[i];
610 if (!dev->mode_config.fb_modifiers_not_supported)
611 r->modifier[i] = fb->modifier;
614 /* GET_FB2() is an unprivileged ioctl so we must not return a
615 * buffer-handle to non master/root processes! To match GET_FB()
616 * just return invalid handles (0) for non masters/root
617 * rather than making GET_FB2() privileged.
619 if (!drm_is_current_master(file_priv) && !capable(CAP_SYS_ADMIN)) {
624 for (i = 0; i < fb->format->num_planes; i++) {
627 /* If we reuse the same object for multiple planes, also
628 * return the same handle.
630 for (j = 0; j < i; j++) {
631 if (fb->obj[i] == fb->obj[j]) {
632 r->handles[i] = r->handles[j];
641 ret = drm_gem_handle_create(file_priv, fb->obj[i],
645 ret = fb->funcs->create_handle(fb, file_priv,
655 /* Delete any previously-created handles on failure. */
656 for (i = 0; i < ARRAY_SIZE(r->handles); i++) {
660 drm_gem_handle_delete(file_priv, r->handles[i]);
662 /* Zero out any handles identical to the one we just
665 for (j = i + 1; j < ARRAY_SIZE(r->handles); j++) {
666 if (r->handles[j] == r->handles[i])
672 drm_framebuffer_put(fb);
677 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
678 * @dev: drm device for the ioctl
679 * @data: data pointer for the ioctl
680 * @file_priv: drm file for the ioctl call
682 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
683 * rectangle list. Generic userspace which does frontbuffer rendering must call
684 * this ioctl to flush out the changes on manual-update display outputs, e.g.
685 * usb display-link, mipi manual update panels or edp panel self refresh modes.
687 * Modesetting drivers which always update the frontbuffer do not need to
688 * implement the corresponding &drm_framebuffer_funcs.dirty callback.
690 * Called by the user via ioctl.
693 * Zero on success, negative errno on failure.
695 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
696 void *data, struct drm_file *file_priv)
698 struct drm_clip_rect __user *clips_ptr;
699 struct drm_clip_rect *clips = NULL;
700 struct drm_mode_fb_dirty_cmd *r = data;
701 struct drm_framebuffer *fb;
706 if (!drm_core_check_feature(dev, DRIVER_MODESET))
709 fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
713 num_clips = r->num_clips;
714 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
716 if (!num_clips != !clips_ptr) {
721 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
723 /* If userspace annotates copy, clips must come in pairs */
724 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
729 if (num_clips && clips_ptr) {
730 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
734 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
740 ret = copy_from_user(clips, clips_ptr,
741 num_clips * sizeof(*clips));
748 if (fb->funcs->dirty) {
749 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
758 drm_framebuffer_put(fb);
764 * drm_fb_release - remove and free the FBs on this file
765 * @priv: drm file for the ioctl
767 * Destroy all the FBs associated with @filp.
769 * Called by the user via ioctl.
772 * Zero on success, negative errno on failure.
774 void drm_fb_release(struct drm_file *priv)
776 struct drm_framebuffer *fb, *tfb;
777 struct drm_mode_rmfb_work arg;
779 INIT_LIST_HEAD(&arg.fbs);
782 * When the file gets released that means no one else can access the fb
783 * list any more, so no need to grab fpriv->fbs_lock. And we need to
784 * avoid upsetting lockdep since the universal cursor code adds a
785 * framebuffer while holding mutex locks.
787 * Note that a real deadlock between fpriv->fbs_lock and the modeset
788 * locks is impossible here since no one else but this function can get
791 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
792 if (drm_framebuffer_read_refcount(fb) > 1) {
793 list_move_tail(&fb->filp_head, &arg.fbs);
795 list_del_init(&fb->filp_head);
797 /* This drops the fpriv->fbs reference. */
798 drm_framebuffer_put(fb);
802 if (!list_empty(&arg.fbs)) {
803 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
805 schedule_work(&arg.work);
806 flush_work(&arg.work);
807 destroy_work_on_stack(&arg.work);
811 void drm_framebuffer_free(struct kref *kref)
813 struct drm_framebuffer *fb =
814 container_of(kref, struct drm_framebuffer, base.refcount);
815 struct drm_device *dev = fb->dev;
818 * The lookup idr holds a weak reference, which has not necessarily been
819 * removed at this point. Check for that.
821 drm_mode_object_unregister(dev, &fb->base);
823 fb->funcs->destroy(fb);
827 * drm_framebuffer_init - initialize a framebuffer
829 * @fb: framebuffer to be initialized
830 * @funcs: ... with these functions
832 * Allocates an ID for the framebuffer's parent mode object, sets its mode
833 * functions & device file and adds it to the master fd list.
836 * This functions publishes the fb and makes it available for concurrent access
837 * by other users. Which means by this point the fb _must_ be fully set up -
838 * since all the fb attributes are invariant over its lifetime, no further
839 * locking but only correct reference counting is required.
842 * Zero on success, error code on failure.
844 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
845 const struct drm_framebuffer_funcs *funcs)
849 if (WARN_ON_ONCE(fb->dev != dev || !fb->format))
852 INIT_LIST_HEAD(&fb->filp_head);
855 strcpy(fb->comm, current->comm);
857 ret = __drm_mode_object_add(dev, &fb->base, DRM_MODE_OBJECT_FB,
858 false, drm_framebuffer_free);
862 mutex_lock(&dev->mode_config.fb_lock);
863 dev->mode_config.num_fb++;
864 list_add(&fb->head, &dev->mode_config.fb_list);
865 mutex_unlock(&dev->mode_config.fb_lock);
867 drm_mode_object_register(dev, &fb->base);
871 EXPORT_SYMBOL(drm_framebuffer_init);
874 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
876 * @file_priv: drm file to check for lease against.
877 * @id: id of the fb object
879 * If successful, this grabs an additional reference to the framebuffer -
880 * callers need to make sure to eventually unreference the returned framebuffer
881 * again, using drm_framebuffer_put().
883 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
884 struct drm_file *file_priv,
887 struct drm_mode_object *obj;
888 struct drm_framebuffer *fb = NULL;
890 obj = __drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_FB);
895 EXPORT_SYMBOL(drm_framebuffer_lookup);
898 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
899 * @fb: fb to unregister
901 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
902 * those used for fbdev. Note that the caller must hold a reference of its own,
903 * i.e. the object may not be destroyed through this call (since it'll lead to a
904 * locking inversion).
906 * NOTE: This function is deprecated. For driver-private framebuffers it is not
907 * recommended to embed a framebuffer struct info fbdev struct, instead, a
908 * framebuffer pointer is preferred and drm_framebuffer_put() should be called
909 * when the framebuffer is to be cleaned up.
911 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
913 struct drm_device *dev;
920 /* Mark fb as reaped and drop idr ref. */
921 drm_mode_object_unregister(dev, &fb->base);
923 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
926 * drm_framebuffer_cleanup - remove a framebuffer object
927 * @fb: framebuffer to remove
929 * Cleanup framebuffer. This function is intended to be used from the drivers
930 * &drm_framebuffer_funcs.destroy callback. It can also be used to clean up
931 * driver private framebuffers embedded into a larger structure.
933 * Note that this function does not remove the fb from active usage - if it is
934 * still used anywhere, hilarity can ensue since userspace could call getfb on
935 * the id and get back -EINVAL. Obviously no concern at driver unload time.
937 * Also, the framebuffer will not be removed from the lookup idr - for
938 * user-created framebuffers this will happen in in the rmfb ioctl. For
939 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
940 * drm_framebuffer_unregister_private.
942 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
944 struct drm_device *dev = fb->dev;
946 mutex_lock(&dev->mode_config.fb_lock);
948 dev->mode_config.num_fb--;
949 mutex_unlock(&dev->mode_config.fb_lock);
951 EXPORT_SYMBOL(drm_framebuffer_cleanup);
953 static int atomic_remove_fb(struct drm_framebuffer *fb)
955 struct drm_modeset_acquire_ctx ctx;
956 struct drm_device *dev = fb->dev;
957 struct drm_atomic_state *state;
958 struct drm_plane *plane;
959 struct drm_connector *conn __maybe_unused;
960 struct drm_connector_state *conn_state;
963 bool disable_crtcs = false;
966 drm_modeset_acquire_init(&ctx, 0);
968 state = drm_atomic_state_alloc(dev);
973 state->acquire_ctx = &ctx;
977 ret = drm_modeset_lock_all_ctx(dev, &ctx);
981 drm_for_each_plane(plane, dev) {
982 struct drm_plane_state *plane_state;
984 if (plane->state->fb != fb)
988 "Disabling [PLANE:%d:%s] because [FB:%d] is removed\n",
989 plane->base.id, plane->name, fb->base.id);
991 plane_state = drm_atomic_get_plane_state(state, plane);
992 if (IS_ERR(plane_state)) {
993 ret = PTR_ERR(plane_state);
997 if (disable_crtcs && plane_state->crtc->primary == plane) {
998 struct drm_crtc_state *crtc_state;
1001 "Disabling [CRTC:%d:%s] because [FB:%d] is removed\n",
1002 plane_state->crtc->base.id,
1003 plane_state->crtc->name, fb->base.id);
1005 crtc_state = drm_atomic_get_existing_crtc_state(state, plane_state->crtc);
1007 ret = drm_atomic_add_affected_connectors(state, plane_state->crtc);
1011 crtc_state->active = false;
1012 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1017 drm_atomic_set_fb_for_plane(plane_state, NULL);
1018 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1022 plane_mask |= drm_plane_mask(plane);
1025 /* This list is only filled when disable_crtcs is set. */
1026 for_each_new_connector_in_state(state, conn, conn_state, i) {
1027 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
1034 ret = drm_atomic_commit(state);
1037 if (ret == -EDEADLK) {
1038 drm_atomic_state_clear(state);
1039 drm_modeset_backoff(&ctx);
1043 drm_atomic_state_put(state);
1046 drm_modeset_drop_locks(&ctx);
1047 drm_modeset_acquire_fini(&ctx);
1049 if (ret == -EINVAL && !disable_crtcs) {
1050 disable_crtcs = true;
1057 static void legacy_remove_fb(struct drm_framebuffer *fb)
1059 struct drm_device *dev = fb->dev;
1060 struct drm_crtc *crtc;
1061 struct drm_plane *plane;
1063 drm_modeset_lock_all(dev);
1064 /* remove from any CRTC */
1065 drm_for_each_crtc(crtc, dev) {
1066 if (crtc->primary->fb == fb) {
1068 "Disabling [CRTC:%d:%s] because [FB:%d] is removed\n",
1069 crtc->base.id, crtc->name, fb->base.id);
1071 /* should turn off the crtc */
1072 if (drm_crtc_force_disable(crtc))
1073 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
1077 drm_for_each_plane(plane, dev) {
1078 if (plane->fb == fb) {
1080 "Disabling [PLANE:%d:%s] because [FB:%d] is removed\n",
1081 plane->base.id, plane->name, fb->base.id);
1082 drm_plane_force_disable(plane);
1085 drm_modeset_unlock_all(dev);
1089 * drm_framebuffer_remove - remove and unreference a framebuffer object
1090 * @fb: framebuffer to remove
1092 * Scans all the CRTCs and planes in @dev's mode_config. If they're
1093 * using @fb, removes it, setting it to NULL. Then drops the reference to the
1094 * passed-in framebuffer. Might take the modeset locks.
1096 * Note that this function optimizes the cleanup away if the caller holds the
1097 * last reference to the framebuffer. It is also guaranteed to not take the
1098 * modeset locks in this case.
1100 void drm_framebuffer_remove(struct drm_framebuffer *fb)
1102 struct drm_device *dev;
1109 WARN_ON(!list_empty(&fb->filp_head));
1112 * drm ABI mandates that we remove any deleted framebuffers from active
1113 * usage. But since most sane clients only remove framebuffers they no
1114 * longer need, try to optimize this away.
1116 * Since we're holding a reference ourselves, observing a refcount of 1
1117 * means that we're the last holder and can skip it. Also, the refcount
1118 * can never increase from 1 again, so we don't need any barriers or
1121 * Note that userspace could try to race with use and instate a new
1122 * usage _after_ we've cleared all current ones. End result will be an
1123 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
1126 if (drm_framebuffer_read_refcount(fb) > 1) {
1127 if (drm_drv_uses_atomic_modeset(dev)) {
1128 int ret = atomic_remove_fb(fb);
1130 WARN(ret, "atomic remove_fb failed with %i\n", ret);
1132 legacy_remove_fb(fb);
1135 drm_framebuffer_put(fb);
1137 EXPORT_SYMBOL(drm_framebuffer_remove);
1140 * drm_framebuffer_plane_width - width of the plane given the first plane
1141 * @width: width of the first plane
1142 * @fb: the framebuffer
1143 * @plane: plane index
1146 * The width of @plane, given that the width of the first plane is @width.
1148 int drm_framebuffer_plane_width(int width,
1149 const struct drm_framebuffer *fb, int plane)
1151 if (plane >= fb->format->num_planes)
1154 return fb_plane_width(width, fb->format, plane);
1156 EXPORT_SYMBOL(drm_framebuffer_plane_width);
1159 * drm_framebuffer_plane_height - height of the plane given the first plane
1160 * @height: height of the first plane
1161 * @fb: the framebuffer
1162 * @plane: plane index
1165 * The height of @plane, given that the height of the first plane is @height.
1167 int drm_framebuffer_plane_height(int height,
1168 const struct drm_framebuffer *fb, int plane)
1170 if (plane >= fb->format->num_planes)
1173 return fb_plane_height(height, fb->format, plane);
1175 EXPORT_SYMBOL(drm_framebuffer_plane_height);
1177 void drm_framebuffer_print_info(struct drm_printer *p, unsigned int indent,
1178 const struct drm_framebuffer *fb)
1182 drm_printf_indent(p, indent, "allocated by = %s\n", fb->comm);
1183 drm_printf_indent(p, indent, "refcount=%u\n",
1184 drm_framebuffer_read_refcount(fb));
1185 drm_printf_indent(p, indent, "format=%p4cc\n", &fb->format->format);
1186 drm_printf_indent(p, indent, "modifier=0x%llx\n", fb->modifier);
1187 drm_printf_indent(p, indent, "size=%ux%u\n", fb->width, fb->height);
1188 drm_printf_indent(p, indent, "layers:\n");
1190 for (i = 0; i < fb->format->num_planes; i++) {
1191 drm_printf_indent(p, indent + 1, "size[%u]=%dx%d\n", i,
1192 drm_framebuffer_plane_width(fb->width, fb, i),
1193 drm_framebuffer_plane_height(fb->height, fb, i));
1194 drm_printf_indent(p, indent + 1, "pitch[%u]=%u\n", i, fb->pitches[i]);
1195 drm_printf_indent(p, indent + 1, "offset[%u]=%u\n", i, fb->offsets[i]);
1196 drm_printf_indent(p, indent + 1, "obj[%u]:%s\n", i,
1197 fb->obj[i] ? "" : "(null)");
1199 drm_gem_print_info(p, indent + 2, fb->obj[i]);
1203 #ifdef CONFIG_DEBUG_FS
1204 static int drm_framebuffer_info(struct seq_file *m, void *data)
1206 struct drm_info_node *node = m->private;
1207 struct drm_device *dev = node->minor->dev;
1208 struct drm_printer p = drm_seq_file_printer(m);
1209 struct drm_framebuffer *fb;
1211 mutex_lock(&dev->mode_config.fb_lock);
1212 drm_for_each_fb(fb, dev) {
1213 drm_printf(&p, "framebuffer[%u]:\n", fb->base.id);
1214 drm_framebuffer_print_info(&p, 1, fb);
1216 mutex_unlock(&dev->mode_config.fb_lock);
1221 static const struct drm_info_list drm_framebuffer_debugfs_list[] = {
1222 { "framebuffer", drm_framebuffer_info, 0 },
1225 void drm_framebuffer_debugfs_init(struct drm_minor *minor)
1227 drm_debugfs_create_files(drm_framebuffer_debugfs_list,
1228 ARRAY_SIZE(drm_framebuffer_debugfs_list),
1229 minor->debugfs_root, minor);