Document link-frequencies better, small fixes
Subsystems (2)
Sakari Ailus
maintainercover Document link-frequencies better, small fixes
Hi folks,
Here are a few small documentation improvements.
Sakari Ailus (3):
media: Documentation: Document how link frequencies can be chosen
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 | 18 ++++++++++++++++-- Documentation/driver-api/media/tx-rx.rst | 19 +++++++++---------- .../media/drivers/camera-sensor.rst | 2 ++ 3 files changed, 27 insertions(+), 12 deletions(-)
Signature · 1 line
2.39.2
Sakari Ailus
maintainerPATCH 1/3 media: Documentation: Document how link frequencies can be chosen
Document how link frequencies can be selected for the link-frequencies property.
Signed-off-by Sakari Ailus <[email protected]>
--- Documentation/driver-api/media/camera-sensor.rst | 14 ++++++++++++++ .../userspace-api/media/drivers/camera-sensor.rst | 2 ++ 2 files changed, 16 insertions(+)
Documentation/driver-api/media/camera-sensor.rst +14 -0
@@ -29,6 +29,20 @@ used in the system. Using another frequency may cause harmful effects elsewhere. Therefore only the pre-determined frequencies are configurable by the user. +On choosing link frequencies +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Choosing link frequencies for a board is generally a part of the hardware design +process as one needs to ensure an EMC-safe frequency the sensor supports with +the given external clock frequency exists. On development systems this may be +less than an immediate concern, so more or less anything that sensor and the +rest of the applicable hardware supports can be used. + +If the sensor's PLL tree is not documented and all that is available are +register lists, even knowing the frequency a driver uses may be difficult. This +could still be :ref:`calculated from the number of lanes, sensor's output image +size, blanking values and frame rate <media_camera_raw_frame_interval>`. + ACPI ~~~~
Documentation/userspace-api/media/drivers/camera-sensor.rst +2 -0
@@ -54,6 +54,8 @@ less all modern raw camera sensors. The frame interval is calculated using the following equation:: +.. _media_camera_raw_frame_interval: + frame interval = (analogue crop width + horizontal blanking) * (analogue crop height + vertical blanking) / pixel rate
Signature · 1 line
2.39.2
Sakari Ailus
maintainerPATCH 2/3 media: Documentation: BT.601 is not a bus
In reply to Sakari AilusBT.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 | 3 +-- 2 files changed, 3 insertions(+), 4 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 and parallel and BT.656 buses +----------------------------------- Please see :ref:`transmitter-receiver`.
Documentation/driver-api/media/tx-rx.rst +1 -2
@@ -25,9 +25,8 @@ the host SoC. It is defined by the `MIPI alliance`_. Parallel ^^^^^^^^ -`BT.601`_ and `BT.656`_ are the most common parallel busses. +The parallel bus and its `BT.656`_ variant are the most common parallel busses. -.. _`BT.601`: https://en.wikipedia.org/wiki/Rec._601 .. _`BT.656`: https://en.wikipedia.org/wiki/ITU-R_BT.656 Transmitter drivers
Signature · 1 line
2.39.2
Sakari Ailus
maintainerPATCH 3/3 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]>
--- Documentation/driver-api/media/tx-rx.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
Documentation/driver-api/media/tx-rx.rst +8 -8
@@ -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 ^^^^^^^^^^^^^^^^^^^^^^^^
Signature · 1 line
2.39.2