]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
media: Documentation: Improve LINK_FREQ documentation
authorSakari Ailus <sakari.ailus@linux.intel.com>
Fri, 6 Feb 2026 09:38:18 +0000 (11:38 +0200)
committerSakari Ailus <sakari.ailus@linux.intel.com>
Thu, 7 May 2026 10:23:47 +0000 (13:23 +0300)
Add a reference to the LINK_FREQ control and clarify the meaning of the
control as for C-PHY the matter is less obvious.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Mirela Rabulea <mirela.rabulea@nxp.com>
Reviewed-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Documentation/driver-api/media/tx-rx.rst
Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst

index 22e1b13ecde9a1e3e0da8b6bd3e57164220f7ed4..7df2407817b35199997fd145b42d5a2096ac8f3c 100644 (file)
@@ -93,7 +93,8 @@ where
    * - variable or constant
      - description
    * - link_freq
-     - The value of the ``V4L2_CID_LINK_FREQ`` integer64 menu item.
+     - The value of the :ref:`V4L2_CID_LINK_FREQ <v4l2-cid-link-freq>` integer64
+       menu item.
    * - nr_of_lanes
      - Number of data lanes used on the CSI-2 link.
    * - 2
index 6d516f041ca2548d9a8141c94e1a448de08e9921..57c2baf34acf0366d85a1640d88311fe7c57443e 100644 (file)
@@ -24,7 +24,10 @@ Image Process Control IDs
 .. _v4l2-cid-link-freq:
 
 ``V4L2_CID_LINK_FREQ (integer menu)``
-    The frequency of the data bus (e.g. parallel or CSI-2).
+    The fundamental frequency of the operating symbol rate (serial interfaces
+    such as CSI-2) or the sampling rate (parallel interfaces such as DVP or
+    Bt.565) of the data interface. For CSI-2, the frequency is equal to
+    _1 / (2 * UI)_.
 
 .. _v4l2-cid-pixel-rate: