From 8e4bff4cab0ddac6060645b0715210484d02ff40 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Wed, 30 Aug 2017 08:25:59 +0000
Subject: Initial file dump from open source release
---
Documentation/DocBook/media/v4l/gen-errors.xml | 77 ++++++++++++++++++++++++++
1 file changed, 77 insertions(+)
create mode 100644 Documentation/DocBook/media/v4l/gen-errors.xml
(limited to 'Documentation/DocBook/media/v4l/gen-errors.xml')
diff --git a/Documentation/DocBook/media/v4l/gen-errors.xml b/Documentation/DocBook/media/v4l/gen-errors.xml
new file mode 100644
index 00000000..7e29a4e1
--- /dev/null
+++ b/Documentation/DocBook/media/v4l/gen-errors.xml
@@ -0,0 +1,77 @@
+
Generic Error Codes
+
+
+ Generic error codes
+
+ &cs-str;
+
+
+
+ EAGAIN (aka EWOULDBLOCK)
+ The ioctl can't be handled because the device is in state where
+ it can't perform it. This could happen for example in case where
+ device is sleeping and ioctl is performed to query statistics.
+ It is also returned when the ioctl would need to wait
+ for an event, but the device was opened in non-blocking mode.
+
+
+
+ EBADF
+ The file descriptor is not a valid.
+
+
+ EBUSY
+ 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).
+
+
+ EFAULT
+ There was a failure while copying data from/to userspace,
+ probably caused by an invalid pointer reference.
+
+
+ EINVAL
+ 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.
+
+
+ ENODEV
+ Device not found or was removed.
+
+
+ ENOMEM
+ There's not enough memory to handle the desired operation.
+
+
+ ENOTTY
+ 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.
+
+
+ ENOSPC
+ 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).
+
+
+ EPERM
+ Permission denied. Can be returned if the device needs write
+ permission, or some special capabilities is needed
+ (e. g. root)
+
+
+
+
+
+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.
+
+
+Note 2: Request-specific error codes are listed in the individual
+requests descriptions.
--
cgit v1.3.1