<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>UbixOS V2: src/sys/include/net/ipv4/ip.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="dir_897b6a2d7bab147dd1db58381aad3984.html">src</a> » <a class="el" href="dir_832905b1f7f5feaf61a306b40c0ac817.html">sys</a> » <a class="el" href="dir_caf4200c438ae9601464168e21e8e4d8.html">include</a> » <a class="el" href="dir_c1d11d251a83b2498f44d410b793c5eb.html">net</a> » <a class="el" href="dir_c3e84400a32e4fc888777536359ca22b.html">ipv4</a></div>
<h1>ip.h</h1><a href="ipv4_2ip_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2001, Swedish Institute of Computer Science.</span>
<a name="l00003"></a>00003 <span class="comment"> * All rights reserved. </span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without </span>
<a name="l00006"></a>00006 <span class="comment"> * modification, are permitted provided that the following conditions </span>
<a name="l00007"></a>00007 <span class="comment"> * are met: </span>
<a name="l00008"></a>00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright </span>
<a name="l00009"></a>00009 <span class="comment"> * notice, this list of conditions and the following disclaimer. </span>
<a name="l00010"></a>00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright </span>
<a name="l00011"></a>00011 <span class="comment"> * notice, this list of conditions and the following disclaimer in the </span>
<a name="l00012"></a>00012 <span class="comment"> * documentation and/or other materials provided with the distribution. </span>
<a name="l00013"></a>00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors </span>
<a name="l00014"></a>00014 <span class="comment"> * may be used to endorse or promote products derived from this software </span>
<a name="l00015"></a>00015 <span class="comment"> * without specific prior written permission. </span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND </span>
<a name="l00018"></a>00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE </span>
<a name="l00019"></a>00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE </span>
<a name="l00020"></a>00020 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE </span>
<a name="l00021"></a>00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL </span>
<a name="l00022"></a>00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS </span>
<a name="l00023"></a>00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) </span>
<a name="l00024"></a>00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT </span>
<a name="l00025"></a>00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY </span>
<a name="l00026"></a>00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF </span>
<a name="l00027"></a>00027 <span class="comment"> * SUCH DAMAGE. </span>
<a name="l00028"></a>00028 <span class="comment"> *</span>
<a name="l00029"></a>00029 <span class="comment"> * This file is part of the lwIP TCP/IP stack.</span>
<a name="l00030"></a>00030 <span class="comment"> * </span>
<a name="l00031"></a>00031 <span class="comment"> * Author: Adam Dunkels <adam@sics.se></span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * $Id: ipv4_2ip_8h-source.html 88 2016-01-12 00:11:29Z reddawg $</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef __LWIP_IP_H__</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define __LWIP_IP_H__</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include "<a class="code" href="arch_8h.html">net/arch.h</a>"</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="def_8h.html">net/def.h</a>"</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="pbuf_8h.html">net/pbuf.h</a>"</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include "<a class="code" href="ipv4_2ip__addr_8h.html">net/ipv4/ip_addr.h</a>"</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include "<a class="code" href="netif_8h.html">net/netif.h</a>"</span>
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="preprocessor">#include "<a class="code" href="err_8h.html">net/err.h</a>"</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keywordtype">void</span> <a class="code" href="ipv4_2ip_8h.html#8be0857c3bd133182ecd9e0dd700f7c7">ip_init</a>(<span class="keywordtype">void</span>);
<a name="l00048"></a>00048 <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> <a class="code" href="ipv4_2ip_8h.html#b3e95b26f169c5d3ed21c88553052a3d">ip_lookup</a>(<span class="keywordtype">void</span> *header, <span class="keyword">struct</span> <a class="code" href="structnetif.html">netif</a> *inp);
<a name="l00049"></a>00049 <span class="keyword">struct </span><a class="code" href="structnetif.html">netif</a> *<a class="code" href="ipv4_2ip_8h.html#27aecc05841bdece5d6bed810cc0ce71">ip_route</a>(<span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *dest);
<a name="l00050"></a>00050 <a class="code" href="err_8h.html#b7190f3da5c85931fc059e0312bc1407">err_t</a> <a class="code" href="ipv4_2ip_8h.html#3c420dab0c6760df099a2d688fa42a26">ip_input</a>(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p, <span class="keyword">struct</span> <a class="code" href="structnetif.html">netif</a> *inp);
<a name="l00051"></a>00051 <a class="code" href="err_8h.html#b7190f3da5c85931fc059e0312bc1407">err_t</a> <a class="code" href="ipv4_2ip_8h.html#c360020282b7630ac9e9780e7a5bb758">ip_output</a>(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p, <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *src, <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *dest,
<a name="l00052"></a>00052 <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> ttl, <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> proto);
<a name="l00053"></a>00053 <a class="code" href="err_8h.html#b7190f3da5c85931fc059e0312bc1407">err_t</a> <a class="code" href="ipv4_2ip_8h.html#786ad4beeca101382b74feb53bd3b05d">ip_output_if</a>(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p, <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *src, <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *dest,
<a name="l00054"></a>00054 <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> ttl, <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> proto,
<a name="l00055"></a>00055 <span class="keyword">struct</span> <a class="code" href="structnetif.html">netif</a> *<a class="code" href="structnetif.html">netif</a>);
<a name="l00056"></a>00056
<a name="l00057"></a><a class="code" href="ipv4_2ip_8h.html#d76777d4d34f33ab5f715f9ca15503c3">00057</a> <span class="preprocessor">#define IP_HLEN 20</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span>
<a name="l00059"></a><a class="code" href="ipv4_2ip_8h.html#acaea7b8c4c8a5229c02b653766b4793">00059</a> <span class="preprocessor">#define IP_PROTO_ICMP 1</span>
<a name="l00060"></a><a class="code" href="ipv4_2ip_8h.html#76212e7ef71a99646040d2e454388bed">00060</a> <span class="preprocessor"></span><span class="preprocessor">#define IP_PROTO_UDP 17</span>
<a name="l00061"></a><a class="code" href="ipv4_2ip_8h.html#3ef2b8a1cb4f7acee3142337438dfd0d">00061</a> <span class="preprocessor"></span><span class="preprocessor">#define IP_PROTO_UDPLITE 170</span>
<a name="l00062"></a><a class="code" href="ipv4_2ip_8h.html#634284ee3a136d6ad61bc5d917ebb82f">00062</a> <span class="preprocessor"></span><span class="preprocessor">#define IP_PROTO_TCP 6</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span>
<a name="l00064"></a>00064 <span class="comment">/* This is passed as the destination address to ip_output_if (not</span>
<a name="l00065"></a>00065 <span class="comment"> to ip_output), meaning that an IP header already is constructed</span>
<a name="l00066"></a>00066 <span class="comment"> in the pbuf. This is used when TCP retransmits. */</span>
<a name="l00067"></a>00067 <span class="preprocessor">#ifdef IP_HDRINCL</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span><span class="preprocessor">#undef IP_HDRINCL</span>
<a name="l00069"></a>00069 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* IP_HDRINCL */</span>
<a name="l00070"></a><a class="code" href="ipv4_2ip_8h.html#4c4294940df109ad673a7295b74259b0">00070</a> <span class="preprocessor">#define IP_HDRINCL NULL</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span>
<a name="l00072"></a><a class="code" href="structip__hdr.html">00072</a> <span class="keyword">struct </span><a class="code" href="structip__hdr.html">ip_hdr</a> {
<a name="l00073"></a>00073 <span class="comment">/* version / header length / type of service */</span>
<a name="l00074"></a>00074 <a class="code" href="structip__hdr.html#3fef89164693599490d3bfcd3faf25df">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> _v_hl_tos);
<a name="l00075"></a>00075 <span class="comment">/* total length */</span>
<a name="l00076"></a>00076 <a class="code" href="structip__hdr.html#3fef89164693599490d3bfcd3faf25df">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> _len);
<a name="l00077"></a>00077 <span class="comment">/* identification */</span>
<a name="l00078"></a>00078 <a class="code" href="structip__hdr.html#3fef89164693599490d3bfcd3faf25df">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> _id);
<a name="l00079"></a>00079 <span class="comment">/* fragment offset field */</span>
<a name="l00080"></a>00080 <a class="code" href="structip__hdr.html#3fef89164693599490d3bfcd3faf25df">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> _offset);
<a name="l00081"></a><a class="code" href="ipv4_2ip_8h.html#895709708f8f909cf7b7459491d549e7">00081</a> <span class="preprocessor">#define IP_RF 0x8000 </span><span class="comment">/* reserved fragment flag */</span>
<a name="l00082"></a><a class="code" href="ipv4_2ip_8h.html#e2473f4a88d141d5298f92a4335b714a">00082</a> <span class="preprocessor">#define IP_DF 0x4000 </span><span class="comment">/* dont fragment flag */</span>
<a name="l00083"></a><a class="code" href="ipv4_2ip_8h.html#e8afe1e04bb9bad791443556c3b2cd73">00083</a> <span class="preprocessor">#define IP_MF 0x2000 </span><span class="comment">/* more fragments flag */</span>
<a name="l00084"></a><a class="code" href="ipv4_2ip_8h.html#d059798b16d1f615b5af8770175121ba">00084</a> <span class="preprocessor">#define IP_OFFMASK 0x1fff </span><span class="comment">/* mask for fragmenting bits */</span>
<a name="l00085"></a>00085 <span class="comment">/* time to live / protocol*/</span>
<a name="l00086"></a>00086 <a class="code" href="structip__hdr.html#3fef89164693599490d3bfcd3faf25df">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> _ttl_proto);
<a name="l00087"></a>00087 <span class="comment">/* checksum */</span>
<a name="l00088"></a>00088 <a class="code" href="structip__hdr.html#3fef89164693599490d3bfcd3faf25df">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> _chksum);
<a name="l00089"></a>00089 <span class="comment">/* source and destination IP addresses */</span>
<a name="l00090"></a>00090 <a class="code" href="structip__hdr.html#3fef89164693599490d3bfcd3faf25df">PACK_STRUCT_FIELD</a>(<span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> src);
<a name="l00091"></a>00091 <a class="code" href="structip__hdr.html#3fef89164693599490d3bfcd3faf25df">PACK_STRUCT_FIELD</a>(<span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> <a class="code" href="structip__hdr.html#815e233e57dabbb88731c7454498286c">dest</a>);
<a name="l00092"></a>00092 } <a class="code" href="cc_8h.html#33623da05bb55497534c3dc26ebebeb2">PACK_STRUCT_STRUCT</a>;
<a name="l00093"></a>00093
<a name="l00094"></a><a class="code" href="ipv4_2ip_8h.html#05a9e8ecf4eff38244b4c13c7e70094c">00094</a> <span class="preprocessor">#define IPH_V(hdr) (NTOHS((hdr)->_v_hl_tos) >> 12)</span>
<a name="l00095"></a><a class="code" href="ipv4_2ip_8h.html#7c60caeb708571a07a44309c10ec3a01">00095</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_HL(hdr) ((NTOHS((hdr)->_v_hl_tos) >> 8) & 0x0f)</span>
<a name="l00096"></a><a class="code" href="ipv4_2ip_8h.html#13fb5476ab97db9c5de6c1f5ca0d82e6">00096</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_TOS(hdr) HTONS((NTOHS((hdr)->_v_hl_tos) & 0xff))</span>
<a name="l00097"></a><a class="code" href="ipv4_2ip_8h.html#ec0328fe4711b8c1ef4dd6709e4fd6d5">00097</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_LEN(hdr) ((hdr)->_len)</span>
<a name="l00098"></a><a class="code" href="ipv4_2ip_8h.html#e79eaecc0bf9e4dbb9e47ea56ad2157a">00098</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_ID(hdr) ((hdr)->_id)</span>
<a name="l00099"></a><a class="code" href="ipv4_2ip_8h.html#559dce3878f1d6a46bcb4cb312962397">00099</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_OFFSET(hdr) ((hdr)->_offset)</span>
<a name="l00100"></a><a class="code" href="ipv4_2ip_8h.html#0d8238411ce35a007170f652e62209b3">00100</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_TTL(hdr) (NTOHS((hdr)->_ttl_proto) >> 8)</span>
<a name="l00101"></a><a class="code" href="ipv4_2ip_8h.html#a2de6f9d35337b4be67d799805665e11">00101</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_PROTO(hdr) (NTOHS((hdr)->_ttl_proto) & 0xff)</span>
<a name="l00102"></a><a class="code" href="ipv4_2ip_8h.html#773b96f54c75b35bcd24e7f857fcf988">00102</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_CHKSUM(hdr) ((hdr)->_chksum)</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span>
<a name="l00104"></a><a class="code" href="ipv4_2ip_8h.html#65a5ff431603908b698b69ff5151f888">00104</a> <span class="preprocessor">#define IPH_VHLTOS_SET(hdr, v, hl, tos) (hdr)->_v_hl_tos = HTONS(((v) << 12) | ((hl) << 8) | (tos))</span>
<a name="l00105"></a><a class="code" href="ipv4_2ip_8h.html#069cb9b3765c4bdd63d13efb2df0206e">00105</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_LEN_SET(hdr, len) (hdr)->_len = (len)</span>
<a name="l00106"></a><a class="code" href="ipv4_2ip_8h.html#3b2c57b6a9dc9cc32fc2f145a96bbf8f">00106</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_ID_SET(hdr, id) (hdr)->_id = (id)</span>
<a name="l00107"></a><a class="code" href="ipv4_2ip_8h.html#4c2189e1400dca1c0f785de96ceda2b6">00107</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_OFFSET_SET(hdr, off) (hdr)->_offset = (off)</span>
<a name="l00108"></a><a class="code" href="ipv4_2ip_8h.html#a0e49f03bd4c3144e3548a0db72d1deb">00108</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_TTL_SET(hdr, ttl) (hdr)->_ttl_proto = HTONS(IPH_PROTO(hdr) | ((ttl) << 8))</span>
<a name="l00109"></a><a class="code" href="ipv4_2ip_8h.html#49753f7668f741b1877340bff6fb97c3">00109</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_PROTO_SET(hdr, proto) (hdr)->_ttl_proto = HTONS((proto) | (IPH_TTL(hdr) << 8))</span>
<a name="l00110"></a><a class="code" href="ipv4_2ip_8h.html#ec30403fb98b013bd094688de55cdaef">00110</a> <span class="preprocessor"></span><span class="preprocessor">#define IPH_CHKSUM_SET(hdr, chksum) (hdr)->_chksum = (chksum)</span>
<a name="l00111"></a>00111 <span class="preprocessor"></span>
<a name="l00112"></a>00112
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="preprocessor">#if IP_DEBUG</span>
<a name="l00115"></a>00115 <span class="preprocessor"></span><span class="keywordtype">void</span> ip_debug_print(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p);
<a name="l00116"></a>00116 <span class="preprocessor">#endif </span><span class="comment">/* IP_DEBUG */</span>
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="preprocessor">#endif </span><span class="comment">/* __LWIP_IP_H__ */</span>
<a name="l00119"></a>00119
<a name="l00120"></a>00120
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Dec 12 08:52:04 2006 for UbixOS V2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
