git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP/include/ipv4/lwip/icmp.h

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