Add linux-next specific files for 20110831
[linux-2.6/next.git] / Documentation / DocBook / media / v4l / vidioc-log-status.xml
blob5ded7d35e27b5b02a247b14ca068ababf2533f1b
1 <refentry id="vidioc-log-status">
2   <refmeta>
3     <refentrytitle>ioctl VIDIOC_LOG_STATUS</refentrytitle>
4     &manvol;
5   </refmeta>
7   <refnamediv>
8     <refname>VIDIOC_LOG_STATUS</refname>
9     <refpurpose>Log driver status information</refpurpose>
10   </refnamediv>
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       </funcprototype>
19     </funcsynopsis>
20   </refsynopsisdiv>
22   <refsect1>
23     <title>Description</title>
25     <para>As the video/audio devices become more complicated it
26 becomes harder to debug problems. When this ioctl is called the driver
27 will output the current device status to the kernel log. This is
28 particular useful when dealing with problems like no sound, no video
29 and incorrectly tuned channels. Also many modern devices autodetect
30 video and audio standards and this ioctl will report what the device
31 thinks what the standard is. Mismatches may give an indication where
32 the problem is.</para>
34     <para>This ioctl is optional and not all drivers support it. It
35 was introduced in Linux 2.6.15.</para>
36   </refsect1>
38   <refsect1>
39     &return-value;
40   </refsect1>
41 </refentry>