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 | /** This netbuf has dest-addr/port set */
|
---|
44 | #define NETBUF_FLAG_DESTADDR 0x01
|
---|
45 | /** This netbuf includes a checksum */
|
---|
46 | #define NETBUF_FLAG_CHKSUM 0x02
|
---|
47 |
|
---|
48 | struct netbuf {
|
---|
49 | struct pbuf *p, *ptr;
|
---|
50 | ip_addr_t addr;
|
---|
51 | u16_t port;
|
---|
52 | #if LWIP_NETBUF_RECVINFO || LWIP_CHECKSUM_ON_COPY
|
---|
53 | #if LWIP_CHECKSUM_ON_COPY
|
---|
54 | u8_t flags;
|
---|
55 | #endif /* LWIP_CHECKSUM_ON_COPY */
|
---|
56 | u16_t toport_chksum;
|
---|
57 | #if LWIP_NETBUF_RECVINFO
|
---|
58 | ip_addr_t toaddr;
|
---|
59 | #endif /* LWIP_NETBUF_RECVINFO */
|
---|
60 | #endif /* LWIP_NETBUF_RECVINFO || LWIP_CHECKSUM_ON_COPY */
|
---|
61 | };
|
---|
62 |
|
---|
63 | /* Network buffer functions: */
|
---|
64 | struct netbuf * netbuf_new (void);
|
---|
65 | void netbuf_delete (struct netbuf *buf);
|
---|
66 | void * netbuf_alloc (struct netbuf *buf, u16_t size);
|
---|
67 | void netbuf_free (struct netbuf *buf);
|
---|
68 | err_t netbuf_ref (struct netbuf *buf,
|
---|
69 | const void *dataptr, u16_t size);
|
---|
70 | void netbuf_chain (struct netbuf *head,
|
---|
71 | struct netbuf *tail);
|
---|
72 |
|
---|
73 | err_t netbuf_data (struct netbuf *buf,
|
---|
74 | void **dataptr, u16_t *len);
|
---|
75 | s8_t netbuf_next (struct netbuf *buf);
|
---|
76 | void netbuf_first (struct netbuf *buf);
|
---|
77 |
|
---|
78 |
|
---|
79 | #define netbuf_copy_partial(buf, dataptr, len, offset) \
|
---|
80 | pbuf_copy_partial((buf)->p, (dataptr), (len), (offset))
|
---|
81 | #define netbuf_copy(buf,dataptr,len) netbuf_copy_partial(buf, dataptr, len, 0)
|
---|
82 | #define netbuf_take(buf, dataptr, len) pbuf_take((buf)->p, dataptr, len)
|
---|
83 | #define netbuf_len(buf) ((buf)->p->tot_len)
|
---|
84 | #define netbuf_fromaddr(buf) (&((buf)->addr))
|
---|
85 | #define netbuf_set_fromaddr(buf, fromaddr) ip_addr_set((&(buf)->addr), fromaddr)
|
---|
86 | #define netbuf_fromport(buf) ((buf)->port)
|
---|
87 | #if LWIP_NETBUF_RECVINFO
|
---|
88 | #define netbuf_destaddr(buf) (&((buf)->toaddr))
|
---|
89 | #define netbuf_set_destaddr(buf, destaddr) ip_addr_set((&(buf)->addr), destaddr)
|
---|
90 | #define netbuf_destport(buf) (((buf)->flags & NETBUF_FLAG_DESTADDR) ? (buf)->toport_chksum : 0)
|
---|
91 | #endif /* LWIP_NETBUF_RECVINFO */
|
---|
92 | #if LWIP_CHECKSUM_ON_COPY
|
---|
93 | #define netbuf_set_chksum(buf, chksum) do { (buf)->flags = NETBUF_FLAG_CHKSUM; \
|
---|
94 | (buf)->toport_chksum = chksum; } while(0)
|
---|
95 | #endif /* LWIP_CHECKSUM_ON_COPY */
|
---|
96 |
|
---|
97 | #ifdef __cplusplus
|
---|
98 | }
|
---|
99 | #endif
|
---|
100 |
|
---|
101 | #endif /* __LWIP_NETBUF_H__ */
|
---|