src/include/lwip/raw.h

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