Update state machine handling for wireless networks
[connman] / include / iface.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007  Intel Corporation. All rights reserved.
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License version 2 as
9  *  published by the Free Software Foundation.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 #ifndef __CONNMAN_IFACE_H
23 #define __CONNMAN_IFACE_H
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 #include <netinet/in.h>
30
31 enum connman_iface_type {
32         CONNMAN_IFACE_TYPE_UNKNOWN   = 0,
33         CONNMAN_IFACE_TYPE_80203     = 1,
34         CONNMAN_IFACE_TYPE_80211     = 2,
35         CONNMAN_IFACE_TYPE_WIMAX     = 3,
36         CONNMAN_IFACE_TYPE_MODEM     = 4,
37         CONNMAN_IFACE_TYPE_BLUETOOTH = 5,
38 };
39
40 enum connman_iface_flags {
41         CONNMAN_IFACE_FLAG_RTNL      = (1 << 0),
42         CONNMAN_IFACE_FLAG_IPV4      = (1 << 1),
43         CONNMAN_IFACE_FLAG_IPV6      = (1 << 2),
44         CONNMAN_IFACE_FLAG_SCANNING  = (1 << 3),
45         CONNMAN_IFACE_FLAG_NOCARRIER = (1 << 4),
46
47         CONNMAN_IFACE_FLAG_STARTED   = (1 << 16),
48         CONNMAN_IFACE_FLAG_RUNNING   = (1 << 17),
49         CONNMAN_IFACE_FLAG_DHCP      = (1 << 18),
50 };
51
52 enum connman_iface_state {
53         CONNMAN_IFACE_STATE_UNKNOWN   = 0,
54         CONNMAN_IFACE_STATE_OFF       = 1,
55         CONNMAN_IFACE_STATE_ENABLED   = 2,
56         CONNMAN_IFACE_STATE_SCANNING  = 3,
57         CONNMAN_IFACE_STATE_CONNECT   = 4,
58         CONNMAN_IFACE_STATE_CONNECTED = 5,
59         CONNMAN_IFACE_STATE_CARRIER   = 6,
60         CONNMAN_IFACE_STATE_CONFIGURE = 7,
61         CONNMAN_IFACE_STATE_READY     = 8,
62         CONNMAN_IFACE_STATE_SHUTDOWN  = 9,
63 };
64
65 enum connman_iface_policy {
66         CONNMAN_IFACE_POLICY_UNKNOWN = 0,
67         CONNMAN_IFACE_POLICY_OFF     = 1,
68         CONNMAN_IFACE_POLICY_IGNORE  = 2,
69         CONNMAN_IFACE_POLICY_AUTO    = 3,
70         CONNMAN_IFACE_POLICY_ASK     = 4,
71 };
72
73 enum connman_ipv4_method {
74         CONNMAN_IPV4_METHOD_UNKNOWN = 0,
75         CONNMAN_IPV4_METHOD_OFF     = 1,
76         CONNMAN_IPV4_METHOD_STATIC  = 2,
77         CONNMAN_IPV4_METHOD_DHCP    = 3,
78 };
79
80 struct connman_ipv4 {
81         enum connman_ipv4_method method;
82         struct in_addr address;
83         struct in_addr netmask;
84         struct in_addr gateway;
85         struct in_addr network;
86         struct in_addr broadcast;
87         struct in_addr nameserver;
88 };
89
90 struct connman_network {
91         char *identifier;
92         char *passphrase;
93 };
94
95 struct connman_iface {
96         char *path;
97         char *udi;
98         char *sysfs;
99         char *identifier;
100         int index;
101         enum connman_iface_type type;
102         unsigned long flags;
103         enum connman_iface_state state;
104         enum connman_iface_policy policy;
105         struct connman_network network;
106         struct connman_ipv4 ipv4;
107
108         struct connman_iface_driver *driver;
109         void *driver_data;
110
111         void *rtnl_data;
112
113         struct {
114                 char *driver;
115                 char *vendor;
116                 char *product;
117         } device;
118 };
119
120 struct connman_iface_driver {
121         const char *name;
122         const char *capability;
123
124         int (*probe) (struct connman_iface *iface);
125         void (*remove) (struct connman_iface *iface);
126
127         int (*start) (struct connman_iface *iface);
128         int (*stop) (struct connman_iface *iface);
129
130         int (*scan) (struct connman_iface *iface);
131         int (*connect) (struct connman_iface *iface,
132                                         struct connman_network *network);
133         int (*disconnect) (struct connman_iface *iface);
134
135         void (*rtnl_carrier) (struct connman_iface *iface, int carrier);
136         void (*rtnl_wireless) (struct connman_iface *iface,
137                                         void *data, unsigned short len);
138 };
139
140 extern int connman_iface_register(struct connman_iface_driver *driver);
141 extern void connman_iface_unregister(struct connman_iface_driver *driver);
142
143 static inline void *connman_iface_get_data(struct connman_iface *iface)
144 {
145         return iface->driver_data;
146 }
147
148 static inline void connman_iface_set_data(struct connman_iface *iface,
149                                                                 void *data)
150 {
151         iface->driver_data = data;
152 }
153
154 extern void connman_iface_indicate_ifup(struct connman_iface *iface);
155 extern void connman_iface_indicate_ifdown(struct connman_iface *iface);
156 extern void connman_iface_indicate_connected(struct connman_iface *iface);
157 extern void connman_iface_indicate_carrier_on(struct connman_iface *iface);
158 extern void connman_iface_indicate_carrier_off(struct connman_iface *iface);
159 extern void connman_iface_indicate_configured(struct connman_iface *iface);
160
161 extern void connman_iface_indicate_station(struct connman_iface *iface,
162                                 const char *name, int strength, int security);
163
164 extern int connman_iface_get_ipv4(struct connman_iface *iface,
165                                                 struct connman_ipv4 *ipv4);
166 extern int connman_iface_set_ipv4(struct connman_iface *iface,
167                                                 struct connman_ipv4 *ipv4);
168 extern int connman_iface_clear_ipv4(struct connman_iface *iface);
169
170 #ifdef __cplusplus
171 }
172 #endif
173
174 #endif /* __CONNMAN_IFACE_H */