Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
lwip/include/lwip/pbuf.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 | |
| donatien | 0:632c9925f013 | 33 | #ifndef __LWIP_PBUF_H__ |
| donatien | 0:632c9925f013 | 34 | #define __LWIP_PBUF_H__ |
| donatien | 0:632c9925f013 | 35 | |
| donatien | 0:632c9925f013 | 36 | #include "lwip/opt.h" |
| donatien | 0:632c9925f013 | 37 | #include "lwip/err.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 | /* Currently, the pbuf_custom code is only needed for one specific configuration |
| donatien | 5:dd63a1e02b1b | 44 | * of IP_FRAG */ |
| donatien | 5:dd63a1e02b1b | 45 | #define LWIP_SUPPORT_CUSTOM_PBUF (IP_FRAG && !IP_FRAG_USES_STATIC_BUF && !LWIP_NETIF_TX_SINGLE_PBUF) |
| donatien | 5:dd63a1e02b1b | 46 | |
| donatien | 0:632c9925f013 | 47 | #define PBUF_TRANSPORT_HLEN 20 |
| donatien | 0:632c9925f013 | 48 | #define PBUF_IP_HLEN 20 |
| donatien | 0:632c9925f013 | 49 | |
| donatien | 0:632c9925f013 | 50 | typedef enum { |
| donatien | 0:632c9925f013 | 51 | PBUF_TRANSPORT, |
| donatien | 0:632c9925f013 | 52 | PBUF_IP, |
| donatien | 0:632c9925f013 | 53 | PBUF_LINK, |
| donatien | 0:632c9925f013 | 54 | PBUF_RAW |
| donatien | 0:632c9925f013 | 55 | } pbuf_layer; |
| donatien | 0:632c9925f013 | 56 | |
| donatien | 0:632c9925f013 | 57 | typedef enum { |
| donatien | 0:632c9925f013 | 58 | PBUF_RAM, /* pbuf data is stored in RAM */ |
| donatien | 0:632c9925f013 | 59 | PBUF_ROM, /* pbuf data is stored in ROM */ |
| donatien | 0:632c9925f013 | 60 | PBUF_REF, /* pbuf comes from the pbuf pool */ |
| donatien | 0:632c9925f013 | 61 | PBUF_POOL /* pbuf payload refers to RAM */ |
| donatien | 0:632c9925f013 | 62 | } pbuf_type; |
| donatien | 0:632c9925f013 | 63 | |
| donatien | 0:632c9925f013 | 64 | |
| donatien | 5:dd63a1e02b1b | 65 | /* indicates this packet's data should be immediately passed to the application */ |
| donatien | 5:dd63a1e02b1b | 66 | #define PBUF_FLAG_PUSH 0x01U |
| donatien | 5:dd63a1e02b1b | 67 | /* indicates this is a custom pbuf: pbuf_free and pbuf_header handle such a |
| donatien | 5:dd63a1e02b1b | 68 | a pbuf differently */ |
| donatien | 5:dd63a1e02b1b | 69 | #define PBUF_FLAG_IS_CUSTOM 0x02U |
| donatien | 5:dd63a1e02b1b | 70 | /* indicates this pbuf is UDP multicast to be looped back */ |
| donatien | 5:dd63a1e02b1b | 71 | #define PBUF_FLAG_MCASTLOOP 0x04U |
| donatien | 0:632c9925f013 | 72 | |
| donatien | 0:632c9925f013 | 73 | struct pbuf { |
| donatien | 5:dd63a1e02b1b | 74 | /* next pbuf in singly linked pbuf chain */ |
| donatien | 0:632c9925f013 | 75 | struct pbuf *next; |
| donatien | 0:632c9925f013 | 76 | |
| donatien | 5:dd63a1e02b1b | 77 | /* pointer to the actual data in the buffer */ |
| donatien | 0:632c9925f013 | 78 | void *payload; |
| donatien | 5:dd63a1e02b1b | 79 | |
| donatien | 0:632c9925f013 | 80 | /** |
| donatien | 0:632c9925f013 | 81 | * total length of this buffer and all next buffers in chain |
| donatien | 0:632c9925f013 | 82 | * belonging to the same packet. |
| donatien | 0:632c9925f013 | 83 | * |
| donatien | 0:632c9925f013 | 84 | * For non-queue packet chains this is the invariant: |
| donatien | 0:632c9925f013 | 85 | * p->tot_len == p->len + (p->next? p->next->tot_len: 0) |
| donatien | 0:632c9925f013 | 86 | */ |
| donatien | 0:632c9925f013 | 87 | u16_t tot_len; |
| donatien | 0:632c9925f013 | 88 | |
| donatien | 5:dd63a1e02b1b | 89 | /* length of this buffer */ |
| donatien | 5:dd63a1e02b1b | 90 | u16_t len; |
| donatien | 5:dd63a1e02b1b | 91 | |
| donatien | 5:dd63a1e02b1b | 92 | /* pbuf_type as u8_t instead of enum to save space */ |
| donatien | 0:632c9925f013 | 93 | u8_t /*pbuf_type*/ type; |
| donatien | 0:632c9925f013 | 94 | |
| donatien | 5:dd63a1e02b1b | 95 | /* misc flags */ |
| donatien | 0:632c9925f013 | 96 | u8_t flags; |
| donatien | 0:632c9925f013 | 97 | |
| donatien | 0:632c9925f013 | 98 | /** |
| donatien | 0:632c9925f013 | 99 | * the reference count always equals the number of pointers |
| donatien | 0:632c9925f013 | 100 | * that refer to this pbuf. This can be pointers from an application, |
| donatien | 0:632c9925f013 | 101 | * the stack itself, or pbuf->next pointers from a chain. |
| donatien | 0:632c9925f013 | 102 | */ |
| donatien | 0:632c9925f013 | 103 | u16_t ref; |
| donatien | 0:632c9925f013 | 104 | }; |
| donatien | 0:632c9925f013 | 105 | |
| donatien | 5:dd63a1e02b1b | 106 | #if LWIP_SUPPORT_CUSTOM_PBUF |
| donatien | 5:dd63a1e02b1b | 107 | /* Prototype for a function to free a custom pbuf */ |
| donatien | 5:dd63a1e02b1b | 108 | typedef void (*pbuf_free_custom_fn)(struct pbuf *p); |
| donatien | 5:dd63a1e02b1b | 109 | |
| donatien | 5:dd63a1e02b1b | 110 | /* A custom pbuf: like a pbuf, but following a function pointer to free it. */ |
| donatien | 5:dd63a1e02b1b | 111 | struct pbuf_custom { |
| donatien | 5:dd63a1e02b1b | 112 | /* The actual pbuf */ |
| donatien | 5:dd63a1e02b1b | 113 | struct pbuf pbuf; |
| donatien | 5:dd63a1e02b1b | 114 | /* This function is called when pbuf_free deallocates this pbuf(_custom) */ |
| donatien | 5:dd63a1e02b1b | 115 | pbuf_free_custom_fn custom_free_function; |
| donatien | 5:dd63a1e02b1b | 116 | }; |
| donatien | 5:dd63a1e02b1b | 117 | #endif /* LWIP_SUPPORT_CUSTOM_PBUF */ |
| donatien | 5:dd63a1e02b1b | 118 | |
| donatien | 0:632c9925f013 | 119 | /* Initializes the pbuf module. This call is empty for now, but may not be in future. */ |
| donatien | 0:632c9925f013 | 120 | #define pbuf_init() |
| donatien | 0:632c9925f013 | 121 | |
| donatien | 5:dd63a1e02b1b | 122 | struct pbuf *pbuf_alloc(pbuf_layer l, u16_t length, pbuf_type type); |
| donatien | 5:dd63a1e02b1b | 123 | #if LWIP_SUPPORT_CUSTOM_PBUF |
| donatien | 5:dd63a1e02b1b | 124 | struct pbuf *pbuf_alloced_custom(pbuf_layer l, u16_t length, pbuf_type type, |
| donatien | 5:dd63a1e02b1b | 125 | struct pbuf_custom *p, void *payload_mem, |
| donatien | 5:dd63a1e02b1b | 126 | u16_t payload_mem_len); |
| donatien | 5:dd63a1e02b1b | 127 | #endif /* LWIP_SUPPORT_CUSTOM_PBUF */ |
| donatien | 0:632c9925f013 | 128 | void pbuf_realloc(struct pbuf *p, u16_t size); |
| donatien | 0:632c9925f013 | 129 | u8_t pbuf_header(struct pbuf *p, s16_t header_size); |
| donatien | 0:632c9925f013 | 130 | void pbuf_ref(struct pbuf *p); |
| donatien | 0:632c9925f013 | 131 | u8_t pbuf_free(struct pbuf *p); |
| donatien | 0:632c9925f013 | 132 | u8_t pbuf_clen(struct pbuf *p); |
| donatien | 0:632c9925f013 | 133 | void pbuf_cat(struct pbuf *head, struct pbuf *tail); |
| donatien | 0:632c9925f013 | 134 | void pbuf_chain(struct pbuf *head, struct pbuf *tail); |
| donatien | 0:632c9925f013 | 135 | struct pbuf *pbuf_dechain(struct pbuf *p); |
| donatien | 0:632c9925f013 | 136 | err_t pbuf_copy(struct pbuf *p_to, struct pbuf *p_from); |
| donatien | 0:632c9925f013 | 137 | u16_t pbuf_copy_partial(struct pbuf *p, void *dataptr, u16_t len, u16_t offset); |
| donatien | 0:632c9925f013 | 138 | err_t pbuf_take(struct pbuf *buf, const void *dataptr, u16_t len); |
| donatien | 0:632c9925f013 | 139 | struct pbuf *pbuf_coalesce(struct pbuf *p, pbuf_layer layer); |
| donatien | 5:dd63a1e02b1b | 140 | #if LWIP_CHECKSUM_ON_COPY |
| donatien | 5:dd63a1e02b1b | 141 | err_t pbuf_fill_chksum(struct pbuf *p, u16_t start_offset, const void *dataptr, |
| donatien | 5:dd63a1e02b1b | 142 | u16_t len, u16_t *chksum); |
| donatien | 5:dd63a1e02b1b | 143 | #endif /* LWIP_CHECKSUM_ON_COPY */ |
| donatien | 5:dd63a1e02b1b | 144 | |
| donatien | 5:dd63a1e02b1b | 145 | u8_t pbuf_get_at(struct pbuf* p, u16_t offset); |
| donatien | 5:dd63a1e02b1b | 146 | u16_t pbuf_memcmp(struct pbuf* p, u16_t offset, const void* s2, u16_t n); |
| donatien | 5:dd63a1e02b1b | 147 | u16_t pbuf_memfind(struct pbuf* p, const void* mem, u16_t mem_len, u16_t start_offset); |
| donatien | 5:dd63a1e02b1b | 148 | u16_t pbuf_strstr(struct pbuf* p, const char* substr); |
| donatien | 0:632c9925f013 | 149 | |
| donatien | 0:632c9925f013 | 150 | #ifdef __cplusplus |
| donatien | 0:632c9925f013 | 151 | } |
| donatien | 0:632c9925f013 | 152 | #endif |
| donatien | 0:632c9925f013 | 153 | |
| donatien | 0:632c9925f013 | 154 | #endif /* __LWIP_PBUF_H__ */ |