• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Redistribution and use in source and binary forms, with or without modification,
3  * are permitted provided that the following conditions are met:
4  *
5  * 1. Redistributions of source code must retain the above copyright notice,
6  *    this list of conditions and the following disclaimer.
7  * 2. Redistributions in binary form must reproduce the above copyright notice,
8  *    this list of conditions and the following disclaimer in the documentation
9  *    and/or other materials provided with the distribution.
10  * 3. The name of the author may not be used to endorse or promote products
11  *    derived from this software without specific prior written permission.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
14  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
15  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
16  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
17  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
18  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
19  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
20  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
21  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
22  * OF SUCH DAMAGE.
23  *
24  * This file is part of the lwIP TCP/IP stack.
25  *
26  */
27 
28 #ifndef __LWIP_NETIFAPI_H__
29 #define __LWIP_NETIFAPI_H__
30 
31 #include "lwip/opt.h"
32 
33 #if LWIP_NETIF_API /* don't build if not configured for use in lwipopts.h */
34 
35 #include "lwip/sys.h"
36 #include "lwip/netif.h"
37 #include "lwip/dhcp.h"
38 #include "lwip/autoip.h"
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 typedef void (*netifapi_void_fn)(struct netif *netif);
45 typedef err_t (*netifapi_errt_fn)(struct netif *netif);
46 
47 struct netifapi_msg_msg {
48 #if !LWIP_TCPIP_CORE_LOCKING
49   sys_sem_t sem;
50 #endif /* !LWIP_TCPIP_CORE_LOCKING */
51   err_t err;
52   struct netif *netif;
53   union {
54     struct {
55       ip_addr_t *ipaddr;
56       ip_addr_t *netmask;
57       ip_addr_t *gw;
58       void *state;
59       netif_init_fn init;
60       netif_input_fn input;
61     } add;
62     struct {
63       netifapi_void_fn voidfunc;
64       netifapi_errt_fn errtfunc;
65     } common;
66   } msg;
67 };
68 
69 struct netifapi_msg {
70   void (* function)(struct netifapi_msg_msg *msg);
71   struct netifapi_msg_msg msg;
72 };
73 
74 
75 /* API for application */
76 err_t netifapi_netif_add       ( struct netif *netif,
77                                  ip_addr_t *ipaddr,
78                                  ip_addr_t *netmask,
79                                  ip_addr_t *gw,
80                                  void *state,
81                                  netif_init_fn init,
82                                  netif_input_fn input);
83 
84 err_t netifapi_netif_set_addr  ( struct netif *netif,
85                                  ip_addr_t *ipaddr,
86                                  ip_addr_t *netmask,
87                                  ip_addr_t *gw );
88 
89 err_t netifapi_netif_common    ( struct netif *netif,
90                                  netifapi_void_fn voidfunc,
91                                  netifapi_errt_fn errtfunc);
92 
93 #define netifapi_netif_remove(n)      netifapi_netif_common(n, netif_remove, NULL)
94 #define netifapi_netif_set_up(n)      netifapi_netif_common(n, netif_set_up, NULL)
95 #define netifapi_netif_set_down(n)    netifapi_netif_common(n, netif_set_down, NULL)
96 #define netifapi_netif_set_default(n) netifapi_netif_common(n, netif_set_default, NULL)
97 #define netifapi_dhcp_start(n)        netifapi_netif_common(n, NULL, dhcp_start)
98 #define netifapi_dhcp_stop(n)         netifapi_netif_common(n, dhcp_stop, NULL)
99 #define netifapi_autoip_start(n)      netifapi_netif_common(n, NULL, autoip_start)
100 #define netifapi_autoip_stop(n)       netifapi_netif_common(n, NULL, autoip_stop)
101 
102 #ifdef __cplusplus
103 }
104 #endif
105 
106 #endif /* LWIP_NETIF_API */
107 
108 #endif /* __LWIP_NETIFAPI_H__ */
109