[1/1] Documentation: media: camera-sensor: The unit of hblank is pixels

Message ID 20210201093914.12994-1-sakari.ailus@linux.intel.com (mailing list archive)
State Obsoleted, archived
Delegated to: Sakari Ailus
Headers
Series [1/1] Documentation: media: camera-sensor: The unit of hblank is pixels |

Commit Message

Sakari Ailus Feb. 1, 2021, 9:39 a.m. UTC
  The unit of the horizontal blanking control on raw sensors is pixels, not
lines. Document this correctly.

Fixes: e4cf8c58af75 ("media: Documentation: media: Document how to write camera sensor drivers")
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 Documentation/driver-api/media/camera-sensor.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
  

Patch

diff --git a/Documentation/driver-api/media/camera-sensor.rst b/Documentation/driver-api/media/camera-sensor.rst
index 3fc378b3b269..9c863e3a79ba 100644
--- a/Documentation/driver-api/media/camera-sensor.rst
+++ b/Documentation/driver-api/media/camera-sensor.rst
@@ -94,9 +94,10 @@  large variety of devices beyond camera sensors. Devices that have no analogue
 crop, use the full source image size, i.e. pixel array size.
 
 Horizontal and vertical blanking are specified by ``V4L2_CID_HBLANK`` and
-``V4L2_CID_VBLANK``, respectively. The unit of these controls are lines. The
-pixel rate is specified by ``V4L2_CID_PIXEL_RATE`` in the same sub-device. The
-unit of that control is Hz.
+``V4L2_CID_VBLANK``, respectively. The unit of the ``V4L2_CID_HBLANK`` control
+is pixels and the unit of the ``V4L2_CID_VBLANK`` is lines. The pixel rate is
+specified by ``V4L2_CID_PIXEL_RATE`` in the same sub-device. The unit of that
+control is Hz.
 
 Register list based drivers need to implement read-only sub-device nodes for the
 purpose. Devices that are not register list based need these to configure the