aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSakari Ailus <[email protected]>2023-06-20 13:26:53 +0200
committerMauro Carvalho Chehab <[email protected]>2023-07-28 10:38:34 +0200
commitf60eccb04a72dadb84a49aaa6f2cc23f6a2ca8bd (patch)
tree749157edecb34c58573abb08b01f2d83005b669e
parent95a188168b7af7b05e2fd5105c5c09da9a3e92ac (diff)
media: Documentation: v4l: Document v4l2_async_nf_cleanup
Document v4l2_async_nf_cleanup() which must be called before releasing an unregistered notifier's memory. Also remove the sentence regarding v4l2_async_nf_init() arguments --- those are documented in kerneldoc which is referred here. Signed-off-by: Sakari Ailus <[email protected]> Tested-by: Lad Prabhakar <[email protected]> # Renesas RZ/G2L SMARC Signed-off-by: Mauro Carvalho Chehab <[email protected]>
-rw-r--r--Documentation/driver-api/media/v4l2-subdev.rst11
1 files changed, 5 insertions, 6 deletions
diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
index e463ab4a3413..327d444f34dc 100644
--- a/Documentation/driver-api/media/v4l2-subdev.rst
+++ b/Documentation/driver-api/media/v4l2-subdev.rst
@@ -198,12 +198,11 @@ picked up by bridge drivers.
Asynchronous sub-device notifiers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Bridge drivers in turn have to register a notifier object. This is
-performed using the :c:func:`v4l2_async_nf_register` call. To
-unregister the notifier the driver has to call
-:c:func:`v4l2_async_nf_unregister`. The former of the two functions
-takes two arguments: a pointer to struct :c:type:`v4l2_device` and a
-pointer to struct :c:type:`v4l2_async_notifier`.
+Bridge drivers in turn have to register a notifier object. This is performed
+using the :c:func:`v4l2_async_nf_register` call. To unregister the notifier the
+driver has to call :c:func:`v4l2_async_nf_unregister`. Before releasing memory
+of an unregister notifier, it must be cleaned up by calling
+:c:func:`v4l2_async_nf_cleanup`.
Before registering the notifier, bridge drivers must do two things: first, the
notifier must be initialized using the :c:func:`v4l2_async_nf_init`. Second,