diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-06-07 15:17:00 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-07-27 16:52:41 -0400 |
commit | d5dc2dee5030564ef3228d3a2647d4c25c84fedf (patch) | |
tree | 3aada974ddb55c169ebe2331105e31ddafa66140 | |
parent | 98a2b60d89ca48c22b77c09306156ccc3c11e939 (diff) |
[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: Mauro Carvalho Chehab <mchehab@redhat.com>
-rw-r--r-- | Documentation/DocBook/media/Makefile | 1 | ||||
-rw-r--r-- | Documentation/DocBook/media/dvb/frontend.xml | 47 |
2 files changed, 37 insertions, 11 deletions
diff --git a/Documentation/DocBook/media/Makefile b/Documentation/DocBook/media/Makefile index d9a21d3ea93a..34afc545ddeb 100644 --- a/Documentation/DocBook/media/Makefile +++ b/Documentation/DocBook/media/Makefile | |||
@@ -124,6 +124,7 @@ DVB_DOCUMENTED = \ | |||
124 | -e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g" \ | 124 | -e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g" \ |
125 | -e "s,\(struct\s\+\)\([a-z0-9_]\+\)\(\s\+{\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ | 125 | -e "s,\(struct\s\+\)\([a-z0-9_]\+\)\(\s\+{\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ |
126 | -e "s,\(}\s\+\)\([a-z0-9_]\+_t\+\),\1\<link linkend=\"\2\">\2\<\/link\>,g" \ | 126 | -e "s,\(}\s\+\)\([a-z0-9_]\+_t\+\),\1\<link linkend=\"\2\">\2\<\/link\>,g" \ |
127 | -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \ | ||
127 | # -e "s,\(\s\+\)\(FE_[A-Z0-9_]\+\)\([\s\=\,]*\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ | 128 | # -e "s,\(\s\+\)\(FE_[A-Z0-9_]\+\)\([\s\=\,]*\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ |
128 | 129 | ||
129 | # | 130 | # |
diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml index 60c6976fb311..b52f66abbbd4 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> | |||
20 | <section id="frontend_types"> | 20 | <section id="frontend_types"> |
21 | <title>Frontend Data Types</title> | 21 | <title>Frontend Data Types</title> |
22 | 22 | ||
23 | <section id="frontend_type"> | 23 | <section id="fe-type-t"> |
24 | <title>frontend type</title> | 24 | <title>Frontend type</title> |
25 | 25 | ||
26 | <para>For historical reasons frontend types are named after the type of modulation used in | 26 | <para>For historical reasons frontend types are named after the type of modulation used in |
27 | transmission.</para> | 27 | transmission. The fontend types are given by fe_type_t type, defined as:</para> |
28 | <programlisting> | 28 | |
29 | typedef enum fe_type { | 29 | <table pgwide="1" frame="none" id="fe-type"> |
30 | FE_QPSK, /⋆ DVB-S ⋆/ | 30 | <title>Frontend types</title> |
31 | FE_QAM, /⋆ DVB-C ⋆/ | 31 | <tgroup cols="2"> |
32 | FE_OFDM /⋆ DVB-T ⋆/ | 32 | &cs-def; |
33 | } fe_type_t; | 33 | <thead> |
34 | </programlisting> | 34 | <row> |
35 | 35 | <entry>fe_type</entry> | |
36 | <entry>Description</entry> | ||
37 | </row> | ||
38 | </thead> | ||
39 | <tbody valign="top"> | ||
40 | <row> | ||
41 | <entry id="FE_QPSK"><constant>FE_QPSK</constant></entry> | ||
42 | <entry>For DVB-S standard</entry> | ||
43 | </row> | ||
44 | <row> | ||
45 | <entry id="FE_QAM"><constant>FE_QAM</constant></entry> | ||
46 | <entry>For DVB-C standard</entry> | ||
47 | </row> | ||
48 | <row> | ||
49 | <entry id="FE_OFDM"><constant>FE_OFDM</constant></entry> | ||
50 | <entry>For DVB-T standard. Also used for ISDB-T on compatibility mode</entry> | ||
51 | </row> | ||
52 | <row> | ||
53 | <entry id="FE_ATSC"><constant>FE_ATSC</constant></entry> | ||
54 | <entry>For ATSC standard (terrestrial or cable)</entry> | ||
55 | </row> | ||
56 | </tbody></tgroup></table> | ||
57 | |||
58 | <para>Newer formats like DVB-S2, ISDB-T, ISDB-S and DVB-T2 are not described at the above, as they're | ||
59 | supported via the new <link linkend="FE_GET_SET_PROPERTY">FE_GET_PROPERTY/FE_GET_SET_PROPERTY</link> method. | ||
60 | </para> | ||
36 | </section> | 61 | </section> |
37 | 62 | ||
38 | <section id="frontend_caps"> | 63 | <section id="frontend_caps"> |