About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / DocBook / media / v4l / vidioc-dv-timings-cap.xml


Based on kernel version 4.7.2. Page generated on 2016-08-22 22:45 EST.

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


About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog