aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorHans Verkuil <hans.verkuil@cisco.com>2013-05-26 08:45:23 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2013-06-21 09:47:22 -0400
commita6edca3c1b4e78c099a426bbe1e724bf70cf3515 (patch)
treee5bfe62e1ca219043f7ab649b030ba4335489ca6 /Documentation/DocBook
parentb71c99801e18eb172ae34851daf25044a3bf644a (diff)
[media] DocBook: remove references to the dropped VIDIOC_DBG_G_CHIP_IDENT ioctl
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Cc: Mauro Carvalho Chehab <mchehab@redhat.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/v4l/compat.xml14
-rw-r--r--Documentation/DocBook/media/v4l/v4l2.xml11
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-ident.xml271
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml17
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml40
5 files changed, 24 insertions, 329 deletions
diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml
index f43542ae2981..0c7195e3e093 100644
--- a/Documentation/DocBook/media/v4l/compat.xml
+++ b/Documentation/DocBook/media/v4l/compat.xml
@@ -2254,7 +2254,7 @@ video encoding.</para>
2254 <orderedlist> 2254 <orderedlist>
2255 <listitem> 2255 <listitem>
2256 <para>The <constant>VIDIOC_G_CHIP_IDENT</constant> ioctl was renamed 2256 <para>The <constant>VIDIOC_G_CHIP_IDENT</constant> ioctl was renamed
2257to <constant>VIDIOC_G_CHIP_IDENT_OLD</constant> and &VIDIOC-DBG-G-CHIP-IDENT; 2257to <constant>VIDIOC_G_CHIP_IDENT_OLD</constant> and <constant>VIDIOC_DBG_G_CHIP_IDENT</constant>
2258was introduced in its place. The old struct <structname>v4l2_chip_ident</structname> 2258was introduced in its place. The old struct <structname>v4l2_chip_ident</structname>
2259was renamed to <structname id="v4l2-chip-ident-old">v4l2_chip_ident_old</structname>.</para> 2259was renamed to <structname id="v4l2-chip-ident-old">v4l2_chip_ident_old</structname>.</para>
2260 </listitem> 2260 </listitem>
@@ -2513,6 +2513,16 @@ that used it. It was originally scheduled for removal in 2.6.35.
2513 </orderedlist> 2513 </orderedlist>
2514 </section> 2514 </section>
2515 2515
2516 <section>
2517 <title>V4L2 in Linux 3.11</title>
2518 <orderedlist>
2519 <listitem>
2520 <para>Remove obsolete <constant>VIDIOC_DBG_G_CHIP_IDENT</constant> ioctl.
2521 </para>
2522 </listitem>
2523 </orderedlist>
2524 </section>
2525
2516 <section id="other"> 2526 <section id="other">
2517 <title>Relation of V4L2 to other Linux multimedia APIs</title> 2527 <title>Relation of V4L2 to other Linux multimedia APIs</title>
2518 2528
@@ -2596,7 +2606,7 @@ and may change in the future.</para>
2596ioctls.</para> 2606ioctls.</para>
2597 </listitem> 2607 </listitem>
2598 <listitem> 2608 <listitem>
2599 <para>&VIDIOC-DBG-G-CHIP-IDENT; ioctl.</para> 2609 <para>&VIDIOC-DBG-G-CHIP-INFO; ioctl.</para>
2600 </listitem> 2610 </listitem>
2601 <listitem> 2611 <listitem>
2602 <para>&VIDIOC-ENUM-DV-TIMINGS;, &VIDIOC-QUERY-DV-TIMINGS; and 2612 <para>&VIDIOC-ENUM-DV-TIMINGS;, &VIDIOC-QUERY-DV-TIMINGS; and
diff --git a/Documentation/DocBook/media/v4l/v4l2.xml b/Documentation/DocBook/media/v4l/v4l2.xml
index bfe823dd0f31..8469fe13945c 100644
--- a/Documentation/DocBook/media/v4l/v4l2.xml
+++ b/Documentation/DocBook/media/v4l/v4l2.xml
@@ -141,6 +141,14 @@ structs, ioctls) must be noted in more detail in the history chapter
141applications. --> 141applications. -->
142 142
143 <revision> 143 <revision>
144 <revnumber>3.11</revnumber>
145 <date>2013-05-26</date>
146 <authorinitials>hv</authorinitials>
147 <revremark>Remove obsolete VIDIOC_DBG_G_CHIP_IDENT ioctl.
148 </revremark>
149 </revision>
150
151 <revision>
144 <revnumber>3.10</revnumber> 152 <revnumber>3.10</revnumber>
145 <date>2013-03-25</date> 153 <date>2013-03-25</date>
146 <authorinitials>hv</authorinitials> 154 <authorinitials>hv</authorinitials>
@@ -493,7 +501,7 @@ and discussions on the V4L mailing list.</revremark>
493</partinfo> 501</partinfo>
494 502
495<title>Video for Linux Two API Specification</title> 503<title>Video for Linux Two API Specification</title>
496 <subtitle>Revision 3.10</subtitle> 504 <subtitle>Revision 3.11</subtitle>
497 505
498 <chapter id="common"> 506 <chapter id="common">
499 &sub-common; 507 &sub-common;
@@ -547,7 +555,6 @@ and discussions on the V4L mailing list.</revremark>
547 <!-- All ioctls go here. --> 555 <!-- All ioctls go here. -->
548 &sub-create-bufs; 556 &sub-create-bufs;
549 &sub-cropcap; 557 &sub-cropcap;
550 &sub-dbg-g-chip-ident;
551 &sub-dbg-g-chip-info; 558 &sub-dbg-g-chip-info;
552 &sub-dbg-g-register; 559 &sub-dbg-g-register;
553 &sub-decoder-cmd; 560 &sub-decoder-cmd;
diff --git a/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-ident.xml b/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-ident.xml
deleted file mode 100644
index 921e18550d26..000000000000
--- a/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-ident.xml
+++ /dev/null
@@ -1,271 +0,0 @@
1<refentry id="vidioc-dbg-g-chip-ident">
2 <refmeta>
3 <refentrytitle>ioctl VIDIOC_DBG_G_CHIP_IDENT</refentrytitle>
4 &manvol;
5 </refmeta>
6
7 <refnamediv>
8 <refname>VIDIOC_DBG_G_CHIP_IDENT</refname>
9 <refpurpose>Identify the chips on a TV card</refpurpose>
10 </refnamediv>
11
12 <refsynopsisdiv>
13 <funcsynopsis>
14 <funcprototype>
15 <funcdef>int <function>ioctl</function></funcdef>
16 <paramdef>int <parameter>fd</parameter></paramdef>
17 <paramdef>int <parameter>request</parameter></paramdef>
18 <paramdef>struct v4l2_dbg_chip_ident
19*<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_DBG_G_CHIP_IDENT</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
55 <para>This is an <link
56linkend="experimental">experimental</link> interface and may change in
57the future.</para>
58 </note>
59
60 <para>For driver debugging purposes this ioctl allows test
61applications to query the driver about the chips present on the TV
62card. Regular applications must not use it. When you found a chip
63specific bug, please contact the linux-media mailing list (&v4l-ml;)
64so it can be fixed.</para>
65
66 <para>To query the driver applications must initialize the
67<structfield>match.type</structfield> and
68<structfield>match.addr</structfield> or <structfield>match.name</structfield>
69fields of a &v4l2-dbg-chip-ident;
70and call <constant>VIDIOC_DBG_G_CHIP_IDENT</constant> with a pointer to
71this structure. On success the driver stores information about the
72selected chip in the <structfield>ident</structfield> and
73<structfield>revision</structfield> fields. On failure the structure
74remains unchanged.</para>
75
76 <para>When <structfield>match.type</structfield> is
77<constant>V4L2_CHIP_MATCH_HOST</constant>,
78<structfield>match.addr</structfield> selects the nth non-&i2c; chip
79on the TV card. You can enumerate all chips by starting at zero and
80incrementing <structfield>match.addr</structfield> by one until
81<constant>VIDIOC_DBG_G_CHIP_IDENT</constant> fails with an &EINVAL;.
82The number zero always selects the host chip, &eg; the chip connected
83to the PCI or USB bus.</para>
84
85 <para>When <structfield>match.type</structfield> is
86<constant>V4L2_CHIP_MATCH_I2C_DRIVER</constant>,
87<structfield>match.name</structfield> contains the I2C driver name.
88For instance
89<constant>"saa7127"</constant> will match any chip
90supported by the saa7127 driver, regardless of its &i2c; bus address.
91When multiple chips supported by the same driver are present, the
92ioctl will return <constant>V4L2_IDENT_AMBIGUOUS</constant> in the
93<structfield>ident</structfield> field.</para>
94
95 <para>When <structfield>match.type</structfield> is
96<constant>V4L2_CHIP_MATCH_I2C_ADDR</constant>,
97<structfield>match.addr</structfield> selects a chip by its 7 bit
98&i2c; bus address.</para>
99
100 <para>When <structfield>match.type</structfield> is
101<constant>V4L2_CHIP_MATCH_AC97</constant>,
102<structfield>match.addr</structfield> selects the nth AC97 chip
103on the TV card. You can enumerate all chips by starting at zero and
104incrementing <structfield>match.addr</structfield> by one until
105<constant>VIDIOC_DBG_G_CHIP_IDENT</constant> fails with an &EINVAL;.</para>
106
107 <para>On success, the <structfield>ident</structfield> field will
108contain a chip ID from the Linux
109<filename>media/v4l2-chip-ident.h</filename> header file, and the
110<structfield>revision</structfield> field will contain a driver
111specific value, or zero if no particular revision is associated with
112this chip.</para>
113
114 <para>When the driver could not identify the selected chip,
115<structfield>ident</structfield> will contain
116<constant>V4L2_IDENT_UNKNOWN</constant>. When no chip matched
117the ioctl will succeed but the
118<structfield>ident</structfield> field will contain
119<constant>V4L2_IDENT_NONE</constant>. If multiple chips matched,
120<structfield>ident</structfield> will contain
121<constant>V4L2_IDENT_AMBIGUOUS</constant>. In all these cases the
122<structfield>revision</structfield> field remains unchanged.</para>
123
124 <para>This ioctl is optional, not all drivers may support it. It
125was introduced in Linux 2.6.21, but the API was changed to the
126one described here in 2.6.29.</para>
127
128 <para>We recommended the <application>v4l2-dbg</application>
129utility over calling this ioctl directly. It is available from the
130LinuxTV v4l-dvb repository; see <ulink
131url="http://linuxtv.org/repo/">http://linuxtv.org/repo/</ulink> for
132access instructions.</para>
133
134 <!-- Note for convenience vidioc-dbg-g-register.sgml
135 contains a duplicate of this table. -->
136 <table pgwide="1" frame="none" id="ident-v4l2-dbg-match">
137 <title>struct <structname>v4l2_dbg_match</structname></title>
138 <tgroup cols="4">
139 &cs-ustr;
140 <tbody valign="top">
141 <row>
142 <entry>__u32</entry>
143 <entry><structfield>type</structfield></entry>
144 <entry>See <xref linkend="ident-chip-match-types" /> for a list of
145possible types.</entry>
146 </row>
147 <row>
148 <entry>union</entry>
149 <entry>(anonymous)</entry>
150 </row>
151 <row>
152 <entry></entry>
153 <entry>__u32</entry>
154 <entry><structfield>addr</structfield></entry>
155 <entry>Match a chip by this number, interpreted according
156to the <structfield>type</structfield> field.</entry>
157 </row>
158 <row>
159 <entry></entry>
160 <entry>char</entry>
161 <entry><structfield>name[32]</structfield></entry>
162 <entry>Match a chip by this name, interpreted according
163to the <structfield>type</structfield> field.</entry>
164 </row>
165 </tbody>
166 </tgroup>
167 </table>
168
169 <table pgwide="1" frame="none" id="v4l2-dbg-chip-ident">
170 <title>struct <structname>v4l2_dbg_chip_ident</structname></title>
171 <tgroup cols="3">
172 &cs-str;
173 <tbody valign="top">
174 <row>
175 <entry>struct v4l2_dbg_match</entry>
176 <entry><structfield>match</structfield></entry>
177 <entry>How to match the chip, see <xref linkend="ident-v4l2-dbg-match" />.</entry>
178 </row>
179 <row>
180 <entry>__u32</entry>
181 <entry><structfield>ident</structfield></entry>
182 <entry>A chip identifier as defined in the Linux
183<filename>media/v4l2-chip-ident.h</filename> header file, or one of
184the values from <xref linkend="chip-ids" />.</entry>
185 </row>
186 <row>
187 <entry>__u32</entry>
188 <entry><structfield>revision</structfield></entry>
189 <entry>A chip revision, chip and driver specific.</entry>
190 </row>
191 </tbody>
192 </tgroup>
193 </table>
194
195 <!-- Note for convenience vidioc-dbg-g-register.sgml
196 contains a duplicate of this table. -->
197 <table pgwide="1" frame="none" id="ident-chip-match-types">
198 <title>Chip Match Types</title>
199 <tgroup cols="3">
200 &cs-def;
201 <tbody valign="top">
202 <row>
203 <entry><constant>V4L2_CHIP_MATCH_BRIDGE</constant></entry>
204 <entry>0</entry>
205 <entry>Match the nth chip on the card, zero for the
206 bridge chip. Does not match sub-devices.</entry>
207 </row>
208 <row>
209 <entry><constant>V4L2_CHIP_MATCH_I2C_DRIVER</constant></entry>
210 <entry>1</entry>
211 <entry>Match an &i2c; chip by its driver name.</entry>
212 </row>
213 <row>
214 <entry><constant>V4L2_CHIP_MATCH_I2C_ADDR</constant></entry>
215 <entry>2</entry>
216 <entry>Match a chip by its 7 bit &i2c; bus address.</entry>
217 </row>
218 <row>
219 <entry><constant>V4L2_CHIP_MATCH_AC97</constant></entry>
220 <entry>3</entry>
221 <entry>Match the nth anciliary AC97 chip.</entry>
222 </row>
223 <row>
224 <entry><constant>V4L2_CHIP_MATCH_SUBDEV</constant></entry>
225 <entry>4</entry>
226 <entry>Match the nth sub-device. Can't be used with this ioctl.</entry>
227 </row>
228 </tbody>
229 </tgroup>
230 </table>
231
232 <!-- This is an anonymous enum in media/v4l2-chip-ident.h. -->
233 <table pgwide="1" frame="none" id="chip-ids">
234 <title>Chip Identifiers</title>
235 <tgroup cols="3">
236 &cs-def;
237 <tbody valign="top">
238 <row>
239 <entry><constant>V4L2_IDENT_NONE</constant></entry>
240 <entry>0</entry>
241 <entry>No chip matched.</entry>
242 </row>
243 <row>
244 <entry><constant>V4L2_IDENT_AMBIGUOUS</constant></entry>
245 <entry>1</entry>
246 <entry>Multiple chips matched.</entry>
247 </row>
248 <row>
249 <entry><constant>V4L2_IDENT_UNKNOWN</constant></entry>
250 <entry>2</entry>
251 <entry>A chip is present at this address, but the driver
252could not identify it.</entry>
253 </row>
254 </tbody>
255 </tgroup>
256 </table>
257 </refsect1>
258
259 <refsect1>
260 &return-value;
261
262 <variablelist>
263 <varlistentry>
264 <term><errorcode>EINVAL</errorcode></term>
265 <listitem>
266 <para>The <structfield>match_type</structfield> is invalid.</para>
267 </listitem>
268 </varlistentry>
269 </variablelist>
270 </refsect1>
271</refentry>
diff --git a/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml b/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml
index 80e8021369f6..4c4603c135fe 100644
--- a/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml
@@ -131,7 +131,7 @@ to the <structfield>type</structfield> field.</entry>
131 <entry>char</entry> 131 <entry>char</entry>
132 <entry><structfield>name[32]</structfield></entry> 132 <entry><structfield>name[32]</structfield></entry>
133 <entry>Match a chip by this name, interpreted according 133 <entry>Match a chip by this name, interpreted according
134to the <structfield>type</structfield> field.</entry> 134to the <structfield>type</structfield> field. Currently unused.</entry>
135 </row> 135 </row>
136 </tbody> 136 </tbody>
137 </tgroup> 137 </tgroup>
@@ -182,21 +182,6 @@ is set, then the driver supports reading registers from the device. If
182 bridge chip. Does not match sub-devices.</entry> 182 bridge chip. Does not match sub-devices.</entry>
183 </row> 183 </row>
184 <row> 184 <row>
185 <entry><constant>V4L2_CHIP_MATCH_I2C_DRIVER</constant></entry>
186 <entry>1</entry>
187 <entry>Match an &i2c; chip by its driver name. Can't be used with this ioctl.</entry>
188 </row>
189 <row>
190 <entry><constant>V4L2_CHIP_MATCH_I2C_ADDR</constant></entry>
191 <entry>2</entry>
192 <entry>Match a chip by its 7 bit &i2c; bus address. Can't be used with this ioctl.</entry>
193 </row>
194 <row>
195 <entry><constant>V4L2_CHIP_MATCH_AC97</constant></entry>
196 <entry>3</entry>
197 <entry>Match the nth anciliary AC97 chip. Can't be used with this ioctl.</entry>
198 </row>
199 <row>
200 <entry><constant>V4L2_CHIP_MATCH_SUBDEV</constant></entry> 185 <entry><constant>V4L2_CHIP_MATCH_SUBDEV</constant></entry>
201 <entry>4</entry> 186 <entry>4</entry>
202 <entry>Match the nth sub-device.</entry> 187 <entry>Match the nth sub-device.</entry>
diff --git a/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml b/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml
index e23285fad3bf..32c4bde9d4b8 100644
--- a/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml
@@ -102,27 +102,6 @@ chip connected to the PCI or USB bus. You can find out which chips are
102present with the &VIDIOC-DBG-G-CHIP-INFO; ioctl.</para> 102present with the &VIDIOC-DBG-G-CHIP-INFO; ioctl.</para>
103 103
104 <para>When <structfield>match.type</structfield> is 104 <para>When <structfield>match.type</structfield> is
105<constant>V4L2_CHIP_MATCH_I2C_DRIVER</constant>,
106<structfield>match.name</structfield> contains the I2C driver name.
107For instance
108<constant>"saa7127"</constant> will match any chip
109supported by the saa7127 driver, regardless of its &i2c; bus address.
110When multiple chips supported by the same driver are present, the
111effect of these ioctls is undefined. Again with the
112&VIDIOC-DBG-G-CHIP-INFO; ioctl you can find out which &i2c; chips are
113present.</para>
114
115 <para>When <structfield>match.type</structfield> is
116<constant>V4L2_CHIP_MATCH_I2C_ADDR</constant>,
117<structfield>match.addr</structfield> selects a chip by its 7 bit &i2c;
118bus address.</para>
119
120 <para>When <structfield>match.type</structfield> is
121<constant>V4L2_CHIP_MATCH_AC97</constant>,
122<structfield>match.addr</structfield> selects the nth AC97 chip
123on the TV card.</para>
124
125 <para>When <structfield>match.type</structfield> is
126<constant>V4L2_CHIP_MATCH_SUBDEV</constant>, 105<constant>V4L2_CHIP_MATCH_SUBDEV</constant>,
127<structfield>match.addr</structfield> selects the nth sub-device.</para> 106<structfield>match.addr</structfield> selects the nth sub-device.</para>
128 107
@@ -160,7 +139,7 @@ access instructions.</para>
160 <row> 139 <row>
161 <entry>__u32</entry> 140 <entry>__u32</entry>
162 <entry><structfield>type</structfield></entry> 141 <entry><structfield>type</structfield></entry>
163 <entry>See <xref linkend="ident-chip-match-types" /> for a list of 142 <entry>See <xref linkend="chip-match-types" /> for a list of
164possible types.</entry> 143possible types.</entry>
165 </row> 144 </row>
166 <row> 145 <row>
@@ -179,7 +158,7 @@ to the <structfield>type</structfield> field.</entry>
179 <entry>char</entry> 158 <entry>char</entry>
180 <entry><structfield>name[32]</structfield></entry> 159 <entry><structfield>name[32]</structfield></entry>
181 <entry>Match a chip by this name, interpreted according 160 <entry>Match a chip by this name, interpreted according
182to the <structfield>type</structfield> field.</entry> 161to the <structfield>type</structfield> field. Currently unused.</entry>
183 </row> 162 </row>
184 </tbody> 163 </tbody>
185 </tgroup> 164 </tgroup>
@@ -232,21 +211,6 @@ register.</entry>
232 bridge chip. Does not match sub-devices.</entry> 211 bridge chip. Does not match sub-devices.</entry>
233 </row> 212 </row>
234 <row> 213 <row>
235 <entry><constant>V4L2_CHIP_MATCH_I2C_DRIVER</constant></entry>
236 <entry>1</entry>
237 <entry>Match an &i2c; chip by its driver name.</entry>
238 </row>
239 <row>
240 <entry><constant>V4L2_CHIP_MATCH_I2C_ADDR</constant></entry>
241 <entry>2</entry>
242 <entry>Match a chip by its 7 bit &i2c; bus address.</entry>
243 </row>
244 <row>
245 <entry><constant>V4L2_CHIP_MATCH_AC97</constant></entry>
246 <entry>3</entry>
247 <entry>Match the nth anciliary AC97 chip.</entry>
248 </row>
249 <row>
250 <entry><constant>V4L2_CHIP_MATCH_SUBDEV</constant></entry> 214 <entry><constant>V4L2_CHIP_MATCH_SUBDEV</constant></entry>
251 <entry>4</entry> 215 <entry>4</entry>
252 <entry>Match the nth sub-device.</entry> 216 <entry>Match the nth sub-device.</entry>
generated by cgit v1.2.2 (git 2.25.0) at 2026-05-27 14:15:25 -0400