Yihui Xiong / lwip-arch-max-dev

dev

Dependents:   EthernetInterface

Fork of lwip by mbed official

include/lwip/netbuf.h@0:51ac1d130fd4, 2012-06-22 (annotated)

Committer:
mbed_official
Date:
Fri Jun 22 09:25:39 2012 +0000
Revision:
0:51ac1d130fd4
Initial import from lwip-1.4.0: http://download.savannah.gnu.org/releases/lwip/lwip-1.4.0.zip

Who changed what in which revision?

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