Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-22 12:11:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

media: docs: uAPI: Expand error documentation for invalid 'which' value

Browse Source 
Multiple subdev ioctls that take a 'which' field do not document the
error returned when the field has an invalid value. Expand the
documentation to fix this.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
This commit is contained in:
Laurent Pinchart 2023-12-13 17:00:08 +02:00 committed by Hans Verkuil
parent 2b455a551f
commit a5113ac875
4 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/userspace-api/media/v4l/vidioc-subdev-enum-frame-interval.rst
View File

@ -107,8 +107,7 @@ appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
EINVAL EINVAL
The struct The struct :c:type:`v4l2_subdev_frame_interval_enum` ``pad`` references a
:c:type:`v4l2_subdev_frame_interval_enum` non-existing pad, the ``which`` field has an unsupported value, one of the
``pad`` references a non-existing pad, one of the ``code``, ``code``, ``width`` or ``height`` fields are invalid for the given pad, or
``width`` or ``height`` fields are invalid for the given pad or the the ``index`` field is out of bounds.
``index`` field is out of bounds.

7
Documentation/userspace-api/media/v4l/vidioc-subdev-enum-frame-size.rst
View File

@ -126,7 +126,6 @@ appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
EINVAL EINVAL
The struct The struct :c:type:`v4l2_subdev_frame_size_enum` ``pad`` references a
:c:type:`v4l2_subdev_frame_size_enum` non-existing pad, the ``which`` field has an unsupported value, the ``code``
``pad`` references a non-existing pad, the ``code`` is invalid for is invalid for the given pad, or the ``index`` field is out of bounds.
the given pad or the ``index`` field is out of bounds.

7
Documentation/userspace-api/media/v4l/vidioc-subdev-enum-mbus-code.rst
View File

@ -158,7 +158,6 @@ appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
EINVAL EINVAL
The struct The struct :c:type:`v4l2_subdev_mbus_code_enum` ``pad`` references a
:c:type:`v4l2_subdev_mbus_code_enum` non-existing pad, the ``which`` field has an unsupported value, or the
``pad`` references a non-existing pad, or the ``index`` field is out ``index`` field is out of bounds.
of bounds.

5
Documentation/userspace-api/media/v4l/vidioc-subdev-g-routing.rst
View File

@ -140,8 +140,9 @@ ENOSPC
all the available routes the subdevice exposes. all the available routes the subdevice exposes.
EINVAL EINVAL
The sink or source pad identifiers reference a non-existing pad, or reference The sink or source pad identifiers reference a non-existing pad or reference
pads of different types (ie. the sink_pad identifiers refers to a source pad). pads of different types (ie. the sink_pad identifiers refers to a source
pad), or the ``which`` field has an unsupported value.
E2BIG E2BIG
The application provided ``num_routes`` for ``VIDIOC_SUBDEV_S_ROUTING`` is The application provided ``num_routes`` for ``VIDIOC_SUBDEV_S_ROUTING`` is