Just some comments on the spacing...
On Mon May 14 2012 21:24:28 manjunatha_ha...@ti.com wrote:
> From: Manjunatha Halli <x0130...@ti.com>
>
> The list of new features -
> 1) New control class for FM RX
> 2) New FM RX CID's - De-Emphasis filter mode and RDS AF switch
> 3) New FM TX CID - RDS Alternate frequency set.
> 4) New capability struct v4l2_tuner flags for band selection
>
> Signed-off-by: Manjunatha Halli <x0130...@ti.com>
> ---
> Documentation/DocBook/media/v4l/compat.xml | 3 +
> Documentation/DocBook/media/v4l/controls.xml | 77
> ++++++++++++++++++++
> Documentation/DocBook/media/v4l/dev-rds.xml | 5 +-
> .../DocBook/media/v4l/vidioc-g-ext-ctrls.xml | 7 ++
> Documentation/DocBook/media/v4l/vidioc-g-tuner.xml | 25 +++++++
> .../DocBook/media/v4l/vidioc-s-hw-freq-seek.xml | 38 +++++++++-
> 6 files changed, 151 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/DocBook/media/v4l/compat.xml
> b/Documentation/DocBook/media/v4l/compat.xml
> index bce97c5..df1f345 100644
> --- a/Documentation/DocBook/media/v4l/compat.xml
> +++ b/Documentation/DocBook/media/v4l/compat.xml
> @@ -2311,6 +2311,9 @@ more information.</para>
> <para>Added FM Modulator (FM TX) Extended Control Class:
> <constant>V4L2_CTRL_CLASS_FM_TX</constant> and their Control IDs.</para>
> </listitem>
> <listitem>
> + <para>Added FM Receiver (FM RX) Extended Control Class:
> <constant>V4L2_CTRL_CLASS_FM_RX</constant> and their Control IDs.</para>
> + </listitem>
> + <listitem>
> <para>Added Remote Controller chapter, describing the default Remote
> Controller mapping for media devices.</para>
> </listitem>
> </orderedlist>
> diff --git a/Documentation/DocBook/media/v4l/controls.xml
> b/Documentation/DocBook/media/v4l/controls.xml
> index b84f25e..976b11b 100644
> --- a/Documentation/DocBook/media/v4l/controls.xml
> +++ b/Documentation/DocBook/media/v4l/controls.xml
> @@ -3018,6 +3018,12 @@ to find receivers which can scroll strings sized as 32
> x N or 64 x N characters.
> with steps of 32 or 64 characters. The result is it must always contain a
> string with size multiple of 32 or 64. </entry>
> </row>
> <row>
> + <entry
> spanname="id"><constant>V4L2_CID_RDS_TX_AF_FREQ</constant> </entry>
> + <entry>integer</entry>
> + </row>
> + <row><entry spanname="descr">Sets the RDS Alternate Frequency value
> which allows a receiver to re-tune to a different frequency providing the
> same station when the first signal becomes too weak (e.g., when moving out of
> range). </entry>
> + </row>
> + <row>
> <entry
> spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_ENABLED</constant> </entry>
> <entry>boolean</entry>
> </row>
> @@ -3146,6 +3152,77 @@ manually or automatically if set to zero. Unit, range
> and step are driver-specif
> <xref linkend="en50067" /> document, from CENELEC.</para>
> </section>
>
> + <section id="fm-rx-controls">
> + <title>FM Receiver Control Reference</title>
> +
> + <para>The FM Receiver (FM_RX) class includes controls for common
> features of
> +FM Reception capable devices.</para>
> +
> + <table pgwide="1" frame="none" id="fm-rx-control-id">
> + <title>FM_RX Control IDs</title>
> +
> + <tgroup cols="4">
> + <colspec colname="c1" colwidth="1*" />
> + <colspec colname="c2" colwidth="6*" />
> + <colspec colname="c3" colwidth="2*" />
> + <colspec colname="c4" colwidth="6*" />
> + <spanspec namest="c1" nameend="c2" spanname="id" />
> + <spanspec namest="c2" nameend="c4" spanname="descr" />
> + <thead>
> + <row>
> + <entry spanname="id" align="left">ID</entry>
> + <entry align="left">Type</entry>
> + </row><row rowsep="1"><entry spanname="descr"
> align="left">Description</entry>
> + </row>
> + </thead>
> + <tbody valign="top">
> + <row><entry></entry></row>
> + <row>
> + <entry
> spanname="id"><constant>V4L2_CID_FM_RX_CLASS</constant> </entry>
> + <entry>class</entry>
> + </row><row><entry spanname="descr">The FM_RX class
> +descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
> +description of this control class.</entry>
> + </row>
> + <row>
> + <entry
> spanname="id"><constant>V4L2_CID_RDS_AF_SWITCH</constant> </entry>
> + <entry>boolean</entry>
> + </row>
> + <row><entry spanname="descr">Enable or Disable the RDS Alternate
> frequency feature. When enabled the driver will decode the RDS AF field and
> tries to switch to this AF frequency once the current frequency RSSI(Received
> signal strength indication) level goes below the threshold. If the frequency
> is switched, then
Put a space before the parenthesis: "RSSI (Received..."
> &VIDIOC-G-FREQUENCY; will return the new frequency.</entry>
> + </row>
> + <row>
> + <entry
> spanname="id"><constant>V4L2_CID_TUNE_DEEMPHASIS</constant> </entry>
> + <entry>integer</entry>
> + </row>
> + <row id="v4l2-deemphasis"><entry spanname="descr">Configures the
> de-emphasis value for reception.
> +A pre-emphasis filter is applied to the broadcast to accentuate the high
> audio frequencies.
> +Depending on the region, a time constant of either 50 or 75 useconds is
> used. The enum v4l2_preemphasis
> +defines possible values for pre-emphasis. Here they are:</entry>
> + </row><row>
> + <entrytbl spanname="descr" cols="2">
> + <tbody valign="top">
> + <row>
> +
> <entry><constant>V4L2_PREEMPHASIS_DISABLED</constant> </entry>
> + <entry>No de-emphasis is applied.</entry>
> + </row>
> + <row>
> +
> <entry><constant>V4L2_PREEMPHASIS_50_uS</constant> </entry>
> + <entry>A de-emphasis of 50 uS is used.</entry>
> + </row>
> + <row>
> +
> <entry><constant>V4L2_PREEMPHASIS_75_uS</constant> </entry>
> + <entry>A de-emphasis of 75 uS is used.</entry>
> + </row>
> + </tbody>
> + </entrytbl>
> +
> + </row>
> + <row><entry></entry></row>
> + </tbody>
> + </tgroup>
> + </table>
> +
> + </section>
> <section id="flash-controls">
> <title>Flash Control Reference</title>
>
> diff --git a/Documentation/DocBook/media/v4l/dev-rds.xml
> b/Documentation/DocBook/media/v4l/dev-rds.xml
> index 38883a4..8188161 100644
> --- a/Documentation/DocBook/media/v4l/dev-rds.xml
> +++ b/Documentation/DocBook/media/v4l/dev-rds.xml
> @@ -55,8 +55,9 @@ If the driver only passes RDS blocks without interpreting
> the data
> the <constant>V4L2_TUNER_CAP_RDS_BLOCK_IO</constant> flag has to be set. If
> the
> tuner is capable of handling RDS entities like program identification codes
> and radio
> text, the flag <constant>V4L2_TUNER_CAP_RDS_CONTROLS</constant> should be
> set,
> -see <link linkend="writing-rds-data">Writing RDS data</link> and
> -<link linkend="fm-tx-controls">FM Transmitter Control
> Reference</link>.</para>
> +see <link linkend="writing-rds-data">Writing RDS data</link>,
> +<link linkend="fm-tx-controls">FM Transmitter Control Reference</link>
> +<link linkend="fm-rx-controls">FM Receiver Control Reference</link>.</para>
> </section>
>
> <section id="reading-rds-data">
> diff --git a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml
> b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml
> index b17a7aa..2a8b44e 100644
> --- a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml
> +++ b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml
> @@ -258,6 +258,13 @@ These controls are described in <xref
> These controls are described in <xref
> linkend="fm-tx-controls" />.</entry>
> </row>
> + <row>
> + <entry><constant>V4L2_CTRL_CLASS_FM_RX</constant></entry>
> + <entry>0x9c0000</entry>
> + <entry>The class containing FM Receiver (FM RX) controls.
> +These controls are described in <xref
> + linkend="fm-rx-controls" />.</entry>
> + </row>
> <row>
> <entry><constant>V4L2_CTRL_CLASS_FLASH</constant></entry>
> <entry>0x9c0000</entry>
> diff --git a/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
> b/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
> index 91ec2fb..bdc5986 100644
> --- a/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
> +++ b/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
> @@ -328,6 +328,31 @@ radio tuners.</entry>
> <entry>0x0200</entry>
> <entry>The RDS data is parsed by the hardware and set via
> controls.</entry>
> </row>
> + <row>
> + <entry><constant>V4L2_TUNER_CAP_BAND_TYPE_DEFAULT</constant></entry>
> + <entry>0x010000</entry>
> + <entry>This is the default band, which should be the widest frequency
> range supported by the hardware.</entry>
> + </row>
> + <row>
> + <entry><constant>V4L2_TUNER_CAP_BAND_TYPE_EUROPE_US</constant></entry>
> + <entry>0x020000</entry>
> + <entry>Europe or US band(87.5 Mhz - 108 MHz).</entry>
Space before (
> + </row>
> + <row>
> + <entry><constant>V4L2_TUNER_CAP_BAND_TYPE_JAPAN</constant></entry>
> + <entry>0x030000</entry>
> + <entry>Japan band(76 MHz - 90 MHz).</entry>
Ditto.
> + </row>
> + <row>
> + <entry><constant>V4L2_TUNER_CAP_BAND_TYPE_RUSSIAN</constant></entry>
> + <entry>0x040000</entry>
> + <entry>OIRT or Russian band(65.8 MHz - 74 MHz).</entry>
Ditto.
> + </row>
> + <row>
> + <entry><constant>V4L2_TUNER_CAP_BAND_TYPE_WEATHER</constant></entry>
> + <entry>0x050000</entry>
> + <entry>Weather band(162.4 MHz - 162.55 MHz).</entry>
Ditto.
> + </row>
> </tbody>
> </tgroup>
> </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 18b1a82..0d36c14 100644
> --- a/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
> +++ b/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
> @@ -95,7 +95,12 @@ field and the &v4l2-tuner;
> <structfield>index</structfield> field.</entry>
> </row>
> <row>
> <entry>__u32</entry>
> - <entry><structfield>reserved</structfield>[7]</entry>
> + <entry><structfield>band</structfield></entry>
> + <entry>Configure the FM chip to a specific band before starting
> seek operation. Please refer table
refer -> refer to
> 'Radio Band Types'.</entry>
> + </row>
> + <row>
> + <entry>__u32</entry>
> + <entry><structfield>reserved</structfield>[6]</entry>
> <entry>Reserved for future extensions. Applications
> must set the array to zero.</entry>
> </row>
> @@ -103,6 +108,35 @@ field and the &v4l2-tuner;
> <structfield>index</structfield> field.</entry>
> </tgroup>
> </table>
> </refsect1>
> + <table pgwide="1" frame="none" id="Radio band Types">
> + <title>Radio Band Types</title>
> + <tgroup cols="2">
> + &cs-str;
> + <tbody valign="top">
> + <row>
> +
> <entry><constant>FM_BAND_TYPE_DEFAULT</constant> </entry>
> + <entry>This is the default band, which should be the
> widest frequency range supported by
> + the hardware.</entry>
> + </row>
> + <row>
> +
> <entry><constant>FM_BAND_TYPE_EUROPE_US</constant> </entry>
> + <entry>Europe or US band(87.5 Mhz - 108 MHz).</entry>
Space before '(', just like above.
> + </row>
> + <row>
> +
> <entry><constant>FM_BAND_TYPE_JAPAN</constant> </entry>
> + <entry>Japan band(76 MHz - 90 MHz).</entry>
> + </row>
> + <row>
> +
> <entry><constant>FM_BAND_TYPE_RUSSIAN</constant> </entry>
> + <entry>OIRT or Russian band(65.8 MHz - 74 MHz).</entry>
> + </row>
> + <row>
> +
> <entry><constant>FM_BAND_TYPE_WEATHER</constant> </entry>
> + <entry>Weather band(162.4 MHz - 162.55 MHz).</entry>
> + </row>
> + </tbody>
> + </tgroup>
> + </table>
>
> <refsect1>
> &return-value;
> @@ -112,7 +146,7 @@ field and the &v4l2-tuner;
> <structfield>index</structfield> field.</entry>
> <term><errorcode>EINVAL</errorcode></term>
> <listitem>
> <para>The <structfield>tuner</structfield> index is out of
> -bounds, the wrap_around value is not supported or the value in the
> <structfield>type</structfield> field is
> +bounds, the band is not supported, the wrap_around value is not supported or
> the value in the <structfield>type</structfield> field is
> wrong.</para>
> </listitem>
> </varlistentry>
>
Regards,
Hans
--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
