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