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_H__
33#define __LWIP_IP_H__
34
35#include "lwip/opt.h"
36#include "lwip/def.h"
37#include "lwip/pbuf.h"
38#include "lwip/ip_addr.h"
39
40#include "lwip/err.h"
41
42#ifdef __cplusplus
43extern "C" {
44#endif
45
46#define IP_HLEN 40
47
48#define IP_PROTO_ICMP    58
49#define IP_PROTO_UDP     17
50#define IP_PROTO_UDPLITE 136
51#define IP_PROTO_TCP     6
52
53/* This is passed as the destination address to ip_output_if (not
54   to ip_output), meaning that an IP header already is constructed
55   in the pbuf. This is used when TCP retransmits. */
56#ifdef IP_HDRINCL
57#undef IP_HDRINCL
58#endif                          /* IP_HDRINCL */
59#define IP_HDRINCL  NULL
60
61#if LWIP_NETIF_HWADDRHINT
62#define IP_PCB_ADDRHINT ;u8_t addr_hint
63#else
64#define IP_PCB_ADDRHINT
65#endif                          /* LWIP_NETIF_HWADDRHINT */
66
67/* This is the common part of all PCB types. It needs to be at the
68   beginning of a PCB type definition. It is located here so that
69   changes to this common part are made in one location instead of
70   having to change all PCB structs. */
71#define IP_PCB struct ip_addr local_ip; \
72  struct ip_addr remote_ip; \
73   /* Socket options */  \
74  u16_t so_options;      \
75   /* Type Of Service */ \
76  u8_t tos;              \
77  /* Time To Live */     \
78  u8_t ttl;              \
79  /* link layer address resolution hint */ \
80  IP_PCB_ADDRHINT
81
82
83/* The IPv6 header. */
84    struct ip_hdr {
85#if BYTE_ORDER == LITTLE_ENDIAN
86        u8_t tclass1:4, v:4;
87        u8_t flow1:4, tclass2:4;
88#else
89        u8_t v:4, tclass1:4;
90        u8_t tclass2:8, flow1:4;
91#endif
92        u16_t flow2;
93        u16_t len;              /* payload length */
94        u8_t nexthdr;           /* next header */
95        u8_t hoplim;            /* hop limit (TTL) */
96        struct ip_addr src, dest;       /* source and destination IP addresses */
97    };
98
99#define IPH_PROTO(hdr) (iphdr->nexthdr)
100
101    void ip_init(void);
102
103#include "lwip/netif.h"
104
105    struct netif *ip_route(struct ip_addr *dest);
106
107    void ip_input(struct pbuf *p, struct netif *inp);
108
109/* source and destination addresses in network byte order, please */
110    err_t ip_output(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest,
111                    u8_t ttl, u8_t proto);
112
113    err_t ip_output_if(struct pbuf *p, struct ip_addr *src,
114                       struct ip_addr *dest, u8_t ttl, u8_t proto,
115                       struct netif *netif);
116
117#define ip_current_netif() NULL
118#define ip_current_header() NULL
119
120#if IP_DEBUG
121    void ip_debug_print(struct pbuf *p);
122#endif                          /* IP_DEBUG */
123
124#ifdef __cplusplus
125}
126#endif
127#endif                          /* __LWIP_IP_H__ */
128