Skip to contentSkip to conversation

Subdev link validation and format documentation improvements

PATCH In review Sakari Ailus 4 participants 9 messages Dec 2, 2020 – Dec 7, 2020 Media (V4L/DVB)

lore
Share & tools
lore
#0 lore raw

cover Subdev link validation and format documentation improvements

Hello,

I wrote these small patches to improve the documentation regarding requirements for subdev drivers to implement format related ops as well as the link_validate op.

Sakari Ailus (2):
Documentation: v4l: Remove reference to video ops
Documentation: v4l: Document that link_validate op is valid for sink
only

 Documentation/driver-api/media/v4l2-subdev.rst | 15 ++++++---------
 1 file changed, 6 insertions(+), 9 deletions(-)
Signature · 1 line
2.27.0
#1 lore raw

PATCH 1/2 Documentation: v4l: Remove reference to video ops

We no longer have format related callbacks in video ops. Remove the reference to them.

---
 Documentation/driver-api/media/v4l2-subdev.rst | 4 ----
 1 file changed, 4 deletions(-)
Documentation/driver-api/media/v4l2-subdev.rst +0 -4
index bb5b1a7cdfd9..d4cba0d6c4ca 100644
@@ -122,10 +122,6 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
 
 	media_entity_cleanup(&sd->entity);
 
-If the subdev driver intends to process video and integrate with the media
-framework, it must implement format related functionality using
-:c:type:`v4l2_subdev_pad_ops` instead of :c:type:`v4l2_subdev_video_ops`.
-
 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
Signature · 1 line
2.27.0
#2 lore raw

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

In reply to Sakari Ailus

The link_validate pad op will only be called on sink pads. Document this.

---
 Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
Documentation/driver-api/media/v4l2-subdev.rst +6 -5
index d4cba0d6c4ca..6d5c799c49fe 100644
@@ -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
Signature · 1 line
2.27.0
#3 lore raw

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

Thank you.

Quoted 14 lines · Sakari Ailus

The link_validate pad op will only be called on sink pads. Document this.

---
Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----

1 file changed, 6 insertions(+), 5 deletions(-)
Documentation/driver-api/media/v4l2-subdev.rst +0 -0
index d4cba0d6c4ca..6d5c799c49fe 100644
@@ -122,11 +122,12 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
 
 	media_entity_cleanup(&sd->entity);

Documentation/driver-api/media/v4l2-subdev.rst Don't forget to cleanup the media entity before the sub-device is destroyed: · line 128

Quoted 10 lines
Documentation/driver-api/media/v4l2-subdev.rst +4 -5
 
-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/

Quoted 8 lines
Documentation/driver-api/media/v4l2-subdev.rst +2 -0
+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

Signature · 1 line
2.27.0
#4 lore raw

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

Thank you, Sakari.
This will remove any confusion regarding this matter.

Quoted 38 lines

Thank you.

Documentation/driver-api/media/v4l2-subdev.rst Don't forget to cleanup the media entity before the

Quoted 13 lines · Sakari Ailus

The link_validate pad op will only be called on sink pads. Document this.

---
Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----

1 file changed, 6 insertions(+), 5 deletions(-)
Documentation/driver-api/media/v4l2-subdev.rst +0 -0
index d4cba0d6c4ca..6d5c799c49fe 100644
@@ -122,11 +122,12 @@ Don't forget to cleanup the media entity before the

sub-device is destroyed:

Quoted 8 lines
Documentation/driver-api/media/v4l2-subdev.rst +0 -1
 	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.

Documentation/driver-api/media/v4l2-subdev.rst

Quoted 5 lines
Documentation/driver-api/media/v4l2-subdev.rst +5 -0
+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/

Quoted 3 lines
Documentation/driver-api/media/v4l2-subdev.rst +2 -0
+still responsible for validating the correctness of the format
+configuration between sub-devices and video nodes.
Quoted 6 lines
Quoted 6 lines

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

#5 lore raw

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

In reply to Sebastian Fricke

Hi Sebastian,

Quoted 18 lines · Sebastian Fricke

Thank you.

Quoted 15 lines · Sakari Ailus

The link_validate pad op will only be called on sink pads. Document this.

---
Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----

1 file changed, 6 insertions(+), 5 deletions(-)
Documentation/driver-api/media/v4l2-subdev.rst +0 -0
index d4cba0d6c4ca..6d5c799c49fe 100644
@@ -122,11 +122,12 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
 
 	media_entity_cleanup(&sd->entity);
 
Quoted 11 lines

Documentation/driver-api/media/v4l2-subdev.rst Don't forget to cleanup the media entity before the sub-device is destroyed: · line 128

Quoted 9 lines
Documentation/driver-api/media/v4l2-subdev.rst +4 -5
-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. :-)

Quoted 6 lines
Quoted 6 lines
Documentation/driver-api/media/v4l2-subdev.rst +2 -0
+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

Signature · 3 lines
Regards,

Sakari Ailus
#6 lore raw

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

Quoted 33 lines · Sakari Ailus

Hi Sebastian,

Quoted 18 lines · Sebastian Fricke

Thank you.

Quoted 15 lines · Sakari Ailus

The link_validate pad op will only be called on sink pads. Document this.

---
Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----

1 file changed, 6 insertions(+), 5 deletions(-)
Documentation/driver-api/media/v4l2-subdev.rst +0 -0
index d4cba0d6c4ca..6d5c799c49fe 100644
@@ -122,11 +122,12 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
 
 	media_entity_cleanup(&sd->entity);
 
Quoted 11 lines

Documentation/driver-api/media/v4l2-subdev.rst Don't forget to cleanup the media entity before the sub-device is destroyed: · line 128

Quoted 9 lines
Documentation/driver-api/media/v4l2-subdev.rst +4 -5
-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/

Quoted 2 lines

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.

Quoted 12 lines
Quoted 7 lines
Quoted 7 lines
Documentation/driver-api/media/v4l2-subdev.rst +2 -0
+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

Signature · 3 lines
Regards,

Sakari Ailus
#7 lore raw

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

Quoted 34 lines · Sebastian Fricke
Quoted 33 lines · Sakari Ailus

Hi Sebastian,

Quoted 29 lines · Sebastian Fricke

Thank you.

Quoted 14 lines · Sakari Ailus

The link_validate pad op will only be called on sink pads. Document this.

---
Documentation/driver-api/media/v4l2-subdev.rst | 11 ++++++-----

1 file changed, 6 insertions(+), 5 deletions(-)
Documentation/driver-api/media/v4l2-subdev.rst +0 -0
index d4cba0d6c4ca..6d5c799c49fe 100644
@@ -122,11 +122,12 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
 
 	media_entity_cleanup(&sd->entity);

Documentation/driver-api/media/v4l2-subdev.rst Don't forget to cleanup the media entity before the sub-device is destroyed: · line 128

Quoted 10 lines
Documentation/driver-api/media/v4l2-subdev.rst +4 -5
 
-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/

Quoted 6 lines
Quoted 2 lines

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.

Signature · 1 line
Sakari Ailus
Reviewed-by on the v1 series
#8 lore raw
In reply to Sakari Ailus

Hi Sakari,
much apreciated

Quoted 10 lines · Sakari Ailus

Hello,

I wrote these small patches to improve the documentation regarding requirements for subdev drivers to implement format related ops as well as the link_validate op.

Sakari Ailus (2):
Documentation: v4l: Remove reference to video ops
Documentation: v4l: Document that link_validate op is valid for sink
only

For the series

Thanks
j

Quoted 7 lines
 Documentation/driver-api/media/v4l2-subdev.rst | 15 ++++++---------
 1 file changed, 6 insertions(+), 9 deletions(-)

--
2.27.0