media: v4l2-common: Update v4l2_get_link_freq() documentation

Document that v4l2_get_link_freq() obtains the link frequency primarily
by calling the get_mbus_config sub-device pad operation.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Signed-off-by: Hans Verkuil <hverkuil+cisco@kernel.org>
This commit is contained in:
Sakari Ailus 2025-08-21 14:56:49 +03:00 committed by Hans Verkuil
parent 683342ce3c
commit bdc9776dac

View file

@ -566,10 +566,12 @@ int v4l2_fill_pixfmt_mp(struct v4l2_pix_format_mplane *pixfmt, u32 pixelformat,
* @div: The divisor between pixel rate and link frequency. Number of data lanes
* times two on D-PHY, 1 on parallel. 0 otherwise.
*
* This function is intended for obtaining the link frequency from the
* transmitter sub-device's pad. It returns the link rate, either from the
* V4L2_CID_LINK_FREQ control implemented by the transmitter, or value
* calculated based on the V4L2_CID_PIXEL_RATE implemented by the transmitter.
* This function obtains and returns the link frequency from the transmitter
* sub-device's pad. The link frequency is retrieved using the get_mbus_config
* sub-device pad operation. If this fails, the function falls back to obtaining
* the frequency either directly from the V4L2_CID_LINK_FREQ control if
* implemented by the transmitter, or by calculating it from the pixel rate
* obtained from the V4L2_CID_PIXEL_RATE control.
*
* Return:
* * >0: Link frequency