Skip to content

Commit a5113ac

Browse files
pinchartlHans Verkuil
authored andcommitted
media: docs: uAPI: Expand error documentation for invalid 'which' value
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 <[email protected]> Signed-off-by: Hans Verkuil <[email protected]>
1 parent 2b455a5 commit a5113ac

File tree

4 files changed

+13
-15
lines changed

4 files changed

+13
-15
lines changed

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,7 @@ appropriately. The generic error codes are described at the
107107
:ref:`Generic Error Codes <gen-errors>` chapter.
108108

109109
EINVAL
110-
The struct
111-
:c:type:`v4l2_subdev_frame_interval_enum`
112-
``pad`` references a non-existing pad, one of the ``code``,
113-
``width`` or ``height`` fields are invalid for the given pad or the
114-
``index`` field is out of bounds.
110+
The struct :c:type:`v4l2_subdev_frame_interval_enum` ``pad`` references a
111+
non-existing pad, the ``which`` field has an unsupported value, one of the
112+
``code``, ``width`` or ``height`` fields are invalid for the given pad, or
113+
the ``index`` field is out of bounds.

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,6 @@ appropriately. The generic error codes are described at the
126126
:ref:`Generic Error Codes <gen-errors>` chapter.
127127

128128
EINVAL
129-
The struct
130-
:c:type:`v4l2_subdev_frame_size_enum`
131-
``pad`` references a non-existing pad, the ``code`` is invalid for
132-
the given pad or the ``index`` field is out of bounds.
129+
The struct :c:type:`v4l2_subdev_frame_size_enum` ``pad`` references a
130+
non-existing pad, the ``which`` field has an unsupported value, the ``code``
131+
is invalid for the given pad, or the ``index`` field is out of bounds.

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,6 @@ appropriately. The generic error codes are described at the
158158
:ref:`Generic Error Codes <gen-errors>` chapter.
159159

160160
EINVAL
161-
The struct
162-
:c:type:`v4l2_subdev_mbus_code_enum`
163-
``pad`` references a non-existing pad, or the ``index`` field is out
164-
of bounds.
161+
The struct :c:type:`v4l2_subdev_mbus_code_enum` ``pad`` references a
162+
non-existing pad, the ``which`` field has an unsupported value, or the
163+
``index`` field is out of bounds.

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,9 @@ ENOSPC
140140
all the available routes the subdevice exposes.
141141

142142
EINVAL
143-
The sink or source pad identifiers reference a non-existing pad, or reference
144-
pads of different types (ie. the sink_pad identifiers refers to a source pad).
143+
The sink or source pad identifiers reference a non-existing pad or reference
144+
pads of different types (ie. the sink_pad identifiers refers to a source
145+
pad), or the ``which`` field has an unsupported value.
145146

146147
E2BIG
147148
The application provided ``num_routes`` for ``VIDIOC_SUBDEV_S_ROUTING`` is

0 commit comments

Comments
 (0)