From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Received: from lb3-smtp-cloud2.xs4all.net ([194.109.24.29]:40298 "EHLO lb3-smtp-cloud2.xs4all.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932496AbbFHJMa (ORCPT ); Mon, 8 Jun 2015 05:12:30 -0400 Message-ID: <55755C77.5000306@xs4all.nl> Date: Mon, 08 Jun 2015 11:12:23 +0200 From: Hans Verkuil MIME-Version: 1.0 To: Antti Palosaari , linux-media@vger.kernel.org Subject: Re: [PATCH 5/9] DocBook: document SDR transmitter References: <1433592188-31748-1-git-send-email-crope@iki.fi> <1433592188-31748-5-git-send-email-crope@iki.fi> In-Reply-To: <1433592188-31748-5-git-send-email-crope@iki.fi> Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit Sender: linux-media-owner@vger.kernel.org List-ID: On 06/06/2015 02:03 PM, Antti Palosaari wrote: > Add documentation for V4L SDR transmitter (output) devices. > > Cc: Hans Verkuil > Signed-off-by: Antti Palosaari Acked-by: Hans Verkuil > --- > Documentation/DocBook/media/v4l/compat.xml | 4 +++ > Documentation/DocBook/media/v4l/dev-sdr.xml | 30 +++++++++++++++------- > Documentation/DocBook/media/v4l/io.xml | 10 ++++++-- > Documentation/DocBook/media/v4l/pixfmt.xml | 2 +- > Documentation/DocBook/media/v4l/v4l2.xml | 1 + > Documentation/DocBook/media/v4l/vidioc-g-fmt.xml | 2 +- > .../DocBook/media/v4l/vidioc-querycap.xml | 6 +++++ > 7 files changed, 42 insertions(+), 13 deletions(-) > > diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml > index e8f28bf..a237e36 100644 > --- a/Documentation/DocBook/media/v4l/compat.xml > +++ b/Documentation/DocBook/media/v4l/compat.xml > @@ -2604,6 +2604,10 @@ and &v4l2-mbus-framefmt;. > Added V4L2_CID_RF_TUNER_RF_GAIN_AUTO and > V4L2_CID_RF_TUNER_RF_GAIN RF Tuner controls. > > + > + Added transmitter support for Software Defined Radio (SDR) > +Interface. > + > > > > diff --git a/Documentation/DocBook/media/v4l/dev-sdr.xml b/Documentation/DocBook/media/v4l/dev-sdr.xml > index 3344921..a659771 100644 > --- a/Documentation/DocBook/media/v4l/dev-sdr.xml > +++ b/Documentation/DocBook/media/v4l/dev-sdr.xml > @@ -28,6 +28,16 @@ Devices supporting the SDR receiver interface set the > capabilities field of &v4l2-capability; > returned by the &VIDIOC-QUERYCAP; ioctl. That flag means the device has an > Analog to Digital Converter (ADC), which is a mandatory element for the SDR receiver. > + > + > +Devices supporting the SDR transmitter interface set the > +V4L2_CAP_SDR_OUTPUT and > +V4L2_CAP_MODULATOR flag in the > +capabilities field of &v4l2-capability; > +returned by the &VIDIOC-QUERYCAP; ioctl. That flag means the device has an > +Digital to Analog Converter (DAC), which is a mandatory element for the SDR transmitter. > + > + > At least one of the read/write, streaming or asynchronous I/O methods must > be supported. > > @@ -39,14 +49,15 @@ be supported. > > SDR devices can support controls, and must > support the tuner ioctls. Tuner ioctls are used > -for setting the ADC sampling rate (sampling frequency) and the possible RF tuner > -frequency. > +for setting the ADC/DAC sampling rate (sampling frequency) and the possible > +radio frequency (RF). > > > > -The V4L2_TUNER_SDR tuner type is used for SDR tuners, and > -the V4L2_TUNER_RF tuner type is used for RF tuners. The > -tuner index of the RF tuner (if any) must always follow the SDR tuner index. > +The V4L2_TUNER_SDR tuner type is used for setting SDR > +device ADC/DAC frequency, and the V4L2_TUNER_RF > +tuner type is used for setting radio frequency. > +The tuner index of the RF tuner (if any) must always follow the SDR tuner index. > Normally the SDR tuner is #0 and the RF tuner is #1. > > > @@ -59,9 +70,9 @@ The &VIDIOC-S-HW-FREQ-SEEK; ioctl is not supported. > Data Format Negotiation > > > -The SDR capture device uses the format ioctls to > -select the capture format. Both the sampling resolution and the data streaming > -format are bound to that selectable format. In addition to the basic > +The SDR device uses the format ioctls to > +select the capture and output format. Both the sampling resolution and the data > +streaming format are bound to that selectable format. In addition to the basic > format ioctls, the &VIDIOC-ENUM-FMT; ioctl > must be supported as well. > > @@ -69,7 +80,8 @@ must be supported as well. > > To use the format ioctls applications set the > type field of a &v4l2-format; to > -V4L2_BUF_TYPE_SDR_CAPTURE and use the &v4l2-sdr-format; > +V4L2_BUF_TYPE_SDR_CAPTURE or > +V4L2_BUF_TYPE_SDR_OUTPUT and use the &v4l2-sdr-format; > sdr member of the fmt > union as needed per the desired operation. > Currently there is two fields, pixelformat and > diff --git a/Documentation/DocBook/media/v4l/io.xml b/Documentation/DocBook/media/v4l/io.xml > index 7bbc2a4..da65403 100644 > --- a/Documentation/DocBook/media/v4l/io.xml > +++ b/Documentation/DocBook/media/v4l/io.xml > @@ -1006,8 +1006,14 @@ must set this to 0. > > V4L2_BUF_TYPE_SDR_CAPTURE > 11 > - Buffer for Software Defined Radio (SDR), see - linkend="sdr" />. > + Buffer for Software Defined Radio (SDR) capture stream, see > + . > + > + > + V4L2_BUF_TYPE_SDR_OUTPUT > + 12 > + Buffer for Software Defined Radio (SDR) output stream, see > + . > > > > diff --git a/Documentation/DocBook/media/v4l/pixfmt.xml b/Documentation/DocBook/media/v4l/pixfmt.xml > index 965ea91..02aac95 100644 > --- a/Documentation/DocBook/media/v4l/pixfmt.xml > +++ b/Documentation/DocBook/media/v4l/pixfmt.xml > @@ -1623,7 +1623,7 @@ extended control V4L2_CID_MPEG_STREAM_TYPE, see >
> SDR Formats > > - These formats are used for SDR Capture > + These formats are used for SDR > interface only. > > &sub-sdr-cu08; > diff --git a/Documentation/DocBook/media/v4l/v4l2.xml b/Documentation/DocBook/media/v4l/v4l2.xml > index b94d381..6a658ac 100644 > --- a/Documentation/DocBook/media/v4l/v4l2.xml > +++ b/Documentation/DocBook/media/v4l/v4l2.xml > @@ -157,6 +157,7 @@ applications. --> > ap > Renamed V4L2_TUNER_ADC to V4L2_TUNER_SDR. > Added V4L2_CID_RF_TUNER_RF_GAIN_AUTO and V4L2_CID_RF_TUNER_RF_GAIN controls. > +Added transmitter support for Software Defined Radio (SDR) Interface. > > > > diff --git a/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml b/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml > index 4fe19a7a..ffcb448 100644 > --- a/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml > +++ b/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml > @@ -175,7 +175,7 @@ capture and output devices. > &v4l2-sdr-format; > sdr > Definition of a data format, see > -, used by SDR capture devices. > +, used by SDR capture and output devices. > > > > diff --git a/Documentation/DocBook/media/v4l/vidioc-querycap.xml b/Documentation/DocBook/media/v4l/vidioc-querycap.xml > index 20fda75..cd82148 100644 > --- a/Documentation/DocBook/media/v4l/vidioc-querycap.xml > +++ b/Documentation/DocBook/media/v4l/vidioc-querycap.xml > @@ -308,6 +308,12 @@ modulator programming see > fields. > > > + V4L2_CAP_SDR_OUTPUT > + 0x00400000 > + The device supports the > +SDR Output interface. > + > + > V4L2_CAP_READWRITE > 0x01000000 > The device supports the