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