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