First run at integrating LWIP into the tree (again)
[akaros.git] / user / lwip / 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 #include "lwip/pbuf.h"
37 #include "lwip/ip_addr.h"
38 #include "lwip/netif.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #define ICMP_ER 0      /* echo reply */
45 #define ICMP_DUR 3     /* destination unreachable */
46 #define ICMP_SQ 4      /* source quench */
47 #define ICMP_RD 5      /* redirect */
48 #define ICMP_ECHO 8    /* echo */
49 #define ICMP_TE 11     /* time exceeded */
50 #define ICMP_PP 12     /* parameter problem */
51 #define ICMP_TS 13     /* timestamp */
52 #define ICMP_TSR 14    /* timestamp reply */
53 #define ICMP_IRQ 15    /* information request */
54 #define ICMP_IR 16     /* information reply */
55
56 enum icmp_dur_type {
57   ICMP_DUR_NET = 0,    /* net unreachable */
58   ICMP_DUR_HOST = 1,   /* host unreachable */
59   ICMP_DUR_PROTO = 2,  /* protocol unreachable */
60   ICMP_DUR_PORT = 3,   /* port unreachable */
61   ICMP_DUR_FRAG = 4,   /* fragmentation needed and DF set */
62   ICMP_DUR_SR = 5      /* source route failed */
63 };
64
65 enum icmp_te_type {
66   ICMP_TE_TTL = 0,     /* time to live exceeded in transit */
67   ICMP_TE_FRAG = 1     /* fragment reassembly time exceeded */
68 };
69
70 #ifdef PACK_STRUCT_USE_INCLUDES
71 #  include "arch/bpstruct.h"
72 #endif
73 /** This is the standard ICMP header only that the u32_t data
74  *  is splitted to two u16_t like ICMP echo needs it.
75  *  This header is also used for other ICMP types that do not
76  *  use the data part.
77  */
78 PACK_STRUCT_BEGIN
79 struct icmp_echo_hdr {
80   PACK_STRUCT_FIELD(u8_t type);
81   PACK_STRUCT_FIELD(u8_t code);
82   PACK_STRUCT_FIELD(u16_t chksum);
83   PACK_STRUCT_FIELD(u16_t id);
84   PACK_STRUCT_FIELD(u16_t seqno);
85 } PACK_STRUCT_STRUCT;
86 PACK_STRUCT_END
87 #ifdef PACK_STRUCT_USE_INCLUDES
88 #  include "arch/epstruct.h"
89 #endif
90
91 #define ICMPH_TYPE(hdr) ((hdr)->type)
92 #define ICMPH_CODE(hdr) ((hdr)->code)
93
94 /** Combines type and code to an u16_t */
95 #define ICMPH_TYPE_SET(hdr, t) ((hdr)->type = (t))
96 #define ICMPH_CODE_SET(hdr, c) ((hdr)->code = (c))
97
98
99 #if LWIP_ICMP /* don't build if not configured for use in lwipopts.h */
100
101 void icmp_input(struct pbuf *p, struct netif *inp);
102 void icmp_dest_unreach(struct pbuf *p, enum icmp_dur_type t);
103 void icmp_time_exceeded(struct pbuf *p, enum icmp_te_type t);
104
105 #endif /* LWIP_ICMP */
106
107 #ifdef __cplusplus
108 }
109 #endif
110
111 #endif /* __LWIP_ICMP_H__ */