Documentation/media/uapi/dvb/dmx-reqbufs.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _DMX_REQBUFS:
  11
  12 *****************
  13 ioctl DMX_REQBUFS
  14 *****************
  15
  16 Name
  17 ====
  18
  19 DMX_REQBUFS - Initiate Memory Mapping and/or DMA buffer I/O
  20
  21 .. warning:: this API is still experimental
  22
  23
  24 Synopsis
  25 ========
  26
  27 .. c:function:: int ioctl( int fd, DMX_REQBUFS, struct dmx_requestbuffers *argp )
  28     :name: DMX_REQBUFS
  29
  30
  31 Arguments
  32 =========
  33
  34 ``fd``
  35     File descriptor returned by :ref:`open() <dmx_fopen>`.
  36
  37 ``argp``
  38     Pointer to struct :c:type:`dmx_requestbuffers`.
  39
  40 Description
  41 ===========
  42
  43 This ioctl is used to initiate a memory mapped or DMABUF based demux I/O.
  44
  45 Memory mapped buffers are located in device memory and must be allocated
  46 with this ioctl before they can be mapped into the application's address
  47 space. User buffers are allocated by applications themselves, and this
  48 ioctl is merely used to switch the driver into user pointer I/O mode and
  49 to setup some internal structures. Similarly, DMABUF buffers are
  50 allocated by applications through a device driver, and this ioctl only
  51 configures the driver into DMABUF I/O mode without performing any direct
  52 allocation.
  53
  54 To allocate device buffers applications initialize all fields of the
  55 struct :c:type:`dmx_requestbuffers` structure. They set the  ``count`` field
  56 to the desired number of buffers,  and ``size`` to the size of each
  57 buffer.
  58
  59 When the ioctl is called with a pointer to this structure, the driver will
  60 attempt to allocate the requested number of buffers and it stores the actual
  61 number allocated in the ``count`` field. The ``count`` can be smaller than the number requested, even zero, when the driver runs out of free memory. A larger
  62 number is also possible when the driver requires more buffers to
  63 function correctly. The actual allocated buffer size can is returned
  64 at ``size``, and can be smaller than what's requested.
  65
  66 When this I/O method is not supported, the ioctl returns an ``EOPNOTSUPP``
  67 error code.
  68
  69 Applications can call :ref:`DMX_REQBUFS` again to change the number of
  70 buffers, however this cannot succeed when any buffers are still mapped.
  71 A ``count`` value of zero frees all buffers, after aborting or finishing
  72 any DMA in progress.
  73
  74
  75 Return Value
  76 ============
  77
  78 On success 0 is returned, on error -1 and the ``errno`` variable is set
  79 appropriately. The generic error codes are described at the
  80 :ref:`Generic Error Codes <gen-errors>` chapter.
  81
  82 EOPNOTSUPP
  83     The  the requested I/O method is not supported.