Commit | Line | Data |
---|---|---|
5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
af4a4d0d | 3 | .. _VIDIOC_DV_TIMINGS_CAP: |
5377d91f MH |
4 | |
5 | ********************************************************* | |
6 | ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP | |
7 | ********************************************************* | |
8 | ||
9 | *man VIDIOC_DV_TIMINGS_CAP(2)* | |
10 | ||
11 | VIDIOC_SUBDEV_DV_TIMINGS_CAP | |
12 | The capabilities of the Digital Video receiver/transmitter | |
13 | ||
14 | ||
15 | Synopsis | |
16 | ======== | |
17 | ||
b7e67f6c | 18 | .. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings_cap *argp ) |
5377d91f MH |
19 | |
20 | Arguments | |
21 | ========= | |
22 | ||
23 | ``fd`` | |
24 | File descriptor returned by :ref:`open() <func-open>`. | |
25 | ||
26 | ``request`` | |
27 | VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP | |
28 | ||
29 | ``argp`` | |
30 | ||
31 | ||
32 | Description | |
33 | =========== | |
34 | ||
35 | To query the capabilities of the DV receiver/transmitter applications | |
36 | initialize the ``pad`` field to 0, zero the reserved array of struct | |
37 | :ref:`v4l2_dv_timings_cap <v4l2-dv-timings-cap>` and call the | |
38 | ``VIDIOC_DV_TIMINGS_CAP`` ioctl on a video node and the driver will fill | |
39 | in the structure. Note that drivers may return different values after | |
40 | switching the video input or output. | |
41 | ||
42 | When implemented by the driver DV capabilities of subdevices can be | |
43 | queried by calling the ``VIDIOC_SUBDEV_DV_TIMINGS_CAP`` ioctl directly | |
44 | on a subdevice node. The capabilities are specific to inputs (for DV | |
45 | receivers) or outputs (for DV transmitters), applications must specify | |
46 | the desired pad number in the struct | |
47 | :ref:`v4l2_dv_timings_cap <v4l2-dv-timings-cap>` ``pad`` field and | |
48 | zero the ``reserved`` array. Attempts to query capabilities on a pad | |
49 | that doesn't support them will return an EINVAL error code. | |
50 | ||
51 | ||
52 | .. _v4l2-bt-timings-cap: | |
53 | ||
54 | .. flat-table:: struct v4l2_bt_timings_cap | |
55 | :header-rows: 0 | |
56 | :stub-columns: 0 | |
57 | :widths: 1 1 2 | |
58 | ||
59 | ||
60 | - .. row 1 | |
61 | ||
62 | - __u32 | |
63 | ||
64 | - ``min_width`` | |
65 | ||
66 | - Minimum width of the active video in pixels. | |
67 | ||
68 | - .. row 2 | |
69 | ||
70 | - __u32 | |
71 | ||
72 | - ``max_width`` | |
73 | ||
74 | - Maximum width of the active video in pixels. | |
75 | ||
76 | - .. row 3 | |
77 | ||
78 | - __u32 | |
79 | ||
80 | - ``min_height`` | |
81 | ||
82 | - Minimum height of the active video in lines. | |
83 | ||
84 | - .. row 4 | |
85 | ||
86 | - __u32 | |
87 | ||
88 | - ``max_height`` | |
89 | ||
90 | - Maximum height of the active video in lines. | |
91 | ||
92 | - .. row 5 | |
93 | ||
94 | - __u64 | |
95 | ||
96 | - ``min_pixelclock`` | |
97 | ||
98 | - Minimum pixelclock frequency in Hz. | |
99 | ||
100 | - .. row 6 | |
101 | ||
102 | - __u64 | |
103 | ||
104 | - ``max_pixelclock`` | |
105 | ||
106 | - Maximum pixelclock frequency in Hz. | |
107 | ||
108 | - .. row 7 | |
109 | ||
110 | - __u32 | |
111 | ||
112 | - ``standards`` | |
113 | ||
114 | - The video standard(s) supported by the hardware. See | |
115 | :ref:`dv-bt-standards` for a list of standards. | |
116 | ||
117 | - .. row 8 | |
118 | ||
119 | - __u32 | |
120 | ||
121 | - ``capabilities`` | |
122 | ||
123 | - Several flags giving more information about the capabilities. See | |
124 | :ref:`dv-bt-cap-capabilities` for a description of the flags. | |
125 | ||
126 | - .. row 9 | |
127 | ||
128 | - __u32 | |
129 | ||
130 | - ``reserved``\ [16] | |
131 | ||
132 | - Reserved for future extensions. Drivers must set the array to | |
133 | zero. | |
134 | ||
135 | ||
136 | ||
137 | .. _v4l2-dv-timings-cap: | |
138 | ||
139 | .. flat-table:: struct v4l2_dv_timings_cap | |
140 | :header-rows: 0 | |
141 | :stub-columns: 0 | |
142 | :widths: 1 1 2 1 | |
143 | ||
144 | ||
145 | - .. row 1 | |
146 | ||
147 | - __u32 | |
148 | ||
149 | - ``type`` | |
150 | ||
151 | - Type of DV timings as listed in :ref:`dv-timing-types`. | |
152 | ||
153 | - .. row 2 | |
154 | ||
155 | - __u32 | |
156 | ||
157 | - ``pad`` | |
158 | ||
159 | - Pad number as reported by the media controller API. This field is | |
160 | only used when operating on a subdevice node. When operating on a | |
161 | video node applications must set this field to zero. | |
162 | ||
163 | - .. row 3 | |
164 | ||
165 | - __u32 | |
166 | ||
167 | - ``reserved``\ [2] | |
168 | ||
169 | - Reserved for future extensions. Drivers and applications must set | |
170 | the array to zero. | |
171 | ||
172 | - .. row 4 | |
173 | ||
174 | - union | |
175 | ||
176 | - | |
177 | - | |
178 | ||
179 | - .. row 5 | |
180 | ||
181 | - | |
182 | - struct :ref:`v4l2_bt_timings_cap <v4l2-bt-timings-cap>` | |
183 | ||
184 | - ``bt`` | |
185 | ||
186 | - BT.656/1120 timings capabilities of the hardware. | |
187 | ||
188 | - .. row 6 | |
189 | ||
190 | - | |
191 | - __u32 | |
192 | ||
193 | - ``raw_data``\ [32] | |
194 | ||
195 | - | |
196 | ||
197 | ||
198 | ||
199 | .. _dv-bt-cap-capabilities: | |
200 | ||
201 | .. flat-table:: DV BT Timing capabilities | |
202 | :header-rows: 0 | |
203 | :stub-columns: 0 | |
204 | ||
205 | ||
206 | - .. row 1 | |
207 | ||
208 | - Flag | |
209 | ||
210 | - Description | |
211 | ||
212 | - .. row 2 | |
213 | ||
214 | - | |
215 | - | |
216 | ||
217 | - .. row 3 | |
218 | ||
219 | - V4L2_DV_BT_CAP_INTERLACED | |
220 | ||
221 | - Interlaced formats are supported. | |
222 | ||
223 | - .. row 4 | |
224 | ||
225 | - V4L2_DV_BT_CAP_PROGRESSIVE | |
226 | ||
227 | - Progressive formats are supported. | |
228 | ||
229 | - .. row 5 | |
230 | ||
231 | - V4L2_DV_BT_CAP_REDUCED_BLANKING | |
232 | ||
233 | - CVT/GTF specific: the timings can make use of reduced blanking | |
234 | (CVT) or the 'Secondary GTF' curve (GTF). | |
235 | ||
236 | - .. row 6 | |
237 | ||
238 | - V4L2_DV_BT_CAP_CUSTOM | |
239 | ||
240 | - Can support non-standard timings, i.e. timings not belonging to | |
241 | the standards set in the ``standards`` field. | |
242 | ||
243 | ||
244 | ||
245 | Return Value | |
246 | ============ | |
247 | ||
248 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
249 | appropriately. The generic error codes are described at the | |
250 | :ref:`Generic Error Codes <gen-errors>` chapter. | |
251 | ||
252 | ||
253 | .. ------------------------------------------------------------------------------ | |
254 | .. This file was automatically converted from DocBook-XML with the dbxml | |
255 | .. library (https://github.com/return42/sphkerneldoc). The origin XML comes | |
256 | .. from the linux kernel, refer to: | |
257 | .. | |
258 | .. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook | |
259 | .. ------------------------------------------------------------------------------ |