| User | Revision | Line number | New contents of line |
|---|
| donatien |
0:0f5a52711275
|
1
|
/*
|
| donatien |
0:0f5a52711275
|
2
|
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
|
| donatien |
0:0f5a52711275
|
3
|
* All rights reserved.
|
| donatien |
0:0f5a52711275
|
4
|
*
|
| donatien |
0:0f5a52711275
|
5
|
* Redistribution and use in source and binary forms, with or without modification,
|
| donatien |
0:0f5a52711275
|
6
|
* are permitted provided that the following conditions are met:
|
| donatien |
0:0f5a52711275
|
7
|
*
|
| donatien |
0:0f5a52711275
|
8
|
* 1. Redistributions of source code must retain the above copyright notice,
|
| donatien |
0:0f5a52711275
|
9
|
* this list of conditions and the following disclaimer.
|
| donatien |
0:0f5a52711275
|
10
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
| donatien |
0:0f5a52711275
|
11
|
* this list of conditions and the following disclaimer in the documentation
|
| donatien |
0:0f5a52711275
|
12
|
* and/or other materials provided with the distribution.
|
| donatien |
0:0f5a52711275
|
13
|
* 3. The name of the author may not be used to endorse or promote products
|
| donatien |
0:0f5a52711275
|
14
|
* derived from this software without specific prior written permission.
|
| donatien |
0:0f5a52711275
|
15
|
*
|
| donatien |
0:0f5a52711275
|
16
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
|
| donatien |
0:0f5a52711275
|
17
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
| donatien |
0:0f5a52711275
|
18
|
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
|
| donatien |
0:0f5a52711275
|
19
|
* SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
| donatien |
0:0f5a52711275
|
20
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
|
| donatien |
0:0f5a52711275
|
21
|
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
| donatien |
0:0f5a52711275
|
22
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
| donatien |
0:0f5a52711275
|
23
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
| donatien |
0:0f5a52711275
|
24
|
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
|
| donatien |
0:0f5a52711275
|
25
|
* OF SUCH DAMAGE.
|
| donatien |
0:0f5a52711275
|
26
|
*
|
| donatien |
0:0f5a52711275
|
27
|
* This file is part of the lwIP TCP/IP stack.
|
| donatien |
0:0f5a52711275
|
28
|
*
|
| donatien |
0:0f5a52711275
|
29
|
* Author: Adam Dunkels <adam@sics.se>
|
| donatien |
0:0f5a52711275
|
30
|
*
|
| donatien |
0:0f5a52711275
|
31
|
*/
|
| donatien |
0:0f5a52711275
|
32
|
|
| donatien |
0:0f5a52711275
|
33
|
#ifndef __LWIP_PBUF_H__
|
| donatien |
0:0f5a52711275
|
34
|
#define __LWIP_PBUF_H__
|
| donatien |
0:0f5a52711275
|
35
|
|
| donatien |
0:0f5a52711275
|
36
|
#include "lwip/opt.h"
|
| donatien |
0:0f5a52711275
|
37
|
#include "lwip/err.h"
|
| donatien |
0:0f5a52711275
|
38
|
|
| donatien |
0:0f5a52711275
|
39
|
#ifdef __cplusplus
|
| donatien |
0:0f5a52711275
|
40
|
extern "C" {
|
| donatien |
0:0f5a52711275
|
41
|
#endif
|
| donatien |
0:0f5a52711275
|
42
|
|
| donatien |
3:e02ec42cf9c8
|
43
|
/* Currently, the pbuf_custom code is only needed for one specific configuration
|
| donatien |
2:1f10f8ab527b
|
44
|
* of IP_FRAG */
|
| donatien |
2:1f10f8ab527b
|
45
|
#define LWIP_SUPPORT_CUSTOM_PBUF (IP_FRAG && !IP_FRAG_USES_STATIC_BUF && !LWIP_NETIF_TX_SINGLE_PBUF)
|
| donatien |
2:1f10f8ab527b
|
46
|
|
| donatien |
0:0f5a52711275
|
47
|
#define PBUF_TRANSPORT_HLEN 20
|
| donatien |
0:0f5a52711275
|
48
|
#define PBUF_IP_HLEN 20
|
| donatien |
0:0f5a52711275
|
49
|
|
| donatien |
0:0f5a52711275
|
50
|
typedef enum {
|
| donatien |
0:0f5a52711275
|
51
|
PBUF_TRANSPORT,
|
| donatien |
0:0f5a52711275
|
52
|
PBUF_IP,
|
| donatien |
0:0f5a52711275
|
53
|
PBUF_LINK,
|
| donatien |
0:0f5a52711275
|
54
|
PBUF_RAW
|
| donatien |
0:0f5a52711275
|
55
|
} pbuf_layer;
|
| donatien |
0:0f5a52711275
|
56
|
|
| donatien |
0:0f5a52711275
|
57
|
typedef enum {
|
| donatien |
0:0f5a52711275
|
58
|
PBUF_RAM, /* pbuf data is stored in RAM */
|
| donatien |
0:0f5a52711275
|
59
|
PBUF_ROM, /* pbuf data is stored in ROM */
|
| donatien |
0:0f5a52711275
|
60
|
PBUF_REF, /* pbuf comes from the pbuf pool */
|
| donatien |
0:0f5a52711275
|
61
|
PBUF_POOL /* pbuf payload refers to RAM */
|
| donatien |
0:0f5a52711275
|
62
|
} pbuf_type;
|
| donatien |
0:0f5a52711275
|
63
|
|
| donatien |
0:0f5a52711275
|
64
|
|
| donatien |
3:e02ec42cf9c8
|
65
|
/* indicates this packet's data should be immediately passed to the application */
|
| donatien |
2:1f10f8ab527b
|
66
|
#define PBUF_FLAG_PUSH 0x01U
|
| donatien |
3:e02ec42cf9c8
|
67
|
/* indicates this is a custom pbuf: pbuf_free and pbuf_header handle such a
|
| donatien |
2:1f10f8ab527b
|
68
|
a pbuf differently */
|
| donatien |
2:1f10f8ab527b
|
69
|
#define PBUF_FLAG_IS_CUSTOM 0x02U
|
| donatien |
3:e02ec42cf9c8
|
70
|
/* indicates this pbuf is UDP multicast to be looped back */
|
| donatien |
2:1f10f8ab527b
|
71
|
#define PBUF_FLAG_MCASTLOOP 0x04U
|
| donatien |
0:0f5a52711275
|
72
|
|
| donatien |
0:0f5a52711275
|
73
|
struct pbuf {
|
| donatien |
3:e02ec42cf9c8
|
74
|
/* next pbuf in singly linked pbuf chain */
|
| donatien |
0:0f5a52711275
|
75
|
struct pbuf *next;
|
| donatien |
0:0f5a52711275
|
76
|
|
| donatien |
3:e02ec42cf9c8
|
77
|
/* pointer to the actual data in the buffer */
|
| donatien |
0:0f5a52711275
|
78
|
void *payload;
|
| donatien |
2:1f10f8ab527b
|
79
|
|
| donatien |
0:0f5a52711275
|
80
|
/**
|
| donatien |
0:0f5a52711275
|
81
|
* total length of this buffer and all next buffers in chain
|
| donatien |
0:0f5a52711275
|
82
|
* belonging to the same packet.
|
| donatien |
0:0f5a52711275
|
83
|
*
|
| donatien |
0:0f5a52711275
|
84
|
* For non-queue packet chains this is the invariant:
|
| donatien |
0:0f5a52711275
|
85
|
* p->tot_len == p->len + (p->next? p->next->tot_len: 0)
|
| donatien |
0:0f5a52711275
|
86
|
*/
|
| donatien |
0:0f5a52711275
|
87
|
u16_t tot_len;
|
| donatien |
2:1f10f8ab527b
|
88
|
|
| donatien |
3:e02ec42cf9c8
|
89
|
/* length of this buffer */
|
| donatien |
2:1f10f8ab527b
|
90
|
u16_t len;
|
| donatien |
0:0f5a52711275
|
91
|
|
| donatien |
3:e02ec42cf9c8
|
92
|
/* pbuf_type as u8_t instead of enum to save space */
|
| donatien |
0:0f5a52711275
|
93
|
u8_t /*pbuf_type*/ type;
|
| donatien |
0:0f5a52711275
|
94
|
|
| donatien |
3:e02ec42cf9c8
|
95
|
/* misc flags */
|
| donatien |
0:0f5a52711275
|
96
|
u8_t flags;
|
| donatien |
0:0f5a52711275
|
97
|
|
| donatien |
0:0f5a52711275
|
98
|
/**
|
| donatien |
0:0f5a52711275
|
99
|
* the reference count always equals the number of pointers
|
| donatien |
0:0f5a52711275
|
100
|
* that refer to this pbuf. This can be pointers from an application,
|
| donatien |
0:0f5a52711275
|
101
|
* the stack itself, or pbuf->next pointers from a chain.
|
| donatien |
0:0f5a52711275
|
102
|
*/
|
| donatien |
0:0f5a52711275
|
103
|
u16_t ref;
|
| donatien |
0:0f5a52711275
|
104
|
};
|
| donatien |
0:0f5a52711275
|
105
|
|
| donatien |
2:1f10f8ab527b
|
106
|
#if LWIP_SUPPORT_CUSTOM_PBUF
|
| donatien |
3:e02ec42cf9c8
|
107
|
/* Prototype for a function to free a custom pbuf */
|
| donatien |
2:1f10f8ab527b
|
108
|
typedef void (*pbuf_free_custom_fn)(struct pbuf *p);
|
| donatien |
2:1f10f8ab527b
|
109
|
|
| donatien |
3:e02ec42cf9c8
|
110
|
/* A custom pbuf: like a pbuf, but following a function pointer to free it. */
|
| donatien |
2:1f10f8ab527b
|
111
|
struct pbuf_custom {
|
| donatien |
3:e02ec42cf9c8
|
112
|
/* The actual pbuf */
|
| donatien |
2:1f10f8ab527b
|
113
|
struct pbuf pbuf;
|
| donatien |
3:e02ec42cf9c8
|
114
|
/* This function is called when pbuf_free deallocates this pbuf(_custom) */
|
| donatien |
2:1f10f8ab527b
|
115
|
pbuf_free_custom_fn custom_free_function;
|
| donatien |
2:1f10f8ab527b
|
116
|
};
|
| donatien |
2:1f10f8ab527b
|
117
|
#endif /* LWIP_SUPPORT_CUSTOM_PBUF */
|
| donatien |
2:1f10f8ab527b
|
118
|
|
| donatien |
0:0f5a52711275
|
119
|
/* Initializes the pbuf module. This call is empty for now, but may not be in future. */
|
| donatien |
0:0f5a52711275
|
120
|
#define pbuf_init()
|
| donatien |
0:0f5a52711275
|
121
|
|
| donatien |
2:1f10f8ab527b
|
122
|
struct pbuf *pbuf_alloc(pbuf_layer l, u16_t length, pbuf_type type);
|
| donatien |
2:1f10f8ab527b
|
123
|
#if LWIP_SUPPORT_CUSTOM_PBUF
|
| donatien |
2:1f10f8ab527b
|
124
|
struct pbuf *pbuf_alloced_custom(pbuf_layer l, u16_t length, pbuf_type type,
|
| donatien |
2:1f10f8ab527b
|
125
|
struct pbuf_custom *p, void *payload_mem,
|
| donatien |
2:1f10f8ab527b
|
126
|
u16_t payload_mem_len);
|
| donatien |
2:1f10f8ab527b
|
127
|
#endif /* LWIP_SUPPORT_CUSTOM_PBUF */
|
| donatien |
0:0f5a52711275
|
128
|
void pbuf_realloc(struct pbuf *p, u16_t size);
|
| donatien |
0:0f5a52711275
|
129
|
u8_t pbuf_header(struct pbuf *p, s16_t header_size);
|
| donatien |
0:0f5a52711275
|
130
|
void pbuf_ref(struct pbuf *p);
|
| donatien |
0:0f5a52711275
|
131
|
u8_t pbuf_free(struct pbuf *p);
|
| donatien |
0:0f5a52711275
|
132
|
u8_t pbuf_clen(struct pbuf *p);
|
| donatien |
0:0f5a52711275
|
133
|
void pbuf_cat(struct pbuf *head, struct pbuf *tail);
|
| donatien |
0:0f5a52711275
|
134
|
void pbuf_chain(struct pbuf *head, struct pbuf *tail);
|
| donatien |
0:0f5a52711275
|
135
|
struct pbuf *pbuf_dechain(struct pbuf *p);
|
| donatien |
0:0f5a52711275
|
136
|
err_t pbuf_copy(struct pbuf *p_to, struct pbuf *p_from);
|
| donatien |
0:0f5a52711275
|
137
|
u16_t pbuf_copy_partial(struct pbuf *p, void *dataptr, u16_t len, u16_t offset);
|
| donatien |
0:0f5a52711275
|
138
|
err_t pbuf_take(struct pbuf *buf, const void *dataptr, u16_t len);
|
| donatien |
0:0f5a52711275
|
139
|
struct pbuf *pbuf_coalesce(struct pbuf *p, pbuf_layer layer);
|
| donatien |
2:1f10f8ab527b
|
140
|
#if LWIP_CHECKSUM_ON_COPY
|
| donatien |
2:1f10f8ab527b
|
141
|
err_t pbuf_fill_chksum(struct pbuf *p, u16_t start_offset, const void *dataptr,
|
| donatien |
2:1f10f8ab527b
|
142
|
u16_t len, u16_t *chksum);
|
| donatien |
2:1f10f8ab527b
|
143
|
#endif /* LWIP_CHECKSUM_ON_COPY */
|
| donatien |
2:1f10f8ab527b
|
144
|
|
| donatien |
2:1f10f8ab527b
|
145
|
u8_t pbuf_get_at(struct pbuf* p, u16_t offset);
|
| donatien |
2:1f10f8ab527b
|
146
|
u16_t pbuf_memcmp(struct pbuf* p, u16_t offset, const void* s2, u16_t n);
|
| donatien |
2:1f10f8ab527b
|
147
|
u16_t pbuf_memfind(struct pbuf* p, const void* mem, u16_t mem_len, u16_t start_offset);
|
| donatien |
2:1f10f8ab527b
|
148
|
u16_t pbuf_strstr(struct pbuf* p, const char* substr);
|
| donatien |
0:0f5a52711275
|
149
|
|
| donatien |
0:0f5a52711275
|
150
|
#ifdef __cplusplus
|
| donatien |
0:0f5a52711275
|
151
|
}
|
| donatien |
0:0f5a52711275
|
152
|
#endif
|
| donatien |
0:0f5a52711275
|
153
|
|
| donatien |
0:0f5a52711275
|
154
|
#endif /* __LWIP_PBUF_H__ */
|
Donatien Garnier