Documentation/media/uapi/v4l/func-ioctl.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _func-ioctl:
   4
   5 ************
   6 V4L2 ioctl()
   7 ************
   8
   9 Name
  10 ====
  11
  12 v4l2-ioctl - Program a V4L2 device
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. code-block:: c
  19
  20     #include <sys/ioctl.h>
  21
  22
  23 .. c:function:: int ioctl( int fd, int request, void *argp )
  24     :name: v4l2-ioctl
  25
  26 Arguments
  27 =========
  28
  29 ``fd``
  30     File descriptor returned by :ref:`open() <func-open>`.
  31
  32 ``request``
  33     V4L2 ioctl request code as defined in the ``videodev2.h`` header
  34     file, for example VIDIOC_QUERYCAP.
  35
  36 ``argp``
  37     Pointer to a function parameter, usually a structure.
  38
  39
  40 Description
  41 ===========
  42
  43 The :ref:`ioctl() <func-ioctl>` function is used to program V4L2 devices. The
  44 argument ``fd`` must be an open file descriptor. An ioctl ``request``
  45 has encoded in it whether the argument is an input, output or read/write
  46 parameter, and the size of the argument ``argp`` in bytes. Macros and
  47 defines specifying V4L2 ioctl requests are located in the
  48 ``videodev2.h`` header file. Applications should use their own copy, not
  49 include the version in the kernel sources on the system they compile on.
  50 All V4L2 ioctl requests, their respective function and parameters are
  51 specified in :ref:`user-func`.
  52
  53
  54 Return Value
  55 ============
  56
  57 On success 0 is returned, on error -1 and the ``errno`` variable is set
  58 appropriately. The generic error codes are described at the
  59 :ref:`Generic Error Codes <gen-errors>` chapter.
  60
  61 When an ioctl that takes an output or read/write parameter fails, the
  62 parameter remains unmodified.