blob: 9bf9ca7f46dc430415ec97939e4259d17995bf48 [file] [log] [blame]
Mauro Carvalho Chehab6d172492011-07-05 10:07:37 -03001<title>Generic Error Codes</title>
2
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">
Mauro Carvalho Chehabdfcf4f92011-07-05 11:37:58 -03008 <!-- 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>
Mauro Carvalho Chehab6d172492011-07-05 10:07:37 -030013 <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
Mauro Carvalho Chehab43c1daa2011-07-05 11:22:28 -030018 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>
Mauro Carvalho Chehabdfcf4f92011-07-05 11:37:58 -030023 <entry>EFAULT</entry>
24 <entry><parameter>fd</parameter> is not a valid open file descriptor.</entry>
25 </row>
26 <row>
Mauro Carvalho Chehab43c1daa2011-07-05 11:22:28 -030027 <entry>EINVAL</entry>
Mauro Carvalho Chehabdfcf4f92011-07-05 11:37:58 -030028 <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>
Mauro Carvalho Chehab43c1daa2011-07-05 11:22:28 -030033 <entry>The ioctl is not supported by the driver, actually meaning that
34 the required functionality is not available.</entry>
35 </row>
36 <row>
37 <entry>ENOMEM</entry>
38 <entry>There's not enough memory to handle the desired operation.</entry>
39 </row>
40 <row>
41 <entry>ENOSPC</entry>
Mauro Carvalho Chehabdfcf4f92011-07-05 11:37:58 -030042 <entry>On USB devices, the stream ioctl's can return this error, meaning
Mauro Carvalho Chehab43c1daa2011-07-05 11:22:28 -030043 that this request would overcommit the usb bandwidth reserved
44 for periodic transfers (up to 80% of the USB bandwidth).</entry>
Mauro Carvalho Chehab6d172492011-07-05 10:07:37 -030045 </row>
46 </tbody>
47 </tgroup>
48</table>