Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

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

[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

Documentation/DocBook/media/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -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" \



#

Documentation/DocBook/media/dvb/frontend.xml

+36 −11
Original line number Diff line number Diff line
@@ -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">