[PATCH 6/8] drm/doc: introduce new section for standard plane properties

[Daniel Vetter]

On Wed, Dec 16, 2020 at 09:22:20PM +0100, Simon Ser wrote:
> Introduce a new "Standard Plane Properties" section for properties
> defined in drm_plane.c. Move the mis-placed IN_FORMATS docs there.

Yeah that's misplaced.

Reviewed-by: Daniel Vetter <daniel.vetter at ffwll.ch>

> 
> Signed-off-by: Simon Ser <contact at emersion.fr>
> Cc: Daniel Vetter <daniel at ffwll.ch>
> Cc: Pekka Paalanen <ppaalanen at gmail.com>
> ---
>  Documentation/gpu/drm-kms.rst |  6 ++++++
>  drivers/gpu/drm/drm_blend.c   |  6 ------
>  drivers/gpu/drm/drm_plane.c   | 12 ++++++++++++
>  3 files changed, 18 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
> index fcd4e15379b0..9cfaab4df21a 100644
> --- a/Documentation/gpu/drm-kms.rst
> +++ b/Documentation/gpu/drm-kms.rst
> @@ -493,6 +493,12 @@ Standard CRTC Properties
>  .. kernel-doc:: drivers/gpu/drm/drm_crtc.c
>     :doc: standard CRTC properties
>  
> +Standard Plane Properties
> +-------------------------
> +
> +.. kernel-doc:: drivers/gpu/drm/drm_plane.c
> +   :doc: standard plane properties
> +
>  Plane Composition Properties
>  ----------------------------
>  
> diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
> index 5c2141e9a9f4..26e2f2ffd255 100644
> --- a/drivers/gpu/drm/drm_blend.c
> +++ b/drivers/gpu/drm/drm_blend.c
> @@ -185,12 +185,6 @@
>   *		 plane does not expose the "alpha" property, then this is
>   *		 assumed to be 1.0
>   *
> - * IN_FORMATS:
> - *	Blob property which contains the set of buffer format and modifier
> - *	pairs supported by this plane. The blob is a drm_format_modifier_blob
> - *	struct. Without this property the plane doesn't support buffers with
> - *	modifiers. Userspace cannot change this property.
> - *
>   * Note that all the property extensions described here apply either to the
>   * plane or the CRTC (e.g. for the background color, which currently is not
>   * exposed and assumed to be black).
> diff --git a/drivers/gpu/drm/drm_plane.c b/drivers/gpu/drm/drm_plane.c
> index 49b0a8b9ac02..4c1a45ac18e6 100644
> --- a/drivers/gpu/drm/drm_plane.c
> +++ b/drivers/gpu/drm/drm_plane.c
> @@ -61,6 +61,18 @@
>   * userspace too much.
>   */
>  
> +/**
> + * DOC: standard plane properties
> + *
> + * DRM planes have a few standardized properties:
> + *
> + * IN_FORMATS:
> + *     Blob property which contains the set of buffer format and modifier
> + *     pairs supported by this plane. The blob is a drm_format_modifier_blob
> + *     struct. Without this property the plane doesn't support buffers with
> + *     modifiers. Userspace cannot change this property.
> + */
> +
>  static unsigned int drm_num_planes(struct drm_device *dev)
>  {
>  	unsigned int num = 0;
> -- 
> 2.29.2
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch