diff mbox series

[v2,3/3] media: Documentation: LP-11 and LP-111 are states, not modes

Message ID 20231017105630.558089-4-sakari.ailus@linux.intel.com
State Superseded
Headers show
Series Document link-frequencies better, small fixes | expand

Commit Message

Sakari Ailus Oct. 17, 2023, 10:56 a.m. UTC
LP-11 and LP-111 are CSI-2 bus states, not modes. Fix this.

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

Comments

Laurent Pinchart Oct. 17, 2023, 11:36 a.m. UTC | #1
Hi Sakari,

Thank you for the patch.

On Tue, Oct 17, 2023 at 01:56:30PM +0300, Sakari Ailus wrote:
> LP-11 and LP-111 are CSI-2 bus states, not modes. Fix this.
> 
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> ---
>  Documentation/driver-api/media/tx-rx.rst | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/driver-api/media/tx-rx.rst b/Documentation/driver-api/media/tx-rx.rst
> index 7e115e3c4735..bc1b94cffdd9 100644
> --- a/Documentation/driver-api/media/tx-rx.rst
> +++ b/Documentation/driver-api/media/tx-rx.rst
> @@ -89,13 +89,13 @@ where
>  	pixel rate on the camera sensor's pixel array which is indicated by the
>  	:ref:`V4L2_CID_PIXEL_RATE <v4l2-cid-pixel-rate>` control.
>  
> -LP-11 and LP-111 modes
> -^^^^^^^^^^^^^^^^^^^^^^
> +LP-11 and LP-111 states
> +^^^^^^^^^^^^^^^^^^^^^^^

Indeed.

>  
> -As part of transitioning to high speed mode, a CSI-2 transmitter typically
> +As part of transitioning to high speed state, a CSI-2 transmitter typically

"high speed" is a mode according to the D-PHY specification.

>  briefly sets the bus to LP-11 or LP-111 state, depending on the PHY. This period
>  may be as short as 100 µs, during which the receiver observes this state and
> -proceeds its own part of high speed mode transition.
> +proceeds its own part of high speed state transition.

Same here.

>  
>  Most receivers are capable of autonomously handling this once the software has
>  configured them to do so, but there are receivers which require software
> @@ -104,7 +104,7 @@ in software, especially when there is no interrupt telling something is
>  happening.
>  
>  One way to address this is to configure the transmitter side explicitly to LP-11
> -or LP-111 mode, which requires support from the transmitter hardware. This is
> +or LP-111 state, which requires support from the transmitter hardware. This is

Ack.

With the two changes referring to high speed state dropped,

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

>  not universally available. Many devices return to this state once streaming is
>  stopped while the state after power-on is LP-00 or LP-000.
>  
> @@ -115,11 +115,11 @@ transitioning to streaming state, but not yet start streaming. Similarly, the
>  to call ``.post_streamoff()`` for each successful call of ``.pre_streamon()``.
>  
>  In the context of CSI-2, the ``.pre_streamon()`` callback is used to transition
> -the transmitter to the LP-11 or LP-111 mode. This also requires powering on the
> +the transmitter to the LP-11 or LP-111 state. This also requires powering on the
>  device, so this should be only done when it is needed.
>  
> -Receiver drivers that do not need explicit LP-11 or LP-111 mode setup are waived
> -from calling the two callbacks.
> +Receiver drivers that do not need explicit LP-11 or LP-111 state setup are
> +waived from calling the two callbacks.
>  
>  Stopping the transmitter
>  ^^^^^^^^^^^^^^^^^^^^^^^^
diff mbox series

Patch

diff --git a/Documentation/driver-api/media/tx-rx.rst b/Documentation/driver-api/media/tx-rx.rst
index 7e115e3c4735..bc1b94cffdd9 100644
--- a/Documentation/driver-api/media/tx-rx.rst
+++ b/Documentation/driver-api/media/tx-rx.rst
@@ -89,13 +89,13 @@  where
 	pixel rate on the camera sensor's pixel array which is indicated by the
 	:ref:`V4L2_CID_PIXEL_RATE <v4l2-cid-pixel-rate>` control.
 
-LP-11 and LP-111 modes
-^^^^^^^^^^^^^^^^^^^^^^
+LP-11 and LP-111 states
+^^^^^^^^^^^^^^^^^^^^^^^
 
-As part of transitioning to high speed mode, a CSI-2 transmitter typically
+As part of transitioning to high speed state, a CSI-2 transmitter typically
 briefly sets the bus to LP-11 or LP-111 state, depending on the PHY. This period
 may be as short as 100 µs, during which the receiver observes this state and
-proceeds its own part of high speed mode transition.
+proceeds its own part of high speed state transition.
 
 Most receivers are capable of autonomously handling this once the software has
 configured them to do so, but there are receivers which require software
@@ -104,7 +104,7 @@  in software, especially when there is no interrupt telling something is
 happening.
 
 One way to address this is to configure the transmitter side explicitly to LP-11
-or LP-111 mode, which requires support from the transmitter hardware. This is
+or LP-111 state, which requires support from the transmitter hardware. This is
 not universally available. Many devices return to this state once streaming is
 stopped while the state after power-on is LP-00 or LP-000.
 
@@ -115,11 +115,11 @@  transitioning to streaming state, but not yet start streaming. Similarly, the
 to call ``.post_streamoff()`` for each successful call of ``.pre_streamon()``.
 
 In the context of CSI-2, the ``.pre_streamon()`` callback is used to transition
-the transmitter to the LP-11 or LP-111 mode. This also requires powering on the
+the transmitter to the LP-11 or LP-111 state. This also requires powering on the
 device, so this should be only done when it is needed.
 
-Receiver drivers that do not need explicit LP-11 or LP-111 mode setup are waived
-from calling the two callbacks.
+Receiver drivers that do not need explicit LP-11 or LP-111 state setup are
+waived from calling the two callbacks.
 
 Stopping the transmitter
 ^^^^^^^^^^^^^^^^^^^^^^^^