diff mbox series

[v3,3/3] media: Documentation: Improve v4l2_subdev_{en,dis}able_streams documentation

Message ID 20240920073503.22536-4-sakari.ailus@linux.intel.com
State Accepted
Commit fd0e579bc62cb1766469866a89471d2d8c8b721d
Headers show
Series Update streaming related documentation | expand

Commit Message

Sakari Ailus Sept. 20, 2024, 7:35 a.m. UTC
Document that callers of v4l2_subdev_{en,dis}able_streams() need to set
the mask to BIT_ULL(0).

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 include/media/v4l2-subdev.h | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Laurent Pinchart Sept. 25, 2024, 9:47 p.m. UTC | #1
Hi Sakari,

Thank you for the patch.

On Fri, Sep 20, 2024 at 10:35:03AM +0300, Sakari Ailus wrote:
> Document that callers of v4l2_subdev_{en,dis}able_streams() need to set
> the mask to BIT_ULL(0).
> 
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>

> ---
>  include/media/v4l2-subdev.h | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
> index ff63fb6046b1..2f2200875b03 100644
> --- a/include/media/v4l2-subdev.h
> +++ b/include/media/v4l2-subdev.h
> @@ -1685,6 +1685,8 @@ int v4l2_subdev_routing_validate(struct v4l2_subdev *sd,
>   * function implements a best-effort compatibility by calling the .s_stream()
>   * operation, limited to subdevs that have a single source pad.
>   *
> + * Drivers that are not stream-aware shall set @streams_mask to BIT_ULL(0).
> + *
>   * Return:
>   * * 0: Success
>   * * -EALREADY: One of the streams in streams_mask is already enabled
> @@ -1715,6 +1717,8 @@ int v4l2_subdev_enable_streams(struct v4l2_subdev *sd, u32 pad,
>   * function implements a best-effort compatibility by calling the .s_stream()
>   * operation, limited to subdevs that have a single source pad.
>   *
> + * Drivers that are not stream-aware shall set @streams_mask to BIT_ULL(0).
> + *
>   * Return:
>   * * 0: Success
>   * * -EALREADY: One of the streams in streams_mask is not enabled
diff mbox series

Patch

diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
index ff63fb6046b1..2f2200875b03 100644
--- a/include/media/v4l2-subdev.h
+++ b/include/media/v4l2-subdev.h
@@ -1685,6 +1685,8 @@  int v4l2_subdev_routing_validate(struct v4l2_subdev *sd,
  * function implements a best-effort compatibility by calling the .s_stream()
  * operation, limited to subdevs that have a single source pad.
  *
+ * Drivers that are not stream-aware shall set @streams_mask to BIT_ULL(0).
+ *
  * Return:
  * * 0: Success
  * * -EALREADY: One of the streams in streams_mask is already enabled
@@ -1715,6 +1717,8 @@  int v4l2_subdev_enable_streams(struct v4l2_subdev *sd, u32 pad,
  * function implements a best-effort compatibility by calling the .s_stream()
  * operation, limited to subdevs that have a single source pad.
  *
+ * Drivers that are not stream-aware shall set @streams_mask to BIT_ULL(0).
+ *
  * Return:
  * * 0: Success
  * * -EALREADY: One of the streams in streams_mask is not enabled