media: Documentation: Update {enable,disable}_streams documentation
authorSakari Ailus <sakari.ailus@linux.intel.com>
Tue, 17 Sep 2024 12:31:47 +0000 (15:31 +0300)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Wed, 16 Oct 2024 07:32:40 +0000 (09:32 +0200)
Document the expected {enable,disable}_streams callback behaviour for
drivers that are stream-unaware i.e. don't specify the
V4L2_SUBDEV_CAP_STREAMS sub-device capability flag. In this specific case,
the mask argument can be ignored.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
include/media/v4l2-subdev.h

index 3cc6b4a5935f88b3b3500ec47922c72ad6733227..ff63fb6046b13f81296104a7b506b55a6f84441c 100644 (file)
@@ -834,11 +834,19 @@ struct v4l2_subdev_state {
  *     v4l2_subdev_init_finalize() at initialization time). Do not call
  *     directly, use v4l2_subdev_enable_streams() instead.
  *
+ *     Drivers that support only a single stream without setting the
+ *     V4L2_SUBDEV_CAP_STREAMS sub-device capability flag can ignore the mask
+ *     argument.
+ *
  * @disable_streams: Disable the streams defined in streams_mask on the given
  *     source pad. Subdevs that implement this operation must use the active
  *     state management provided by the subdev core (enabled through a call to
  *     v4l2_subdev_init_finalize() at initialization time). Do not call
  *     directly, use v4l2_subdev_disable_streams() instead.
+ *
+ *     Drivers that support only a single stream without setting the
+ *     V4L2_SUBDEV_CAP_STREAMS sub-device capability flag can ignore the mask
+ *     argument.
  */
 struct v4l2_subdev_pad_ops {
        int (*enum_mbus_code)(struct v4l2_subdev *sd,