Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
lwip/include/lwip/netbuf.h@5:dd63a1e02b1b, 2010-07-27 (annotated)
- Committer:
- donatien
- Date:
- Tue Jul 27 15:59:42 2010 +0000
- Revision:
- 5:dd63a1e02b1b
- Parent:
- 0:632c9925f013
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:632c9925f013 | 1 | /* |
| donatien | 0:632c9925f013 | 2 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
| donatien | 0:632c9925f013 | 3 | * All rights reserved. |
| donatien | 0:632c9925f013 | 4 | * |
| donatien | 0:632c9925f013 | 5 | * Redistribution and use in source and binary forms, with or without modification, |
| donatien | 0:632c9925f013 | 6 | * are permitted provided that the following conditions are met: |
| donatien | 0:632c9925f013 | 7 | * |
| donatien | 0:632c9925f013 | 8 | * 1. Redistributions of source code must retain the above copyright notice, |
| donatien | 0:632c9925f013 | 9 | * this list of conditions and the following disclaimer. |
| donatien | 0:632c9925f013 | 10 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| donatien | 0:632c9925f013 | 11 | * this list of conditions and the following disclaimer in the documentation |
| donatien | 0:632c9925f013 | 12 | * and/or other materials provided with the distribution. |
| donatien | 0:632c9925f013 | 13 | * 3. The name of the author may not be used to endorse or promote products |
| donatien | 0:632c9925f013 | 14 | * derived from this software without specific prior written permission. |
| donatien | 0:632c9925f013 | 15 | * |
| donatien | 0:632c9925f013 | 16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
| donatien | 0:632c9925f013 | 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| donatien | 0:632c9925f013 | 18 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
| donatien | 0:632c9925f013 | 19 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| donatien | 0:632c9925f013 | 20 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
| donatien | 0:632c9925f013 | 21 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| donatien | 0:632c9925f013 | 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| donatien | 0:632c9925f013 | 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| donatien | 0:632c9925f013 | 24 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
| donatien | 0:632c9925f013 | 25 | * OF SUCH DAMAGE. |
| donatien | 0:632c9925f013 | 26 | * |
| donatien | 0:632c9925f013 | 27 | * This file is part of the lwIP TCP/IP stack. |
| donatien | 0:632c9925f013 | 28 | * |
| donatien | 0:632c9925f013 | 29 | * Author: Adam Dunkels <adam@sics.se> |
| donatien | 0:632c9925f013 | 30 | * |
| donatien | 0:632c9925f013 | 31 | */ |
| donatien | 0:632c9925f013 | 32 | #ifndef __LWIP_NETBUF_H__ |
| donatien | 0:632c9925f013 | 33 | #define __LWIP_NETBUF_H__ |
| donatien | 0:632c9925f013 | 34 | |
| donatien | 0:632c9925f013 | 35 | #include "lwip/opt.h" |
| donatien | 0:632c9925f013 | 36 | #include "lwip/pbuf.h" |
| donatien | 0:632c9925f013 | 37 | #include "lwip/ip_addr.h" |
| donatien | 0:632c9925f013 | 38 | |
| donatien | 0:632c9925f013 | 39 | #ifdef __cplusplus |
| donatien | 0:632c9925f013 | 40 | extern "C" { |
| donatien | 0:632c9925f013 | 41 | #endif |
| donatien | 0:632c9925f013 | 42 | |
| donatien | 5:dd63a1e02b1b | 43 | /** This netbuf has dest-addr/port set */ |
| donatien | 5:dd63a1e02b1b | 44 | #define NETBUF_FLAG_DESTADDR 0x01 |
| donatien | 5:dd63a1e02b1b | 45 | /** This netbuf includes a checksum */ |
| donatien | 5:dd63a1e02b1b | 46 | #define NETBUF_FLAG_CHKSUM 0x02 |
| donatien | 5:dd63a1e02b1b | 47 | |
| donatien | 0:632c9925f013 | 48 | struct netbuf { |
| donatien | 0:632c9925f013 | 49 | struct pbuf *p, *ptr; |
| donatien | 5:dd63a1e02b1b | 50 | ip_addr_t addr; |
| donatien | 0:632c9925f013 | 51 | u16_t port; |
| donatien | 5:dd63a1e02b1b | 52 | #if LWIP_NETBUF_RECVINFO || LWIP_CHECKSUM_ON_COPY |
| donatien | 5:dd63a1e02b1b | 53 | #if LWIP_CHECKSUM_ON_COPY |
| donatien | 5:dd63a1e02b1b | 54 | u8_t flags; |
| donatien | 5:dd63a1e02b1b | 55 | #endif /* LWIP_CHECKSUM_ON_COPY */ |
| donatien | 5:dd63a1e02b1b | 56 | u16_t toport_chksum; |
| donatien | 0:632c9925f013 | 57 | #if LWIP_NETBUF_RECVINFO |
| donatien | 5:dd63a1e02b1b | 58 | ip_addr_t toaddr; |
| donatien | 0:632c9925f013 | 59 | #endif /* LWIP_NETBUF_RECVINFO */ |
| donatien | 5:dd63a1e02b1b | 60 | #endif /* LWIP_NETBUF_RECVINFO || LWIP_CHECKSUM_ON_COPY */ |
| donatien | 0:632c9925f013 | 61 | }; |
| donatien | 0:632c9925f013 | 62 | |
| donatien | 0:632c9925f013 | 63 | /* Network buffer functions: */ |
| donatien | 0:632c9925f013 | 64 | struct netbuf * netbuf_new (void); |
| donatien | 0:632c9925f013 | 65 | void netbuf_delete (struct netbuf *buf); |
| donatien | 0:632c9925f013 | 66 | void * netbuf_alloc (struct netbuf *buf, u16_t size); |
| donatien | 0:632c9925f013 | 67 | void netbuf_free (struct netbuf *buf); |
| donatien | 0:632c9925f013 | 68 | err_t netbuf_ref (struct netbuf *buf, |
| donatien | 5:dd63a1e02b1b | 69 | const void *dataptr, u16_t size); |
| donatien | 0:632c9925f013 | 70 | void netbuf_chain (struct netbuf *head, |
| donatien | 0:632c9925f013 | 71 | struct netbuf *tail); |
| donatien | 0:632c9925f013 | 72 | |
| donatien | 0:632c9925f013 | 73 | err_t netbuf_data (struct netbuf *buf, |
| donatien | 5:dd63a1e02b1b | 74 | void **dataptr, u16_t *len); |
| donatien | 0:632c9925f013 | 75 | s8_t netbuf_next (struct netbuf *buf); |
| donatien | 0:632c9925f013 | 76 | void netbuf_first (struct netbuf *buf); |
| donatien | 0:632c9925f013 | 77 | |
| donatien | 0:632c9925f013 | 78 | |
| donatien | 0:632c9925f013 | 79 | #define netbuf_copy_partial(buf, dataptr, len, offset) \ |
| donatien | 0:632c9925f013 | 80 | pbuf_copy_partial((buf)->p, (dataptr), (len), (offset)) |
| donatien | 0:632c9925f013 | 81 | #define netbuf_copy(buf,dataptr,len) netbuf_copy_partial(buf, dataptr, len, 0) |
| donatien | 0:632c9925f013 | 82 | #define netbuf_take(buf, dataptr, len) pbuf_take((buf)->p, dataptr, len) |
| donatien | 0:632c9925f013 | 83 | #define netbuf_len(buf) ((buf)->p->tot_len) |
| donatien | 5:dd63a1e02b1b | 84 | #define netbuf_fromaddr(buf) (&((buf)->addr)) |
| donatien | 5:dd63a1e02b1b | 85 | #define netbuf_set_fromaddr(buf, fromaddr) ip_addr_set((&(buf)->addr), fromaddr) |
| donatien | 0:632c9925f013 | 86 | #define netbuf_fromport(buf) ((buf)->port) |
| donatien | 0:632c9925f013 | 87 | #if LWIP_NETBUF_RECVINFO |
| donatien | 5:dd63a1e02b1b | 88 | #define netbuf_destaddr(buf) (&((buf)->toaddr)) |
| donatien | 5:dd63a1e02b1b | 89 | #define netbuf_set_destaddr(buf, destaddr) ip_addr_set((&(buf)->addr), destaddr) |
| donatien | 5:dd63a1e02b1b | 90 | #define netbuf_destport(buf) (((buf)->flags & NETBUF_FLAG_DESTADDR) ? (buf)->toport_chksum : 0) |
| donatien | 0:632c9925f013 | 91 | #endif /* LWIP_NETBUF_RECVINFO */ |
| donatien | 5:dd63a1e02b1b | 92 | #if LWIP_CHECKSUM_ON_COPY |
| donatien | 5:dd63a1e02b1b | 93 | #define netbuf_set_chksum(buf, chksum) do { (buf)->flags = NETBUF_FLAG_CHKSUM; \ |
| donatien | 5:dd63a1e02b1b | 94 | (buf)->toport_chksum = chksum; } while(0) |
| donatien | 5:dd63a1e02b1b | 95 | #endif /* LWIP_CHECKSUM_ON_COPY */ |
| donatien | 0:632c9925f013 | 96 | |
| donatien | 0:632c9925f013 | 97 | #ifdef __cplusplus |
| donatien | 0:632c9925f013 | 98 | } |
| donatien | 0:632c9925f013 | 99 | #endif |
| donatien | 0:632c9925f013 | 100 | |
| donatien | 0:632c9925f013 | 101 | #endif /* __LWIP_NETBUF_H__ */ |