Skip to content

L
linux
Commit 70b5efb8 authored by Antti Palosaari's avatar Antti Palosaari Committed by Mauro Carvalho Chehab
Browse files
Options

[media] DocBook: document 1 Hz flag 

Update documentation to reflect 1 Hz frequency step flag.

Cc: Hans Verkuil <hverkuil@xs4all.nl>
Signed-off-by: default avatarAntti Palosaari <crope@iki.fi>
Acked-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <m.chehab@samsung.com>
parent bfffd743
Hide whitespace changes
Inline Side-by-side
Showing with 30 additions and 12 deletions
Documentation/DocBook/media/v4l/vidioc-enum-freq-bands.xml
View file @ 70b5efb8
...@@ -100,7 +100,7 @@ See <xref linkend="v4l2-tuner-type" /></entry> ...@@ -100,7 +100,7 @@ See <xref linkend="v4l2-tuner-type" /></entry>
<entry><structfield>capability</structfield></entry> <entry><structfield>capability</structfield></entry>
<entry spanname="hspan">The tuner/modulator capability flags for <entry spanname="hspan">The tuner/modulator capability flags for
this frequency band, see <xref linkend="tuner-capability" />. The <constant>V4L2_TUNER_CAP_LOW</constant> this frequency band, see <xref linkend="tuner-capability" />. The <constant>V4L2_TUNER_CAP_LOW</constant>
capability must be the same for all frequency bands of the selected tuner/modulator. or <constant>V4L2_TUNER_CAP_1HZ</constant> capability must be the same for all frequency bands of the selected tuner/modulator.
So either all bands have that capability set, or none of them have that capability.</entry> So either all bands have that capability set, or none of them have that capability.</entry>
</row> </row>
<row> <row>
...@@ -109,7 +109,8 @@ So either all bands have that capability set, or none of them have that capabili ...@@ -109,7 +109,8 @@ So either all bands have that capability set, or none of them have that capabili
<entry spanname="hspan">The lowest tunable frequency in <entry spanname="hspan">The lowest tunable frequency in
units of 62.5 kHz, or if the <structfield>capability</structfield> units of 62.5 kHz, or if the <structfield>capability</structfield>
flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5
Hz, for this frequency band.</entry> Hz, for this frequency band. A 1 Hz unit is used when the <structfield>capability</structfield> flag
<constant>V4L2_TUNER_CAP_1HZ</constant> is set.</entry>
</row> </row>
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
...@@ -117,7 +118,8 @@ Hz, for this frequency band.</entry> ...@@ -117,7 +118,8 @@ Hz, for this frequency band.</entry>
<entry spanname="hspan">The highest tunable frequency in <entry spanname="hspan">The highest tunable frequency in
units of 62.5 kHz, or if the <structfield>capability</structfield> units of 62.5 kHz, or if the <structfield>capability</structfield>
flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5
Hz, for this frequency band.</entry> Hz, for this frequency band. A 1 Hz unit is used when the <structfield>capability</structfield> flag
<constant>V4L2_TUNER_CAP_1HZ</constant> is set.</entry>
</row> </row>
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
......
Documentation/DocBook/media/v4l/vidioc-g-frequency.xml
View file @ 70b5efb8
...@@ -109,9 +109,10 @@ See <xref linkend="v4l2-tuner-type" /></entry> ...@@ -109,9 +109,10 @@ See <xref linkend="v4l2-tuner-type" /></entry>
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>frequency</structfield></entry> <entry><structfield>frequency</structfield></entry>
<entry>Tuning frequency in units of 62.5 kHz, or if the <entry>Tuning frequency in units of 62.5 kHz, or if the
&v4l2-tuner; or &v4l2-modulator; <structfield>capabilities</structfield> flag &v4l2-tuner; or &v4l2-modulator; <structfield>capability</structfield> flag
<constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5
Hz.</entry> Hz. A 1 Hz unit is used when the <structfield>capability</structfield> flag
<constant>V4L2_TUNER_CAP_1HZ</constant> is set.</entry>
</row> </row>
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
......
Documentation/DocBook/media/v4l/vidioc-g-modulator.xml
View file @ 70b5efb8
...@@ -113,7 +113,8 @@ change for example with the current video standard.</entry> ...@@ -113,7 +113,8 @@ change for example with the current video standard.</entry>
<entry>The lowest tunable frequency in units of 62.5 <entry>The lowest tunable frequency in units of 62.5
KHz, or if the <structfield>capability</structfield> flag KHz, or if the <structfield>capability</structfield> flag
<constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5
Hz.</entry> Hz, or if the <structfield>capability</structfield> flag
<constant>V4L2_TUNER_CAP_1HZ</constant> is set, in units of 1 Hz.</entry>
</row> </row>
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
...@@ -121,7 +122,8 @@ Hz.</entry> ...@@ -121,7 +122,8 @@ Hz.</entry>
<entry>The highest tunable frequency in units of 62.5 <entry>The highest tunable frequency in units of 62.5
KHz, or if the <structfield>capability</structfield> flag KHz, or if the <structfield>capability</structfield> flag
<constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5
Hz.</entry> Hz, or if the <structfield>capability</structfield> flag
<constant>V4L2_TUNER_CAP_1HZ</constant> is set, in units of 1 Hz.</entry>
</row> </row>
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
......
Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
View file @ 70b5efb8
...@@ -134,7 +134,9 @@ the structure refers to a radio tuner the ...@@ -134,7 +134,9 @@ the structure refers to a radio tuner the
<entry spanname="hspan">The lowest tunable frequency in <entry spanname="hspan">The lowest tunable frequency in
units of 62.5 kHz, or if the <structfield>capability</structfield> units of 62.5 kHz, or if the <structfield>capability</structfield>
flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5
Hz. If multiple frequency bands are supported, then Hz, or if the <structfield>capability</structfield> flag
<constant>V4L2_TUNER_CAP_1HZ</constant> is set, in units of 1 Hz.
If multiple frequency bands are supported, then
<structfield>rangelow</structfield> is the lowest frequency <structfield>rangelow</structfield> is the lowest frequency
of all the frequency bands.</entry> of all the frequency bands.</entry>
</row> </row>
...@@ -144,7 +146,9 @@ of all the frequency bands.</entry> ...@@ -144,7 +146,9 @@ of all the frequency bands.</entry>
<entry spanname="hspan">The highest tunable frequency in <entry spanname="hspan">The highest tunable frequency in
units of 62.5 kHz, or if the <structfield>capability</structfield> units of 62.5 kHz, or if the <structfield>capability</structfield>
flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5
Hz. If multiple frequency bands are supported, then Hz, or if the <structfield>capability</structfield> flag
<constant>V4L2_TUNER_CAP_1HZ</constant> is set, in units of 1 Hz.
If multiple frequency bands are supported, then
<structfield>rangehigh</structfield> is the highest frequency <structfield>rangehigh</structfield> is the highest frequency
of all the frequency bands.</entry> of all the frequency bands.</entry>
</row> </row>
...@@ -270,7 +274,7 @@ applications must set the array to zero.</entry> ...@@ -270,7 +274,7 @@ applications must set the array to zero.</entry>
<entry><constant>V4L2_TUNER_CAP_LOW</constant></entry> <entry><constant>V4L2_TUNER_CAP_LOW</constant></entry>
<entry>0x0001</entry> <entry>0x0001</entry>
<entry>When set, tuning frequencies are expressed in units of <entry>When set, tuning frequencies are expressed in units of
62.5&nbsp;Hz, otherwise in units of 62.5&nbsp;kHz.</entry> 62.5 Hz instead of 62.5 kHz.</entry>
</row> </row>
<row> <row>
<entry><constant>V4L2_TUNER_CAP_NORM</constant></entry> <entry><constant>V4L2_TUNER_CAP_NORM</constant></entry>
...@@ -360,6 +364,11 @@ radio tuners.</entry> ...@@ -360,6 +364,11 @@ radio tuners.</entry>
<entry>The range to search when using the hardware seek functionality <entry>The range to search when using the hardware seek functionality
is programmable, see &VIDIOC-S-HW-FREQ-SEEK; for details.</entry> is programmable, see &VIDIOC-S-HW-FREQ-SEEK; for details.</entry>
</row> </row>
<row>
<entry><constant>V4L2_TUNER_CAP_1HZ</constant></entry>
<entry>0x1000</entry>
<entry>When set, tuning frequencies are expressed in units of 1 Hz instead of 62.5 kHz.</entry>
</row>
</tbody> </tbody>
</tgroup> </tgroup>
</table> </table>
......
Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
View file @ 70b5efb8
...@@ -121,7 +121,9 @@ field and the &v4l2-tuner; <structfield>index</structfield> field.</entry> ...@@ -121,7 +121,9 @@ field and the &v4l2-tuner; <structfield>index</structfield> field.</entry>
<entry>If non-zero, the lowest tunable frequency of the band to <entry>If non-zero, the lowest tunable frequency of the band to
search in units of 62.5 kHz, or if the &v4l2-tuner; search in units of 62.5 kHz, or if the &v4l2-tuner;
<structfield>capability</structfield> field has the <structfield>capability</structfield> field has the
<constant>V4L2_TUNER_CAP_LOW</constant> flag set, in units of 62.5 Hz. <constant>V4L2_TUNER_CAP_LOW</constant> flag set, in units of 62.5 Hz or if the &v4l2-tuner;
<structfield>capability</structfield> field has the
<constant>V4L2_TUNER_CAP_1HZ</constant> flag set, in units of 1 Hz.
If <structfield>rangelow</structfield> is zero a reasonable default value If <structfield>rangelow</structfield> is zero a reasonable default value
is used.</entry> is used.</entry>
</row> </row>
...@@ -131,7 +133,9 @@ is used.</entry> ...@@ -131,7 +133,9 @@ is used.</entry>
<entry>If non-zero, the highest tunable frequency of the band to <entry>If non-zero, the highest tunable frequency of the band to
search in units of 62.5 kHz, or if the &v4l2-tuner; search in units of 62.5 kHz, or if the &v4l2-tuner;
<structfield>capability</structfield> field has the <structfield>capability</structfield> field has the
<constant>V4L2_TUNER_CAP_LOW</constant> flag set, in units of 62.5 Hz. <constant>V4L2_TUNER_CAP_LOW</constant> flag set, in units of 62.5 Hz or if the &v4l2-tuner;
<structfield>capability</structfield> field has the
<constant>V4L2_TUNER_CAP_1HZ</constant> flag set, in units of 1 Hz.
If <structfield>rangehigh</structfield> is zero a reasonable default value If <structfield>rangehigh</structfield> is zero a reasonable default value
is used.</entry> is used.</entry>
</row> </row>
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7