[PATCH] drm: document TV margin properties

[Dave Stevenson]

On Mon, 27 Feb 2023 at 12:21, Simon Ser <contact at emersion.fr> wrote:
>
> Add docs for "{left,right,top,bottom} margin" properties.
>
> Signed-off-by: Simon Ser <contact at emersion.fr>
> Cc: Maxime Ripard <maxime at cerno.tech>
> Cc: Daniel Vetter <daniel at ffwll.ch>
> Cc: Pekka Paalanen <ppaalanen at gmail.com>
> Cc: Noralf Trønnes <noralf at tronnes.org>
> Cc: Mateusz Kwiatkowski <kfyatek+publicgit at gmail.com>

This certainly matches my understanding of the properties. Thanks.

Reviewed-by: Dave Stevenson <dave.stevenson at raspberrypi.com>

> ---
>  drivers/gpu/drm/drm_connector.c | 14 ++++++++++----
>  1 file changed, 10 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/gpu/drm/drm_connector.c b/drivers/gpu/drm/drm_connector.c
> index 9d0250c28e9b..65a586680940 100644
> --- a/drivers/gpu/drm/drm_connector.c
> +++ b/drivers/gpu/drm/drm_connector.c
> @@ -1590,10 +1590,6 @@ EXPORT_SYMBOL(drm_connector_attach_dp_subconnector_property);
>
>  /*
>   * TODO: Document the properties:
> - *   - left margin
> - *   - right margin
> - *   - top margin
> - *   - bottom margin
>   *   - brightness
>   *   - contrast
>   *   - flicker reduction
> @@ -1651,6 +1647,16 @@ EXPORT_SYMBOL(drm_connector_attach_dp_subconnector_property);
>   *
>   *     Drivers can set up this property by calling
>   *     drm_mode_create_tv_properties().
> + *
> + * left margin, right margin, top margin, bottom margin:
> + *     Add margins to the connector's viewport.
> + *
> + *     The value is the size in pixels of the black border which will be
> + *     added. The attached CRTC's content will be scaled to fill the whole
> + *     area inside the margin.
> + *
> + *     Drivers can set up these properties by calling
> + *     drm_mode_create_tv_margin_properties().
>   */
>
>  /**
> --
> 2.39.2
>
>