Angel David Yaguana Hernandez / EthernetNetIf

Dependents:   RTnoV3 RTnoV3_LED RTnoV3_Template RTnoV3_ADC ... more

LPC2368/lwip/include/lwip/netbuf.h@0:479ce5546098, 2011-12-31 (annotated)

Committer:
sherckuith
Date:
Sat Dec 31 11:25:27 2011 +0000
Revision:
0:479ce5546098
Ethernet

Who changed what in which revision?

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