Commit 2092f0de authored by Chen-Yu Tsai's avatar Chen-Yu Tsai Committed by Mauro Carvalho Chehab
Browse files

media: docs: vidioc-dqbuf: State all remaining fields are filled by driver 



The specification for VIDIOC_DQBUF is slightly ambiguous on what fields
of |struct v4l2_buffer| is filled by the driver.

Reword it so things are clear: the driver fills in all remaining fields
not specified to be filled in by userspace applications.

Signed-off-by: default avatarChen-Yu Tsai <wenst@chromium.org>
Signed-off-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@kernel.org>
parent 57c1d5de

Documentation/userspace-api/media/v4l/vidioc-qbuf.rst

+1 −1
Original line number Diff line number Diff line
@@ -125,7 +125,7 @@ Applications call the ``VIDIOC_DQBUF`` ioctl to dequeue a filled 
queue. They just set the ``type``, ``memory`` and ``reserved`` fields of

a struct :c:type:`v4l2_buffer` as above, when

``VIDIOC_DQBUF`` is called with a pointer to this structure the driver

fills the remaining fields or returns an error code. The driver may also

fills all remaining fields or returns an error code. The driver may also

set ``V4L2_BUF_FLAG_ERROR`` in the ``flags`` field. It indicates a

non-critical (recoverable) streaming error. In such case the application

may continue as normal, but should be aware that data in the dequeued