]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
media: Documentation: Receiver drivers should call v4l2_get_link_freq()
authorSakari Ailus <sakari.ailus@linux.intel.com>
Mon, 16 Dec 2024 08:26:22 +0000 (10:26 +0200)
committerHans Verkuil <hverkuil@xs4all.nl>
Sat, 15 Feb 2025 14:22:54 +0000 (15:22 +0100)
Document that receiver drivers should call v4l2_get_link_freq() to obtain
the link frequency.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
Signed-off-by: Hans Verkuil <hverkuil@xs4all.nl>
Documentation/driver-api/media/tx-rx.rst

index 03768e5aa88f1d6003b061d6bd78c65f93e6c0f8..0b8c9cde8ee46a09a26f441b9db1317b5a715861 100644 (file)
@@ -53,6 +53,9 @@ Drivers that do not have user-configurable link frequency should report it
 through the ``.get_mbus_config()`` subdev pad operation, in the ``link_freq``
 field of struct v4l2_mbus_config, instead of through controls.
 
+Receiver drivers should use :c:func:`v4l2_get_link_freq` helper to obtain the
+link frequency from the transmitter sub-device.
+
 ``.enable_streams()`` and ``.disable_streams()`` callbacks
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^