1 /**
2  * @file
3  * netif API (to be used from non-TCPIP threads)
4  */
5 
6 /*
7  * Redistribution and use in source and binary forms, with or without modification,
8  * are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice,
11  *    this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  *    this list of conditions and the following disclaimer in the documentation
14  *    and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
19  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
21  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
23  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
27  * OF SUCH DAMAGE.
28  *
29  * This file is part of the lwIP TCP/IP stack.
30  *
31  */
32 #ifndef LWIP_HDR_NETIFAPI_H
33 #define LWIP_HDR_NETIFAPI_H
34 
35 #include "lwip/opt.h"
36 
37 #if LWIP_NETIF_API /* don't build if not configured for use in lwipopts.h */
38 
39 #include "lwip/sys.h"
40 #include "lwip/netif.h"
41 #include "lwip/dhcp.h"
42 #include "lwip/autoip.h"
43 #include "lwip/priv/tcpip_priv.h"
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 #if LWIP_MPU_COMPATIBLE
50 #define NETIFAPI_IPADDR_DEF(type, m)  type m
51 #else /* LWIP_MPU_COMPATIBLE */
52 #define NETIFAPI_IPADDR_DEF(type, m)  const type * m
53 #endif /* LWIP_MPU_COMPATIBLE */
54 
55 typedef void (*netifapi_void_fn)(struct netif *netif);
56 typedef err_t (*netifapi_errt_fn)(struct netif *netif);
57 
58 struct netifapi_msg {
59   struct tcpip_api_call_data call;
60   struct netif *netif;
61   union {
62     struct {
63 #if LWIP_IPV4
64       NETIFAPI_IPADDR_DEF(ip4_addr_t, ipaddr);
65       NETIFAPI_IPADDR_DEF(ip4_addr_t, netmask);
66       NETIFAPI_IPADDR_DEF(ip4_addr_t, gw);
67 #endif /* LWIP_IPV4 */
68       void *state;
69       netif_init_fn init;
70       netif_input_fn input;
71     } add;
72     struct {
73       netifapi_void_fn voidfunc;
74       netifapi_errt_fn errtfunc;
75     } common;
76     struct {
77 #if LWIP_MPU_COMPATIBLE
78       char name[NETIF_NAMESIZE];
79 #else /* LWIP_MPU_COMPATIBLE */
80       char *name;
81 #endif /* LWIP_MPU_COMPATIBLE */
82       u8_t index;
83     } ifs;
84   } msg;
85 };
86 
87 
88 /* API for application */
89 err_t netifapi_netif_add(struct netif *netif,
90 #if LWIP_IPV4
91                          const ip4_addr_t *ipaddr, const ip4_addr_t *netmask, const ip4_addr_t *gw,
92 #endif /* LWIP_IPV4 */
93                          void *state, netif_init_fn init, netif_input_fn input);
94 
95 #if LWIP_IPV4
96 err_t netifapi_netif_set_addr(struct netif *netif, const ip4_addr_t *ipaddr,
97                               const ip4_addr_t *netmask, const ip4_addr_t *gw);
98 #endif /* LWIP_IPV4*/
99 
100 err_t netifapi_netif_common(struct netif *netif, netifapi_void_fn voidfunc,
101                             netifapi_errt_fn errtfunc);
102 
103 /** @ingroup netifapi_netif */
104 err_t netifapi_netif_name_to_index(const char *name, u8_t *index);
105 /** @ingroup netifapi_netif */
106 err_t netifapi_netif_index_to_name(u8_t index, char *name);
107 
108 /** @ingroup netifapi_netif */
109 #define netifapi_netif_remove(n)        netifapi_netif_common(n, netif_remove, NULL)
110 /** @ingroup netifapi_netif */
111 #define netifapi_netif_set_up(n)        netifapi_netif_common(n, netif_set_up, NULL)
112 /** @ingroup netifapi_netif */
113 #define netifapi_netif_set_down(n)      netifapi_netif_common(n, netif_set_down, NULL)
114 /** @ingroup netifapi_netif */
115 #define netifapi_netif_set_default(n)   netifapi_netif_common(n, netif_set_default, NULL)
116 /** @ingroup netifapi_netif */
117 #define netifapi_netif_set_link_up(n)   netifapi_netif_common(n, netif_set_link_up, NULL)
118 /** @ingroup netifapi_netif */
119 #define netifapi_netif_set_link_down(n) netifapi_netif_common(n, netif_set_link_down, NULL)
120 
121 /**
122  * @defgroup netifapi_dhcp4 DHCPv4
123  * @ingroup netifapi
124  * To be called from non-TCPIP threads
125  */
126 /** @ingroup netifapi_dhcp4 */
127 #define netifapi_dhcp_start(n)        netifapi_netif_common(n, NULL, dhcp_start)
128 /** @ingroup netifapi_dhcp4 */
129 #define netifapi_dhcp_stop(n)         netifapi_netif_common(n, dhcp_stop, NULL)
130 /** @ingroup netifapi_dhcp4 */
131 #define netifapi_dhcp_inform(n)       netifapi_netif_common(n, dhcp_inform, NULL)
132 /** @ingroup netifapi_dhcp4 */
133 #define netifapi_dhcp_renew(n)        netifapi_netif_common(n, NULL, dhcp_renew)
134 /** @ingroup netifapi_dhcp4 */
135 #define netifapi_dhcp_release(n)      netifapi_netif_common(n, NULL, dhcp_release)
136 
137 /**
138  * @defgroup netifapi_autoip AUTOIP
139  * @ingroup netifapi
140  * To be called from non-TCPIP threads
141  */
142 /** @ingroup netifapi_autoip */
143 #define netifapi_autoip_start(n)      netifapi_netif_common(n, NULL, autoip_start)
144 /** @ingroup netifapi_autoip */
145 #define netifapi_autoip_stop(n)       netifapi_netif_common(n, NULL, autoip_stop)
146 
147 #ifdef __cplusplus
148 }
149 #endif
150 
151 #endif /* LWIP_NETIF_API */
152 
153 #endif /* LWIP_HDR_NETIFAPI_H */
154