diff options
Diffstat (limited to 'libmm-glib/mm-signal.c')
| -rw-r--r-- | libmm-glib/mm-signal.c | 442 |
1 files changed, 442 insertions, 0 deletions
diff --git a/libmm-glib/mm-signal.c b/libmm-glib/mm-signal.c new file mode 100644 index 00000000..b93e0bb4 --- /dev/null +++ b/libmm-glib/mm-signal.c @@ -0,0 +1,442 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * 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: + * + * Copyright (C) 2013 Aleksander Morgado <aleksander@gnu.org> + */ + +#include <string.h> +#include <ctype.h> +#include <stdlib.h> + +#include "mm-signal.h" +#include "mm-errors-types.h" + +/** + * SECTION: mm-signal + * @title: MMSignal + * @short_description: Helper object to handle extended Signal information. + * + * The #MMSignal is an object handling the signal information of the + * modem. + */ + +G_DEFINE_TYPE (MMSignal, mm_signal, G_TYPE_OBJECT) + +#define PROPERTY_RSSI "rssi" +#define PROPERTY_ECIO "ecio" +#define PROPERTY_SINR "sinr" +#define PROPERTY_IO "io" +#define PROPERTY_RSRQ "rsrq" +#define PROPERTY_RSRP "rsrp" +#define PROPERTY_SNR "snr" + +struct _MMSignalPrivate { + gdouble rssi; + gdouble ecio; + gdouble sinr; + gdouble io; + gdouble rsrq; + gdouble rsrp; + gdouble snr; +}; + +/*****************************************************************************/ + +/** + * mm_signal_get_rssi: + * @self: a #MMSignal. + * + * Gets the RSSI (Received Signal Strength Indication), in dBm. + * + * Returns: the RSSI, or %MM_SIGNAL_UNKNOWN if unknown. + */ +gdouble +mm_signal_get_rssi (MMSignal *self) +{ + g_return_val_if_fail (MM_IS_SIGNAL (self), MM_SIGNAL_UNKNOWN); + + return self->priv->rssi; +} + +void +mm_signal_set_rssi (MMSignal *self, + gdouble value) +{ + g_return_if_fail (MM_IS_SIGNAL (self)); + + self->priv->rssi = value; +} + +/*****************************************************************************/ + +/** + * mm_signal_get_ecio: + * @self: a #MMSignal. + * + * Gets the Ec/Io, in dBm. + * + * Only applicable to CDMA1x, CDMA EV-DO and UMTS (WCDMA). + * + * Returns: the ECIO, or %MM_SIGNAL_UNKNOWN if unknown. + */ +gdouble +mm_signal_get_ecio (MMSignal *self) +{ + g_return_val_if_fail (MM_IS_SIGNAL (self), MM_SIGNAL_UNKNOWN); + + return self->priv->ecio; +} + +void +mm_signal_set_ecio (MMSignal *self, + gdouble value) +{ + g_return_if_fail (MM_IS_SIGNAL (self)); + + self->priv->ecio = value; +} + +/*****************************************************************************/ + +/** + * mm_signal_get_sinr: + * @self: a #MMSignal. + * + * Gets the SINR level, in dB. + * + * Only applicable to CDMA EV-DO. + * + * Returns: the SINR, or %MM_SIGNAL_UNKNOWN if unknown. + */ +gdouble +mm_signal_get_sinr (MMSignal *self) +{ + g_return_val_if_fail (MM_IS_SIGNAL (self), MM_SIGNAL_UNKNOWN); + + return self->priv->sinr; +} + +void +mm_signal_set_sinr (MMSignal *self, + gdouble value) +{ + g_return_if_fail (MM_IS_SIGNAL (self)); + + self->priv->sinr = value; +} + +/*****************************************************************************/ + +/** + * mm_signal_get_io: + * @self: a #MMSignal. + * + * Gets the Io, in dBm. + * + * Only applicable to CDMA EV-DO. + * + * Returns: the Io, or %MM_SIGNAL_UNKNOWN if unknown. + */ +gdouble +mm_signal_get_io (MMSignal *self) +{ + g_return_val_if_fail (MM_IS_SIGNAL (self), MM_SIGNAL_UNKNOWN); + + return self->priv->io; +} + +void +mm_signal_set_io (MMSignal *self, + gdouble value) +{ + g_return_if_fail (MM_IS_SIGNAL (self)); + + self->priv->io = value; +} + +/*****************************************************************************/ + +/** + * mm_signal_get_rsrp: + * @self: a #MMSignal. + * + * Gets the RSRP (Reference Signal Received Power), in dBm. + * + * Only applicable to LTE. + * + * Returns: the RSRP, or %MM_SIGNAL_UNKNOWN if unknown. + */ +gdouble +mm_signal_get_rsrp (MMSignal *self) +{ + g_return_val_if_fail (MM_IS_SIGNAL (self), MM_SIGNAL_UNKNOWN); + + return self->priv->rsrp; +} + +void +mm_signal_set_rsrp (MMSignal *self, + gdouble value) +{ + g_return_if_fail (MM_IS_SIGNAL (self)); + + self->priv->rsrp = value; +} + +/*****************************************************************************/ + +/** + * mm_signal_get_rsrq: + * @self: a #MMSignal. + * + * Gets the RSRQ (Reference Signal Received Quality), in dB. + * + * Only applicable to LTE. + * + * Returns: the RSRQ, or %MM_SIGNAL_UNKNOWN if unknown. + */ +gdouble +mm_signal_get_rsrq (MMSignal *self) +{ + g_return_val_if_fail (MM_IS_SIGNAL (self), MM_SIGNAL_UNKNOWN); + + return self->priv->rsrq; +} + +void +mm_signal_set_rsrq (MMSignal *self, + gdouble value) +{ + g_return_if_fail (MM_IS_SIGNAL (self)); + + self->priv->rsrq = value; +} + +/*****************************************************************************/ + +/** + * mm_signal_get_snr: + * @self: a #MMSignal. + * + * Gets the S/R ration, in dB. + * + * Only applicable to LTE. + * + * Returns: the S/R ratio, or %MM_SIGNAL_UNKNOWN if unknown. + */ +gdouble +mm_signal_get_snr (MMSignal *self) +{ + g_return_val_if_fail (MM_IS_SIGNAL (self), MM_SIGNAL_UNKNOWN); + + return self->priv->snr; +} + +void +mm_signal_set_snr (MMSignal *self, + gdouble value) +{ + g_return_if_fail (MM_IS_SIGNAL (self)); + + self->priv->snr = value; +} + +/*****************************************************************************/ + +/** + * mm_signal_get_dictionary: + * @self: A #MMSignal. + * + * Gets a variant dictionary with the contents of @self. + * + * Returns: (transfer full): A dictionary with the signal values. The returned value should be freed with g_variant_unref(). + */ +GVariant * +mm_signal_get_dictionary (MMSignal *self) +{ + GVariantBuilder builder; + + /* We do allow NULL */ + if (!self) + return NULL; + + g_return_val_if_fail (MM_IS_SIGNAL (self), NULL); + + g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}")); + + if (self->priv->rssi != MM_SIGNAL_UNKNOWN) + g_variant_builder_add (&builder, + "{sv}", + PROPERTY_RSSI, + g_variant_new_double (self->priv->rssi)); + + if (self->priv->ecio != MM_SIGNAL_UNKNOWN) + g_variant_builder_add (&builder, + "{sv}", + PROPERTY_ECIO, + g_variant_new_double (self->priv->ecio)); + + if (self->priv->sinr != MM_SIGNAL_UNKNOWN) + g_variant_builder_add (&builder, + "{sv}", + PROPERTY_SINR, + g_variant_new_double (self->priv->sinr)); + + if (self->priv->io != MM_SIGNAL_UNKNOWN) + g_variant_builder_add (&builder, + "{sv}", + PROPERTY_IO, + g_variant_new_double (self->priv->io)); + + if (self->priv->rsrp != MM_SIGNAL_UNKNOWN) + g_variant_builder_add (&builder, + "{sv}", + PROPERTY_RSRP, + g_variant_new_double (self->priv->rsrp)); + + if (self->priv->rsrq != MM_SIGNAL_UNKNOWN) + g_variant_builder_add (&builder, + "{sv}", + PROPERTY_RSRQ, + g_variant_new_double (self->priv->rsrq)); + + if (self->priv->snr != MM_SIGNAL_UNKNOWN) + g_variant_builder_add (&builder, + "{sv}", + PROPERTY_SNR, + g_variant_new_double (self->priv->snr)); + + return g_variant_ref_sink (g_variant_builder_end (&builder)); +} + +/*****************************************************************************/ + +static gboolean +consume_variant (MMSignal *self, + const gchar *key, + GVariant *value, + GError **error) +{ + if (g_str_equal (key, PROPERTY_RSSI)) + self->priv->rssi = g_variant_get_double (value); + else if (g_str_equal (key, PROPERTY_ECIO)) + self->priv->ecio = g_variant_get_double (value); + else if (g_str_equal (key, PROPERTY_SINR)) + self->priv->sinr = g_variant_get_double (value); + else if (g_str_equal (key, PROPERTY_IO)) + self->priv->io = g_variant_get_double (value); + else if (g_str_equal (key, PROPERTY_RSRP)) + self->priv->rsrp = g_variant_get_double (value); + else if (g_str_equal (key, PROPERTY_RSRQ)) + self->priv->rsrq = g_variant_get_double (value); + else if (g_str_equal (key, PROPERTY_SNR)) + self->priv->snr = g_variant_get_double (value); + else { + /* Set error */ + g_set_error (error, + MM_CORE_ERROR, + MM_CORE_ERROR_INVALID_ARGS, + "Invalid signal dictionary, unexpected key '%s'", + key); + return FALSE; + } + + return TRUE; +} + +/** + * mm_signal_new_from_dictionary: + * @dictionary: A variant dictionary with the signal information. + * @error: Return location for error or %NULL. + * + * Creates a new #MMSignal object with the values exposed in + * the dictionary. + * + * Returns: (transfer full): A #MMSignal or %NULL if @error is set. The returned value should be freed with g_object_unref(). + */ +MMSignal * +mm_signal_new_from_dictionary (GVariant *dictionary, + GError **error) +{ + GError *inner_error = NULL; + GVariantIter iter; + gchar *key; + GVariant *value; + MMSignal *self; + + if (!dictionary) { + g_set_error (error, + MM_CORE_ERROR, + MM_CORE_ERROR_INVALID_ARGS, + "Cannot create Signal info from empty dictionary"); + return NULL; + } + + if (!g_variant_is_of_type (dictionary, G_VARIANT_TYPE ("a{sv}"))) { + g_set_error (error, + MM_CORE_ERROR, + MM_CORE_ERROR_INVALID_ARGS, + "Cannot create Signal info from dictionary: " + "invalid variant type received"); + return NULL; + } + + self = mm_signal_new (); + g_variant_iter_init (&iter, dictionary); + while (!inner_error && + g_variant_iter_next (&iter, "{sv}", &key, &value)) { + consume_variant (self, + key, + value, + &inner_error); + g_free (key); + g_variant_unref (value); + } + + /* If error, destroy the object */ + if (inner_error) { + g_propagate_error (error, inner_error); + g_object_unref (self); + return NULL; + } + + return self; +} + +/*****************************************************************************/ + +MMSignal * +mm_signal_new (void) +{ + return MM_SIGNAL (g_object_new (MM_TYPE_SIGNAL, NULL)); +} + +static void +mm_signal_init (MMSignal *self) +{ + self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, MM_TYPE_SIGNAL, MMSignalPrivate); + self->priv->rssi = MM_SIGNAL_UNKNOWN; + self->priv->ecio = MM_SIGNAL_UNKNOWN; + self->priv->sinr = MM_SIGNAL_UNKNOWN; + self->priv->io = MM_SIGNAL_UNKNOWN; + self->priv->rsrq = MM_SIGNAL_UNKNOWN; + self->priv->rsrp = MM_SIGNAL_UNKNOWN; + self->priv->snr = MM_SIGNAL_UNKNOWN; +} + +static void +mm_signal_class_init (MMSignalClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + g_type_class_add_private (object_class, sizeof (MMSignalPrivate)); +} |