media: subdev: Improve s_stream documentation
authorTomi Valkeinen <tomi.valkeinen@ideasonboard.com>
Wed, 24 Apr 2024 15:39:14 +0000 (18:39 +0300)
committerHans Verkuil <hverkuil-cisco@xs4all.nl>
Tue, 4 Jun 2024 06:31:25 +0000 (08:31 +0200)
Now that enable/disable_streams operations are available for
single-stream subdevices too, there's no reason to use the old s_stream
operation on new drivers. Extend the documentation reflecting this.

Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
Reviewed-by: Umang Jain<umang.jain@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
include/media/v4l2-subdev.h

index 23c970d09870e9d365e283b7e2c4e0bfeb5b6eeb..df66365576dddf7acf9eca964d95c80944683f1e 100644 (file)
@@ -450,6 +450,15 @@ enum v4l2_subdev_pre_streamon_flags {
  *     already started or stopped subdev. Also see call_s_stream wrapper in
  *     v4l2-subdev.c.
  *
+ *     New drivers should instead implement &v4l2_subdev_pad_ops.enable_streams
+ *     and &v4l2_subdev_pad_ops.disable_streams operations, and use
+ *     v4l2_subdev_s_stream_helper for the &v4l2_subdev_video_ops.s_stream
+ *     operation to support legacy users.
+ *
+ *     Drivers should also not call the .s_stream() subdev operation directly,
+ *     but use the v4l2_subdev_enable_streams() and
+ *     v4l2_subdev_disable_streams() helpers.
+ *
  * @g_pixelaspect: callback to return the pixelaspect ratio.
  *
  * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev