46  * struct drm_plane_state - mutable plane state
55 	/** @plane: backpointer to the plane */
56 	struct drm_plane *plane;  member
90 	 * Left position of visible portion of plane on crtc, signed dest
98 	 * Upper position of visible portion of plane on crtc, signed dest
103 	/** @crtc_w: width of visible portion of plane on crtc */
104 	/** @crtc_h: height of visible portion of plane on crtc */
108 	 * @src_x: left position of visible portion of plane within plane (in
113 	 * @src_y: upper position of visible portion of plane within plane (in
117 	/** @src_w: width of visible portion of plane (in 16.16) */
118 	/** @src_h: height of visible portion of plane (in 16.16) */
127 	 * Opacity of the plane with 0 as completely transparent and 0xffff as
136 	 * the current plane are composited with the background. Value can be
143 	 * Rotation of the plane. See drm_plane_create_rotation_property() for
150 	 * Priority of the given plane on crtc (optional).
155 	 * plane object IDs; the plane with a higher ID is stacked on top of a
156 	 * plane with a lower ID.
189 	 * Blob representing damage (area in plane framebuffer that changed
190 	 * since last plane update) as an array of &drm_mode_rect in framebuffer
191 	 * coodinates of the attached framebuffer. Note that unlike plane src,
212 	 * source coordinates of the plane (in 16.16).
222 	 * clipped destination coordinates of the plane.
234 	 * Visibility of the plane. This can be false even if fb!=NULL and
248 	 * and for async plane updates.
290  * struct drm_plane_funcs - driver plane control functions
296 	 * This is the legacy entry point to enable and configure the plane for
298 	 * plane, i.e. the passed-in crtc and fb paramters are never NULL.
302 	 * values). Devices that don't support subpixel plane coordinates can
319 	int (*update_plane)(struct drm_plane *plane,
330 	 * This is the legacy entry point to disable the plane. The DRM core
342 	int (*disable_plane)(struct drm_plane *plane,
348 	 * Clean up plane resources. This is only called at driver unload time
349 	 * through drm_mode_config_cleanup() since a plane cannot be hotplugged
352 	void (*destroy)(struct drm_plane *plane);
357 	 * Reset plane hardware and software state to off. This function isn't
364 	void (*reset)(struct drm_plane *plane);
370 	 * plane.
380 	int (*set_property)(struct drm_plane *plane,
386 	 * Duplicate the current atomic state for this plane and return it.
414 	struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
424 	void (*atomic_destroy_state)(struct drm_plane *plane,
464 	 * asks for properties attached to this plane). No other validation is
469 	int (*atomic_set_property)(struct drm_plane *plane,
490 	 * properties attached to this plane).
492 	int (*atomic_get_property)(struct drm_plane *plane,
500 	 * interfaces attached to the plane like debugfs interfaces.
509 	int (*late_register)(struct drm_plane *plane);
515 	 * userspace interfaces attached to the plane from
520 	void (*early_unregister)(struct drm_plane *plane);
538 	 * format/modifier combination is valid for the plane. This allows the
542 	 * If not present, then any modifier in the plane's modifier
543 	 * list is allowed with any of the plane's formats.
547 	 * True if the given modifier is valid for that format on the plane.
550 	bool (*format_mod_supported)(struct drm_plane *plane, uint32_t format,
555  * enum drm_plane_type - uapi plane type enumeration
559  * uapi semantics for them. For userspace which is universal plane aware and
566  * wish to receive a universal plane list containing all plane types. See also
569  * In addition to setting each plane's type, drivers need to setup the
588 	 * A primary plane attached to a CRTC is the most likely to be able to
589 	 * light up the CRTC when no scaling/cropping is used and the plane
597 	 * A cursor plane attached to a CRTC is more likely to be able to be
608  * struct drm_plane - central DRM plane control structure
612  * the color conversion, see `Plane Composition Properties`_ for more details,
617 	/** @dev: DRM device this plane belongs to */
635 	 * Protects modeset plane state, together with the &drm_crtc.mutex of
636 	 * CRTC this plane is linked to (when active, getting activated or
647 	 * @possible_crtcs: pipes this plane can be bound to constructed from
651 	/** @format_types: array of formats supported by this plane */
657 	 * plane. Used by the non-atomic driver compatibility wrapper only.
661 	/** @modifiers: array of modifiers supported by this plane */
692 	/** @funcs: plane control functions */
695 	/** @properties: property tracking for this plane */
698 	/** @type: Type of plane, see &enum drm_plane_type for details. */
703 	 * index. It is invariant over the lifetime of the plane.
713 	 * Current atomic state for this plane.
716 	 * access the current plane state without taking locks. Either by going
727 	 * Optional alpha property for this plane. See
733 	 * Optional zpos property for this plane. See
739 	 * Optional rotation property for this plane. See
745 	 * Optional "pixel blend mode" enum property for this plane.
747 	 * describing how the pixels from the current plane are composited with
786 	 * @kmsg_panic: Used to register a panic notifier for this plane
795 			     struct drm_plane *plane,
803 void drm_plane_cleanup(struct drm_plane *plane);
817  * drmm_universal_plane_alloc - Allocate and initialize an universal plane object
822  * @funcs: callbacks for the new plane
827  * @plane_type: type of plane (overlay, primary, cursor)
828  * @name: printf style format string for the plane name, or NULL for default name
830  * Allocates and initializes a plane object of type @type. Cleanup is
837  * @format_modifiers to NULL. The plane will advertise the linear modifier.
840  * Pointer to new plane, or ERR_PTR on failure.
862  * drm_universal_plane_alloc() - Allocate and initialize an universal plane object
867  * @funcs: callbacks for the new plane
872  * @plane_type: type of plane (overlay, primary, cursor)
873  * @name: printf style format string for the plane name, or NULL for default name
875  * Allocates and initializes a plane object of type @type. The caller
881  * @format_modifiers to NULL. The plane will advertise the linear modifier.
884  * Pointer to new plane, or ERR_PTR on failure.
895  * drm_plane_index - find the index of a registered plane
896  * @plane: plane to find index for
898  * Given a registered plane, return the index of that plane within a DRM
901 static inline unsigned int drm_plane_index(const struct drm_plane *plane)  in drm_plane_index()  argument
903 	return plane->index;  in drm_plane_index()
907  * drm_plane_mask - find the mask of a registered plane
908  * @plane: plane to find mask for
910 static inline u32 drm_plane_mask(const struct drm_plane *plane)  in drm_plane_mask()  argument
912 	return 1 << drm_plane_index(plane);  in drm_plane_mask()
916 void drm_plane_force_disable(struct drm_plane *plane);
918 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
926  * @id: plane id
928  * Returns the plane with @id, NULL if it doesn't exist. Simple wrapper around
942  * @plane: the loop cursor
944  * @plane_mask: bitmask of plane indices
948 #define drm_for_each_plane_mask(plane, dev, plane_mask) \  argument
949 	list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
950 		for_each_if ((plane_mask) & drm_plane_mask(plane))
954  * @plane: the loop cursor
959  * universal plane aware. See also &enum drm_plane_type.
961 #define drm_for_each_legacy_plane(plane, dev) \  argument
962 	list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
963 		for_each_if (plane->type == DRM_PLANE_TYPE_OVERLAY)
967  * @plane: the loop cursor
972 #define drm_for_each_plane(plane, dev) \  argument
973 	list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
975 bool drm_plane_has_format(struct drm_plane *plane,
980 void drm_plane_enable_fb_damage_clips(struct drm_plane *plane);
986 int drm_plane_create_scaling_filter_property(struct drm_plane *plane,
988 int drm_plane_add_size_hints_property(struct drm_plane *plane,