public inbox for linux-media@vger.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@redhat.com>
To: unlisted-recipients:; (no To-header on input)@casper.infradead.org
Cc: Linux Media Mailing List <linux-media@vger.kernel.org>
Subject: [PATCH 06/15] [media] DocBook/frontend.xml: Better describe the frontend parameters
Date: Tue, 7 Jun 2011 22:45:33 -0300	[thread overview]
Message-ID: <20110607224533.0faaa965@pedra> (raw)
In-Reply-To: <cover.1307496835.git.mchehab@redhat.com>

Update the DVB parameter structs to reflect VSB modulation and
improve a few descriptions.

Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml
index a925b45..b1f0123 100644
--- a/Documentation/DocBook/media/dvb/frontend.xml
+++ b/Documentation/DocBook/media/dvb/frontend.xml
@@ -262,6 +262,15 @@ OFDM frontends the <constant>frequency</constant> specifies the absolute frequen
  };
 </programlisting>
 </section>
+<section id="dvb-vsb-parameters">
+<title>VSB parameters</title>
+<para>DVB-T frontends are supported by the <constant>dvb_vsb_parameters</constant> structure:</para>
+<programlisting>
+struct dvb_vsb_parameters {
+	fe_modulation_t modulation;	/&#x22C6; modulation type (see above) &#x22C6;/
+};
+</programlisting>
+</section>
 <section id="dvb-ofdm-parameters">
 <title>OFDM parameters</title>
 <para>DVB-T frontends are supported by the <constant>dvb_ofdm_parameters</constant> structure:</para>
@@ -277,15 +286,6 @@ OFDM frontends the <constant>frequency</constant> specifies the absolute frequen
  };
 </programlisting>
 </section>
-<section id="dvb-vsb-parameters">
-<title>VSB parameters</title>
-<para>DVB-T frontends are supported by the <constant>dvb_vsb_parameters</constant> structure:</para>
-<programlisting>
-struct dvb_vsb_parameters {
-	fe_modulation_t modulation;	/&#x22C6; modulation type (see above) &#x22C6;/
-};
-</programlisting>
-</section>
 <section id="fe-spectral-inversion-t">
 <title>frontend spectral inversion</title>
 <para>The Inversion field can take one of these values:
@@ -304,7 +304,9 @@ itself.
 </section>
 <section id="fe-code-rate-t">
 <title>frontend code rate</title>
-<para>The possible values for the <constant>FEC_inner</constant> field are
+<para>The possible values for the <constant>fec_inner</constant> field used on
+<link refend="dvb-qpsk-parameters"><constant>struct dvb_qpsk_parameters</constant></link> and
+<link refend="dvb-qam-parameters"><constant>struct dvb_qam_parameters</constant></link> are:
 </para>
 <programlisting>
 typedef enum fe_code_rate {
@@ -327,9 +329,12 @@ detection.
 </para>
 </section>
 <section id="fe-modulation-t">
-<title>frontend modulation type for QAM and OFDM</title>
-<para>For cable and terrestrial frontends (QAM and OFDM) one also has to specify the quadrature
-modulation mode which can be one of the following:
+<title>frontend modulation type for QAM, OFDM and VSB</title>
+<para>For cable and terrestrial frontends, e. g. for
+<link refend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>,
+<link refend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and
+<link refend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>,
+it needs to specify the quadrature modulation mode which can be one of the following:
 </para>
 <programlisting>
  typedef enum fe_modulation {
@@ -352,7 +357,7 @@ modulation mode which can be one of the following:
 <para>Finally, there are several more parameters for OFDM:
 </para>
 <section id="fe-transmit-mode-t">
-<title>Number of carriers per channel, on OFTM modulation</title>
+<title>Number of carriers per channel</title>
 <programlisting>
 typedef enum fe_transmit_mode {
 	TRANSMISSION_MODE_2K,
-- 
1.7.1



  parent reply	other threads:[~2011-06-08  1:45 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <cover.1307496835.git.mchehab@redhat.com>
2011-06-08  1:45 ` [PATCH 01/15] [media] DocBook/Makefile: add references for several dvb structures Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 02/15] [media] DocBook/frontend.xml: Better document fe_type_t Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 03/15] [media] DocBook/frontend.xml: Link DVB S2API parameters Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 04/15] [media] DocBook/frontend.xml: Correlate dvb delivery systems Mauro Carvalho Chehab
2011-06-08  1:45 ` Mauro Carvalho Chehab [this message]
2011-06-08  1:45 ` [PATCH 05/15] [media] DocBook/frontend.xml: add references for some missing info Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 07/15] [media] DocBook/dvbproperty.xml: Document the remaining S2API parameters Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 08/15] [media] DocBook/dvbproperty.xml: Use links for all parameters Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 09/15] [media] DocBook/dvbproperty.xml: Reorganize the parameters Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 10/15] [media] DocBook/frontend.xml: Recomend the usage of the new API Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 11/15] [media] DocBook/dvbproperty.xml: Document the terrestrial delivery systems Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 12/15] [media] DocBook: Finish synchronizing the frontend API Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 13/15] [media] DocBook/dvbproperty.xml: Add Cable standards Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 14/15] [media] DocBook/dvbproperty.xml: Add ATSC standard Mauro Carvalho Chehab
2011-06-08  1:45 ` [PATCH 15/15] [media] DocBook/dvbproperty.xml: Add Satellite standards Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20110607224533.0faaa965@pedra \
    --to=mchehab@redhat.com \
    --cc=linux-media@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox