net.xml 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. <title>DVB Network API</title>
  2. <para>The DVB net device enables feeding of MPE (multi protocol encapsulation) packets
  3. received via DVB into the Linux network protocol stack, e.g. for internet via satellite
  4. applications. It can be accessed through <emphasis role="tt">/dev/dvb/adapter0/net0</emphasis>. Data types and
  5. and ioctl definitions can be accessed by including <emphasis role="tt">linux/dvb/net.h</emphasis> in your
  6. application.
  7. </para>
  8. <section id="dvb_net_types">
  9. <title>DVB Net Data Types</title>
  10. <section id="dvb-net-if">
  11. <title>struct dvb_net_if</title>
  12. <programlisting>
  13. struct dvb_net_if {
  14. __u16 pid;
  15. __u16 if_num;
  16. __u8 feedtype;
  17. #define DVB_NET_FEEDTYPE_MPE 0 /&#x22C6; multi protocol encapsulation &#x22C6;/
  18. #define DVB_NET_FEEDTYPE_ULE 1 /&#x22C6; ultra lightweight encapsulation &#x22C6;/
  19. };
  20. </programlisting>
  21. </section>
  22. </section>
  23. <section id="net_fcalls">
  24. <title>DVB net Function Calls</title>
  25. <para>To be written&#x2026;
  26. </para>
  27. <section id="NET_ADD_IF"
  28. role="subsection"><title>NET_ADD_IF</title>
  29. <para>DESCRIPTION
  30. </para>
  31. <informaltable><tgroup cols="1"><tbody><row><entry
  32. align="char">
  33. <para>This ioctl is undocumented. Documentation is welcome.</para>
  34. </entry>
  35. </row></tbody></tgroup></informaltable>
  36. <para>SYNOPSIS
  37. </para>
  38. <informaltable><tgroup cols="1"><tbody><row><entry
  39. align="char">
  40. <para>int ioctl(fd, int request = NET_ADD_IF,
  41. struct dvb_net_if *if);</para>
  42. </entry>
  43. </row></tbody></tgroup></informaltable>
  44. <para>PARAMETERS
  45. </para>
  46. <informaltable><tgroup cols="2"><tbody><row><entry
  47. align="char">
  48. <para>int fd</para>
  49. </entry><entry
  50. align="char">
  51. <para>File descriptor returned by a previous call to open().</para>
  52. </entry>
  53. </row><row><entry
  54. align="char">
  55. <para>int request</para>
  56. </entry><entry
  57. align="char">
  58. <para>Equals NET_ADD_IF for this command.</para>
  59. </entry>
  60. </row><row><entry
  61. align="char">
  62. <para>struct dvb_net_if *if
  63. </para>
  64. </entry><entry
  65. align="char">
  66. <para>Undocumented.</para>
  67. </entry>
  68. </row></tbody></tgroup></informaltable>
  69. &return-value-dvb;
  70. </section>
  71. <section id="NET_REMOVE_IF"
  72. role="subsection"><title>NET_REMOVE_IF</title>
  73. <para>DESCRIPTION
  74. </para>
  75. <informaltable><tgroup cols="1"><tbody><row><entry
  76. align="char">
  77. <para>This ioctl is undocumented. Documentation is welcome.</para>
  78. </entry>
  79. </row></tbody></tgroup></informaltable>
  80. <para>SYNOPSIS
  81. </para>
  82. <informaltable><tgroup cols="1"><tbody><row><entry
  83. align="char">
  84. <para>int ioctl(fd, int request = NET_REMOVE_IF);
  85. </para>
  86. </entry>
  87. </row></tbody></tgroup></informaltable>
  88. <para>PARAMETERS
  89. </para>
  90. <informaltable><tgroup cols="2"><tbody><row><entry
  91. align="char">
  92. <para>int fd</para>
  93. </entry><entry
  94. align="char">
  95. <para>File descriptor returned by a previous call to open().</para>
  96. </entry>
  97. </row><row><entry
  98. align="char">
  99. <para>int request</para>
  100. </entry><entry
  101. align="char">
  102. <para>Equals NET_REMOVE_IF for this command.</para>
  103. </entry>
  104. </row></tbody></tgroup></informaltable>
  105. &return-value-dvb;
  106. </section>
  107. <section id="NET_GET_IF"
  108. role="subsection"><title>NET_GET_IF</title>
  109. <para>DESCRIPTION
  110. </para>
  111. <informaltable><tgroup cols="1"><tbody><row><entry
  112. align="char">
  113. <para>This ioctl is undocumented. Documentation is welcome.</para>
  114. </entry>
  115. </row></tbody></tgroup></informaltable>
  116. <para>SYNOPSIS
  117. </para>
  118. <informaltable><tgroup cols="1"><tbody><row><entry
  119. align="char">
  120. <para>int ioctl(fd, int request = NET_GET_IF,
  121. struct dvb_net_if *if);</para>
  122. </entry>
  123. </row></tbody></tgroup></informaltable>
  124. <para>PARAMETERS
  125. </para>
  126. <informaltable><tgroup cols="2"><tbody><row><entry
  127. align="char">
  128. <para>int fd</para>
  129. </entry><entry
  130. align="char">
  131. <para>File descriptor returned by a previous call to open().</para>
  132. </entry>
  133. </row><row><entry
  134. align="char">
  135. <para>int request</para>
  136. </entry><entry
  137. align="char">
  138. <para>Equals NET_GET_IF for this command.</para>
  139. </entry>
  140. </row><row><entry
  141. align="char">
  142. <para>struct dvb_net_if *if
  143. </para>
  144. </entry><entry
  145. align="char">
  146. <para>Undocumented.</para>
  147. </entry>
  148. </row></tbody></tgroup></informaltable>
  149. &return-value-dvb;
  150. </section>
  151. </section>