[PATCH 2/2] drm/connector: Document the TV props

[Boris Brezillon <boris.brezillon@collabora.com>]

Document TV connector props and get rid of the according entries in
the csv file.

Signed-off-by: Boris Brezillon <boris.brezillon@collabora.com>
---
 Documentation/gpu/drm-kms.rst        |  6 +++
 Documentation/gpu/kms-properties.csv | 13 -------
 drivers/gpu/drm/drm_connector.c      | 56 ++++++++++++++++++++++++++++
 3 files changed, 62 insertions(+), 13 deletions(-)

diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
index 23a3c986ef6d..376f88e56d14 100644
--- a/Documentation/gpu/drm-kms.rst
+++ b/Documentation/gpu/drm-kms.rst
@@ -449,6 +449,12 @@ HDMI Specific Connector Properties
 .. kernel-doc:: drivers/gpu/drm/drm_connector.c
    :doc: HDMI connector properties
 
+TV Connector Properties
+-----------------------
+
+.. kernel-doc:: drivers/gpu/drm/drm_connector.c
+   :doc: TV connector properties
+
 Plane Composition Properties
 ----------------------------
 
diff --git a/Documentation/gpu/kms-properties.csv b/Documentation/gpu/kms-properties.csv
index 07ed22ea3bd6..1a8277f3028d 100644
--- a/Documentation/gpu/kms-properties.csv
+++ b/Documentation/gpu/kms-properties.csv
@@ -1,19 +1,6 @@
 Owner Module/Drivers,Group,Property Name,Type,Property Values,Object attached,Description/Restrictions
 ,DVI-I,“subconnector”,ENUM,"{ “Unknown”, “DVI-D”, “DVI-A” }",Connector,TBD
 ,,“select subconnector”,ENUM,"{ “Automatic”, “DVI-D”, “DVI-A” }",Connector,TBD
-,TV,“subconnector”,ENUM,"{ ""Unknown"", ""Composite"", ""SVIDEO"", ""Component"", ""SCART"" }",Connector,TBD
-,,“select subconnector”,ENUM,"{ ""Automatic"", ""Composite"", ""SVIDEO"", ""Component"", ""SCART"" }",Connector,TBD
-,,“mode”,ENUM,"{ ""NTSC_M"", ""NTSC_J"", ""NTSC_443"", ""PAL_B"" } etc.",Connector,TBD
-,,“left margin”,RANGE,"Min=0, Max=100",Connector,TBD
-,,“right margin”,RANGE,"Min=0, Max=100",Connector,TBD
-,,“top margin”,RANGE,"Min=0, Max=100",Connector,TBD
-,,“bottom margin”,RANGE,"Min=0, Max=100",Connector,TBD
-,,“brightness”,RANGE,"Min=0, Max=100",Connector,TBD
-,,“contrast”,RANGE,"Min=0, Max=100",Connector,TBD
-,,“flicker reduction”,RANGE,"Min=0, Max=100",Connector,TBD
-,,“overscan”,RANGE,"Min=0, Max=100",Connector,TBD
-,,“saturation”,RANGE,"Min=0, Max=100",Connector,TBD
-,,“hue”,RANGE,"Min=0, Max=100",Connector,TBD
 ,Virtual GPU,“suggested X”,RANGE,"Min=0, Max=0xffffffff",Connector,property to suggest an X offset for a connector
 ,,“suggested Y”,RANGE,"Min=0, Max=0xffffffff",Connector,property to suggest an Y offset for a connector
 ,Optional,"""aspect ratio""",ENUM,"{ ""None"", ""4:3"", ""16:9"" }",Connector,TDB
diff --git a/drivers/gpu/drm/drm_connector.c b/drivers/gpu/drm/drm_connector.c
index 95dfb322b14e..bb581994b48e 100644
--- a/drivers/gpu/drm/drm_connector.c
+++ b/drivers/gpu/drm/drm_connector.c
@@ -1249,6 +1249,62 @@ int drm_mode_create_tv_margin_properties(struct drm_device *dev)
 }
 EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
 
+/**
+ * DOC: TV connector properties
+ *
+ * subconnector:
+ *	Subconnector can be Composite, SVIDEO, Component or SCART. For legacy
+ *	reasons we have two properties, one to select the subconnector and one
+ *	showing the currently selected subconnector.
+ *
+ *	select subconnector:
+ *		Select a subconnector type. There's an 'Automatic' value to let
+ *		DRM select the subconnector automatically
+ *
+ * 	subconnector:
+ * 		Shows the currently selected subconnector
+ *
+ * margins:
+ *	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.
+ *
+ *	left margin:
+ *		Left margin
+ *
+ *	right margin:
+ *		Left margin
+ *
+ *	top margin:
+ *		Top margin
+ *
+ *	bottom margin:
+ *		Bottom margin
+ *
+ * mode:
+ *	Exposes all supported TV modes and allows one to select a mode. The
+ *	list of supported modes is driver dependent, but you should basically
+ *	find one or more variants of the PAL and NTSC standards.
+ *
+ * brightness:
+ *	Brigthness settings expressed in percent
+ *
+ * contrast:
+ *	Contrast settings expressed in percent
+ *
+ * flicker reduction:
+ *	Flicker reduction settings expressed in percent
+ *
+ * overscan:
+ *	Overscan settings
+ *
+ * saturation:
+ *	Saturation settings expressed in percent
+ *
+ * hue:
+ *	Hue settings expressed in percent
+ */
+
 /**
  * drm_mode_create_tv_properties - create TV specific connector properties
  * @dev: DRM device
-- 
2.20.1

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel