Documentation/media/uapi/v4l/vidioc-g-ctrl.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_G_CTRL:
   4
   5 **********************************
   6 ioctl VIDIOC_G_CTRL, VIDIOC_S_CTRL
   7 **********************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_G_CTRL - VIDIOC_S_CTRL - Get or set the value of a control
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, VIDIOC_G_CTRL, struct v4l2_control *argp )
  19     :name: VIDIOC_G_CTRL
  20
  21 .. c:function:: int ioctl( int fd, VIDIOC_S_CTRL, struct v4l2_control *argp )
  22     :name: VIDIOC_S_CTRL
  23
  24
  25 Arguments
  26 =========
  27
  28 ``fd``
  29     File descriptor returned by :ref:`open() <func-open>`.
  30
  31 ``argp``
  32
  33
  34 Description
  35 ===========
  36
  37 To get the current value of a control applications initialize the ``id``
  38 field of a struct :c:type:`v4l2_control` and call the
  39 :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl with a pointer to this structure. To change the
  40 value of a control applications initialize the ``id`` and ``value``
  41 fields of a struct :c:type:`v4l2_control` and call the
  42 :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctl.
  43
  44 When the ``id`` is invalid drivers return an ``EINVAL`` error code. When the
  45 ``value`` is out of bounds drivers can choose to take the closest valid
  46 value or return an ``ERANGE`` error code, whatever seems more appropriate.
  47 However, :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` is a write-only ioctl, it does not return the
  48 actual new value. If the ``value`` is inappropriate for the control
  49 (e.g. if it refers to an unsupported menu index of a menu control), then
  50 EINVAL error code is returned as well.
  51
  52 These ioctls work only with user controls. For other control classes the
  53 :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
  54 :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` or
  55 :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` must be used.
  56
  57
  58 .. c:type:: v4l2_control
  59
  60 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  61
  62 .. flat-table:: struct v4l2_control
  63     :header-rows:  0
  64     :stub-columns: 0
  65     :widths:       1 1 2
  66
  67     * - __u32
  68       - ``id``
  69       - Identifies the control, set by the application.
  70     * - __s32
  71       - ``value``
  72       - New value or current value.
  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 EINVAL
  83     The struct :c:type:`v4l2_control` ``id`` is invalid
  84     or the ``value`` is inappropriate for the given control (i.e. if a
  85     menu item is selected that is not supported by the driver according
  86     to :ref:`VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>`).
  87
  88 ERANGE
  89     The struct :c:type:`v4l2_control` ``value`` is out of
  90     bounds.
  91
  92 EBUSY
  93     The control is temporarily not changeable, possibly because another
  94     applications took over control of the device function this control
  95     belongs to.
  96
  97 EACCES
  98     Attempt to set a read-only control or to get a write-only control.