858fd7d1710401f1783598f6686cf16dadf9b168
[firefly-linux-kernel-4.4.55.git] / Documentation / DocBook / media / dvb / dvbapi.xml
1 <partinfo>
2 <authorgroup>
3 <author>
4 <firstname>Ralph</firstname>
5 <surname>Metzler</surname>
6 <othername role="mi">J. K.</othername>
7 <affiliation><address><email>rjkm@metzlerbros.de</email></address></affiliation>
8 </author>
9 <author>
10 <firstname>Marcus</firstname>
11 <surname>Metzler</surname>
12 <othername role="mi">O. C.</othername>
13 <affiliation><address><email>rjkm@metzlerbros.de</email></address></affiliation>
14 </author>
15 </authorgroup>
16 <authorgroup>
17 <author>
18 <firstname>Mauro</firstname>
19 <othername role="mi">Carvalho</othername>
20 <surname>Chehab</surname>
21 <affiliation><address><email>m.chehab@samsung.com</email></address></affiliation>
22 <contrib>Ported document to Docbook XML.</contrib>
23 </author>
24 </authorgroup>
25 <copyright>
26         <year>2002</year>
27         <year>2003</year>
28         <holder>Convergence GmbH</holder>
29 </copyright>
30 <copyright>
31         <year>2009-2015</year>
32         <holder>Mauro Carvalho Chehab</holder>
33 </copyright>
34
35 <revhistory>
36 <!-- Put document revisions here, newest first. -->
37 <revision>
38         <revnumber>2.1.0</revnumber>
39         <date>2015-05-29</date>
40         <authorinitials>mcc</authorinitials>
41         <revremark>
42                 DocBook improvements and cleanups, in order to document the
43                 system calls on a more standard way and provide more description
44                 about the current DVB API.
45         </revremark>
46 </revision>
47 <revision>
48         <revnumber>2.0.4</revnumber>
49         <date>2011-05-06</date>
50         <authorinitials>mcc</authorinitials>
51         <revremark>
52                 Add more information about DVB APIv5, better describing the frontend GET/SET props ioctl's.
53         </revremark>
54 </revision>
55 <revision>
56         <revnumber>2.0.3</revnumber>
57         <date>2010-07-03</date>
58         <authorinitials>mcc</authorinitials>
59         <revremark>
60                 Add some frontend capabilities flags, present on kernel, but missing at the specs.
61         </revremark>
62 </revision>
63 <revision>
64         <revnumber>2.0.2</revnumber>
65         <date>2009-10-25</date>
66         <authorinitials>mcc</authorinitials>
67         <revremark>
68                 documents FE_SET_FRONTEND_TUNE_MODE and FE_DISHETWORK_SEND_LEGACY_CMD ioctls.
69         </revremark>
70 </revision>
71 <revision>
72 <revnumber>2.0.1</revnumber>
73 <date>2009-09-16</date>
74 <authorinitials>mcc</authorinitials>
75 <revremark>
76 Added ISDB-T test originally written by Patrick Boettcher
77 </revremark>
78 </revision>
79 <revision>
80 <revnumber>2.0.0</revnumber>
81 <date>2009-09-06</date>
82 <authorinitials>mcc</authorinitials>
83 <revremark>Conversion from LaTex to DocBook XML. The
84         contents is the same as the original LaTex version.</revremark>
85 </revision>
86 <revision>
87 <revnumber>1.0.0</revnumber>
88 <date>2003-07-24</date>
89 <authorinitials>rjkm</authorinitials>
90 <revremark>Initial revision on LaTEX.</revremark>
91 </revision>
92 </revhistory>
93 </partinfo>
94
95
96 <title>LINUX DVB API</title>
97 <subtitle>Version 5.10</subtitle>
98 <!-- ADD THE CHAPTERS HERE -->
99   <chapter id="dvb_introdution">
100     &sub-intro;
101   </chapter>
102   <chapter id="dvb_frontend">
103     &sub-frontend;
104   </chapter>
105   <chapter id="dvb_demux">
106     &sub-demux;
107   </chapter>
108   <chapter id="dvb_ca">
109     &sub-ca;
110   </chapter>
111   <chapter id="net">
112     &sub-net;
113   </chapter>
114   <chapter id="legacy_dvb_apis">
115   <title>DVB Deprecated APIs</title>
116   <para>The APIs described here are kept only for historical reasons. There's
117       just one driver for a very legacy hardware that uses this API. No
118       modern drivers should use it. Instead, audio and video should be using
119       the V4L2 and ALSA APIs, and the pipelines should be set using the
120       Media Controller API</para>
121     <section id="dvb_video">
122         &sub-video;
123     </section>
124     <section id="dvb_audio">
125         &sub-audio;
126     </section>
127   </chapter>
128   <chapter id="dvb_kdapi">
129     &sub-kdapi;
130   </chapter>
131   <chapter id="dvb_examples">
132     &sub-examples;
133   </chapter>
134 <!-- END OF CHAPTERS -->
135   <appendix id="audio_h">
136     <title>DVB Audio Header File</title>
137     &sub-audio-h;
138   </appendix>
139   <appendix id="ca_h">
140     <title>DVB Conditional Access Header File</title>
141     &sub-ca-h;
142   </appendix>
143   <appendix id="dmx_h">
144     <title>DVB Demux Header File</title>
145     &sub-dmx-h;
146   </appendix>
147   <appendix id="frontend_h">
148     <title>DVB Frontend Header File</title>
149     &sub-frontend-h;
150   </appendix>
151   <appendix id="net_h">
152     <title>DVB Network Header File</title>
153     &sub-net-h;
154   </appendix>
155   <appendix id="video_h">
156     <title>DVB Video Header File</title>
157     &sub-video-h;
158   </appendix>
159