Skip to content

Commit

Permalink
[media] gen-errors.rst: document EIO
Browse files Browse the repository at this point in the history
Document the EIO error since this can happen anywhere anytime and applications
should be aware of this.

Also fix typo: exaustive -> exhaustive

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
  • Loading branch information
hverkuil authored and mchehab committed Jan 30, 2017
1 parent 6ab1a32 commit 05a8973
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion Documentation/media/uapi/gen-errors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,17 @@ Generic Error Codes
- Permission denied. Can be returned if the device needs write
permission, or some special capabilities is needed (e. g. root)

- .. row 11

- ``EIO``

- 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.

.. note::

#. This list is not exaustive; ioctls may return other error codes.
#. This list is not exhaustive; ioctls may return other error codes.
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.
Expand Down

0 comments on commit 05a8973

Please sign in to comment.