Commit 56683d7d authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] docs-rst: fix cross-references for videodev2.h

There are several broken references there, due to the conversion to
C domain. Fix them using this shell script and manually adjust what's
broken:

	# funcs is a file with the broken functions/references
	for i in $(cat funcs|sort|uniq|perl -ne 'print "$1\n" if (m/(\S+)$/)'); do
		i=${i//-/_}
		echo $i
		j=${i//_/-}
		for k in $(git grep -l "_$j:" Documentation/); do
			sed s,\_$j\:,"c\:type\:\: $i", <$k >a && mv a $k
		done
		for k in $(git grep -l "$j" Documentation/media/*.exceptions); do
			sed s,$j,":c\:type\:\`$i\`", <$k >a && mv a $k
		done
		for k in $(git grep -l "$j" Documentation/); do
			sed "s,:ref:\`$i <$j>\`,:c:type:\`$i\`," <$k >a && mv a $k
			sed "s,:ref:\`$j\`,:c:type:\`$i\`," <$k >a && mv a $k
			sed -E "s,:ref:\`(.*)<$j>\`,:c:type:\`\1<$i>\`," <$k >a && mv a $k
		done
		for k in $(git grep -l "<$j>" include/media); do
			sed -E "s,:ref:\`(.*)<$j>\`,enum \&$i," <$k >a && mv a $k
		done
	done
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent be831b34
......@@ -74,7 +74,7 @@ struct v4l2_buffer
- Type of the buffer, same as struct
:c:type:`v4l2_format` ``type`` or struct
:c:type:`v4l2_requestbuffers` ``type``, set
by the application. See :ref:`v4l2-buf-type`
by the application. See :c:type:`v4l2_buf_type`
- .. row 3
......@@ -110,7 +110,7 @@ struct v4l2_buffer
-
- Indicates the field order of the image in the buffer, see
:ref:`v4l2-field`. This field is not used when the buffer
:c:type:`v4l2_field`. This field is not used when the buffer
contains VBI data. Drivers must set it when ``type`` refers to a
capture stream, applications when it refers to an output stream.
......@@ -142,7 +142,7 @@ struct v4l2_buffer
- When ``type`` is ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` and the
``V4L2_BUF_FLAG_TIMECODE`` flag is set in ``flags``, this
structure contains a frame timecode. In
:ref:`V4L2_FIELD_ALTERNATE <v4l2-field>` mode the top and
:c:type:`V4L2_FIELD_ALTERNATE <v4l2_field>` mode the top and
bottom field contain the same timecode. Timecodes are intended to
help video editing and are typically recorded on video tapes, but
also embedded in compressed formats like MPEG. This field is
......@@ -162,7 +162,7 @@ struct v4l2_buffer
- :cspan:`3`
In :ref:`V4L2_FIELD_ALTERNATE <v4l2-field>` mode the top and
In :c:type:`V4L2_FIELD_ALTERNATE <v4l2_field>` mode the top and
bottom field have the same sequence number. The count starts at
zero and includes dropped or repeated frames. A dropped frame was
received by an input device but could not be stored due to lack of
......@@ -187,7 +187,7 @@ struct v4l2_buffer
-
- This field must be set by applications and/or drivers in
accordance with the selected I/O method. See :ref:`v4l2-memory`
accordance with the selected I/O method. See :c:type:`v4l2_memory`
- .. row 11
......@@ -402,7 +402,7 @@ struct v4l2_plane
.. _v4l2-buf-type:
.. c:type:: v4l2_buf_type
enum v4l2_buf_type
==================
......@@ -773,7 +773,7 @@ Buffer Flags
.. _v4l2-memory:
.. c:type:: v4l2_memory
enum v4l2_memory
================
......
......@@ -52,11 +52,11 @@ this end applications initialize the ``field`` field of struct
should have the value ``V4L2_FIELD_ANY`` (0).
.. _v4l2-field:
enum v4l2_field
===============
.. c:type:: v4l2_field
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
.. flat-table::
......
......@@ -438,7 +438,7 @@ This unnamed version was finally merged into Linux 2.5.46.
``VIDIOC_S_FMT`` and ``VIDIOC_TRY_FMT``; ioctl. The ``VIDIOC_G_WIN``
and ``VIDIOC_S_WIN`` ioctls to prepare for a video overlay were
removed. The ``type`` field changed to type enum
:ref:`v4l2_buf_type <v4l2-buf-type>` and the buffer type names
:c:type:`v4l2_buf_type` and the buffer type names
changed as follows.
......@@ -452,7 +452,7 @@ This unnamed version was finally merged into Linux 2.5.46.
- Old defines
- enum :ref:`v4l2_buf_type <v4l2-buf-type>`
- enum :c:type:`v4l2_buf_type`
- .. row 2
......@@ -534,7 +534,7 @@ This unnamed version was finally merged into Linux 2.5.46.
10. In struct :c:type:`v4l2_fmtdesc` a enum
:ref:`v4l2_buf_type <v4l2-buf-type>` field named ``type`` was
:c:type:`v4l2_buf_type` field named ``type`` was
added as in struct :c:type:`v4l2_format`. The
``VIDIOC_ENUM_FBUFFMT`` ioctl is no longer needed and was removed.
These calls can be replaced by
......@@ -555,7 +555,7 @@ This unnamed version was finally merged into Linux 2.5.46.
itself was removed.
The interlace flags were replaced by a enum
:ref:`v4l2_field <v4l2-field>` value in a newly added ``field``
:c:type:`v4l2_field` value in a newly added ``field``
field.
......@@ -569,7 +569,7 @@ This unnamed version was finally merged into Linux 2.5.46.
- Old flag
- enum :ref:`v4l2_field <v4l2-field>`
- enum :c:type:`v4l2_field`
- .. row 2
......@@ -615,23 +615,23 @@ This unnamed version was finally merged into Linux 2.5.46.
The color space flags were replaced by a enum
:ref:`v4l2_colorspace <v4l2-colorspace>` value in a newly added
:c:type:`v4l2_colorspace` value in a newly added
``colorspace`` field, where one of ``V4L2_COLORSPACE_SMPTE170M``,
``V4L2_COLORSPACE_BT878``, ``V4L2_COLORSPACE_470_SYSTEM_M`` or
``V4L2_COLORSPACE_470_SYSTEM_BG`` replaces ``V4L2_FMT_CS_601YUV``.
12. In struct :c:type:`v4l2_requestbuffers` the
``type`` field was properly defined as enum
:ref:`v4l2_buf_type <v4l2-buf-type>`. Buffer types changed as
:c:type:`v4l2_buf_type`. Buffer types changed as
mentioned above. A new ``memory`` field of type enum
:ref:`v4l2_memory <v4l2-memory>` was added to distinguish between
:c:type:`v4l2_memory` was added to distinguish between
I/O methods using buffers allocated by the driver or the
application. See :ref:`io` for details.
13. In struct :c:type:`v4l2_buffer` the ``type`` field was
properly defined as enum :ref:`v4l2_buf_type <v4l2-buf-type>`.
properly defined as enum :c:type:`v4l2_buf_type`.
Buffer types changed as mentioned above. A ``field`` field of type
enum :ref:`v4l2_field <v4l2-field>` was added to indicate if a
enum :c:type:`v4l2_field` was added to indicate if a
buffer contains a top or bottom field. The old field flags were
removed. Since no unadjusted system time clock was added to the
kernel as planned, the ``timestamp`` field changed back from type
......@@ -639,7 +639,7 @@ This unnamed version was finally merged into Linux 2.5.46.
nanoseconds, to struct :c:type:`timeval`. With the addition
of a second memory mapping method the ``offset`` field moved into
union ``m``, and a new ``memory`` field of type enum
:ref:`v4l2_memory <v4l2-memory>` was added to distinguish between
:c:type:`v4l2_memory` was added to distinguish between
I/O methods. See :ref:`io` for details.
The ``V4L2_BUF_REQ_CONTIG`` flag was used by the V4L compatibility
......@@ -667,7 +667,7 @@ This unnamed version was finally merged into Linux 2.5.46.
16. In struct :c:type:`v4l2_window` the ``x``, ``y``,
``width`` and ``height`` field moved into a ``w`` substructure as
above. A ``field`` field of type %v4l2-field; was added to
above. A ``field`` field of type :c:type:`v4l2_field` was added to
distinguish between field and frame (interlaced) overlay.
17. The digital zoom interface, including struct
......@@ -1029,7 +1029,7 @@ V4L2 in Linux 2.6.22
====================
1. Two new field orders ``V4L2_FIELD_INTERLACED_TB`` and
``V4L2_FIELD_INTERLACED_BT`` were added. See :ref:`v4l2-field` for
``V4L2_FIELD_INTERLACED_BT`` were added. See :c:type:`v4l2_field` for
details.
2. Three new clipping/blending methods with a global or straight or
......@@ -1357,8 +1357,8 @@ V4L2 in Linux 3.19
==================
1. Rewrote Colorspace chapter, added new enum
:ref:`v4l2_ycbcr_encoding <v4l2-ycbcr-encoding>` and enum
:ref:`v4l2_quantization <v4l2-quantization>` fields to struct
:c:type:`v4l2_ycbcr_encoding` and enum
:c:type:`v4l2_quantization` fields to struct
:c:type:`v4l2_pix_format`, struct
:c:type:`v4l2_pix_format_mplane` and
struct :c:type:`v4l2_mbus_framefmt`.
......
......@@ -61,7 +61,7 @@ Single-planar format structure
- .. row 5
- enum :ref:`v4l2_field <v4l2-field>`
- enum :c:type::`v4l2_field`
- ``field``
......@@ -121,7 +121,7 @@ Single-planar format structure
- .. row 9
- enum :ref:`v4l2_colorspace <v4l2-colorspace>`
- enum :c:type:`v4l2_colorspace`
- ``colorspace``
......@@ -170,7 +170,7 @@ Single-planar format structure
- .. row 12
- enum :ref:`v4l2_ycbcr_encoding <v4l2-ycbcr-encoding>`
- enum :c:type:`v4l2_ycbcr_encoding`
- ``ycbcr_enc``
......@@ -180,7 +180,7 @@ Single-planar format structure
- .. row 13
- enum :ref:`v4l2_quantization <v4l2-quantization>`
- enum :c:type:`v4l2_quantization`
- ``quantization``
......@@ -190,7 +190,7 @@ Single-planar format structure
- .. row 14
- enum :ref:`v4l2_xfer_func <v4l2-xfer-func>`
- enum :c:type:`v4l2_xfer_func`
- ``xfer_func``
......
......@@ -88,7 +88,7 @@ describing all planes of that format.
- .. row 4
- enum :ref:`v4l2_field <v4l2-field>`
- enum :c:type:`v4l2_field`
- ``field``
......@@ -96,7 +96,7 @@ describing all planes of that format.
- .. row 5
- enum :ref:`v4l2_colorspace <v4l2-colorspace>`
- enum :c:type:`v4l2_colorspace`
- ``colorspace``
......@@ -131,7 +131,7 @@ describing all planes of that format.
- .. row 9
- enum :ref:`v4l2_ycbcr_encoding <v4l2-ycbcr-encoding>`
- enum :c:type:`v4l2_ycbcr_encoding`
- ``ycbcr_enc``
......@@ -141,7 +141,7 @@ describing all planes of that format.
- .. row 10
- enum :ref:`v4l2_quantization <v4l2-quantization>`
- enum :c:type:`v4l2_quantization`
- ``quantization``
......@@ -151,7 +151,7 @@ describing all planes of that format.
- .. row 11
- enum :ref:`v4l2_xfer_func <v4l2-xfer-func>`
- enum :c:type:`v4l2_xfer_func`
- ``xfer_func``
......
......@@ -5,15 +5,15 @@ Defining Colorspaces in V4L2
****************************
In V4L2 colorspaces are defined by four values. The first is the
colorspace identifier (enum :ref:`v4l2_colorspace <v4l2-colorspace>`)
colorspace identifier (enum :c:type:`v4l2_colorspace`)
which defines the chromaticities, the default transfer function, the
default Y'CbCr encoding and the default quantization method. The second
is the transfer function identifier (enum
:ref:`v4l2_xfer_func <v4l2-xfer-func>`) to specify non-standard
:c:type:`v4l2_xfer_func`) to specify non-standard
transfer functions. The third is the Y'CbCr encoding identifier (enum
:ref:`v4l2_ycbcr_encoding <v4l2-ycbcr-encoding>`) to specify
:c:type:`v4l2_ycbcr_encoding`) to specify
non-standard Y'CbCr encodings and the fourth is the quantization
identifier (enum :ref:`v4l2_quantization <v4l2-quantization>`) to
identifier (enum :c:type:`v4l2_quantization`) to
specify non-standard quantization methods. Most of the time only the
colorspace field of struct :c:type:`v4l2_pix_format`
or struct :c:type:`v4l2_pix_format_mplane`
......@@ -27,7 +27,7 @@ needs to be filled in.
.. tabularcolumns:: |p{6.0cm}|p{11.5cm}|
.. _v4l2-colorspace:
.. c:type:: v4l2_colorspace
.. flat-table:: V4L2 Colorspaces
:header-rows: 1
......@@ -119,7 +119,7 @@ needs to be filled in.
.. _v4l2-xfer-func:
.. c:type:: v4l2_xfer_func
.. flat-table:: V4L2 Transfer Function
:header-rows: 1
......@@ -182,7 +182,7 @@ needs to be filled in.
.. _v4l2-ycbcr-encoding:
.. c:type:: v4l2_ycbcr_encoding
.. tabularcolumns:: |p{6.5cm}|p{11.0cm}|
......@@ -247,7 +247,7 @@ needs to be filled in.
.. _v4l2-quantization:
.. c:type:: v4l2_quantization
.. tabularcolumns:: |p{6.5cm}|p{11.0cm}|
......
......@@ -22,7 +22,7 @@ application can choose whether to use one or the other by passing a
corresponding buffer type to its ioctl calls. Multi-planar versions of
buffer types are suffixed with an ``_MPLANE`` string. For a list of
available multi-planar buffer types see enum
:ref:`v4l2_buf_type <v4l2-buf-type>`.
:c:type:`v4l2_buf_type`.
Multi-planar formats
......
......@@ -46,7 +46,7 @@ Media Bus Formats
- ``field``
- Field order, from enum :ref:`v4l2_field <v4l2-field>`. See
- Field order, from enum :c:type:`v4l2_field`. See
:ref:`field-order` for details.
- .. row 5
......@@ -56,12 +56,12 @@ Media Bus Formats
- ``colorspace``
- Image colorspace, from enum
:ref:`v4l2_colorspace <v4l2-colorspace>`. See
:c:type:`v4l2_colorspace`. See
:ref:`colorspaces` for details.
- .. row 6
- enum :ref:`v4l2_ycbcr_encoding <v4l2-ycbcr-encoding>`
- enum :c:type:`v4l2_ycbcr_encoding`
- ``ycbcr_enc``
......@@ -71,7 +71,7 @@ Media Bus Formats
- .. row 7
- enum :ref:`v4l2_quantization <v4l2-quantization>`
- enum :c:type:`v4l2_quantization`
- ``quantization``
......@@ -81,7 +81,7 @@ Media Bus Formats
- .. row 8
- enum :ref:`v4l2_xfer_func <v4l2-xfer-func>`
- enum :c:type:`v4l2_xfer_func`
- ``xfer_func``
......
......@@ -33,8 +33,8 @@ current video or radio input is queried.
:ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` does not switch the
current tuner, when there is more than one at all. The tuner is solely
determined by the current video input. Drivers must support both ioctls
and set the ``V4L2_CAP_TUNER`` flag in the struct :ref:`v4l2_capability
<v4l2-capability>` returned by the :ref:`VIDIOC_QUERYCAP` ioctl when the
and set the ``V4L2_CAP_TUNER`` flag in the struct :c:type:`v4l2_capability`
returned by the :ref:`VIDIOC_QUERYCAP` ioctl when the
device has one or more tuners.
......
......@@ -112,8 +112,8 @@ DVB device nodes. Add support for Tuner sub-device.
:revision: 3.19 / 2014-12-05 (*hv*)
Rewrote Colorspace chapter, added new enum
:ref:`v4l2_ycbcr_encoding <v4l2-ycbcr-encoding>` and enum
:ref:`v4l2_quantization <v4l2-quantization>` fields to struct
:c:type:`v4l2_ycbcr_encoding` and enum
:c:type:`v4l2_quantization` fields to struct
:c:type:`v4l2_pix_format`, struct
:c:type:`v4l2_pix_format_mplane` and struct
:c:type:`v4l2_mbus_framefmt`.
......
......@@ -111,7 +111,7 @@ than the number requested.
- Applications set this field to ``V4L2_MEMORY_MMAP``,
``V4L2_MEMORY_DMABUF`` or ``V4L2_MEMORY_USERPTR``. See
:ref:`v4l2-memory`
:c:type:`v4l2_memory`
- .. row 4
......
......@@ -69,7 +69,7 @@ overlay devices.
- Type of the data stream, set by the application. Only these types
are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``,
``V4L2_BUF_TYPE_VIDEO_OUTPUT`` and
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :ref:`v4l2-buf-type`.
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
- .. row 2
......
......@@ -144,7 +144,7 @@ instructions.
- ``match``
- How to match the chip, see :ref:`v4l2-dbg-match`.
- How to match the chip, see :c:type:`v4l2_dbg_match`.
- .. row 2
......
......@@ -324,7 +324,7 @@ call.
- ``field``
- The upcoming field. See enum :ref:`v4l2_field <v4l2-field>`.
- The upcoming field. See enum :c:type:`v4l2_field`.
......
......@@ -73,7 +73,7 @@ one until ``EINVAL`` is returned.
``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``,
``V4L2_BUF_TYPE_VIDEO_OUTPUT``,
``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE`` and
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :ref:`v4l2-buf-type`.
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
- .. row 3
......
......@@ -231,7 +231,7 @@ Enums
=====
.. _v4l2-frmivaltypes:
.. c:type:: v4l2_frmivaltypes
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
......
......@@ -254,7 +254,7 @@ Enums
=====
.. _v4l2-frmsizetypes:
.. c:type:: v4l2_frmsizetypes
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
......
......@@ -75,7 +75,7 @@ of the corresponding tuner/modulator is set.
set to ``V4L2_TUNER_RADIO`` for ``/dev/radioX`` device nodes, and
to ``V4L2_TUNER_ANALOG_TV`` for all others. Set this field to
``V4L2_TUNER_RADIO`` for modulators (currently only radio
modulators are supported). See :ref:`v4l2-tuner-type`
modulators are supported). See :c:type:`v4l2_tuner_type`
- .. row 3
......
......@@ -133,7 +133,7 @@ Examples
- Type of the buffer, same as struct
:c:type:`v4l2_format` ``type`` or struct
:c:type:`v4l2_requestbuffers` ``type``, set
by the application. See :ref:`v4l2-buf-type`
by the application. See :c:type:`v4l2_buf_type`
- .. row 2
......
......@@ -94,7 +94,7 @@ When cropping is not supported then no parameters are changed and
- Type of the data stream, set by the application. Only these types
are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``,
``V4L2_BUF_TYPE_VIDEO_OUTPUT`` and
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :ref:`v4l2-buf-type`.
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
- .. row 2
......
......@@ -97,7 +97,7 @@ the EDID data in some way. In any case, the end result is the same: the
EDID is no longer available.
.. _v4l2-edid:
.. c:type:: v4l2_edid
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
......
......@@ -200,7 +200,7 @@ destructive video overlay.
- .. row 12
-
- enum :ref:`v4l2_field <v4l2-field>`
- enum :c:type:`v4l2_field`
- ``field``
......@@ -266,7 +266,7 @@ destructive video overlay.
- .. row 16
-
- enum :ref:`v4l2_colorspace <v4l2-colorspace>`
- enum :c:type:`v4l2_colorspace`
- ``colorspace``
......
......@@ -101,7 +101,7 @@ The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical
- ``type``
-
- Type of the data stream, see :ref:`v4l2-buf-type`.
- Type of the data stream, see :c:type:`v4l2_buf_type`.
- .. row 2
......
......@@ -85,7 +85,7 @@ write-only ioctl, it does not return the actual new frequency.
set to ``V4L2_TUNER_RADIO`` for ``/dev/radioX`` device nodes, and
to ``V4L2_TUNER_ANALOG_TV`` for all others. Set this field to
``V4L2_TUNER_RADIO`` for modulators (currently only radio
modulators are supported). See :ref:`v4l2-tuner-type`
modulators are supported). See :c:type:`v4l2_tuner_type`
- .. row 3
......
......@@ -147,7 +147,7 @@ To change the radio frequency the
- ``type``
- :cspan:`2` Type of the modulator, see :ref:`v4l2-tuner-type`.
- :cspan:`2` Type of the modulator, see :c:type:`v4l2_tuner_type`.
- .. row 8
......
......@@ -70,7 +70,7 @@ union holding separate parameters for input and output devices.
-
- The buffer (stream) type, same as struct
:c:type:`v4l2_format` ``type``, set by the
application. See :ref:`v4l2-buf-type`
application. See :c:type:`v4l2_buf_type`
- .. row 2
......
......@@ -157,7 +157,7 @@ Selection targets and flags are documented in
- ``type``
- Type of the buffer (from enum
:ref:`v4l2_buf_type <v4l2-buf-type>`).
:c:type:`v4l2_buf_type`).
- .. row 2
......
......@@ -158,7 +158,7 @@ the sliced VBI API is unsupported or ``type`` is invalid.
- ``type``
- Type of the data stream, see :ref:`v4l2-buf-type`. Should be
- Type of the data stream, see :c:type:`v4l2_buf_type`. Should be
``V4L2_BUF_TYPE_SLICED_VBI_CAPTURE`` or
``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT``.
......
......@@ -96,7 +96,7 @@ To change the radio frequency the
- ``type``
- :cspan:`1` Type of the tuner, see :ref:`v4l2-tuner-type`.
- :cspan:`1` Type of the tuner, see :c:type:`v4l2_tuner_type`.
- .. row 4
......@@ -263,7 +263,7 @@ To change the radio frequency the
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
.. _v4l2-tuner-type:
.. c:type:: v4l2_tuner_type
.. flat-table:: enum v4l2_tuner_type
:header-rows: 0
......
......@@ -436,5 +436,5 @@ appropriately. The generic error codes are described at the
.. [#f1]
The struct :c:type:`v4l2_framebuffer` lacks an
enum :ref:`v4l2_buf_type <v4l2-buf-type>` field, therefore the
enum :c:type:`v4l2_buf_type` field, therefore the
type of overlay is implied by the driver capabilities.
......@@ -124,7 +124,7 @@ See also the examples in :ref:`control`.
- ``type``
- Type of control, see :ref:`v4l2-ctrl-type`.
- Type of control, see :c:type:`v4l2_ctrl_type`.
- .. row 3
......@@ -251,7 +251,7 @@ See also the examples in :ref:`control`.
- ``type``
- Type of control, see :ref:`v4l2-ctrl-type`.
- Type of control, see :c:type:`v4l2_ctrl_type`.
- .. row 3
......
......@@ -91,7 +91,7 @@ any DMA in progress, an implicit
- Type of the stream or buffers, this is the same as the struct
:c:type:`v4l2_format` ``type`` field. See
:ref:`v4l2-buf-type` for valid values.
:c:type:`v4l2_buf_type` for valid values.
- .. row 3
......@@ -101,7 +101,7 @@ any DMA in progress, an implicit
- Applications set this field to ``V4L2_MEMORY_MMAP``,
``V4L2_MEMORY_DMABUF`` or ``V4L2_MEMORY_USERPTR``. See
:ref:`v4l2-memory`.
:c:type:`v4l2_memory`.
- .. row 4
......
......@@ -87,7 +87,7 @@ error code is returned and no seek takes place.
- The tuner type. This is the same value as in the struct
:c:type:`v4l2_tuner` ``type`` field. See
:ref:`v4l2-tuner-type`
:c:type:`v4l2_tuner_type`
- .. row 3
......
......@@ -43,7 +43,7 @@ when enumerating frame intervals.
To enumerate frame intervals applications initialize the ``index``,
``pad``, ``which``, ``code``, ``width`` and ``height`` fields of struct
:ref:`v4l2_subdev_frame_interval_enum <v4l2-subdev-frame-interval-enum>`
:c:type:`v4l2_subdev_frame_interval_enum`
and call the :ref:`VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL` ioctl with a pointer
to this structure. Drivers fill the rest of the structure or return an
EINVAL error code if one of the input fields is invalid. All frame
......@@ -59,8 +59,7 @@ Sub-devices that support the frame interval enumeration ioctl should
implemented it on a single pad only. Its behaviour when supported on
multiple pads of the same sub-device is not defined.
.. _v4l2-subdev-frame-interval-enum:
.. c:type:: v4l2_subdev_frame_interval_enum
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
......@@ -147,7 +146,7 @@ appropriately. The generic error codes are described at the
EINVAL
The struct
:ref:`v4l2_subdev_frame_interval_enum <v4l2-subdev-frame-interval-enum>`
:c:type:`v4l2_subdev_frame_interval_enum`
``pad`` references a non-existing pad, one of the ``code``,
``width`` or ``height`` fields are invalid for the given pad or the
``index`` field is out of bounds.
......@@ -39,7 +39,7 @@ ioctl.
To enumerate frame sizes applications initialize the ``pad``, ``which``
, ``code`` and ``index`` fields of the struct
:ref:`v4l2_subdev_mbus_code_enum <v4l2-subdev-mbus-code-enum>` and
:c:type:`v4l2_subdev_mbus_code_enum` and
call the :ref:`VIDIOC_SUBDEV_ENUM_FRAME_SIZE` ioctl with a pointer to the
structure. Drivers fill the minimum and maximum frame sizes or return an
EINVAL error code if one of the input parameters is invalid.
......@@ -62,7 +62,7 @@ current values of V4L2 controls. See
information about try formats.
.. _v4l2-subdev-frame-size-enum:
.. c:type:: v4l2_subdev_frame_size_enum
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
......@@ -157,6 +157,6 @@ appropriately. The generic error codes are described at the
EINVAL
The struct
:ref:`v4l2_subdev_frame_size_enum <v4l2-subdev-frame-size-enum>`
:c:type:`v4l2_subdev_frame_size_enum`
``pad`` references a non-existing pad, the ``code`` is invalid for
the given pad or the ``index`` field is out of bounds.
......@@ -34,7 +34,7 @@ Description
To enumerate media bus formats available at a given sub-device pad
applications initialize the ``pad``, ``which`` and ``index`` fields of
struct
:ref:`v4l2_subdev_mbus_code_enum <v4l2-subdev-mbus-code-enum>` and
:c:type:`v4l2_subdev_mbus_code_enum` and
call the :ref:`VIDIOC_SUBDEV_ENUM_MBUS_CODE` ioctl with a pointer to this
structure. Drivers fill the rest of the structure or return an ``EINVAL``
error code if either the ``pad`` or ``index`` are invalid. All media bus
......@@ -47,7 +47,7 @@ See :ref:`VIDIOC_SUBDEV_G_FMT` for more
information about the try formats.
.. _v4l2-subdev-mbus-code-enum:
.. c:type:: v4l2_subdev_mbus_code_enum
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
......@@ -110,6 +110,6 @@ appropriately. The generic error codes are described at the
EINVAL
The struct
:ref:`v4l2_subdev_mbus_code_enum <v4l2-subdev-mbus-code-enum>`
:c:type:`v4l2_subdev_mbus_code_enum`
``pad`` references a non-existing pad, or the ``index`` field is out
of bounds.
......@@ -41,7 +41,7 @@ Description
:ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`.
To retrieve the current crop rectangle applications set the ``pad``
field of a struct :ref:`v4l2_subdev_crop <v4l2-subdev-crop>` to the
field of a struct :c:type:`v4l2_subdev_crop` to the
desired pad number as reported by the media API and the ``which`` field
to ``V4L2_SUBDEV_FORMAT_ACTIVE``. They then call the
``VIDIOC_SUBDEV_G_CROP`` ioctl with a pointer to this structure. The
......@@ -54,7 +54,7 @@ and ``which`` fields and all members of the ``rect`` field. They then
call the ``VIDIOC_SUBDEV_S_CROP`` ioctl with a pointer to this
structure. The driver verifies the requested crop rectangle, adjusts it
based on the hardware capabilities and configures the device. Upon
return the struct :ref:`v4l2_subdev_crop <v4l2-subdev-crop>`
return the struct :c:type:`v4l2_subdev_crop`
contains the current format as would be returned by a
``VIDIOC_SUBDEV_G_CROP`` call.
......@@ -71,7 +71,7 @@ modify the rectangle to match what the hardware can provide. The
modified format should be as close as possible to the original request.
.. _v4l2-subdev-crop:
.. c:type:: v4l2_subdev_crop
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
......@@ -131,7 +131,7 @@ EBUSY
``VIDIOC_SUBDEV_S_CROP``
EINVAL
The struct :ref:`v4l2_subdev_crop <v4l2-subdev-crop>` ``pad``
The struct :c:type:`v4l2_subdev_crop` ``pad``
references a non-existing pad, the ``which`` field references a
non-existing format, or cropping is not supported on the given
subdev pad.
......@@ -109,7 +109,7 @@ should be as close as possible to the original request.
- ``format``
- Definition of an image format, see :ref:`v4l2-mbus-framefmt` for
- Definition of an image format, see :c:type:`v4l2_mbus_framefmt` for
details.
- .. row 4
......
......@@ -42,7 +42,7 @@ don't support frame intervals must not implement these ioctls.
To retrieve the current frame interval applications set the ``pad``
field of a struct
:ref:`v4l2_subdev_frame_interval <v4l2-subdev-frame-interval>` to
:c:type:`v4l2_subdev_frame_interval` to
the desired pad number as reported by the media controller API. When
they call the ``VIDIOC_SUBDEV_G_FRAME_INTERVAL`` ioctl with a pointer to
this structure the driver fills the members of the ``interval`` field.
......@@ -53,7 +53,7 @@ field and all members of the ``interval`` field. When they call the
structure the driver verifies the requested interval, adjusts it based
on the hardware capabilities and configures the device. Upon return the
struct
:ref:`v4l2_subdev_frame_interval <v4l2-subdev-frame-interval>`
:c:type:`v4l2_subdev_frame_interval`
contains the current frame interval as would be returned by a
``VIDIOC_SUBDEV_G_FRAME_INTERVAL`` call.
......@@ -67,7 +67,7 @@ on a single pad only. Their behaviour when supported on multiple pads of
the same sub-device is not defined.
.. _v4l2-subdev-frame-interval:
.. c:type:: v4l2_subdev_frame_interval
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
......@@ -119,6 +119,6 @@ EBUSY
EINVAL
The struct
:ref:`v4l2_subdev_frame_interval <v4l2-subdev-frame-interval>`
:c:type:`v4l2_subdev_frame_interval`
``pad`` references a non-existing pad, or the pad doesn't support
frame intervals.
......@@ -65,7 +65,7 @@ Selection targets and flags are documented in
:ref:`v4l2-selections-common`.
.. _v4l2-subdev-selection:
.. c:type:: v4l2_subdev_selection
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
......@@ -141,7 +141,7 @@ EBUSY
``VIDIOC_SUBDEV_S_SELECTION``
EINVAL
The struct :ref:`v4l2_subdev_selection <v4l2-subdev-selection>`
The struct :c:type:`v4l2_subdev_selection`
``pad`` references a non-existing pad, the ``which`` field
references a non-existing format, or the selection target is not
supported on the given subdev pad.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment