Documentation/media/uapi/v4l/vidioc-subdev-g-frame-interval.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_SUBDEV_G_FRAME_INTERVAL:
   4
   5 ********************************************************************
   6 ioctl VIDIOC_SUBDEV_G_FRAME_INTERVAL, VIDIOC_SUBDEV_S_FRAME_INTERVAL
   7 ********************************************************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_SUBDEV_G_FRAME_INTERVAL - VIDIOC_SUBDEV_S_FRAME_INTERVAL - Get or set the frame interval on a subdev pad
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval *argp )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <func-open>`.
  26
  27 ``request``
  28     VIDIOC_SUBDEV_G_FRAME_INTERVAL,
  29     VIDIOC_SUBDEV_S_FRAME_INTERVAL
  30
  31 ``argp``
  32
  33
  34 Description
  35 ===========
  36
  37 These ioctls are used to get and set the frame interval at specific
  38 subdev pads in the image pipeline. The frame interval only makes sense
  39 for sub-devices that can control the frame period on their own. This
  40 includes, for instance, image sensors and TV tuners. Sub-devices that
  41 don't support frame intervals must not implement these ioctls.
  42
  43 To retrieve the current frame interval applications set the ``pad``
  44 field of a struct
  45 :ref:`v4l2_subdev_frame_interval <v4l2-subdev-frame-interval>` to
  46 the desired pad number as reported by the media controller API. When
  47 they call the ``VIDIOC_SUBDEV_G_FRAME_INTERVAL`` ioctl with a pointer to
  48 this structure the driver fills the members of the ``interval`` field.
  49
  50 To change the current frame interval applications set both the ``pad``
  51 field and all members of the ``interval`` field. When they call the
  52 ``VIDIOC_SUBDEV_S_FRAME_INTERVAL`` ioctl with a pointer to this
  53 structure the driver verifies the requested interval, adjusts it based
  54 on the hardware capabilities and configures the device. Upon return the
  55 struct
  56 :ref:`v4l2_subdev_frame_interval <v4l2-subdev-frame-interval>`
  57 contains the current frame interval as would be returned by a
  58 ``VIDIOC_SUBDEV_G_FRAME_INTERVAL`` call.
  59
  60 Drivers must not return an error solely because the requested interval
  61 doesn't match the device capabilities. They must instead modify the
  62 interval to match what the hardware can provide. The modified interval
  63 should be as close as possible to the original request.
  64
  65 Sub-devices that support the frame interval ioctls should implement them
  66 on a single pad only. Their behaviour when supported on multiple pads of
  67 the same sub-device is not defined.
  68
  69
  70 .. _v4l2-subdev-frame-interval:
  71
  72 .. flat-table:: struct v4l2_subdev_frame_interval
  73     :header-rows:  0
  74     :stub-columns: 0
  75     :widths:       1 1 2
  76
  77
  78     -  .. row 1
  79
  80        -  __u32
  81
  82        -  ``pad``
  83
  84        -  Pad number as reported by the media controller API.
  85
  86     -  .. row 2
  87
  88        -  struct :ref:`v4l2_fract <v4l2-fract>`
  89
  90        -  ``interval``
  91
  92        -  Period, in seconds, between consecutive video frames.
  93
  94     -  .. row 3
  95
  96        -  __u32
  97
  98        -  ``reserved``\ [9]
  99
 100        -  Reserved for future extensions. Applications and drivers must set
 101           the array to zero.
 102
 103
 104 Return Value
 105 ============
 106
 107 On success 0 is returned, on error -1 and the ``errno`` variable is set
 108 appropriately. The generic error codes are described at the
 109 :ref:`Generic Error Codes <gen-errors>` chapter.
 110
 111 EBUSY
 112     The frame interval can't be changed because the pad is currently
 113     busy. This can be caused, for instance, by an active video stream on
 114     the pad. The ioctl must not be retried without performing another
 115     action to fix the problem first. Only returned by
 116     ``VIDIOC_SUBDEV_S_FRAME_INTERVAL``
 117
 118 EINVAL
 119     The struct
 120     :ref:`v4l2_subdev_frame_interval <v4l2-subdev-frame-interval>`
 121     ``pad`` references a non-existing pad, or the pad doesn't support
 122     frame intervals.