[media] doc-rst: mention the memory type to be set for all streaming I/O
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 8 Jul 2016 18:47:00 +0000 (15:47 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 8 Jul 2016 18:47:00 +0000 (15:47 -0300)
Changeset 8c9f46095176 ("[media] DocBook: mention the memory type to
be set for all streaming I/O") updated the media DocBook to mention
the need of filling the memory types. We need to keep the ReST
doc updated to such change.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/uapi/v4l/mmap.rst
Documentation/media/uapi/v4l/userp.rst

index 2171b18c1aab404b0fa2a48f4e02c83ee9410700..f7fe26e7ca43e12f6d8f3179615cc50717143f40 100644 (file)
@@ -11,8 +11,8 @@ Input and output devices support this I/O method when the
 :ref:`v4l2_capability <v4l2-capability>` returned by the
 :ref:`VIDIOC_QUERYCAP` ioctl is set. There are two
 streaming methods, to determine if the memory mapping flavor is
-supported applications must call the
-:ref:`VIDIOC_REQBUFS` ioctl.
+supported applications must call the :ref:`VIDIOC_REQBUFS` ioctl
+with the memory type set to ``V4L2_MEMORY_MMAP``.
 
 Streaming is an I/O method where only pointers to buffers are exchanged
 between application and driver, the data itself is not copied. Memory
index 0ecf7a13a7af10ac824cd085608d65ffaba51ee0..2f0002bfbc3fc5cbb3abdda6ea5c84eda802d55c 100644 (file)
@@ -11,8 +11,8 @@ Input and output devices support this I/O method when the
 :ref:`v4l2_capability <v4l2-capability>` returned by the
 :ref:`VIDIOC_QUERYCAP` ioctl is set. If the
 particular user pointer method (not only memory mapping) is supported
-must be determined by calling the
-:ref:`VIDIOC_REQBUFS` ioctl.
+must be determined by calling the :ref:`VIDIOC_REQBUFS` ioctl
+with the memory type set to ``V4L2_MEMORY_USERPTR``.
 
 This I/O method combines advantages of the read/write and memory mapping
 methods. Buffers (planes) are allocated by the application itself, and