2020-08-26 15:03:09 +08:00
|
|
|
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
|
2018-08-30 22:15:26 +08:00
|
|
|
|
2016-06-30 21:18:56 +08:00
|
|
|
.. _gen_errors:
|
|
|
|
|
|
|
|
|
|
*******************
|
|
|
|
|
Generic Error Codes
|
|
|
|
|
*******************
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. _gen-errors:
|
|
|
|
|
|
2016-08-19 20:46:28 +08:00
|
|
|
.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
|
[media] docs-rst: add tabularcolumns to all tables
LaTeX doesn't handle too well auto-width on tables, and ReST
markup requires an special tag to give it the needed hints.
As we're using A4 paper, we have 17cm of useful spaces. As
most media tables have widths, let's use it to generate the
needed via the following perl script:
my ($line_size, $table_header, $has_cols) = (17.5, 0, 0);
my $out;
my $header = "";
my @widths = ();
sub round { $_[0] > 0 ? int($_[0] + .5) : -int(-$_[0] + .5) }
while (<>) {
if (!$table_header) {
$has_cols = 1 if (m/..\s+tabularcolumns::/);
if (m/..\s+flat-table::/) {
$table_header = 1;
$header = $_;
next;
}
$out .= $_;
next;
}
$header .= $_;
@widths = split(/ /, $1) if (m/:widths:\s+(.*)/);
if (m/^\n$/) {
if (!$has_cols && @widths) {
my ($tot, $t, $i) = (0, 0, 0);
foreach my $v(@widths) { $tot += $v; };
$out .= ".. tabularcolumns:: |";
for ($i = 0; $i < scalar @widths - 1; $i++) {
my $v = $widths[$i];
my $w = round(10 * ($v * $line_size) / $tot) / 10;
$out .= sprintf "p{%.1fcm}|", $w;
$t += $w;
}
my $w = $line_size - $t;
$out .= sprintf "p{%.1fcm}|\n\n", $w;
}
$out .= $header;
$table_header = 0;
$has_cols = 0;
$header = "";
@widths = ();
}
}
print $out;
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-17 19:14:19 +08:00
|
|
|
|
2016-06-30 21:18:56 +08:00
|
|
|
.. flat-table:: Generic error codes
|
|
|
|
|
:header-rows: 0
|
|
|
|
|
:stub-columns: 0
|
2016-07-06 18:58:20 +08:00
|
|
|
:widths: 1 16
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``EAGAIN`` (aka ``EWOULDBLOCK``)
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- The ioctl can't be handled because the device is in state where it
|
2016-07-05 03:25:48 +08:00
|
|
|
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.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``EBADF``
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- The file descriptor is not a valid.
|
|
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``EBUSY``
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- The ioctl can't be handled because the device is busy. This is
|
2016-07-05 03:25:48 +08:00
|
|
|
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).
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``EFAULT``
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- There was a failure while copying data from/to userspace, probably
|
2016-07-05 03:25:48 +08:00
|
|
|
caused by an invalid pointer reference.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``EINVAL``
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- One or more of the ioctl parameters are invalid or out of the
|
2016-07-05 03:25:48 +08:00
|
|
|
allowed range. This is a widely used error code. See the
|
|
|
|
|
individual ioctl requests for specific causes.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``ENODEV``
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- Device not found or was removed.
|
|
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``ENOMEM``
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- There's not enough memory to handle the desired operation.
|
|
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``ENOTTY``
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- The ioctl is not supported by the driver, actually meaning that
|
2016-07-05 03:25:48 +08:00
|
|
|
the required functionality is not available, or the file
|
|
|
|
|
descriptor is not for a media device.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``ENOSPC``
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- On USB devices, the stream ioctl's can return this error, meaning
|
2016-07-05 03:25:48 +08:00
|
|
|
that this request would overcommit the usb bandwidth reserved for
|
|
|
|
|
periodic transfers (up to 80% of the USB bandwidth).
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``EPERM``
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- Permission denied. Can be returned if the device needs write
|
2016-07-05 03:25:48 +08:00
|
|
|
permission, or some special capabilities is needed (e. g. root)
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2017-09-02 00:19:17 +08:00
|
|
|
- - ``EIO``
|
2016-12-16 17:22:08 +08:00
|
|
|
|
|
|
|
|
- I/O error. Typically used when there are problems communicating with
|
|
|
|
|
a hardware device. This could indicate broken or flaky hardware.
|
|
|
|
|
It's a 'Something is wrong, I give up!' type of error.
|
|
|
|
|
|
2017-09-02 00:20:12 +08:00
|
|
|
- - ``ENXIO``
|
|
|
|
|
|
|
|
|
|
- No device corresponding to this device special file exists.
|
|
|
|
|
|
|
|
|
|
|
2016-07-10 22:57:43 +08:00
|
|
|
.. note::
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2016-12-16 17:22:08 +08:00
|
|
|
#. This list is not exhaustive; ioctls may return other error codes.
|
2016-07-10 22:57:43 +08:00
|
|
|
Since errors may have side effects such as a driver reset,
|
|
|
|
|
applications should abort on unexpected errors, or otherwise
|
|
|
|
|
assume that the device is in a bad state.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2016-07-10 22:57:43 +08:00
|
|
|
#. Request-specific error codes are listed in the individual
|
|
|
|
|
requests descriptions.
|