On Friday 16 July 2010 12:27:47 Matti J. Aaltonen wrote: > Add a couple of words about the spacing field in ithe HW seek struct and > about the new FM RX control class. > > Signed-off-by: Matti J. Aaltonen <matti.j.aaltonen@xxxxxxxxx> > --- > Documentation/DocBook/v4l/controls.xml | 71 ++++++++++++++++++++ > .../DocBook/v4l/vidioc-s-hw-freq-seek.xml | 10 ++- > 2 files changed, 79 insertions(+), 2 deletions(-) > > diff --git a/Documentation/DocBook/v4l/controls.xml b/Documentation/DocBook/v4l/controls.xml > index e1bdbb6..9725f06 100644 > --- a/Documentation/DocBook/v4l/controls.xml > +++ b/Documentation/DocBook/v4l/controls.xml > @@ -2062,6 +2062,77 @@ manually or automatically if set to zero. Unit, range and step are driver-specif > <para>For more details about RDS specification, refer to > <xref linkend="en50067" /> document, from CENELEC.</para> > </section> > + <section id="fm-rx-controls"> > + <title>FM Tuner Control Reference</title> > + > + <para>The FM Tuner (FM_RX) class includes controls for common features of > +devices that are capable of receiving FM transmissions. Currently this class includes a parameter > +defining the FM radio band being used.</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_FM_RX_BAND</constant> </entry> > + <entry>integer</entry> > + </row> > + <row id="v4l2-fm_rx_band"><entry spanname="descr">Configures the FM radio band that is > +the frequency range being used. Currentrly there are three band in use, see <ulink > +url="http://en.wikipedia.org/wiki/FM_broadcasting";>Wikipedia</ulink>. > +Usually 87.5 to 108.0 MHz is used, or some portion thereof, with a few exceptions: > +In Japan, the band 76-90 MHz is used and > +In the former Soviet republics, and some former Eastern Bloc countries, > +the older 65-74 MHz band, referred also to as the OIRT band, is still used. > + > +The enum v4l2_fm_rx_band defines possible values for the FM band. They are:</entry> > + </row><row> > + <entrytbl spanname="descr" cols="2"> > + <tbody valign="top"> > + <row> > + <entry><constant>V4L2_FM_BAND_OTHER</constant> </entry> > + <entry>Frequencies from 87.5 to 108.0 MHz</entry> > + </row> > + <row> > + <entry><constant>V4L2_FM_BAND_JAPAN</constant> </entry> > + <entry>from 65 to 74 MHz</entry> > + </row> > + <row> > + <entry><constant>V4L2_FM_BAND_OIRT</constant> </entry> > + <entry>from 65 to 74 MHz</entry> > + </row> > + </tbody> > + </entrytbl> > + > + </row> > + <row><entry></entry></row> > + </tbody> > + </tgroup> > + </table> > + > + </section> > </section> > > <!-- > diff --git a/Documentation/DocBook/v4l/vidioc-s-hw-freq-seek.xml b/Documentation/DocBook/v4l/vidioc-s-hw-freq-seek.xml > index 14b3ec7..8ee614c 100644 > --- a/Documentation/DocBook/v4l/vidioc-s-hw-freq-seek.xml > +++ b/Documentation/DocBook/v4l/vidioc-s-hw-freq-seek.xml > @@ -51,7 +51,8 @@ > > <para>Start a hardware frequency seek from the current frequency. > To do this applications initialize the <structfield>tuner</structfield>, > -<structfield>type</structfield>, <structfield>seek_upward</structfield> and > +<structfield>type</structfield>, <structfield>seek_upward</structfield>, > +<structfield>spacing</structfield> and > <structfield>wrap_around</structfield> fields, and zero out the > <structfield>reserved</structfield> array of a &v4l2-hw-freq-seek; and > call the <constant>VIDIOC_S_HW_FREQ_SEEK</constant> ioctl with a pointer > @@ -89,7 +90,12 @@ field and the &v4l2-tuner; <structfield>index</structfield> field.</entry> > </row> > <row> > <entry>__u32</entry> > - <entry><structfield>reserved</structfield>[8]</entry> > + <entry><structfield>spacing</structfield></entry> > + <entry>If non-zero, gives the search resolution to be used in hardware scan. The driver selects the nearest value that is supported by the hardware. If spacing is zero use a reasonable default value.</entry> As Mauro's review mentioned: please specify the unit of this spacing field! (It should be Hz). Don't forget to read and reply to Mauro's review as well! Regards, Hans > + </row> > + <row> > + <entry>__u32</entry> > + <entry><structfield>reserved</structfield>[7]</entry> > <entry>Reserved for future extensions. Drivers and > applications must set the array to zero.</entry> > </row> > -- Hans Verkuil - video4linux developer - sponsored by TANDBERG, part of Cisco -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
