[PATCH 1/2] drm/connector: Document the optional margin props in the HDMI section

[Daniel Vetter]

On Wed, Mar 27, 2019 at 10:59:15AM +0100, Boris Brezillon wrote:
> HDMI connectors can optionally be attached margin props. Let's
> document them.
> 
> Signed-off-by: Boris Brezillon <boris.brezillon at collabora.com>
> ---
>  drivers/gpu/drm/drm_connector.c | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/drivers/gpu/drm/drm_connector.c b/drivers/gpu/drm/drm_connector.c
> index 2355124849db..95dfb322b14e 100644
> --- a/drivers/gpu/drm/drm_connector.c
> +++ b/drivers/gpu/drm/drm_connector.c
> @@ -1116,6 +1116,23 @@ EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
>   *	Drivers can set up this property by calling
>   *	drm_connector_attach_content_type_property(). Decoding to
>   *	infoframe values is done through drm_hdmi_avi_infoframe_content_type().
> + *
> + * TV margins (optional):
> + *	Defines invisible area of a screen so that the CRTC driver can possibly
> + *	scale the output image and move it to make it entirely visible. All
> + *	margins are defined in pixels and the valid range is 0 - 100.

Maybe add the usual hints for driver writers too:

"Drivers can set this up by calling
drm_connector_attach_tv_margin_properties(), the values are stored in
&drm_connector_state.tv."

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

I'm also not entirely sure it's in pixels, but *shrug*
-Daniel


> + *
> + *	left margin:
> + *		Left margin
> + *
> + *	right margin:
> + *		Left margin
> + *
> + *	top margin:
> + *		Top margin
> + *
> + *	bottom margin:
> + *		Bottom margin
>   */
>  
>  /**
> -- 
> 2.20.1
> 

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