First run at integrating LWIP into the tree (again)
[akaros.git] / user / lwip / include / lwip / netbuf.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_NETBUF_H__
33 #define __LWIP_NETBUF_H__
34
35 #include "lwip/opt.h"
36 #include "lwip/pbuf.h"
37 #include "lwip/ip_addr.h"
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 struct netbuf {
44   struct pbuf *p, *ptr;
45   struct ip_addr *addr;
46   u16_t port;
47 #if LWIP_NETBUF_RECVINFO
48   struct ip_addr *toaddr;
49   u16_t toport;
50 #endif /* LWIP_NETBUF_RECVINFO */
51 };
52
53 /* Network buffer functions: */
54 struct netbuf *   netbuf_new      (void);
55 void              netbuf_delete   (struct netbuf *buf);
56 void *            netbuf_alloc    (struct netbuf *buf, u16_t size);
57 void              netbuf_free     (struct netbuf *buf);
58 err_t             netbuf_ref      (struct netbuf *buf,
59            const void *dataptr, u16_t size);
60 void              netbuf_chain    (struct netbuf *head,
61            struct netbuf *tail);
62
63 u16_t             netbuf_len      (struct netbuf *buf);
64 err_t             netbuf_data     (struct netbuf *buf,
65            void **dataptr, u16_t *len);
66 s8_t              netbuf_next     (struct netbuf *buf);
67 void              netbuf_first    (struct netbuf *buf);
68
69
70 #define netbuf_copy_partial(buf, dataptr, len, offset) \
71   pbuf_copy_partial((buf)->p, (dataptr), (len), (offset))
72 #define netbuf_copy(buf,dataptr,len) netbuf_copy_partial(buf, dataptr, len, 0)
73 #define netbuf_take(buf, dataptr, len) pbuf_take((buf)->p, dataptr, len)
74 #define netbuf_len(buf)              ((buf)->p->tot_len)
75 #define netbuf_fromaddr(buf)         ((buf)->addr)
76 #define netbuf_fromport(buf)         ((buf)->port)
77 #if LWIP_NETBUF_RECVINFO
78 #define netbuf_destaddr(buf)         ((buf)->toaddr)
79 #define netbuf_destport(buf)         ((buf)->toport)
80 #endif /* LWIP_NETBUF_RECVINFO */
81
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif /* __LWIP_NETBUF_H__ */