diff mbox series

[v8,5/9] media: Documentation: Receiver drivers should call v4l2_get_link_freq()

Message ID 20241217215445.901459-6-sakari.ailus@linux.intel.com
State New
Headers show
Series [v8,1/9] media: v4l: Support passing media pad argument to v4l2_get_link_freq() | expand

Commit Message

Sakari Ailus Dec. 17, 2024, 9:54 p.m. UTC
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>
---
 Documentation/driver-api/media/tx-rx.rst | 3 +++
 1 file changed, 3 insertions(+)

Comments

Tomi Valkeinen Dec. 20, 2024, 1:22 p.m. UTC | #1
On 17/12/2024 23:54, Sakari Ailus wrote:
> 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>
> ---
>   Documentation/driver-api/media/tx-rx.rst | 3 +++
>   1 file changed, 3 insertions(+)
> 
> diff --git a/Documentation/driver-api/media/tx-rx.rst b/Documentation/driver-api/media/tx-rx.rst
> index 03768e5aa88f..0b8c9cde8ee4 100644
> --- a/Documentation/driver-api/media/tx-rx.rst
> +++ b/Documentation/driver-api/media/tx-rx.rst
> @@ -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
>   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>   

Reviewed-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>

  Tomi
diff mbox series

Patch

diff --git a/Documentation/driver-api/media/tx-rx.rst b/Documentation/driver-api/media/tx-rx.rst
index 03768e5aa88f..0b8c9cde8ee4 100644
--- a/Documentation/driver-api/media/tx-rx.rst
+++ b/Documentation/driver-api/media/tx-rx.rst
@@ -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
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^