44  * struct drm_plane_state - mutable plane state
53 	/** @plane: backpointer to the plane */
54 	struct drm_plane *plane;  member
88 	 * Left position of visible portion of plane on crtc, signed dest
96 	 * Upper position of visible portion of plane on crtc, signed dest
101 	/** @crtc_w: width of visible portion of plane on crtc */
102 	/** @crtc_h: height of visible portion of plane on crtc */
106 	 * @src_x: left position of visible portion of plane within plane (in
111 	 * @src_y: upper position of visible portion of plane within plane (in
115 	/** @src_w: width of visible portion of plane (in 16.16) */
116 	/** @src_h: height of visible portion of plane (in 16.16) */
125 	 * Opacity of the plane with 0 as completely transparent and 0xffff as
134 	 * the current plane are composited with the background. Value can be
141 	 * Rotation of the plane. See drm_plane_create_rotation_property() for
148 	 * Priority of the given plane on crtc (optional).
153 	 * plane object IDs; the plane with a higher ID is stacked on top of a
154 	 * plane with a lower ID.
187 	 * Blob representing damage (area in plane framebuffer that changed
188 	 * since last plane update) as an array of &drm_mode_rect in framebuffer
189 	 * coodinates of the attached framebuffer. Note that unlike plane src,
210 	 * source coordinates of the plane (in 16.16).
220 	 * clipped destination coordinates of the plane.
232 	 * Visibility of the plane. This can be false even if fb!=NULL and
246 	 * and for async plane updates.
288  * struct drm_plane_funcs - driver plane control functions
294 	 * This is the legacy entry point to enable and configure the plane for
296 	 * plane, i.e. the passed-in crtc and fb paramters are never NULL.
300 	 * values). Devices that don't support subpixel plane coordinates can
317 	int (*update_plane)(struct drm_plane *plane,
328 	 * This is the legacy entry point to disable the plane. The DRM core
340 	int (*disable_plane)(struct drm_plane *plane,
346 	 * Clean up plane resources. This is only called at driver unload time
347 	 * through drm_mode_config_cleanup() since a plane cannot be hotplugged
350 	void (*destroy)(struct drm_plane *plane);
355 	 * Reset plane hardware and software state to off. This function isn't
362 	void (*reset)(struct drm_plane *plane);
368 	 * plane.
378 	int (*set_property)(struct drm_plane *plane,
384 	 * Duplicate the current atomic state for this plane and return it.
412 	struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
422 	void (*atomic_destroy_state)(struct drm_plane *plane,
462 	 * asks for properties attached to this plane). No other validation is
467 	int (*atomic_set_property)(struct drm_plane *plane,
488 	 * properties attached to this plane).
490 	int (*atomic_get_property)(struct drm_plane *plane,
498 	 * interfaces attached to the plane like debugfs interfaces.
507 	int (*late_register)(struct drm_plane *plane);
513 	 * userspace interfaces attached to the plane from
518 	void (*early_unregister)(struct drm_plane *plane);
536 	 * format/modifier combination is valid for the plane. This allows the
540 	 * If not present, then any modifier in the plane's modifier
541 	 * list is allowed with any of the plane's formats.
545 	 * True if the given modifier is valid for that format on the plane.
548 	bool (*format_mod_supported)(struct drm_plane *plane, uint32_t format,
553  * enum drm_plane_type - uapi plane type enumeration
557  * uapi semantics for them. For userspace which is universal plane aware and
564  * wish to receive a universal plane list containing all plane types. See also
567  * In addition to setting each plane's type, drivers need to setup the
586 	 * A primary plane attached to a CRTC is the most likely to be able to
587 	 * light up the CRTC when no scaling/cropping is used and the plane
595 	 * A cursor plane attached to a CRTC is more likely to be able to be
606  * struct drm_plane - central DRM plane control structure
610  * the color conversion, see `Plane Composition Properties`_ for more details,
615 	/** @dev: DRM device this plane belongs to */
633 	 * Protects modeset plane state, together with the &drm_crtc.mutex of
634 	 * CRTC this plane is linked to (when active, getting activated or
645 	 * @possible_crtcs: pipes this plane can be bound to constructed from
649 	/** @format_types: array of formats supported by this plane */
655 	 * plane. Used by the non-atomic driver compatibility wrapper only.
659 	/** @modifiers: array of modifiers supported by this plane */
690 	/** @funcs: plane control functions */
693 	/** @properties: property tracking for this plane */
696 	/** @type: Type of plane, see &enum drm_plane_type for details. */
701 	 * index. It is invariant over the lifetime of the plane.
711 	 * Current atomic state for this plane.
714 	 * access the current plane state without taking locks. Either by going
725 	 * Optional alpha property for this plane. See
731 	 * Optional zpos property for this plane. See
737 	 * Optional rotation property for this plane. See
743 	 * Optional "pixel blend mode" enum property for this plane.
745 	 * describing how the pixels from the current plane are composited with
788 			     struct drm_plane *plane,
796 void drm_plane_cleanup(struct drm_plane *plane);
810  * drmm_universal_plane_alloc - Allocate and initialize an universal plane object
815  * @funcs: callbacks for the new plane
820  * @plane_type: type of plane (overlay, primary, cursor)
821  * @name: printf style format string for the plane name, or NULL for default name
823  * Allocates and initializes a plane object of type @type. Cleanup is
830  * @format_modifiers to NULL. The plane will advertise the linear modifier.
833  * Pointer to new plane, or ERR_PTR on failure.
855  * drm_universal_plane_alloc() - Allocate and initialize an universal plane object
860  * @funcs: callbacks for the new plane
865  * @plane_type: type of plane (overlay, primary, cursor)
866  * @name: printf style format string for the plane name, or NULL for default name
868  * Allocates and initializes a plane object of type @type. The caller
874  * @format_modifiers to NULL. The plane will advertise the linear modifier.
877  * Pointer to new plane, or ERR_PTR on failure.
888  * drm_plane_index - find the index of a registered plane
889  * @plane: plane to find index for
891  * Given a registered plane, return the index of that plane within a DRM
894 static inline unsigned int drm_plane_index(const struct drm_plane *plane)  in drm_plane_index()  argument
896 	return plane->index;  in drm_plane_index()
900  * drm_plane_mask - find the mask of a registered plane
901  * @plane: plane to find mask for
903 static inline u32 drm_plane_mask(const struct drm_plane *plane)  in drm_plane_mask()  argument
905 	return 1 << drm_plane_index(plane);  in drm_plane_mask()
909 void drm_plane_force_disable(struct drm_plane *plane);
911 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
919  * @id: plane id
921  * Returns the plane with @id, NULL if it doesn't exist. Simple wrapper around
935  * @plane: the loop cursor
937  * @plane_mask: bitmask of plane indices
941 #define drm_for_each_plane_mask(plane, dev, plane_mask) \  argument
942 	list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
943 		for_each_if ((plane_mask) & drm_plane_mask(plane))
947  * @plane: the loop cursor
952  * universal plane aware. See also &enum drm_plane_type.
954 #define drm_for_each_legacy_plane(plane, dev) \  argument
955 	list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
956 		for_each_if (plane->type == DRM_PLANE_TYPE_OVERLAY)
960  * @plane: the loop cursor
965 #define drm_for_each_plane(plane, dev) \  argument
966 	list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
971 void drm_plane_enable_fb_damage_clips(struct drm_plane *plane);
977 int drm_plane_create_scaling_filter_property(struct drm_plane *plane,