diff options
author | Andrey Smirnov <andrew.smirnov@gmail.com> | 2013-03-26 21:47:24 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2013-03-29 08:23:58 -0400 |
commit | b4e96a7e9f9511d1b57a10a08cd10af6e517966b (patch) | |
tree | 16a2dffca50658d9cd3dbe840d7f33765fbf9340 | |
parent | aec330a8cbd373d78c327201ec28fd5f252f3846 (diff) |
[media] v4l2: Add documentation for the FM RX controls
Add appropriate documentation for all the newly added standard
controls.
Based on the patch by Manjunatha Halli [1]
[1] http://lists-archives.com/linux-kernel/27641303-media-update-docs-for-v4l2-fm-new-features.html
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Andrey Smirnov <andrew.smirnov@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
-rw-r--r-- | Documentation/DocBook/media/v4l/compat.xml | 3 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/controls.xml | 72 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml | 9 |
3 files changed, 84 insertions, 0 deletions
diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml index 8c2b3687a6a4..e44161ffdd07 100644 --- a/Documentation/DocBook/media/v4l/compat.xml +++ b/Documentation/DocBook/media/v4l/compat.xml | |||
@@ -2310,6 +2310,9 @@ more information.</para> | |||
2310 | <listitem> | 2310 | <listitem> |
2311 | <para>Added FM Modulator (FM TX) Extended Control Class: <constant>V4L2_CTRL_CLASS_FM_TX</constant> and their Control IDs.</para> | 2311 | <para>Added FM Modulator (FM TX) Extended Control Class: <constant>V4L2_CTRL_CLASS_FM_TX</constant> and their Control IDs.</para> |
2312 | </listitem> | 2312 | </listitem> |
2313 | <listitem> | ||
2314 | <para>Added FM Receiver (FM RX) Extended Control Class: <constant>V4L2_CTRL_CLASS_FM_RX</constant> and their Control IDs.</para> | ||
2315 | </listitem> | ||
2313 | <listitem> | 2316 | <listitem> |
2314 | <para>Added Remote Controller chapter, describing the default Remote Controller mapping for media devices.</para> | 2317 | <para>Added Remote Controller chapter, describing the default Remote Controller mapping for media devices.</para> |
2315 | </listitem> | 2318 | </listitem> |
diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml index 06e9a5facb40..c8eb6c222274 100644 --- a/Documentation/DocBook/media/v4l/controls.xml +++ b/Documentation/DocBook/media/v4l/controls.xml | |||
@@ -4693,4 +4693,76 @@ interface and may change in the future.</para> | |||
4693 | </table> | 4693 | </table> |
4694 | 4694 | ||
4695 | </section> | 4695 | </section> |
4696 | |||
4697 | <section id="fm-rx-controls"> | ||
4698 | <title>FM Receiver Control Reference</title> | ||
4699 | |||
4700 | <para>The FM Receiver (FM_RX) class includes controls for common features of | ||
4701 | FM Reception capable devices.</para> | ||
4702 | |||
4703 | <table pgwide="1" frame="none" id="fm-rx-control-id"> | ||
4704 | <title>FM_RX Control IDs</title> | ||
4705 | |||
4706 | <tgroup cols="4"> | ||
4707 | <colspec colname="c1" colwidth="1*" /> | ||
4708 | <colspec colname="c2" colwidth="6*" /> | ||
4709 | <colspec colname="c3" colwidth="2*" /> | ||
4710 | <colspec colname="c4" colwidth="6*" /> | ||
4711 | <spanspec namest="c1" nameend="c2" spanname="id" /> | ||
4712 | <spanspec namest="c2" nameend="c4" spanname="descr" /> | ||
4713 | <thead> | ||
4714 | <row> | ||
4715 | <entry spanname="id" align="left">ID</entry> | ||
4716 | <entry align="left">Type</entry> | ||
4717 | </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry> | ||
4718 | </row> | ||
4719 | </thead> | ||
4720 | <tbody valign="top"> | ||
4721 | <row><entry></entry></row> | ||
4722 | <row> | ||
4723 | <entry spanname="id"><constant>V4L2_CID_FM_RX_CLASS</constant> </entry> | ||
4724 | <entry>class</entry> | ||
4725 | </row><row><entry spanname="descr">The FM_RX class | ||
4726 | descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a | ||
4727 | description of this control class.</entry> | ||
4728 | </row> | ||
4729 | <row> | ||
4730 | <entry spanname="id"><constant>V4L2_CID_RDS_RECEPTION</constant> </entry> | ||
4731 | <entry>boolean</entry> | ||
4732 | </row><row><entry spanname="descr">Enables/disables RDS | ||
4733 | reception by the radio tuner</entry> | ||
4734 | </row> | ||
4735 | <row> | ||
4736 | <entry spanname="id"><constant>V4L2_CID_TUNE_DEEMPHASIS</constant> </entry> | ||
4737 | <entry>enum v4l2_deemphasis</entry> | ||
4738 | </row> | ||
4739 | <row id="v4l2-deemphasis"><entry spanname="descr">Configures the de-emphasis value for reception. | ||
4740 | A de-emphasis filter is applied to the broadcast to accentuate the high audio frequencies. | ||
4741 | Depending on the region, a time constant of either 50 or 75 useconds is used. The enum v4l2_deemphasis | ||
4742 | defines possible values for de-emphasis. Here they are:</entry> | ||
4743 | </row><row> | ||
4744 | <entrytbl spanname="descr" cols="2"> | ||
4745 | <tbody valign="top"> | ||
4746 | <row> | ||
4747 | <entry><constant>V4L2_DEEMPHASIS_DISABLED</constant> </entry> | ||
4748 | <entry>No de-emphasis is applied.</entry> | ||
4749 | </row> | ||
4750 | <row> | ||
4751 | <entry><constant>V4L2_DEEMPHASIS_50_uS</constant> </entry> | ||
4752 | <entry>A de-emphasis of 50 uS is used.</entry> | ||
4753 | </row> | ||
4754 | <row> | ||
4755 | <entry><constant>V4L2_DEEMPHASIS_75_uS</constant> </entry> | ||
4756 | <entry>A de-emphasis of 75 uS is used.</entry> | ||
4757 | </row> | ||
4758 | </tbody> | ||
4759 | </entrytbl> | ||
4760 | |||
4761 | </row> | ||
4762 | <row><entry></entry></row> | ||
4763 | </tbody> | ||
4764 | </tgroup> | ||
4765 | </table> | ||
4766 | |||
4767 | </section> | ||
4696 | </section> | 4768 | </section> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml index 4e16112df992..b3bb9575b2e0 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml | |||
@@ -319,6 +319,15 @@ These controls are described in <xref | |||
319 | processing controls. These controls are described in <xref | 319 | processing controls. These controls are described in <xref |
320 | linkend="image-process-controls" />.</entry> | 320 | linkend="image-process-controls" />.</entry> |
321 | </row> | 321 | </row> |
322 | |||
323 | <row> | ||
324 | <entry><constant>V4L2_CTRL_CLASS_FM_RX</constant></entry> | ||
325 | <entry>0xa10000</entry> | ||
326 | <entry>The class containing FM Receiver (FM RX) controls. | ||
327 | These controls are described in <xref | ||
328 | linkend="fm-rx-controls" />.</entry> | ||
329 | </row> | ||
330 | |||
322 | </tbody> | 331 | </tbody> |
323 | </tgroup> | 332 | </tgroup> |
324 | </table> | 333 | </table> |