[PATCH] drm/connector: document supported_colorspaces and DRM_MODE_COLORIMETRY_COUNT

[Randy Dunlap]

Hi,

On 9/6/23 11:19, Javier Carrasco wrote:
> The supported_colorspaces parameter was added to the following
> functions without documenting it:
> 
> drm_mode_create_dp_colorspace_property
> drm_mode_create_hdmi_colorspace_property
> 
> The missing descriptions generate warnings when compiling the
> documentation. Add the descriptions to document the
> supported_colorspaces parameter.
> 
> The drm_colorspace enum member DRM_MODE_COLORIMETRY_COUNT has been
> properly documented by moving the description out of the enum to the
> member description list to get rid of an additional warning and improve
> documentation clarity.
> 
> Signed-off-by: Javier Carrasco <javier.carrasco.cruz at gmail.com>
> ---
> The supported_colorspaces parameter was added to the following
> functions without documenting it:
> 
> drm_mode_create_dp_colorspace_property
> drm_mode_create_hdmi_colorspace_property
> 
> The missing descriptions generate warnings when compiling the
> documentation. Add the descriptions to document the
> supported_colorspaces parameter.
> 
> The drm_colorspace enum member DRM_MODE_COLORIMETRY_COUNT has been
> properly documented by moving the description out of the enum to the
> member description list to get rid of an additional warning and improve
> documentation clarity.
> ---
>  drivers/gpu/drm/drm_connector.c | 2 ++
>  include/drm/drm_connector.h     | 3 ++-
>  2 files changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/drm_connector.c b/drivers/gpu/drm/drm_connector.c
> index bf8371dc2a61..77bfe17dcf98 100644
> --- a/drivers/gpu/drm/drm_connector.c
> +++ b/drivers/gpu/drm/drm_connector.c

These (2) are already fixed in linux-next.

> @@ -2203,6 +2203,7 @@ static int drm_mode_create_colorspace_property(struct drm_connector *connector,
>  /**
>   * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
>   * @connector: connector to create the Colorspace property on.
> + * @supported_colorspaces: colorspaces supported by the driver.
>   *
>   * Called by a driver the first time it's needed, must be attached to desired
>   * HDMI connectors.
> @@ -2227,6 +2228,7 @@ EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
>  /**
>   * drm_mode_create_dp_colorspace_property - create dp colorspace property
>   * @connector: connector to create the Colorspace property on.
> + * @supported_colorspaces: colorspaces supported by the driver.
>   *
>   * Called by a driver the first time it's needed, must be attached to desired
>   * DP connectors.
> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
> index d300fde6c1a4..18cf46e3478b 100644
> --- a/include/drm/drm_connector.h
> +++ b/include/drm/drm_connector.h

This one still needs to be fixed/applied.
You can add:

Reviewed-by: Randy Dunlap <rdunlap at infradead.org>

Thanks.

> @@ -498,6 +498,8 @@ enum drm_privacy_screen_status {
>   *   ITU-R BT.601 colorimetry format
>   *   The DP spec does not say whether this is the 525 or the 625
>   *   line version.
> + * @DRM_MODE_COLORIMETRY_COUNT:
> + *   Not a valid value; merely used four counting
>   */
>  enum drm_colorspace {
>  	/* For Default case, driver will set the colorspace */
> @@ -522,7 +524,6 @@ enum drm_colorspace {
>  	DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED	= 13,
>  	DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT	= 14,
>  	DRM_MODE_COLORIMETRY_BT601_YCC		= 15,
> -	/* not a valid value; merely used for counting */
>  	DRM_MODE_COLORIMETRY_COUNT
>  };
>  
> 
> ---
> base-commit: 65d6e954e37872fd9afb5ef3fc0481bb3c2f20f4
> change-id: 20230906-topic-drm_connector_doc-42dae3ba43c6
> 
> Best regards,

-- 
~Randy