Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
lwip/include/lwip/pbuf.h@0:632c9925f013, 2010-06-11 (annotated)
- Committer:
- donatien
- Date:
- Fri Jun 11 16:05:15 2010 +0000
- Revision:
- 0:632c9925f013
- Child:
- 5:dd63a1e02b1b
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 | 0:632c9925f013 | 43 | #define PBUF_TRANSPORT_HLEN 20 |
| donatien | 0:632c9925f013 | 44 | #define PBUF_IP_HLEN 20 |
| donatien | 0:632c9925f013 | 45 | |
| donatien | 0:632c9925f013 | 46 | typedef enum { |
| donatien | 0:632c9925f013 | 47 | PBUF_TRANSPORT, |
| donatien | 0:632c9925f013 | 48 | PBUF_IP, |
| donatien | 0:632c9925f013 | 49 | PBUF_LINK, |
| donatien | 0:632c9925f013 | 50 | PBUF_RAW |
| donatien | 0:632c9925f013 | 51 | } pbuf_layer; |
| donatien | 0:632c9925f013 | 52 | |
| donatien | 0:632c9925f013 | 53 | typedef enum { |
| donatien | 0:632c9925f013 | 54 | PBUF_RAM, /* pbuf data is stored in RAM */ |
| donatien | 0:632c9925f013 | 55 | PBUF_ROM, /* pbuf data is stored in ROM */ |
| donatien | 0:632c9925f013 | 56 | PBUF_REF, /* pbuf comes from the pbuf pool */ |
| donatien | 0:632c9925f013 | 57 | PBUF_POOL /* pbuf payload refers to RAM */ |
| donatien | 0:632c9925f013 | 58 | } pbuf_type; |
| donatien | 0:632c9925f013 | 59 | |
| donatien | 0:632c9925f013 | 60 | |
| donatien | 0:632c9925f013 | 61 | /** indicates this packet's data should be immediately passed to the application */ |
| donatien | 0:632c9925f013 | 62 | #define PBUF_FLAG_PUSH 0x01U |
| donatien | 0:632c9925f013 | 63 | |
| donatien | 0:632c9925f013 | 64 | struct pbuf { |
| donatien | 0:632c9925f013 | 65 | /** next pbuf in singly linked pbuf chain */ |
| donatien | 0:632c9925f013 | 66 | struct pbuf *next; |
| donatien | 0:632c9925f013 | 67 | |
| donatien | 0:632c9925f013 | 68 | /** pointer to the actual data in the buffer */ |
| donatien | 0:632c9925f013 | 69 | void *payload; |
| donatien | 0:632c9925f013 | 70 | |
| donatien | 0:632c9925f013 | 71 | /** |
| donatien | 0:632c9925f013 | 72 | * total length of this buffer and all next buffers in chain |
| donatien | 0:632c9925f013 | 73 | * belonging to the same packet. |
| donatien | 0:632c9925f013 | 74 | * |
| donatien | 0:632c9925f013 | 75 | * For non-queue packet chains this is the invariant: |
| donatien | 0:632c9925f013 | 76 | * p->tot_len == p->len + (p->next? p->next->tot_len: 0) |
| donatien | 0:632c9925f013 | 77 | */ |
| donatien | 0:632c9925f013 | 78 | u16_t tot_len; |
| donatien | 0:632c9925f013 | 79 | |
| donatien | 0:632c9925f013 | 80 | /** length of this buffer */ |
| donatien | 0:632c9925f013 | 81 | u16_t len; |
| donatien | 0:632c9925f013 | 82 | |
| donatien | 0:632c9925f013 | 83 | /** pbuf_type as u8_t instead of enum to save space */ |
| donatien | 0:632c9925f013 | 84 | u8_t /*pbuf_type*/ type; |
| donatien | 0:632c9925f013 | 85 | |
| donatien | 0:632c9925f013 | 86 | /** misc flags */ |
| donatien | 0:632c9925f013 | 87 | u8_t flags; |
| donatien | 0:632c9925f013 | 88 | |
| donatien | 0:632c9925f013 | 89 | /** |
| donatien | 0:632c9925f013 | 90 | * the reference count always equals the number of pointers |
| donatien | 0:632c9925f013 | 91 | * that refer to this pbuf. This can be pointers from an application, |
| donatien | 0:632c9925f013 | 92 | * the stack itself, or pbuf->next pointers from a chain. |
| donatien | 0:632c9925f013 | 93 | */ |
| donatien | 0:632c9925f013 | 94 | u16_t ref; |
| donatien | 0:632c9925f013 | 95 | |
| donatien | 0:632c9925f013 | 96 | }; |
| donatien | 0:632c9925f013 | 97 | |
| donatien | 0:632c9925f013 | 98 | /* Initializes the pbuf module. This call is empty for now, but may not be in future. */ |
| donatien | 0:632c9925f013 | 99 | #define pbuf_init() |
| donatien | 0:632c9925f013 | 100 | |
| donatien | 0:632c9925f013 | 101 | struct pbuf *pbuf_alloc(pbuf_layer l, u16_t size, pbuf_type type); |
| donatien | 0:632c9925f013 | 102 | void pbuf_realloc(struct pbuf *p, u16_t size); |
| donatien | 0:632c9925f013 | 103 | u8_t pbuf_header(struct pbuf *p, s16_t header_size); |
| donatien | 0:632c9925f013 | 104 | void pbuf_ref(struct pbuf *p); |
| donatien | 0:632c9925f013 | 105 | void pbuf_ref_chain(struct pbuf *p); |
| donatien | 0:632c9925f013 | 106 | u8_t pbuf_free(struct pbuf *p); |
| donatien | 0:632c9925f013 | 107 | u8_t pbuf_clen(struct pbuf *p); |
| donatien | 0:632c9925f013 | 108 | void pbuf_cat(struct pbuf *head, struct pbuf *tail); |
| donatien | 0:632c9925f013 | 109 | void pbuf_chain(struct pbuf *head, struct pbuf *tail); |
| donatien | 0:632c9925f013 | 110 | struct pbuf *pbuf_dechain(struct pbuf *p); |
| donatien | 0:632c9925f013 | 111 | err_t pbuf_copy(struct pbuf *p_to, struct pbuf *p_from); |
| donatien | 0:632c9925f013 | 112 | u16_t pbuf_copy_partial(struct pbuf *p, void *dataptr, u16_t len, u16_t offset); |
| donatien | 0:632c9925f013 | 113 | err_t pbuf_take(struct pbuf *buf, const void *dataptr, u16_t len); |
| donatien | 0:632c9925f013 | 114 | struct pbuf *pbuf_coalesce(struct pbuf *p, pbuf_layer layer); |
| donatien | 0:632c9925f013 | 115 | |
| donatien | 0:632c9925f013 | 116 | #ifdef __cplusplus |
| donatien | 0:632c9925f013 | 117 | } |
| donatien | 0:632c9925f013 | 118 | #endif |
| donatien | 0:632c9925f013 | 119 | |
| donatien | 0:632c9925f013 | 120 | #endif /* __LWIP_PBUF_H__ */ |