Newer
Older
ubixos-pre / doc / doxygen / html / ipv4_2icmp_8h-source.html
@reddawg reddawg on 18 Jun 2004 7 KB UbixOS PreRelease
<!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: icmp.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.3 -->
<h1>icmp.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_ICMP_H__</span>
00036 <span class="preprocessor"></span><span class="preprocessor">#define __LWIP_ICMP_H__</span>
00037 <span class="preprocessor"></span>
00038 <span class="preprocessor">#include "net/arch.h"</span>
00039 
00040 <span class="preprocessor">#include "net/opt.h"</span>
00041 <span class="preprocessor">#include "net/pbuf.h"</span>
00042 
00043 <span class="preprocessor">#include "net/netif.h"</span>
00044 
00045 <span class="preprocessor">#define ICMP_ER 0      </span><span class="comment">/* echo reply */</span>
00046 <span class="preprocessor">#define ICMP_DUR 3     </span><span class="comment">/* destination unreachable */</span>
00047 <span class="preprocessor">#define ICMP_SQ 4      </span><span class="comment">/* source quench */</span>
00048 <span class="preprocessor">#define ICMP_RD 5      </span><span class="comment">/* redirect */</span>
00049 <span class="preprocessor">#define ICMP_ECHO 8    </span><span class="comment">/* echo */</span>
00050 <span class="preprocessor">#define ICMP_TE 11     </span><span class="comment">/* time exceeded */</span>
00051 <span class="preprocessor">#define ICMP_PP 12     </span><span class="comment">/* parameter problem */</span>
00052 <span class="preprocessor">#define ICMP_TS 13     </span><span class="comment">/* timestamp */</span>
00053 <span class="preprocessor">#define ICMP_TSR 14    </span><span class="comment">/* timestamp reply */</span>
00054 <span class="preprocessor">#define ICMP_IRQ 15    </span><span class="comment">/* information request */</span>
00055 <span class="preprocessor">#define ICMP_IR 16     </span><span class="comment">/* information reply */</span>
00056 
00057 <span class="keyword">enum</span> icmp_dur_type {
00058   ICMP_DUR_NET = 0,    <span class="comment">/* net unreachable */</span>
00059   ICMP_DUR_HOST = 1,   <span class="comment">/* host unreachable */</span>
00060   ICMP_DUR_PROTO = 2,  <span class="comment">/* protocol unreachable */</span>
00061   ICMP_DUR_PORT = 3,   <span class="comment">/* port unreachable */</span>
00062   ICMP_DUR_FRAG = 4,   <span class="comment">/* fragmentation needed and DF set */</span>
00063   ICMP_DUR_SR = 5      <span class="comment">/* source route failed */</span>
00064 };
00065 
00066 <span class="keyword">enum</span> icmp_te_type {
00067   ICMP_TE_TTL = 0,     <span class="comment">/* time to live exceeded in transit */</span>
00068   ICMP_TE_FRAG = 1     <span class="comment">/* fragment reassembly time exceeded */</span>
00069 };
00070 
00071 <span class="keywordtype">void</span> icmp_input(<span class="keyword">struct</span> pbuf *p, <span class="keyword">struct</span> netif *inp);
00072 
00073 <span class="keywordtype">void</span> icmp_dest_unreach(<span class="keyword">struct</span> pbuf *p, <span class="keyword">enum</span> icmp_dur_type t);
00074 <span class="keywordtype">void</span> icmp_time_exceeded(<span class="keyword">struct</span> pbuf *p, <span class="keyword">enum</span> icmp_te_type t);
00075 
00076 <span class="keyword">struct </span>icmp_echo_hdr {
00077   PACK_STRUCT_FIELD(uInt16 _type_code);
00078   PACK_STRUCT_FIELD(uInt16 chksum);
00079   PACK_STRUCT_FIELD(uInt16 id);
00080   PACK_STRUCT_FIELD(uInt16 seqno);
00081 } PACK_STRUCT_STRUCT;
00082 
00083 
00084 
00085 <span class="keyword">struct </span>icmp_dur_hdr {
00086   PACK_STRUCT_FIELD(uInt16 _type_code);
00087   PACK_STRUCT_FIELD(uInt16 chksum);
00088   PACK_STRUCT_FIELD(uInt32 unused);
00089 } PACK_STRUCT_STRUCT;
00090 
00091 <span class="keyword">struct </span>icmp_te_hdr {
00092   PACK_STRUCT_FIELD(uInt16 _type_code);
00093   PACK_STRUCT_FIELD(uInt16 chksum);
00094   PACK_STRUCT_FIELD(uInt32 unused);
00095 } PACK_STRUCT_STRUCT;
00096 
00097 <span class="preprocessor">#define ICMPH_TYPE(hdr) (NTOHS((hdr)-&gt;_type_code) &gt;&gt; 8)</span>
00098 <span class="preprocessor"></span><span class="preprocessor">#define ICMPH_CODE(hdr) (NTOHS((hdr)-&gt;_type_code) &amp; 0xff)</span>
00099 <span class="preprocessor"></span>
00100 <span class="preprocessor">#define ICMPH_TYPE_SET(hdr, type) ((hdr)-&gt;_type_code = HTONS(ICMPH_CODE(hdr) | ((type) &lt;&lt; 8)))</span>
00101 <span class="preprocessor"></span><span class="preprocessor">#define ICMPH_CODE_SET(hdr, code) ((hdr)-&gt;_type_code = HTONS((code) | (ICMPH_TYPE(hdr) &lt;&lt; 8)))</span>
00102 <span class="preprocessor"></span>
00103 <span class="preprocessor">#endif </span><span class="comment">/* __LWIP_ICMP_H__ */</span>
00104           
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Apr 28 17:49:34 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>