Re: [PATCH 02/11] Documentation: media: description of DMABUF importing in V4L2

Le jeudi 5 avril 2012 16:59:59 Tomasz Stanislawski, vous avez écrit :

This patch adds description and usage examples for importing DMABUF file descriptor in V4L2.

Signed-off-by: Tomasz Stanislawski t.stanislaws@samsung.com Signed-off-by: Kyungmin Park kyungmin.park@samsung.com

---

Documentation/DocBook/media/v4l/compat.xml | 4 + Documentation/DocBook/media/v4l/io.xml | 177 ++++++++++++++++++++ .../DocBook/media/v4l/vidioc-create-bufs.xml | 1 + Documentation/DocBook/media/v4l/vidioc-qbuf.xml | 15 ++ Documentation/DocBook/media/v4l/vidioc-reqbufs.xml | 8 +- 5 files changed, 203 insertions(+), 2 deletions(-)

diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml index bce97c5..2a2083d 100644 --- a/Documentation/DocBook/media/v4l/compat.xml +++ b/Documentation/DocBook/media/v4l/compat.xml @@ -2523,6 +2523,10 @@ ioctls.</para> <listitem> <para>Selection API. <xref linkend="selection-api" /></para> </listitem>

•    <listitem>
  

•  <para>Importing DMABUF file descriptors as a new IO method described
  

•  in <xref linkend="dmabuf" />.</para>
  

•    </listitem>
   </itemizedlist>
  

  </section>

diff --git a/Documentation/DocBook/media/v4l/io.xml b/Documentation/DocBook/media/v4l/io.xml index b815929..2a32363 100644 --- a/Documentation/DocBook/media/v4l/io.xml +++ b/Documentation/DocBook/media/v4l/io.xml @@ -472,6 +472,160 @@ rest should be evident.</para> </footnote></para>

</section>

• <section id="dmabuf">

• <title>Streaming I/O (DMA buffer importing)</title>

• <note>

•  <title>Experimental</title>
  

•  <para>This is an <link linkend="experimental"> experimental </link>
  

•  interface and may change in the future.</para>
  

• </note>

+<para>The DMABUF framework was introduced to provide a generic mean for sharing +buffers between multiple HW devices. Some device drivers provide an API that +may be capable to export a DMA buffer as a DMABUF file descriptor. The other +device drivers may be configured to use such a buffer. They implements an API +for importing of DMABUF. This section describes the support of DMABUF importing +in V4L2.</para>

• <para>Input and output devices support this I/O method when the

+<constant>V4L2_CAP_STREAMING</constant> flag in the +<structfield>capabilities</structfield> field of &v4l2-capability; returned by +the &VIDIOC-QUERYCAP; ioctl is set. If the particular importing buffer via +DMABUF file descriptors method is supported must be determined by calling the +&VIDIOC-REQBUFS; ioctl.</para>

• <para>This I/O method is dedicated for sharing DMA buffers between V4L

and +other APIs. Buffers (planes) are allocated by the application itself using +a client API. The buffers must be exported as DMABUF file descriptor. Only those +file descriptor are exchanged, these files and meta-information are passed in +&v4l2-buffer; (or in &v4l2-plane; in the multi-planar API case). The driver +must be switched into DMABUF I/O mode by calling the &VIDIOC-REQBUFS; with the +desired buffer type. No buffers (planes) are allocated beforehand, consequently +they are not indexed and cannot be queried like mapped buffers with the +<constant>VIDIOC_QUERYBUF</constant> ioctl.</para>

• <example>

•  <title>Initiating streaming I/O with DMABUF file descriptors</title>
  

•  <programlisting>
  

+&v4l2-requestbuffers; reqbuf;

+memset (&amp;reqbuf, 0, sizeof (reqbuf)); +reqbuf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE; +reqbuf.memory = V4L2_MEMORY_DMABUF;

+if (ioctl (fd, &VIDIOC-REQBUFS;, &amp;reqbuf) == -1) {

• if (errno == EINVAL)

• printf ("Video capturing or user pointer streaming is not 
  

supported\n");

User pointer??

• else

• perror ("VIDIOC_REQBUFS");
  

• exit (EXIT_FAILURE);

+}

•  </programlisting>
  

• </example>

• <para>Buffer (plane) file is passed on the fly with the &VIDIOC-QBUF;

+ioctl. In case of multiplanar buffers, every plane can be associated with a +different DMABUF descriptor.Although buffers are commonly cycled, applications +can pass different DMABUF descriptor at each <constant>VIDIOC_QBUF</constant> +call.</para>

• <example>

•  <title>Queueing DMABUF using single plane API</title>
  

•  <programlisting>
  

+int buffer_queue(int v4lfd, int index, int dmafd) +{

• &v4l2-buffer; buf;
• memset(&amp;buf, 0, sizeof buf);
• buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
• buf.memory = V4L2_MEMORY_DMABUF;
• buf.index = index;
• buf.m.fd = dmafd;
• if (ioctl (v4lfd, &VIDIOC-QBUF;, &amp;buf) == -1) {

• perror ("VIDIOC_QBUF");
  

• return -1;
  

• }
• return 0;

+}

•  </programlisting>
  

• </example>

• <example>

•  <title>Queueing DMABUF using multi plane API</title>
  

•  <programlisting>
  

+int buffer_queue_mp(int v4lfd, int index, int dmafd[], int n_planes) +{

• &v4l2-buffer; buf;
• &v4l2-plane; planes[VIDEO_MAX_PLANES];
• int i;
• memset(&amp;buf, 0, sizeof buf);
• buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE;
• buf.memory = V4L2_MEMORY_DMABUF;
• buf.index = index;
• buf.m.planes = planes;
• buf.length = n_planes;
• memset(&amp;planes, 0, sizeof planes);
• for (i = 0; i &lt; n_planes; ++i)

• buf.m.planes[i].m.fd = dmafd[i];
  

• if (ioctl (v4lfd, &VIDIOC-QBUF;, &amp;buf) == -1) {

• perror ("VIDIOC_QBUF");
  

• return -1;
  

• }
• return 0;

+}

•  </programlisting>
  

• </example>

• <para>Filled or displayed buffers are dequeued with the

+&VIDIOC-DQBUF; ioctl. The driver can unpin the buffer at any +time between the completion of the DMA and this ioctl. The memory is +also unpinned when &VIDIOC-STREAMOFF; is called, &VIDIOC-REQBUFS;, or +when the device is closed.</para>

• <para>For capturing applications it is customary to enqueue a

+number of empty buffers, to start capturing and enter the read loop. +Here the application waits until a filled buffer can be dequeued, and +re-enqueues the buffer when the data is no longer needed. Output +applications fill and enqueue buffers, when enough buffers are stacked +up output is started. In the write loop, when the application +runs out of free buffers it must wait until an empty buffer can be +dequeued and reused. Two methods exist to suspend execution of the +application until one or more buffers can be dequeued. By default +<constant>VIDIOC_DQBUF</constant> blocks when no buffer is in the +outgoing queue. When the <constant>O_NONBLOCK</constant> flag was +given to the &func-open; function, <constant>VIDIOC_DQBUF</constant> +returns immediately with an &EAGAIN; when no buffer is available. The +&func-select; or &func-poll; function are always available.</para>

• <para>To start and stop capturing or output applications call the

+&VIDIOC-STREAMON; and &VIDIOC-STREAMOFF; ioctl. Note +<constant>VIDIOC_STREAMOFF</constant> removes all buffers from both queues and +unlocks/unpins all buffers as a side effect. Since there is no notion of doing +anything "now" on a multitasking system, if an application needs to synchronize +with another event it should examine the &v4l2-buffer; +<structfield>timestamp</structfield> of captured buffers, or set the field +before enqueuing buffers for output.</para>

• <para>Drivers implementing user pointer I/O must support the

User pointer again??