Adam Green / Mbed 2 deprecated WeatherStation

Web server based weather station using Sparkfun Weather Meters.

Dependencies:   FatFileSystem mbed WeatherMeters SDFileSystem

NetStack/lwip/include/lwip/pbuf.h@0:616601bde9fb, 2012-02-23 (annotated)

Committer:
AdamGreen
Date:
Thu Feb 23 21:38:39 2012 +0000
Revision:
0:616601bde9fb

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


AdamGreen

0:616601bde9fb


     1

/*





AdamGreen

0:616601bde9fb


     2

 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.





AdamGreen

0:616601bde9fb


     3

 * All rights reserved. 





AdamGreen

0:616601bde9fb


     4

 * 





AdamGreen

0:616601bde9fb


     5

 * Redistribution and use in source and binary forms, with or without modification, 





AdamGreen

0:616601bde9fb


     6

 * are permitted provided that the following conditions are met:





AdamGreen

0:616601bde9fb


     7

 *





AdamGreen

0:616601bde9fb


     8

 * 1. Redistributions of source code must retain the above copyright notice,





AdamGreen

0:616601bde9fb


     9

 *    this list of conditions and the following disclaimer.





AdamGreen

0:616601bde9fb


    10

 * 2. Redistributions in binary form must reproduce the above copyright notice,





AdamGreen

0:616601bde9fb


    11

 *    this list of conditions and the following disclaimer in the documentation





AdamGreen

0:616601bde9fb


    12

 *    and/or other materials provided with the distribution.





AdamGreen

0:616601bde9fb


    13

 * 3. The name of the author may not be used to endorse or promote products





AdamGreen

0:616601bde9fb


    14

 *    derived from this software without specific prior written permission. 





AdamGreen

0:616601bde9fb


    15

 *





AdamGreen

0:616601bde9fb


    16

 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 





AdamGreen

0:616601bde9fb


    17

 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 





AdamGreen

0:616601bde9fb


    18

 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 





AdamGreen

0:616601bde9fb


    19

 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 





AdamGreen

0:616601bde9fb


    20

 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 





AdamGreen

0:616601bde9fb


    21

 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 





AdamGreen

0:616601bde9fb


    22

 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 





AdamGreen

0:616601bde9fb


    23

 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 





AdamGreen

0:616601bde9fb


    24

 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 





AdamGreen

0:616601bde9fb


    25

 * OF SUCH DAMAGE.





AdamGreen

0:616601bde9fb


    26

 *





AdamGreen

0:616601bde9fb


    27

 * This file is part of the lwIP TCP/IP stack.





AdamGreen

0:616601bde9fb


    28

 * 





AdamGreen

0:616601bde9fb


    29

 * Author: Adam Dunkels <adam@sics.se>





AdamGreen

0:616601bde9fb


    30

 *





AdamGreen

0:616601bde9fb


    31

 */





AdamGreen

0:616601bde9fb


    32







AdamGreen

0:616601bde9fb


    33

#ifndef __LWIP_PBUF_H__





AdamGreen

0:616601bde9fb


    34

#define __LWIP_PBUF_H__





AdamGreen

0:616601bde9fb


    35







AdamGreen

0:616601bde9fb


    36

#include "lwip/opt.h"





AdamGreen

0:616601bde9fb


    37

#include "lwip/err.h"





AdamGreen

0:616601bde9fb


    38







AdamGreen

0:616601bde9fb


    39

#ifdef __cplusplus





AdamGreen

0:616601bde9fb


    40

extern "C" {





AdamGreen

0:616601bde9fb


    41

#endif





AdamGreen

0:616601bde9fb


    42







AdamGreen

0:616601bde9fb


    43

/* Currently, the pbuf_custom code is only needed for one specific configuration





AdamGreen

0:616601bde9fb


    44

 * of IP_FRAG */





AdamGreen

0:616601bde9fb


    45

#define LWIP_SUPPORT_CUSTOM_PBUF (IP_FRAG && !IP_FRAG_USES_STATIC_BUF && !LWIP_NETIF_TX_SINGLE_PBUF)





AdamGreen

0:616601bde9fb


    46







AdamGreen

0:616601bde9fb


    47

#define PBUF_TRANSPORT_HLEN 20





AdamGreen

0:616601bde9fb


    48

#define PBUF_IP_HLEN        20





AdamGreen

0:616601bde9fb


    49







AdamGreen

0:616601bde9fb


    50

typedef enum {





AdamGreen

0:616601bde9fb


    51

  PBUF_TRANSPORT,





AdamGreen

0:616601bde9fb


    52

  PBUF_IP,





AdamGreen

0:616601bde9fb


    53

  PBUF_LINK,





AdamGreen

0:616601bde9fb


    54

  PBUF_RAW





AdamGreen

0:616601bde9fb


    55

} pbuf_layer;





AdamGreen

0:616601bde9fb


    56







AdamGreen

0:616601bde9fb


    57

typedef enum {





AdamGreen

0:616601bde9fb


    58

  PBUF_RAM, /* pbuf data is stored in RAM */





AdamGreen

0:616601bde9fb


    59

  PBUF_ROM, /* pbuf data is stored in ROM */





AdamGreen

0:616601bde9fb


    60

  PBUF_REF, /* pbuf comes from the pbuf pool */





AdamGreen

0:616601bde9fb


    61

  PBUF_POOL /* pbuf payload refers to RAM */





AdamGreen

0:616601bde9fb


    62

} pbuf_type;





AdamGreen

0:616601bde9fb


    63







AdamGreen

0:616601bde9fb


    64







AdamGreen

0:616601bde9fb


    65

/* indicates this packet's data should be immediately passed to the application */





AdamGreen

0:616601bde9fb


    66

#define PBUF_FLAG_PUSH      0x01U





AdamGreen

0:616601bde9fb


    67

/* indicates this is a custom pbuf: pbuf_free and pbuf_header handle such a





AdamGreen

0:616601bde9fb


    68

    a pbuf differently */





AdamGreen

0:616601bde9fb


    69

#define PBUF_FLAG_IS_CUSTOM 0x02U





AdamGreen

0:616601bde9fb


    70

/* indicates this pbuf is UDP multicast to be looped back */





AdamGreen

0:616601bde9fb


    71

#define PBUF_FLAG_MCASTLOOP 0x04U





AdamGreen

0:616601bde9fb


    72







AdamGreen

0:616601bde9fb


    73

struct pbuf {





AdamGreen

0:616601bde9fb


    74

  /* next pbuf in singly linked pbuf chain */





AdamGreen

0:616601bde9fb


    75

  struct pbuf *next;





AdamGreen

0:616601bde9fb


    76







AdamGreen

0:616601bde9fb


    77

  /* pointer to the actual data in the buffer */





AdamGreen

0:616601bde9fb


    78

  void *payload;





AdamGreen

0:616601bde9fb


    79







AdamGreen

0:616601bde9fb


    80

  /**





AdamGreen

0:616601bde9fb


    81

   * total length of this buffer and all next buffers in chain





AdamGreen

0:616601bde9fb


    82

   * belonging to the same packet.





AdamGreen

0:616601bde9fb


    83

   *





AdamGreen

0:616601bde9fb


    84

   * For non-queue packet chains this is the invariant:





AdamGreen

0:616601bde9fb


    85

   * p->tot_len == p->len + (p->next? p->next->tot_len: 0)





AdamGreen

0:616601bde9fb


    86

   */





AdamGreen

0:616601bde9fb


    87

  u16_t tot_len;





AdamGreen

0:616601bde9fb


    88







AdamGreen

0:616601bde9fb


    89

  /* length of this buffer */





AdamGreen

0:616601bde9fb


    90

  u16_t len;





AdamGreen

0:616601bde9fb


    91







AdamGreen

0:616601bde9fb


    92

  /* pbuf_type as u8_t instead of enum to save space */





AdamGreen

0:616601bde9fb


    93

  u8_t /*pbuf_type*/ type;





AdamGreen

0:616601bde9fb


    94







AdamGreen

0:616601bde9fb


    95

  /* misc flags */





AdamGreen

0:616601bde9fb


    96

  u8_t flags;





AdamGreen

0:616601bde9fb


    97







AdamGreen

0:616601bde9fb


    98

  /**





AdamGreen

0:616601bde9fb


    99

   * the reference count always equals the number of pointers





AdamGreen

0:616601bde9fb


   100

   * that refer to this pbuf. This can be pointers from an application,





AdamGreen

0:616601bde9fb


   101

   * the stack itself, or pbuf->next pointers from a chain.





AdamGreen

0:616601bde9fb


   102

   */





AdamGreen

0:616601bde9fb


   103

  u16_t ref;





AdamGreen

0:616601bde9fb


   104

};





AdamGreen

0:616601bde9fb


   105







AdamGreen

0:616601bde9fb


   106

#if LWIP_SUPPORT_CUSTOM_PBUF





AdamGreen

0:616601bde9fb


   107

/* Prototype for a function to free a custom pbuf */





AdamGreen

0:616601bde9fb


   108

typedef void (*pbuf_free_custom_fn)(struct pbuf *p);





AdamGreen

0:616601bde9fb


   109







AdamGreen

0:616601bde9fb


   110

/* A custom pbuf: like a pbuf, but following a function pointer to free it. */





AdamGreen

0:616601bde9fb


   111

struct pbuf_custom {





AdamGreen

0:616601bde9fb


   112

  /* The actual pbuf */





AdamGreen

0:616601bde9fb


   113

  struct pbuf pbuf;





AdamGreen

0:616601bde9fb


   114

  /* This function is called when pbuf_free deallocates this pbuf(_custom) */





AdamGreen

0:616601bde9fb


   115

  pbuf_free_custom_fn custom_free_function;





AdamGreen

0:616601bde9fb


   116

};





AdamGreen

0:616601bde9fb


   117

#endif /* LWIP_SUPPORT_CUSTOM_PBUF */





AdamGreen

0:616601bde9fb


   118







AdamGreen

0:616601bde9fb


   119

/* Initializes the pbuf module. This call is empty for now, but may not be in future. */





AdamGreen

0:616601bde9fb


   120

#define pbuf_init()





AdamGreen

0:616601bde9fb


   121







AdamGreen

0:616601bde9fb


   122

struct pbuf *pbuf_alloc(pbuf_layer l, u16_t length, pbuf_type type);





AdamGreen

0:616601bde9fb


   123

#if LWIP_SUPPORT_CUSTOM_PBUF





AdamGreen

0:616601bde9fb


   124

struct pbuf *pbuf_alloced_custom(pbuf_layer l, u16_t length, pbuf_type type,





AdamGreen

0:616601bde9fb


   125

                                 struct pbuf_custom *p, void *payload_mem,





AdamGreen

0:616601bde9fb


   126

                                 u16_t payload_mem_len);





AdamGreen

0:616601bde9fb


   127

#endif /* LWIP_SUPPORT_CUSTOM_PBUF */





AdamGreen

0:616601bde9fb


   128

void pbuf_realloc(struct pbuf *p, u16_t size); 





AdamGreen

0:616601bde9fb


   129

u8_t pbuf_header(struct pbuf *p, s16_t header_size);





AdamGreen

0:616601bde9fb


   130

void pbuf_ref(struct pbuf *p);





AdamGreen

0:616601bde9fb


   131

u8_t pbuf_free(struct pbuf *p);





AdamGreen

0:616601bde9fb


   132

u8_t pbuf_clen(struct pbuf *p);  





AdamGreen

0:616601bde9fb


   133

void pbuf_cat(struct pbuf *head, struct pbuf *tail);





AdamGreen

0:616601bde9fb


   134

void pbuf_chain(struct pbuf *head, struct pbuf *tail);





AdamGreen

0:616601bde9fb


   135

struct pbuf *pbuf_dechain(struct pbuf *p);





AdamGreen

0:616601bde9fb


   136

err_t pbuf_copy(struct pbuf *p_to, struct pbuf *p_from);





AdamGreen

0:616601bde9fb


   137

u16_t pbuf_copy_partial(struct pbuf *p, void *dataptr, u16_t len, u16_t offset);





AdamGreen

0:616601bde9fb


   138

err_t pbuf_take(struct pbuf *buf, const void *dataptr, u16_t len);





AdamGreen

0:616601bde9fb


   139

struct pbuf *pbuf_coalesce(struct pbuf *p, pbuf_layer layer);





AdamGreen

0:616601bde9fb


   140

#if LWIP_CHECKSUM_ON_COPY





AdamGreen

0:616601bde9fb


   141

err_t pbuf_fill_chksum(struct pbuf *p, u16_t start_offset, const void *dataptr,





AdamGreen

0:616601bde9fb


   142

                       u16_t len, u16_t *chksum);





AdamGreen

0:616601bde9fb


   143

#endif /* LWIP_CHECKSUM_ON_COPY */





AdamGreen

0:616601bde9fb


   144







AdamGreen

0:616601bde9fb


   145

u8_t pbuf_get_at(struct pbuf* p, u16_t offset);





AdamGreen

0:616601bde9fb


   146

u16_t pbuf_memcmp(struct pbuf* p, u16_t offset, const void* s2, u16_t n);





AdamGreen

0:616601bde9fb


   147

u16_t pbuf_memfind(struct pbuf* p, const void* mem, u16_t mem_len, u16_t start_offset);





AdamGreen

0:616601bde9fb


   148

u16_t pbuf_strstr(struct pbuf* p, const char* substr);





AdamGreen

0:616601bde9fb


   149







AdamGreen

0:616601bde9fb


   150

#ifdef __cplusplus





AdamGreen

0:616601bde9fb


   151

}





AdamGreen

0:616601bde9fb


   152

#endif





AdamGreen

0:616601bde9fb


   153







AdamGreen

0:616601bde9fb


   154

#endif /* __LWIP_PBUF_H__ */