| Line No. | Rev | Author | Line |
|---|---|---|---|
| 1 | 6 | kaklik | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
| 3 | <title>Procyon AVRlib: Network support library (net.c)</title> |
||
| 4 | <link href="dox.css" rel="stylesheet" type="text/css"> |
||
| 5 | </head><body> |
||
| 6 | <!-- Generated by Doxygen 1.4.2 --> |
||
| 7 | <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
||
| 8 | <h1>Network support library (net.c)<br> |
||
| 9 | <small> |
||
| 10 | [<a class="el" href="group__network.html">Network Library</a>]</small> |
||
| 11 | </h1><hr><a name="_details"></a><h2>Detailed Description</h2> |
||
| 12 | <div class="fragment"><pre class="fragment"><span class="preprocessor"> #include "<a class="code" href="net_8h.html">net/net.h</a>"</span> |
||
| 13 | </pre></div> <dl compact><dt><b>Description</b></dt><dd>This is a general network support library including a multitude of structure definitions for various types of network packets, functions and macros for switching byte order, and an RFC-compliant function for calculating checksums. </dd></dl> |
||
| 14 | |||
| 15 | <p> |
||
| 16 | <table border="0" cellpadding="0" cellspacing="0"> |
||
| 17 | <tr><td></td></tr> |
||
| 18 | <tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> |
||
| 19 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>netEthAddr</b></td></tr> |
||
| 20 | |||
| 21 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>netEthHeader</b></td></tr> |
||
| 22 | |||
| 23 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>netArpHeader</b></td></tr> |
||
| 24 | |||
| 25 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>netIpHeader</b></td></tr> |
||
| 26 | |||
| 27 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>netIcmpHeader</b></td></tr> |
||
| 28 | |||
| 29 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>netUdpHeader</b></td></tr> |
||
| 30 | |||
| 31 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>netTcpHeader</b></td></tr> |
||
| 32 | |||
| 33 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>netEthArpHeader</b></td></tr> |
||
| 34 | |||
| 35 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>netEthIpHeader</b></td></tr> |
||
| 36 | |||
| 37 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>tcpip_hdr</b></td></tr> |
||
| 38 | |||
| 39 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>icmpip_hdr</b></td></tr> |
||
| 40 | |||
| 41 | <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>udpip_hdr</b></td></tr> |
||
| 42 | |||
| 43 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
| 44 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga10" doxytag="net::ETH_HEADER_LEN"></a> |
||
| 45 | #define </td><td class="memItemRight" valign="bottom"><b>ETH_HEADER_LEN</b> 14</td></tr> |
||
| 46 | |||
| 47 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga11" doxytag="net::ETHTYPE_ARP"></a> |
||
| 48 | #define </td><td class="memItemRight" valign="bottom"><b>ETHTYPE_ARP</b> 0x0806</td></tr> |
||
| 49 | |||
| 50 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga12" doxytag="net::ETHTYPE_IP"></a> |
||
| 51 | #define </td><td class="memItemRight" valign="bottom"><b>ETHTYPE_IP</b> 0x0800</td></tr> |
||
| 52 | |||
| 53 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga13" doxytag="net::ETHTYPE_IP6"></a> |
||
| 54 | #define </td><td class="memItemRight" valign="bottom"><b>ETHTYPE_IP6</b> 0x86dd</td></tr> |
||
| 55 | |||
| 56 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga14" doxytag="net::ARP_OPCODE_REQUEST"></a> |
||
| 57 | #define </td><td class="memItemRight" valign="bottom"><b>ARP_OPCODE_REQUEST</b> 1</td></tr> |
||
| 58 | |||
| 59 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga15" doxytag="net::ARP_OPCODE_REPLY"></a> |
||
| 60 | #define </td><td class="memItemRight" valign="bottom"><b>ARP_OPCODE_REPLY</b> 2</td></tr> |
||
| 61 | |||
| 62 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga16" doxytag="net::ARP_HWTYPE_ETH"></a> |
||
| 63 | #define </td><td class="memItemRight" valign="bottom"><b>ARP_HWTYPE_ETH</b> 1</td></tr> |
||
| 64 | |||
| 65 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga17" doxytag="net::IP_HEADER_LEN"></a> |
||
| 66 | #define </td><td class="memItemRight" valign="bottom"><b>IP_HEADER_LEN</b> 20</td></tr> |
||
| 67 | |||
| 68 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga18" doxytag="net::IP_PROTO_ICMP"></a> |
||
| 69 | #define </td><td class="memItemRight" valign="bottom"><b>IP_PROTO_ICMP</b> 1</td></tr> |
||
| 70 | |||
| 71 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga19" doxytag="net::IP_PROTO_TCP"></a> |
||
| 72 | #define </td><td class="memItemRight" valign="bottom"><b>IP_PROTO_TCP</b> 6</td></tr> |
||
| 73 | |||
| 74 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga20" doxytag="net::IP_PROTO_UDP"></a> |
||
| 75 | #define </td><td class="memItemRight" valign="bottom"><b>IP_PROTO_UDP</b> 17</td></tr> |
||
| 76 | |||
| 77 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga21" doxytag="net::ICMP_HEADER_LEN"></a> |
||
| 78 | #define </td><td class="memItemRight" valign="bottom"><b>ICMP_HEADER_LEN</b> 8</td></tr> |
||
| 79 | |||
| 80 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga22" doxytag="net::ICMP_TYPE_ECHOREPLY"></a> |
||
| 81 | #define </td><td class="memItemRight" valign="bottom"><b>ICMP_TYPE_ECHOREPLY</b> 0</td></tr> |
||
| 82 | |||
| 83 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga23" doxytag="net::ICMP_TYPE_ECHOREQUEST"></a> |
||
| 84 | #define </td><td class="memItemRight" valign="bottom"><b>ICMP_TYPE_ECHOREQUEST</b> 8</td></tr> |
||
| 85 | |||
| 86 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga24" doxytag="net::UDP_HEADER_LEN"></a> |
||
| 87 | #define </td><td class="memItemRight" valign="bottom"><b>UDP_HEADER_LEN</b> 8</td></tr> |
||
| 88 | |||
| 89 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga25" doxytag="net::TCP_HEADER_LEN"></a> |
||
| 90 | #define </td><td class="memItemRight" valign="bottom"><b>TCP_HEADER_LEN</b> 20</td></tr> |
||
| 91 | |||
| 92 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga26" doxytag="net::TCP_FLAGS_FIN"></a> |
||
| 93 | #define </td><td class="memItemRight" valign="bottom"><b>TCP_FLAGS_FIN</b> 0x01</td></tr> |
||
| 94 | |||
| 95 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga27" doxytag="net::TCP_FLAGS_SYN"></a> |
||
| 96 | #define </td><td class="memItemRight" valign="bottom"><b>TCP_FLAGS_SYN</b> 0x02</td></tr> |
||
| 97 | |||
| 98 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga28" doxytag="net::TCP_FLAGS_RST"></a> |
||
| 99 | #define </td><td class="memItemRight" valign="bottom"><b>TCP_FLAGS_RST</b> 0x04</td></tr> |
||
| 100 | |||
| 101 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga29" doxytag="net::TCP_FLAGS_PSH"></a> |
||
| 102 | #define </td><td class="memItemRight" valign="bottom"><b>TCP_FLAGS_PSH</b> 0x08</td></tr> |
||
| 103 | |||
| 104 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga30" doxytag="net::TCP_FLAGS_ACK"></a> |
||
| 105 | #define </td><td class="memItemRight" valign="bottom"><b>TCP_FLAGS_ACK</b> 0x10</td></tr> |
||
| 106 | |||
| 107 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga31" doxytag="net::TCP_FLAGS_URG"></a> |
||
| 108 | #define </td><td class="memItemRight" valign="bottom"><b>TCP_FLAGS_URG</b> 0x20</td></tr> |
||
| 109 | |||
| 110 | <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga32">IPDOT</a>(a, b, c, d) ((a<<24)|(b<<16)|(c<<8)|(d))</td></tr> |
||
| 111 | |||
| 112 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga33" doxytag="net::HTONS"></a> |
||
| 113 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga33">HTONS</a>(s) ((s<<8) | (s>>8))</td></tr> |
||
| 114 | |||
| 115 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Host-to-Network SHORT (16-bit) byte-order swap (macro). <br></td></tr> |
||
| 116 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga34" doxytag="net::HTONL"></a> |
||
| 117 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga34">HTONL</a>(l) ((l<<24) | ((l&0x00FF0000l)>>8) | ((l&0x0000FF00l)<<8) | (l>>24))</td></tr> |
||
| 118 | |||
| 119 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Host-to-Network LONG (32-bit) byte-order swap (macro). <br></td></tr> |
||
| 120 | <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> |
||
| 121 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1" doxytag="net::ip_hdr"></a> |
||
| 122 | typedef netIpHeader </td><td class="memItemRight" valign="bottom"><b>ip_hdr</b></td></tr> |
||
| 123 | |||
| 124 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
| 125 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga2" doxytag="net::htons"></a> |
||
| 126 | uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga2">htons</a> (uint16_t val)</td></tr> |
||
| 127 | |||
| 128 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Host-to-Network SHORT (16-bit) byte-order swap (function). <br></td></tr> |
||
| 129 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3" doxytag="net::htonl"></a> |
||
| 130 | uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga3">htonl</a> (uint32_t val)</td></tr> |
||
| 131 | |||
| 132 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Host-to-Network LONG (32-bit) byte-order swap (function). <br></td></tr> |
||
| 133 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga4" doxytag="net::netChecksum"></a> |
||
| 134 | uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga4">netChecksum</a> (void *data, uint16_t len)</td></tr> |
||
| 135 | |||
| 136 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate IP-style checksum from data. <br></td></tr> |
||
| 137 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5" doxytag="net::netPrintEthAddr"></a> |
||
| 138 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga5">netPrintEthAddr</a> (struct netEthAddr *ethaddr)</td></tr> |
||
| 139 | |||
| 140 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Print Ethernet address in XX:XX:XX:XX:XX:XX format. <br></td></tr> |
||
| 141 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6" doxytag="net::netPrintIPAddr"></a> |
||
| 142 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga6">netPrintIPAddr</a> (uint32_t ipaddr)</td></tr> |
||
| 143 | |||
| 144 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Print IP address in dot notation. <br></td></tr> |
||
| 145 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga7" doxytag="net::netPrintEthHeader"></a> |
||
| 146 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga7">netPrintEthHeader</a> (struct netEthHeader *eth_hdr)</td></tr> |
||
| 147 | |||
| 148 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Print Ethernet header information. <br></td></tr> |
||
| 149 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga8" doxytag="net::netPrintIpHeader"></a> |
||
| 150 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga8">netPrintIpHeader</a> (struct netIpHeader *ipheader)</td></tr> |
||
| 151 | |||
| 152 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Print IP header information. <br></td></tr> |
||
| 153 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga9" doxytag="net::netPrintTcpHeader"></a> |
||
| 154 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__net.html#ga9">netPrintTcpHeader</a> (struct netTcpHeader *tcpheader)</td></tr> |
||
| 155 | |||
| 156 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Print TCP header information. <br></td></tr> |
||
| 157 | <tr><td colspan="2"><br><h2>Variables</h2></td></tr> |
||
| 158 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga0" doxytag="net::GNUC_PACKED"></a> |
||
| 159 | netEthAddr </td><td class="memItemRight" valign="bottom"><b>GNUC_PACKED</b></td></tr> |
||
| 160 | |||
| 161 | </table> |
||
| 162 | <hr><h2>Define Documentation</h2> |
||
| 163 | <a class="anchor" name="ga32" doxytag="net.h::IPDOT"></a><p> |
||
| 164 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
| 165 | <tr> |
||
| 166 | <td class="mdRow"> |
||
| 167 | <table cellpadding="0" cellspacing="0" border="0"> |
||
| 168 | <tr> |
||
| 169 | <td class="md" nowrap valign="top">#define IPDOT </td> |
||
| 170 | <td class="md" valign="top">( </td> |
||
| 171 | <td class="md" nowrap valign="top">a, <tr> |
||
| 172 | <td class="md" nowrap align="right"></td> |
||
| 173 | <td class="md"></td> |
||
| 174 | <td class="md" nowrap>b, <tr> |
||
| 175 | <td class="md" nowrap align="right"></td> |
||
| 176 | <td class="md"></td> |
||
| 177 | <td class="md" nowrap>c, <tr> |
||
| 178 | <td class="md" nowrap align="right"></td> |
||
| 179 | <td class="md"></td> |
||
| 180 | <td class="md" nowrap>d </td> |
||
| 181 | <td class="mdname1" valign="top" nowrap> </td> |
||
| 182 | <td class="md" valign="top"> ) </td> |
||
| 183 | <td class="md" nowrap> ((a<<24)|(b<<16)|(c<<8)|(d))</td> |
||
| 184 | </tr> |
||
| 185 | </table> |
||
| 186 | </td> |
||
| 187 | </tr> |
||
| 188 | </table> |
||
| 189 | <table cellspacing="5" cellpadding="0" border="0"> |
||
| 190 | <tr> |
||
| 191 | <td> |
||
| 192 | |
||
| 193 | </td> |
||
| 194 | <td> |
||
| 195 | |||
| 196 | <p> |
||
| 197 | Convert dot-notation IP address into 32-bit word. Example: <a class="el" href="group__net.html#ga32">IPDOT(192l,168l,1l,1l)</a> |
||
| 198 | <p> |
||
| 199 | Definition at line <a class="el" href="net_8h-source.html#l00178">178</a> of file <a class="el" href="net_8h-source.html">net.h</a>. </td> |
||
| 200 | </tr> |
||
| 201 | </table> |
||
| 202 | <hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:10 2006 for Procyon AVRlib by |
||
| 203 | <a href="http://www.doxygen.org/index.html"> |
||
| 204 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
| 205 | </body> |
||
| 206 | </html> |
Powered by WebSVN v2.8.3