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/slab.h>
24 #include <linux/uaccess.h>
26 #include <drm/drm_plane.h>
27 #include <drm/drm_drv.h>
28 #include <drm/drm_print.h>
29 #include <drm/drm_framebuffer.h>
30 #include <drm/drm_file.h>
31 #include <drm/drm_crtc.h>
32 #include <drm/drm_fourcc.h>
33 #include <drm/drm_managed.h>
34 #include <drm/drm_vblank.h>
36 #include "drm_crtc_internal.h"
41 * A plane represents an image source that can be blended with or overlaid on
42 * top of a CRTC during the scanout process. Planes take their input data from a
43 * &drm_framebuffer object. The plane itself specifies the cropping and scaling
44 * of that image, and where it is placed on the visible area of a display
45 * pipeline, represented by &drm_crtc. A plane can also have additional
46 * properties that specify how the pixels are positioned and blended, like
47 * rotation or Z-position. All these properties are stored in &drm_plane_state.
49 * Unless explicitly specified (via CRTC property or otherwise), the active area
50 * of a CRTC will be black by default. This means portions of the active area
51 * which are not covered by a plane will be black, and alpha blending of any
52 * planes with the CRTC background will blend with black at the lowest zpos.
54 * To create a plane, a KMS drivers allocates and zeroes an instances of
55 * &struct drm_plane (possibly as part of a larger structure) and registers it
56 * with a call to drm_universal_plane_init().
58 * Each plane has a type, see enum drm_plane_type. A plane can be compatible
59 * with multiple CRTCs, see &drm_plane.possible_crtcs.
61 * Each CRTC must have a unique primary plane userspace can attach to enable
62 * the CRTC. In other words, userspace must be able to attach a different
63 * primary plane to each CRTC at the same time. Primary planes can still be
64 * compatible with multiple CRTCs. There must be exactly as many primary planes
67 * Legacy uAPI doesn't expose the primary and cursor planes directly. DRM core
68 * relies on the driver to set the primary and optionally the cursor plane used
69 * for legacy IOCTLs. This is done by calling drm_crtc_init_with_planes(). All
70 * drivers must provide one primary plane per CRTC to avoid surprising legacy
75 * DOC: standard plane properties
77 * DRM planes have a few standardized properties:
80 * Immutable property describing the type of the plane.
82 * For user-space which has enabled the &DRM_CLIENT_CAP_ATOMIC capability,
83 * the plane type is just a hint and is mostly superseded by atomic
84 * test-only commits. The type hint can still be used to come up more
85 * easily with a plane configuration accepted by the driver.
87 * The value of this property can be one of the following:
90 * To light up a CRTC, attaching a primary plane is the most likely to
91 * work if it covers the whole CRTC and doesn't have scaling or
94 * Drivers may support more features for the primary plane, user-space
95 * can find out with test-only atomic commits.
97 * Some primary planes are implicitly used by the kernel in the legacy
98 * IOCTLs &DRM_IOCTL_MODE_SETCRTC and &DRM_IOCTL_MODE_PAGE_FLIP.
99 * Therefore user-space must not mix explicit usage of any primary
100 * plane (e.g. through an atomic commit) with these legacy IOCTLs.
103 * To enable this plane, using a framebuffer configured without scaling
104 * or cropping and with the following properties is the most likely to
107 * - If the driver provides the capabilities &DRM_CAP_CURSOR_WIDTH and
108 * &DRM_CAP_CURSOR_HEIGHT, create the framebuffer with this size.
109 * Otherwise, create a framebuffer with the size 64x64.
110 * - If the driver doesn't support modifiers, create a framebuffer with
111 * a linear layout. Otherwise, use the IN_FORMATS plane property.
113 * Drivers may support more features for the cursor plane, user-space
114 * can find out with test-only atomic commits.
116 * Some cursor planes are implicitly used by the kernel in the legacy
117 * IOCTLs &DRM_IOCTL_MODE_CURSOR and &DRM_IOCTL_MODE_CURSOR2.
118 * Therefore user-space must not mix explicit usage of any cursor
119 * plane (e.g. through an atomic commit) with these legacy IOCTLs.
121 * Some drivers may support cursors even if no cursor plane is exposed.
122 * In this case, the legacy cursor IOCTLs can be used to configure the
126 * Neither primary nor cursor.
128 * Overlay planes are the only planes exposed when the
129 * &DRM_CLIENT_CAP_UNIVERSAL_PLANES capability is disabled.
132 * Blob property which contains the set of buffer format and modifier
133 * pairs supported by this plane. The blob is a struct
134 * drm_format_modifier_blob. Without this property the plane doesn't
135 * support buffers with modifiers. Userspace cannot change this property.
137 * Note that userspace can check the &DRM_CAP_ADDFB2_MODIFIERS driver
138 * capability for general modifier support. If this flag is set then every
139 * plane will have the IN_FORMATS property, even when it only supports
140 * DRM_FORMAT_MOD_LINEAR. Before linux kernel release v5.1 there have been
141 * various bugs in this area with inconsistencies between the capability
142 * flag and per-plane properties.
145 static unsigned int drm_num_planes(struct drm_device *dev)
147 unsigned int num = 0;
148 struct drm_plane *tmp;
150 drm_for_each_plane(tmp, dev) {
158 formats_ptr(struct drm_format_modifier_blob *blob)
160 return (u32 *)(((char *)blob) + blob->formats_offset);
163 static inline struct drm_format_modifier *
164 modifiers_ptr(struct drm_format_modifier_blob *blob)
166 return (struct drm_format_modifier *)(((char *)blob) + blob->modifiers_offset);
169 static int create_in_format_blob(struct drm_device *dev, struct drm_plane *plane)
171 const struct drm_mode_config *config = &dev->mode_config;
172 struct drm_property_blob *blob;
173 struct drm_format_modifier *mod;
174 size_t blob_size, formats_size, modifiers_size;
175 struct drm_format_modifier_blob *blob_data;
178 formats_size = sizeof(__u32) * plane->format_count;
179 if (WARN_ON(!formats_size)) {
180 /* 0 formats are never expected */
185 sizeof(struct drm_format_modifier) * plane->modifier_count;
187 blob_size = sizeof(struct drm_format_modifier_blob);
188 /* Modifiers offset is a pointer to a struct with a 64 bit field so it
189 * should be naturally aligned to 8B.
191 BUILD_BUG_ON(sizeof(struct drm_format_modifier_blob) % 8);
192 blob_size += ALIGN(formats_size, 8);
193 blob_size += modifiers_size;
195 blob = drm_property_create_blob(dev, blob_size, NULL);
199 blob_data = blob->data;
200 blob_data->version = FORMAT_BLOB_CURRENT;
201 blob_data->count_formats = plane->format_count;
202 blob_data->formats_offset = sizeof(struct drm_format_modifier_blob);
203 blob_data->count_modifiers = plane->modifier_count;
205 blob_data->modifiers_offset =
206 ALIGN(blob_data->formats_offset + formats_size, 8);
208 memcpy(formats_ptr(blob_data), plane->format_types, formats_size);
210 mod = modifiers_ptr(blob_data);
211 for (i = 0; i < plane->modifier_count; i++) {
212 for (j = 0; j < plane->format_count; j++) {
213 if (!plane->funcs->format_mod_supported ||
214 plane->funcs->format_mod_supported(plane,
215 plane->format_types[j],
216 plane->modifiers[i])) {
217 mod->formats |= 1ULL << j;
221 mod->modifier = plane->modifiers[i];
227 drm_object_attach_property(&plane->base, config->modifiers_property,
234 * DOC: hotspot properties
236 * HOTSPOT_X: property to set mouse hotspot x offset.
237 * HOTSPOT_Y: property to set mouse hotspot y offset.
239 * When the plane is being used as a cursor image to display a mouse pointer,
240 * the "hotspot" is the offset within the cursor image where mouse events
241 * are expected to go.
243 * Positive values move the hotspot from the top-left corner of the cursor
244 * plane towards the right and bottom.
246 * Most display drivers do not need this information because the
247 * hotspot is not actually connected to anything visible on screen.
248 * However, this is necessary for display drivers like the para-virtualized
249 * drivers (eg qxl, vbox, virtio, vmwgfx), that are attached to a user console
250 * with a mouse pointer. Since these consoles are often being remoted over a
251 * network, they would otherwise have to wait to display the pointer movement to
252 * the user until a full network round-trip has occurred. New mouse events have
253 * to be sent from the user's console, over the network to the virtual input
254 * devices, forwarded to the desktop for processing, and then the cursor plane's
255 * position can be updated and sent back to the user's console over the network.
256 * Instead, with the hotspot information, the console can anticipate the new
257 * location, and draw the mouse cursor there before the confirmation comes in.
258 * To do that correctly, the user's console must be able predict how the
259 * desktop will process mouse events, which normally requires the desktop's
260 * mouse topology information, ie where each CRTC sits in the mouse coordinate
261 * space. This is typically sent to the para-virtualized drivers using some
262 * driver-specific method, and the driver then forwards it to the console by
263 * way of the virtual display device or hypervisor.
265 * The assumption is generally made that there is only one cursor plane being
266 * used this way at a time, and that the desktop is feeding all mouse devices
267 * into the same global pointer. Para-virtualized drivers that require this
268 * should only be exposing a single cursor plane, or find some other way
269 * to coordinate with a userspace desktop that supports multiple pointers.
270 * If the hotspot properties are set, the cursor plane is therefore assumed to be
271 * used only for displaying a mouse cursor image, and the position of the combined
272 * cursor plane + offset can therefore be used for coordinating with input from a
275 * The cursor will then be drawn either at the location of the plane in the CRTC
276 * console, or as a free-floating cursor plane on the user's console
277 * corresponding to their desktop mouse position.
279 * DRM clients which would like to work correctly on drivers which expose
280 * hotspot properties should advertise DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT.
281 * Setting this property on drivers which do not special case
282 * cursor planes will return EOPNOTSUPP, which can be used by userspace to
283 * gauge requirements of the hardware/drivers they're running on. Advertising
284 * DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT implies that the userspace client will be
285 * correctly setting the hotspot properties.
289 * drm_plane_create_hotspot_properties - creates the mouse hotspot
290 * properties and attaches them to the given cursor plane
292 * @plane: drm cursor plane
294 * This function enables the mouse hotspot property on a given
295 * cursor plane. Look at the documentation for hotspot properties
296 * to get a better understanding for what they're used for.
299 * Zero for success or -errno
301 static int drm_plane_create_hotspot_properties(struct drm_plane *plane)
303 struct drm_property *prop_x;
304 struct drm_property *prop_y;
306 drm_WARN_ON(plane->dev,
307 !drm_core_check_feature(plane->dev,
308 DRIVER_CURSOR_HOTSPOT));
310 prop_x = drm_property_create_signed_range(plane->dev, 0, "HOTSPOT_X",
313 return PTR_ERR(prop_x);
315 prop_y = drm_property_create_signed_range(plane->dev, 0, "HOTSPOT_Y",
317 if (IS_ERR(prop_y)) {
318 drm_property_destroy(plane->dev, prop_x);
319 return PTR_ERR(prop_y);
322 drm_object_attach_property(&plane->base, prop_x, 0);
323 drm_object_attach_property(&plane->base, prop_y, 0);
324 plane->hotspot_x_property = prop_x;
325 plane->hotspot_y_property = prop_y;
331 static int __drm_universal_plane_init(struct drm_device *dev,
332 struct drm_plane *plane,
333 uint32_t possible_crtcs,
334 const struct drm_plane_funcs *funcs,
335 const uint32_t *formats,
336 unsigned int format_count,
337 const uint64_t *format_modifiers,
338 enum drm_plane_type type,
339 const char *name, va_list ap)
341 struct drm_mode_config *config = &dev->mode_config;
342 static const uint64_t default_modifiers[] = {
343 DRM_FORMAT_MOD_LINEAR,
345 unsigned int format_modifier_count = 0;
348 /* plane index is used with 32bit bitmasks */
349 if (WARN_ON(config->num_total_plane >= 32))
353 * First driver to need more than 64 formats needs to fix this. Each
354 * format is encoded as a bit and the current code only supports a u64.
356 if (WARN_ON(format_count > 64))
359 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
360 (!funcs->atomic_destroy_state ||
361 !funcs->atomic_duplicate_state));
363 ret = drm_mode_object_add(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
367 drm_modeset_lock_init(&plane->mutex);
369 plane->base.properties = &plane->properties;
371 plane->funcs = funcs;
372 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
374 if (!plane->format_types) {
375 DRM_DEBUG_KMS("out of memory when allocating plane\n");
376 drm_mode_object_unregister(dev, &plane->base);
380 if (format_modifiers) {
381 const uint64_t *temp_modifiers = format_modifiers;
383 while (*temp_modifiers++ != DRM_FORMAT_MOD_INVALID)
384 format_modifier_count++;
386 if (!dev->mode_config.fb_modifiers_not_supported) {
387 format_modifiers = default_modifiers;
388 format_modifier_count = ARRAY_SIZE(default_modifiers);
392 /* autoset the cap and check for consistency across all planes */
393 drm_WARN_ON(dev, config->fb_modifiers_not_supported &&
394 format_modifier_count);
396 plane->modifier_count = format_modifier_count;
397 plane->modifiers = kmalloc_array(format_modifier_count,
398 sizeof(format_modifiers[0]),
401 if (format_modifier_count && !plane->modifiers) {
402 DRM_DEBUG_KMS("out of memory when allocating plane\n");
403 kfree(plane->format_types);
404 drm_mode_object_unregister(dev, &plane->base);
409 plane->name = kvasprintf(GFP_KERNEL, name, ap);
411 plane->name = kasprintf(GFP_KERNEL, "plane-%d",
412 drm_num_planes(dev));
415 kfree(plane->format_types);
416 kfree(plane->modifiers);
417 drm_mode_object_unregister(dev, &plane->base);
421 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
422 plane->format_count = format_count;
423 memcpy(plane->modifiers, format_modifiers,
424 format_modifier_count * sizeof(format_modifiers[0]));
425 plane->possible_crtcs = possible_crtcs;
428 list_add_tail(&plane->head, &config->plane_list);
429 plane->index = config->num_total_plane++;
431 drm_object_attach_property(&plane->base,
432 config->plane_type_property,
435 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
436 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
437 drm_object_attach_property(&plane->base, config->prop_in_fence_fd, -1);
438 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
439 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
440 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
441 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
442 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
443 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
444 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
445 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
446 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
448 if (drm_core_check_feature(dev, DRIVER_CURSOR_HOTSPOT) &&
449 type == DRM_PLANE_TYPE_CURSOR) {
450 drm_plane_create_hotspot_properties(plane);
453 if (format_modifier_count)
454 create_in_format_blob(dev, plane);
460 * drm_universal_plane_init - Initialize a new universal plane object
462 * @plane: plane object to init
463 * @possible_crtcs: bitmask of possible CRTCs
464 * @funcs: callbacks for the new plane
465 * @formats: array of supported formats (DRM_FORMAT\_\*)
466 * @format_count: number of elements in @formats
467 * @format_modifiers: array of struct drm_format modifiers terminated by
468 * DRM_FORMAT_MOD_INVALID
469 * @type: type of plane (overlay, primary, cursor)
470 * @name: printf style format string for the plane name, or NULL for default name
472 * Initializes a plane object of type @type. The &drm_plane_funcs.destroy hook
473 * should call drm_plane_cleanup() and kfree() the plane structure. The plane
474 * structure should not be allocated with devm_kzalloc().
476 * Note: consider using drmm_universal_plane_alloc() instead of
477 * drm_universal_plane_init() to let the DRM managed resource infrastructure
478 * take care of cleanup and deallocation.
480 * Drivers that only support the DRM_FORMAT_MOD_LINEAR modifier support may set
481 * @format_modifiers to NULL. The plane will advertise the linear modifier.
484 * Zero on success, error code on failure.
486 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
487 uint32_t possible_crtcs,
488 const struct drm_plane_funcs *funcs,
489 const uint32_t *formats, unsigned int format_count,
490 const uint64_t *format_modifiers,
491 enum drm_plane_type type,
492 const char *name, ...)
497 WARN_ON(!funcs->destroy);
500 ret = __drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
501 formats, format_count, format_modifiers,
506 EXPORT_SYMBOL(drm_universal_plane_init);
508 static void drmm_universal_plane_alloc_release(struct drm_device *dev, void *ptr)
510 struct drm_plane *plane = ptr;
512 if (WARN_ON(!plane->dev))
515 drm_plane_cleanup(plane);
518 void *__drmm_universal_plane_alloc(struct drm_device *dev, size_t size,
519 size_t offset, uint32_t possible_crtcs,
520 const struct drm_plane_funcs *funcs,
521 const uint32_t *formats, unsigned int format_count,
522 const uint64_t *format_modifiers,
523 enum drm_plane_type type,
524 const char *name, ...)
527 struct drm_plane *plane;
531 if (WARN_ON(!funcs || funcs->destroy))
532 return ERR_PTR(-EINVAL);
534 container = drmm_kzalloc(dev, size, GFP_KERNEL);
536 return ERR_PTR(-ENOMEM);
538 plane = container + offset;
541 ret = __drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
542 formats, format_count, format_modifiers,
548 ret = drmm_add_action_or_reset(dev, drmm_universal_plane_alloc_release,
555 EXPORT_SYMBOL(__drmm_universal_plane_alloc);
557 void *__drm_universal_plane_alloc(struct drm_device *dev, size_t size,
558 size_t offset, uint32_t possible_crtcs,
559 const struct drm_plane_funcs *funcs,
560 const uint32_t *formats, unsigned int format_count,
561 const uint64_t *format_modifiers,
562 enum drm_plane_type type,
563 const char *name, ...)
566 struct drm_plane *plane;
570 if (drm_WARN_ON(dev, !funcs))
571 return ERR_PTR(-EINVAL);
573 container = kzalloc(size, GFP_KERNEL);
575 return ERR_PTR(-ENOMEM);
577 plane = container + offset;
580 ret = __drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
581 formats, format_count, format_modifiers,
593 EXPORT_SYMBOL(__drm_universal_plane_alloc);
595 int drm_plane_register_all(struct drm_device *dev)
597 unsigned int num_planes = 0;
598 unsigned int num_zpos = 0;
599 struct drm_plane *plane;
602 drm_for_each_plane(plane, dev) {
603 if (plane->funcs->late_register)
604 ret = plane->funcs->late_register(plane);
608 if (plane->zpos_property)
613 drm_WARN(dev, num_zpos && num_planes != num_zpos,
614 "Mixing planes with and without zpos property is invalid\n");
619 void drm_plane_unregister_all(struct drm_device *dev)
621 struct drm_plane *plane;
623 drm_for_each_plane(plane, dev) {
624 if (plane->funcs->early_unregister)
625 plane->funcs->early_unregister(plane);
630 * drm_plane_cleanup - Clean up the core plane usage
631 * @plane: plane to cleanup
633 * This function cleans up @plane and removes it from the DRM mode setting
634 * core. Note that the function does *not* free the plane structure itself,
635 * this is the responsibility of the caller.
637 void drm_plane_cleanup(struct drm_plane *plane)
639 struct drm_device *dev = plane->dev;
641 drm_modeset_lock_fini(&plane->mutex);
643 kfree(plane->format_types);
644 kfree(plane->modifiers);
645 drm_mode_object_unregister(dev, &plane->base);
647 BUG_ON(list_empty(&plane->head));
649 /* Note that the plane_list is considered to be static; should we
650 * remove the drm_plane at runtime we would have to decrement all
651 * the indices on the drm_plane after us in the plane_list.
654 list_del(&plane->head);
655 dev->mode_config.num_total_plane--;
657 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
658 if (plane->state && plane->funcs->atomic_destroy_state)
659 plane->funcs->atomic_destroy_state(plane, plane->state);
663 memset(plane, 0, sizeof(*plane));
665 EXPORT_SYMBOL(drm_plane_cleanup);
668 * drm_plane_from_index - find the registered plane at an index
670 * @idx: index of registered plane to find for
672 * Given a plane index, return the registered plane from DRM device's
673 * list of planes with matching index. This is the inverse of drm_plane_index().
676 drm_plane_from_index(struct drm_device *dev, int idx)
678 struct drm_plane *plane;
680 drm_for_each_plane(plane, dev)
681 if (idx == plane->index)
686 EXPORT_SYMBOL(drm_plane_from_index);
689 * drm_plane_force_disable - Forcibly disable a plane
690 * @plane: plane to disable
692 * Forces the plane to be disabled.
694 * Used when the plane's current framebuffer is destroyed,
695 * and when restoring fbdev mode.
697 * Note that this function is not suitable for atomic drivers, since it doesn't
698 * wire through the lock acquisition context properly and hence can't handle
699 * retries or driver private locks. You probably want to use
700 * drm_atomic_helper_disable_plane() or
701 * drm_atomic_helper_disable_planes_on_crtc() instead.
703 void drm_plane_force_disable(struct drm_plane *plane)
710 WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
712 plane->old_fb = plane->fb;
713 ret = plane->funcs->disable_plane(plane, NULL);
715 DRM_ERROR("failed to disable plane with busy fb\n");
716 plane->old_fb = NULL;
719 /* disconnect the plane from the fb and crtc: */
720 drm_framebuffer_put(plane->old_fb);
721 plane->old_fb = NULL;
725 EXPORT_SYMBOL(drm_plane_force_disable);
728 * drm_mode_plane_set_obj_prop - set the value of a property
729 * @plane: drm plane object to set property value for
730 * @property: property to set
731 * @value: value the property should be set to
733 * This functions sets a given property on a given plane object. This function
734 * calls the driver's ->set_property callback and changes the software state of
735 * the property if the callback succeeds.
738 * Zero on success, error code on failure.
740 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
741 struct drm_property *property,
745 struct drm_mode_object *obj = &plane->base;
747 if (plane->funcs->set_property)
748 ret = plane->funcs->set_property(plane, property, value);
750 drm_object_property_set_value(obj, property, value);
754 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
756 int drm_mode_getplane_res(struct drm_device *dev, void *data,
757 struct drm_file *file_priv)
759 struct drm_mode_get_plane_res *plane_resp = data;
760 struct drm_plane *plane;
761 uint32_t __user *plane_ptr;
764 if (!drm_core_check_feature(dev, DRIVER_MODESET))
767 plane_ptr = u64_to_user_ptr(plane_resp->plane_id_ptr);
770 * This ioctl is called twice, once to determine how much space is
771 * needed, and the 2nd time to fill it.
773 drm_for_each_plane(plane, dev) {
775 * Unless userspace set the 'universal planes'
776 * capability bit, only advertise overlays.
778 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
779 !file_priv->universal_planes)
783 * If we're running on a virtualized driver then,
784 * unless userspace advertizes support for the
785 * virtualized cursor plane, disable cursor planes
786 * because they'll be broken due to missing cursor
789 if (plane->type == DRM_PLANE_TYPE_CURSOR &&
790 drm_core_check_feature(dev, DRIVER_CURSOR_HOTSPOT) &&
792 !file_priv->supports_virtualized_cursor_plane)
795 if (drm_lease_held(file_priv, plane->base.id)) {
796 if (count < plane_resp->count_planes &&
797 put_user(plane->base.id, plane_ptr + count))
802 plane_resp->count_planes = count;
807 int drm_mode_getplane(struct drm_device *dev, void *data,
808 struct drm_file *file_priv)
810 struct drm_mode_get_plane *plane_resp = data;
811 struct drm_plane *plane;
812 uint32_t __user *format_ptr;
814 if (!drm_core_check_feature(dev, DRIVER_MODESET))
817 plane = drm_plane_find(dev, file_priv, plane_resp->plane_id);
821 drm_modeset_lock(&plane->mutex, NULL);
822 if (plane->state && plane->state->crtc && drm_lease_held(file_priv, plane->state->crtc->base.id))
823 plane_resp->crtc_id = plane->state->crtc->base.id;
824 else if (!plane->state && plane->crtc && drm_lease_held(file_priv, plane->crtc->base.id))
825 plane_resp->crtc_id = plane->crtc->base.id;
827 plane_resp->crtc_id = 0;
829 if (plane->state && plane->state->fb)
830 plane_resp->fb_id = plane->state->fb->base.id;
831 else if (!plane->state && plane->fb)
832 plane_resp->fb_id = plane->fb->base.id;
834 plane_resp->fb_id = 0;
835 drm_modeset_unlock(&plane->mutex);
837 plane_resp->plane_id = plane->base.id;
838 plane_resp->possible_crtcs = drm_lease_filter_crtcs(file_priv,
839 plane->possible_crtcs);
841 plane_resp->gamma_size = 0;
844 * This ioctl is called twice, once to determine how much space is
845 * needed, and the 2nd time to fill it.
847 if (plane->format_count &&
848 (plane_resp->count_format_types >= plane->format_count)) {
849 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
850 if (copy_to_user(format_ptr,
852 sizeof(uint32_t) * plane->format_count)) {
856 plane_resp->count_format_types = plane->format_count;
861 int drm_plane_check_pixel_format(struct drm_plane *plane,
862 u32 format, u64 modifier)
866 for (i = 0; i < plane->format_count; i++) {
867 if (format == plane->format_types[i])
870 if (i == plane->format_count)
873 if (plane->funcs->format_mod_supported) {
874 if (!plane->funcs->format_mod_supported(plane, format, modifier))
877 if (!plane->modifier_count)
880 for (i = 0; i < plane->modifier_count; i++) {
881 if (modifier == plane->modifiers[i])
884 if (i == plane->modifier_count)
891 static int __setplane_check(struct drm_plane *plane,
892 struct drm_crtc *crtc,
893 struct drm_framebuffer *fb,
894 int32_t crtc_x, int32_t crtc_y,
895 uint32_t crtc_w, uint32_t crtc_h,
896 uint32_t src_x, uint32_t src_y,
897 uint32_t src_w, uint32_t src_h)
901 /* Check whether this plane is usable on this CRTC */
902 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
903 DRM_DEBUG_KMS("Invalid crtc for plane\n");
907 /* Check whether this plane supports the fb pixel format. */
908 ret = drm_plane_check_pixel_format(plane, fb->format->format,
911 DRM_DEBUG_KMS("Invalid pixel format %p4cc, modifier 0x%llx\n",
912 &fb->format->format, fb->modifier);
916 /* Give drivers some help against integer overflows */
917 if (crtc_w > INT_MAX ||
918 crtc_x > INT_MAX - (int32_t) crtc_w ||
920 crtc_y > INT_MAX - (int32_t) crtc_h) {
921 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
922 crtc_w, crtc_h, crtc_x, crtc_y);
926 ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb);
934 * drm_any_plane_has_format - Check whether any plane supports this format and modifier combination
936 * @format: pixel format (DRM_FORMAT_*)
937 * @modifier: data layout modifier
940 * Whether at least one plane supports the specified format and modifier combination.
942 bool drm_any_plane_has_format(struct drm_device *dev,
943 u32 format, u64 modifier)
945 struct drm_plane *plane;
947 drm_for_each_plane(plane, dev) {
948 if (drm_plane_check_pixel_format(plane, format, modifier) == 0)
954 EXPORT_SYMBOL(drm_any_plane_has_format);
957 * __setplane_internal - setplane handler for internal callers
959 * This function will take a reference on the new fb for the plane
962 * src_{x,y,w,h} are provided in 16.16 fixed point format
964 static int __setplane_internal(struct drm_plane *plane,
965 struct drm_crtc *crtc,
966 struct drm_framebuffer *fb,
967 int32_t crtc_x, int32_t crtc_y,
968 uint32_t crtc_w, uint32_t crtc_h,
969 /* src_{x,y,w,h} values are 16.16 fixed point */
970 uint32_t src_x, uint32_t src_y,
971 uint32_t src_w, uint32_t src_h,
972 struct drm_modeset_acquire_ctx *ctx)
976 WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
978 /* No fb means shut it down */
980 plane->old_fb = plane->fb;
981 ret = plane->funcs->disable_plane(plane, ctx);
986 plane->old_fb = NULL;
991 ret = __setplane_check(plane, crtc, fb,
992 crtc_x, crtc_y, crtc_w, crtc_h,
993 src_x, src_y, src_w, src_h);
997 plane->old_fb = plane->fb;
998 ret = plane->funcs->update_plane(plane, crtc, fb,
999 crtc_x, crtc_y, crtc_w, crtc_h,
1000 src_x, src_y, src_w, src_h, ctx);
1004 drm_framebuffer_get(plane->fb);
1006 plane->old_fb = NULL;
1011 drm_framebuffer_put(plane->old_fb);
1012 plane->old_fb = NULL;
1017 static int __setplane_atomic(struct drm_plane *plane,
1018 struct drm_crtc *crtc,
1019 struct drm_framebuffer *fb,
1020 int32_t crtc_x, int32_t crtc_y,
1021 uint32_t crtc_w, uint32_t crtc_h,
1022 uint32_t src_x, uint32_t src_y,
1023 uint32_t src_w, uint32_t src_h,
1024 struct drm_modeset_acquire_ctx *ctx)
1028 WARN_ON(!drm_drv_uses_atomic_modeset(plane->dev));
1030 /* No fb means shut it down */
1032 return plane->funcs->disable_plane(plane, ctx);
1035 * FIXME: This is redundant with drm_atomic_plane_check(),
1036 * but the legacy cursor/"async" .update_plane() tricks
1037 * don't call that so we still need this here. Should remove
1038 * this when all .update_plane() implementations have been
1039 * fixed to call drm_atomic_plane_check().
1041 ret = __setplane_check(plane, crtc, fb,
1042 crtc_x, crtc_y, crtc_w, crtc_h,
1043 src_x, src_y, src_w, src_h);
1047 return plane->funcs->update_plane(plane, crtc, fb,
1048 crtc_x, crtc_y, crtc_w, crtc_h,
1049 src_x, src_y, src_w, src_h, ctx);
1052 static int setplane_internal(struct drm_plane *plane,
1053 struct drm_crtc *crtc,
1054 struct drm_framebuffer *fb,
1055 int32_t crtc_x, int32_t crtc_y,
1056 uint32_t crtc_w, uint32_t crtc_h,
1057 /* src_{x,y,w,h} values are 16.16 fixed point */
1058 uint32_t src_x, uint32_t src_y,
1059 uint32_t src_w, uint32_t src_h)
1061 struct drm_modeset_acquire_ctx ctx;
1064 DRM_MODESET_LOCK_ALL_BEGIN(plane->dev, ctx,
1065 DRM_MODESET_ACQUIRE_INTERRUPTIBLE, ret);
1067 if (drm_drv_uses_atomic_modeset(plane->dev))
1068 ret = __setplane_atomic(plane, crtc, fb,
1069 crtc_x, crtc_y, crtc_w, crtc_h,
1070 src_x, src_y, src_w, src_h, &ctx);
1072 ret = __setplane_internal(plane, crtc, fb,
1073 crtc_x, crtc_y, crtc_w, crtc_h,
1074 src_x, src_y, src_w, src_h, &ctx);
1076 DRM_MODESET_LOCK_ALL_END(plane->dev, ctx, ret);
1081 int drm_mode_setplane(struct drm_device *dev, void *data,
1082 struct drm_file *file_priv)
1084 struct drm_mode_set_plane *plane_req = data;
1085 struct drm_plane *plane;
1086 struct drm_crtc *crtc = NULL;
1087 struct drm_framebuffer *fb = NULL;
1090 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1094 * First, find the plane, crtc, and fb objects. If not available,
1095 * we don't bother to call the driver.
1097 plane = drm_plane_find(dev, file_priv, plane_req->plane_id);
1099 DRM_DEBUG_KMS("Unknown plane ID %d\n",
1100 plane_req->plane_id);
1104 if (plane_req->fb_id) {
1105 fb = drm_framebuffer_lookup(dev, file_priv, plane_req->fb_id);
1107 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
1112 crtc = drm_crtc_find(dev, file_priv, plane_req->crtc_id);
1114 drm_framebuffer_put(fb);
1115 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
1116 plane_req->crtc_id);
1121 ret = setplane_internal(plane, crtc, fb,
1122 plane_req->crtc_x, plane_req->crtc_y,
1123 plane_req->crtc_w, plane_req->crtc_h,
1124 plane_req->src_x, plane_req->src_y,
1125 plane_req->src_w, plane_req->src_h);
1128 drm_framebuffer_put(fb);
1133 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
1134 struct drm_mode_cursor2 *req,
1135 struct drm_file *file_priv,
1136 struct drm_modeset_acquire_ctx *ctx)
1138 struct drm_device *dev = crtc->dev;
1139 struct drm_plane *plane = crtc->cursor;
1140 struct drm_framebuffer *fb = NULL;
1141 struct drm_mode_fb_cmd2 fbreq = {
1142 .width = req->width,
1143 .height = req->height,
1144 .pixel_format = DRM_FORMAT_ARGB8888,
1145 .pitches = { req->width * 4 },
1146 .handles = { req->handle },
1148 int32_t crtc_x, crtc_y;
1149 uint32_t crtc_w = 0, crtc_h = 0;
1150 uint32_t src_w = 0, src_h = 0;
1154 WARN_ON(plane->crtc != crtc && plane->crtc != NULL);
1157 * Obtain fb we'll be using (either new or existing) and take an extra
1158 * reference to it if fb != null. setplane will take care of dropping
1159 * the reference if the plane update fails.
1161 if (req->flags & DRM_MODE_CURSOR_BO) {
1163 fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv);
1165 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
1169 if (plane->hotspot_x_property && plane->state)
1170 plane->state->hotspot_x = req->hot_x;
1171 if (plane->hotspot_y_property && plane->state)
1172 plane->state->hotspot_y = req->hot_y;
1178 fb = plane->state->fb;
1183 drm_framebuffer_get(fb);
1186 if (req->flags & DRM_MODE_CURSOR_MOVE) {
1190 crtc_x = crtc->cursor_x;
1191 crtc_y = crtc->cursor_y;
1196 crtc_h = fb->height;
1197 src_w = fb->width << 16;
1198 src_h = fb->height << 16;
1201 if (drm_drv_uses_atomic_modeset(dev))
1202 ret = __setplane_atomic(plane, crtc, fb,
1203 crtc_x, crtc_y, crtc_w, crtc_h,
1204 0, 0, src_w, src_h, ctx);
1206 ret = __setplane_internal(plane, crtc, fb,
1207 crtc_x, crtc_y, crtc_w, crtc_h,
1208 0, 0, src_w, src_h, ctx);
1211 drm_framebuffer_put(fb);
1213 /* Update successful; save new cursor position, if necessary */
1214 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
1215 crtc->cursor_x = req->x;
1216 crtc->cursor_y = req->y;
1222 static int drm_mode_cursor_common(struct drm_device *dev,
1223 struct drm_mode_cursor2 *req,
1224 struct drm_file *file_priv)
1226 struct drm_crtc *crtc;
1227 struct drm_modeset_acquire_ctx ctx;
1230 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1233 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
1236 crtc = drm_crtc_find(dev, file_priv, req->crtc_id);
1238 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
1242 drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
1244 ret = drm_modeset_lock(&crtc->mutex, &ctx);
1248 * If this crtc has a universal cursor plane, call that plane's update
1249 * handler rather than using legacy cursor handlers.
1252 ret = drm_modeset_lock(&crtc->cursor->mutex, &ctx);
1256 if (!drm_lease_held(file_priv, crtc->cursor->base.id)) {
1261 ret = drm_mode_cursor_universal(crtc, req, file_priv, &ctx);
1265 if (req->flags & DRM_MODE_CURSOR_BO) {
1266 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
1270 /* Turns off the cursor if handle is 0 */
1271 if (crtc->funcs->cursor_set2)
1272 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
1273 req->width, req->height, req->hot_x, req->hot_y);
1275 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
1276 req->width, req->height);
1279 if (req->flags & DRM_MODE_CURSOR_MOVE) {
1280 if (crtc->funcs->cursor_move) {
1281 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
1288 if (ret == -EDEADLK) {
1289 ret = drm_modeset_backoff(&ctx);
1294 drm_modeset_drop_locks(&ctx);
1295 drm_modeset_acquire_fini(&ctx);
1302 int drm_mode_cursor_ioctl(struct drm_device *dev,
1303 void *data, struct drm_file *file_priv)
1305 struct drm_mode_cursor *req = data;
1306 struct drm_mode_cursor2 new_req;
1308 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
1309 new_req.hot_x = new_req.hot_y = 0;
1311 return drm_mode_cursor_common(dev, &new_req, file_priv);
1315 * Set the cursor configuration based on user request. This implements the 2nd
1316 * version of the cursor ioctl, which allows userspace to additionally specify
1317 * the hotspot of the pointer.
1319 int drm_mode_cursor2_ioctl(struct drm_device *dev,
1320 void *data, struct drm_file *file_priv)
1322 struct drm_mode_cursor2 *req = data;
1324 return drm_mode_cursor_common(dev, req, file_priv);
1327 int drm_mode_page_flip_ioctl(struct drm_device *dev,
1328 void *data, struct drm_file *file_priv)
1330 struct drm_mode_crtc_page_flip_target *page_flip = data;
1331 struct drm_crtc *crtc;
1332 struct drm_plane *plane;
1333 struct drm_framebuffer *fb = NULL, *old_fb;
1334 struct drm_pending_vblank_event *e = NULL;
1335 u32 target_vblank = page_flip->sequence;
1336 struct drm_modeset_acquire_ctx ctx;
1339 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1342 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS)
1345 if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET))
1348 /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
1351 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET)
1354 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
1357 crtc = drm_crtc_find(dev, file_priv, page_flip->crtc_id);
1361 plane = crtc->primary;
1363 if (!drm_lease_held(file_priv, plane->base.id))
1366 if (crtc->funcs->page_flip_target) {
1370 r = drm_crtc_vblank_get(crtc);
1374 current_vblank = (u32)drm_crtc_vblank_count(crtc);
1376 switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) {
1377 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE:
1378 if ((int)(target_vblank - current_vblank) > 1) {
1379 DRM_DEBUG("Invalid absolute flip target %u, "
1380 "must be <= %u\n", target_vblank,
1381 current_vblank + 1);
1382 drm_crtc_vblank_put(crtc);
1386 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE:
1387 if (target_vblank != 0 && target_vblank != 1) {
1388 DRM_DEBUG("Invalid relative flip target %u, "
1389 "must be 0 or 1\n", target_vblank);
1390 drm_crtc_vblank_put(crtc);
1393 target_vblank += current_vblank;
1396 target_vblank = current_vblank +
1397 !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC);
1400 } else if (crtc->funcs->page_flip == NULL ||
1401 (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) {
1405 drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
1407 ret = drm_modeset_lock(&crtc->mutex, &ctx);
1410 ret = drm_modeset_lock(&plane->mutex, &ctx);
1415 old_fb = plane->state->fb;
1419 if (old_fb == NULL) {
1420 /* The framebuffer is currently unbound, presumably
1421 * due to a hotplug event, that userspace has not
1428 fb = drm_framebuffer_lookup(dev, file_priv, page_flip->fb_id);
1435 const struct drm_plane_state *state = plane->state;
1437 ret = drm_framebuffer_check_src_coords(state->src_x,
1443 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y,
1450 * Only check the FOURCC format code, excluding modifiers. This is
1451 * enough for all legacy drivers. Atomic drivers have their own
1452 * checks in their ->atomic_check implementation, which will
1453 * return -EINVAL if any hw or driver constraint is violated due
1454 * to modifier changes.
1456 if (old_fb->format->format != fb->format->format) {
1457 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
1462 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1463 e = kzalloc(sizeof *e, GFP_KERNEL);
1469 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1470 e->event.base.length = sizeof(e->event);
1471 e->event.vbl.user_data = page_flip->user_data;
1472 e->event.vbl.crtc_id = crtc->base.id;
1474 ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
1482 plane->old_fb = plane->fb;
1483 if (crtc->funcs->page_flip_target)
1484 ret = crtc->funcs->page_flip_target(crtc, fb, e,
1489 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags,
1492 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT)
1493 drm_event_cancel_free(dev, &e->base);
1494 /* Keep the old fb, don't unref it. */
1495 plane->old_fb = NULL;
1497 if (!plane->state) {
1499 drm_framebuffer_get(fb);
1505 drm_framebuffer_put(fb);
1507 drm_framebuffer_put(plane->old_fb);
1508 plane->old_fb = NULL;
1510 if (ret == -EDEADLK) {
1511 ret = drm_modeset_backoff(&ctx);
1516 drm_modeset_drop_locks(&ctx);
1517 drm_modeset_acquire_fini(&ctx);
1519 if (ret && crtc->funcs->page_flip_target)
1520 drm_crtc_vblank_put(crtc);
1526 * DOC: damage tracking
1528 * FB_DAMAGE_CLIPS is an optional plane property which provides a means to
1529 * specify a list of damage rectangles on a plane in framebuffer coordinates of
1530 * the framebuffer attached to the plane. In current context damage is the area
1531 * of plane framebuffer that has changed since last plane update (also called
1532 * page-flip), irrespective of whether currently attached framebuffer is same as
1533 * framebuffer attached during last plane update or not.
1535 * FB_DAMAGE_CLIPS is a hint to kernel which could be helpful for some drivers
1536 * to optimize internally especially for virtual devices where each framebuffer
1537 * change needs to be transmitted over network, usb, etc.
1539 * Since FB_DAMAGE_CLIPS is a hint so it is an optional property. User-space can
1540 * ignore damage clips property and in that case driver will do a full plane
1541 * update. In case damage clips are provided then it is guaranteed that the area
1542 * inside damage clips will be updated to plane. For efficiency driver can do
1543 * full update or can update more than specified in damage clips. Since driver
1544 * is free to read more, user-space must always render the entire visible
1545 * framebuffer. Otherwise there can be corruptions. Also, if a user-space
1546 * provides damage clips which doesn't encompass the actual damage to
1547 * framebuffer (since last plane update) can result in incorrect rendering.
1549 * FB_DAMAGE_CLIPS is a blob property with the layout of blob data is simply an
1550 * array of &drm_mode_rect. Unlike plane &drm_plane_state.src coordinates,
1551 * damage clips are not in 16.16 fixed point. Similar to plane src in
1552 * framebuffer, damage clips cannot be negative. In damage clip, x1/y1 are
1553 * inclusive and x2/y2 are exclusive. While kernel does not error for overlapped
1554 * damage clips, it is strongly discouraged.
1556 * Drivers that are interested in damage interface for plane should enable
1557 * FB_DAMAGE_CLIPS property by calling drm_plane_enable_fb_damage_clips().
1558 * Drivers implementing damage can use drm_atomic_helper_damage_iter_init() and
1559 * drm_atomic_helper_damage_iter_next() helper iterator function to get damage
1560 * rectangles clipped to &drm_plane_state.src.
1562 * Note that there are two types of damage handling: frame damage and buffer
1563 * damage, the type of damage handling implemented depends on a driver's upload
1564 * target. Drivers implementing a per-plane or per-CRTC upload target need to
1565 * handle frame damage, while drivers implementing a per-buffer upload target
1566 * need to handle buffer damage.
1568 * The existing damage helpers only support the frame damage type, there is no
1569 * buffer age support or similar damage accumulation algorithm implemented yet.
1571 * Only drivers handling frame damage can use the mentioned damage helpers to
1572 * iterate over the damaged regions. Drivers that handle buffer damage, must set
1573 * &drm_plane_state.ignore_damage_clips for drm_atomic_helper_damage_iter_init()
1574 * to know that damage clips should be ignored and return &drm_plane_state.src
1575 * as the damage rectangle, to force a full plane update.
1577 * Drivers with a per-buffer upload target could compare the &drm_plane_state.fb
1578 * of the old and new plane states to determine if the framebuffer attached to a
1579 * plane has changed or not since the last plane update. If &drm_plane_state.fb
1580 * has changed, then &drm_plane_state.ignore_damage_clips must be set to true.
1582 * That is because drivers with a per-plane upload target, expect the backing
1583 * storage buffer to not change for a given plane. If the upload buffer changes
1584 * between page flips, the new upload buffer has to be updated as a whole. This
1585 * can be improved in the future if support for frame damage is added to the DRM
1586 * damage helpers, similarly to how user-space already handle this case as it is
1587 * explained in the following documents:
1589 * https://registry.khronos.org/EGL/extensions/KHR/EGL_KHR_swap_buffers_with_damage.txt
1590 * https://emersion.fr/blog/2019/intro-to-damage-tracking/
1594 * drm_plane_enable_fb_damage_clips - Enables plane fb damage clips property.
1595 * @plane: Plane on which to enable damage clips property.
1597 * This function lets driver to enable the damage clips property on a plane.
1599 void drm_plane_enable_fb_damage_clips(struct drm_plane *plane)
1601 struct drm_device *dev = plane->dev;
1602 struct drm_mode_config *config = &dev->mode_config;
1604 drm_object_attach_property(&plane->base, config->prop_fb_damage_clips,
1607 EXPORT_SYMBOL(drm_plane_enable_fb_damage_clips);
1610 * drm_plane_get_damage_clips_count - Returns damage clips count.
1611 * @state: Plane state.
1613 * Simple helper to get the number of &drm_mode_rect clips set by user-space
1614 * during plane update.
1616 * Return: Number of clips in plane fb_damage_clips blob property.
1619 drm_plane_get_damage_clips_count(const struct drm_plane_state *state)
1621 return (state && state->fb_damage_clips) ?
1622 state->fb_damage_clips->length/sizeof(struct drm_mode_rect) : 0;
1624 EXPORT_SYMBOL(drm_plane_get_damage_clips_count);
1626 struct drm_mode_rect *
1627 __drm_plane_get_damage_clips(const struct drm_plane_state *state)
1629 return (struct drm_mode_rect *)((state && state->fb_damage_clips) ?
1630 state->fb_damage_clips->data : NULL);
1634 * drm_plane_get_damage_clips - Returns damage clips.
1635 * @state: Plane state.
1637 * Note that this function returns uapi type &drm_mode_rect. Drivers might want
1638 * to use the helper functions drm_atomic_helper_damage_iter_init() and
1639 * drm_atomic_helper_damage_iter_next() or drm_atomic_helper_damage_merged() if
1640 * the driver can only handle a single damage region at most.
1642 * Return: Damage clips in plane fb_damage_clips blob property.
1644 struct drm_mode_rect *
1645 drm_plane_get_damage_clips(const struct drm_plane_state *state)
1647 struct drm_device *dev = state->plane->dev;
1648 struct drm_mode_config *config = &dev->mode_config;
1650 /* check that drm_plane_enable_fb_damage_clips() was called */
1651 if (!drm_mode_obj_find_prop_id(&state->plane->base,
1652 config->prop_fb_damage_clips->base.id))
1653 drm_warn_once(dev, "drm_plane_enable_fb_damage_clips() not called\n");
1655 return __drm_plane_get_damage_clips(state);
1657 EXPORT_SYMBOL(drm_plane_get_damage_clips);
1659 struct drm_property *
1660 drm_create_scaling_filter_prop(struct drm_device *dev,
1661 unsigned int supported_filters)
1663 struct drm_property *prop;
1664 static const struct drm_prop_enum_list props[] = {
1665 { DRM_SCALING_FILTER_DEFAULT, "Default" },
1666 { DRM_SCALING_FILTER_NEAREST_NEIGHBOR, "Nearest Neighbor" },
1668 unsigned int valid_mode_mask = BIT(DRM_SCALING_FILTER_DEFAULT) |
1669 BIT(DRM_SCALING_FILTER_NEAREST_NEIGHBOR);
1672 if (WARN_ON((supported_filters & ~valid_mode_mask) ||
1673 ((supported_filters & BIT(DRM_SCALING_FILTER_DEFAULT)) == 0)))
1674 return ERR_PTR(-EINVAL);
1676 prop = drm_property_create(dev, DRM_MODE_PROP_ENUM,
1678 hweight32(supported_filters));
1680 return ERR_PTR(-ENOMEM);
1682 for (i = 0; i < ARRAY_SIZE(props); i++) {
1685 if (!(BIT(props[i].type) & supported_filters))
1688 ret = drm_property_add_enum(prop, props[i].type,
1692 drm_property_destroy(dev, prop);
1694 return ERR_PTR(ret);
1702 * drm_plane_create_scaling_filter_property - create a new scaling filter
1706 * @supported_filters: bitmask of supported scaling filters, must include
1707 * BIT(DRM_SCALING_FILTER_DEFAULT).
1709 * This function lets driver to enable the scaling filter property on a given
1713 * Zero for success or -errno
1715 int drm_plane_create_scaling_filter_property(struct drm_plane *plane,
1716 unsigned int supported_filters)
1718 struct drm_property *prop =
1719 drm_create_scaling_filter_prop(plane->dev, supported_filters);
1722 return PTR_ERR(prop);
1724 drm_object_attach_property(&plane->base, prop,
1725 DRM_SCALING_FILTER_DEFAULT);
1726 plane->scaling_filter_property = prop;
1730 EXPORT_SYMBOL(drm_plane_create_scaling_filter_property);