^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) .. c:namespace:: V4L
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) .. _VIDIOC_DV_TIMINGS_CAP:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) *********************************************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) *********************************************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) Name
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) ====
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) VIDIOC_DV_TIMINGS_CAP - VIDIOC_SUBDEV_DV_TIMINGS_CAP - The capabilities of the Digital Video receiver/transmitter
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) Synopsis
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) ========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) .. c:macro:: VIDIOC_DV_TIMINGS_CAP
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) ``int ioctl(int fd, VIDIOC_DV_TIMINGS_CAP, struct v4l2_dv_timings_cap *argp)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) .. c:macro:: VIDIOC_SUBDEV_DV_TIMINGS_CAP
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) ``int ioctl(int fd, VIDIOC_SUBDEV_DV_TIMINGS_CAP, struct v4l2_dv_timings_cap *argp)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) Arguments
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) =========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) ``fd``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) File descriptor returned by :c:func:`open()`.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) ``argp``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) Pointer to struct :c:type:`v4l2_dv_timings_cap`.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) Description
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) ===========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) To query the capabilities of the DV receiver/transmitter applications
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) initialize the ``pad`` field to 0, zero the reserved array of struct
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) :c:type:`v4l2_dv_timings_cap` and call the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) ``VIDIOC_DV_TIMINGS_CAP`` ioctl on a video node and the driver will fill
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) in the structure.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) .. note::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) Drivers may return different values after
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) switching the video input or output.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) When implemented by the driver DV capabilities of subdevices can be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) queried by calling the ``VIDIOC_SUBDEV_DV_TIMINGS_CAP`` ioctl directly
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) on a subdevice node. The capabilities are specific to inputs (for DV
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) receivers) or outputs (for DV transmitters), applications must specify
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) the desired pad number in the struct
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) :c:type:`v4l2_dv_timings_cap` ``pad`` field and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) zero the ``reserved`` array. Attempts to query capabilities on a pad
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) that doesn't support them will return an ``EINVAL`` error code.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) .. tabularcolumns:: |p{1.2cm}|p{3.0cm}|p{13.3cm}|
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) .. c:type:: v4l2_bt_timings_cap
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) .. flat-table:: struct v4l2_bt_timings_cap
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) :header-rows: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) :stub-columns: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) :widths: 1 1 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) - ``min_width``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) - Minimum width of the active video in pixels.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) - ``max_width``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) - Maximum width of the active video in pixels.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) - ``min_height``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) - Minimum height of the active video in lines.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) - ``max_height``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) - Maximum height of the active video in lines.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) * - __u64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) - ``min_pixelclock``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) - Minimum pixelclock frequency in Hz.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) * - __u64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) - ``max_pixelclock``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) - Maximum pixelclock frequency in Hz.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) - ``standards``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) - The video standard(s) supported by the hardware. See
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) :ref:`dv-bt-standards` for a list of standards.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) - ``capabilities``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) - Several flags giving more information about the capabilities. See
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) :ref:`dv-bt-cap-capabilities` for a description of the flags.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) - ``reserved``\ [16]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) - Reserved for future extensions.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) Drivers must set the array to zero.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) .. tabularcolumns:: |p{1.0cm}|p{4.0cm}|p{3.5cm}|p{9.2cm}|
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) .. c:type:: v4l2_dv_timings_cap
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) .. flat-table:: struct v4l2_dv_timings_cap
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) :header-rows: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) :stub-columns: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) :widths: 1 1 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) - ``type``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) - Type of DV timings as listed in :ref:`dv-timing-types`.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) - ``pad``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) - Pad number as reported by the media controller API. This field is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) only used when operating on a subdevice node. When operating on a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) video node applications must set this field to zero.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) - ``reserved``\ [2]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) - Reserved for future extensions.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) Drivers and applications must set the array to zero.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) * - union {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) - (anonymous)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) * - struct :c:type:`v4l2_bt_timings_cap`
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) - ``bt``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) - BT.656/1120 timings capabilities of the hardware.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) * - __u32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) - ``raw_data``\ [32]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) * - }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) -
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) .. tabularcolumns:: |p{7.0cm}|p{10.5cm}|
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) .. _dv-bt-cap-capabilities:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) .. flat-table:: DV BT Timing capabilities
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) :header-rows: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) :stub-columns: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) * - Flag
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) - Description
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) * -
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) -
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) * - ``V4L2_DV_BT_CAP_INTERLACED``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) - Interlaced formats are supported.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) * - ``V4L2_DV_BT_CAP_PROGRESSIVE``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) - Progressive formats are supported.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) * - ``V4L2_DV_BT_CAP_REDUCED_BLANKING``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) - CVT/GTF specific: the timings can make use of reduced blanking
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) (CVT) or the 'Secondary GTF' curve (GTF).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) * - ``V4L2_DV_BT_CAP_CUSTOM``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) - Can support non-standard timings, i.e. timings not belonging to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) the standards set in the ``standards`` field.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) Return Value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) ============
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) On success 0 is returned, on error -1 and the ``errno`` variable is set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) appropriately. The generic error codes are described at the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) :ref:`Generic Error Codes <gen-errors>` chapter.