diff mbox series

[v6,38/38] media: Documentation: v4l: Document sub-device notifiers

Message ID 20230727054255.1183255-39-sakari.ailus@linux.intel.com (mailing list archive)
State New, archived
Headers show
Series Separate links and async sub-devices | expand

Commit Message

Sakari Ailus July 27, 2023, 5:42 a.m. UTC
Document that sub-device notifiers are now registered using
v4l2_async_subdev_nf_init(). No documentation is changed as it seems that
sub-device notifiers were not documented apart from kernel-doc comments.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Tested-by: Philipp Zabel <p.zabel@pengutronix.de> # imx6qp
Tested-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> # rcar + adv746x
Tested-by: Aishwarya Kothari <aishwarya.kothari@toradex.com> # Apalis i.MX6Q with TC358743
Tested-by: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com> # Renesas RZ/G2L SMARC
---
 Documentation/driver-api/media/v4l2-subdev.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Mauro Carvalho Chehab July 28, 2023, 9:02 a.m. UTC | #1
Em Thu, 27 Jul 2023 08:42:55 +0300
Sakari Ailus <sakari.ailus@linux.intel.com> escreveu:

> Document that sub-device notifiers are now registered using
> v4l2_async_subdev_nf_init(). No documentation is changed as it seems that
> sub-device notifiers were not documented apart from kernel-doc comments.
> 
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> Tested-by: Philipp Zabel <p.zabel@pengutronix.de> # imx6qp
> Tested-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> # rcar + adv746x
> Tested-by: Aishwarya Kothari <aishwarya.kothari@toradex.com> # Apalis i.MX6Q with TC358743
> Tested-by: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com> # Renesas RZ/G2L SMARC
> ---
>  Documentation/driver-api/media/v4l2-subdev.rst | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
> index eba5e4468282..e56b50b3f203 100644
> --- a/Documentation/driver-api/media/v4l2-subdev.rst
> +++ b/Documentation/driver-api/media/v4l2-subdev.rst
> @@ -218,6 +218,17 @@ available. There may be one or more async connections to a given sub-device but
>  this is not known at the time of adding the connections to the notifier. Async
>  connections are bound as matching async sub-devices are found, one by one.
>  
> +Asynchronous sub-device notifier for sub-devices
> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +
> +A driver that registers an asynchronous sub-device may also register an
> +asynchronous notifier. This is called an asynchronous sub-device notifier andthe
> +process is similar to that of a bridge driver apart from that the notifier is
> +initialised using :c:func:`v4l2_async_subdev_nf_init` instead. A sub-device
> +notifier may complete only after the V4L2 device becomes available, i.e. there's
> +a path via async sub-devices and notifiers to a notifier that is not an
> +asynchronous sub-device notifier.
> +
>  Asynchronous sub-device registration helper for camera sensor drivers
>  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 

Hmm... you did a lot of reorder at the code for async devices. IMO,
you should be pointing at the documentation what's the expected order
of kAPI usage: what comes first? V4L2 register? async notifiers? etc.

Regards

Thanks,
Mauro
diff mbox series

Patch

diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
index eba5e4468282..e56b50b3f203 100644
--- a/Documentation/driver-api/media/v4l2-subdev.rst
+++ b/Documentation/driver-api/media/v4l2-subdev.rst
@@ -218,6 +218,17 @@  available. There may be one or more async connections to a given sub-device but
 this is not known at the time of adding the connections to the notifier. Async
 connections are bound as matching async sub-devices are found, one by one.
 
+Asynchronous sub-device notifier for sub-devices
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A driver that registers an asynchronous sub-device may also register an
+asynchronous notifier. This is called an asynchronous sub-device notifier andthe
+process is similar to that of a bridge driver apart from that the notifier is
+initialised using :c:func:`v4l2_async_subdev_nf_init` instead. A sub-device
+notifier may complete only after the V4L2 device becomes available, i.e. there's
+a path via async sub-devices and notifiers to a notifier that is not an
+asynchronous sub-device notifier.
+
 Asynchronous sub-device registration helper for camera sensor drivers
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^