git.sur5r.net Git - freertos/blob - Demo/lwIP_MCF5235_GCC/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/arch.h"
  36
  37 #include "lwip/opt.h"
  38 #include "lwip/pbuf.h"
  39
  40 #include "lwip/ip_addr.h"
  41 #include "lwip/netif.h"
  42
  43 #define ICMP_ER 0      /* echo reply */
  44 #define ICMP_DUR 3     /* destination unreachable */
  45 #define ICMP_SQ 4      /* source quench */
  46 #define ICMP_RD 5      /* redirect */
  47 #define ICMP_ECHO 8    /* echo */
  48 #define ICMP_TE 11     /* time exceeded */
  49 #define ICMP_PP 12     /* parameter problem */
  50 #define ICMP_TS 13     /* timestamp */
  51 #define ICMP_TSR 14    /* timestamp reply */
  52 #define ICMP_IRQ 15    /* information request */
  53 #define ICMP_IR 16     /* information reply */
  54
  55 enum icmp_dur_type {
  56   ICMP_DUR_NET = 0,    /* net unreachable */
  57   ICMP_DUR_HOST = 1,   /* host unreachable */
  58   ICMP_DUR_PROTO = 2,  /* protocol unreachable */
  59   ICMP_DUR_PORT = 3,   /* port unreachable */
  60   ICMP_DUR_FRAG = 4,   /* fragmentation needed and DF set */
  61   ICMP_DUR_SR = 5      /* source route failed */
  62 };
  63
  64 enum icmp_te_type {
  65   ICMP_TE_TTL = 0,     /* time to live exceeded in transit */
  66   ICMP_TE_FRAG = 1     /* fragment reassembly time exceeded */
  67 };
  68
  69 void icmp_input(struct pbuf *p, struct netif *inp);
  70
  71 void icmp_dest_unreach(struct pbuf *p, enum icmp_dur_type t);
  72 void icmp_time_exceeded(struct pbuf *p, enum icmp_te_type t);
  73
  74 #ifdef PACK_STRUCT_USE_INCLUDES
  75 #  include "arch/bpstruct.h"
  76 #endif
  77 PACK_STRUCT_BEGIN
  78 struct icmp_echo_hdr {
  79   PACK_STRUCT_FIELD(u16_t _type_code);
  80   PACK_STRUCT_FIELD(u16_t chksum);
  81   PACK_STRUCT_FIELD(u16_t id);
  82   PACK_STRUCT_FIELD(u16_t seqno);
  83 } PACK_STRUCT_STRUCT;
  84 PACK_STRUCT_END
  85
  86 PACK_STRUCT_BEGIN
  87 struct icmp_dur_hdr {
  88   PACK_STRUCT_FIELD(u16_t _type_code);
  89   PACK_STRUCT_FIELD(u16_t chksum);
  90   PACK_STRUCT_FIELD(u32_t unused);
  91 } PACK_STRUCT_STRUCT;
  92 PACK_STRUCT_END
  93
  94 PACK_STRUCT_BEGIN
  95 struct icmp_te_hdr {
  96   PACK_STRUCT_FIELD(u16_t _type_code);
  97   PACK_STRUCT_FIELD(u16_t chksum);
  98   PACK_STRUCT_FIELD(u32_t unused);
  99 } PACK_STRUCT_STRUCT;
 100 PACK_STRUCT_END
 101 #ifdef PACK_STRUCT_USE_INCLUDES
 102 #  include "arch/epstruct.h"
 103 #endif
 104
 105 #define ICMPH_TYPE(hdr) (ntohs((hdr)->_type_code) >> 8)
 106 #define ICMPH_CODE(hdr) (ntohs((hdr)->_type_code) & 0xff)
 107
 108 #define ICMPH_TYPE_SET(hdr, type) ((hdr)->_type_code = htons(ICMPH_CODE(hdr) | ((type) << 8)))
 109 #define ICMPH_CODE_SET(hdr, code) ((hdr)->_type_code = htons((code) | (ICMPH_TYPE(hdr) << 8)))
 110
 111 #endif /* __LWIP_ICMP_H__ */
 112