From: Leandro Ribeiro <leandro.ribeiro@collabora.com>
To: dri-devel@lists.freedesktop.org
Cc: airlied@linux.ie, pekka.paalanen@collabora.co.uk, kernel@collabora.com
Subject: Re: [PATCH v4 2/2] drm/doc: document drm_mode_get_plane
Date: Wed, 9 Jun 2021 20:05:06 -0300 [thread overview]
Message-ID: <b26a33dd-39ac-48b4-7c9d-512d13ea9acd@collabora.com> (raw)
In-Reply-To: <20210609230039.73307-3-leandro.ribeiro@collabora.com>
On 6/9/21 8:00 PM, Leandro Ribeiro wrote:
> 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 | 36 ++++++++++++++++++++++++++++++++++++
> 1 file changed, 36 insertions(+)
>
> diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
> index a5e76aa06ad5..67bcd8e1931c 100644
> --- a/include/uapi/drm/drm_mode.h
> +++ b/include/uapi/drm/drm_mode.h
> @@ -312,16 +312,52 @@ 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).
> + *
> + * Between one ioctl and the other, the number of formats may change.
> + * Userspace should retry the last ioctl until this number stabilizes. The
> + * kernel won't fill any array which doesn't have the expected length.
> + */
Actually I don't know if this last paragraph applies. For connectors,
for instance, I can see this happening because of hot-plugging. But for
plane formats I have no idea. As in libdrm we have this algorithm, I've
decided to describe it here.
> 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: Number of entries of the legacy gamma lookup 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
>
>
next prev parent reply other threads:[~2021-06-09 23:05 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-09 23:00 [PATCH v4 0/2] Document drm_mode_get_plane Leandro Ribeiro
2021-06-09 23:00 ` [PATCH v4 1/2] drm/doc: document how userspace should find out CRTC index Leandro Ribeiro
2021-06-10 8:27 ` Pekka Paalanen
2021-06-10 17:17 ` Daniel Vetter
2021-06-09 23:00 ` [PATCH v4 2/2] drm/doc: document drm_mode_get_plane Leandro Ribeiro
2021-06-09 23:05 ` Leandro Ribeiro [this message]
2021-06-10 8:36 ` Pekka Paalanen
2021-06-10 12:53 ` Ville Syrjälä
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b26a33dd-39ac-48b4-7c9d-512d13ea9acd@collabora.com \
--to=leandro.ribeiro@collabora.com \
--cc=airlied@linux.ie \
--cc=dri-devel@lists.freedesktop.org \
--cc=kernel@collabora.com \
--cc=pekka.paalanen@collabora.co.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).