Add intelligent Network Selection
[platform/upstream/connman.git] / include / network.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2013  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_NETWORK_H
23 #define __CONNMAN_NETWORK_H
24
25 #include <stdbool.h>
26 #include <stdint.h>
27
28 #include <dbus/dbus.h>
29
30 #include <connman/device.h>
31 #include <connman/ipconfig.h>
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 #if defined TIZEN_EXT
38 #define WIFI_ENCYPTION_MODE_LEN_MAX 6
39 #define WIFI_BSSID_LEN_MAX 6
40 #define MAC_ADDRESS_LENGTH 18
41 #endif
42
43 /**
44  * SECTION:network
45  * @title: Network premitives
46  * @short_description: Functions for handling networks
47  */
48
49 enum connman_network_type {
50         CONNMAN_NETWORK_TYPE_UNKNOWN       = 0,
51         CONNMAN_NETWORK_TYPE_ETHERNET      = 1,
52         CONNMAN_NETWORK_TYPE_WIFI          = 2,
53         CONNMAN_NETWORK_TYPE_BLUETOOTH_PAN = 8,
54         CONNMAN_NETWORK_TYPE_BLUETOOTH_DUN = 9,
55         CONNMAN_NETWORK_TYPE_CELLULAR      = 10,
56         CONNMAN_NETWORK_TYPE_GADGET        = 11,
57         CONNMAN_NETWORK_TYPE_VENDOR        = 10000,
58 };
59
60 enum connman_network_error {
61         CONNMAN_NETWORK_ERROR_UNKNOWN         = 0,
62         CONNMAN_NETWORK_ERROR_ASSOCIATE_FAIL  = 1,
63         CONNMAN_NETWORK_ERROR_CONFIGURE_FAIL  = 2,
64         CONNMAN_NETWORK_ERROR_INVALID_KEY     = 3,
65         CONNMAN_NETWORK_ERROR_CONNECT_FAIL    = 4,
66 #if defined TIZEN_EXT
67         CONNMAN_NETWORK_ERROR_DHCP_FAIL       = 5,
68         CONNMAN_NETWORK_ERROR_BLOCKED         = 6,
69 #else
70         CONNMAN_NETWORK_ERROR_BLOCKED         = 5,
71 #endif
72 };
73
74 #if defined TIZEN_EXT
75 struct connman_bssids {
76         unsigned char bssid[WIFI_BSSID_LEN_MAX];
77         uint16_t strength;
78         uint16_t frequency;
79 };
80
81 /* Backward compatible
82  * modes of available network */
83 typedef enum {
84         IEEE80211_UNKNOWN,
85         IEEE80211_MODE_B,
86         IEEE80211_MODE_BG,
87         IEEE80211_MODE_BGN,
88         IEEE80211_MODE_A,
89         IEEE80211_MODE_AN,
90         IEEE80211_MODE_ANAC,
91 } ieee80211_modes_e;
92
93 /* connection mode of connected network
94  * based on current linkspeed */
95 typedef enum {
96         CONNECTION_MODE_IEEE80211_UNKNOWN,
97         CONNECTION_MODE_IEEE80211B,
98         CONNECTION_MODE_IEEE80211G,
99         CONNECTION_MODE_IEEE80211N,
100         CONNECTION_MODE_IEEE80211A,
101         CONNECTION_MODE_IEEE80211AC,
102 } connection_mode_e;
103 #endif
104
105 #define CONNMAN_NETWORK_PRIORITY_LOW      -100
106 #define CONNMAN_NETWORK_PRIORITY_DEFAULT     0
107 #define CONNMAN_NETWORK_PRIORITY_HIGH      100
108
109 struct connman_network;
110
111 struct connman_network *connman_network_create(const char *identifier,
112                                         enum connman_network_type type);
113
114 #define connman_network_ref(network) \
115         connman_network_ref_debug(network, __FILE__, __LINE__, __func__)
116
117 #define connman_network_unref(network) \
118         connman_network_unref_debug(network, __FILE__, __LINE__, __func__)
119
120 struct connman_network *
121 connman_network_ref_debug(struct connman_network *network,
122                         const char *file, int line, const char *caller);
123 void connman_network_unref_debug(struct connman_network *network,
124                         const char *file, int line, const char *caller);
125
126 enum connman_network_type connman_network_get_type(struct connman_network *network);
127 const char *connman_network_get_identifier(struct connman_network *network);
128
129 void connman_network_set_index(struct connman_network *network, int index);
130 int connman_network_get_index(struct connman_network *network);
131
132 void connman_network_set_group(struct connman_network *network,
133                                                 const char *group);
134 const char *connman_network_get_group(struct connman_network *network);
135
136 bool connman_network_get_connecting(struct connman_network *network);
137 #if defined TIZEN_EXT
138 void connman_network_set_connecting(struct connman_network *network);
139 #endif
140 int connman_network_set_available(struct connman_network *network,
141                                                 bool available);
142 bool connman_network_get_available(struct connman_network *network);
143 int connman_network_set_associating(struct connman_network *network,
144                                                 bool associating);
145 void connman_network_set_error(struct connman_network *network,
146                                         enum connman_network_error error);
147 int connman_network_set_connected(struct connman_network *network,
148                                                 bool connected);
149 bool connman_network_get_connected(struct connman_network *network);
150 void connman_network_set_connected_dhcp_later(struct connman_network *network,
151                 uint32_t sec);
152
153 bool connman_network_get_associating(struct connman_network *network);
154
155 void connman_network_clear_hidden(void *user_data);
156 int connman_network_connect_hidden(struct connman_network *network,
157                         char *identity, char* passphrase, void *user_data);
158
159 void connman_network_set_ipv4_method(struct connman_network *network,
160                                         enum connman_ipconfig_method method);
161 void connman_network_set_ipv6_method(struct connman_network *network,
162                                         enum connman_ipconfig_method method);
163 int connman_network_set_ipaddress(struct connman_network *network,
164                                 struct connman_ipaddress *ipaddress);
165 int connman_network_set_nameservers(struct connman_network *network,
166                                 const char *nameservers);
167 int connman_network_set_domain(struct connman_network *network,
168                                      const char *domain);
169 #if defined TIZEN_EXT
170 /*
171  * Description: Network client requires additional wifi specific info
172  */
173 int connman_network_set_bssid(struct connman_network *network,
174                                 const unsigned char *bssid);
175 unsigned char *connman_network_get_bssid(struct connman_network *network);
176
177 int connman_network_set_maxrate(struct connman_network *network,
178                                 unsigned int maxrate);
179
180 int connman_network_set_maxspeed(struct connman_network *network,
181                                 int maxrate);
182
183 unsigned int connman_network_get_maxrate(struct connman_network *network);
184
185 int connman_network_get_maxspeed(struct connman_network *network);
186
187 int connman_network_set_enc_mode(struct connman_network *network,
188                                 const char *encryption_mode);
189 const char *connman_network_get_enc_mode(struct connman_network *network);
190
191 int connman_network_set_rsn_mode(struct connman_network *network,
192                                 bool rsn_mode);
193
194 int connman_network_set_proxy(struct connman_network *network,
195                                const char *proxies);
196
197 void connman_network_clear_associating(struct connman_network *network);
198
199 int connman_network_set_keymgmt(struct connman_network *network,
200                                 unsigned int keymgmt);
201 unsigned int connman_network_get_keymgmt(struct connman_network *network);
202 int connman_network_set_disconnect_reason(struct connman_network *network,
203                                 int reason_code);
204 int connman_network_get_disconnect_reason(struct connman_network *network);
205 int connman_network_get_assoc_status_code(struct connman_network *network);
206 int connman_network_set_assoc_status_code(struct connman_network *network,
207                                 int assoc_status_code);
208 int connman_network_set_countrycode(struct connman_network *network, const
209                                     unsigned char *country_code);
210 unsigned char *connman_network_get_countrycode(struct connman_network *network);
211 int connman_network_set_bssid_list(struct connman_network *network,
212                                         GSList *bssids);
213 void *connman_network_get_bssid_list(struct connman_network *network);
214 #if defined TIZEN_EXT
215 int connman_network_set_last_connected_bssid(struct connman_network *network,
216                                 const unsigned char *bssid);
217 unsigned char *connman_network_get_last_connected_bssid(struct connman_network *network);
218 void connman_network_set_assoc_reject_table(struct connman_network *network,
219                 GHashTable *assoc_reject_table);
220 GHashTable *connman_network_get_assoc_reject_table(struct connman_network *network);
221 #endif
222 int connman_network_set_phy_mode(struct connman_network *network,
223                                 ieee80211_modes_e mode);
224 ieee80211_modes_e connman_network_get_phy_mode(struct connman_network *network);
225 int connman_network_set_connection_mode(struct connman_network *network,
226                                 connection_mode_e mode);
227 connection_mode_e connman_network_get_connection_mode(struct connman_network *network);
228 #endif
229
230 int connman_network_set_name(struct connman_network *network,
231                                                         const char *name);
232 int connman_network_set_strength(struct connman_network *network,
233                                                 uint8_t strength);
234 uint8_t connman_network_get_strength(struct connman_network *network);
235 int connman_network_set_frequency(struct connman_network *network,
236                                         uint16_t frequency);
237 uint16_t connman_network_get_frequency(struct connman_network *network);
238 int connman_network_set_wifi_channel(struct connman_network *network,
239                                         uint16_t channel);
240 uint16_t connman_network_get_wifi_channel(struct connman_network *network);
241
242 int connman_network_set_string(struct connman_network *network,
243                                         const char *key, const char *value);
244 const char *connman_network_get_string(struct connman_network *network,
245                                                         const char *key);
246 int connman_network_set_bool(struct connman_network *network,
247                                         const char *key, bool value);
248 bool connman_network_get_bool(struct connman_network *network,
249                                                         const char *key);
250 int connman_network_set_blob(struct connman_network *network,
251                         const char *key, const void *data, unsigned int size);
252 const void *connman_network_get_blob(struct connman_network *network,
253                                         const char *key, unsigned int *size);
254 #if defined TIZEN_EXT
255 void connman_network_set_vsie_list(struct connman_network *network, GSList *vsie_list);
256 void *connman_network_get_vsie_list(struct connman_network *network);
257 #endif
258
259 struct connman_device *connman_network_get_device(struct connman_network *network);
260
261 void *connman_network_get_data(struct connman_network *network);
262 void connman_network_set_data(struct connman_network *network, void *data);
263
264 void connman_network_update(struct connman_network *network);
265
266 struct connman_network_driver {
267         const char *name;
268         enum connman_network_type type;
269         int priority;
270         int (*probe) (struct connman_network *network);
271         void (*remove) (struct connman_network *network);
272         int (*connect) (struct connman_network *network);
273         int (*disconnect) (struct connman_network *network);
274 #if defined TIZEN_EXT
275         int (*merge) (struct connman_network *network);
276 #endif
277 };
278
279 int connman_network_driver_register(struct connman_network_driver *driver);
280 void connman_network_driver_unregister(struct connman_network_driver *driver);
281
282 void connman_network_append_acddbus(DBusMessageIter *dict,
283                 struct connman_network *network);
284
285 #ifdef __cplusplus
286 }
287 #endif
288
289 #endif /* __CONNMAN_NETWORK_H */