Add a small description and document struct fields of
drm_mode_get_plane.

Signed-off-by: Leandro Ribeiro <leandro.ribe...@collabora.com>
---
 include/uapi/drm/drm_mode.h | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
index d1a93d2a85f9..96fc9a6da608 100644
--- a/include/uapi/drm/drm_mode.h
+++ b/include/uapi/drm/drm_mode.h
@@ -312,16 +312,35 @@ struct drm_mode_set_plane {
        __u32 src_w;
 };
 
+/**
+ * struct drm_mode_get_plane - Get plane metadata.
+ *
+ * Userspace can perform a GETPLANE ioctl to retrieve information about a
+ * plane.
+ */
 struct drm_mode_get_plane {
+       /** @plane_id: Object ID of the plane. */
        __u32 plane_id;
 
+       /** @crtc_id: Object ID of the current CRTC. */
        __u32 crtc_id;
+       /** @fb_id: Object ID of the current fb. */
        __u32 fb_id;
 
+       /**
+        * @possible_crtcs: Pointer to ``__u32`` array of CRTC's that are
+        * compatible with the plane.
+        */
        __u32 possible_crtcs;
+       /** @gamma_size: Size of the legacy gamma table. */
        __u32 gamma_size;
 
+       /** @count_format_types: Number of formats. */
        __u32 count_format_types;
+       /**
+        * @format_type_ptr: Pointer to ``__u32`` array of formats that are
+        * supported by the plane. These formats do not require modifiers.
+        */
        __u64 format_type_ptr;
 };
 
-- 
2.31.1

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Reply via email to