Parallel and BT.656 documentation fixes
Subsystems (2)
Sakari Ailus
maintainerv3 cover Parallel and BT.656 documentation fixes
Hi folks,
Here are a few small documentation improvements.
since v2:
- Better separate parallel and BT.656 buses in documentation.
- Drop the link-frequencies patch from this set.
- Don't call "high speed" mode a state.
since v1:
- Fix reference.
Sakari Ailus (2):
media: Documentation: BT.601 is not a bus
media: Documentation: LP-11 and LP-111 are states, not modes
.../driver-api/media/camera-sensor.rst | 4 ++-- Documentation/driver-api/media/tx-rx.rst | 21 ++++++++++--------- 2 files changed, 13 insertions(+), 12 deletions(-)
Signature · 1 line
2.39.2
Sakari Ailus
maintainerPATCH v3 1/2 media: Documentation: BT.601 is not a bus
BT.601 is not actually a bus specification, leaving parallel bus without a specification to refer to. Fix this.
Signed-off-by Sakari Ailus <[email protected]>
--- Documentation/driver-api/media/camera-sensor.rst | 4 ++-- Documentation/driver-api/media/tx-rx.rst | 9 +++++---- 2 files changed, 7 insertions(+), 6 deletions(-)
Documentation/driver-api/media/camera-sensor.rst +2 -2
@@ -9,8 +9,8 @@ This document covers the in-kernel APIs only. For the best practices on userspace API implementation in camera sensor drivers, please see :ref:`media_using_camera_sensor_drivers`. -CSI-2 and parallel (BT.601 and BT.656) busses ---------------------------------------------- +CSI-2, parallel and BT.656 buses +-------------------------------- Please see :ref:`transmitter-receiver`.
Documentation/driver-api/media/tx-rx.rst +5 -4
@@ -22,12 +22,13 @@ the host SoC. It is defined by the `MIPI alliance`_. .. _`MIPI alliance`: https://www.mipi.org/ -Parallel -^^^^^^^^ +Parallel and BT.656 +^^^^^^^^^^^^^^^^^^^ -`BT.601`_ and `BT.656`_ are the most common parallel busses. +Besides CSI-2, the `parallel`_ and `BT.656`_ buses are the two other bus types +used commonly by camera sensors. Many camera sensors support both bus types. -.. _`BT.601`: https://en.wikipedia.org/wiki/Rec._601 +.. _`parallel`: https://en.wikipedia.org/wiki/Parallel_communication .. _`BT.656`: https://en.wikipedia.org/wiki/ITU-R_BT.656 Transmitter drivers
Signature · 1 line
2.39.2
Sakari Ailus
maintainerPATCH v3 2/2 media: Documentation: LP-11 and LP-111 are states, not modes
In reply to Sakari AilusLP-11 and LP-111 are CSI-2 bus states, not modes. Fix this.
Signed-off-by Sakari Ailus <[email protected]>
Reviewed-by Laurent Pinchart <[email protected]>
--- Documentation/driver-api/media/tx-rx.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
Documentation/driver-api/media/tx-rx.rst +6 -6
@@ -91,8 +91,8 @@ 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 briefly sets the bus to LP-11 or LP-111 state, depending on the PHY. This period
@@ -106,7 +106,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.
@@ -117,11 +117,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 ^^^^^^^^^^^^^^^^^^^^^^^^
Signature · 1 line
2.39.2