raw.h 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  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_RAW_H__
  33. #define __LWIP_RAW_H__
  34. #include "lwip/opt.h"
  35. #if LWIP_RAW /* don't build if not configured for use in lwipopts.h */
  36. #include "lwip/pbuf.h"
  37. #include "lwip/def.h"
  38. #include "lwip/ip.h"
  39. #include "lwip/ip_addr.h"
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. struct raw_pcb;
  44. /** Function prototype for raw pcb receive callback functions.
  45. * @param arg user supplied argument (raw_pcb.recv_arg)
  46. * @param pcb the raw_pcb which received data
  47. * @param p the packet buffer that was received
  48. * @param addr the remote IP address from which the packet was received
  49. * @return 1 if the packet was 'eaten' (aka. deleted),
  50. * 0 if the packet lives on
  51. * If returning 1, the callback is responsible for freeing the pbuf
  52. * if it's not used any more.
  53. */
  54. typedef u8_t (*raw_recv_fn)(void *arg, struct raw_pcb *pcb, struct pbuf *p,
  55. ip_addr_t *addr);
  56. struct raw_pcb {
  57. /* Common members of all PCB types */
  58. IP_PCB;
  59. struct raw_pcb *next;
  60. u8_t protocol;
  61. /** receive callback function */
  62. raw_recv_fn recv;
  63. /* user-supplied argument for the recv callback */
  64. void *recv_arg;
  65. };
  66. /* The following functions is the application layer interface to the
  67. RAW code. */
  68. struct raw_pcb * raw_new (u8_t proto)ICACHE_FLASH_ATTR;
  69. void raw_remove (struct raw_pcb *pcb)ICACHE_FLASH_ATTR;
  70. err_t raw_bind (struct raw_pcb *pcb, ip_addr_t *ipaddr)ICACHE_FLASH_ATTR;
  71. err_t raw_connect (struct raw_pcb *pcb, ip_addr_t *ipaddr)ICACHE_FLASH_ATTR;
  72. void raw_recv (struct raw_pcb *pcb, raw_recv_fn recv, void *recv_arg)ICACHE_FLASH_ATTR;
  73. err_t raw_sendto (struct raw_pcb *pcb, struct pbuf *p, ip_addr_t *ipaddr)ICACHE_FLASH_ATTR;
  74. err_t raw_send (struct raw_pcb *pcb, struct pbuf *p);
  75. /* The following functions are the lower layer interface to RAW. */
  76. u8_t raw_input (struct pbuf *p, struct netif *inp)ICACHE_FLASH_ATTR;
  77. #define raw_init() /* Compatibility define, not init needed. */
  78. #ifdef __cplusplus
  79. }
  80. #endif
  81. #endif /* LWIP_RAW */
  82. #endif /* __LWIP_RAW_H__ */