8d610c93bc4a99168c07c303fa732b56d5391db3
[project/netifd.git] / device.h
1 #ifndef __LL_H
2 #define __LL_H
3
4 #include <libubox/avl.h>
5 #include <netinet/in.h>
6
7 struct device;
8 struct device_hotplug_ops;
9
10 typedef int (*device_state_cb)(struct device *, bool up);
11
12 enum {
13         DEV_ATTR_TYPE,
14         DEV_ATTR_IFNAME,
15         DEV_ATTR_MTU,
16         DEV_ATTR_MACADDR,
17         DEV_ATTR_TXQUEUELEN,
18         __DEV_ATTR_MAX,
19 };
20
21 enum dev_change_type {
22         DEV_CONFIG_NO_CHANGE,
23         DEV_CONFIG_APPLIED,
24         DEV_CONFIG_RECREATE,
25 };
26
27 struct device_type {
28         struct list_head list;
29         const char *name;
30
31         const struct config_param_list *config_params;
32
33         struct device *(*create)(const char *name, struct blob_attr *attr);
34         void (*config_init)(struct device *);
35         enum dev_change_type (*reload)(struct device *, struct blob_attr *);
36         void (*dump_info)(struct device *, struct blob_buf *buf);
37         void (*dump_stats)(struct device *, struct blob_buf *buf);
38         int (*check_state)(struct device *);
39         void (*free)(struct device *);
40 };
41
42 enum {
43         DEV_OPT_MTU             = (1 << 0),
44         DEV_OPT_MACADDR         = (1 << 1),
45         DEV_OPT_TXQUEUELEN      = (1 << 2)
46 };
47
48 /* 
49  * link layer device. typically represents a linux network device.
50  * can be used to support VLANs as well
51  */
52 struct device {
53         const struct device_type *type;
54
55         struct avl_node avl;
56         struct list_head users;
57
58         char ifname[IFNAMSIZ + 1];
59         int ifindex;
60
61         struct blob_attr *config;
62         bool config_pending;
63         bool present;
64         int active;
65
66         bool current_config;
67         bool default_config;
68
69         /* set interface up or down */
70         device_state_cb set_state;
71
72         const struct device_hotplug_ops *hotplug_ops;
73
74         /* settings */
75         unsigned int flags;
76
77         unsigned int mtu;
78         unsigned int txqueuelen;
79         uint8_t macaddr[6];
80 };
81
82 /* events broadcasted to all users of a device */
83 enum device_event {
84         DEV_EVENT_ADD,
85         DEV_EVENT_REMOVE,
86
87         DEV_EVENT_SETUP,
88         DEV_EVENT_TEARDOWN,
89         DEV_EVENT_UP,
90         DEV_EVENT_DOWN,
91
92         DEV_EVENT_LINK_UP,
93         DEV_EVENT_LINK_DOWN,
94 };
95
96 /*
97  * device dependency with callbacks
98  */
99 struct device_user {
100         struct list_head list;
101
102         bool claimed;
103         struct device *dev;
104         void (*cb)(struct device_user *, enum device_event);
105 };
106
107 struct device_hotplug_ops {
108         int (*add)(struct device *main, struct device *member);
109         int (*del)(struct device *main, struct device *member);
110 };
111
112 extern const struct config_param_list device_attr_list;
113 extern const struct device_type simple_device_type;
114 extern const struct device_type bridge_device_type;
115
116 struct device *device_create(const char *name, const struct device_type *type,
117                              struct blob_attr *config);
118 void device_init_settings(struct device *dev, struct blob_attr **tb);
119 void device_init_pending(void);
120
121 void device_reset_config(void);
122 void device_reset_old(void);
123
124 void device_init_virtual(struct device *dev, const struct device_type *type, const char *name);
125 int device_init(struct device *iface, const struct device_type *type, const char *ifname);
126 void device_cleanup(struct device *iface);
127 struct device *device_get(const char *name, bool create);
128 void device_add_user(struct device_user *dep, struct device *iface);
129 void device_remove_user(struct device_user *dep);
130
131 void device_set_present(struct device *dev, bool state);
132 int device_claim(struct device_user *dep);
133 void device_release(struct device_user *dep);
134 int device_check_state(struct device *dev);
135 void device_dump_status(struct blob_buf *b, struct device *dev);
136
137 static inline void
138 device_free(struct device *dev)
139 {
140         dev->type->free(dev);
141 }
142
143 void device_free_unused(struct device *dev);
144
145 struct device *get_vlan_device_chain(const char *ifname, bool create);
146
147 #endif