Re: [PATCH v5 6/8] v4l2: Add documentation for the FM RX controls
On Tue February 26 2013 07:38:52 Andrey Smirnov wrote: Add appropriate documentation for all the newly added standard controls. Give credit to Manjunatha Halli. Signed-off-by: Andrey Smirnov andrew.smir...@gmail.com --- Documentation/DocBook/media/v4l/compat.xml |3 + Documentation/DocBook/media/v4l/controls.xml | 72 .../DocBook/media/v4l/vidioc-g-ext-ctrls.xml | 11 ++- 3 files changed, 85 insertions(+), 1 deletion(-) diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml index 104a1a2..f418bc3 100644 --- a/Documentation/DocBook/media/v4l/compat.xml +++ b/Documentation/DocBook/media/v4l/compat.xml @@ -2310,6 +2310,9 @@ more information./para listitem 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 diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml index 9e8f854..e8fe005 100644 --- a/Documentation/DocBook/media/v4l/controls.xml +++ b/Documentation/DocBook/media/v4l/controls.xml @@ -4687,4 +4687,76 @@ interface and may change in the future./para /table /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./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_RECEPTION/constantnbsp;/entry +entryboolean/entry + /rowrowentry spanname=descrEnables/disables RDS + reception by the radio tuner/entry + /row + row + entry spanname=idconstantV4L2_CID_TUNE_DEEMPHASIS/constantnbsp;/entry + entryinteger/entry This is type 'enum v4l2_deemphasis', not integer. BTW, V4L2_CID_TUNE_PREEMPHASIS has the same mistake, can you update that entry as well to 'enum v4l2_preemphasis'? + /row + row id=v4l2-deemphasisentry spanname=descrConfigures the de-emphasis value for reception. +A de-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_emphasis enum v4l2_deemphasis +defines possible values for de-emphasis. Here they are:/entry + /rowrow + entrytbl spanname=descr cols=2 + tbody valign=top + row + entryconstantV4L2_PREEMPHASIS_DISABLED/constantnbsp;/entry + entryNo de-emphasis is applied./entry + /row + row + entryconstantV4L2_PREEMPHASIS_50_uS/constantnbsp;/entry + entryA de-emphasis of 50 uS is used./entry + /row + row + entryconstantV4L2_PREEMPHASIS_75_uS/constantnbsp;/entry + entryA de-emphasis of 75 uS is used./entry For the three constants above: PRE - DE + /row + /tbody + /entrytbl + + /row + rowentry/entry/row +/tbody + /tgroup + /table + + /section /section diff --git a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml index 4e16112..b03a57b 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml @@ -9,7 +9,7 @@ VIDIOC_TRY_EXT_CTRLS/refentrytitle
[PATCH v5 6/8] v4l2: Add documentation for the FM RX controls
Add appropriate documentation for all the newly added standard controls. Signed-off-by: Andrey Smirnov andrew.smir...@gmail.com --- Documentation/DocBook/media/v4l/compat.xml |3 + Documentation/DocBook/media/v4l/controls.xml | 72 .../DocBook/media/v4l/vidioc-g-ext-ctrls.xml | 11 ++- 3 files changed, 85 insertions(+), 1 deletion(-) diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml index 104a1a2..f418bc3 100644 --- a/Documentation/DocBook/media/v4l/compat.xml +++ b/Documentation/DocBook/media/v4l/compat.xml @@ -2310,6 +2310,9 @@ more information./para listitem 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 diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml index 9e8f854..e8fe005 100644 --- a/Documentation/DocBook/media/v4l/controls.xml +++ b/Documentation/DocBook/media/v4l/controls.xml @@ -4687,4 +4687,76 @@ interface and may change in the future./para /table /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./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_RECEPTION/constantnbsp;/entry +entryboolean/entry + /rowrowentry spanname=descrEnables/disables RDS + reception by the radio tuner/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 de-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_emphasis +defines possible values for de-emphasis. Here they are:/entry + /rowrow + entrytbl spanname=descr cols=2 + tbody valign=top + row + entryconstantV4L2_PREEMPHASIS_DISABLED/constantnbsp;/entry + entryNo de-emphasis is applied./entry + /row + row + entryconstantV4L2_PREEMPHASIS_50_uS/constantnbsp;/entry + entryA de-emphasis of 50 uS is used./entry + /row + row + entryconstantV4L2_PREEMPHASIS_75_uS/constantnbsp;/entry + entryA de-emphasis of 75 uS is used./entry + /row + /tbody + /entrytbl + + /row + rowentry/entry/row +/tbody + /tgroup + /table + + /section /section diff --git a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml index 4e16112..b03a57b 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml @@ -9,7 +9,7 @@ VIDIOC_TRY_EXT_CTRLS/refentrytitle refnameVIDIOC_G_EXT_CTRLS/refname refnameVIDIOC_S_EXT_CTRLS/refname refnameVIDIOC_TRY_EXT_CTRLS/refname -refpurposeGet or set the value of several controls, try control + refpurposeGet or set the value of several controls, try control values/refpurpose /refnamediv @@ -319,6 +319,15 @@ These controls are described in xref processing controls. These controls
