linux/Documentation/DocBook/v4l/vidioc-log-status.xml
Mauro Carvalho Chehab 8e080c2e6c V4L/DVB (12761): DocBook: add media API specs
The V4L and DVB API's are there for a long time. however, up to now,
no efforts were done to merge them to kernel DocBook.

This patch adds the current versions of the specs as an unique compendium.

Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2009-09-18 23:47:55 -03:00

59 lines
1.5 KiB
XML

<refentry id="vidioc-log-status">
<refmeta>
<refentrytitle>ioctl VIDIOC_LOG_STATUS</refentrytitle>
&manvol;
</refmeta>
<refnamediv>
<refname>VIDIOC_LOG_STATUS</refname>
<refpurpose>Log driver status information</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ioctl</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>request</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>As the video/audio devices become more complicated it
becomes harder to debug problems. When this ioctl is called the driver
will output the current device status to the kernel log. This is
particular useful when dealing with problems like no sound, no video
and incorrectly tuned channels. Also many modern devices autodetect
video and audio standards and this ioctl will report what the device
thinks what the standard is. Mismatches may give an indication where
the problem is.</para>
<para>This ioctl is optional and not all drivers support it. It
was introduced in Linux 2.6.15.</para>
</refsect1>
<refsect1>
&return-value;
<variablelist>
<varlistentry>
<term><errorcode>EINVAL</errorcode></term>
<listitem>
<para>The driver does not support this ioctl.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!--
Local Variables:
mode: sgml
sgml-parent-document: "v4l2.sgml"
indent-tabs-mode: nil
End:
-->