kernel.git/Documentation/userspace-api/media/v4l/buffer.rst, branch linux-rolling-lts

Documentation: media: move Memory Consistency Flags

2024-08-09T05:56:38Z

The documentation of the Memory Consistency Flags was part of the struct v4l2_buffer documentation, but that struct doesn't use those flags. Instead it is used by VIDIOC_CREATE_BUFS and VIDIOC_REQBUFS. Move the documentation from buffer.rst to vidioc-reqbufs.rst which is where it belongs. Signed-off-by: Hans Verkuil

Documentation: media: buffer.rst: fix V4L2_BUF_FLAG_PREPARED

2023-10-13T09:33:22Z

The list of ioctls that set or clear this flag was garbled in the generator output. Put in the proper text. Signed-off-by: Hans Verkuil

media: Documentation: Drop deprecated bytesused == 0

2022-11-04T15:56:46Z

The V4L2 API historically allowed buffers to be queued with bytesused set to 0 on output devices, in which case the driver would use the buffer length. This behaviour is deprecated, and videobuf2 prints a warning message in the kernel log. Drop it from the documentation. Signed-off-by: Laurent Pinchart Reviewed-by: Hans Verkuil Reviewed-by: Sakari Ailus Signed-off-by: Hans Verkuil

media: videobuf2: add V4L2_MEMORY_FLAG_NON_COHERENT flag

2021-09-30T08:07:57Z

By setting or clearing the V4L2_MEMORY_FLAG_NON_COHERENT flag user-space should be able to hint vb2 that either non-coherent (if supported) or coherent memory should be used for the buffer allocation. Signed-off-by: Sergey Senozhatsky Signed-off-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab

media: buffer.rst: fix incorrect :c:type

2021-03-22T12:05:20Z

:c:type:`struct v4l2_requestbuffers` should be struct :c:type:`v4l2_requestbuffers`. Signed-off-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab

media: docs: uAPI: fix table output in LaTeX/PDF format

2021-03-11T10:59:40Z

There are lots of tables that are not properly displayed in LaTeX/PDF. Fix the tablecolumns, add longtable where needed and LaTeX formatting macros, in order to address such issues. Signed-off-by: Mauro Carvalho Chehab

media: buffer.rst: fix a PDF output issue

2021-03-11T10:59:40Z

Sphinx/LaTeX doesn't work well with literal blocks. Due to that, V4L2_BUF_FLAG_M2M_HOLD_CAPTURE_BUF ends being writing outside the table (and even outside the page). We need to not only change the table size and font size, but also to change the message, in order to avoid this bug. So, improve the text a little bit, while ensuring that the literal will be written at the beginning of the second line. Signed-off-by: Mauro Carvalho Chehab

media: Documentation: userspace-api/media: dvb/audio: drop doubled word

2020-11-27T11:52:41Z

Drop the doubled word "Any". Signed-off-by: Randy Dunlap Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Signed-off-by: Mauro Carvalho Chehab

media: uAPI: buffer.rst: remove a left-over documentation

2020-10-15T05:49:46Z

Changeset 129134e5415d ("media: media/v4l2: remove V4L2_FLAG_MEMORY_NON_CONSISTENT flag") reverted an uAPI flag, but it kept some left-overs at the documentation. Drop them too. This should solve this warning: Documentation/userspace-api/media/v4l/buffer.rst:692: WARNING: The "flat-table" directive is empty; content required. .. flat-table:: :header-rows: 0 :stub-columns: 0 :widths: 3 1 4 Fixes: 129134e5415d ("media: media/v4l2: remove V4L2_FLAG_MEMORY_NON_CONSISTENT flag") Signed-off-by: Mauro Carvalho Chehab

media: docs: make V4L documents more compatible with Sphinx 3.1+

2020-10-15T05:49:39Z

Sphinx 3.x broke support for the cdomain.py extension, as the c domain code was rewritten. Due to that, the c tags need to be re-written, in order to use the new c domain notation. Signed-off-by: Mauro Carvalho Chehab