Documentation/media/uapi/v4l/vidioc-prepare-buf.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_PREPARE_BUF:
   4
   5 ************************
   6 ioctl VIDIOC_PREPARE_BUF
   7 ************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_PREPARE_BUF - Prepare a buffer for I/O
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, VIDIOC_PREPARE_BUF, struct v4l2_buffer *argp )
  19     :name: VIDIOC_PREPARE_BUF
  20
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :ref:`open() <func-open>`.
  27
  28 ``argp``
  29     Pointer to struct :c:type:`v4l2_buffer`.
  30
  31
  32 Description
  33 ===========
  34
  35 Applications can optionally call the :ref:`VIDIOC_PREPARE_BUF` ioctl to
  36 pass ownership of the buffer to the driver before actually enqueuing it,
  37 using the :ref:`VIDIOC_QBUF` ioctl, and to prepare it for future I/O. Such
  38 preparations may include cache invalidation or cleaning. Performing them
  39 in advance saves time during the actual I/O. In case such cache
  40 operations are not required, the application can use one of
  41 ``V4L2_BUF_FLAG_NO_CACHE_INVALIDATE`` and
  42 ``V4L2_BUF_FLAG_NO_CACHE_CLEAN`` flags to skip the respective step.
  43
  44 The struct :c:type:`v4l2_buffer` structure is specified in
  45 :ref:`buffer`.
  46
  47
  48 Return Value
  49 ============
  50
  51 On success 0 is returned, on error -1 and the ``errno`` variable is set
  52 appropriately. The generic error codes are described at the
  53 :ref:`Generic Error Codes <gen-errors>` chapter.
  54
  55 EBUSY
  56     File I/O is in progress.
  57
  58 EINVAL
  59     The buffer ``type`` is not supported, or the ``index`` is out of
  60     bounds, or no buffers have been allocated yet, or the ``userptr`` or
  61     ``length`` are invalid.