Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_ENUM_DV_TIMINGS:
   4
   5 ***********************************************************
   6 ioctl VIDIOC_ENUM_DV_TIMINGS, VIDIOC_SUBDEV_ENUM_DV_TIMINGS
   7 ***********************************************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_ENUM_DV_TIMINGS - VIDIOC_SUBDEV_ENUM_DV_TIMINGS - Enumerate supported Digital Video timings
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, VIDIOC_ENUM_DV_TIMINGS, struct v4l2_enum_dv_timings *argp )
  19     :name: VIDIOC_ENUM_DV_TIMINGS
  20
  21 .. c:function:: int ioctl( int fd, VIDIOC_SUBDEV_ENUM_DV_TIMINGS, struct v4l2_enum_dv_timings *argp )
  22     :name: VIDIOC_SUBDEV_ENUM_DV_TIMINGS
  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 While some DV receivers or transmitters support a wide range of timings,
  38 others support only a limited number of timings. With this ioctl
  39 applications can enumerate a list of known supported timings. Call
  40 :ref:`VIDIOC_DV_TIMINGS_CAP` to check if it
  41 also supports other standards or even custom timings that are not in
  42 this list.
  43
  44 To query the available timings, applications initialize the ``index``
  45 field, set the ``pad`` field to 0, zero the reserved array of struct
  46 :c:type:`v4l2_enum_dv_timings` and call the
  47 ``VIDIOC_ENUM_DV_TIMINGS`` ioctl on a video node with a pointer to this
  48 structure. Drivers fill the rest of the structure or return an ``EINVAL``
  49 error code when the index is out of bounds. To enumerate all supported
  50 DV timings, applications shall begin at index zero, incrementing by one
  51 until the driver returns ``EINVAL``.
  52
  53 .. note::
  54
  55    Drivers may enumerate a different set of DV timings after
  56    switching the video input or output.
  57
  58 When implemented by the driver DV timings of subdevices can be queried
  59 by calling the ``VIDIOC_SUBDEV_ENUM_DV_TIMINGS`` ioctl directly on a
  60 subdevice node. The DV timings are specific to inputs (for DV receivers)
  61 or outputs (for DV transmitters), applications must specify the desired
  62 pad number in the struct
  63 :c:type:`v4l2_enum_dv_timings` ``pad`` field.
  64 Attempts to enumerate timings on a pad that doesn't support them will
  65 return an ``EINVAL`` error code.
  66
  67
  68 .. c:type:: v4l2_enum_dv_timings
  69
  70 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  71
  72 .. flat-table:: struct v4l2_enum_dv_timings
  73     :header-rows:  0
  74     :stub-columns: 0
  75     :widths:       1 1 2
  76
  77     * - __u32
  78       - ``index``
  79       - Number of the DV timings, set by the application.
  80     * - __u32
  81       - ``pad``
  82       - Pad number as reported by the media controller API. This field is
  83         only used when operating on a subdevice node. When operating on a
  84         video node applications must set this field to zero.
  85     * - __u32
  86       - ``reserved``\ [2]
  87       - Reserved for future extensions. Drivers and applications must set
  88         the array to zero.
  89     * - struct :c:type:`v4l2_dv_timings`
  90       - ``timings``
  91       - The timings.
  92
  93
  94 Return Value
  95 ============
  96
  97 On success 0 is returned, on error -1 and the ``errno`` variable is set
  98 appropriately. The generic error codes are described at the
  99 :ref:`Generic Error Codes <gen-errors>` chapter.
 100
 101 EINVAL
 102     The struct :c:type:`v4l2_enum_dv_timings`
 103     ``index`` is out of bounds or the ``pad`` number is invalid.
 104
 105 ENODATA
 106     Digital video presets are not supported for this input or output.