media: media-request: update documentation
Various clarifications and readability improvements based on Laurent Pinchart's review of the documentation. Signed-off-by: Hans Verkuil <hans.verkuil@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>
This commit is contained in:

committed by
Mauro Carvalho Chehab

parent
15cd442e79
commit
d4215edbd4
@@ -308,12 +308,18 @@ struct v4l2_buffer
|
||||
* - __u32
|
||||
- ``request_fd``
|
||||
-
|
||||
- The file descriptor of the request to queue the buffer to. If specified
|
||||
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.
|
||||
- The file descriptor of the request to queue the buffer to. If the flag
|
||||
``V4L2_BUF_FLAG_REQUEST_FD`` is set, then the buffer will be
|
||||
queued to this request. If the flag is not set, then this field will
|
||||
be ignored.
|
||||
|
||||
The ``V4L2_BUF_FLAG_REQUEST_FD`` flag and this field are only used by
|
||||
:ref:`ioctl VIDIOC_QBUF <VIDIOC_QBUF>` and ignored by other ioctls that
|
||||
take a :c:type:`v4l2_buffer` as argument.
|
||||
|
||||
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 ``EACCES`` will be returned.
|
||||
If requests are supported but an invalid request file descriptor is
|
||||
given, then ``EINVAL`` will be returned.
|
||||
|
Reference in New Issue
Block a user