diff mbox series

[v8,4/9] media: Documentation: tx-rx: Move transmitter control out of CSI-2 part

Message ID 20241217215445.901459-5-sakari.ailus@linux.intel.com (mailing list archive)
State New
Headers show
Series Use V4L2 mbus config for conveying link frequency | expand

Commit Message

Sakari Ailus Dec. 17, 2024, 9:54 p.m. UTC
The subsection on stopping the transmitter belongs to the generic part and
is not specific to CSI-2. Move it out of the CSI-2 section.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 Documentation/driver-api/media/tx-rx.rst | 19 +++++++++----------
 1 file changed, 9 insertions(+), 10 deletions(-)

Comments

Tomi Valkeinen Dec. 20, 2024, 1:21 p.m. UTC | #1
On 17/12/2024 23:54, Sakari Ailus wrote:
> The subsection on stopping the transmitter belongs to the generic part and
> is not specific to CSI-2. Move it out of the CSI-2 section.
> 
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> ---
>   Documentation/driver-api/media/tx-rx.rst | 19 +++++++++----------
>   1 file changed, 9 insertions(+), 10 deletions(-)
> 
> diff --git a/Documentation/driver-api/media/tx-rx.rst b/Documentation/driver-api/media/tx-rx.rst
> index 6f9eba189a9f..03768e5aa88f 100644
> --- a/Documentation/driver-api/media/tx-rx.rst
> +++ b/Documentation/driver-api/media/tx-rx.rst
> @@ -62,6 +62,15 @@ to control the transmitter driver's streaming state. These callbacks may not be
>   called directly, but by using ``v4l2_subdev_enable_streams()`` and
>   ``v4l2_subdev_disable_streams()``.
>   
> +Stopping the transmitter
> +^^^^^^^^^^^^^^^^^^^^^^^^
> +
> +A transmitter stops sending the stream of images as a result of
> +calling the ``.disable_streams()`` callback. Some transmitters may stop the
> +stream at a frame boundary whereas others stop immediately,
> +effectively leaving the current frame unfinished. The receiver driver
> +should not make assumptions either way, but function properly in both
> +cases.
>   
>   CSI-2 transmitter drivers
>   -------------------------
> @@ -130,13 +139,3 @@ device, so this should be only done when it is needed.
>   
>   Receiver drivers that do not need explicit LP-11 or LP-111 state setup are
>   waived from calling the two callbacks.
> -
> -Stopping the transmitter
> -^^^^^^^^^^^^^^^^^^^^^^^^
> -
> -A transmitter stops sending the stream of images as a result of
> -calling the ``.disable_streams()`` callback. Some transmitters may stop the
> -stream at a frame boundary whereas others stop immediately,
> -effectively leaving the current frame unfinished. The receiver driver
> -should not make assumptions either way, but function properly in both
> -cases.

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 6f9eba189a9f..03768e5aa88f 100644
--- a/Documentation/driver-api/media/tx-rx.rst
+++ b/Documentation/driver-api/media/tx-rx.rst
@@ -62,6 +62,15 @@  to control the transmitter driver's streaming state. These callbacks may not be
 called directly, but by using ``v4l2_subdev_enable_streams()`` and
 ``v4l2_subdev_disable_streams()``.
 
+Stopping the transmitter
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+A transmitter stops sending the stream of images as a result of
+calling the ``.disable_streams()`` callback. Some transmitters may stop the
+stream at a frame boundary whereas others stop immediately,
+effectively leaving the current frame unfinished. The receiver driver
+should not make assumptions either way, but function properly in both
+cases.
 
 CSI-2 transmitter drivers
 -------------------------
@@ -130,13 +139,3 @@  device, so this should be only done when it is needed.
 
 Receiver drivers that do not need explicit LP-11 or LP-111 state setup are
 waived from calling the two callbacks.
-
-Stopping the transmitter
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-A transmitter stops sending the stream of images as a result of
-calling the ``.disable_streams()`` callback. Some transmitters may stop the
-stream at a frame boundary whereas others stop immediately,
-effectively leaving the current frame unfinished. The receiver driver
-should not make assumptions either way, but function properly in both
-cases.