[PATCHv2] Documentation: media: add missing V4L2_BUF_CAP_ flags

Message ID 47829e6f-4749-4259-abd3-6cb5b5713006@xs4all.nl (mailing list archive)
State Accepted
Delegated to: Hans Verkuil
Headers
Series [PATCHv2] Documentation: media: add missing V4L2_BUF_CAP_ flags |

Commit Message

Hans Verkuil July 16, 2024, 12:28 p.m. UTC
  The documentation for V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS and
V4L2_BUF_CAP_SUPPORTS_REMOVE_BUFS was missing. Add this.

Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
---
Changes since v1:
- Report what the maximum is if V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS is not set
---
 Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst | 7 +++++++
 1 file changed, 7 insertions(+)
  

Comments

Sebastian Fricke July 16, 2024, 12:35 p.m. UTC | #1
Hey Hans,

On 16.07.2024 14:28, Hans Verkuil wrote:
>The documentation for V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS and
>V4L2_BUF_CAP_SUPPORTS_REMOVE_BUFS was missing. Add this.
>
>Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>

LGTM :)

Reviewed-by: Sebastian Fricke <sebastian.fricke@collabora.com>

Regards,
Sebastian

>---
>Changes since v1:
>- Report what the maximum is if V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS is not set
>---
> Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst | 7 +++++++
> 1 file changed, 7 insertions(+)
>
>diff --git a/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst b/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
>index bbc22dd76032..1df3ce1fe93e 100644
>--- a/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
>+++ b/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
>@@ -166,6 +166,13 @@ aborting or finishing any DMA in progress, an implicit
>         :ref:`V4L2_BUF_FLAG_NO_CACHE_INVALIDATE <V4L2-BUF-FLAG-NO-CACHE-INVALIDATE>`,
>         :ref:`V4L2_BUF_FLAG_NO_CACHE_CLEAN <V4L2-BUF-FLAG-NO-CACHE-CLEAN>` and
>         :ref:`V4L2_MEMORY_FLAG_NON_COHERENT <V4L2-MEMORY-FLAG-NON-COHERENT>`.
>+    * - ``V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS``
>+      - 0x00000080
>+      - If set, then the ``max_num_buffers`` field in ``struct v4l2_create_buffers``
>+        is valid. If not set, then the maximum is ``VIDEO_MAX_FRAME`` buffers.
>+    * - ``V4L2_BUF_CAP_SUPPORTS_REMOVE_BUFS``
>+      - 0x00000100
>+      - If set, then ``VIDIOC_REMOVE_BUFS`` is supported.
>
> .. raw:: latex
>
>-- 
>2.43.0
>
  
Benjamin Gaignard July 17, 2024, 7:46 a.m. UTC | #2
Le 16/07/2024 à 14:28, Hans Verkuil a écrit :
> The documentation for V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS and
> V4L2_BUF_CAP_SUPPORTS_REMOVE_BUFS was missing. Add this.

Reviewed-by: Benjamin Gaignard <benjamin.gaignard@collabora.com>

Thanks for the patch.
Regards,
Benjamin

>
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
> ---
> Changes since v1:
> - Report what the maximum is if V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS is not set
> ---
>   Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst | 7 +++++++
>   1 file changed, 7 insertions(+)
>
> diff --git a/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst b/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
> index bbc22dd76032..1df3ce1fe93e 100644
> --- a/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
> +++ b/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
> @@ -166,6 +166,13 @@ aborting or finishing any DMA in progress, an implicit
>           :ref:`V4L2_BUF_FLAG_NO_CACHE_INVALIDATE <V4L2-BUF-FLAG-NO-CACHE-INVALIDATE>`,
>           :ref:`V4L2_BUF_FLAG_NO_CACHE_CLEAN <V4L2-BUF-FLAG-NO-CACHE-CLEAN>` and
>           :ref:`V4L2_MEMORY_FLAG_NON_COHERENT <V4L2-MEMORY-FLAG-NON-COHERENT>`.
> +    * - ``V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS``
> +      - 0x00000080
> +      - If set, then the ``max_num_buffers`` field in ``struct v4l2_create_buffers``
> +        is valid. If not set, then the maximum is ``VIDEO_MAX_FRAME`` buffers.
> +    * - ``V4L2_BUF_CAP_SUPPORTS_REMOVE_BUFS``
> +      - 0x00000100
> +      - If set, then ``VIDIOC_REMOVE_BUFS`` is supported.
>
>   .. raw:: latex
>
  

Patch

diff --git a/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst b/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
index bbc22dd76032..1df3ce1fe93e 100644
--- a/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
+++ b/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
@@ -166,6 +166,13 @@  aborting or finishing any DMA in progress, an implicit
         :ref:`V4L2_BUF_FLAG_NO_CACHE_INVALIDATE <V4L2-BUF-FLAG-NO-CACHE-INVALIDATE>`,
         :ref:`V4L2_BUF_FLAG_NO_CACHE_CLEAN <V4L2-BUF-FLAG-NO-CACHE-CLEAN>` and
         :ref:`V4L2_MEMORY_FLAG_NON_COHERENT <V4L2-MEMORY-FLAG-NON-COHERENT>`.
+    * - ``V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS``
+      - 0x00000080
+      - If set, then the ``max_num_buffers`` field in ``struct v4l2_create_buffers``
+        is valid. If not set, then the maximum is ``VIDEO_MAX_FRAME`` buffers.
+    * - ``V4L2_BUF_CAP_SUPPORTS_REMOVE_BUFS``
+      - 0x00000100
+      - If set, then ``VIDIOC_REMOVE_BUFS`` is supported.

 .. raw:: latex