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