1 /*
2  * Copyright (c) 2013 Corey Tabaka
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 #ifndef __DEV_CLASS_NETIF_H
24 #define __DEV_CLASS_NETIF_H
25 
26 #include <list.h>
27 #include <compiler.h>
28 #include <dev/driver.h>
29 
30 struct netstack_state;
31 struct pbuf;
32 
33 /* netif interface */
34 struct netif_ops {
35     struct driver_ops std;
36 
37     status_t (*set_state)(struct device *dev, struct netstack_state *state);
38     ssize_t (*get_hwaddr)(struct device *dev, void *buf, size_t max_len);
39     ssize_t (*get_mtu)(struct device *dev);
40 
41     status_t (*set_status)(struct device *dev, bool up);
42     status_t (*output)(struct device *dev, struct pbuf *p);
43     status_t (*mcast_filter)(struct device *dev, const uint8_t *mac, int action);
44 };
45 
46 __BEGIN_CDECLS
47 
48 /* netif API */
49 status_t class_netif_set_state(struct device *dev, struct netstack_state *state);
50 ssize_t class_netif_get_hwaddr(struct device *dev, void *buf, size_t max_len);
51 ssize_t class_netif_get_mtu(struct device *dev);
52 status_t class_netif_set_status(struct device *dev, bool up);
53 status_t class_netif_output(struct device *dev, struct pbuf *p);
54 status_t class_netif_mcast_filter(struct device *dev, const uint8_t *mac, int action);
55 
56 status_t class_netif_add(struct device *dev);
57 
58 /* network stack API - called by drivers */
59 status_t class_netstack_input(struct device *dev, struct netstack_state *state, struct pbuf *p);
60 
61 status_t class_netstack_wait_for_network(lk_time_t timeout);
62 
63 __END_CDECLS
64 
65 #endif
66 
67