aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@redhat.com>2011-07-05 10:37:58 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-07-27 16:53:35 -0400
commitdfcf4f9d97eec997283e41cef2d2b6956c32fecd (patch)
tree072056f3e96d39b68da58dfe6254f812f627f6af /Documentation
parent43c1daa47d57197c1491411a9f33189f9ef680dd (diff)
[media] DocBook: Use the generic error code page also for MC API
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 <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DocBook/media/v4l/gen-errors.xml16
-rw-r--r--Documentation/DocBook/media/v4l/media-func-ioctl.xml48
-rw-r--r--Documentation/DocBook/media/v4l/media-ioc-device-info.xml3
3 files changed, 18 insertions, 49 deletions
diff --git a/Documentation/DocBook/media/v4l/gen-errors.xml b/Documentation/DocBook/media/v4l/gen-errors.xml
index 6ef476a54016..9bf9ca7f46dc 100644
--- a/Documentation/DocBook/media/v4l/gen-errors.xml
+++ b/Documentation/DocBook/media/v4l/gen-errors.xml
@@ -5,6 +5,11 @@
5 <tgroup cols="2"> 5 <tgroup cols="2">
6 &cs-str; 6 &cs-str;
7 <tbody valign="top"> 7 <tbody valign="top">
8 <!-- Keep it ordered alphabetically -->
9 <row>
10 <entry>EBADF</entry>
11 <entry><parameter>fd</parameter> is not a valid open file descriptor.</entry>
12 </row>
8 <row> 13 <row>
9 <entry>EBUSY</entry> 14 <entry>EBUSY</entry>
10 <entry>The ioctl can't be handled because the device is busy. This is 15 <entry>The ioctl can't be handled because the device is busy. This is
@@ -15,7 +20,16 @@
15 problem first (typically: stop the stream before retrying).</entry> 20 problem first (typically: stop the stream before retrying).</entry>
16 </row> 21 </row>
17 <row> 22 <row>
23 <entry>EFAULT</entry>
24 <entry><parameter>fd</parameter> is not a valid open file descriptor.</entry>
25 </row>
26 <row>
18 <entry>EINVAL</entry> 27 <entry>EINVAL</entry>
28 <entry>One or more of the ioctl parameters are invalid. This is a widely
29 used error code. See the individual ioctl requests for actual causes.</entry>
30 </row>
31 <row>
32 <entry>EINVAL or ENOTTY</entry>
19 <entry>The ioctl is not supported by the driver, actually meaning that 33 <entry>The ioctl is not supported by the driver, actually meaning that
20 the required functionality is not available.</entry> 34 the required functionality is not available.</entry>
21 </row> 35 </row>
@@ -25,7 +39,7 @@
25 </row> 39 </row>
26 <row> 40 <row>
27 <entry>ENOSPC</entry> 41 <entry>ENOSPC</entry>
28 <entry>On USB devices, the stream ioctl's can return this error meaning 42 <entry>On USB devices, the stream ioctl's can return this error, meaning
29 that this request would overcommit the usb bandwidth reserved 43 that this request would overcommit the usb bandwidth reserved
30 for periodic transfers (up to 80% of the USB bandwidth).</entry> 44 for periodic transfers (up to 80% of the USB bandwidth).</entry>
31 </row> 45 </row>
diff --git a/Documentation/DocBook/media/v4l/media-func-ioctl.xml b/Documentation/DocBook/media/v4l/media-func-ioctl.xml
index bda8604de15c..e0ee285baf1c 100644
--- a/Documentation/DocBook/media/v4l/media-func-ioctl.xml
+++ b/Documentation/DocBook/media/v4l/media-func-ioctl.xml
@@ -63,54 +63,10 @@
63 </refsect1> 63 </refsect1>
64 64
65 <refsect1> 65 <refsect1>
66 <title>Return Value</title> 66 &return-value;
67 67 <para>Request-specific error codes are listed in the
68 <para><function>ioctl()</function> returns <returnvalue>0</returnvalue> on
69 success. On failure, <returnvalue>-1</returnvalue> is returned, and the
70 <varname>errno</varname> variable is set appropriately. Generic error codes
71 are listed below, and request-specific error codes are listed in the
72 individual requests descriptions.</para> 68 individual requests descriptions.</para>
73 <para>When an ioctl that takes an output or read/write parameter fails, 69 <para>When an ioctl that takes an output or read/write parameter fails,
74 the parameter remains unmodified.</para> 70 the parameter remains unmodified.</para>
75
76 <variablelist>
77 <varlistentry>
78 <term><errorcode>EBADF</errorcode></term>
79 <listitem>
80 <para><parameter>fd</parameter> is not a valid open file descriptor.
81 </para>
82 </listitem>
83 </varlistentry>
84 <varlistentry>
85 <term><errorcode>EFAULT</errorcode></term>
86 <listitem>
87 <para><parameter>argp</parameter> references an inaccessible memory
88 area.</para>
89 </listitem>
90 </varlistentry>
91 <varlistentry>
92 <term><errorcode>EINVAL</errorcode></term>
93 <listitem>
94 <para>The <parameter>request</parameter> or the data pointed to by
95 <parameter>argp</parameter> is not valid. This is a very common error
96 code, see the individual ioctl requests listed in
97 <xref linkend="media-user-func" /> for actual causes.</para>
98 </listitem>
99 </varlistentry>
100 <varlistentry>
101 <term><errorcode>ENOMEM</errorcode></term>
102 <listitem>
103 <para>Insufficient kernel memory was available to complete the
104 request.</para>
105 </listitem>
106 </varlistentry>
107 <varlistentry>
108 <term><errorcode>ENOTTY</errorcode></term>
109 <listitem>
110 <para><parameter>fd</parameter> is not associated with a character
111 special device.</para>
112 </listitem>
113 </varlistentry>
114 </variablelist>
115 </refsect1> 71 </refsect1>
116</refentry> 72</refentry>
diff --git a/Documentation/DocBook/media/v4l/media-ioc-device-info.xml b/Documentation/DocBook/media/v4l/media-ioc-device-info.xml
index 1f3237351bba..2ce521419e67 100644
--- a/Documentation/DocBook/media/v4l/media-ioc-device-info.xml
+++ b/Documentation/DocBook/media/v4l/media-ioc-device-info.xml
@@ -127,7 +127,6 @@
127 </refsect1> 127 </refsect1>
128 128
129 <refsect1> 129 <refsect1>
130 <title>Return value</title> 130 &return-value;
131 <para>This function doesn't return specific error codes.</para>
132 </refsect1> 131 </refsect1>
133</refentry> 132</refentry>