remove a few comments clarified in the design documentation
[project/netifd.git] / interface.h
1 #ifndef __NETIFD_INTERFACE_H
2 #define __NETIFD_INTERFACE_H
3
4 struct interface;
5 struct interface_proto;
6 struct interface_proto_state;
7
8 extern struct list_head interfaces;
9
10 enum interface_event {
11         IFEV_UP,
12         IFEV_DOWN,
13 };
14
15 struct interface_proto_state {
16         const struct interface_proto *proto;
17
18         int (*event)(struct interface *, struct interface_proto_state *, enum interface_event ev);
19         void (*free)(struct interface *, struct interface_proto_state *);
20 };
21
22 struct interface_error {
23         struct list_head list;
24
25         const char *subsystem;
26         const char *code;
27         const char *data[];
28 };
29
30 /*
31  * interface configuration
32  */
33 struct interface {
34         struct list_head list;
35
36         char name[IFNAMSIZ];
37
38         bool up;
39         bool active;
40         bool autostart;
41
42         /* main interface that the interface is bound to */
43         struct device_user main_dev;
44
45         /* interface that layer 3 communication will go through */
46         struct device_user *l3_iface;
47
48         /* primary protocol state */
49         struct interface_proto_state *state;
50
51         /* errors/warnings while trying to bring up the interface */
52         struct list_head errors;
53
54         struct ubus_object ubus;
55 };
56
57 struct interface *get_interface(const char *name);
58 struct interface *alloc_interface(const char *name);
59 void free_interface(struct interface *iface);
60
61 int set_interface_up(struct interface *iface);
62 int set_interface_down(struct interface *iface);
63
64 int interface_add_link(struct interface *iface, struct device *llif);
65 void interface_remove_link(struct interface *iface, struct device *llif);
66
67 void interface_add_error(struct interface *iface, const char *subsystem,
68                          const char *code, const char **data, int n_data);
69
70 int interface_attach_bridge(struct interface *iface, struct uci_section *s);
71
72 #endif