Expand documentation of the newly introduced get_mbus_config() pad
operation.
Signed-off-by: Jacopo Mondi <jacopo+renesas@xxxxxxxxxx>
---
Providing this as separate patch to ease review/discussion.
Can be likely squashed in 1/6
---
include/media/v4l2-subdev.h | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
index 9bf14c41626d..e95f44e778a6 100644
--- a/include/media/v4l2-subdev.h
+++ b/include/media/v4l2-subdev.h
@@ -737,7 +737,17 @@ struct v4l2_subdev_pad_config {
* @set_frame_desc: set the low level media bus frame parameters, @fd array
* may be adjusted by the subdev driver to device capabilities.
*
- * @get_mbus_config: get the current mbus configuration
+ * @get_mbus_config: get the current media bus configuration. This operation is
+ * intended to be used to synchronize the media bus
+ * configuration parameters between receivers and
+ * transmitters. The static bus configuration is usually
+ * received from the firmware interface, and updated
+ * dynamically using this operation to retrieve bus
+ * configuration parameters which could change at run-time.
+ * Callers should make sure they get the most up-to-date as
+ * possible configuration from the connected sub-device,
+ * likely calling this operation as close as possible to
+ * stream on time.
*/
struct v4l2_subdev_pad_ops {
int (*init_cfg)(struct v4l2_subdev *sd,
--
2.26.0
