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 02/15] [media] DocBook/frontend.xml: Better document fe_type_t
Date: Tue, 7 Jun 2011 22:45:30 -0300	[thread overview]
Message-ID: <20110607224530.0875fbaa@pedra> (raw)
In-Reply-To: <cover.1307496835.git.mchehab@redhat.com>

The fe_type_t documentation was incomplete and not linked to the
dvb/frontend.h.xml. Properly document it.

Also, drop a note that newer formats are only supported via
FE_GET_PROPERTY/FE_GET_SET_PROPERTY ioctls.

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

diff --git a/Documentation/DocBook/media/Makefile b/Documentation/DocBook/media/Makefile
index d9a21d3..34afc54 100644
--- a/Documentation/DocBook/media/Makefile
+++ b/Documentation/DocBook/media/Makefile
@@ -124,6 +124,7 @@ DVB_DOCUMENTED = \
 	-e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g" \
 	-e "s,\(struct\s\+\)\([a-z0-9_]\+\)\(\s\+{\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
 	-e "s,\(}\s\+\)\([a-z0-9_]\+_t\+\),\1\<link linkend=\"\2\">\2\<\/link\>,g" \
+	-e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
 #	-e "s,\(\s\+\)\(FE_[A-Z0-9_]\+\)\([\s\=\,]*\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
 
 #
diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml
index 60c6976..b52f66a 100644
--- a/Documentation/DocBook/media/dvb/frontend.xml
+++ b/Documentation/DocBook/media/dvb/frontend.xml
@@ -20,19 +20,44 @@ cards, in which case there exists no frontend device.</para>
 <section id="frontend_types">
 <title>Frontend Data Types</title>
 
-<section id="frontend_type">
-<title>frontend type</title>
+<section id="fe-type-t">
+<title>Frontend type</title>
 
 <para>For historical reasons frontend types are named after the type of modulation used in
-transmission.</para>
-<programlisting>
-	typedef enum fe_type {
-	FE_QPSK,   /&#x22C6; DVB-S &#x22C6;/
-	FE_QAM,    /&#x22C6; DVB-C &#x22C6;/
-	FE_OFDM    /&#x22C6; DVB-T &#x22C6;/
-	} fe_type_t;
-</programlisting>
+transmission. The fontend types are given by fe_type_t type, defined as:</para>
 
+<table pgwide="1" frame="none" id="fe-type">
+<title>Frontend types</title>
+<tgroup cols="2">
+   &cs-def;
+   <thead>
+     <row>
+       <entry>fe_type</entry>
+       <entry>Description</entry>
+     </row>
+  </thead>
+  <tbody valign="top">
+  <row>
+     <entry id="FE_QPSK"><constant>FE_QPSK</constant></entry>
+     <entry>For DVB-S standard</entry>
+  </row>
+  <row>
+     <entry id="FE_QAM"><constant>FE_QAM</constant></entry>
+     <entry>For DVB-C standard</entry>
+  </row>
+  <row>
+     <entry id="FE_OFDM"><constant>FE_OFDM</constant></entry>
+     <entry>For DVB-T standard. Also used for ISDB-T on compatibility mode</entry>
+  </row>
+  <row>
+     <entry id="FE_ATSC"><constant>FE_ATSC</constant></entry>
+     <entry>For ATSC standard (terrestrial or cable)</entry>
+  </row>
+</tbody></tgroup></table>
+
+<para>Newer formats like DVB-S2, ISDB-T, ISDB-S and DVB-T2 are not described at the above, as they're
+supported via the new <link linkend="FE_GET_SET_PROPERTY">FE_GET_PROPERTY/FE_GET_SET_PROPERTY</link> method.
+</para>
 </section>
 
 <section id="frontend_caps">
-- 
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 ` Mauro Carvalho Chehab [this message]
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 ` [PATCH 06/15] [media] DocBook/frontend.xml: Better describe the frontend parameters Mauro Carvalho Chehab
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=20110607224530.0875fbaa@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