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