summaryrefslogtreecommitdiffhomepage
path: root/device.h
blob: 9e7d309c15f534e3a5beec2ab0af9c7dab0b66e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
#ifndef __LL_H
#define __LL_H

#include <libubox/avl.h>

struct device;
struct device_hotplug_ops;

typedef int (*device_state_cb)(struct device *, bool up);

struct device_type {
	const char *name;

	int (*check_state)(struct device *);
	void (*free)(struct device *);
};

/* 
 * link layer device. typically represents a linux network device.
 * can be used to support VLANs as well
 */
struct device {
	const struct device_type *type;

	struct avl_node avl;
	struct list_head users;

	char ifname[IFNAMSIZ + 1];
	int ifindex;

	bool present;
	int active;

	/* set interface up or down */
	device_state_cb set_state;

	const struct device_hotplug_ops *hotplug_ops;
};

/* events broadcasted to all users of a device */
enum device_event {
	/* device has been added to the system and can be brought up */
	DEV_EVENT_ADD,

	/* device has been removed */
	DEV_EVENT_REMOVE,

	/* device is being brought up */
	DEV_EVENT_SETUP,

	/* device is being brought down */
	DEV_EVENT_TEARDOWN,

	/* device has been brought up */
	DEV_EVENT_UP,

	/* device has been brought down */
	DEV_EVENT_DOWN,

	/* device has changed its link state to up */
	DEV_EVENT_LINK_UP,

	/* device has changed its link state to down */
	DEV_EVENT_LINK_DOWN,
};

/*
 * device dependency with callbacks
 */
struct device_user {
	struct list_head list;

	struct device *dev;
	void (*cb)(struct device_user *, enum device_event);
};

struct device_hotplug_ops {
	int (*add)(struct device *main, struct device *member);
	int (*del)(struct device *main, struct device *member);
};

int init_device(struct device *iface, const struct device_type *type, const char *ifname);
void cleanup_device(struct device *iface);
struct device *get_device(const char *name, bool create);
void add_device_user(struct device_user *dep, struct device *iface);
void remove_device_user(struct device_user *dep);

void set_device_present(struct device *dev, bool state);
int claim_device(struct device *dev);
void release_device(struct device *dev);
int check_device_state(struct device *dev);

struct device *get_vlan_device_chain(const char *ifname, bool create);

#endif