summaryrefslogtreecommitdiff
path: root/src/nm-device.h
blob: aa623623c9735beb0bfdb3a84dec50be6ef0540d (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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
/* NetworkManager -- Network link manager
 *
 * Dan Williams <dcbw@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * (C) Copyright 2005 Red Hat, Inc.
 */

#ifndef NM_DEVICE_H
#define NM_DEVICE_H

#include <glib-object.h>
#include <dbus/dbus.h>
#include <netinet/in.h>
#include <net/ethernet.h>

#include "NetworkManager.h"
#include "nm-ip4-config.h"

#if 0
#define IOCTL_DEBUG
#endif

typedef enum NMWirelessScanInterval
{
	NM_WIRELESS_SCAN_INTERVAL_INIT = 0,
	NM_WIRELESS_SCAN_INTERVAL_ACTIVE,
	NM_WIRELESS_SCAN_INTERVAL_INACTIVE
} NMWirelessScanInterval;

typedef enum NMActStageReturn
{
	NM_ACT_STAGE_RETURN_FAILURE = 0,
	NM_ACT_STAGE_RETURN_SUCCESS,
	NM_ACT_STAGE_RETURN_POSTPONE
} NMActStageReturn;


G_BEGIN_DECLS

#define NM_TYPE_DEVICE			(nm_device_get_type ())
#define NM_DEVICE(obj)			(G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_DEVICE, NMDevice))
#define NM_DEVICE_CLASS(klass)	(G_TYPE_CHECK_CLASS_CAST ((klass),  NM_TYPE_DEVICE, NMDeviceClass))
#define NM_IS_DEVICE(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_DEVICE))
#define NM_IS_DEVICE_CLASS(klass)	(G_TYPE_CHECK_CLASS_TYPE ((klass),  NM_TYPE_DEVICE))
#define NM_DEVICE_GET_CLASS(obj)	(G_TYPE_INSTANCE_GET_CLASS ((obj),  NM_TYPE_DEVICE, NMDeviceClass))

typedef struct _NMDevice NMDevice;
typedef struct _NMDeviceClass NMDeviceClass;
typedef struct _NMDevicePrivate NMDevicePrivate;

struct _NMDevice
{
	GObject parent;

	/*< private >*/
	NMDevicePrivate *priv;
};

struct NMData;
struct NMActRequest;

struct _NMDeviceClass
{
	GObjectClass parent;

	gboolean		(* is_test_device)	(NMDevice *self);

	const char *	(* has_active_link)	(NMDevice *self);
	void			(* set_active_link)	(NMDevice *self, gboolean active);
	void			(* update_link)	(NMDevice *self);

	void			(* bring_up)		(NMDevice *self);
	void			(* bring_down)		(NMDevice *self);

	guint32		(* get_type_capabilities)	(NMDevice *self);
	guint32		(* get_generic_capabilities)	(NMDevice *self);

	void			(* init)				(NMDevice *self);
	void			(* start)				(NMDevice *self);
	NMActStageReturn	(* act_stage1_prepare)	(NMDevice *self, struct NMActRequest *req);
	NMActStageReturn	(* act_stage2_config)	(NMDevice *self, struct NMActRequest *req);
	NMActStageReturn	(* act_stage3_ip_config_start)(NMDevice *self,
											 struct NMActRequest *req);
	NMActStageReturn	(* act_stage4_get_ip4_config)	(NMDevice *self,
											 struct NMActRequest *req,
											 NMIP4Config **config);
	NMActStageReturn	(* act_stage4_ip_config_timeout)	(NMDevice *self,
												 struct NMActRequest *req,
												 NMIP4Config **config);

	void			(* deactivate)			(NMDevice *self);
	void			(* deactivate_quickly)	(NMDevice *self);

	void			(* activation_failure_handler)	(NMDevice *self,
											 struct NMActRequest *req);
	void			(* activation_success_handler)	(NMDevice *self,
											 struct NMActRequest *req);
	void			(* activation_cancel_handler)		(NMDevice *self,
											 struct NMActRequest *req);

	gboolean		(* can_interrupt_activation)		(NMDevice *self);

	void			(* notify_device_added)		(NMDevice * self, NMDevice *added_dev);
	void			(* notify_device_removed)	(NMDevice * self, NMDevice *removed_dev);

	void			(* handle_autoip_event)		(NMDevice * self, const char * event, const char * addr);

	void			(* notify_no_best_device)	(NMDevice * self);

	/* Signals */
	void (* activation_started) (NMDevice * dev);
	void (* activation_success) (NMDevice * dev);
	void (* activation_failure) (NMDevice * dev);
	void (* sig_deactivated) (NMDevice * dev);
};


GType nm_device_get_type (void);

NMDevice *	nm_device_new (const char *iface, 
						const char *udi,
						gboolean test_dev,
						NMDeviceType test_dev_type,
						struct NMData *app_data);

void		nm_device_stop (NMDevice *self);

const char *	nm_device_get_udi		(NMDevice *dev);

const char *	nm_device_get_iface		(NMDevice *dev);

const char *	nm_device_get_driver	(NMDevice *dev);

NMDeviceType	nm_device_get_device_type	(NMDevice *dev);
guint32		nm_device_get_capabilities	(NMDevice *dev);
guint32		nm_device_get_type_capabilities	(NMDevice *dev);

struct NMData *	nm_device_get_app_data	(NMDevice *dev);

gboolean		nm_device_get_removed	(NMDevice *dev);
void			nm_device_set_removed	(NMDevice *dev,
								 const gboolean removed);

gboolean		nm_device_has_active_link	(NMDevice *dev);
void			nm_device_set_active_link	(NMDevice *dev,
									 const gboolean active);

guint32			nm_device_get_ip4_address	(NMDevice *dev);
void				nm_device_update_ip4_address	(NMDevice *dev);
struct in6_addr *	nm_device_get_ip6_address	(NMDevice *dev);

gboolean		nm_device_get_use_dhcp	(NMDevice *dev);
void			nm_device_set_use_dhcp	(NMDevice *dev,
								 gboolean use_dhcp);

NMIP4Config *	nm_device_get_ip4_config	(NMDevice *dev);
void			nm_device_set_ip4_config	(NMDevice *dev,
								 NMIP4Config *config);

void			nm_device_bring_up		(NMDevice *dev);
gboolean		nm_device_bring_up_wait	(NMDevice *self,
								 gboolean cancelable);
void			nm_device_bring_down	(NMDevice *dev);
gboolean		nm_device_bring_down_wait (NMDevice *self,
								  gboolean cancelable);
gboolean		nm_device_is_up		(NMDevice *dev);

void *		nm_device_get_system_config_data	(NMDevice *dev);

struct NMActRequest *	nm_device_get_act_request	(NMDevice *dev);

void		nm_device_get_hw_address (NMDevice *dev, struct ether_addr *addr);
void		nm_device_update_hw_address (NMDevice *dev);

void		nm_device_handle_autoip_event (NMDevice *dev, const char *event, const char *addr);

/* Utility routines */
NMDevice *	nm_get_device_by_udi	(struct NMData *data,
								 const char *udi);
NMDevice *	nm_get_device_by_iface	(struct NMData *data,
								 const char *iface);
NMDevice *	nm_get_device_by_iface_locked	(struct NMData *data,
								 const char *iface);

gboolean		nm_device_is_test_device	(NMDevice *dev);

gboolean		nm_device_activation_start	(struct NMActRequest *req);
void			nm_device_activate_schedule_stage1_device_prepare		(struct NMActRequest *req);
void			nm_device_activate_schedule_stage2_device_config		(struct NMActRequest *req);
void			nm_device_activate_schedule_stage4_ip_config_get		(struct NMActRequest *req);
void			nm_device_activate_schedule_stage4_ip_config_timeout	(struct NMActRequest *req);
void			nm_device_activate_schedule_stage5_ip_config_commit		(struct NMActRequest *req);
void			nm_device_deactivate		(NMDevice *dev);
gboolean		nm_device_deactivate_quickly	(NMDevice *dev);
gboolean		nm_device_is_activating		(NMDevice *dev);
void			nm_device_activation_cancel	(NMDevice *dev);
gboolean		nm_device_activation_should_cancel (NMDevice *self);

void			nm_device_activation_failure_handler	(NMDevice *dev,
											 struct NMActRequest *req);
void			nm_device_activation_success_handler	(NMDevice *dev,
											 struct NMActRequest *req);

gboolean		nm_device_can_interrupt_activation		(NMDevice *self);

const char *	nm_device_get_physical_device_udi		(NMDevice *dev);

void			nm_device_notify_device_added (NMDevice *self, NMDevice *added_dev);
void			nm_device_notify_device_removed (NMDevice *self, NMDevice *removed_dev);

void			nm_device_notify_no_best_device (NMDevice * self);

G_END_DECLS

#endif	/* NM_DEVICE_H */