]> Joshua Wise's Git repositories - netwatch.git/blob - lwip/src/include/ipv4/lwip/icmp.h
59a31f9c664e28881b697f51278be961857bee05
[netwatch.git] / lwip / src / include / ipv4 / lwip / icmp.h
1 /*
2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
3  * All rights reserved. 
4  * 
5  * Redistribution and use in source and binary forms, with or without modification, 
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  *    this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  *    this list of conditions and the following disclaimer in the documentation
12  *    and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission. 
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
25  * OF SUCH DAMAGE.
26  *
27  * This file is part of the lwIP TCP/IP stack.
28  * 
29  * Author: Adam Dunkels <adam@sics.se>
30  *
31  */
32 #ifndef __LWIP_ICMP_H__
33 #define __LWIP_ICMP_H__
34
35 #include "lwip/opt.h"
36
37 #if LWIP_ICMP /* don't build if not configured for use in lwipopts.h */
38
39 #include "lwip/pbuf.h"
40 #include "lwip/ip_addr.h"
41 #include "lwip/netif.h"
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 #define ICMP_ER 0      /* echo reply */
48 #define ICMP_DUR 3     /* destination unreachable */
49 #define ICMP_SQ 4      /* source quench */
50 #define ICMP_RD 5      /* redirect */
51 #define ICMP_ECHO 8    /* echo */
52 #define ICMP_TE 11     /* time exceeded */
53 #define ICMP_PP 12     /* parameter problem */
54 #define ICMP_TS 13     /* timestamp */
55 #define ICMP_TSR 14    /* timestamp reply */
56 #define ICMP_IRQ 15    /* information request */
57 #define ICMP_IR 16     /* information reply */
58
59 enum icmp_dur_type {
60   ICMP_DUR_NET = 0,    /* net unreachable */
61   ICMP_DUR_HOST = 1,   /* host unreachable */
62   ICMP_DUR_PROTO = 2,  /* protocol unreachable */
63   ICMP_DUR_PORT = 3,   /* port unreachable */
64   ICMP_DUR_FRAG = 4,   /* fragmentation needed and DF set */
65   ICMP_DUR_SR = 5      /* source route failed */
66 };
67
68 enum icmp_te_type {
69   ICMP_TE_TTL = 0,     /* time to live exceeded in transit */
70   ICMP_TE_FRAG = 1     /* fragment reassembly time exceeded */
71 };
72
73 void icmp_input(struct pbuf *p, struct netif *inp);
74
75 void icmp_dest_unreach(struct pbuf *p, enum icmp_dur_type t);
76 void icmp_time_exceeded(struct pbuf *p, enum icmp_te_type t);
77
78 #ifdef PACK_STRUCT_USE_INCLUDES
79 #  include "arch/bpstruct.h"
80 #endif
81 PACK_STRUCT_BEGIN
82 struct icmp_echo_hdr {
83   PACK_STRUCT_FIELD(u16_t _type_code);
84   PACK_STRUCT_FIELD(u16_t chksum);
85   PACK_STRUCT_FIELD(u16_t id);
86   PACK_STRUCT_FIELD(u16_t seqno);
87 } PACK_STRUCT_STRUCT;
88 PACK_STRUCT_END
89
90 PACK_STRUCT_BEGIN
91 struct icmp_dur_hdr {
92   PACK_STRUCT_FIELD(u16_t _type_code);
93   PACK_STRUCT_FIELD(u16_t chksum);
94   PACK_STRUCT_FIELD(u32_t unused);
95 } PACK_STRUCT_STRUCT;
96 PACK_STRUCT_END
97
98 PACK_STRUCT_BEGIN
99 struct icmp_te_hdr {
100   PACK_STRUCT_FIELD(u16_t _type_code);
101   PACK_STRUCT_FIELD(u16_t chksum);
102   PACK_STRUCT_FIELD(u32_t unused);
103 } PACK_STRUCT_STRUCT;
104 PACK_STRUCT_END
105 #ifdef PACK_STRUCT_USE_INCLUDES
106 #  include "arch/epstruct.h"
107 #endif
108
109 #define ICMPH_TYPE(hdr) (ntohs((hdr)->_type_code) >> 8)
110 #define ICMPH_CODE(hdr) (ntohs((hdr)->_type_code) & 0xff)
111
112 #define ICMPH_TYPE_SET(hdr, type) ((hdr)->_type_code = htons(ICMPH_CODE(hdr) | ((type) << 8)))
113 #define ICMPH_CODE_SET(hdr, code) ((hdr)->_type_code = htons((code) | (ICMPH_TYPE(hdr) << 8)))
114
115 #ifdef __cplusplus
116 }
117 #endif
118
119 #endif /* LWIP_ICMP */
120
121 #endif /* __LWIP_ICMP_H__ */
This page took 0.034182 seconds and 4 git commands to generate.