Commit d5dc2dee authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] DocBook/frontend.xml: Better document fe_type_t

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: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent 98a2b60d
...@@ -124,6 +124,7 @@ DVB_DOCUMENTED = \ ...@@ -124,6 +124,7 @@ DVB_DOCUMENTED = \
-e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g" \ -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,\(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 "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" \ # -e "s,\(\s\+\)\(FE_[A-Z0-9_]\+\)\([\s\=\,]*\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
# #
......
...@@ -20,19 +20,44 @@ cards, in which case there exists no frontend device.</para> ...@@ -20,19 +20,44 @@ cards, in which case there exists no frontend device.</para>
<section id="frontend_types"> <section id="frontend_types">
<title>Frontend Data Types</title> <title>Frontend Data Types</title>
<section id="frontend_type"> <section id="fe-type-t">
<title>frontend type</title> <title>Frontend type</title>
<para>For historical reasons frontend types are named after the type of modulation used in <para>For historical reasons frontend types are named after the type of modulation used in
transmission.</para> transmission. The fontend types are given by fe_type_t type, defined as:</para>
<programlisting>
typedef enum fe_type { <table pgwide="1" frame="none" id="fe-type">
FE_QPSK, /&#x22C6; DVB-S &#x22C6;/ <title>Frontend types</title>
FE_QAM, /&#x22C6; DVB-C &#x22C6;/ <tgroup cols="2">
FE_OFDM /&#x22C6; DVB-T &#x22C6;/ &cs-def;
} fe_type_t; <thead>
</programlisting> <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>
<section id="frontend_caps"> <section id="frontend_caps">
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment