/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */ /* * libnm_glib -- Access network status & information from glib applications * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library 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 * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, * Boston, MA 02110-1301 USA. * * Copyright (C) 2011 - 2012 Red Hat, Inc. * Copyright (C) 2009 Novell, Inc. */ #include #include #include #include "nm-glib-compat.h" #include #include #include "nm-device-wimax.h" #include "nm-object-private.h" #include "nm-object-cache.h" #include "nm-dbus-glib-types.h" #include "nm-types-private.h" #include "nm-device-private.h" G_DEFINE_TYPE (NMDeviceWimax, nm_device_wimax, NM_TYPE_DEVICE) #define NM_DEVICE_WIMAX_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_DEVICE_WIMAX, NMDeviceWimaxPrivate)) void _nm_device_wimax_set_wireless_enabled (NMDeviceWimax *wimax, gboolean enabled); typedef struct { DBusGProxy *proxy; char *hw_address; NMWimaxNsp *active_nsp; GPtrArray *nsps; guint center_freq; gint rssi; gint cinr; gint tx_power; char *bsid; } NMDeviceWimaxPrivate; enum { PROP_0, PROP_HW_ADDRESS, PROP_ACTIVE_NSP, PROP_CENTER_FREQ, PROP_RSSI, PROP_CINR, PROP_TX_POWER, PROP_BSID, PROP_NSPS, LAST_PROP }; enum { NSP_ADDED, NSP_REMOVED, LAST_SIGNAL }; static guint signals[LAST_SIGNAL] = { 0 }; /** * nm_device_wimax_error_quark: * * Registers an error quark for #NMDeviceWimax if necessary. * * Returns: the error quark used for #NMDeviceWimax errors. **/ GQuark nm_device_wimax_error_quark (void) { static GQuark quark = 0; if (G_UNLIKELY (quark == 0)) quark = g_quark_from_static_string ("nm-device-wimax-error-quark"); return quark; } /** * nm_device_wimax_new: * @connection: the #DBusGConnection * @path: the D-Bus object path of the WiMAX device * * Creates a new #NMDeviceWimax. * * Returns: (transfer full): a new WiMAX device **/ GObject * nm_device_wimax_new (DBusGConnection *connection, const char *path) { GObject *device; g_return_val_if_fail (connection != NULL, NULL); g_return_val_if_fail (path != NULL, NULL); device = g_object_new (NM_TYPE_DEVICE_WIMAX, NM_OBJECT_DBUS_CONNECTION, connection, NM_OBJECT_DBUS_PATH, path, NULL); _nm_object_ensure_inited (NM_OBJECT (device)); return device; } /** * nm_device_wimax_get_hw_address: * @wimax: a #NMDeviceWimax * * Gets the hardware (MAC) address of the #NMDeviceWimax * * Returns: the hardware address. This is the internal string used by the * device, and must not be modified. **/ const char * nm_device_wimax_get_hw_address (NMDeviceWimax *wimax) { g_return_val_if_fail (NM_IS_DEVICE_WIMAX (wimax), NULL); _nm_object_ensure_inited (NM_OBJECT (wimax)); return NM_DEVICE_WIMAX_GET_PRIVATE (wimax)->hw_address; } /** * nm_device_wimax_get_active_nsp: * @wimax: a #NMDeviceWimax * * Gets the active #NMWimaxNsp. * * Returns: (transfer full): the access point or %NULL if none is active **/ NMWimaxNsp * nm_device_wimax_get_active_nsp (NMDeviceWimax *wimax) { NMDeviceState state; g_return_val_if_fail (NM_IS_DEVICE_WIMAX (wimax), NULL); state = nm_device_get_state (NM_DEVICE (wimax)); switch (state) { case NM_DEVICE_STATE_PREPARE: case NM_DEVICE_STATE_CONFIG: case NM_DEVICE_STATE_NEED_AUTH: case NM_DEVICE_STATE_IP_CONFIG: case NM_DEVICE_STATE_IP_CHECK: case NM_DEVICE_STATE_SECONDARIES: case NM_DEVICE_STATE_ACTIVATED: case NM_DEVICE_STATE_DEACTIVATING: break; default: return NULL; break; } _nm_object_ensure_inited (NM_OBJECT (wimax)); return NM_DEVICE_WIMAX_GET_PRIVATE (wimax)->active_nsp; } /** * nm_device_wimax_get_nsps: * @wimax: a #NMDeviceWimax * * Gets all the scanned NSPs of the #NMDeviceWimax. * * Returns: (element-type NMClient.WimaxNsp): a #GPtrArray containing * all the scanned #NMWimaxNsps. * The returned array is owned by the client and should not be modified. **/ const GPtrArray * nm_device_wimax_get_nsps (NMDeviceWimax *wimax) { g_return_val_if_fail (NM_IS_DEVICE_WIMAX (wimax), NULL); _nm_object_ensure_inited (NM_OBJECT (wimax)); return handle_ptr_array_return (NM_DEVICE_WIMAX_GET_PRIVATE (wimax)->nsps); } /** * nm_device_wimax_get_nsp_by_path: * @wimax: a #NMDeviceWimax * @path: the object path of the NSP * * Gets a #NMWimaxNsp by path. * * Returns: (transfer none): the access point or %NULL if none is found. **/ NMWimaxNsp * nm_device_wimax_get_nsp_by_path (NMDeviceWimax *wimax, const char *path) { const GPtrArray *nsps; int i; NMWimaxNsp *nsp = NULL; g_return_val_if_fail (NM_IS_DEVICE_WIMAX (wimax), NULL); g_return_val_if_fail (path != NULL, NULL); nsps = nm_device_wimax_get_nsps (wimax); if (!nsps) return NULL; for (i = 0; i < nsps->len; i++) { NMWimaxNsp *candidate = g_ptr_array_index (nsps, i); if (!strcmp (nm_object_get_path (NM_OBJECT (candidate)), path)) { nsp = candidate; break; } } return nsp; } static void clean_up_nsps (NMDeviceWimax *self, gboolean notify) { NMDeviceWimaxPrivate *priv; g_return_if_fail (NM_IS_DEVICE_WIMAX (self)); priv = NM_DEVICE_WIMAX_GET_PRIVATE (self); if (priv->active_nsp) { g_object_unref (priv->active_nsp); priv->active_nsp = NULL; } if (priv->nsps) { while (priv->nsps->len) { NMWimaxNsp *nsp = NM_WIMAX_NSP (g_ptr_array_index (priv->nsps, 0)); if (notify) g_signal_emit (self, signals[NSP_REMOVED], 0, nsp); g_ptr_array_remove (priv->nsps, nsp); g_object_unref (nsp); } g_ptr_array_free (priv->nsps, TRUE); priv->nsps = NULL; } } /** * nm_device_wimax_get_center_frequency: * @self: a #NMDeviceWimax * * Gets the center frequency (in KHz) of the radio channel the device is using * to communicate with the network when connected. Has no meaning when the * device is not connected. * * Returns: the center frequency in KHz, or 0 **/ guint nm_device_wimax_get_center_frequency (NMDeviceWimax *self) { g_return_val_if_fail (NM_IS_DEVICE_WIMAX (self), 0); _nm_object_ensure_inited (NM_OBJECT (self)); return NM_DEVICE_WIMAX_GET_PRIVATE (self)->center_freq; } /** * nm_device_wimax_get_rssi: * @self: a #NMDeviceWimax * * Gets the RSSI of the current radio link in dBm. This value indicates how * strong the raw received RF signal from the base station is, but does not * indicate the overall quality of the radio link. Has no meaning when the * device is not connected. * * Returns: the RSSI in dBm, or 0 **/ gint nm_device_wimax_get_rssi (NMDeviceWimax *self) { g_return_val_if_fail (NM_IS_DEVICE_WIMAX (self), 0); _nm_object_ensure_inited (NM_OBJECT (self)); return NM_DEVICE_WIMAX_GET_PRIVATE (self)->rssi; } /** * nm_device_wimax_get_cinr: * @self: a #NMDeviceWimax * * Gets the CINR (Carrier to Interference + Noise Ratio) of the current radio * link in dB. CINR is a more accurate measure of radio link quality. Has no * meaning when the device is not connected. * * Returns: the CINR in dB, or 0 **/ gint nm_device_wimax_get_cinr (NMDeviceWimax *self) { g_return_val_if_fail (NM_IS_DEVICE_WIMAX (self), 0); _nm_object_ensure_inited (NM_OBJECT (self)); return NM_DEVICE_WIMAX_GET_PRIVATE (self)->cinr; } /** * nm_device_wimax_get_tx_power: * @self: a #NMDeviceWimax * * Average power of the last burst transmitted by the device, in units of * 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of * -5.5 dBm. Has no meaning when the device is not connected. * * Returns: the TX power in dBm, or 0 **/ gint nm_device_wimax_get_tx_power (NMDeviceWimax *self) { g_return_val_if_fail (NM_IS_DEVICE_WIMAX (self), 0); _nm_object_ensure_inited (NM_OBJECT (self)); return NM_DEVICE_WIMAX_GET_PRIVATE (self)->tx_power; } /** * nm_device_wimax_get_bsid: * @self: a #NMDeviceWimax * * Gets the ID of the serving Base Station when the device is connected. * * Returns: the ID of the serving Base Station, or %NULL **/ const char * nm_device_wimax_get_bsid (NMDeviceWimax *self) { g_return_val_if_fail (NM_IS_DEVICE_WIMAX (self), NULL); _nm_object_ensure_inited (NM_OBJECT (self)); return NM_DEVICE_WIMAX_GET_PRIVATE (self)->bsid; } static gboolean connection_compatible (NMDevice *device, NMConnection *connection, GError **error) { NMSettingConnection *s_con; NMSettingWimax *s_wimax; const char *ctype; const GByteArray *mac; const char *hw_str; struct ether_addr *hw_mac; s_con = nm_connection_get_setting_connection (connection); g_assert (s_con); ctype = nm_setting_connection_get_connection_type (s_con); if (strcmp (ctype, NM_SETTING_WIMAX_SETTING_NAME) != 0) { g_set_error (error, NM_DEVICE_WIMAX_ERROR, NM_DEVICE_WIMAX_ERROR_NOT_WIMAX_CONNECTION, "The connection was not a Wimax connection."); return FALSE; } s_wimax = nm_connection_get_setting_wimax (connection); if (!s_wimax) { g_set_error (error, NM_DEVICE_WIMAX_ERROR, NM_DEVICE_WIMAX_ERROR_INVALID_WIMAX_CONNECTION, "The connection was not a valid Wimax connection."); return FALSE; } /* Check MAC address */ hw_str = nm_device_wimax_get_hw_address (NM_DEVICE_WIMAX (device)); if (hw_str) { hw_mac = ether_aton (hw_str); if (!hw_mac) { g_set_error (error, NM_DEVICE_WIMAX_ERROR, NM_DEVICE_WIMAX_ERROR_INVALID_DEVICE_MAC, "Invalid device MAC address."); return FALSE; } mac = nm_setting_wimax_get_mac_address (s_wimax); if (mac && hw_mac && memcmp (mac->data, hw_mac->ether_addr_octet, ETH_ALEN)) { g_set_error (error, NM_DEVICE_WIMAX_ERROR, NM_DEVICE_WIMAX_ERROR_MAC_MISMATCH, "The MACs of the device and the connection didn't match."); return FALSE; } } return NM_DEVICE_CLASS (nm_device_wimax_parent_class)->connection_compatible (device, connection, error); } static GType get_setting_type (NMDevice *device) { return NM_TYPE_SETTING_WIMAX; } static const char * get_hw_address (NMDevice *device) { return nm_device_wimax_get_hw_address (NM_DEVICE_WIMAX (device)); } /**************************************************************/ static void nm_device_wimax_init (NMDeviceWimax *device) { _nm_device_set_device_type (NM_DEVICE (device), NM_DEVICE_TYPE_WIMAX); } static void get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec) { NMDeviceWimax *self = NM_DEVICE_WIMAX (object); _nm_object_ensure_inited (NM_OBJECT (object)); switch (prop_id) { case PROP_HW_ADDRESS: g_value_set_string (value, nm_device_wimax_get_hw_address (self)); break; case PROP_ACTIVE_NSP: g_value_set_object (value, nm_device_wimax_get_active_nsp (self)); break; case PROP_CENTER_FREQ: g_value_set_uint (value, nm_device_wimax_get_center_frequency (self)); break; case PROP_RSSI: g_value_set_int (value, nm_device_wimax_get_rssi (self)); break; case PROP_CINR: g_value_set_int (value, nm_device_wimax_get_cinr (self)); break; case PROP_TX_POWER: g_value_set_int (value, nm_device_wimax_get_tx_power (self)); break; case PROP_BSID: g_value_set_string (value, nm_device_wimax_get_bsid (self)); break; case PROP_NSPS: g_value_set_boxed (value, nm_device_wimax_get_nsps (self)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void clear_link_status (NMDeviceWimax *self) { NMDeviceWimaxPrivate *priv = NM_DEVICE_WIMAX_GET_PRIVATE (self); if (priv->center_freq) { priv->center_freq = 0; _nm_object_queue_notify (NM_OBJECT (self), NM_DEVICE_WIMAX_CENTER_FREQUENCY); } if (priv->rssi) { priv->rssi = 0; _nm_object_queue_notify (NM_OBJECT (self), NM_DEVICE_WIMAX_RSSI); } if (priv->cinr) { priv->cinr = 0; _nm_object_queue_notify (NM_OBJECT (self), NM_DEVICE_WIMAX_CINR); } if (priv->tx_power) { priv->tx_power = 0; _nm_object_queue_notify (NM_OBJECT (self), NM_DEVICE_WIMAX_TX_POWER); } if (priv->bsid) { g_free (priv->bsid); priv->bsid = NULL; _nm_object_queue_notify (NM_OBJECT (self), NM_DEVICE_WIMAX_BSID); } } static void state_changed_cb (NMDevice *device, GParamSpec *pspec, gpointer user_data) { NMDeviceWimax *self = NM_DEVICE_WIMAX (device); NMDeviceWimaxPrivate *priv = NM_DEVICE_WIMAX_GET_PRIVATE (self); NMDeviceState state; state = nm_device_get_state (device); switch (state) { case NM_DEVICE_STATE_UNKNOWN: case NM_DEVICE_STATE_UNMANAGED: case NM_DEVICE_STATE_UNAVAILABLE: case NM_DEVICE_STATE_DISCONNECTED: case NM_DEVICE_STATE_FAILED: if (priv->active_nsp) { g_object_unref (priv->active_nsp); priv->active_nsp = NULL; } _nm_object_queue_notify (NM_OBJECT (device), NM_DEVICE_WIMAX_ACTIVE_NSP); clear_link_status (self); break; case NM_DEVICE_STATE_PREPARE: case NM_DEVICE_STATE_CONFIG: case NM_DEVICE_STATE_NEED_AUTH: case NM_DEVICE_STATE_IP_CONFIG: clear_link_status (self); break; default: break; } } static void register_properties (NMDeviceWimax *wimax) { NMDeviceWimaxPrivate *priv = NM_DEVICE_WIMAX_GET_PRIVATE (wimax); const NMPropertiesInfo property_info[] = { { NM_DEVICE_WIMAX_HW_ADDRESS, &priv->hw_address }, { NM_DEVICE_WIMAX_ACTIVE_NSP, &priv->active_nsp, NULL, NM_TYPE_WIMAX_NSP }, { NM_DEVICE_WIMAX_CENTER_FREQUENCY, &priv->center_freq }, { NM_DEVICE_WIMAX_RSSI, &priv->rssi }, { NM_DEVICE_WIMAX_CINR, &priv->cinr }, { NM_DEVICE_WIMAX_TX_POWER, &priv->tx_power }, { NM_DEVICE_WIMAX_BSID, &priv->bsid }, { NM_DEVICE_WIMAX_NSPS, &priv->nsps, NULL, NM_TYPE_WIMAX_NSP, "nsp" }, { NULL }, }; _nm_object_register_properties (NM_OBJECT (wimax), priv->proxy, property_info); } static void nsp_removed (NMDeviceWimax *self, NMWimaxNsp *nsp) { NMDeviceWimaxPrivate *priv = NM_DEVICE_WIMAX_GET_PRIVATE (self); if (nsp == priv->active_nsp) { g_object_unref (priv->active_nsp); priv->active_nsp = NULL; _nm_object_queue_notify (NM_OBJECT (self), NM_DEVICE_WIMAX_ACTIVE_NSP); } } static void constructed (GObject *object) { NMDeviceWimaxPrivate *priv = NM_DEVICE_WIMAX_GET_PRIVATE (object); G_OBJECT_CLASS (nm_device_wimax_parent_class)->constructed (object); priv->proxy = _nm_object_new_proxy (NM_OBJECT (object), NULL, NM_DBUS_INTERFACE_DEVICE_WIMAX); register_properties (NM_DEVICE_WIMAX (object)); g_signal_connect (object, "notify::" NM_DEVICE_STATE, G_CALLBACK (state_changed_cb), NULL); } static void dispose (GObject *object) { NMDeviceWimaxPrivate *priv = NM_DEVICE_WIMAX_GET_PRIVATE (object); if (priv->hw_address) { g_free (priv->hw_address); priv->hw_address = NULL; } if (priv->bsid) { g_free (priv->bsid); priv->bsid = NULL; } clean_up_nsps (NM_DEVICE_WIMAX (object), FALSE); g_clear_object (&priv->proxy); G_OBJECT_CLASS (nm_device_wimax_parent_class)->dispose (object); } static void nm_device_wimax_class_init (NMDeviceWimaxClass *wimax_class) { GObjectClass *object_class = G_OBJECT_CLASS (wimax_class); NMDeviceClass *device_class = NM_DEVICE_CLASS (wimax_class); g_type_class_add_private (wimax_class, sizeof (NMDeviceWimaxPrivate)); /* virtual methods */ object_class->constructed = constructed; object_class->get_property = get_property; object_class->dispose = dispose; device_class->connection_compatible = connection_compatible; device_class->get_setting_type = get_setting_type; device_class->get_hw_address = get_hw_address; wimax_class->nsp_removed = nsp_removed; /* properties */ /** * NMDeviceWimax:hw-address: * * The hardware (MAC) address of the device. **/ g_object_class_install_property (object_class, PROP_HW_ADDRESS, g_param_spec_string (NM_DEVICE_WIMAX_HW_ADDRESS, "MAC Address", "Hardware MAC address", NULL, G_PARAM_READABLE)); /** * NMDeviceWimax:active-nsp: * * The active #NMWimaxNsp of the device. **/ g_object_class_install_property (object_class, PROP_ACTIVE_NSP, g_param_spec_object (NM_DEVICE_WIMAX_ACTIVE_NSP, "Active NSP", "Active NSP", NM_TYPE_WIMAX_NSP, G_PARAM_READABLE)); /** * NMDeviceWimax:center-frequency: * * The center frequency (in KHz) of the radio channel the device is using to * communicate with the network when connected. Has no meaning when the * device is not connected. **/ g_object_class_install_property (object_class, PROP_CENTER_FREQ, g_param_spec_uint (NM_DEVICE_WIMAX_CENTER_FREQUENCY, "Center frequency", "Center frequency", 0, G_MAXUINT, 0, G_PARAM_READABLE)); /** * NMDeviceWimax:rssi: * * RSSI of the current radio link in dBm. This value indicates how strong * the raw received RF signal from the base station is, but does not * indicate the overall quality of the radio link. Has no meaning when the * device is not connected. **/ g_object_class_install_property (object_class, PROP_RSSI, g_param_spec_int (NM_DEVICE_WIMAX_RSSI, "RSSI", "RSSI", G_MININT, G_MAXINT, 0, G_PARAM_READABLE)); /** * NMDeviceWimax:cinr: * * CINR (Carrier to Interference + Noise Ratio) of the current radio link * in dB. CINR is a more accurate measure of radio link quality. Has no * meaning when the device is not connected. **/ g_object_class_install_property (object_class, PROP_CINR, g_param_spec_int (NM_DEVICE_WIMAX_CINR, "CINR", "CINR", G_MININT, G_MAXINT, 0, G_PARAM_READABLE)); /** * NMDeviceWimax:tx-power: * * Average power of the last burst transmitted by the device, in units of * 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of * -5.5 dBm. Has no meaning when the device is not connected. **/ g_object_class_install_property (object_class, PROP_TX_POWER, g_param_spec_int (NM_DEVICE_WIMAX_TX_POWER, "TX Power", "TX Power", G_MININT, G_MAXINT, 0, G_PARAM_READABLE)); /** * NMDeviceWimax:bsid: * * The ID of the serving base station as received from the network. Has * no meaning when the device is not connected. **/ g_object_class_install_property (object_class, PROP_BSID, g_param_spec_string (NM_DEVICE_WIMAX_BSID, "BSID", "BSID", NULL, G_PARAM_READABLE)); /** * NMDeviceWimax:nsps: * * List of all WiMAX Network Service Providers the device can see. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_NSPS, g_param_spec_boxed (NM_DEVICE_WIMAX_NSPS, "NSPs", "Network Service Providers", NM_TYPE_OBJECT_ARRAY, G_PARAM_READABLE)); /* signals */ /** * NMDeviceWimax::nsp-added: * @self: the wimax device that received the signal * @nsp: the new NSP * * Notifies that a #NMWimaxNsp is added to the wimax device. **/ signals[NSP_ADDED] = g_signal_new ("nsp-added", G_OBJECT_CLASS_TYPE (object_class), G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (NMDeviceWimaxClass, nsp_added), NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1, G_TYPE_OBJECT); /** * NMDeviceWimax::nsp-removed: * @self: the wimax device that received the signal * @nsp: the removed NSP * * Notifies that a #NMWimaxNsp is removed from the wimax device. **/ signals[NSP_REMOVED] = g_signal_new ("nsp-removed", G_OBJECT_CLASS_TYPE (object_class), G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (NMDeviceWimaxClass, nsp_removed), NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1, G_TYPE_OBJECT); }