diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-07-05 10:57:05 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-07-27 16:53:36 -0400 |
commit | 4c14e4a93f02e89e7d0a62604a7652f61057c923 (patch) | |
tree | 6f87bbe237408ea77dafa7ccdc4bf08f6d03e194 /Documentation/DocBook | |
parent | 9e1d50756bad35c7e1b566bed9426f68d93135fd (diff) |
[media] DocBook: Remove V4L generic error description for ioctl()
V4L ioctl function descripton also has a generic error chapter.
Remove it, as it is now obsoleted by a general, multi-API generic
error descriptions.
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/media/v4l/func-ioctl.xml | 72 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/gen-errors.xml | 10 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/media-func-ioctl.xml | 1 |
3 files changed, 13 insertions, 70 deletions
diff --git a/Documentation/DocBook/media/v4l/func-ioctl.xml b/Documentation/DocBook/media/v4l/func-ioctl.xml index b60fd37a6295..2de64be706f5 100644 --- a/Documentation/DocBook/media/v4l/func-ioctl.xml +++ b/Documentation/DocBook/media/v4l/func-ioctl.xml | |||
@@ -64,75 +64,9 @@ their respective function and parameters are specified in <xref | |||
64 | </refsect1> | 64 | </refsect1> |
65 | 65 | ||
66 | <refsect1> | 66 | <refsect1> |
67 | <title>Return Value</title> | 67 | &return-value; |
68 | 68 | <para>When an ioctl that takes an output or read/write parameter fails, | |
69 | <para>On success the <function>ioctl()</function> function returns | 69 | the parameter remains unmodified.</para> |
70 | <returnvalue>0</returnvalue> and does not reset the | ||
71 | <varname>errno</varname> variable. On failure | ||
72 | <returnvalue>-1</returnvalue> is returned, when the ioctl takes an | ||
73 | output or read/write parameter it remains unmodified, and the | ||
74 | <varname>errno</varname> variable is set appropriately. See below for | ||
75 | possible error codes. Generic errors like <errorcode>EBADF</errorcode> | ||
76 | or <errorcode>EFAULT</errorcode> are not listed in the sections | ||
77 | discussing individual ioctl requests.</para> | ||
78 | <para>Note ioctls may return undefined error codes. Since errors | ||
79 | may have side effects such as a driver reset applications should | ||
80 | abort on unexpected errors.</para> | ||
81 | |||
82 | <variablelist> | ||
83 | <varlistentry> | ||
84 | <term><errorcode>EBADF</errorcode></term> | ||
85 | <listitem> | ||
86 | <para><parameter>fd</parameter> is not a valid open file | ||
87 | descriptor.</para> | ||
88 | </listitem> | ||
89 | </varlistentry> | ||
90 | <varlistentry> | ||
91 | <term><errorcode>EBUSY</errorcode></term> | ||
92 | <listitem> | ||
93 | <para>The property cannot be changed right now. Typically | ||
94 | this error code is returned when I/O is in progress or the driver | ||
95 | supports multiple opens and another process locked the property.</para> | ||
96 | </listitem> | ||
97 | </varlistentry> | ||
98 | <varlistentry> | ||
99 | <term><errorcode>EFAULT</errorcode></term> | ||
100 | <listitem> | ||
101 | <para><parameter>argp</parameter> references an inaccessible | ||
102 | memory area.</para> | ||
103 | </listitem> | ||
104 | </varlistentry> | ||
105 | <varlistentry> | ||
106 | <term><errorcode>ENOTTY</errorcode></term> | ||
107 | <listitem> | ||
108 | <para><parameter>fd</parameter> is not associated with a | ||
109 | character special device.</para> | ||
110 | </listitem> | ||
111 | </varlistentry> | ||
112 | <varlistentry> | ||
113 | <term><errorcode>EINVAL</errorcode></term> | ||
114 | <listitem> | ||
115 | <para>The <parameter>request</parameter> or the data pointed | ||
116 | to by <parameter>argp</parameter> is not valid. This is a very common | ||
117 | error code, see the individual ioctl requests listed in <xref | ||
118 | linkend="user-func" /> for actual causes.</para> | ||
119 | </listitem> | ||
120 | </varlistentry> | ||
121 | <varlistentry> | ||
122 | <term><errorcode>ENOMEM</errorcode></term> | ||
123 | <listitem> | ||
124 | <para>Not enough physical or virtual memory was available to | ||
125 | complete the request.</para> | ||
126 | </listitem> | ||
127 | </varlistentry> | ||
128 | <varlistentry> | ||
129 | <term><errorcode>ERANGE</errorcode></term> | ||
130 | <listitem> | ||
131 | <para>The application attempted to set a control with the | ||
132 | &VIDIOC-S-CTRL; ioctl to a value which is out of bounds.</para> | ||
133 | </listitem> | ||
134 | </varlistentry> | ||
135 | </variablelist> | ||
136 | </refsect1> | 70 | </refsect1> |
137 | </refentry> | 71 | </refentry> |
138 | 72 | ||
diff --git a/Documentation/DocBook/media/v4l/gen-errors.xml b/Documentation/DocBook/media/v4l/gen-errors.xml index 9bf9ca7f46dc..4268c658652f 100644 --- a/Documentation/DocBook/media/v4l/gen-errors.xml +++ b/Documentation/DocBook/media/v4l/gen-errors.xml | |||
@@ -31,7 +31,8 @@ | |||
31 | <row> | 31 | <row> |
32 | <entry>EINVAL or ENOTTY</entry> | 32 | <entry>EINVAL or ENOTTY</entry> |
33 | <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 |
34 | the required functionality is not available.</entry> | 34 | the required functionality is not available, or the file |
35 | descriptor is not for a media device.</entry> | ||
35 | </row> | 36 | </row> |
36 | <row> | 37 | <row> |
37 | <entry>ENOMEM</entry> | 38 | <entry>ENOMEM</entry> |
@@ -46,3 +47,10 @@ | |||
46 | </tbody> | 47 | </tbody> |
47 | </tgroup> | 48 | </tgroup> |
48 | </table> | 49 | </table> |
50 | |||
51 | <para>Note 1: ioctls may return other error codes. Since errors may have side | ||
52 | effects such as a driver reset, applications should abort on unexpected errors. | ||
53 | </para> | ||
54 | |||
55 | <para>Note 2: Request-specific error codes are listed in the individual | ||
56 | requests descriptions.</para> | ||
diff --git a/Documentation/DocBook/media/v4l/media-func-ioctl.xml b/Documentation/DocBook/media/v4l/media-func-ioctl.xml index e0ee285baf1c..39478d0fbcaa 100644 --- a/Documentation/DocBook/media/v4l/media-func-ioctl.xml +++ b/Documentation/DocBook/media/v4l/media-func-ioctl.xml | |||
@@ -64,6 +64,7 @@ | |||
64 | 64 | ||
65 | <refsect1> | 65 | <refsect1> |
66 | &return-value; | 66 | &return-value; |
67 | |||
67 | <para>Request-specific error codes are listed in the | 68 | <para>Request-specific error codes are listed in the |
68 | individual requests descriptions.</para> | 69 | individual requests descriptions.</para> |
69 | <para>When an ioctl that takes an output or read/write parameter fails, | 70 | <para>When an ioctl that takes an output or read/write parameter fails, |