xref: /nrf52832-nimble/rt-thread/components/net/lwip-2.1.0/src/include/netif/zepif.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /**
2*10465441SEvalZero  * @file
3*10465441SEvalZero  *
4*10465441SEvalZero  * A netif implementing the ZigBee Eencapsulation Protocol (ZEP).
5*10465441SEvalZero  * This is used to tunnel 6LowPAN over UDP.
6*10465441SEvalZero  */
7*10465441SEvalZero 
8*10465441SEvalZero /*
9*10465441SEvalZero  * Copyright (c) 2018 Simon Goldschmidt
10*10465441SEvalZero  * All rights reserved.
11*10465441SEvalZero  *
12*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without modification,
13*10465441SEvalZero  * are permitted provided that the following conditions are met:
14*10465441SEvalZero  *
15*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright notice,
16*10465441SEvalZero  *    this list of conditions and the following disclaimer.
17*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright notice,
18*10465441SEvalZero  *    this list of conditions and the following disclaimer in the documentation
19*10465441SEvalZero  *    and/or other materials provided with the distribution.
20*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote products
21*10465441SEvalZero  *    derived from this software without specific prior written permission.
22*10465441SEvalZero  *
23*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
24*10465441SEvalZero  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25*10465441SEvalZero  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
26*10465441SEvalZero  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27*10465441SEvalZero  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
28*10465441SEvalZero  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29*10465441SEvalZero  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30*10465441SEvalZero  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
31*10465441SEvalZero  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
32*10465441SEvalZero  * OF SUCH DAMAGE.
33*10465441SEvalZero  *
34*10465441SEvalZero  * This file is part of the lwIP TCP/IP stack.
35*10465441SEvalZero  *
36*10465441SEvalZero  * Author: Simon Goldschmidt <[email protected]>
37*10465441SEvalZero  *
38*10465441SEvalZero  */
39*10465441SEvalZero 
40*10465441SEvalZero #ifndef LWIP_HDR_ZEPIF_H
41*10465441SEvalZero #define LWIP_HDR_ZEPIF_H
42*10465441SEvalZero 
43*10465441SEvalZero #include "lwip/opt.h"
44*10465441SEvalZero #include "netif/lowpan6.h"
45*10465441SEvalZero 
46*10465441SEvalZero #if LWIP_IPV6 && LWIP_UDP /* don't build if not configured for use in lwipopts.h */
47*10465441SEvalZero 
48*10465441SEvalZero #include "lwip/netif.h"
49*10465441SEvalZero 
50*10465441SEvalZero #ifdef __cplusplus
51*10465441SEvalZero extern "C" {
52*10465441SEvalZero #endif
53*10465441SEvalZero 
54*10465441SEvalZero #define ZEPIF_DEFAULT_UDP_PORT  17754
55*10465441SEvalZero 
56*10465441SEvalZero /** Pass this struct as 'state' to netif_add to control the behaviour
57*10465441SEvalZero  * of this netif. If NULL is passed, default behaviour is chosen */
58*10465441SEvalZero struct zepif_init {
59*10465441SEvalZero   /** The UDP port used to ZEP frames from (0 = default) */
60*10465441SEvalZero   u16_t               zep_src_udp_port;
61*10465441SEvalZero   /** The UDP port used to ZEP frames to (0 = default) */
62*10465441SEvalZero   u16_t               zep_dst_udp_port;
63*10465441SEvalZero   /** The IP address to sed ZEP frames from (NULL = ANY) */
64*10465441SEvalZero   const ip_addr_t    *zep_src_ip_addr;
65*10465441SEvalZero   /** The IP address to sed ZEP frames to (NULL = BROADCAST) */
66*10465441SEvalZero   const ip_addr_t    *zep_dst_ip_addr;
67*10465441SEvalZero   /** If != NULL, the udp pcb is bound to this netif */
68*10465441SEvalZero   const struct netif *zep_netif;
69*10465441SEvalZero   /** MAC address of the 6LowPAN device */
70*10465441SEvalZero   u8_t                addr[6];
71*10465441SEvalZero };
72*10465441SEvalZero 
73*10465441SEvalZero err_t zepif_init(struct netif *netif);
74*10465441SEvalZero 
75*10465441SEvalZero #ifdef __cplusplus
76*10465441SEvalZero }
77*10465441SEvalZero #endif
78*10465441SEvalZero 
79*10465441SEvalZero #endif /* LWIP_IPV6 && LWIP_UDP */
80*10465441SEvalZero 
81*10465441SEvalZero #endif /* LWIP_HDR_ZEPIF_H */
82