Mistake on this page?
Report an issue in GitHub or email us
icmp.h
Go to the documentation of this file.
1 /**
2  * @file
3  * ICMP API
4  */
5 
6 /*
7  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without modification,
11  * are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  * 3. The name of the author may not be used to endorse or promote products
19  * derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30  * OF SUCH DAMAGE.
31  *
32  * This file is part of the lwIP TCP/IP stack.
33  *
34  * Author: Adam Dunkels <adam@sics.se>
35  *
36  */
37 #ifndef LWIP_HDR_ICMP_H
38 #define LWIP_HDR_ICMP_H
39 
40 #include "lwip/opt.h"
41 #include "lwip/pbuf.h"
42 #include "lwip/ip_addr.h"
43 #include "lwip/netif.h"
44 #include "lwip/prot/icmp.h"
45 
46 #if LWIP_IPV6 && LWIP_ICMP6
47 #include "lwip/icmp6.h"
48 #endif
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
54 /** ICMP destination unreachable codes */
56  /** net unreachable */
58  /** host unreachable */
60  /** protocol unreachable */
62  /** port unreachable */
64  /** fragmentation needed and DF set */
66  /** source route failed */
68 };
69 
70 /** ICMP time exceeded codes */
72  /** time to live exceeded in transit */
74  /** fragment reassembly time exceeded */
76 };
77 
78 #if LWIP_IPV4 && LWIP_ICMP /* don't build if not configured for use in lwipopts.h */
79 
80 void icmp_input(struct pbuf *p, struct netif *inp);
81 void icmp_dest_unreach(struct pbuf *p, enum icmp_dur_type t);
82 void icmp_time_exceeded(struct pbuf *p, enum icmp_te_type t);
83 
84 #endif /* LWIP_IPV4 && LWIP_ICMP */
85 
86 #if LWIP_IPV4 && LWIP_IPV6
87 #if LWIP_ICMP && LWIP_ICMP6
88 #define icmp_port_unreach(isipv6, pbuf) ((isipv6) ? \
89  icmp6_dest_unreach(pbuf, ICMP6_DUR_PORT) : \
90  icmp_dest_unreach(pbuf, ICMP_DUR_PORT))
91 #elif LWIP_ICMP
92 #define icmp_port_unreach(isipv6, pbuf) do{ if(!(isipv6)) { icmp_dest_unreach(pbuf, ICMP_DUR_PORT);}}while(0)
93 #elif LWIP_ICMP6
94 #define icmp_port_unreach(isipv6, pbuf) do{ if(isipv6) { icmp6_dest_unreach(pbuf, ICMP6_DUR_PORT);}}while(0)
95 #else
96 #define icmp_port_unreach(isipv6, pbuf)
97 #endif
98 #elif LWIP_IPV6 && LWIP_ICMP6
99 #define icmp_port_unreach(isipv6, pbuf) icmp6_dest_unreach(pbuf, ICMP6_DUR_PORT)
100 #elif LWIP_IPV4 && LWIP_ICMP
101 #define icmp_port_unreach(isipv6, pbuf) icmp_dest_unreach(pbuf, ICMP_DUR_PORT)
102 #else /* (LWIP_IPV6 && LWIP_ICMP6) || (LWIP_IPV4 && LWIP_ICMP) */
103 #define icmp_port_unreach(isipv6, pbuf)
104 #endif /* (LWIP_IPV6 && LWIP_ICMP6) || (LWIP_IPV4 && LWIP_ICMP) LWIP_IPV4*/
105 
106 #ifdef __cplusplus
107 }
108 #endif
109 
110 #endif /* LWIP_HDR_ICMP_H */
fragment reassembly time exceeded
Definition: icmp.h:75
net unreachable
Definition: icmp.h:57
lwIP Options Configuration
time to live exceeded in transit
Definition: icmp.h:73
port unreachable
Definition: icmp.h:63
netif API (to be used from TCPIP thread)
IPv6 version of ICMP, as per RFC 4443.
Main packet buffer struct.
icmp_te_type
ICMP time exceeded codes.
Definition: icmp.h:71
Generic data structure used for all lwIP network interfaces.
icmp_dur_type
ICMP destination unreachable codes.
Definition: icmp.h:55
ICMP protocol definitions.
protocol unreachable
Definition: icmp.h:61
pbuf API
fragmentation needed and DF set
Definition: icmp.h:65
source route failed
Definition: icmp.h:67
host unreachable
Definition: icmp.h:59
IP address API (common IPv4 and IPv6)
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.