v2: possible_crtcs field is a bitmask, not a pointer. Suggested by Ville Syrjälä ville.syrjala@linux.intel.com
v3: document how userspace should find out CRTC index. Also, document that field 'gamma_size' represents the number of entries in the lookup table. Suggested by Pekka Paalanen ppaalanen@gmail.com and Daniel Vetter daniel@ffwll.ch
v4: document IN and OUT fields and make the description more concise. Suggested by Pekka Paalanen ppaalanen@gmail.com
v5: CRTC index patch already merged, only patch to document drm_mode_get_plane now. Added that gamma LUT size is deprecated and dropped incorrect text documenting that plane number of formats may change from one ioctl to the other. Suggested by Ville Syrjälä ville.syrjala@linux.intel.com
v6: document that gamma_size field was never used. Suggested by Pekka Paalanen ppaalanen@gmail.com and Daniel Vetter daniel@ffwll.ch
Leandro Ribeiro (1): drm/doc: document drm_mode_get_plane
include/uapi/drm/drm_mode.h | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+)
-- 2.31.1
Add a small description and document struct fields of drm_mode_get_plane.
Signed-off-by: Leandro Ribeiro leandro.ribeiro@collabora.com --- include/uapi/drm/drm_mode.h | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+)
diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h index 9b6722d45f36..98bf130feda5 100644 --- a/include/uapi/drm/drm_mode.h +++ b/include/uapi/drm/drm_mode.h @@ -312,16 +312,48 @@ 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. + * + * To retrieve the number of formats supported, set @count_format_types to zero + * and call the ioctl. @count_format_types will be updated with the value. + * + * To retrieve these formats, allocate an array with the memory needed to store + * @count_format_types formats. Point @format_type_ptr to this array and call + * the ioctl again (with @count_format_types still set to the value returned in + * the first ioctl call). + */ struct drm_mode_get_plane { + /** + * @plane_id: Object ID of the plane whose information should be + * retrieved. Set by caller. + */ __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: Bitmask of CRTC's compatible with the plane. CRTC's + * are created and they receive an index, which corresponds to their + * position in the bitmask. Bit N corresponds to + * :ref:`CRTC index<crtc_index>` N. + */ __u32 possible_crtcs; + /** @gamma_size: Never used. */ __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
On Fri, 11 Jun 2021 18:35:16 -0300 Leandro Ribeiro leandro.ribeiro@collabora.com wrote:
Add a small description and document struct fields of drm_mode_get_plane.
Signed-off-by: Leandro Ribeiro leandro.ribeiro@collabora.com
Hi,
my
Reviewed-by: Pekka Paalanen pekka.paalanen@collabora.com
still stands as mentioned earlier.
Thanks, pq
include/uapi/drm/drm_mode.h | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+)
diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h index 9b6722d45f36..98bf130feda5 100644 --- a/include/uapi/drm/drm_mode.h +++ b/include/uapi/drm/drm_mode.h @@ -312,16 +312,48 @@ 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.
- To retrieve the number of formats supported, set @count_format_types to zero
- and call the ioctl. @count_format_types will be updated with the value.
- To retrieve these formats, allocate an array with the memory needed to store
- @count_format_types formats. Point @format_type_ptr to this array and call
- the ioctl again (with @count_format_types still set to the value returned in
- the first ioctl call).
- */
struct drm_mode_get_plane {
/**
* @plane_id: Object ID of the plane whose information should be* retrieved. Set by caller.*/__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: Bitmask of CRTC's compatible with the plane. CRTC's* are created and they receive an index, which corresponds to their* position in the bitmask. Bit N corresponds to* :ref:`CRTC index<crtc_index>` N.*/__u32 possible_crtcs;
/** @gamma_size: Never used. */ __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
Pushed to drm-misc-next, thanks!
dri-devel@lists.freedesktop.org
-
Leandro Ribeiro -
Pekka Paalanen -
Simon Ser