Newer
Older
ubixos-old / doc / doxygen / html / ipv4_2ip_8h-source.html
@CloudNine CloudNine on 28 Apr 2004 10 KB doxygen documentation added
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Ubixos: ip.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.3 -->
<h1>ip.h</h1><div class="fragment"><pre>00001 <span class="comment">/*</span>
00002 <span class="comment"> * Copyright (c) 2001, Swedish Institute of Computer Science.</span>
00003 <span class="comment"> * All rights reserved. </span>
00004 <span class="comment"> *</span>
00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without </span>
00006 <span class="comment"> * modification, are permitted provided that the following conditions </span>
00007 <span class="comment"> * are met: </span>
00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright </span>
00009 <span class="comment"> *    notice, this list of conditions and the following disclaimer. </span>
00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright </span>
00011 <span class="comment"> *    notice, this list of conditions and the following disclaimer in the </span>
00012 <span class="comment"> *    documentation and/or other materials provided with the distribution. </span>
00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors </span>
00014 <span class="comment"> *    may be used to endorse or promote products derived from this software </span>
00015 <span class="comment"> *    without specific prior written permission. </span>
00016 <span class="comment"> *</span>
00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND </span>
00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE </span>
00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE </span>
00020 <span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE </span>
00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL </span>
00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS </span>
00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) </span>
00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT </span>
00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY </span>
00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF </span>
00027 <span class="comment"> * SUCH DAMAGE. </span>
00028 <span class="comment"> *</span>
00029 <span class="comment"> * This file is part of the lwIP TCP/IP stack.</span>
00030 <span class="comment"> * </span>
00031 <span class="comment"> * Author: Adam Dunkels &lt;adam@sics.se&gt;</span>
00032 <span class="comment"> *</span>
00033 <span class="comment"> * $Id$</span>
00034 <span class="comment"> */</span>
00035 <span class="preprocessor">#ifndef __LWIP_IP_H__</span>
00036 <span class="preprocessor"></span><span class="preprocessor">#define __LWIP_IP_H__</span>
00037 <span class="preprocessor"></span>
00038 <span class="preprocessor">#include "net/arch.h"</span>
00039 
00040 <span class="preprocessor">#include "net/def.h"</span>
00041 <span class="preprocessor">#include "net/pbuf.h"</span>
00042 <span class="preprocessor">#include "net/ipv4/ip_addr.h"</span>
00043 <span class="preprocessor">#include "net/netif.h"</span>
00044 
00045 <span class="preprocessor">#include "net/err.h"</span>
00046 
00047 <span class="keywordtype">void</span> ip_init(<span class="keywordtype">void</span>);
00048 uInt8 ip_lookup(<span class="keywordtype">void</span> *header, <span class="keyword">struct</span> netif *inp);
00049 <span class="keyword">struct </span>netif *ip_route(<span class="keyword">struct</span> ip_addr *dest);
00050 err_t ip_input(<span class="keyword">struct</span> pbuf *p, <span class="keyword">struct</span> netif *inp);
00051 err_t ip_output(<span class="keyword">struct</span> pbuf *p, <span class="keyword">struct</span> ip_addr *src, <span class="keyword">struct</span> ip_addr *dest,
00052                 uInt8 ttl, uInt8 proto);
00053 err_t ip_output_if(<span class="keyword">struct</span> pbuf *p, <span class="keyword">struct</span> ip_addr *src, <span class="keyword">struct</span> ip_addr *dest,
00054                    uInt8 ttl, uInt8 proto,
00055                    <span class="keyword">struct</span> netif *netif);
00056 
00057 <span class="preprocessor">#define IP_HLEN 20</span>
00058 <span class="preprocessor"></span>
00059 <span class="preprocessor">#define IP_PROTO_ICMP 1</span>
00060 <span class="preprocessor"></span><span class="preprocessor">#define IP_PROTO_UDP 17</span>
00061 <span class="preprocessor"></span><span class="preprocessor">#define IP_PROTO_UDPLITE 170</span>
00062 <span class="preprocessor"></span><span class="preprocessor">#define IP_PROTO_TCP 6</span>
00063 <span class="preprocessor"></span>
00064 <span class="comment">/* This is passed as the destination address to ip_output_if (not</span>
00065 <span class="comment">   to ip_output), meaning that an IP header already is constructed</span>
00066 <span class="comment">   in the pbuf. This is used when TCP retransmits. */</span>
00067 <span class="preprocessor">#ifdef IP_HDRINCL</span>
00068 <span class="preprocessor"></span><span class="preprocessor">#undef IP_HDRINCL</span>
00069 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* IP_HDRINCL */</span>
00070 <span class="preprocessor">#define IP_HDRINCL  NULL</span>
00071 <span class="preprocessor"></span>
00072 <span class="keyword">struct </span>ip_hdr {
00073   <span class="comment">/* version / header length / type of service */</span>
00074   PACK_STRUCT_FIELD(uInt16 _v_hl_tos);
00075   <span class="comment">/* total length */</span>
00076   PACK_STRUCT_FIELD(uInt16 _len);
00077   <span class="comment">/* identification */</span>
00078   PACK_STRUCT_FIELD(uInt16 _id);
00079   <span class="comment">/* fragment offset field */</span>
00080   PACK_STRUCT_FIELD(uInt16 _offset);
00081 <span class="preprocessor">#define IP_RF 0x8000        </span><span class="comment">/* reserved fragment flag */</span>
00082 <span class="preprocessor">#define IP_DF 0x4000        </span><span class="comment">/* dont fragment flag */</span>
00083 <span class="preprocessor">#define IP_MF 0x2000        </span><span class="comment">/* more fragments flag */</span>
00084 <span class="preprocessor">#define IP_OFFMASK 0x1fff   </span><span class="comment">/* mask for fragmenting bits */</span>
00085   <span class="comment">/* time to live / protocol*/</span>
00086   PACK_STRUCT_FIELD(uInt16 _ttl_proto);
00087   <span class="comment">/* checksum */</span>
00088   PACK_STRUCT_FIELD(uInt16 _chksum);
00089   <span class="comment">/* source and destination IP addresses */</span>
00090   PACK_STRUCT_FIELD(<span class="keyword">struct</span> ip_addr src);
00091   PACK_STRUCT_FIELD(<span class="keyword">struct</span> ip_addr dest); 
00092 } PACK_STRUCT_STRUCT;
00093 
00094 <span class="preprocessor">#define IPH_V(hdr)  (NTOHS((hdr)-&gt;_v_hl_tos) &gt;&gt; 12)</span>
00095 <span class="preprocessor"></span><span class="preprocessor">#define IPH_HL(hdr) ((NTOHS((hdr)-&gt;_v_hl_tos) &gt;&gt; 8) &amp; 0x0f)</span>
00096 <span class="preprocessor"></span><span class="preprocessor">#define IPH_TOS(hdr) HTONS((NTOHS((hdr)-&gt;_v_hl_tos) &amp; 0xff))</span>
00097 <span class="preprocessor"></span><span class="preprocessor">#define IPH_LEN(hdr) ((hdr)-&gt;_len)</span>
00098 <span class="preprocessor"></span><span class="preprocessor">#define IPH_ID(hdr) ((hdr)-&gt;_id)</span>
00099 <span class="preprocessor"></span><span class="preprocessor">#define IPH_OFFSET(hdr) ((hdr)-&gt;_offset)</span>
00100 <span class="preprocessor"></span><span class="preprocessor">#define IPH_TTL(hdr) (NTOHS((hdr)-&gt;_ttl_proto) &gt;&gt; 8)</span>
00101 <span class="preprocessor"></span><span class="preprocessor">#define IPH_PROTO(hdr) (NTOHS((hdr)-&gt;_ttl_proto) &amp; 0xff)</span>
00102 <span class="preprocessor"></span><span class="preprocessor">#define IPH_CHKSUM(hdr) ((hdr)-&gt;_chksum)</span>
00103 <span class="preprocessor"></span>
00104 <span class="preprocessor">#define IPH_VHLTOS_SET(hdr, v, hl, tos) (hdr)-&gt;_v_hl_tos = HTONS(((v) &lt;&lt; 12) | ((hl) &lt;&lt; 8) | (tos))</span>
00105 <span class="preprocessor"></span><span class="preprocessor">#define IPH_LEN_SET(hdr, len) (hdr)-&gt;_len = (len)</span>
00106 <span class="preprocessor"></span><span class="preprocessor">#define IPH_ID_SET(hdr, id) (hdr)-&gt;_id = (id)</span>
00107 <span class="preprocessor"></span><span class="preprocessor">#define IPH_OFFSET_SET(hdr, off) (hdr)-&gt;_offset = (off)</span>
00108 <span class="preprocessor"></span><span class="preprocessor">#define IPH_TTL_SET(hdr, ttl) (hdr)-&gt;_ttl_proto = HTONS(IPH_PROTO(hdr) | ((ttl) &lt;&lt; 8))</span>
00109 <span class="preprocessor"></span><span class="preprocessor">#define IPH_PROTO_SET(hdr, proto) (hdr)-&gt;_ttl_proto = HTONS((proto) | (IPH_TTL(hdr) &lt;&lt; 8))</span>
00110 <span class="preprocessor"></span><span class="preprocessor">#define IPH_CHKSUM_SET(hdr, chksum) (hdr)-&gt;_chksum = (chksum)</span>
00111 <span class="preprocessor"></span>
00112 
00113 
00114 <span class="preprocessor">#if IP_DEBUG</span>
00115 <span class="preprocessor"></span><span class="keywordtype">void</span> ip_debug_print(<span class="keyword">struct</span> pbuf *p);
00116 <span class="preprocessor">#endif </span><span class="comment">/* IP_DEBUG */</span>
00117 
00118 <span class="preprocessor">#endif </span><span class="comment">/* __LWIP_IP_H__ */</span>
00119 
00120 
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Apr 28 17:49:35 2004 for Ubixos by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
</a>1.3.3 </small></address>
</body>
</html>