Re: [PATCH V3 4/5] [Documentation] Media: Update docs for V4L2 FM new features

2012-05-03 Thread Hans Verkuil
On Wed May 2 2012 23:42:30 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.
 
 Signed-off-by: Manjunatha Halli x0130...@ti.com
 ---
  Documentation/DocBook/media/v4l/compat.xml |3 +
  Documentation/DocBook/media/v4l/controls.xml   |   78 
 
  Documentation/DocBook/media/v4l/dev-rds.xml|5 +-
  .../DocBook/media/v4l/vidioc-g-ext-ctrls.xml   |7 ++
  .../DocBook/media/v4l/vidioc-s-hw-freq-seek.xml|7 ++-
  5 files changed, 97 insertions(+), 3 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
 paraAdded FM Modulator (FM TX) Extended Control Class: 
 constantV4L2_CTRL_CLASS_FM_TX/constant and their Control IDs./para
   /listitem
   listitem
 + paraAdded FM Receiver (FM RX) Extended Control Class: 
 constantV4L2_CTRL_CLASS_FM_RX/constant and their Control IDs./para
 + /listitem
 + listitem
 paraAdded 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..b6e4db2 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=idconstantV4L2_CID_RDS_TX_AF_FREQ/constantnbsp;/entry
 +   entryinteger/entry
 +   /row
 +   rowentry spanname=descrSets 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=idconstantV4L2_CID_AUDIO_LIMITER_ENABLED/constantnbsp;/entry
   entryboolean/entry
 /row
 @@ -3146,6 +3152,78 @@ 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
 +  titleFM Receiver Control Reference/title
 +
 +  paraThe FM Receiver (FM_RX) class includes controls for common 
 features of
 +FM Reception capable devices. Currently this class includes parameter for 
 Alternate
 +frequency./para

Remove the last sentence (Currently this...). It serves no purpose and would 
only need
to be updated whenever a control is added.

 +
 +  table pgwide=1 frame=none id=fm-rx-control-id
 +  titleFM_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=leftID/entry
 +entry align=leftType/entry
 +  /rowrow rowsep=1entry spanname=descr 
 align=leftDescription/entry
 +  /row
 +/thead
 +tbody valign=top
 +  rowentry/entry/row
 +  row
 +entry 
 spanname=idconstantV4L2_CID_FM_RX_CLASS/constantnbsp;/entry
 +entryclass/entry
 +  /rowrowentry spanname=descrThe FM_RX class
 +descriptor. Calling VIDIOC-QUERYCTRL; for this control will return a
 +description of this control class./entry
 +  /row
 +  row
 +entry 
 spanname=idconstantV4L2_CID_RDS_AF_SWITCH/constantnbsp;/entry
 +entryboolean/entry
 +  /row
 +  rowentry spanname=descrEnable/Disable's FM RX RDS Alternate 
 frequency feature. When enabled driver will decode the RDS AF field and tries 
 to switch to this AF frequency once current frequency RSSI level goes below 
 threshold. Value of G_FREQUENCY is unchanged since both original frequency 
 and AF frequency share the same PI code./entry

Small improvement: Enable/Disable's - Enable or Disable the

I'd also remove the FM RX part: it's already obvious that we are in the FM RX 
class of controls.

When enabled - When enabled the
once current - once the current
below threshold - below the threshold

I don't understand what you mean with the last sentence: Value of 
G_FREQUENCY

Shouldn't it 

[PATCH V3 4/5] [Documentation] Media: Update docs for V4L2 FM new features

2012-05-02 Thread manjunatha_halli
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.

Signed-off-by: Manjunatha Halli x0130...@ti.com
---
 Documentation/DocBook/media/v4l/compat.xml |3 +
 Documentation/DocBook/media/v4l/controls.xml   |   78 
 Documentation/DocBook/media/v4l/dev-rds.xml|5 +-
 .../DocBook/media/v4l/vidioc-g-ext-ctrls.xml   |7 ++
 .../DocBook/media/v4l/vidioc-s-hw-freq-seek.xml|7 ++-
 5 files changed, 97 insertions(+), 3 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
  paraAdded FM Modulator (FM TX) Extended Control Class: 
constantV4L2_CTRL_CLASS_FM_TX/constant and their Control IDs./para
/listitem
listitem
+   paraAdded FM Receiver (FM RX) Extended Control Class: 
constantV4L2_CTRL_CLASS_FM_RX/constant and their Control IDs./para
+   /listitem
+   listitem
  paraAdded 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..b6e4db2 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=idconstantV4L2_CID_RDS_TX_AF_FREQ/constantnbsp;/entry
+ entryinteger/entry
+ /row
+ rowentry spanname=descrSets 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=idconstantV4L2_CID_AUDIO_LIMITER_ENABLED/constantnbsp;/entry
entryboolean/entry
  /row
@@ -3146,6 +3152,78 @@ 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
+  titleFM Receiver Control Reference/title
+
+  paraThe FM Receiver (FM_RX) class includes controls for common 
features of
+FM Reception capable devices. Currently this class includes parameter for 
Alternate
+frequency./para
+
+  table pgwide=1 frame=none id=fm-rx-control-id
+  titleFM_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=leftID/entry
+entry align=leftType/entry
+  /rowrow rowsep=1entry spanname=descr 
align=leftDescription/entry
+  /row
+/thead
+tbody valign=top
+  rowentry/entry/row
+  row
+entry 
spanname=idconstantV4L2_CID_FM_RX_CLASS/constantnbsp;/entry
+entryclass/entry
+  /rowrowentry spanname=descrThe FM_RX class
+descriptor. Calling VIDIOC-QUERYCTRL; for this control will return a
+description of this control class./entry
+  /row
+  row
+entry 
spanname=idconstantV4L2_CID_RDS_AF_SWITCH/constantnbsp;/entry
+entryboolean/entry
+  /row
+  rowentry spanname=descrEnable/Disable's FM RX RDS Alternate 
frequency feature. When enabled driver will decode the RDS AF field and tries 
to switch to this AF frequency once current frequency RSSI level goes below 
threshold. Value of G_FREQUENCY is unchanged since both original frequency and 
AF frequency share the same PI code./entry
+  /row
+  row
+   entry 
spanname=idconstantV4L2_CID_TUNE_DEEMPHASIS/constantnbsp;/entry
+   entryinteger/entry
+ /row
+ row id=v4l2-deemphasisentry spanname=descrConfigures 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 enumnbsp;v4l2_preemphasis
+defines possible values for pre-emphasis. Here they are:/entry
+   /rowrow
+   entrytbl spanname=descr cols=2
+ tbody valign=top
+