Documentation/media/uapi/mediactl/request-func-close.rst

   1 .. This file is dual-licensed: you can use it either under the terms
   2 .. of the GPL 2.0 or the GFDL 1.1+ license, at your option. Note that this
   3 .. dual licensing only applies to this file, and not this project as a
   4 .. whole.
   5 ..
   6 .. a) This file is free software; you can redistribute it and/or
   7 ..    modify it under the terms of the GNU General Public License as
   8 ..    published by the Free Software Foundation version 2 of
   9 ..    the License.
  10 ..
  11 ..    This file is distributed in the hope that it will be useful,
  12 ..    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ..    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ..    GNU General Public License for more details.
  15 ..
  16 .. Or, alternatively,
  17 ..
  18 .. b) Permission is granted to copy, distribute and/or modify this
  19 ..    document under the terms of the GNU Free Documentation License,
  20 ..    Version 1.1 or any later version published by the Free Software
  21 ..    Foundation, with no Invariant Sections, no Front-Cover Texts
  22 ..    and no Back-Cover Texts. A copy of the license is included at
  23 ..    Documentation/media/uapi/fdl-appendix.rst.
  24 ..
  25 .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections
  26
  27 .. _request-func-close:
  28
  29 ***************
  30 request close()
  31 ***************
  32
  33 Name
  34 ====
  35
  36 request-close - Close a request file descriptor
  37
  38
  39 Synopsis
  40 ========
  41
  42 .. code-block:: c
  43
  44     #include <unistd.h>
  45
  46
  47 .. c:function:: int close( int fd )
  48     :name: req-close
  49
  50 Arguments
  51 =========
  52
  53 ``fd``
  54     File descriptor returned by :ref:`MEDIA_IOC_REQUEST_ALLOC`.
  55
  56
  57 Description
  58 ===========
  59
  60 Closes the request file descriptor. Resources associated with the request
  61 are freed once all file descriptors associated with the request are closed
  62 and the driver has completed the request.
  63 See :ref:`here <media-request-life-time>` for more information.
  64
  65
  66 Return Value
  67 ============
  68
  69 :ref:`close() <request-func-close>` returns 0 on success. On error, -1 is
  70 returned, and ``errno`` is set appropriately. Possible error codes are:
  71
  72 EBADF
  73     ``fd`` is not a valid open file descriptor.