FreeRTOS/Common/ethernet/lwIP/include/ipv4/lwip/ip_addr.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_IP_ADDR_H__
  33 #define __LWIP_IP_ADDR_H__
  34
  35 #include "lwip/arch.h"
  36
  37 #ifdef PACK_STRUCT_USE_INCLUDES
  38 #  include "arch/bpstruct.h"
  39 #endif
  40 PACK_STRUCT_BEGIN
  41 struct ip_addr {
  42   PACK_STRUCT_FIELD(u32_t addr);
  43 } PACK_STRUCT_STRUCT;
  44 PACK_STRUCT_END
  45 #ifdef PACK_STRUCT_USE_INCLUDES
  46 #  include "arch/epstruct.h"
  47 #endif
  48
  49 /*
  50  * struct ipaddr2 is used in the definition of the ARP packet format in
  51  * order to support compilers that don't have structure packing.
  52  */
  53 #ifdef PACK_STRUCT_USE_INCLUDES
  54 #  include "arch/bpstruct.h"
  55 #endif
  56 PACK_STRUCT_BEGIN
  57 struct ip_addr2 {
  58   PACK_STRUCT_FIELD(u16_t addrw[2]);
  59 } PACK_STRUCT_STRUCT;
  60 PACK_STRUCT_END
  61 #ifdef PACK_STRUCT_USE_INCLUDES
  62 #  include "arch/epstruct.h"
  63 #endif
  64
  65 /* For compatibility with BSD code */
  66 struct in_addr {
  67   u32_t s_addr;
  68 };
  69
  70 struct netif;
  71
  72 extern const struct ip_addr ip_addr_any;
  73 extern const struct ip_addr ip_addr_broadcast;
  74
  75 /** IP_ADDR_ can be used as a fixed IP address
  76  *  for the wildcard and the broadcast address
  77  */
  78 #define IP_ADDR_ANY         ((struct ip_addr *)&ip_addr_any)
  79 #define IP_ADDR_BROADCAST   ((struct ip_addr *)&ip_addr_broadcast)
  80
  81 #define INADDR_NONE         ((u32_t)0xffffffff)  /* 255.255.255.255 */
  82 #define INADDR_LOOPBACK     ((u32_t)0x7f000001)  /* 127.0.0.1 */
  83
  84 /* Definitions of the bits in an Internet address integer.
  85
  86    On subnets, host and network parts are found according to
  87    the subnet mask, not these masks.  */
  88
  89 #define IN_CLASSA(a)        ((((u32_t)(a)) & 0x80000000) == 0)
  90 #define IN_CLASSA_NET       0xff000000
  91 #define IN_CLASSA_NSHIFT    24
  92 #define IN_CLASSA_HOST      (0xffffffff & ~IN_CLASSA_NET)
  93 #define IN_CLASSA_MAX       128
  94
  95 #define IN_CLASSB(a)        ((((u32_t)(a)) & 0xc0000000) == 0x80000000)
  96 #define IN_CLASSB_NET       0xffff0000
  97 #define IN_CLASSB_NSHIFT    16
  98 #define IN_CLASSB_HOST      (0xffffffff & ~IN_CLASSB_NET)
  99 #define IN_CLASSB_MAX       65536
 100
 101 #define IN_CLASSC(a)        ((((u32_t)(a)) & 0xe0000000) == 0xc0000000)
 102 #define IN_CLASSC_NET       0xffffff00
 103 #define IN_CLASSC_NSHIFT    8
 104 #define IN_CLASSC_HOST      (0xffffffff & ~IN_CLASSC_NET)
 105
 106 #define IN_CLASSD(a)        (((u32_t)(a) & 0xf0000000) == 0xe0000000)
 107 #define IN_CLASSD_NET       0xf0000000          /* These ones aren't really */
 108 #define IN_CLASSD_NSHIFT    28                  /*   net and host fields, but */
 109 #define IN_CLASSD_HOST      0x0fffffff          /*   routing needn't know. */
 110 #define IN_MULTICAST(a)     IN_CLASSD(a)
 111
 112 #define IN_EXPERIMENTAL(a)  (((u32_t)(a) & 0xf0000000) == 0xf0000000)
 113 #define IN_BADCLASS(a)      (((u32_t)(a) & 0xf0000000) == 0xf0000000)
 114
 115 #define IN_LOOPBACKNET      127                 /* official! */
 116
 117 #define IP4_ADDR(ipaddr, a,b,c,d) \
 118         (ipaddr)->addr = htonl(((u32_t)((a) & 0xff) << 24) | \
 119                                ((u32_t)((b) & 0xff) << 16) | \
 120                                ((u32_t)((c) & 0xff) << 8) | \
 121                                 (u32_t)((d) & 0xff))
 122
 123 #define ip_addr_set(dest, src) (dest)->addr = \
 124                                ((src) == NULL? 0:\
 125                                (src)->addr)
 126 /**
 127  * Determine if two address are on the same network.
 128  *
 129  * @arg addr1 IP address 1
 130  * @arg addr2 IP address 2
 131  * @arg mask network identifier mask
 132  * @return !0 if the network identifiers of both address match
 133  */
 134 #define ip_addr_netcmp(addr1, addr2, mask) (((addr1)->addr & \
 135                                               (mask)->addr) == \
 136                                              ((addr2)->addr & \
 137                                               (mask)->addr))
 138 #define ip_addr_cmp(addr1, addr2) ((addr1)->addr == (addr2)->addr)
 139
 140 #define ip_addr_isany(addr1) ((addr1) == NULL || (addr1)->addr == 0)
 141
 142 u8_t ip_addr_isbroadcast(struct ip_addr *, struct netif *);
 143
 144 #define ip_addr_ismulticast(addr1) (((addr1)->addr & ntohl(0xf0000000)) == ntohl(0xe0000000))
 145
 146 #define ip_addr_debug_print(debug, ipaddr) \
 147         LWIP_DEBUGF(debug, ("%"U16_F".%"U16_F".%"U16_F".%"U16_F, \
 148                 ipaddr ? (u16_t)(ntohl((ipaddr)->addr) >> 24) & 0xff : 0, \
 149                 ipaddr ? (u16_t)(ntohl((ipaddr)->addr) >> 16) & 0xff : 0, \
 150                 ipaddr ? (u16_t)(ntohl((ipaddr)->addr) >> 8) & 0xff : 0, \
 151                 ipaddr ? (u16_t)ntohl((ipaddr)->addr) & 0xff : 0))
 152
 153 /* These are cast to u16_t, with the intent that they are often arguments
 154  * to printf using the U16_F format from cc.h. */
 155 #define ip4_addr1(ipaddr) ((u16_t)(ntohl((ipaddr)->addr) >> 24) & 0xff)
 156 #define ip4_addr2(ipaddr) ((u16_t)(ntohl((ipaddr)->addr) >> 16) & 0xff)
 157 #define ip4_addr3(ipaddr) ((u16_t)(ntohl((ipaddr)->addr) >> 8) & 0xff)
 158 #define ip4_addr4(ipaddr) ((u16_t)(ntohl((ipaddr)->addr)) & 0xff)
 159
 160 #endif /* __LWIP_IP_ADDR_H__ */