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_atomic_uapi.h>
29 #include <drm/drm_print.h>
31 #include "drm_internal.h"
32 #include "drm_crtc_internal.h"
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.
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.
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
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
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)
73 unsigned int fb_width, fb_height;
75 fb_width = fb->width << 16;
76 fb_height = fb->height << 16;
78 /* Make sure source coordinates are inside the fb. */
79 if (src_w > fb_width ||
80 src_x > fb_width - src_w ||
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);
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
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.
105 * Called by the user via ioctl, or by an in-kernel client.
108 * Zero on success, negative errno on failure.
110 int drm_mode_addfb(struct drm_device *dev, struct drm_mode_fb_cmd *or,
111 struct drm_file *file_priv)
113 struct drm_mode_fb_cmd2 r = {};
116 if (!drm_core_check_feature(dev, DRIVER_MODESET))
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);
125 /* convert to new format and call new ioctl */
128 r.height = or->height;
129 r.pitches[0] = or->pitch;
130 r.handles[0] = or->handle;
132 ret = drm_mode_addfb2(dev, &r, file_priv);
141 int drm_mode_addfb_ioctl(struct drm_device *dev,
142 void *data, struct drm_file *file_priv)
144 return drm_mode_addfb(dev, data, file_priv);
147 static int fb_plane_width(int width,
148 const struct drm_format_info *format, int plane)
153 return DIV_ROUND_UP(width, format->hsub);
156 static int fb_plane_height(int height,
157 const struct drm_format_info *format, int plane)
162 return DIV_ROUND_UP(height, format->vsub);
165 static int framebuffer_check(struct drm_device *dev,
166 const struct drm_mode_fb_cmd2 *r)
168 const struct drm_format_info *info;
171 /* check if the format is supported at all */
172 info = __drm_format_info(r->pixel_format);
174 struct drm_format_name_buf format_name;
176 DRM_DEBUG_KMS("bad framebuffer format %s\n",
177 drm_get_format_name(r->pixel_format,
182 /* now let the driver pick its own format info */
183 info = drm_get_format_info(dev, r);
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 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];
200 if (!r->handles[i]) {
201 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
205 if ((uint64_t) width * cpp > UINT_MAX)
208 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
211 if (r->pitches[i] < width * cpp) {
212 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
216 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
217 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
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",
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:
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);
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);
254 /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */
255 if (!(r->flags & DRM_MODE_FB_MODIFIERS))
259 DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i);
264 DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i);
269 DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i);
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)
282 struct drm_mode_config *config = &dev->mode_config;
283 struct drm_framebuffer *fb;
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);
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);
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);
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);
308 ret = framebuffer_check(dev, r);
312 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
314 DRM_DEBUG_KMS("could not create framebuffer\n");
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
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.
331 * Called by the user via ioctl.
334 * Zero on success, negative errno on failure.
336 int drm_mode_addfb2(struct drm_device *dev,
337 void *data, struct drm_file *file_priv)
339 struct drm_mode_fb_cmd2 *r = data;
340 struct drm_framebuffer *fb;
342 if (!drm_core_check_feature(dev, DRIVER_MODESET))
345 fb = drm_internal_framebuffer_create(dev, r, file_priv);
349 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
350 r->fb_id = fb->base.id;
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);
360 int drm_mode_addfb2_ioctl(struct drm_device *dev,
361 void *data, struct drm_file *file_priv)
364 if (!dev->mode_config.quirk_addfb_prefer_host_byte_order) {
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.
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
377 DRM_DEBUG_KMS("addfb2 broken on bigendian");
381 return drm_mode_addfb2(dev, data, file_priv);
384 struct drm_mode_rmfb_work {
385 struct work_struct work;
386 struct list_head fbs;
389 static void drm_mode_rmfb_work_fn(struct work_struct *w)
391 struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work);
393 while (!list_empty(&arg->fbs)) {
394 struct drm_framebuffer *fb =
395 list_first_entry(&arg->fbs, typeof(*fb), filp_head);
397 list_del_init(&fb->filp_head);
398 drm_framebuffer_remove(fb);
403 * drm_mode_rmfb - remove an FB from the configuration
405 * @fb_id: id of framebuffer to remove
406 * @file_priv: drm file
408 * Remove the specified FB.
410 * Called by the user via ioctl, or by an in-kernel client.
413 * Zero on success, negative errno on failure.
415 int drm_mode_rmfb(struct drm_device *dev, u32 fb_id,
416 struct drm_file *file_priv)
418 struct drm_framebuffer *fb = NULL;
419 struct drm_framebuffer *fbl = NULL;
422 if (!drm_core_check_feature(dev, DRIVER_MODESET))
425 fb = drm_framebuffer_lookup(dev, file_priv, fb_id);
429 mutex_lock(&file_priv->fbs_lock);
430 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
434 mutex_unlock(&file_priv->fbs_lock);
438 list_del_init(&fb->filp_head);
439 mutex_unlock(&file_priv->fbs_lock);
441 /* drop the reference we picked up in framebuffer lookup */
442 drm_framebuffer_put(fb);
445 * we now own the reference that was stored in the fbs list
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.
451 if (drm_framebuffer_read_refcount(fb) > 1) {
452 struct drm_mode_rmfb_work arg;
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);
458 schedule_work(&arg.work);
459 flush_work(&arg.work);
460 destroy_work_on_stack(&arg.work);
462 drm_framebuffer_put(fb);
467 drm_framebuffer_put(fb);
471 int drm_mode_rmfb_ioctl(struct drm_device *dev,
472 void *data, struct drm_file *file_priv)
474 uint32_t *fb_id = data;
476 return drm_mode_rmfb(dev, *fb_id, file_priv);
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
485 * Lookup the FB given its ID and return info about it.
487 * Called by the user via ioctl.
490 * Zero on success, negative errno on failure.
492 int drm_mode_getfb(struct drm_device *dev,
493 void *data, struct drm_file *file_priv)
495 struct drm_mode_fb_cmd *r = data;
496 struct drm_framebuffer *fb;
499 if (!drm_core_check_feature(dev, DRIVER_MODESET))
502 fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
506 /* Multi-planar framebuffers need getfb2. */
507 if (fb->format->num_planes > 1) {
512 if (!fb->funcs->create_handle) {
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];
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.
528 if (!drm_is_current_master(file_priv) && !capable(CAP_SYS_ADMIN)) {
534 ret = fb->funcs->create_handle(fb, file_priv, &r->handle);
537 drm_framebuffer_put(fb);
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
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.
553 * Modesetting drivers which always update the frontbuffer do not need to
554 * implement the corresponding &drm_framebuffer_funcs.dirty callback.
556 * Called by the user via ioctl.
559 * Zero on success, negative errno on failure.
561 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
562 void *data, struct drm_file *file_priv)
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;
572 if (!drm_core_check_feature(dev, DRIVER_MODESET))
575 fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id);
579 num_clips = r->num_clips;
580 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
582 if (!num_clips != !clips_ptr) {
587 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
589 /* If userspace annotates copy, clips must come in pairs */
590 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
595 if (num_clips && clips_ptr) {
596 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
600 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
606 ret = copy_from_user(clips, clips_ptr,
607 num_clips * sizeof(*clips));
614 if (fb->funcs->dirty) {
615 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
624 drm_framebuffer_put(fb);
630 * drm_fb_release - remove and free the FBs on this file
631 * @priv: drm file for the ioctl
633 * Destroy all the FBs associated with @filp.
635 * Called by the user via ioctl.
638 * Zero on success, negative errno on failure.
640 void drm_fb_release(struct drm_file *priv)
642 struct drm_framebuffer *fb, *tfb;
643 struct drm_mode_rmfb_work arg;
645 INIT_LIST_HEAD(&arg.fbs);
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.
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
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);
661 list_del_init(&fb->filp_head);
663 /* This drops the fpriv->fbs reference. */
664 drm_framebuffer_put(fb);
668 if (!list_empty(&arg.fbs)) {
669 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
671 schedule_work(&arg.work);
672 flush_work(&arg.work);
673 destroy_work_on_stack(&arg.work);
677 void drm_framebuffer_free(struct kref *kref)
679 struct drm_framebuffer *fb =
680 container_of(kref, struct drm_framebuffer, base.refcount);
681 struct drm_device *dev = fb->dev;
684 * The lookup idr holds a weak reference, which has not necessarily been
685 * removed at this point. Check for that.
687 drm_mode_object_unregister(dev, &fb->base);
689 fb->funcs->destroy(fb);
693 * drm_framebuffer_init - initialize a framebuffer
695 * @fb: framebuffer to be initialized
696 * @funcs: ... with these functions
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.
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.
708 * Zero on success, error code on failure.
710 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
711 const struct drm_framebuffer_funcs *funcs)
715 if (WARN_ON_ONCE(fb->dev != dev || !fb->format))
718 INIT_LIST_HEAD(&fb->filp_head);
721 strcpy(fb->comm, current->comm);
723 ret = __drm_mode_object_add(dev, &fb->base, DRM_MODE_OBJECT_FB,
724 false, drm_framebuffer_free);
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);
733 drm_mode_object_register(dev, &fb->base);
737 EXPORT_SYMBOL(drm_framebuffer_init);
740 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
742 * @file_priv: drm file to check for lease against.
743 * @id: id of the fb object
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().
749 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
750 struct drm_file *file_priv,
753 struct drm_mode_object *obj;
754 struct drm_framebuffer *fb = NULL;
756 obj = __drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_FB);
761 EXPORT_SYMBOL(drm_framebuffer_lookup);
764 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
765 * @fb: fb to unregister
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).
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.
777 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
779 struct drm_device *dev;
786 /* Mark fb as reaped and drop idr ref. */
787 drm_mode_object_unregister(dev, &fb->base);
789 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
792 * drm_framebuffer_cleanup - remove a framebuffer object
793 * @fb: framebuffer to remove
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.
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.
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.
808 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
810 struct drm_device *dev = fb->dev;
812 mutex_lock(&dev->mode_config.fb_lock);
814 dev->mode_config.num_fb--;
815 mutex_unlock(&dev->mode_config.fb_lock);
817 EXPORT_SYMBOL(drm_framebuffer_cleanup);
819 static int atomic_remove_fb(struct drm_framebuffer *fb)
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;
829 bool disable_crtcs = false;
832 drm_modeset_acquire_init(&ctx, 0);
834 state = drm_atomic_state_alloc(dev);
839 state->acquire_ctx = &ctx;
843 ret = drm_modeset_lock_all_ctx(dev, &ctx);
847 drm_for_each_plane(plane, dev) {
848 struct drm_plane_state *plane_state;
850 if (plane->state->fb != fb)
853 plane_state = drm_atomic_get_plane_state(state, plane);
854 if (IS_ERR(plane_state)) {
855 ret = PTR_ERR(plane_state);
859 if (disable_crtcs && plane_state->crtc->primary == plane) {
860 struct drm_crtc_state *crtc_state;
862 crtc_state = drm_atomic_get_existing_crtc_state(state, plane_state->crtc);
864 ret = drm_atomic_add_affected_connectors(state, plane_state->crtc);
868 crtc_state->active = false;
869 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
874 drm_atomic_set_fb_for_plane(plane_state, NULL);
875 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
879 plane_mask |= drm_plane_mask(plane);
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);
891 ret = drm_atomic_commit(state);
894 if (ret == -EDEADLK) {
895 drm_atomic_state_clear(state);
896 drm_modeset_backoff(&ctx);
900 drm_atomic_state_put(state);
903 drm_modeset_drop_locks(&ctx);
904 drm_modeset_acquire_fini(&ctx);
906 if (ret == -EINVAL && !disable_crtcs) {
907 disable_crtcs = true;
914 static void legacy_remove_fb(struct drm_framebuffer *fb)
916 struct drm_device *dev = fb->dev;
917 struct drm_crtc *crtc;
918 struct drm_plane *plane;
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);
930 drm_for_each_plane(plane, dev) {
932 drm_plane_force_disable(plane);
934 drm_modeset_unlock_all(dev);
938 * drm_framebuffer_remove - remove and unreference a framebuffer object
939 * @fb: framebuffer to remove
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.
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.
949 void drm_framebuffer_remove(struct drm_framebuffer *fb)
951 struct drm_device *dev;
958 WARN_ON(!list_empty(&fb->filp_head));
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.
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
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
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);
980 legacy_remove_fb(fb);
983 drm_framebuffer_put(fb);
985 EXPORT_SYMBOL(drm_framebuffer_remove);
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
994 * The width of @plane, given that the width of the first plane is @width.
996 int drm_framebuffer_plane_width(int width,
997 const struct drm_framebuffer *fb, int plane)
999 if (plane >= fb->format->num_planes)
1002 return fb_plane_width(width, fb->format, plane);
1004 EXPORT_SYMBOL(drm_framebuffer_plane_width);
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
1013 * The height of @plane, given that the height of the first plane is @height.
1015 int drm_framebuffer_plane_height(int height,
1016 const struct drm_framebuffer *fb, int plane)
1018 if (plane >= fb->format->num_planes)
1021 return fb_plane_height(height, fb->format, plane);
1023 EXPORT_SYMBOL(drm_framebuffer_plane_height);
1025 void drm_framebuffer_print_info(struct drm_printer *p, unsigned int indent,
1026 const struct drm_framebuffer *fb)
1028 struct drm_format_name_buf format_name;
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");
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)");
1049 drm_gem_print_info(p, indent + 2, fb->obj[i]);
1053 #ifdef CONFIG_DEBUG_FS
1054 static int drm_framebuffer_info(struct seq_file *m, void *data)
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;
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);
1066 mutex_unlock(&dev->mode_config.fb_lock);
1071 static const struct drm_info_list drm_framebuffer_debugfs_list[] = {
1072 { "framebuffer", drm_framebuffer_info, 0 },
1075 int drm_framebuffer_debugfs_init(struct drm_minor *minor)
1077 return drm_debugfs_create_files(drm_framebuffer_debugfs_list,
1078 ARRAY_SIZE(drm_framebuffer_debugfs_list),
1079 minor->debugfs_root, minor);