Commit e1ad2702 authored by Ricardo Ribalda's avatar Ricardo Ribalda Committed by Hans Verkuil
Browse files

media: Documentation: Add note about UVCH length field 



The documentation currently describes the UVC length field as the "length
of the rest of the block", which can be misleading. The driver limits the
data copied to a maximum of 12 bytes.

This change adds a clarifying sentence to the documentation to make this
restriction explicit.

Reviewed-by: default avatarHans de Goede <hansg@kernel.org>
Signed-off-by: default avatarRicardo Ribalda <ribalda@chromium.org>
Link: https://lore.kernel.org/r/20250707-uvc-meta-v8-2-ed17f8b1218b@chromium.org


Signed-off-by: default avatarHans de Goede <hansg@kernel.org>
Signed-off-by: default avatarHans Verkuil <hverkuil@xs4all.nl>
parent bda2859b

Documentation/userspace-api/media/v4l/metafmt-uvc.rst

+3 −1
Original line number Diff line number Diff line
@@ -44,7 +44,9 @@ Each individual block contains the following fields: 
        them

    * - :cspan:`1` *The rest is an exact copy of the UVC payload header:*

    * - __u8 length;

      - length of the rest of the block, including this field

      - length of the rest of the block, including this field. Please note that

        regardless of this value, for V4L2_META_FMT_UVC the kernel will never

        copy more than 2-12 bytes.

    * - __u8 flags;

      - Flags, indicating presence of other standard UVC fields

    * - __u8 buf[];