[PATCH v5 1/1] drm/doc: document drm_mode_get_plane

[Leandro Ribeiro]

On 6/11/21 4:33 AM, Daniel Vetter wrote:
> On Fri, Jun 11, 2021 at 9:20 AM Pekka Paalanen <ppaalanen at gmail.com> wrote:
>>
>> On Thu, 10 Jun 2021 17:38:24 -0300
>> Leandro Ribeiro <leandro.ribeiro at collabora.com> wrote:
>>
>>> Add a small description and document struct fields of
>>> drm_mode_get_plane.
>>>
>>> Signed-off-by: Leandro Ribeiro <leandro.ribeiro at collabora.com>
>>> ---
>>>  include/uapi/drm/drm_mode.h | 35 +++++++++++++++++++++++++++++++++++
>>>  1 file changed, 35 insertions(+)
>>>
>>> diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
>>> index 9b6722d45f36..698559d9336b 100644
>>> --- a/include/uapi/drm/drm_mode.h
>>> +++ b/include/uapi/drm/drm_mode.h
>>> @@ -312,16 +312,51 @@ 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: Number of entries of the legacy gamma lookup table.
>>> +      * Deprecated.
>>> +      */
>>>       __u32 gamma_size;
>>
>> Hi,
>>
>> I wonder, has this field ever been used?
>>
>> "The legacy gamma" refers to CRTC gamma LUT AFAIK, but this here is
>> about planes. I forgot that at first, so didn't see anything funny.
> 
> Yeah "Deprecated" isn't really conveying that this was never used or
> implemented anywehere ever. I think we should put that into the docs
> to make this clear, otherwise someone is going to wonder whether maybe
> they still need to parse it since it's only deprecated and there's no
> other plane gamma (yet). I wouldn't even put any further  docs than
> that in it, because stating that it's the number of entries for
> something we never implemented is going to be confusing at best :-)
> -Daniel
> 

Nice, thanks for elaborating.

I'll update to "@gamma_size: Never used".

>>
>> Anyway, whether the doc for this field is as is, or is changed to
>> "never used" or "unused" or "reserved" or whatever, you have my:
>>
>> Reviewed-by: Pekka Paalanen <pekka.paalanen at collabora.com>
>>
>> With the caveat that I didn't actually build the docs to see how they
>> look.
>>
>>
>> Thanks,
>> pq
>>
>>>
>>> +     /** @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
>>>
>>
> 
>