/**************************************************************************** * net/uip/uip-icmp.h * Header file for the uIP ICMP stack. * * Copyright (C) 2007, 2008 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * This logic was leveraged from uIP which also has a BSD-style license: * * Author Adam Dunkels * Copyright (c) 2001-2003, Adam Dunkels. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. The name of the author may not be used to endorse or promote * products derived from this software without specific prior * written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************/ #ifndef __NET_UIP_UIP_ICMP_H #define __NET_UIP_UIP_ICMP_H /**************************************************************************** * Included Files ****************************************************************************/ #include #include #include /**************************************************************************** * Definitions ****************************************************************************/ /* ICMP/ICMP6 definitions */ /* ICMP/ICMP6 Message Types */ #define ICMP_ECHO_REPLY 0 /* RFC 792 */ #define ICMP_DEST_UNREACHABLE 3 /* RFC 792 */ #define ICMP_SRC_QUENCH 4 /* RFC 792 */ #define ICMP_REDIRECT 5 /* RFC 792 */ #define ICMP_ALT_HOST_ADDRESS 6 #define ICMP_ECHO_REQUEST 8 /* RFC 792 */ #define ICMP_ROUTER_ADVERTISEMENT 9 /* RFC 1256 */ #define ICMP_ROUTER_SOLICITATION 10 /* RFC 1256 */ #define ICMP_TIME_EXCEEDED 11 /* RFC 792 */ #define ICMP_PARAMETER_PROBLEM 12 #define ICMP_TIMESTAMP_REQUEST 13 #define ICMP_TIMESTAMP_REPLY 14 #define ICMP_INFORMATION_REQUEST 15 #define ICMP_INFORMATION_REPLY 16 #define ICMP_ADDRESS_MASK_REQUEST 17 #define ICMP_ADDRESS_MASK_REPLY 18 #define ICMP_TRACEROUTE 30 #define ICMP_CONVERSION_ERROR 31 #define ICMP_MOBILE_HOST_REDIRECT 32 #define ICMP_IPV6_WHEREAREYOU 33 #define ICMP_IPV6_IAMHERE 34 #define ICMP_MOBILE_REGIS_REQUEST 35 #define ICMP_MOBILE_REGIS_REPLY 36 #define ICMP_DOMAIN_NAME_REQUEST 37 #define ICMP_DOMAIN_NAME_REPLY 38 #define ICMP_SKIP_DISCOVERY_PROTO 39 #define ICMP_PHOTURIS_SECURITY_FAIL 40 #define ICMP_EXP_MOBILE_PROTO 41 /* RFC 4065 */ /* ICMP6 Message Types */ #define ICMP6_ECHO_REPLY 129 #define ICMP6_ECHO_REQUEST 128 #define ICMP6_NEIGHBOR_SOLICITATION 135 #define ICMP6_NEIGHBOR_ADVERTISEMENT 136 #define ICMP6_FLAG_S (1 << 6) #define ICMP6_OPTION_SOURCE_LINK_ADDRESS 1 #define ICMP6_OPTION_TARGET_LINK_ADDRESS 2 /* Header sizes */ #define UIP_ICMPH_LEN 4 /* Size of ICMP header */ #define UIP_IPICMPH_LEN (UIP_ICMPH_LEN + UIP_IPH_LEN) /* Size of IP + ICMP header */ /**************************************************************************** * Public Type Definitions ****************************************************************************/ /* The ICMP and IP headers */ struct uip_icmpip_hdr { #ifdef CONFIG_NET_IPv6 /* IPv6 Ip header */ uint8 vtc; /* Bits 0-3: version, bits 4-7: traffic class (MS) */ uint8 tcf; /* Bits 0-3: traffic class (LS), bits 4-7: flow label (MS) */ uint16 flow; /* 16-bit flow label (LS) */ uint8 len[2]; /* 16-bit Payload length */ uint8 proto; /* 8-bit Next header (same as IPv4 protocol field) */ uint8 ttl; /* 8-bit Hop limit (like IPv4 TTL field) */ uip_ip6addr_t srcipaddr; /* 128-bit Source address */ uip_ip6addr_t destipaddr; /* 128-bit Destination address */ #else /* CONFIG_NET_IPv6 */ /* IPv4 IP header */ uint8 vhl; /* 8-bit Version (4) and header length (5 or 6) */ uint8 tos; /* 8-bit Type of service (e.g., 6=TCP) */ uint8 len[2]; /* 16-bit Total length */ uint8 ipid[2]; /* 16-bit Identification */ uint8 ipoffset[2]; /* 16-bit IP flags + fragment offset */ uint8 ttl; /* 8-bit Time to Live */ uint8 proto; /* 8-bit Protocol */ uint16 ipchksum; /* 16-bit Header checksum */ uint16 srcipaddr[2]; /* 32-bit Source IP address */ uint16 destipaddr[2]; /* 32-bit Destination IP address */ #endif /* CONFIG_NET_IPv6 */ /* ICMP header */ uint8 type; /* Defines the format of the ICMP message */ uint8 icode; /* Further qualifies the ICMP messsage */ uint16 icmpchksum; /* Checksum of ICMP header and data */ /* Data following the ICMP header contains the data specific to the * message type indicated by the Type and Code fields. */ #ifndef CONFIG_NET_IPv6 /* ICMP_ECHO_REQUEST and ICMP_ECHO_REPLY data */ uint16 id; /* Used to match requests with replies */ uint16 seqno; /* " " "" " " " " " " " " */ #else /* !CONFIG_NET_IPv6 */ /* ICMP6_ECHO_REQUEST and ICMP6_ECHO_REPLY data */ uint8 flags; uint8 reserved1; uint8 reserved2; uint8 reserved3; uint8 icmp6data[16]; uint8 options[1]; #endif /* !CONFIG_NET_IPv6 */ }; /* The structure holding the ICMP statistics that are gathered if * CONFIG_NET_STATISTICS is defined. */ #ifdef CONFIG_NET_STATISTICS struct uip_icmp_stats_s { uip_stats_t drop; /* Number of dropped ICMP packets */ uip_stats_t recv; /* Number of received ICMP packets */ uip_stats_t sent; /* Number of sent ICMP packets */ uip_stats_t typeerr; /* Number of ICMP packets with a wrong type */ }; #endif /**************************************************************************** * Public Data ****************************************************************************/ /**************************************************************************** * Public Function Prototypes ****************************************************************************/ #ifdef __cplusplus #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif EXTERN int uip_ping(uip_ipaddr_t addr, uint16 id, uint16 seqno, uint16 datalen, int dsecs); #undef EXTERN #ifdef __cplusplus } #endif #endif /* __NET_UIP_UIP_ICMP_H */