media: buffer.rst: only set V4L2_BUF_FLAG_REQUEST_FD for QBUF
authorHans Verkuil <hansverk@cisco.com>
Thu, 23 Aug 2018 10:45:09 +0000 (06:45 -0400)
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Tue, 11 Sep 2018 13:47:38 +0000 (09:47 -0400)
Document that V4L2_BUF_FLAG_REQUEST_FD should only be used with
VIDIOC_QBUF and cleared otherwise.

Signed-off-by: Hans Verkuil <hansverk@cisco.com>
Reviewed-by: Tomasz Figa <tfiga@chromium.org>
Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Documentation/media/uapi/v4l/buffer.rst

index 35c2fad..1865cd5 100644 (file)
@@ -312,6 +312,8 @@ struct v4l2_buffer
         and flag ``V4L2_BUF_FLAG_REQUEST_FD`` is set, then the buffer will be
        queued to that request. This is set by the user when calling
        :ref:`ioctl VIDIOC_QBUF <VIDIOC_QBUF>` and ignored by other ioctls.
+       Applications should not set ``V4L2_BUF_FLAG_REQUEST_FD`` for any ioctls
+       other than :ref:`VIDIOC_QBUF <VIDIOC_QBUF>`.
        If the device does not support requests, then ``EPERM`` will be returned.
        If requests are supported but an invalid request file descriptor is
        given, then ``EINVAL`` will be returned.