5 * Copyright (C) 2007-2009 Intel Corporation. All rights reserved.
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.
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.
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
32 #define CONNMAN_API_SUBJECT_TO_CHANGE
33 #include <connman/plugin.h>
34 #include <connman/device.h>
35 #include <connman/inet.h>
36 #include <connman/log.h>
39 #include <WiMaxAPIEx.h>
44 * Connman plugin interface
46 * This part deals with the connman internals
49 /* WiMAX network driver probe/remove, nops */
50 static int iwmx_cm_network_probe(struct connman_network *nw)
55 static void iwmx_cm_network_remove(struct connman_network *nw)
60 * Called by connman when it wants us to tell the device to connect to
61 * the network @network_el; the device is @network_el->parent.
63 * We do a synchronous call to start the connection; the logic
64 * attached to the status change callback will update the connman
65 * internals once the change happens.
67 static int iwmx_cm_network_connect(struct connman_network *nw)
70 struct wmxsdk *wmxsdk;
71 const char *station_name = connman_network_get_identifier(nw);
73 wmxsdk = connman_device_get_data(connman_network_get_device(nw));
74 result = iwmx_sdk_connect(wmxsdk, nw);
75 DBG("(nw %p [%s] wmxsdk %p) = %d\n", nw, station_name, wmxsdk, result);
80 * Called by connman to have the device @nw->parent
81 * disconnected from @nw.
83 * We do a synchronous call to start the disconnection; the logic
84 * attached to the status change callback will update the connman
85 * internals once the change happens.
87 static int iwmx_cm_network_disconnect(struct connman_network *nw)
90 struct wmxsdk *wmxsdk;
91 const char *station_name = connman_network_get_identifier(nw);
93 wmxsdk = connman_device_get_data(connman_network_get_device(nw));
94 result = iwmx_sdk_disconnect(wmxsdk);
95 DBG("(nw %p [%s] wmxsdk %p) = %d\n", nw, station_name, wmxsdk, result);
100 * "Driver" for the networks detected by a device.
102 static struct connman_network_driver iwmx_cm_network_driver = {
104 .type = CONNMAN_NETWORK_TYPE_WIMAX,
105 .probe = iwmx_cm_network_probe,
106 .remove = iwmx_cm_network_remove,
107 .connect = iwmx_cm_network_connect,
108 .disconnect = iwmx_cm_network_disconnect,
112 * A (maybe) new network is available, create/update its data
114 * If the network is new, we create and register a new element; if it
115 * is not, we reuse the one in the list.
118 * wmxsdk->network_mutex has to be locked
120 struct connman_network *__iwmx_cm_network_available(
121 struct wmxsdk *wmxsdk, const char *station_name,
122 const char *station_type,
123 const void *sdk_nspname, size_t sdk_nspname_size,
126 struct connman_network *nw = NULL;
127 struct connman_device *dev = wmxsdk->dev;
128 char group[3 * strlen(station_name) + 1];
131 nw = connman_device_get_network(dev, station_name);
133 DBG("new network %s", station_name);
134 nw = connman_network_create(station_name,
135 CONNMAN_NETWORK_TYPE_WIMAX);
136 connman_network_set_index(nw, connman_device_get_index(dev));
137 connman_network_set_protocol(nw, CONNMAN_NETWORK_PROTOCOL_IP);
138 connman_network_set_name(nw, station_name);
139 connman_network_set_blob(nw, "WiMAX.NSP.name",
140 sdk_nspname, sdk_nspname_size);
141 /* FIXME: add roaming info? */
142 /* Set the group name -- this has to be a unique
143 * [a-zA-Z0-9_] string common to all the networks that
144 * are actually the same provider. In WiMAX each
145 * network from the CAPI is a single provider, so we
146 * just set this as the network name, encoded in
148 for (cnt = 0; station_name[cnt] != 0; cnt++)
149 sprintf(group + 3 * cnt, "%02x", station_name[cnt]);
150 group[3 * cnt + 1] = 0;
151 connman_network_set_group(nw, station_name);
152 if (connman_device_add_network(dev, nw) < 0) {
153 connman_network_unref(nw);
157 DBG("updating network %s nw %p\n", station_name, nw);
158 connman_network_set_available(nw, TRUE);
159 connman_network_set_strength(nw, strength);
160 connman_network_set_string(nw, "WiMAX Network Type", station_type);
166 * A new network is available [locking version]
168 * See __iwmx_cm_network_available() for docs
170 struct connman_network *iwmx_cm_network_available(
171 struct wmxsdk *wmxsdk, const char *station_name,
172 const char *station_type,
173 const void *sdk_nspname, size_t sdk_nspname_size,
176 struct connman_network *nw;
178 g_static_mutex_lock(&wmxsdk->network_mutex);
179 nw = __iwmx_cm_network_available(wmxsdk, station_name, station_type,
180 sdk_nspname, sdk_nspname_size,
182 g_static_mutex_unlock(&wmxsdk->network_mutex);
187 * The device has been enabled, make sure connman knows
189 static void iwmx_cm_dev_enabled(struct wmxsdk *wmxsdk)
191 struct connman_device *dev = wmxsdk->dev;
192 connman_inet_ifup(connman_device_get_index(dev));
193 connman_device_set_powered(dev, TRUE);
197 * The device has been disabled, make sure connman is aware of it.
199 static void iwmx_cm_dev_disabled(struct wmxsdk *wmxsdk)
201 struct connman_device *dev = wmxsdk->dev;
202 connman_inet_ifdown(connman_device_get_index(dev));
203 connman_device_set_powered(dev, FALSE);
207 * The device has been (externally to connman) connnected to a
208 * network, make sure connman knows.
210 * When the device is connected to a network, this function is called
211 * to change connman's internal state to reflect the fact.
213 * If the change came from an external entity, that means that our
214 * connect code wasn't called. Our connect code sets
215 * @wmxsdk->connecting_nw to the network we were connecting
216 * to. If it is unset, it means an external entity forced the device
217 * to connect. In that case, we need to find out which network it was
218 * connected to, and create/lookup a @nw for it.
220 * Once the nw is set, then we are done.
222 static void iwmx_cm_dev_connected(struct wmxsdk *wmxsdk)
224 struct connman_network *nw;
226 g_mutex_lock(wmxsdk->connect_mutex);
227 nw = wmxsdk->connecting_nw;
229 nw = __iwmx_sdk_get_connected_network(wmxsdk);
231 connman_error("wmxsdk: can't find connected network\n");
235 wmxsdk->nw = connman_network_ref(nw);
236 wmxsdk->connecting_nw = NULL;
237 connman_network_set_connected(nw, TRUE);
238 DBG("connected to network %s\n",
239 connman_network_get_identifier(nw));
241 g_mutex_unlock(wmxsdk->connect_mutex);
245 * The device has been (externally to connman) disconnnected, make
248 * We need to reverse the steps done in iwmx_cm_dev_connected().
249 * If the event was caused by an external entity and we had no record
250 * of being connected to a network...well, bad luck. We'll just
251 * pretend it happened ok.
253 static void __iwmx_cm_dev_disconnected(struct wmxsdk *wmxsdk)
255 struct connman_network *nw = wmxsdk->nw;
258 DBG("disconnected from network %s\n",
259 connman_network_get_identifier(nw));
260 connman_network_set_connected(nw, FALSE);
261 connman_network_unref(nw);
264 DBG("disconnected from unknown network\n");
268 * The device has been disconnnected, make sure connman knows
270 * See __iwmx_cm_dev_disconnect() for more information.
272 static void iwmx_cm_dev_disconnected(struct wmxsdk *wmxsdk)
274 g_mutex_lock(wmxsdk->connect_mutex);
275 __iwmx_cm_dev_disconnected(wmxsdk);
276 g_mutex_unlock(wmxsdk->connect_mutex);
280 * Handle a change in state
282 * This is were most of the action happens. When the device changes
283 * state, this will catch it (through the state change callback or an
284 * explicit call) and call iwmx_cm_dev_*ed() to indicate to connman what
287 * Finally, cache the new device status.
289 void __iwmx_cm_state_change(struct wmxsdk *wmxsdk,
290 WIMAX_API_DEVICE_STATUS __new_status)
292 WIMAX_API_DEVICE_STATUS __old_status = wmxsdk->status;
293 WIMAX_API_DEVICE_STATUS old_status;
294 WIMAX_API_DEVICE_STATUS new_status;
297 * Simplify state transition computations.
299 * For practical effects, some states are the same
302 /* Conection_Idle is the same as Data_Connected */
303 if (__old_status == WIMAX_API_DEVICE_STATUS_Connection_Idle)
304 old_status = WIMAX_API_DEVICE_STATUS_Data_Connected;
306 old_status = __old_status;
307 if (__new_status == WIMAX_API_DEVICE_STATUS_Connection_Idle)
308 new_status = WIMAX_API_DEVICE_STATUS_Data_Connected;
310 new_status = __new_status;
312 /* Radio off: all are just RF_OFF_SW (the highest) */
313 switch (__old_status) {
314 case WIMAX_API_DEVICE_STATUS_RF_OFF_HW_SW:
315 case WIMAX_API_DEVICE_STATUS_RF_OFF_HW:
316 case WIMAX_API_DEVICE_STATUS_RF_OFF_SW:
317 old_status = WIMAX_API_DEVICE_STATUS_RF_OFF_SW;
320 old_status = __old_status;
324 switch (__new_status) {
325 case WIMAX_API_DEVICE_STATUS_RF_OFF_HW_SW:
326 case WIMAX_API_DEVICE_STATUS_RF_OFF_HW:
327 case WIMAX_API_DEVICE_STATUS_RF_OFF_SW:
328 new_status = WIMAX_API_DEVICE_STATUS_RF_OFF_SW;
331 new_status = __new_status;
335 /* If no real state change, do nothing */
336 if (old_status == new_status) {
337 DBG("no state changed\n");
340 DBG("state change from %d (%d: %s) to %d (%d: %s)\n",
341 old_status, __old_status,
342 iwmx_sdk_dev_status_to_str(__old_status),
343 new_status, __new_status,
344 iwmx_sdk_dev_status_to_str(__new_status));
346 /* Cleanup old state */
347 switch (old_status) {
348 case WIMAX_API_DEVICE_STATUS_UnInitialized:
349 /* This means the plugin is starting but the device is
350 * in some state already, so we need to update our
351 * internal knowledge of it. */
352 if (new_status > WIMAX_API_DEVICE_STATUS_RF_OFF_SW)
353 iwmx_cm_dev_enabled(wmxsdk);
355 case WIMAX_API_DEVICE_STATUS_RF_OFF_SW:
356 /* This means the radio is being turned on, so enable
357 * the device ( unless going to uninitialized). */
358 if (new_status != WIMAX_API_DEVICE_STATUS_RF_OFF_SW)
359 iwmx_cm_dev_enabled(wmxsdk);
361 case WIMAX_API_DEVICE_STATUS_Ready:
363 case WIMAX_API_DEVICE_STATUS_Scanning:
365 case WIMAX_API_DEVICE_STATUS_Connecting:
367 case WIMAX_API_DEVICE_STATUS_Data_Connected:
368 iwmx_cm_dev_disconnected(wmxsdk);
371 connman_error("wmxsdk: unknown old status %d\n", old_status);
375 /* Implement new state */
376 switch (new_status) {
377 case WIMAX_API_DEVICE_STATUS_UnInitialized:
379 case WIMAX_API_DEVICE_STATUS_RF_OFF_SW:
380 /* This means the radio is being turned off, so
381 * disable the device unless coming from uninitialized. */
382 if (old_status != WIMAX_API_DEVICE_STATUS_UnInitialized)
383 iwmx_cm_dev_disabled(wmxsdk);
385 case WIMAX_API_DEVICE_STATUS_Ready:
387 case WIMAX_API_DEVICE_STATUS_Scanning:
389 case WIMAX_API_DEVICE_STATUS_Connecting:
391 case WIMAX_API_DEVICE_STATUS_Data_Connected:
392 iwmx_cm_dev_connected(wmxsdk);
395 connman_error("wmxsdk: unknown new status %d\n", old_status);
398 wmxsdk->status = __new_status;
402 * Implement a device state transition [locking version]
404 * See __iwmx_cm_state_change()
406 void iwmx_cm_state_change(struct wmxsdk *wmxsdk,
407 WIMAX_API_DEVICE_STATUS __new_status)
409 g_mutex_lock(wmxsdk->status_mutex);
410 __iwmx_cm_state_change(wmxsdk, __new_status);
411 g_mutex_unlock(wmxsdk->status_mutex);
415 * Read the cached device status
417 WIMAX_API_DEVICE_STATUS iwmx_cm_status_get(struct wmxsdk *wmxsdk)
419 WIMAX_API_DEVICE_STATUS status;
421 g_mutex_lock(wmxsdk->status_mutex);
422 status = wmxsdk->status;
423 g_mutex_unlock(wmxsdk->status_mutex);
428 * Called by connman when a device is enabled by the user
430 * We need to turn the radio on; the state change function will poke
433 static int iwmx_cm_enable(struct connman_device *dev)
436 struct wmxsdk *wmxsdk = connman_device_get_data(dev);
438 connman_inet_ifup(connman_device_get_index(dev));
439 result = iwmx_sdk_rf_state_set(wmxsdk, WIMAX_API_RF_ON);
444 * Called by connman when a device is disabled by the user
446 * Simple: just make sure the radio is off; the state change function
447 * will poke the internals.
449 static int iwmx_cm_disable(struct connman_device *dev)
452 struct wmxsdk *wmxsdk = connman_device_get_data(dev);
454 result = iwmx_sdk_rf_state_set(wmxsdk, WIMAX_API_RF_OFF);
455 connman_inet_ifdown(connman_device_get_index(dev));
460 * Probe deferred call from when the mainloop is idle
462 * probe() schedules this to be called from the mainloop when idle to
463 * do a device status evaluation. Needed because of an internal race
464 * condition in connman. FIXME: deploy into _probe() when fixed.
466 static gboolean __iwmx_cm_probe_dpc(gpointer _wmxsdk)
469 struct wmxsdk *wmxsdk = _wmxsdk;
470 result = iwmx_sdk_get_device_status(wmxsdk);
472 connman_error("wmxsdk: can't get status: %d\n", result);
474 iwmx_cm_state_change(wmxsdk, result);
479 * Called by connman when a new device pops in
481 * We allocate our private structure, register with the WiMAX API,
482 * open their device, subscribe to all the callbacks.
484 * At the end, we launch a deferred call (to work around current
485 * connman issues that need to be fixed in the future) and update the
486 * device's status. This allows us to pick up the current status and
487 * adapt connman's idea of the device to it.
489 static int iwmx_cm_probe(struct connman_device *dev)
492 struct wmxsdk *wmxsdk = NULL;
494 wmxsdk = connman_device_get_data(dev);
496 /* not called from a discovery done by the WiMAX
497 * Network Service, ignore */
500 result = iwmx_sdk_setup(wmxsdk);
504 /* There is a race condition in the connman core that doesn't
505 * allow us to call this directly and things to work properly
506 * FIXME FIXME FIXME: merge _dpc call in here when connman is fixed */
507 g_idle_add(__iwmx_cm_probe_dpc, wmxsdk);
510 iwmx_sdk_remove(wmxsdk);
516 * Called when a device is removed from connman
518 * Cleanup all that is done in _probe. Remove callbacks, unregister
519 * from the WiMAX API.
521 static void iwmx_cm_remove(struct connman_device *dev)
523 struct wmxsdk *wmxsdk = connman_device_get_data(dev);
524 iwmx_sdk_remove(wmxsdk);
528 * Called by connman to ask the device to scan for networks
530 * We have set in the WiMAX API the scan result callbacks, so we just
531 * start a simple scan (not a wide one).
533 * First we obtain the current list of networks and pass it to the
534 * callback processor. Then we start an scan cycle.
536 static int iwmx_cm_scan(struct connman_device *dev)
538 struct wmxsdk *wmxsdk = connman_device_get_data(dev);
539 return iwmx_sdk_scan(wmxsdk);
543 * Driver for a WiMAX API based device.
545 static struct connman_device_driver iwmx_cm_device_driver = {
547 .type = CONNMAN_DEVICE_TYPE_WIMAX,
548 .probe = iwmx_cm_probe,
549 .remove = iwmx_cm_remove,
550 .enable = iwmx_cm_enable,
551 .disable = iwmx_cm_disable,
552 .scan = iwmx_cm_scan,
555 static int iwmx_cm_init(void)
559 result = connman_device_driver_register(&iwmx_cm_device_driver);
561 goto error_driver_register;
562 result = connman_network_driver_register(&iwmx_cm_network_driver);
564 goto error_network_driver_register;
565 result = iwmx_sdk_api_init();
567 goto error_iwmx_sdk_init;
571 connman_network_driver_unregister(&iwmx_cm_network_driver);
572 error_network_driver_register:
573 connman_device_driver_unregister(&iwmx_cm_device_driver);
574 error_driver_register:
578 static void iwmx_cm_exit(void)
581 connman_network_driver_unregister(&iwmx_cm_network_driver);
582 connman_device_driver_unregister(&iwmx_cm_device_driver);
585 CONNMAN_PLUGIN_DEFINE(iwmx, "Intel WiMAX SDK / Common API plugin",
586 CONNMAN_VERSION, CONNMAN_PLUGIN_PRIORITY_LOW,
587 iwmx_cm_init, iwmx_cm_exit);