diff options
| author | Leandro Ribeiro <leandro.ribeiro@collabora.com> | 2021-06-11 18:35:16 -0300 |
|---|---|---|
| committer | Simon Ser <contact@emersion.fr> | 2021-06-14 09:22:07 +0200 |
| commit | ade0e676ecdcdd3428210684c76493722e09a791 (patch) | |
| tree | 8997b2579e6ca9aa94acfe8384bb94229040fcd4 /include/uapi | |
| parent | bfd616ff9a2602ec66414438c3f9871a49fa1e16 (diff) | |
| download | linux-stable-ade0e676ecdcdd3428210684c76493722e09a791.tar.gz linux-stable-ade0e676ecdcdd3428210684c76493722e09a791.tar.bz2 linux-stable-ade0e676ecdcdd3428210684c76493722e09a791.zip | |
drm/doc: document drm_mode_get_plane
Add a small description and document struct fields of
drm_mode_get_plane.
Signed-off-by: Leandro Ribeiro <leandro.ribeiro@collabora.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.com>
Signed-off-by: Simon Ser <contact@emersion.fr>
Link: https://patchwork.freedesktop.org/patch/msgid/20210611213516.77904-2-leandro.ribeiro@collabora.com
Diffstat (limited to 'include/uapi')
| -rw-r--r-- | include/uapi/drm/drm_mode.h | 32 |
1 files changed, 32 insertions, 0 deletions
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; }; |