netbuf.h 4.1 KB

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