1<refentry id="vidioc-dv-timings-cap">
2  <refmeta>
3    <refentrytitle>ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP</refentrytitle>
4    &manvol;
5  </refmeta>
6
7  <refnamediv>
8    <refname>VIDIOC_DV_TIMINGS_CAP</refname>
9    <refname>VIDIOC_SUBDEV_DV_TIMINGS_CAP</refname>
10    <refpurpose>The capabilities of the Digital Video receiver/transmitter</refpurpose>
11  </refnamediv>
12
13  <refsynopsisdiv>
14    <funcsynopsis>
15      <funcprototype>
16	<funcdef>int <function>ioctl</function></funcdef>
17	<paramdef>int <parameter>fd</parameter></paramdef>
18	<paramdef>int <parameter>request</parameter></paramdef>
19	<paramdef>struct v4l2_dv_timings_cap *<parameter>argp</parameter></paramdef>
20      </funcprototype>
21    </funcsynopsis>
22  </refsynopsisdiv>
23
24  <refsect1>
25    <title>Arguments</title>
26
27    <variablelist>
28      <varlistentry>
29	<term><parameter>fd</parameter></term>
30	<listitem>
31	  <para>&fd;</para>
32	</listitem>
33      </varlistentry>
34      <varlistentry>
35	<term><parameter>request</parameter></term>
36	<listitem>
37	  <para>VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP</para>
38	</listitem>
39      </varlistentry>
40      <varlistentry>
41	<term><parameter>argp</parameter></term>
42	<listitem>
43	  <para></para>
44	</listitem>
45      </varlistentry>
46    </variablelist>
47  </refsect1>
48
49  <refsect1>
50    <title>Description</title>
51
52    <note>
53      <title>Experimental</title>
54      <para>This is an <link linkend="experimental"> experimental </link>
55      interface and may change in the future.</para>
56    </note>
57
58    <para>To query the capabilities of the DV receiver/transmitter applications
59can call the <constant>VIDIOC_DV_TIMINGS_CAP</constant> ioctl on a video node
60and the driver will fill in the structure. Note that drivers may return
61different values after switching the video input or output.</para>
62
63    <para>When implemented by the driver DV capabilities of subdevices can be
64queried by calling the <constant>VIDIOC_SUBDEV_DV_TIMINGS_CAP</constant> ioctl
65directly on a subdevice node. The capabilities are specific to inputs (for DV
66receivers) or outputs (for DV transmitters), applications must specify the
67desired pad number in the &v4l2-dv-timings-cap; <structfield>pad</structfield>
68field. Attempts to query capabilities on a pad that doesn't support them will
69return an &EINVAL;.</para>
70
71    <table pgwide="1" frame="none" id="v4l2-bt-timings-cap">
72      <title>struct <structname>v4l2_bt_timings_cap</structname></title>
73      <tgroup cols="3">
74	&cs-str;
75	<tbody valign="top">
76	  <row>
77	    <entry>__u32</entry>
78	    <entry><structfield>min_width</structfield></entry>
79	    <entry>Minimum width of the active video in pixels.</entry>
80	  </row>
81	  <row>
82	    <entry>__u32</entry>
83	    <entry><structfield>max_width</structfield></entry>
84	    <entry>Maximum width of the active video in pixels.</entry>
85	  </row>
86	  <row>
87	    <entry>__u32</entry>
88	    <entry><structfield>min_height</structfield></entry>
89	    <entry>Minimum height of the active video in lines.</entry>
90	  </row>
91	  <row>
92	    <entry>__u32</entry>
93	    <entry><structfield>max_height</structfield></entry>
94	    <entry>Maximum height of the active video in lines.</entry>
95	  </row>
96	  <row>
97	    <entry>__u64</entry>
98	    <entry><structfield>min_pixelclock</structfield></entry>
99	    <entry>Minimum pixelclock frequency in Hz.</entry>
100	  </row>
101	  <row>
102	    <entry>__u64</entry>
103	    <entry><structfield>max_pixelclock</structfield></entry>
104	    <entry>Maximum pixelclock frequency in Hz.</entry>
105	  </row>
106	  <row>
107	    <entry>__u32</entry>
108	    <entry><structfield>standards</structfield></entry>
109	    <entry>The video standard(s) supported by the hardware.
110	    See <xref linkend="dv-bt-standards"/> for a list of standards.</entry>
111	  </row>
112	  <row>
113	    <entry>__u32</entry>
114	    <entry><structfield>capabilities</structfield></entry>
115	    <entry>Several flags giving more information about the capabilities.
116	    See <xref linkend="dv-bt-cap-capabilities"/> for a description of the flags.
117	    </entry>
118	  </row>
119	  <row>
120	    <entry>__u32</entry>
121	    <entry><structfield>reserved</structfield>[16]</entry>
122	    <entry>Reserved for future extensions. Drivers must set the array to zero.</entry>
123	  </row>
124	</tbody>
125      </tgroup>
126    </table>
127
128    <table pgwide="1" frame="none" id="v4l2-dv-timings-cap">
129      <title>struct <structname>v4l2_dv_timings_cap</structname></title>
130      <tgroup cols="4">
131	&cs-str;
132	<tbody valign="top">
133	  <row>
134	    <entry>__u32</entry>
135	    <entry><structfield>type</structfield></entry>
136	    <entry>Type of DV timings as listed in <xref linkend="dv-timing-types"/>.</entry>
137	  </row>
138	  <row>
139	    <entry>__u32</entry>
140	    <entry><structfield>pad</structfield></entry>
141	    <entry>Pad number as reported by the media controller API. This field
142	    is only used when operating on a subdevice node. When operating on a
143	    video node applications must set this field to zero.</entry>
144	  </row>
145	  <row>
146	    <entry>__u32</entry>
147	    <entry><structfield>reserved</structfield>[2]</entry>
148	    <entry>Reserved for future extensions. Drivers must set the array to zero.</entry>
149	  </row>
150	  <row>
151	    <entry>union</entry>
152	    <entry><structfield></structfield></entry>
153	    <entry></entry>
154	  </row>
155	  <row>
156	    <entry></entry>
157	    <entry>&v4l2-bt-timings-cap;</entry>
158	    <entry><structfield>bt</structfield></entry>
159	    <entry>BT.656/1120 timings capabilities of the hardware.</entry>
160	  </row>
161	  <row>
162	    <entry></entry>
163	    <entry>__u32</entry>
164	    <entry><structfield>raw_data</structfield>[32]</entry>
165	    <entry></entry>
166	  </row>
167	</tbody>
168      </tgroup>
169    </table>
170
171    <table pgwide="1" frame="none" id="dv-bt-cap-capabilities">
172      <title>DV BT Timing capabilities</title>
173      <tgroup cols="2">
174	&cs-str;
175	<tbody valign="top">
176	  <row>
177	    <entry>Flag</entry>
178	    <entry>Description</entry>
179	  </row>
180	  <row>
181	    <entry></entry>
182	    <entry></entry>
183	  </row>
184	  <row>
185	    <entry>V4L2_DV_BT_CAP_INTERLACED</entry>
186	    <entry>Interlaced formats are supported.
187	    </entry>
188	  </row>
189	  <row>
190	    <entry>V4L2_DV_BT_CAP_PROGRESSIVE</entry>
191	    <entry>Progressive formats are supported.
192	    </entry>
193	  </row>
194	  <row>
195	    <entry>V4L2_DV_BT_CAP_REDUCED_BLANKING</entry>
196	    <entry>CVT/GTF specific: the timings can make use of reduced blanking (CVT)
197or the 'Secondary GTF' curve (GTF).
198	    </entry>
199	  </row>
200	  <row>
201	    <entry>V4L2_DV_BT_CAP_CUSTOM</entry>
202	    <entry>Can support non-standard timings, i.e. timings not belonging to the
203standards set in the <structfield>standards</structfield> field.
204	    </entry>
205	  </row>
206	</tbody>
207      </tgroup>
208    </table>
209  </refsect1>
210
211  <refsect1>
212    &return-value;
213  </refsect1>
214</refentry>
215