Commit 6fd87774 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] DocBook: some fixes for DVB FE open()

The changeset dc9ef7d1 change the open() ioctl documentation to
match the V4L2 open(). However, some cut-and-pasted stuff doesn't
match what actually happens at the DVB core.

So, fix the documentation entry to be more accurate with the DVB
frontend open() specifics.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent dc9ef7d1
...@@ -61,7 +61,7 @@ specification is available at ...@@ -61,7 +61,7 @@ specification is available at
<refentry id="frontend_f_open"> <refentry id="frontend_f_open">
<refmeta> <refmeta>
<refentrytitle>open()</refentrytitle> <refentrytitle>DVB frontend open()</refentrytitle>
&manvol; &manvol;
</refmeta> </refmeta>
...@@ -94,20 +94,19 @@ specification is available at ...@@ -94,20 +94,19 @@ specification is available at
<varlistentry> <varlistentry>
<term><parameter>flags</parameter></term> <term><parameter>flags</parameter></term>
<listitem> <listitem>
<para>Open flags. Access mode must be <para>Open flags. Access can either be
<constant>O_RDWR</constant>. This is just a technicality, input devices <constant>O_RDWR</constant> or <constant>O_RDONLY</constant>.</para>
still support only reading and output devices only writing.</para> <para>Multiple opens are allowed with <constant>O_RDONLY</constant>. In this mode, only query and read ioctls are allowed.</para>
<para>When the <constant>O_NONBLOCK</constant> flag is <para>Only one open is allowed in <constant>O_RDWR</constant>. In this mode, all ioctls are allowed.</para>
given, the read() function will return the &EAGAIN; when no data is available, <para>When the <constant>O_NONBLOCK</constant> flag is given, the system calls may return &EAGAIN; when no data is available or when the device driver is temporarily busy.</para>
otherwise these functions block until data becomes <para>Other flags have no effect.</para>
available. Other flags have no effect.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<para>This system call opens a named frontend device (/dev/dvb/adapter0/frontend0) <para>This system call opens a named frontend device (<constant>/dev/dvb/adapter?/frontend?</constant>)
for subsequent use. Usually the first thing to do after a successful open is to for subsequent use. Usually the first thing to do after a successful open is to
find out the frontend type with <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para> find out the frontend type with <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
<para>The device can be opened in read-only mode, which only allows monitoring of <para>The device can be opened in read-only mode, which only allows monitoring of
...@@ -145,8 +144,7 @@ device.</para> ...@@ -145,8 +144,7 @@ device.</para>
<varlistentry> <varlistentry>
<term><errorcode>EBUSY</errorcode></term> <term><errorcode>EBUSY</errorcode></term>
<listitem> <listitem>
<para>The driver does not support multiple opens and the <para>The the device driver is already in use.</para>
device is already in use.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
...@@ -177,13 +175,19 @@ files open.</para> ...@@ -177,13 +175,19 @@ files open.</para>
system has been reached.</para> system has been reached.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><errorcode>ENODEV</errorcode></term>
<listitem>
<para>The device got removed.</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>
</refentry> </refentry>
<refentry id="frontend_f_close"> <refentry id="frontend_f_close">
<refmeta> <refmeta>
<refentrytitle>close()</refentrytitle> <refentrytitle>DVB frontend close()</refentrytitle>
&manvol; &manvol;
</refmeta> </refmeta>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment