[media] DocBook: Remove V4L generic error description for ioctl()
[linux-2.6.git] / Documentation / DocBook / media / v4l / gen-errors.xml
1 <title>Generic Error Codes</title>
3 <table frame="none" pgwide="1" id="gen-errors">
4   <title>Generic error codes</title>
5   <tgroup cols="2">
6     &cs-str;
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>
13       <row>
14         <entry>EBUSY</entry>
15         <entry>The ioctl can't be handled because the device is busy. This is
16                typically return while device is streaming, and an ioctl tried to
17                change something that would affect the stream, or would require the
18                usage of a hardware resource that was already allocated. The ioctl
19                must not be retried without performing another action to fix the
20                problem first (typically: stop the stream before retrying).</entry>
21       </row>
22       <row>
23         <entry>EFAULT</entry>
24         <entry><parameter>fd</parameter> is not a valid open file descriptor.</entry>
25       </row>
26       <row>
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>
33         <entry>The ioctl is not supported by the driver, actually meaning that
34                the required functionality is not available, or the file
35                descriptor is not for a media device.</entry>
36       </row>
37       <row>
38         <entry>ENOMEM</entry>
39         <entry>There's not enough memory to handle the desired operation.</entry>
40       </row>
41       <row>
42         <entry>ENOSPC</entry>
43         <entry>On USB devices, the stream ioctl's can return this error, meaning
44                that this request would overcommit the usb bandwidth reserved
45                for periodic transfers (up to 80% of the USB bandwidth).</entry>
46       </row>
47     </tbody>
48   </tgroup>
49 </table>
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>
55 <para>Note 2: Request-specific error codes are listed in the individual
56 requests descriptions.</para>