xref: /nrf52832-nimble/rt-thread/components/net/lwip-1.4.1/src/include/lwip/raw.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /*
2*10465441SEvalZero  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
3*10465441SEvalZero  * All rights reserved.
4*10465441SEvalZero  *
5*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without modification,
6*10465441SEvalZero  * are permitted provided that the following conditions are met:
7*10465441SEvalZero  *
8*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright notice,
9*10465441SEvalZero  *    this list of conditions and the following disclaimer.
10*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright notice,
11*10465441SEvalZero  *    this list of conditions and the following disclaimer in the documentation
12*10465441SEvalZero  *    and/or other materials provided with the distribution.
13*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote products
14*10465441SEvalZero  *    derived from this software without specific prior written permission.
15*10465441SEvalZero  *
16*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17*10465441SEvalZero  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18*10465441SEvalZero  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
19*10465441SEvalZero  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20*10465441SEvalZero  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
21*10465441SEvalZero  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22*10465441SEvalZero  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23*10465441SEvalZero  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
24*10465441SEvalZero  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
25*10465441SEvalZero  * OF SUCH DAMAGE.
26*10465441SEvalZero  *
27*10465441SEvalZero  * This file is part of the lwIP TCP/IP stack.
28*10465441SEvalZero  *
29*10465441SEvalZero  * Author: Adam Dunkels <[email protected]>
30*10465441SEvalZero  *
31*10465441SEvalZero  */
32*10465441SEvalZero #ifndef __LWIP_RAW_H__
33*10465441SEvalZero #define __LWIP_RAW_H__
34*10465441SEvalZero 
35*10465441SEvalZero #include "lwip/opt.h"
36*10465441SEvalZero 
37*10465441SEvalZero #if LWIP_RAW /* don't build if not configured for use in lwipopts.h */
38*10465441SEvalZero 
39*10465441SEvalZero #include "lwip/pbuf.h"
40*10465441SEvalZero #include "lwip/def.h"
41*10465441SEvalZero #include "lwip/ip.h"
42*10465441SEvalZero #include "lwip/ip_addr.h"
43*10465441SEvalZero 
44*10465441SEvalZero #ifdef __cplusplus
45*10465441SEvalZero extern "C" {
46*10465441SEvalZero #endif
47*10465441SEvalZero 
48*10465441SEvalZero struct raw_pcb;
49*10465441SEvalZero 
50*10465441SEvalZero /** Function prototype for raw pcb receive callback functions.
51*10465441SEvalZero  * @param arg user supplied argument (raw_pcb.recv_arg)
52*10465441SEvalZero  * @param pcb the raw_pcb which received data
53*10465441SEvalZero  * @param p the packet buffer that was received
54*10465441SEvalZero  * @param addr the remote IP address from which the packet was received
55*10465441SEvalZero  * @return 1 if the packet was 'eaten' (aka. deleted),
56*10465441SEvalZero  *         0 if the packet lives on
57*10465441SEvalZero  * If returning 1, the callback is responsible for freeing the pbuf
58*10465441SEvalZero  * if it's not used any more.
59*10465441SEvalZero  */
60*10465441SEvalZero typedef u8_t (*raw_recv_fn)(void *arg, struct raw_pcb *pcb, struct pbuf *p,
61*10465441SEvalZero     ip_addr_t *addr);
62*10465441SEvalZero 
63*10465441SEvalZero struct raw_pcb {
64*10465441SEvalZero   /* Common members of all PCB types */
65*10465441SEvalZero   IP_PCB;
66*10465441SEvalZero 
67*10465441SEvalZero   struct raw_pcb *next;
68*10465441SEvalZero 
69*10465441SEvalZero   u8_t protocol;
70*10465441SEvalZero 
71*10465441SEvalZero   /** receive callback function */
72*10465441SEvalZero   raw_recv_fn recv;
73*10465441SEvalZero   /* user-supplied argument for the recv callback */
74*10465441SEvalZero   void *recv_arg;
75*10465441SEvalZero };
76*10465441SEvalZero 
77*10465441SEvalZero /* The following functions is the application layer interface to the
78*10465441SEvalZero    RAW code. */
79*10465441SEvalZero struct raw_pcb * raw_new        (u8_t proto);
80*10465441SEvalZero void             raw_remove     (struct raw_pcb *pcb);
81*10465441SEvalZero err_t            raw_bind       (struct raw_pcb *pcb, ip_addr_t *ipaddr);
82*10465441SEvalZero err_t            raw_connect    (struct raw_pcb *pcb, ip_addr_t *ipaddr);
83*10465441SEvalZero 
84*10465441SEvalZero void             raw_recv       (struct raw_pcb *pcb, raw_recv_fn recv, void *recv_arg);
85*10465441SEvalZero err_t            raw_sendto     (struct raw_pcb *pcb, struct pbuf *p, ip_addr_t *ipaddr);
86*10465441SEvalZero err_t            raw_send       (struct raw_pcb *pcb, struct pbuf *p);
87*10465441SEvalZero 
88*10465441SEvalZero /* The following functions are the lower layer interface to RAW. */
89*10465441SEvalZero u8_t             raw_input      (struct pbuf *p, struct netif *inp);
90*10465441SEvalZero #define raw_init() /* Compatibility define, not init needed. */
91*10465441SEvalZero 
92*10465441SEvalZero #ifdef __cplusplus
93*10465441SEvalZero }
94*10465441SEvalZero #endif
95*10465441SEvalZero 
96*10465441SEvalZero #endif /* LWIP_RAW */
97*10465441SEvalZero 
98*10465441SEvalZero #endif /* __LWIP_RAW_H__ */
99