diff options
author | Antti Palosaari <crope@iki.fi> | 2013-12-18 21:40:49 -0500 |
---|---|---|
committer | Mauro Carvalho Chehab <m.chehab@samsung.com> | 2014-03-05 12:16:12 -0500 |
commit | 70b5efb8b7be95e9e7a762c62e25a7e0aeb73ee7 (patch) | |
tree | acd8b846e304de424f46ba6ab1cb68f993c1a225 /Documentation | |
parent | bfffd7431c6e7661d13c3fd141863fde55c9338b (diff) |
[media] DocBook: document 1 Hz flag
Update documentation to reflect 1 Hz frequency step flag.
Cc: Hans Verkuil <hverkuil@xs4all.nl>
Signed-off-by: Antti Palosaari <crope@iki.fi>
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
Diffstat (limited to 'Documentation')
5 files changed, 30 insertions, 12 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-enum-freq-bands.xml b/Documentation/DocBook/media/v4l/vidioc-enum-freq-bands.xml index 6541ba0175ed..4e8ea65f7282 100644 --- a/Documentation/DocBook/media/v4l/vidioc-enum-freq-bands.xml +++ b/Documentation/DocBook/media/v4l/vidioc-enum-freq-bands.xml | |||
@@ -100,7 +100,7 @@ See <xref linkend="v4l2-tuner-type" /></entry> | |||
100 | <entry><structfield>capability</structfield></entry> | 100 | <entry><structfield>capability</structfield></entry> |
101 | <entry spanname="hspan">The tuner/modulator capability flags for | 101 | <entry spanname="hspan">The tuner/modulator capability flags for |
102 | this frequency band, see <xref linkend="tuner-capability" />. The <constant>V4L2_TUNER_CAP_LOW</constant> | 102 | this frequency band, see <xref linkend="tuner-capability" />. The <constant>V4L2_TUNER_CAP_LOW</constant> |
103 | capability must be the same for all frequency bands of the selected tuner/modulator. | 103 | or <constant>V4L2_TUNER_CAP_1HZ</constant> capability must be the same for all frequency bands of the selected tuner/modulator. |
104 | So either all bands have that capability set, or none of them have that capability.</entry> | 104 | So either all bands have that capability set, or none of them have that capability.</entry> |
105 | </row> | 105 | </row> |
106 | <row> | 106 | <row> |
@@ -109,7 +109,8 @@ So either all bands have that capability set, or none of them have that capabili | |||
109 | <entry spanname="hspan">The lowest tunable frequency in | 109 | <entry spanname="hspan">The lowest tunable frequency in |
110 | units of 62.5 kHz, or if the <structfield>capability</structfield> | 110 | units of 62.5 kHz, or if the <structfield>capability</structfield> |
111 | flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 | 111 | flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 |
112 | Hz, for this frequency band.</entry> | 112 | Hz, for this frequency band. A 1 Hz unit is used when the <structfield>capability</structfield> flag |
113 | <constant>V4L2_TUNER_CAP_1HZ</constant> is set.</entry> | ||
113 | </row> | 114 | </row> |
114 | <row> | 115 | <row> |
115 | <entry>__u32</entry> | 116 | <entry>__u32</entry> |
@@ -117,7 +118,8 @@ Hz, for this frequency band.</entry> | |||
117 | <entry spanname="hspan">The highest tunable frequency in | 118 | <entry spanname="hspan">The highest tunable frequency in |
118 | units of 62.5 kHz, or if the <structfield>capability</structfield> | 119 | units of 62.5 kHz, or if the <structfield>capability</structfield> |
119 | flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 | 120 | flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 |
120 | Hz, for this frequency band.</entry> | 121 | Hz, for this frequency band. A 1 Hz unit is used when the <structfield>capability</structfield> flag |
122 | <constant>V4L2_TUNER_CAP_1HZ</constant> is set.</entry> | ||
121 | </row> | 123 | </row> |
122 | <row> | 124 | <row> |
123 | <entry>__u32</entry> | 125 | <entry>__u32</entry> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml b/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml index c7a1c462e724..d1034fb61d15 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml | |||
@@ -109,9 +109,10 @@ See <xref linkend="v4l2-tuner-type" /></entry> | |||
109 | <entry>__u32</entry> | 109 | <entry>__u32</entry> |
110 | <entry><structfield>frequency</structfield></entry> | 110 | <entry><structfield>frequency</structfield></entry> |
111 | <entry>Tuning frequency in units of 62.5 kHz, or if the | 111 | <entry>Tuning frequency in units of 62.5 kHz, or if the |
112 | &v4l2-tuner; or &v4l2-modulator; <structfield>capabilities</structfield> flag | 112 | &v4l2-tuner; or &v4l2-modulator; <structfield>capability</structfield> flag |
113 | <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 | 113 | <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 |
114 | Hz.</entry> | 114 | Hz. A 1 Hz unit is used when the <structfield>capability</structfield> flag |
115 | <constant>V4L2_TUNER_CAP_1HZ</constant> is set.</entry> | ||
115 | </row> | 116 | </row> |
116 | <row> | 117 | <row> |
117 | <entry>__u32</entry> | 118 | <entry>__u32</entry> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-modulator.xml b/Documentation/DocBook/media/v4l/vidioc-g-modulator.xml index 7f4ac7e41fa8..7068b599a00d 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-modulator.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-modulator.xml | |||
@@ -113,7 +113,8 @@ change for example with the current video standard.</entry> | |||
113 | <entry>The lowest tunable frequency in units of 62.5 | 113 | <entry>The lowest tunable frequency in units of 62.5 |
114 | KHz, or if the <structfield>capability</structfield> flag | 114 | KHz, or if the <structfield>capability</structfield> flag |
115 | <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 | 115 | <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 |
116 | Hz.</entry> | 116 | Hz, or if the <structfield>capability</structfield> flag |
117 | <constant>V4L2_TUNER_CAP_1HZ</constant> is set, in units of 1 Hz.</entry> | ||
117 | </row> | 118 | </row> |
118 | <row> | 119 | <row> |
119 | <entry>__u32</entry> | 120 | <entry>__u32</entry> |
@@ -121,7 +122,8 @@ Hz.</entry> | |||
121 | <entry>The highest tunable frequency in units of 62.5 | 122 | <entry>The highest tunable frequency in units of 62.5 |
122 | KHz, or if the <structfield>capability</structfield> flag | 123 | KHz, or if the <structfield>capability</structfield> flag |
123 | <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 | 124 | <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 |
124 | Hz.</entry> | 125 | Hz, or if the <structfield>capability</structfield> flag |
126 | <constant>V4L2_TUNER_CAP_1HZ</constant> is set, in units of 1 Hz.</entry> | ||
125 | </row> | 127 | </row> |
126 | <row> | 128 | <row> |
127 | <entry>__u32</entry> | 129 | <entry>__u32</entry> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml b/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml index 6cc82010c736..b0d865933da6 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml | |||
@@ -134,7 +134,9 @@ the structure refers to a radio tuner the | |||
134 | <entry spanname="hspan">The lowest tunable frequency in | 134 | <entry spanname="hspan">The lowest tunable frequency in |
135 | units of 62.5 kHz, or if the <structfield>capability</structfield> | 135 | units of 62.5 kHz, or if the <structfield>capability</structfield> |
136 | flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 | 136 | flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 |
137 | Hz. If multiple frequency bands are supported, then | 137 | Hz, or if the <structfield>capability</structfield> flag |
138 | <constant>V4L2_TUNER_CAP_1HZ</constant> is set, in units of 1 Hz. | ||
139 | If multiple frequency bands are supported, then | ||
138 | <structfield>rangelow</structfield> is the lowest frequency | 140 | <structfield>rangelow</structfield> is the lowest frequency |
139 | of all the frequency bands.</entry> | 141 | of all the frequency bands.</entry> |
140 | </row> | 142 | </row> |
@@ -144,7 +146,9 @@ of all the frequency bands.</entry> | |||
144 | <entry spanname="hspan">The highest tunable frequency in | 146 | <entry spanname="hspan">The highest tunable frequency in |
145 | units of 62.5 kHz, or if the <structfield>capability</structfield> | 147 | units of 62.5 kHz, or if the <structfield>capability</structfield> |
146 | flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 | 148 | flag <constant>V4L2_TUNER_CAP_LOW</constant> is set, in units of 62.5 |
147 | Hz. If multiple frequency bands are supported, then | 149 | Hz, or if the <structfield>capability</structfield> flag |
150 | <constant>V4L2_TUNER_CAP_1HZ</constant> is set, in units of 1 Hz. | ||
151 | If multiple frequency bands are supported, then | ||
148 | <structfield>rangehigh</structfield> is the highest frequency | 152 | <structfield>rangehigh</structfield> is the highest frequency |
149 | of all the frequency bands.</entry> | 153 | of all the frequency bands.</entry> |
150 | </row> | 154 | </row> |
@@ -270,7 +274,7 @@ applications must set the array to zero.</entry> | |||
270 | <entry><constant>V4L2_TUNER_CAP_LOW</constant></entry> | 274 | <entry><constant>V4L2_TUNER_CAP_LOW</constant></entry> |
271 | <entry>0x0001</entry> | 275 | <entry>0x0001</entry> |
272 | <entry>When set, tuning frequencies are expressed in units of | 276 | <entry>When set, tuning frequencies are expressed in units of |
273 | 62.5 Hz, otherwise in units of 62.5 kHz.</entry> | 277 | 62.5 Hz instead of 62.5 kHz.</entry> |
274 | </row> | 278 | </row> |
275 | <row> | 279 | <row> |
276 | <entry><constant>V4L2_TUNER_CAP_NORM</constant></entry> | 280 | <entry><constant>V4L2_TUNER_CAP_NORM</constant></entry> |
@@ -360,6 +364,11 @@ radio tuners.</entry> | |||
360 | <entry>The range to search when using the hardware seek functionality | 364 | <entry>The range to search when using the hardware seek functionality |
361 | is programmable, see &VIDIOC-S-HW-FREQ-SEEK; for details.</entry> | 365 | is programmable, see &VIDIOC-S-HW-FREQ-SEEK; for details.</entry> |
362 | </row> | 366 | </row> |
367 | <row> | ||
368 | <entry><constant>V4L2_TUNER_CAP_1HZ</constant></entry> | ||
369 | <entry>0x1000</entry> | ||
370 | <entry>When set, tuning frequencies are expressed in units of 1 Hz instead of 62.5 kHz.</entry> | ||
371 | </row> | ||
363 | </tbody> | 372 | </tbody> |
364 | </tgroup> | 373 | </tgroup> |
365 | </table> | 374 | </table> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml b/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml index 5b379e752194..a5fc4c4880f3 100644 --- a/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml +++ b/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml | |||
@@ -121,7 +121,9 @@ field and the &v4l2-tuner; <structfield>index</structfield> field.</entry> | |||
121 | <entry>If non-zero, the lowest tunable frequency of the band to | 121 | <entry>If non-zero, the lowest tunable frequency of the band to |
122 | search in units of 62.5 kHz, or if the &v4l2-tuner; | 122 | search in units of 62.5 kHz, or if the &v4l2-tuner; |
123 | <structfield>capability</structfield> field has the | 123 | <structfield>capability</structfield> field has the |
124 | <constant>V4L2_TUNER_CAP_LOW</constant> flag set, in units of 62.5 Hz. | 124 | <constant>V4L2_TUNER_CAP_LOW</constant> flag set, in units of 62.5 Hz or if the &v4l2-tuner; |
125 | <structfield>capability</structfield> field has the | ||
126 | <constant>V4L2_TUNER_CAP_1HZ</constant> flag set, in units of 1 Hz. | ||
125 | If <structfield>rangelow</structfield> is zero a reasonable default value | 127 | If <structfield>rangelow</structfield> is zero a reasonable default value |
126 | is used.</entry> | 128 | is used.</entry> |
127 | </row> | 129 | </row> |
@@ -131,7 +133,9 @@ is used.</entry> | |||
131 | <entry>If non-zero, the highest tunable frequency of the band to | 133 | <entry>If non-zero, the highest tunable frequency of the band to |
132 | search in units of 62.5 kHz, or if the &v4l2-tuner; | 134 | search in units of 62.5 kHz, or if the &v4l2-tuner; |
133 | <structfield>capability</structfield> field has the | 135 | <structfield>capability</structfield> field has the |
134 | <constant>V4L2_TUNER_CAP_LOW</constant> flag set, in units of 62.5 Hz. | 136 | <constant>V4L2_TUNER_CAP_LOW</constant> flag set, in units of 62.5 Hz or if the &v4l2-tuner; |
137 | <structfield>capability</structfield> field has the | ||
138 | <constant>V4L2_TUNER_CAP_1HZ</constant> flag set, in units of 1 Hz. | ||
135 | If <structfield>rangehigh</structfield> is zero a reasonable default value | 139 | If <structfield>rangehigh</structfield> is zero a reasonable default value |
136 | is used.</entry> | 140 | is used.</entry> |
137 | </row> | 141 | </row> |