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>
25 #include <drm/drm_auth.h>
26 #include <drm/drm_framebuffer.h>
27 #include <drm/drm_atomic.h>
28 #include <drm/drm_print.h>
30 #include "drm_internal.h"
31 #include "drm_crtc_internal.h"
36 * Frame buffers are abstract memory objects that provide a source of pixels to
37 * scanout to a CRTC. Applications explicitly request the creation of frame
38 * buffers through the DRM_IOCTL_MODE_ADDFB(2) ioctls and receive an opaque
39 * handle that can be passed to the KMS CRTC control, plane configuration and
40 * page flip functions.
42 * Frame buffers rely on the underlying memory manager for allocating backing
43 * storage. When creating a frame buffer applications pass a memory handle
44 * (or a list of memory handles for multi-planar formats) through the
45 * &struct drm_mode_fb_cmd2 argument. For drivers using GEM as their userspace
46 * buffer management interface this would be a GEM handle. Drivers are however
47 * free to use their own backing storage object handles, e.g. vmwgfx directly
48 * exposes special TTM handles to userspace and so expects TTM handles in the
49 * create ioctl and not GEM handles.
51 * Framebuffers are tracked with &struct drm_framebuffer. They are published
52 * using drm_framebuffer_init() - after calling that function userspace can use
53 * and access the framebuffer object. The helper function
54 * drm_helper_mode_fill_fb_struct() can be used to pre-fill the required
57 * The lifetime of a drm framebuffer is controlled with a reference count,
58 * drivers can grab additional references with drm_framebuffer_get() and drop
59 * them again with drm_framebuffer_put(). For driver-private framebuffers for
60 * which the last reference is never dropped (e.g. for the fbdev framebuffer
61 * when the struct &struct drm_framebuffer is embedded into the fbdev helper
62 * struct) drivers can manually clean up a framebuffer at module unload time
63 * with drm_framebuffer_unregister_private(). But doing this is not
64 * recommended, and it's better to have a normal free-standing &struct
68 int drm_framebuffer_check_src_coords(uint32_t src_x, uint32_t src_y,
69 uint32_t src_w, uint32_t src_h,
70 const struct drm_framebuffer *fb)
72 unsigned int fb_width, fb_height;
74 fb_width = fb->width << 16;
75 fb_height = fb->height << 16;
77 /* Make sure source coordinates are inside the fb. */
78 if (src_w > fb_width ||
79 src_x > fb_width - src_w ||
81 src_y > fb_height - src_h) {
82 DRM_DEBUG_KMS("Invalid source coordinates "
83 "%u.%06ux%u.%06u+%u.%06u+%u.%06u (fb %ux%u)\n",
84 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
85 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
86 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
87 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10,
88 fb->width, fb->height);
96 * drm_mode_addfb - add an FB to the graphics configuration
97 * @dev: drm device for the ioctl
98 * @data: data pointer for the ioctl
99 * @file_priv: drm file for the ioctl call
101 * Add a new FB to the specified CRTC, given a user request. This is the
102 * original addfb ioctl which only supported RGB formats.
104 * Called by the user via ioctl.
107 * Zero on success, negative errno on failure.
109 int drm_mode_addfb(struct drm_device *dev,
110 void *data, struct drm_file *file_priv)
112 struct drm_mode_fb_cmd *or = data;
113 struct drm_mode_fb_cmd2 r = {};
116 /* convert to new format and call new ioctl */
119 r.height = or->height;
120 r.pitches[0] = or->pitch;
121 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
122 r.handles[0] = or->handle;
124 ret = drm_mode_addfb2(dev, &r, file_priv);
133 static int fb_plane_width(int width,
134 const struct drm_format_info *format, int plane)
139 return DIV_ROUND_UP(width, format->hsub);
142 static int fb_plane_height(int height,
143 const struct drm_format_info *format, int plane)
148 return DIV_ROUND_UP(height, format->vsub);
151 static int framebuffer_check(struct drm_device *dev,
152 const struct drm_mode_fb_cmd2 *r)
154 const struct drm_format_info *info;
157 /* check if the format is supported at all */
158 info = __drm_format_info(r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN);
160 struct drm_format_name_buf format_name;
161 DRM_DEBUG_KMS("bad framebuffer format %s\n",
162 drm_get_format_name(r->pixel_format,
167 /* now let the driver pick its own format info */
168 info = drm_get_format_info(dev, r);
171 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
175 if (r->height == 0) {
176 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
180 for (i = 0; i < info->num_planes; i++) {
181 unsigned int width = fb_plane_width(r->width, info, i);
182 unsigned int height = fb_plane_height(r->height, info, i);
183 unsigned int cpp = info->cpp[i];
185 if (!r->handles[i]) {
186 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
190 if ((uint64_t) width * cpp > UINT_MAX)
193 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
196 if (r->pitches[i] < width * cpp) {
197 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
201 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
202 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
207 if (r->flags & DRM_MODE_FB_MODIFIERS &&
208 r->modifier[i] != r->modifier[0]) {
209 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
214 /* modifier specific checks: */
215 switch (r->modifier[i]) {
216 case DRM_FORMAT_MOD_SAMSUNG_64_32_TILE:
217 /* NOTE: the pitch restriction may be lifted later if it turns
218 * out that no hw has this restriction:
220 if (r->pixel_format != DRM_FORMAT_NV12 ||
221 width % 128 || height % 32 ||
222 r->pitches[i] % 128) {
223 DRM_DEBUG_KMS("bad modifier data for plane %d\n", i);
233 for (i = info->num_planes; i < 4; i++) {
234 if (r->modifier[i]) {
235 DRM_DEBUG_KMS("non-zero modifier for unused plane %d\n", i);
239 /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */
240 if (!(r->flags & DRM_MODE_FB_MODIFIERS))
244 DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i);
249 DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i);
254 DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i);
262 struct drm_framebuffer *
263 drm_internal_framebuffer_create(struct drm_device *dev,
264 const struct drm_mode_fb_cmd2 *r,
265 struct drm_file *file_priv)
267 struct drm_mode_config *config = &dev->mode_config;
268 struct drm_framebuffer *fb;
271 if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
272 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
273 return ERR_PTR(-EINVAL);
276 if ((config->min_width > r->width) || (r->width > config->max_width)) {
277 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
278 r->width, config->min_width, config->max_width);
279 return ERR_PTR(-EINVAL);
281 if ((config->min_height > r->height) || (r->height > config->max_height)) {
282 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
283 r->height, config->min_height, config->max_height);
284 return ERR_PTR(-EINVAL);
287 if (r->flags & DRM_MODE_FB_MODIFIERS &&
288 !dev->mode_config.allow_fb_modifiers) {
289 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
290 return ERR_PTR(-EINVAL);
293 ret = framebuffer_check(dev, r);
297 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
299 DRM_DEBUG_KMS("could not create framebuffer\n");
307 * drm_mode_addfb2 - add an FB to the graphics configuration
308 * @dev: drm device for the ioctl
309 * @data: data pointer for the ioctl
310 * @file_priv: drm file for the ioctl call
312 * Add a new FB to the specified CRTC, given a user request with format. This is
313 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
314 * and uses fourcc codes as pixel format specifiers.
316 * Called by the user via ioctl.
319 * Zero on success, negative errno on failure.
321 int drm_mode_addfb2(struct drm_device *dev,
322 void *data, struct drm_file *file_priv)
324 struct drm_mode_fb_cmd2 *r = data;
325 struct drm_framebuffer *fb;
327 if (!drm_core_check_feature(dev, DRIVER_MODESET))
330 fb = drm_internal_framebuffer_create(dev, r, file_priv);
334 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
335 r->fb_id = fb->base.id;
337 /* Transfer ownership to the filp for reaping on close */
338 mutex_lock(&file_priv->fbs_lock);
339 list_add(&fb->filp_head, &file_priv->fbs);
340 mutex_unlock(&file_priv->fbs_lock);
345 struct drm_mode_rmfb_work {
346 struct work_struct work;
347 struct list_head fbs;
350 static void drm_mode_rmfb_work_fn(struct work_struct *w)
352 struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work);
354 while (!list_empty(&arg->fbs)) {
355 struct drm_framebuffer *fb =
356 list_first_entry(&arg->fbs, typeof(*fb), filp_head);
358 list_del_init(&fb->filp_head);
359 drm_framebuffer_remove(fb);
364 * drm_mode_rmfb - remove an FB from the configuration
365 * @dev: drm device for the ioctl
366 * @data: data pointer for the ioctl
367 * @file_priv: drm file for the ioctl call
369 * Remove the FB specified by the user.
371 * Called by the user via ioctl.
374 * Zero on success, negative errno on failure.
376 int drm_mode_rmfb(struct drm_device *dev,
377 void *data, struct drm_file *file_priv)
379 struct drm_framebuffer *fb = NULL;
380 struct drm_framebuffer *fbl = NULL;
384 if (!drm_core_check_feature(dev, DRIVER_MODESET))
387 fb = drm_framebuffer_lookup(dev, file_priv, *id);
391 mutex_lock(&file_priv->fbs_lock);
392 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
396 mutex_unlock(&file_priv->fbs_lock);
400 list_del_init(&fb->filp_head);
401 mutex_unlock(&file_priv->fbs_lock);
403 /* drop the reference we picked up in framebuffer lookup */
404 drm_framebuffer_put(fb);
407 * we now own the reference that was stored in the fbs list
409 * drm_framebuffer_remove may fail with -EINTR on pending signals,
410 * so run this in a separate stack as there's no way to correctly
411 * handle this after the fb is already removed from the lookup table.
413 if (drm_framebuffer_read_refcount(fb) > 1) {
414 struct drm_mode_rmfb_work arg;
416 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
417 INIT_LIST_HEAD(&arg.fbs);
418 list_add_tail(&fb->filp_head, &arg.fbs);
420 schedule_work(&arg.work);
421 flush_work(&arg.work);
422 destroy_work_on_stack(&arg.work);
424 drm_framebuffer_put(fb);
429 drm_framebuffer_put(fb);
434 * drm_mode_getfb - get FB info
435 * @dev: drm device for the ioctl
436 * @data: data pointer for the ioctl
437 * @file_priv: drm file for the ioctl call
439 * Lookup the FB given its ID and return info about it.
441 * Called by the user via ioctl.
444 * Zero on success, negative errno on failure.
446 int drm_mode_getfb(struct drm_device *dev,
447 void *data, struct drm_file *file_priv)
449 struct drm_mode_fb_cmd *r = data;
450 struct drm_framebuffer *fb;
453 if (!drm_core_check_feature(dev, DRIVER_MODESET))
456 fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
460 r->height = fb->height;
461 r->width = fb->width;
462 r->depth = fb->format->depth;
463 r->bpp = fb->format->cpp[0] * 8;
464 r->pitch = fb->pitches[0];
465 if (fb->funcs->create_handle) {
466 if (drm_is_current_master(file_priv) || capable(CAP_SYS_ADMIN) ||
467 drm_is_control_client(file_priv)) {
468 ret = fb->funcs->create_handle(fb, file_priv,
471 /* GET_FB() is an unprivileged ioctl so we must not
472 * return a buffer-handle to non-master processes! For
473 * backwards-compatibility reasons, we cannot make
474 * GET_FB() privileged, so just return an invalid handle
475 * for non-masters. */
483 drm_framebuffer_put(fb);
489 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
490 * @dev: drm device for the ioctl
491 * @data: data pointer for the ioctl
492 * @file_priv: drm file for the ioctl call
494 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
495 * rectangle list. Generic userspace which does frontbuffer rendering must call
496 * this ioctl to flush out the changes on manual-update display outputs, e.g.
497 * usb display-link, mipi manual update panels or edp panel self refresh modes.
499 * Modesetting drivers which always update the frontbuffer do not need to
500 * implement the corresponding &drm_framebuffer_funcs.dirty callback.
502 * Called by the user via ioctl.
505 * Zero on success, negative errno on failure.
507 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
508 void *data, struct drm_file *file_priv)
510 struct drm_clip_rect __user *clips_ptr;
511 struct drm_clip_rect *clips = NULL;
512 struct drm_mode_fb_dirty_cmd *r = data;
513 struct drm_framebuffer *fb;
518 if (!drm_core_check_feature(dev, DRIVER_MODESET))
521 fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
525 num_clips = r->num_clips;
526 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
528 if (!num_clips != !clips_ptr) {
533 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
535 /* If userspace annotates copy, clips must come in pairs */
536 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
541 if (num_clips && clips_ptr) {
542 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
546 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
552 ret = copy_from_user(clips, clips_ptr,
553 num_clips * sizeof(*clips));
560 if (fb->funcs->dirty) {
561 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
570 drm_framebuffer_put(fb);
576 * drm_fb_release - remove and free the FBs on this file
577 * @priv: drm file for the ioctl
579 * Destroy all the FBs associated with @filp.
581 * Called by the user via ioctl.
584 * Zero on success, negative errno on failure.
586 void drm_fb_release(struct drm_file *priv)
588 struct drm_framebuffer *fb, *tfb;
589 struct drm_mode_rmfb_work arg;
591 INIT_LIST_HEAD(&arg.fbs);
594 * When the file gets released that means no one else can access the fb
595 * list any more, so no need to grab fpriv->fbs_lock. And we need to
596 * avoid upsetting lockdep since the universal cursor code adds a
597 * framebuffer while holding mutex locks.
599 * Note that a real deadlock between fpriv->fbs_lock and the modeset
600 * locks is impossible here since no one else but this function can get
603 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
604 if (drm_framebuffer_read_refcount(fb) > 1) {
605 list_move_tail(&fb->filp_head, &arg.fbs);
607 list_del_init(&fb->filp_head);
609 /* This drops the fpriv->fbs reference. */
610 drm_framebuffer_put(fb);
614 if (!list_empty(&arg.fbs)) {
615 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
617 schedule_work(&arg.work);
618 flush_work(&arg.work);
619 destroy_work_on_stack(&arg.work);
623 void drm_framebuffer_free(struct kref *kref)
625 struct drm_framebuffer *fb =
626 container_of(kref, struct drm_framebuffer, base.refcount);
627 struct drm_device *dev = fb->dev;
630 * The lookup idr holds a weak reference, which has not necessarily been
631 * removed at this point. Check for that.
633 drm_mode_object_unregister(dev, &fb->base);
635 fb->funcs->destroy(fb);
639 * drm_framebuffer_init - initialize a framebuffer
641 * @fb: framebuffer to be initialized
642 * @funcs: ... with these functions
644 * Allocates an ID for the framebuffer's parent mode object, sets its mode
645 * functions & device file and adds it to the master fd list.
648 * This functions publishes the fb and makes it available for concurrent access
649 * by other users. Which means by this point the fb _must_ be fully set up -
650 * since all the fb attributes are invariant over its lifetime, no further
651 * locking but only correct reference counting is required.
654 * Zero on success, error code on failure.
656 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
657 const struct drm_framebuffer_funcs *funcs)
661 if (WARN_ON_ONCE(fb->dev != dev || !fb->format))
664 INIT_LIST_HEAD(&fb->filp_head);
668 ret = __drm_mode_object_add(dev, &fb->base, DRM_MODE_OBJECT_FB,
669 false, drm_framebuffer_free);
673 mutex_lock(&dev->mode_config.fb_lock);
674 dev->mode_config.num_fb++;
675 list_add(&fb->head, &dev->mode_config.fb_list);
676 mutex_unlock(&dev->mode_config.fb_lock);
678 drm_mode_object_register(dev, &fb->base);
682 EXPORT_SYMBOL(drm_framebuffer_init);
685 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
687 * @file_priv: drm file to check for lease against.
688 * @id: id of the fb object
690 * If successful, this grabs an additional reference to the framebuffer -
691 * callers need to make sure to eventually unreference the returned framebuffer
692 * again, using drm_framebuffer_put().
694 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
695 struct drm_file *file_priv,
698 struct drm_mode_object *obj;
699 struct drm_framebuffer *fb = NULL;
701 obj = __drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_FB);
706 EXPORT_SYMBOL(drm_framebuffer_lookup);
709 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
710 * @fb: fb to unregister
712 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
713 * those used for fbdev. Note that the caller must hold a reference of it's own,
714 * i.e. the object may not be destroyed through this call (since it'll lead to a
715 * locking inversion).
717 * NOTE: This function is deprecated. For driver-private framebuffers it is not
718 * recommended to embed a framebuffer struct info fbdev struct, instead, a
719 * framebuffer pointer is preferred and drm_framebuffer_put() should be called
720 * when the framebuffer is to be cleaned up.
722 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
724 struct drm_device *dev;
731 /* Mark fb as reaped and drop idr ref. */
732 drm_mode_object_unregister(dev, &fb->base);
734 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
737 * drm_framebuffer_cleanup - remove a framebuffer object
738 * @fb: framebuffer to remove
740 * Cleanup framebuffer. This function is intended to be used from the drivers
741 * &drm_framebuffer_funcs.destroy callback. It can also be used to clean up
742 * driver private framebuffers embedded into a larger structure.
744 * Note that this function does not remove the fb from active usage - if it is
745 * still used anywhere, hilarity can ensue since userspace could call getfb on
746 * the id and get back -EINVAL. Obviously no concern at driver unload time.
748 * Also, the framebuffer will not be removed from the lookup idr - for
749 * user-created framebuffers this will happen in in the rmfb ioctl. For
750 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
751 * drm_framebuffer_unregister_private.
753 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
755 struct drm_device *dev = fb->dev;
757 mutex_lock(&dev->mode_config.fb_lock);
759 dev->mode_config.num_fb--;
760 mutex_unlock(&dev->mode_config.fb_lock);
762 EXPORT_SYMBOL(drm_framebuffer_cleanup);
764 static int atomic_remove_fb(struct drm_framebuffer *fb)
766 struct drm_modeset_acquire_ctx ctx;
767 struct drm_device *dev = fb->dev;
768 struct drm_atomic_state *state;
769 struct drm_plane *plane;
770 struct drm_connector *conn;
771 struct drm_connector_state *conn_state;
774 bool disable_crtcs = false;
777 drm_modeset_acquire_init(&ctx, 0);
779 state = drm_atomic_state_alloc(dev);
784 state->acquire_ctx = &ctx;
788 ret = drm_modeset_lock_all_ctx(dev, &ctx);
792 drm_for_each_plane(plane, dev) {
793 struct drm_plane_state *plane_state;
795 if (plane->state->fb != fb)
798 plane_state = drm_atomic_get_plane_state(state, plane);
799 if (IS_ERR(plane_state)) {
800 ret = PTR_ERR(plane_state);
804 if (disable_crtcs && plane_state->crtc->primary == plane) {
805 struct drm_crtc_state *crtc_state;
807 crtc_state = drm_atomic_get_existing_crtc_state(state, plane_state->crtc);
809 ret = drm_atomic_add_affected_connectors(state, plane_state->crtc);
813 crtc_state->active = false;
814 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
819 drm_atomic_set_fb_for_plane(plane_state, NULL);
820 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
824 plane_mask |= BIT(drm_plane_index(plane));
826 plane->old_fb = plane->fb;
829 /* This list is only filled when disable_crtcs is set. */
830 for_each_new_connector_in_state(state, conn, conn_state, i) {
831 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
838 ret = drm_atomic_commit(state);
842 drm_atomic_clean_old_fb(dev, plane_mask, ret);
844 if (ret == -EDEADLK) {
845 drm_atomic_state_clear(state);
846 drm_modeset_backoff(&ctx);
850 drm_atomic_state_put(state);
853 drm_modeset_drop_locks(&ctx);
854 drm_modeset_acquire_fini(&ctx);
856 if (ret == -EINVAL && !disable_crtcs) {
857 disable_crtcs = true;
864 static void legacy_remove_fb(struct drm_framebuffer *fb)
866 struct drm_device *dev = fb->dev;
867 struct drm_crtc *crtc;
868 struct drm_plane *plane;
870 drm_modeset_lock_all(dev);
871 /* remove from any CRTC */
872 drm_for_each_crtc(crtc, dev) {
873 if (crtc->primary->fb == fb) {
874 /* should turn off the crtc */
875 if (drm_crtc_force_disable(crtc))
876 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
880 drm_for_each_plane(plane, dev) {
882 drm_plane_force_disable(plane);
884 drm_modeset_unlock_all(dev);
888 * drm_framebuffer_remove - remove and unreference a framebuffer object
889 * @fb: framebuffer to remove
891 * Scans all the CRTCs and planes in @dev's mode_config. If they're
892 * using @fb, removes it, setting it to NULL. Then drops the reference to the
893 * passed-in framebuffer. Might take the modeset locks.
895 * Note that this function optimizes the cleanup away if the caller holds the
896 * last reference to the framebuffer. It is also guaranteed to not take the
897 * modeset locks in this case.
899 void drm_framebuffer_remove(struct drm_framebuffer *fb)
901 struct drm_device *dev;
908 WARN_ON(!list_empty(&fb->filp_head));
911 * drm ABI mandates that we remove any deleted framebuffers from active
912 * useage. But since most sane clients only remove framebuffers they no
913 * longer need, try to optimize this away.
915 * Since we're holding a reference ourselves, observing a refcount of 1
916 * means that we're the last holder and can skip it. Also, the refcount
917 * can never increase from 1 again, so we don't need any barriers or
920 * Note that userspace could try to race with use and instate a new
921 * usage _after_ we've cleared all current ones. End result will be an
922 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
925 if (drm_framebuffer_read_refcount(fb) > 1) {
926 if (drm_drv_uses_atomic_modeset(dev)) {
927 int ret = atomic_remove_fb(fb);
928 WARN(ret, "atomic remove_fb failed with %i\n", ret);
930 legacy_remove_fb(fb);
933 drm_framebuffer_put(fb);
935 EXPORT_SYMBOL(drm_framebuffer_remove);
938 * drm_framebuffer_plane_width - width of the plane given the first plane
939 * @width: width of the first plane
940 * @fb: the framebuffer
941 * @plane: plane index
944 * The width of @plane, given that the width of the first plane is @width.
946 int drm_framebuffer_plane_width(int width,
947 const struct drm_framebuffer *fb, int plane)
949 if (plane >= fb->format->num_planes)
952 return fb_plane_width(width, fb->format, plane);
954 EXPORT_SYMBOL(drm_framebuffer_plane_width);
957 * drm_framebuffer_plane_height - height of the plane given the first plane
958 * @height: height of the first plane
959 * @fb: the framebuffer
960 * @plane: plane index
963 * The height of @plane, given that the height of the first plane is @height.
965 int drm_framebuffer_plane_height(int height,
966 const struct drm_framebuffer *fb, int plane)
968 if (plane >= fb->format->num_planes)
971 return fb_plane_height(height, fb->format, plane);
973 EXPORT_SYMBOL(drm_framebuffer_plane_height);
975 void drm_framebuffer_print_info(struct drm_printer *p, unsigned int indent,
976 const struct drm_framebuffer *fb)
978 struct drm_format_name_buf format_name;
981 drm_printf_indent(p, indent, "refcount=%u\n",
982 drm_framebuffer_read_refcount(fb));
983 drm_printf_indent(p, indent, "format=%s\n",
984 drm_get_format_name(fb->format->format, &format_name));
985 drm_printf_indent(p, indent, "modifier=0x%llx\n", fb->modifier);
986 drm_printf_indent(p, indent, "size=%ux%u\n", fb->width, fb->height);
987 drm_printf_indent(p, indent, "layers:\n");
989 for (i = 0; i < fb->format->num_planes; i++) {
990 drm_printf_indent(p, indent + 1, "size[%u]=%dx%d\n", i,
991 drm_framebuffer_plane_width(fb->width, fb, i),
992 drm_framebuffer_plane_height(fb->height, fb, i));
993 drm_printf_indent(p, indent + 1, "pitch[%u]=%u\n", i, fb->pitches[i]);
994 drm_printf_indent(p, indent + 1, "offset[%u]=%u\n", i, fb->offsets[i]);
995 drm_printf_indent(p, indent + 1, "obj[%u]:%s\n", i,
996 fb->obj[i] ? "" : "(null)");
998 drm_gem_print_info(p, indent + 2, fb->obj[i]);
1002 #ifdef CONFIG_DEBUG_FS
1003 static int drm_framebuffer_info(struct seq_file *m, void *data)
1005 struct drm_info_node *node = m->private;
1006 struct drm_device *dev = node->minor->dev;
1007 struct drm_printer p = drm_seq_file_printer(m);
1008 struct drm_framebuffer *fb;
1010 mutex_lock(&dev->mode_config.fb_lock);
1011 drm_for_each_fb(fb, dev) {
1012 drm_printf(&p, "framebuffer[%u]:\n", fb->base.id);
1013 drm_framebuffer_print_info(&p, 1, fb);
1015 mutex_unlock(&dev->mode_config.fb_lock);
1020 static const struct drm_info_list drm_framebuffer_debugfs_list[] = {
1021 { "framebuffer", drm_framebuffer_info, 0 },
1024 int drm_framebuffer_debugfs_init(struct drm_minor *minor)
1026 return drm_debugfs_create_files(drm_framebuffer_debugfs_list,
1027 ARRAY_SIZE(drm_framebuffer_debugfs_list),
1028 minor->debugfs_root, minor);