Documentation/DocBook/media/dvb/net.xml

   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
  11 <section id="dvb-net-if">
  12 <title>struct dvb_net_if</title>
  13 <programlisting>
  14 struct dvb_net_if {
  15         __u16 pid;
  16         __u16 if_num;
  17         __u8  feedtype;
  18 #define DVB_NET_FEEDTYPE_MPE 0  /&#x22C6; multi protocol encapsulation &#x22C6;/
  19 #define DVB_NET_FEEDTYPE_ULE 1  /&#x22C6; ultra lightweight encapsulation &#x22C6;/
  20 };
  21 </programlisting>
  22 </section>
  23
  24 </section>
  25 <section id="net_fcalls">
  26 <title>DVB net Function Calls</title>
  27 <para>To be written&#x2026;
  28 </para>
  29
  30 <section id="NET_ADD_IF"
  31 role="subsection"><title>NET_ADD_IF</title>
  32 <para>DESCRIPTION
  33 </para>
  34 <informaltable><tgroup cols="1"><tbody><row><entry
  35  align="char">
  36 <para>This ioctl is undocumented. Documentation is welcome.</para>
  37 </entry>
  38  </row></tbody></tgroup></informaltable>
  39 <para>SYNOPSIS
  40 </para>
  41 <informaltable><tgroup cols="1"><tbody><row><entry
  42  align="char">
  43 <para>int ioctl(fd, int request = NET_ADD_IF,
  44  struct dvb_net_if *if);</para>
  45 </entry>
  46  </row></tbody></tgroup></informaltable>
  47 <para>PARAMETERS
  48 </para>
  49 <informaltable><tgroup cols="2"><tbody><row><entry
  50  align="char">
  51 <para>int fd</para>
  52 </entry><entry
  53  align="char">
  54 <para>File descriptor returned by a previous call to open().</para>
  55 </entry>
  56  </row><row><entry
  57  align="char">
  58 <para>int request</para>
  59 </entry><entry
  60  align="char">
  61 <para>Equals NET_ADD_IF for this command.</para>
  62 </entry>
  63  </row><row><entry
  64  align="char">
  65 <para>struct dvb_net_if *if
  66 </para>
  67 </entry><entry
  68  align="char">
  69 <para>Undocumented.</para>
  70 </entry>
  71  </row></tbody></tgroup></informaltable>
  72 &return-value-dvb;
  73 </section>
  74
  75 <section id="NET_REMOVE_IF"
  76 role="subsection"><title>NET_REMOVE_IF</title>
  77 <para>DESCRIPTION
  78 </para>
  79 <informaltable><tgroup cols="1"><tbody><row><entry
  80  align="char">
  81 <para>This ioctl is undocumented. Documentation is welcome.</para>
  82 </entry>
  83  </row></tbody></tgroup></informaltable>
  84 <para>SYNOPSIS
  85 </para>
  86 <informaltable><tgroup cols="1"><tbody><row><entry
  87  align="char">
  88 <para>int ioctl(fd, int request = NET_REMOVE_IF);
  89 </para>
  90 </entry>
  91  </row></tbody></tgroup></informaltable>
  92 <para>PARAMETERS
  93 </para>
  94 <informaltable><tgroup cols="2"><tbody><row><entry
  95  align="char">
  96 <para>int fd</para>
  97 </entry><entry
  98  align="char">
  99 <para>File descriptor returned by a previous call to open().</para>
 100 </entry>
 101  </row><row><entry
 102  align="char">
 103 <para>int request</para>
 104 </entry><entry
 105  align="char">
 106 <para>Equals NET_REMOVE_IF for this command.</para>
 107 </entry>
 108  </row></tbody></tgroup></informaltable>
 109 &return-value-dvb;
 110 </section>
 111
 112 <section id="NET_GET_IF"
 113 role="subsection"><title>NET_GET_IF</title>
 114 <para>DESCRIPTION
 115 </para>
 116 <informaltable><tgroup cols="1"><tbody><row><entry
 117  align="char">
 118 <para>This ioctl is undocumented. Documentation is welcome.</para>
 119 </entry>
 120  </row></tbody></tgroup></informaltable>
 121 <para>SYNOPSIS
 122 </para>
 123 <informaltable><tgroup cols="1"><tbody><row><entry
 124  align="char">
 125 <para>int ioctl(fd, int request = NET_GET_IF,
 126  struct dvb_net_if *if);</para>
 127 </entry>
 128  </row></tbody></tgroup></informaltable>
 129 <para>PARAMETERS
 130 </para>
 131 <informaltable><tgroup cols="2"><tbody><row><entry
 132  align="char">
 133 <para>int fd</para>
 134 </entry><entry
 135  align="char">
 136 <para>File descriptor returned by a previous call to open().</para>
 137 </entry>
 138  </row><row><entry
 139  align="char">
 140 <para>int request</para>
 141 </entry><entry
 142  align="char">
 143 <para>Equals NET_GET_IF for this command.</para>
 144 </entry>
 145  </row><row><entry
 146  align="char">
 147 <para>struct dvb_net_if *if
 148 </para>
 149 </entry><entry
 150  align="char">
 151 <para>Undocumented.</para>
 152 </entry>
 153  </row></tbody></tgroup></informaltable>
 154 &return-value-dvb;
 155 </section>
 156 </section>