diff mbox series

[2/2] Documentation: v4l: Document that link_validate op is valid for sink only

Message ID 20201202181955.18165-3-sakari.ailus@linux.intel.com (mailing list archive)
State New, archived
Headers show
Series Subdev link validation and format documentation improvements | expand

Commit Message

Sakari Ailus Dec. 2, 2020, 6:19 p.m. UTC
The link_validate pad op will only be called on sink pads. Document this.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

Comments

Sebastian Fricke Dec. 3, 2020, 5 a.m. UTC | #1
Thank you.

On 02.12.2020 20:19, Sakari Ailus wrote:
>The link_validate pad op will only be called on sink pads. Document this.
>
>Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
>---
> Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----
> 1 file changed, 6 insertions(+), 5 deletions(-)
>
>diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
>index d4cba0d6c4ca..6d5c799c49fe 100644
>--- a/Documentation/driver-api/media/v4l2-subdev.rst
>+++ b/Documentation/driver-api/media/v4l2-subdev.rst
>@@ -122,11 +122,12 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
>
> 	media_entity_cleanup(&sd->entity);
>
>-In that case, the subdev driver may set the link_validate field to provide
>-its own link validation function. The link validation function is called for
>-every link in the pipeline where both of the ends of the links are V4L2
>-sub-devices. The driver is still responsible for validating the correctness
>-of the format configuration between sub-devices and video nodes.
>+If a sub-device driver implements sink pads, the subdev driver may set the
>+link_validate field in :c:type:`v4l2_subdev_pad_ops`to provide its own link
>+validation function. For every link in the pipeline, the link_validate pad
>+operation of the sink end of the link is called. In both cases the driver is

s/In both cases the driver/In both cases, the driver/

>+still responsible for validating the correctness of the format configuration
>+between sub-devices and video nodes.
>
> If link_validate op is not set, the default function
> :c:func:`v4l2_subdev_link_validate_default` is used instead. This function
>-- 
>2.27.0
>
Krasteva, Martina Dec. 3, 2020, 8:49 a.m. UTC | #2
Thank you, Sakari.
This will remove any confusion regarding this matter.

> 
> Thank you.
> 
> On 02.12.2020 20:19, Sakari Ailus wrote:
> >The link_validate pad op will only be called on sink pads. Document this.
> >
> >Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> >---
> > Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----
> > 1 file changed, 6 insertions(+), 5 deletions(-)
> >
> >diff --git a/Documentation/driver-api/media/v4l2-subdev.rst
> >b/Documentation/driver-api/media/v4l2-subdev.rst
> >index d4cba0d6c4ca..6d5c799c49fe 100644
> >--- a/Documentation/driver-api/media/v4l2-subdev.rst
> >+++ b/Documentation/driver-api/media/v4l2-subdev.rst
> >@@ -122,11 +122,12 @@ Don't forget to cleanup the media entity before the
> sub-device is destroyed:
> >
> > 	media_entity_cleanup(&sd->entity);
> >
> >-In that case, the subdev driver may set the link_validate field to
> >provide -its own link validation function. The link validation function
> >is called for -every link in the pipeline where both of the ends of the
> >links are V4L2 -sub-devices. The driver is still responsible for
> >validating the correctness -of the format configuration between sub-devices
> and video nodes.
> >+If a sub-device driver implements sink pads, the subdev driver may set
> >+the link_validate field in :c:type:`v4l2_subdev_pad_ops`to provide its
> >+own link validation function. For every link in the pipeline, the
> >+link_validate pad operation of the sink end of the link is called. In
> >+both cases the driver is
> 
> s/In both cases the driver/In both cases, the driver/
> 
> >+still responsible for validating the correctness of the format
> >+configuration between sub-devices and video nodes.
> >
> > If link_validate op is not set, the default function
> >:c:func:`v4l2_subdev_link_validate_default` is used instead. This
> >function
> >--
> >2.27.0
> >

Best Regards,
Martina
Sakari Ailus Dec. 4, 2020, 12:20 p.m. UTC | #3
Hi Sebastian,

On Thu, Dec 03, 2020 at 06:00:40AM +0100, Sebastian Fricke wrote:
> Thank you.
> 
> On 02.12.2020 20:19, Sakari Ailus wrote:
> > The link_validate pad op will only be called on sink pads. Document this.
> > 
> > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > ---
> > Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----
> > 1 file changed, 6 insertions(+), 5 deletions(-)
> > 
> > diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
> > index d4cba0d6c4ca..6d5c799c49fe 100644
> > --- a/Documentation/driver-api/media/v4l2-subdev.rst
> > +++ b/Documentation/driver-api/media/v4l2-subdev.rst
> > @@ -122,11 +122,12 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
> > 
> > 	media_entity_cleanup(&sd->entity);
> > 
> > -In that case, the subdev driver may set the link_validate field to provide
> > -its own link validation function. The link validation function is called for
> > -every link in the pipeline where both of the ends of the links are V4L2
> > -sub-devices. The driver is still responsible for validating the correctness
> > -of the format configuration between sub-devices and video nodes.
> > +If a sub-device driver implements sink pads, the subdev driver may set the
> > +link_validate field in :c:type:`v4l2_subdev_pad_ops`to provide its own link
> > +validation function. For every link in the pipeline, the link_validate pad
> > +operation of the sink end of the link is called. In both cases the driver is
> 
> s/In both cases the driver/In both cases, the driver/

Is there any particular reason for this change? I think it's fine as it
was. :-)

> 
> > +still responsible for validating the correctness of the format configuration
> > +between sub-devices and video nodes.
> > 
> > If link_validate op is not set, the default function
> > :c:func:`v4l2_subdev_link_validate_default` is used instead. This function
Sebastian Fricke Dec. 4, 2020, 3:06 p.m. UTC | #4
On 04.12.2020 14:20, Sakari Ailus wrote:
>Hi Sebastian,
>
>On Thu, Dec 03, 2020 at 06:00:40AM +0100, Sebastian Fricke wrote:
>> Thank you.
>>
>> On 02.12.2020 20:19, Sakari Ailus wrote:
>> > The link_validate pad op will only be called on sink pads. Document this.
>> >
>> > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
>> > ---
>> > Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----
>> > 1 file changed, 6 insertions(+), 5 deletions(-)
>> >
>> > diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
>> > index d4cba0d6c4ca..6d5c799c49fe 100644
>> > --- a/Documentation/driver-api/media/v4l2-subdev.rst
>> > +++ b/Documentation/driver-api/media/v4l2-subdev.rst
>> > @@ -122,11 +122,12 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
>> >
>> > 	media_entity_cleanup(&sd->entity);
>> >
>> > -In that case, the subdev driver may set the link_validate field to provide
>> > -its own link validation function. The link validation function is called for
>> > -every link in the pipeline where both of the ends of the links are V4L2
>> > -sub-devices. The driver is still responsible for validating the correctness
>> > -of the format configuration between sub-devices and video nodes.
>> > +If a sub-device driver implements sink pads, the subdev driver may set the
>> > +link_validate field in :c:type:`v4l2_subdev_pad_ops`to provide its own link
>> > +validation function. For every link in the pipeline, the link_validate pad
>> > +operation of the sink end of the link is called. In both cases the driver is
>>
>> s/In both cases the driver/In both cases, the driver/
>
>Is there any particular reason for this change? I think it's fine as it
>was. :-)

I was just proof reading the change and thought that a comma would fit
here quite well. It really isn't anything important, so if you
don't agree, that is totally fine for me.

>
>>
>> > +still responsible for validating the correctness of the format configuration
>> > +between sub-devices and video nodes.
>> >
>> > If link_validate op is not set, the default function
>> > :c:func:`v4l2_subdev_link_validate_default` is used instead. This function
>
>-- 
>Regards,
>
>Sakari Ailus
Sakari Ailus Dec. 7, 2020, 8:39 p.m. UTC | #5
On Fri, Dec 04, 2020 at 04:06:48PM +0100, Sebastian Fricke wrote:
> On 04.12.2020 14:20, Sakari Ailus wrote:
> > Hi Sebastian,
> > 
> > On Thu, Dec 03, 2020 at 06:00:40AM +0100, Sebastian Fricke wrote:
> > > Thank you.
> > > 
> > > On 02.12.2020 20:19, Sakari Ailus wrote:
> > > > The link_validate pad op will only be called on sink pads. Document this.
> > > >
> > > > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > > > ---
> > > > Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----
> > > > 1 file changed, 6 insertions(+), 5 deletions(-)
> > > >
> > > > diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
> > > > index d4cba0d6c4ca..6d5c799c49fe 100644
> > > > --- a/Documentation/driver-api/media/v4l2-subdev.rst
> > > > +++ b/Documentation/driver-api/media/v4l2-subdev.rst
> > > > @@ -122,11 +122,12 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
> > > >
> > > > 	media_entity_cleanup(&sd->entity);
> > > >
> > > > -In that case, the subdev driver may set the link_validate field to provide
> > > > -its own link validation function. The link validation function is called for
> > > > -every link in the pipeline where both of the ends of the links are V4L2
> > > > -sub-devices. The driver is still responsible for validating the correctness
> > > > -of the format configuration between sub-devices and video nodes.
> > > > +If a sub-device driver implements sink pads, the subdev driver may set the
> > > > +link_validate field in :c:type:`v4l2_subdev_pad_ops`to provide its own link
> > > > +validation function. For every link in the pipeline, the link_validate pad
> > > > +operation of the sink end of the link is called. In both cases the driver is
> > > 
> > > s/In both cases the driver/In both cases, the driver/
> > 
> > Is there any particular reason for this change? I think it's fine as it
> > was. :-)
> 
> I was just proof reading the change and thought that a comma would fit
> here quite well. It really isn't anything important, so if you
> don't agree, that is totally fine for me.

Ack. Thanks, Sebastian.
diff mbox series

Patch

diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
index d4cba0d6c4ca..6d5c799c49fe 100644
--- a/Documentation/driver-api/media/v4l2-subdev.rst
+++ b/Documentation/driver-api/media/v4l2-subdev.rst
@@ -122,11 +122,12 @@  Don't forget to cleanup the media entity before the sub-device is destroyed:
 
 	media_entity_cleanup(&sd->entity);
 
-In that case, the subdev driver may set the link_validate field to provide
-its own link validation function. The link validation function is called for
-every link in the pipeline where both of the ends of the links are V4L2
-sub-devices. The driver is still responsible for validating the correctness
-of the format configuration between sub-devices and video nodes.
+If a sub-device driver implements sink pads, the subdev driver may set the
+link_validate field in :c:type:`v4l2_subdev_pad_ops`to provide its own link
+validation function. For every link in the pipeline, the link_validate pad
+operation of the sink end of the link is called. In both cases the driver is
+still responsible for validating the correctness of the format configuration
+between sub-devices and video nodes.
 
 If link_validate op is not set, the default function
 :c:func:`v4l2_subdev_link_validate_default` is used instead. This function