aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/media/v4l/gen-errors.xml
blob: 5bbf3ce1973a8df5d72619ce3df4cc62de52b036 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<title>Generic Error Codes</title>

<table frame="none" pgwide="1" id="gen-errors">
  <title>Generic error codes</title>
  <tgroup cols="2">
    &cs-str;
    <tbody valign="top">
	<!-- Keep it ordered alphabetically -->
      <row>
	<entry>EBADF</entry>
	<entry>The file descriptor is not a valid.</entry>
      </row>
      <row>
	<entry>EBUSY</entry>
	<entry>The ioctl can't be handled because the device is busy. This is
	       typically return while device is streaming, and an ioctl tried to
	       change something that would affect the stream, or would require the
	       usage of a hardware resource that was already allocated. The ioctl
	       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>There was a failure while copying data from/to userspace,
	       probably caused by an invalid pointer reference.</entry>
      </row>
      <row>
	<entry>EINVAL</entry>
	<entry>One or more of the ioctl parameters are invalid or out of the
	       allowed range. This is a widely used error code. See the individual
	       ioctl requests for specific causes.</entry>
      </row>
      <row>
        <entry>ENODEV</entry>
	<entry>Device not found or was removed.</entry>
      </row>
      <row>
	<entry>ENOMEM</entry>
	<entry>There's not enough memory to handle the desired operation.</entry>
      </row>
      <row>
	<entry>ENOTTY</entry>
	<entry>The ioctl is not supported by the driver, actually meaning that
	       the required functionality is not available, or the file
	       descriptor is not for a media device.</entry>
      </row>
      <row>
	<entry>ENOSPC</entry>
	<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>
      <row>
	<entry>ENOSYS or EOPNOTSUPP</entry>
	<entry>Function not available for this device (dvb API only. Will likely
	       be replaced anytime soon by ENOTTY).</entry>
      </row>
      <row>
	<entry>EPERM</entry>
	<entry>Permission denied. Can be returned if the device needs write
		permission, or some special capabilities is needed
		(e. g. root)</entry>
      </row>
      <row>
	<entry>EWOULDBLOCK</entry>
	<entry>Operation would block. Used when the ioctl would need to wait
	       for an event, but the device was opened in non-blocking mode.</entry>
      </row>
    </tbody>
  </tgroup>
</table>

<para>Note 1: ioctls may return other error codes. Since errors may have side
effects such as a driver reset, applications should abort on unexpected errors.
</para>

<para>Note 2: Request-specific error codes are listed in the individual
requests descriptions.</para>