* [PATCH] drm: connector: Clarify drm_connecter.ddc field documentation
@ 2019-08-04 12:26 Laurent Pinchart
2019-08-05 16:28 ` Daniel Vetter
0 siblings, 1 reply; 4+ messages in thread
From: Laurent Pinchart @ 2019-08-04 12:26 UTC (permalink / raw)
To: dri-devel; +Cc: Neil Armstrong, Andrzej Pietrasiewicz
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@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().
*/
--
Regards,
Laurent Pinchart
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] drm: connector: Clarify drm_connecter.ddc field documentation
2019-08-04 12:26 [PATCH] drm: connector: Clarify drm_connecter.ddc field documentation Laurent Pinchart
@ 2019-08-05 16:28 ` Daniel Vetter
2019-08-05 17:15 ` Laurent Pinchart
0 siblings, 1 reply; 4+ messages in thread
From: Daniel Vetter @ 2019-08-05 16:28 UTC (permalink / raw)
To: Laurent Pinchart; +Cc: Andrzej Pietrasiewicz, dri-devel, Neil Armstrong
On Sun, Aug 04, 2019 at 03:26:53PM +0300, Laurent Pinchart wrote:
> 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@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
s/DDC/a DDC/
> + * adapter connected to the DDC signals, if any. When this field is not
s/not NULL/is set/ otherwise parsing hiccup on the double negative :-)
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
> + * 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().
> */
> --
> Regards,
>
> Laurent Pinchart
>
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] drm: connector: Clarify drm_connecter.ddc field documentation
2019-08-05 16:28 ` Daniel Vetter
@ 2019-08-05 17:15 ` Laurent Pinchart
2019-08-05 18:44 ` Daniel Vetter
0 siblings, 1 reply; 4+ messages in thread
From: Laurent Pinchart @ 2019-08-05 17:15 UTC (permalink / raw)
To: Daniel Vetter; +Cc: Andrzej Pietrasiewicz, dri-devel, Neil Armstrong
Hi Daniel,
On Mon, Aug 05, 2019 at 06:28:15PM +0200, Daniel Vetter wrote:
> On Sun, Aug 04, 2019 at 03:26:53PM +0300, Laurent Pinchart wrote:
> > 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@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
>
> s/DDC/a DDC/
DDC is carried by two signals (at least for DDC2, the mostly
unimplemented DDC1 used a single signal), so "carries DDC signals" seems
appropriate to me.
> > + * adapter connected to the DDC signals, if any. When this field is not
> s/not NULL/is set/ otherwise parsing hiccup on the double negative :-)
>
> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
>
> > + * 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().
> > */
--
Regards,
Laurent Pinchart
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] drm: connector: Clarify drm_connecter.ddc field documentation
2019-08-05 17:15 ` Laurent Pinchart
@ 2019-08-05 18:44 ` Daniel Vetter
0 siblings, 0 replies; 4+ messages in thread
From: Daniel Vetter @ 2019-08-05 18:44 UTC (permalink / raw)
To: Laurent Pinchart; +Cc: Andrzej Pietrasiewicz, dri-devel, Neil Armstrong
On Mon, Aug 5, 2019 at 7:15 PM Laurent Pinchart
<laurent.pinchart@ideasonboard.com> wrote:
>
> Hi Daniel,
>
> On Mon, Aug 05, 2019 at 06:28:15PM +0200, Daniel Vetter wrote:
> > On Sun, Aug 04, 2019 at 03:26:53PM +0300, Laurent Pinchart wrote:
> > > 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@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
> >
> > s/DDC/a DDC/
>
> DDC is carried by two signals (at least for DDC2, the mostly
> unimplemented DDC1 used a single signal), so "carries DDC signals" seems
> appropriate to me.
I overlooked the plural, looks good as-is.
-Daniel
>
> > > + * adapter connected to the DDC signals, if any. When this field is not
> > s/not NULL/is set/ otherwise parsing hiccup on the double negative :-)
> >
> > Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
> >
> > > + * 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().
> > > */
>
> --
> Regards,
>
> Laurent Pinchart
--
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2019-08-05 18:45 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-08-04 12:26 [PATCH] drm: connector: Clarify drm_connecter.ddc field documentation Laurent Pinchart
2019-08-05 16:28 ` Daniel Vetter
2019-08-05 17:15 ` Laurent Pinchart
2019-08-05 18:44 ` Daniel Vetter
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.