git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP_130/src/include/lwip/netbuf.h

   1 /*\r
   2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.\r
   3  * All rights reserved.\r
   4  *\r
   5  * Redistribution and use in source and binary forms, with or without modification,\r
   6  * are permitted provided that the following conditions are met:\r
   7  *\r
   8  * 1. Redistributions of source code must retain the above copyright notice,\r
   9  *    this list of conditions and the following disclaimer.\r
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  11  *    this list of conditions and the following disclaimer in the documentation\r
  12  *    and/or other materials provided with the distribution.\r
  13  * 3. The name of the author may not be used to endorse or promote products\r
  14  *    derived from this software without specific prior written permission.\r
  15  *\r
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED\r
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT\r
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\r
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT\r
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING\r
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY\r
  25  * OF SUCH DAMAGE.\r
  26  *\r
  27  * This file is part of the lwIP TCP/IP stack.\r
  28  *\r
  29  * Author: Adam Dunkels <adam@sics.se>\r
  30  *\r
  31  */\r
  32 #ifndef __LWIP_NETBUF_H__\r
  33 #define __LWIP_NETBUF_H__\r
  34 \r
  35 #include "lwip/opt.h"\r
  36 #include "lwip/pbuf.h"\r
  37 \r
  38 #ifdef __cplusplus\r
  39 extern "C" {\r
  40 #endif\r
  41 \r
  42 struct netbuf {\r
  43   struct pbuf *p, *ptr;\r
  44   struct ip_addr *addr;\r
  45   u16_t port;\r
  46 };\r
  47 \r
  48 /* Network buffer functions: */\r
  49 struct netbuf *   netbuf_new      (void);\r
  50 void              netbuf_delete   (struct netbuf *buf);\r
  51 void *            netbuf_alloc    (struct netbuf *buf, u16_t size);\r
  52 void              netbuf_free     (struct netbuf *buf);\r
  53 err_t             netbuf_ref      (struct netbuf *buf,\r
  54            const void *dataptr, u16_t size);\r
  55 void              netbuf_chain    (struct netbuf *head,\r
  56            struct netbuf *tail);\r
  57 \r
  58 u16_t             netbuf_len      (struct netbuf *buf);\r
  59 err_t             netbuf_data     (struct netbuf *buf,\r
  60            void **dataptr, u16_t *len);\r
  61 s8_t              netbuf_next     (struct netbuf *buf);\r
  62 void              netbuf_first    (struct netbuf *buf);\r
  63 \r
  64 \r
  65 #define netbuf_copy_partial(buf, dataptr, len, offset) \\r
  66   pbuf_copy_partial((buf)->p, (dataptr), (len), (offset))\r
  67 #define netbuf_copy(buf,dataptr,len) netbuf_copy_partial(buf, dataptr, len, 0)\r
  68 #define netbuf_len(buf)              ((buf)->p->tot_len)\r
  69 #define netbuf_fromaddr(buf)         ((buf)->addr)\r
  70 #define netbuf_fromport(buf)         ((buf)->port)\r
  71 \r
  72 #ifdef __cplusplus\r
  73 }\r
  74 #endif\r
  75 \r
  76 #endif /* __LWIP_NETBUF_H__ */\r