Documentation

Documentation

Includes

lwip/opt.h

#include "lwip/opt.h"
#include "lwip/opt.h"

lwip/def.h

#include "lwip/def.h"
#include "lwip/def.h"

Macros

Marco LWIP_HDR_IP4_ADDR_H

#define LWIP_HDR_IP4_ADDR_H


      

Marco IPADDR_NONE

#define IPADDR_NONE        ((u32_t)0xffffffffUL)
/** 255.255.255.255 */

Marco IPADDR_LOOPBACK

#define IPADDR_LOOPBACK    ((u32_t)0x7f000001UL)
/** 127.0.0.1 */

Marco IPADDR_ANY

#define IPADDR_ANY         ((u32_t)0x00000000UL)
/** 0.0.0.0 */

Marco IPADDR_BROADCAST

#define IPADDR_BROADCAST   ((u32_t)0xffffffffUL)
/** 255.255.255.255 */

Marco IP_CLASSA(a)

#define IP_CLASSA(a)       ((((u32_t)(a)) & 0x80000000UL) == 0)
/* Definitions of the bits in an Internet address integer.

   On subnets, host and network parts are found according to
   the subnet mask, not these masks.  */

Marco IP_CLASSA_NET

#define IP_CLASSA_NET      4278190080


      

Marco IP_CLASSA_NSHIFT

#define IP_CLASSA_NSHIFT   24


      

Marco IP_CLASSA_HOST

#define IP_CLASSA_HOST     (4294967295 & ~IP_CLASSA_NET)


      

Marco IP_CLASSA_MAX

#define IP_CLASSA_MAX      128


      

Marco IP_CLASSB(a)

#define IP_CLASSB(a)       ((((u32_t)(a)) & 0xc0000000UL) == 0x80000000UL)


      

Marco IP_CLASSB_NET

#define IP_CLASSB_NET      4294901760


      

Marco IP_CLASSB_NSHIFT

#define IP_CLASSB_NSHIFT   16


      

Marco IP_CLASSB_HOST

#define IP_CLASSB_HOST     (4294967295 & ~IP_CLASSB_NET)


      

Marco IP_CLASSB_MAX

#define IP_CLASSB_MAX      65536


      

Marco IP_CLASSC(a)

#define IP_CLASSC(a)       ((((u32_t)(a)) & 0xe0000000UL) == 0xc0000000UL)


      

Marco IP_CLASSC_NET

#define IP_CLASSC_NET      4294967040


      

Marco IP_CLASSC_NSHIFT

#define IP_CLASSC_NSHIFT   8


      

Marco IP_CLASSC_HOST

#define IP_CLASSC_HOST     (4294967295 & ~IP_CLASSC_NET)


      

Marco IP_CLASSD(a)

#define IP_CLASSD(a)       (((u32_t)(a) & 0xf0000000UL) == 0xe0000000UL)


      

Marco IP_CLASSD_NET

#define IP_CLASSD_NET      4026531840         /* These ones aren't really */


      

Marco IP_CLASSD_NSHIFT

#define IP_CLASSD_NSHIFT   28                 /*   net and host fields, but */


      

Marco IP_CLASSD_HOST

#define IP_CLASSD_HOST     268435455         /*   routing needn't know. */


      

Marco IP_MULTICAST(a)

#define IP_MULTICAST(a)    IP_CLASSD(a)


      

Marco IP_EXPERIMENTAL(a)

#define IP_EXPERIMENTAL(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)


      

Marco IP_BADCLASS(a)

#define IP_BADCLASS(a)     (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)


      

Marco IP_LOOPBACKNET

#define IP_LOOPBACKNET     127                /* official! */


      

Marco IP4_ADDR(ipaddr, a,b,c,d)

#define IP4_ADDR(ipaddr, a,b,c,d) (ipaddr)->addr = PP_HTONL(LWIP_MAKEU32(a,b,c,d))
/** Set an IP address given by the four byte-parts */

Marco ip4_addr_copy(dest, src)

#define ip4_addr_copy(dest, src) ((dest).addr = (src).addr)
/** Copy IP address - faster than ip4_addr_set: no NULL check */

Marco ip4_addr_set(dest, src)

#define ip4_addr_set(dest, src) ((dest)->addr = \
                                   ((src) == NULL ? 0 : \
                                   (src)->addr))
/** Safely copy one IP address to another (src may be NULL) */

Marco ip4_addr_set_zero(ipaddr)

#define ip4_addr_set_zero(ipaddr)    ((ipaddr)->addr = 0)
/** Set complete address to zero */

Marco ip4_addr_set_any(ipaddr)

#define ip4_addr_set_any(ipaddr)     ((ipaddr)->addr = IPADDR_ANY)
/** Set address to IPADDR_ANY (no need for lwip_htonl()) */

Marco ip4_addr_set_loopback(ipaddr)

#define ip4_addr_set_loopback(ipaddr) ((ipaddr)->addr = PP_HTONL(IPADDR_LOOPBACK))
/** Set address to loopback address */

Marco ip4_addr_isloopback(ipaddr)

#define ip4_addr_isloopback(ipaddr)   (((ipaddr)->addr & PP_HTONL(IP_CLASSA_NET)) == PP_HTONL(((u32_t)IP_LOOPBACKNET) << 24))
/** Check if an address is in the loopback region */

Marco ip4_addr_set_hton(dest, src)

#define ip4_addr_set_hton(dest, src) ((dest)->addr = \
                              ((src) == NULL ? 0:\
                              lwip_htonl((src)->addr)))
/** Safely copy one IP address to another and change byte order
 * from host- to network-order. */

Marco ip4_addr_set_u32(dest_ipaddr, src_u32)

#define ip4_addr_set_u32(dest_ipaddr, src_u32) ((dest_ipaddr)->addr = (src_u32))
/** IPv4 only: set the IP address given as an u32_t */

Marco ip4_addr_get_u32(src_ipaddr)

#define ip4_addr_get_u32(src_ipaddr) ((src_ipaddr)->addr)
/** IPv4 only: get the IP address as an u32_t */

Marco ip4_addr_get_network(target, host, netmask)

#define ip4_addr_get_network(target, host, netmask) do { ((target)->addr = ((host)->addr) & ((netmask)->addr)); } while(0)
/** Get the network address by combining host address with netmask */

Marco ip4_addr_netcmp(addr1, addr2, mask)

#define ip4_addr_netcmp(addr1, addr2, mask) (((addr1)->addr & \
                                             (mask)->addr) == \
                                            ((addr2)->addr & \
                                             (mask)->addr))
/**
 * Determine if two address are on the same network.
 *
 * @arg addr1 IP address 1
 * @arg addr2 IP address 2
 * @arg mask network identifier mask
 * @return !0 if the network identifiers of both address match
 */

Marco ip4_addr_cmp(addr1, addr2)

#define ip4_addr_cmp(addr1, addr2) ((addr1)->addr == (addr2)->addr)


      

Marco ip4_addr_isany_val(addr1)

#define ip4_addr_isany_val(addr1)  ((addr1).addr == IPADDR_ANY)


      

Marco ip4_addr_isany(addr1)

#define ip4_addr_isany(addr1) ((addr1) == NULL || ip4_addr_isany_val(*(addr1)))


      

Marco ip4_addr_isbroadcast(addr1, netif)

#define ip4_addr_isbroadcast(addr1, netif) ip4_addr_isbroadcast_u32((addr1)->addr, netif)


      

Marco ip_addr_netmask_valid(netmask)

#define ip_addr_netmask_valid(netmask) ip4_addr_netmask_valid((netmask)->addr)


      

Marco ip4_addr_ismulticast(addr1)

#define ip4_addr_ismulticast(addr1) (((addr1)->addr & PP_HTONL(0xf0000000UL)) == PP_HTONL(0xe0000000UL))


      

Marco ip4_addr_islinklocal(addr1)

#define ip4_addr_islinklocal(addr1) (((addr1)->addr & PP_HTONL(0xffff0000UL)) == PP_HTONL(0xa9fe0000UL))


      

Marco ip4_addr_debug_print_parts(debug, a, b, c, d)

#define ip4_addr_debug_print_parts(debug, a, b, c, d) \
 LWIP_DEBUGF(debug, ("%" U16_F ".%" U16_F ".%" U16_F ".%" U16_F, a, b, c, d))


      

Marco ip4_addr_debug_print(debug, ipaddr)

#define ip4_addr_debug_print(debug, ipaddr) \
 ip4_addr_debug_print_parts(debug, \
                     (u16_t)((ipaddr) != NULL ? ip4_addr1_16(ipaddr) : 0),      \
                     (u16_t)((ipaddr) != NULL ? ip4_addr2_16(ipaddr) : 0),      \
                     (u16_t)((ipaddr) != NULL ? ip4_addr3_16(ipaddr) : 0),      \
                     (u16_t)((ipaddr) != NULL ? ip4_addr4_16(ipaddr) : 0))


      

Marco ip4_addr_debug_print_val(debug, ipaddr)

#define ip4_addr_debug_print_val(debug, ipaddr) \
 ip4_addr_debug_print_parts(debug, \
                     ip4_addr1_16_val(ipaddr),      \
                     ip4_addr2_16_val(ipaddr),      \
                     ip4_addr3_16_val(ipaddr),      \
                     ip4_addr4_16_val(ipaddr))


      

Marco ip4_addr_get_byte(ipaddr, idx)

#define ip4_addr_get_byte(ipaddr, idx) (((const u8_t*)(&(ipaddr)->addr))[idx])
/* Get one byte from the 4-byte address */

Marco ip4_addr1(ipaddr)

#define ip4_addr1(ipaddr) ip4_addr_get_byte(ipaddr, 0)


      

Marco ip4_addr2(ipaddr)

#define ip4_addr2(ipaddr) ip4_addr_get_byte(ipaddr, 1)


      

Marco ip4_addr3(ipaddr)

#define ip4_addr3(ipaddr) ip4_addr_get_byte(ipaddr, 2)


      

Marco ip4_addr4(ipaddr)

#define ip4_addr4(ipaddr) ip4_addr_get_byte(ipaddr, 3)


      

Marco ip4_addr_get_byte_val(ipaddr, idx)

#define ip4_addr_get_byte_val(ipaddr, idx) ((u8_t)(((ipaddr).addr >> (idx * 8)) & 255))
/* Get one byte from the 4-byte address, but argument is 'ip4_addr_t',
 * not a pointer */

Marco ip4_addr1_val(ipaddr)

#define ip4_addr1_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 0)


      

Marco ip4_addr2_val(ipaddr)

#define ip4_addr2_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 1)


      

Marco ip4_addr3_val(ipaddr)

#define ip4_addr3_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 2)


      

Marco ip4_addr4_val(ipaddr)

#define ip4_addr4_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 3)


      

Marco ip4_addr1_16(ipaddr)

#define ip4_addr1_16(ipaddr) ((u16_t)ip4_addr1(ipaddr))
/* These are cast to u16_t, with the intent that they are often arguments
 * to printf using the U16_F format from cc.h. */

Marco ip4_addr2_16(ipaddr)

#define ip4_addr2_16(ipaddr) ((u16_t)ip4_addr2(ipaddr))


      

Marco ip4_addr3_16(ipaddr)

#define ip4_addr3_16(ipaddr) ((u16_t)ip4_addr3(ipaddr))


      

Marco ip4_addr4_16(ipaddr)

#define ip4_addr4_16(ipaddr) ((u16_t)ip4_addr4(ipaddr))


      

Marco ip4_addr1_16_val(ipaddr)

#define ip4_addr1_16_val(ipaddr) ((u16_t)ip4_addr1_val(ipaddr))


      

Marco ip4_addr2_16_val(ipaddr)

#define ip4_addr2_16_val(ipaddr) ((u16_t)ip4_addr2_val(ipaddr))


      

Marco ip4_addr3_16_val(ipaddr)

#define ip4_addr3_16_val(ipaddr) ((u16_t)ip4_addr3_val(ipaddr))


      

Marco ip4_addr4_16_val(ipaddr)

#define ip4_addr4_16_val(ipaddr) ((u16_t)ip4_addr4_val(ipaddr))


      

Marco IP4ADDR_STRLEN_MAX

#define IP4ADDR_STRLEN_MAX 16


      

Marco ip_ntoa(ipaddr)

#define ip_ntoa(ipaddr) ipaddr_ntoa(ipaddr)
/** For backwards compatibility */

Functions

Func ip4_addr_isbroadcast_u32

u8_t ip4_addr_isbroadcast_u32(u32_t addr, const struct netif *netif);


      

Func ip4_addr_netmask_valid

u8_t ip4_addr_netmask_valid(u32_t netmask);


      

Func ipaddr_addr

u32_t ipaddr_addr(const char *cp);


      

Func ip4addr_aton

int ip4addr_aton(const char *cp, ip4_addr_t *addr);

      

Vars

Variable netif

struct netif;
/* Forward declaration to not include netif.h */

Variable char

char *ip4addr_ntoa(const ip4_addr_t *addr);
/** returns ptr to static buffer; not reentrant! */

Variable char

char *ip4addr_ntoa_r(const ip4_addr_t *addr, char *buf, int buflen);

      

Consts

Types

Typedefs

Typedef ip4_addr_t

typedef struct ip4_addr ip4_addr_t;
/** ip4_addr_t uses a struct for convenience only, so that the same defines can
 * operate both on ip4_addr_t as well as on ip4_addr_p_t. */