Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932237Ab2ENTYt (ORCPT ); Mon, 14 May 2012 15:24:49 -0400 Received: from devils.ext.ti.com ([198.47.26.153]:38547 "EHLO devils.ext.ti.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1757637Ab2ENTYe (ORCPT ); Mon, 14 May 2012 15:24:34 -0400 From: To: CC: , Manjunatha Halli Subject: [PATCH V5 4/5] Media: Update docs for V4L2 FM new features Date: Mon, 14 May 2012 14:24:28 -0500 Message-ID: <1337023469-24990-5-git-send-email-manjunatha_halli@ti.com> X-Mailer: git-send-email 1.7.4.1 In-Reply-To: <1337023469-24990-1-git-send-email-manjunatha_halli@ti.com> References: <1337023469-24990-1-git-send-email-manjunatha_halli@ti.com> MIME-Version: 1.0 Content-Type: text/plain Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 12012 Lines: 268 From: Manjunatha Halli 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 --- 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. Added FM Modulator (FM TX) Extended Control Class: V4L2_CTRL_CLASS_FM_TX and their Control IDs. + Added FM Receiver (FM RX) Extended Control Class: V4L2_CTRL_CLASS_FM_RX and their Control IDs. + + Added Remote Controller chapter, describing the default Remote Controller mapping for media devices. 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. + V4L2_CID_RDS_TX_AF_FREQ  + integer + + 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). + + V4L2_CID_AUDIO_LIMITER_ENABLED  boolean @@ -3146,6 +3152,77 @@ manually or automatically if set to zero. Unit, range and step are driver-specif document, from CENELEC. +
+ FM Receiver Control Reference + + The FM Receiver (FM_RX) class includes controls for common features of +FM Reception capable devices. + + + FM_RX Control IDs + + + + + + + + + + + ID + Type + Description + + + + + + V4L2_CID_FM_RX_CLASS  + class + The FM_RX class +descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a +description of this control class. + + + V4L2_CID_RDS_AF_SWITCH  + boolean + + 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 &VIDIOC-G-FREQUENCY; will return the new frequency. + + + V4L2_CID_TUNE_DEEMPHASIS  + integer + + 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: + + + + + V4L2_PREEMPHASIS_DISABLED  + No de-emphasis is applied. + + + V4L2_PREEMPHASIS_50_uS  + A de-emphasis of 50 uS is used. + + + V4L2_PREEMPHASIS_75_uS  + A de-emphasis of 75 uS is used. + + + + + + + + +
+ +
Flash Control Reference 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 V4L2_TUNER_CAP_RDS_BLOCK_IO flag has to be set. If the tuner is capable of handling RDS entities like program identification codes and radio text, the flag V4L2_TUNER_CAP_RDS_CONTROLS should be set, -see Writing RDS data and -FM Transmitter Control Reference. +see Writing RDS data, +FM Transmitter Control Reference +FM Receiver Control Reference.
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 . + + V4L2_CTRL_CLASS_FM_RX + 0x9c0000 + The class containing FM Receiver (FM RX) controls. +These controls are described in . + V4L2_CTRL_CLASS_FLASH 0x9c0000 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. 0x0200 The RDS data is parsed by the hardware and set via controls. + + V4L2_TUNER_CAP_BAND_TYPE_DEFAULT + 0x010000 + This is the default band, which should be the widest frequency range supported by the hardware. + + + V4L2_TUNER_CAP_BAND_TYPE_EUROPE_US + 0x020000 + Europe or US band(87.5 Mhz - 108 MHz). + + + V4L2_TUNER_CAP_BAND_TYPE_JAPAN + 0x030000 + Japan band(76 MHz - 90 MHz). + + + V4L2_TUNER_CAP_BAND_TYPE_RUSSIAN + 0x040000 + OIRT or Russian band(65.8 MHz - 74 MHz). + + + V4L2_TUNER_CAP_BAND_TYPE_WEATHER + 0x050000 + Weather band(162.4 MHz - 162.55 MHz). + 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; index field. __u32 - reserved[7] + band + Configure the FM chip to a specific band before starting seek operation. Please refer table 'Radio Band Types'. + + + __u32 + reserved[6] Reserved for future extensions. Applications must set the array to zero. @@ -103,6 +108,35 @@ field and the &v4l2-tuner; index field. + + Radio Band Types + + &cs-str; + + + FM_BAND_TYPE_DEFAULT  + This is the default band, which should be the widest frequency range supported by + the hardware. + + + FM_BAND_TYPE_EUROPE_US  + Europe or US band(87.5 Mhz - 108 MHz). + + + FM_BAND_TYPE_JAPAN  + Japan band(76 MHz - 90 MHz). + + + FM_BAND_TYPE_RUSSIAN  + OIRT or Russian band(65.8 MHz - 74 MHz). + + + FM_BAND_TYPE_WEATHER  + Weather band(162.4 MHz - 162.55 MHz). + + + +
&return-value; @@ -112,7 +146,7 @@ field and the &v4l2-tuner; index field. EINVAL The tuner index is out of -bounds, the wrap_around value is not supported or the value in the type field is +bounds, the band is not supported, the wrap_around value is not supported or the value in the type field is wrong. -- 1.7.4.1 -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/