Skip to content

Commit

Permalink
[media] DocBook: Use the generic error code page also for MC API
Browse files Browse the repository at this point in the history
Instead of having their own generic error codes at the MC API, move
its section to the generic one and be sure that all media ioctl's
will point to it.

Acked-by: Hans Verkuil <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
  • Loading branch information
Mauro Carvalho Chehab committed Jul 27, 2011
1 parent 43c1daa commit dfcf4f9
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 49 deletions.
16 changes: 15 additions & 1 deletion Documentation/DocBook/media/v4l/gen-errors.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
<tgroup cols="2">
&cs-str;
<tbody valign="top">
<!-- Keep it ordered alphabetically -->
<row>
<entry>EBADF</entry>
<entry><parameter>fd</parameter> is not a valid open file descriptor.</entry>
</row>
<row>
<entry>EBUSY</entry>
<entry>The ioctl can't be handled because the device is busy. This is
Expand All @@ -14,8 +19,17 @@
must not be retried without performing another action to fix the
problem first (typically: stop the stream before retrying).</entry>
</row>
<row>
<entry>EFAULT</entry>
<entry><parameter>fd</parameter> is not a valid open file descriptor.</entry>
</row>
<row>
<entry>EINVAL</entry>
<entry>One or more of the ioctl parameters are invalid. This is a widely
used error code. See the individual ioctl requests for actual causes.</entry>
</row>
<row>
<entry>EINVAL or ENOTTY</entry>
<entry>The ioctl is not supported by the driver, actually meaning that
the required functionality is not available.</entry>
</row>
Expand All @@ -25,7 +39,7 @@
</row>
<row>
<entry>ENOSPC</entry>
<entry>On USB devices, the stream ioctl's can return this error meaning
<entry>On USB devices, the stream ioctl's can return this error, meaning
that this request would overcommit the usb bandwidth reserved
for periodic transfers (up to 80% of the USB bandwidth).</entry>
</row>
Expand Down
48 changes: 2 additions & 46 deletions Documentation/DocBook/media/v4l/media-func-ioctl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -63,54 +63,10 @@
</refsect1>

<refsect1>
<title>Return Value</title>

<para><function>ioctl()</function> returns <returnvalue>0</returnvalue> on
success. On failure, <returnvalue>-1</returnvalue> is returned, and the
<varname>errno</varname> variable is set appropriately. Generic error codes
are listed below, and request-specific error codes are listed in the
&return-value;
<para>Request-specific error codes are listed in the
individual requests descriptions.</para>
<para>When an ioctl that takes an output or read/write parameter fails,
the parameter remains unmodified.</para>

<variablelist>
<varlistentry>
<term><errorcode>EBADF</errorcode></term>
<listitem>
<para><parameter>fd</parameter> is not a valid open file descriptor.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EFAULT</errorcode></term>
<listitem>
<para><parameter>argp</parameter> references an inaccessible memory
area.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EINVAL</errorcode></term>
<listitem>
<para>The <parameter>request</parameter> or the data pointed to by
<parameter>argp</parameter> is not valid. This is a very common error
code, see the individual ioctl requests listed in
<xref linkend="media-user-func" /> for actual causes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>ENOMEM</errorcode></term>
<listitem>
<para>Insufficient kernel memory was available to complete the
request.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>ENOTTY</errorcode></term>
<listitem>
<para><parameter>fd</parameter> is not associated with a character
special device.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
3 changes: 1 addition & 2 deletions Documentation/DocBook/media/v4l/media-ioc-device-info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@
</refsect1>

<refsect1>
<title>Return value</title>
<para>This function doesn't return specific error codes.</para>
&return-value;
</refsect1>
</refentry>

0 comments on commit dfcf4f9

Please sign in to comment.