summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab2016-08-29 22:37:59 +0200
committerMauro Carvalho Chehab2016-09-09 14:34:01 +0200
commite8be7e97e639af6f968473e5a598afbebc737b9c (patch)
treea33c38e32956ad127634eabb978f824ecbbb6c65 /Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst
parent[media] v4l2-ctrls: document some extra data structures (diff)
downloadkernel-qcow2-linux-e8be7e97e639af6f968473e5a598afbebc737b9c.tar.gz
kernel-qcow2-linux-e8be7e97e639af6f968473e5a598afbebc737b9c.tar.xz
kernel-qcow2-linux-e8be7e97e639af6f968473e5a598afbebc737b9c.zip
[media] docs-rst: convert uAPI structs to C domain
instead of declaring the uAPI structs using usual refs, e. g.: .. _foo-struct: Use the C domain way: .. c:type:: foo_struct This way, the kAPI documentation can use cross-references to point to the uAPI symbols. That solves about ~100 undefined warnings like: WARNING: c:type reference target not found: foo_struct Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst')
-rw-r--r--Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst22
1 files changed, 11 insertions, 11 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst
index efbe3a1f1134..e33969b9d3da 100644
--- a/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst
+++ b/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst
@@ -35,12 +35,12 @@ Start a hardware frequency seek from the current frequency. To do this
applications initialize the ``tuner``, ``type``, ``seek_upward``,
``wrap_around``, ``spacing``, ``rangelow`` and ``rangehigh`` fields, and
zero out the ``reserved`` array of a struct
-:ref:`v4l2_hw_freq_seek <v4l2-hw-freq-seek>` and call the
+:c:type:`v4l2_hw_freq_seek` and call the
``VIDIOC_S_HW_FREQ_SEEK`` ioctl with a pointer to this structure.
The ``rangelow`` and ``rangehigh`` fields can be set to a non-zero value
to tell the driver to search a specific band. If the struct
-:ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field has the
+:c:type:`v4l2_tuner` ``capability`` field has the
``V4L2_TUNER_CAP_HWSEEK_PROG_LIM`` flag set, these values must fall
within one of the bands returned by
:ref:`VIDIOC_ENUM_FREQ_BANDS`. If the
@@ -61,7 +61,7 @@ error code is returned and no seek takes place.
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
-.. _v4l2-hw-freq-seek:
+.. c:type:: v4l2_hw_freq_seek
.. flat-table:: struct v4l2_hw_freq_seek
:header-rows: 0
@@ -76,8 +76,8 @@ error code is returned and no seek takes place.
- ``tuner``
- The tuner index number. This is the same value as in the struct
- :ref:`v4l2_input <v4l2-input>` ``tuner`` field and the struct
- :ref:`v4l2_tuner <v4l2-tuner>` ``index`` field.
+ :c:type:`v4l2_input` ``tuner`` field and the struct
+ :c:type:`v4l2_tuner` ``index`` field.
- .. row 2
@@ -86,7 +86,7 @@ error code is returned and no seek takes place.
- ``type``
- The tuner type. This is the same value as in the struct
- :ref:`v4l2_tuner <v4l2-tuner>` ``type`` field. See
+ :c:type:`v4l2_tuner` ``type`` field. See
:ref:`v4l2-tuner-type`
- .. row 3
@@ -105,7 +105,7 @@ error code is returned and no seek takes place.
- ``wrap_around``
- If non-zero, wrap around when at the end of the frequency range,
- else stop seeking. The struct :ref:`v4l2_tuner <v4l2-tuner>`
+ else stop seeking. The struct :c:type:`v4l2_tuner`
``capability`` field will tell you what the hardware supports.
- .. row 5
@@ -126,9 +126,9 @@ error code is returned and no seek takes place.
- If non-zero, the lowest tunable frequency of the band to search in
units of 62.5 kHz, or if the struct
- :ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field has the
+ :c:type:`v4l2_tuner` ``capability`` field has the
``V4L2_TUNER_CAP_LOW`` flag set, in units of 62.5 Hz or if the
- struct :ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field has
+ struct :c:type:`v4l2_tuner` ``capability`` field has
the ``V4L2_TUNER_CAP_1HZ`` flag set, in units of 1 Hz. If
``rangelow`` is zero a reasonable default value is used.
@@ -140,9 +140,9 @@ error code is returned and no seek takes place.
- If non-zero, the highest tunable frequency of the band to search
in units of 62.5 kHz, or if the struct
- :ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field has the
+ :c:type:`v4l2_tuner` ``capability`` field has the
``V4L2_TUNER_CAP_LOW`` flag set, in units of 62.5 Hz or if the
- struct :ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field has
+ struct :c:type:`v4l2_tuner` ``capability`` field has
the ``V4L2_TUNER_CAP_1HZ`` flag set, in units of 1 Hz. If
``rangehigh`` is zero a reasonable default value is used.