[PATCH] drm: connector: Clarify drm_connecter.ddc field documentation

Laurent Pinchart laurent.pinchart at ideasonboard.com
Sun Aug 4 12:26:53 UTC 2019

Improve the documentation of the ddc field by using DDC and I2C
consistently, and explaining more clearly what the field points to.

Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
 include/drm/drm_connector.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
index fc5d08438333..0d01662aa40e 100644
--- a/include/drm/drm_connector.h
+++ b/include/drm/drm_connector.h
@@ -1315,10 +1315,10 @@ struct drm_connector {
 	 * @ddc: associated ddc adapter.
-	 * A connector usually has its associated ddc adapter. If a driver uses
-	 * this field, then an appropriate symbolic link is created in connector
-	 * sysfs directory to make it easy for the user to tell which i2c
-	 * adapter is for a particular display.
+	 * When the connector carries DDC signals, this field points to the I2C
+	 * adapter connected to the DDC signals, if any. When this field is not
+	 * NULL a symbolic link is created in the connector's sysfs directory
+	 * to expose the I2C adapter used by the connector.
 	 * The field should be set by calling drm_connector_init_with_ddc().

Laurent Pinchart

More information about the dri-devel mailing list